xref: /freebsd/sys/sys/netexport.h (revision 2e6615b26bb51ceadc99121f16856aad9345a3cf)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 1989, 1993
5  *	The Regents of the University of California.  All rights reserved.
6  * (c) UNIX System Laboratories, Inc.
7  * All or some portions of this file are derived from material licensed
8  * to the University of California by American Telephone and Telegraph
9  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
10  * the permission of UNIX System Laboratories, Inc.
11  *
12  * Redistribution and use in source and binary forms, with or without
13  * modification, are permitted provided that the following conditions
14  * are met:
15  * 1. Redistributions of source code must retain the above copyright
16  *    notice, this list of conditions and the following disclaimer.
17  * 2. Redistributions in binary form must reproduce the above copyright
18  *    notice, this list of conditions and the following disclaimer in the
19  *    documentation and/or other materials provided with the distribution.
20  * 3. Neither the name of the University nor the names of its contributors
21  *    may be used to endorse or promote products derived from this software
22  *    without specific prior written permission.
23  *
24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34  * SUCH DAMAGE.
35  */
36 
37 #ifndef _SYS_NETEXPORT_H_
38 #define _SYS_NETEXPORT_H_
39 
40 /*
41  * This file must be included after net/radix.h so that "struct radix_node"
42  * is defined.
43  */
44 #ifdef _KERNEL
45 /*
46  * Network address lookup element
47  */
48 struct netcred {
49 	struct	radix_node netc_rnodes[2];
50 	uint64_t netc_exflags;
51 	struct	ucred *netc_anon;
52 	int	netc_numsecflavors;
53 	int	netc_secflavors[MAXSECFLAVORS];
54 };
55 
56 /*
57  * Network export information
58  * ne_defexported - Protected by mnt_explock.
59  * ne4 - Protected by mnt_explock.
60  * ne6 - Protected by mnt_explock.
61  * The following fields are used by the pNFS server's replenisher process.
62  * ne_pnfsnumfile - Protected by the ne_mtx mutex.
63  * ne_pnfsnextfile - Protected by the vnode lock for the numfiles directory.
64  * ne_pnfsnumcnt - Handled as an atomic.
65  *                 (Although this value doesn't need to be exact, so using
66  *                  an atomic is not really necessary.)
67  */
68 struct netexport {
69 #define	ne_startzero	ne_defexported
70 	struct	netcred ne_defexported;		/* Default export */
71 	struct 	radix_node_head	*ne4;
72 	struct 	radix_node_head	*ne6;
73 #define	ne_endzero	ne_mtx
74 	struct	mtx ne_mtx;			/* For ne_pnfsnumfile. */
75 	struct	vnode *ne_pnfsnumfile;
76 	uint64_t ne_pnfsnextfile;
77 	u_int	ne_ref;				/* Refcount for structure */
78 	u_int	ne_pnfsnumcnt;			/* For stats, not protected. */
79 };
80 
81 #define	MNTEXP_LOCK(n)		mtx_lock(&(n)->ne_mtx)
82 #define	MNTEXP_UNLOCK(n)	mtx_unlock(&(n)->ne_mtx)
83 #define	MNTEXP_MTX(n)		(&(n)->ne_mtx)
84 
85 #define	PNFSD_START		((struct vnode *)-1)
86 #define	PNFSD_STOP		((struct vnode *)-2)
87 #define	PNFSD_STOPPED		((struct vnode *)-3)
88 
89 #endif	/* _KERNEL */
90 
91 #endif /* !_SYS_NETEXPORT_H_ */
92