Fix the warnings raised by Sparse (#92)

Sparse[1] is a semantic parser, capable of finding out the potential
problems of Linux kernel code. This patch fixed the warnings.

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

Merge pull request #91 from ccs100203/master

Fix Typo

Fix Typo

from "mask" to "masks"
from "quick" to "quickly"
from "a" to "an"

Enforce consistent style for directory "other" (#89)

Enforce Linux kernel coding style (#88)

The only exception is to indent with four spaces rather than tabs
for sticking to compact layout of source listing.

Close #87

Rewrite the descriptions about bottom half

Merge pull request #86 from linD026/master

Fix typo

Fix typo

Add GitHub buttons in rendered HTML (#85)

GitHub buttons are rendered in the generated HTML:
one is GitHub project page; another is PDF download.

Close #84

Fix disallowed cr0 write protection and close_fd (#80)

Since the commit 8dbec27a242cd3e2816eeb98d3237b9f57cf6232 [1]
(kernel version v5.3+ [2]) the sensitive CR0 bits in x86 is pinned,
we need to use the inline asm [3][4] to bypass it.

commit 8dbec27a242cd3e2816eeb98d3237b9f57cf6232 :
> With sensitive CR4 bits pinned now, it's possible that the WP bit for
> CR0 might become a target as well.
>
> Following the same reasoning for the CR4 pinning, pin CR0's WP
> bit. Contrary to the cpu feature dependend CR4 pinning this can be done
> with a constant value.

Also, getting "sys_call_table" [8] from the symbol lookup by using the address
of "close_fd" does not work for v5.11+ [5][6]. The reason is the entry of
"sys_call_table[__NR_close]" is not the address of "close_fd", actually
it is "__x64_sys_close" in x86.

Two solutions were proposed: using "kallsyms_lookup_name" [7] or just specifying
the address into the module. The symbol "kallsyms_lookup_name"  is unexported
since v5.7; the address of "sys_call_table" can be found in
"/boot/System.map" or "/proc/kallsyms".

Since v5.7, the manual symbol lookup is not guaranteed to work
because of control-flow integrity (or control-flow enforcement [9][10]) is added
[11] for x86, but it is disabled since v5.11 [12][13]. To make sure manual symbol
lookup work, it only uses up to v5.4.

Reference:
[1] https://github.com/torvalds/linux/commit/8dbec27a242cd3e2816eeb98d3237b9f57cf6232
[2] https://outflux.net/blog/archives/2019/11/14/security-things-in-linux-v5-3/
[3] https://patchwork.kernel.org/project/linux-kbuild/patch/20200903203053.3411268-3-samitolvanen@google.com/
[4] https://stackoverflow.com/questions/58512430/how-to-write-to-protected-pages-in-the-linux-kernel
[5] https://lore.kernel.org/bpf/20201120231441.29911-21-ebiederm@xmission.com/
[6] https://lore.kernel.org/bpf/87blj83ysq.fsf@x220.int.ebiederm.org/
[7] https://github.com/torvalds/linux/commit/0bd476e6c67190b5eb7b6e105c8db8ff61103281
[8] https://github.com/torvalds/linux/commit/8f27766a883149926e7c1f69d9f1d8f68efcd65f
[9] https://lore.kernel.org/lkml/20200204171425.28073-1-yu-cheng.yu@intel.com/
[10] https://lore.kernel.org/linux-doc/20201110162211.9207-1-yu-cheng.yu@intel.com/T/
[11] https://github.com/torvalds/linux/commit/5790921bc18b1eb5c0c61371e31114fd4c4b0154
[12] https://github.com/torvalds/linux/commit/20bf2b378729c4a0366a53e2018a0b70ace94bcd
[13] https://lore.kernel.org/bpf/20210128123842.c9e33949e62f504b84bfadf5@gmail.com/

print_string: Validate tty before accessing its operations

Close #81

Merge pull request #79 from xatier/patch-1

Update Arch Linux kernel headers information

Update Archlinux kernel headers instructions

`linux-libre-headers` has been moved to AUR [1]. We can simply install `linux-headers` [2] instead.

[1] https://aur.archlinux.org/packages/linux-libre-headers/
[2] https://archlinux.org/packages/core/x86_64/linux-headers/

Fix incorrect major number registration in chardev (#77)

chardev2.c demonstrates the ioctl operation with static major
number MAJOR_NUM, but there also exists "Major," the dynamic
one, which results in registration and deregistration on different
device. Once the module remove, it cannot insert again:

  $ sudo insmod chardev2.ko
  $ sudo rmmod chardev2
  $ cat /proc/devices
  Character devices:
  ...
  100 char_dev
  $ sudo insmod chardev2.ko
  insmod: ERROR: could not insert module chardev2.ko: Device or resource busy

This patch removed the use of dynamic major number.

Merge pull request #75 from tuckerpo/fix/errno_assignment

Fix: errno assignment should be comparison.

Fix: errno assignment should be comparison.

Get rid of the initial 0 that shows up in every (sub)section

Every section and subsection number can be eliminated by adding the
renewcommand.

Suggested by Lars Engebretsen.

Merge pull request #74 from brdbkr/master

Fixed typo

Fixing typo

Merge pull request #70 from fennecJ/patch

Adapt recent kernel changes

Update several example code for newer kernel

Known issues with current example code:
If you using newer kernel(e.g linux 5.11.x) to compile the example code,
you may meet following error:
1. syscall.c:83:50: error: ‘ksys_close’ undeclared;
2. cryptosk.c:17:24: error: field ‘sg’ has incomplete type
3. cryptosk.c:143:9: error: implicit declaration of function
‘get_random_bytes’
4. error: macro "DECLARE_TASKLET" passed 3 arguments, but takes just 2

Solutions/workaround:
1. In syscall.c, replace #include <linux/syscalls.h> with
#include <linux/fdtable.h> and replace  ksys_close with close_fd
if the kernel version >= 5.11. [1][2]
2. Add #include <linux/scatterlist.h> into cryptosk.c
3. Add #include <linux/random.h> into cryptosk.c
4. In bottomhalf.c and example_tasklet.c, replace DECLARE_TASKLET
with DECLARE_TASKLET_OLD and dispose third argument(0L). [3]

[1] - https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=1572bfdf21d4d50e51941498ffe0b56c2289f783
[2] - https://www.mail-archive.com/meta-arago@arago-project.org//msg11939.html
[3] - https://patchwork.kernel.org/project/kernel-hardening/patch/20200716030847.1564131-3-keescook@chromium.org/

Merge pull request #69 from gagachang/master

Update path to kernel v5.x

Update some file path to kernel v5.x+ in example/kbleds.c

1. drivers/char/vt_ioctl.c -> drivers/tty/vt/vt_ioctl.c
2. drivers/char/keyboard.c -> drivers/tty/vt/keyboard.c

Use recent kernel build messages

Revise the version magic descriptions for recent kernels

Fix wording

Neither latexmk nor dvipng is required

The package texlive-bin from extra also contains a dvipng binary.

Close #58

Merge pull request #67 from fennecJ/master

Add pdf download link in html only

Add PDF download link in html only

Close #64

Check coding style in CI

Merge pull request #66 from CyrilBrulebois/master

Proofreading and small improvements

Adjust link to ioctl-number.rst

Improve wording (avoid a send/sent repetition along the way)

Use an https:// link for LWN

Improve wording (statistics seem gathered, not stat-ed)

Improve wording (there's only one kernel)

Add emphasis for the y/m values

Fix various typos

Mention pr_info() rather than KERN_INFO

The latter might have been used along with printk() in an earlier
version, but pr_info() is getting used consistently so adjust the
#include comments accordingly.

For the avoidance of doubt, pr_info() actually comes from printk.h,
which gets #include'd by kernel.h.

Improve the descriptions about reference count (#62)

The term "reference count" would be better than "use count."
In addition, the usage of module_refcount(THIS_MODULE) was appended
for the reference counter query.

Merge pull request #63 from fennecJ/patch2

Fix typo

Fix typo

Use \verb for the identifiers starting with "--"

Remove never implemented MODULE_SUPPORTED_DEVICE

MODULE_SUPPORTED_DEVICE is remove from upstream since March 17, 2021.
See linux.git commit 6417f03

Reported by Niklas Lantau <niklaslantau@gmail.com>
Close #61

Avoid incorrectly separated words (#55)

This patch fixed some typos and added the missing punctuation.

Merge pull request #60 from fennecJ/patch

Fix grammar and typo

Fix grammar and typo

Annotate more directories/files

Merge pull request #57 from fennecJ/patch

Fix typo

Fix typo

Merge pull request #56 from bbenno/fix/typo

Fix typo: concurent -> concurrent

Fix typo: concurent -> concurrent

Merge pull request #54 from fennecJ/patch

Fix typo

Fix typo

Make insmod/rmmod more consistent

Merge pull request #53 from fennecJ/patch

Fix incorrect path

Fix incorrect path

There should be a space between uname and -r

Merge pull request #51 from ChinYikMing/fix-init-mesg

Fix init message

Fix init message

Remove out-of-date information

Annotate NULL

Fix wording

Point to corresponding kernel header

Annotate more commands

Introduce \src to generate Linux kernel source hyperlinks

The new command \src was introduced for preliminary hyperlink generation
which points to Linux kernel source code. At present, stable/linux.git
was referred:
  https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git

We might switch to specific LTS kernels once requested.

Revise the path of Linux kernel headers

This patch uses the relative path to Linux kernel headers in source tree
rather than what they are usually inclused in LKM. It would be great to
introduce \href with appropriate hyperlinks to Linux kernel tree.

Clarify kernel header inclusion

Both <linux/module.h> and <linux/kernel.h> are essential headers, and
LKM should include them. Here, we do not use the fully qualified path
specifying the headers.

Change the header file which defines sys_delete_module

Annotate function calls

Annotate more commands

Annotate 'mknod' command

Add hyperlinks to microkernel examples

Update tLDP hyperlink

Add hyperlink to Understanding The Linux Kernel

Fix layout with \LaTeX

Always mention \LaTeX rather than plain text form

Fix cross reference

Use the newer entries for Linux kernel documentation

Annotate the path

Remove out-of-date kernel source descriptions

Update .gitignore

Unify the annotations

This patch enforces the annotations by means of the following:
  * \cpp : C/C++ code, functions, variables, macros, symbols
  * \sh : commands, executable files
  * \verb : path and filenames

Merge pull request #49 from henrybear327/latex/add_very_style_inline_code

Add \cpp and \sh syntax for inline code

Add inline code blocks by using newmintinline

We can now use \cpp|...| and \sh|...| to add inline code blocks, which
resembles the \verb|...| syntax

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

Merge pull request #50 from VxTeemo/patch-1

Fix minor typo

fix minor typo

verb warp wrong at line 330 "linux/.config"

Merge pull request #48 from fennecJ/patch

Temporary fix release action failed issue

Temporary fix release action failed issue

Merge pull request #47 from fennecJ/patch

Remove _minted-lkmpg directory after compiled pdf

Remove _minted-lkmpg directory after compiled pdf

The _minted-lkmpg directory should be removed AFTER all compile work is
done.

Merge pull request #46 from arushsharma24/patch-1

Fix typo

fix minor typo

Fixes a very minor typo.

Make program style consistent again

Fix alignment problem in code block (#45)

In rendered HTML, the line number should be right aligned, and
code should be left aligned accordingly.

In addition, this patch added the basic build instructions, so that
someone can generated the PDF and HTML files.

Close #44

Apply editorial changes

This patch makes source listing shorter and more compact, that helps
when browsing.

Drop the deprecated init_module() and cleanup_module()

Enforce consistent style

Execute "make indent" before submitting patches.

Mention the availability of PDF pre-release

Tweak pdfLaTeX related commands

Tidy the rest of chapters