#!/bin/sh -
copyright="\
/*
* Copyright (c) 1992, 1993, 1994, 1995
* 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. 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.
*/
"
SCRIPT_ID='$NetBSD: vnode_if.sh,v 1.77 2022/10/26 23:39:43 riastradh Exp $'
# Script to produce VFS front-end sugar.
#
# usage: vnode_if.sh srcfile
# (where srcfile is currently /sys/kern/vnode_if.src)
#
if [ $# -ne 1 ] ; then
echo 'usage: vnode_if.sh srcfile'
exit 1
fi
# Name and revision of the source file.
src=$1
SRC_ID=`head -1 $src | sed -e 's/.*\$\(.*\)\$.*/\1/'`
# Names of the created files.
out_c=vnode_if.c
out_rumpc=../rump/librump/rumpvfs/rumpvnode_if.c
out_h=../sys/vnode_if.h
out_rumph=../rump/include/rump/rumpvnode_if.h
# Awk program (must support nawk extensions)
# Use "awk" at Berkeley, "nawk" or "gawk" elsewhere.
awk=${AWK:-awk}
# Does this awk have a "toupper" function? (i.e. is it GNU awk)
isgawk=`$awk 'BEGIN { print toupper("true"); exit; }' 2>/dev/null`
# If this awk does not define "toupper" then define our own.
if [ "$isgawk" = TRUE ] ; then
# GNU awk provides it.
toupper=
else
# Provide our own toupper()
toupper='
function toupper(str) {
_toupper_cmd = "echo "str" |tr a-z A-Z"
_toupper_cmd | getline _toupper_str;
close(_toupper_cmd);
return _toupper_str;
}'
fi
#
# This is the common part of all awk programs that read $src
# This parses the input for one function into the arrays:
# argdir, argtype, argname, willrele
# and calls "doit()" to generate output for the function.
#
# Input to this parser is pre-processed slightly by sed
# so this awk parser doesn't have to work so hard. The
# changes done by the sed pre-processing step are:
# insert a space between * and pointer name
# replace semicolons with spaces
#
sed_prep='s:\*\([^\*/]\):\* \1:g
s/;/ /'
awk_parser='
# Comment line
/^#/ { next; }
# First line of description
/^vop_/ {
name=$1;
args_name=$1;
argc=0;
have_context=0;
is_context=0;
ncontext=0;
willmake=-1;
fstrans="";
do_pre="";
do_post="";
next;
}
# Last line of description
/^}/ {
doit();
next;
}
# Middle lines of description
{
if ($1 == "VERSION") {
args_name=args_name "_v" $2;
next;
} else if ($1 ~ "^FSTRANS=") {
fstrans = $1;
sub("FSTRANS=", "", fstrans);
next;
} else if ($1 ~ "^PRE=") {
do_pre = $1;
sub("PRE=", "", do_pre);
next;
} else if ($1 ~ "^POST=") {
do_post = $1;
sub("POST=", "", do_post);
next;
}
if ($1 == "CONTEXT") {
# CONTEXT require PRE and POST handlers.
if (do_pre == "" || do_post == "")
next;
is_context=1;
have_context=1;
} else {
if (have_context) {
# CONTEXT members must come at the end of
# the args structure, so everything else
# is ignored.
next;
}
argdir[argc] = $1;
}
i=2;
# XXX: replace non-portable types for rump. We should really
# nuke the types from the kernel, but that is a battle for
# another day.
at = $i;
if (rump) {
if (at == "vm_prot_t")
at = "int";
if (at == "voff_t")
at = "off_t";
if (at == "kauth_cred_t")
at = "struct kauth_cred *"
if (at == "daddr_t")
at = "int64_t"
}
argtype[argc + ncontext] = at;
i++;
while (i < NF) {
argtype[argc + ncontext] = argtype[argc + ncontext]" "$i;
i++;
}
argname[argc + ncontext] = $i;
if (is_context)
ncontext++;
else
argc++;
next;
}
'
# This is put before the copyright on each generated file.
warning="\
/* @NetBSD@ */
/*
* Warning: DO NOT EDIT! This file is automatically generated!
* (Modifications made here may easily be lost!)
*
* Created from the file:
* ${SRC_ID}
* by the script:
* ${SCRIPT_ID}
*/
"
# This is to satisfy McKusick (get rid of evil spaces 8^)
anal_retentive='s:\([^/]\*\) :\1:g'
do_hfile () {
#
# Redirect stdout to the H file.
#
echo "$0: Creating $1" 1>&2
exec > $1
rump=$2
# Begin stuff
if [ -z "${rump}" ]; then
SYS='SYS_'
else
SYS='RUMP_RUMP'
fi
echo -n "$warning" | sed -e 's/\$//g;s/@/\$/g;s/ $//'
echo ""
echo -n "$copyright"
echo ''
echo "#ifndef _${SYS}VNODE_IF_H_"
echo "#define _${SYS}VNODE_IF_H_"
[ -z "${rump}" ] && echo "
extern const struct vnodeop_desc ${rump}vop_default_desc;"
echo
# Body stuff
# This awk program needs toupper() so define it if necessary.
sed -e "$sed_prep" $src | $awk -v rump=${rump} "$toupper"'
function doit() {
name = rump name
# Declare arg struct, descriptor.
if (!rump) {
printf("\n#define %s_DESCOFFSET %d\n",
toupper(name), vop_offset++);
printf("struct %s_args {\n", args_name);
printf("\tconst struct vnodeop_desc * a_desc;\n");
for (i=0; i<argc; i++) {
printf("\t%s a_%s;\n", argtype[i], argname[i]);
}
for (i=0; i<ncontext; i++) {
printf("\t%s ctx_%s;\n", argtype[argc+i], \
argname[argc+i]);
}
printf("};\n");
printf("extern const struct vnodeop_desc %s_desc;\n", name);
}
# Prototype it.
protoarg = sprintf("int %s(", toupper(name));
protolen = length(protoarg);
printf("%s", protoarg);
for (i=0; i<argc; i++) {
protoarg = sprintf("%s", argtype[i]);
if (i < (argc-1)) protoarg = (protoarg ", ");
arglen = length(protoarg);
if ((protolen + arglen) > 77) {
protoarg = ("\n " protoarg);
arglen += 4;
protolen = 0;
}
printf("%s", protoarg);
protolen += arglen;
}
printf(");\n");
}
BEGIN {
vop_offset = 1; # start at 1, to count the 'default' op
printf("struct buf;\n");
if (rump) {
printf("struct flock;\n");
printf("struct knote;\n");
printf("struct vm_page;\n");
printf("struct acl;\n");
printf("\n#include <sys/acl.h>\n");
}
printf("\n#ifndef _KERNEL\n#include <stdbool.h>\n#endif\n");
if (rump)
printf("\n");
}
END {
if (!rump) {
printf("\n#define VNODE_OPS_COUNT\t%d\n", vop_offset);
}
}
'"$awk_parser" | sed -e "$anal_retentive"
/*
* VOP_RMDIR(), VOP_REMOVE(), and VOP_RENAME() need special handling
* because they each drop the caller's references on one or more of
* their arguments. While there must be an open file descriptor in
* associated with a vnode in order for knotes to be attached to it,
* that status could change during the course of the operation. So,
* for the vnode arguments that are WILLRELE or WILLPUT, we check
* pre-op if there are registered knotes, take a hold count if so,
* and post-op release the hold after activating any knotes still
* associated with the vnode.
*/
#define VOP_POST_KNOTE(thisvp, e, n) \\
do { \\
if (__predict_true((e) == 0)) { \\
/* \\
* VN_KNOTE() does the VN_KEVENT_INTEREST() \\
* check for us. \\
*/ \\
VN_KNOTE((thisvp), (n)); \\
} \\
} while (/*CONSTCOND*/0)
#define VOP_POST_KNOTE_HELD(thisvp, e, n) \\
do { \\
/* \\
* We don't perform a VN_KEVENT_INTEREST() check here; it \\
* was already performed when we did the pre-op work that \\
* caused the vnode to be held in the first place. \\
*/ \\
mutex_enter((thisvp)->v_interlock); \\
if (__predict_true((e) == 0)) { \\
knote(&(thisvp)->v_klist->vk_klist, (n)); \\
} \\
holdrelel((thisvp)); \\
mutex_exit((thisvp)->v_interlock); \\
/* \\
* thisvp might be gone now! Don't touch! \\
*/ \\
} while (/*CONSTCOND*/0)
#define vop_remove_post_common(ap, e, dn, lc) \\
do { \\
VOP_POST_KNOTE((ap)->a_dvp, (e), (dn)); \\
if (__predict_false(post_event_vp)) { \\
VOP_POST_KNOTE_HELD((ap)->a_vp, (e), \\
(lc) ? NOTE_LINK : NOTE_DELETE); \\
} \\
} while (/*CONSTCOND*/0)
/*
* One could make the argument that VOP_REMOVE() should send NOTE_LINK
* on vp if the resulting link count is not zero, but that's not what
* the documentation says.
*
* We could change this easily by passing ap->ctx_vp_new_nlink to
* vop_remove_post_common().
*/
#define vop_remove_pre(ap) \\
vop_remove_pre_common((ap)); \\
/* \\
* We will assume that the file being removed is deleted unless \\
* the file system tells us otherwise by updating vp_new_nlink. \\
*/ \\
(ap)->ctx_vp_new_nlink = 0;
#define vop_close_post(ap, e) \\
do { \\
/* See the definition of VN_KNOTE() in <sys/vnode.h>. */ \\
if (__predict_false(VN_KEVENT_INTEREST((ap)->a_vp, \\
NOTE_CLOSE_WRITE | NOTE_CLOSE) && (e) == 0)) { \\
struct vnode *thisvp = (ap)->a_vp; \\
mutex_enter(thisvp->v_interlock); \\
/* \\
* Don't send NOTE_CLOSE when closing a vnode that's \\
* been reclaimed or otherwise revoked; a NOTE_REVOKE \\
* has already been sent, and this close is effectively \\
* meaningless from the watcher's perspective. \\
*/ \\
if (__predict_true(thisvp->v_op != dead_vnodeop_p)) { \\
knote(&thisvp->v_klist->vk_klist, \\
((ap)->a_fflag & FWRITE) \\
? NOTE_CLOSE_WRITE : NOTE_CLOSE); \\
} \\
mutex_exit(thisvp->v_interlock); \\
} \\
} while (/*CONSTCOND*/0)
#define vop_write_post(ap, e) \\
do { \\
/* \\
* If any data was written, we'll post an event, even if \\
* there was an error. \\
*/ \\
noffset = (ap)->a_uio->uio_offset; \\
if (__predict_false(vp_events != 0 && noffset > ooffset)) { \\
if (noffset > osize) { \\
vp_events |= NOTE_EXTEND; \\
} \\
VN_KNOTE((ap)->a_vp, vp_events); \\
} \\
} while (/*CONSTCOND*/0)
function bodyrump() {
printf("{\n\tint error;\n\n");
printf("\trump_schedule();\n");
printf("\terror = %s(", toupper(name));
for (i=0; i<argc; i++) {
printf("%s", argname[i]);
if (i < (argc-1)) printf(", ");
}
printf(");\n");
printf("\trump_unschedule();\n\n");
printf("\treturn error;\n}\n");
}
function bodynorm() {
printf("{\n\tint error;\n\tbool mpsafe;\n\tstruct %s_args a;\n",
args_name);
printf("\tstruct mount *mp;\n");
printf("\ta.a_desc = VDESC(%s);\n", name);
for (i=0; i<argc; i++) {
printf("\ta.a_%s = %s;\n", argname[i], argname[i]);
}
if (lockdebug) {
for (i=0; i<argc; i++) {
if (lockstate[i] == "")
continue;
printf("\tassert_vop_%s(%s, \"%s: %s\");\n",
lockstate[i], argname[i], name, argname[i]);
}
}
# This is done before generic vop_pre() because we want
# to do any setup before beginning an fstrans.
if (do_pre != "")
printf("\t%s(&a);\n", do_pre);
if (fstrans == "LOCK")
printf("\terror = vop_pre(%s, &mp, &mpsafe, %s);\n",
argname[0], "(!(flags & (LK_SHARED|LK_EXCLUSIVE)) ? FST_NO : (flags & LK_NOWAIT ? FST_TRY : FST_YES))");
else if (fstrans == "UNLOCK")
printf("\terror = vop_pre(%s, &mp, &mpsafe, FST_%s);\n",
argname[0], "NO");
else
printf("\terror = vop_pre(%s, &mp, &mpsafe, FST_%s);\n",
argname[0], fstrans);
printf("\tif (error)\n\t\treturn error;\n");
printf("\terror = (VCALL(%s, VOFFSET(%s), &a));\n",
argname[0], name);
if (fstrans == "LOCK")
printf("\tvop_post(%s, mp, mpsafe, %s);\n",
argname[0], "(flags & (LK_UPGRADE|LK_DOWNGRADE) ? FST_NO : (error ? FST_YES : FST_NO))");
else if (fstrans == "UNLOCK")
printf("\tvop_post(%s, mp, mpsafe, FST_%s);\n",
argname[0], "YES");
else
printf("\tvop_post(%s, mp, mpsafe, FST_%s);\n",
argname[0], fstrans);
# This is done after generic vop_post() in order to minimize
# time spent with the KERNEL_LOCK held for file systems that
# still require it.
if (do_post != "")
printf("\t%s(&a, error);\n", do_post);
if (willmake != -1) {
printf("#ifdef DIAGNOSTIC\n");
printf("\tif (error == 0)\n" \
"\t\tKASSERT((*%s)->v_size != VSIZENOTSET\n" \
"\t\t && (*%s)->v_writesize != VSIZENOTSET);\n",
argname[willmake], argname[willmake]);
printf("#endif /* DIAGNOSTIC */\n");
}
printf("\treturn error;\n}\n");
}
function doit() {
printf("\n");
if (!rump)
offsets();
if (rump)
extname = "RUMP_" toupper(name);
else
extname = toupper(name);
# Define function.
printf("int\n%s(", extname);
for (i=0; i<argc; i++) {
printf("%s %s", argtype[i], argname[i]);
if (i < (argc-1)) printf(",\n ");
}
printf(")\n");
if (rump)
bodyrump();
else
bodynorm();
}
BEGIN {
# start from 1 (vop_default is at 0)
argc=1;
}
'"$awk_parser" | sed -e "$anal_retentive"
# End stuff
[ -n "${rump}" ] && return
# Add the vfs_op_descs array to the C file.
# Begin stuff
echo "
const struct vnodeop_desc * const ${rump}vfs_op_descs[] = {
&${rump}vop_default_desc, /* MUST BE FIRST */
"
# Body stuff
sed -e "$sed_prep" $src | $awk -v rump=${rump} '
function doit() {
printf("\t&%s_desc,\n", name);
}
'"$awk_parser"