HardenedBSD/sys/tools/vnode_if.awk
2002-01-04 05:27:47 +00:00

356 lines
8.9 KiB
Awk

#!/usr/bin/perl -w
#
# Copyright (c) 1992, 1993
# The Regents of the University of California. All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
# 1. Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
# 2. Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution.
# 3. All advertising materials mentioning features or use of this software
# must display the following acknowledgement:
# This product includes software developed by the University of
# California, Berkeley and its contributors.
# 4. Neither the name of the University nor the names of its contributors
# may be used to endorse or promote products derived from this software
# without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
# SUCH DAMAGE.
#
# @(#)vnode_if.sh 8.1 (Berkeley) 6/10/93
# $FreeBSD$
#
# Script to produce VFS front-end sugar.
#
# usage: vnode_if.pl srcfile
# (where srcfile is currently /sys/kern/vnode_if.src)
#
use strict;
my %lockdata;
my $cfile = 0;
my $hfile = 0;
my $srcfile;
# Process the command line
#
while (my $arg = shift @ARGV) {
if ($arg eq '-c') {
$cfile = 1;
} elsif ($arg eq '-h') {
$hfile = 1;
} elsif ($arg eq '-ch' || $arg eq '-hc') {
$cfile = 1;
$hfile = 1;
} elsif ($arg =~ m/\.src$/) {
$srcfile = $arg;
} else {
print "usage: vnode_if.pl [-c] [-h] srcfile\n";
exit(1);
}
}
if (!$cfile and !$hfile) {
exit(0); # nothing asked for..
}
# Names of the created files.
my $CFILE='vnode_if.c';
my $HEADER='vnode_if.h';
open(SRC, "<$srcfile") || die "Unable to open input file";
if ($hfile) {
open(HEADER, ">$HEADER") || die "Unable to create $HEADER";
# Print out header information for vnode_if.h.
print HEADER <<'END_OF_LEADING_COMMENT'
/*
* This file is produced automatically.
* Do not modify anything in here by hand.
*
* Created from $FreeBSD$
*/
extern struct vnodeop_desc vop_default_desc;
END_OF_LEADING_COMMENT
;
}
if ($cfile) {
open(CFILE, ">$CFILE") || die "Unable to create $CFILE";
# Print out header information for vnode_if.c.
print CFILE <<'END_OF_LEADING_COMMENT'
/*
* This file is produced automatically.
* Do not modify anything in here by hand.
*
* Created from $FreeBSD$
*/
#include <sys/param.h>
#include <sys/vnode.h>
struct vnodeop_desc vop_default_desc = {
1, /* special case, vop_default => 1 */
"default",
0,
NULL,
VDESC_NO_OFFSET,
VDESC_NO_OFFSET,
VDESC_NO_OFFSET,
VDESC_NO_OFFSET,
NULL,
};
END_OF_LEADING_COMMENT
;
}
my %a;
my %dirs;
my %reles;
my %types;
my %args;
my $numargs;
my $name;
line: while (<SRC>) {
chop; # strip record separator
my @Fld = split ' ';
if (@Fld == 0) {
next line;
}
if (/^#/) {
if (!/^#%\s+([a-z]+)\s+([a-z]+)\s+(.)\s(.)\s(.)/) {
next;
}
if (!defined($lockdata{"vop_$1"})) {
$lockdata{"vop_$1"} = {};
}
$lockdata{"vop_$1"}->{$2} = {
'Entry' => $3,
'OK' => $4,
'Error' => $5,
};
next;
}
# Get the function name.
$name = $Fld[0];
my $uname = uc($name);
my $ln;
# Get the function arguments.
for ($numargs = 0; ; ++$numargs) {
if ($ln = <SRC>) {
chomp;
} else {
die "Unable to read through the arguments for \"$name\"";
}
if ($ln =~ /^\};/) {
last;
}
# For the header file
$a{$numargs} = $ln;
# The rest of this loop is for the C file
# Delete comments, if any.
$ln =~ s/\/\*.*\*\///g;
# Delete leading/trailing space.
$ln =~ s/^\s*(.*?)\s*$/$1/;
# Pick off direction.
my $dir;
if ($ln =~ s/^INOUT\s+//) {
$dir = 'INOUT';
} elsif ($ln =~ s/^IN\s+//) {
$dir = 'IN';
} elsif ($ln =~ s/^OUT\s+//) {
$dir = 'OUT';
} else {
die "No IN/OUT direction for \"$ln\".";
}
my $rele;
if ($ln =~ s/^WILLRELE\s+//) {
$rele = 'WILLRELE';
} else {
$rele = 'WONTRELE';
}
# kill trailing ;
if ($ln !~ s/;$//) {
die("Missing end-of-line ; in \"$ln\".");
}
# pick off variable name
if ($ln !~ s/([A-Za-z0-9_]+)$//) {
die("Missing var name \"a_foo\" in \"$ln\".");
}
my $arg = $1;
# what is left must be type
# (put clean it up some)
my $type = $ln;
# condense whitespace
$type =~ s/\s+/ /g;
$type =~ s/^\s*(.*?)\s*$/$1/;
$dirs{$numargs} = $dir;
$reles{$numargs} = $rele;
$types{$numargs} = $type;
$args{$numargs} = $arg;
}
if ($hfile) {
# Print out the vop_F_args structure.
print HEADER "struct ${name}_args {\n\tstruct vnodeop_desc *a_desc;\n";
for (my $c2 = 0; $c2 < $numargs; ++$c2) {
$a{$c2} =~ /^\s*(INOUT|OUT|IN)(\s+WILLRELE)?\s+(.*?)\s+(\**)(\S*\;)/;
print HEADER "\t$3 $4a_$5\n",
}
print HEADER "};\n";
# Print out extern declaration.
print HEADER "extern struct vnodeop_desc ${name}_desc;\n";
# Print out function.
print HEADER "static __inline int ${uname}(\n";
for (my $c2 = 0; $c2 < $numargs; ++$c2) {
$a{$c2} =~ /^\s*(INOUT|OUT|IN)(\s+WILLRELE)?\s+(.*?)\s+(\**\S*)\;/;
print HEADER "\t$3 $4" .
($c2 < $numargs-1 ? "," : ")") . "\n";
}
print HEADER "{\n\tstruct ${name}_args a;\n";
print HEADER "\tint rc;\n";
print HEADER "\ta.a_desc = VDESC(${name});\n";
for (my $c2 = 0; $c2 < $numargs; ++$c2) {
$a{$c2} =~ /(\**)([^;\s]*)([^\s]*)$/;
print HEADER "\ta.a_$2 = $2$3\n",
}
for (my $c2 = 0; $c2 < $numargs; ++$c2) {
if (!exists($args{$c2})) {
die "Internal error";
}
if (exists($lockdata{$name}) &&
exists($lockdata{$name}->{$args{$c2}})) {
if (defined($ENV{'DEBUG_ALL_VFS_LOCKS'}) &&
$ENV{'DEBUG_ALL_VFS_LOCKS'} =~ /yes/i) {
# Add assertions for locking
if ($lockdata{$name}->{$args{$c2}}->{Entry} eq "L") {
print HEADER
"\tASSERT_VOP_LOCKED($args{$c2}, \"$uname\");\n";
} elsif ($lockdata{$name}->{$args{$c2}}->{Entry} eq "U") {
print HEADER
"\tASSERT_VOP_UNLOCKED($args{$c2}, \"$uname\");\n";
} elsif (0) {
# XXX More checks!
}
}
}
}
$a{0} =~ /\s\**([^;\s]*);/;
print HEADER "\trc = VCALL($1, VOFFSET(${name}), &a);\n";
print HEADER "\treturn (rc);\n";
print HEADER "}\n";
}
if ($cfile) {
# Print out the vop_F_vp_offsets structure. This all depends
# on naming conventions and nothing else.
printf CFILE "static int %s_vp_offsets[] = {\n", $name;
# as a side effect, figure out the releflags
my $releflags = '';
my $vpnum = 0;
for (my $i = 0; $i < $numargs; $i++) {
if ($types{$i} eq 'struct vnode *') {
printf CFILE "\tVOPARG_OFFSETOF(struct %s_args,a_%s),\n",
$name, $args{$i};
if ($reles{$i} eq 'WILLRELE') {
$releflags = $releflags . '|VDESC_VP' . $vpnum . '_WILLRELE';
}
$vpnum++;
}
}
$releflags =~ s/^\|//;
print CFILE "\tVDESC_NO_OFFSET\n";
print CFILE "};\n";
# Print out the vnodeop_desc structure.
print CFILE "struct vnodeop_desc ${name}_desc = {\n";
# offset
print CFILE "\t0,\n";
# printable name
printf CFILE "\t\"%s\",\n", $name;
# flags
my $vppwillrele = '';
for (my $i = 0; $i < $numargs; $i++) {
if ($types{$i} eq 'struct vnode **' &&
($reles{$i} eq 'WILLRELE')) {
$vppwillrele = '|VDESC_VPP_WILLRELE';
}
}
if ($releflags eq '') {
printf CFILE "\t0%s,\n", $vppwillrele;
}
else {
printf CFILE "\t%s%s,\n", $releflags, $vppwillrele;
}
# vp offsets
printf CFILE "\t%s_vp_offsets,\n", $name;
# vpp (if any)
printf CFILE "\t%s,\n", &find_arg_with_type('struct vnode **');
# cred (if any)
printf CFILE "\t%s,\n", &find_arg_with_type('struct ucred *');
# thread (if any)
printf CFILE "\t%s,\n", &find_arg_with_type('struct thread *');
# componentname
printf CFILE "\t%s,\n", &find_arg_with_type('struct componentname *');
# transport layer information
print CFILE "\tNULL,\n};\n\n";
}
}
if ($hfile) {
close(HEADER) || die "Unable to close $HEADER";
}
if ($cfile) {
close(CFILE) || die "Unable to close $CFILE";
}
close(SRC) || die;
exit 0;
sub find_arg_with_type {
my $type = shift;
my $i;
for ($i=0; $i < $numargs; $i++) {
if ($types{$i} eq $type) {
return "VOPARG_OFFSETOF(struct ${name}_args,a_" . $args{$i} . ")";
}
}
return "VDESC_NO_OFFSET";
}