xref: /openbsd/usr.bin/kdump/mksubr (revision 4ec73a12) 
1#!/bin/sh
2# $OpenBSD: mksubr,v 1.38 2022/02/22 17:35:01 deraadt Exp $
3#
4# Copyright (c) 2006 David Kirchner <dpk@dpk.net>
5#
6# Permission to use, copy, modify, and distribute this software for any
7# purpose with or without fee is hereby granted, provided that the above
8# copyright notice and this permission notice appear in all copies.
9#
10# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17#
18# $FreeBSD: src/usr.bin/kdump/mksubr,v 1.17 2011/06/06 19:00:38 dchagin Exp $
19#
20# Generates kdump_subr.c
21# mkioctls is a special-purpose script, and works fine as it is
22# now, so it remains independent. The idea behind how it generates
23# its list was heavily borrowed here.
24#
25# Some functions here are automatically generated. This can mean
26# the user will see unusual kdump output or errors while building
27# if the underlying .h files are changed significantly.
28#
29# Key:
30# AUTO: Completely auto-generated with either the "or" or the "switch"
31# method.
32# AUTO - Special: Generated automatically, but with some extra commands
33# that the auto_*_type() functions are inappropriate for.
34# MANUAL: Manually entered and must therefore be manually updated.
35
36set -e
37
38LC_ALL=C; export LC_ALL
39
40if [ -z "$1" ]
41then
42	echo "usage: sh $0 include-dir"
43	exit 1
44fi
45include_dir=$1
46
47#
48# Automatically generates a C function that will print out the
49# numeric input as a pipe-delimited string of the appropriate
50# #define keys. ex:
51# 0x1a4<S_IRUSR|S_IWUSR|S_IRGRP|S_IROTH>
52# The XOR is necessary to prevent including the "0"-value in every
53# line.
54#
55auto_or_type () {
56	local name grep file
57	name=$1
58	grep=$2
59	file=$3
60	format=${4-%#x}
61
62	cat <<_EOF_
63/* AUTO */
64void
65$name (int arg)
66{
67	int	or = 0;
68	printf("$format<", arg);
69_EOF_
70	egrep "^#[[:space:]]*define[[:space:]]+"${grep}"[[:space:]]*" \
71		$include_dir/$file | \
72	awk '{ for (i = 1; i <= NF; i++) \
73		if ($i ~ /define/) \
74			break; \
75		++i; \
76		printf "\tif(!((arg>0)^((%s)>0)))\n\t\tif_print_or(arg, %s, or);\n", $i, $i }'
77cat <<_EOF_
78	printf(">");
79	if (or == 0)
80		(void)printf("<invalid>%d", arg);
81}
82
83_EOF_
84}
85
86#
87# Like auto_or_type(), but a zero value is valid and prints as "0<>"
88#
89auto_orz_type () {
90	local name grep file
91	name=$1
92	grep=$2
93	file=$3
94	format=${4-%#x}
95
96	cat <<_EOF_
97/* AUTO */
98void
99$name (int arg)
100{
101	int	or = 0;
102	if (arg == 0) {
103		printf("0<>");
104		return;
105	}
106	printf("$format<", arg);
107_EOF_
108	egrep "^#[[:space:]]*define[[:space:]]+"${grep}"[[:space:]]*" \
109		$include_dir/$file | \
110	awk '{ for (i = 1; i <= NF; i++) \
111		if ($i ~ /define/) \
112			break; \
113		++i; \
114		printf "\tif(!((arg>0)^((%s)>0)))\n\t\tif_print_or(arg, %s, or);\n", $i, $i }'
115cat <<_EOF_
116	printf(">");
117	if (or == 0)
118		(void)printf("<invalid>%d", arg);
119}
120
121_EOF_
122}
123
124#
125# Automatically generates a C function that will print out a
126# file flags input as a pipe-delimited string of the appropriate
127# #define keys. ex:
128# 0x30000<O_RDONLY|O_CLOEXEC|O_DIRECTORY>
129# This is different than the others to handle O_RDONLY correctly when
130# other flags are present and to diagnose an invalid O_ACCMODE value
131#
132auto_fflags_type () {
133	local name grep file
134	name=$1
135	grep=$2
136	file=$3
137
138	cat <<_EOF_
139/* AUTO */
140void
141$name (int arg, int show_accmode)
142{
143	int	or = 0;
144
145	printf("%#x<", arg);
146	if (show_accmode || (arg & O_ACCMODE)) {
147		or = 1;
148		switch (arg & O_ACCMODE) {
149		case O_RDONLY:
150			printf("O_RDONLY");
151			break;
152		case O_WRONLY:
153			printf("O_WRONLY");
154			break;
155		case O_RDWR:
156			printf("O_RDWR");
157			break;
158		default:
159			printf("<invalid>O_ACCMODE");
160			break;
161		}
162	}
163_EOF_
164	egrep "^#[[:space:]]*define[[:space:]]+"${grep}"[[:space:]]*" \
165		$include_dir/$file | \
166	egrep -v 'O_(RD(ONLY|WR)|WRONLY|ACCMODE)' | \
167	awk '{ for (i = 1; i <= NF; i++) \
168		if ($i ~ /define/) \
169			break; \
170		++i; \
171		printf "\tif_print_or(arg, %s, or);\n", $i }'
172cat <<_EOF_
173	printf(">");
174}
175
176/*
177 * Wrappers of the above to use with pn()
178 */
179void
180flagsname(int flags)
181{
182	doflagsname(flags, 0);
183}
184
185void
186openflagsname(int flags)
187{
188	doflagsname(flags, 1);
189}
190
191
192_EOF_
193}
194
195
196#
197# Automatically generates a C function used when the argument
198# maps to a single, specific #definition
199#
200auto_switch_type () {
201	local name grep file
202	name=$1
203	grep=$2
204	file=$3
205
206	cat <<_EOF_
207/* AUTO */
208void
209$name (int arg)
210{
211	switch (arg) {
212_EOF_
213	egrep "^#[[:space:]]*define[[:space:]]+"${grep}"[[:space:]]*" \
214		$include_dir/$file | \
215	awk '{ for (i = 1; i <= NF; i++) \
216		if ($i ~ /define/) \
217			break; \
218		++i; \
219		printf "\tcase %s:\n\t\t(void)printf(\"%s\");\n\t\tbreak;\n", $i, $i }'
220cat <<_EOF_
221	default: /* Should not reach */
222		(void)printf("<invalid=%d>", arg);
223	}
224}
225
226_EOF_
227}
228
229#
230# Automatically generates a C function used when the argument
231# maps to a #definition
232#
233auto_if_type () {
234	local name grep file
235	name=$1
236	grep=$2
237	file=$3
238
239	cat <<_EOF_
240/* AUTO */
241void
242$name (int arg)
243{
244_EOF_
245	egrep "^#[[:space:]]*define[[:space:]]+"${grep}"[[:space:]]*" \
246		$include_dir/$file | \
247	awk '{ printf "\t"; \
248		if (NR > 1) \
249			printf "else " ; \
250		printf "if (arg == %s) \n\t\tprintf(\"%s\");\n", $2, $2 }'
251cat <<_EOF_
252	else /* Should not reach */
253		(void)printf("<invalid=%d>", arg);
254}
255
256_EOF_
257}
258
259# C start
260
261cat <<_EOF_
262#include <sys/types.h>
263#include <sys/signal.h>
264#include <sys/event.h>
265#include <sys/fcntl.h>
266#include <sys/stat.h>
267#include <sys/unistd.h>
268#define _KERNEL
269#include <sys/mman.h>
270#undef _KERNEL
271#include <sys/wait.h>
272#include <sys/proc.h>
273#include <sys/socket.h>
274#include <netinet/in.h>
275#include <sys/mount.h>
276#include <sys/poll.h>
277#include <sys/ptrace.h>
278#include <sys/resource.h>
279#include <sys/reboot.h>
280#include <sys/uio.h>
281#include <sys/ktrace.h>
282#include <sched.h>
283#if 0
284#include <sys/linker.h>
285#define _KERNEL
286#include <sys/thr.h>
287#undef _KERNEL
288#include <sys/extattr.h>
289#include <sys/acl.h>
290#include <aio.h>
291#endif
292#include <sys/sem.h>
293#include <sys/ipc.h>
294#if 0
295#include <sys/rtprio.h>
296#endif
297#include <sys/shm.h>
298#if 0
299#include <nfsserver/nfs.h>
300#endif
301#include <ufs/ufs/quota.h>
302#include <sys/syslog.h>
303#include <sys/futex.h>
304#include <stdio.h>
305
306#include "kdump_subr.h"
307
308_EOF_
309
310auto_orz_type "modename" "S_[A-Z]+[[:space:]]+[0-6]{7}" "sys/stat.h" "%#o"
311auto_fflags_type "doflagsname" "O_[A-Z]+[[:space:]]+0x[0-9A-Fa-f]+" "sys/fcntl.h"
312auto_orz_type "atflagsname" "AT_[A-Z_]+[[:space:]]+0x[0-9A-Fa-f]+" "sys/fcntl.h"
313auto_or_type "accessmodename" "[A-Z]_OK[[:space:]]+0?x?[0-9A-Fa-f]+" "sys/unistd.h"
314auto_or_type "mmapprotname" "PROT_[A-Z]+[[:space:]]+0x[0-9A-Fa-f]+" "sys/mman.h"
315auto_or_type "mmapflagsname" "(__)?MAP_[A-Z]+[[:space:]]+0x[0-9A-Fa-f]+" "sys/mman.h"
316auto_orz_type "wait4optname" "W[A-Z]+[[:space:]]+[0-9]+" "sys/wait.h"
317#auto_or_type "timerflagsname" "TIMER_[A-Z]+[[:space:]]+0x[0-9A-Fa-f]+" "sys/time.h"
318#auto_or_type "getfsstatflagsname" "MNT_[A-Z]+[[:space:]]+[1-9][0-9]*" "sys/mount.h"
319auto_orz_type "mountflagsname" "MNT_[A-Z]+[[:space:]]+0x[0-9]+" "sys/mount.h"
320auto_or_type "rebootoptname" "RB_[A-Z]+[[:space:]]+0x[0-9]+" "sys/reboot.h"
321auto_or_type "flockname" "LOCK_[A-Z]+[[:space:]]+0x[0-9]+" "sys/fcntl.h"
322#auto_or_type "thrcreateflagsname" "THR_[A-Z]+[[:space:]]+0x[0-9]+" "sys/thr.h"
323auto_or_type "mlockallname" "MCL_[A-Z]+[[:space:]]+0x[0-9]+" "sys/mman.h"
324auto_orz_type "shmatname" "SHM_[A-Z]+[[:space:]]+[0-9]{6}" "sys/shm.h"
325#auto_or_type "nfssvcname" "NFSSVC_[A-Z]+[[:space:]]+0x[0-9]+" "nfsserver/nfs.h"
326#
327auto_switch_type "whencename" "SEEK_[A-Z]+[[:space:]]+[0-9]+" "sys/unistd.h"
328auto_switch_type "pathconfname" "_PC_[_A-Z]+[[:space:]]+[0-9]+" "sys/unistd.h"
329auto_switch_type "rlimitname" "RLIMIT_[A-Z]+[[:space:]]+[0-9]+" "sys/resource.h"
330auto_switch_type "shutdownhowname" "SHUT_[A-Z]+[[:space:]]+[0-9]+" "sys/socket.h"
331auto_switch_type "prioname" "PRIO_[A-Z]+[[:space:]]+[0-9]" "sys/resource.h"
332auto_switch_type "madvisebehavname" "MADV_[A-Z]+[[:space:]]+[0-9A-Z_]+" "sys/mman.h"
333auto_switch_type "msyncflagsname" "MS_[A-Z]+[[:space:]]+0x[0-9]+" "sys/mman.h"
334auto_switch_type "clocktypename" "CLOCK_[_A-Z]+[[:space:]]+[0-9]+" "sys/_time.h"
335#auto_switch_type "schedpolicyname" "SCHED_[A-Z]+[[:space:]]+[0-9]+" "sched.h"
336#auto_switch_type "kldunloadfflagsname" "LINKER_UNLOAD_[A-Z]+[[:space:]]+[0-9]+" "sys/linker.h"
337#auto_switch_type "extattrctlname" "EXTATTR_NAMESPACE_[A-Z]+[[:space:]]+0x[0-9]+" "sys/extattr.h"
338#auto_switch_type "kldsymcmdname" "KLDSYM_[A-Z]+[[:space:]]+[0-9]+" "sys/linker.h"
339#auto_switch_type "sendfileflagsname" "SF_[A-Z]+[[:space:]]+[0-9]+" "sys/socket.h"
340#auto_switch_type "acltypename" "ACL_TYPE_[A-Z4_]+[[:space:]]+0x[0-9]+" "sys/acl.h"
341auto_switch_type "rusagewho" "RUSAGE_[A-Z]+[[:space:]]+[-0-9()]+" "sys/resource.h"
342auto_orz_type "sigactionflagname" "SA_[A-Z]+[[:space:]]+0x[0-9]+" "sys/signal.h"
343auto_switch_type "sigprocmaskhowname" "SIG_[A-Z]+[[:space:]]+[0-9]+" "sys/signal.h"
344auto_switch_type "sigill_name" "ILL_[A-Z]+[[:space:]]+[0-9]+" "sys/siginfo.h"
345auto_switch_type "sigtrap_name" "TRAP_[A-Z]+[[:space:]]+[0-9]+" "sys/siginfo.h"
346auto_switch_type "sigemt_name" "EMT_[A-Z]+[[:space:]]+[0-9]+" "sys/siginfo.h"
347auto_switch_type "sigfpe_name" "FPE_[A-Z]+[[:space:]]+[0-9]+" "sys/siginfo.h"
348auto_switch_type "sigbus_name" "BUS_[A-Z]+[[:space:]]+[0-9]+" "sys/siginfo.h"
349auto_switch_type "sigsegv_name" "SEGV_[A-Z]+[[:space:]]+[0-9]+" "sys/siginfo.h"
350auto_switch_type "sigchld_name" "CLD_[A-Z]+[[:space:]]+[0-9]+" "sys/siginfo.h"
351#auto_switch_type "lio_listioname" "LIO_(NO)?WAIT[[:space:]]+[0-9]+" "aio.h"
352auto_switch_type "minheritname" "MAP_INHERIT_[A-Z]+[[:space:]]+[0-9]+" "sys/mman.h"
353auto_switch_type "quotactlname" "Q_[A-Z]+[[:space:]]+0x[0-9]+" "ufs/ufs/quota.h"
354#auto_if_type "sockdomainname" "PF_[[:alnum:]]+[[:space:]]+" "sys/socket.h"
355auto_if_type "sockfamilyname" "AF_[[:alnum:]]+[[:space:]]+" "sys/socket.h"
356auto_if_type "sockipprotoname" "IPPROTO_[[:alnum:]]+[[:space:]]+" "netinet/in.h"
357auto_switch_type "sockoptname" "SO_[A-Z]+[[:space:]]+0x[0-9]+" "sys/socket.h"
358#auto_switch_type "ptraceopname" "PT_[[:alnum:]_]+[[:space:]]+[0-9]+" "sys/ptrace.h"
359# exclude KTRFAC_MASK
360auto_orz_type "ktracefacname" "KTRFAC_[^M][[:alnum:]_]+" "sys/ktrace.h"
361auto_switch_type "itimername" "ITIMER_[[:alnum:]_]+" "sys/time.h"
362auto_switch_type "evfiltername" "EVFILT_[[:alnum:]_]+[[:space:]]+[(]" "sys/event.h"
363auto_orz_type "pollfdeventname" "POLL[^_][[:alnum:]_]+[[:space:]]+0x" "sys/poll.h"
364# exclude EV_{SYSFLAGS,FLAG1}
365auto_orz_type "evflagsname" "EV_[^S][A-Z]+[[:space:]]+0x" "sys/event.h"
366auto_orz_type "syslogflagname" "LOG_[A-Z]+[[:space:]]+0x0*[1248]0*[[:space:]]" "sys/syslog.h"
367auto_orz_type "futexflagname" "FUTEX_[A-Z_]+[[:space:]]+[0-9]+" "sys/futex.h"
368auto_switch_type "flocktypename" "F_[A-Z]+LCK" "sys/fcntl.h"
369
370cat <<_EOF_
371/*
372 * AUTO - Special
373 * F_ is used to specify fcntl commands as well as arguments. Both sets are
374 * grouped in fcntl.h, and this awk script grabs the first group.
375 */
376void
377fcntlcmdname (int arg)
378{
379	int noarg = 0;
380
381	switch (arg1) {
382_EOF_
383egrep "^#[[:space:]]*define[[:space:]]+F_[A-Z_]+[[:space:]]+[0-9]+[[:space:]]*" \
384	$include_dir/sys/fcntl.h | \
385	awk 'BEGIN { o=0; \
386		noarg["F_GETFD"] = 1; \
387		noarg["F_GETFL"] = 1; \
388		noarg["F_ISATTY"] = 1; \
389		noarg["F_GETOWN"] = 1; \
390	     }{ for (i = 1; i <= NF; i++) \
391		if ($i ~ /define/) \
392			break; \
393		++i; \
394		if (o > $(i+1)) \
395			exit; \
396		printf "\tcase %s:\n\t\t(void)printf(\"%s\");%s\n\t\tbreak;\n", $i, $i, \
397			noarg[$i] ? "\n\t\tnoarg = 1;" : ""; \
398		o = $(i+1) }'
399cat <<_EOF_
400	default: /* Should not reach */
401		(void)printf("<invalid=%d>", arg1);
402	}
403	if (arg1 == F_SETFD) {
404		(void)putchar(',');
405		if (arg == FD_CLOEXEC)
406			(void)printf("FD_CLOEXEC");
407		else if (arg == 0)
408			(void)printf("0");
409		else
410			(void)printf("<invalid>%#x", arg);
411
412	} else if (arg1 == F_SETFL) {
413		(void)putchar(',');
414		doflagsname(arg, 0);
415	} else if (!fancy || !noarg)
416		(void)printf(",%#x", arg);
417}
418
419/*
420 * AUTO - Special
421 *
422 * The send and recv functions have a flags argument which can be
423 * set to 0. There is no corresponding #define. The auto_ functions
424 * detect this as "invalid", which is incorrect here.
425 */
426void
427sendrecvflagsname (int flags)
428{
429	int	or = 0;
430
431	if (flags == 0) {
432		(void)printf("0");
433		return;
434	}
435
436	printf("%#x<", flags);
437_EOF_
438egrep "^#[[:space:]]*define[[:space:]]+MSG_[_A-Z]+[[:space:]]+0x[0-9]+[[:space:]]*" $include_dir/sys/socket.h | \
439	awk '{ for (i = 1; i <= NF; i++) \
440		if ($i ~ /define/) \
441			break; \
442		++i; \
443		printf "\tif(!((flags>0)^((%s)>0)))\n\t\tif_print_or(flags, %s, or);\n", $i, $i }'
444cat <<_EOF_
445	printf(">");
446}
447
448/*
449 * AUTO - Special
450 *
451 * SOCK_NONBLOCK and SOCK_CLOEXEC are or'ed into the type
452 */
453static void
454dosocktypename (int arg, int show_type)
455{
456	int	type = arg & 0xff;		/* XXX */
457	int	or = 0;
458	
459	printf("%#x<", arg);
460	if (show_type || type) {
461		or = 1;
462		switch (type) {
463_EOF_
464	egrep "^#[[:space:]]*define[[:space:]]+SOCK_[A-Z]+[[:space:]]+[1-9]+[0-9]*[[:space:]]*" \
465		$include_dir/sys/socket.h | \
466	awk '{ for (i = 1; i <= NF; i++) \
467		if ($i ~ /define/) \
468			break; \
469		++i; \
470		printf "\t\tcase %s:\n\t\t\t(void)printf(\"%s\");\n\t\t\tbreak;\n", $i, $i }'
471cat <<_EOF_
472		default: /* Should not reach */
473			(void)printf("<invalid=%d>", arg);
474		}
475	}
476
477_EOF_
478	egrep "^#[[:space:]]*define[[:space:]]+SOCK_[A-Z]+[[:space:]]+0x[0-9]+[[:space:]]*" \
479		$include_dir/sys/socket.h | \
480	awk '{ for (i = 1; i <= NF; i++) \
481		if ($i ~ /define/) \
482			break; \
483		++i; \
484		printf "\tif_print_or(arg, %s, or);\n", $i }'
485cat <<_EOF_
486	printf(">");
487}
488
489void
490socktypename (int arg)
491{
492	dosocktypename(arg, 1);
493}
494
495void
496sockflagsname (int arg)
497{
498	dosocktypename(arg, 0);
499}
500
501void
502quotactlcmdname(int cmd)
503{
504	printf("%#x<QCMD(", cmd);
505	quotactlname(cmd >> SUBCMDSHIFT);
506	switch (cmd & SUBCMDMASK) {
507	case USRQUOTA:
508		printf(",%s)>", "USRQUOTA");
509		break;
510	case GRPQUOTA:
511		printf(",%s)>", "GRPQUOTA");
512		break;
513	default:
514		printf(",<invalid>%#x)>", cmd & SUBCMDMASK);
515		break;
516	}
517}
518
519/*
520 * AUTO - Special
521 *
522 * kevent() NOTE_* interpretation depends on the filter type
523 */
524void
525evfflagsname (int filter, int fflags)
526{
527	int	or = 0;
528
529	if (fflags == 0) {
530		printf("0<>");
531		return;
532	}
533	printf("%#x<", fflags);
534	switch (filter) {
535	case EVFILT_READ:
536	case EVFILT_WRITE:
537		if_print_or(fflags, NOTE_LOWAT, or);
538		if_print_or(fflags, NOTE_EOF, or);
539		break;
540	case EVFILT_VNODE:
541_EOF_
542	egrep "^#[[:space:]]*define[[:space:]]+NOTE_.[^O][A-Z]+[[:space:]]+0x[01248]{4}[^[:alnum:]]" \
543		$include_dir/sys/event.h | \
544	awk '{ for (i = 1; i <= NF; i++) \
545		if ($i ~ /define/) \
546			break; \
547		++i; \
548		printf "\t\tif_print_or(fflags, %s, or);\n", $i }'
549cat <<_EOF_
550		break;
551	case EVFILT_PROC:
552_EOF_
553	egrep "^#[[:space:]]*define[[:space:]]+NOTE_[^S][A-Z]+[[:space:]]+0x[01248]{8}" \
554		$include_dir/sys/event.h | \
555	awk '{ for (i = 1; i <= NF; i++) \
556		if ($i ~ /define/) \
557			break; \
558		++i; \
559		printf "\t\tif_print_or(fflags, %s, or);\n", $i }'
560cat <<_EOF_
561		break;
562	}
563	printf(">");
564}
565
566_EOF_
567