xref: /titanic_41/usr/src/lib/libshare/nfs/libshare_nfs.h (revision ff3124eff995e6cd8ebd8c6543648e0670920034)
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 2008 Sun Microsystems, Inc.  All rights reserved.
24  * Use is subject to license terms.
25  */
26 
27 /*
28  * basic API declarations for share management
29  */
30 
31 #ifndef _LIBSHARE_NFS_H
32 #define	_LIBSHARE_NFS_H
33 
34 #pragma ident	"%Z%%M%	%I%	%E% SMI"
35 
36 #ifdef	__cplusplus
37 extern "C" {
38 #endif
39 
40 /* property names used by NFS */
41 #define	SHOPT_RO	"ro"
42 #define	SHOPT_RW	"rw"
43 
44 #define	SHOPT_SEC	"sec"
45 #define	SHOPT_SECURE	"secure"
46 #define	SHOPT_ROOT	"root"
47 #define	SHOPT_ANON	"anon"
48 #define	SHOPT_WINDOW	"window"
49 #define	SHOPT_NOSUB	"nosub"
50 #define	SHOPT_NOSUID	"nosuid"
51 #define	SHOPT_ACLOK	"aclok"
52 #define	SHOPT_PUBLIC	"public"
53 #define	SHOPT_INDEX	"index"
54 #define	SHOPT_LOG	"log"
55 #define	SHOPT_CKSUM	"cksum"
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 
101 /*
102  * place holder for future service -- will move to daemon_utils.h when
103  * fully implemented.
104  */
105 #define	NFSLOGD	"svc:/network/nfs/log:default"
106 
107 /* The NFS export structure flags for read/write modes */
108 #define	NFS_RWMODES	(M_RO|M_ROL|M_RW|M_RWL)
109 
110 /* other values */
111 /* max size of 64-bit integer in digits plus a bit extra */
112 #define	MAXDIGITS	32
113 
114 /* external variable */
115 extern boolean_t nfsl_errs_to_syslog;
116 
117 /* imported functions */
118 extern int exportfs(char *, struct exportdata *);
119 extern void _check_services(char **);
120 extern int nfs_getseconfig_default(seconfig_t *);
121 extern int nfs_getseconfig_byname(char *, seconfig_t *);
122 extern bool_t nfs_get_root_principal(seconfig_t *, char *, caddr_t *);
123 extern int nfsl_getconfig_list(nfsl_config_t **);
124 extern void nfsl_freeconfig_list(nfsl_config_t **);
125 extern nfsl_config_t *nfsl_findconfig(nfsl_config_t *, char *, int *);
126 
127 #ifdef	__cplusplus
128 }
129 #endif
130 
131 #endif /* _LIBSHARE_NFS_H */
132