include/zfeature_common.h

   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 https://opensource.org/licenses/CDDL-1.0.
  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, 2018 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) 2017, Intel Corporation.
  27  * Copyright (c) 2024, Klara, Inc.
  28  */
  29
  30 #ifndef _ZFEATURE_COMMON_H
  31 #define _ZFEATURE_COMMON_H extern __attribute__((visibility("default")))
  32
  33 #include <sys/fs/zfs.h>
  34 #include <sys/inttypes.h>
  35 #include <sys/types.h>
  36
  37 #ifdef  __cplusplus
  38 extern "C" {
  39 #endif
  40
  41 struct zfeature_info;
  42
  43 typedef enum spa_feature {
  44         SPA_FEATURE_NONE = -1,
  45         SPA_FEATURE_ASYNC_DESTROY,
  46         SPA_FEATURE_EMPTY_BPOBJ,
  47         SPA_FEATURE_LZ4_COMPRESS,
  48         SPA_FEATURE_MULTI_VDEV_CRASH_DUMP,
  49         SPA_FEATURE_SPACEMAP_HISTOGRAM,
  50         SPA_FEATURE_ENABLED_TXG,
  51         SPA_FEATURE_HOLE_BIRTH,
  52         SPA_FEATURE_EXTENSIBLE_DATASET,
  53         SPA_FEATURE_EMBEDDED_DATA,
  54         SPA_FEATURE_BOOKMARKS,
  55         SPA_FEATURE_FS_SS_LIMIT,
  56         SPA_FEATURE_LARGE_BLOCKS,
  57         SPA_FEATURE_LARGE_DNODE,
  58         SPA_FEATURE_SHA512,
  59         SPA_FEATURE_SKEIN,
  60         SPA_FEATURE_EDONR,
  61         SPA_FEATURE_USEROBJ_ACCOUNTING,
  62         SPA_FEATURE_ENCRYPTION,
  63         SPA_FEATURE_PROJECT_QUOTA,
  64         SPA_FEATURE_DEVICE_REMOVAL,
  65         SPA_FEATURE_OBSOLETE_COUNTS,
  66         SPA_FEATURE_POOL_CHECKPOINT,
  67         SPA_FEATURE_SPACEMAP_V2,
  68         SPA_FEATURE_ALLOCATION_CLASSES,
  69         SPA_FEATURE_RESILVER_DEFER,
  70         SPA_FEATURE_BOOKMARK_V2,
  71         SPA_FEATURE_REDACTION_BOOKMARKS,
  72         SPA_FEATURE_REDACTED_DATASETS,
  73         SPA_FEATURE_BOOKMARK_WRITTEN,
  74         SPA_FEATURE_LOG_SPACEMAP,
  75         SPA_FEATURE_LIVELIST,
  76         SPA_FEATURE_DEVICE_REBUILD,
  77         SPA_FEATURE_ZSTD_COMPRESS,
  78         SPA_FEATURE_DRAID,
  79         SPA_FEATURE_ZILSAXATTR,
  80         SPA_FEATURE_HEAD_ERRLOG,
  81         SPA_FEATURE_BLAKE3,
  82         SPA_FEATURE_BLOCK_CLONING,
  83         SPA_FEATURE_AVZ_V2,
  84         SPA_FEATURE_REDACTION_LIST_SPILL,
  85         SPA_FEATURE_RAIDZ_EXPANSION,
  86         SPA_FEATURE_FAST_DEDUP,
  87         SPA_FEATURE_LONGNAME,
  88         SPA_FEATURE_LARGE_MICROZAP,
  89         SPA_FEATURES
  90 } spa_feature_t;
  91
  92 #define SPA_FEATURE_DISABLED    (-1ULL)
  93
  94 typedef enum zfeature_flags {
  95         /* Can open pool readonly even if this feature is not supported. */
  96         ZFEATURE_FLAG_READONLY_COMPAT =         (1 << 0),
  97         /*
  98          * Is this feature necessary to load the pool? i.e. do we need this
  99          * feature to read the full feature list out of the MOS?
 100          */
 101         ZFEATURE_FLAG_MOS =                     (1 << 1),
 102         /* Activate this feature at the same time it is enabled. */
 103         ZFEATURE_FLAG_ACTIVATE_ON_ENABLE =      (1 << 2),
 104         /* Each dataset has a field set if it has ever used this feature. */
 105         ZFEATURE_FLAG_PER_DATASET =             (1 << 3)
 106 } zfeature_flags_t;
 107
 108 typedef enum zfeature_type {
 109         ZFEATURE_TYPE_BOOLEAN,
 110         ZFEATURE_TYPE_UINT64_ARRAY,
 111         ZFEATURE_NUM_TYPES
 112 } zfeature_type_t;
 113
 114 typedef struct zfeature_info {
 115         spa_feature_t fi_feature;
 116         const char *fi_uname;   /* User-facing feature name */
 117         const char *fi_guid;    /* On-disk feature identifier */
 118         const char *fi_desc;    /* Feature description */
 119         zfeature_flags_t fi_flags;
 120         boolean_t fi_zfs_mod_supported; /* supported by running zfs module */
 121         zfeature_type_t fi_type; /* Only relevant for PER_DATASET features */
 122         /* array of dependencies, terminated by SPA_FEATURE_NONE */
 123         const spa_feature_t *fi_depends;
 124 } zfeature_info_t;
 125
 126 typedef int (zfeature_func_t)(zfeature_info_t *, void *);
 127
 128 #define ZFS_FEATURE_DEBUG
 129
 130 _ZFEATURE_COMMON_H zfeature_info_t spa_feature_table[SPA_FEATURES];
 131 _ZFEATURE_COMMON_H boolean_t zfeature_checks_disable;
 132
 133 _ZFEATURE_COMMON_H boolean_t zfeature_is_valid_guid(const char *);
 134
 135 _ZFEATURE_COMMON_H boolean_t zfeature_is_supported(const char *);
 136 _ZFEATURE_COMMON_H int zfeature_lookup_guid(const char *, spa_feature_t *);
 137 _ZFEATURE_COMMON_H int zfeature_lookup_name(const char *, spa_feature_t *);
 138 _ZFEATURE_COMMON_H boolean_t zfeature_depends_on(spa_feature_t, spa_feature_t);
 139
 140 _ZFEATURE_COMMON_H void zpool_feature_init(void);
 141
 142 #ifdef  __cplusplus
 143 }
 144 #endif
 145
 146 #endif  /* _ZFEATURE_COMMON_H */