Home | History | Annotate | Line # | Download | only in nfs
nfs_var.h revision 1.90.24.1
      1 /*	$NetBSD: nfs_var.h,v 1.90.24.1 2014/05/18 17:46:14 rmind Exp $	*/
      2 
      3 /*-
      4  * Copyright (c) 1996 The NetBSD Foundation, Inc.
      5  * All rights reserved.
      6  *
      7  * This code is derived from software contributed to The NetBSD Foundation
      8  * by Christos Zoulas.
      9  *
     10  * Redistribution and use in source and binary forms, with or without
     11  * modification, are permitted provided that the following conditions
     12  * are met:
     13  * 1. Redistributions of source code must retain the above copyright
     14  *    notice, this list of conditions and the following disclaimer.
     15  * 2. Redistributions in binary form must reproduce the above copyright
     16  *    notice, this list of conditions and the following disclaimer in the
     17  *    documentation and/or other materials provided with the distribution.
     18  *
     19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     29  * POSSIBILITY OF SUCH DAMAGE.
     30  */
     31 
     32 /*
     33  * XXX needs <nfs/rpcv2.h> and <nfs/nfs.h> because of typedefs
     34  */
     35 
     36 #ifdef _KERNEL
     37 #include <sys/mallocvar.h>
     38 #include <sys/pool.h>
     39 
     40 struct vnode;
     41 struct uio;
     42 struct proc;
     43 struct buf;
     44 struct nfs_diskless;
     45 struct sockaddr_in;
     46 struct nfs_dlmount;
     47 struct vnode;
     48 struct nfsd;
     49 struct mbuf;
     50 struct file;
     51 struct nfssvc_sock;
     52 struct nfsmount;
     53 struct socket;
     54 struct nfsreq;
     55 struct vattr;
     56 struct nameidata;
     57 struct nfsnode;
     58 struct sillyrename;
     59 struct componentname;
     60 struct nfsd_srvargs;
     61 struct nfsrv_descript;
     62 struct nfs_fattr;
     63 struct nfsdircache;
     64 union nethostaddr;
     65 
     66 /* nfs_bio.c */
     67 int nfs_bioread(struct vnode *, struct uio *, int, kauth_cred_t, int);
     68 struct buf *nfs_getcacheblk(struct vnode *, daddr_t, int, struct lwp *);
     69 int nfs_vinvalbuf(struct vnode *, int, kauth_cred_t, struct lwp *, int);
     70 int nfs_flushstalebuf(struct vnode *, kauth_cred_t, struct lwp *, int);
     71 #define	NFS_FLUSHSTALEBUF_MYWRITE	1	/* assume writes are ours */
     72 int nfs_asyncio(struct buf *);
     73 int nfs_doio(struct buf *);
     74 
     75 /* nfs_boot.c */
     76 /* see nfsdiskless.h */
     77 
     78 /* nfs_kq.c */
     79 void nfs_kqinit(void);
     80 void nfs_kqfini(void);
     81 
     82 /* nfs_node.c */
     83 void nfs_rbtinit(struct nfsmount *);
     84 void nfs_node_init(void);
     85 void nfs_node_done(void);
     86 
     87 int nfs_nget1(struct mount *, nfsfh_t *, int, struct nfsnode **, int);
     88 #define	nfs_nget(mp, fhp, fhsize, npp) \
     89 	nfs_nget1((mp), (fhp), (fhsize), (npp), 0)
     90 
     91 /* nfs_vnops.c */
     92 int nfs_null(struct vnode *, kauth_cred_t, struct lwp *);
     93 int nfs_setattrrpc(struct vnode *, struct vattr *, kauth_cred_t, struct lwp *);
     94 int nfs_readlinkrpc(struct vnode *, struct uio *, kauth_cred_t);
     95 int nfs_readrpc(struct vnode *, struct uio *);
     96 int nfs_writerpc(struct vnode *, struct uio *, int *, bool, bool *);
     97 int nfs_mknodrpc(struct vnode *, struct vnode **, struct componentname *,
     98 	struct vattr *);
     99 int nfs_removeit(struct sillyrename *);
    100 int nfs_removerpc(struct vnode *, const char *, int, kauth_cred_t,
    101 	struct lwp *);
    102 int nfs_renameit(struct vnode *, struct componentname *, struct sillyrename *);
    103 int nfs_renamerpc(struct vnode *, const char *, int, struct vnode *,
    104 	const char *, int, kauth_cred_t, struct lwp *);
    105 int nfs_readdirrpc(struct vnode *, struct uio *, kauth_cred_t);
    106 int nfs_readdirplusrpc(struct vnode *, struct uio *, kauth_cred_t);
    107 int nfs_sillyrename(struct vnode *, struct vnode *, struct componentname *,
    108 	bool);
    109 int nfs_lookitup(struct vnode *, const char *, int, kauth_cred_t,
    110 	struct lwp *, struct nfsnode **);
    111 int nfs_commit(struct vnode *, off_t, uint32_t, struct lwp *);
    112 int nfs_flush(struct vnode *, kauth_cred_t, int, struct lwp *, int);
    113 
    114 /* nfs_serv.c */
    115 int nfsrv3_access(struct nfsrv_descript *, struct nfssvc_sock *,
    116 	struct lwp *, struct mbuf **);
    117 int nfsrv_getattr(struct nfsrv_descript *, struct nfssvc_sock *,
    118 	struct lwp *, struct mbuf **);
    119 int nfsrv_setattr(struct nfsrv_descript *, struct nfssvc_sock *,
    120 	struct lwp *, struct mbuf **);
    121 int nfsrv_lookup(struct nfsrv_descript *, struct nfssvc_sock *,
    122 	struct lwp *, struct mbuf **);
    123 int nfsrv_readlink(struct nfsrv_descript *, struct nfssvc_sock *,
    124 	struct lwp *, struct mbuf **);
    125 int nfsrv_read(struct nfsrv_descript *, struct nfssvc_sock *,
    126 	struct lwp *, struct mbuf **);
    127 int nfsrv_write(struct nfsrv_descript *, struct nfssvc_sock *,
    128 	struct lwp *, struct mbuf **);
    129 int nfsrv_writegather(struct nfsrv_descript **, struct nfssvc_sock *,
    130 	struct lwp *, struct mbuf **);
    131 void nfsrvw_coalesce(struct nfsrv_descript *, struct nfsrv_descript *);
    132 int nfsrv_create(struct nfsrv_descript *, struct nfssvc_sock *,
    133 	struct lwp *, struct mbuf **);
    134 int nfsrv_mknod(struct nfsrv_descript *, struct nfssvc_sock *,
    135 	struct lwp *, struct mbuf **);
    136 int nfsrv_remove(struct nfsrv_descript *, struct nfssvc_sock *,
    137 	struct lwp *, struct mbuf **);
    138 int nfsrv_rename(struct nfsrv_descript *, struct nfssvc_sock *,
    139 	struct lwp *, struct mbuf **);
    140 int nfsrv_link(struct nfsrv_descript *, struct nfssvc_sock *,
    141 	struct lwp *, struct mbuf **);
    142 int nfsrv_symlink(struct nfsrv_descript *, struct nfssvc_sock *,
    143 	struct lwp *, struct mbuf **);
    144 int nfsrv_mkdir(struct nfsrv_descript *, struct nfssvc_sock *,
    145 	struct lwp *, struct mbuf **);
    146 int nfsrv_rmdir(struct nfsrv_descript *, struct nfssvc_sock *,
    147 	struct lwp *, struct mbuf **);
    148 int nfsrv_readdir(struct nfsrv_descript *, struct nfssvc_sock *,
    149 	struct lwp *, struct mbuf **);
    150 int nfsrv_readdirplus(struct nfsrv_descript *, struct nfssvc_sock *,
    151 	struct lwp *, struct mbuf **);
    152 int nfsrv_commit(struct nfsrv_descript *, struct nfssvc_sock *,
    153 	struct lwp *, struct mbuf **);
    154 int nfsrv_statfs(struct nfsrv_descript *, struct nfssvc_sock *,
    155 	struct lwp *, struct mbuf **);
    156 int nfsrv_fsinfo(struct nfsrv_descript *, struct nfssvc_sock *,
    157 	struct lwp *, struct mbuf **);
    158 int nfsrv_pathconf(struct nfsrv_descript *, struct nfssvc_sock *,
    159 	struct lwp *, struct mbuf **);
    160 int nfsrv_null(struct nfsrv_descript *, struct nfssvc_sock *,
    161 	struct lwp *, struct mbuf **);
    162 int nfsrv_noop(struct nfsrv_descript *, struct nfssvc_sock *,
    163 	struct lwp *, struct mbuf **);
    164 int nfsrv_access(struct vnode *, int, kauth_cred_t, int, struct lwp *, int);
    165 
    166 /* nfs_socket.c */
    167 int nfs_connect(struct nfsmount *, struct nfsreq *, struct lwp *);
    168 int nfs_reconnect(struct nfsreq *);
    169 void nfs_disconnect(struct nfsmount *);
    170 void nfs_safedisconnect(struct nfsmount *);
    171 int nfs_send(struct socket *, struct mbuf *, struct mbuf *, struct nfsreq *,
    172 	struct lwp *);
    173 int nfs_request(struct nfsnode *, struct mbuf *, int, struct lwp *,
    174 	kauth_cred_t, struct mbuf **, struct mbuf **, char **, int *);
    175 int nfs_rephead(int, struct nfsrv_descript *, struct nfssvc_sock *,
    176 	int, int, u_quad_t *, struct mbuf **, struct mbuf **, char **);
    177 void nfs_timer(void *);
    178 void nfs_timer_init(void);
    179 void nfs_timer_fini(void);
    180 void nfs_timer_start(void);
    181 void nfs_timer_srvinit(bool (*)(void));
    182 void nfs_timer_srvfini(void);
    183 int nfs_sigintr(struct nfsmount *, struct nfsreq *, struct lwp *);
    184 int nfs_getreq(struct nfsrv_descript *, struct nfsd *, int);
    185 int nfs_msg(struct lwp *, const char *, const char *);
    186 void nfsrv_soupcall(struct socket *, void *, int, int);
    187 void nfsrv_rcv(struct nfssvc_sock *);
    188 int nfsrv_getstream(struct nfssvc_sock *, int);
    189 int nfsrv_dorec(struct nfssvc_sock *, struct nfsd *, struct nfsrv_descript **,
    190     bool *);
    191 void nfsrv_wakenfsd(struct nfssvc_sock *);
    192 int nfsdsock_lock(struct nfssvc_sock *, bool);
    193 void nfsdsock_unlock(struct nfssvc_sock *);
    194 int nfsdsock_drain(struct nfssvc_sock *);
    195 int nfsdsock_sendreply(struct nfssvc_sock *, struct nfsrv_descript *);
    196 void nfsdreq_init(void);
    197 void nfsdreq_fini(void);
    198 struct nfsrv_descript *nfsdreq_alloc(void);
    199 void nfsdreq_free(struct nfsrv_descript *);
    200 bool nfsrv_timer(void);
    201 int nfs_rcvlock(struct nfsmount *, struct nfsreq *);
    202 void nfs_rcvunlock(struct nfsmount *);
    203 
    204 void nfsdsock_setbits(struct nfssvc_sock *, int);
    205 void nfsdsock_clearbits(struct nfssvc_sock *, int);
    206 bool nfsdsock_testbits(struct nfssvc_sock *, int);
    207 
    208 /*
    209  * Estimate rto for an nfs rpc sent via. an unreliable datagram.
    210  * Use the mean and mean deviation of rtt for the appropriate type of rpc
    211  * for the frequent rpcs and a default for the others.
    212  * The justification for doing "other" this way is that these rpcs
    213  * happen so infrequently that timer est. would probably be stale.
    214  * Also, since many of these rpcs are
    215  * non-idempotent, a conservative timeout is desired.
    216  * getattr, lookup - A+2D
    217  * read, write     - A+4D
    218  * other           - nm_timeo
    219  */
    220 #define	NFS_RTO(n, t) \
    221 	((t) == 0 ? (n)->nm_timeo : \
    222 	 ((t) < 3 ? \
    223 	  (((((n)->nm_srtt[t-1] + 3) >> 2) + (n)->nm_sdrtt[t-1] + 1) >> 1) : \
    224 	  ((((n)->nm_srtt[t-1] + 7) >> 3) + (n)->nm_sdrtt[t-1] + 1)))
    225 #define	NFS_SRTT(r)	(r)->r_nmp->nm_srtt[nfs_proct[(r)->r_procnum] - 1]
    226 #define	NFS_SDRTT(r)	(r)->r_nmp->nm_sdrtt[nfs_proct[(r)->r_procnum] - 1]
    227 
    228 extern int nfsrtton;
    229 extern struct nfsrtt nfsrtt;
    230 extern const int nfs_proct[];
    231 
    232 extern const struct timeval nfs_err_interval;
    233 extern struct timeval nfs_reply_last_err_time;
    234 extern struct timeval nfs_timer_last_err_time;
    235 
    236 
    237 /* nfs_srvcache.c */
    238 void nfsrv_initcache(void);
    239 void nfsrv_finicache(void);
    240 int nfsrv_getcache(struct nfsrv_descript *, struct nfssvc_sock *,
    241 	struct mbuf **);
    242 void nfsrv_updatecache(struct nfsrv_descript *, int, struct mbuf *);
    243 void nfsrv_cleancache(void);
    244 
    245 /* nfs_subs.c */
    246 struct mbuf *nfsm_reqh(struct nfsnode *, u_long, int, char **);
    247 struct mbuf *nfsm_rpchead(kauth_cred_t, int, int, int, int, char *, int,
    248 	char *, struct mbuf *, int, struct mbuf **, u_int32_t *);
    249 int nfsm_mbuftouio(struct mbuf **, struct uio *, int, char **);
    250 int nfsm_uiotombuf(struct uio *, struct mbuf **, int, char **);
    251 int nfsm_disct(struct mbuf **, char **, int, int, char **);
    252 int nfs_adv(struct mbuf **, char **, int, int);
    253 int nfsm_strtmbuf(struct mbuf **, char **, const char *, long);
    254 u_long nfs_dirhash(off_t);
    255 void nfs_initdircache(struct vnode *);
    256 void nfs_initdirxlatecookie(struct vnode *);
    257 struct nfsdircache *nfs_searchdircache(struct vnode *, off_t, int, int *);
    258 struct nfsdircache *nfs_enterdircache(struct vnode *, off_t, off_t, int,
    259 	daddr_t);
    260 void nfs_putdircache(struct nfsnode *, struct nfsdircache *);
    261 void nfs_invaldircache(struct vnode *, int);
    262 #define	NFS_INVALDIRCACHE_FORCE		1
    263 #define	NFS_INVALDIRCACHE_KEEPEOF	2
    264 void nfs_init(void);
    265 void nfs_fini(void);
    266 int nfsm_loadattrcache(struct vnode **, struct mbuf **, char **,
    267 	struct vattr *, int flags);
    268 int nfs_loadattrcache(struct vnode **, struct nfs_fattr *, struct vattr *,
    269 	int flags);
    270 int nfs_getattrcache(struct vnode *, struct vattr *);
    271 void nfs_delayedtruncate(struct vnode *);
    272 int nfs_check_wccdata(struct nfsnode *, const struct timespec *,
    273 	struct timespec *, bool);
    274 int nfs_namei(struct nameidata *, nfsrvfh_t *, uint32_t, struct nfssvc_sock *,
    275 	struct mbuf *, struct mbuf **, char **, struct vnode **, struct lwp *,
    276 	int, int);
    277 void nfs_zeropad(struct mbuf *, int, int);
    278 void nfsm_srvwcc(struct nfsrv_descript *, int, struct vattr *, int,
    279 	struct vattr *, struct mbuf **, char **);
    280 void nfsm_srvpostopattr(struct nfsrv_descript *, int, struct vattr *,
    281 	struct mbuf **, char **);
    282 void nfsm_srvfattr(struct nfsrv_descript *, struct vattr *, struct nfs_fattr *);
    283 int nfsrv_fhtovp(nfsrvfh_t *, int, struct vnode **, kauth_cred_t,
    284 	struct nfssvc_sock *, struct mbuf *, int *, int, int);
    285 int nfs_ispublicfh(const nfsrvfh_t *);
    286 int netaddr_match(int, union nethostaddr *, struct mbuf *);
    287 time_t nfs_attrtimeo(struct nfsmount *, struct nfsnode *);
    288 
    289 /* flags for nfs_loadattrcache and friends */
    290 #define	NAC_NOTRUNC	1	/* don't truncate file size */
    291 
    292 void nfs_clearcommit(struct mount *);
    293 void nfs_merge_commit_ranges(struct vnode *);
    294 int nfs_in_committed_range(struct vnode *, off_t, off_t);
    295 int nfs_in_tobecommitted_range(struct vnode *, off_t, off_t);
    296 void nfs_add_committed_range(struct vnode *, off_t, off_t);
    297 void nfs_del_committed_range(struct vnode *, off_t, off_t);
    298 void nfs_add_tobecommitted_range(struct vnode *, off_t, off_t);
    299 void nfs_del_tobecommitted_range(struct vnode *, off_t, off_t);
    300 
    301 int nfsrv_errmap(struct nfsrv_descript *, int);
    302 void nfs_cookieheuristic(struct vnode *, int *, struct lwp *, kauth_cred_t);
    303 
    304 u_int32_t nfs_getxid(void);
    305 void nfs_renewxid(struct nfsreq *);
    306 
    307 int nfsrv_composefh(struct vnode *, nfsrvfh_t *, bool);
    308 int nfsrv_comparefh(const nfsrvfh_t *, const nfsrvfh_t *);
    309 void nfsrv_copyfh(nfsrvfh_t *, const nfsrvfh_t *);
    310 
    311 extern const enum vtype nv2tov_type[8];
    312 extern const enum vtype nv3tov_type[8];
    313 
    314 extern u_int32_t rpc_reply, rpc_msgdenied, rpc_mismatch, rpc_vers,
    315         rpc_auth_unix, rpc_msgaccepted, rpc_call, rpc_autherr,
    316 	rpc_auth_kerb;
    317 extern u_int32_t nfs_prog;
    318 extern const int nfsv3_procid[NFS_NPROCS];
    319 extern int nfs_ticks;
    320 
    321 /* nfs_syscalls.c */
    322 struct sys_getfh_args;
    323 struct sys_nfssvc_args;
    324 int sys_getfh(struct lwp *, const struct sys_getfh_args *, register_t *);
    325 int sys_nfssvc(struct lwp *, const struct sys_nfssvc_args *, register_t *);
    326 int nfssvc_addsock(struct file *, struct mbuf *);
    327 int nfssvc_nfsd(struct nfsd_srvargs *, void *, struct lwp *);
    328 void nfsrv_zapsock(struct nfssvc_sock *);
    329 void nfsrv_slpderef(struct nfssvc_sock *);
    330 void nfsrv_init(int);
    331 void nfsrv_fini(void);
    332 void nfs_iodinit(void);
    333 void nfs_iodfini(void);
    334 int nfs_set_niothreads(int);
    335 int nfs_getauth(struct nfsmount *, struct nfsreq *, kauth_cred_t, char **,
    336 	int *, char *, int *, NFSKERBKEY_T);
    337 int nfs_getnickauth(struct nfsmount *, kauth_cred_t, char **, int *, char *,
    338 	int);
    339 int nfs_savenickauth(struct nfsmount *, kauth_cred_t, int, NFSKERBKEY_T,
    340 	struct mbuf **, char **, struct mbuf *);
    341 
    342 /* nfs_export.c */
    343 extern struct nfs_public nfs_pub;
    344 int mountd_set_exports_list(const struct mountd_exports_list *, struct lwp *,
    345     struct mount *);
    346 int netexport_check(const fsid_t *, struct mbuf *, struct mount **, int *,
    347     kauth_cred_t *);
    348 void netexport_rdlock(void);
    349 void netexport_rdunlock(void);
    350 void netexport_init(void);
    351 void netexport_fini(void);
    352 bool netexport_hasexports(void);
    353 #endif /* _KERNEL */
    354