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 2007 Sun Microsystems, Inc. All rights reserved. 23 * Use is subject to license terms. 24 */ 25 26 #pragma ident "%Z%%M% %I% %E% SMI" 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 /* string properties */ 62 register_string(ZPOOL_PROP_ALTROOT, "altroot", NULL, PROP_DEFAULT, 63 ZFS_TYPE_POOL, "<path>", "ALTROOT"); 64 register_string(ZPOOL_PROP_BOOTFS, "bootfs", NULL, PROP_DEFAULT, 65 ZFS_TYPE_POOL, "<filesystem>", "BOOTFS"); 66 67 /* readonly number properties */ 68 register_number(ZPOOL_PROP_SIZE, "size", 0, PROP_READONLY, 69 ZFS_TYPE_POOL, "<size>", "SIZE"); 70 register_number(ZPOOL_PROP_USED, "used", 0, PROP_READONLY, 71 ZFS_TYPE_POOL, "<size>", "USED"); 72 register_number(ZPOOL_PROP_AVAILABLE, "available", 0, PROP_READONLY, 73 ZFS_TYPE_POOL, "<size>", "AVAIL"); 74 register_number(ZPOOL_PROP_CAPACITY, "capacity", 0, PROP_READONLY, 75 ZFS_TYPE_POOL, "<size>", "CAP"); 76 register_number(ZPOOL_PROP_GUID, "guid", 0, PROP_READONLY, 77 ZFS_TYPE_POOL, "<guid>", "GUID"); 78 register_number(ZPOOL_PROP_HEALTH, "health", 0, PROP_READONLY, 79 ZFS_TYPE_POOL, "<state>", "HEALTH"); 80 81 /* default number properties */ 82 register_number(ZPOOL_PROP_VERSION, "version", SPA_VERSION, 83 PROP_DEFAULT, ZFS_TYPE_POOL, "<version>", "VERSION"); 84 85 /* default index (boolean) properties */ 86 register_index(ZPOOL_PROP_DELEGATION, "delegation", 1, PROP_DEFAULT, 87 ZFS_TYPE_POOL, "on | off", "DELEGATION", boolean_table); 88 register_index(ZPOOL_PROP_AUTOREPLACE, "autoreplace", 0, PROP_DEFAULT, 89 ZFS_TYPE_POOL, "on | off", "REPLACE", boolean_table); 90 register_index(ZPOOL_PROP_TEMPORARY, "temporary", 0, PROP_DEFAULT, 91 ZFS_TYPE_POOL, "on | off", "TEMP", boolean_table); 92 93 /* hidden properties */ 94 register_hidden(ZPOOL_PROP_NAME, "name", PROP_TYPE_STRING, 95 PROP_READONLY, ZFS_TYPE_POOL, "NAME"); 96 } 97 98 /* 99 * Given a property name and its type, returns the corresponding property ID. 100 */ 101 zpool_prop_t 102 zpool_name_to_prop(const char *propname) 103 { 104 return (zprop_name_to_prop(propname, ZFS_TYPE_POOL)); 105 } 106 107 /* 108 * Given a pool property ID, returns the corresponding name. 109 * Assuming the pool propety ID is valid. 110 */ 111 const char * 112 zpool_prop_to_name(zpool_prop_t prop) 113 { 114 return (zpool_prop_table[prop].pd_name); 115 } 116 117 zprop_type_t 118 zpool_prop_get_type(zpool_prop_t prop) 119 { 120 return (zpool_prop_table[prop].pd_proptype); 121 } 122 123 boolean_t 124 zpool_prop_readonly(zpool_prop_t prop) 125 { 126 return (zpool_prop_table[prop].pd_attr == PROP_READONLY); 127 } 128 129 const char * 130 zpool_prop_default_string(zpool_prop_t prop) 131 { 132 return (zpool_prop_table[prop].pd_strdefault); 133 } 134 135 uint64_t 136 zpool_prop_default_numeric(zpool_prop_t prop) 137 { 138 return (zpool_prop_table[prop].pd_numdefault); 139 } 140 141 int 142 zpool_prop_string_to_index(zpool_prop_t prop, const char *string, 143 uint64_t *index) 144 { 145 return (zprop_string_to_index(prop, string, index, ZFS_TYPE_POOL)); 146 } 147 148 int 149 zpool_prop_index_to_string(zpool_prop_t prop, uint64_t index, 150 const char **string) 151 { 152 return (zprop_index_to_string(prop, index, string, ZFS_TYPE_POOL)); 153 } 154 155 #ifndef _KERNEL 156 157 const char * 158 zpool_prop_values(zpool_prop_t prop) 159 { 160 return (zpool_prop_table[prop].pd_values); 161 } 162 163 const char * 164 zpool_prop_column_name(zpool_prop_t prop) 165 { 166 return (zpool_prop_table[prop].pd_colname); 167 } 168 169 boolean_t 170 zpool_prop_align_right(zpool_prop_t prop) 171 { 172 return (zpool_prop_table[prop].pd_rightalign); 173 } 174 #endif 175