mksubr revision 168543 
1set -e
2
3# Generates kdump_subr.c
4# mkioctls is a special-purpose script, and works fine as it is
5# now, so it remains independent. The idea behind how it generates
6# its list was heavily borrowed here.
7#
8# Some functions here are automatically generated. This can mean
9# the user will see unusual kdump output or errors while building
10# if the underlying .h files are changed significantly.
11#
12# Key:
13# AUTO: Completely auto-generated with either the "or" or the "switch"
14# method.
15# AUTO - Special: Generated automatically, but with some extra commands
16# that the auto_*_type() functions are inappropriate for.
17# MANUAL: Manually entered and must therefore be manually updated.
18
19# $FreeBSD: head/usr.bin/kdump/mksubr 168543 2007-04-09 19:16:24Z emaste $
20
21LC_ALL=C; export LC_ALL
22
23if [ -z "$1" ]
24then
25	echo "usage: sh $0 include-dir"
26	exit 1
27fi
28include_dir=$1
29
30#
31# Automatically generates a C function that will print out the
32# numeric input as a pipe-delimited string of the appropriate
33# #define keys. ex:
34# S_IRUSR|S_IWUSR|S_IRGRP|S_IROTH
35# The XOR is necessary to prevent including the "0"-value in every
36# line.
37#
38auto_or_type () {
39	local name grep file
40	name=$1
41	grep=$2
42	file=$3
43
44	cat <<_EOF_
45/* AUTO */
46void
47$name (int arg)
48{
49	int	or = 0;
50_EOF_
51	egrep "^#[[:space:]]*define[[:space:]]+"${grep}"[[:space:]]*" \
52		$include_dir/$file | \
53	awk '{ for (i = 1; i <= NF; i++) \
54		if ($i ~ /define/) \
55			break; \
56		++i; \
57		printf "\tif(!((arg>0)^((%s)>0)))\n\t\tif_print_or(arg, %s, or);\n", $i, $i }'
58cat <<_EOF_
59	if (or == 0)
60		(void)printf("<invalid>%ld", (long)arg);
61}
62
63_EOF_
64}
65
66#
67# Automatically generates a C function used when the argument
68# maps to a single, specific #definition
69#
70auto_switch_type () {
71	local name grep file
72	name=$1
73	grep=$2
74	file=$3
75
76	cat <<_EOF_
77/* AUTO */
78void
79$name (int arg)
80{
81	switch (arg) {
82_EOF_
83	egrep "^#[[:space:]]*define[[:space:]]+"${grep}"[[:space:]]*" \
84		$include_dir/$file | \
85	awk '{ for (i = 1; i <= NF; i++) \
86		if ($i ~ /define/) \
87			break; \
88		++i; \
89		printf "\tcase %s:\n\t\t(void)printf(\"%s\");\n\t\tbreak;\n", $i, $i }'
90cat <<_EOF_
91	default: /* Should not reach */
92		(void)printf("<invalid=%ld>", (long)arg);
93	}
94}
95
96_EOF_
97}
98
99#
100# Automatically generates a C function used when the argument
101# maps to a #definition
102#
103auto_if_type () {
104	local name grep file
105	name=$1
106	grep=$2
107	file=$3
108
109	cat <<_EOF_
110/* AUTO */
111void
112$name (int arg)
113{
114_EOF_
115	egrep "^#[[:space:]]*define[[:space:]]+"${grep}"[[:space:]]*" \
116		$include_dir/$file | \
117	awk '{ printf "\t"; \
118		if (NR > 1) \
119			printf "else " ; \
120		printf "if (arg == %s) \n\t\tprintf(\"%s\");\n", $2, $2 }'
121cat <<_EOF_
122	else /* Should not reach */
123		(void)printf("<invalid=%ld>", (long)arg);
124}
125
126_EOF_
127}
128
129# C start
130
131cat <<_EOF_
132#include <stdio.h>
133#include <sys/fcntl.h>
134#include <sys/stat.h>
135#include <sys/unistd.h>
136#include <sys/mman.h>
137#include <sys/wait.h>
138#define _KERNEL
139#include <sys/socket.h>
140#undef _KERNEL
141#include <netinet/in.h>
142#include <sys/param.h>
143#include <sys/mount.h>
144#include <sys/ptrace.h>
145#include <sys/resource.h>
146#include <sys/reboot.h>
147#include <sched.h>
148#include <sys/linker.h>
149#define _KERNEL
150#include <sys/thr.h>
151#undef _KERNEL
152#include <sys/kse.h>
153#include <sys/extattr.h>
154#include <sys/acl.h>
155#include <aio.h>
156#include <sys/sem.h>
157#include <sys/ipc.h>
158#include <sys/rtprio.h>
159#include <sys/shm.h>
160#include <nfsserver/nfs.h>
161#include <ufs/ufs/quota.h>
162
163#include "kdump_subr.h"
164
165/*
166 * These are simple support macros. print_or utilizes a variable
167 * defined in the calling function to track whether or not it should
168 * print a logical-OR character ('|') before a string. if_print_or
169 * simply handles the necessary "if" statement used in many lines
170 * of this file.
171 */
172#define print_or(str,orflag) do {                  \\
173	if (orflag) putchar('|'); else orflag = 1; \\
174	printf (str); }                            \\
175	while (0)
176#define if_print_or(i,flag,orflag) do {            \\
177	if ((i & flag) == flag)                    \\
178	print_or(#flag,orflag); }                  \\
179	while (0)
180
181/* MANUAL */
182extern char *signames[]; /* from kdump.c */
183void
184signame (int sig)
185{
186	if (sig > 0 && sig < NSIG)
187		(void)printf("SIG%s",signames[sig]);
188	else
189		(void)printf("SIG %d", sig);
190}
191
192/* MANUAL */
193void
194semctlname (int cmd)
195{
196	switch (cmd) {
197	case GETNCNT:
198		(void)printf("GETNCNT");
199		break;
200	case GETPID:
201		(void)printf("GETPID");
202		break;
203	case GETVAL:
204		(void)printf("GETVAL");
205		break;
206	case GETALL:
207		(void)printf("GETALL");
208		break;
209	case GETZCNT:
210		(void)printf("GETZCNT");
211		break;
212	case SETVAL:
213		(void)printf("SETVAL");
214		break;
215	case SETALL:
216		(void)printf("SETALL");
217		break;
218	case IPC_RMID:
219		(void)printf("IPC_RMID");
220		break;
221	case IPC_SET:
222		(void)printf("IPC_SET");
223		break;
224	case IPC_STAT:
225		(void)printf("IPC_STAT");
226		break;
227	default: /* Should not reach */
228		(void)printf("<invalid=%ld>", (long)cmd);
229	}
230}
231
232/* MANUAL */
233void
234shmctlname (int cmd) {
235	switch (cmd) {
236	case IPC_RMID:
237		(void)printf("IPC_RMID");
238		break;
239	case IPC_SET:
240		(void)printf("IPC_SET");
241		break;
242	case IPC_STAT:
243		(void)printf("IPC_STAT");
244		break;
245	default: /* Should not reach */
246		(void)printf("<invalid=%ld>", (long)cmd);
247	}
248}
249
250/* MANUAL */
251void
252semgetname (int flag) {
253	int	or = 0;
254	if_print_or(flag, SEM_R, or);
255	if_print_or(flag, SEM_A, or);
256	if_print_or(flag, (SEM_R>>3), or);
257	if_print_or(flag, (SEM_A>>3), or);
258	if_print_or(flag, (SEM_R>>6), or);
259	if_print_or(flag, (SEM_A>>6), or);
260}
261
262/*
263 * MANUAL
264 *
265 * Only used by SYS_open. Unless O_CREAT is set in flags, the
266 * mode argument is unused (and often bogus and misleading).
267 */
268void
269flagsandmodename (int flags, int mode, int decimal) {
270	flagsname (flags);
271	(void)putchar(',');
272	if ((flags & O_CREAT) == O_CREAT) {
273		modename (mode);
274	} else {
275		if (decimal) {
276			(void)printf("<unused>%ld", (long)mode);
277		} else {
278			(void)printf("<unused>%#lx", (long)mode);
279		}
280	}
281}
282
283/*
284 * MANUAL
285 *
286 * [g|s]etsockopt's level argument can either be SOL_SOCKET or a value
287 * referring to a line in /etc/protocols . It might be appropriate
288 * to use getprotoent(3) here.
289 */
290void
291sockoptlevelname (int level, int decimal)
292{
293	if (level == SOL_SOCKET) {
294		(void)printf("SOL_SOCKET");
295	} else {
296		if (decimal) {
297			(void)printf("%ld", (long)level);
298		} else {
299			(void)printf("%#lx", (long)level);
300		}
301	}
302}
303
304_EOF_
305
306auto_or_type "modename" "S_[A-Z]+[[:space:]]+[0-6]{7}" "sys/stat.h"
307auto_or_type "flagsname" "O_[A-Z]+[[:space:]]+0x[0-9A-Fa-f]+" "sys/fcntl.h"
308auto_or_type "accessmodename" "[A-Z]_OK[[:space:]]+0?x?[0-9A-Fa-f]+" "sys/unistd.h"
309auto_or_type "mmapprotname" "PROT_[A-Z]+[[:space:]]+0x[0-9A-Fa-f]+" "sys/mman.h"
310auto_or_type "mmapflagsname" "MAP_[A-Z]+[[:space:]]+0x[0-9A-Fa-f]+" "sys/mman.h"
311auto_or_type "wait4optname" "W[A-Z]+[[:space:]]+[0-9]+" "sys/wait.h"
312auto_or_type "getfsstatflagsname" "MNT_[A-Z]+[[:space:]]+[1-9][0-9]*" "sys/mount.h"
313auto_or_type "mountflagsname" "MNT_[A-Z]+[[:space:]]+0x[0-9]+" "sys/mount.h"
314auto_or_type "rebootoptname" "RB_[A-Z]+[[:space:]]+0x[0-9]+" "sys/reboot.h"
315auto_or_type "flockname" "LOCK_[A-Z]+[[:space:]]+0x[0-9]+" "sys/fcntl.h"
316auto_or_type "thrcreateflagsname" "THR_[A-Z]+[[:space:]]+0x[0-9]+" "sys/thr.h"
317auto_or_type "mlockallname" "MCL_[A-Z]+[[:space:]]+0x[0-9]+" "sys/mman.h"
318auto_or_type "shmatname" "SHM_[A-Z]+[[:space:]]+[0-9]{6}+" "sys/shm.h"
319auto_or_type "rforkname" "RF[A-Z]+[[:space:]]+\([0-9]+<<[0-9]+\)" "sys/unistd.h"
320auto_or_type "nfssvcname" "NFSSVC_[A-Z]+[[:space:]]+0x[0-9]+" "nfsserver/nfs.h"
321
322auto_switch_type "whencename" "SEEK_[A-Z]+[[:space:]]+[0-9]+" "sys/unistd.h"
323auto_switch_type "rlimitname" "RLIMIT_[A-Z]+[[:space:]]+[0-9]+" "sys/resource.h"
324auto_switch_type "shutdownhowname" "SHUT_[A-Z]+[[:space:]]+0x[0-9]+" "sys/socket.h"
325auto_switch_type "prioname" "PRIO_[A-Z]+[[:space:]]+[0-9]" "sys/resource.h"
326auto_switch_type "madvisebehavname" "_?MADV_[A-Z]+[[:space:]]+[0-9]+" "sys/mman.h"
327auto_switch_type "msyncflagsname" "MS_[A-Z]+[[:space:]]+0x[0-9]+" "sys/mman.h"
328auto_switch_type "schedpolicyname" "SCHED_[A-Z]+[[:space:]]+[0-9]+" "sched.h"
329auto_switch_type "kldunloadfflagsname" "LINKER_UNLOAD_[A-Z]+[[:space:]]+[0-9]+" "sys/linker.h"
330auto_switch_type "ksethrcmdname" "KSE_INTR_[A-Z]+[[:space:]]+[0-9]+" "sys/kse.h"
331auto_switch_type "extattrctlname" "EXTATTR_NAMESPACE_[A-Z]+[[:space:]]+0x[0-9]+" "sys/extattr.h"
332auto_switch_type "kldsymcmdname" "KLDSYM_[A-Z]+[[:space:]]+[0-9]+" "sys/linker.h"
333auto_switch_type "sendfileflagsname" "SF_[A-Z]+[[:space:]]+[0-9]+" "sys/socket.h"
334auto_switch_type "acltypename" "ACL_TYPE_[A-Z]+[[:space:]]+0x[0-9]+" "sys/acl.h"
335auto_switch_type "sigprocmaskhowname" "SIG_[A-Z]+[[:space:]]+[0-9]+" "sys/signal.h"
336auto_switch_type "lio_listioname" "LIO_(NO)?WAIT[[:space:]]+[0-9]+" "aio.h"
337auto_switch_type "minheritname" "INHERIT_[A-Z]+[[:space:]]+[0-9]+" "sys/mman.h"
338auto_switch_type "quotactlname" "Q_[A-Z]+[[:space:]]+0x[0-9]+" "ufs/ufs/quota.h"
339auto_if_type "sockdomainname" "PF_[[:alnum:]]+[[:space:]]+" "sys/socket.h"
340auto_if_type "sockipprotoname" "IPPROTO_[[:alnum:]]+[[:space:]]+" "netinet/in.h"
341auto_switch_type "sockoptname" "SO_[A-Z]+[[:space:]]+0x[0-9]+" "sys/socket.h"
342auto_switch_type "socktypename" "SOCK_[A-Z]+[[:space:]]+[1-9]+[0-9]*" "sys/socket.h"
343auto_switch_type "ptraceopname" "PT_[[:alnum:]]+[[:space:]]+[0-9]+" "sys/ptrace.h"
344
345cat <<_EOF_
346/*
347 * AUTO - Special
348 * F_ is used to specify fcntl commands as well as arguments. Both sets are
349 * grouped in fcntl.h, and this awk script grabs the first group.
350 */
351void
352fcntlcmdname (int cmd, int arg, int decimal)
353{
354	switch (cmd) {
355_EOF_
356egrep "^#[[:space:]]*define[[:space:]]+F_[A-Z]+[[:space:]]+[0-9]+[[:space:]]*" \
357	$include_dir/sys/fcntl.h | \
358	awk 'BEGIN { o=0 } { for (i = 1; i <= NF; i++) \
359		if ($i ~ /define/) \
360			break; \
361		++i; \
362		if (o <= $(i+1)) \
363			printf "\tcase %s:\n\t\t(void)printf(\"%s\");\n\t\tbreak;\n", $i, $i; \
364		else \
365			exit; \
366		o = $(i+1) }'
367cat <<_EOF_
368	default: /* Should not reach */
369		(void)printf("<invalid=%ld>", (long)cmd);
370	}
371	(void)putchar(',');
372	if (cmd == F_GETFD || cmd == F_SETFD) {
373		if (arg == FD_CLOEXEC)
374			(void)printf("FD_CLOEXEC");
375		else if (arg == 0)
376			(void)printf("0");
377		else {
378			if (decimal)
379				(void)printf("<invalid>%ld", (long)arg);
380			else
381				(void)printf("<invalid>%#lx", (long)arg);
382		}
383	} else if (cmd == F_SETFL) {
384		flagsname(arg);
385	} else {
386		if (decimal)
387			(void)printf("%ld", (long)arg);
388		else
389			(void)printf("%#lx", (long)arg);
390	}
391}
392
393/*
394 * AUTO - Special
395 *
396 * The only reason this is not fully automated is due to the
397 * grep -v RTP_PRIO statement. A better egrep line should
398 * make this capable of being a auto_switch_type() function.
399 */
400void
401rtprioname (int func)
402{
403	switch (func) {
404_EOF_
405egrep "^#[[:space:]]*define[[:space:]]+RTP_[A-Z]+[[:space:]]+0x[0-9]+[[:space:]]*" \
406	$include_dir/sys/rtprio.h | grep -v RTP_PRIO | \
407	awk '{ for (i = 1; i <= NF; i++) \
408		if ($i ~ /define/) \
409			break; \
410		++i; \
411		printf "\tcase %s:\n\t\t(void)printf(\"%s\");\n\t\tbreak;\n", $i, $i }'
412cat <<_EOF_
413	default: /* Should not reach */
414		(void)printf("<invalid=%ld>", (long)func);
415	}
416}
417
418/*
419 * AUTO - Special
420 *
421 * The send and recv functions have a flags argument which can be
422 * set to 0. There is no corresponding #define. The auto_ functions
423 * detect this as "invalid", which is incorrect here.
424 */
425void
426sendrecvflagsname (int flags)
427{
428	int	or = 0;
429	
430	if (flags == 0) {
431		(void)printf("0");
432		return;
433	}
434_EOF_
435egrep "^#[[:space:]]*define[[:space:]]+MSG_[A-Z]+[[:space:]]+0x[0-9]+[[:space:]]*" $include_dir/sys/socket.h | \
436	awk '{ for (i = 1; i <= NF; i++) \
437		if ($i ~ /define/) \
438			break; \
439		++i; \
440		printf "\tif(!((flags>0)^((%s)>0)))\n\t\tif_print_or(flags, %s, or);\n", $i, $i }'
441cat <<_EOF_
442}
443
444_EOF_
445