mksubr revision 226151 
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 226151 2011-10-08 12:21:51Z des $
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(intmax_t arg)
73{
74	int or = 0;
75	printf("%#jx<", (uintmax_t)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>%jd", 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(intmax_t 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=%jd>", 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(intmax_t 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=%jd>", arg);
151}
152
153_EOF_
154}
155
156# C start
157
158cat <<_EOF_
159#include <stdint.h>
160#include <stdio.h>
161#include <sys/fcntl.h>
162#include <sys/stat.h>
163#include <sys/unistd.h>
164#include <sys/mman.h>
165#include <sys/wait.h>
166#define _KERNEL
167#include <sys/socket.h>
168#undef _KERNEL
169#include <netinet/in.h>
170#include <sys/param.h>
171#include <sys/mount.h>
172#include <sys/ptrace.h>
173#include <sys/resource.h>
174#include <sys/reboot.h>
175#include <sched.h>
176#include <sys/linker.h>
177#define _KERNEL
178#include <sys/thr.h>
179#undef _KERNEL
180#include <sys/extattr.h>
181#include <sys/acl.h>
182#include <aio.h>
183#include <sys/sem.h>
184#include <sys/ipc.h>
185#include <sys/rtprio.h>
186#include <sys/shm.h>
187#include <nfsserver/nfs.h>
188#include <ufs/ufs/quota.h>
189
190#include "kdump_subr.h"
191
192/*
193 * These are simple support macros. print_or utilizes a variable
194 * defined in the calling function to track whether or not it should
195 * print a logical-OR character ('|') before a string. if_print_or
196 * simply handles the necessary "if" statement used in many lines
197 * of this file.
198 */
199#define print_or(str,orflag) do {                  \\
200	if (orflag) putchar('|'); else orflag = 1; \\
201	printf (str); }                            \\
202	while (0)
203#define if_print_or(i,flag,orflag) do {            \\
204	if ((i & flag) == flag)                    \\
205	print_or(#flag,orflag); }                  \\
206	while (0)
207
208/* MANUAL */
209extern char *signames[]; /* from kdump.c */
210void
211signame(int sig)
212{
213	if (sig > 0 && sig < NSIG)
214		(void)printf("SIG%s",signames[sig]);
215	else
216		(void)printf("SIG %d", sig);
217}
218
219/* MANUAL */
220void
221semctlname(int cmd)
222{
223	switch (cmd) {
224	case GETNCNT:
225		(void)printf("GETNCNT");
226		break;
227	case GETPID:
228		(void)printf("GETPID");
229		break;
230	case GETVAL:
231		(void)printf("GETVAL");
232		break;
233	case GETALL:
234		(void)printf("GETALL");
235		break;
236	case GETZCNT:
237		(void)printf("GETZCNT");
238		break;
239	case SETVAL:
240		(void)printf("SETVAL");
241		break;
242	case SETALL:
243		(void)printf("SETALL");
244		break;
245	case IPC_RMID:
246		(void)printf("IPC_RMID");
247		break;
248	case IPC_SET:
249		(void)printf("IPC_SET");
250		break;
251	case IPC_STAT:
252		(void)printf("IPC_STAT");
253		break;
254	default: /* Should not reach */
255		(void)printf("<invalid=%d>", cmd);
256	}
257}
258
259/* MANUAL */
260void
261shmctlname(int cmd)
262{
263	switch (cmd) {
264	case IPC_RMID:
265		(void)printf("IPC_RMID");
266		break;
267	case IPC_SET:
268		(void)printf("IPC_SET");
269		break;
270	case IPC_STAT:
271		(void)printf("IPC_STAT");
272		break;
273	default: /* Should not reach */
274		(void)printf("<invalid=%d>", cmd);
275	}
276}
277
278/* MANUAL */
279void
280semgetname(int flag)
281{
282	int or = 0;
283	if_print_or(flag, IPC_CREAT, or);
284	if_print_or(flag, IPC_EXCL, or);
285	if_print_or(flag, SEM_R, or);
286	if_print_or(flag, SEM_A, or);
287	if_print_or(flag, (SEM_R>>3), or);
288	if_print_or(flag, (SEM_A>>3), or);
289	if_print_or(flag, (SEM_R>>6), or);
290	if_print_or(flag, (SEM_A>>6), or);
291}
292
293/*
294 * MANUAL
295 *
296 * Only used by SYS_open. Unless O_CREAT is set in flags, the
297 * mode argument is unused (and often bogus and misleading).
298 */
299void
300flagsandmodename(int flags, int mode, int decimal)
301{
302	flagsname(flags);
303	(void)putchar(',');
304	if ((flags & O_CREAT) == O_CREAT) {
305		modename (mode);
306	} else {
307		if (decimal) {
308			(void)printf("<unused>%d", mode);
309		} else {
310			(void)printf("<unused>%#x", (unsigned int)mode);
311		}
312	}
313}
314
315/*
316 * MANUAL
317 *
318 * [g|s]etsockopt's level argument can either be SOL_SOCKET or a value
319 * referring to a line in /etc/protocols . It might be appropriate
320 * to use getprotoent(3) here.
321 */
322void
323sockoptlevelname(int level, int decimal)
324{
325	if (level == SOL_SOCKET) {
326		(void)printf("SOL_SOCKET");
327	} else {
328		if (decimal) {
329			(void)printf("%d", level);
330		} else {
331			(void)printf("%#x", (unsigned int)level);
332		}
333	}
334}
335
336_EOF_
337
338auto_or_type     "accessmodename"      "[A-Z]_OK[[:space:]]+0?x?[0-9A-Fa-f]+"         "sys/unistd.h"
339auto_switch_type "acltypename"         "ACL_TYPE_[A-Z4_]+[[:space:]]+0x[0-9]+"        "sys/acl.h"
340auto_switch_type "extattrctlname"      "EXTATTR_NAMESPACE_[A-Z]+[[:space:]]+0x[0-9]+" "sys/extattr.h"
341auto_or_type     "flagsname"           "O_[A-Z]+[[:space:]]+0x[0-9A-Fa-f]+"           "sys/fcntl.h"
342auto_or_type     "flockname"           "LOCK_[A-Z]+[[:space:]]+0x[0-9]+"              "sys/fcntl.h"
343auto_or_type     "getfsstatflagsname"  "MNT_[A-Z]+[[:space:]]+[1-9][0-9]*"            "sys/mount.h"
344auto_switch_type "kldsymcmdname"       "KLDSYM_[A-Z]+[[:space:]]+[0-9]+"              "sys/linker.h"
345auto_switch_type "kldunloadfflagsname" "LINKER_UNLOAD_[A-Z]+[[:space:]]+[0-9]+"       "sys/linker.h"
346auto_switch_type "lio_listioname"      "LIO_(NO)?WAIT[[:space:]]+[0-9]+"              "aio.h"
347auto_switch_type "madvisebehavname"    "_?MADV_[A-Z]+[[:space:]]+[0-9]+"              "sys/mman.h"
348auto_switch_type "minheritname"        "INHERIT_[A-Z]+[[:space:]]+[0-9]+"             "sys/mman.h"
349auto_or_type     "mlockallname"        "MCL_[A-Z]+[[:space:]]+0x[0-9]+"               "sys/mman.h"
350auto_or_type     "mmapflagsname"       "MAP_[A-Z]+[[:space:]]+0x[0-9A-Fa-f]+"         "sys/mman.h"
351auto_or_type     "mmapprotname"        "PROT_[A-Z]+[[:space:]]+0x[0-9A-Fa-f]+"        "sys/mman.h"
352auto_or_type     "modename"            "S_[A-Z]+[[:space:]]+[0-6]{7}"                 "sys/stat.h"
353auto_or_type     "mountflagsname"      "MNT_[A-Z]+[[:space:]]+0x[0-9]+"               "sys/mount.h"
354auto_switch_type "msyncflagsname"      "MS_[A-Z]+[[:space:]]+0x[0-9]+"                "sys/mman.h"
355auto_or_type     "nfssvcname"          "NFSSVC_[A-Z]+[[:space:]]+0x[0-9]+"            "nfsserver/nfs.h"
356auto_switch_type "prioname"            "PRIO_[A-Z]+[[:space:]]+[0-9]"                 "sys/resource.h"
357auto_switch_type "ptraceopname"        "PT_[[:alnum:]_]+[[:space:]]+[0-9]+"           "sys/ptrace.h"
358auto_switch_type "quotactlname"        "Q_[A-Z]+[[:space:]]+0x[0-9]+"                 "ufs/ufs/quota.h"
359auto_or_type     "rebootoptname"       "RB_[A-Z]+[[:space:]]+0x[0-9]+"                "sys/reboot.h"
360auto_or_type     "rforkname"           "RF[A-Z]+[[:space:]]+\([0-9]+<<[0-9]+\)"       "sys/unistd.h"
361auto_switch_type "rlimitname"          "RLIMIT_[A-Z]+[[:space:]]+[0-9]+"              "sys/resource.h"
362auto_switch_type "schedpolicyname"     "SCHED_[A-Z]+[[:space:]]+[0-9]+"               "sched.h"
363auto_switch_type "sendfileflagsname"   "SF_[A-Z]+[[:space:]]+[0-9]+"                  "sys/socket.h"
364auto_or_type     "shmatname"           "SHM_[A-Z]+[[:space:]]+[0-9]{6}+"              "sys/shm.h"
365auto_switch_type "shutdownhowname"     "SHUT_[A-Z]+[[:space:]]+[0-9]+"                "sys/socket.h"
366auto_switch_type "sigprocmaskhowname"  "SIG_[A-Z]+[[:space:]]+[0-9]+"                 "sys/signal.h"
367auto_if_type     "sockdomainname"      "PF_[[:alnum:]]+[[:space:]]+"                  "sys/socket.h"
368auto_if_type     "sockfamilyname"      "AF_[[:alnum:]]+[[:space:]]+"                  "sys/socket.h"
369auto_if_type     "sockipprotoname"     "IPPROTO_[[:alnum:]]+[[:space:]]+"             "netinet/in.h"
370auto_switch_type "sockoptname"         "SO_[A-Z]+[[:space:]]+0x[0-9]+"                "sys/socket.h"
371auto_switch_type "socktypename"        "SOCK_[A-Z]+[[:space:]]+[1-9]+[0-9]*"          "sys/socket.h"
372auto_or_type     "thrcreateflagsname"  "THR_[A-Z]+[[:space:]]+0x[0-9]+"               "sys/thr.h"
373auto_or_type     "wait4optname"        "W[A-Z]+[[:space:]]+[0-9]+"                    "sys/wait.h"
374auto_switch_type "whencename"          "SEEK_[A-Z]+[[:space:]]+[0-9]+"                "sys/unistd.h"
375
376cat <<_EOF_
377/*
378 * AUTO - Special
379 * F_ is used to specify fcntl commands as well as arguments. Both sets are
380 * grouped in fcntl.h, and this awk script grabs the first group.
381 */
382void
383fcntlcmdname(int cmd, int arg, int decimal)
384{
385	switch (cmd) {
386_EOF_
387egrep "^#[[:space:]]*define[[:space:]]+F_[A-Z]+[[:space:]]+[0-9]+[[:space:]]*" \
388	$include_dir/sys/fcntl.h | \
389	awk 'BEGIN { o=0 } { for (i = 1; i <= NF; i++) \
390		if ($i ~ /define/) \
391			break; \
392		++i; \
393		if (o <= $(i+1)) \
394			printf "\tcase %s:\n\t\t(void)printf(\"%s\");\n\t\tbreak;\n", $i, $i; \
395		else \
396			exit; \
397		o = $(i+1) }'
398cat <<_EOF_
399	default: /* Should not reach */
400		(void)printf("<invalid=%d>", cmd);
401	}
402	(void)putchar(',');
403	if (cmd == F_GETFD || cmd == F_SETFD) {
404		if (arg == FD_CLOEXEC)
405			(void)printf("FD_CLOEXEC");
406		else if (arg == 0)
407			(void)printf("0");
408		else {
409			if (decimal)
410				(void)printf("<invalid>%d", arg);
411			else
412				(void)printf("<invalid>%#x", (unsigned int)arg);
413		}
414	} else if (cmd == F_SETFL) {
415		flagsname(arg);
416	} else {
417		if (decimal)
418			(void)printf("%d", arg);
419		else
420			(void)printf("%#x", (unsigned int)arg);
421	}
422}
423
424/*
425 * AUTO - Special
426 *
427 * The only reason this is not fully automated is due to the
428 * grep -v RTP_PRIO statement. A better egrep line should
429 * make this capable of being a auto_switch_type() function.
430 */
431void
432rtprioname(int func)
433{
434	switch (func) {
435_EOF_
436egrep "^#[[:space:]]*define[[:space:]]+RTP_[A-Z]+[[:space:]]+0x[0-9]+[[:space:]]*" \
437	$include_dir/sys/rtprio.h | grep -v RTP_PRIO | \
438	awk '{ for (i = 1; i <= NF; i++) \
439		if ($i ~ /define/) \
440			break; \
441		++i; \
442		printf "\tcase %s:\n\t\t(void)printf(\"%s\");\n\t\tbreak;\n", $i, $i }'
443cat <<_EOF_
444	default: /* Should not reach */
445		(void)printf("<invalid=%d>", func);
446	}
447}
448
449/*
450 * AUTO - Special
451 *
452 * The send and recv functions have a flags argument which can be
453 * set to 0. There is no corresponding #define. The auto_ functions
454 * detect this as "invalid", which is incorrect here.
455 */
456void
457sendrecvflagsname(int flags)
458{
459	int or = 0;
460
461	if (flags == 0) {
462		(void)printf("0");
463		return;
464	}
465
466	printf("%#x<", flags);
467_EOF_
468egrep "^#[[:space:]]*define[[:space:]]+MSG_[A-Z]+[[:space:]]+0x[0-9]+[[:space:]]*" $include_dir/sys/socket.h | \
469	awk '{ for (i = 1; i <= NF; i++) \
470		if ($i ~ /define/) \
471			break; \
472		++i; \
473		printf "\tif(!((flags>0)^((%s)>0)))\n\t\tif_print_or(flags, %s, or);\n", $i, $i }'
474cat <<_EOF_
475	printf(">");
476}
477
478_EOF_
479