4 # SPDX-License-Identifier: BSD-3-Clause
6 # Copyright (c) 1992, 1993
7 # The Regents of the University of California. All rights reserved.
9 # Redistribution and use in source and binary forms, with or without
10 # modification, are permitted provided that the following conditions
12 # 1. Redistributions of source code must retain the above copyright
13 # notice, this list of conditions and the following disclaimer.
14 # 2. Redistributions in binary form must reproduce the above copyright
15 # notice, this list of conditions and the following disclaimer in the
16 # documentation and/or other materials provided with the distribution.
17 # 3. Neither the name of the University nor the names of its contributors
18 # may be used to endorse or promote products derived from this software
19 # without specific prior written permission.
21 # THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22 # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 # ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25 # FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 # DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 # OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 # HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 # OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 # @(#)vnode_if.sh 8.1 (Berkeley) 6/10/93
37 # Script to produce VFS front-end sugar.
39 # usage: vnode_if.awk <srcfile> [-c | -h | -p | -q]
40 # (where <srcfile> is currently /sys/kern/vnode_if.src)
41 # The source file must have a .src extension
46 print "usage: vnode_if.awk <srcfile> [-c|-h|-p|-q]";
50 function die(msg, what)
52 printf srcfile "(" fnr "): " > "/dev/stderr";
53 printf msg "\n", what > "/dev/stderr";
59 # Append a space if the type is not a pointer
60 return (type ~ /\*$/) ? type : type " ";
63 # These are just for convenience ...
64 function printc(s) {print s > cfile;}
65 function printh(s) {print s > hfile;}
66 function printp(s) {print s > pfile;}
67 function printq(s) {print s > qfile;}
69 function add_debug_code(name, arg, pos, ind)
75 if (lockdata[name, arg, pos] && (lockdata[name, arg, pos] != "-")) {
76 printc(ind"ASSERT_VI_UNLOCKED("star"a->a_"arg", \""uname"\");");
77 # Add assertions for locking
78 if (lockdata[name, arg, pos] == "L")
79 printc(ind"ASSERT_VOP_LOCKED(" star "a->a_"arg", \""uname"\");");
80 else if (lockdata[name, arg, pos] == "U")
81 printc(ind"ASSERT_VOP_UNLOCKED(" star "a->a_"arg", \""uname"\");");
82 else if (lockdata[name, arg, pos] == "E")
83 printc(ind"ASSERT_VOP_ELOCKED(" star "a->a_"arg", \""uname"\");");
90 function add_debugpre(name)
92 if (lockdata[name, "debugpre"]) {
93 printc("#ifdef DEBUG_VFS_LOCKS");
94 printc("\t"lockdata[name, "debugpre"]"(a);");
99 function add_debugpost(name)
101 if (lockdata[name, "debugpost"]) {
102 printc("#ifdef DEBUG_VFS_LOCKS");
103 printc("\t"lockdata[name, "debugpost"]"(a, rc);");
108 function add_pre(name)
110 if (lockdata[name, "pre"]) {
111 printc("\t"lockdata[name, "pre"]"(a);");
115 function add_post(name)
117 if (lockdata[name, "post"]) {
118 printc("\t"lockdata[name, "post"]"(a, rc);");
122 function can_inline(name)
124 if (lockdata[name, "pre"])
126 if (lockdata[name, "post"])
131 function find_arg_with_type (type)
133 for (jj = 0; jj < numargs; jj++) {
134 if (types[jj] == type) {
135 return "VOPARG_OFFSETOF(struct " \
136 name "_args,a_" args[jj] ")";
140 return "VDESC_NO_OFFSET";
145 # Process the command line
146 for (i = 1; i < ARGC; i++) {
148 if (arg !~ /^-[chpq]+$/ && arg !~ /\.src$/)
151 cfile = "vnode_if.c";
153 hfile = "vnode_if.h";
155 pfile = "vnode_if_newproto.h";
157 qfile = "vnode_if_typedef.h";
163 if (!cfile && !hfile && !pfile && !qfile)
169 # Avoid a literal generated file tag here.
170 generated = "@" "generated";
174 " * This file is " generated " automatically.\n" \
175 " * Do not modify anything in here by hand.\n" \
177 " * Created from $FreeBSD$\n" \
183 printp("struct vop_vector {")
184 printp("\tstruct vop_vector\t*vop_default;")
185 printp("\tvop_bypass_t\t*vop_bypass;")
193 printh(common_head "extern struct vnodeop_desc vop_default_desc;");
194 printh("#include \"vnode_if_typedef.h\"")
195 printh("#include \"vnode_if_newproto.h\"")
200 "#include <sys/param.h>\n" \
201 "#include <sys/event.h>\n" \
202 "#include <sys/kernel.h>\n" \
203 "#include <sys/mount.h>\n" \
204 "#include <sys/sdt.h>\n" \
205 "#include <sys/signalvar.h>\n" \
206 "#include <sys/systm.h>\n" \
207 "#include <sys/vnode.h>\n" \
209 "SDT_PROVIDER_DECLARE(vfs);\n" \
211 "struct vnodeop_desc vop_default_desc = {\n" \
215 " (vop_bypass_t *)vop_panic,\n" \
217 " VDESC_NO_OFFSET,\n" \
218 " VDESC_NO_OFFSET,\n" \
219 " VDESC_NO_OFFSET,\n" \
220 " VDESC_NO_OFFSET,\n" \
224 while ((getline < srcfile) > 0) {
230 $2 !~ /^[a-z_]+$/ || $3 !~ /^[a-z]+$/ ||
231 $4 !~ /^.$/ || $5 !~ /^.$/ || $6 !~ /^.$/) {
232 die("Invalid %s construction", "%%");
235 lockdata["vop_" $2, $3, "Entry"] = $4;
236 lockdata["vop_" $2, $3, "OK"] = $5;
237 lockdata["vop_" $2, $3, "Error"] = $6;
243 ($3 != "pre" && $3 != "post" &&
244 $3 != "debugpre" && $3 != "debugpost")) {
245 die("Invalid %s construction", "%!");
248 lockdata["vop_" $2, $3] = $4;
254 # Get the function name.
256 uname = toupper(name);
258 # Get the function arguments.
259 for (numargs = 0; ; ++numargs) {
260 if ((getline < srcfile) <= 0) {
261 die("Unable to read through the arguments for \"%s\"",
268 # Delete comments, if any.
269 gsub (/\/\*.*\*\//, "");
271 # Condense whitespace and delete leading/trailing space.
272 gsub(/[[:space:]]+/, " ");
276 # Pick off direction.
277 if ($1 != "INOUT" && $1 != "IN" && $1 != "OUT")
278 die("No IN/OUT direction for \"%s\".", $0);
282 if ((reles[numargs] = $1) == "WILLRELE")
285 reles[numargs] = "WONTRELE";
288 if (sub(/;$/, "") < 1)
289 die("Missing end-of-line ; in \"%s\".", $0);
291 # pick off variable name
292 if ((argp = match($0, /[A-Za-z0-9_]+$/)) < 1)
293 die("Missing var name \"a_foo\" in \"%s\".", $0);
294 args[numargs] = substr($0, argp);
295 $0 = substr($0, 1, argp - 1);
297 # what is left must be type
298 # remove trailing space (if any)
306 ctrstr = ctrargs "(KTR_VOP, \"VOP\", \"" uname "\", (uintptr_t)a,\n\t ";
307 ctrstr = ctrstr "\"" args[0] ":0x%jX\", (uintptr_t)a->a_" args[0];
308 for (i = 1; i < ctrargs; ++i)
309 ctrstr = ctrstr ", \"" args[i] ":0x%jX\", a->a_" args[i];
310 ctrstr = ctrstr ");";
313 printp("\t"name"_t\t*"name";")
316 printq("struct "name"_args;")
317 printq("typedef int "name"_t(struct "name"_args *);\n")
321 # Print out the vop_F_args structure.
322 printh("struct "name"_args {\n\tstruct vop_generic_args a_gen;");
323 for (i = 0; i < numargs; ++i)
324 printh("\t" t_spc(types[i]) "a_" args[i] ";");
328 # Print out extern declaration.
329 printh("extern struct vnodeop_desc " name "_desc;");
332 # Print out function prototypes.
333 printh("int " uname "_AP(struct " name "_args *);");
334 printh("int " uname "_APV(struct vop_vector *vop, struct " name "_args *);");
336 printh("static __inline int " uname "(");
337 for (i = 0; i < numargs; ++i) {
338 printh("\t" t_spc(types[i]) args[i] \
339 (i < numargs - 1 ? "," : ")"));
342 printh("\tstruct " name "_args a;");
344 printh("\ta.a_gen.a_desc = &" name "_desc;");
345 for (i = 0; i < numargs; ++i)
346 printh("\ta.a_" args[i] " = " args[i] ";");
347 if (can_inline(name)) {
348 printh("\n#if !defined(DEBUG_VFS_LOCKS) && !defined(INVARIANTS) && !defined(KTR)");
349 printh("\tif (!SDT_PROBES_ENABLED())");
350 printh("\t\treturn (" args[0]"->v_op->"name"(&a));");
352 printh("\t\treturn (" uname "_APV("args[0]"->v_op, &a));");
355 printh("\treturn (" uname "_APV("args[0]"->v_op, &a));");
356 if (can_inline(name))
366 # Print out the vop_F_vp_offsets structure. This all depends
367 # on naming conventions and nothing else.
368 printc("static int " name "_vp_offsets[] = {");
369 # as a side effect, figure out the releflags
372 for (i = 0; i < numargs; i++) {
373 if (types[i] == "struct vnode *") {
374 printc("\tVOPARG_OFFSETOF(struct " name \
375 "_args,a_" args[i] "),");
376 if (reles[i] == "WILLRELE") {
377 releflags = releflags \
378 "|VDESC_VP" vpnum "_WILLRELE";
384 sub(/^\|/, "", releflags);
385 printc("\tVDESC_NO_OFFSET");
389 printc("SDT_PROBE_DEFINE2(vfs, vop, " name ", entry, \"struct vnode *\", \"struct " name "_args *\");\n");
390 printc("SDT_PROBE_DEFINE3(vfs, vop, " name ", return, \"struct vnode *\", \"struct " name "_args *\", \"int\");\n");
392 # Print out function.
393 printc("\nint\n" uname "_AP(struct " name "_args *a)");
396 printc("\treturn(" uname "_APV(a->a_" args[0] "->v_op, a));");
398 printc("\nint\n" uname "_APV(struct vop_vector *vop, struct " name "_args *a)");
402 printc("\tVNASSERT(a->a_gen.a_desc == &" name "_desc, a->a_" args[0]",");
403 printc("\t (\"Wrong a_desc in " name "(%p, %p)\", a->a_" args[0]", a));");
404 printc("\tVNASSERT(vop != NULL, a->a_" args[0]", (\"No "name"(%p, %p)\", a->a_" args[0]", a));")
405 printc("\tKTR_START" ctrstr);
408 for (i = 0; i < numargs; ++i)
409 add_debug_code(name, args[i], "Entry", "\t");
410 printc("\tif (!SDT_PROBES_ENABLED()) {");
411 printc("\t\trc = vop->"name"(a);")
413 printc("\t\tSDT_PROBE2(vfs, vop, " name ", entry, a->a_" args[0] ", a);");
414 printc("\t\trc = vop->"name"(a);")
415 printc("\t\tSDT_PROBE3(vfs, vop, " name ", return, a->a_" args[0] ", a, rc);");
417 printc("\tif (rc == 0) {");
418 for (i = 0; i < numargs; ++i)
419 add_debug_code(name, args[i], "OK", "\t\t");
420 printc("\t} else {");
421 for (i = 0; i < numargs; ++i)
422 add_debug_code(name, args[i], "Error", "\t\t");
426 printc("\tKTR_STOP" ctrstr);
427 printc("\treturn (rc);");
430 # Print out the vnodeop_desc structure.
431 printc("struct vnodeop_desc " name "_desc = {");
433 printc("\t\"" name "\",");
436 for (i = 0; i < numargs; i++) {
437 if (types[i] == "struct vnode **" && \
438 reles[i] == "WILLRELE") {
439 vppwillrele = "|VDESC_VPP_WILLRELE";
445 printc("\t" releflags vppwillrele ",");
447 # index in struct vop_vector
448 printc("\t__offsetof(struct vop_vector, " name "),");
450 printc("\t(vop_bypass_t *)" uname "_AP,");
452 printc("\t" name "_vp_offsets,");
454 printc("\t" find_arg_with_type("struct vnode **") ",");
456 printc("\t" find_arg_with_type("struct ucred *") ",");
458 printc("\t" find_arg_with_type("struct thread *") ",");
460 printc("\t" find_arg_with_type("struct componentname *") ",");
461 # transport layer information
468 printc("vfs_vector_op_register(struct vop_vector *orig_vop)");
470 printc("\tstruct vop_vector *vop;");
472 printc("\tif (orig_vop->registered)");
473 printc("\t\tpanic(\"%s: vop_vector %p already registered\",")
474 printc("\t\t __func__, orig_vop);");
476 for (name in funcarr) {
477 printc("\tvop = orig_vop;");
478 printc("\twhile (vop != NULL && \\");
479 printc("\t vop->"name" == NULL && vop->vop_bypass == NULL)")
480 printc("\t\tvop = vop->vop_default;")
481 printc("\tif (vop != NULL)");
482 printc("\t\torig_vop->"name" = vop->"name";");
485 printc("\tvop = orig_vop;");
486 printc("\twhile (vop != NULL && vop->vop_bypass == NULL)")
487 printc("\t\tvop = vop->vop_default;")
488 printc("\tif (vop != NULL)");
489 printc("\t\torig_vop->vop_bypass = vop->vop_bypass;");
491 for (name in funcarr) {
492 printc("\tif (orig_vop->"name" == NULL)");
493 printc("\t\torig_vop->"name" = (void *)orig_vop->vop_bypass;");
496 printc("\torig_vop->registered = true;");
501 printh("void vfs_vector_op_register(struct vop_vector *orig_vop);");
505 printp("\tbool\tregistered;")