vnode_if.sh revision 1.27 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. 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 "
36 SCRIPT_ID='$NetBSD: vnode_if.sh,v 1.27 2001/01/19 12:22:56 martin Exp $'
37
38 # Script to produce VFS front-end sugar.
39 #
40 # usage: vnode_if.sh srcfile
41 # (where srcfile is currently /sys/kern/vnode_if.src)
42 #
43
44 if [ $# -ne 1 ] ; then
45 echo 'usage: vnode_if.sh srcfile'
46 exit 1
47 fi
48
49 # Name and revision of the source file.
50 src=$1
51 SRC_ID=`head -1 $src | sed -e 's/.*\$\(.*\)\$.*/\1/'`
52
53 # Names of the created files.
54 out_c=vnode_if.c
55 out_h=../sys/vnode_if.h
56
57 # Awk program (must support nawk extensions)
58 # Use "awk" at Berkeley, "nawk" or "gawk" elsewhere.
59 awk=${AWK:-awk}
60
61 # Does this awk have a "toupper" function? (i.e. is it GNU awk)
62 isgawk=`$awk 'BEGIN { print toupper("true"); exit; }' 2>/dev/null`
63
64 # If this awk does not define "toupper" then define our own.
65 if [ "$isgawk" = TRUE ] ; then
66 # GNU awk provides it.
67 toupper=
68 else
69 # Provide our own toupper()
70 toupper='
71 function toupper(str) {
72 _toupper_cmd = "echo "str" |tr a-z A-Z"
73 _toupper_cmd | getline _toupper_str;
74 close(_toupper_cmd);
75 return _toupper_str;
76 }'
77 fi
78
79 #
80 # This is the common part of all awk programs that read $src
81 # This parses the input for one function into the arrays:
82 # argdir, argtype, argname, willrele
83 # and calls "doit()" to generate output for the function.
84 #
85 # Input to this parser is pre-processed slightly by sed
86 # so this awk parser doesn't have to work so hard. The
87 # changes done by the sed pre-processing step are:
88 # insert a space beween * and pointer name
89 # replace semicolons with spaces
90 #
91 sed_prep='s:\*\([^\*/]\):\* \1:g
92 s/;/ /'
93 awk_parser='
94 # Comment line
95 /^#/ { next; }
96 # First line of description
97 /^vop_/ {
98 name=$1;
99 argc=0;
100 next;
101 }
102 # Last line of description
103 /^}/ {
104 doit();
105 next;
106 }
107 # Middle lines of description
108 {
109 argdir[argc] = $1; i=2;
110 if ($2 == "WILLRELE") {
111 willrele[argc] = 1;
112 i++;
113 } else if ($2 == "WILLUNLOCK") {
114 willrele[argc] = 2;
115 i++;
116 } else if ($2 == "WILLPUT") {
117 willrele[argc] = 3;
118 i++;
119 } else
120 willrele[argc] = 0;
121 argtype[argc] = $i; i++;
122 while (i < NF) {
123 argtype[argc] = argtype[argc]" "$i;
124 i++;
125 }
126 argname[argc] = $i;
127 argc++;
128 next;
129 }
130 '
131
132 # This is put before the copyright on each generated file.
133 warning="\
134 /* @NetBSD@ */
135
136 /*
137 * Warning: This file is generated automatically.
138 * (Modifications made here may easily be lost!)
139 *
140 * Created from the file:
141 * ${SRC_ID}
142 * by the script:
143 * ${SCRIPT_ID}
144 */
145 "
146
147 # This is to satisfy McKusick (get rid of evil spaces 8^)
148 anal_retentive='s:\([^/]\*\) :\1:g'
149
150 #
151 # Redirect stdout to the H file.
152 #
153 echo "$0: Creating $out_h" 1>&2
154 exec > $out_h
155
156 # Begin stuff
157 echo -n "$warning" | sed -e 's/\$//g;s/@/\$/g'
158 echo ""
159 echo -n "$copyright"
160 echo ''
161 echo '#ifndef _SYS_VNODE_IF_H_'
162 echo '#define _SYS_VNODE_IF_H_'
163 echo ''
164 echo '#ifdef _KERNEL'
165 echo '#if defined(_LKM) || defined(LKM)'
166 echo '/* LKMs always use non-inlined vnode ops. */'
167 echo '#define VNODE_OP_NOINLINE'
168 echo '#else'
169 echo '#include "opt_vnode_op_noinline.h"'
170 echo '#endif'
171 echo '#endif /* _KERNEL */'
172 echo '
173 extern struct vnodeop_desc vop_default_desc;
174 '
175
176 # Body stuff
177 # This awk program needs toupper() so define it if necessary.
178 sed -e "$sed_prep" $src | $awk "$toupper"'
179 function doit() {
180 # Declare arg struct, descriptor.
181 printf("\nstruct %s_args {\n", name);
182 printf("\tstruct vnodeop_desc * a_desc;\n");
183 for (i=0; i<argc; i++) {
184 printf("\t%s a_%s;\n", argtype[i], argname[i]);
185 }
186 printf("};\n");
187 printf("extern struct vnodeop_desc %s_desc;\n", name);
188 # Prototype it.
189 printf("#ifndef VNODE_OP_NOINLINE\n");
190 printf("static __inline\n");
191 printf("#endif\n");
192 protoarg = sprintf("int %s(", toupper(name));
193 protolen = length(protoarg);
194 printf("%s", protoarg);
195 for (i=0; i<argc; i++) {
196 protoarg = sprintf("%s", argtype[i]);
197 if (i < (argc-1)) protoarg = (protoarg ", ");
198 arglen = length(protoarg);
199 if ((protolen + arglen) > 77) {
200 protoarg = ("\n " protoarg);
201 arglen += 4;
202 protolen = 0;
203 }
204 printf("%s", protoarg);
205 protolen += arglen;
206 }
207 printf(")\n");
208 printf("#ifndef VNODE_OP_NOINLINE\n");
209 printf("__attribute__((__unused__))\n");
210 printf("#endif\n");
211 printf(";\n");
212 # Define inline function.
213 printf("#ifndef VNODE_OP_NOINLINE\n");
214 printf("static __inline int %s(", toupper(name));
215 for (i=0; i<argc; i++) {
216 printf("%s", argname[i]);
217 if (i < (argc-1)) printf(", ");
218 }
219 printf(")\n");
220 for (i=0; i<argc; i++) {
221 printf("\t%s %s;\n", argtype[i], argname[i]);
222 }
223 printf("{\n\tstruct %s_args a;\n", name);
224 printf("\ta.a_desc = VDESC(%s);\n", name);
225 for (i=0; i<argc; i++) {
226 printf("\ta.a_%s = %s;\n", argname[i], argname[i]);
227 }
228 printf("\treturn (VCALL(%s%s, VOFFSET(%s), &a));\n}\n",
229 argname[0], arg0special, name);
230 printf("#endif\n");
231 }
232 BEGIN {
233 arg0special="";
234 }
235 END {
236 printf("\n/* Special cases: */\n#include <sys/buf.h>\n");
237 argc=1;
238 argtype[0]="struct buf *";
239 argname[0]="bp";
240 arg0special="->b_vp";
241 name="vop_strategy";
242 doit();
243 name="vop_bwrite";
244 doit();
245 }
246 '"$awk_parser" | sed -e "$anal_retentive"
247
248 # End stuff
249 echo '
250 /* End of special cases. */'
251 echo ''
252 echo '#endif /* !_SYS_VNODE_IF_H_ */'
253
254 #
255 # Redirect stdout to the C file.
256 #
257 echo "$0: Creating $out_c" 1>&2
258 exec > $out_c
259
260 # Begin stuff
261 echo -n "$warning" | sed -e 's/\$//g;s/@/\$/g'
262 echo ""
263 echo -n "$copyright"
264 echo '
265 /*
266 * If we have LKM support, always include the non-inline versions for
267 * LKMs. Otherwise, do it based on the option.
268 */
269 #ifdef LKM
270 #define VNODE_OP_NOINLINE
271 #else
272 #include "opt_vnode_op_noinline.h"
273 #endif'
274 echo '
275 #include <sys/param.h>
276 #include <sys/mount.h>
277 #include <sys/buf.h>
278 #include <sys/vnode.h>
279
280 struct vnodeop_desc vop_default_desc = {
281 0,
282 "default",
283 0,
284 NULL,
285 VDESC_NO_OFFSET,
286 VDESC_NO_OFFSET,
287 VDESC_NO_OFFSET,
288 VDESC_NO_OFFSET,
289 NULL,
290 };
291 '
292
293 # Body stuff
294 sed -e "$sed_prep" $src | $awk '
295 function do_offset(typematch) {
296 for (i=0; i<argc; i++) {
297 if (argtype[i] == typematch) {
298 printf("\tVOPARG_OFFSETOF(struct %s_args, a_%s),\n",
299 name, argname[i]);
300 return i;
301 };
302 };
303 print "\tVDESC_NO_OFFSET,";
304 return -1;
305 }
306
307 function doit() {
308 # Define offsets array
309 printf("\nconst int %s_vp_offsets[] = {\n", name);
310 for (i=0; i<argc; i++) {
311 if (argtype[i] == "struct vnode *") {
312 printf ("\tVOPARG_OFFSETOF(struct %s_args,a_%s),\n",
313 name, argname[i]);
314 }
315 }
316 print "\tVDESC_NO_OFFSET";
317 print "};";
318 # Define F_desc
319 printf("struct vnodeop_desc %s_desc = {\n", name);
320 # offset
321 printf ("\t0,\n");
322 # printable name
323 printf ("\t\"%s\",\n", name);
324 # flags
325 printf("\t0");
326 vpnum = 0;
327 for (i=0; i<argc; i++) {
328 if (willrele[i]) {
329 if (willrele[i] == 2) {
330 word = "UNLOCK";
331 } else if (willrele[i] == 3) {
332 word = "PUT";
333 } else {
334 word = "RELE";
335 }
336 if (argdir[i] ~ /OUT/) {
337 printf(" | VDESC_VPP_WILL%s", word);
338 } else {
339 printf(" | VDESC_VP%s_WILL%s", vpnum, word);
340 };
341 vpnum++;
342 }
343 }
344 print ",";
345 # vp offsets
346 printf ("\t%s_vp_offsets,\n", name);
347 # vpp (if any)
348 do_offset("struct vnode **");
349 # cred (if any)
350 do_offset("struct ucred *");
351 # proc (if any)
352 do_offset("struct proc *");
353 # componentname
354 do_offset("struct componentname *");
355 # transport layer information
356 printf ("\tNULL,\n};\n");
357
358 # Define function.
359 printf("#ifdef VNODE_OP_NOINLINE\n");
360 printf("int\n%s(", toupper(name));
361 for (i=0; i<argc; i++) {
362 printf("%s", argname[i]);
363 if (i < (argc-1)) printf(", ");
364 }
365 printf(")\n");
366 for (i=0; i<argc; i++) {
367 printf("\t%s %s;\n", argtype[i], argname[i]);
368 }
369 printf("{\n\tstruct %s_args a;\n", name);
370 printf("\ta.a_desc = VDESC(%s);\n", name);
371 for (i=0; i<argc; i++) {
372 printf("\ta.a_%s = %s;\n", argname[i], argname[i]);
373 }
374 printf("\treturn (VCALL(%s%s, VOFFSET(%s), &a));\n}\n",
375 argname[0], arg0special, name);
376 printf("#endif\n");
377 }
378 BEGIN {
379 arg0special="";
380 }
381 END {
382 printf("\n/* Special cases: */\n");
383 argc=1;
384 argdir[0]="IN";
385 argtype[0]="struct buf *";
386 argname[0]="bp";
387 arg0special="->b_vp";
388 willrele[0]=0;
389 name="vop_strategy";
390 doit();
391 name="vop_bwrite";
392 doit();
393 }
394 '"$awk_parser" | sed -e "$anal_retentive"
395
396 # End stuff
397 echo '
398 /* End of special cases. */'
399
400 # Add the vfs_op_descs array to the C file.
401 # Begin stuff
402 echo '
403 struct vnodeop_desc * const vfs_op_descs[] = {
404 &vop_default_desc, /* MUST BE FIRST */
405 &vop_strategy_desc, /* XXX: SPECIAL CASE */
406 &vop_bwrite_desc, /* XXX: SPECIAL CASE */
407 '
408
409 # Body stuff
410 sed -e "$sed_prep" $src | $awk '
411 function doit() {
412 printf("\t&%s_desc,\n", name);
413 }
414 '"$awk_parser"
415
416 # End stuff
417 echo ' NULL
418 };
419 '
420
421 exit 0
422
423 # Local Variables:
424 # tab-width: 4
425 # End:
426