mksubr revision 258870 
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: stable/9/usr.bin/kdump/mksubr 258870 2013-12-03 16:07:56Z jhb $
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		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\tprintf(\"%s\");\n\t\tbreak;\n", $i, $i }'
117cat <<_EOF_
118	default: /* Should not reach */
119		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		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#include <vm/vm.h>
190#include <vm/vm_param.h>
191
192#include "kdump_subr.h"
193
194/*
195 * These are simple support macros. print_or utilizes a variable
196 * defined in the calling function to track whether or not it should
197 * print a logical-OR character ('|') before a string. if_print_or
198 * simply handles the necessary "if" statement used in many lines
199 * of this file.
200 */
201#define print_or(str,orflag) do {                  \\
202	if (orflag) putchar('|'); else orflag = 1; \\
203	printf (str); }                            \\
204	while (0)
205#define if_print_or(i,flag,orflag) do {            \\
206	if ((i & flag) == flag)                    \\
207	print_or(#flag,orflag); }                  \\
208	while (0)
209
210/* MANUAL */
211extern char *signames[]; /* from kdump.c */
212void
213signame(int sig)
214{
215	if (sig > 0 && sig < NSIG)
216		printf("SIG%s",signames[sig]);
217	else
218		printf("SIG %d", sig);
219}
220
221/* MANUAL */
222void
223semctlname(int cmd)
224{
225	switch (cmd) {
226	case GETNCNT:
227		printf("GETNCNT");
228		break;
229	case GETPID:
230		printf("GETPID");
231		break;
232	case GETVAL:
233		printf("GETVAL");
234		break;
235	case GETALL:
236		printf("GETALL");
237		break;
238	case GETZCNT:
239		printf("GETZCNT");
240		break;
241	case SETVAL:
242		printf("SETVAL");
243		break;
244	case SETALL:
245		printf("SETALL");
246		break;
247	case IPC_RMID:
248		printf("IPC_RMID");
249		break;
250	case IPC_SET:
251		printf("IPC_SET");
252		break;
253	case IPC_STAT:
254		printf("IPC_STAT");
255		break;
256	default: /* Should not reach */
257		printf("<invalid=%d>", cmd);
258	}
259}
260
261/* MANUAL */
262void
263shmctlname(int cmd)
264{
265	switch (cmd) {
266	case IPC_RMID:
267		printf("IPC_RMID");
268		break;
269	case IPC_SET:
270		printf("IPC_SET");
271		break;
272	case IPC_STAT:
273		printf("IPC_STAT");
274		break;
275	default: /* Should not reach */
276		printf("<invalid=%d>", cmd);
277	}
278}
279
280/* MANUAL */
281void
282semgetname(int flag)
283{
284	int or = 0;
285	if_print_or(flag, IPC_CREAT, or);
286	if_print_or(flag, IPC_EXCL, or);
287	if_print_or(flag, SEM_R, or);
288	if_print_or(flag, SEM_A, or);
289	if_print_or(flag, (SEM_R>>3), or);
290	if_print_or(flag, (SEM_A>>3), or);
291	if_print_or(flag, (SEM_R>>6), or);
292	if_print_or(flag, (SEM_A>>6), or);
293}
294
295/*
296 * MANUAL
297 *
298 * Only used by SYS_open. Unless O_CREAT is set in flags, the
299 * mode argument is unused (and often bogus and misleading).
300 */
301void
302flagsandmodename(int flags, int mode, int decimal)
303{
304	flagsname(flags);
305	putchar(',');
306	if ((flags & O_CREAT) == O_CREAT) {
307		modename (mode);
308	} else {
309		if (decimal) {
310			printf("<unused>%d", mode);
311		} else {
312			printf("<unused>%#x", (unsigned int)mode);
313		}
314	}
315}
316
317/*
318 * MANUAL
319 *
320 * [g|s]etsockopt's level argument can either be SOL_SOCKET or a value
321 * referring to a line in /etc/protocols . It might be appropriate
322 * to use getprotoent(3) here.
323 */
324void
325sockoptlevelname(int level, int decimal)
326{
327	if (level == SOL_SOCKET) {
328		printf("SOL_SOCKET");
329	} else {
330		if (decimal) {
331			printf("%d", level);
332		} else {
333			printf("%#x", (unsigned int)level);
334		}
335	}
336}
337
338/*
339 * MANUAL
340 *
341 * Used for page fault type.  Cannot use auto_or_type since the macro
342 * values contain a cast.  Also, VM_PROT_NONE has to be handled specially.
343 */
344void
345vmprotname (int type)
346{
347	int	or = 0;
348
349	if (type == VM_PROT_NONE) {
350		(void)printf("VM_PROT_NONE");
351		return;
352	}
353	if_print_or(type, VM_PROT_READ, or);
354	if_print_or(type, VM_PROT_WRITE, or);
355	if_print_or(type, VM_PROT_EXECUTE, or);
356	if_print_or(type, VM_PROT_COPY, or);
357}
358_EOF_
359
360auto_or_type     "accessmodename"      "[A-Z]_OK[[:space:]]+0?x?[0-9A-Fa-f]+"         "sys/unistd.h"
361auto_switch_type "acltypename"         "ACL_TYPE_[A-Z4_]+[[:space:]]+0x[0-9]+"        "sys/acl.h"
362auto_switch_type "extattrctlname"      "EXTATTR_NAMESPACE_[A-Z]+[[:space:]]+0x[0-9]+" "sys/extattr.h"
363auto_switch_type "fadvisebehavname"    "POSIX_FADV_[A-Z]+[[:space:]]+[0-9]+"          "sys/fcntl.h"
364auto_or_type     "flagsname"           "O_[A-Z]+[[:space:]]+0x[0-9A-Fa-f]+"           "sys/fcntl.h"
365auto_or_type     "flockname"           "LOCK_[A-Z]+[[:space:]]+0x[0-9]+"              "sys/fcntl.h"
366auto_or_type     "getfsstatflagsname"  "MNT_[A-Z]+[[:space:]]+[1-9][0-9]*"            "sys/mount.h"
367auto_switch_type "kldsymcmdname"       "KLDSYM_[A-Z]+[[:space:]]+[0-9]+"              "sys/linker.h"
368auto_switch_type "kldunloadfflagsname" "LINKER_UNLOAD_[A-Z]+[[:space:]]+[0-9]+"       "sys/linker.h"
369auto_switch_type "lio_listioname"      "LIO_(NO)?WAIT[[:space:]]+[0-9]+"              "aio.h"
370auto_switch_type "madvisebehavname"    "_?MADV_[A-Z]+[[:space:]]+[0-9]+"              "sys/mman.h"
371auto_switch_type "minheritname"        "INHERIT_[A-Z]+[[:space:]]+[0-9]+"             "sys/mman.h"
372auto_or_type     "mlockallname"        "MCL_[A-Z]+[[:space:]]+0x[0-9]+"               "sys/mman.h"
373auto_or_type     "mmapprotname"        "PROT_[A-Z]+[[:space:]]+0x[0-9A-Fa-f]+"        "sys/mman.h"
374auto_or_type     "modename"            "S_[A-Z]+[[:space:]]+[0-6]{7}"                 "sys/stat.h"
375auto_or_type     "mountflagsname"      "MNT_[A-Z]+[[:space:]]+0x[0-9]+"               "sys/mount.h"
376auto_switch_type "msyncflagsname"      "MS_[A-Z]+[[:space:]]+0x[0-9]+"                "sys/mman.h"
377auto_or_type     "nfssvcname"          "NFSSVC_[A-Z0-9]+[[:space:]]+0x[0-9]+"         "nfs/nfssvc.h"
378auto_switch_type "prioname"            "PRIO_[A-Z]+[[:space:]]+[0-9]"                 "sys/resource.h"
379auto_switch_type "ptraceopname"        "PT_[[:alnum:]_]+[[:space:]]+[0-9]+"           "sys/ptrace.h"
380auto_switch_type "quotactlname"        "Q_[A-Z]+[[:space:]]+0x[0-9]+"                 "ufs/ufs/quota.h"
381auto_or_type     "rebootoptname"       "RB_[A-Z]+[[:space:]]+0x[0-9]+"                "sys/reboot.h"
382auto_or_type     "rforkname"           "RF[A-Z]+[[:space:]]+\([0-9]+<<[0-9]+\)"       "sys/unistd.h"
383auto_switch_type "rlimitname"          "RLIMIT_[A-Z]+[[:space:]]+[0-9]+"              "sys/resource.h"
384auto_switch_type "schedpolicyname"     "SCHED_[A-Z]+[[:space:]]+[0-9]+"               "sched.h"
385auto_switch_type "sendfileflagsname"   "SF_[A-Z]+[[:space:]]+[0-9]+"                  "sys/socket.h"
386auto_or_type     "shmatname"           "SHM_[A-Z]+[[:space:]]+[0-9]{6}+"              "sys/shm.h"
387auto_switch_type "shutdownhowname"     "SHUT_[A-Z]+[[:space:]]+[0-9]+"                "sys/socket.h"
388auto_switch_type "sigprocmaskhowname"  "SIG_[A-Z]+[[:space:]]+[0-9]+"                 "sys/signal.h"
389auto_if_type     "sockdomainname"      "PF_[[:alnum:]]+[[:space:]]+"                  "sys/socket.h"
390auto_if_type     "sockfamilyname"      "AF_[[:alnum:]]+[[:space:]]+"                  "sys/socket.h"
391auto_if_type     "sockipprotoname"     "IPPROTO_[[:alnum:]]+[[:space:]]+"             "netinet/in.h"
392auto_switch_type "sockoptname"         "SO_[A-Z]+[[:space:]]+0x[0-9]+"                "sys/socket.h"
393auto_switch_type "socktypename"        "SOCK_[A-Z]+[[:space:]]+[1-9]+[0-9]*"          "sys/socket.h"
394auto_or_type     "thrcreateflagsname"  "THR_[A-Z]+[[:space:]]+0x[0-9]+"               "sys/thr.h"
395auto_switch_type "vmresultname"        "KERN_[A-Z]+[[:space:]]+[0-9]+"                "vm/vm_param.h"
396auto_or_type     "wait4optname"        "W[A-Z]+[[:space:]]+[0-9]+"                    "sys/wait.h"
397auto_switch_type "whencename"          "SEEK_[A-Z]+[[:space:]]+[0-9]+"                "sys/unistd.h"
398
399cat <<_EOF_
400/*
401 * AUTO - Special
402 * F_ is used to specify fcntl commands as well as arguments. Both sets are
403 * grouped in fcntl.h, and this awk script grabs the first group.
404 */
405void
406fcntlcmdname(int cmd, int arg, int decimal)
407{
408	switch (cmd) {
409_EOF_
410egrep "^#[[:space:]]*define[[:space:]]+F_[A-Z]+[[:space:]]+[0-9]+[[:space:]]*" \
411	$include_dir/sys/fcntl.h | \
412	awk 'BEGIN { o=0 } { for (i = 1; i <= NF; i++) \
413		if ($i ~ /define/) \
414			break; \
415		++i; \
416		if (o <= $(i+1)) \
417			printf "\tcase %s:\n\t\tprintf(\"%s\");\n\t\tbreak;\n", $i, $i; \
418		else \
419			exit; \
420		o = $(i+1) }'
421cat <<_EOF_
422	default: /* Should not reach */
423		printf("<invalid=%d>", cmd);
424	}
425	putchar(',');
426	if (cmd == F_GETFD || cmd == F_SETFD) {
427		if (arg == FD_CLOEXEC)
428			printf("FD_CLOEXEC");
429		else if (arg == 0)
430			printf("0");
431		else {
432			if (decimal)
433				printf("<invalid>%d", arg);
434			else
435				printf("<invalid>%#x", (unsigned int)arg);
436		}
437	} else if (cmd == F_SETFL) {
438		flagsname(arg);
439	} else {
440		if (decimal)
441			printf("%d", arg);
442		else
443			printf("%#x", (unsigned int)arg);
444	}
445}
446
447/*
448 * AUTO - Special
449 *
450 * The MAP_ALIGNED flag requires special handling.
451 */
452void
453mmapflagsname(int flags)
454{
455	int align;
456	int or = 0;
457	printf("%#x<", flags);
458_EOF_
459egrep "^#[[:space:]]*define[[:space:]]+MAP_[A-Z_]+[[:space:]]+0x[0-9A-Fa-f]+[[:space:]]*" \
460	$include_dir/sys/mman.h | grep -v MAP_ALIGNED | \
461	awk '{ for (i = 1; i <= NF; i++) \
462		if ($i ~ /define/) \
463			break; \
464		++i; \
465		printf "\tif (!((flags > 0) ^ ((%s) > 0)))\n\t\tif_print_or(flags, %s, or);\n", $i, $i }'
466cat <<_EOF_
467	align = flags & MAP_ALIGNMENT_MASK;
468	if (align != 0) {
469		if (align == MAP_ALIGNED_SUPER)
470			print_or("MAP_ALIGNED_SUPER", or);
471		else {
472			print_or("MAP_ALIGNED", or);
473			printf("(%d)", align >> MAP_ALIGNMENT_SHIFT);
474		}
475	}
476	printf(">");
477	if (or == 0)
478		printf("<invalid>%d", flags);
479}
480
481/*
482 * AUTO - Special
483 *
484 * The only reason this is not fully automated is due to the
485 * grep -v RTP_PRIO statement. A better egrep line should
486 * make this capable of being a auto_switch_type() function.
487 */
488void
489rtprioname(int func)
490{
491	switch (func) {
492_EOF_
493egrep "^#[[:space:]]*define[[:space:]]+RTP_[A-Z]+[[:space:]]+0x[0-9]+[[:space:]]*" \
494	$include_dir/sys/rtprio.h | grep -v RTP_PRIO | \
495	awk '{ for (i = 1; i <= NF; i++) \
496		if ($i ~ /define/) \
497			break; \
498		++i; \
499		printf "\tcase %s:\n\t\tprintf(\"%s\");\n\t\tbreak;\n", $i, $i }'
500cat <<_EOF_
501	default: /* Should not reach */
502		printf("<invalid=%d>", func);
503	}
504}
505
506/*
507 * AUTO - Special
508 *
509 * The send and recv functions have a flags argument which can be
510 * set to 0. There is no corresponding #define. The auto_ functions
511 * detect this as "invalid", which is incorrect here.
512 */
513void
514sendrecvflagsname(int flags)
515{
516	int or = 0;
517
518	if (flags == 0) {
519		printf("0");
520		return;
521	}
522
523	printf("%#x<", flags);
524_EOF_
525egrep "^#[[:space:]]*define[[:space:]]+MSG_[A-Z]+[[:space:]]+0x[0-9]+[[:space:]]*" $include_dir/sys/socket.h | \
526	awk '{ for (i = 1; i <= NF; i++) \
527		if ($i ~ /define/) \
528			break; \
529		++i; \
530		printf "\tif(!((flags>0)^((%s)>0)))\n\t\tif_print_or(flags, %s, or);\n", $i, $i }'
531cat <<_EOF_
532	printf(">");
533}
534
535_EOF_
536