github-mirror/lkmpg
2
0
Fork 0
mirror of https://github.com/sysprog21/lkmpg.git synced 2024-11-22 11:43:41 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
The Linux Kernel Module Programming Guide (updated for 5.0+ kernels)
371 Commits 2 Branches 1 Tag 7.9 MiB
TeX 94.4%
Shell 4.9%
Makefile 0.7%
f2ad878e9b
Go to file
keytouch f2ad878e9b syscall_steal: rename sys_call_table to fix compile error 
sys_call_table is already declared in arch/x86/include/asm/syscall.h but of
cource not exported by the kernel.
before this commit, gcc complains as follows:
/usr/src/linux-headers-6.1.0-16-common/arch/x86/include/asm/syscall.h:21:29:
note: previous declaration of 'sys_call_table' with type 'long int (*
const[])(const struct pt_regs *)'
   21 | extern const sys_call_ptr_t sys_call_table[];
2023-12-22 20:17:02 +08:00
.ci CI: Fix "unreplaced" warnings by using git source (#229) 2023-09-17 18:09:48 +08:00
.github/workflows CI: Only perform extensive checks on source file changes 2023-09-18 11:30:54 +08:00
assets Add book cover (#136) 2022-01-09 20:26:07 +08:00
examples syscall_steal: rename sys_call_table to fix compile error 2023-12-22 20:17:02 +08:00
lib Introduce \src to generate Linux kernel source hyperlinks 2021-08-09 23:01:34 +08:00
scripts Refine contributor list 2023-08-11 10:38:18 +08:00
.gitignore Exclude generated files 2023-09-18 02:06:51 +08:00
.mailmap Refine contributor list 2023-08-11 10:38:18 +08:00
contrib.tex Refine contributor list 2023-08-11 10:38:18 +08:00
GPL-2 Initial import 2021-07-22 06:34:19 +08:00
html.cfg Add Manrope variable font (#118) 2021-10-10 21:34:25 +08:00
LICENSE Initial import 2021-07-22 06:34:19 +08:00
lkmpg.tex syscall: rename module name to syscall_steal 2023-12-22 20:14:42 +08:00
Makefile Update README and Makefile for the latexmk existence check 2022-03-18 20:16:02 +01:00
README.md Explicitly mention 6.x kernels 2023-09-17 18:24:27 +08:00

README.md

The Linux Kernel Module Programming Guide

This project keeps the Linux Kernel Module Programming Guide up to date, with working examples for recent 5.x and 6.x kernel versions.
The guide has been around since 2001 and most copies of it on the web only describe old 2.6.x kernels.

The book can be freely accessed via https://sysprog21.github.io/lkmpg/ or latest PDF file.
The original guide may be found at Linux Documentation Project.
You may check other freely available programming books listed by The Free Ebook Foundation or Linux online books collected by The Online Books Page.

Getting Started

Summary

  1. Get the latest source code from the GitHub page.
  2. Install the prerequisites.
  3. Generate PDF and/or HTML documents.

Step 1: Get the latest source code

Make sure you can run git with an Internet connection.

$ git clone https://github.com/sysprog21/lkmpg.git && cd lkmpg

Step 2: Install the prerequisites

To generate the book from source, TeXLive (MacTeX) is required.

For Ubuntu Linux, macOS, and other Unix-like systems, run the following command(s):

# Debian / Ubuntu
$ sudo apt install make texlive-full

# Arch / Manjaro
$ sudo pacman -S make texlive-binextra texlive-bin

# macOS
$ brew install mactex
$ sudo tlmgr update --self

Note that latexmk is required to generated PDF, and it probably has been installed on your OS already. If not, please follow the installation guide.

In macOS systems, package Pygments may not be pre-installed. If not, please refer to the installation guide before generate documents.

Alternatively, using Docker is recommended, as it guarantees the same dependencies with our GitHub Actions workflow.
After install docker engine on your machine, pull the docker image twtug/lkmpg and run in isolated containers.

# pull docker image and run it as container
$ docker pull twtug/lkmpg
$ docker run --rm -it -v $(pwd):/workdir twtug/lkmpg

nerdctl is a Docker-compatible command line tool for containerd, and you can replace the above docker commands with nerdctl counterparts.

Step 3: Generate PDF and/or HTML documents

Now we could build document with following commands:

$ make all              # Generate PDF document
$ make html             # Convert TeX to HTML
$ make clean            # Delete generated files

License

The Linux Kernel Module Programming Guide is a free book; you may reproduce and/or modify it under the terms of the Open Software License.
Use of this work is governed by a copyleft license that can be found in the LICENSE file.

The complementary sample code is licensed under GNU GPL version 2, as same as Linux kernel.