/*

 * 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 http://www.opensolaris.org/os/licensing.

 * 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

 */

/*

 * Use is subject to license terms.

 */

#include <sys/zio.h>

#include <sys/spa.h>

#include <sys/u8_textprep.h>

#include <sys/zfs_acl.h>

#include <sys/zfs_ioctl.h>

#include <sys/zfs_znode.h>

#include "zfs_prop.h"

#include "zfs_deleg.h"

#if defined(_KERNEL)

#include <sys/systm.h>

#else

#include <stdlib.h>

#include <string.h>

#include <ctype.h>

#endif

static zprop_desc_t zfs_prop_table[ZFS_NUM_PROPS];

zprop_desc_t *

zfs_prop_get_table(void)

{

	return (zfs_prop_table);

}

void

zfs_prop_init(void)

{

	static zprop_index_t checksum_table[] = {

		{ "on",		ZIO_CHECKSUM_ON },

		{ "off",	ZIO_CHECKSUM_OFF },

		{ "fletcher2",	ZIO_CHECKSUM_FLETCHER_2 },

		{ "fletcher4",	ZIO_CHECKSUM_FLETCHER_4 },

		{ "sha256",	ZIO_CHECKSUM_SHA256 },

		{ NULL }

	};

	static zprop_index_t compress_table[] = {

		{ "on",		ZIO_COMPRESS_ON },

		{ "off",	ZIO_COMPRESS_OFF },

		{ "lzjb",	ZIO_COMPRESS_LZJB },

		{ "gzip",	ZIO_COMPRESS_GZIP_6 },	/* gzip default */

		{ "gzip-1",	ZIO_COMPRESS_GZIP_1 },

		{ "gzip-2",	ZIO_COMPRESS_GZIP_2 },

		{ "gzip-3",	ZIO_COMPRESS_GZIP_3 },

		{ "gzip-4",	ZIO_COMPRESS_GZIP_4 },

		{ "gzip-5",	ZIO_COMPRESS_GZIP_5 },

		{ "gzip-6",	ZIO_COMPRESS_GZIP_6 },

		{ "gzip-7",	ZIO_COMPRESS_GZIP_7 },

		{ "gzip-8",	ZIO_COMPRESS_GZIP_8 },

		{ "gzip-9",	ZIO_COMPRESS_GZIP_9 },

		{ NULL }

	};

	static zprop_index_t snapdir_table[] = {

		{ "hidden",	ZFS_SNAPDIR_HIDDEN },

		{ "visible",	ZFS_SNAPDIR_VISIBLE },

		{ NULL }

	};

	static zprop_index_t acl_mode_table[] = {

		{ "discard",	ZFS_ACL_DISCARD },

		{ "groupmask",	ZFS_ACL_GROUPMASK },

		{ "passthrough", ZFS_ACL_PASSTHROUGH },

		{ NULL }

	};

	static zprop_index_t acl_inherit_table[] = {

		{ "discard",	ZFS_ACL_DISCARD },

		{ "noallow",	ZFS_ACL_NOALLOW },

		{ "restricted",	ZFS_ACL_RESTRICTED },

		{ "passthrough", ZFS_ACL_PASSTHROUGH },

		{ "secure",	ZFS_ACL_RESTRICTED }, /* bkwrd compatability */

		{ "passthrough-x", ZFS_ACL_PASSTHROUGH_X },

		{ NULL }

	};

	static zprop_index_t case_table[] = {

		{ "sensitive",		ZFS_CASE_SENSITIVE },

		{ "insensitive",	ZFS_CASE_INSENSITIVE },

		{ "mixed",		ZFS_CASE_MIXED },

		{ NULL }

	};

	static zprop_index_t copies_table[] = {

		{ "1",		1 },

		{ "2",		2 },

		{ "3",		3 },

		{ NULL }

	};

	/*

	 * Use the unique flags we have to send to u8_strcmp() and/or

	 * u8_textprep() to represent the various normalization property

	 * values.

	 */

	static zprop_index_t normalize_table[] = {

		{ "none",	0 },

		{ "formD",	U8_TEXTPREP_NFD },

		{ "formKC",	U8_TEXTPREP_NFKC },

		{ "formC",	U8_TEXTPREP_NFC },

		{ "formKD",	U8_TEXTPREP_NFKD },

		{ NULL }

	};

	static zprop_index_t version_table[] = {

		{ "1",		1 },

		{ "2",		2 },

		{ "3",		3 },

		{ "current",	ZPL_VERSION },

		{ NULL }

	};

	static zprop_index_t boolean_table[] = {

		{ "off",	0 },

		{ "on",		1 },

		{ NULL }

	};

	static zprop_index_t canmount_table[] = {

		{ "off",	ZFS_CANMOUNT_OFF },

		{ "on",		ZFS_CANMOUNT_ON },

		{ "noauto",	ZFS_CANMOUNT_NOAUTO },

		{ NULL }

	};

	static zprop_index_t cache_table[] = {

		{ "none",	ZFS_CACHE_NONE },

		{ "metadata",	ZFS_CACHE_METADATA },

		{ "all",	ZFS_CACHE_ALL },

		{ NULL }

	};

	/* inherit index properties */

	register_index(ZFS_PROP_CHECKSUM, "checksum", ZIO_CHECKSUM_DEFAULT,

	    PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,

	    "on | off | fletcher2 | fletcher4 | sha256", "CHECKSUM",

	    checksum_table);

	register_index(ZFS_PROP_COMPRESSION, "compression",

	    ZIO_COMPRESS_DEFAULT, PROP_INHERIT,

	    ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,

	    "on | off | lzjb | gzip | gzip-[1-9]", "COMPRESS", compress_table);

	register_index(ZFS_PROP_SNAPDIR, "snapdir", ZFS_SNAPDIR_HIDDEN,

	    PROP_INHERIT, ZFS_TYPE_FILESYSTEM,

	    "hidden | visible", "SNAPDIR", snapdir_table);

	register_index(ZFS_PROP_ACLMODE, "aclmode", ZFS_ACL_GROUPMASK,

	    PROP_INHERIT, ZFS_TYPE_FILESYSTEM,

	    "discard | groupmask | passthrough", "ACLMODE", acl_mode_table);

	register_index(ZFS_PROP_ACLINHERIT, "aclinherit", ZFS_ACL_RESTRICTED,

	    PROP_INHERIT, ZFS_TYPE_FILESYSTEM,

	    "discard | noallow | restricted | passthrough | passthrough-x",

	    "ACLINHERIT", acl_inherit_table);

	register_index(ZFS_PROP_COPIES, "copies", 1,

	    PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,

	    "1 | 2 | 3", "COPIES", copies_table);

	register_index(ZFS_PROP_PRIMARYCACHE, "primarycache",

	    ZFS_CACHE_ALL, PROP_INHERIT,

	    ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT | ZFS_TYPE_VOLUME,

	    "all | none | metadata", "PRIMARYCACHE", cache_table);

	register_index(ZFS_PROP_SECONDARYCACHE, "secondarycache",

	    ZFS_CACHE_ALL, PROP_INHERIT,

	    ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT | ZFS_TYPE_VOLUME,

	    "all | none | metadata", "SECONDARYCACHE", cache_table);

	/* inherit index (boolean) properties */

	register_index(ZFS_PROP_ATIME, "atime", 1, PROP_INHERIT,

	    ZFS_TYPE_FILESYSTEM, "on | off", "ATIME", boolean_table);

	register_index(ZFS_PROP_DEVICES, "devices", 1, PROP_INHERIT,

	    ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "DEVICES",

	    boolean_table);

	register_index(ZFS_PROP_EXEC, "exec", 1, PROP_INHERIT,

	    ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "EXEC",

	    boolean_table);

	register_index(ZFS_PROP_SETUID, "setuid", 1, PROP_INHERIT,

	    ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "SETUID",

	    boolean_table);

	register_index(ZFS_PROP_READONLY, "readonly", 0, PROP_INHERIT,

	    ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "on | off", "RDONLY",

	    boolean_table);

	register_index(ZFS_PROP_ZONED, "zoned", 0, PROP_INHERIT,

	    ZFS_TYPE_FILESYSTEM, "on | off", "ZONED", boolean_table);

	register_index(ZFS_PROP_XATTR, "xattr", 1, PROP_INHERIT,

	    ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "XATTR",

	    boolean_table);

	register_index(ZFS_PROP_VSCAN, "vscan", 0, PROP_INHERIT,

	    ZFS_TYPE_FILESYSTEM, "on | off", "VSCAN",

	    boolean_table);

	register_index(ZFS_PROP_NBMAND, "nbmand", 0, PROP_INHERIT,

	    ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "NBMAND",

	    boolean_table);

	/* default index properties */

	register_index(ZFS_PROP_VERSION, "version", 0, PROP_DEFAULT,

	    ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT,

	register_index(ZFS_PROP_CANMOUNT, "canmount", ZFS_CANMOUNT_ON,

	    PROP_DEFAULT, ZFS_TYPE_FILESYSTEM, "on | off | noauto",

	    "CANMOUNT", canmount_table);

	/* readonly index (boolean) properties */

	register_index(ZFS_PROP_MOUNTED, "mounted", 0, PROP_READONLY,

	    ZFS_TYPE_FILESYSTEM, "yes | no", "MOUNTED", boolean_table);

	/* set once index properties */

	register_index(ZFS_PROP_NORMALIZE, "normalization", 0,

	    PROP_ONETIME, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT,

	    "none | formC | formD | formKC | formKD", "NORMALIZATION",

	    normalize_table);

	register_index(ZFS_PROP_CASE, "casesensitivity", ZFS_CASE_SENSITIVE,

	    PROP_ONETIME, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT,

	    "sensitive | insensitive | mixed", "CASE", case_table);

	/* set once index (boolean) properties */

	register_index(ZFS_PROP_UTF8ONLY, "utf8only", 0, PROP_ONETIME,

	    ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT,

	    "on | off", "UTF8ONLY", boolean_table);

	/* string properties */

	register_string(ZFS_PROP_ORIGIN, "origin", NULL, PROP_READONLY,

	    ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<snapshot>", "ORIGIN");

	register_string(ZFS_PROP_MOUNTPOINT, "mountpoint", "/", PROP_INHERIT,

	    ZFS_TYPE_FILESYSTEM, "<path> | legacy | none", "MOUNTPOINT");

	register_string(ZFS_PROP_SHARENFS, "sharenfs", "off", PROP_INHERIT,

	    ZFS_TYPE_FILESYSTEM, "on | off | share(1M) options", "SHARENFS");

	register_string(ZFS_PROP_SHAREISCSI, "shareiscsi", "off", PROP_INHERIT,

	    ZFS_TYPE_DATASET, "on | off | type=<type>", "SHAREISCSI");

	register_string(ZFS_PROP_TYPE, "type", NULL, PROP_READONLY,

	    ZFS_TYPE_DATASET, "filesystem | volume | snapshot", "TYPE");

	register_string(ZFS_PROP_SHARESMB, "sharesmb", "off", PROP_INHERIT,

	    ZFS_TYPE_FILESYSTEM, "on | off | sharemgr(1M) options", "SHARESMB");

	/* readonly number properties */

	register_number(ZFS_PROP_USED, "used", 0, PROP_READONLY,

	    ZFS_TYPE_DATASET, "<size>", "USED");

	register_number(ZFS_PROP_AVAILABLE, "available", 0, PROP_READONLY,

	    ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", "AVAIL");

	register_number(ZFS_PROP_REFERENCED, "referenced", 0, PROP_READONLY,

	    ZFS_TYPE_DATASET, "<size>", "REFER");

	register_number(ZFS_PROP_COMPRESSRATIO, "compressratio", 0,

	    PROP_READONLY, ZFS_TYPE_DATASET,

	    "<1.00x or higher if compressed>", "RATIO");

	register_number(ZFS_PROP_VOLBLOCKSIZE, "volblocksize", 8192,

	    PROP_ONETIME,

	    ZFS_TYPE_VOLUME, "512 to 128k, power of 2",	"VOLBLOCK");

	register_number(ZFS_PROP_USEDSNAP, "usedbysnapshots", 0, PROP_READONLY,

	    ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", "USEDSNAP");

	register_number(ZFS_PROP_USEDDS, "usedbydataset", 0, PROP_READONLY,

	    ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", "USEDDS");

	register_number(ZFS_PROP_USEDCHILD, "usedbychildren", 0, PROP_READONLY,

	    ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", "USEDCHILD");

	register_number(ZFS_PROP_USEDREFRESERV, "usedbyrefreservation", 0,

	    PROP_READONLY,

	    ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", "USEDREFRESERV");

	/* default number properties */

	register_number(ZFS_PROP_QUOTA, "quota", 0, PROP_DEFAULT,

	    ZFS_TYPE_FILESYSTEM, "<size> | none", "QUOTA");

	register_number(ZFS_PROP_RESERVATION, "reservation", 0, PROP_DEFAULT,

	    ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size> | none", "RESERV");

	register_number(ZFS_PROP_VOLSIZE, "volsize", 0, PROP_DEFAULT,

	    ZFS_TYPE_VOLUME, "<size>", "VOLSIZE");

	register_number(ZFS_PROP_REFQUOTA, "refquota", 0, PROP_DEFAULT,

	    ZFS_TYPE_FILESYSTEM, "<size> | none", "REFQUOTA");

	register_number(ZFS_PROP_REFRESERVATION, "refreservation", 0,

	    PROP_DEFAULT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,

	    "<size> | none", "REFRESERV");

	/* inherit number properties */

	register_number(ZFS_PROP_RECORDSIZE, "recordsize", SPA_MAXBLOCKSIZE,

	    PROP_INHERIT,

	    ZFS_TYPE_FILESYSTEM, "512 to 128k, power of 2", "RECSIZE");

	/* hidden properties */

	register_hidden(ZFS_PROP_CREATETXG, "createtxg", PROP_TYPE_NUMBER,

	    PROP_READONLY, ZFS_TYPE_DATASET, NULL);

	register_hidden(ZFS_PROP_NUMCLONES, "numclones", PROP_TYPE_NUMBER,

	    PROP_READONLY, ZFS_TYPE_SNAPSHOT, NULL);

	register_hidden(ZFS_PROP_NAME, "name", PROP_TYPE_STRING,

	    PROP_READONLY, ZFS_TYPE_DATASET, "NAME");

	register_hidden(ZFS_PROP_ISCSIOPTIONS, "iscsioptions", PROP_TYPE_STRING,

	    PROP_INHERIT, ZFS_TYPE_VOLUME, "ISCSIOPTIONS");

	register_hidden(ZFS_PROP_GUID, "guid", PROP_TYPE_NUMBER, PROP_READONLY,

	    ZFS_TYPE_DATASET, "GUID");

	/* oddball properties */

	register_impl(ZFS_PROP_CREATION, "creation", PROP_TYPE_NUMBER, 0, NULL,

	    PROP_READONLY, ZFS_TYPE_DATASET,

	    "<date>", "CREATION", B_FALSE, B_TRUE, NULL);

}

boolean_t

zfs_prop_delegatable(zfs_prop_t prop)

{

	zprop_desc_t *pd = &zfs_prop_table[prop];

	return (pd->pd_attr != PROP_READONLY);

}

/*

 * Given a zfs dataset property name, returns the corresponding property ID.

 */

zfs_prop_t

zfs_name_to_prop(const char *propname)

{

	return (zprop_name_to_prop(propname, ZFS_TYPE_DATASET));

}

/*

 * For user property names, we allow all lowercase alphanumeric characters, plus

 * a few useful punctuation characters.

 */

static int

valid_char(char c)

{

	return ((c >= 'a' && c <= 'z') ||

	    (c >= '0' && c <= '9') ||

	    c == '-' || c == '_' || c == '.' || c == ':');

}

/*

 * Returns true if this is a valid user-defined property (one with a ':').

 */

boolean_t

zfs_prop_user(const char *name)

{

	int i;

	char c;

	boolean_t foundsep = B_FALSE;

	for (i = 0; i < strlen(name); i++) {

		c = name[i];

		if (!valid_char(c))

			return (B_FALSE);

		if (c == ':')

			foundsep = B_TRUE;

	}

	if (!foundsep)

		return (B_FALSE);

	return (B_TRUE);

}

/*

 * Tables of index types, plus functions to convert between the user view

 * (strings) and internal representation (uint64_t).

 */

int

zfs_prop_string_to_index(zfs_prop_t prop, const char *string, uint64_t *index)

{

	return (zprop_string_to_index(prop, string, index, ZFS_TYPE_DATASET));

}

int

zfs_prop_index_to_string(zfs_prop_t prop, uint64_t index, const char **string)

{

	return (zprop_index_to_string(prop, index, string, ZFS_TYPE_DATASET));

}

/*

 * Returns TRUE if the property applies to any of the given dataset types.

 */

boolean_t

zfs_prop_valid_for_type(int prop, zfs_type_t types)

{

	return (zprop_valid_for_type(prop, types));

}

zprop_type_t

zfs_prop_get_type(zfs_prop_t prop)

{

	return (zfs_prop_table[prop].pd_proptype);

}

/*

 * Returns TRUE if the property is readonly.

 */

boolean_t

zfs_prop_readonly(zfs_prop_t prop)

{

	return (zfs_prop_table[prop].pd_attr == PROP_READONLY ||

	    zfs_prop_table[prop].pd_attr == PROP_ONETIME);

}

/*

 * Returns TRUE if the property is only allowed to be set once.

 */

boolean_t

zfs_prop_setonce(zfs_prop_t prop)

{

	return (zfs_prop_table[prop].pd_attr == PROP_ONETIME);

}

const char *

zfs_prop_default_string(zfs_prop_t prop)

{

	return (zfs_prop_table[prop].pd_strdefault);

}

uint64_t

zfs_prop_default_numeric(zfs_prop_t prop)

{

	return (zfs_prop_table[prop].pd_numdefault);

}

/*

 * Given a dataset property ID, returns the corresponding name.

 * Assuming the zfs dataset property ID is valid.

 */

const char *

zfs_prop_to_name(zfs_prop_t prop)

{

	return (zfs_prop_table[prop].pd_name);

}

/*

 * Returns TRUE if the property is inheritable.

 */

boolean_t

zfs_prop_inheritable(zfs_prop_t prop)

{

	return (zfs_prop_table[prop].pd_attr == PROP_INHERIT ||

	    zfs_prop_table[prop].pd_attr == PROP_ONETIME);

}

#ifndef _KERNEL

/*

 * Returns a string describing the set of acceptable values for the given

 * zfs property, or NULL if it cannot be set.

 */

const char *

zfs_prop_values(zfs_prop_t prop)

{

	return (zfs_prop_table[prop].pd_values);