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# 3. All advertising materials mentioning features or use of this software 16# must display the following acknowledgement: 17# This product includes software developed by the University of 18# California, Berkeley and its contributors. 19# 4. Neither the name of the University nor the names of its contributors 20# may be used to endorse or promote products derived from this software 21# without specific prior written permission. 22# 23# THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 24# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 25# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 26# ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 27# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 28# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 29# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 30# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 31# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 32# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 33# SUCH DAMAGE. 34# 35# @(#)vnode_if.sh 8.1 (Berkeley) 6/10/93 36# $FreeBSD$ 37# 38# Script to produce VFS front-end sugar. 39# 40# usage: vnode_if.awk <srcfile> [-c | -h] 41# (where <srcfile> is currently /sys/kern/vnode_if.src) 42# 43 44function usage() 45{ 46 print "usage: vnode_if.awk <srcfile> [-c|-h]"; 47 exit 1; 48} 49 50function die(msg, what) 51{ 52 printf msg "\n", what > "/dev/stderr"; 53 exit 1; 54} 55 56function t_spc(type) 57{ 58 # Append a space if the type is not a pointer 59 return (type ~ /\*$/) ? type : type " "; 60} 61 62# These are just for convenience ... 63function printc(s) {print s > cfile;} 64function printh(s) {print s > hfile;} 65 66function add_debug_code(name, arg) 67{ 68 if (debug_all_vfs_locks && lockdata[name, arg, "Entry"]) { 69 # Add assertions for locking 70 if (lockdata[name, arg, "Entry"] == "L") 71 printh("\tASSERT_VOP_LOCKED("arg", \""uname"\");"); 72 else if (lockdata[name, arg, "Entry"] == "U") 73 printh("\tASSERT_VOP_UNLOCKED("arg", \""uname"\");"); 74 else if (0) { 75 # XXX More checks! 76 } 77 } 78} 79 80function find_arg_with_type (type) 81{ 82 for (jj = 0; jj < numargs; jj++) { 83 if (types[jj] == type) { 84 return "VOPARG_OFFSETOF(struct " \ 85 name "_args,a_" args[jj] ")"; 86 } 87 } 88 89 return "VDESC_NO_OFFSET"; 90} 91 92BEGIN{ 93 94# Process the command line 95for (i = 1; i < ARGC; i++) { 96 arg = ARGV[i]; 97 if (arg !~ /^-[ch]+$/ && arg !~ /\.src$/) 98 usage(); 99 if (arg ~ /^-.*c/) 100 cfile = "vnode_if.c"; 101 if (arg ~ /^-.*h/) 102 hfile = "vnode_if.h"; 103 if (arg ~ /\.src$/) 104 srcfile = arg; 105} 106ARGC = 1; 107 108if (!cfile && !hfile) 109 exit 0; 110 111if (!srcfile) 112 usage(); 113 114debug_all_vfs_locks = (ENVIRON["DEBUG_ALL_VFS_LOCKS"] ~ /[Yy][Ee][Ss]/); 115 116common_head = \ 117 "/*\n" \ 118 " * This file is produced automatically.\n" \ 119 " * Do not modify anything in here by hand.\n" \ 120 " *\n" \ 121 " * Created from $FreeBSD$\n" \ 122 " */\n" \ 123 "\n"; 124 125if (hfile) 126 printh(common_head "extern struct vnodeop_desc vop_default_desc;"); 127 128if (cfile) { 129 printc(common_head \ 130 "#include <sys/param.h>\n" \ 131 "#include <sys/systm.h>\n" \ 132 "#include <sys/vnode.h>\n" \ 133 "\n" \ 134 "struct vnodeop_desc vop_default_desc = {\n" \ 135 " 1,\t\t\t/* special case, vop_default => 1 */\n" \ 136 " \"default\",\n" \ 137 " 0,\n" \ 138 " NULL,\n" \ 139 " VDESC_NO_OFFSET,\n" \ 140 " VDESC_NO_OFFSET,\n" \ 141 " VDESC_NO_OFFSET,\n" \ 142 " VDESC_NO_OFFSET,\n" \ 143 " NULL,\n" \ 144 "};\n"); 145} 146 147while ((getline < srcfile) > 0) { 148 if (NF == 0) 149 continue; 150 if ($1 ~ /^#/) { 151 if (NF != 6 || $1 != "#%" || \ 152 $2 !~ /^[a-z]+$/ || $3 !~ /^[a-z]+$/ || \ 153 $4 !~ /^.$/ || $5 !~ /^.$/ || $6 !~ /^.$/) 154 continue; 155 lockdata["vop_" $2, $3, "Entry"] = $4; 156 lockdata["vop_" $2, $3, "OK"] = $5; 157 lockdata["vop_" $2, $3, "Error"] = $6; 158 continue; 159 } 160 161 # Get the function name. 162 name = $1; 163 uname = toupper(name); 164 # Get the function arguments. 165 for (numargs = 0; ; ++numargs) { 166 if ((getline < srcfile) <= 0) { 167 die("Unable to read through the arguments for \"%s\"", 168 name); 169 } 170 if ($1 ~ /^\};/) 171 break; 172 173 # Delete comments, if any. 174 gsub (/\/\*.*\*\//, ""); 175 176 # Condense whitespace and delete leading/trailing space. 177 gsub(/[[:space:]]+/, " "); 178 sub(/^ /, ""); 179 sub(/ $/, ""); 180 181 # Pick off direction. 182 if ($1 != "INOUT" && $1 != "IN" && $1 != "OUT") 183 die("No IN/OUT direction for \"%s\".", $0); 184 dirs[numargs] = $1; 185 sub(/^[A-Z]* /, ""); 186 187 if ((reles[numargs] = $1) == "WILLRELE") 188 sub(/^[A-Z]* /, ""); 189 else 190 reles[numargs] = "WONTRELE"; 191 192 # kill trailing ; 193 if (sub(/;$/, "") < 1) 194 die("Missing end-of-line ; in \"%s\".", $0); 195 196 # pick off variable name 197 if ((argp = match($0, /[A-Za-z0-9_]+$/)) < 1) 198 die("Missing var name \"a_foo\" in \"%s\".", $0); 199 args[numargs] = substr($0, argp); 200 $0 = substr($0, 1, argp - 1); 201 202 # what is left must be type 203 # remove trailing space (if any) 204 sub(/ $/, ""); 205 types[numargs] = $0; 206 } 207 208 if (hfile) { 209 # Print out the vop_F_args structure. 210 printh("struct "name"_args {\n\tstruct vnodeop_desc *a_desc;"); 211 for (i = 0; i < numargs; ++i) 212 printh("\t" t_spc(types[i]) "a_" args[i] ";"); 213 printh("};"); 214 215 # Print out extern declaration. 216 printh("extern struct vnodeop_desc " name "_desc;"); 217 218 # Print out function. 219 printh("static __inline int " uname "("); 220 for (i = 0; i < numargs; ++i) { 221 printh("\t" t_spc(types[i]) args[i] \ 222 (i < numargs - 1 ? "," : ")")); 223 } 224 printh("{\n\tstruct " name "_args a;"); 225 printh("\tint rc;"); 226 printh("\ta.a_desc = VDESC(" name ");"); 227 for (i = 0; i < numargs; ++i) 228 printh("\ta.a_" args[i] " = " args[i] ";"); 229 for (i = 0; i < numargs; ++i) 230 add_debug_code(name, args[i]); 231 printh("\trc = VCALL(" args[0] ", VOFFSET(" name "), &a);"); 232 printh("\treturn (rc);\n}"); 233 } 234 235 if (cfile) { 236 # Print out the vop_F_vp_offsets structure. This all depends 237 # on naming conventions and nothing else. 238 printc("static int " name "_vp_offsets[] = {"); 239 # as a side effect, figure out the releflags 240 releflags = ""; 241 vpnum = 0; 242 for (i = 0; i < numargs; i++) { 243 if (types[i] == "struct vnode *") { 244 printc("\tVOPARG_OFFSETOF(struct " name \ 245 "_args,a_" args[i] "),"); 246 if (reles[i] == "WILLRELE") { 247 releflags = releflags \ 248 "|VDESC_VP" vpnum "_WILLRELE"; 249 } 250 vpnum++; 251 } 252 } 253 254 sub(/^\|/, "", releflags); 255 printc("\tVDESC_NO_OFFSET"); 256 printc("};"); 257 258 # Print out the vnodeop_desc structure. 259 printc("struct vnodeop_desc " name "_desc = {"); 260 # offset 261 printc("\t0,"); 262 # printable name 263 printc("\t\"" name "\","); 264 # flags 265 vppwillrele = ""; 266 for (i = 0; i < numargs; i++) { 267 if (types[i] == "struct vnode **" && \ 268 reles[i] == "WILLRELE") { 269 vppwillrele = "|VDESC_VPP_WILLRELE"; 270 } 271 } 272 273 if (!releflags) 274 releflags = "0"; 275 printc("\t" releflags vppwillrele ","); 276 277 # vp offsets 278 printc("\t" name "_vp_offsets,"); 279 # vpp (if any) 280 printc("\t" find_arg_with_type("struct vnode **") ","); 281 # cred (if any) 282 printc("\t" find_arg_with_type("struct ucred *") ","); 283 # thread (if any) 284 printc("\t" find_arg_with_type("struct thread *") ","); 285 # componentname 286 printc("\t" find_arg_with_type("struct componentname *") ","); 287 # transport layer information 288 printc("\tNULL,\n};\n"); 289 } 290} 291 292if (hfile) 293 close(hfile); 294if (cfile) 295 close(cfile); 296close(srcfile); 297 298exit 0; 299 300} 301