Annotation of src/usr.bin/kdump/mksubr, Revision 1.26
1.1 otto 1: #!/bin/sh
1.26 ! guenther 2: # $OpenBSD: mksubr,v 1.25 2014/12/11 05:44:12 guenther Exp $
1.1 otto 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:
36: set -e
37:
38: LC_ALL=C; export LC_ALL
39:
40: if [ -z "$1" ]
41: then
42: echo "usage: sh $0 include-dir"
43: exit 1
44: fi
45: include_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:
1.12 guenther 51: # 0x1a4<S_IRUSR|S_IWUSR|S_IRGRP|S_IROTH>
1.1 otto 52: # The XOR is necessary to prevent including the "0"-value in every
53: # line.
54: #
55: auto_or_type () {
56: local name grep file
57: name=$1
58: grep=$2
59: file=$3
1.21 guenther 60: format=${4-%#x}
1.1 otto 61:
62: cat <<_EOF_
63: /* AUTO */
64: void
65: $name (int arg)
66: {
67: int or = 0;
1.21 guenther 68: printf("$format<", arg);
1.1 otto 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 }'
77: cat <<_EOF_
78: printf(">");
79: if (or == 0)
1.24 guenther 80: (void)printf("<invalid>%d", arg);
1.1 otto 81: }
82:
83: _EOF_
84: }
85:
86: #
1.8 guenther 87: # Like auto_or_type(), but a zero value is valid and prints as "0<>"
88: #
89: auto_orz_type () {
90: local name grep file
91: name=$1
92: grep=$2
93: file=$3
1.21 guenther 94: format=${4-%#x}
1.8 guenther 95:
96: cat <<_EOF_
97: /* AUTO */
98: void
99: $name (int arg)
100: {
101: int or = 0;
102: if (arg == 0) {
103: printf("0<>");
104: return;
105: }
1.21 guenther 106: printf("$format<", arg);
1.8 guenther 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 }'
115: cat <<_EOF_
116: printf(">");
117: if (or == 0)
1.24 guenther 118: (void)printf("<invalid>%d", arg);
1.8 guenther 119: }
120:
121: _EOF_
122: }
123:
124: #
1.12 guenther 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: #
132: auto_fflags_type () {
133: local name grep file
134: name=$1
135: grep=$2
136: file=$3
137:
138: cat <<_EOF_
139: /* AUTO */
140: void
1.22 guenther 141: $name (int arg, int show_accmode)
1.12 guenther 142: {
1.22 guenther 143: int or = 0;
144:
1.12 guenther 145: printf("%#x<", arg);
1.22 guenther 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: }
1.12 guenther 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; \
1.22 guenther 171: printf "\tif_print_or(arg, %s, or);\n", $i }'
1.12 guenther 172: cat <<_EOF_
173: printf(">");
174: }
175:
1.22 guenther 176: /*
1.24 guenther 177: * Wrappers of the above to use with pn()
1.22 guenther 178: */
179: void
180: flagsname(int flags)
181: {
182: doflagsname(flags, 0);
183: }
184:
1.24 guenther 185: void
186: openflagsname(int flags)
187: {
188: doflagsname(flags, 1);
189: }
190:
1.22 guenther 191:
1.12 guenther 192: _EOF_
193: }
194:
195:
196: #
1.1 otto 197: # Automatically generates a C function used when the argument
198: # maps to a single, specific #definition
199: #
200: auto_switch_type () {
201: local name grep file
202: name=$1
203: grep=$2
204: file=$3
205:
206: cat <<_EOF_
207: /* AUTO */
208: void
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 }'
220: cat <<_EOF_
221: default: /* Should not reach */
1.24 guenther 222: (void)printf("<invalid=%d>", arg);
1.1 otto 223: }
224: }
225:
226: _EOF_
227: }
228:
229: #
230: # Automatically generates a C function used when the argument
231: # maps to a #definition
232: #
233: auto_if_type () {
234: local name grep file
235: name=$1
236: grep=$2
237: file=$3
238:
239: cat <<_EOF_
240: /* AUTO */
241: void
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 }'
251: cat <<_EOF_
252: else /* Should not reach */
1.24 guenther 253: (void)printf("<invalid=%d>", arg);
1.1 otto 254: }
255:
256: _EOF_
257: }
258:
259: # C start
260:
261: cat <<_EOF_
262: #include <stdio.h>
1.2 otto 263: #include <sys/param.h>
1.1 otto 264: #include <sys/fcntl.h>
265: #include <sys/stat.h>
266: #include <sys/unistd.h>
1.19 matthew 267: #define _KERNEL
1.1 otto 268: #include <sys/mman.h>
1.19 matthew 269: #undef _KERNEL
1.1 otto 270: #include <sys/wait.h>
1.2 otto 271: #include <sys/proc.h>
1.1 otto 272: #include <sys/socket.h>
273: #include <netinet/in.h>
274: #include <sys/param.h>
275: #include <sys/mount.h>
1.14 guenther 276: #include <sys/poll.h>
1.1 otto 277: #include <sys/ptrace.h>
278: #include <sys/resource.h>
279: #include <sys/reboot.h>
1.18 guenther 280: #include <sys/uio.h>
281: #include <sys/ktrace.h>
1.1 otto 282: #include <sched.h>
1.2 otto 283: #if 0
1.1 otto 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>
1.2 otto 291: #endif
1.1 otto 292: #include <sys/sem.h>
293: #include <sys/ipc.h>
1.2 otto 294: #if 0
1.1 otto 295: #include <sys/rtprio.h>
1.2 otto 296: #endif
1.1 otto 297: #include <sys/shm.h>
1.2 otto 298: #if 0
1.1 otto 299: #include <nfsserver/nfs.h>
1.2 otto 300: #endif
1.1 otto 301: #include <ufs/ufs/quota.h>
302:
303: #include "kdump_subr.h"
304:
305: _EOF_
306:
1.21 guenther 307: auto_orz_type "modename" "S_[A-Z]+[[:space:]]+[0-6]{7}" "sys/stat.h" "%#o"
1.22 guenther 308: auto_fflags_type "doflagsname" "O_[A-Z]+[[:space:]]+0x[0-9A-Fa-f]+" "sys/fcntl.h"
1.8 guenther 309: auto_orz_type "atflagsname" "AT_[A-Z_]+[[:space:]]+0x[0-9A-Fa-f]+" "sys/fcntl.h"
1.3 otto 310: auto_or_type "accessmodename" "[A-Z]_OK[[:space:]]+0?x?[0-9A-Fa-f]+" "sys/unistd.h"
1.1 otto 311: auto_or_type "mmapprotname" "PROT_[A-Z]+[[:space:]]+0x[0-9A-Fa-f]+" "sys/mman.h"
1.13 matthew 312: auto_or_type "mmapflagsname" "(__)?MAP_[A-Z]+[[:space:]]+0x[0-9A-Fa-f]+" "sys/mman.h"
1.8 guenther 313: auto_orz_type "wait4optname" "W[A-Z]+[[:space:]]+[0-9]+" "sys/wait.h"
314: #auto_or_type "timerflagsname" "TIMER_[A-Z]+[[:space:]]+0x[0-9A-Fa-f]+" "sys/time.h"
1.2 otto 315: #auto_or_type "getfsstatflagsname" "MNT_[A-Z]+[[:space:]]+[1-9][0-9]*" "sys/mount.h"
1.24 guenther 316: auto_or_type "mountflagsname" "MNT_[A-Z]+[[:space:]]+0x[0-9]+" "sys/mount.h"
317: auto_or_type "rebootoptname" "RB_[A-Z]+[[:space:]]+0x[0-9]+" "sys/reboot.h"
1.3 otto 318: auto_or_type "flockname" "LOCK_[A-Z]+[[:space:]]+0x[0-9]+" "sys/fcntl.h"
1.2 otto 319: #auto_or_type "thrcreateflagsname" "THR_[A-Z]+[[:space:]]+0x[0-9]+" "sys/thr.h"
1.3 otto 320: auto_or_type "mlockallname" "MCL_[A-Z]+[[:space:]]+0x[0-9]+" "sys/mman.h"
1.8 guenther 321: auto_orz_type "shmatname" "SHM_[A-Z]+[[:space:]]+[0-9]{6}" "sys/shm.h"
1.2 otto 322: #auto_or_type "nfssvcname" "NFSSVC_[A-Z]+[[:space:]]+0x[0-9]+" "nfsserver/nfs.h"
323: #
1.3 otto 324: auto_switch_type "whencename" "SEEK_[A-Z]+[[:space:]]+[0-9]+" "sys/unistd.h"
1.14 guenther 325: auto_switch_type "pathconfname" "_PC_[_A-Z]+[[:space:]]+[0-9]+" "sys/unistd.h"
1.3 otto 326: auto_switch_type "rlimitname" "RLIMIT_[A-Z]+[[:space:]]+[0-9]+" "sys/resource.h"
1.14 guenther 327: auto_switch_type "shutdownhowname" "SHUT_[A-Z]+[[:space:]]+[0-9]+" "sys/socket.h"
1.24 guenther 328: auto_switch_type "prioname" "PRIO_[A-Z]+[[:space:]]+[0-9]" "sys/resource.h"
1.3 otto 329: auto_switch_type "madvisebehavname" "_?MADV_[A-Z]+[[:space:]]+[0-9]+" "sys/mman.h"
330: auto_switch_type "msyncflagsname" "MS_[A-Z]+[[:space:]]+0x[0-9]+" "sys/mman.h"
1.15 guenther 331: auto_switch_type "clocktypename" "CLOCK_[_A-Z]+[[:space:]]+[0-9]+" "sys/_time.h"
1.2 otto 332: #auto_switch_type "schedpolicyname" "SCHED_[A-Z]+[[:space:]]+[0-9]+" "sched.h"
333: #auto_switch_type "kldunloadfflagsname" "LINKER_UNLOAD_[A-Z]+[[:space:]]+[0-9]+" "sys/linker.h"
334: #auto_switch_type "extattrctlname" "EXTATTR_NAMESPACE_[A-Z]+[[:space:]]+0x[0-9]+" "sys/extattr.h"
335: #auto_switch_type "kldsymcmdname" "KLDSYM_[A-Z]+[[:space:]]+[0-9]+" "sys/linker.h"
336: #auto_switch_type "sendfileflagsname" "SF_[A-Z]+[[:space:]]+[0-9]+" "sys/socket.h"
337: #auto_switch_type "acltypename" "ACL_TYPE_[A-Z4_]+[[:space:]]+0x[0-9]+" "sys/acl.h"
1.16 guenther 338: auto_switch_type "rusagewho" "RUSAGE_[A-Z]+[[:space:]]+[-0-9()]+" "sys/resource.h"
1.9 guenther 339: auto_orz_type "sigactionflagname" "SA_[A-Z]+[[:space:]]+0x[0-9]+" "sys/signal.h"
1.1 otto 340: auto_switch_type "sigprocmaskhowname" "SIG_[A-Z]+[[:space:]]+[0-9]+" "sys/signal.h"
1.7 deraadt 341: auto_switch_type "sigill_name" "ILL_[A-Z]+[[:space:]]+[0-9]+" "sys/siginfo.h"
342: auto_switch_type "sigtrap_name" "TRAP_[A-Z]+[[:space:]]+[0-9]+" "sys/siginfo.h"
343: auto_switch_type "sigemt_name" "EMT_[A-Z]+[[:space:]]+[0-9]+" "sys/siginfo.h"
344: auto_switch_type "sigfpe_name" "FPE_[A-Z]+[[:space:]]+[0-9]+" "sys/siginfo.h"
345: auto_switch_type "sigbus_name" "BUS_[A-Z]+[[:space:]]+[0-9]+" "sys/siginfo.h"
346: auto_switch_type "sigsegv_name" "SEGV_[A-Z]+[[:space:]]+[0-9]+" "sys/siginfo.h"
347: auto_switch_type "sigchld_name" "CLD_[A-Z]+[[:space:]]+[0-9]+" "sys/siginfo.h"
1.2 otto 348: #auto_switch_type "lio_listioname" "LIO_(NO)?WAIT[[:space:]]+[0-9]+" "aio.h"
1.20 otto 349: auto_switch_type "minheritname" "MAP_INHERIT_[A-Z]+[[:space:]]+[0-9]+" "sys/mman.h"
1.23 guenther 350: auto_switch_type "quotactlname" "Q_[A-Z]+[[:space:]]+0x[0-9]+" "ufs/ufs/quota.h"
1.3 otto 351: auto_if_type "sockdomainname" "PF_[[:alnum:]]+[[:space:]]+" "sys/socket.h"
1.5 otto 352: auto_if_type "sockfamilyname" "AF_[[:alnum:]]+[[:space:]]+" "sys/socket.h"
1.3 otto 353: auto_if_type "sockipprotoname" "IPPROTO_[[:alnum:]]+[[:space:]]+" "netinet/in.h"
354: auto_switch_type "sockoptname" "SO_[A-Z]+[[:space:]]+0x[0-9]+" "sys/socket.h"
1.2 otto 355: #auto_switch_type "ptraceopname" "PT_[[:alnum:]_]+[[:space:]]+[0-9]+" "sys/ptrace.h"
1.18 guenther 356: auto_orz_type "ktracefacname" "KTRFAC_[^M][[:alnum:]_]+" "sys/ktrace.h"
357: auto_switch_type "itimername" "ITIMER_[[:alnum:]_]+" "sys/time.h"
1.1 otto 358:
359: cat <<_EOF_
360: /*
361: * AUTO - Special
362: * F_ is used to specify fcntl commands as well as arguments. Both sets are
363: * grouped in fcntl.h, and this awk script grabs the first group.
364: */
365: void
1.24 guenther 366: fcntlcmdname (int arg)
1.1 otto 367: {
1.24 guenther 368: switch (arg1) {
1.1 otto 369: _EOF_
1.6 matthew 370: egrep "^#[[:space:]]*define[[:space:]]+F_[A-Z_]+[[:space:]]+[0-9]+[[:space:]]*" \
1.1 otto 371: $include_dir/sys/fcntl.h | \
372: awk 'BEGIN { o=0 } { for (i = 1; i <= NF; i++) \
373: if ($i ~ /define/) \
374: break; \
375: ++i; \
376: if (o <= $(i+1)) \
377: printf "\tcase %s:\n\t\t(void)printf(\"%s\");\n\t\tbreak;\n", $i, $i; \
378: else \
379: exit; \
380: o = $(i+1) }'
381: cat <<_EOF_
382: default: /* Should not reach */
1.24 guenther 383: (void)printf("<invalid=%d>", arg1);
1.1 otto 384: }
1.24 guenther 385: if (arg1 == F_SETFD) {
1.14 guenther 386: (void)putchar(',');
1.1 otto 387: if (arg == FD_CLOEXEC)
388: (void)printf("FD_CLOEXEC");
389: else if (arg == 0)
390: (void)printf("0");
1.24 guenther 391: else
392: (void)printf("<invalid>%#x", arg);
1.14 guenther 393:
1.24 guenther 394: } else if (arg1 == F_SETFL) {
1.14 guenther 395: (void)putchar(',');
1.24 guenther 396: doflagsname(arg, 0);
397: } else if (!fancy || (arg1 != F_GETFD && arg1 != F_GETFL))
398: (void)printf(",%#x", arg);
1.1 otto 399: }
400:
401: /*
402: * AUTO - Special
403: *
404: * The send and recv functions have a flags argument which can be
405: * set to 0. There is no corresponding #define. The auto_ functions
406: * detect this as "invalid", which is incorrect here.
407: */
408: void
409: sendrecvflagsname (int flags)
410: {
411: int or = 0;
412:
413: if (flags == 0) {
414: (void)printf("0");
415: return;
416: }
417:
418: printf("%#x<", flags);
419: _EOF_
1.22 guenther 420: egrep "^#[[:space:]]*define[[:space:]]+MSG_[_A-Z]+[[:space:]]+0x[0-9]+[[:space:]]*" $include_dir/sys/socket.h | \
1.1 otto 421: awk '{ for (i = 1; i <= NF; i++) \
422: if ($i ~ /define/) \
423: break; \
424: ++i; \
425: printf "\tif(!((flags>0)^((%s)>0)))\n\t\tif_print_or(flags, %s, or);\n", $i, $i }'
426: cat <<_EOF_
427: printf(">");
1.22 guenther 428: }
429:
430: /*
431: * AUTO - Special
432: *
433: * SOCK_NONBLOCK and SOCK_CLOEXEC are or'ed into the type
434: */
435: static void
436: dosocktypename (int arg, int show_type)
437: {
438: int type = arg & 0xff; /* XXX */
439: int or = 0;
440:
441: printf("%#x<", arg);
442: if (show_type || type) {
443: or = 1;
444: switch (type) {
445: _EOF_
446: egrep "^#[[:space:]]*define[[:space:]]+SOCK_[A-Z]+[[:space:]]+[1-9]+[0-9]*[[:space:]]*" \
447: $include_dir/sys/socket.h | \
448: awk '{ for (i = 1; i <= NF; i++) \
449: if ($i ~ /define/) \
450: break; \
451: ++i; \
1.25 guenther 452: printf "\t\tcase %s:\n\t\t\t(void)printf(\"%s\");\n\t\t\tbreak;\n", $i, $i }'
1.22 guenther 453: cat <<_EOF_
454: default: /* Should not reach */
455: (void)printf("<invalid=%d>", arg);
456: }
457: }
458:
459: _EOF_
460: egrep "^#[[:space:]]*define[[:space:]]+SOCK_[A-Z]+[[:space:]]+0x[0-9]+[[:space:]]*" \
461: $include_dir/sys/socket.h | \
462: awk '{ for (i = 1; i <= NF; i++) \
463: if ($i ~ /define/) \
464: break; \
465: ++i; \
466: printf "\tif_print_or(arg, %s, or);\n", $i }'
467: cat <<_EOF_
468: printf(">");
469: }
470:
471: void
472: socktypename (int arg)
473: {
474: dosocktypename(arg, 1);
475: }
476:
477: void
478: sockflagsname (int arg)
479: {
480: dosocktypename(arg, 0);
1.23 guenther 481: }
482:
483: void
484: quotactlcmdname(int cmd)
485: {
1.25 guenther 486: printf("%#x<QCMD(", cmd);
1.23 guenther 487: quotactlname(cmd >> SUBCMDSHIFT);
488: switch (cmd & SUBCMDMASK) {
489: case USRQUOTA:
1.25 guenther 490: printf(",%s)>", "USRQUOTA");
1.23 guenther 491: break;
492: case GRPQUOTA:
1.25 guenther 493: printf(",%s)>", "GRPQUOTA");
1.23 guenther 494: break;
495: default:
1.25 guenther 496: printf(",<invalid>%#x)>", cmd & SUBCMDMASK);
1.23 guenther 497: break;
498: }
1.1 otto 499: }
500:
501: _EOF_
![[BACK]](/icons/back.gif){kind=icon}
Return to mksubr CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / kdump