headers: Update header installation for Fedora

static_key: Include <linux/jump_label.h> (#210)

examples: Add missing __init/__exit (#209)

Close #207

Merge pull request #208 from samuelerickson977/master

include linux/init.h in bottomhalf.c

include linux/init.h in bottomhalf.c

Merge pull request #206 from ekangmonyet/master

Cleanup redundant workflow step, fix release body and timestamp

Delete old release and retag latest commit

This ensures the latest commit message and timestamp can be correctly
included in the release.

Revert "Delete existing release asset before releasing"

This reverts commit 7ee66c559ff12c254d04c65c54325acbb655133a.

Merge pull request #200 from lyctw/static_key

Introduce static key in optimizations section

Introduce static key in optimizations section

This patch introduces static key technique and adds a kernel module
to demostrate how to use static key to optimize an almost unlikely
branch, the module can interact with userspace thru a character device.

Signed-off-by: Peter Lin <peterlin@qilai.dev>

Merge pull request #202 from linD026/master

CI: Switch Smatch source code to GitHub mirror

CI: Switch Smatch source code to GitHub mirror

Since the Smatch repository is unavailable recently [1], let's switch
to GitHub mirror, https://github.com/error27/smatch.git [2], instead
of using https://repo.or.cz/smatch.git.

[1] https://lore.kernel.org/all/Y1qf7w%2Fjo8FH5I8G@kadam/
[2] https://lore.kernel.org/all/20220810105926.GS3460@kadam/

Merge pull request #198 from linD026/master

Remove sleep_on family

Remove sleep_on family

Since the commit b8780c363d80 ("sched: remove sleep_on() and friends
"), the description about sleep_on is incorrect and the example code has
been fixed by replacing it with wait_event family. Let's also fix the
description to match the corrected code.

Fix macOS prerequisites

Merge pull request #193 from linD026/master

procfs: Enforce Linux naming style

procfs: Enforce Linux naming style

Merge pull request #189 from linD026/master

Improve the compatibility and fix the missing header

completion: Improve the compatibility with v5.17+

Since v5.17-rc1, particularly after the commit cead1855266 ("exit:
Rename complete_and_exit to kthread_complete_and_exit"),
complete_and_exit() is renamed to kthread_complete_and_exit().

Close #188

chardev2: Fix missing header for {get, put}_user

Merge pull request #187 from linD026/master

Relocate Archlinux code snippet to avoid confusion

Relocate Archlinux code snippet to avoid confusion

Close #185

Merge pull request #186 from ashevche/kernel.h

Discourage kernel.h usage and other header cleanups

treewide: Replace kernel.h by printk.h

The kernel.h should be discouraged for use.

Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>

treewide: Clean up the headers

The rule of thumb is to include the headers we are the direct user of.
In particular, if we need an atomic API, we include <linux/atomic.h>.

On the other hand we should not use headers for no reason. In particular,
if we are not doing any IRQ job, why is the <linux/irq.h> included?

Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>

devicemodel: Remove duplicate owner assignment

platform_driver_register() macro already does the correct assignment for
the owner of the driver.

Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>

Merge pull request #184 from linD026/master

syscall: Use openat() instead of open()

syscall: Use openat() instead of open()

Since sys_open is deprecated and some architectures don't support it.
We switch the implementation to sys_openat.

Moreover, in some architectures like x86-64, the prototype of syscall,
for example, openat(), might have been changed to struct pt_regs [1]
but we cannot promise that so support the two types
(sys_openat and pt_regs).

Also, to prevent other untraced tasks print out the information, add
the uid checking in our_sys_openat().

[1] https://lore.kernel.org/lkml/20180405095307.3730-1-linux@dominikbrodowski.net/

Close #159

Merge pull request #183 from linD026/master

example/syscall: Fix typo and unmatch types

example/syscall: Fix typo and unmatch types

Merge pull request #182 from lyctw/master

Add error message when sha256 algorithm is not supported

Add error message when sha256 algorithm is not supported

It failed silently when crypto_alloc_tfm() failed, so add an error
message to inform the developer to enable sha256 algorithm support.

Signed-off-by: Yu Chien Peter Lin <peterlin.tw@pm.me>

Merge pull request #181 from lyctw/master

Fix typo in interrupt handlers section

Fix typo in interrupt handlers section

%s/assembler/assembly language/

Signed-off-by: Yu Chien Peter Lin <peterlin.tw@pm.me>

CI: Bump validation host versioning

The CI is now running on Ubuntu 22.04-LTS along with gcc-11 and
clang-format-12 .

CI: Bump dependency versions

Make the naming for GitHub Actions more consistent

Convey secure boot specific considerations (#177)

Merge pull request #176 from linD026/master

vinput: Fix missing error code

vinput: Fix missing error code

Fix the missing error code when register_chrdev() failed.
The report is from Smatch:

Smatch failed: 1 warning(s), 0 error(s)
/home/runner/work/lkmpg/lkmpg/examples/vinput.c:372 vinput_init() warn: missing error code 'err'

Fix typo (line 1019) (#174)

Changed "The choose of two different functions depend on whether ..." to
"The choice between two different functions depends on whether ..."

Merge pull request #124 from tzuyichan/patch

Fix grammar

Fix dead link

Close #173

Fix typo (#169)

Merge pull request #168 from linD026/master

Fix dereference NULL pointer with proc_lseek

Merge pull request #167 from linD026/minmax

Improve the compatibility with kernel < v5.10

Fix dereference NULL pointer with proc_lseek

Since the operations are static storage duration, the pointer in
operation structures will initialize with NULL. But, the kernel
doesn't check whether the pointer is NULL or not when calling it.

Related Discussion:
- https://github.com/sysprog21/lkmpg/issues/165
- https://github.com/sysprog21/lkmpg/issues/160

Close #165

Improve the compatibility with kernel < v5.10

min()/max() splited from kernel.h to minmax.h since v5.10-rc1.
Before v5.10, minmax.h doesn't exist [1].

[1] https://github.com/torvalds/linux/commit/b296a6d53339a79082c1d2c1761e948e8b3def69

Merge pull request #163 from linD026/read-write

procfs{2, 3}: Change to use offset parameter

procfs{2, 3}: Change to use offset parameter

To make sure the behavior of the read and write operations are correct
with offset, update it each time. Also, since it is using the offset,
modify the part of read for removing unnecessary variable.

Merge pull request #164 from linD026/file-proc_ops

Improve the description of proc in file-ops

Merge pull request #162 from linD026/master

Fix the buffer length may cause a read error

Improve the description of proc in file-ops

Currently, the description of the proc_ops in the file operation section
will confuse the reader with registering the device. Add more hints to
avoid it.

Fix the buffer length may cause a read error

Since The length of the message buffer is BUF_LEN. When writing the
BUF_LEN length of the string it will overwrite the last character
(usually it is '\0' from the initialization). And, because the read
operation uses the character in the message buffer ('\0') to stop the
read loop. It will cause the read operation will read out of the
message buffer when the length parameter of read() is not lower than
or equal to BUF_LEN. So add one more byte space to avoid this problem.

Add additional macos installation instruction in README.md (#157)

Signed-off-by: Cheng-En Lee <chengenl@usc.edu>

Merge pull request #156 from linD026/master

Adjust "in the mean time" description of tasklet

Adjust "in the mean time" description of tasklet

Since the init function may be interrupted. Tweak the description of
"in the mean time".

Close #152

Merge pull request #155 from linD026/master

Add more information about the CFI of timer API

Add more information about the CFI of timer API

Currently, in 13.2 Flashing keyboard LEDs, the description of the
control-flow integrity, "Furthermore, the function prototype with
unsigned long argument may be an obstacle to the control-flow integrity
.", will confuse the reader.

It may lead the reader to think about hardware-assisted CFI like Intel
CET uses the shadow stack attack for ROP (backward-edge protection). But
the description of CFI here talks about the function pointer checking
with the prototype (forward-edge protection).

So add more information to make it more clear.

Close #151

Merge pull request #154 from leovincentseles/master

module_init and module_exit are defined in module.h

module_init and module_exit are defined in module.h

Both module_init and module_exit are defined in
include/linux/module.h

CI: Bump dependency versions

Merge pull request #150 from asas1asas200/zeng-feat-attributes

Add description of sysfs attribute

Add description of sysfs attribute

The description of the attribute was added in sysfs section and referenced in vinput section.

In vinput section, just described the class_attribute and some macros about sysfs class.

Add file name at vinput-related examples begin.

Merge pull request #149 from linD026/master

Fix potential concurrent problems in chardev2.c

Fix potential concurrent problems in chardev2.c

After forking, Each file descriptor in the child refers to the same
open file description as the parent. So when calling open() before
fork(), the child can access the device file without checking by
exclusive access in device_open(). It may cause race conditions
in device_ioctl().

Because of that, it is unnecessary to check the multiple access
in device_open(). It just needs check in device_ioctl(), since
read(), write(), seek() system call are atomic [1][2].

Related discussion:
- https://github.com/sysprog21/lkmpg/issues/148

[1] https://lore.kernel.org/lkml/53022DB1.4070805@gmail.com/
[2] https://www.kernel.org/doc/html/latest/filesystems/files.html

Close #148

Merge pull request #147 from linD026/master

Fix wrong regular expression of clang-format

Fix wrong regular expression of clang-format

Merge pull request #146 from linD026/master

Fix typo

Fix typo

Merge pull request #145 from linD026/master

Introduce Virtual Input Device Driver

Introduce Virtual Input Device Driver

Add the new section of input device driver, vinput[1].

Also, update the Acknowledgements.

[1] https://github.com/sysprog21/vinput

Merge pull request #144 from henrybear327/improvement/latexmk

Use latexmk instead of pdflatex for PDF generation

Update README and Makefile for the latexmk existence check

Signed-off-by: Chun-Hung Tseng <henrybear327@gmail.com>

Tweak the style of sudoers file

Update .gitignore files to ignore latexmk tmp files

Signed-off-by: Chun-Hung Tseng <henrybear327@gmail.com>

Fix the pdf generation code in Makefile

The current Makefile is missing one more pdflatex pass.

The correct steps are : pdflatex -> bibtex -> pdflatex -> pdflatex [1]. Otherwise, bib items will not be showing properly.

[1] https://github.com/James-Yu/LaTeX-Workshop/wiki/Compile#latex-recipes

Signed-off-by: Chun-Hung Tseng <henrybear327@gmail.com>

Merge pull request #143 from linD026/master

Improve the description of finding syscall table

Improve the description of finding syscall table

Presently, the representation of showing which version will use the
method to find out the system call table is vague.

Related discussion:
* sysprog21/lkmpg: https://github.com/sysprog21/lkmpg/pull/142

Refine wording on module loading

Close #134

Merge pull request #141 from steven1lung/master

Fix grammar and typo

Fix grammar

Merge pull request #140 from steven1lung/master

Fix typo, grammar and remove duplicated words

Fix typo, grammar and remove duplicated  words

Replaced 'a' with 'an' since a vowel sound is after.

Fix a logic error in examples/ioctl.c (#137)

Change the "alloc_ret" and "cdev_ret" initial values to non-zero.
According to the source code, "alloc_chrdev_region" and "cdev_add"
return zero on success, and negative code on failure.

So, if the "alloc_chrdev_region" failed, the if condition becomes true,
then we will jump to the label "error" by goto, checking each return
value whether is a success state from both functions mentioned above
and dealing with it properly for exiting the process.

However, it checks the success state by comparing the return value
with zero (means success), and we got "cdev_ret == 0" is true from
the initial value zero, while we didn't execute "cdev_add" yet.
Hence, there was a logic error when the initial value is zero.

Co-authored-by: NOVBobLee <defru04002@gamil.com>

Fix incoherent ioctl examples (#139)

Previously ioctl.c is a userspace program for chardev2.c and chardev.h [1].
But now, this file is an independent kernel module, and the original code
disappear.
This patch adds back the original userspace code and renames it to
userspace_ioctl.c.

[1] https://tldp.org/LDP/lkmpg/2.4/html/x856.html

Add book cover (#136)

Both PDF and HTML generation are supported.

Update Makefile and Add explanation (#133)

Add `PWD := $(CURDIR)` in Makefile and the explanation about `sudo make`
when only having `PWD`.

Merge pull request #135 from RinHizakura/master

Revise chardev registration

Introduce the new method for chardev registration

Instead of using the old register_chrdev / unregister_chrdev API,
cdev interface which is newer and would be better for new driver programmers
in most cases. This commit is trying to give the brief overview for
this different interface.

modinfo does not require superuser permission

Merge pull request #130 from lyctw/master

Fix typo

Fix typo

Merge pull request #128 from sudoliyang/patch-2

Fix typo

Merge pull request #127 from sudoliyang/patch-1

Fix typo

Fix typo

Fix typo

Merge pull request #123 from fennecJ/patch

Generate contributor list as a modular inclusion

Adjust the position of Figure 1 (#126)

Add script to gen contributor list and contrib.tex

This script do mainly 2 things:
1.
Generate file `Contributors` with git log in following format:
Contributor's name,<1-st e-mail>[,<2nd e-mail>][,<3rd e-mail>]...
The 2-nd email and so on are based on file `.mailmap` in the root
directory of the repo.
Note that it will also append contributors in File `Include`; and
will NOT append contributors in File `Exclude`.
If there are new contributors, script will sort `Contributor` after
append new contributors into each file; Otherwise it do nothing.

2.
Generate contrib.tex based on `Contributors` into lib/contrib.tex in
following format:
[name], (reasonable width) % [1-st e-mail]
Which is inspired by The Not So Short Introduction to Latex 2e[1]

We need to maintain `.mailmap`, `Exclude` and `Include` manually.
All Chinese name should be converted into English/Pinyin in `.mailmap`,
otherwise we may need extra pkg for latex to parse Chinese characters.

[1] - https://tobi.oetiker.ch/lshort/lshort.pdf

Close #68