1#!/usr/bin/awk -f 2 3#- 4# Copyright (c) 1992, 1993 5# The Regents of the University of California. All rights reserved. 6# 7# Redistribution and use in source and binary forms, with or without 8# modification, are permitted provided that the following conditions 9# are met: 10# 1. Redistributions of source code must retain the above copyright 11# notice, this list of conditions and the following disclaimer. 12# 2. Redistributions in binary form must reproduce the above copyright 13# notice, this list of conditions and the following disclaimer in the 14# documentation and/or other materials provided with the distribution. 15# 4. Neither the name of the University nor the names of its contributors 16# may be used to endorse or promote products derived from this software 17# without specific prior written permission. 18# 19# THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 20# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 21# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 22# ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 23# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 24# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 25# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 26# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 27# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 28# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 29# SUCH DAMAGE. 30 31# 32# @(#)vnode_if.sh 8.1 (Berkeley) 6/10/93 33# $FreeBSD$ 34# 35# Script to produce VFS front-end sugar. 36# 37# usage: vnode_if.awk <srcfile> [-c | -h | -p | -q] 38# (where <srcfile> is currently /sys/kern/vnode_if.src) 39# The source file must have a .src extension 40# 41 42function usage() 43{ 44 print "usage: vnode_if.awk <srcfile> [-c|-h|-p|-q]"; 45 exit 1; 46} 47 48function die(msg, what) 49{ 50 printf srcfile "(" fnr "): " > "/dev/stderr"; 51 printf msg "\n", what > "/dev/stderr"; 52 exit 1; 53} 54 55function t_spc(type) 56{ 57 # Append a space if the type is not a pointer 58 return (type ~ /\*$/) ? type : type " "; 59} 60 61# These are just for convenience ... 62function printc(s) {print s > cfile;} 63function printh(s) {print s > hfile;} 64function printp(s) {print s > pfile;} 65function printq(s) {print s > qfile;} 66 67function add_debug_code(name, arg, pos, ind) 68{ 69 if (arg == "vpp") 70 star = "*"; 71 else 72 star = ""; 73 if (lockdata[name, arg, pos] && (lockdata[name, arg, pos] != "-")) { 74 printc(ind"ASSERT_VI_UNLOCKED("star"a->a_"arg", \""uname"\");"); 75 # Add assertions for locking 76 if (lockdata[name, arg, pos] == "L") 77 printc(ind"ASSERT_VOP_LOCKED(" star "a->a_"arg", \""uname"\");"); 78 else if (lockdata[name, arg, pos] == "U") 79 printc(ind"ASSERT_VOP_UNLOCKED(" star "a->a_"arg", \""uname"\");"); 80 else if (lockdata[name, arg, pos] == "E") 81 printc(ind"ASSERT_VOP_ELOCKED(" star "a->a_"arg", \""uname"\");"); 82 else if (0) { 83 # XXX More checks! 84 } 85 } 86} 87 88function add_pre(name) 89{ 90 if (lockdata[name, "pre"]) { 91 printc("\t"lockdata[name, "pre"]"(a);"); 92 } 93} 94 95function add_post(name) 96{ 97 if (lockdata[name, "post"]) { 98 printc("\t"lockdata[name, "post"]"(a, rc);"); 99 } 100} 101 102function find_arg_with_type (type) 103{ 104 for (jj = 0; jj < numargs; jj++) { 105 if (types[jj] == type) { 106 return "VOPARG_OFFSETOF(struct " \ 107 name "_args,a_" args[jj] ")"; 108 } 109 } 110 111 return "VDESC_NO_OFFSET"; 112} 113 114BEGIN{ 115 116# Process the command line 117for (i = 1; i < ARGC; i++) { 118 arg = ARGV[i]; 119 if (arg !~ /^-[chpq]+$/ && arg !~ /\.src$/) 120 usage(); 121 if (arg ~ /^-.*c/) 122 cfile = "vnode_if.c"; 123 if (arg ~ /^-.*h/) 124 hfile = "vnode_if.h"; 125 if (arg ~ /^-.*p/) 126 pfile = "vnode_if_newproto.h"; 127 if (arg ~ /^-.*q/) 128 qfile = "vnode_if_typedef.h"; 129 if (arg ~ /\.src$/) 130 srcfile = arg; 131} 132ARGC = 1; 133 134if (!cfile && !hfile && !pfile && !qfile) 135 exit 0; 136 137if (!srcfile) 138 usage(); 139 140common_head = \ 141 "/*\n" \ 142 " * This file is produced automatically.\n" \ 143 " * Do not modify anything in here by hand.\n" \ 144 " *\n" \ 145 " * Created from $FreeBSD$\n" \ 146 " */\n" \ 147 "\n"; 148 149if (pfile) { 150 printp(common_head) 151 printp("struct vop_vector {") 152 printp("\tstruct vop_vector\t*vop_default;") 153 printp("\tvop_bypass_t\t*vop_bypass;") 154} 155 156if (qfile) { 157 printq(common_head) 158} 159 160if (hfile) { 161 printh(common_head "extern struct vnodeop_desc vop_default_desc;"); 162 printh("#include \"vnode_if_typedef.h\"") 163 printh("#include \"vnode_if_newproto.h\"") 164} 165 166if (cfile) { 167 printc(common_head \ 168 "#include <sys/param.h>\n" \ 169 "#include <sys/event.h>\n" \ 170 "#include <sys/mount.h>\n" \ 171 "#include <sys/systm.h>\n" \ 172 "#include <sys/vnode.h>\n" \ 173 "\n" \ 174 "struct vnodeop_desc vop_default_desc = {\n" \ 175 " \"default\",\n" \ 176 " 0,\n" \ 177 " (vop_bypass_t *)vop_panic,\n" \ 178 " NULL,\n" \ 179 " VDESC_NO_OFFSET,\n" \ 180 " VDESC_NO_OFFSET,\n" \ 181 " VDESC_NO_OFFSET,\n" \ 182 " VDESC_NO_OFFSET,\n" \ 183 "};\n"); 184} 185 186while ((getline < srcfile) > 0) { 187 fnr++; 188 if (NF == 0) 189 continue; 190 if ($1 ~ /^%%/) { 191 if (NF != 6 || 192 $2 !~ /^[a-z]+$/ || $3 !~ /^[a-z]+$/ || 193 $4 !~ /^.$/ || $5 !~ /^.$/ || $6 !~ /^.$/) { 194 die("Invalid %s construction", "%%"); 195 continue; 196 } 197 lockdata["vop_" $2, $3, "Entry"] = $4; 198 lockdata["vop_" $2, $3, "OK"] = $5; 199 lockdata["vop_" $2, $3, "Error"] = $6; 200 continue; 201 } 202 203 if ($1 ~ /^%!/) { 204 if (NF != 4 || 205 ($3 != "pre" && $3 != "post")) { 206 die("Invalid %s construction", "%!"); 207 continue; 208 } 209 lockdata["vop_" $2, $3] = $4; 210 continue; 211 } 212 if ($1 ~ /^#/) 213 continue; 214 215 # Get the function name. 216 name = $1; 217 uname = toupper(name); 218 219 # Start constructing a ktrpoint string 220 ctrstr = "\"" uname; 221 # Get the function arguments. 222 for (numargs = 0; ; ++numargs) { 223 if ((getline < srcfile) <= 0) { 224 die("Unable to read through the arguments for \"%s\"", 225 name); 226 } 227 fnr++; 228 if ($1 ~ /^\};/) 229 break; 230 231 # Delete comments, if any. 232 gsub (/\/\*.*\*\//, ""); 233 234 # Condense whitespace and delete leading/trailing space. 235 gsub(/[[:space:]]+/, " "); 236 sub(/^ /, ""); 237 sub(/ $/, ""); 238 239 # Pick off direction. 240 if ($1 != "INOUT" && $1 != "IN" && $1 != "OUT") 241 die("No IN/OUT direction for \"%s\".", $0); 242 dirs[numargs] = $1; 243 sub(/^[A-Z]* /, ""); 244 245 if ((reles[numargs] = $1) == "WILLRELE") 246 sub(/^[A-Z]* /, ""); 247 else 248 reles[numargs] = "WONTRELE"; 249 250 # kill trailing ; 251 if (sub(/;$/, "") < 1) 252 die("Missing end-of-line ; in \"%s\".", $0); 253 254 # pick off variable name 255 if ((argp = match($0, /[A-Za-z0-9_]+$/)) < 1) 256 die("Missing var name \"a_foo\" in \"%s\".", $0); 257 args[numargs] = substr($0, argp); 258 $0 = substr($0, 1, argp - 1); 259 260 # what is left must be type 261 # remove trailing space (if any) 262 sub(/ $/, ""); 263 types[numargs] = $0; 264 265 # We can do a maximum of 6 arguments to CTR* 266 if (numargs <= 6) { 267 if (numargs == 0) 268 ctrstr = ctrstr "(" args[numargs]; 269 else 270 ctrstr = ctrstr ", " args[numargs]; 271 if (types[numargs] ~ /\*/) 272 ctrstr = ctrstr " 0x%lX"; 273 else 274 ctrstr = ctrstr " %ld"; 275 } 276 } 277 if (numargs > 6) 278 ctrargs = 6; 279 else 280 ctrargs = numargs; 281 ctrstr = "\tCTR" ctrargs "(KTR_VOP,\n\t " ctrstr ")\",\n\t "; 282 ctrstr = ctrstr "a->a_" args[0]; 283 for (i = 1; i < ctrargs; ++i) 284 ctrstr = ctrstr ", a->a_" args[i]; 285 ctrstr = ctrstr ");"; 286 287 if (pfile) { 288 printp("\t"name"_t\t*"name";") 289 } 290 if (qfile) { 291 printq("struct "name"_args;") 292 printq("typedef int "name"_t(struct "name"_args *);\n") 293 } 294 295 if (hfile) { 296 # Print out the vop_F_args structure. 297 printh("struct "name"_args {\n\tstruct vop_generic_args a_gen;"); 298 for (i = 0; i < numargs; ++i) 299 printh("\t" t_spc(types[i]) "a_" args[i] ";"); 300 printh("};"); 301 printh(""); 302 303 # Print out extern declaration. 304 printh("extern struct vnodeop_desc " name "_desc;"); 305 printh(""); 306 307 # Print out function prototypes. 308 printh("int " uname "_AP(struct " name "_args *);"); 309 printh("int " uname "_APV(struct vop_vector *vop, struct " name "_args *);"); 310 printh(""); 311 printh("static __inline int " uname "("); 312 for (i = 0; i < numargs; ++i) { 313 printh("\t" t_spc(types[i]) args[i] \ 314 (i < numargs - 1 ? "," : ")")); 315 } 316 printh("{"); 317 printh("\tstruct " name "_args a;"); 318 printh(""); 319 printh("\ta.a_gen.a_desc = &" name "_desc;"); 320 for (i = 0; i < numargs; ++i) 321 printh("\ta.a_" args[i] " = " args[i] ";"); 322 printh("\treturn (" uname "_APV("args[0]"->v_op, &a));"); 323 printh("}"); 324 325 printh(""); 326 } 327 328 if (cfile) { 329 # Print out the vop_F_vp_offsets structure. This all depends 330 # on naming conventions and nothing else. 331 printc("static int " name "_vp_offsets[] = {"); 332 # as a side effect, figure out the releflags 333 releflags = ""; 334 vpnum = 0; 335 for (i = 0; i < numargs; i++) { 336 if (types[i] == "struct vnode *") { 337 printc("\tVOPARG_OFFSETOF(struct " name \ 338 "_args,a_" args[i] "),"); 339 if (reles[i] == "WILLRELE") { 340 releflags = releflags \ 341 "|VDESC_VP" vpnum "_WILLRELE"; 342 } 343 vpnum++; 344 } 345 } 346 347 sub(/^\|/, "", releflags); 348 printc("\tVDESC_NO_OFFSET"); 349 printc("};"); 350 351 # Print out function. 352 printc("\nint\n" uname "_AP(struct " name "_args *a)"); 353 printc("{"); 354 printc(""); 355 printc("\treturn(" uname "_APV(a->a_" args[0] "->v_op, a));"); 356 printc("}"); 357 printc("\nint\n" uname "_APV(struct vop_vector *vop, struct " name "_args *a)"); 358 printc("{"); 359 printc("\tint rc;"); 360 printc(""); 361 printc("\tVNASSERT(a->a_gen.a_desc == &" name "_desc, a->a_" args[0]","); 362 printc("\t (\"Wrong a_desc in " name "(%p, %p)\", a->a_" args[0]", a));"); 363 printc("\twhile(vop != NULL && \\"); 364 printc("\t vop->"name" == NULL && vop->vop_bypass == NULL)") 365 printc("\t\tvop = vop->vop_default;") 366 printc("\tVNASSERT(vop != NULL, a->a_" args[0]", (\"No "name"(%p, %p)\", a->a_" args[0]", a));") 367 for (i = 0; i < numargs; ++i) 368 add_debug_code(name, args[i], "Entry", "\t"); 369 add_pre(name); 370 printc("\tif (vop->"name" != NULL)") 371 printc("\t\trc = vop->"name"(a);") 372 printc("\telse") 373 printc("\t\trc = vop->vop_bypass(&a->a_gen);") 374 printc(ctrstr); 375 printc("\tif (rc == 0) {"); 376 for (i = 0; i < numargs; ++i) 377 add_debug_code(name, args[i], "OK", "\t\t"); 378 printc("\t} else {"); 379 for (i = 0; i < numargs; ++i) 380 add_debug_code(name, args[i], "Error", "\t\t"); 381 printc("\t}"); 382 add_post(name); 383 printc("\treturn (rc);"); 384 printc("}\n"); 385 386 # Print out the vnodeop_desc structure. 387 printc("struct vnodeop_desc " name "_desc = {"); 388 # printable name 389 printc("\t\"" name "\","); 390 # flags 391 vppwillrele = ""; 392 for (i = 0; i < numargs; i++) { 393 if (types[i] == "struct vnode **" && \ 394 reles[i] == "WILLRELE") { 395 vppwillrele = "|VDESC_VPP_WILLRELE"; 396 } 397 } 398 399 if (!releflags) 400 releflags = "0"; 401 printc("\t" releflags vppwillrele ","); 402 403 # function to call 404 printc("\t(vop_bypass_t *)" uname "_AP,"); 405 # vp offsets 406 printc("\t" name "_vp_offsets,"); 407 # vpp (if any) 408 printc("\t" find_arg_with_type("struct vnode **") ","); 409 # cred (if any) 410 printc("\t" find_arg_with_type("struct ucred *") ","); 411 # thread (if any) 412 printc("\t" find_arg_with_type("struct thread *") ","); 413 # componentname 414 printc("\t" find_arg_with_type("struct componentname *") ","); 415 # transport layer information 416 printc("};\n"); 417 } 418} 419 420if (pfile) 421 printp("};") 422 423if (hfile) 424 close(hfile); 425if (cfile) 426 close(cfile); 427if (pfile) 428 close(pfile); 429close(srcfile); 430 431exit 0; 432 433} 434