linux/tools/usb/hcd-tests.sh
Greg Kroah-Hartman b24413180f 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-02 11:10:55 +01:00

277 lines
6.1 KiB
Bash

#!/bin/sh
# SPDX-License-Identifier: GPL-2.0
#
# test types can be passed on the command line:
#
# - control: any device can do this
# - out, in: out needs 'bulk sink' firmware, in needs 'bulk src'
# - iso-out, iso-in: out needs 'iso sink' firmware, in needs 'iso src'
# - halt: needs bulk sink+src, tests halt set/clear from host
# - unlink: needs bulk sink and/or src, test HCD unlink processing
# - loop: needs firmware that will buffer N transfers
#
# run it for hours, days, weeks.
#
#
# this default provides a steady test load for a bulk device
#
TYPES='control out in'
#TYPES='control out in halt'
#
# to test HCD code
#
# - include unlink tests
# - add some ${RANDOM}ness
# - connect several devices concurrently (same HC)
# - keep HC's IRQ lines busy with unrelated traffic (IDE, net, ...)
# - add other concurrent system loads
#
declare -i COUNT BUFLEN
COUNT=50000
BUFLEN=2048
# NOTE: the 'in' and 'out' cases are usually bulk, but can be
# set up to use interrupt transfers by 'usbtest' module options
if [ "$DEVICE" = "" ]; then
echo "testing ALL recognized usbtest devices"
echo ""
TEST_ARGS="-a"
else
TEST_ARGS=""
fi
do_test ()
{
if ! ./testusb $TEST_ARGS -s $BUFLEN -c $COUNT $* 2>/dev/null
then
echo "FAIL"
exit 1
fi
}
ARGS="$*"
if [ "$ARGS" = "" ];
then
ARGS="$TYPES"
fi
# FIXME use /sys/bus/usb/device/$THIS/bConfigurationValue to
# check and change configs
CONFIG=''
check_config ()
{
if [ "$CONFIG" = "" ]; then
CONFIG=$1
echo "assuming $CONFIG configuration"
return
fi
if [ "$CONFIG" = $1 ]; then
return
fi
echo "** device must be in $1 config, but it's $CONFIG instead"
exit 1
}
echo "TESTING: $ARGS"
while : true
do
echo $(date)
for TYPE in $ARGS
do
# restore defaults
COUNT=5000
BUFLEN=2048
# FIXME automatically multiply COUNT by 10 when
# /sys/bus/usb/device/$THIS/speed == "480"
# COUNT=50000
case $TYPE in
control)
# any device, in any configuration, can use this.
echo '** Control test cases:'
echo "test 9: ch9 postconfig"
do_test -t 9 -c 5000
echo "test 10: control queueing"
do_test -t 10 -c 5000
# this relies on some vendor-specific commands
echo "test 14: control writes"
do_test -t 14 -c 15000 -s 256 -v 1
echo "test 21: control writes, unaligned"
do_test -t 21 -c 100 -s 256 -v 1
;;
out)
check_config sink-src
echo '** Host Write (OUT) test cases:'
echo "test 1: $COUNT transfers, same size"
do_test -t 1
echo "test 3: $COUNT transfers, variable/short size"
do_test -t 3 -v 421
COUNT=100
echo "test 17: $COUNT transfers, unaligned DMA map by core"
do_test -t 17
echo "test 19: $COUNT transfers, unaligned DMA map by usb_alloc_coherent"
do_test -t 19
COUNT=2000
echo "test 5: $COUNT scatterlists, same size entries"
do_test -t 5
# try to trigger short OUT processing bugs
echo "test 7a: $COUNT scatterlists, variable size/short entries"
do_test -t 7 -v 579
BUFLEN=4096
echo "test 7b: $COUNT scatterlists, variable size/bigger entries"
do_test -t 7 -v 41
BUFLEN=64
echo "test 7c: $COUNT scatterlists, variable size/micro entries"
do_test -t 7 -v 63
;;
iso-out)
check_config sink-src
echo '** Host ISOCHRONOUS Write (OUT) test cases:'
# at peak iso transfer rates:
# - usb 2.0 high bandwidth, this is one frame.
# - usb 1.1, it's twenty-four frames.
BUFLEN=24500
COUNT=1000
# COUNT=10000
echo "test 15: $COUNT transfers, same size"
# do_test -t 15 -g 3 -v 0
BUFLEN=32768
do_test -t 15 -g 8 -v 0
# FIXME it'd make sense to have an iso OUT test issuing
# short writes on more packets than the last one
COUNT=100
echo "test 22: $COUNT transfers, non aligned"
do_test -t 22 -g 8 -v 0
;;
in)
check_config sink-src
echo '** Host Read (IN) test cases:'
# NOTE: these "variable size" reads are just multiples
# of 512 bytes, no EOVERFLOW testing is done yet
echo "test 2: $COUNT transfers, same size"
do_test -t 2
echo "test 4: $COUNT transfers, variable size"
do_test -t 4
COUNT=100
echo "test 18: $COUNT transfers, unaligned DMA map by core"
do_test -t 18
echo "test 20: $COUNT transfers, unaligned DMA map by usb_alloc_coherent"
do_test -t 20
COUNT=2000
echo "test 6: $COUNT scatterlists, same size entries"
do_test -t 6
echo "test 8: $COUNT scatterlists, variable size entries"
do_test -t 8
;;
iso-in)
check_config sink-src
echo '** Host ISOCHRONOUS Read (IN) test cases:'
# at peak iso transfer rates:
# - usb 2.0 high bandwidth, this is one frame.
# - usb 1.1, it's twenty-four frames.
BUFLEN=24500
COUNT=1000
# COUNT=10000
echo "test 16: $COUNT transfers, same size"
# do_test -t 16 -g 3 -v 0
BUFLEN=32768
do_test -t 16 -g 8 -v 0
# FIXME since iso expects faults, it'd make sense
# to have an iso IN test issuing short reads ...
COUNT=100
echo "test 23: $COUNT transfers, unaligned"
do_test -t 23 -g 8 -v 0
;;
halt)
# NOTE: sometimes hardware doesn't cooperate well with halting
# endpoints from the host side. so long as mass-storage class
# firmware can halt them from the device, don't worry much if
# you can't make this test work on your device.
COUNT=2000
echo "test 13: $COUNT halt set/clear"
do_test -t 13
;;
unlink)
COUNT=2000
echo "test 11: $COUNT read unlinks"
do_test -t 11
echo "test 12: $COUNT write unlinks"
do_test -t 12
;;
loop)
# defaults need too much buffering for ez-usb devices
BUFLEN=2048
COUNT=32
# modprobe g_zero qlen=$COUNT buflen=$BUFLEN loopdefault
check_config loopback
# FIXME someone needs to write and merge a version of this
echo "write $COUNT buffers of $BUFLEN bytes, read them back"
echo "write $COUNT variable size buffers, read them back"
;;
*)
echo "Don't understand test type $TYPE"
exit 1;
esac
echo ''
done
done
# vim: sw=4