Home | History | Annotate | Line # | Download | only in common
      1 /*	$NetBSD: nfsdport.h,v 1.1.1.2 2016/11/18 07:49:12 pgoyette Exp $	*/
      2 /*-
      3  * Copyright (c) 2009 Rick Macklem, University of Guelph
      4  * 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  *
     15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
     16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
     19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     25  * SUCH DAMAGE.
     26  *
     27  * FreeBSD: head/sys/fs/nfs/nfsdport.h 283635 2015-05-27 22:00:05Z rmacklem
     28  * $NetBSD: nfsdport.h,v 1.1.1.2 2016/11/18 07:49:12 pgoyette Exp $
     29  */
     30 
     31 /*
     32  * These macros handle nfsvattr fields. They look a bit silly here, but
     33  * are quite different for the Darwin port.
     34  */
     35 #define	NFSVNO_ATTRINIT(n)		(VATTR_NULL(&((n)->na_vattr)))
     36 #define	NFSVNO_SETATTRVAL(n, f, v)	((n)->na_##f = (v))
     37 #define	NFSVNO_SETACTIVE(n, f)
     38 #define	NFSVNO_UNSET(n, f)		((n)->na_##f = VNOVAL)
     39 #define	NFSVNO_NOTSETMODE(n)		((n)->na_mode == ((mode_t)VNOVAL))
     40 #define	NFSVNO_ISSETMODE(n)		((n)->na_mode != ((mode_t)VNOVAL))
     41 #define	NFSVNO_NOTSETUID(n)		((n)->na_uid == ((uid_t)VNOVAL))
     42 #define	NFSVNO_ISSETUID(n)		((n)->na_uid != ((uid_t)VNOVAL))
     43 #define	NFSVNO_NOTSETGID(n)		((n)->na_gid == ((gid_t)VNOVAL))
     44 #define	NFSVNO_ISSETGID(n)		((n)->na_gid != ((gid_t)VNOVAL))
     45 #define	NFSVNO_NOTSETSIZE(n)		((n)->na_size == VNOVAL)
     46 #define	NFSVNO_ISSETSIZE(n)		((n)->na_size != VNOVAL)
     47 #define	NFSVNO_NOTSETATIME(n)		((n)->na_atime.tv_sec == VNOVAL)
     48 #define	NFSVNO_ISSETATIME(n)		((n)->na_atime.tv_sec != VNOVAL)
     49 #define	NFSVNO_NOTSETMTIME(n)		((n)->na_mtime.tv_sec == VNOVAL)
     50 #define	NFSVNO_ISSETMTIME(n)		((n)->na_mtime.tv_sec != VNOVAL)
     51 
     52 /*
     53  * This structure acts as a "catch-all" for information that
     54  * needs to be returned by nfsd_fhtovp().
     55  */
     56 struct nfsexstuff {
     57 	int	nes_exflag;			/* export flags */
     58 	int	nes_numsecflavor;		/* # of security flavors */
     59 	int	nes_secflavors[MAXSECFLAVORS];	/* and the flavors */
     60 };
     61 
     62 /*
     63  * These are NO-OPS for BSD until Isilon upstreams EXITCODE support.
     64  * EXITCODE is an in-memory ring buffer that holds the routines failing status.
     65  * This is a valuable tool to use when debugging and analyzing issues.
     66  * In addition to recording a routine's failing status, it offers
     67  * logging of routines for call stack tracing.
     68  * EXITCODE should be used only in routines that return a true errno value, as
     69  * that value will be formatted to a displayable errno string.  Routines that
     70  * return regular int status that are not true errno should not set EXITCODE.
     71  * If you want to log routine tracing, you can add EXITCODE(0) to any routine.
     72  * NFS extended the EXITCODE with EXITCODE2 to record either the routine's
     73  * exit errno status or the nd_repstat.
     74  */
     75 #define	NFSEXITCODE(error)
     76 #define	NFSEXITCODE2(error, nd)
     77 
     78 #define	NFSVNO_EXINIT(e)		((e)->nes_exflag = 0)
     79 #define	NFSVNO_EXPORTED(e)		((e)->nes_exflag & MNT_EXPORTED)
     80 #define	NFSVNO_EXRDONLY(e)		((e)->nes_exflag & MNT_EXRDONLY)
     81 #define	NFSVNO_EXPORTANON(e)		((e)->nes_exflag & MNT_EXPORTANON)
     82 #define	NFSVNO_EXSTRICTACCESS(e)	((e)->nes_exflag & MNT_EXSTRICTACCESS)
     83 #define	NFSVNO_EXV4ONLY(e)		((e)->nes_exflag & MNT_EXV4ONLY)
     84 
     85 #define	NFSVNO_SETEXRDONLY(e)	((e)->nes_exflag = (MNT_EXPORTED|MNT_EXRDONLY))
     86 
     87 #define	NFSVNO_CMPFH(f1, f2)						\
     88     ((f1)->fh_fsid.val[0] == (f2)->fh_fsid.val[0] &&			\
     89      (f1)->fh_fsid.val[1] == (f2)->fh_fsid.val[1] &&			\
     90      bcmp(&(f1)->fh_fid, &(f2)->fh_fid, sizeof(struct fid)) == 0)
     91 
     92 #define	NFSLOCKHASH(f) 							\
     93 	(&nfslockhash[nfsrv_hashfh(f) % nfsrv_lockhashsize])
     94 
     95 #define	NFSFPVNODE(f)	((struct vnode *)((f)->f_data))
     96 #define	NFSFPCRED(f)	((f)->f_cred)
     97 #define	NFSFPFLAG(f)	((f)->f_flag)
     98 
     99 #define	NFSNAMEICNDSET(n, c, o, f)	do {				\
    100 	(n)->cn_cred = (c);						\
    101 	(n)->cn_nameiop = (o);						\
    102 	(n)->cn_flags = (f);						\
    103     } while (0)
    104 
    105 /*
    106  * A little bit of Darwin vfs kpi.
    107  */
    108 #define	vnode_mount(v)	((v)->v_mount)
    109 #define	vfs_statfs(m)	(&((m)->mnt_stat))
    110 
    111 #define	NFSPATHLEN_T	size_t
    112 
    113 /*
    114  * These are set to the minimum and maximum size of a server file
    115  * handle.
    116  */
    117 #define	NFSRV_MINFH	(sizeof (fhandle_t))
    118 #define	NFSRV_MAXFH	(sizeof (fhandle_t))
    119 
    120 /* Use this macro for debug printfs. */
    121 #define	NFSD_DEBUG(level, ...)	do {					\
    122 		if (nfsd_debuglevel >= (level))				\
    123 			printf(__VA_ARGS__);				\
    124 	} while (0)
    125 
    126