xref: /freebsd/sys/contrib/openzfs/lib/libspl/include/libshare.h (revision dd41de95a84d979615a2ef11df6850622bf6184e)
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  * Copyright (c) 2019, 2020 by Delphix. All rights reserved.
26  */
27 #ifndef _LIBSPL_LIBSHARE_H
28 #define	_LIBSPL_LIBSHARE_H
29 
30 /* API Initialization */
31 #define	SA_INIT_SHARE_API	0x0001	/* init share specific interface */
32 #define	SA_INIT_CONTROL_API	0x0002	/* init control specific interface */
33 
34 /*
35  * defined error values
36  */
37 
38 #define	SA_OK			0
39 #define	SA_NO_SUCH_PATH		1	/* provided path doesn't exist */
40 #define	SA_NO_MEMORY		2	/* no memory for data structures */
41 #define	SA_DUPLICATE_NAME	3	/* object name is already in use */
42 #define	SA_BAD_PATH		4	/* not a full path */
43 #define	SA_NO_SUCH_GROUP	5	/* group is not defined */
44 #define	SA_CONFIG_ERR		6	/* system configuration error */
45 #define	SA_SYSTEM_ERR		7	/* system error, use errno */
46 #define	SA_SYNTAX_ERR		8	/* syntax error on command line */
47 #define	SA_NO_PERMISSION	9	/* no permission for operation */
48 #define	SA_BUSY			10	/* resource is busy */
49 #define	SA_NO_SUCH_PROP		11	/* property doesn't exist */
50 #define	SA_INVALID_NAME		12	/* name of object is invalid */
51 #define	SA_INVALID_PROTOCOL	13	/* specified protocol not valid */
52 #define	SA_NOT_ALLOWED		14	/* operation not allowed */
53 #define	SA_BAD_VALUE		15	/* bad value for property */
54 #define	SA_INVALID_SECURITY	16	/* invalid security type */
55 #define	SA_NO_SUCH_SECURITY	17	/* security set not found */
56 #define	SA_VALUE_CONFLICT	18	/* property value conflict */
57 #define	SA_NOT_IMPLEMENTED	19	/* plugin interface not implemented */
58 #define	SA_INVALID_PATH		20	/* path is sub-dir of existing share */
59 #define	SA_NOT_SUPPORTED	21	/* operation not supported for proto */
60 #define	SA_PROP_SHARE_ONLY	22	/* property valid on share only */
61 #define	SA_NOT_SHARED		23	/* path is not shared */
62 #define	SA_NO_SUCH_RESOURCE	24	/* resource not found */
63 #define	SA_RESOURCE_REQUIRED	25	/* resource name is required  */
64 #define	SA_MULTIPLE_ERROR	26	/* multiple protocols reported error */
65 #define	SA_PATH_IS_SUBDIR	27	/* check_path found path is subdir */
66 #define	SA_PATH_IS_PARENTDIR	28	/* check_path found path is parent */
67 #define	SA_NO_SECTION		29	/* protocol requires section info */
68 #define	SA_NO_SUCH_SECTION	30	/* no section found */
69 #define	SA_NO_PROPERTIES	31	/* no properties found */
70 #define	SA_PASSWORD_ENC		32	/* passwords must be encrypted */
71 #define	SA_SHARE_EXISTS		33	/* path or file is already shared */
72 
73 /* initialization */
74 extern char *sa_errorstr(int);
75 
76 /* share control */
77 extern int sa_enable_share(const char *, const char *, const char *,
78     char *);
79 extern int sa_disable_share(const char *, char *);
80 extern boolean_t sa_is_shared(const char *, char *);
81 extern void sa_commit_shares(const char *);
82 
83 /* protocol specific interfaces */
84 extern int sa_validate_shareopts(char *, char *);
85 
86 #endif /* _LIBSPL_LIBSHARE_H */
87