3 # Copyright (c) 2006 "David Kirchner" <dpk@dpk.net>. All rights reserved.
5 # Redistribution and use in source and binary forms, with or without
6 # modification, are permitted provided that the following conditions
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.
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
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.
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.
38 # AUTO: Completely auto-generated with either the "or" or the "switch"
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.
46 LC_ALL=C; export LC_ALL
50 echo "usage: sh $0 include-dir"
56 # Automatically generates a C function that will print out the
57 # numeric input as a pipe-delimited string of the appropriate
59 # S_IRUSR|S_IWUSR|S_IRGRP|S_IROTH
60 # The XOR is necessary to prevent including the "0"-value in every
76 egrep "^#[[:space:]]*define[[:space:]]+"${grep}"[[:space:]]*" \
77 $include_dir/$file | \
78 awk '{ for (i = 1; i <= NF; i++) \
82 printf "\tif(!((arg>0)^((%s)>0)))\n\t\tif_print_or(arg, %s, or);\n", $i, $i }'
85 (void)printf("<invalid>%ld", (long)arg);
92 # Automatically generates a C function used when the argument
93 # maps to a single, specific #definition
108 egrep "^#[[:space:]]*define[[:space:]]+"${grep}"[[:space:]]*" \
109 $include_dir/$file | \
110 awk '{ for (i = 1; i <= NF; i++) \
114 printf "\tcase %s:\n\t\t(void)printf(\"%s\");\n\t\tbreak;\n", $i, $i }'
116 default: /* Should not reach */
117 (void)printf("<invalid=%ld>", (long)arg);
125 # Automatically generates a C function used when the argument
126 # maps to a #definition
140 egrep "^#[[:space:]]*define[[:space:]]+"${grep}"[[:space:]]*" \
141 $include_dir/$file | \
142 awk '{ printf "\t"; \
145 printf "if (arg == %s) \n\t\tprintf(\"%s\");\n", $2, $2 }'
147 else /* Should not reach */
148 (void)printf("<invalid=%ld>", (long)arg);
158 #include <sys/fcntl.h>
159 #include <sys/stat.h>
160 #include <sys/unistd.h>
161 #include <sys/mman.h>
162 #include <sys/wait.h>
164 #include <sys/socket.h>
166 #include <netinet/in.h>
167 #include <sys/param.h>
168 #include <sys/mount.h>
169 #include <sys/ptrace.h>
170 #include <sys/resource.h>
171 #include <sys/reboot.h>
173 #include <sys/linker.h>
177 #include <sys/extattr.h>
182 #include <sys/rtprio.h>
184 #include <nfsserver/nfs.h>
185 #include <ufs/ufs/quota.h>
187 #include "kdump_subr.h"
190 * These are simple support macros. print_or utilizes a variable
191 * defined in the calling function to track whether or not it should
192 * print a logical-OR character ('|') before a string. if_print_or
193 * simply handles the necessary "if" statement used in many lines
196 #define print_or(str,orflag) do { \\
197 if (orflag) putchar('|'); else orflag = 1; \\
200 #define if_print_or(i,flag,orflag) do { \\
201 if ((i & flag) == flag) \\
202 print_or(#flag,orflag); } \\
206 extern char *signames[]; /* from kdump.c */
210 if (sig > 0 && sig < NSIG)
211 (void)printf("SIG%s",signames[sig]);
213 (void)printf("SIG %d", sig);
222 (void)printf("GETNCNT");
225 (void)printf("GETPID");
228 (void)printf("GETVAL");
231 (void)printf("GETALL");
234 (void)printf("GETZCNT");
237 (void)printf("SETVAL");
240 (void)printf("SETALL");
243 (void)printf("IPC_RMID");
246 (void)printf("IPC_SET");
249 (void)printf("IPC_STAT");
251 default: /* Should not reach */
252 (void)printf("<invalid=%ld>", (long)cmd);
258 shmctlname (int cmd) {
261 (void)printf("IPC_RMID");
264 (void)printf("IPC_SET");
267 (void)printf("IPC_STAT");
269 default: /* Should not reach */
270 (void)printf("<invalid=%ld>", (long)cmd);
276 semgetname (int flag) {
278 if_print_or(flag, IPC_CREAT, or);
279 if_print_or(flag, IPC_EXCL, or);
280 if_print_or(flag, SEM_R, or);
281 if_print_or(flag, SEM_A, or);
282 if_print_or(flag, (SEM_R>>3), or);
283 if_print_or(flag, (SEM_A>>3), or);
284 if_print_or(flag, (SEM_R>>6), or);
285 if_print_or(flag, (SEM_A>>6), or);
291 * Only used by SYS_open. Unless O_CREAT is set in flags, the
292 * mode argument is unused (and often bogus and misleading).
295 flagsandmodename (int flags, int mode, int decimal) {
298 if ((flags & O_CREAT) == O_CREAT) {
302 (void)printf("<unused>%ld", (long)mode);
304 (void)printf("<unused>%#lx", (long)mode);
312 * [g|s]etsockopt's level argument can either be SOL_SOCKET or a value
313 * referring to a line in /etc/protocols . It might be appropriate
314 * to use getprotoent(3) here.
317 sockoptlevelname (int level, int decimal)
319 if (level == SOL_SOCKET) {
320 (void)printf("SOL_SOCKET");
323 (void)printf("%ld", (long)level);
325 (void)printf("%#lx", (long)level);
332 auto_or_type "modename" "S_[A-Z]+[[:space:]]+[0-6]{7}" "sys/stat.h"
333 auto_or_type "flagsname" "O_[A-Z]+[[:space:]]+0x[0-9A-Fa-f]+" "sys/fcntl.h"
334 auto_or_type "accessmodename" "[A-Z]_OK[[:space:]]+0?x?[0-9A-Fa-f]+" "sys/unistd.h"
335 auto_or_type "mmapprotname" "PROT_[A-Z]+[[:space:]]+0x[0-9A-Fa-f]+" "sys/mman.h"
336 auto_or_type "mmapflagsname" "MAP_[A-Z]+[[:space:]]+0x[0-9A-Fa-f]+" "sys/mman.h"
337 auto_or_type "wait4optname" "W[A-Z]+[[:space:]]+[0-9]+" "sys/wait.h"
338 auto_or_type "getfsstatflagsname" "MNT_[A-Z]+[[:space:]]+[1-9][0-9]*" "sys/mount.h"
339 auto_or_type "mountflagsname" "MNT_[A-Z]+[[:space:]]+0x[0-9]+" "sys/mount.h"
340 auto_or_type "rebootoptname" "RB_[A-Z]+[[:space:]]+0x[0-9]+" "sys/reboot.h"
341 auto_or_type "flockname" "LOCK_[A-Z]+[[:space:]]+0x[0-9]+" "sys/fcntl.h"
342 auto_or_type "thrcreateflagsname" "THR_[A-Z]+[[:space:]]+0x[0-9]+" "sys/thr.h"
343 auto_or_type "mlockallname" "MCL_[A-Z]+[[:space:]]+0x[0-9]+" "sys/mman.h"
344 auto_or_type "shmatname" "SHM_[A-Z]+[[:space:]]+[0-9]{6}+" "sys/shm.h"
345 auto_or_type "rforkname" "RF[A-Z]+[[:space:]]+\([0-9]+<<[0-9]+\)" "sys/unistd.h"
346 auto_or_type "nfssvcname" "NFSSVC_[A-Z]+[[:space:]]+0x[0-9]+" "nfsserver/nfs.h"
348 auto_switch_type "whencename" "SEEK_[A-Z]+[[:space:]]+[0-9]+" "sys/unistd.h"
349 auto_switch_type "rlimitname" "RLIMIT_[A-Z]+[[:space:]]+[0-9]+" "sys/resource.h"
350 auto_switch_type "shutdownhowname" "SHUT_[A-Z]+[[:space:]]+0x[0-9]+" "sys/socket.h"
351 auto_switch_type "prioname" "PRIO_[A-Z]+[[:space:]]+[0-9]" "sys/resource.h"
352 auto_switch_type "madvisebehavname" "_?MADV_[A-Z]+[[:space:]]+[0-9]+" "sys/mman.h"
353 auto_switch_type "msyncflagsname" "MS_[A-Z]+[[:space:]]+0x[0-9]+" "sys/mman.h"
354 auto_switch_type "schedpolicyname" "SCHED_[A-Z]+[[:space:]]+[0-9]+" "sched.h"
355 auto_switch_type "kldunloadfflagsname" "LINKER_UNLOAD_[A-Z]+[[:space:]]+[0-9]+" "sys/linker.h"
356 auto_switch_type "extattrctlname" "EXTATTR_NAMESPACE_[A-Z]+[[:space:]]+0x[0-9]+" "sys/extattr.h"
357 auto_switch_type "kldsymcmdname" "KLDSYM_[A-Z]+[[:space:]]+[0-9]+" "sys/linker.h"
358 auto_switch_type "sendfileflagsname" "SF_[A-Z]+[[:space:]]+[0-9]+" "sys/socket.h"
359 auto_switch_type "acltypename" "ACL_TYPE_[A-Z]+[[:space:]]+0x[0-9]+" "sys/acl.h"
360 auto_switch_type "sigprocmaskhowname" "SIG_[A-Z]+[[:space:]]+[0-9]+" "sys/signal.h"
361 auto_switch_type "lio_listioname" "LIO_(NO)?WAIT[[:space:]]+[0-9]+" "aio.h"
362 auto_switch_type "minheritname" "INHERIT_[A-Z]+[[:space:]]+[0-9]+" "sys/mman.h"
363 auto_switch_type "quotactlname" "Q_[A-Z]+[[:space:]]+0x[0-9]+" "ufs/ufs/quota.h"
364 auto_if_type "sockdomainname" "PF_[[:alnum:]]+[[:space:]]+" "sys/socket.h"
365 auto_if_type "sockfamilyname" "AF_[[:alnum:]]+[[:space:]]+" "sys/socket.h"
366 auto_if_type "sockipprotoname" "IPPROTO_[[:alnum:]]+[[:space:]]+" "netinet/in.h"
367 auto_switch_type "sockoptname" "SO_[A-Z]+[[:space:]]+0x[0-9]+" "sys/socket.h"
368 auto_switch_type "socktypename" "SOCK_[A-Z]+[[:space:]]+[1-9]+[0-9]*" "sys/socket.h"
369 auto_switch_type "ptraceopname" "PT_[[:alnum:]_]+[[:space:]]+[0-9]+" "sys/ptrace.h"
374 * F_ is used to specify fcntl commands as well as arguments. Both sets are
375 * grouped in fcntl.h, and this awk script grabs the first group.
378 fcntlcmdname (int cmd, int arg, int decimal)
382 egrep "^#[[:space:]]*define[[:space:]]+F_[A-Z]+[[:space:]]+[0-9]+[[:space:]]*" \
383 $include_dir/sys/fcntl.h | \
384 awk 'BEGIN { o=0 } { for (i = 1; i <= NF; i++) \
389 printf "\tcase %s:\n\t\t(void)printf(\"%s\");\n\t\tbreak;\n", $i, $i; \
394 default: /* Should not reach */
395 (void)printf("<invalid=%ld>", (long)cmd);
398 if (cmd == F_GETFD || cmd == F_SETFD) {
399 if (arg == FD_CLOEXEC)
400 (void)printf("FD_CLOEXEC");
405 (void)printf("<invalid>%ld", (long)arg);
407 (void)printf("<invalid>%#lx", (long)arg);
409 } else if (cmd == F_SETFL) {
413 (void)printf("%ld", (long)arg);
415 (void)printf("%#lx", (long)arg);
422 * The only reason this is not fully automated is due to the
423 * grep -v RTP_PRIO statement. A better egrep line should
424 * make this capable of being a auto_switch_type() function.
427 rtprioname (int func)
431 egrep "^#[[:space:]]*define[[:space:]]+RTP_[A-Z]+[[:space:]]+0x[0-9]+[[:space:]]*" \
432 $include_dir/sys/rtprio.h | grep -v RTP_PRIO | \
433 awk '{ for (i = 1; i <= NF; i++) \
437 printf "\tcase %s:\n\t\t(void)printf(\"%s\");\n\t\tbreak;\n", $i, $i }'
439 default: /* Should not reach */
440 (void)printf("<invalid=%ld>", (long)func);
447 * The send and recv functions have a flags argument which can be
448 * set to 0. There is no corresponding #define. The auto_ functions
449 * detect this as "invalid", which is incorrect here.
452 sendrecvflagsname (int flags)
461 egrep "^#[[:space:]]*define[[:space:]]+MSG_[A-Z]+[[:space:]]+0x[0-9]+[[:space:]]*" $include_dir/sys/socket.h | \
462 awk '{ for (i = 1; i <= NF; i++) \
466 printf "\tif(!((flags>0)^((%s)>0)))\n\t\tif_print_or(flags, %s, or);\n", $i, $i }'