xref: /illumos-gate/usr/src/lib/libshare/nfs/libshare_nfs.h (revision e77c795bcbe51aebd7579fe13cbf2a6d56eca47f)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 
22 /*
23  * Copyright (c) 2006, 2010, Oracle and/or its affiliates. All rights reserved.
24  */
25 
26 /*
27  * basic API declarations for share management
28  */
29 
30 #ifndef _LIBSHARE_NFS_H
31 #define	_LIBSHARE_NFS_H
32 
33 #ifdef	__cplusplus
34 extern "C" {
35 #endif
36 
37 /* property names used by NFS */
38 #define	SHOPT_RO	"ro"
39 #define	SHOPT_RW	"rw"
40 #define	SHOPT_NONE	"none"
41 #define	SHOPT_ROOT_MAPPING	"root_mapping"
42 
43 #define	SHOPT_SEC	"sec"
44 #define	SHOPT_SECURE	"secure"
45 #define	SHOPT_ROOT	"root"
46 #define	SHOPT_ANON	"anon"
47 #define	SHOPT_WINDOW	"window"
48 #define	SHOPT_NOSUB	"nosub"
49 #define	SHOPT_NOSUID	"nosuid"
50 #define	SHOPT_ACLOK	"aclok"
51 #define	SHOPT_PUBLIC	"public"
52 #define	SHOPT_INDEX	"index"
53 #define	SHOPT_LOG	"log"
54 #define	SHOPT_CKSUM	"cksum"
55 #define	SHOPT_NOACLFAB	"noaclfab"
56 
57 /*
58  * defined options types. These should be in a file rather than
59  * compiled in. Until there is a plugin mechanism to add new types,
60  * this is sufficient.
61  */
62 #define	OPT_TYPE_ANY		0
63 #define	OPT_TYPE_STRING		1
64 #define	OPT_TYPE_BOOLEAN	2
65 #define	OPT_TYPE_NUMBER		3
66 #define	OPT_TYPE_RANGE		4
67 #define	OPT_TYPE_USER		5
68 #define	OPT_TYPE_ACCLIST	6
69 #define	OPT_TYPE_DEPRECATED	7
70 #define	OPT_TYPE_SECURITY	8
71 #define	OPT_TYPE_PATH		9
72 #define	OPT_TYPE_FILE		10
73 #define	OPT_TYPE_LOGTAG		11
74 #define	OPT_TYPE_STRINGSET	12
75 #define	OPT_TYPE_DOMAIN		13
76 #define	OPT_TYPE_ONOFF		14
77 #define	OPT_TYPE_PROTOCOL	15
78 
79 #define	OPT_SHARE_ONLY		1
80 
81 struct option_defs {
82 	char *tag;
83 	int index;
84 	int type;
85 	int share;	/* share only option */
86 	int (*check)(sa_handle_t, char *);
87 };
88 
89 /*
90  * service bit mask values
91  */
92 #define	SVC_LOCKD	0x0001
93 #define	SVC_STATD	0x0002
94 #define	SVC_NFSD	0x0004
95 #define	SVC_MOUNTD	0x0008
96 #define	SVC_NFS4CBD	0x0010
97 #define	SVC_NFSMAPID	0x0020
98 #define	SVC_RQUOTAD	0x0040
99 #define	SVC_NFSLOGD	0x0080
100 #define	SVC_REPARSED	0x0100
101 #define	SVC_CLIENT	0x0200
102 
103 /*
104  * NFS Restart/Refresh options
105  */
106 #define	NFSD_REFRESH		0x0001
107 #define	NFSD_RESTART		0x0002
108 #define	NLOCKMGR_REFESH		0x0003
109 #define	NLOCKMGR_RESTART	0x0004
110 #define	MAPID_REFRESH		0x0005
111 #define	MAPID_RESTART		0x0006
112 
113 /*
114  * place holder for future service -- will move to daemon_utils.h when
115  * fully implemented.
116  */
117 #define	NFSLOGD	"svc:/network/nfs/log:default"
118 
119 /* The NFS export structure flags for read/write modes */
120 #define	NFS_RWMODES	(M_RO|M_ROL|M_RW|M_RWL)
121 
122 /* other values */
123 /* max size of 64-bit integer in digits plus a bit extra */
124 #define	MAXDIGITS	32
125 
126 /* external variable */
127 extern boolean_t nfsl_errs_to_syslog;
128 
129 /* imported functions */
130 extern int exportfs(char *, struct exportdata *);
131 extern int nfs_getseconfig_default(seconfig_t *);
132 extern int nfs_getseconfig_byname(char *, seconfig_t *);
133 extern bool_t nfs_get_root_principal(seconfig_t *, char *, caddr_t *);
134 extern int nfsl_getconfig_list(nfsl_config_t **);
135 extern void nfsl_freeconfig_list(nfsl_config_t **);
136 extern nfsl_config_t *nfsl_findconfig(nfsl_config_t *, char *, int *);
137 
138 #ifdef	__cplusplus
139 }
140 #endif
141 
142 #endif /* _LIBSHARE_NFS_H */
143