sys/cddl/contrib/opensolaris/common/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) 2013 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  */
  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/types.h>
  37 #include "zfeature_common.h"
  38
  39 /*
  40  * Set to disable all feature checks while opening pools, allowing pools with
  41  * unsupported features to be opened. Set for testing only.
  42  */
  43 boolean_t zfeature_checks_disable = B_FALSE;
  44
  45 zfeature_info_t spa_feature_table[SPA_FEATURES];
  46
  47 /*
  48  * Valid characters for feature guids. This list is mainly for aesthetic
  49  * purposes and could be expanded in the future. There are different allowed
  50  * characters in the guids reverse dns portion (before the colon) and its
  51  * short name (after the colon).
  52  */
  53 static int
  54 valid_char(char c, boolean_t after_colon)
  55 {
  56         return ((c >= 'a' && c <= 'z') ||
  57             (c >= '0' && c <= '9') ||
  58             c == (after_colon ? '_' : '.'));
  59 }
  60
  61 /*
  62  * Every feature guid must contain exactly one colon which separates a reverse
  63  * dns organization name from the feature's "short" name (e.g.
  64  * "com.company:feature_name").
  65  */
  66 boolean_t
  67 zfeature_is_valid_guid(const char *name)
  68 {
  69         int i;
  70         boolean_t has_colon = B_FALSE;
  71
  72         i = 0;
  73         while (name[i] != '\0') {
  74                 char c = name[i++];
  75                 if (c == ':') {
  76                         if (has_colon)
  77                                 return (B_FALSE);
  78                         has_colon = B_TRUE;
  79                         continue;
  80                 }
  81                 if (!valid_char(c, has_colon))
  82                         return (B_FALSE);
  83         }
  84
  85         return (has_colon);
  86 }
  87
  88 boolean_t
  89 zfeature_is_supported(const char *guid)
  90 {
  91         if (zfeature_checks_disable)
  92                 return (B_TRUE);
  93
  94         for (spa_feature_t i = 0; i < SPA_FEATURES; i++) {
  95                 zfeature_info_t *feature = &spa_feature_table[i];
  96                 if (strcmp(guid, feature->fi_guid) == 0)
  97                         return (B_TRUE);
  98         }
  99         return (B_FALSE);
 100 }
 101
 102 int
 103 zfeature_lookup_name(const char *name, spa_feature_t *res)
 104 {
 105         for (spa_feature_t i = 0; i < SPA_FEATURES; i++) {
 106                 zfeature_info_t *feature = &spa_feature_table[i];
 107                 if (strcmp(name, feature->fi_uname) == 0) {
 108                         if (res != NULL)
 109                                 *res = i;
 110                         return (0);
 111                 }
 112         }
 113
 114         return (ENOENT);
 115 }
 116
 117 boolean_t
 118 zfeature_depends_on(spa_feature_t fid, spa_feature_t check) {
 119         zfeature_info_t *feature = &spa_feature_table[fid];
 120
 121         for (int i = 0; feature->fi_depends[i] != SPA_FEATURE_NONE; i++) {
 122                 if (feature->fi_depends[i] == check)
 123                         return (B_TRUE);
 124         }
 125         return (B_FALSE);
 126 }
 127
 128 static void
 129 zfeature_register(spa_feature_t fid, const char *guid, const char *name,
 130     const char *desc, boolean_t readonly, boolean_t mos,
 131     boolean_t activate_on_enable, const spa_feature_t *deps)
 132 {
 133         zfeature_info_t *feature = &spa_feature_table[fid];
 134         static spa_feature_t nodeps[] = { SPA_FEATURE_NONE };
 135
 136         ASSERT(name != NULL);
 137         ASSERT(desc != NULL);
 138         ASSERT(!readonly || !mos);
 139         ASSERT3U(fid, <, SPA_FEATURES);
 140         ASSERT(zfeature_is_valid_guid(guid));
 141
 142         if (deps == NULL)
 143                 deps = nodeps;
 144
 145         feature->fi_feature = fid;
 146         feature->fi_guid = guid;
 147         feature->fi_uname = name;
 148         feature->fi_desc = desc;
 149         feature->fi_can_readonly = readonly;
 150         feature->fi_mos = mos;
 151         feature->fi_activate_on_enable = activate_on_enable;
 152         feature->fi_depends = deps;
 153 }
 154
 155 void
 156 zpool_feature_init(void)
 157 {
 158         zfeature_register(SPA_FEATURE_ASYNC_DESTROY,
 159             "com.delphix:async_destroy", "async_destroy",
 160             "Destroy filesystems asynchronously.", B_TRUE, B_FALSE,
 161             B_FALSE, NULL);
 162
 163         zfeature_register(SPA_FEATURE_EMPTY_BPOBJ,
 164             "com.delphix:empty_bpobj", "empty_bpobj",
 165             "Snapshots use less space.", B_TRUE, B_FALSE,
 166             B_FALSE, NULL);
 167
 168         zfeature_register(SPA_FEATURE_LZ4_COMPRESS,
 169             "org.illumos:lz4_compress", "lz4_compress",
 170             "LZ4 compression algorithm support.", B_FALSE, B_FALSE,
 171             B_FALSE, NULL);
 172
 173         zfeature_register(SPA_FEATURE_MULTI_VDEV_CRASH_DUMP,
 174             "com.joyent:multi_vdev_crash_dump", "multi_vdev_crash_dump",
 175             "Crash dumps to multiple vdev pools.", B_FALSE, B_FALSE,
 176             B_FALSE, NULL);
 177
 178         zfeature_register(SPA_FEATURE_SPACEMAP_HISTOGRAM,
 179             "com.delphix:spacemap_histogram", "spacemap_histogram",
 180             "Spacemaps maintain space histograms.", B_TRUE, B_FALSE,
 181             B_FALSE, NULL);
 182
 183         zfeature_register(SPA_FEATURE_ENABLED_TXG,
 184             "com.delphix:enabled_txg", "enabled_txg",
 185             "Record txg at which a feature is enabled", B_TRUE, B_FALSE,
 186             B_FALSE, NULL);
 187
 188         static spa_feature_t hole_birth_deps[] = { SPA_FEATURE_ENABLED_TXG,
 189             SPA_FEATURE_NONE };
 190         zfeature_register(SPA_FEATURE_HOLE_BIRTH,
 191             "com.delphix:hole_birth", "hole_birth",
 192             "Retain hole birth txg for more precise zfs send",
 193             B_FALSE, B_TRUE, B_TRUE, hole_birth_deps);
 194
 195         zfeature_register(SPA_FEATURE_EXTENSIBLE_DATASET,
 196             "com.delphix:extensible_dataset", "extensible_dataset",
 197             "Enhanced dataset functionality, used by other features.",
 198             B_FALSE, B_FALSE, B_FALSE, NULL);
 199
 200         static const spa_feature_t bookmarks_deps[] = {
 201                 SPA_FEATURE_EXTENSIBLE_DATASET,
 202                 SPA_FEATURE_NONE
 203         };
 204         zfeature_register(SPA_FEATURE_BOOKMARKS,
 205             "com.delphix:bookmarks", "bookmarks",
 206             "\"zfs bookmark\" command",
 207             B_TRUE, B_FALSE, B_FALSE, bookmarks_deps);
 208
 209         static const spa_feature_t filesystem_limits_deps[] = {
 210             SPA_FEATURE_EXTENSIBLE_DATASET,
 211             SPA_FEATURE_NONE
 212         };
 213         zfeature_register(SPA_FEATURE_FS_SS_LIMIT,
 214             "com.joyent:filesystem_limits", "filesystem_limits",
 215             "Filesystem and snapshot limits.", B_TRUE, B_FALSE, B_FALSE,
 216             filesystem_limits_deps);
 217 }