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