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