1#!/bin/sh - 2copyright="\ 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" 32SCRIPT_ID='$NetBSD: vnode_if.sh,v 1.57 2011/04/03 01:19:37 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 40if [ $# -ne 1 ] ; then 41 echo 'usage: vnode_if.sh srcfile' 42 exit 1 43fi 44 45# Name and revision of the source file. 46src=$1 47SRC_ID=`head -1 $src | sed -e 's/.*\$\(.*\)\$.*/\1/'` 48 49# Names of the created files. 50out_c=vnode_if.c 51out_rumpc=../rump/librump/rumpvfs/rumpvnode_if.c 52out_h=../sys/vnode_if.h 53out_rumph=../rump/include/rump/rumpvnode_if.h 54 55# generate VNODE_LOCKDEBUG checks (not fully functional) 56lockdebug=0 57 58# Awk program (must support nawk extensions) 59# Use "awk" at Berkeley, "nawk" or "gawk" elsewhere. 60awk=${AWK:-awk} 61 62# Does this awk have a "toupper" function? (i.e. is it GNU awk) 63isgawk=`$awk 'BEGIN { print toupper("true"); exit; }' 2>/dev/null` 64 65# If this awk does not define "toupper" then define our own. 66if [ "$isgawk" = TRUE ] ; then 67 # GNU awk provides it. 68 toupper= 69else 70 # Provide our own toupper() 71 toupper=' 72function 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}' 78fi 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# 92sed_prep='s:\*\([^\*/]\):\* \1:g 93s/;/ /' 94awk_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. 167warning="\ 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^) 182anal_retentive='s:\([^/]\*\) :\1:g' 183 184do_hfile () { 185# 186# Redirect stdout to the H file. 187# 188echo "$0: Creating $1" 1>&2 189exec > $1 190rump=$2 191 192# Begin stuff 193if [ -z "${rump}" ]; then 194 SYS='SYS_' 195else 196 SYS='RUMP_RUMP' 197fi 198echo -n "$warning" | sed -e 's/\$//g;s/@/\$/g;s/ $//' 199echo "" 200echo -n "$copyright" 201echo '' 202echo "#ifndef _${SYS}VNODE_IF_H_" 203echo "#define _${SYS}VNODE_IF_H_" 204if [ ${lockdebug} -ne 0 ] ; then 205 echo '' 206 echo '#ifdef _KERNEL_OPT' 207 echo '#include "opt_vnode_lockdebug.h"' 208 echo '#endif /* _KERNEL_OPT */' 209fi 210[ -z "${rump}" ] && echo " 211extern const struct vnodeop_desc ${rump}vop_default_desc;" 212echo 213 214# Body stuff 215# This awk program needs toupper() so define it if necessary. 216sed -e "$sed_prep" $src | $awk -v rump=${rump} "$toupper"' 217function 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} 249BEGIN { 250 vop_offset = 1; # start at 1, to count the 'default' op 251 252 printf("struct buf;\n"); 253 if (rump) { 254 printf("struct flock;\n"); 255 printf("struct knote;\n"); 256 printf("struct vm_page;\n"); 257 } 258 printf("\n#ifndef _KERNEL\n#include <stdbool.h>\n#endif\n"); 259 if (rump) 260 printf("\n"); 261} 262END { 263 if (!rump) { 264 printf("\n#define VNODE_OPS_COUNT\t%d\n", vop_offset); 265 } 266} 267'"$awk_parser" | sed -e "$anal_retentive" 268 269# End stuff 270echo '' 271echo "#endif /* !_${SYS}VNODE_IF_H_ */" 272} 273do_hfile $out_h '' 274do_hfile $out_rumph 'rump_' 275 276do_cfile () { 277# 278# Redirect stdout to the C file. 279# 280echo "$0: Creating $1" 1>&2 281exec > $1 282rump=$2 283 284# Begin stuff 285echo -n "$warning" | sed -e 's/\$//g;s/@/\$/g;s/ $//' 286echo "" 287echo -n "$copyright" 288echo " 289#include <sys/cdefs.h> 290__KERNEL_RCSID(0, \"\$NetBSD\$\");" 291 292[ ${lockdebug} -ne 0 ] && echo && echo '#include "opt_vnode_lockdebug.h"' 293 294echo ' 295#include <sys/param.h> 296#include <sys/mount.h> 297#include <sys/buf.h> 298#include <sys/vnode.h> 299#include <sys/lock.h>' 300[ ! -z "${rump}" ] && echo '#include <rump/rumpvnode_if.h>' \ 301 && echo '#include "rump_private.h"' 302 303if [ -z "${rump}" ] ; then 304 echo " 305const struct vnodeop_desc vop_default_desc = {" 306echo ' 0, 307 "default", 308 0, 309 NULL, 310 VDESC_NO_OFFSET, 311 VDESC_NO_OFFSET, 312 VDESC_NO_OFFSET, 313}; 314' 315fi 316 317# Body stuff 318sed -e "$sed_prep" $src | $awk -v rump=${rump} -v lockdebug=${lockdebug} ' 319function do_offset(typematch) { 320 for (i=0; i<argc; i++) { 321 if (argtype[i] == typematch) { 322 printf("\tVOPARG_OFFSETOF(struct %s_args, a_%s),\n", 323 name, argname[i]); 324 return i; 325 }; 326 }; 327 print "\tVDESC_NO_OFFSET,"; 328 return -1; 329} 330 331function offsets() { 332 # Define offsets array 333 printf("const int %s_vp_offsets[] = {\n", name); 334 for (i=0; i<argc; i++) { 335 if (argtype[i] == "struct vnode *") { 336 printf ("\tVOPARG_OFFSETOF(struct %s_args,a_%s),\n", 337 name, argname[i]); 338 } 339 } 340 print "\tVDESC_NO_OFFSET"; 341 print "};"; 342 # Define F_desc 343 printf("const struct vnodeop_desc %s_desc = {\n", name); 344 # offset 345 printf ("\t%s_DESCOFFSET,\n", toupper(name)); 346 # printable name 347 printf ("\t\"%s\",\n", name); 348 # flags 349 printf("\t0"); 350 vpnum = 0; 351 for (i=0; i<argc; i++) { 352 if (willrele[i]) { 353 if (willrele[i] == 2) { 354 word = "UNLOCK"; 355 } else if (willrele[i] == 3) { 356 word = "PUT"; 357 } else { 358 word = "RELE"; 359 } 360 printf(" | VDESC_VP%s_WILL%s", vpnum, word); 361 vpnum++; 362 } 363 } 364 print ","; 365 # vp offsets 366 printf ("\t%s_vp_offsets,\n", name); 367 # vpp (if any) 368 do_offset("struct vnode **"); 369 # cred (if any) 370 do_offset("kauth_cred_t"); 371 # componentname 372 do_offset("struct componentname *"); 373 printf ("};\n"); 374} 375 376function bodyrump() { 377 printf("{\n\tint error;\n\n"); 378 printf("\trump_schedule();\n"); 379 printf("\terror = %s(", toupper(name)); 380 for (i=0; i<argc; i++) { 381 printf("%s", argname[i]); 382 if (i < (argc-1)) printf(", "); 383 } 384 printf(");\n"); 385 printf("\trump_unschedule();\n\n"); 386 printf("\treturn error;\n}\n"); 387} 388 389function bodynorm() { 390 printf("{\n\tint error;\n\tbool mpsafe;\n\tstruct %s_args a;\n", name); 391 if (lockdebug) { 392 printf("#ifdef VNODE_LOCKDEBUG\n"); 393 for (i=0; i<argc; i++) { 394 if (lockstate[i] != -1) 395 printf("\tint islocked_%s;\n", argname[i]); 396 } 397 printf("#endif\n"); 398 } 399 printf("\ta.a_desc = VDESC(%s);\n", name); 400 for (i=0; i<argc; i++) { 401 printf("\ta.a_%s = %s;\n", argname[i], argname[i]); 402 if (lockdebug && lockstate[i] != -1) { 403 printf("#ifdef VNODE_LOCKDEBUG\n"); 404 printf("\tislocked_%s = (%s->v_vflag & VV_LOCKSWORK) ? (VOP_ISLOCKED(%s) == LK_EXCLUSIVE) : %d;\n", 405 argname[i], argname[i], argname[i], lockstate[i]); 406 printf("\tif (islocked_%s != %d)\n", argname[i], 407 lockstate[i]); 408 printf("\t\tpanic(\"%s: %s: locked %%d, expected %%d\", islocked_%s, %d);\n", name, argname[i], argname[i], lockstate[i]); 409 printf("#endif\n"); 410 } 411 } 412 printf("\tmpsafe = (%s->v_vflag & VV_MPSAFE);\n", argname[0]); 413 printf("\tif (!mpsafe) { KERNEL_LOCK(1, curlwp); }\n"); 414 printf("\terror = (VCALL(%s, VOFFSET(%s), &a));\n", 415 argname[0], name); 416 printf("\tif (!mpsafe) { KERNEL_UNLOCK_ONE(curlwp); }\n"); 417 if (willmake != -1) { 418 printf("#ifdef DIAGNOSTIC\n"); 419 printf("\tif (error == 0)\n" \ 420 "\t\tKASSERT((*%s)->v_size != VSIZENOTSET\n" \ 421 "\t\t && (*%s)->v_writesize != VSIZENOTSET);\n", 422 argname[willmake], argname[willmake]); 423 printf("#endif /* DIAGNOSTIC */\n"); 424 } 425 printf("\treturn error;\n}\n"); 426} 427 428function doit() { 429 printf("\n"); 430 if (!rump) 431 offsets(); 432 433 if (rump) 434 extname = "RUMP_" toupper(name); 435 else 436 extname = toupper(name); 437 438 # Define function. 439 printf("int\n%s(", extname); 440 for (i=0; i<argc; i++) { 441 printf("%s %s", argtype[i], argname[i]); 442 if (i < (argc-1)) printf(",\n "); 443 } 444 printf(")\n"); 445 446 if (rump) 447 bodyrump(); 448 else 449 bodynorm(); 450} 451BEGIN { 452 # start from 1 (vop_default is at 0) 453 argc=1; 454} 455'"$awk_parser" | sed -e "$anal_retentive" 456 457# End stuff 458[ -n "${rump}" ] && return 459 460# Add the vfs_op_descs array to the C file. 461# Begin stuff 462echo " 463const struct vnodeop_desc * const ${rump}vfs_op_descs[] = { 464 &${rump}vop_default_desc, /* MUST BE FIRST */ 465" 466 467# Body stuff 468sed -e "$sed_prep" $src | $awk -v rump=${rump} ' 469function doit() { 470 printf("\t&%s_desc,\n", name); 471} 472'"$awk_parser" 473 474# End stuff 475echo ' NULL 476};' 477} 478do_cfile $out_c '' 479do_cfile $out_rumpc 'rump_' 480 481exit 0 482 483# Local Variables: 484# tab-width: 4 485# End: 486