1185029Spjd/* 2185029Spjd * CDDL HEADER START 3185029Spjd * 4185029Spjd * The contents of this file are subject to the terms of the 5185029Spjd * Common Development and Distribution License (the "License"). 6185029Spjd * You may not use this file except in compliance with the License. 7185029Spjd * 8185029Spjd * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9185029Spjd * or http://www.opensolaris.org/os/licensing. 10185029Spjd * See the License for the specific language governing permissions 11185029Spjd * and limitations under the License. 12185029Spjd * 13185029Spjd * When distributing Covered Code, include this CDDL HEADER in each 14185029Spjd * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15185029Spjd * If applicable, add the following below this CDDL HEADER, with the 16185029Spjd * fields enclosed by brackets "[]" replaced with your own identifying 17185029Spjd * information: Portions Copyright [yyyy] [name of copyright owner] 18185029Spjd * 19185029Spjd * CDDL HEADER END 20185029Spjd */ 21185029Spjd/* 22219089Spjd * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved. 23228103Smm * Copyright 2011 Nexenta Systems, Inc. All rights reserved. 24332547Smav * Copyright (c) 2012, 2017 by Delphix. All rights reserved. 25296519Smav * Copyright (c) 2014 Integros [integros.com] 26185029Spjd */ 27185029Spjd 28185029Spjd#include <sys/zio.h> 29185029Spjd#include <sys/spa.h> 30185029Spjd#include <sys/zfs_acl.h> 31185029Spjd#include <sys/zfs_ioctl.h> 32185029Spjd#include <sys/fs/zfs.h> 33185029Spjd 34185029Spjd#include "zfs_prop.h" 35185029Spjd 36185029Spjd#if defined(_KERNEL) 37185029Spjd#include <sys/systm.h> 38185029Spjd#else 39185029Spjd#include <stdlib.h> 40185029Spjd#include <string.h> 41185029Spjd#include <ctype.h> 42185029Spjd#endif 43185029Spjd 44185029Spjdstatic zprop_desc_t zpool_prop_table[ZPOOL_NUM_PROPS]; 45185029Spjd 46185029Spjdzprop_desc_t * 47185029Spjdzpool_prop_get_table(void) 48185029Spjd{ 49185029Spjd return (zpool_prop_table); 50185029Spjd} 51185029Spjd 52185029Spjdvoid 53185029Spjdzpool_prop_init(void) 54185029Spjd{ 55185029Spjd static zprop_index_t boolean_table[] = { 56185029Spjd { "off", 0}, 57185029Spjd { "on", 1}, 58185029Spjd { NULL } 59185029Spjd }; 60185029Spjd 61185029Spjd static zprop_index_t failuremode_table[] = { 62185029Spjd { "wait", ZIO_FAILURE_MODE_WAIT }, 63185029Spjd { "continue", ZIO_FAILURE_MODE_CONTINUE }, 64185029Spjd { "panic", ZIO_FAILURE_MODE_PANIC }, 65185029Spjd { NULL } 66185029Spjd }; 67185029Spjd 68185029Spjd /* string properties */ 69219089Spjd zprop_register_string(ZPOOL_PROP_ALTROOT, "altroot", NULL, PROP_DEFAULT, 70185029Spjd ZFS_TYPE_POOL, "<path>", "ALTROOT"); 71219089Spjd zprop_register_string(ZPOOL_PROP_BOOTFS, "bootfs", NULL, PROP_DEFAULT, 72185029Spjd ZFS_TYPE_POOL, "<filesystem>", "BOOTFS"); 73219089Spjd zprop_register_string(ZPOOL_PROP_CACHEFILE, "cachefile", NULL, 74219089Spjd PROP_DEFAULT, ZFS_TYPE_POOL, "<file> | none", "CACHEFILE"); 75228103Smm zprop_register_string(ZPOOL_PROP_COMMENT, "comment", NULL, 76228103Smm PROP_DEFAULT, ZFS_TYPE_POOL, "<comment-string>", "COMMENT"); 77185029Spjd 78185029Spjd /* readonly number properties */ 79219089Spjd zprop_register_number(ZPOOL_PROP_SIZE, "size", 0, PROP_READONLY, 80185029Spjd ZFS_TYPE_POOL, "<size>", "SIZE"); 81219089Spjd zprop_register_number(ZPOOL_PROP_FREE, "free", 0, PROP_READONLY, 82219089Spjd ZFS_TYPE_POOL, "<size>", "FREE"); 83236884Smm zprop_register_number(ZPOOL_PROP_FREEING, "freeing", 0, PROP_READONLY, 84236884Smm ZFS_TYPE_POOL, "<size>", "FREEING"); 85332547Smav zprop_register_number(ZPOOL_PROP_CHECKPOINT, "checkpoint", 0, 86332547Smav PROP_READONLY, ZFS_TYPE_POOL, "<size>", "CKPOINT"); 87268079Sdelphij zprop_register_number(ZPOOL_PROP_LEAKED, "leaked", 0, PROP_READONLY, 88268079Sdelphij ZFS_TYPE_POOL, "<size>", "LEAKED"); 89219089Spjd zprop_register_number(ZPOOL_PROP_ALLOCATED, "allocated", 0, 90219089Spjd PROP_READONLY, ZFS_TYPE_POOL, "<size>", "ALLOC"); 91236155Smm zprop_register_number(ZPOOL_PROP_EXPANDSZ, "expandsize", 0, 92236155Smm PROP_READONLY, ZFS_TYPE_POOL, "<size>", "EXPANDSZ"); 93269118Sdelphij zprop_register_number(ZPOOL_PROP_FRAGMENTATION, "fragmentation", 0, 94269118Sdelphij PROP_READONLY, ZFS_TYPE_POOL, "<percent>", "FRAG"); 95219089Spjd zprop_register_number(ZPOOL_PROP_CAPACITY, "capacity", 0, PROP_READONLY, 96185029Spjd ZFS_TYPE_POOL, "<size>", "CAP"); 97219089Spjd zprop_register_number(ZPOOL_PROP_GUID, "guid", 0, PROP_READONLY, 98185029Spjd ZFS_TYPE_POOL, "<guid>", "GUID"); 99219089Spjd zprop_register_number(ZPOOL_PROP_HEALTH, "health", 0, PROP_READONLY, 100185029Spjd ZFS_TYPE_POOL, "<state>", "HEALTH"); 101219089Spjd zprop_register_number(ZPOOL_PROP_DEDUPRATIO, "dedupratio", 0, 102219089Spjd PROP_READONLY, ZFS_TYPE_POOL, "<1.00x or higher if deduped>", 103219089Spjd "DEDUP"); 104185029Spjd 105331395Smav /* system partition size */ 106331395Smav zprop_register_number(ZPOOL_PROP_BOOTSIZE, "bootsize", 0, PROP_ONETIME, 107331395Smav ZFS_TYPE_POOL, "<size>", "BOOTSIZE"); 108331395Smav 109185029Spjd /* default number properties */ 110219089Spjd zprop_register_number(ZPOOL_PROP_VERSION, "version", SPA_VERSION, 111185029Spjd PROP_DEFAULT, ZFS_TYPE_POOL, "<version>", "VERSION"); 112219089Spjd zprop_register_number(ZPOOL_PROP_DEDUPDITTO, "dedupditto", 0, 113219089Spjd PROP_DEFAULT, ZFS_TYPE_POOL, "<threshold (min 100)>", "DEDUPDITTO"); 114185029Spjd 115185029Spjd /* default index (boolean) properties */ 116219089Spjd zprop_register_index(ZPOOL_PROP_DELEGATION, "delegation", 1, 117219089Spjd PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "DELEGATION", 118219089Spjd boolean_table); 119219089Spjd zprop_register_index(ZPOOL_PROP_AUTOREPLACE, "autoreplace", 0, 120219089Spjd PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "REPLACE", boolean_table); 121219089Spjd zprop_register_index(ZPOOL_PROP_LISTSNAPS, "listsnapshots", 0, 122219089Spjd PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "LISTSNAPS", 123219089Spjd boolean_table); 124219089Spjd zprop_register_index(ZPOOL_PROP_AUTOEXPAND, "autoexpand", 0, 125219089Spjd PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "EXPAND", boolean_table); 126219089Spjd zprop_register_index(ZPOOL_PROP_READONLY, "readonly", 0, 127219089Spjd PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "RDONLY", boolean_table); 128185029Spjd 129185029Spjd /* default index properties */ 130219089Spjd zprop_register_index(ZPOOL_PROP_FAILUREMODE, "failmode", 131185029Spjd ZIO_FAILURE_MODE_WAIT, PROP_DEFAULT, ZFS_TYPE_POOL, 132185029Spjd "wait | continue | panic", "FAILMODE", failuremode_table); 133185029Spjd 134185029Spjd /* hidden properties */ 135219089Spjd zprop_register_hidden(ZPOOL_PROP_NAME, "name", PROP_TYPE_STRING, 136185029Spjd PROP_READONLY, ZFS_TYPE_POOL, "NAME"); 137274337Sdelphij zprop_register_hidden(ZPOOL_PROP_MAXBLOCKSIZE, "maxblocksize", 138274337Sdelphij PROP_TYPE_NUMBER, PROP_READONLY, ZFS_TYPE_POOL, "MAXBLOCKSIZE"); 139333194Savg zprop_register_hidden(ZPOOL_PROP_TNAME, "tname", PROP_TYPE_STRING, 140333194Savg PROP_ONETIME, ZFS_TYPE_POOL, "TNAME"); 141185029Spjd} 142185029Spjd 143185029Spjd/* 144185029Spjd * Given a property name and its type, returns the corresponding property ID. 145185029Spjd */ 146185029Spjdzpool_prop_t 147185029Spjdzpool_name_to_prop(const char *propname) 148185029Spjd{ 149185029Spjd return (zprop_name_to_prop(propname, ZFS_TYPE_POOL)); 150185029Spjd} 151185029Spjd 152185029Spjd/* 153185029Spjd * Given a pool property ID, returns the corresponding name. 154185029Spjd * Assuming the pool propety ID is valid. 155185029Spjd */ 156185029Spjdconst char * 157185029Spjdzpool_prop_to_name(zpool_prop_t prop) 158185029Spjd{ 159185029Spjd return (zpool_prop_table[prop].pd_name); 160185029Spjd} 161185029Spjd 162185029Spjdzprop_type_t 163185029Spjdzpool_prop_get_type(zpool_prop_t prop) 164185029Spjd{ 165185029Spjd return (zpool_prop_table[prop].pd_proptype); 166185029Spjd} 167185029Spjd 168185029Spjdboolean_t 169185029Spjdzpool_prop_readonly(zpool_prop_t prop) 170185029Spjd{ 171185029Spjd return (zpool_prop_table[prop].pd_attr == PROP_READONLY); 172185029Spjd} 173185029Spjd 174185029Spjdconst char * 175185029Spjdzpool_prop_default_string(zpool_prop_t prop) 176185029Spjd{ 177185029Spjd return (zpool_prop_table[prop].pd_strdefault); 178185029Spjd} 179185029Spjd 180185029Spjduint64_t 181185029Spjdzpool_prop_default_numeric(zpool_prop_t prop) 182185029Spjd{ 183185029Spjd return (zpool_prop_table[prop].pd_numdefault); 184185029Spjd} 185185029Spjd 186236884Smm/* 187236884Smm * Returns true if this is a valid feature@ property. 188236884Smm */ 189236884Smmboolean_t 190236884Smmzpool_prop_feature(const char *name) 191236884Smm{ 192236884Smm static const char *prefix = "feature@"; 193236884Smm return (strncmp(name, prefix, strlen(prefix)) == 0); 194236884Smm} 195236884Smm 196236884Smm/* 197236884Smm * Returns true if this is a valid unsupported@ property. 198236884Smm */ 199236884Smmboolean_t 200236884Smmzpool_prop_unsupported(const char *name) 201236884Smm{ 202236884Smm static const char *prefix = "unsupported@"; 203236884Smm return (strncmp(name, prefix, strlen(prefix)) == 0); 204236884Smm} 205236884Smm 206185029Spjdint 207185029Spjdzpool_prop_string_to_index(zpool_prop_t prop, const char *string, 208185029Spjd uint64_t *index) 209185029Spjd{ 210185029Spjd return (zprop_string_to_index(prop, string, index, ZFS_TYPE_POOL)); 211185029Spjd} 212185029Spjd 213185029Spjdint 214185029Spjdzpool_prop_index_to_string(zpool_prop_t prop, uint64_t index, 215185029Spjd const char **string) 216185029Spjd{ 217185029Spjd return (zprop_index_to_string(prop, index, string, ZFS_TYPE_POOL)); 218185029Spjd} 219185029Spjd 220219089Spjduint64_t 221219089Spjdzpool_prop_random_value(zpool_prop_t prop, uint64_t seed) 222219089Spjd{ 223219089Spjd return (zprop_random_value(prop, seed, ZFS_TYPE_POOL)); 224219089Spjd} 225219089Spjd 226185029Spjd#ifndef _KERNEL 227185029Spjd 228185029Spjdconst char * 229185029Spjdzpool_prop_values(zpool_prop_t prop) 230185029Spjd{ 231185029Spjd return (zpool_prop_table[prop].pd_values); 232185029Spjd} 233185029Spjd 234185029Spjdconst char * 235185029Spjdzpool_prop_column_name(zpool_prop_t prop) 236185029Spjd{ 237185029Spjd return (zpool_prop_table[prop].pd_colname); 238185029Spjd} 239185029Spjd 240185029Spjdboolean_t 241185029Spjdzpool_prop_align_right(zpool_prop_t prop) 242185029Spjd{ 243185029Spjd return (zpool_prop_table[prop].pd_rightalign); 244185029Spjd} 245185029Spjd#endif 246