xref: /illumos-gate/usr/src/common/zfs/zfs_namecheck.h (revision 8b80e8cb6855118d46f605e91b5ed4ce83417395)
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  * Copyright 2007 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  */
25 
26 #ifndef	_ZFS_NAMECHECK_H
27 #define	_ZFS_NAMECHECK_H
28 
29 #pragma ident	"%Z%%M%	%I%	%E% SMI"
30 
31 #ifdef	__cplusplus
32 extern "C" {
33 #endif
34 
35 typedef enum {
36 	NAME_ERR_LEADING_SLASH,		/* name begins with leading slash */
37 	NAME_ERR_EMPTY_COMPONENT,	/* name contains an empty component */
38 	NAME_ERR_TRAILING_SLASH,	/* name ends with a slash */
39 	NAME_ERR_INVALCHAR,		/* invalid character found */
40 	NAME_ERR_MULTIPLE_AT,		/* multiple '@' characters found */
41 	NAME_ERR_NOLETTER,		/* pool doesn't begin with a letter */
42 	NAME_ERR_RESERVED,		/* entire name is reserved */
43 	NAME_ERR_DISKLIKE,		/* reserved disk name (c[0-9].*) */
44 	NAME_ERR_TOOLONG,		/* name is too long */
45 	NAME_ERR_NO_AT,			/* permission set is missing '@' */
46 } namecheck_err_t;
47 
48 #define	ZFS_PERMSET_MAXLEN	64
49 
50 int pool_namecheck(const char *, namecheck_err_t *, char *);
51 int dataset_namecheck(const char *, namecheck_err_t *, char *);
52 int mountpoint_namecheck(const char *, namecheck_err_t *);
53 int dataset_name_hidden(const char *);
54 int snapshot_namecheck(const char *, namecheck_err_t *, char *);
55 int permset_namecheck(const char *, namecheck_err_t *, char *);
56 
57 #ifdef	__cplusplus
58 }
59 #endif
60 
61 #endif	/* _ZFS_NAMECHECK_H */
62