License cleanup: add SPDX GPL-2.0 license identifier to files with no license
Many source files in the tree are missing licensing information, which
makes it harder for compliance tools to determine the correct license.
By default all files without license information are under the default
license of the kernel, which is GPL version 2.
Update the files which contain no license information with the 'GPL-2.0'
SPDX license identifier. The SPDX identifier is a legally binding
shorthand, which can be used instead of the full boiler plate text.
This patch is based on work done by Thomas Gleixner and Kate Stewart and
Philippe Ombredanne.
How this work was done:
Patches were generated and checked against linux-4.14-rc6 for a subset of
the use cases:
- file had no licensing information it it.
- file was a */uapi/* one with no licensing information in it,
- file was a */uapi/* one with existing licensing information,
Further patches will be generated in subsequent months to fix up cases
where non-standard license headers were used, and references to license
had to be inferred by heuristics based on keywords.
The analysis to determine which SPDX License Identifier to be applied to
a file was done in a spreadsheet of side by side results from of the
output of two independent scanners (ScanCode & Windriver) producing SPDX
tag:value files created by Philippe Ombredanne. Philippe prepared the
base worksheet, and did an initial spot review of a few 1000 files.
The 4.13 kernel was the starting point of the analysis with 60,537 files
assessed. Kate Stewart did a file by file comparison of the scanner
results in the spreadsheet to determine which SPDX license identifier(s)
to be applied to the file. She confirmed any determination that was not
immediately clear with lawyers working with the Linux Foundation.
Criteria used to select files for SPDX license identifier tagging was:
- Files considered eligible had to be source code files.
- Make and config files were included as candidates if they contained >5
lines of source
- File already had some variant of a license header in it (even if <5
lines).
All documentation files were explicitly excluded.
The following heuristics were used to determine which SPDX license
identifiers to apply.
- when both scanners couldn't find any license traces, file was
considered to have no license information in it, and the top level
COPYING file license applied.
For non */uapi/* files that summary was:
SPDX license identifier # files
---------------------------------------------------|-------
GPL-2.0 11139
and resulted in the first patch in this series.
If that file was a */uapi/* path one, it was "GPL-2.0 WITH
Linux-syscall-note" otherwise it was "GPL-2.0". Results of that was:
SPDX license identifier # files
---------------------------------------------------|-------
GPL-2.0 WITH Linux-syscall-note 930
and resulted in the second patch in this series.
- if a file had some form of licensing information in it, and was one
of the */uapi/* ones, it was denoted with the Linux-syscall-note if
any GPL family license was found in the file or had no licensing in
it (per prior point). Results summary:
SPDX license identifier # files
---------------------------------------------------|------
GPL-2.0 WITH Linux-syscall-note 270
GPL-2.0+ WITH Linux-syscall-note 169
((GPL-2.0 WITH Linux-syscall-note) OR BSD-2-Clause) 21
((GPL-2.0 WITH Linux-syscall-note) OR BSD-3-Clause) 17
LGPL-2.1+ WITH Linux-syscall-note 15
GPL-1.0+ WITH Linux-syscall-note 14
((GPL-2.0+ WITH Linux-syscall-note) OR BSD-3-Clause) 5
LGPL-2.0+ WITH Linux-syscall-note 4
LGPL-2.1 WITH Linux-syscall-note 3
((GPL-2.0 WITH Linux-syscall-note) OR MIT) 3
((GPL-2.0 WITH Linux-syscall-note) AND MIT) 1
and that resulted in the third patch in this series.
- when the two scanners agreed on the detected license(s), that became
the concluded license(s).
- when there was disagreement between the two scanners (one detected a
license but the other didn't, or they both detected different
licenses) a manual inspection of the file occurred.
- In most cases a manual inspection of the information in the file
resulted in a clear resolution of the license that should apply (and
which scanner probably needed to revisit its heuristics).
- When it was not immediately clear, the license identifier was
confirmed with lawyers working with the Linux Foundation.
- If there was any question as to the appropriate license identifier,
the file was flagged for further research and to be revisited later
in time.
In total, over 70 hours of logged manual review was done on the
spreadsheet to determine the SPDX license identifiers to apply to the
source files by Kate, Philippe, Thomas and, in some cases, confirmation
by lawyers working with the Linux Foundation.
Kate also obtained a third independent scan of the 4.13 code base from
FOSSology, and compared selected files where the other two scanners
disagreed against that SPDX file, to see if there was new insights. The
Windriver scanner is based on an older version of FOSSology in part, so
they are related.
Thomas did random spot checks in about 500 files from the spreadsheets
for the uapi headers and agreed with SPDX license identifier in the
files he inspected. For the non-uapi files Thomas did random spot checks
in about 15000 files.
In initial set of patches against 4.14-rc6, 3 files were found to have
copy/paste license identifier errors, and have been fixed to reflect the
correct identifier.
Additionally Philippe spent 10 hours this week doing a detailed manual
inspection and review of the 12,461 patched files from the initial patch
version early this week with:
- a full scancode scan run, collecting the matched texts, detected
license ids and scores
- reviewing anything where there was a license detected (about 500+
files) to ensure that the applied SPDX license was correct
- reviewing anything where there was no detection but the patch license
was not GPL-2.0 WITH Linux-syscall-note to ensure that the applied
SPDX license was correct
This produced a worksheet with 20 files needing minor correction. This
worksheet was then exported into 3 different .csv files for the
different types of files to be modified.
These .csv files were then reviewed by Greg. Thomas wrote a script to
parse the csv files and add the proper SPDX tag to the file, in the
format that the file expected. This script was further refined by Greg
based on the output to detect more types of files automatically and to
distinguish between header and source .c files (which need different
comment types.) Finally Greg ran the script using the .csv files to
generate the patches.
Reviewed-by: Kate Stewart <kstewart@linuxfoundation.org>
Reviewed-by: Philippe Ombredanne <pombredanne@nexb.com>
Reviewed-by: Thomas Gleixner <tglx@linutronix.de>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
2017-11-01 22:07:57 +08:00
|
|
|
/* SPDX-License-Identifier: GPL-2.0 */
|
2017-01-09 23:55:13 +08:00
|
|
|
/*
|
|
|
|
* Shared Memory Communications over RDMA (SMC-R) and RoCE
|
|
|
|
*
|
|
|
|
* Definitions for the SMC module (socket related)
|
|
|
|
*
|
|
|
|
* Copyright IBM Corp. 2016
|
|
|
|
*
|
|
|
|
* Author(s): Ursula Braun <ubraun@linux.vnet.ibm.com>
|
|
|
|
*/
|
|
|
|
#ifndef __SMC_H
|
|
|
|
#define __SMC_H
|
|
|
|
|
|
|
|
#include <linux/socket.h>
|
|
|
|
#include <linux/types.h>
|
2017-01-09 23:55:19 +08:00
|
|
|
#include <linux/compiler.h> /* __aligned */
|
2017-01-09 23:55:13 +08:00
|
|
|
#include <net/sock.h>
|
|
|
|
|
2017-01-09 23:55:17 +08:00
|
|
|
#include "smc_ib.h"
|
|
|
|
|
2018-03-16 22:06:41 +08:00
|
|
|
#define SMCPROTO_SMC 0 /* SMC protocol, IPv4 */
|
|
|
|
#define SMCPROTO_SMC6 1 /* SMC protocol, IPv6 */
|
2017-01-09 23:55:13 +08:00
|
|
|
|
2017-01-09 23:55:14 +08:00
|
|
|
#define SMC_MAX_PORTS 2 /* Max # of ports */
|
|
|
|
|
2017-01-09 23:55:26 +08:00
|
|
|
extern struct proto smc_proto;
|
2018-03-16 22:06:41 +08:00
|
|
|
extern struct proto smc_proto6;
|
2017-01-09 23:55:26 +08:00
|
|
|
|
2017-01-09 23:55:22 +08:00
|
|
|
#ifdef ATOMIC64_INIT
|
|
|
|
#define KERNEL_HAS_ATOMIC64
|
|
|
|
#endif
|
|
|
|
|
2017-01-09 23:55:13 +08:00
|
|
|
enum smc_state { /* possible states of an SMC socket */
|
|
|
|
SMC_ACTIVE = 1,
|
|
|
|
SMC_INIT = 2,
|
|
|
|
SMC_CLOSED = 7,
|
|
|
|
SMC_LISTEN = 10,
|
2017-01-09 23:55:25 +08:00
|
|
|
/* normal close */
|
|
|
|
SMC_PEERCLOSEWAIT1 = 20,
|
|
|
|
SMC_PEERCLOSEWAIT2 = 21,
|
|
|
|
SMC_APPFINCLOSEWAIT = 24,
|
|
|
|
SMC_APPCLOSEWAIT1 = 22,
|
|
|
|
SMC_APPCLOSEWAIT2 = 23,
|
|
|
|
SMC_PEERFINCLOSEWAIT = 25,
|
|
|
|
/* abnormal close */
|
|
|
|
SMC_PEERABORTWAIT = 26,
|
|
|
|
SMC_PROCESSABORT = 27,
|
2017-01-09 23:55:13 +08:00
|
|
|
};
|
|
|
|
|
2017-01-09 23:55:17 +08:00
|
|
|
struct smc_link_group;
|
|
|
|
|
2017-01-09 23:55:19 +08:00
|
|
|
struct smc_wr_rx_hdr { /* common prefix part of LLC and CDC to demultiplex */
|
|
|
|
u8 type;
|
|
|
|
} __aligned(1);
|
|
|
|
|
2017-01-09 23:55:22 +08:00
|
|
|
struct smc_cdc_conn_state_flags {
|
|
|
|
#if defined(__BIG_ENDIAN_BITFIELD)
|
|
|
|
u8 peer_done_writing : 1; /* Sending done indicator */
|
|
|
|
u8 peer_conn_closed : 1; /* Peer connection closed indicator */
|
|
|
|
u8 peer_conn_abort : 1; /* Abnormal close indicator */
|
|
|
|
u8 reserved : 5;
|
|
|
|
#elif defined(__LITTLE_ENDIAN_BITFIELD)
|
|
|
|
u8 reserved : 5;
|
|
|
|
u8 peer_conn_abort : 1;
|
|
|
|
u8 peer_conn_closed : 1;
|
|
|
|
u8 peer_done_writing : 1;
|
|
|
|
#endif
|
|
|
|
};
|
|
|
|
|
|
|
|
struct smc_cdc_producer_flags {
|
|
|
|
#if defined(__BIG_ENDIAN_BITFIELD)
|
|
|
|
u8 write_blocked : 1; /* Writing Blocked, no rx buf space */
|
|
|
|
u8 urg_data_pending : 1; /* Urgent Data Pending */
|
|
|
|
u8 urg_data_present : 1; /* Urgent Data Present */
|
|
|
|
u8 cons_curs_upd_req : 1; /* cursor update requested */
|
|
|
|
u8 failover_validation : 1;/* message replay due to failover */
|
|
|
|
u8 reserved : 3;
|
|
|
|
#elif defined(__LITTLE_ENDIAN_BITFIELD)
|
|
|
|
u8 reserved : 3;
|
|
|
|
u8 failover_validation : 1;
|
|
|
|
u8 cons_curs_upd_req : 1;
|
|
|
|
u8 urg_data_present : 1;
|
|
|
|
u8 urg_data_pending : 1;
|
|
|
|
u8 write_blocked : 1;
|
|
|
|
#endif
|
|
|
|
};
|
|
|
|
|
|
|
|
/* in host byte order */
|
|
|
|
union smc_host_cursor { /* SMC cursor - an offset in an RMBE */
|
|
|
|
struct {
|
|
|
|
u16 reserved;
|
|
|
|
u16 wrap; /* window wrap sequence number */
|
|
|
|
u32 count; /* cursor (= offset) part */
|
|
|
|
};
|
|
|
|
#ifdef KERNEL_HAS_ATOMIC64
|
|
|
|
atomic64_t acurs; /* for atomic processing */
|
|
|
|
#else
|
|
|
|
u64 acurs; /* for atomic processing */
|
|
|
|
#endif
|
|
|
|
} __aligned(8);
|
|
|
|
|
|
|
|
/* in host byte order, except for flag bitfields in network byte order */
|
|
|
|
struct smc_host_cdc_msg { /* Connection Data Control message */
|
|
|
|
struct smc_wr_rx_hdr common; /* .type = 0xFE */
|
|
|
|
u8 len; /* length = 44 */
|
|
|
|
u16 seqno; /* connection seq # */
|
|
|
|
u32 token; /* alert_token */
|
|
|
|
union smc_host_cursor prod; /* producer cursor */
|
|
|
|
union smc_host_cursor cons; /* consumer cursor,
|
|
|
|
* piggy backed "ack"
|
|
|
|
*/
|
|
|
|
struct smc_cdc_producer_flags prod_flags; /* conn. tx/rx status */
|
|
|
|
struct smc_cdc_conn_state_flags conn_state_flags; /* peer conn. status*/
|
|
|
|
u8 reserved[18];
|
|
|
|
} __aligned(8);
|
|
|
|
|
2017-01-09 23:55:17 +08:00
|
|
|
struct smc_connection {
|
|
|
|
struct rb_node alert_node;
|
|
|
|
struct smc_link_group *lgr; /* link group of connection */
|
|
|
|
u32 alert_token_local; /* unique conn. id */
|
2018-05-18 15:34:12 +08:00
|
|
|
u8 peer_rmbe_idx; /* from tcp handshake */
|
2017-01-09 23:55:18 +08:00
|
|
|
int peer_rmbe_size; /* size of peer rx buffer */
|
|
|
|
atomic_t peer_rmbe_space;/* remaining free bytes in peer
|
|
|
|
* rmbe
|
|
|
|
*/
|
2017-01-09 23:55:20 +08:00
|
|
|
int rtoken_idx; /* idx to peer RMB rkey/addr */
|
2017-01-09 23:55:18 +08:00
|
|
|
|
|
|
|
struct smc_buf_desc *sndbuf_desc; /* send buffer descriptor */
|
|
|
|
struct smc_buf_desc *rmb_desc; /* RMBE descriptor */
|
|
|
|
int rmbe_size_short;/* compressed notation */
|
2017-01-09 23:55:24 +08:00
|
|
|
int rmbe_update_limit;
|
|
|
|
/* lower limit for consumer
|
|
|
|
* cursor update
|
|
|
|
*/
|
2017-01-09 23:55:22 +08:00
|
|
|
|
|
|
|
struct smc_host_cdc_msg local_tx_ctrl; /* host byte order staging
|
|
|
|
* buffer for CDC msg send
|
|
|
|
* .prod cf. TCP snd_nxt
|
|
|
|
* .cons cf. TCP sends ack
|
|
|
|
*/
|
|
|
|
union smc_host_cursor tx_curs_prep; /* tx - prepared data
|
|
|
|
* snd_max..wmem_alloc
|
|
|
|
*/
|
|
|
|
union smc_host_cursor tx_curs_sent; /* tx - sent data
|
|
|
|
* snd_nxt ?
|
|
|
|
*/
|
|
|
|
union smc_host_cursor tx_curs_fin; /* tx - confirmed by peer
|
|
|
|
* snd-wnd-begin ?
|
|
|
|
*/
|
|
|
|
atomic_t sndbuf_space; /* remaining space in sndbuf */
|
|
|
|
u16 tx_cdc_seq; /* sequence # for CDC send */
|
|
|
|
spinlock_t send_lock; /* protect wr_sends */
|
2017-09-21 15:16:33 +08:00
|
|
|
struct delayed_work tx_work; /* retry of smc_cdc_msg_send */
|
2017-01-09 23:55:22 +08:00
|
|
|
|
|
|
|
struct smc_host_cdc_msg local_rx_ctrl; /* filled during event_handl.
|
|
|
|
* .prod cf. TCP rcv_nxt
|
|
|
|
* .cons cf. TCP snd_una
|
|
|
|
*/
|
|
|
|
union smc_host_cursor rx_curs_confirmed; /* confirmed to peer
|
|
|
|
* source of snd_una ?
|
|
|
|
*/
|
|
|
|
atomic_t bytes_to_rcv; /* arrived data,
|
|
|
|
* not yet received
|
|
|
|
*/
|
2018-05-04 00:12:39 +08:00
|
|
|
atomic_t splice_pending; /* number of spliced bytes
|
|
|
|
* pending processing
|
|
|
|
*/
|
2017-01-09 23:55:22 +08:00
|
|
|
#ifndef KERNEL_HAS_ATOMIC64
|
|
|
|
spinlock_t acurs_lock; /* protect cursors */
|
|
|
|
#endif
|
2017-04-10 20:58:01 +08:00
|
|
|
struct work_struct close_work; /* peer sent some closing */
|
2017-01-09 23:55:17 +08:00
|
|
|
};
|
|
|
|
|
2017-01-09 23:55:13 +08:00
|
|
|
struct smc_sock { /* smc sock container */
|
|
|
|
struct sock sk;
|
|
|
|
struct socket *clcsock; /* internal tcp socket */
|
2017-01-09 23:55:17 +08:00
|
|
|
struct smc_connection conn; /* smc connection */
|
2017-01-09 23:55:16 +08:00
|
|
|
struct smc_sock *listen_smc; /* listen parent */
|
|
|
|
struct work_struct tcp_listen_work;/* handle tcp socket accepts */
|
|
|
|
struct work_struct smc_listen_work;/* prepare new accept socket */
|
|
|
|
struct list_head accept_q; /* sockets to be accepted */
|
|
|
|
spinlock_t accept_q_lock; /* protects accept_q */
|
2017-01-09 23:55:13 +08:00
|
|
|
bool use_fallback; /* fallback to tcp */
|
2018-04-26 23:18:23 +08:00
|
|
|
int sockopt_defer_accept;
|
|
|
|
/* sockopt TCP_DEFER_ACCEPT
|
|
|
|
* value
|
|
|
|
*/
|
2017-01-09 23:55:25 +08:00
|
|
|
u8 wait_close_tx_prepared : 1;
|
|
|
|
/* shutdown wr or close
|
|
|
|
* started, waiting for unsent
|
|
|
|
* data to be sent
|
|
|
|
*/
|
2017-01-09 23:55:13 +08:00
|
|
|
};
|
|
|
|
|
|
|
|
static inline struct smc_sock *smc_sk(const struct sock *sk)
|
|
|
|
{
|
|
|
|
return (struct smc_sock *)sk;
|
|
|
|
}
|
|
|
|
|
2017-01-09 23:55:14 +08:00
|
|
|
#define SMC_SYSTEMID_LEN 8
|
|
|
|
|
|
|
|
extern u8 local_systemid[SMC_SYSTEMID_LEN]; /* unique system identifier */
|
|
|
|
|
2017-01-09 23:55:17 +08:00
|
|
|
/* convert an u32 value into network byte order, store it into a 3 byte field */
|
|
|
|
static inline void hton24(u8 *net, u32 host)
|
|
|
|
{
|
|
|
|
__be32 t;
|
|
|
|
|
|
|
|
t = cpu_to_be32(host);
|
|
|
|
memcpy(net, ((u8 *)&t) + 1, 3);
|
|
|
|
}
|
|
|
|
|
|
|
|
/* convert a received 3 byte field into host byte order*/
|
|
|
|
static inline u32 ntoh24(u8 *net)
|
|
|
|
{
|
|
|
|
__be32 t = 0;
|
|
|
|
|
|
|
|
memcpy(((u8 *)&t) + 1, net, 3);
|
|
|
|
return be32_to_cpu(t);
|
|
|
|
}
|
|
|
|
|
2017-01-09 23:55:18 +08:00
|
|
|
#define SMC_BUF_MIN_SIZE 16384 /* minimum size of an RMB */
|
|
|
|
|
|
|
|
#define SMC_RMBE_SIZES 16 /* number of distinct sizes for an RMBE */
|
|
|
|
/* theoretically, the RFC states that largest size would be 512K,
|
|
|
|
* i.e. compressed 5 and thus 6 sizes (0..5), despite
|
|
|
|
* struct smc_clc_msg_accept_confirm.rmbe_size being a 4 bit value (0..15)
|
|
|
|
*/
|
|
|
|
|
|
|
|
/* convert the RMB size into the compressed notation - minimum 16K.
|
|
|
|
* In contrast to plain ilog2, this rounds towards the next power of 2,
|
|
|
|
* so the socket application gets at least its desired sndbuf / rcvbuf size.
|
|
|
|
*/
|
|
|
|
static inline u8 smc_compress_bufsize(int size)
|
|
|
|
{
|
|
|
|
u8 compressed;
|
|
|
|
|
|
|
|
if (size <= SMC_BUF_MIN_SIZE)
|
|
|
|
return 0;
|
|
|
|
|
|
|
|
size = (size - 1) >> 14;
|
|
|
|
compressed = ilog2(size) + 1;
|
|
|
|
if (compressed >= SMC_RMBE_SIZES)
|
|
|
|
compressed = SMC_RMBE_SIZES - 1;
|
|
|
|
return compressed;
|
|
|
|
}
|
|
|
|
|
|
|
|
/* convert the RMB size from compressed notation into integer */
|
|
|
|
static inline int smc_uncompress_bufsize(u8 compressed)
|
|
|
|
{
|
|
|
|
u32 size;
|
|
|
|
|
|
|
|
size = 0x00000001 << (((int)compressed) + 14);
|
|
|
|
return (int)size;
|
|
|
|
}
|
|
|
|
|
2017-01-09 23:55:16 +08:00
|
|
|
#ifdef CONFIG_XFRM
|
|
|
|
static inline bool using_ipsec(struct smc_sock *smc)
|
|
|
|
{
|
|
|
|
return (smc->clcsock->sk->sk_policy[0] ||
|
2018-01-26 16:28:50 +08:00
|
|
|
smc->clcsock->sk->sk_policy[1]) ? true : false;
|
2017-01-09 23:55:16 +08:00
|
|
|
}
|
|
|
|
#else
|
|
|
|
static inline bool using_ipsec(struct smc_sock *smc)
|
|
|
|
{
|
2018-01-26 16:28:50 +08:00
|
|
|
return false;
|
2017-01-09 23:55:16 +08:00
|
|
|
}
|
|
|
|
#endif
|
|
|
|
|
2017-01-09 23:55:17 +08:00
|
|
|
struct smc_clc_msg_local;
|
|
|
|
|
|
|
|
void smc_conn_free(struct smc_connection *conn);
|
2018-03-01 20:51:28 +08:00
|
|
|
int smc_conn_create(struct smc_sock *smc,
|
2017-01-09 23:55:17 +08:00
|
|
|
struct smc_ib_device *smcibdev, u8 ibport,
|
|
|
|
struct smc_clc_msg_local *lcl, int srv_first_contact);
|
2017-01-09 23:55:25 +08:00
|
|
|
struct sock *smc_accept_dequeue(struct sock *parent, struct socket *new_sock);
|
|
|
|
void smc_close_non_accepted(struct sock *sk);
|
2017-01-09 23:55:16 +08:00
|
|
|
|
2017-01-09 23:55:13 +08:00
|
|
|
#endif /* __SMC_H */
|