sys/kern/makedevops.pl

   1 #!/usr/bin/perl
   2 #
   3 # Copyright (c) 1992, 1993
   4 #        The Regents of the University of California.  All rights reserved.
   5 #
   6 # Redistribution and use in source and binary forms, with or without
   7 # modification, are permitted provided that the following conditions
   8 # are met:
   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.
  21 #
  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
  32 # SUCH DAMAGE.
  33 #
  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 #
  38 # $FreeBSD$
  39
  40 #
  41 # Script to produce device front-end sugar.
  42 #
  43
  44 $debug = 0;
  45 $cfile = 0;          # by default do not produce any file type
  46 $hfile = 0;
  47
  48 $keepcurrentdir = 1;
  49
  50 $line_width = 80;
  51
  52 # Process the command line
  53 #
  54 while ( $arg = shift @ARGV ) {
  55    if ( $arg eq '-c' ) {
  56       warn "Producing .c output files"
  57          if $debug;
  58       $cfile = 1;
  59    } elsif ( $arg eq '-h' ) {
  60       warn "Producing .h output files"
  61          if $debug;
  62       $hfile = 1;
  63    } elsif ( $arg eq '-ch' || $arg eq '-hc' ) {
  64       warn "Producing .c and .h output files"
  65          if $debug;
  66       $cfile = 1;
  67       $hfile = 1;
  68    } elsif ( $arg eq '-d' ) {
  69       $debug = 1;
  70    } elsif ( $arg eq '-p' ) {
  71       warn "Will produce files in original not in current directory"
  72          if $debug;
  73       $keepcurrentdir = 0;
  74    } elsif ( $arg eq '-l' ) {
  75       if ( $line_width = shift @ARGV and $line_width > 0 ) {
  76          warn "Line width set to $line_width"
  77             if $debug;
  78       } else {
  79          die "Please specify a valid line width after -l";
  80       }
  81    } elsif ( $arg =~ m/\.m$/ ) {
  82       warn "Filename: $arg"
  83          if $debug;
  84       push @filenames, $arg;
  85    } else {
  86       warn "$arg ignored"
  87          if $debug;
  88    }
  89 }
  90
  91
  92 # Validate the command line parameters
  93 #
  94 die "usage: $0 [-d] [-p] [-l <nr>] [-c|-h] srcfile
  95 where -c   produce only .c files
  96       -h   produce only .h files
  97       -p   use the path component in the source file for destination dir
  98       -l   set line width for output files [80]
  99       -d   switch on debugging
 100 "
 101         unless ($cfile or $hfile)
 102            and $#filenames != -1;
 103
 104 # FIXME should be able to do this more easily
 105 #
 106 $tmpdir = $ENV{'TMPDIR'};           # environment variables
 107 $tmpdir = $ENV{'TMP'}
 108    if !$tmpdir;
 109 $tmpdir = $ENV{'TEMP'}
 110    if !$tmpdir;
 111 $tmpdir = '/tmp'                    # look for a physical directory
 112    if !$tmpdir and -d '/tmp';
 113 $tmpdir = '/usr/tmp'
 114    if !$tmpdir and -d '/usr/tmp';
 115 $tmpdir = '/var/tmp'
 116    if !$tmpdir and -d '/var/tmp';
 117 $tmpdir = '.'                       # give up and use current dir
 118    if !$tmpdir;
 119
 120 foreach $src ( @filenames ) {
 121    # Names of the created files
 122    $ctmpname = "$tmpdir/ctmp.$$";
 123    $htmpname = "$tmpdir/htmp.$$";
 124
 125    ($name, $path, $suffix) = &fileparse($src, '.m');
 126    $path = '.'
 127       if $keepcurrentdir;
 128    $cfilename="$path/$name.c";
 129    $hfilename="$path/$name.h";
 130
 131    warn "Processing from $src to $cfilename / $hfilename via $ctmpname / $htmpname"
 132       if $debug;
 133
 134    die "Could not open $src, $!"
 135       if !open SRC, "$src";
 136    die "Could not open $ctmpname, $!"
 137       if $cfile and !open CFILE, ">$ctmpname";
 138    die "Could not open $htmpname, $!"
 139       if $hfile and !open HFILE, ">$htmpname";
 140
 141    if ( $cfile ) {
 142       # Produce the header of the C file
 143       #
 144       print CFILE "/*\n";
 145       print CFILE " * This file is produced automatically.\n";
 146       print CFILE " * Do not modify anything in here by hand.\n";
 147       print CFILE " *\n";
 148       print CFILE " * Created from source file\n";
 149       print CFILE " *   $src\n";
 150       print CFILE " * with\n";
 151       print CFILE " *   $0\n";
 152       print CFILE " *\n";
 153       print CFILE " * See the source file for legal information\n";
 154       print CFILE " */\n";
 155       print CFILE "\n";
 156       print CFILE "#include <sys/param.h>\n";
 157       print CFILE "#include <sys/queue.h>\n";
 158       print CFILE "#include <sys/sysctl.h>\n";
 159       print CFILE "#include <sys/bus_private.h>\n";
 160    }
 161
 162    if ( $hfile ) {
 163       # Produce the header of the H file
 164       #
 165       print HFILE "/*\n";
 166       print HFILE " * This file is produced automatically.\n";
 167       print HFILE " * Do not modify anything in here by hand.\n";
 168       print HFILE " *\n";
 169       print HFILE " * Created from source file\n";
 170       print HFILE " *   $src\n";
 171       print HFILE " * with\n";
 172       print HFILE " *   $0\n";
 173       print HFILE " *\n";
 174       print HFILE " * See the source file for legal information\n";
 175       print HFILE " */\n";
 176       print HFILE "\n";
 177    }
 178
 179    %methods = ();    # clear list of methods
 180    $lineno = 0;
 181    $error = 0;       # to signal clean up and gerror setting
 182
 183    LINE: while ( $line = <SRC> ) {
 184       $lineno++;
 185
 186       # take special notice of include directives.
 187       #
 188       if ( $line =~ m/^#\s*include\s+(["<])([^">]+)([">]).*/i ) {
 189          warn "Included file: $1$2" . ($1 eq '<'? '>':'"')
 190             if $debug;
 191          print CFILE "#include $1$2" . ($1 eq '<'? '>':'"') . "\n"
 192             if $cfile;
 193       }
 194
 195       $line =~ s/#.*//;                # remove comments
 196       $line =~ s/^\s+//;               # remove leading ...
 197       $line =~ s/\s+$//;               # remove trailing whitespace
 198
 199       if ( $line =~ m/^$/ ) {          # skip empty lines
 200          # nop
 201
 202       } elsif ( $line =~ m/^INTERFACE\s*([^\s;]*)(\s*;?)/i ) {
 203          $intname = $1;
 204          $semicolon = $2;
 205          unless ( $intname =~ m/^[a-z_][a-z0-9_]*$/ ) {
 206             warn $line
 207                if $debug;
 208             warn "$src:$lineno: Invalid interface name '$intname', use [a-z_][a-z0-9_]*";
 209             $error = 1;
 210             last LINE;
 211          }
 212
 213          warn "$src:$lineno: semicolon missing at end of line, no problem"
 214             if $semicolon !~ s/;$//;
 215
 216          warn "Interface $intname"
 217             if $debug;
 218
 219          print HFILE '#ifndef _'.$intname."_if_h_\n"
 220             if $hfile;
 221          print HFILE '#define _'.$intname."_if_h_\n\n"
 222             if $hfile;
 223          print CFILE '#include "'.$intname.'_if.h"'."\n\n"
 224             if $cfile;
 225
 226       } elsif ( $line =~ m/^CODE\s*{$/i ) {
 227          $code = "";
 228          $line = <SRC>;
 229          $line =~ m/^(\s*)/;
 230          $indent = $1;           # find the indent used
 231          while ( $line !~ m/^}/ ) {
 232             $line =~ s/^$indent//g; # remove the indent
 233             $code .= $line;
 234             $line = <SRC>;
 235             $lineno++
 236          }
 237          if ( $cfile ) {
 238              print CFILE "\n".$code."\n";
 239          }
 240       } elsif ( $line =~ m/^HEADER\s*{$/i ) {
 241          $header = "";
 242          $line = <SRC>;
 243          $line =~ m/^(\s*)/;
 244          $indent = $1;              # find the indent used
 245          while ( $line !~ m/^}/ ) {
 246             $line =~ s/^$indent//g; # remove the indent
 247             $header .= $line;
 248             $line = <SRC>;
 249             $lineno++
 250          }
 251          if ( $hfile ) {
 252              print CFILE $header;
 253          }
 254       } elsif ( $line =~ m/^(STATIC|)METHOD/i ) {
 255          # Get the return type function name and delete that from
 256          # the line. What is left is the possibly first function argument
 257          # if it is on the same line.
 258          #
 259          if ( !$intname ) {
 260             warn "$src:$lineno: No interface name defined";
 261             $error = 1;
 262             last LINE;
 263          }
 264          $line =~ s/^(STATIC|)METHOD\s+([^{]+?)\s*{\s*//i;
 265          $static = $1;
 266          @ret = split m/\s+/, $2;
 267          $name = pop @ret;          # last element is name of method
 268          $ret = join(" ", @ret);    # return type
 269
 270          warn "Method: name=$name return type=$ret"
 271             if $debug;
 272
 273          if ( !$name or !$ret ) {
 274             warn $line
 275                if $debug;
 276             warn "$src:$lineno: Invalid method specification";
 277             $error = 1;
 278             last LINE;
 279          }
 280
 281          unless ( $name =~ m/^[a-z_][a-z_0-9]*$/ ) {
 282             warn $line
 283                if $debug;
 284             warn "$src:$lineno: Invalid method name '$name', use [a-z_][a-z0-9_]*";
 285             $error = 1;
 286             last LINE;
 287          }
 288
 289          if ( defined($methods{$name}) ) {
 290             warn "$src:$lineno: Duplicate method name";
 291             $error = 1;
 292             last LINE;
 293          }
 294
 295          $methods{$name} = 'VIS';
 296
 297          while ( $line !~ m/}/ and $line .= <SRC> ) {
 298             $lineno++
 299          }
 300
 301          $default = "";
 302          if ( $line !~ s/};?(.*)// ) { # remove first '}' and trailing garbage
 303             # The '}' was not there (the rest is optional), so complain
 304             warn "$src:$lineno: Premature end of file";
 305             $error = 1;
 306             last LINE;
 307          }
 308          $extra = $1;
 309          if ( $extra =~ /\s*DEFAULT\s*([a-zA-Z_][a-zA-Z_0-9]*)\s*;/ ) {
 310             $default = $1;
 311          } else {
 312             warn "$src:$lineno: Ignored '$1'"  # warn about garbage at end of line
 313                if $debug and $1;
 314          }
 315
 316          # Create a list of variables without the types prepended
 317          #
 318          $line =~ s/^\s+//;            # remove leading ...
 319          $line =~ s/\s+$//;            # ... and trailing whitespace
 320          $line =~ s/\s+/ /g;           # remove double spaces
 321
 322          @arguments = split m/\s*;\s*/, $line;
 323          @varnames = ();               # list of varnames
 324          foreach $argument (@arguments) {
 325             next                       # skip argument if argument is empty
 326                if !$argument;
 327
 328             @ar = split m/[*\s]+/, $argument;
 329             if ( $#ar == 0 ) {         # only 1 word in argument?
 330                warn "$src:$lineno: no type for '$argument'";
 331                $error = 1;
 332                last LINE;
 333             }
 334
 335             push @varnames, $ar[-1];   # last element is name of variable
 336          };
 337
 338          warn 'Arguments: ' . join(', ', @arguments) . "\n"
 339             . 'Varnames: ' . join(', ', @varnames)
 340             if $debug;
 341
 342          $mname = $intname.'_'.$name;  # method name
 343          $umname = uc($mname);         # uppercase method name
 344
 345          $arguments = join(", ", @arguments);
 346          $varnames = join(", ", @varnames);
 347
 348          $default = "0" if $default eq "";
 349
 350          if ( $hfile ) {
 351             # the method description
 352             print HFILE "extern struct device_op_desc $mname\_desc;\n";
 353             # the method typedef
 354             print HFILE &format_line("typedef $ret $mname\_t($arguments);",
 355                               $line_width, ', ',
 356                               ',',' ' x length("typedef $ret $mname\_t("))
 357                       . "\n";
 358             # the method declaration
 359             print HFILE "$mname\_t $umname;\n\n";
 360          }
 361
 362          if ( $cfile ) {
 363             # Print out the method desc
 364             print CFILE "struct device_op_desc $mname\_desc = {\n";
 365             print CFILE "\t0, 0, (devop_t) $default, \"$mname\"\n";
 366             print CFILE "};\n\n";
 367
 368             # Print out the method itself
 369             if ( 0 ) {                 # haven't chosen the format yet
 370                print CFILE "$ret $umname($varnames)\n";
 371                print CFILE "\t".join(";\n\t", @arguments).";\n";
 372             } else {
 373                print CFILE &format_line("$ret $umname($arguments)",
 374                               $line_width, ', ',
 375                               ',', ' ' x length("$ret $umname(")) . "\n";
 376             }
 377             print CFILE "{\n";
 378             if ($static) {
 379               print CFILE &format_line("\t$mname\_t *m = ($mname\_t *) DRVOPMETH(driver, $mname);",
 380                                        $line_width-8, ' = ', ' =', "\t\t")
 381                 . "\n";
 382             } else {
 383               print CFILE &format_line("\t$mname\_t *m = ($mname\_t *) DEVOPMETH(dev, $mname);",
 384                                        $line_width-8, ' = ', ' =', "\t\t")
 385                 . "\n";
 386             }
 387             print CFILE "\t".($ret eq 'void'? '':'return ') . "m($varnames);\n";
 388             print CFILE "}\n\n";
 389          }
 390       } else {
 391          warn $line
 392             if $debug;
 393          warn "$src:$lineno: Invalid line encountered";
 394          $error = 1;
 395          last LINE;
 396       }
 397    } # end LINE
 398
 399    # print the final '#endif' in the header file
 400    #
 401    print HFILE "#endif /* _".$intname."_if_h_ */\n"
 402       if $hfile;
 403
 404    close SRC;
 405    close CFILE
 406       if $cfile;
 407    close HFILE
 408       if $hfile;
 409
 410    if ( !$error ) {
 411       if ( $cfile ) {
 412          ($rc = system("mv $ctmpname $cfilename"))
 413             and warn "mv $ctmpname $cfilename failed, $rc";
 414       }
 415
 416       if ( $hfile ) {
 417          ($rc = system("mv $htmpname $hfilename"))
 418             and warn "mv $htmpname $hfilename failed, $rc";
 419       }
 420    } else {
 421       warn 'Output skipped';
 422       ($rc = system("rm -f $htmpname $ctmpname"))
 423          and warn "rm -f $htmpname $ctmpname failed, $rc";
 424       $gerror = 1;
 425    }
 426 }
 427
 428 exit $gerror;
 429
 430
 431 sub format_line {
 432    my ($line, $maxlength, $break, $new_end, $new_start) = @_;
 433    my $rline = "";
 434
 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));
 439    }
 440
 441    return $rline . $line;
 442 }
 443
 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
 447
 448 sub fileparse {
 449    my ($filename, @suffix) = @_;
 450    my ($dir, $name, $type, $i);
 451
 452    $type = '';
 453    foreach $i (@suffix) {
 454       if ($filename =~ m|$i$|) {
 455          $filename =~ s|$i$||;
 456          $type = $i;
 457       }
 458    }
 459    if ($filename =~ m|/|) {
 460       $filename =~ m|([^/]*)$|;
 461       $name = $1;
 462       $dir = $filename;
 463       $dir =~ s|$name$||;
 464    }
 465    else {
 466       $dir = '';
 467       $name = $filename;
 468    }
 469    ($name, $dir, $type);
 470 }