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 17:07:57 +03:00
// SPDX-License-Identifier: GPL-2.0
2005-11-10 04:25:51 +03:00
/*
* NETLINK Netlink attributes
*
* Authors : Thomas Graf < tgraf @ suug . ch >
* Alexey Kuznetsov < kuznet @ ms2 . inr . ac . ru >
*/
2011-11-17 06:29:17 +04:00
# include <linux/export.h>
2005-11-10 04:25:51 +03:00
# include <linux/kernel.h>
# include <linux/errno.h>
# include <linux/jiffies.h>
# include <linux/skbuff.h>
# include <linux/string.h>
# include <linux/types.h>
# include <net/netlink.h>
2017-12-07 07:09:12 +03:00
/* For these data types, attribute length should be exactly the given
* size . However , to maintain compatibility with broken commands , if the
* attribute length does not match the expected size a warning is emitted
* to the user that the command is sending invalid data and needs to be fixed .
*/
2017-11-08 08:59:40 +03:00
static const u8 nla_attr_len [ NLA_TYPE_MAX + 1 ] = {
2005-11-10 04:25:51 +03:00
[ NLA_U8 ] = sizeof ( u8 ) ,
[ NLA_U16 ] = sizeof ( u16 ) ,
[ NLA_U32 ] = sizeof ( u32 ) ,
[ NLA_U64 ] = sizeof ( u64 ) ,
2012-08-26 02:47:57 +04:00
[ NLA_S8 ] = sizeof ( s8 ) ,
[ NLA_S16 ] = sizeof ( s16 ) ,
[ NLA_S32 ] = sizeof ( s32 ) ,
[ NLA_S64 ] = sizeof ( s64 ) ,
2005-11-10 04:25:51 +03:00
} ;
2017-11-08 08:59:40 +03:00
static const u8 nla_attr_minlen [ NLA_TYPE_MAX + 1 ] = {
2017-12-07 07:09:12 +03:00
[ NLA_U8 ] = sizeof ( u8 ) ,
[ NLA_U16 ] = sizeof ( u16 ) ,
[ NLA_U32 ] = sizeof ( u32 ) ,
[ NLA_U64 ] = sizeof ( u64 ) ,
2017-11-08 08:59:40 +03:00
[ NLA_MSECS ] = sizeof ( u64 ) ,
[ NLA_NESTED ] = NLA_HDRLEN ,
2017-12-07 07:09:12 +03:00
[ NLA_S8 ] = sizeof ( s8 ) ,
[ NLA_S16 ] = sizeof ( s16 ) ,
[ NLA_S32 ] = sizeof ( s32 ) ,
[ NLA_S64 ] = sizeof ( s64 ) ,
2017-11-08 08:59:40 +03:00
} ;
2017-07-30 20:24:49 +03:00
static int validate_nla_bitfield32 ( const struct nlattr * nla ,
2018-09-26 12:15:31 +03:00
const u32 * valid_flags_mask )
2017-07-30 20:24:49 +03:00
{
const struct nla_bitfield32 * bf = nla_data ( nla ) ;
2018-09-26 12:15:31 +03:00
if ( ! valid_flags_mask )
2017-07-30 20:24:49 +03:00
return - EINVAL ;
/*disallow invalid bit selector */
if ( bf - > selector & ~ * valid_flags_mask )
return - EINVAL ;
/*disallow invalid bit values */
if ( bf - > value & ~ * valid_flags_mask )
return - EINVAL ;
/*disallow valid bit values that are not selected*/
if ( bf - > value & ~ bf - > selector )
return - EINVAL ;
return 0 ;
}
2018-09-26 12:15:34 +03:00
static int nla_validate_array ( const struct nlattr * head , int len , int maxtype ,
const struct nla_policy * policy ,
struct netlink_ext_ack * extack )
{
const struct nlattr * entry ;
int rem ;
nla_for_each_attr ( entry , head , len , rem ) {
int ret ;
if ( nla_len ( entry ) = = 0 )
continue ;
if ( nla_len ( entry ) < NLA_HDRLEN ) {
NL_SET_ERR_MSG_ATTR ( extack , entry ,
" Array element too short " ) ;
return - ERANGE ;
}
ret = nla_validate ( nla_data ( entry ) , nla_len ( entry ) ,
maxtype , policy , extack ) ;
if ( ret < 0 )
return ret ;
}
return 0 ;
}
netlink: add attribute range validation to policy
Without further bloating the policy structs, we can overload
the `validation_data' pointer with a struct of s16 min, max
and use those to validate ranges in NLA_{U,S}{8,16,32,64}
attributes.
It may sound strange to validate NLA_U32 with a s16 max, but
in many cases NLA_U32 is used for enums etc. since there's no
size benefit in using a smaller attribute width anyway, due
to netlink attribute alignment; in cases like that it's still
useful, particularly when the attribute really transports an
enum value.
Doing so lets us remove quite a bit of validation code, if we
can be sure that these attributes aren't used by userspace in
places where they're ignored today.
To achieve all this, split the 'type' field and introduce a
new 'validation_type' field which indicates what further
validation (beyond the validation prescribed by the type of
the attribute) is done. This currently allows for no further
validation (the default), as well as min, max and range checks.
Signed-off-by: Johannes Berg <johannes.berg@intel.com>
Signed-off-by: David S. Miller <davem@davemloft.net>
2018-09-27 12:28:35 +03:00
static int nla_validate_int_range ( const struct nla_policy * pt ,
const struct nlattr * nla ,
struct netlink_ext_ack * extack )
{
bool validate_min , validate_max ;
s64 value ;
validate_min = pt - > validation_type = = NLA_VALIDATE_RANGE | |
pt - > validation_type = = NLA_VALIDATE_MIN ;
validate_max = pt - > validation_type = = NLA_VALIDATE_RANGE | |
pt - > validation_type = = NLA_VALIDATE_MAX ;
switch ( pt - > type ) {
case NLA_U8 :
value = nla_get_u8 ( nla ) ;
break ;
case NLA_U16 :
value = nla_get_u16 ( nla ) ;
break ;
case NLA_U32 :
value = nla_get_u32 ( nla ) ;
break ;
case NLA_S8 :
value = nla_get_s8 ( nla ) ;
break ;
case NLA_S16 :
value = nla_get_s16 ( nla ) ;
break ;
case NLA_S32 :
value = nla_get_s32 ( nla ) ;
break ;
case NLA_S64 :
value = nla_get_s64 ( nla ) ;
break ;
case NLA_U64 :
/* treat this one specially, since it may not fit into s64 */
if ( ( validate_min & & nla_get_u64 ( nla ) < pt - > min ) | |
( validate_max & & nla_get_u64 ( nla ) > pt - > max ) ) {
NL_SET_ERR_MSG_ATTR ( extack , nla ,
" integer out of range " ) ;
return - ERANGE ;
}
return 0 ;
default :
WARN_ON ( 1 ) ;
return - EINVAL ;
}
if ( ( validate_min & & value < pt - > min ) | |
( validate_max & & value > pt - > max ) ) {
NL_SET_ERR_MSG_ATTR ( extack , nla ,
" integer out of range " ) ;
return - ERANGE ;
}
return 0 ;
}
2010-11-16 20:52:32 +03:00
static int validate_nla ( const struct nlattr * nla , int maxtype ,
2018-09-17 12:57:28 +03:00
const struct nla_policy * policy ,
2018-09-26 12:15:32 +03:00
struct netlink_ext_ack * extack )
2005-11-10 04:25:51 +03:00
{
2007-06-05 23:38:30 +04:00
const struct nla_policy * pt ;
2007-09-12 16:44:36 +04:00
int minlen = 0 , attrlen = nla_len ( nla ) , type = nla_type ( nla ) ;
2018-09-26 12:15:32 +03:00
int err = - ERANGE ;
2005-11-10 04:25:51 +03:00
2007-09-12 16:44:36 +04:00
if ( type < = 0 | | type > maxtype )
2005-11-10 04:25:51 +03:00
return 0 ;
2007-09-12 16:44:36 +04:00
pt = & policy [ type ] ;
2005-11-10 04:25:51 +03:00
BUG_ON ( pt - > type > NLA_TYPE_MAX ) ;
2018-09-17 12:57:29 +03:00
if ( ( nla_attr_len [ pt - > type ] & & attrlen ! = nla_attr_len [ pt - > type ] ) | |
( pt - > type = = NLA_EXACT_LEN_WARN & & attrlen ! = pt - > len ) ) {
2017-12-07 07:09:12 +03:00
pr_warn_ratelimited ( " netlink: '%s': attribute type %d has an invalid length. \n " ,
current - > comm , type ) ;
2017-11-08 08:59:40 +03:00
}
2006-08-27 07:11:47 +04:00
switch ( pt - > type ) {
2018-09-17 12:57:29 +03:00
case NLA_EXACT_LEN :
if ( attrlen ! = pt - > len )
2018-09-26 12:15:32 +03:00
goto out_err ;
2018-09-17 12:57:29 +03:00
break ;
2018-09-17 12:57:28 +03:00
case NLA_REJECT :
2018-09-26 12:15:32 +03:00
if ( extack & & pt - > validation_data ) {
NL_SET_BAD_ATTR ( extack , nla ) ;
extack - > _msg = pt - > validation_data ;
return - EINVAL ;
}
err = - EINVAL ;
goto out_err ;
2018-09-17 12:57:28 +03:00
2006-08-27 07:11:47 +04:00
case NLA_FLAG :
if ( attrlen > 0 )
2018-09-26 12:15:32 +03:00
goto out_err ;
2006-08-27 07:11:47 +04:00
break ;
2005-11-10 04:25:51 +03:00
2017-07-30 20:24:49 +03:00
case NLA_BITFIELD32 :
if ( attrlen ! = sizeof ( struct nla_bitfield32 ) )
2018-09-26 12:15:32 +03:00
goto out_err ;
2017-07-30 20:24:49 +03:00
2018-09-26 12:15:32 +03:00
err = validate_nla_bitfield32 ( nla , pt - > validation_data ) ;
if ( err )
goto out_err ;
break ;
2017-07-30 20:24:49 +03:00
2006-08-27 07:11:47 +04:00
case NLA_NUL_STRING :
if ( pt - > len )
minlen = min_t ( int , attrlen , pt - > len + 1 ) ;
else
minlen = attrlen ;
2005-11-10 04:25:51 +03:00
2018-09-26 12:15:32 +03:00
if ( ! minlen | | memchr ( nla_data ( nla ) , ' \0 ' , minlen ) = = NULL ) {
err = - EINVAL ;
goto out_err ;
}
2006-08-27 07:11:47 +04:00
/* fall through */
case NLA_STRING :
if ( attrlen < 1 )
2018-09-26 12:15:32 +03:00
goto out_err ;
2006-08-27 07:11:47 +04:00
if ( pt - > len ) {
char * buf = nla_data ( nla ) ;
if ( buf [ attrlen - 1 ] = = ' \0 ' )
attrlen - - ;
if ( attrlen > pt - > len )
2018-09-26 12:15:32 +03:00
goto out_err ;
2006-08-27 07:11:47 +04:00
}
break ;
2007-03-23 21:37:48 +03:00
case NLA_BINARY :
if ( pt - > len & & attrlen > pt - > len )
2018-09-26 12:15:32 +03:00
goto out_err ;
2007-03-23 21:37:48 +03:00
break ;
2008-11-28 14:05:19 +03:00
case NLA_NESTED :
/* a nested attributes is allowed to be empty; if its not,
* it must have a size of at least NLA_HDRLEN .
*/
if ( attrlen = = 0 )
break ;
2018-09-26 12:15:33 +03:00
if ( attrlen < NLA_HDRLEN )
goto out_err ;
if ( pt - > validation_data ) {
err = nla_validate ( nla_data ( nla ) , nla_len ( nla ) , pt - > len ,
pt - > validation_data , extack ) ;
if ( err < 0 ) {
/*
* return directly to preserve the inner
* error message / attribute pointer
*/
return err ;
}
}
break ;
2018-09-26 12:15:34 +03:00
case NLA_NESTED_ARRAY :
/* a nested array attribute is allowed to be empty; if its not,
* it must have a size of at least NLA_HDRLEN .
*/
if ( attrlen = = 0 )
break ;
if ( attrlen < NLA_HDRLEN )
goto out_err ;
if ( pt - > validation_data ) {
int err ;
err = nla_validate_array ( nla_data ( nla ) , nla_len ( nla ) ,
pt - > len , pt - > validation_data ,
extack ) ;
if ( err < 0 ) {
/*
* return directly to preserve the inner
* error message / attribute pointer
*/
return err ;
}
}
break ;
2006-08-27 07:11:47 +04:00
default :
if ( pt - > len )
minlen = pt - > len ;
else if ( pt - > type ! = NLA_UNSPEC )
minlen = nla_attr_minlen [ pt - > type ] ;
if ( attrlen < minlen )
2018-09-26 12:15:32 +03:00
goto out_err ;
2006-08-27 07:11:47 +04:00
}
2005-11-10 04:25:51 +03:00
netlink: add attribute range validation to policy
Without further bloating the policy structs, we can overload
the `validation_data' pointer with a struct of s16 min, max
and use those to validate ranges in NLA_{U,S}{8,16,32,64}
attributes.
It may sound strange to validate NLA_U32 with a s16 max, but
in many cases NLA_U32 is used for enums etc. since there's no
size benefit in using a smaller attribute width anyway, due
to netlink attribute alignment; in cases like that it's still
useful, particularly when the attribute really transports an
enum value.
Doing so lets us remove quite a bit of validation code, if we
can be sure that these attributes aren't used by userspace in
places where they're ignored today.
To achieve all this, split the 'type' field and introduce a
new 'validation_type' field which indicates what further
validation (beyond the validation prescribed by the type of
the attribute) is done. This currently allows for no further
validation (the default), as well as min, max and range checks.
Signed-off-by: Johannes Berg <johannes.berg@intel.com>
Signed-off-by: David S. Miller <davem@davemloft.net>
2018-09-27 12:28:35 +03:00
/* further validation */
switch ( pt - > validation_type ) {
case NLA_VALIDATE_NONE :
/* nothing to do */
break ;
case NLA_VALIDATE_RANGE :
case NLA_VALIDATE_MIN :
case NLA_VALIDATE_MAX :
err = nla_validate_int_range ( pt , nla , extack ) ;
if ( err )
return err ;
break ;
2018-09-27 12:28:36 +03:00
case NLA_VALIDATE_FUNCTION :
if ( pt - > validate ) {
err = pt - > validate ( nla , extack ) ;
if ( err )
return err ;
}
break ;
netlink: add attribute range validation to policy
Without further bloating the policy structs, we can overload
the `validation_data' pointer with a struct of s16 min, max
and use those to validate ranges in NLA_{U,S}{8,16,32,64}
attributes.
It may sound strange to validate NLA_U32 with a s16 max, but
in many cases NLA_U32 is used for enums etc. since there's no
size benefit in using a smaller attribute width anyway, due
to netlink attribute alignment; in cases like that it's still
useful, particularly when the attribute really transports an
enum value.
Doing so lets us remove quite a bit of validation code, if we
can be sure that these attributes aren't used by userspace in
places where they're ignored today.
To achieve all this, split the 'type' field and introduce a
new 'validation_type' field which indicates what further
validation (beyond the validation prescribed by the type of
the attribute) is done. This currently allows for no further
validation (the default), as well as min, max and range checks.
Signed-off-by: Johannes Berg <johannes.berg@intel.com>
Signed-off-by: David S. Miller <davem@davemloft.net>
2018-09-27 12:28:35 +03:00
}
2005-11-10 04:25:51 +03:00
return 0 ;
2018-09-26 12:15:32 +03:00
out_err :
NL_SET_ERR_MSG_ATTR ( extack , nla , " Attribute failed policy validation " ) ;
return err ;
2005-11-10 04:25:51 +03:00
}
/**
* nla_validate - Validate a stream of attributes
* @ head : head of attribute stream
* @ len : length of attribute stream
* @ maxtype : maximum attribute type to be expected
* @ policy : validation policy
2017-04-12 15:34:07 +03:00
* @ extack : extended ACK report struct
2005-11-10 04:25:51 +03:00
*
* Validates all attributes in the specified attribute stream against the
* specified policy . Attributes with a type exceeding maxtype will be
* ignored . See documenation of struct nla_policy for more details .
*
* Returns 0 on success or a negative error code .
*/
2010-11-16 20:52:32 +03:00
int nla_validate ( const struct nlattr * head , int len , int maxtype ,
2017-04-12 15:34:07 +03:00
const struct nla_policy * policy ,
struct netlink_ext_ack * extack )
2005-11-10 04:25:51 +03:00
{
2010-11-16 20:52:32 +03:00
const struct nlattr * nla ;
2017-04-12 15:34:07 +03:00
int rem ;
2005-11-10 04:25:51 +03:00
nla_for_each_attr ( nla , head , len , rem ) {
2018-09-26 12:15:32 +03:00
int err = validate_nla ( nla , maxtype , policy , extack ) ;
2017-04-12 15:34:07 +03:00
2018-09-26 12:15:32 +03:00
if ( err < 0 )
2017-04-12 15:34:07 +03:00
return err ;
2005-11-10 04:25:51 +03:00
}
2017-04-12 15:34:07 +03:00
return 0 ;
2005-11-10 04:25:51 +03:00
}
2014-06-05 03:11:57 +04:00
EXPORT_SYMBOL ( nla_validate ) ;
2005-11-10 04:25:51 +03:00
2009-03-25 20:26:30 +03:00
/**
* nla_policy_len - Determin the max . length of a policy
* @ policy : policy to use
* @ n : number of policies
*
* Determines the max . length of the policy . It is currently used
* to allocated Netlink buffers roughly the size of the actual
* message .
*
* Returns 0 on success or a negative error code .
*/
int
nla_policy_len ( const struct nla_policy * p , int n )
{
int i , len = 0 ;
2011-02-28 23:38:25 +03:00
for ( i = 0 ; i < n ; i + + , p + + ) {
2009-03-25 20:26:30 +03:00
if ( p - > len )
len + = nla_total_size ( p - > len ) ;
2017-11-08 08:59:40 +03:00
else if ( nla_attr_len [ p - > type ] )
len + = nla_total_size ( nla_attr_len [ p - > type ] ) ;
2009-03-25 20:26:30 +03:00
else if ( nla_attr_minlen [ p - > type ] )
len + = nla_total_size ( nla_attr_minlen [ p - > type ] ) ;
}
return len ;
}
2014-06-05 03:11:57 +04:00
EXPORT_SYMBOL ( nla_policy_len ) ;
2009-03-25 20:26:30 +03:00
2005-11-10 04:25:51 +03:00
/**
* nla_parse - Parse a stream of attributes into a tb buffer
* @ tb : destination array with maxtype + 1 elements
* @ maxtype : maximum attribute type to be expected
* @ head : head of attribute stream
* @ len : length of attribute stream
2008-06-28 07:02:14 +04:00
* @ policy : validation policy
2005-11-10 04:25:51 +03:00
*
* Parses a stream of attributes and stores a pointer to each attribute in
tree-wide: fix comment/printk typos
"gadget", "through", "command", "maintain", "maintain", "controller", "address",
"between", "initiali[zs]e", "instead", "function", "select", "already",
"equal", "access", "management", "hierarchy", "registration", "interest",
"relative", "memory", "offset", "already",
Signed-off-by: Uwe Kleine-König <u.kleine-koenig@pengutronix.de>
Signed-off-by: Jiri Kosina <jkosina@suse.cz>
2010-11-01 22:38:34 +03:00
* the tb array accessible via the attribute type . Attributes with a type
2005-11-10 04:25:51 +03:00
* exceeding maxtype will be silently ignored for backwards compatibility
* reasons . policy may be set to NULL if no validation is required .
*
* Returns 0 on success or a negative error code .
*/
2018-10-08 06:16:25 +03:00
static int __nla_parse ( struct nlattr * * tb , int maxtype ,
const struct nlattr * head , int len ,
bool strict , const struct nla_policy * policy ,
struct netlink_ext_ack * extack )
2005-11-10 04:25:51 +03:00
{
2010-11-16 20:52:32 +03:00
const struct nlattr * nla ;
2018-09-26 12:15:32 +03:00
int rem ;
2005-11-10 04:25:51 +03:00
memset ( tb , 0 , sizeof ( struct nlattr * ) * ( maxtype + 1 ) ) ;
nla_for_each_attr ( nla , head , len , rem ) {
2007-09-12 16:44:36 +04:00
u16 type = nla_type ( nla ) ;
2005-11-10 04:25:51 +03:00
2018-10-08 06:16:25 +03:00
if ( type = = 0 | | type > maxtype ) {
if ( strict ) {
NL_SET_ERR_MSG ( extack , " Unknown attribute type " ) ;
return - EINVAL ;
2005-11-10 04:25:51 +03:00
}
2018-10-08 06:16:25 +03:00
continue ;
}
if ( policy ) {
int err = validate_nla ( nla , maxtype , policy , extack ) ;
2005-11-10 04:25:51 +03:00
2018-10-08 06:16:25 +03:00
if ( err < 0 )
return err ;
2005-11-10 04:25:51 +03:00
}
2018-10-08 06:16:25 +03:00
tb [ type ] = ( struct nlattr * ) nla ;
2005-11-10 04:25:51 +03:00
}
2018-10-08 06:16:25 +03:00
if ( unlikely ( rem > 0 ) ) {
2014-06-02 20:25:02 +04:00
pr_warn_ratelimited ( " netlink: %d bytes leftover after parsing attributes in process `%s'. \n " ,
rem , current - > comm ) ;
2018-10-08 06:16:25 +03:00
NL_SET_ERR_MSG ( extack , " bytes leftover after parsing attributes " ) ;
if ( strict )
return - EINVAL ;
}
2005-11-10 04:25:51 +03:00
2018-09-26 12:15:32 +03:00
return 0 ;
2005-11-10 04:25:51 +03:00
}
2018-10-08 06:16:25 +03:00
int nla_parse ( struct nlattr * * tb , int maxtype , const struct nlattr * head ,
int len , const struct nla_policy * policy ,
struct netlink_ext_ack * extack )
{
return __nla_parse ( tb , maxtype , head , len , false , policy , extack ) ;
}
2014-06-05 03:11:57 +04:00
EXPORT_SYMBOL ( nla_parse ) ;
2005-11-10 04:25:51 +03:00
2018-10-08 06:16:25 +03:00
int nla_parse_strict ( struct nlattr * * tb , int maxtype , const struct nlattr * head ,
int len , const struct nla_policy * policy ,
struct netlink_ext_ack * extack )
{
return __nla_parse ( tb , maxtype , head , len , true , policy , extack ) ;
}
EXPORT_SYMBOL ( nla_parse_strict ) ;
2005-11-10 04:25:51 +03:00
/**
* nla_find - Find a specific attribute in a stream of attributes
* @ head : head of attribute stream
* @ len : length of attribute stream
* @ attrtype : type of attribute to look for
*
* Returns the first attribute in the stream matching the specified type .
*/
2010-11-16 20:52:32 +03:00
struct nlattr * nla_find ( const struct nlattr * head , int len , int attrtype )
2005-11-10 04:25:51 +03:00
{
2010-11-16 20:52:32 +03:00
const struct nlattr * nla ;
2005-11-10 04:25:51 +03:00
int rem ;
nla_for_each_attr ( nla , head , len , rem )
2007-09-12 16:44:36 +04:00
if ( nla_type ( nla ) = = attrtype )
2010-11-16 20:52:32 +03:00
return ( struct nlattr * ) nla ;
2005-11-10 04:25:51 +03:00
return NULL ;
}
2014-06-05 03:11:57 +04:00
EXPORT_SYMBOL ( nla_find ) ;
2005-11-10 04:25:51 +03:00
/**
* nla_strlcpy - Copy string attribute payload into a sized buffer
* @ dst : where to copy the string to
2008-06-28 07:02:14 +04:00
* @ nla : attribute to copy the string from
2005-11-10 04:25:51 +03:00
* @ dstsize : size of destination buffer
*
* Copies at most dstsize - 1 bytes into the destination buffer .
* The result is always a valid NUL - terminated string . Unlike
* strlcpy the destination buffer is always padded out .
*
* Returns the length of the source buffer .
*/
size_t nla_strlcpy ( char * dst , const struct nlattr * nla , size_t dstsize )
{
size_t srclen = nla_len ( nla ) ;
char * src = nla_data ( nla ) ;
if ( srclen > 0 & & src [ srclen - 1 ] = = ' \0 ' )
srclen - - ;
if ( dstsize > 0 ) {
size_t len = ( srclen > = dstsize ) ? dstsize - 1 : srclen ;
memset ( dst , 0 , dstsize ) ;
memcpy ( dst , src , len ) ;
}
return srclen ;
}
2014-06-05 03:11:57 +04:00
EXPORT_SYMBOL ( nla_strlcpy ) ;
2005-11-10 04:25:51 +03:00
2017-07-27 17:56:40 +03:00
/**
* nla_strdup - Copy string attribute payload into a newly allocated buffer
* @ nla : attribute to copy the string from
* @ flags : the type of memory to allocate ( see kmalloc ) .
*
* Returns a pointer to the allocated buffer or NULL on error .
*/
char * nla_strdup ( const struct nlattr * nla , gfp_t flags )
{
size_t srclen = nla_len ( nla ) ;
char * src = nla_data ( nla ) , * dst ;
if ( srclen > 0 & & src [ srclen - 1 ] = = ' \0 ' )
srclen - - ;
dst = kmalloc ( srclen + 1 , flags ) ;
if ( dst ! = NULL ) {
memcpy ( dst , src , srclen ) ;
dst [ srclen ] = ' \0 ' ;
}
return dst ;
}
EXPORT_SYMBOL ( nla_strdup ) ;
2005-11-10 04:25:51 +03:00
/**
* nla_memcpy - Copy a netlink attribute into another memory area
* @ dest : where to copy to memcpy
* @ src : netlink attribute to copy from
* @ count : size of the destination area
*
* Note : The number of bytes copied is limited by the length of
* attribute ' s payload . memcpy
*
* Returns the number of bytes copied .
*/
2008-10-28 21:59:11 +03:00
int nla_memcpy ( void * dest , const struct nlattr * src , int count )
2005-11-10 04:25:51 +03:00
{
int minlen = min_t ( int , count , nla_len ( src ) ) ;
memcpy ( dest , nla_data ( src ) , minlen ) ;
2015-03-29 17:05:28 +03:00
if ( count > minlen )
memset ( dest + minlen , 0 , count - minlen ) ;
2005-11-10 04:25:51 +03:00
return minlen ;
}
2014-06-05 03:11:57 +04:00
EXPORT_SYMBOL ( nla_memcpy ) ;
2005-11-10 04:25:51 +03:00
/**
* nla_memcmp - Compare an attribute with sized memory area
* @ nla : netlink attribute
* @ data : memory area
* @ size : size of memory area
*/
int nla_memcmp ( const struct nlattr * nla , const void * data ,
size_t size )
{
int d = nla_len ( nla ) - size ;
if ( d = = 0 )
d = memcmp ( nla_data ( nla ) , data , size ) ;
return d ;
}
2014-06-05 03:11:57 +04:00
EXPORT_SYMBOL ( nla_memcmp ) ;
2005-11-10 04:25:51 +03:00
/**
* nla_strcmp - Compare a string attribute against a string
* @ nla : netlink string attribute
* @ str : another string
*/
int nla_strcmp ( const struct nlattr * nla , const char * str )
{
2014-04-01 21:38:44 +04:00
int len = strlen ( str ) ;
char * buf = nla_data ( nla ) ;
int attrlen = nla_len ( nla ) ;
int d ;
2005-11-10 04:25:51 +03:00
2014-04-01 21:38:44 +04:00
if ( attrlen > 0 & & buf [ attrlen - 1 ] = = ' \0 ' )
attrlen - - ;
d = attrlen - len ;
2005-11-10 04:25:51 +03:00
if ( d = = 0 )
d = memcmp ( nla_data ( nla ) , str , len ) ;
return d ;
}
2014-06-05 03:11:57 +04:00
EXPORT_SYMBOL ( nla_strcmp ) ;
2005-11-10 04:25:51 +03:00
2009-03-11 18:18:32 +03:00
# ifdef CONFIG_NET
2005-11-10 04:25:51 +03:00
/**
* __nla_reserve - reserve room for attribute on the skb
* @ skb : socket buffer to reserve room on
* @ attrtype : attribute type
* @ attrlen : length of attribute payload
*
* Adds a netlink attribute header to a socket buffer and reserves
* room for the payload but does not copy it .
*
* The caller is responsible to ensure that the skb provides enough
* tailroom for the attribute header and payload .
*/
struct nlattr * __nla_reserve ( struct sk_buff * skb , int attrtype , int attrlen )
{
struct nlattr * nla ;
networking: make skb_put & friends return void pointers
It seems like a historic accident that these return unsigned char *,
and in many places that means casts are required, more often than not.
Make these functions (skb_put, __skb_put and pskb_put) return void *
and remove all the casts across the tree, adding a (u8 *) cast only
where the unsigned char pointer was used directly, all done with the
following spatch:
@@
expression SKB, LEN;
typedef u8;
identifier fn = { skb_put, __skb_put };
@@
- *(fn(SKB, LEN))
+ *(u8 *)fn(SKB, LEN)
@@
expression E, SKB, LEN;
identifier fn = { skb_put, __skb_put };
type T;
@@
- E = ((T *)(fn(SKB, LEN)))
+ E = fn(SKB, LEN)
which actually doesn't cover pskb_put since there are only three
users overall.
A handful of stragglers were converted manually, notably a macro in
drivers/isdn/i4l/isdn_bsdcomp.c and, oddly enough, one of the many
instances in net/bluetooth/hci_sock.c. In the former file, I also
had to fix one whitespace problem spatch introduced.
Signed-off-by: Johannes Berg <johannes.berg@intel.com>
Signed-off-by: David S. Miller <davem@davemloft.net>
2017-06-16 15:29:21 +03:00
nla = skb_put ( skb , nla_total_size ( attrlen ) ) ;
2005-11-10 04:25:51 +03:00
nla - > nla_type = attrtype ;
nla - > nla_len = nla_attr_size ( attrlen ) ;
memset ( ( unsigned char * ) nla + nla - > nla_len , 0 , nla_padlen ( attrlen ) ) ;
return nla ;
}
2009-03-11 18:18:32 +03:00
EXPORT_SYMBOL ( __nla_reserve ) ;
2005-11-10 04:25:51 +03:00
2016-04-21 19:58:24 +03:00
/**
* __nla_reserve_64bit - reserve room for attribute on the skb and align it
* @ skb : socket buffer to reserve room on
* @ attrtype : attribute type
* @ attrlen : length of attribute payload
2016-04-22 18:31:16 +03:00
* @ padattr : attribute type for the padding
2016-04-21 19:58:24 +03:00
*
* Adds a netlink attribute header to a socket buffer and reserves
* room for the payload but does not copy it . It also ensure that this
2016-04-22 18:31:16 +03:00
* attribute will have a 64 - bit aligned nla_data ( ) area .
2016-04-21 19:58:24 +03:00
*
* The caller is responsible to ensure that the skb provides enough
* tailroom for the attribute header and payload .
*/
struct nlattr * __nla_reserve_64bit ( struct sk_buff * skb , int attrtype ,
int attrlen , int padattr )
{
if ( nla_need_padding_for_64bit ( skb ) )
nla_align_64bit ( skb , padattr ) ;
return __nla_reserve ( skb , attrtype , attrlen ) ;
}
EXPORT_SYMBOL ( __nla_reserve_64bit ) ;
2006-08-05 10:03:05 +04:00
/**
* __nla_reserve_nohdr - reserve room for attribute without header
* @ skb : socket buffer to reserve room on
* @ attrlen : length of attribute payload
*
* Reserves room for attribute payload without a header .
*
* The caller is responsible to ensure that the skb provides enough
* tailroom for the payload .
*/
void * __nla_reserve_nohdr ( struct sk_buff * skb , int attrlen )
{
2017-06-18 17:52:04 +03:00
return skb_put_zero ( skb , NLA_ALIGN ( attrlen ) ) ;
2006-08-05 10:03:05 +04:00
}
2009-03-11 18:18:32 +03:00
EXPORT_SYMBOL ( __nla_reserve_nohdr ) ;
2006-08-05 10:03:05 +04:00
2005-11-10 04:25:51 +03:00
/**
* nla_reserve - reserve room for attribute on the skb
* @ skb : socket buffer to reserve room on
* @ attrtype : attribute type
* @ attrlen : length of attribute payload
*
* Adds a netlink attribute header to a socket buffer and reserves
* room for the payload but does not copy it .
*
* Returns NULL if the tailroom of the skb is insufficient to store
* the attribute header and payload .
*/
struct nlattr * nla_reserve ( struct sk_buff * skb , int attrtype , int attrlen )
{
if ( unlikely ( skb_tailroom ( skb ) < nla_total_size ( attrlen ) ) )
return NULL ;
return __nla_reserve ( skb , attrtype , attrlen ) ;
}
2009-03-11 18:18:32 +03:00
EXPORT_SYMBOL ( nla_reserve ) ;
2005-11-10 04:25:51 +03:00
2016-04-21 19:58:24 +03:00
/**
* nla_reserve_64bit - reserve room for attribute on the skb and align it
* @ skb : socket buffer to reserve room on
* @ attrtype : attribute type
* @ attrlen : length of attribute payload
2016-04-22 18:31:16 +03:00
* @ padattr : attribute type for the padding
2016-04-21 19:58:24 +03:00
*
* Adds a netlink attribute header to a socket buffer and reserves
* room for the payload but does not copy it . It also ensure that this
2016-04-22 18:31:16 +03:00
* attribute will have a 64 - bit aligned nla_data ( ) area .
2016-04-21 19:58:24 +03:00
*
* Returns NULL if the tailroom of the skb is insufficient to store
* the attribute header and payload .
*/
struct nlattr * nla_reserve_64bit ( struct sk_buff * skb , int attrtype , int attrlen ,
int padattr )
{
size_t len ;
if ( nla_need_padding_for_64bit ( skb ) )
len = nla_total_size_64bit ( attrlen ) ;
else
len = nla_total_size ( attrlen ) ;
if ( unlikely ( skb_tailroom ( skb ) < len ) )
return NULL ;
return __nla_reserve_64bit ( skb , attrtype , attrlen , padattr ) ;
}
EXPORT_SYMBOL ( nla_reserve_64bit ) ;
2006-08-05 10:03:05 +04:00
/**
2008-06-28 07:02:14 +04:00
* nla_reserve_nohdr - reserve room for attribute without header
2006-08-05 10:03:05 +04:00
* @ skb : socket buffer to reserve room on
2008-06-28 07:02:14 +04:00
* @ attrlen : length of attribute payload
2006-08-05 10:03:05 +04:00
*
* Reserves room for attribute payload without a header .
*
* Returns NULL if the tailroom of the skb is insufficient to store
* the attribute payload .
*/
void * nla_reserve_nohdr ( struct sk_buff * skb , int attrlen )
{
if ( unlikely ( skb_tailroom ( skb ) < NLA_ALIGN ( attrlen ) ) )
return NULL ;
return __nla_reserve_nohdr ( skb , attrlen ) ;
}
2009-03-11 18:18:32 +03:00
EXPORT_SYMBOL ( nla_reserve_nohdr ) ;
2006-08-05 10:03:05 +04:00
2005-11-10 04:25:51 +03:00
/**
* __nla_put - Add a netlink attribute to a socket buffer
* @ skb : socket buffer to add attribute to
* @ attrtype : attribute type
* @ attrlen : length of attribute payload
* @ data : head of attribute payload
*
* The caller is responsible to ensure that the skb provides enough
* tailroom for the attribute header and payload .
*/
void __nla_put ( struct sk_buff * skb , int attrtype , int attrlen ,
const void * data )
{
struct nlattr * nla ;
nla = __nla_reserve ( skb , attrtype , attrlen ) ;
memcpy ( nla_data ( nla ) , data , attrlen ) ;
}
2009-03-11 18:18:32 +03:00
EXPORT_SYMBOL ( __nla_put ) ;
2005-11-10 04:25:51 +03:00
2016-04-21 19:58:24 +03:00
/**
* __nla_put_64bit - Add a netlink attribute to a socket buffer and align it
* @ skb : socket buffer to add attribute to
* @ attrtype : attribute type
* @ attrlen : length of attribute payload
* @ data : head of attribute payload
2016-04-22 18:31:16 +03:00
* @ padattr : attribute type for the padding
2016-04-21 19:58:24 +03:00
*
* The caller is responsible to ensure that the skb provides enough
* tailroom for the attribute header and payload .
*/
void __nla_put_64bit ( struct sk_buff * skb , int attrtype , int attrlen ,
const void * data , int padattr )
{
struct nlattr * nla ;
nla = __nla_reserve_64bit ( skb , attrtype , attrlen , padattr ) ;
memcpy ( nla_data ( nla ) , data , attrlen ) ;
}
EXPORT_SYMBOL ( __nla_put_64bit ) ;
2006-08-05 10:03:05 +04:00
/**
* __nla_put_nohdr - Add a netlink attribute without header
* @ skb : socket buffer to add attribute to
* @ attrlen : length of attribute payload
* @ data : head of attribute payload
*
* The caller is responsible to ensure that the skb provides enough
* tailroom for the attribute payload .
*/
void __nla_put_nohdr ( struct sk_buff * skb , int attrlen , const void * data )
{
void * start ;
start = __nla_reserve_nohdr ( skb , attrlen ) ;
memcpy ( start , data , attrlen ) ;
}
2009-03-11 18:18:32 +03:00
EXPORT_SYMBOL ( __nla_put_nohdr ) ;
2005-11-10 04:25:51 +03:00
/**
* nla_put - Add a netlink attribute to a socket buffer
* @ skb : socket buffer to add attribute to
* @ attrtype : attribute type
* @ attrlen : length of attribute payload
* @ data : head of attribute payload
*
2008-06-04 03:36:54 +04:00
* Returns - EMSGSIZE if the tailroom of the skb is insufficient to store
2005-11-10 04:25:51 +03:00
* the attribute header and payload .
*/
int nla_put ( struct sk_buff * skb , int attrtype , int attrlen , const void * data )
{
if ( unlikely ( skb_tailroom ( skb ) < nla_total_size ( attrlen ) ) )
2008-06-04 03:36:54 +04:00
return - EMSGSIZE ;
2005-11-10 04:25:51 +03:00
__nla_put ( skb , attrtype , attrlen , data ) ;
return 0 ;
}
2009-03-11 18:18:32 +03:00
EXPORT_SYMBOL ( nla_put ) ;
2005-11-10 04:25:51 +03:00
2016-04-21 19:58:24 +03:00
/**
* nla_put_64bit - Add a netlink attribute to a socket buffer and align it
* @ skb : socket buffer to add attribute to
* @ attrtype : attribute type
* @ attrlen : length of attribute payload
* @ data : head of attribute payload
2016-04-22 18:31:16 +03:00
* @ padattr : attribute type for the padding
2016-04-21 19:58:24 +03:00
*
* Returns - EMSGSIZE if the tailroom of the skb is insufficient to store
* the attribute header and payload .
*/
int nla_put_64bit ( struct sk_buff * skb , int attrtype , int attrlen ,
const void * data , int padattr )
{
size_t len ;
if ( nla_need_padding_for_64bit ( skb ) )
len = nla_total_size_64bit ( attrlen ) ;
else
len = nla_total_size ( attrlen ) ;
if ( unlikely ( skb_tailroom ( skb ) < len ) )
return - EMSGSIZE ;
__nla_put_64bit ( skb , attrtype , attrlen , data , padattr ) ;
return 0 ;
}
EXPORT_SYMBOL ( nla_put_64bit ) ;
2006-08-05 10:03:05 +04:00
/**
* nla_put_nohdr - Add a netlink attribute without header
* @ skb : socket buffer to add attribute to
* @ attrlen : length of attribute payload
* @ data : head of attribute payload
*
2008-06-04 03:36:54 +04:00
* Returns - EMSGSIZE if the tailroom of the skb is insufficient to store
2006-08-05 10:03:05 +04:00
* the attribute payload .
*/
int nla_put_nohdr ( struct sk_buff * skb , int attrlen , const void * data )
{
if ( unlikely ( skb_tailroom ( skb ) < NLA_ALIGN ( attrlen ) ) )
2008-06-04 03:36:54 +04:00
return - EMSGSIZE ;
2006-08-05 10:03:05 +04:00
__nla_put_nohdr ( skb , attrlen , data ) ;
return 0 ;
}
2009-03-11 18:18:32 +03:00
EXPORT_SYMBOL ( nla_put_nohdr ) ;
2005-11-10 04:25:51 +03:00
2008-01-23 09:10:59 +03:00
/**
* nla_append - Add a netlink attribute without header or padding
* @ skb : socket buffer to add attribute to
* @ attrlen : length of attribute payload
* @ data : head of attribute payload
*
2008-06-04 03:36:54 +04:00
* Returns - EMSGSIZE if the tailroom of the skb is insufficient to store
2008-01-23 09:10:59 +03:00
* the attribute payload .
*/
int nla_append ( struct sk_buff * skb , int attrlen , const void * data )
{
if ( unlikely ( skb_tailroom ( skb ) < NLA_ALIGN ( attrlen ) ) )
2008-06-04 03:36:54 +04:00
return - EMSGSIZE ;
2008-01-23 09:10:59 +03:00
networking: introduce and use skb_put_data()
A common pattern with skb_put() is to just want to memcpy()
some data into the new space, introduce skb_put_data() for
this.
An spatch similar to the one for skb_put_zero() converts many
of the places using it:
@@
identifier p, p2;
expression len, skb, data;
type t, t2;
@@
(
-p = skb_put(skb, len);
+p = skb_put_data(skb, data, len);
|
-p = (t)skb_put(skb, len);
+p = skb_put_data(skb, data, len);
)
(
p2 = (t2)p;
-memcpy(p2, data, len);
|
-memcpy(p, data, len);
)
@@
type t, t2;
identifier p, p2;
expression skb, data;
@@
t *p;
...
(
-p = skb_put(skb, sizeof(t));
+p = skb_put_data(skb, data, sizeof(t));
|
-p = (t *)skb_put(skb, sizeof(t));
+p = skb_put_data(skb, data, sizeof(t));
)
(
p2 = (t2)p;
-memcpy(p2, data, sizeof(*p));
|
-memcpy(p, data, sizeof(*p));
)
@@
expression skb, len, data;
@@
-memcpy(skb_put(skb, len), data, len);
+skb_put_data(skb, data, len);
(again, manually post-processed to retain some comments)
Reviewed-by: Stephen Hemminger <stephen@networkplumber.org>
Signed-off-by: Johannes Berg <johannes.berg@intel.com>
Signed-off-by: David S. Miller <davem@davemloft.net>
2017-06-16 15:29:20 +03:00
skb_put_data ( skb , data , attrlen ) ;
2008-01-23 09:10:59 +03:00
return 0 ;
}
2009-03-11 18:18:32 +03:00
EXPORT_SYMBOL ( nla_append ) ;
# endif