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