1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause 3 * 4 * Copyright (c) 2009 Rick Macklem, University of Guelph 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26 * SUCH DAMAGE. 27 */ 28 29 /* 30 * These macros handle nfsvattr fields. They look a bit silly here, but 31 * are quite different for the Darwin port. 32 */ 33 #define NFSVNO_ATTRINIT(n) (VATTR_NULL(&((n)->na_vattr))) 34 #define NFSVNO_SETATTRVAL(n, f, v) ((n)->na_##f = (v)) 35 #define NFSVNO_SETACTIVE(n, f) 36 #define NFSVNO_UNSET(n, f) ((n)->na_##f = VNOVAL) 37 #define NFSVNO_NOTSETMODE(n) ((n)->na_mode == ((mode_t)VNOVAL)) 38 #define NFSVNO_ISSETMODE(n) ((n)->na_mode != ((mode_t)VNOVAL)) 39 #define NFSVNO_NOTSETUID(n) ((n)->na_uid == ((uid_t)VNOVAL)) 40 #define NFSVNO_ISSETUID(n) ((n)->na_uid != ((uid_t)VNOVAL)) 41 #define NFSVNO_NOTSETGID(n) ((n)->na_gid == ((gid_t)VNOVAL)) 42 #define NFSVNO_ISSETGID(n) ((n)->na_gid != ((gid_t)VNOVAL)) 43 #define NFSVNO_NOTSETSIZE(n) ((n)->na_size == VNOVAL) 44 #define NFSVNO_ISSETSIZE(n) ((n)->na_size != VNOVAL) 45 #define NFSVNO_NOTSETATIME(n) ((n)->na_atime.tv_sec == VNOVAL) 46 #define NFSVNO_ISSETATIME(n) ((n)->na_atime.tv_sec != VNOVAL) 47 #define NFSVNO_NOTSETMTIME(n) ((n)->na_mtime.tv_sec == VNOVAL) 48 #define NFSVNO_ISSETMTIME(n) ((n)->na_mtime.tv_sec != VNOVAL) 49 50 /* 51 * This structure acts as a "catch-all" for information that 52 * needs to be returned by nfsd_fhtovp(). 53 */ 54 struct nfsexstuff { 55 uint64_t nes_exflag; /* export flags */ 56 int nes_numsecflavor; /* # of security flavors */ 57 int nes_secflavors[MAXSECFLAVORS]; /* and the flavors */ 58 }; 59 60 /* 61 * These are NO-OPS for BSD until Isilon upstreams EXITCODE support. 62 * EXITCODE is an in-memory ring buffer that holds the routines failing status. 63 * This is a valuable tool to use when debugging and analyzing issues. 64 * In addition to recording a routine's failing status, it offers 65 * logging of routines for call stack tracing. 66 * EXITCODE should be used only in routines that return a true errno value, as 67 * that value will be formatted to a displayable errno string. Routines that 68 * return regular int status that are not true errno should not set EXITCODE. 69 * If you want to log routine tracing, you can add EXITCODE(0) to any routine. 70 * NFS extended the EXITCODE with EXITCODE2 to record either the routine's 71 * exit errno status or the nd_repstat. 72 */ 73 #define NFSEXITCODE(error) 74 #define NFSEXITCODE2(error, nd) 75 76 #define NFSVNO_EXINIT(e) ((e)->nes_exflag = 0) 77 #define NFSVNO_EXPORTED(e) ((e)->nes_exflag & MNT_EXPORTED) 78 #define NFSVNO_EXRDONLY(e) ((e)->nes_exflag & MNT_EXRDONLY) 79 #define NFSVNO_EXPORTANON(e) ((e)->nes_exflag & MNT_EXPORTANON) 80 #define NFSVNO_EXSTRICTACCESS(e) ((e)->nes_exflag & MNT_EXSTRICTACCESS) 81 #define NFSVNO_EXV4ONLY(e) ((e)->nes_exflag & MNT_EXV4ONLY) 82 #define NFSVNO_EXTLS(e) ((e)->nes_exflag & MNT_EXTLS) 83 #define NFSVNO_EXTLSCERT(e) ((e)->nes_exflag & MNT_EXTLSCERT) 84 #define NFSVNO_EXTLSCERTUSER(e) ((e)->nes_exflag & MNT_EXTLSCERTUSER) 85 86 #define NFSVNO_SETEXRDONLY(e) ((e)->nes_exflag = (MNT_EXPORTED|MNT_EXRDONLY)) 87 88 #define NFSVNO_CMPFH(f1, f2) \ 89 (fsidcmp(&(f1)->fh_fsid, &(f2)->fh_fsid) == 0 && \ 90 bcmp(&(f1)->fh_fid, &(f2)->fh_fid, sizeof(struct fid)) == 0) 91 92 #define NFSLOCKHASH(f) \ 93 (&NFSD_VNET(nfslockhash)[nfsrv_hashfh(f) % nfsrv_lockhashsize]) 94 95 #define NFSFPVNODE(f) ((f)->f_vnode) 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 #define NFSPATHLEN_T size_t 106 107 /* 108 * These are set to the minimum and maximum size of a server file 109 * handle. 110 */ 111 #define NFSRV_MINFH (sizeof (fhandle_t)) 112 #define NFSRV_MAXFH (sizeof (fhandle_t)) 113 114 /* Use this macro for debug printfs. */ 115 #define NFSD_DEBUG(level, ...) do { \ 116 if (nfsd_debuglevel >= (level)) \ 117 printf(__VA_ARGS__); \ 118 } while (0) 119