vnode_if.sh revision 1.53.4.1
1 #!/bin/sh - 2 copyright="\ 3 /* 4 * Copyright (c) 1992, 1993, 1994, 1995 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 * 3. 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 SCRIPT_ID='$NetBSD: vnode_if.sh,v 1.53.4.1 2010/05/30 05:17:59 rmind Exp $' 33 34 # Script to produce VFS front-end sugar. 35 # 36 # usage: vnode_if.sh srcfile 37 # (where srcfile is currently /sys/kern/vnode_if.src) 38 # 39 40 if [ $# -ne 1 ] ; then 41 echo 'usage: vnode_if.sh srcfile' 42 exit 1 43 fi 44 45 # Name and revision of the source file. 46 src=$1 47 SRC_ID=`head -1 $src | sed -e 's/.*\$\(.*\)\$.*/\1/'` 48 49 # Names of the created files. 50 out_c=vnode_if.c 51 out_rumpc=../rump/librump/rumpvfs/rumpvnode_if.c 52 out_h=../sys/vnode_if.h 53 out_rumph=../rump/include/rump/rumpvnode_if.h 54 55 # generate VNODE_LOCKDEBUG checks (not fully functional) 56 lockdebug=0 57 58 # Awk program (must support nawk extensions) 59 # Use "awk" at Berkeley, "nawk" or "gawk" elsewhere. 60 awk=${AWK:-awk} 61 62 # Does this awk have a "toupper" function? (i.e. is it GNU awk) 63 isgawk=`$awk 'BEGIN { print toupper("true"); exit; }' 2>/dev/null` 64 65 # If this awk does not define "toupper" then define our own. 66 if [ "$isgawk" = TRUE ] ; then 67 # GNU awk provides it. 68 toupper= 69 else 70 # Provide our own toupper() 71 toupper=' 72 function toupper(str) { 73 _toupper_cmd = "echo "str" |tr a-z A-Z" 74 _toupper_cmd | getline _toupper_str; 75 close(_toupper_cmd); 76 return _toupper_str; 77 }' 78 fi 79 80 # 81 # This is the common part of all awk programs that read $src 82 # This parses the input for one function into the arrays: 83 # argdir, argtype, argname, willrele 84 # and calls "doit()" to generate output for the function. 85 # 86 # Input to this parser is pre-processed slightly by sed 87 # so this awk parser doesn't have to work so hard. The 88 # changes done by the sed pre-processing step are: 89 # insert a space beween * and pointer name 90 # replace semicolons with spaces 91 # 92 sed_prep='s:\*\([^\*/]\):\* \1:g 93 s/;/ /' 94 awk_parser=' 95 # Comment line 96 /^#/ { next; } 97 # First line of description 98 /^vop_/ { 99 name=$1; 100 argc=0; 101 willmake=-1; 102 next; 103 } 104 # Last line of description 105 /^}/ { 106 doit(); 107 next; 108 } 109 # Middle lines of description 110 { 111 argdir[argc] = $1; i=2; 112 113 if ($2 == "LOCKED=YES") { 114 lockstate[argc] = 1; 115 i++; 116 } else if ($2 == "LOCKED=NO") { 117 lockstate[argc] = 0; 118 i++; 119 } else 120 lockstate[argc] = -1; 121 122 if ($2 == "WILLRELE" || 123 $3 == "WILLRELE") { 124 willrele[argc] = 1; 125 i++; 126 } else if ($2 == "WILLUNLOCK" || 127 $3 == "WILLUNLOCK") { 128 willrele[argc] = 2; 129 i++; 130 } else if ($2 == "WILLPUT" || 131 $3 == "WILLPUT") { 132 willrele[argc] = 3; 133 i++; 134 } else 135 willrele[argc] = 0; 136 137 if ($2 == "WILLMAKE") { 138 willmake=argc; 139 i++; 140 } 141 142 # XXX: replace non-portable types for rump. We should really 143 # nuke the types from the kernel, but that is a battle for 144 # another day. 145 at = $i; 146 if (rump) { 147 if (at == "vm_prot_t") 148 at = "int"; 149 if (at == "voff_t") 150 at = "off_t"; 151 if (at == "kauth_cred_t") 152 at = "struct kauth_cred *" 153 } 154 argtype[argc] = at; 155 i++; 156 while (i < NF) { 157 argtype[argc] = argtype[argc]" "$i; 158 i++; 159 } 160 argname[argc] = $i; 161 argc++; 162 next; 163 } 164 ' 165 166 # This is put before the copyright on each generated file. 167 warning="\ 168 /* @NetBSD@ */ 169 170 /* 171 * Warning: DO NOT EDIT! This file is automatically generated! 172 * (Modifications made here may easily be lost!) 173 * 174 * Created from the file: 175 * ${SRC_ID} 176 * by the script: 177 * ${SCRIPT_ID} 178 */ 179 " 180 181 # This is to satisfy McKusick (get rid of evil spaces 8^) 182 anal_retentive='s:\([^/]\*\) :\1:g' 183 184 do_hfile () { 185 # 186 # Redirect stdout to the H file. 187 # 188 echo "$0: Creating $1" 1>&2 189 exec > $1 190 rump=$2 191 192 # Begin stuff 193 if [ -z "${rump}" ]; then 194 SYS='SYS_' 195 else 196 SYS='RUMP_RUMP' 197 fi 198 echo -n "$warning" | sed -e 's/\$//g;s/@/\$/g;s/ $//' 199 echo "" 200 echo -n "$copyright" 201 echo '' 202 echo "#ifndef _${SYS}VNODE_IF_H_" 203 echo "#define _${SYS}VNODE_IF_H_" 204 if [ ${lockdebug} -ne 0 ] ; then 205 echo '' 206 echo '#ifdef _KERNEL_OPT' 207 echo '#include "opt_vnode_lockdebug.h"' 208 echo '#endif /* _KERNEL_OPT */' 209 fi 210 [ -z "${rump}" ] && echo " 211 extern const struct vnodeop_desc ${rump}vop_default_desc;" 212 echo 213 214 # Body stuff 215 # This awk program needs toupper() so define it if necessary. 216 sed -e "$sed_prep" $src | $awk -v rump=${rump} "$toupper"' 217 function doit() { 218 name = rump name 219 # Declare arg struct, descriptor. 220 if (!rump) { 221 printf("\n#define %s_DESCOFFSET %d\n", 222 toupper(name), vop_offset++); 223 printf("struct %s_args {\n", name); 224 printf("\tconst struct vnodeop_desc * a_desc;\n"); 225 for (i=0; i<argc; i++) { 226 printf("\t%s a_%s;\n", argtype[i], argname[i]); 227 } 228 printf("};\n"); 229 printf("extern const struct vnodeop_desc %s_desc;\n", name); 230 } 231 # Prototype it. 232 protoarg = sprintf("int %s(", toupper(name)); 233 protolen = length(protoarg); 234 printf("%s", protoarg); 235 for (i=0; i<argc; i++) { 236 protoarg = sprintf("%s", argtype[i]); 237 if (i < (argc-1)) protoarg = (protoarg ", "); 238 arglen = length(protoarg); 239 if ((protolen + arglen) > 77) { 240 protoarg = ("\n " protoarg); 241 arglen += 4; 242 protolen = 0; 243 } 244 printf("%s", protoarg); 245 protolen += arglen; 246 } 247 printf(");\n"); 248 } 249 BEGIN { 250 arg0special=""; 251 vop_offset = 1; # start at 1, to count the 'default' op 252 253 printf("struct buf;\n"); 254 if (rump) { 255 printf("struct flock;\n"); 256 printf("struct knote;\n"); 257 printf("struct vm_page;\n"); 258 } 259 printf("\n#ifndef _KERNEL\n#include <stdbool.h>\n#endif\n"); 260 printf("\n/* Special cases: */\n"); 261 262 argc=1; 263 argtype[0]="struct buf *"; 264 argname[0]="bp"; 265 lockstate[0] = -1; 266 arg0special="->b_vp"; 267 name="vop_bwrite"; 268 doit(); 269 printf("\n/* End of special cases */\n"); 270 if (rump) 271 printf("\n"); 272 } 273 END { 274 if (!rump) { 275 printf("\n#define VNODE_OPS_COUNT\t%d\n", vop_offset); 276 } 277 } 278 '"$awk_parser" | sed -e "$anal_retentive" 279 280 # End stuff 281 echo '' 282 echo "#endif /* !_${SYS}VNODE_IF_H_ */" 283 } 284 do_hfile $out_h '' 285 do_hfile $out_rumph 'rump_' 286 287 do_cfile () { 288 # 289 # Redirect stdout to the C file. 290 # 291 echo "$0: Creating $1" 1>&2 292 exec > $1 293 rump=$2 294 295 # Begin stuff 296 echo -n "$warning" | sed -e 's/\$//g;s/@/\$/g;s/ $//' 297 echo "" 298 echo -n "$copyright" 299 echo " 300 #include <sys/cdefs.h> 301 __KERNEL_RCSID(0, \"\$NetBSD\$\");" 302 303 [ ${lockdebug} -ne 0 ] && echo && echo '#include "opt_vnode_lockdebug.h"' 304 305 echo ' 306 #include <sys/param.h> 307 #include <sys/mount.h> 308 #include <sys/buf.h> 309 #include <sys/vnode.h> 310 #include <sys/lock.h>' 311 [ ! -z "${rump}" ] && echo '#include <rump/rumpvnode_if.h>' \ 312 && echo '#include "rump_private.h"' 313 314 if [ -z "${rump}" ] ; then 315 echo " 316 const struct vnodeop_desc vop_default_desc = {" 317 echo ' 0, 318 "default", 319 0, 320 NULL, 321 VDESC_NO_OFFSET, 322 VDESC_NO_OFFSET, 323 VDESC_NO_OFFSET, 324 }; 325 ' 326 fi 327 328 # Body stuff 329 sed -e "$sed_prep" $src | $awk -v rump=${rump} -v lockdebug=${lockdebug} ' 330 function do_offset(typematch) { 331 for (i=0; i<argc; i++) { 332 if (argtype[i] == typematch) { 333 printf("\tVOPARG_OFFSETOF(struct %s_args, a_%s),\n", 334 name, argname[i]); 335 return i; 336 }; 337 }; 338 print "\tVDESC_NO_OFFSET,"; 339 return -1; 340 } 341 342 function offsets() { 343 # Define offsets array 344 printf("const int %s_vp_offsets[] = {\n", name); 345 for (i=0; i<argc; i++) { 346 if (argtype[i] == "struct vnode *") { 347 printf ("\tVOPARG_OFFSETOF(struct %s_args,a_%s),\n", 348 name, argname[i]); 349 } 350 } 351 print "\tVDESC_NO_OFFSET"; 352 print "};"; 353 # Define F_desc 354 printf("const struct vnodeop_desc %s_desc = {\n", name); 355 # offset 356 printf ("\t%s_DESCOFFSET,\n", toupper(name)); 357 # printable name 358 printf ("\t\"%s\",\n", name); 359 # flags 360 printf("\t0"); 361 vpnum = 0; 362 for (i=0; i<argc; i++) { 363 if (willrele[i]) { 364 if (willrele[i] == 2) { 365 word = "UNLOCK"; 366 } else if (willrele[i] == 3) { 367 word = "PUT"; 368 } else { 369 word = "RELE"; 370 } 371 if (argdir[i] ~ /OUT/) { 372 printf(" | VDESC_VPP_WILL%s", word); 373 } else { 374 printf(" | VDESC_VP%s_WILL%s", vpnum, word); 375 }; 376 vpnum++; 377 } 378 } 379 print ","; 380 # vp offsets 381 printf ("\t%s_vp_offsets,\n", name); 382 # vpp (if any) 383 do_offset("struct vnode **"); 384 # cred (if any) 385 do_offset("kauth_cred_t"); 386 # componentname 387 do_offset("struct componentname *"); 388 printf ("};\n"); 389 } 390 391 function bodyrump() { 392 printf("{\n\tint error;\n\n"); 393 printf("\trump_schedule();\n"); 394 printf("\terror = %s(", toupper(name)); 395 for (i=0; i<argc; i++) { 396 printf("%s", argname[i]); 397 if (i < (argc-1)) printf(", "); 398 } 399 printf(");\n"); 400 printf("\trump_unschedule();\n\n"); 401 printf("\treturn error;\n}\n"); 402 } 403 404 function bodynorm() { 405 printf("{\n\tint error;\n\tbool mpsafe;\n\tstruct %s_args a;\n", name); 406 if (lockdebug) { 407 printf("#ifdef VNODE_LOCKDEBUG\n"); 408 for (i=0; i<argc; i++) { 409 if (lockstate[i] != -1) 410 printf("\tint islocked_%s;\n", argname[i]); 411 } 412 printf("#endif\n"); 413 } 414 printf("\ta.a_desc = VDESC(%s);\n", name); 415 for (i=0; i<argc; i++) { 416 printf("\ta.a_%s = %s;\n", argname[i], argname[i]); 417 if (lockdebug && lockstate[i] != -1) { 418 printf("#ifdef VNODE_LOCKDEBUG\n"); 419 printf("\tislocked_%s = (%s->v_vflag & VV_LOCKSWORK) ? (VOP_ISLOCKED(%s) == LK_EXCLUSIVE) : %d;\n", 420 argname[i], argname[i], argname[i], lockstate[i]); 421 printf("\tif (islocked_%s != %d)\n", argname[i], 422 lockstate[i]); 423 printf("\t\tpanic(\"%s: %s: locked %%d, expected %%d\", islocked_%s, %d);\n", name, argname[i], argname[i], lockstate[i]); 424 printf("#endif\n"); 425 } 426 } 427 printf("\tmpsafe = (%s%s->v_vflag & VV_MPSAFE);\n", argname[0], arg0special); 428 printf("\tif (!mpsafe) { KERNEL_LOCK(1, curlwp); }\n"); 429 printf("\terror = (VCALL(%s%s, VOFFSET(%s), &a));\n", 430 argname[0], arg0special, name); 431 printf("\tif (!mpsafe) { KERNEL_UNLOCK_ONE(curlwp); }\n"); 432 if (willmake != -1) { 433 printf("#ifdef DIAGNOSTIC\n"); 434 printf("\tif (error == 0)\n" \ 435 "\t\tKASSERT((*%s)->v_size != VSIZENOTSET\n" \ 436 "\t\t && (*%s)->v_writesize != VSIZENOTSET);\n", 437 argname[willmake], argname[willmake]); 438 printf("#endif /* DIAGNOSTIC */\n"); 439 } 440 printf("\treturn error;\n}\n"); 441 } 442 443 function doit() { 444 printf("\n"); 445 if (!rump) 446 offsets(); 447 448 if (rump) 449 extname = "RUMP_" toupper(name); 450 else 451 extname = toupper(name); 452 453 # Define function. 454 printf("int\n%s(", extname); 455 for (i=0; i<argc; i++) { 456 printf("%s %s", argtype[i], argname[i]); 457 if (i < (argc-1)) printf(",\n "); 458 } 459 printf(")\n"); 460 461 if (rump) 462 bodyrump(); 463 else 464 bodynorm(); 465 } 466 BEGIN { 467 printf("\n/* Special cases: */\n"); 468 # start from 1 (vop_default is at 0) 469 argc=1; 470 willmake=-1; 471 argdir[0]="IN"; 472 argtype[0]="struct buf *"; 473 argname[0]="bp"; 474 lockstate[0] = -1; 475 arg0special="->b_vp"; 476 willrele[0]=0; 477 name="vop_bwrite"; 478 doit(); 479 printf("\n/* End of special cases */\n"); 480 481 arg0special=""; 482 } 483 '"$awk_parser" | sed -e "$anal_retentive" 484 485 # End stuff 486 [ -n "${rump}" ] && return 487 488 # Add the vfs_op_descs array to the C file. 489 # Begin stuff 490 echo " 491 const struct vnodeop_desc * const ${rump}vfs_op_descs[] = { 492 &${rump}vop_default_desc, /* MUST BE FIRST */ 493 &${rump}vop_bwrite_desc, /* XXX: SPECIAL CASE */ 494 " 495 496 # Body stuff 497 sed -e "$sed_prep" $src | $awk -v rump=${rump} ' 498 function doit() { 499 printf("\t&%s_desc,\n", name); 500 } 501 '"$awk_parser" 502 503 # End stuff 504 echo ' NULL 505 };' 506 } 507 do_cfile $out_c '' 508 do_cfile $out_rumpc 'rump_' 509 510 exit 0 511 512 # Local Variables: 513 # tab-width: 4 514 # End: 515
Indexes created Thu Oct 02 14:10:14 GMT 2025