module/zcommon/zpool_prop.c

   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 (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
  23  * Copyright 2011 Nexenta Systems, Inc. All rights reserved.
  24  * Copyright (c) 2011 by Delphix. All rights reserved.
  25  */
  26
  27 #include <sys/zio.h>
  28 #include <sys/spa.h>
  29 #include <sys/zfs_acl.h>
  30 #include <sys/zfs_ioctl.h>
  31 #include <sys/fs/zfs.h>
  32
  33 #include "zfs_prop.h"
  34
  35 #if defined(_KERNEL)
  36 #include <sys/systm.h>
  37 #else
  38 #include <stdlib.h>
  39 #include <string.h>
  40 #include <ctype.h>
  41 #endif
  42
  43 static zprop_desc_t zpool_prop_table[ZPOOL_NUM_PROPS];
  44
  45 zprop_desc_t *
  46 zpool_prop_get_table(void)
  47 {
  48         return (zpool_prop_table);
  49 }
  50
  51 void
  52 zpool_prop_init(void)
  53 {
  54         static zprop_index_t boolean_table[] = {
  55                 { "off",        0},
  56                 { "on",         1},
  57                 { NULL }
  58         };
  59
  60         static zprop_index_t failuremode_table[] = {
  61                 { "wait",       ZIO_FAILURE_MODE_WAIT },
  62                 { "continue",   ZIO_FAILURE_MODE_CONTINUE },
  63                 { "panic",      ZIO_FAILURE_MODE_PANIC },
  64                 { NULL }
  65         };
  66
  67         /* string properties */
  68         zprop_register_string(ZPOOL_PROP_ALTROOT, "altroot", NULL, PROP_DEFAULT,
  69             ZFS_TYPE_POOL, "<path>", "ALTROOT");
  70         zprop_register_string(ZPOOL_PROP_BOOTFS, "bootfs", NULL, PROP_DEFAULT,
  71             ZFS_TYPE_POOL, "<filesystem>", "BOOTFS");
  72         zprop_register_string(ZPOOL_PROP_CACHEFILE, "cachefile", NULL,
  73             PROP_DEFAULT, ZFS_TYPE_POOL, "<file> | none", "CACHEFILE");
  74         zprop_register_string(ZPOOL_PROP_COMMENT, "comment", NULL,
  75             PROP_DEFAULT, ZFS_TYPE_POOL, "<comment-string>", "COMMENT");
  76
  77         /* readonly number properties */
  78         zprop_register_number(ZPOOL_PROP_SIZE, "size", 0, PROP_READONLY,
  79             ZFS_TYPE_POOL, "<size>", "SIZE");
  80         zprop_register_number(ZPOOL_PROP_FREE, "free", 0, PROP_READONLY,
  81             ZFS_TYPE_POOL, "<size>", "FREE");
  82         zprop_register_number(ZPOOL_PROP_ALLOCATED, "allocated", 0,
  83             PROP_READONLY, ZFS_TYPE_POOL, "<size>", "ALLOC");
  84         zprop_register_number(ZPOOL_PROP_CAPACITY, "capacity", 0, PROP_READONLY,
  85             ZFS_TYPE_POOL, "<size>", "CAP");
  86         zprop_register_number(ZPOOL_PROP_GUID, "guid", 0, PROP_READONLY,
  87             ZFS_TYPE_POOL, "<guid>", "GUID");
  88         zprop_register_number(ZPOOL_PROP_HEALTH, "health", 0, PROP_READONLY,
  89             ZFS_TYPE_POOL, "<state>", "HEALTH");
  90         zprop_register_number(ZPOOL_PROP_DEDUPRATIO, "dedupratio", 0,
  91             PROP_READONLY, ZFS_TYPE_POOL, "<1.00x or higher if deduped>",
  92             "DEDUP");
  93
  94         /* readonly onetime number properties */
  95         zprop_register_number(ZPOOL_PROP_ASHIFT, "ashift", 0, PROP_ONETIME,
  96             ZFS_TYPE_POOL, "<ashift, 9-13, or 0=default>", "ASHIFT");
  97
  98         /* default number properties */
  99         zprop_register_number(ZPOOL_PROP_VERSION, "version", SPA_VERSION,
 100             PROP_DEFAULT, ZFS_TYPE_POOL, "<version>", "VERSION");
 101         zprop_register_number(ZPOOL_PROP_DEDUPDITTO, "dedupditto", 0,
 102             PROP_DEFAULT, ZFS_TYPE_POOL, "<threshold (min 100)>", "DEDUPDITTO");
 103
 104         /* default index (boolean) properties */
 105         zprop_register_index(ZPOOL_PROP_DELEGATION, "delegation", 1,
 106             PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "DELEGATION",
 107             boolean_table);
 108         zprop_register_index(ZPOOL_PROP_AUTOREPLACE, "autoreplace", 0,
 109             PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "REPLACE", boolean_table);
 110         zprop_register_index(ZPOOL_PROP_LISTSNAPS, "listsnapshots", 0,
 111             PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "LISTSNAPS",
 112             boolean_table);
 113         zprop_register_index(ZPOOL_PROP_AUTOEXPAND, "autoexpand", 0,
 114             PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "EXPAND", boolean_table);
 115         zprop_register_index(ZPOOL_PROP_READONLY, "readonly", 0,
 116             PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "RDONLY", boolean_table);
 117
 118         /* default index properties */
 119         zprop_register_index(ZPOOL_PROP_FAILUREMODE, "failmode",
 120             ZIO_FAILURE_MODE_WAIT, PROP_DEFAULT, ZFS_TYPE_POOL,
 121             "wait | continue | panic", "FAILMODE", failuremode_table);
 122
 123         /* hidden properties */
 124         zprop_register_hidden(ZPOOL_PROP_NAME, "name", PROP_TYPE_STRING,
 125             PROP_READONLY, ZFS_TYPE_POOL, "NAME");
 126 }
 127
 128 /*
 129  * Given a property name and its type, returns the corresponding property ID.
 130  */
 131 zpool_prop_t
 132 zpool_name_to_prop(const char *propname)
 133 {
 134         return (zprop_name_to_prop(propname, ZFS_TYPE_POOL));
 135 }
 136
 137 /*
 138  * Given a pool property ID, returns the corresponding name.
 139  * Assuming the pool propety ID is valid.
 140  */
 141 const char *
 142 zpool_prop_to_name(zpool_prop_t prop)
 143 {
 144         return (zpool_prop_table[prop].pd_name);
 145 }
 146
 147 zprop_type_t
 148 zpool_prop_get_type(zpool_prop_t prop)
 149 {
 150         return (zpool_prop_table[prop].pd_proptype);
 151 }
 152
 153 boolean_t
 154 zpool_prop_readonly(zpool_prop_t prop)
 155 {
 156         return (zpool_prop_table[prop].pd_attr == PROP_READONLY);
 157 }
 158
 159 const char *
 160 zpool_prop_default_string(zpool_prop_t prop)
 161 {
 162         return (zpool_prop_table[prop].pd_strdefault);
 163 }
 164
 165 uint64_t
 166 zpool_prop_default_numeric(zpool_prop_t prop)
 167 {
 168         return (zpool_prop_table[prop].pd_numdefault);
 169 }
 170
 171 int
 172 zpool_prop_string_to_index(zpool_prop_t prop, const char *string,
 173     uint64_t *index)
 174 {
 175         return (zprop_string_to_index(prop, string, index, ZFS_TYPE_POOL));
 176 }
 177
 178 int
 179 zpool_prop_index_to_string(zpool_prop_t prop, uint64_t index,
 180     const char **string)
 181 {
 182         return (zprop_index_to_string(prop, index, string, ZFS_TYPE_POOL));
 183 }
 184
 185 uint64_t
 186 zpool_prop_random_value(zpool_prop_t prop, uint64_t seed)
 187 {
 188         return (zprop_random_value(prop, seed, ZFS_TYPE_POOL));
 189 }
 190
 191 #ifndef _KERNEL
 192
 193 const char *
 194 zpool_prop_values(zpool_prop_t prop)
 195 {
 196         return (zpool_prop_table[prop].pd_values);
 197 }
 198
 199 const char *
 200 zpool_prop_column_name(zpool_prop_t prop)
 201 {
 202         return (zpool_prop_table[prop].pd_colname);
 203 }
 204
 205 boolean_t
 206 zpool_prop_align_right(zpool_prop_t prop)
 207 {
 208         return (zpool_prop_table[prop].pd_rightalign);
 209 }
 210 #endif
 211
 212 #if defined(_KERNEL) && defined(HAVE_SPL)
 213 /* zpool property functions */
 214 EXPORT_SYMBOL(zpool_prop_init);
 215 EXPORT_SYMBOL(zpool_prop_get_type);
 216 EXPORT_SYMBOL(zpool_prop_get_table);
 217
 218 /* Pool property functions shared between libzfs and kernel. */
 219 EXPORT_SYMBOL(zpool_name_to_prop);
 220 EXPORT_SYMBOL(zpool_prop_to_name);
 221 EXPORT_SYMBOL(zpool_prop_default_string);
 222 EXPORT_SYMBOL(zpool_prop_default_numeric);
 223 EXPORT_SYMBOL(zpool_prop_readonly);
 224 EXPORT_SYMBOL(zpool_prop_index_to_string);
 225 EXPORT_SYMBOL(zpool_prop_string_to_index);
 226 #endif