1 // SPDX-License-Identifier: CDDL-1.0 2 /* 3 * CDDL HEADER START 4 * 5 * The contents of this file are subject to the terms of the 6 * Common Development and Distribution License (the "License"). 7 * You may not use this file except in compliance with the License. 8 * 9 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 10 * or https://opensource.org/licenses/CDDL-1.0. 11 * See the License for the specific language governing permissions 12 * and limitations under the License. 13 * 14 * When distributing Covered Code, include this CDDL HEADER in each 15 * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 16 * If applicable, add the following below this CDDL HEADER, with the 17 * fields enclosed by brackets "[]" replaced with your own identifying 18 * information: Portions Copyright [yyyy] [name of copyright owner] 19 * 20 * CDDL HEADER END 21 */ 22 23 /* 24 * Copyright 2008 Sun Microsystems, Inc. All rights reserved. 25 * Use is subject to license terms. 26 * Copyright (c) 2019, 2022 by Delphix. All rights reserved. 27 */ 28 #ifndef _LIBSPL_LIBSHARE_H 29 #define _LIBSPL_LIBSHARE_H extern __attribute__((visibility("default"))) 30 31 #include <sys/types.h> 32 33 /* 34 * defined error values 35 */ 36 #define SA_OK 0 37 #define SA_SYSTEM_ERR 7 /* system error, use errno */ 38 #define SA_SYNTAX_ERR 8 /* syntax error on command line */ 39 #define SA_NO_MEMORY 2 /* no memory for data structures */ 40 #define SA_INVALID_PROTOCOL 13 /* specified protocol not valid */ 41 #define SA_NOT_SUPPORTED 21 /* operation not supported for proto */ 42 43 /* The following errors are never returned by libshare */ 44 #define SA_NO_SUCH_PATH 1 /* provided path doesn't exist */ 45 #define SA_DUPLICATE_NAME 3 /* object name is already in use */ 46 #define SA_BAD_PATH 4 /* not a full path */ 47 #define SA_NO_SUCH_GROUP 5 /* group is not defined */ 48 #define SA_CONFIG_ERR 6 /* system configuration error */ 49 #define SA_NO_PERMISSION 9 /* no permission for operation */ 50 #define SA_BUSY 10 /* resource is busy */ 51 #define SA_NO_SUCH_PROP 11 /* property doesn't exist */ 52 #define SA_INVALID_NAME 12 /* name of object is invalid */ 53 #define SA_NOT_ALLOWED 14 /* operation not allowed */ 54 #define SA_BAD_VALUE 15 /* bad value for property */ 55 #define SA_INVALID_SECURITY 16 /* invalid security type */ 56 #define SA_NO_SUCH_SECURITY 17 /* security set not found */ 57 #define SA_VALUE_CONFLICT 18 /* property value conflict */ 58 #define SA_NOT_IMPLEMENTED 19 /* plugin interface not implemented */ 59 #define SA_INVALID_PATH 20 /* path is sub-dir of existing share */ 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 _LIBSPL_LIBSHARE_H const char *sa_errorstr(int); 75 76 /* available protocols */ 77 enum sa_protocol { 78 SA_PROTOCOL_NFS, 79 SA_PROTOCOL_SMB, /* ABI: add before _COUNT */ 80 SA_PROTOCOL_COUNT, 81 }; 82 83 /* lower-case */ 84 _LIBSPL_LIBSHARE_H const char *const sa_protocol_names[SA_PROTOCOL_COUNT]; 85 86 /* share control */ 87 _LIBSPL_LIBSHARE_H int sa_enable_share(const char *, const char *, const char *, 88 enum sa_protocol); 89 _LIBSPL_LIBSHARE_H int sa_disable_share(const char *, enum sa_protocol); 90 _LIBSPL_LIBSHARE_H boolean_t sa_is_shared(const char *, enum sa_protocol); 91 _LIBSPL_LIBSHARE_H void sa_commit_shares(enum sa_protocol); 92 _LIBSPL_LIBSHARE_H void sa_truncate_shares(enum sa_protocol); 93 94 /* protocol specific interfaces */ 95 _LIBSPL_LIBSHARE_H int sa_validate_shareopts(const char *, enum sa_protocol); 96 97 #endif /* _LIBSPL_LIBSHARE_H */ 98