Annotation of src/usr.bin/kdump/mksubr, Revision 1.19
1.1 otto 1: #!/bin/sh
1.19 ! matthew 2: # $OpenBSD: mksubr,v 1.18 2013/12/21 07:32:35 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
60:
61: cat <<_EOF_
62: /* AUTO */
63: void
64: $name (int arg)
65: {
66: int or = 0;
67: printf("%#x<", arg);
68: _EOF_
69: egrep "^#[[:space:]]*define[[:space:]]+"${grep}"[[:space:]]*" \
70: $include_dir/$file | \
71: awk '{ for (i = 1; i <= NF; i++) \
72: if ($i ~ /define/) \
73: break; \
74: ++i; \
75: printf "\tif(!((arg>0)^((%s)>0)))\n\t\tif_print_or(arg, %s, or);\n", $i, $i }'
76: cat <<_EOF_
77: printf(">");
78: if (or == 0)
79: (void)printf("<invalid>%ld", (long)arg);
80: }
81:
82: _EOF_
83: }
84:
85: #
1.8 guenther 86: # Like auto_or_type(), but a zero value is valid and prints as "0<>"
87: #
88: auto_orz_type () {
89: local name grep file
90: name=$1
91: grep=$2
92: file=$3
93:
94: cat <<_EOF_
95: /* AUTO */
96: void
97: $name (int arg)
98: {
99: int or = 0;
100: if (arg == 0) {
101: printf("0<>");
102: return;
103: }
104: printf("%#x<", arg);
105: _EOF_
106: egrep "^#[[:space:]]*define[[:space:]]+"${grep}"[[:space:]]*" \
107: $include_dir/$file | \
108: awk '{ for (i = 1; i <= NF; i++) \
109: if ($i ~ /define/) \
110: break; \
111: ++i; \
112: printf "\tif(!((arg>0)^((%s)>0)))\n\t\tif_print_or(arg, %s, or);\n", $i, $i }'
113: cat <<_EOF_
114: printf(">");
115: if (or == 0)
116: (void)printf("<invalid>%ld", (long)arg);
117: }
118:
119: _EOF_
120: }
121:
122: #
1.12 guenther 123: # Automatically generates a C function that will print out a
124: # file flags input as a pipe-delimited string of the appropriate
125: # #define keys. ex:
126: # 0x30000<O_RDONLY|O_CLOEXEC|O_DIRECTORY>
127: # This is different than the others to handle O_RDONLY correctly when
128: # other flags are present and to diagnose an invalid O_ACCMODE value
129: #
130: auto_fflags_type () {
131: local name grep file
132: name=$1
133: grep=$2
134: file=$3
135:
136: cat <<_EOF_
137: /* AUTO */
138: void
139: $name (int arg)
140: {
141: printf("%#x<", arg);
142: switch (arg & O_ACCMODE) {
143: case O_RDONLY:
144: printf("O_RDONLY");
145: break;
146: case O_WRONLY:
147: printf("O_WRONLY");
148: break;
149: case O_RDWR:
150: printf("O_RDWR");
151: break;
152: default:
153: printf("<invalid>O_ACCMODE");
154: break;
155: }
156: _EOF_
157: egrep "^#[[:space:]]*define[[:space:]]+"${grep}"[[:space:]]*" \
158: $include_dir/$file | \
159: egrep -v 'O_(RD(ONLY|WR)|WRONLY|ACCMODE)' | \
160: awk '{ for (i = 1; i <= NF; i++) \
161: if ($i ~ /define/) \
162: break; \
163: ++i; \
164: printf "\tif (arg & %s) printf (\"|%%s\", \"%s\");\n", $i, $i }'
165: cat <<_EOF_
166: printf(">");
167: }
168:
169: _EOF_
170: }
171:
172:
173: #
1.1 otto 174: # Automatically generates a C function used when the argument
175: # maps to a single, specific #definition
176: #
177: auto_switch_type () {
178: local name grep file
179: name=$1
180: grep=$2
181: file=$3
182:
183: cat <<_EOF_
184: /* AUTO */
185: void
186: $name (int arg)
187: {
188: switch (arg) {
189: _EOF_
190: egrep "^#[[:space:]]*define[[:space:]]+"${grep}"[[:space:]]*" \
191: $include_dir/$file | \
192: awk '{ for (i = 1; i <= NF; i++) \
193: if ($i ~ /define/) \
194: break; \
195: ++i; \
196: printf "\tcase %s:\n\t\t(void)printf(\"%s\");\n\t\tbreak;\n", $i, $i }'
197: cat <<_EOF_
198: default: /* Should not reach */
199: (void)printf("<invalid=%ld>", (long)arg);
200: }
201: }
202:
203: _EOF_
204: }
205:
206: #
207: # Automatically generates a C function used when the argument
208: # maps to a #definition
209: #
210: auto_if_type () {
211: local name grep file
212: name=$1
213: grep=$2
214: file=$3
215:
216: cat <<_EOF_
217: /* AUTO */
218: void
219: $name (int arg)
220: {
221: _EOF_
222: egrep "^#[[:space:]]*define[[:space:]]+"${grep}"[[:space:]]*" \
223: $include_dir/$file | \
224: awk '{ printf "\t"; \
225: if (NR > 1) \
226: printf "else " ; \
227: printf "if (arg == %s) \n\t\tprintf(\"%s\");\n", $2, $2 }'
228: cat <<_EOF_
229: else /* Should not reach */
230: (void)printf("<invalid=%ld>", (long)arg);
231: }
232:
233: _EOF_
234: }
235:
236: # C start
237:
238: cat <<_EOF_
239: #include <stdio.h>
1.2 otto 240: #include <sys/param.h>
1.1 otto 241: #include <sys/fcntl.h>
242: #include <sys/stat.h>
243: #include <sys/unistd.h>
1.19 ! matthew 244: #define _KERNEL
1.1 otto 245: #include <sys/mman.h>
1.19 ! matthew 246: #undef _KERNEL
1.1 otto 247: #include <sys/wait.h>
1.2 otto 248: #include <sys/proc.h>
1.1 otto 249: #define _KERNEL
1.2 otto 250: #define COMPAT_43
1.1 otto 251: #include <sys/socket.h>
252: #undef _KERNEL
253: #include <netinet/in.h>
254: #include <sys/param.h>
255: #include <sys/mount.h>
1.14 guenther 256: #include <sys/poll.h>
1.1 otto 257: #include <sys/ptrace.h>
258: #include <sys/resource.h>
259: #include <sys/reboot.h>
1.18 guenther 260: #include <sys/uio.h>
261: #include <sys/ktrace.h>
1.1 otto 262: #include <sched.h>
1.2 otto 263: #if 0
1.1 otto 264: #include <sys/linker.h>
265: #define _KERNEL
266: #include <sys/thr.h>
267: #undef _KERNEL
268: #include <sys/extattr.h>
269: #include <sys/acl.h>
270: #include <aio.h>
1.2 otto 271: #endif
1.1 otto 272: #include <sys/sem.h>
273: #include <sys/ipc.h>
1.2 otto 274: #if 0
1.1 otto 275: #include <sys/rtprio.h>
1.2 otto 276: #endif
1.1 otto 277: #include <sys/shm.h>
1.2 otto 278: #if 0
1.1 otto 279: #include <nfsserver/nfs.h>
1.2 otto 280: #endif
1.1 otto 281: #include <ufs/ufs/quota.h>
282:
283: #include "kdump_subr.h"
284:
285: _EOF_
286:
1.8 guenther 287: auto_orz_type "modename" "S_[A-Z]+[[:space:]]+[0-6]{7}" "sys/stat.h"
1.12 guenther 288: auto_fflags_type "flagsname" "O_[A-Z]+[[:space:]]+0x[0-9A-Fa-f]+" "sys/fcntl.h"
1.8 guenther 289: auto_orz_type "atflagsname" "AT_[A-Z_]+[[:space:]]+0x[0-9A-Fa-f]+" "sys/fcntl.h"
1.3 otto 290: auto_or_type "accessmodename" "[A-Z]_OK[[:space:]]+0?x?[0-9A-Fa-f]+" "sys/unistd.h"
1.1 otto 291: auto_or_type "mmapprotname" "PROT_[A-Z]+[[:space:]]+0x[0-9A-Fa-f]+" "sys/mman.h"
1.13 matthew 292: auto_or_type "mmapflagsname" "(__)?MAP_[A-Z]+[[:space:]]+0x[0-9A-Fa-f]+" "sys/mman.h"
1.8 guenther 293: auto_orz_type "wait4optname" "W[A-Z]+[[:space:]]+[0-9]+" "sys/wait.h"
294: #auto_or_type "timerflagsname" "TIMER_[A-Z]+[[:space:]]+0x[0-9A-Fa-f]+" "sys/time.h"
1.2 otto 295: #auto_or_type "getfsstatflagsname" "MNT_[A-Z]+[[:space:]]+[1-9][0-9]*" "sys/mount.h"
296: #auto_or_type "mountflagsname" "MNT_[A-Z]+[[:space:]]+0x[0-9]+" "sys/mount.h"
297: #auto_or_type "rebootoptname" "RB_[A-Z]+[[:space:]]+0x[0-9]+" "sys/reboot.h"
1.3 otto 298: auto_or_type "flockname" "LOCK_[A-Z]+[[:space:]]+0x[0-9]+" "sys/fcntl.h"
1.2 otto 299: #auto_or_type "thrcreateflagsname" "THR_[A-Z]+[[:space:]]+0x[0-9]+" "sys/thr.h"
1.3 otto 300: auto_or_type "mlockallname" "MCL_[A-Z]+[[:space:]]+0x[0-9]+" "sys/mman.h"
1.8 guenther 301: auto_orz_type "shmatname" "SHM_[A-Z]+[[:space:]]+[0-9]{6}" "sys/shm.h"
1.2 otto 302: #auto_or_type "nfssvcname" "NFSSVC_[A-Z]+[[:space:]]+0x[0-9]+" "nfsserver/nfs.h"
303: #
1.3 otto 304: auto_switch_type "whencename" "SEEK_[A-Z]+[[:space:]]+[0-9]+" "sys/unistd.h"
1.14 guenther 305: auto_switch_type "pathconfname" "_PC_[_A-Z]+[[:space:]]+[0-9]+" "sys/unistd.h"
1.3 otto 306: auto_switch_type "rlimitname" "RLIMIT_[A-Z]+[[:space:]]+[0-9]+" "sys/resource.h"
1.14 guenther 307: auto_switch_type "shutdownhowname" "SHUT_[A-Z]+[[:space:]]+[0-9]+" "sys/socket.h"
1.2 otto 308: #auto_switch_type "prioname" "PRIO_[A-Z]+[[:space:]]+[0-9]" "sys/resource.h"
1.3 otto 309: auto_switch_type "madvisebehavname" "_?MADV_[A-Z]+[[:space:]]+[0-9]+" "sys/mman.h"
310: auto_switch_type "msyncflagsname" "MS_[A-Z]+[[:space:]]+0x[0-9]+" "sys/mman.h"
1.15 guenther 311: auto_switch_type "clocktypename" "CLOCK_[_A-Z]+[[:space:]]+[0-9]+" "sys/_time.h"
1.2 otto 312: #auto_switch_type "schedpolicyname" "SCHED_[A-Z]+[[:space:]]+[0-9]+" "sched.h"
313: #auto_switch_type "kldunloadfflagsname" "LINKER_UNLOAD_[A-Z]+[[:space:]]+[0-9]+" "sys/linker.h"
314: #auto_switch_type "extattrctlname" "EXTATTR_NAMESPACE_[A-Z]+[[:space:]]+0x[0-9]+" "sys/extattr.h"
315: #auto_switch_type "kldsymcmdname" "KLDSYM_[A-Z]+[[:space:]]+[0-9]+" "sys/linker.h"
316: #auto_switch_type "sendfileflagsname" "SF_[A-Z]+[[:space:]]+[0-9]+" "sys/socket.h"
317: #auto_switch_type "acltypename" "ACL_TYPE_[A-Z4_]+[[:space:]]+0x[0-9]+" "sys/acl.h"
1.16 guenther 318: auto_switch_type "rusagewho" "RUSAGE_[A-Z]+[[:space:]]+[-0-9()]+" "sys/resource.h"
1.9 guenther 319: auto_orz_type "sigactionflagname" "SA_[A-Z]+[[:space:]]+0x[0-9]+" "sys/signal.h"
1.1 otto 320: auto_switch_type "sigprocmaskhowname" "SIG_[A-Z]+[[:space:]]+[0-9]+" "sys/signal.h"
1.7 deraadt 321: auto_switch_type "sigill_name" "ILL_[A-Z]+[[:space:]]+[0-9]+" "sys/siginfo.h"
322: auto_switch_type "sigtrap_name" "TRAP_[A-Z]+[[:space:]]+[0-9]+" "sys/siginfo.h"
323: auto_switch_type "sigemt_name" "EMT_[A-Z]+[[:space:]]+[0-9]+" "sys/siginfo.h"
324: auto_switch_type "sigfpe_name" "FPE_[A-Z]+[[:space:]]+[0-9]+" "sys/siginfo.h"
325: auto_switch_type "sigbus_name" "BUS_[A-Z]+[[:space:]]+[0-9]+" "sys/siginfo.h"
326: auto_switch_type "sigsegv_name" "SEGV_[A-Z]+[[:space:]]+[0-9]+" "sys/siginfo.h"
327: auto_switch_type "sigchld_name" "CLD_[A-Z]+[[:space:]]+[0-9]+" "sys/siginfo.h"
1.2 otto 328: #auto_switch_type "lio_listioname" "LIO_(NO)?WAIT[[:space:]]+[0-9]+" "aio.h"
1.3 otto 329: auto_switch_type "minheritname" "INHERIT_[A-Z]+[[:space:]]+[0-9]+" "sys/mman.h"
1.2 otto 330: #auto_switch_type "quotactlname" "Q_[A-Z]+[[:space:]]+0x[0-9]+" "ufs/ufs/quota.h"
1.3 otto 331: auto_if_type "sockdomainname" "PF_[[:alnum:]]+[[:space:]]+" "sys/socket.h"
1.5 otto 332: auto_if_type "sockfamilyname" "AF_[[:alnum:]]+[[:space:]]+" "sys/socket.h"
1.3 otto 333: auto_if_type "sockipprotoname" "IPPROTO_[[:alnum:]]+[[:space:]]+" "netinet/in.h"
334: auto_switch_type "sockoptname" "SO_[A-Z]+[[:space:]]+0x[0-9]+" "sys/socket.h"
335: auto_switch_type "socktypename" "SOCK_[A-Z]+[[:space:]]+[1-9]+[0-9]*" "sys/socket.h"
1.2 otto 336: #auto_switch_type "ptraceopname" "PT_[[:alnum:]_]+[[:space:]]+[0-9]+" "sys/ptrace.h"
1.18 guenther 337: auto_orz_type "ktracefacname" "KTRFAC_[^M][[:alnum:]_]+" "sys/ktrace.h"
338: auto_switch_type "itimername" "ITIMER_[[:alnum:]_]+" "sys/time.h"
1.1 otto 339:
340: cat <<_EOF_
341: /*
342: * AUTO - Special
343: * F_ is used to specify fcntl commands as well as arguments. Both sets are
344: * grouped in fcntl.h, and this awk script grabs the first group.
345: */
346: void
1.4 otto 347: fcntlcmdname (int cmd, int arg)
1.1 otto 348: {
349: switch (cmd) {
350: _EOF_
1.6 matthew 351: egrep "^#[[:space:]]*define[[:space:]]+F_[A-Z_]+[[:space:]]+[0-9]+[[:space:]]*" \
1.1 otto 352: $include_dir/sys/fcntl.h | \
353: awk 'BEGIN { o=0 } { for (i = 1; i <= NF; i++) \
354: if ($i ~ /define/) \
355: break; \
356: ++i; \
357: if (o <= $(i+1)) \
358: printf "\tcase %s:\n\t\t(void)printf(\"%s\");\n\t\tbreak;\n", $i, $i; \
359: else \
360: exit; \
361: o = $(i+1) }'
362: cat <<_EOF_
363: default: /* Should not reach */
364: (void)printf("<invalid=%ld>", (long)cmd);
365: }
1.14 guenther 366: if (cmd == F_SETFD) {
367: (void)putchar(',');
1.1 otto 368: if (arg == FD_CLOEXEC)
369: (void)printf("FD_CLOEXEC");
370: else if (arg == 0)
371: (void)printf("0");
372: else {
373: if (decimal)
374: (void)printf("<invalid>%ld", (long)arg);
375: else
376: (void)printf("<invalid>%#lx", (long)arg);
377: }
1.14 guenther 378:
1.1 otto 379: } else if (cmd == F_SETFL) {
1.14 guenther 380: (void)putchar(',');
1.1 otto 381: flagsname(arg);
1.14 guenther 382: } else if (!fancy || (cmd != F_GETFD && cmd != F_GETFL)) {
383: (void)putchar(',');
1.1 otto 384: if (decimal)
385: (void)printf("%ld", (long)arg);
386: else
387: (void)printf("%#lx", (long)arg);
388: }
389: }
390:
391: /*
392: * AUTO - Special
393: *
394: * The send and recv functions have a flags argument which can be
395: * set to 0. There is no corresponding #define. The auto_ functions
396: * detect this as "invalid", which is incorrect here.
397: */
398: void
399: sendrecvflagsname (int flags)
400: {
401: int or = 0;
402:
403: if (flags == 0) {
404: (void)printf("0");
405: return;
406: }
407:
408: printf("%#x<", flags);
409: _EOF_
410: egrep "^#[[:space:]]*define[[:space:]]+MSG_[A-Z]+[[:space:]]+0x[0-9]+[[:space:]]*" $include_dir/sys/socket.h | \
411: awk '{ for (i = 1; i <= NF; i++) \
412: if ($i ~ /define/) \
413: break; \
414: ++i; \
415: printf "\tif(!((flags>0)^((%s)>0)))\n\t\tif_print_or(flags, %s, or);\n", $i, $i }'
416: cat <<_EOF_
417: printf(">");
418: }
419:
420: _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