]> git.proxmox.com Git - mirror_zfs.git/blame - module/zcommon/zfs_prop.c
projects / mirror_zfs.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Fix type mismatch on 32-bit systems
[mirror_zfs.git] / module / zcommon / zfs_prop.c
CommitLineData
34dc7c2f
BB		 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/*
428870ff 22 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
faf0f58c 23 * Copyright (c) 2011, 2014 by Delphix. All rights reserved.
632a242e 24 * Copyright (c) 2013 by Saso Kiselkov. All rights reserved.
34dc7c2f
BB		 25 */
26
428870ff
BB		 27/* Portions Copyright 2010 Robert Milkowski */
28
34dc7c2f
BB		 29#include <sys/zio.h>
30#include <sys/spa.h>
31#include <sys/u8_textprep.h>
32#include <sys/zfs_acl.h>
33#include <sys/zfs_ioctl.h>
34#include <sys/zfs_znode.h>
35
36#include "zfs_prop.h"
37#include "zfs_deleg.h"
38
39#if defined(_KERNEL)
40#include <sys/systm.h>
41#else
42#include <stdlib.h>
43#include <string.h>
44#include <ctype.h>
45#endif
46
47static zprop_desc_t zfs_prop_table[ZFS_NUM_PROPS];
48
9babb374
BB		 49/* Note this is indexed by zfs_userquota_prop_t, keep the order the same */
50const char *zfs_userquota_prop_prefixes[] = {
51 "userused@",
52 "userquota@",
53 "groupused@",
54 "groupquota@"
55};
56
34dc7c2f
BB		 57zprop_desc_t *
58zfs_prop_get_table(void)
59{
60 return (zfs_prop_table);
61}
62
63void
64zfs_prop_init(void)
65{
66 static zprop_index_t checksum_table[] = {
67 { "on", ZIO_CHECKSUM_ON },
68 { "off", ZIO_CHECKSUM_OFF },
69 { "fletcher2", ZIO_CHECKSUM_FLETCHER_2 },
70 { "fletcher4", ZIO_CHECKSUM_FLETCHER_4 },
71 { "sha256", ZIO_CHECKSUM_SHA256 },
72 { NULL }
73 };
74
428870ff
BB		 75 static zprop_index_t dedup_table[] = {
76 { "on", ZIO_CHECKSUM_ON },
77 { "off", ZIO_CHECKSUM_OFF },
78 { "verify", ZIO_CHECKSUM_ON | ZIO_CHECKSUM_VERIFY },
79 { "sha256", ZIO_CHECKSUM_SHA256 },
80 { "sha256,verify",
81 ZIO_CHECKSUM_SHA256 | ZIO_CHECKSUM_VERIFY },
82 { NULL }
83 };
84
34dc7c2f
BB		 85 static zprop_index_t compress_table[] = {
86 { "on", ZIO_COMPRESS_ON },
87 { "off", ZIO_COMPRESS_OFF },
88 { "lzjb", ZIO_COMPRESS_LZJB },
89 { "gzip", ZIO_COMPRESS_GZIP_6 }, /* gzip default */
90 { "gzip-1", ZIO_COMPRESS_GZIP_1 },
91 { "gzip-2", ZIO_COMPRESS_GZIP_2 },
92 { "gzip-3", ZIO_COMPRESS_GZIP_3 },
93 { "gzip-4", ZIO_COMPRESS_GZIP_4 },
94 { "gzip-5", ZIO_COMPRESS_GZIP_5 },
95 { "gzip-6", ZIO_COMPRESS_GZIP_6 },
96 { "gzip-7", ZIO_COMPRESS_GZIP_7 },
97 { "gzip-8", ZIO_COMPRESS_GZIP_8 },
98 { "gzip-9", ZIO_COMPRESS_GZIP_9 },
428870ff 99 { "zle", ZIO_COMPRESS_ZLE },
9759c60f 100 { "lz4", ZIO_COMPRESS_LZ4 },
34dc7c2f
BB		 101 { NULL }
102 };
103
104 static zprop_index_t snapdir_table[] = {
105 { "hidden", ZFS_SNAPDIR_HIDDEN },
106 { "visible", ZFS_SNAPDIR_VISIBLE },
107 { NULL }
108 };
109
0b4d1b58
ED		 110 static zprop_index_t snapdev_table[] = {
111 { "hidden", ZFS_SNAPDEV_HIDDEN },
112 { "visible", ZFS_SNAPDEV_VISIBLE },
113 { NULL }
114 };
115
023699cd
MM		 116 static zprop_index_t acltype_table[] = {
117 { "off", ZFS_ACLTYPE_OFF },
118 { "disabled", ZFS_ACLTYPE_OFF },
119 { "noacl", ZFS_ACLTYPE_OFF },
120 { "posixacl", ZFS_ACLTYPE_POSIXACL },
121 { NULL }
122 };
123
34dc7c2f
BB		 124 static zprop_index_t acl_inherit_table[] = {
125 { "discard", ZFS_ACL_DISCARD },
126 { "noallow", ZFS_ACL_NOALLOW },
127 { "restricted", ZFS_ACL_RESTRICTED },
128 { "passthrough", ZFS_ACL_PASSTHROUGH },
129 { "secure", ZFS_ACL_RESTRICTED }, /* bkwrd compatability */
b128c09f 130 { "passthrough-x", ZFS_ACL_PASSTHROUGH_X },
34dc7c2f
BB		 131 { NULL }
132 };
133
134 static zprop_index_t case_table[] = {
135 { "sensitive", ZFS_CASE_SENSITIVE },
136 { "insensitive", ZFS_CASE_INSENSITIVE },
137 { "mixed", ZFS_CASE_MIXED },
138 { NULL }
139 };
140
141 static zprop_index_t copies_table[] = {
142 { "1", 1 },
143 { "2", 2 },
144 { "3", 3 },
145 { NULL }
146 };
147
148 /*
149 * Use the unique flags we have to send to u8_strcmp() and/or
150 * u8_textprep() to represent the various normalization property
151 * values.
152 */
153 static zprop_index_t normalize_table[] = {
154 { "none", 0 },
155 { "formD", U8_TEXTPREP_NFD },
156 { "formKC", U8_TEXTPREP_NFKC },
157 { "formC", U8_TEXTPREP_NFC },
158 { "formKD", U8_TEXTPREP_NFKD },
159 { NULL }
160 };
161
162 static zprop_index_t version_table[] = {
163 { "1", 1 },
164 { "2", 2 },
165 { "3", 3 },
9babb374 166 { "4", 4 },
428870ff 167 { "5", 5 },
34dc7c2f
BB		 168 { "current", ZPL_VERSION },
169 { NULL }
170 };
171
172 static zprop_index_t boolean_table[] = {
173 { "off", 0 },
174 { "on", 1 },
175 { NULL }
176 };
177
428870ff
BB		 178 static zprop_index_t logbias_table[] = {
179 { "latency", ZFS_LOGBIAS_LATENCY },
180 { "throughput", ZFS_LOGBIAS_THROUGHPUT },
181 { NULL }
182 };
183
34dc7c2f
BB		 184 static zprop_index_t canmount_table[] = {
185 { "off", ZFS_CANMOUNT_OFF },
186 { "on", ZFS_CANMOUNT_ON },
187 { "noauto", ZFS_CANMOUNT_NOAUTO },
188 { NULL }
189 };
190
b128c09f
BB		 191 static zprop_index_t cache_table[] = {
192 { "none", ZFS_CACHE_NONE },
193 { "metadata", ZFS_CACHE_METADATA },
194 { "all", ZFS_CACHE_ALL },
195 { NULL }
196 };
197
428870ff
BB		 198 static zprop_index_t sync_table[] = {
199 { "standard", ZFS_SYNC_STANDARD },
200 { "always", ZFS_SYNC_ALWAYS },
201 { "disabled", ZFS_SYNC_DISABLED },
202 { NULL }
203 };
204
82a37189
BB		 205 static zprop_index_t xattr_table[] = {
206 { "off", ZFS_XATTR_OFF },
207 { "on", ZFS_XATTR_DIR },
208 { "sa", ZFS_XATTR_SA },
209 { "dir", ZFS_XATTR_DIR },
210 { NULL }
211 };
212
faf0f58c
MA		 213 static zprop_index_t redundant_metadata_table[] = {
214 { "all", ZFS_REDUNDANT_METADATA_ALL },
215 { "most", ZFS_REDUNDANT_METADATA_MOST },
216 { NULL }
217 };
218
34dc7c2f 219 /* inherit index properties */
faf0f58c
MA		 220 zprop_register_index(ZFS_PROP_REDUNDANT_METADATA, "redundant_metadata",
221 ZFS_REDUNDANT_METADATA_ALL,
222 PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
223 "all | most", "REDUND_MD",
224 redundant_metadata_table);
428870ff 225 zprop_register_index(ZFS_PROP_SYNC, "sync", ZFS_SYNC_STANDARD,
34dc7c2f 226 PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
428870ff
BB		 227 "standard | always | disabled", "SYNC",
228 sync_table);
229 zprop_register_index(ZFS_PROP_CHECKSUM, "checksum",
230 ZIO_CHECKSUM_DEFAULT, PROP_INHERIT, ZFS_TYPE_FILESYSTEM |
231 ZFS_TYPE_VOLUME,
34dc7c2f
BB		 232 "on | off | fletcher2 | fletcher4 | sha256", "CHECKSUM",
233 checksum_table);
428870ff
BB		 234 zprop_register_index(ZFS_PROP_DEDUP, "dedup", ZIO_CHECKSUM_OFF,
235 PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
236 "on | off | verify | sha256[,verify]", "DEDUP",
237 dedup_table);
238 zprop_register_index(ZFS_PROP_COMPRESSION, "compression",
34dc7c2f
BB		 239 ZIO_COMPRESS_DEFAULT, PROP_INHERIT,
240 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
9759c60f 241 "on | off | lzjb | gzip | gzip-[1-9] | zle | lz4", "COMPRESS",
428870ff
BB		 242 compress_table);
243 zprop_register_index(ZFS_PROP_SNAPDIR, "snapdir", ZFS_SNAPDIR_HIDDEN,
34dc7c2f
BB		 244 PROP_INHERIT, ZFS_TYPE_FILESYSTEM,
245 "hidden | visible", "SNAPDIR", snapdir_table);
0b4d1b58
ED		 246 zprop_register_index(ZFS_PROP_SNAPDEV, "snapdev", ZFS_SNAPDEV_HIDDEN,
247 PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
248 "hidden | visible", "SNAPDEV", snapdev_table);
023699cd
MM		 249 zprop_register_index(ZFS_PROP_ACLTYPE, "acltype", ZFS_ACLTYPE_OFF,
250 PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT,
251 "noacl | posixacl", "ACLTYPE", acltype_table);
428870ff
BB		 252 zprop_register_index(ZFS_PROP_ACLINHERIT, "aclinherit",
253 ZFS_ACL_RESTRICTED, PROP_INHERIT, ZFS_TYPE_FILESYSTEM,
b128c09f 254 "discard | noallow | restricted | passthrough | passthrough-x",
34dc7c2f 255 "ACLINHERIT", acl_inherit_table);
428870ff
BB		 256 zprop_register_index(ZFS_PROP_COPIES, "copies", 1, PROP_INHERIT,
257 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
34dc7c2f 258 "1 | 2 | 3", "COPIES", copies_table);
428870ff 259 zprop_register_index(ZFS_PROP_PRIMARYCACHE, "primarycache",
b128c09f
BB		 260 ZFS_CACHE_ALL, PROP_INHERIT,
261 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT | ZFS_TYPE_VOLUME,
262 "all | none | metadata", "PRIMARYCACHE", cache_table);
428870ff 263 zprop_register_index(ZFS_PROP_SECONDARYCACHE, "secondarycache",
b128c09f
BB		 264 ZFS_CACHE_ALL, PROP_INHERIT,
265 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT | ZFS_TYPE_VOLUME,
266 "all | none | metadata", "SECONDARYCACHE", cache_table);
428870ff
BB		 267 zprop_register_index(ZFS_PROP_LOGBIAS, "logbias", ZFS_LOGBIAS_LATENCY,
268 PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
269 "latency | throughput", "LOGBIAS", logbias_table);
82a37189
BB		 270 zprop_register_index(ZFS_PROP_XATTR, "xattr", ZFS_XATTR_DIR,
271 PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT,
272 "on | off | dir | sa", "XATTR", xattr_table);
34dc7c2f
BB		 273
274 /* inherit index (boolean) properties */
428870ff 275 zprop_register_index(ZFS_PROP_ATIME, "atime", 1, PROP_INHERIT,
34dc7c2f 276 ZFS_TYPE_FILESYSTEM, "on | off", "ATIME", boolean_table);
6d111134
TC		 277 zprop_register_index(ZFS_PROP_RELATIME, "relatime", 0, PROP_INHERIT,
278 ZFS_TYPE_FILESYSTEM, "on | off", "RELATIME", boolean_table);
428870ff 279 zprop_register_index(ZFS_PROP_DEVICES, "devices", 1, PROP_INHERIT,
34dc7c2f
BB		 280 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "DEVICES",
281 boolean_table);
428870ff 282 zprop_register_index(ZFS_PROP_EXEC, "exec", 1, PROP_INHERIT,
34dc7c2f
BB		 283 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "EXEC",
284 boolean_table);
428870ff 285 zprop_register_index(ZFS_PROP_SETUID, "setuid", 1, PROP_INHERIT,
34dc7c2f
BB		 286 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "SETUID",
287 boolean_table);
428870ff 288 zprop_register_index(ZFS_PROP_READONLY, "readonly", 0, PROP_INHERIT,
34dc7c2f
BB		 289 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "on | off", "RDONLY",
290 boolean_table);
428870ff 291 zprop_register_index(ZFS_PROP_ZONED, "zoned", 0, PROP_INHERIT,
34dc7c2f 292 ZFS_TYPE_FILESYSTEM, "on | off", "ZONED", boolean_table);
428870ff 293 zprop_register_index(ZFS_PROP_VSCAN, "vscan", 0, PROP_INHERIT,
82a37189 294 ZFS_TYPE_FILESYSTEM, "on | off", "VSCAN", boolean_table);
428870ff 295 zprop_register_index(ZFS_PROP_NBMAND, "nbmand", 0, PROP_INHERIT,
34dc7c2f
BB		 296 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "NBMAND",
297 boolean_table);
f67d7090
TF		 298 zprop_register_index(ZFS_PROP_OVERLAY, "overlay", 0, PROP_INHERIT,
299 ZFS_TYPE_FILESYSTEM, "on | off", "OVERLAY", boolean_table);
34dc7c2f
BB		 300
301 /* default index properties */
428870ff 302 zprop_register_index(ZFS_PROP_VERSION, "version", 0, PROP_DEFAULT,
34dc7c2f 303 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT,
330d06f9 304 "1 | 2 | 3 | 4 | 5 | current", "VERSION", version_table);
428870ff 305 zprop_register_index(ZFS_PROP_CANMOUNT, "canmount", ZFS_CANMOUNT_ON,
34dc7c2f
BB		 306 PROP_DEFAULT, ZFS_TYPE_FILESYSTEM, "on | off | noauto",
307 "CANMOUNT", canmount_table);
308
309 /* readonly index (boolean) properties */
428870ff 310 zprop_register_index(ZFS_PROP_MOUNTED, "mounted", 0, PROP_READONLY,
34dc7c2f 311 ZFS_TYPE_FILESYSTEM, "yes | no", "MOUNTED", boolean_table);
428870ff 312 zprop_register_index(ZFS_PROP_DEFER_DESTROY, "defer_destroy", 0,
45d1cae3
BB		 313 PROP_READONLY, ZFS_TYPE_SNAPSHOT, "yes | no", "DEFER_DESTROY",
314 boolean_table);
34dc7c2f
BB		 315
316 /* set once index properties */
428870ff 317 zprop_register_index(ZFS_PROP_NORMALIZE, "normalization", 0,
34dc7c2f
BB		 318 PROP_ONETIME, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT,
319 "none | formC | formD | formKC | formKD", "NORMALIZATION",
320 normalize_table);
428870ff
BB		 321 zprop_register_index(ZFS_PROP_CASE, "casesensitivity",
322 ZFS_CASE_SENSITIVE, PROP_ONETIME, ZFS_TYPE_FILESYSTEM |
323 ZFS_TYPE_SNAPSHOT,
34dc7c2f
BB		 324 "sensitive | insensitive | mixed", "CASE", case_table);
325
326 /* set once index (boolean) properties */
428870ff 327 zprop_register_index(ZFS_PROP_UTF8ONLY, "utf8only", 0, PROP_ONETIME,
34dc7c2f
BB		 328 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT,
329 "on | off", "UTF8ONLY", boolean_table);
330
331 /* string properties */
428870ff 332 zprop_register_string(ZFS_PROP_ORIGIN, "origin", NULL, PROP_READONLY,
34dc7c2f 333 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<snapshot>", "ORIGIN");
330d06f9
MA		 334 zprop_register_string(ZFS_PROP_CLONES, "clones", NULL, PROP_READONLY,
335 ZFS_TYPE_SNAPSHOT, "<dataset>[,...]", "CLONES");
428870ff
BB		 336 zprop_register_string(ZFS_PROP_MOUNTPOINT, "mountpoint", "/",
337 PROP_INHERIT, ZFS_TYPE_FILESYSTEM, "<path> | legacy | none",
338 "MOUNTPOINT");
339 zprop_register_string(ZFS_PROP_SHARENFS, "sharenfs", "off",
340 PROP_INHERIT, ZFS_TYPE_FILESYSTEM, "on | off | share(1M) options",
341 "SHARENFS");
342 zprop_register_string(ZFS_PROP_TYPE, "type", NULL, PROP_READONLY,
da536844
MA		 343 ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK,
344 "filesystem | volume | snapshot | bookmark", "TYPE");
428870ff
BB		 345 zprop_register_string(ZFS_PROP_SHARESMB, "sharesmb", "off",
346 PROP_INHERIT, ZFS_TYPE_FILESYSTEM,
347 "on | off | sharemgr(1M) options", "SHARESMB");
348 zprop_register_string(ZFS_PROP_MLSLABEL, "mlslabel",
349 ZFS_MLSLABEL_DEFAULT, PROP_INHERIT, ZFS_TYPE_DATASET,
350 "<sensitivity label>", "MLSLABEL");
11b9ec23
MT		 351 zprop_register_string(ZFS_PROP_SELINUX_CONTEXT, "context",
352 "none", PROP_DEFAULT, ZFS_TYPE_DATASET, "<selinux context>",
353 "CONTEXT");
354 zprop_register_string(ZFS_PROP_SELINUX_FSCONTEXT, "fscontext",
355 "none", PROP_DEFAULT, ZFS_TYPE_DATASET, "<selinux fscontext>",
356 "FSCONTEXT");
357 zprop_register_string(ZFS_PROP_SELINUX_DEFCONTEXT, "defcontext",
358 "none", PROP_DEFAULT, ZFS_TYPE_DATASET, "<selinux defcontext>",
359 "DEFCONTEXT");
360 zprop_register_string(ZFS_PROP_SELINUX_ROOTCONTEXT, "rootcontext",
361 "none", PROP_DEFAULT, ZFS_TYPE_DATASET, "<selinux rootcontext>",
362 "ROOTCONTEXT");
34dc7c2f
BB		 363
364 /* readonly number properties */
428870ff 365 zprop_register_number(ZFS_PROP_USED, "used", 0, PROP_READONLY,
34dc7c2f 366 ZFS_TYPE_DATASET, "<size>", "USED");
428870ff 367 zprop_register_number(ZFS_PROP_AVAILABLE, "available", 0, PROP_READONLY,
34dc7c2f 368 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", "AVAIL");
428870ff
BB		 369 zprop_register_number(ZFS_PROP_REFERENCED, "referenced", 0,
370 PROP_READONLY, ZFS_TYPE_DATASET, "<size>", "REFER");
371 zprop_register_number(ZFS_PROP_COMPRESSRATIO, "compressratio", 0,
34dc7c2f
BB		 372 PROP_READONLY, ZFS_TYPE_DATASET,
373 "<1.00x or higher if compressed>", "RATIO");
f5fc4aca
MA		 374 zprop_register_number(ZFS_PROP_REFRATIO, "refcompressratio", 0,
375 PROP_READONLY, ZFS_TYPE_DATASET,
376 "<1.00x or higher if compressed>", "REFRATIO");
428870ff
BB		 377 zprop_register_number(ZFS_PROP_VOLBLOCKSIZE, "volblocksize",
378 ZVOL_DEFAULT_BLOCKSIZE, PROP_ONETIME,
34dc7c2f 379 ZFS_TYPE_VOLUME, "512 to 128k, power of 2", "VOLBLOCK");
428870ff
BB		 380 zprop_register_number(ZFS_PROP_USEDSNAP, "usedbysnapshots", 0,
381 PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>",
382 "USEDSNAP");
383 zprop_register_number(ZFS_PROP_USEDDS, "usedbydataset", 0,
384 PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>",
385 "USEDDS");
386 zprop_register_number(ZFS_PROP_USEDCHILD, "usedbychildren", 0,
387 PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>",
388 "USEDCHILD");
389 zprop_register_number(ZFS_PROP_USEDREFRESERV, "usedbyrefreservation", 0,
b128c09f
BB		 390 PROP_READONLY,
391 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", "USEDREFRESERV");
428870ff 392 zprop_register_number(ZFS_PROP_USERREFS, "userrefs", 0, PROP_READONLY,
45d1cae3 393 ZFS_TYPE_SNAPSHOT, "<count>", "USERREFS");
330d06f9
MA		 394 zprop_register_number(ZFS_PROP_WRITTEN, "written", 0, PROP_READONLY,
395 ZFS_TYPE_DATASET, "<size>", "WRITTEN");
24a64651
MA		 396 zprop_register_number(ZFS_PROP_LOGICALUSED, "logicalused", 0,
397 PROP_READONLY, ZFS_TYPE_DATASET, "<size>", "LUSED");
398 zprop_register_number(ZFS_PROP_LOGICALREFERENCED, "logicalreferenced",
399 0, PROP_READONLY, ZFS_TYPE_DATASET, "<size>", "LREFER");
34dc7c2f
BB		 400
401 /* default number properties */
428870ff 402 zprop_register_number(ZFS_PROP_QUOTA, "quota", 0, PROP_DEFAULT,
34dc7c2f 403 ZFS_TYPE_FILESYSTEM, "<size> | none", "QUOTA");
428870ff
BB		 404 zprop_register_number(ZFS_PROP_RESERVATION, "reservation", 0,
405 PROP_DEFAULT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
406 "<size> | none", "RESERV");
407 zprop_register_number(ZFS_PROP_VOLSIZE, "volsize", 0, PROP_DEFAULT,
962d5242 408 ZFS_TYPE_SNAPSHOT | ZFS_TYPE_VOLUME, "<size>", "VOLSIZE");
428870ff 409 zprop_register_number(ZFS_PROP_REFQUOTA, "refquota", 0, PROP_DEFAULT,
34dc7c2f 410 ZFS_TYPE_FILESYSTEM, "<size> | none", "REFQUOTA");
428870ff 411 zprop_register_number(ZFS_PROP_REFRESERVATION, "refreservation", 0,
34dc7c2f
BB		 412 PROP_DEFAULT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
413 "<size> | none", "REFRESERV");
788eb90c
JJ		 414 zprop_register_number(ZFS_PROP_FILESYSTEM_LIMIT, "filesystem_limit",
415 UINT64_MAX, PROP_DEFAULT, ZFS_TYPE_FILESYSTEM,
416 "<count> | none", "FSLIMIT");
417 zprop_register_number(ZFS_PROP_SNAPSHOT_LIMIT, "snapshot_limit",
418 UINT64_MAX, PROP_DEFAULT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
419 "<count> | none", "SSLIMIT");
420 zprop_register_number(ZFS_PROP_FILESYSTEM_COUNT, "filesystem_count",
421 UINT64_MAX, PROP_DEFAULT, ZFS_TYPE_FILESYSTEM,
422 "<count>", "FSCOUNT");
423 zprop_register_number(ZFS_PROP_SNAPSHOT_COUNT, "snapshot_count",
424 UINT64_MAX, PROP_DEFAULT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
425 "<count>", "SSCOUNT");
34dc7c2f
BB		 426
427 /* inherit number properties */
428870ff
BB		 428 zprop_register_number(ZFS_PROP_RECORDSIZE, "recordsize",
429 SPA_MAXBLOCKSIZE, PROP_INHERIT,
34dc7c2f
BB		 430 ZFS_TYPE_FILESYSTEM, "512 to 128k, power of 2", "RECSIZE");
431
432 /* hidden properties */
428870ff 433 zprop_register_hidden(ZFS_PROP_CREATETXG, "createtxg", PROP_TYPE_NUMBER,
da536844 434 PROP_READONLY, ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK, "CREATETXG");
428870ff
BB		 435 zprop_register_hidden(ZFS_PROP_NUMCLONES, "numclones", PROP_TYPE_NUMBER,
436 PROP_READONLY, ZFS_TYPE_SNAPSHOT, "NUMCLONES");
437 zprop_register_hidden(ZFS_PROP_NAME, "name", PROP_TYPE_STRING,
da536844 438 PROP_READONLY, ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK, "NAME");
428870ff
BB		 439 zprop_register_hidden(ZFS_PROP_ISCSIOPTIONS, "iscsioptions",
440 PROP_TYPE_STRING, PROP_INHERIT, ZFS_TYPE_VOLUME, "ISCSIOPTIONS");
441 zprop_register_hidden(ZFS_PROP_STMF_SHAREINFO, "stmf_sbd_lu",
9babb374
BB		 442 PROP_TYPE_STRING, PROP_INHERIT, ZFS_TYPE_VOLUME,
443 "STMF_SBD_LU");
428870ff 444 zprop_register_hidden(ZFS_PROP_GUID, "guid", PROP_TYPE_NUMBER,
da536844 445 PROP_READONLY, ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK, "GUID");
428870ff
BB		 446 zprop_register_hidden(ZFS_PROP_USERACCOUNTING, "useraccounting",
447 PROP_TYPE_NUMBER, PROP_READONLY, ZFS_TYPE_DATASET,
448 "USERACCOUNTING");
449 zprop_register_hidden(ZFS_PROP_UNIQUE, "unique", PROP_TYPE_NUMBER,
450 PROP_READONLY, ZFS_TYPE_DATASET, "UNIQUE");
451 zprop_register_hidden(ZFS_PROP_OBJSETID, "objsetid", PROP_TYPE_NUMBER,
452 PROP_READONLY, ZFS_TYPE_DATASET, "OBJSETID");
96c2e961
KW		 453 zprop_register_hidden(ZFS_PROP_INCONSISTENT, "inconsistent",
454 PROP_TYPE_NUMBER, PROP_READONLY, ZFS_TYPE_DATASET, "INCONSISTENT");
428870ff
BB		 455
456 /*
457 * Property to be removed once libbe is integrated
458 */
459 zprop_register_hidden(ZFS_PROP_PRIVATE, "priv_prop",
460 PROP_TYPE_NUMBER, PROP_READONLY, ZFS_TYPE_FILESYSTEM,
461 "PRIV_PROP");
34dc7c2f
BB		 462
463 /* oddball properties */
428870ff 464 zprop_register_impl(ZFS_PROP_CREATION, "creation", PROP_TYPE_NUMBER, 0,
da536844 465 NULL, PROP_READONLY, ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK,
34dc7c2f
BB		 466 "<date>", "CREATION", B_FALSE, B_TRUE, NULL);
467}
468
469boolean_t
470zfs_prop_delegatable(zfs_prop_t prop)
471{
472 zprop_desc_t *pd = &zfs_prop_table[prop];
428870ff
BB		 473
474 /* The mlslabel property is never delegatable. */
475 if (prop == ZFS_PROP_MLSLABEL)
476 return (B_FALSE);
477
34dc7c2f
BB		 478 return (pd->pd_attr != PROP_READONLY);
479}
480
481/*
482 * Given a zfs dataset property name, returns the corresponding property ID.
483 */
484zfs_prop_t
485zfs_name_to_prop(const char *propname)
486{
487 return (zprop_name_to_prop(propname, ZFS_TYPE_DATASET));
488}
489
34dc7c2f
BB		 490/*
491 * For user property names, we allow all lowercase alphanumeric characters, plus
492 * a few useful punctuation characters.
493 */
494static int
495valid_char(char c)
496{
497 return ((c >= 'a' && c <= 'z') ||
498 (c >= '0' && c <= '9') ||
499 c == '-' || c == '_' || c == '.' || c == ':');
500}
501
502/*
503 * Returns true if this is a valid user-defined property (one with a ':').
504 */
505boolean_t
506zfs_prop_user(const char *name)
507{
508 int i;
509 char c;
510 boolean_t foundsep = B_FALSE;
511
512 for (i = 0; i < strlen(name); i++) {
513 c = name[i];
514 if (!valid_char(c))
515 return (B_FALSE);
516 if (c == ':')
517 foundsep = B_TRUE;
518 }
519
520 if (!foundsep)
521 return (B_FALSE);
522
523 return (B_TRUE);
524}
525
9babb374
BB		 526/*
527 * Returns true if this is a valid userspace-type property (one with a '@').
528 * Note that after the @, any character is valid (eg, another @, for SID
529 * user@domain).
530 */
531boolean_t
532zfs_prop_userquota(const char *name)
533{
534 zfs_userquota_prop_t prop;
535
536 for (prop = 0; prop < ZFS_NUM_USERQUOTA_PROPS; prop++) {
537 if (strncmp(name, zfs_userquota_prop_prefixes[prop],
538 strlen(zfs_userquota_prop_prefixes[prop])) == 0) {
539 return (B_TRUE);
540 }
541 }
542
543 return (B_FALSE);
544}
545
330d06f9
MA		 546/*
547 * Returns true if this is a valid written@ property.
548 * Note that after the @, any character is valid (eg, another @, for
549 * written@pool/fs@origin).
550 */
551boolean_t
552zfs_prop_written(const char *name)
553{
554 static const char *prefix = "written@";
555 return (strncmp(name, prefix, strlen(prefix)) == 0);
556}
557
34dc7c2f
BB		 558/*
559 * Tables of index types, plus functions to convert between the user view
560 * (strings) and internal representation (uint64_t).
561 */
562int
563zfs_prop_string_to_index(zfs_prop_t prop, const char *string, uint64_t *index)
564{
565 return (zprop_string_to_index(prop, string, index, ZFS_TYPE_DATASET));
566}
567
568int
569zfs_prop_index_to_string(zfs_prop_t prop, uint64_t index, const char **string)
570{
571 return (zprop_index_to_string(prop, index, string, ZFS_TYPE_DATASET));
572}
573
428870ff
BB		 574uint64_t
575zfs_prop_random_value(zfs_prop_t prop, uint64_t seed)
576{
577 return (zprop_random_value(prop, seed, ZFS_TYPE_DATASET));
578}
579
34dc7c2f
BB		 580/*
581 * Returns TRUE if the property applies to any of the given dataset types.
582 */
b128c09f 583boolean_t
962d5242 584zfs_prop_valid_for_type(int prop, zfs_type_t types, boolean_t headcheck)
34dc7c2f 585{
962d5242 586 return (zprop_valid_for_type(prop, types, headcheck));
34dc7c2f
BB		 587}
588
589zprop_type_t
590zfs_prop_get_type(zfs_prop_t prop)
591{
592 return (zfs_prop_table[prop].pd_proptype);
593}
594
595/*
596 * Returns TRUE if the property is readonly.
597 */
598boolean_t
599zfs_prop_readonly(zfs_prop_t prop)
600{
601 return (zfs_prop_table[prop].pd_attr == PROP_READONLY ||
602 zfs_prop_table[prop].pd_attr == PROP_ONETIME);
603}
604
605/*
606 * Returns TRUE if the property is only allowed to be set once.
607 */
608boolean_t
609zfs_prop_setonce(zfs_prop_t prop)
610{
611 return (zfs_prop_table[prop].pd_attr == PROP_ONETIME);
612}
613
614const char *
615zfs_prop_default_string(zfs_prop_t prop)
616{
617 return (zfs_prop_table[prop].pd_strdefault);
618}
619
620uint64_t
621zfs_prop_default_numeric(zfs_prop_t prop)
622{
623 return (zfs_prop_table[prop].pd_numdefault);
624}
625
626/*
627 * Given a dataset property ID, returns the corresponding name.
628 * Assuming the zfs dataset property ID is valid.
629 */
630const char *
631zfs_prop_to_name(zfs_prop_t prop)
632{
633 return (zfs_prop_table[prop].pd_name);
634}
635
636/*
637 * Returns TRUE if the property is inheritable.
638 */
639boolean_t
640zfs_prop_inheritable(zfs_prop_t prop)
641{
642 return (zfs_prop_table[prop].pd_attr == PROP_INHERIT ||
643 zfs_prop_table[prop].pd_attr == PROP_ONETIME);
644}
645
646#ifndef _KERNEL
647
648/*
649 * Returns a string describing the set of acceptable values for the given
650 * zfs property, or NULL if it cannot be set.
651 */
652const char *
653zfs_prop_values(zfs_prop_t prop)
654{
655 return (zfs_prop_table[prop].pd_values);
656}
657
658/*
659 * Returns TRUE if this property is a string type. Note that index types
660 * (compression, checksum) are treated as strings in userland, even though they
661 * are stored numerically on disk.
662 */
663int
664zfs_prop_is_string(zfs_prop_t prop)
665{
666 return (zfs_prop_table[prop].pd_proptype == PROP_TYPE_STRING ||
667 zfs_prop_table[prop].pd_proptype == PROP_TYPE_INDEX);
668}
669
670/*
671 * Returns the column header for the given property. Used only in
672 * 'zfs list -o', but centralized here with the other property information.
673 */
674const char *
675zfs_prop_column_name(zfs_prop_t prop)
676{
677 return (zfs_prop_table[prop].pd_colname);
678}
679
680/*
681 * Returns whether the given property should be displayed right-justified for
682 * 'zfs list'.
683 */
684boolean_t
685zfs_prop_align_right(zfs_prop_t prop)
686{
687 return (zfs_prop_table[prop].pd_rightalign);
688}
689
690#endif
c28b2279
BB		 691
692#if defined(_KERNEL) && defined(HAVE_SPL)
b4f3666a
BB		 693static int __init
694zcommon_init(void)
695{
696 return (0);
697}
c28b2279 698
b4f3666a
BB		 699static void __exit
700zcommon_fini(void)
701{
702}
c28b2279 703
b4f3666a
BB		 704module_init(zcommon_init);
705module_exit(zcommon_fini);
c28b2279
BB		 706
707MODULE_DESCRIPTION("Generic ZFS support");
708MODULE_AUTHOR(ZFS_META_AUTHOR);
709MODULE_LICENSE(ZFS_META_LICENSE);
99e349db 710MODULE_VERSION(ZFS_META_VERSION "-" ZFS_META_RELEASE);
c28b2279
BB		 711
712/* zfs dataset property functions */
713EXPORT_SYMBOL(zfs_userquota_prop_prefixes);
714EXPORT_SYMBOL(zfs_prop_init);
715EXPORT_SYMBOL(zfs_prop_get_type);
716EXPORT_SYMBOL(zfs_prop_get_table);
717EXPORT_SYMBOL(zfs_prop_delegatable);
718
719/* Dataset property functions shared between libzfs and kernel. */
720EXPORT_SYMBOL(zfs_prop_default_string);
721EXPORT_SYMBOL(zfs_prop_default_numeric);
722EXPORT_SYMBOL(zfs_prop_readonly);
723EXPORT_SYMBOL(zfs_prop_inheritable);
724EXPORT_SYMBOL(zfs_prop_setonce);
725EXPORT_SYMBOL(zfs_prop_to_name);
726EXPORT_SYMBOL(zfs_name_to_prop);
727EXPORT_SYMBOL(zfs_prop_user);
728EXPORT_SYMBOL(zfs_prop_userquota);
729EXPORT_SYMBOL(zfs_prop_index_to_string);
730EXPORT_SYMBOL(zfs_prop_string_to_index);
731EXPORT_SYMBOL(zfs_prop_valid_for_type);
732
733#endif
ZFS On Linux mirror for PVE