zpool_prop.c revision 268650
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 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 43static zprop_desc_t zpool_prop_table[ZPOOL_NUM_PROPS]; 44 45zprop_desc_t * 46zpool_prop_get_table(void) 47{ 48 return (zpool_prop_table); 49} 50 51void 52zpool_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_FREEING, "freeing", 0, PROP_READONLY, 83 ZFS_TYPE_POOL, "<size>", "FREEING"); 84 zprop_register_number(ZPOOL_PROP_LEAKED, "leaked", 0, PROP_READONLY, 85 ZFS_TYPE_POOL, "<size>", "LEAKED"); 86 zprop_register_number(ZPOOL_PROP_ALLOCATED, "allocated", 0, 87 PROP_READONLY, ZFS_TYPE_POOL, "<size>", "ALLOC"); 88 zprop_register_number(ZPOOL_PROP_EXPANDSZ, "expandsize", 0, 89 PROP_READONLY, ZFS_TYPE_POOL, "<size>", "EXPANDSZ"); 90 zprop_register_number(ZPOOL_PROP_CAPACITY, "capacity", 0, PROP_READONLY, 91 ZFS_TYPE_POOL, "<size>", "CAP"); 92 zprop_register_number(ZPOOL_PROP_GUID, "guid", 0, PROP_READONLY, 93 ZFS_TYPE_POOL, "<guid>", "GUID"); 94 zprop_register_number(ZPOOL_PROP_HEALTH, "health", 0, PROP_READONLY, 95 ZFS_TYPE_POOL, "<state>", "HEALTH"); 96 zprop_register_number(ZPOOL_PROP_DEDUPRATIO, "dedupratio", 0, 97 PROP_READONLY, ZFS_TYPE_POOL, "<1.00x or higher if deduped>", 98 "DEDUP"); 99 100 /* default number properties */ 101 zprop_register_number(ZPOOL_PROP_VERSION, "version", SPA_VERSION, 102 PROP_DEFAULT, ZFS_TYPE_POOL, "<version>", "VERSION"); 103 zprop_register_number(ZPOOL_PROP_DEDUPDITTO, "dedupditto", 0, 104 PROP_DEFAULT, ZFS_TYPE_POOL, "<threshold (min 100)>", "DEDUPDITTO"); 105 106 /* default index (boolean) properties */ 107 zprop_register_index(ZPOOL_PROP_DELEGATION, "delegation", 1, 108 PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "DELEGATION", 109 boolean_table); 110 zprop_register_index(ZPOOL_PROP_AUTOREPLACE, "autoreplace", 0, 111 PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "REPLACE", boolean_table); 112 zprop_register_index(ZPOOL_PROP_LISTSNAPS, "listsnapshots", 0, 113 PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "LISTSNAPS", 114 boolean_table); 115 zprop_register_index(ZPOOL_PROP_AUTOEXPAND, "autoexpand", 0, 116 PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "EXPAND", boolean_table); 117 zprop_register_index(ZPOOL_PROP_READONLY, "readonly", 0, 118 PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "RDONLY", boolean_table); 119 120 /* default index properties */ 121 zprop_register_index(ZPOOL_PROP_FAILUREMODE, "failmode", 122 ZIO_FAILURE_MODE_WAIT, PROP_DEFAULT, ZFS_TYPE_POOL, 123 "wait | continue | panic", "FAILMODE", failuremode_table); 124 125 /* hidden properties */ 126 zprop_register_hidden(ZPOOL_PROP_NAME, "name", PROP_TYPE_STRING, 127 PROP_READONLY, ZFS_TYPE_POOL, "NAME"); 128} 129 130/* 131 * Given a property name and its type, returns the corresponding property ID. 132 */ 133zpool_prop_t 134zpool_name_to_prop(const char *propname) 135{ 136 return (zprop_name_to_prop(propname, ZFS_TYPE_POOL)); 137} 138 139/* 140 * Given a pool property ID, returns the corresponding name. 141 * Assuming the pool propety ID is valid. 142 */ 143const char * 144zpool_prop_to_name(zpool_prop_t prop) 145{ 146 return (zpool_prop_table[prop].pd_name); 147} 148 149zprop_type_t 150zpool_prop_get_type(zpool_prop_t prop) 151{ 152 return (zpool_prop_table[prop].pd_proptype); 153} 154 155boolean_t 156zpool_prop_readonly(zpool_prop_t prop) 157{ 158 return (zpool_prop_table[prop].pd_attr == PROP_READONLY); 159} 160 161const char * 162zpool_prop_default_string(zpool_prop_t prop) 163{ 164 return (zpool_prop_table[prop].pd_strdefault); 165} 166 167uint64_t 168zpool_prop_default_numeric(zpool_prop_t prop) 169{ 170 return (zpool_prop_table[prop].pd_numdefault); 171} 172 173/* 174 * Returns true if this is a valid feature@ property. 175 */ 176boolean_t 177zpool_prop_feature(const char *name) 178{ 179 static const char *prefix = "feature@"; 180 return (strncmp(name, prefix, strlen(prefix)) == 0); 181} 182 183/* 184 * Returns true if this is a valid unsupported@ property. 185 */ 186boolean_t 187zpool_prop_unsupported(const char *name) 188{ 189 static const char *prefix = "unsupported@"; 190 return (strncmp(name, prefix, strlen(prefix)) == 0); 191} 192 193int 194zpool_prop_string_to_index(zpool_prop_t prop, const char *string, 195 uint64_t *index) 196{ 197 return (zprop_string_to_index(prop, string, index, ZFS_TYPE_POOL)); 198} 199 200int 201zpool_prop_index_to_string(zpool_prop_t prop, uint64_t index, 202 const char **string) 203{ 204 return (zprop_index_to_string(prop, index, string, ZFS_TYPE_POOL)); 205} 206 207uint64_t 208zpool_prop_random_value(zpool_prop_t prop, uint64_t seed) 209{ 210 return (zprop_random_value(prop, seed, ZFS_TYPE_POOL)); 211} 212 213#ifndef _KERNEL 214 215const char * 216zpool_prop_values(zpool_prop_t prop) 217{ 218 return (zpool_prop_table[prop].pd_values); 219} 220 221const char * 222zpool_prop_column_name(zpool_prop_t prop) 223{ 224 return (zpool_prop_table[prop].pd_colname); 225} 226 227boolean_t 228zpool_prop_align_right(zpool_prop_t prop) 229{ 230 return (zpool_prop_table[prop].pd_rightalign); 231} 232#endif 233