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