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 14:07:57 +00:00
|
|
|
# SPDX-License-Identifier: GPL-2.0
|
2010-06-01 08:01:24 +00:00
|
|
|
config ZRAM
|
|
|
|
|
tristate "Compressed RAM block device support"
|
2022-05-22 20:40:27 +00:00
|
|
|
depends on BLOCK && SYSFS && MMU
|
2020-12-15 03:14:35 +00:00
|
|
|
depends on CRYPTO_LZO || CRYPTO_ZSTD || CRYPTO_LZ4 || CRYPTO_LZ4HC || CRYPTO_842
|
2022-05-19 21:08:53 +00:00
|
|
|
select ZSMALLOC
|
2010-06-01 08:01:24 +00:00
|
|
|
help
|
|
|
|
|
Creates virtual block devices called /dev/zramX (X = 0, 1, ...).
|
|
|
|
|
Pages written to these disks are compressed and stored in memory
|
|
|
|
|
itself. These disks allow very fast I/O and compression provides
|
|
|
|
|
good amounts of memory savings.
|
|
|
|
|
|
|
|
|
|
It has several use cases, for example: /tmp storage, use as swap
|
|
|
|
|
disks and maybe many more.
|
|
|
|
|
|
2019-06-18 14:47:10 +00:00
|
|
|
See Documentation/admin-guide/blockdev/zram.rst for more information.
|
2017-09-06 23:20:10 +00:00
|
|
|
|
2020-12-15 03:14:35 +00:00
|
|
|
choice
|
|
|
|
|
prompt "Default zram compressor"
|
|
|
|
|
default ZRAM_DEF_COMP_LZORLE
|
|
|
|
|
depends on ZRAM
|
|
|
|
|
|
|
|
|
|
config ZRAM_DEF_COMP_LZORLE
|
|
|
|
|
bool "lzo-rle"
|
|
|
|
|
depends on CRYPTO_LZO
|
|
|
|
|
|
|
|
|
|
config ZRAM_DEF_COMP_ZSTD
|
|
|
|
|
bool "zstd"
|
|
|
|
|
depends on CRYPTO_ZSTD
|
|
|
|
|
|
|
|
|
|
config ZRAM_DEF_COMP_LZ4
|
|
|
|
|
bool "lz4"
|
|
|
|
|
depends on CRYPTO_LZ4
|
|
|
|
|
|
|
|
|
|
config ZRAM_DEF_COMP_LZO
|
|
|
|
|
bool "lzo"
|
|
|
|
|
depends on CRYPTO_LZO
|
|
|
|
|
|
|
|
|
|
config ZRAM_DEF_COMP_LZ4HC
|
|
|
|
|
bool "lz4hc"
|
|
|
|
|
depends on CRYPTO_LZ4HC
|
|
|
|
|
|
|
|
|
|
config ZRAM_DEF_COMP_842
|
|
|
|
|
bool "842"
|
|
|
|
|
depends on CRYPTO_842
|
|
|
|
|
|
|
|
|
|
endchoice
|
|
|
|
|
|
|
|
|
|
config ZRAM_DEF_COMP
|
|
|
|
|
string
|
|
|
|
|
default "lzo-rle" if ZRAM_DEF_COMP_LZORLE
|
|
|
|
|
default "zstd" if ZRAM_DEF_COMP_ZSTD
|
|
|
|
|
default "lz4" if ZRAM_DEF_COMP_LZ4
|
|
|
|
|
default "lzo" if ZRAM_DEF_COMP_LZO
|
|
|
|
|
default "lz4hc" if ZRAM_DEF_COMP_LZ4HC
|
|
|
|
|
default "842" if ZRAM_DEF_COMP_842
|
|
|
|
|
|
2017-09-06 23:20:10 +00:00
|
|
|
config ZRAM_WRITEBACK
|
zram: support idle/huge page writeback
Add a new feature "zram idle/huge page writeback". In the zram-swap use
case, zram usually has many idle/huge swap pages. It's pointless to keep
them in memory (ie, zram).
To solve this problem, this feature introduces idle/huge page writeback to
the backing device so the goal is to save more memory space on embedded
systems.
Normal sequence to use idle/huge page writeback feature is as follows,
while (1) {
# mark allocated zram slot to idle
echo all > /sys/block/zram0/idle
# leave system working for several hours
# Unless there is no access for some blocks on zram,
# they are still IDLE marked pages.
echo "idle" > /sys/block/zram0/writeback
or/and
echo "huge" > /sys/block/zram0/writeback
# write the IDLE or/and huge marked slot into backing device
# and free the memory.
}
Per the discussion at
https://lore.kernel.org/lkml/20181122065926.GG3441@jagdpanzerIV/T/#u,
This patch removes direct incommpressibe page writeback feature
(d2afd25114f4 ("zram: write incompressible pages to backing device")).
Below concerns from Sergey:
== &< ==
"IDLE writeback" is superior to "incompressible writeback".
"incompressible writeback" is completely unpredictable and uncontrollable;
it depens on data patterns and compression algorithms. While "IDLE
writeback" is predictable.
I even suspect, that, *ideally*, we can remove "incompressible writeback".
"IDLE pages" is a super set which also includes "incompressible" pages.
So, technically, we still can do "incompressible writeback" from "IDLE
writeback" path; but a much more reasonable one, based on a page idling
period.
I understand that you want to keep "direct incompressible writeback"
around. ZRAM is especially popular on devices which do suffer from flash
wearout, so I can see "incompressible writeback" path becoming a dead
code, long term.
== &< ==
Below concerns from Minchan:
== &< ==
My concern is if we enable CONFIG_ZRAM_WRITEBACK in this implementation,
both hugepage/idlepage writeck will turn on. However someuser want to
enable only idlepage writeback so we need to introduce turn on/off knob
for hugepage or new CONFIG_ZRAM_IDLEPAGE_WRITEBACK for those usecase. I
don't want to make it complicated *if possible*.
Long term, I imagine we need to make VM aware of new swap hierarchy a
little bit different with as-is. For example, first high priority swap
can return -EIO or -ENOCOMP, swap try to fallback to next lower priority
swap device. With that, hugepage writeback will work tranparently.
So we could regard it as regression because incompressible pages doesn't
go to backing storage automatically. Instead, user should do it via "echo
huge" > /sys/block/zram/writeback" manually.
== &< ==
Link: http://lkml.kernel.org/r/20181127055429.251614-6-minchan@kernel.org
Signed-off-by: Minchan Kim <minchan@kernel.org>
Reviewed-by: Joey Pabalinas <joeypabalinas@gmail.com>
Reviewed-by: Sergey Senozhatsky <sergey.senozhatsky@gmail.com>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
2018-12-28 08:36:47 +00:00
|
|
|
bool "Write back incompressible or idle page to backing device"
|
2017-09-06 23:20:10 +00:00
|
|
|
depends on ZRAM
|
|
|
|
|
help
|
|
|
|
|
With incompressible page, there is no memory saving to keep it
|
|
|
|
|
in memory. Instead, write it out to backing device.
|
|
|
|
|
For this feature, admin should set up backing device via
|
|
|
|
|
/sys/block/zramX/backing_dev.
|
|
|
|
|
|
zram: support idle/huge page writeback
Add a new feature "zram idle/huge page writeback". In the zram-swap use
case, zram usually has many idle/huge swap pages. It's pointless to keep
them in memory (ie, zram).
To solve this problem, this feature introduces idle/huge page writeback to
the backing device so the goal is to save more memory space on embedded
systems.
Normal sequence to use idle/huge page writeback feature is as follows,
while (1) {
# mark allocated zram slot to idle
echo all > /sys/block/zram0/idle
# leave system working for several hours
# Unless there is no access for some blocks on zram,
# they are still IDLE marked pages.
echo "idle" > /sys/block/zram0/writeback
or/and
echo "huge" > /sys/block/zram0/writeback
# write the IDLE or/and huge marked slot into backing device
# and free the memory.
}
Per the discussion at
https://lore.kernel.org/lkml/20181122065926.GG3441@jagdpanzerIV/T/#u,
This patch removes direct incommpressibe page writeback feature
(d2afd25114f4 ("zram: write incompressible pages to backing device")).
Below concerns from Sergey:
== &< ==
"IDLE writeback" is superior to "incompressible writeback".
"incompressible writeback" is completely unpredictable and uncontrollable;
it depens on data patterns and compression algorithms. While "IDLE
writeback" is predictable.
I even suspect, that, *ideally*, we can remove "incompressible writeback".
"IDLE pages" is a super set which also includes "incompressible" pages.
So, technically, we still can do "incompressible writeback" from "IDLE
writeback" path; but a much more reasonable one, based on a page idling
period.
I understand that you want to keep "direct incompressible writeback"
around. ZRAM is especially popular on devices which do suffer from flash
wearout, so I can see "incompressible writeback" path becoming a dead
code, long term.
== &< ==
Below concerns from Minchan:
== &< ==
My concern is if we enable CONFIG_ZRAM_WRITEBACK in this implementation,
both hugepage/idlepage writeck will turn on. However someuser want to
enable only idlepage writeback so we need to introduce turn on/off knob
for hugepage or new CONFIG_ZRAM_IDLEPAGE_WRITEBACK for those usecase. I
don't want to make it complicated *if possible*.
Long term, I imagine we need to make VM aware of new swap hierarchy a
little bit different with as-is. For example, first high priority swap
can return -EIO or -ENOCOMP, swap try to fallback to next lower priority
swap device. With that, hugepage writeback will work tranparently.
So we could regard it as regression because incompressible pages doesn't
go to backing storage automatically. Instead, user should do it via "echo
huge" > /sys/block/zram/writeback" manually.
== &< ==
Link: http://lkml.kernel.org/r/20181127055429.251614-6-minchan@kernel.org
Signed-off-by: Minchan Kim <minchan@kernel.org>
Reviewed-by: Joey Pabalinas <joeypabalinas@gmail.com>
Reviewed-by: Sergey Senozhatsky <sergey.senozhatsky@gmail.com>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
2018-12-28 08:36:47 +00:00
|
|
|
With /sys/block/zramX/{idle,writeback}, application could ask
|
|
|
|
|
idle page's writeback to the backing device to save in memory.
|
|
|
|
|
|
2019-06-18 14:47:10 +00:00
|
|
|
See Documentation/admin-guide/blockdev/zram.rst for more information.
|
2018-06-08 00:05:49 +00:00
|
|
|
|
|
|
|
|
config ZRAM_MEMORY_TRACKING
|
|
|
|
|
bool "Track zRam block status"
|
|
|
|
|
depends on ZRAM && DEBUG_FS
|
|
|
|
|
help
|
|
|
|
|
With this feature, admin can track the state of allocated blocks
|
|
|
|
|
of zRAM. Admin could see the information via
|
|
|
|
|
/sys/kernel/debug/zram/zramX/block_state.
|
|
|
|
|
|
2019-06-18 14:47:10 +00:00
|
|
|
See Documentation/admin-guide/blockdev/zram.rst for more information.
|
2022-11-09 11:50:38 +00:00
|
|
|
|
|
|
|
|
config ZRAM_MULTI_COMP
|
|
|
|
|
bool "Enable multiple compression streams"
|
|
|
|
|
depends on ZRAM
|
|
|
|
|
help
|
|
|
|
|
This will enable multi-compression streams, so that ZRAM can
|
|
|
|
|
re-compress pages using a potentially slower but more effective
|
|
|
|
|
compression algorithm. Note, that IDLE page recompression
|
|
|
|
|
requires ZRAM_MEMORY_TRACKING.
|