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
38 # $FreeBSD: src/sys/kern/makedevops.pl,v 1.12.2.3 2001/01/18 00:23:57 n_hibma Exp $
39 # $DragonFly: src/sys/kern/Attic/makedevops.pl,v 1.2 2003/06/17 04:28:41 dillon Exp $
42 # Script to produce device front-end sugar.
46 $cfile = 0; # by default do not produce any file type
53 # Process the command line
55 while ( $arg = shift @ARGV ) {
57 warn "Producing .c output files"
60 } elsif ( $arg eq '-h' ) {
61 warn "Producing .h output files"
64 } elsif ( $arg eq '-ch' || $arg eq '-hc' ) {
65 warn "Producing .c and .h output files"
69 } elsif ( $arg eq '-d' ) {
71 } elsif ( $arg eq '-p' ) {
72 warn "Will produce files in original not in current directory"
75 } elsif ( $arg eq '-l' ) {
76 if ( $line_width = shift @ARGV and $line_width > 0 ) {
77 warn "Line width set to $line_width"
80 die "Please specify a valid line width after -l";
82 } elsif ( $arg =~ m/\.m$/ ) {
85 push @filenames, $arg;
93 # Validate the command line parameters
95 die "usage: $0 [-d] [-p] [-l <nr>] [-c|-h] srcfile
96 where -c produce only .c files
97 -h produce only .h files
98 -p use the path component in the source file for destination dir
99 -l set line width for output files [80]
100 -d switch on debugging
102 unless ($cfile or $hfile)
103 and $#filenames != -1;
105 # FIXME should be able to do this more easily
107 $tmpdir = $ENV{'TMPDIR'}; # environment variables
108 $tmpdir = $ENV{'TMP'}
110 $tmpdir = $ENV{'TEMP'}
112 $tmpdir = '/tmp' # look for a physical directory
113 if !$tmpdir and -d '/tmp';
115 if !$tmpdir and -d '/usr/tmp';
117 if !$tmpdir and -d '/var/tmp';
118 $tmpdir = '.' # give up and use current dir
121 foreach $src ( @filenames ) {
122 # Names of the created files
123 $ctmpname = "$tmpdir/ctmp.$$";
124 $htmpname = "$tmpdir/htmp.$$";
126 ($name, $path, $suffix) = &fileparse($src, '.m');
129 $cfilename="$path/$name.c";
130 $hfilename="$path/$name.h";
132 warn "Processing from $src to $cfilename / $hfilename via $ctmpname / $htmpname"
135 die "Could not open $src, $!"
136 if !open SRC, "$src";
137 die "Could not open $ctmpname, $!"
138 if $cfile and !open CFILE, ">$ctmpname";
139 die "Could not open $htmpname, $!"
140 if $hfile and !open HFILE, ">$htmpname";
143 # Produce the header of the C file
146 print CFILE " * This file is produced automatically.\n";
147 print CFILE " * Do not modify anything in here by hand.\n";
149 print CFILE " * Created from source file\n";
150 print CFILE " * $src\n";
151 print CFILE " * with\n";
152 print CFILE " * $0\n";
154 print CFILE " * See the source file for legal information\n";
157 print CFILE "#include <sys/param.h>\n";
158 print CFILE "#include <sys/queue.h>\n";
159 print CFILE "#include <sys/sysctl.h>\n";
160 print CFILE "#include <sys/bus_private.h>\n";
164 # Produce the header of the H file
167 print HFILE " * This file is produced automatically.\n";
168 print HFILE " * Do not modify anything in here by hand.\n";
170 print HFILE " * Created from source file\n";
171 print HFILE " * $src\n";
172 print HFILE " * with\n";
173 print HFILE " * $0\n";
175 print HFILE " * See the source file for legal information\n";
180 %methods = (); # clear list of methods
182 $error = 0; # to signal clean up and gerror setting
184 LINE: while ( $line = <SRC> ) {
187 # take special notice of include directives.
189 if ( $line =~ m/^#\s*include\s+(["<])([^">]+)([">]).*/i ) {
190 warn "Included file: $1$2" . ($1 eq '<'? '>':'"')
192 print CFILE "#include $1$2" . ($1 eq '<'? '>':'"') . "\n"
196 $line =~ s/#.*//; # remove comments
197 $line =~ s/^\s+//; # remove leading ...
198 $line =~ s/\s+$//; # remove trailing whitespace
200 if ( $line =~ m/^$/ ) { # skip empty lines
202 } elsif ( $line =~ m/^INTERFACE\s*([^\s;]*)(\s*;?)/i ) {
205 unless ( $intname =~ m/^[a-z_][a-z0-9_]*$/ ) {
208 warn "$src:$lineno: Invalid interface name '$intname', use [a-z_][a-z0-9_]*";
213 warn "$src:$lineno: semicolon missing at end of line, no problem"
214 if $semicolon !~ s/;$//;
216 warn "Interface $intname"
219 print HFILE '#ifndef _'.$intname."_if_h_\n"
221 print HFILE '#define _'.$intname."_if_h_\n\n"
223 print CFILE '#include "'.$intname.'_if.h"'."\n\n"
225 } elsif ( $line =~ m/^CODE\s*{$/i ) {
229 $indent = $1; # find the indent used
230 while ( $line !~ m/^}/ ) {
231 $line =~ s/^$indent//g; # remove the indent
237 print CFILE "\n".$code."\n";
239 } elsif ( $line =~ m/^HEADER\s*{$/i ) {
243 $indent = $1; # find the indent used
244 while ( $line !~ m/^}/ ) {
245 $line =~ s/^$indent//g; # remove the indent
253 } elsif ( $line =~ m/^(STATIC|)METHOD/i ) {
254 # Get the return type function name and delete that from
255 # the line. What is left is the possibly first function argument
256 # if it is on the same line.
259 warn "$src:$lineno: No interface name defined";
263 $line =~ s/^(STATIC|)METHOD\s+([^{]+?)\s*{\s*//i;
265 @ret = split m/\s+/, $2;
266 $name = pop @ret; # last element is name of method
267 $ret = join(" ", @ret); # return type
269 warn "Method: name=$name return type=$ret"
272 if ( !$name or !$ret ) {
275 warn "$src:$lineno: Invalid method specification";
280 unless ( $name =~ m/^[a-z_][a-z_0-9]*$/ ) {
283 warn "$src:$lineno: Invalid method name '$name', use [a-z_][a-z0-9_]*";
288 if ( defined($methods{$name}) ) {
289 warn "$src:$lineno: Duplicate method name";
294 $methods{$name} = 'VIS';
296 while ( $line !~ m/}/ and $line .= <SRC> ) {
301 if ( $line !~ s/};?(.*)// ) { # remove first '}' and trailing garbage
302 # The '}' was not there (the rest is optional), so complain
303 warn "$src:$lineno: Premature end of file";
308 if ( $extra =~ /\s*DEFAULT\s*([a-zA-Z_][a-zA-Z_0-9]*)\s*;/ ) {
311 warn "$src:$lineno: Ignored '$1'" # warn about garbage at end of line
315 # Create a list of variables without the types prepended
317 $line =~ s/^\s+//; # remove leading ...
318 $line =~ s/\s+$//; # ... and trailing whitespace
319 $line =~ s/\s+/ /g; # remove double spaces
321 @arguments = split m/\s*;\s*/, $line;
322 @varnames = (); # list of varnames
323 foreach $argument (@arguments) {
324 next # skip argument if argument is empty
327 @ar = split m/[*\s]+/, $argument;
328 if ( $#ar == 0 ) { # only 1 word in argument?
329 warn "$src:$lineno: no type for '$argument'";
334 push @varnames, $ar[-1]; # last element is name of variable
337 warn 'Arguments: ' . join(', ', @arguments) . "\n"
338 . 'Varnames: ' . join(', ', @varnames)
341 $mname = $intname.'_'.$name; # method name
342 $umname = uc($mname); # uppercase method name
344 $arguments = join(", ", @arguments);
345 $varnames = join(", ", @varnames);
347 $default = "0" if $default eq "";
350 # the method description
351 print HFILE "extern struct device_op_desc $mname\_desc;\n";
353 my $prototype = "typedef $ret $mname\_t(";
354 print HFILE &format_line("$prototype$arguments);",
355 $line_width, ', ', ',',' ' x length($prototype))
357 # the method declaration
358 print HFILE "$mname\_t $umname;\n\n";
362 # Print out the method desc
363 print CFILE "struct device_op_desc $mname\_desc = {\n";
364 print CFILE "\t0, 0, (devop_t) $default, \"$mname\"\n";
365 print CFILE "};\n\n";
367 # Print out the method itself
368 if ( 0 ) { # haven't chosen the format yet
369 print CFILE "$ret $umname($varnames)\n";
370 print CFILE "\t".join(";\n\t", @arguments).";\n";
372 my $prototype = "$ret $umname(";
373 print CFILE &format_line("$prototype$arguments)",
374 $line_width, ', ', ',', ' ' x length($prototype))
379 print CFILE &format_line("\t$mname\_t *m = ($mname\_t *) DRVOPMETH(driver, $mname);",
380 $line_width-8, ' = ', ' =', "\t\t")
383 print CFILE &format_line("\t$mname\_t *m = ($mname\_t *) DEVOPMETH(dev, $mname);",
384 $line_width-8, ' = ', ' =', "\t\t")
387 print CFILE "\t".($ret eq 'void'? '':'return ') . "m($varnames);\n";
393 warn "$src:$lineno: Invalid line encountered";
399 # print the final '#endif' in the header file
401 print HFILE "#endif /* _".$intname."_if_h_ */\n"
412 ($rc = system("mv $ctmpname $cfilename"))
413 and warn "mv $ctmpname $cfilename failed, $rc";
417 ($rc = system("mv $htmpname $hfilename"))
418 and warn "mv $htmpname $hfilename failed, $rc";
421 warn 'Output skipped';
422 ($rc = system("rm -f $htmpname $ctmpname"))
423 and warn "rm -f $htmpname $ctmpname failed, $rc";
432 my ($line, $maxlength, $break, $new_end, $new_start) = @_;
435 while ( length($line) > $maxlength
436 and ($i = rindex $line, $break, $maxlength-length($new_end)) != -1 ) {
437 $rline .= substr($line, 0, $i) . $new_end . "\n";
438 $line = $new_start . substr($line, $i+length($break));
441 return $rline . $line;
444 # This routine is a crude replacement for one in File::Basename. We
445 # cannot use any library code because it fouls up the Perl bootstrap
446 # when we update a perl version. MarkM
449 my ($filename, @suffix) = @_;
450 my ($dir, $name, $type, $i);
453 foreach $i (@suffix) {
454 if ($filename =~ m|$i$|) {
455 $filename =~ s|$i$||;
459 if ($filename =~ m|/|) {
460 $filename =~ m|([^/]*)$|;
469 ($name, $dir, $type);