bsd/vfs/vnode_if.sh

   1 #!/bin/sh -
   2 copyright='
   3 /*
   4  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
   5  *
   6  * @APPLE_LICENSE_HEADER_START@
   7  *
   8  * The contents of this file constitute Original Code as defined in and
   9  * are subject to the Apple Public Source License Version 1.1 (the
  10  * "License").  You may not use this file except in compliance with the
  11  * License.  Please obtain a copy of the License at
  12  * http://www.apple.com/publicsource and read it before using this file.
  13  *
  14  * This Original Code and all software distributed under the License are
  15  * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  16  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  17  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
  19  * License for the specific language governing rights and limitations
  20  * under the License.
  21  *
  22  * @APPLE_LICENSE_HEADER_END@
  23  */
  24 /*
  25  * Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved
  26  * Copyright (c) 1992, 1993, 1994, 1995
  27  *      The Regents of the University of California.  All rights reserved.
  28  *
  29  * Redistribution and use in source and binary forms, with or without
  30  * modification, are permitted provided that the following conditions
  31  * are met:
  32  * 1. Redistributions of source code must retain the above copyright
  33  *    notice, this list of conditions and the following disclaimer.
  34  * 2. Redistributions in binary form must reproduce the above copyright
  35  *    notice, this list of conditions and the following disclaimer in the
  36  *    documentation and/or other materials provided with the distribution.
  37  * 3. All advertising materials mentioning features or use of this software
  38  *    must display the following acknowledgement:
  39  *      This product includes software developed by the University of
  40  *      California, Berkeley and its contributors.
  41  * 4. Neither the name of the University nor the names of its contributors
  42  *    may be used to endorse or promote products derived from this software
  43  *    without specific prior written permission.
  44  *
  45  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  46  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  47  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  48  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  49  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  50  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  51  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  52  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  53  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  54  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  55  * SUCH DAMAGE.
  56  */
  57 '
  58 SCRIPT_ID='@(#)vnode_if.sh      8.7 (Berkeley) 5/11/95'
  59
  60 # Script to produce VFS front-end sugar.
  61 #
  62 # usage: vnode_if.sh srcfile
  63 #       (where srcfile is currently bsd/vfs/vnode_if.src)
  64 #
  65
  66 if [ $# -ne 1 ] ; then
  67         echo 'usage: vnode_if.sh srcfile'
  68         exit 1
  69 fi
  70
  71 # Name of the source file.
  72 src=$1
  73
  74 # Names of the created files.
  75 out_c=vnode_if.c
  76 out_h=vnode_if.h
  77
  78 # Awk program (must support nawk extensions)
  79 # Use "awk" at Berkeley, "nawk" or "gawk" elsewhere.
  80 awk=${AWK:-awk}
  81 #awk=${AWK:-gawk}
  82
  83 # Does this awk have a "toupper" function? (i.e. is it GNU awk)
  84 isgawk=`$awk 'BEGIN { print toupper("true"); exit; }' 2>/dev/null`
  85
  86 # If this awk does not define "toupper" then define our own.
  87 if [ "$isgawk" = TRUE ] ; then
  88         # GNU awk provides it.
  89         toupper=
  90 else
  91         # Provide our own toupper()
  92         toupper='
  93 function toupper(str) {
  94         _toupper_cmd = "echo "str" |tr a-z A-Z"
  95         _toupper_cmd | getline _toupper_str;
  96         close(_toupper_cmd);
  97         return _toupper_str;
  98 }'
  99 fi
 100
 101 #
 102 # This is the common part of all awk programs that read $src
 103 # This parses the input for one function into the arrays:
 104 #       argdir, argtype, argname, willrele
 105 # and calls "doit()" to generate output for the function.
 106 #
 107 # Input to this parser is pre-processed slightly by sed
 108 # so this awk parser doesn't have to work so hard.  The
 109 # changes done by the sed pre-processing step are:
 110 #       insert a space beween * and pointer name
 111 #       replace semicolons with spaces
 112 #
 113 sed_prep='s:\*\([^\*/]\):\* \1:g
 114 s/;/ /'
 115 awk_parser='
 116 # Comment line
 117 /^#/    { next; }
 118 # First line of description
 119 /^vop_/ {
 120         name=$1;
 121         argc=0;
 122         ubc=$3;
 123         next;
 124 }
 125 # Last line of description
 126 /^}/    {
 127         doit();
 128         next;
 129 }
 130 # Middle lines of description
 131 {
 132         argdir[argc] = $1; i=2;
 133         if ($2 == "WILLRELE") {
 134                 willrele[argc] = 1;
 135                 i++;
 136         } else
 137                 willrele[argc] = 0;
 138         argtype[argc] = $i; i++;
 139         while (i < NF) {
 140                 argtype[argc] = argtype[argc]" "$i;
 141                 i++;
 142         }
 143         argname[argc] = $i;
 144         argc++;
 145         next;
 146 }
 147 '
 148
 149 # This is put after the copyright on each generated file.
 150 warning="
 151 /*
 152  * Warning: This file is generated automatically.
 153  * (Modifications made here may easily be lost!)
 154  *
 155  * Created by the script:
 156  *      ${SCRIPT_ID}
 157  */
 158 "
 159
 160 # Get rid of ugly spaces
 161 space_elim='s:\([^/]\*\) :\1:g'
 162
 163 #
 164 # Redirect stdout to the H file.
 165 #
 166 echo "$0: Creating $out_h" 1>&2
 167 exec > $out_h
 168
 169 # Begin stuff
 170 echo "$copyright"
 171 echo "$warning"
 172 echo '
 173 #ifndef _VNODE_IF_H_
 174 #define _VNODE_IF_H_
 175
 176 extern struct vnodeop_desc vop_default_desc;
 177 '
 178
 179 # Body stuff
 180 # This awk program needs toupper() so define it if necessary.
 181 sed -e "$sed_prep" $src | $awk "$toupper"'
 182 function doit() {
 183         # Declare arg struct, descriptor.
 184         printf("\nstruct %s_args {\n", name);
 185         printf("\tstruct vnodeop_desc * a_desc;\n");
 186         for (i=0; i<argc; i++) {
 187                 printf("\t%s a_%s;\n", argtype[i], argname[i]);
 188         }
 189         printf("};\n");
 190         printf("extern struct vnodeop_desc %s_desc;\n", name);
 191         # Define inline function.
 192         printf("#define %s(", toupper(name));
 193         for (i=0; i<argc; i++) {
 194                 printf("%s", argname[i]);
 195                 if (i < (argc-1)) printf(", ");
 196         }
 197         printf(") _%s(", toupper(name));
 198         for (i=0; i<argc; i++) {
 199                 printf("%s", argname[i]);
 200                 if (i < (argc-1)) printf(", ");
 201         }
 202         printf(")\n");
 203         printf("static __inline int _%s(", toupper(name));
 204         for (i=0; i<argc; i++) {
 205                 # generate ANSI protoypes now, hurrah!
 206                 printf("%s %s", argtype[i], argname[i]);
 207                 if (i < (argc-1)) printf(", ");
 208         }
 209         printf(")\n");
 210         printf("{\n\tstruct %s_args a;\n", name);
 211         printf("\ta.a_desc = VDESC(%s);\n", name);
 212         for (i=0; i<argc; i++) {
 213                 printf("\ta.a_%s = %s;\n", argname[i], argname[i]);
 214         }
 215         if (toupper(ubc) == "UBC") {
 216                 printf("\t{\n\t\tint _err;\n\t\t"   \
 217                         "extern int ubc_hold();\n\t\textern void ubc_rele();\n\t\t"     \
 218                         "int _didhold = ubc_hold(%s);\n\t\t"  \
 219                         "_err = VCALL(%s%s, VOFFSET(%s), &a);\n\t\t"    \
 220                         "if (_didhold)\n\t\t\tubc_rele(%s);\n\t\t"      \
 221                         "return (_err);\n\t}\n}\n",
 222                         argname[0], argname[0], arg0special, name, argname[0]);
 223         } else {
 224                 printf("\treturn (VCALL(%s%s, VOFFSET(%s), &a));\n}\n",
 225                         argname[0], arg0special, name);
 226         }
 227 }
 228 BEGIN   {
 229         arg0special="";
 230 }
 231 END     {
 232         printf("\n/* Special cases: */\n#include <sys/buf.h>\n#include <sys/vm.h>\n");
 233         argc=1;
 234         argtype[0]="struct buf *";
 235         argname[0]="bp";
 236         arg0special="->b_vp";
 237         name="vop_strategy";
 238         doit();
 239         name="vop_bwrite";
 240         doit();
 241 }
 242 '"$awk_parser" | sed -e "$space_elim"
 243
 244 # End stuff
 245 echo '
 246 /* End of special cases. */
 247
 248 #endif /* !_VNODE_IF_H_ */'
 249
 250 #
 251 # Redirect stdout to the C file.
 252 #
 253 echo "$0: Creating $out_c" 1>&2
 254 exec > $out_c
 255
 256 # Begin stuff
 257 echo "$copyright"
 258 echo "$warning"
 259 echo '
 260 #include <sys/param.h>
 261 #include <sys/mount.h>
 262 #include <sys/vm.h>
 263 #include <sys/vnode.h>
 264
 265 struct vnodeop_desc vop_default_desc = {
 266         0,
 267         "default",
 268         0,
 269         NULL,
 270         VDESC_NO_OFFSET,
 271         VDESC_NO_OFFSET,
 272         VDESC_NO_OFFSET,
 273         VDESC_NO_OFFSET,
 274         NULL,
 275 };
 276 '
 277
 278 # Body stuff
 279 sed -e "$sed_prep" $src | $awk '
 280 function do_offset(typematch) {
 281         for (i=0; i<argc; i++) {
 282                 if (argtype[i] == typematch) {
 283                         printf("\tVOPARG_OFFSETOF(struct %s_args, a_%s),\n",
 284                                 name, argname[i]);
 285                         return i;
 286                 };
 287         };
 288         print "\tVDESC_NO_OFFSET,";
 289         return -1;
 290 }
 291
 292 function doit() {
 293         # Define offsets array
 294         printf("\nint %s_vp_offsets[] = {\n", name);
 295         for (i=0; i<argc; i++) {
 296                 if (argtype[i] == "struct vnode *") {
 297                         printf ("\tVOPARG_OFFSETOF(struct %s_args,a_%s),\n",
 298                                 name, argname[i]);
 299                 }
 300         }
 301         print "\tVDESC_NO_OFFSET";
 302         print "};";
 303         # Define F_desc
 304         printf("struct vnodeop_desc %s_desc = {\n", name);
 305         # offset
 306         printf ("\t0,\n");
 307         # printable name
 308         printf ("\t\"%s\",\n", name);
 309         # flags
 310         printf("\t0");
 311         vpnum = 0;
 312         for (i=0; i<argc; i++) {
 313                 if (willrele[i]) {
 314                         if (argdir[i] ~ /OUT/) {
 315                                 printf(" | VDESC_VPP_WILLRELE");
 316                         } else {
 317                                 printf(" | VDESC_VP%s_WILLRELE", vpnum);
 318                         };
 319                         vpnum++;
 320                 }
 321         }
 322         print ",";
 323         # vp offsets
 324         printf ("\t%s_vp_offsets,\n", name);
 325         # vpp (if any)
 326         do_offset("struct vnode **");
 327         # cred (if any)
 328         do_offset("struct ucred *");
 329         # proc (if any)
 330         do_offset("struct proc *");
 331         # componentname
 332         do_offset("struct componentname *");
 333         # transport layer information
 334         printf ("\tNULL,\n};\n");
 335 }
 336 END     {
 337         printf("\n/* Special cases: */\n");
 338         argc=1;
 339         argdir[0]="IN";
 340         argtype[0]="struct buf *";
 341         argname[0]="bp";
 342         willrele[0]=0;
 343         name="vop_strategy";
 344         doit();
 345         name="vop_bwrite";
 346         doit();
 347 }
 348 '"$awk_parser" | sed -e "$space_elim"
 349
 350 # End stuff
 351 echo '
 352 /* End of special cases. */'
 353
 354 # Add the vfs_op_descs array to the C file.
 355 # Begin stuff
 356 echo '
 357 struct vnodeop_desc *vfs_op_descs[] = {
 358         &vop_default_desc,      /* MUST BE FIRST */
 359         &vop_strategy_desc,     /* XXX: SPECIAL CASE */
 360         &vop_bwrite_desc,       /* XXX: SPECIAL CASE */
 361 '
 362
 363 # Body stuff
 364 sed -e "$sed_prep" $src | $awk '
 365 function doit() {
 366         printf("\t&%s_desc,\n", name);
 367 }
 368 '"$awk_parser"
 369
 370 # End stuff
 371 echo '  NULL
 372 };
 373 '
 374
 375 exit 0
 376
 377 # Local Variables:
 378 # tab-width: 4
 379 # End: