granicus.if.org Git - zfs/blob - module/zfs/zfeature_common.c

   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 /*
  23  * Copyright (c) 2011, 2015 by Delphix. All rights reserved.
  24  * Copyright (c) 2013 by Saso Kiselkov. All rights reserved.
  25  * Copyright (c) 2014, Nexenta Systems, Inc. All rights reserved.
  26  */
  27
  28 #ifdef _KERNEL
  29 #include <sys/systm.h>
  30 #else
  31 #include <errno.h>
  32 #include <string.h>
  33 #endif
  34 #include <sys/debug.h>
  35 #include <sys/fs/zfs.h>
  36 #include <sys/inttypes.h>
  37 #include <sys/types.h>
  38 #include "zfeature_common.h"
  39
  40 /*
  41  * Set to disable all feature checks while opening pools, allowing pools with
  42  * unsupported features to be opened. Set for testing only.
  43  */
  44 boolean_t zfeature_checks_disable = B_FALSE;
  45
  46 zfeature_info_t spa_feature_table[SPA_FEATURES];
  47
  48 /*
  49  * Valid characters for feature guids. This list is mainly for aesthetic
  50  * purposes and could be expanded in the future. There are different allowed
  51  * characters in the guids reverse dns portion (before the colon) and its
  52  * short name (after the colon).
  53  */
  54 static int
  55 valid_char(char c, boolean_t after_colon)
  56 {
  57         return ((c >= 'a' && c <= 'z') ||
  58             (c >= '0' && c <= '9') ||
  59             (after_colon && c == '_') ||
  60             (!after_colon && (c == '.' || c == '-')));
  61 }
  62
  63 /*
  64  * Every feature guid must contain exactly one colon which separates a reverse
  65  * dns organization name from the feature's "short" name (e.g.
  66  * "com.company:feature_name").
  67  */
  68 boolean_t
  69 zfeature_is_valid_guid(const char *name)
  70 {
  71         int i;
  72         boolean_t has_colon = B_FALSE;
  73
  74         i = 0;
  75         while (name[i] != '\0') {
  76                 char c = name[i++];
  77                 if (c == ':') {
  78                         if (has_colon)
  79                                 return (B_FALSE);
  80                         has_colon = B_TRUE;
  81                         continue;
  82                 }
  83                 if (!valid_char(c, has_colon))
  84                         return (B_FALSE);
  85         }
  86
  87         return (has_colon);
  88 }
  89
  90 boolean_t
  91 zfeature_is_supported(const char *guid)
  92 {
  93         spa_feature_t i;
  94
  95         if (zfeature_checks_disable)
  96                 return (B_TRUE);
  97
  98         for (i = 0; i < SPA_FEATURES; i++) {
  99                 zfeature_info_t *feature = &spa_feature_table[i];
 100                 if (strcmp(guid, feature->fi_guid) == 0)
 101                         return (B_TRUE);
 102         }
 103
 104         return (B_FALSE);
 105 }
 106
 107 int
 108 zfeature_lookup_name(const char *name, spa_feature_t *res)
 109 {
 110         spa_feature_t i;
 111
 112         for (i = 0; i < SPA_FEATURES; i++) {
 113                 zfeature_info_t *feature = &spa_feature_table[i];
 114                 if (strcmp(name, feature->fi_uname) == 0) {
 115                         if (res != NULL)
 116                                 *res = i;
 117                         return (0);
 118                 }
 119         }
 120
 121         return (ENOENT);
 122 }
 123
 124 boolean_t
 125 zfeature_depends_on(spa_feature_t fid, spa_feature_t check)
 126 {
 127         zfeature_info_t *feature = &spa_feature_table[fid];
 128         int i;
 129
 130         for (i = 0; feature->fi_depends[i] != SPA_FEATURE_NONE; i++) {
 131                 if (feature->fi_depends[i] == check)
 132                         return (B_TRUE);
 133         }
 134         return (B_FALSE);
 135 }
 136
 137 static boolean_t
 138 deps_contains_feature(const spa_feature_t *deps, const spa_feature_t feature)
 139 {
 140         int i;
 141
 142         for (i = 0; deps[i] != SPA_FEATURE_NONE; i++)
 143                 if (deps[i] == feature)
 144                         return (B_TRUE);
 145
 146         return (B_FALSE);
 147 }
 148
 149 static void
 150 zfeature_register(spa_feature_t fid, const char *guid, const char *name,
 151     const char *desc, zfeature_flags_t flags, const spa_feature_t *deps)
 152 {
 153         zfeature_info_t *feature = &spa_feature_table[fid];
 154         static spa_feature_t nodeps[] = { SPA_FEATURE_NONE };
 155
 156         ASSERT(name != NULL);
 157         ASSERT(desc != NULL);
 158         ASSERT((flags & ZFEATURE_FLAG_READONLY_COMPAT) == 0 ||
 159             (flags & ZFEATURE_FLAG_MOS) == 0);
 160         ASSERT3U(fid, <, SPA_FEATURES);
 161         ASSERT(zfeature_is_valid_guid(guid));
 162
 163         if (deps == NULL)
 164                 deps = nodeps;
 165
 166         VERIFY(((flags & ZFEATURE_FLAG_PER_DATASET) == 0) ||
 167             (deps_contains_feature(deps, SPA_FEATURE_EXTENSIBLE_DATASET)));
 168
 169         feature->fi_feature = fid;
 170         feature->fi_guid = guid;
 171         feature->fi_uname = name;
 172         feature->fi_desc = desc;
 173         feature->fi_flags = flags;
 174         feature->fi_depends = deps;
 175 }
 176
 177 void
 178 zpool_feature_init(void)
 179 {
 180         zfeature_register(SPA_FEATURE_ASYNC_DESTROY,
 181             "com.delphix:async_destroy", "async_destroy",
 182             "Destroy filesystems asynchronously.",
 183             ZFEATURE_FLAG_READONLY_COMPAT, NULL);
 184
 185         zfeature_register(SPA_FEATURE_EMPTY_BPOBJ,
 186             "com.delphix:empty_bpobj", "empty_bpobj",
 187             "Snapshots use less space.",
 188             ZFEATURE_FLAG_READONLY_COMPAT, NULL);
 189
 190         zfeature_register(SPA_FEATURE_LZ4_COMPRESS,
 191             "org.illumos:lz4_compress", "lz4_compress",
 192             "LZ4 compression algorithm support.",
 193             ZFEATURE_FLAG_ACTIVATE_ON_ENABLE, NULL);
 194
 195         zfeature_register(SPA_FEATURE_SPACEMAP_HISTOGRAM,
 196             "com.delphix:spacemap_histogram", "spacemap_histogram",
 197             "Spacemaps maintain space histograms.",
 198             ZFEATURE_FLAG_READONLY_COMPAT, NULL);
 199
 200         zfeature_register(SPA_FEATURE_ENABLED_TXG,
 201             "com.delphix:enabled_txg", "enabled_txg",
 202             "Record txg at which a feature is enabled",
 203             ZFEATURE_FLAG_READONLY_COMPAT, NULL);
 204
 205         {
 206         static const spa_feature_t hole_birth_deps[] = {
 207                 SPA_FEATURE_ENABLED_TXG,
 208                 SPA_FEATURE_NONE
 209         };
 210         zfeature_register(SPA_FEATURE_HOLE_BIRTH,
 211             "com.delphix:hole_birth", "hole_birth",
 212             "Retain hole birth txg for more precise zfs send",
 213             ZFEATURE_FLAG_MOS | ZFEATURE_FLAG_ACTIVATE_ON_ENABLE,
 214             hole_birth_deps);
 215         }
 216
 217         zfeature_register(SPA_FEATURE_EXTENSIBLE_DATASET,
 218             "com.delphix:extensible_dataset", "extensible_dataset",
 219             "Enhanced dataset functionality, used by other features.",
 220             0, NULL);
 221
 222         {
 223         static const spa_feature_t bookmarks_deps[] = {
 224                 SPA_FEATURE_EXTENSIBLE_DATASET,
 225                 SPA_FEATURE_NONE
 226         };
 227
 228         zfeature_register(SPA_FEATURE_BOOKMARKS,
 229             "com.delphix:bookmarks", "bookmarks",
 230             "\"zfs bookmark\" command",
 231             ZFEATURE_FLAG_READONLY_COMPAT, bookmarks_deps);
 232         }
 233
 234         {
 235         static const spa_feature_t filesystem_limits_deps[] = {
 236                 SPA_FEATURE_EXTENSIBLE_DATASET,
 237                 SPA_FEATURE_NONE
 238         };
 239         zfeature_register(SPA_FEATURE_FS_SS_LIMIT,
 240             "com.joyent:filesystem_limits", "filesystem_limits",
 241             "Filesystem and snapshot limits.",
 242             ZFEATURE_FLAG_READONLY_COMPAT, filesystem_limits_deps);
 243         }
 244
 245         zfeature_register(SPA_FEATURE_EMBEDDED_DATA,
 246             "com.delphix:embedded_data", "embedded_data",
 247             "Blocks which compress very well use even less space.",
 248             ZFEATURE_FLAG_MOS | ZFEATURE_FLAG_ACTIVATE_ON_ENABLE,
 249             NULL);
 250
 251         {
 252         static const spa_feature_t large_blocks_deps[] = {
 253                 SPA_FEATURE_EXTENSIBLE_DATASET,
 254                 SPA_FEATURE_NONE
 255         };
 256         zfeature_register(SPA_FEATURE_LARGE_BLOCKS,
 257             "org.open-zfs:large_blocks", "large_blocks",
 258             "Support for blocks larger than 128KB.",
 259             ZFEATURE_FLAG_PER_DATASET, large_blocks_deps);
 260         }
 261
 262         {
 263         static const spa_feature_t large_dnode_deps[] = {
 264                 SPA_FEATURE_EXTENSIBLE_DATASET,
 265                 SPA_FEATURE_NONE
 266         };
 267         zfeature_register(SPA_FEATURE_LARGE_DNODE,
 268             "org.zfsonlinux:large_dnode", "large_dnode",
 269             "Variable on-disk size of dnodes.",
 270             ZFEATURE_FLAG_PER_DATASET, large_dnode_deps);
 271         }
 272
 273         {
 274         static const spa_feature_t sha512_deps[] = {
 275                 SPA_FEATURE_EXTENSIBLE_DATASET,
 276                 SPA_FEATURE_NONE
 277         };
 278         zfeature_register(SPA_FEATURE_SHA512,
 279             "org.illumos:sha512", "sha512",
 280             "SHA-512/256 hash algorithm.",
 281             ZFEATURE_FLAG_PER_DATASET, sha512_deps);
 282         }
 283         {
 284         static const spa_feature_t skein_deps[] = {
 285                 SPA_FEATURE_EXTENSIBLE_DATASET,
 286                 SPA_FEATURE_NONE
 287         };
 288         zfeature_register(SPA_FEATURE_SKEIN,
 289             "org.illumos:skein", "skein",
 290             "Skein hash algorithm.",
 291             ZFEATURE_FLAG_PER_DATASET, skein_deps);
 292         }
 293
 294         {
 295         static const spa_feature_t edonr_deps[] = {
 296                 SPA_FEATURE_EXTENSIBLE_DATASET,
 297                 SPA_FEATURE_NONE
 298         };
 299         zfeature_register(SPA_FEATURE_EDONR,
 300             "org.illumos:edonr", "edonr",
 301             "Edon-R hash algorithm.",
 302             ZFEATURE_FLAG_PER_DATASET, edonr_deps);
 303         }
 304         {
 305         static const spa_feature_t userobj_accounting_deps[] = {
 306                 SPA_FEATURE_EXTENSIBLE_DATASET,
 307                 SPA_FEATURE_NONE
 308         };
 309         zfeature_register(SPA_FEATURE_USEROBJ_ACCOUNTING,
 310             "org.zfsonlinux:userobj_accounting", "userobj_accounting",
 311             "User/Group object accounting.",
 312             ZFEATURE_FLAG_READONLY_COMPAT | ZFEATURE_FLAG_PER_DATASET,
 313             userobj_accounting_deps);
 314         }
 315 }