include/zfs_namecheck.h

   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 https://opensource.org/licenses/CDDL-1.0.
  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  * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
  23  * Use is subject to license terms.
  24  */
  25 /*
  26  * Copyright (c) 2013, 2016 by Delphix. All rights reserved.
  27  */
  28
  29 #ifndef _ZFS_NAMECHECK_H
  30 #define _ZFS_NAMECHECK_H extern __attribute__((visibility("default")))
  31
  32 #ifdef  __cplusplus
  33 extern "C" {
  34 #endif
  35
  36 typedef enum {
  37         NAME_ERR_LEADING_SLASH,         /* name begins with leading slash */
  38         NAME_ERR_EMPTY_COMPONENT,       /* name contains an empty component */
  39         NAME_ERR_TRAILING_SLASH,        /* name ends with a slash */
  40         NAME_ERR_INVALCHAR,             /* invalid character found */
  41         NAME_ERR_MULTIPLE_DELIMITERS,   /* multiple '@'/'#' delimiters found */
  42         NAME_ERR_NOLETTER,              /* pool doesn't begin with a letter */
  43         NAME_ERR_RESERVED,              /* entire name is reserved */
  44         NAME_ERR_DISKLIKE,              /* reserved disk name (c[0-9].*) */
  45         NAME_ERR_TOOLONG,               /* name is too long */
  46         NAME_ERR_SELF_REF,              /* reserved self path name ('.') */
  47         NAME_ERR_PARENT_REF,            /* reserved parent path name ('..') */
  48         NAME_ERR_NO_AT,                 /* permission set is missing '@' */
  49         NAME_ERR_NO_POUND,              /* permission set is missing '#' */
  50 } namecheck_err_t;
  51
  52 #define ZFS_PERMSET_MAXLEN      64
  53
  54 _ZFS_NAMECHECK_H int zfs_max_dataset_nesting;
  55
  56 _ZFS_NAMECHECK_H int get_dataset_depth(const char *);
  57 _ZFS_NAMECHECK_H int pool_namecheck(const char *, namecheck_err_t *, char *);
  58 _ZFS_NAMECHECK_H int entity_namecheck(const char *, namecheck_err_t *, char *);
  59 _ZFS_NAMECHECK_H int dataset_namecheck(const char *, namecheck_err_t *, char *);
  60 _ZFS_NAMECHECK_H int snapshot_namecheck(const char *, namecheck_err_t *,
  61     char *);
  62 _ZFS_NAMECHECK_H int bookmark_namecheck(const char *, namecheck_err_t *,
  63     char *);
  64 _ZFS_NAMECHECK_H int dataset_nestcheck(const char *);
  65 _ZFS_NAMECHECK_H int mountpoint_namecheck(const char *, namecheck_err_t *);
  66 _ZFS_NAMECHECK_H int zfs_component_namecheck(const char *, namecheck_err_t *,
  67     char *);
  68 _ZFS_NAMECHECK_H int permset_namecheck(const char *, namecheck_err_t *,
  69     char *);
  70
  71 #ifdef  __cplusplus
  72 }
  73 #endif
  74
  75 #endif  /* _ZFS_NAMECHECK_H */