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