README
1 $NetBSD: README,v 1.15 2020/04/30 00:48:10 christos Exp $
2
3 Kernel Developer's Manual
4
5DESCRIPTION
6 The kernel example dynamic modules.
7
8 This directory contains the following example modules:
9 * current_time - prints current date and time in GMT/UTC
10 * executor - basic implementation of callout and RUN_ONCE
11 * fopsmapper - basic implementation of mmap with fileops fo_mmap
12 * hello - the simplest `hello world' module
13 * luahello - the simplest `hello world' Lua module
14 * luareadhappy - demonstrates calling Lua code from C
15 * mapper - basic implementation of mmap
16 * panic_string - shows how panic is being called through a device
17 * ping - basic ioctl(9)
18 * ping_block - basic ioctl(9) with a block device
19 * properties - handle incoming properties during the module load
20 * pollpal - implementation of basic poll(9) using palindrome
21 * readhappy - basic implementation of read(9) with happy numbers
22 * readhappy_mpsafe- demonstrates how to make a module MPSAFE
23 * sysctl - demonstrates adding a sysctl handle dynamically
24
25 To build the examples you need a local copy of NetBSD sources. You also
26 need the comp set with toolchain. To build the module just enter a
27 directory with example modules and use make(1):
28
29 # make
30
31 To load, unload, and stat the module use modload(8), modunload(8) and
32 modstat(8).
33
34 The S parameter in the Makefile files points to src/sys and it can be
35 overloaded in this way:
36
37 # make S=/data/netbsd/src/sys
38
39 The code of a module does not need to be in src/sys unless it uses
40 the autoconf(9) framework.
41
42 A cross-build of a module for a target platform is possible with the
43 build.sh framework. You need to generate the toolchain and set
44 appropriately PATH to point bin/ in the TOOLDIR path. An example command
45 to cross-build a module with the amd64 toolchain is as follows:
46
47 # nbmake-amd64 S=/data/netbsd/src/sys
48
49
50 The example modules should not be used on a production machine.
51
52 All modules that create a cdevsw (or bdevsw) should be verified that
53 the major number(s) should not conflict with a real device.
54
55SEE ALSO
56 modctl(2), module(7), modload(8), modstat(8), modunload(8), module(9),
57 intro(9lua)
58
59HISTORY
60 An example of handling incoming properties first appeared in NetBSD 5.0
61 and was written by Julio Merino with further modifications by Martin
62 Husemann, Adam Hamsik, John Nemeth and Mindaugas Rasiukevicius.
63
64 This document and additional modules (hello, readhappy, properties,
65 ping, luahello and luareadhappy) first appeared in NetBSD 8.0; they were
66 written by Kamil Rytarowski.
67
68 The readhappy_mpsafe, executor and sysctls modules first appeared in NetBSD
69 9.0 and were authored by Siddharth Muralee.
70
71 The panic_string module first appeared in NetBSD 9.0 and was authored by
72 Harry Pantazis.
73
74 The mapper module first appeared in NetBSD 9.0 and was authored by
75 Akul Pillai.
76
77 The ping_block module first appeared in NetBSD 10.0 and was authored by
78 Nisarg Joshi.
79
80 The fopsmapper module first appeared in NetBSD 10.0 and was authored by
81 Aditya Vardhan Padala.
82
83 The current_time module first appeared in NetBSD 10.0 and was authored by
84 Apurva Nandan.
85
86 The pollpall module first appeared in NetBSD 10.0 and was authored by
87 Ayushi Sharma.
88
89AUTHORS
90 This document was written by Kamil Rytarowski.
91