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