FreeBSD/Linux Kernel Cross Reference
sys/contrib/openzfs/lib/libspl/include/libshare.h

     /*
      * CDDL HEADER START
      *
      * The contents of this file are subject to the terms of the
      * Common Development and Distribution License (the "License").
      * You may not use this file except in compliance with the License.
      *
      * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
      * or https://opensource.org/licenses/CDDL-1.0.
     * See the License for the specific language governing permissions
     * and limitations under the License.
     *
     * When distributing Covered Code, include this CDDL HEADER in each
     * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
     * If applicable, add the following below this CDDL HEADER, with the
     * fields enclosed by brackets "[]" replaced with your own identifying
     * information: Portions Copyright [yyyy] [name of copyright owner]
     *
     * CDDL HEADER END
     */
    
    /*
     * Copyright 2008 Sun Microsystems, Inc.  All rights reserved.
     * Use is subject to license terms.
     * Copyright (c) 2019, 2022 by Delphix. All rights reserved.
     */
    #ifndef _LIBSPL_LIBSHARE_H
    #define _LIBSPL_LIBSHARE_H extern __attribute__((visibility("default")))
    
    #include <sys/types.h>
    
    /*
     * defined error values
     */
    #define SA_OK                   0
    #define SA_SYSTEM_ERR           7       /* system error, use errno */
    #define SA_SYNTAX_ERR           8       /* syntax error on command line */
    #define SA_NO_MEMORY            2       /* no memory for data structures */
    #define SA_INVALID_PROTOCOL     13      /* specified protocol not valid */
    #define SA_NOT_SUPPORTED        21      /* operation not supported for proto */
    
    /* The following errors are never returned by libshare */
    #define SA_NO_SUCH_PATH         1       /* provided path doesn't exist */
    #define SA_DUPLICATE_NAME       3       /* object name is already in use */
    #define SA_BAD_PATH             4       /* not a full path */
    #define SA_NO_SUCH_GROUP        5       /* group is not defined */
    #define SA_CONFIG_ERR           6       /* system configuration error */
    #define SA_NO_PERMISSION        9       /* no permission for operation */
    #define SA_BUSY                 10      /* resource is busy */
    #define SA_NO_SUCH_PROP         11      /* property doesn't exist */
    #define SA_INVALID_NAME         12      /* name of object is invalid */
    #define SA_NOT_ALLOWED          14      /* operation not allowed */
    #define SA_BAD_VALUE            15      /* bad value for property */
    #define SA_INVALID_SECURITY     16      /* invalid security type */
    #define SA_NO_SUCH_SECURITY     17      /* security set not found */
    #define SA_VALUE_CONFLICT       18      /* property value conflict */
    #define SA_NOT_IMPLEMENTED      19      /* plugin interface not implemented */
    #define SA_INVALID_PATH         20      /* path is sub-dir of existing share */
    #define SA_PROP_SHARE_ONLY      22      /* property valid on share only */
    #define SA_NOT_SHARED           23      /* path is not shared */
    #define SA_NO_SUCH_RESOURCE     24      /* resource not found */
    #define SA_RESOURCE_REQUIRED    25      /* resource name is required  */
    #define SA_MULTIPLE_ERROR       26      /* multiple protocols reported error */
    #define SA_PATH_IS_SUBDIR       27      /* check_path found path is subdir */
    #define SA_PATH_IS_PARENTDIR    28      /* check_path found path is parent */
    #define SA_NO_SECTION           29      /* protocol requires section info */
    #define SA_NO_SUCH_SECTION      30      /* no section found */
    #define SA_NO_PROPERTIES        31      /* no properties found */
    #define SA_PASSWORD_ENC         32      /* passwords must be encrypted */
    #define SA_SHARE_EXISTS         33      /* path or file is already shared */
    
    /* initialization */
    _LIBSPL_LIBSHARE_H const char *sa_errorstr(int);
    
    /* available protocols */
    enum sa_protocol {
            SA_PROTOCOL_NFS,
            SA_PROTOCOL_SMB, /* ABI: add before _COUNT */
            SA_PROTOCOL_COUNT,
    };
    
    /* lower-case */
    _LIBSPL_LIBSHARE_H const char *const sa_protocol_names[SA_PROTOCOL_COUNT];
    
    /* share control */
    _LIBSPL_LIBSHARE_H int sa_enable_share(const char *, const char *, const char *,
        enum sa_protocol);
    _LIBSPL_LIBSHARE_H int sa_disable_share(const char *, enum sa_protocol);
    _LIBSPL_LIBSHARE_H boolean_t sa_is_shared(const char *, enum sa_protocol);
    _LIBSPL_LIBSHARE_H void sa_commit_shares(enum sa_protocol);
    _LIBSPL_LIBSHARE_H void sa_truncate_shares(enum sa_protocol);
    
    /* protocol specific interfaces */
    _LIBSPL_LIBSHARE_H int sa_validate_shareopts(const char *, enum sa_protocol);
    
    #endif /* _LIBSPL_LIBSHARE_H */

Cache object: c91b8c86c53ea38c642ef21c4dc18f2e