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
75 printf("%#jx<", (uintmax_t)arg);
77 egrep "^#[[:space:]]*define[[:space:]]+"${grep}"[[:space:]]*" \
78 $include_dir/$file | \
79 awk '{ for (i = 1; i <= NF; i++) \
83 printf "\tif (!((arg > 0) ^ ((%s) > 0)))\n\t\tif_print_or(arg, %s, or);\n", $i, $i }'
87 printf("<invalid>%jd", arg);
94 # Automatically generates a C function used when the argument
95 # maps to a single, specific #definition
110 egrep "^#[[:space:]]*define[[:space:]]+"${grep}"[[:space:]]*" \
111 $include_dir/$file | \
112 awk '{ for (i = 1; i <= NF; i++) \
116 printf "\tcase %s:\n\t\tprintf(\"%s\");\n\t\tbreak;\n", $i, $i }'
118 default: /* Should not reach */
119 printf("<invalid=%jd>", arg);
127 # Automatically generates a C function used when the argument
128 # maps to a #definition
142 egrep "^#[[:space:]]*define[[:space:]]+"${grep}"[[:space:]]*" \
143 $include_dir/$file | \
144 awk '{ printf "\t"; \
147 printf "if (arg == %s) \n\t\tprintf(\"%s\");\n", $2, $2 }'
149 else /* Should not reach */
150 printf("<invalid=%jd>", arg);
162 #include <sys/fcntl.h>
163 #include <sys/stat.h>
164 #include <sys/unistd.h>
165 #include <sys/mman.h>
166 #include <sys/wait.h>
168 #include <sys/socket.h>
170 #include <netinet/in.h>
171 #include <sys/param.h>
172 #include <sys/mount.h>
173 #include <sys/procctl.h>
174 #include <sys/ptrace.h>
175 #include <sys/resource.h>
176 #include <sys/reboot.h>
178 #include <sys/linker.h>
182 #include <sys/extattr.h>
187 #include <sys/rtprio.h>
189 #include <machine/atomic.h>
190 #include <sys/umtx.h>
191 #include <nfsserver/nfs.h>
192 #include <ufs/ufs/quota.h>
193 #include <sys/capsicum.h>
195 #include <vm/vm_param.h>
197 #include "kdump_subr.h"
200 * These are simple support macros. print_or utilizes a variable
201 * defined in the calling function to track whether or not it should
202 * print a logical-OR character ('|') before a string. if_print_or
203 * simply handles the necessary "if" statement used in many lines
206 #define print_or(str,orflag) do { \\
207 if (orflag) putchar('|'); else orflag = 1; \\
210 #define if_print_or(i,flag,orflag) do { \\
211 if ((i & flag) == flag) \\
212 print_or(#flag,orflag); } \\
217 atfdname(int fd, int decimal)
228 extern char *signames[]; /* from kdump.c */
232 if (sig > 0 && sig < NSIG)
233 printf("SIG%s",signames[sig]);
235 printf("SIG %d", sig);
273 default: /* Should not reach */
274 printf("<invalid=%d>", cmd);
292 default: /* Should not reach */
293 printf("<invalid=%d>", cmd);
302 if_print_or(flag, IPC_CREAT, or);
303 if_print_or(flag, IPC_EXCL, or);
304 if_print_or(flag, SEM_R, or);
305 if_print_or(flag, SEM_A, or);
306 if_print_or(flag, (SEM_R>>3), or);
307 if_print_or(flag, (SEM_A>>3), or);
308 if_print_or(flag, (SEM_R>>6), or);
309 if_print_or(flag, (SEM_A>>6), or);
315 * Only used by SYS_open. Unless O_CREAT is set in flags, the
316 * mode argument is unused (and often bogus and misleading).
319 flagsandmodename(int flags, int mode, int decimal)
323 if ((flags & O_CREAT) == O_CREAT) {
327 printf("<unused>%d", mode);
329 printf("<unused>%#x", (unsigned int)mode);
336 idtypename(idtype_t idtype, int decimal)
389 printf("%d", idtype);
391 printf("%#x", idtype);
399 * [g|s]etsockopt's level argument can either be SOL_SOCKET or a value
400 * referring to a line in /etc/protocols . It might be appropriate
401 * to use getprotoent(3) here.
404 sockoptlevelname(int level, int decimal)
406 if (level == SOL_SOCKET) {
407 printf("SOL_SOCKET");
412 printf("%#x", (unsigned int)level);
420 * Used for page fault type. Cannot use auto_or_type since the macro
421 * values contain a cast. Also, VM_PROT_NONE has to be handled specially.
424 vmprotname (int type)
428 if (type == VM_PROT_NONE) {
429 (void)printf("VM_PROT_NONE");
432 if_print_or(type, VM_PROT_READ, or);
433 if_print_or(type, VM_PROT_WRITE, or);
434 if_print_or(type, VM_PROT_EXECUTE, or);
435 if_print_or(type, VM_PROT_COPY, or);
442 socktypenamewithflags(int type)
444 if (type & SOCK_CLOEXEC)
445 printf("SOCK_CLOEXEC|"), type &= ~SOCK_CLOEXEC;
446 if (type & SOCK_NONBLOCK)
447 printf("SOCK_NONBLOCK|"), type &= ~SOCK_NONBLOCK;
452 auto_or_type "accessmodename" "[A-Z]_OK[[:space:]]+0?x?[0-9A-Fa-f]+" "sys/unistd.h"
453 auto_switch_type "acltypename" "ACL_TYPE_[A-Z4_]+[[:space:]]+0x[0-9]+" "sys/acl.h"
454 auto_or_type "capfcntlname" "CAP_FCNTL_[A-Z]+[[:space:]]+\(1" "sys/capsicum.h"
455 auto_switch_type "extattrctlname" "EXTATTR_NAMESPACE_[A-Z]+[[:space:]]+0x[0-9]+" "sys/extattr.h"
456 auto_switch_type "fadvisebehavname" "POSIX_FADV_[A-Z]+[[:space:]]+[0-9]+" "sys/fcntl.h"
457 auto_or_type "flagsname" "O_[A-Z]+[[:space:]]+0x[0-9A-Fa-f]+" "sys/fcntl.h"
458 auto_or_type "flockname" "LOCK_[A-Z]+[[:space:]]+0x[0-9]+" "sys/fcntl.h"
459 auto_or_type "getfsstatflagsname" "MNT_[A-Z]+[[:space:]]+[1-9][0-9]*" "sys/mount.h"
460 auto_switch_type "kldsymcmdname" "KLDSYM_[A-Z]+[[:space:]]+[0-9]+" "sys/linker.h"
461 auto_switch_type "kldunloadfflagsname" "LINKER_UNLOAD_[A-Z]+[[:space:]]+[0-9]+" "sys/linker.h"
462 auto_switch_type "lio_listioname" "LIO_(NO)?WAIT[[:space:]]+[0-9]+" "aio.h"
463 auto_switch_type "madvisebehavname" "_?MADV_[A-Z]+[[:space:]]+[0-9]+" "sys/mman.h"
464 auto_switch_type "minheritname" "INHERIT_[A-Z]+[[:space:]]+[0-9]+" "sys/mman.h"
465 auto_or_type "mlockallname" "MCL_[A-Z]+[[:space:]]+0x[0-9]+" "sys/mman.h"
466 auto_or_type "mmapprotname" "PROT_[A-Z]+[[:space:]]+0x[0-9A-Fa-f]+" "sys/mman.h"
467 auto_or_type "modename" "S_[A-Z]+[[:space:]]+[0-6]{7}" "sys/stat.h"
468 auto_or_type "mountflagsname" "MNT_[A-Z]+[[:space:]]+0x[0-9]+" "sys/mount.h"
469 auto_switch_type "msyncflagsname" "MS_[A-Z]+[[:space:]]+0x[0-9]+" "sys/mman.h"
470 auto_or_type "nfssvcname" "NFSSVC_[A-Z0-9]+[[:space:]]+0x[0-9]+" "nfs/nfssvc.h"
471 auto_switch_type "prioname" "PRIO_[A-Z]+[[:space:]]+[0-9]" "sys/resource.h"
472 auto_switch_type "procctlcmdname" "PROC_[A-Z]+[[:space:]]+[0-9]" "sys/procctl.h"
473 auto_switch_type "ptraceopname" "PT_[[:alnum:]_]+[[:space:]]+[0-9]+" "sys/ptrace.h"
474 auto_switch_type "quotactlname" "Q_[A-Z]+[[:space:]]+0x[0-9]+" "ufs/ufs/quota.h"
475 auto_or_type "rebootoptname" "RB_[A-Z]+[[:space:]]+0x[0-9]+" "sys/reboot.h"
476 auto_or_type "rforkname" "RF[A-Z]+[[:space:]]+\([0-9]+<<[0-9]+\)" "sys/unistd.h"
477 auto_switch_type "rlimitname" "RLIMIT_[A-Z]+[[:space:]]+[0-9]+" "sys/resource.h"
478 auto_switch_type "schedpolicyname" "SCHED_[A-Z]+[[:space:]]+[0-9]+" "sched.h"
479 auto_switch_type "sendfileflagsname" "SF_[A-Z]+[[:space:]]+[0-9]+" "sys/socket.h"
480 auto_or_type "shmatname" "SHM_[A-Z]+[[:space:]]+[0-9]{6}+" "sys/shm.h"
481 auto_switch_type "shutdownhowname" "SHUT_[A-Z]+[[:space:]]+[0-9]+" "sys/socket.h"
482 auto_switch_type "sigbuscodename" "BUS_[A-Z]+[[:space:]]+[0-9]+" "sys/signal.h"
483 auto_switch_type "sigchldcodename" "CLD_[A-Z]+[[:space:]]+[0-9]+" "sys/signal.h"
484 auto_switch_type "sigfpecodename" "FPE_[A-Z]+[[:space:]]+[0-9]+" "sys/signal.h"
485 auto_switch_type "sigprocmaskhowname" "SIG_[A-Z]+[[:space:]]+[0-9]+" "sys/signal.h"
486 auto_switch_type "sigillcodename" "ILL_[A-Z]+[[:space:]]+[0-9]+" "sys/signal.h"
487 auto_switch_type "sigsegvcodename" "SEGV_[A-Z]+[[:space:]]+[0-9]+" "sys/signal.h"
488 auto_switch_type "sigtrapcodename" "TRAP_[A-Z]+[[:space:]]+[0-9]+" "sys/signal.h"
489 auto_if_type "sockdomainname" "PF_[[:alnum:]]+[[:space:]]+" "sys/socket.h"
490 auto_if_type "sockfamilyname" "AF_[[:alnum:]]+[[:space:]]+" "sys/socket.h"
491 auto_if_type "sockipprotoname" "IPPROTO_[[:alnum:]]+[[:space:]]+" "netinet/in.h"
492 auto_switch_type "sockoptname" "SO_[A-Z]+[[:space:]]+0x[0-9]+" "sys/socket.h"
493 auto_switch_type "socktypename" "SOCK_[A-Z]+[[:space:]]+[1-9]+[0-9]*" "sys/socket.h"
494 auto_or_type "thrcreateflagsname" "THR_[A-Z]+[[:space:]]+0x[0-9]+" "sys/thr.h"
495 auto_switch_type "umtxopname" "UMTX_OP_[[:alnum:]_]+[[:space:]]+[0-9]+" "sys/umtx.h"
496 auto_switch_type "vmresultname" "KERN_[A-Z]+[[:space:]]+[0-9]+" "vm/vm_param.h"
497 auto_or_type "wait6optname" "W[A-Z]+[[:space:]]+[0-9]+" "sys/wait.h"
498 auto_switch_type "whencename" "SEEK_[A-Z]+[[:space:]]+[0-9]+" "sys/unistd.h"
503 * F_ is used to specify fcntl commands as well as arguments. Both sets are
504 * grouped in fcntl.h, and this awk script grabs the first group.
507 fcntlcmdname(int cmd, int arg, int decimal)
511 egrep "^#[[:space:]]*define[[:space:]]+F_[A-Z0-9_]+[[:space:]]+[0-9]+[[:space:]]*" \
512 $include_dir/sys/fcntl.h | \
513 awk 'BEGIN { o=0 } { for (i = 1; i <= NF; i++) \
518 printf "\tcase %s:\n\t\tprintf(\"%s\");\n\t\tbreak;\n", $i, $i; \
523 default: /* Should not reach */
524 printf("<invalid=%d>", cmd);
527 if (cmd == F_GETFD || cmd == F_SETFD) {
528 if (arg == FD_CLOEXEC)
529 printf("FD_CLOEXEC");
534 printf("<invalid>%d", arg);
536 printf("<invalid>%#x", (unsigned int)arg);
538 } else if (cmd == F_SETFL) {
544 printf("%#x", (unsigned int)arg);
551 * The MAP_ALIGNED flag requires special handling.
554 mmapflagsname(int flags)
558 printf("%#x<", flags);
560 egrep "^#[[:space:]]*define[[:space:]]+MAP_[A-Z_]+[[:space:]]+0x[0-9A-Fa-f]+[[:space:]]*" \
561 $include_dir/sys/mman.h | grep -v MAP_ALIGNED | \
562 awk '{ for (i = 1; i <= NF; i++) \
566 printf "\tif (!((flags > 0) ^ ((%s) > 0)))\n\t\tif_print_or(flags, %s, or);\n", $i, $i }'
569 if (!((flags > 0) ^ ((MAP_32BIT) > 0)))
570 if_print_or(flags, MAP_32BIT, or);
572 align = flags & MAP_ALIGNMENT_MASK;
574 if (align == MAP_ALIGNED_SUPER)
575 print_or("MAP_ALIGNED_SUPER", or);
577 print_or("MAP_ALIGNED", or);
578 printf("(%d)", align >> MAP_ALIGNMENT_SHIFT);
583 printf("<invalid>%d", flags);
589 * The only reason this is not fully automated is due to the
590 * grep -v RTP_PRIO statement. A better egrep line should
591 * make this capable of being a auto_switch_type() function.
598 egrep "^#[[:space:]]*define[[:space:]]+RTP_[A-Z]+[[:space:]]+0x[0-9]+[[:space:]]*" \
599 $include_dir/sys/rtprio.h | grep -v RTP_PRIO | \
600 awk '{ for (i = 1; i <= NF; i++) \
604 printf "\tcase %s:\n\t\tprintf(\"%s\");\n\t\tbreak;\n", $i, $i }'
606 default: /* Should not reach */
607 printf("<invalid=%d>", func);
614 * The send and recv functions have a flags argument which can be
615 * set to 0. There is no corresponding #define. The auto_ functions
616 * detect this as "invalid", which is incorrect here.
619 sendrecvflagsname(int flags)
628 printf("%#x<", flags);
630 egrep "^#[[:space:]]*define[[:space:]]+MSG_[A-Z]+[[:space:]]+0x[0-9]+[[:space:]]*" $include_dir/sys/socket.h | \
631 awk '{ for (i = 1; i <= NF; i++) \
635 printf "\tif(!((flags>0)^((%s)>0)))\n\t\tif_print_or(flags, %s, or);\n", $i, $i }'
643 * Check general codes first, then defer to signal-specific codes.
646 sigcodename(int sig, int code)
650 egrep "^#[[:space:]]*define[[:space:]]+SI_[A-Z]+[[:space:]]+0(x[0-9abcdef]+)?[[:space:]]*" \
651 $include_dir/sys/signal.h | grep -v SI_UNDEFINED | \
652 awk '{ for (i = 1; i <= NF; i++) \
656 printf "\tcase %s:\n\t\tprintf(\"%s\");\n\t\tbreak;\n", $i, $i }'
661 sigillcodename(code);
664 sigbuscodename(code);
667 sigsegvcodename(code);
670 sigfpecodename(code);
673 sigtrapcodename(code);
676 sigchldcodename(code);
679 printf("<invalid=%#x>", code);
690 umtxcvwaitflags(intmax_t arg)
697 printf("%#jx<", (uintmax_t)arg);
699 egrep "^#[[:space:]]*define[[:space:]]+CVWAIT_[A-Z_]+[[:space:]]+0x[0-9]+[[:space:]]*" \
700 $include_dir/sys/umtx.h | \
701 awk '{ for (i = 1; i <= NF; i++) \
705 printf "\tif (!((arg > 0) ^ ((%s) > 0)))\n\t\tif_print_or(arg, %s, or);\n", $i, $i }'
709 printf("<invalid>%jd", arg);
719 umtxrwlockflags(intmax_t arg)
726 printf("%#jx<", (uintmax_t)arg);
728 egrep "^#[[:space:]]*define[[:space:]]+URWLOCK_PREFER_READER[[:space:]]+0x[0-9]+[[:space:]]*" \
729 $include_dir/sys/umtx.h | \
730 awk '{ for (i = 1; i <= NF; i++) \
734 printf "\tif (!((arg > 0) ^ ((%s) > 0)))\n\t\tif_print_or(arg, %s, or);\n", $i, $i }'
738 printf("<invalid>%jd", arg);
741 egrep '#define[[:space:]]+CAP_[A-Z_]+[[:space:]]+CAPRIGHT\([0-9],[[:space:]]+0x[0-9]{16}ULL\)' \
742 $include_dir/sys/capsicum.h | \
743 sed -E 's/[ ]+/ /g' | \
747 printf "capname(const cap_rights_t *rightsp)\n"
749 printf "\tint comma = 0;\n\n"
750 printf "\tprintf(\"<\");\n"
753 printf "\tif ((rightsp->cr_rights[%s] & %s) == %s) {\n", $4, $2, $2
754 printf "\t\tif (comma) printf(\",\"); else comma = 1;\n"
755 printf "\t\tprintf(\"%s\");\n", $2
759 printf "\tprintf(\">\");\n"