3 # Copyright (c) 1992, 1993
4 # The Regents of the University of California. All rights reserved.
6 # Redistribution and use in source and binary forms, with or without
7 # modification, are permitted provided that the following conditions
9 # 1. Redistributions of source code must retain the above copyright
10 # notice, this list of conditions and the following disclaimer.
11 # 2. Redistributions in binary form must reproduce the above copyright
12 # notice, this list of conditions and the following disclaimer in the
13 # documentation and/or other materials provided with the distribution.
14 # 3. All advertising materials mentioning features or use of this software
15 # must display the following acknowledgement:
16 # This product includes software developed by the University of
17 # California, Berkeley and its contributors.
18 # 4. Neither the name of the University nor the names of its contributors
19 # may be used to endorse or promote products derived from this software
20 # without specific prior written permission.
22 # THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 # ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 # FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 # DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 # OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 # HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 # OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 # From @(#)vnode_if.sh 8.1 (Berkeley) 6/10/93
35 # From @(#)makedevops.sh 1.1 1998/06/14 13:53:12 dfr Exp $
36 # From @(#)makedevops.sh ?.? 1998/10/05
37 # From src/sys/kern/makedevops.pl,v 1.12 1999/11/22 14:40:04 n_hibma Exp
39 # $FreeBSD: src/sys/kern/makeobjops.pl,v 1.2.2.1 2001/02/02 19:49:13 cg Exp $
40 # $DragonFly: src/sys/kern/Attic/makeobjops.pl,v 1.2 2003/06/17 04:28:41 dillon Exp $
43 # Script to produce kobj front-end sugar.
47 $cfile = 0; # by default do not produce any file type
54 # Process the command line
56 while ( $arg = shift @ARGV ) {
58 warn "Producing .c output files"
61 } elsif ( $arg eq '-h' ) {
62 warn "Producing .h output files"
65 } elsif ( $arg eq '-ch' || $arg eq '-hc' ) {
66 warn "Producing .c and .h output files"
70 } elsif ( $arg eq '-d' ) {
72 } elsif ( $arg eq '-p' ) {
73 warn "Will produce files in original not in current directory"
76 } elsif ( $arg eq '-l' ) {
77 if ( $line_width = shift @ARGV and $line_width > 0 ) {
78 warn "Line width set to $line_width"
81 die "Please specify a valid line width after -l";
83 } elsif ( $arg =~ m/\.m$/ ) {
86 push @filenames, $arg;
94 # Validate the command line parameters
96 die "usage: $0 [-d] [-p] [-l <nr>] [-c|-h] srcfile
97 where -c produce only .c files
98 -h produce only .h files
99 -p use the path component in the source file for destination dir
100 -l set line width for output files [80]
101 -d switch on debugging
103 unless ($cfile or $hfile)
104 and $#filenames != -1;
106 # FIXME should be able to do this more easily
108 $tmpdir = $ENV{'TMPDIR'}; # environment variables
109 $tmpdir = $ENV{'TMP'}
111 $tmpdir = $ENV{'TEMP'}
113 $tmpdir = '/tmp' # look for a physical directory
114 if !$tmpdir and -d '/tmp';
116 if !$tmpdir and -d '/usr/tmp';
118 if !$tmpdir and -d '/var/tmp';
119 $tmpdir = '.' # give up and use current dir
122 foreach $src ( @filenames ) {
123 # Names of the created files
124 $ctmpname = "$tmpdir/ctmp.$$";
125 $htmpname = "$tmpdir/htmp.$$";
127 ($name, $path, $suffix) = &fileparse($src, '.m');
130 $cfilename="$path/$name.c";
131 $hfilename="$path/$name.h";
133 warn "Processing from $src to $cfilename / $hfilename via $ctmpname / $htmpname"
136 die "Could not open $src, $!"
137 if !open SRC, "$src";
138 die "Could not open $ctmpname, $!"
139 if $cfile and !open CFILE, ">$ctmpname";
140 die "Could not open $htmpname, $!"
141 if $hfile and !open HFILE, ">$htmpname";
144 # Produce the header of the C file
147 print CFILE " * This file is produced automatically.\n";
148 print CFILE " * Do not modify anything in here by hand.\n";
150 print CFILE " * Created from source file\n";
151 print CFILE " * $src\n";
152 print CFILE " * with\n";
153 print CFILE " * $0\n";
155 print CFILE " * See the source file for legal information\n";
158 print CFILE "#include <sys/param.h>\n";
159 print CFILE "#include <sys/queue.h>\n";
160 print CFILE "#include <sys/kernel.h>\n";
161 print CFILE "#include <sys/kobj.h>\n";
165 # Produce the header of the H file
168 print HFILE " * This file is produced automatically.\n";
169 print HFILE " * Do not modify anything in here by hand.\n";
171 print HFILE " * Created from source file\n";
172 print HFILE " * $src\n";
173 print HFILE " * with\n";
174 print HFILE " * $0\n";
176 print HFILE " * See the source file for legal information\n";
181 %methods = (); # clear list of methods
183 @defaultmethods = ();
185 $error = 0; # to signal clean up and gerror setting
188 while ( $line = <SRC> ) {
191 # take special notice of include directives.
193 if ( $line =~ m/^#\s*include\s+(["<])([^">]+)([">]).*/i ) {
194 warn "Included file: $1$2" . ($1 eq '<'? '>':'"')
196 print CFILE "#include $1$2" . ($1 eq '<'? '>':'"') . "\n"
200 $line =~ s/#.*//; # remove comments
201 $line =~ s/^\s+//; # remove leading ...
202 $line =~ s/\s+$//; # remove trailing whitespace
204 if ( $line =~ m/^$/ ) { # skip empty lines
207 } elsif ( $line =~ m/^INTERFACE\s*([^\s;]*)(\s*;?)/i ) {
210 unless ( $intname =~ m/^[a-z_][a-z0-9_]*$/ ) {
213 warn "$src:$lineno: Invalid interface name '$intname', use [a-z_][a-z0-9_]*";
218 warn "$src:$lineno: semicolon missing at end of line, no problem"
219 if $semicolon !~ s/;$//;
221 warn "Interface $intname"
224 print HFILE '#ifndef _'.$intname."_if_h_\n"
226 print HFILE '#define _'.$intname."_if_h_\n\n"
228 print CFILE '#include "'.$intname.'_if.h"'."\n\n"
230 } elsif ( $line =~ m/^CODE\s*{$/i ) {
234 $indent = $1; # find the indent used
235 while ( $line !~ m/^}/ ) {
236 $line =~ s/^$indent//g; # remove the indent
242 print CFILE "\n".$code."\n";
244 } elsif ( $line =~ m/^HEADER\s*{$/i ) {
248 $indent = $1; # find the indent used
249 while ( $line !~ m/^}/ ) {
250 $line =~ s/^$indent//g; # remove the indent
258 } elsif ( $line =~ m/^(STATIC|)METHOD/i ) {
259 # Get the return type function name and delete that from
260 # the line. What is left is the possibly first function argument
261 # if it is on the same line.
264 warn "$src:$lineno: No interface name defined";
268 $line =~ s/^(STATIC|)METHOD\s+([^\{]+?)\s*\{\s*//i;
270 @ret = split m/\s+/, $2;
271 $name = pop @ret; # last element is name of method
272 $ret = join(" ", @ret); # return type
274 warn "Method: name=$name return type=$ret"
277 if ( !$name or !$ret ) {
280 warn "$src:$lineno: Invalid method specification";
285 unless ( $name =~ m/^[a-z_][a-z_0-9]*$/ ) {
288 warn "$src:$lineno: Invalid method name '$name', use [a-z_][a-z0-9_]*";
293 if ( defined($methods{$name}) ) {
294 warn "$src:$lineno: Duplicate method name";
299 $methods{$name} = $name;
302 while ( $line !~ m/}/ and $line .= <SRC> ) {
307 if ( $line !~ s/};?(.*)// ) { # remove first '}' and trailing garbage
308 # The '}' was not there (the rest is optional), so complain
309 warn "$src:$lineno: Premature end of file";
314 if ( $extra =~ /\s*DEFAULT\s*([a-zA-Z_][a-zA-Z_0-9]*)\s*;/ ) {
317 warn "$src:$lineno: Ignored '$1'" # warn about garbage at end of line
321 # Create a list of variables without the types prepended
323 $line =~ s/^\s+//; # remove leading ...
324 $line =~ s/\s+$//; # ... and trailing whitespace
325 $line =~ s/\s+/ /g; # remove double spaces
327 @arguments = split m/\s*;\s*/, $line;
328 @varnames = (); # list of varnames
329 foreach $argument (@arguments) {
330 next # skip argument if argument is empty
333 @ar = split m/[*\s]+/, $argument;
334 if ( $#ar == 0 ) { # only 1 word in argument?
335 warn "$src:$lineno: no type for '$argument'";
340 push @varnames, $ar[-1]; # last element is name of variable
343 warn 'Arguments: ' . join(', ', @arguments) . "\n"
344 . 'Varnames: ' . join(', ', @varnames)
347 $mname = $intname.'_'.$name; # method name
348 $umname = uc($mname); # uppercase method name
350 $arguments = join(", ", @arguments);
351 $firstvar = $varnames[0];
352 $varnames = join(", ", @varnames);
354 $default = "0" if $default eq "";
355 push @defaultmethods, $default;
358 # the method description
359 print HFILE "extern struct kobjop_desc $mname\_desc;\n";
361 print HFILE &format_line("typedef $ret $mname\_t($arguments);",
363 ',',' ' x length("typedef $ret $mname\_t("))
368 # Print out the method desc
369 print CFILE "struct kobjop_desc $mname\_desc = {\n";
370 print CFILE "\t0, (kobjop_t) $default\n";
371 print CFILE "};\n\n";
375 # Print out the method itself
376 if (0) { # haven't chosen the format yet
377 print HFILE "static __inline $ret $umname($varnames)\n";
378 print HFILE "\t".join(";\n\t", @arguments).";\n";
380 print HFILE &format_line("static __inline $ret $umname($arguments)",
382 ',', ' ' x length("$ret $umname(")) . "\n";
385 print HFILE "\tkobjop_t _m;\n";
387 print HFILE "\tKOBJOPLOOKUP($firstvar->ops,$mname);\n";
389 print HFILE "\tKOBJOPLOOKUP(((kobj_t)$firstvar)->ops,$mname);\n";
392 if ($ret ne 'void') {
393 print HFILE "return ";
395 print HFILE "(($mname\_t *) _m)($varnames);\n";
401 warn "$src:$lineno: Invalid line encountered";
407 # print the final '#endif' in the header file
409 print HFILE "#endif /* _".$intname."_if_h_ */\n"
420 ($rc = system("mv $ctmpname $cfilename"))
421 and warn "mv $ctmpname $cfilename failed, $rc";
425 ($rc = system("mv $htmpname $hfilename"))
426 and warn "mv $htmpname $hfilename failed, $rc";
429 warn 'Output skipped';
430 ($rc = system("rm -f $htmpname $ctmpname"))
431 and warn "rm -f $htmpname $ctmpname failed, $rc";
440 my ($line, $maxlength, $break, $new_end, $new_start) = @_;
443 while ( length($line) > $maxlength
444 and ($i = rindex $line, $break, $maxlength-length($new_end)) != -1 ) {
445 $rline .= substr($line, 0, $i) . $new_end . "\n";
446 $line = $new_start . substr($line, $i+length($break));
449 return $rline . $line;
452 # This routine is a crude replacement for one in File::Basename. We
453 # cannot use any library code because it fouls up the Perl bootstrap
454 # when we update a perl version. MarkM
457 my ($filename, @suffix) = @_;
458 my ($dir, $name, $type, $i);
461 foreach $i (@suffix) {
462 if ($filename =~ m|$i$|) {
463 $filename =~ s|$i$||;
467 if ($filename =~ m|/|) {
468 $filename =~ m|([^/]*)$|;
477 ($name, $dir, $type);
480 sub write_interface {
481 $mcount = $#mnames + 1;