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

CI: Introduce Smatch for static analysis (#125)

Smatch[1][2] is a pluggable static analysis for C. It may help us find
out the potential problem of the example code.

Doing with smatch, if set the --file-output flag, it will generate the
{}.c.smatch report for each c file. This will make a little bit
complicated to collect all the report messages. So, here we stay at the
default setting, stdout for the smatch messages.

For more information, see:
- https://lwn.net/Articles/696624/
- https://elinux.org/images/d/d3/Bargmann.pdf

Also, fix the warning from Smatch:

Smatch failed: 1 warning(s), 1 error(s)
lkmpg/examples/procfs2.c:57 procfile_write() error: buffer overflow 'procfs_buffer' 1024 <= 1024
lkmpg/examples/kbleds.c:58 kbleds_init() warn: argument 5 to %lx specifier is cast from pointer

Furthermore, the effect of the write operation in procfs2.c is too
implied. So after writing, print the buffer every time.

Close #122

[1] https://github.com/error27/smatch
[2] https://repo.or.cz/w/smatch.git

Fix grammar

in the hope ... will -> in the hope that ... would
get -> got
where are ... gone -> where have ... gone
For those not -> For those who are not

Explain inode at the first occurrence (#115)

The explanation of "inode" should appear at the first occurrence to which readers
can refer.

Remove out-of-date syscall information

Close #121

Fix wording

Add Manrope variable font (#118)

Manrope is an open-source modern sans-serif font family.

Merge pull request #120 from linD026/master

CI: Introduce GCC static analysis

CI: introduce GCC static analysis

Since GCC version 10, there has been a new option -fanalyzer for
static analysis. It can make the CI pipeline more comprehensive.

Also, the static analysis updates in GCC 11, but we cannot install
the GCC 11 in ubuntu 20.04 straightforwardly right now, which is
the GitHub workflow environment (see status-check.yaml).
For this reason, we stay at the GCC 10.

Close #117

Reference
- https://gcc.gnu.org/onlinedocs/gcc-10.1.0/gcc/Static-Analyzer-Options.html
- https://developers.redhat.com/blog/2020/03/26/static-analysis-in-gcc-10
- https://lwn.net/Articles/870290/
- https://developers.redhat.com/blog/2021/01/28/static-analysis-updates-in-gcc-11
- https://github.com/torvalds/linux/commit/7d73c3e9c51400d3e0e755488050804e4d44737a

Merge pull request #119 from marconi1964/master

Improve grammar

Correct English gramma

Simplify the epilog

Always run "dmesg" with sudo

The dmesg command allows you to review the messages that are stored in the
ring buffer. Some Linux distributions have strict requirements for
dmesg, and you need to use sudo to use dmesg.

Remove unintended code block

Dump the message of hello-5 explicitly (#112)

Close #111

Merge pull request #114 from fennecJ/patch

CI: Keep workflow running even if no release tag found

Keep workflow running even if no release tag found

The action we used to delete the old release somehow cannot find the
release tag in forked repo and cause the workflow failed.
To solve this issue, simply setting `fail-if-no-release` option to false
will do the trick.

CI: Enforce status checks once pull requests received (#113)

We tend to reject the pull requests if they fail to pass coding style checks
and static analysis.

See https://www.wesleyhaakman.org/working-with-pull-requests-status-checks-arm-templates-and-github-actions/

Fix potential concurrent access problems with VFS (#108)

Since Linux v3.14, the read, write and seek operations of "struct file" are
guaranteed for thread safety [1][2]. This patch added an explanation.

Here are the potential problems:
chardev.c:
- Move the "msg_ptr" pointer into the read function to remove unnecessary usage.
- List the clear states of "already_open" by using mnemonic enumeration.

chardev2.c:
- The "buffer" in the write function is user space data. It cannot use in the
  kernel space.
- Reduce the redundant type transformation.
- List the states of "already_open". Same as chardev.c.

[1] https://lore.kernel.org/lkml/20140303210359.26624.qmail@science.horizon.com/T/#u
[2] https://github.com/torvalds/linux/commit/9c225f2655e36a470c4f58dbbc99244c5fc7f2d4

Denote LWN hyperlink

Mention the Online Books Page

Merge pull request #109 from YLowy/master

Fix typo

Typo.

Merge pull request #107 from sprowell/master

Fixed parameter name for hello-5.

Fixed parameter name for hello-5.

Parameters are case-sensitive, so myintArray is different from myintarray, and people who are running the example with copy/paste will find it doesn't work as described in the text.

Merge pull request #106 from linD026/master

CI: Integrate the Sparse into the CI pipeline

CI: Integrate the Sparse into the CI pipeline

Sparse[1] is a semantic parser for C language, it can find out the
potential problem of the example code.

[1] https://www.kernel.org/doc/html/latest/dev-tools/sparse.html

CI: Run static analysis with Cppcheck (#105)

Cppcheck[1] is integrated into CI pipeline for running static analysis.

However, Cppcheck is known to report false-positive, and we have to
suppress some warnings in advance.

[1] https://cppcheck.sourceforge.io/

Merge pull request #104 from linD026/master

ioctl: Remove unnecessary initialization

ioctl.c: Remove unnecessary initialization

The "alloc_chrdev_region" function will dynamically choose the
major number and store it at "dev". It is unnecessary to initialize
the "dev" before the "alloc_chrdev_region" function.

Trivial GitHub workflow tweak

Make CI validation more verbose

Mention Free Ebook Foundation

Merge pull request #102 from giladreti/patch-1

Fix typo

fix typo: `compatibiity -> compatibility`

Merge pull request #101 from fennecJ/patch

Enable kbleds in CI pipeline

Remove kbleds from non-working list

Since #98 has fixed the error with kbleds caused by changed timer API,
now it can work again with docker container.