zfeature_common.c revision 289562
1180740Sdes/* 2180740Sdes * CDDL HEADER START 3180740Sdes * 4218767Sdes * The contents of this file are subject to the terms of the 5180740Sdes * Common Development and Distribution License (the "License"). 6180740Sdes * You may not use this file except in compliance with the License. 7239844Sdes * 8204861Sdes * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9204861Sdes * or http://www.opensolaris.org/os/licensing. 10180740Sdes * See the License for the specific language governing permissions 11180740Sdes * and limitations under the License. 12218767Sdes * 13180740Sdes * When distributing Covered Code, include this CDDL HEADER in each 14218767Sdes * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15218767Sdes * If applicable, add the following below this CDDL HEADER, with the 16214979Sdes * fields enclosed by brackets "[]" replaced with your own identifying 17214979Sdes * information: Portions Copyright [yyyy] [name of copyright owner] 18214979Sdes * 19180740Sdes * CDDL HEADER END 20204861Sdes */ 21204861Sdes 22204861Sdes/* 23204861Sdes * Copyright (c) 2011, 2015 by Delphix. All rights reserved. 24214979Sdes * Copyright (c) 2013 by Saso Kiselkov. All rights reserved. 25214979Sdes * Copyright (c) 2013, Joyent, Inc. All rights reserved. 26214979Sdes * Copyright (c) 2014, Nexenta Systems, Inc. All rights reserved. 27180740Sdes */ 28180740Sdes 29180740Sdes#ifdef _KERNEL 30180740Sdes#include <sys/systm.h> 31180740Sdes#else 32214979Sdes#include <errno.h> 33214979Sdes#include <string.h> 34214979Sdes#endif 35180740Sdes#include <sys/debug.h> 36180740Sdes#include <sys/fs/zfs.h> 37180740Sdes#include <sys/types.h> 38180744Sdes#include "zfeature_common.h" 39214979Sdes 40248613Sdes/* 41248613Sdes * Set to disable all feature checks while opening pools, allowing pools with 42248613Sdes * unsupported features to be opened. Set for testing only. 43248613Sdes */ 44248613Sdesboolean_t zfeature_checks_disable = B_FALSE; 45180740Sdes 46204861Sdeszfeature_info_t spa_feature_table[SPA_FEATURES]; 47204861Sdes 48180740Sdes/* 49248613Sdes * Valid characters for feature guids. This list is mainly for aesthetic 50248613Sdes * purposes and could be expanded in the future. There are different allowed 51239844Sdes * characters in the guids reverse dns portion (before the colon) and its 52214979Sdes * short name (after the colon). 53214979Sdes */ 54180740Sdesstatic int 55180740Sdesvalid_char(char c, boolean_t after_colon) 56180740Sdes{ 57180740Sdes return ((c >= 'a' && c <= 'z') || 58204861Sdes (c >= '0' && c <= '9') || 59204861Sdes (after_colon && c == '_') || 60180740Sdes (!after_colon && (c == '.' || c == '-'))); 61180740Sdes} 62180740Sdes 63214979Sdes/* 64214979Sdes * Every feature guid must contain exactly one colon which separates a reverse 65180740Sdes * dns organization name from the feature's "short" name (e.g. 66180740Sdes * "com.company:feature_name"). 67180740Sdes */ 68180740Sdesboolean_t 69180740Sdeszfeature_is_valid_guid(const char *name) 70180740Sdes{ 71180740Sdes int i; 72180740Sdes boolean_t has_colon = B_FALSE; 73180740Sdes 74180740Sdes i = 0; 75180740Sdes while (name[i] != '\0') { 76180740Sdes char c = name[i++]; 77180740Sdes if (c == ':') { 78180740Sdes if (has_colon) 79180740Sdes return (B_FALSE); 80180740Sdes has_colon = B_TRUE; 81180740Sdes continue; 82204861Sdes } 83180740Sdes if (!valid_char(c, has_colon)) 84180740Sdes return (B_FALSE); 85180740Sdes } 86180740Sdes 87180740Sdes return (has_colon); 88180740Sdes} 89180740Sdes 90180740Sdesboolean_t 91180740Sdeszfeature_is_supported(const char *guid) 92180740Sdes{ 93180740Sdes if (zfeature_checks_disable) 94218767Sdes return (B_TRUE); 95218767Sdes 96218767Sdes for (spa_feature_t i = 0; i < SPA_FEATURES; i++) { 97218767Sdes zfeature_info_t *feature = &spa_feature_table[i]; 98180740Sdes if (strcmp(guid, feature->fi_guid) == 0) 99180740Sdes return (B_TRUE); 100180740Sdes } 101180740Sdes return (B_FALSE); 102180740Sdes} 103180740Sdes 104180740Sdesint 105218767Sdeszfeature_lookup_name(const char *name, spa_feature_t *res) 106180740Sdes{ 107180740Sdes for (spa_feature_t i = 0; i < SPA_FEATURES; i++) { 108180740Sdes zfeature_info_t *feature = &spa_feature_table[i]; 109180740Sdes if (strcmp(name, feature->fi_uname) == 0) { 110180740Sdes if (res != NULL) 111180740Sdes *res = i; 112180740Sdes return (0); 113180740Sdes } 114180740Sdes } 115214979Sdes 116214979Sdes return (ENOENT); 117180740Sdes} 118180740Sdes 119255670Sdesboolean_t 120zfeature_depends_on(spa_feature_t fid, spa_feature_t check) 121{ 122 zfeature_info_t *feature = &spa_feature_table[fid]; 123 124 for (int i = 0; feature->fi_depends[i] != SPA_FEATURE_NONE; i++) { 125 if (feature->fi_depends[i] == check) 126 return (B_TRUE); 127 } 128 return (B_FALSE); 129} 130 131static void 132zfeature_register(spa_feature_t fid, const char *guid, const char *name, 133 const char *desc, zfeature_flags_t flags, const spa_feature_t *deps) 134{ 135 zfeature_info_t *feature = &spa_feature_table[fid]; 136 static spa_feature_t nodeps[] = { SPA_FEATURE_NONE }; 137 138 ASSERT(name != NULL); 139 ASSERT(desc != NULL); 140 ASSERT((flags & ZFEATURE_FLAG_READONLY_COMPAT) == 0 || 141 (flags & ZFEATURE_FLAG_MOS) == 0); 142 ASSERT3U(fid, <, SPA_FEATURES); 143 ASSERT(zfeature_is_valid_guid(guid)); 144 145 if (deps == NULL) 146 deps = nodeps; 147 148 feature->fi_feature = fid; 149 feature->fi_guid = guid; 150 feature->fi_uname = name; 151 feature->fi_desc = desc; 152 feature->fi_flags = flags; 153 feature->fi_depends = deps; 154} 155 156void 157zpool_feature_init(void) 158{ 159 zfeature_register(SPA_FEATURE_ASYNC_DESTROY, 160 "com.delphix:async_destroy", "async_destroy", 161 "Destroy filesystems asynchronously.", 162 ZFEATURE_FLAG_READONLY_COMPAT, NULL); 163 164 zfeature_register(SPA_FEATURE_EMPTY_BPOBJ, 165 "com.delphix:empty_bpobj", "empty_bpobj", 166 "Snapshots use less space.", 167 ZFEATURE_FLAG_READONLY_COMPAT, NULL); 168 169 zfeature_register(SPA_FEATURE_LZ4_COMPRESS, 170 "org.illumos:lz4_compress", "lz4_compress", 171 "LZ4 compression algorithm support.", 172 ZFEATURE_FLAG_ACTIVATE_ON_ENABLE, NULL); 173 174 zfeature_register(SPA_FEATURE_MULTI_VDEV_CRASH_DUMP, 175 "com.joyent:multi_vdev_crash_dump", "multi_vdev_crash_dump", 176 "Crash dumps to multiple vdev pools.", 177 0, NULL); 178 179 zfeature_register(SPA_FEATURE_SPACEMAP_HISTOGRAM, 180 "com.delphix:spacemap_histogram", "spacemap_histogram", 181 "Spacemaps maintain space histograms.", 182 ZFEATURE_FLAG_READONLY_COMPAT, NULL); 183 184 zfeature_register(SPA_FEATURE_ENABLED_TXG, 185 "com.delphix:enabled_txg", "enabled_txg", 186 "Record txg at which a feature is enabled", 187 ZFEATURE_FLAG_READONLY_COMPAT, NULL); 188 189 static spa_feature_t hole_birth_deps[] = { SPA_FEATURE_ENABLED_TXG, 190 SPA_FEATURE_NONE }; 191 zfeature_register(SPA_FEATURE_HOLE_BIRTH, 192 "com.delphix:hole_birth", "hole_birth", 193 "Retain hole birth txg for more precise zfs send", 194 ZFEATURE_FLAG_MOS | ZFEATURE_FLAG_ACTIVATE_ON_ENABLE, 195 hole_birth_deps); 196 197 zfeature_register(SPA_FEATURE_EXTENSIBLE_DATASET, 198 "com.delphix:extensible_dataset", "extensible_dataset", 199 "Enhanced dataset functionality, used by other features.", 200 0, NULL); 201 202 static const spa_feature_t bookmarks_deps[] = { 203 SPA_FEATURE_EXTENSIBLE_DATASET, 204 SPA_FEATURE_NONE 205 }; 206 zfeature_register(SPA_FEATURE_BOOKMARKS, 207 "com.delphix:bookmarks", "bookmarks", 208 "\"zfs bookmark\" command", 209 ZFEATURE_FLAG_READONLY_COMPAT, bookmarks_deps); 210 211 static const spa_feature_t filesystem_limits_deps[] = { 212 SPA_FEATURE_EXTENSIBLE_DATASET, 213 SPA_FEATURE_NONE 214 }; 215 zfeature_register(SPA_FEATURE_FS_SS_LIMIT, 216 "com.joyent:filesystem_limits", "filesystem_limits", 217 "Filesystem and snapshot limits.", 218 ZFEATURE_FLAG_READONLY_COMPAT, filesystem_limits_deps); 219 220 zfeature_register(SPA_FEATURE_EMBEDDED_DATA, 221 "com.delphix:embedded_data", "embedded_data", 222 "Blocks which compress very well use even less space.", 223 ZFEATURE_FLAG_MOS | ZFEATURE_FLAG_ACTIVATE_ON_ENABLE, 224 NULL); 225 226 static const spa_feature_t large_blocks_deps[] = { 227 SPA_FEATURE_EXTENSIBLE_DATASET, 228 SPA_FEATURE_NONE 229 }; 230 zfeature_register(SPA_FEATURE_LARGE_BLOCKS, 231 "org.open-zfs:large_blocks", "large_blocks", 232 "Support for blocks larger than 128KB.", 233 ZFEATURE_FLAG_PER_DATASET, large_blocks_deps); 234 235#ifdef illumos 236 zfeature_register(SPA_FEATURE_SHA512, 237 "org.illumos:sha512", "sha512", 238 "SHA-512/256 hash algorithm.", 239 ZFEATURE_FLAG_PER_DATASET, NULL); 240 zfeature_register(SPA_FEATURE_SKEIN, 241 "org.illumos:skein", "skein", 242 "Skein hash algorithm.", 243 ZFEATURE_FLAG_PER_DATASET, NULL); 244 zfeature_register(SPA_FEATURE_EDONR, 245 "org.illumos:edonr", "edonr", 246 "Edon-R hash algorithm.", 247 ZFEATURE_FLAG_PER_DATASET, NULL); 248#endif 249} 250