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
33 # From @(#)vnode_if.sh 8.1 (Berkeley) 6/10/93
34 # From @(#)makedevops.sh 1.1 1998/06/14 13:53:12 dfr Exp $
35 # From @(#)makedevops.sh ?.? 1998/10/05
36 # From src/sys/kern/makedevops.pl,v 1.12 1999/11/22 14:40:04 n_hibma Exp
37 # From src/sys/kern/makeobjops.pl,v 1.8 2001/11/16 02:02:42 joe Exp
42 # Script to produce kobj front-end sugar.
47 print "usage: makeobjops.awk <srcfile.m> [-d] [-p] [-l <nr>] [-c|-h]";
48 print "where -c produce only .c files";
49 print " -h produce only .h files";
50 print " -p use the path component in the source file for destination dir";
51 print " -l set line width for output files [80]";
52 print " -d switch on debugging";
58 print "makeobjops.awk:", msg > "/dev/stderr";
61 function warnsrc (msg)
63 warn(src ":" lineno ": " msg);
78 # These are just for convenience ...
79 function printc(s) {if (opt_c) print s > ctmpfilename;}
80 function printh(s) {if (opt_h) print s > htmpfilename;}
83 # If a line exceeds maxlength, split it into multiple
84 # lines at commas. Subsequent lines are indented by
85 # the specified number of spaces.
87 # In other words: Lines are split by replacing ", "
88 # by ",\n" plus indent spaces.
91 function format_line (line, maxlength, indent)
95 while (length(line) > maxlength) {
97 # Find the rightmost ", " so that the part
98 # to the left of it is just within maxlength.
99 # If there is none, give up and leave it as-is.
101 if (!match(substr(line, 1, maxlength + 1), /^.*, /))
103 rline = rline substr(line, 1, RLENGTH - 1) "\n";
104 line = sprintf("%*s", indent, "") substr(line, RLENGTH + 1);
110 # Join an array into a string.
113 function join (separator, array, num)
118 _result = separator array[num--] _result;
119 _result = array[1] _result;
125 # Execute a system command and report if it failed.
128 function system_check (cmd)
130 if ((rc = system(cmd)))
131 warn(cmd " failed (" rc ")");
135 # Handle "INTERFACE" line.
138 function handle_interface ()
141 sub(/;$/, "", intname);
142 if (intname !~ /^[a-z_][a-z0-9_]*$/) {
144 warnsrc("Invalid interface name '" intname "', use [a-z_][a-z0-9_]*");
149 warnsrc("Semicolon missing at end of line, no problem");
151 debug("Interface " intname);
153 printh("#ifndef _" intname "_if_h_");
154 printh("#define _" intname "_if_h_\n");
155 printc("#include \"" intname "_if.h\"\n");
159 # Pass doc comments through to the C file
161 function handle_doc ()
174 # Handle "CODE" and "HEADER" sections.
175 # Returns the code as-is.
178 function handle_code ()
183 sub(/[^ ].*$/, "", indent); # find the indent used
185 sub("^" indent, ""); # remove the indent
194 # Handle "METHOD" and "STATICMETHOD" sections.
197 function handle_method (static, doc)
200 # Get the return type and function name and delete that from
201 # the line. What is left is the possibly first function argument
202 # if it is on the same line.
205 warnsrc("No interface name defined");
209 sub(/^[^ ]+[ ]+/, "");
211 sub(/[ ]*\{.*$/, "", ret);
213 sub(/^.*[ ]/, "", name); # last element is name of method
214 sub(/[ ]+[^ ]+$/, "", ret); # return type
215 debug("Method: name=" name " return type=" ret);
217 sub(/^[^\{]*\{[ ]*/, "");
221 warnsrc("Invalid method specification");
226 if (name !~ /^[a-z_][a-z_0-9]*$/) {
227 warnsrc("Invalid method name '" name "', use [a-z_][a-z0-9_]*");
233 warnsrc("Duplicate method name");
237 methods[name] = name;
240 while (line !~ /\}/ && (getline < src) > 0) {
245 default_function = "";
246 if (!match(line, /\};?/)) {
247 warnsrc("Premature end of file");
251 extra = substr(line, RSTART + RLENGTH);
252 if (extra ~ /[ ]*DEFAULT[ ]*[a-zA-Z_][a-zA-Z_0-9]*[ ]*;/) {
253 default_function = extra;
254 sub(/.*DEFAULT[ ]*/, "", default_function);
255 sub(/[; ]+.*$/, "", default_function);
257 else if (extra && opt_d) {
258 # Warn about garbage at end of line.
259 warnsrc("Ignored '" extra "'");
261 sub(/\};?.*$/, "", line);
264 # Create a list of variables without the types prepended.
266 sub(/^[ ]+/, "", line); # remove leading ...
267 sub(/[ ]+$/, "", line); # ... and trailing whitespace
268 gsub(/[ ]+/, " ", line); # remove double spaces
270 num_arguments = split(line, arguments, / *; */) - 1;
271 delete varnames; # list of varnames
273 for (i = 1; i <= num_arguments; i++) {
275 continue; # skip argument if argument is empty
276 num_ar = split(arguments[i], ar, /[* ]+/);
277 if (num_ar < 2) { # only 1 word in argument?
278 warnsrc("no type for '" arguments[i] "'");
282 # Last element is name of variable.
283 varnames[++num_varnames] = ar[num_ar];
286 argument_list = join(", ", arguments, num_arguments);
287 varname_list = join(", ", varnames, num_varnames);
290 warn("Arguments: " argument_list);
291 warn("Varnames: " varname_list);
294 mname = intname "_" name; # method name
295 umname = toupper(mname); # uppercase method name
297 firstvar = varnames[1];
299 if (default_function == "")
300 default_function = "kobj_error_method";
302 # the method description
303 printh("/** @brief Unique descriptor for the " umname "() method */");
304 printh("extern struct kobjop_desc " mname "_desc;");
306 printh("/** @brief A function implementing the " umname "() method */");
307 prototype = "typedef " ret " " mname "_t(";
308 printh(format_line(prototype argument_list ");",
309 line_width, length(prototype)));
311 # Print out the method desc
312 printc("struct kobjop_desc " mname "_desc = {");
313 printc("\t0, { &" mname "_desc, (kobjop_t)" default_function " }");
316 # Print out the method itself
318 if (0) { # haven't chosen the format yet
319 printh("static __inline " ret " " umname "(" varname_list ")");
320 printh("\t" join(";\n\t", arguments, num_arguments) ";");
323 prototype = "static __inline " ret " " umname "(";
324 printh(format_line(prototype argument_list ")",
325 line_width, length(prototype)));
328 printh("\tkobjop_t _m;");
330 printh("\t" ret " rc;");
332 firstvar = "((kobj_t)" firstvar ")";
335 printh("\tKOBJOPLOOKUP(" firstvar "->ops," mname ");");
336 rceq = (ret != "void") ? "rc = " : "";
337 printh("\t" rceq "((" mname "_t *) _m)(" varname_list ");");
341 printh("\treturn (rc);");
346 # Begin of the main program.
355 # Process the command line.
360 for (i = 1; i < ARGC; i++) {
361 if (ARGV[i] ~ /^-/) {
363 # awk doesn't have getopt(), so we have to do it ourselves.
364 # This is a bit clumsy, but it works.
366 for (j = 2; j <= length(ARGV[i]); j++) {
367 o = substr(ARGV[i], j, 1);
368 if (o == "c") opt_c = 1;
369 else if (o == "h") opt_h = 1;
370 else if (o == "p") opt_p = 1;
371 else if (o == "d") opt_d = 1;
373 if (length(ARGV[i]) > j) {
374 opt_l = substr(ARGV[i], j + 1);
388 else if (ARGV[i] ~ /\.m$/)
389 filenames[num_files++] = ARGV[i];
394 if (!num_files || !(opt_c || opt_h))
398 debug("Will produce files in original not in current directory");
401 if (opt_l !~ /^[0-9]+$/ || opt_l < 1)
402 die("Invalid line width '" opt_l "'");
404 debug("Line width set to " line_width);
407 for (i = 0; i < num_files; i++)
408 debug("Filename: " filenames[i]);
410 for (file_i = 0; file_i < num_files; file_i++) {
411 src = filenames[file_i];
412 cfilename = hfilename = src;
413 sub(/\.m$/, ".c", cfilename);
414 sub(/\.m$/, ".h", hfilename);
416 sub(/^.*\//, "", cfilename);
417 sub(/^.*\//, "", hfilename);
420 debug("Processing from " src " to " cfilename " / " hfilename);
422 ctmpfilename = cfilename ".tmp";
423 htmpfilename = hfilename ".tmp";
425 # Avoid a literal generated file tag here.
426 generated = "@" "generated";
430 " * This file is " generated " automatically.\n" \
431 " * Do not modify anything in here by hand.\n" \
433 " * Created from source file\n" \
436 " * makeobjops.awk\n" \
438 " * See the source file for legal information\n" \
441 printc(common_head "\n" \
442 "#include <sys/param.h>\n" \
443 "#include <sys/queue.h>\n" \
444 "#include <sys/kernel.h>\n" \
445 "#include <sys/kobj.h>");
449 delete methods; # clear list of methods
452 error = 0; # to signal clean up and gerror setting
457 while (!error && (getline < src) > 0) {
461 # Take special notice of include directives.
463 if (/^#[ ]*include[ ]+["<][^">]+[">]/) {
465 sub(/^#[ ]*include[ ]+/, "", incld);
466 debug("Included file: " incld);
467 printc("#include " incld);
470 sub(/#.*/, ""); # remove comments
471 sub(/^[ ]+/, ""); # remove leading ...
472 sub(/[ ]+$/, ""); # ... and trailing whitespace
474 if (/^$/) { # skip empty lines
477 lastdoc = handle_doc();
478 else if (/^INTERFACE[ ]+[^ ;]*[ ]*;?[ ]*$/) {
482 } else if (/^CODE[ ]*{$/)
483 printc(handle_code());
484 else if (/^HEADER[ ]*{$/)
485 printh(handle_code());
486 else if (/^METHOD/) {
487 handle_method(0, lastdoc);
491 } else if (/^STATICMETHOD/) {
492 handle_method(1, lastdoc);
496 } else if (/^PROLOG[ ]*{$/)
497 prolog = handle_code();
498 else if (/^EPILOG[ ]*{$/)
499 epilog = handle_code();
502 warnsrc("Invalid line encountered");
508 # Print the final '#endif' in the header file.
510 printh("#endif /* _" intname "_if_h_ */");
512 close (ctmpfilename);
513 close (htmpfilename);
516 warn("Output skipped");
517 system_check("rm -f " ctmpfilename " " htmpfilename);
522 system_check("mv -f " ctmpfilename " " cfilename);
524 system_check("mv -f " htmpfilename " " hfilename);