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.
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.
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]
23 * Copyright (c) 2010, Oracle and/or its affiliates. All rights reserved.
24 * Portions Copyright 2011 iXsystems, Inc
25 * Copyright (c) 2013 by Delphix. All rights reserved.
28 #include <sys/zfs_context.h>
29 #include <sys/types.h>
30 #include <sys/param.h>
31 #include <sys/systm.h>
32 #include <sys/sysmacros.h>
34 #include <sys/dmu_impl.h>
35 #include <sys/dmu_objset.h>
37 #include <sys/dnode.h>
40 #include <sys/sunddi.h>
41 #include <sys/sa_impl.h>
42 #include <sys/dnode.h>
43 #include <sys/errno.h>
44 #include <sys/zfs_context.h>
47 * ZFS System attributes:
49 * A generic mechanism to allow for arbitrary attributes
50 * to be stored in a dnode. The data will be stored in the bonus buffer of
51 * the dnode and if necessary a special "spill" block will be used to handle
52 * overflow situations. The spill block will be sized to fit the data
53 * from 512 - 128K. When a spill block is used the BP (blkptr_t) for the
54 * spill block is stored at the end of the current bonus buffer. Any
55 * attributes that would be in the way of the blkptr_t will be relocated
56 * into the spill block.
58 * Attribute registration:
60 * Stored persistently on a per dataset basis
61 * a mapping between attribute "string" names and their actual attribute
62 * numeric values, length, and byteswap function. The names are only used
63 * during registration. All attributes are known by their unique attribute
64 * id value. If an attribute can have a variable size then the value
65 * 0 will be used to indicate this.
69 * Attribute layouts are a way to compactly store multiple attributes, but
70 * without taking the overhead associated with managing each attribute
71 * individually. Since you will typically have the same set of attributes
72 * stored in the same order a single table will be used to represent that
73 * layout. The ZPL for example will usually have only about 10 different
74 * layouts (regular files, device files, symlinks,
75 * regular files + scanstamp, files/dir with extended attributes, and then
76 * you have the possibility of all of those minus ACL, because it would
77 * be kicked out into the spill block)
79 * Layouts are simply an array of the attributes and their
80 * ordering i.e. [0, 1, 4, 5, 2]
82 * Each distinct layout is given a unique layout number and that is whats
83 * stored in the header at the beginning of the SA data buffer.
85 * A layout only covers a single dbuf (bonus or spill). If a set of
86 * attributes is split up between the bonus buffer and a spill buffer then
87 * two different layouts will be used. This allows us to byteswap the
88 * spill without looking at the bonus buffer and keeps the on disk format of
89 * the bonus and spill buffer the same.
91 * Adding a single attribute will cause the entire set of attributes to
92 * be rewritten and could result in a new layout number being constructed
93 * as part of the rewrite if no such layout exists for the new set of
94 * attribues. The new attribute will be appended to the end of the already
95 * existing attributes.
97 * Both the attribute registration and attribute layout information are
98 * stored in normal ZAP attributes. Their should be a small number of
99 * known layouts and the set of attributes is assumed to typically be quite
102 * The registered attributes and layout "table" information is maintained
103 * in core and a special "sa_os_t" is attached to the objset_t.
105 * A special interface is provided to allow for quickly applying
106 * a large set of attributes at once. sa_replace_all_by_template() is
107 * used to set an array of attributes. This is used by the ZPL when
108 * creating a brand new file. The template that is passed into the function
109 * specifies the attribute, size for variable length attributes, location of
110 * data and special "data locator" function if the data isn't in a contiguous
113 * Byteswap implications:
114 * Since the SA attributes are not entirely self describing we can't do
115 * the normal byteswap processing. The special ZAP layout attribute and
116 * attribute registration attributes define the byteswap function and the
117 * size of the attributes, unless it is variable sized.
118 * The normal ZFS byteswapping infrastructure assumes you don't need
119 * to read any objects in order to do the necessary byteswapping. Whereas
120 * SA attributes can only be properly byteswapped if the dataset is opened
121 * and the layout/attribute ZAP attributes are available. Because of this
122 * the SA attributes will be byteswapped when they are first accessed by
123 * the SA code that will read the SA data.
126 typedef void (sa_iterfunc_t)(void *hdr, void *addr, sa_attr_type_t,
127 uint16_t length, int length_idx, boolean_t, void *userp);
129 static int sa_build_index(sa_handle_t *hdl, sa_buf_type_t buftype);
130 static void sa_idx_tab_hold(objset_t *os, sa_idx_tab_t *idx_tab);
131 static void *sa_find_idx_tab(objset_t *os, dmu_object_type_t bonustype,
133 static void sa_idx_tab_rele(objset_t *os, void *arg);
134 static void sa_copy_data(sa_data_locator_t *func, void *start, void *target,
136 static int sa_modify_attrs(sa_handle_t *hdl, sa_attr_type_t newattr,
137 sa_data_op_t action, sa_data_locator_t *locator, void *datastart,
138 uint16_t buflen, dmu_tx_t *tx);
140 arc_byteswap_func_t *sa_bswap_table[] = {
141 byteswap_uint64_array,
142 byteswap_uint32_array,
143 byteswap_uint16_array,
144 byteswap_uint8_array,
148 #define SA_COPY_DATA(f, s, t, l) \
152 *(uint64_t *)t = *(uint64_t *)s; \
153 } else if (l == 16) { \
154 *(uint64_t *)t = *(uint64_t *)s; \
155 *(uint64_t *)((uintptr_t)t + 8) = \
156 *(uint64_t *)((uintptr_t)s + 8); \
161 sa_copy_data(f, s, t, l); \
165 * This table is fixed and cannot be changed. Its purpose is to
166 * allow the SA code to work with both old/new ZPL file systems.
167 * It contains the list of legacy attributes. These attributes aren't
168 * stored in the "attribute" registry zap objects, since older ZPL file systems
169 * won't have the registry. Only objsets of type ZFS_TYPE_FILESYSTEM will
170 * use this static table.
172 sa_attr_reg_t sa_legacy_attrs[] = {
173 {"ZPL_ATIME", sizeof (uint64_t) * 2, SA_UINT64_ARRAY, 0},
174 {"ZPL_MTIME", sizeof (uint64_t) * 2, SA_UINT64_ARRAY, 1},
175 {"ZPL_CTIME", sizeof (uint64_t) * 2, SA_UINT64_ARRAY, 2},
176 {"ZPL_CRTIME", sizeof (uint64_t) * 2, SA_UINT64_ARRAY, 3},
177 {"ZPL_GEN", sizeof (uint64_t), SA_UINT64_ARRAY, 4},
178 {"ZPL_MODE", sizeof (uint64_t), SA_UINT64_ARRAY, 5},
179 {"ZPL_SIZE", sizeof (uint64_t), SA_UINT64_ARRAY, 6},
180 {"ZPL_PARENT", sizeof (uint64_t), SA_UINT64_ARRAY, 7},
181 {"ZPL_LINKS", sizeof (uint64_t), SA_UINT64_ARRAY, 8},
182 {"ZPL_XATTR", sizeof (uint64_t), SA_UINT64_ARRAY, 9},
183 {"ZPL_RDEV", sizeof (uint64_t), SA_UINT64_ARRAY, 10},
184 {"ZPL_FLAGS", sizeof (uint64_t), SA_UINT64_ARRAY, 11},
185 {"ZPL_UID", sizeof (uint64_t), SA_UINT64_ARRAY, 12},
186 {"ZPL_GID", sizeof (uint64_t), SA_UINT64_ARRAY, 13},
187 {"ZPL_PAD", sizeof (uint64_t) * 4, SA_UINT64_ARRAY, 14},
188 {"ZPL_ZNODE_ACL", 88, SA_UINT8_ARRAY, 15},
193 * This is only used for objects of type DMU_OT_ZNODE
195 sa_attr_type_t sa_legacy_zpl_layout[] = {
196 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
200 * Special dummy layout used for buffers with no attributes.
203 sa_attr_type_t sa_dummy_zpl_layout[] = { 0 };
205 static int sa_legacy_attr_count = 16;
206 static kmem_cache_t *sa_cache = NULL;
210 sa_cache_constructor(void *buf, void *unused, int kmflag)
212 sa_handle_t *hdl = buf;
214 hdl->sa_bonus_tab = NULL;
215 hdl->sa_spill_tab = NULL;
217 hdl->sa_userp = NULL;
218 hdl->sa_bonus = NULL;
219 hdl->sa_spill = NULL;
220 mutex_init(&hdl->sa_lock, NULL, MUTEX_DEFAULT, NULL);
226 sa_cache_destructor(void *buf, void *unused)
228 sa_handle_t *hdl = buf;
229 mutex_destroy(&hdl->sa_lock);
235 sa_cache = kmem_cache_create("sa_cache",
236 sizeof (sa_handle_t), 0, sa_cache_constructor,
237 sa_cache_destructor, NULL, NULL, NULL, 0);
244 kmem_cache_destroy(sa_cache);
248 layout_num_compare(const void *arg1, const void *arg2)
250 const sa_lot_t *node1 = arg1;
251 const sa_lot_t *node2 = arg2;
253 if (node1->lot_num > node2->lot_num)
255 else if (node1->lot_num < node2->lot_num)
261 layout_hash_compare(const void *arg1, const void *arg2)
263 const sa_lot_t *node1 = arg1;
264 const sa_lot_t *node2 = arg2;
266 if (node1->lot_hash > node2->lot_hash)
268 if (node1->lot_hash < node2->lot_hash)
270 if (node1->lot_instance > node2->lot_instance)
272 if (node1->lot_instance < node2->lot_instance)
278 sa_layout_equal(sa_lot_t *tbf, sa_attr_type_t *attrs, int count)
282 if (count != tbf->lot_attr_count)
285 for (i = 0; i != count; i++) {
286 if (attrs[i] != tbf->lot_attrs[i])
292 #define SA_ATTR_HASH(attr) (zfs_crc64_table[(-1ULL ^ attr) & 0xFF])
295 sa_layout_info_hash(sa_attr_type_t *attrs, int attr_count)
298 uint64_t crc = -1ULL;
300 for (i = 0; i != attr_count; i++)
301 crc ^= SA_ATTR_HASH(attrs[i]);
307 sa_get_spill(sa_handle_t *hdl)
310 if (hdl->sa_spill == NULL) {
311 if ((rc = dmu_spill_hold_existing(hdl->sa_bonus, NULL,
312 &hdl->sa_spill)) == 0)
313 VERIFY(0 == sa_build_index(hdl, SA_SPILL));
322 * Main attribute lookup/update function
323 * returns 0 for success or non zero for failures
325 * Operates on bulk array, first failure will abort further processing
328 sa_attr_op(sa_handle_t *hdl, sa_bulk_attr_t *bulk, int count,
329 sa_data_op_t data_op, dmu_tx_t *tx)
331 sa_os_t *sa = hdl->sa_os->os_sa;
334 sa_buf_type_t buftypes;
339 for (i = 0; i != count; i++) {
340 ASSERT(bulk[i].sa_attr <= hdl->sa_os->os_sa->sa_num_attrs);
342 bulk[i].sa_addr = NULL;
343 /* First check the bonus buffer */
345 if (hdl->sa_bonus_tab && TOC_ATTR_PRESENT(
346 hdl->sa_bonus_tab->sa_idx_tab[bulk[i].sa_attr])) {
347 SA_ATTR_INFO(sa, hdl->sa_bonus_tab,
348 SA_GET_HDR(hdl, SA_BONUS),
349 bulk[i].sa_attr, bulk[i], SA_BONUS, hdl);
350 if (tx && !(buftypes & SA_BONUS)) {
351 dmu_buf_will_dirty(hdl->sa_bonus, tx);
352 buftypes |= SA_BONUS;
355 if (bulk[i].sa_addr == NULL &&
356 ((error = sa_get_spill(hdl)) == 0)) {
357 if (TOC_ATTR_PRESENT(
358 hdl->sa_spill_tab->sa_idx_tab[bulk[i].sa_attr])) {
359 SA_ATTR_INFO(sa, hdl->sa_spill_tab,
360 SA_GET_HDR(hdl, SA_SPILL),
361 bulk[i].sa_attr, bulk[i], SA_SPILL, hdl);
362 if (tx && !(buftypes & SA_SPILL) &&
363 bulk[i].sa_size == bulk[i].sa_length) {
364 dmu_buf_will_dirty(hdl->sa_spill, tx);
365 buftypes |= SA_SPILL;
369 if (error && error != ENOENT) {
370 return ((error == ECKSUM) ? EIO : error);
375 if (bulk[i].sa_addr == NULL)
376 return (SET_ERROR(ENOENT));
377 if (bulk[i].sa_data) {
378 SA_COPY_DATA(bulk[i].sa_data_func,
379 bulk[i].sa_addr, bulk[i].sa_data,
385 /* existing rewrite of attr */
386 if (bulk[i].sa_addr &&
387 bulk[i].sa_size == bulk[i].sa_length) {
388 SA_COPY_DATA(bulk[i].sa_data_func,
389 bulk[i].sa_data, bulk[i].sa_addr,
392 } else if (bulk[i].sa_addr) { /* attr size change */
393 error = sa_modify_attrs(hdl, bulk[i].sa_attr,
394 SA_REPLACE, bulk[i].sa_data_func,
395 bulk[i].sa_data, bulk[i].sa_length, tx);
396 } else { /* adding new attribute */
397 error = sa_modify_attrs(hdl, bulk[i].sa_attr,
398 SA_ADD, bulk[i].sa_data_func,
399 bulk[i].sa_data, bulk[i].sa_length, tx);
410 sa_add_layout_entry(objset_t *os, sa_attr_type_t *attrs, int attr_count,
411 uint64_t lot_num, uint64_t hash, boolean_t zapadd, dmu_tx_t *tx)
413 sa_os_t *sa = os->os_sa;
414 sa_lot_t *tb, *findtb;
418 ASSERT(MUTEX_HELD(&sa->sa_lock));
419 tb = kmem_zalloc(sizeof (sa_lot_t), KM_SLEEP);
420 tb->lot_attr_count = attr_count;
421 tb->lot_attrs = kmem_alloc(sizeof (sa_attr_type_t) * attr_count,
423 bcopy(attrs, tb->lot_attrs, sizeof (sa_attr_type_t) * attr_count);
424 tb->lot_num = lot_num;
426 tb->lot_instance = 0;
431 if (sa->sa_layout_attr_obj == 0) {
432 sa->sa_layout_attr_obj = zap_create_link(os,
433 DMU_OT_SA_ATTR_LAYOUTS,
434 sa->sa_master_obj, SA_LAYOUTS, tx);
437 (void) snprintf(attr_name, sizeof (attr_name),
439 VERIFY(0 == zap_update(os, os->os_sa->sa_layout_attr_obj,
440 attr_name, 2, attr_count, attrs, tx));
443 list_create(&tb->lot_idx_tab, sizeof (sa_idx_tab_t),
444 offsetof(sa_idx_tab_t, sa_next));
446 for (i = 0; i != attr_count; i++) {
447 if (sa->sa_attr_table[tb->lot_attrs[i]].sa_length == 0)
451 avl_add(&sa->sa_layout_num_tree, tb);
453 /* verify we don't have a hash collision */
454 if ((findtb = avl_find(&sa->sa_layout_hash_tree, tb, &loc)) != NULL) {
455 for (; findtb && findtb->lot_hash == hash;
456 findtb = AVL_NEXT(&sa->sa_layout_hash_tree, findtb)) {
457 if (findtb->lot_instance != tb->lot_instance)
462 avl_add(&sa->sa_layout_hash_tree, tb);
467 sa_find_layout(objset_t *os, uint64_t hash, sa_attr_type_t *attrs,
468 int count, dmu_tx_t *tx, sa_lot_t **lot)
470 sa_lot_t *tb, tbsearch;
472 sa_os_t *sa = os->os_sa;
473 boolean_t found = B_FALSE;
475 mutex_enter(&sa->sa_lock);
476 tbsearch.lot_hash = hash;
477 tbsearch.lot_instance = 0;
478 tb = avl_find(&sa->sa_layout_hash_tree, &tbsearch, &loc);
480 for (; tb && tb->lot_hash == hash;
481 tb = AVL_NEXT(&sa->sa_layout_hash_tree, tb)) {
482 if (sa_layout_equal(tb, attrs, count) == 0) {
489 tb = sa_add_layout_entry(os, attrs, count,
490 avl_numnodes(&sa->sa_layout_num_tree), hash, B_TRUE, tx);
492 mutex_exit(&sa->sa_lock);
497 sa_resize_spill(sa_handle_t *hdl, uint32_t size, dmu_tx_t *tx)
503 blocksize = SPA_MINBLOCKSIZE;
504 } else if (size > SPA_MAXBLOCKSIZE) {
506 return (SET_ERROR(EFBIG));
508 blocksize = P2ROUNDUP_TYPED(size, SPA_MINBLOCKSIZE, uint32_t);
511 error = dbuf_spill_set_blksz(hdl->sa_spill, blocksize, tx);
517 sa_copy_data(sa_data_locator_t *func, void *datastart, void *target, int buflen)
520 bcopy(datastart, target, buflen);
525 void *saptr = target;
530 while (bytes < buflen) {
531 func(&dataptr, &length, buflen, start, datastart);
532 bcopy(dataptr, saptr, length);
533 saptr = (void *)((caddr_t)saptr + length);
541 * Determine several different sizes
542 * first the sa header size
543 * the number of bytes to be stored
544 * if spill would occur the index in the attribute array is returned
546 * the boolean will_spill will be set when spilling is necessary. It
547 * is only set when the buftype is SA_BONUS
550 sa_find_sizes(sa_os_t *sa, sa_bulk_attr_t *attr_desc, int attr_count,
551 dmu_buf_t *db, sa_buf_type_t buftype, int *index, int *total,
552 boolean_t *will_spill)
559 boolean_t done = B_FALSE;
561 if (buftype == SA_BONUS && sa->sa_force_spill) {
564 *will_spill = B_TRUE;
571 if (buftype == SA_BONUS)
572 *will_spill = B_FALSE;
574 hdrsize = (SA_BONUSTYPE_FROM_DB(db) == DMU_OT_ZNODE) ? 0 :
575 sizeof (sa_hdr_phys_t);
577 full_space = (buftype == SA_BONUS) ? DN_MAX_BONUSLEN : db->db_size;
578 ASSERT(IS_P2ALIGNED(full_space, 8));
580 for (i = 0; i != attr_count; i++) {
583 *total = P2ROUNDUP(*total, 8);
584 *total += attr_desc[i].sa_length;
588 is_var_sz = (SA_REGISTERED_LEN(sa, attr_desc[i].sa_attr) == 0);
593 if (is_var_sz && var_size > 1) {
594 if (P2ROUNDUP(hdrsize + sizeof (uint16_t), 8) +
595 *total < full_space) {
597 * Account for header space used by array of
598 * optional sizes of variable-length attributes.
599 * Record the index in case this increase needs
600 * to be reversed due to spill-over.
602 hdrsize += sizeof (uint16_t);
607 if (buftype == SA_BONUS)
608 *will_spill = B_TRUE;
614 * find index of where spill *could* occur.
615 * Then continue to count of remainder attribute
616 * space. The sum is used later for sizing bonus
619 if (buftype == SA_BONUS && *index == -1 &&
620 (*total + P2ROUNDUP(hdrsize, 8)) >
621 (full_space - sizeof (blkptr_t))) {
627 if ((*total + P2ROUNDUP(hdrsize, 8)) > full_space &&
629 *will_spill = B_TRUE;
633 * j holds the index of the last variable-sized attribute for
634 * which hdrsize was increased. Reverse the increase if that
635 * attribute will be relocated to the spill block.
637 if (*will_spill && j == *index)
638 hdrsize -= sizeof (uint16_t);
640 hdrsize = P2ROUNDUP(hdrsize, 8);
644 #define BUF_SPACE_NEEDED(total, header) (total + header)
647 * Find layout that corresponds to ordering of attributes
648 * If not found a new layout number is created and added to
649 * persistent layout tables.
652 sa_build_layouts(sa_handle_t *hdl, sa_bulk_attr_t *attr_desc, int attr_count,
655 sa_os_t *sa = hdl->sa_os->os_sa;
657 sa_buf_type_t buftype;
658 sa_hdr_phys_t *sahdr;
661 sa_attr_type_t *attrs, *attrs_start;
664 int spillhdrsize = 0;
666 dmu_object_type_t bonustype;
672 dmu_buf_will_dirty(hdl->sa_bonus, tx);
673 bonustype = SA_BONUSTYPE_FROM_DB(hdl->sa_bonus);
675 /* first determine bonus header size and sum of all attributes */
676 hdrsize = sa_find_sizes(sa, attr_desc, attr_count, hdl->sa_bonus,
677 SA_BONUS, &i, &used, &spilling);
679 if (used > SPA_MAXBLOCKSIZE)
680 return (SET_ERROR(EFBIG));
682 VERIFY(0 == dmu_set_bonus(hdl->sa_bonus, spilling ?
683 MIN(DN_MAX_BONUSLEN - sizeof (blkptr_t), used + hdrsize) :
684 used + hdrsize, tx));
686 ASSERT((bonustype == DMU_OT_ZNODE && spilling == 0) ||
687 bonustype == DMU_OT_SA);
689 /* setup and size spill buffer when needed */
693 if (hdl->sa_spill == NULL) {
694 VERIFY(dmu_spill_hold_by_bonus(hdl->sa_bonus, NULL,
695 &hdl->sa_spill) == 0);
697 dmu_buf_will_dirty(hdl->sa_spill, tx);
699 spillhdrsize = sa_find_sizes(sa, &attr_desc[i],
700 attr_count - i, hdl->sa_spill, SA_SPILL, &i,
701 &spill_used, &dummy);
703 if (spill_used > SPA_MAXBLOCKSIZE)
704 return (SET_ERROR(EFBIG));
706 buf_space = hdl->sa_spill->db_size - spillhdrsize;
707 if (BUF_SPACE_NEEDED(spill_used, spillhdrsize) >
708 hdl->sa_spill->db_size)
709 VERIFY(0 == sa_resize_spill(hdl,
710 BUF_SPACE_NEEDED(spill_used, spillhdrsize), tx));
713 /* setup starting pointers to lay down data */
714 data_start = (void *)((uintptr_t)hdl->sa_bonus->db_data + hdrsize);
715 sahdr = (sa_hdr_phys_t *)hdl->sa_bonus->db_data;
719 buf_space = (sa->sa_force_spill) ?
720 0 : SA_BLKPTR_SPACE - hdrsize;
722 buf_space = hdl->sa_bonus->db_size - hdrsize;
724 attrs_start = attrs = kmem_alloc(sizeof (sa_attr_type_t) * attr_count,
728 for (i = 0, len_idx = 0, hash = -1ULL; i != attr_count; i++) {
731 ASSERT(IS_P2ALIGNED(data_start, 8));
732 ASSERT(IS_P2ALIGNED(buf_space, 8));
733 attrs[i] = attr_desc[i].sa_attr;
734 length = SA_REGISTERED_LEN(sa, attrs[i]);
736 length = attr_desc[i].sa_length;
738 VERIFY(length == attr_desc[i].sa_length);
740 if (buf_space < length) { /* switch to spill buffer */
742 VERIFY(bonustype == DMU_OT_SA);
743 if (buftype == SA_BONUS && !sa->sa_force_spill) {
744 sa_find_layout(hdl->sa_os, hash, attrs_start,
745 lot_count, tx, &lot);
746 SA_SET_HDR(sahdr, lot->lot_num, hdrsize);
753 sahdr = (sa_hdr_phys_t *)hdl->sa_spill->db_data;
754 sahdr->sa_magic = SA_MAGIC;
755 data_start = (void *)((uintptr_t)sahdr +
757 attrs_start = &attrs[i];
758 buf_space = hdl->sa_spill->db_size - spillhdrsize;
761 hash ^= SA_ATTR_HASH(attrs[i]);
762 attr_desc[i].sa_addr = data_start;
763 attr_desc[i].sa_size = length;
764 SA_COPY_DATA(attr_desc[i].sa_data_func, attr_desc[i].sa_data,
766 if (sa->sa_attr_table[attrs[i]].sa_length == 0) {
767 sahdr->sa_lengths[len_idx++] = length;
769 VERIFY((uintptr_t)data_start % 8 == 0);
770 data_start = (void *)P2ROUNDUP(((uintptr_t)data_start +
772 buf_space -= P2ROUNDUP(length, 8);
776 sa_find_layout(hdl->sa_os, hash, attrs_start, lot_count, tx, &lot);
779 * Verify that old znodes always have layout number 0.
780 * Must be DMU_OT_SA for arbitrary layouts
782 VERIFY((bonustype == DMU_OT_ZNODE && lot->lot_num == 0) ||
783 (bonustype == DMU_OT_SA && lot->lot_num > 1));
785 if (bonustype == DMU_OT_SA) {
786 SA_SET_HDR(sahdr, lot->lot_num,
787 buftype == SA_BONUS ? hdrsize : spillhdrsize);
790 kmem_free(attrs, sizeof (sa_attr_type_t) * attr_count);
791 if (hdl->sa_bonus_tab) {
792 sa_idx_tab_rele(hdl->sa_os, hdl->sa_bonus_tab);
793 hdl->sa_bonus_tab = NULL;
795 if (!sa->sa_force_spill)
796 VERIFY(0 == sa_build_index(hdl, SA_BONUS));
798 sa_idx_tab_rele(hdl->sa_os, hdl->sa_spill_tab);
801 * remove spill block that is no longer needed.
803 dmu_buf_rele(hdl->sa_spill, NULL);
804 hdl->sa_spill = NULL;
805 hdl->sa_spill_tab = NULL;
806 VERIFY(0 == dmu_rm_spill(hdl->sa_os,
807 sa_handle_object(hdl), tx));
809 VERIFY(0 == sa_build_index(hdl, SA_SPILL));
817 sa_free_attr_table(sa_os_t *sa)
821 if (sa->sa_attr_table == NULL)
824 for (i = 0; i != sa->sa_num_attrs; i++) {
825 if (sa->sa_attr_table[i].sa_name)
826 kmem_free(sa->sa_attr_table[i].sa_name,
827 strlen(sa->sa_attr_table[i].sa_name) + 1);
830 kmem_free(sa->sa_attr_table,
831 sizeof (sa_attr_table_t) * sa->sa_num_attrs);
833 sa->sa_attr_table = NULL;
837 sa_attr_table_setup(objset_t *os, sa_attr_reg_t *reg_attrs, int count)
839 sa_os_t *sa = os->os_sa;
840 uint64_t sa_attr_count = 0;
841 uint64_t sa_reg_count = 0;
847 int registered_count = 0;
849 dmu_objset_type_t ostype = dmu_objset_type(os);
852 kmem_zalloc(count * sizeof (sa_attr_type_t), KM_SLEEP);
853 sa->sa_user_table_sz = count * sizeof (sa_attr_type_t);
855 if (sa->sa_reg_attr_obj != 0) {
856 error = zap_count(os, sa->sa_reg_attr_obj,
860 * Make sure we retrieved a count and that it isn't zero
862 if (error || (error == 0 && sa_attr_count == 0)) {
864 error = SET_ERROR(EINVAL);
867 sa_reg_count = sa_attr_count;
870 if (ostype == DMU_OST_ZFS && sa_attr_count == 0)
871 sa_attr_count += sa_legacy_attr_count;
873 /* Allocate attribute numbers for attributes that aren't registered */
874 for (i = 0; i != count; i++) {
875 boolean_t found = B_FALSE;
878 if (ostype == DMU_OST_ZFS) {
879 for (j = 0; j != sa_legacy_attr_count; j++) {
880 if (strcmp(reg_attrs[i].sa_name,
881 sa_legacy_attrs[j].sa_name) == 0) {
882 sa->sa_user_table[i] =
883 sa_legacy_attrs[j].sa_attr;
891 if (sa->sa_reg_attr_obj)
892 error = zap_lookup(os, sa->sa_reg_attr_obj,
893 reg_attrs[i].sa_name, 8, 1, &attr_value);
895 error = SET_ERROR(ENOENT);
898 sa->sa_user_table[i] = (sa_attr_type_t)sa_attr_count;
902 sa->sa_user_table[i] = ATTR_NUM(attr_value);
909 sa->sa_num_attrs = sa_attr_count;
910 tb = sa->sa_attr_table =
911 kmem_zalloc(sizeof (sa_attr_table_t) * sa_attr_count, KM_SLEEP);
914 * Attribute table is constructed from requested attribute list,
915 * previously foreign registered attributes, and also the legacy
916 * ZPL set of attributes.
919 if (sa->sa_reg_attr_obj) {
920 for (zap_cursor_init(&zc, os, sa->sa_reg_attr_obj);
921 (error = zap_cursor_retrieve(&zc, &za)) == 0;
922 zap_cursor_advance(&zc)) {
924 value = za.za_first_integer;
927 tb[ATTR_NUM(value)].sa_attr = ATTR_NUM(value);
928 tb[ATTR_NUM(value)].sa_length = ATTR_LENGTH(value);
929 tb[ATTR_NUM(value)].sa_byteswap = ATTR_BSWAP(value);
930 tb[ATTR_NUM(value)].sa_registered = B_TRUE;
932 if (tb[ATTR_NUM(value)].sa_name) {
935 tb[ATTR_NUM(value)].sa_name =
936 kmem_zalloc(strlen(za.za_name) +1, KM_SLEEP);
937 (void) strlcpy(tb[ATTR_NUM(value)].sa_name, za.za_name,
938 strlen(za.za_name) +1);
940 zap_cursor_fini(&zc);
942 * Make sure we processed the correct number of registered
945 if (registered_count != sa_reg_count) {
952 if (ostype == DMU_OST_ZFS) {
953 for (i = 0; i != sa_legacy_attr_count; i++) {
956 tb[i].sa_attr = sa_legacy_attrs[i].sa_attr;
957 tb[i].sa_length = sa_legacy_attrs[i].sa_length;
958 tb[i].sa_byteswap = sa_legacy_attrs[i].sa_byteswap;
959 tb[i].sa_registered = B_FALSE;
961 kmem_zalloc(strlen(sa_legacy_attrs[i].sa_name) +1,
963 (void) strlcpy(tb[i].sa_name,
964 sa_legacy_attrs[i].sa_name,
965 strlen(sa_legacy_attrs[i].sa_name) + 1);
969 for (i = 0; i != count; i++) {
970 sa_attr_type_t attr_id;
972 attr_id = sa->sa_user_table[i];
973 if (tb[attr_id].sa_name)
976 tb[attr_id].sa_length = reg_attrs[i].sa_length;
977 tb[attr_id].sa_byteswap = reg_attrs[i].sa_byteswap;
978 tb[attr_id].sa_attr = attr_id;
979 tb[attr_id].sa_name =
980 kmem_zalloc(strlen(reg_attrs[i].sa_name) + 1, KM_SLEEP);
981 (void) strlcpy(tb[attr_id].sa_name, reg_attrs[i].sa_name,
982 strlen(reg_attrs[i].sa_name) + 1);
985 sa->sa_need_attr_registration =
986 (sa_attr_count != registered_count);
990 kmem_free(sa->sa_user_table, count * sizeof (sa_attr_type_t));
991 sa->sa_user_table = NULL;
992 sa_free_attr_table(sa);
993 return ((error != 0) ? error : EINVAL);
997 sa_setup(objset_t *os, uint64_t sa_obj, sa_attr_reg_t *reg_attrs, int count,
998 sa_attr_type_t **user_table)
1003 dmu_objset_type_t ostype = dmu_objset_type(os);
1007 mutex_enter(&os->os_user_ptr_lock);
1009 mutex_enter(&os->os_sa->sa_lock);
1010 mutex_exit(&os->os_user_ptr_lock);
1011 tb = os->os_sa->sa_user_table;
1012 mutex_exit(&os->os_sa->sa_lock);
1017 sa = kmem_zalloc(sizeof (sa_os_t), KM_SLEEP);
1018 mutex_init(&sa->sa_lock, NULL, MUTEX_DEFAULT, NULL);
1019 sa->sa_master_obj = sa_obj;
1022 mutex_enter(&sa->sa_lock);
1023 mutex_exit(&os->os_user_ptr_lock);
1024 avl_create(&sa->sa_layout_num_tree, layout_num_compare,
1025 sizeof (sa_lot_t), offsetof(sa_lot_t, lot_num_node));
1026 avl_create(&sa->sa_layout_hash_tree, layout_hash_compare,
1027 sizeof (sa_lot_t), offsetof(sa_lot_t, lot_hash_node));
1030 error = zap_lookup(os, sa_obj, SA_LAYOUTS,
1031 8, 1, &sa->sa_layout_attr_obj);
1032 if (error != 0 && error != ENOENT)
1034 error = zap_lookup(os, sa_obj, SA_REGISTRY,
1035 8, 1, &sa->sa_reg_attr_obj);
1036 if (error != 0 && error != ENOENT)
1040 if ((error = sa_attr_table_setup(os, reg_attrs, count)) != 0)
1043 if (sa->sa_layout_attr_obj != 0) {
1044 uint64_t layout_count;
1046 error = zap_count(os, sa->sa_layout_attr_obj,
1050 * Layout number count should be > 0
1052 if (error || (error == 0 && layout_count == 0)) {
1054 error = SET_ERROR(EINVAL);
1058 for (zap_cursor_init(&zc, os, sa->sa_layout_attr_obj);
1059 (error = zap_cursor_retrieve(&zc, &za)) == 0;
1060 zap_cursor_advance(&zc)) {
1061 sa_attr_type_t *lot_attrs;
1064 lot_attrs = kmem_zalloc(sizeof (sa_attr_type_t) *
1065 za.za_num_integers, KM_SLEEP);
1067 if ((error = (zap_lookup(os, sa->sa_layout_attr_obj,
1068 za.za_name, 2, za.za_num_integers,
1069 lot_attrs))) != 0) {
1070 kmem_free(lot_attrs, sizeof (sa_attr_type_t) *
1071 za.za_num_integers);
1074 VERIFY(ddi_strtoull(za.za_name, NULL, 10,
1075 (unsigned long long *)&lot_num) == 0);
1077 (void) sa_add_layout_entry(os, lot_attrs,
1078 za.za_num_integers, lot_num,
1079 sa_layout_info_hash(lot_attrs,
1080 za.za_num_integers), B_FALSE, NULL);
1081 kmem_free(lot_attrs, sizeof (sa_attr_type_t) *
1082 za.za_num_integers);
1084 zap_cursor_fini(&zc);
1087 * Make sure layout count matches number of entries added
1090 if (avl_numnodes(&sa->sa_layout_num_tree) != layout_count) {
1096 /* Add special layout number for old ZNODES */
1097 if (ostype == DMU_OST_ZFS) {
1098 (void) sa_add_layout_entry(os, sa_legacy_zpl_layout,
1099 sa_legacy_attr_count, 0,
1100 sa_layout_info_hash(sa_legacy_zpl_layout,
1101 sa_legacy_attr_count), B_FALSE, NULL);
1103 (void) sa_add_layout_entry(os, sa_dummy_zpl_layout, 0, 1,
1106 *user_table = os->os_sa->sa_user_table;
1107 mutex_exit(&sa->sa_lock);
1111 sa_free_attr_table(sa);
1112 if (sa->sa_user_table)
1113 kmem_free(sa->sa_user_table, sa->sa_user_table_sz);
1114 mutex_exit(&sa->sa_lock);
1115 kmem_free(sa, sizeof (sa_os_t));
1116 return ((error == ECKSUM) ? EIO : error);
1120 sa_tear_down(objset_t *os)
1122 sa_os_t *sa = os->os_sa;
1126 kmem_free(sa->sa_user_table, sa->sa_user_table_sz);
1128 /* Free up attr table */
1130 sa_free_attr_table(sa);
1133 while (layout = avl_destroy_nodes(&sa->sa_layout_hash_tree, &cookie)) {
1135 while (tab = list_head(&layout->lot_idx_tab)) {
1136 ASSERT(refcount_count(&tab->sa_refcount));
1137 sa_idx_tab_rele(os, tab);
1142 while (layout = avl_destroy_nodes(&sa->sa_layout_num_tree, &cookie)) {
1143 kmem_free(layout->lot_attrs,
1144 sizeof (sa_attr_type_t) * layout->lot_attr_count);
1145 kmem_free(layout, sizeof (sa_lot_t));
1148 avl_destroy(&sa->sa_layout_hash_tree);
1149 avl_destroy(&sa->sa_layout_num_tree);
1151 kmem_free(sa, sizeof (sa_os_t));
1156 sa_build_idx_tab(void *hdr, void *attr_addr, sa_attr_type_t attr,
1157 uint16_t length, int length_idx, boolean_t var_length, void *userp)
1159 sa_idx_tab_t *idx_tab = userp;
1162 ASSERT(idx_tab->sa_variable_lengths);
1163 idx_tab->sa_variable_lengths[length_idx] = length;
1165 TOC_ATTR_ENCODE(idx_tab->sa_idx_tab[attr], length_idx,
1166 (uint32_t)((uintptr_t)attr_addr - (uintptr_t)hdr));
1170 sa_attr_iter(objset_t *os, sa_hdr_phys_t *hdr, dmu_object_type_t type,
1171 sa_iterfunc_t func, sa_lot_t *tab, void *userp)
1177 sa_os_t *sa = os->os_sa;
1179 uint16_t *length_start = NULL;
1180 uint8_t length_idx = 0;
1183 search.lot_num = SA_LAYOUT_NUM(hdr, type);
1184 tb = avl_find(&sa->sa_layout_num_tree, &search, &loc);
1188 if (IS_SA_BONUSTYPE(type)) {
1189 data_start = (void *)P2ROUNDUP(((uintptr_t)hdr +
1190 offsetof(sa_hdr_phys_t, sa_lengths) +
1191 (sizeof (uint16_t) * tb->lot_var_sizes)), 8);
1192 length_start = hdr->sa_lengths;
1197 for (i = 0; i != tb->lot_attr_count; i++) {
1198 int attr_length, reg_length;
1201 reg_length = sa->sa_attr_table[tb->lot_attrs[i]].sa_length;
1203 attr_length = reg_length;
1206 attr_length = length_start[length_idx];
1207 idx_len = length_idx++;
1210 func(hdr, data_start, tb->lot_attrs[i], attr_length,
1211 idx_len, reg_length == 0 ? B_TRUE : B_FALSE, userp);
1213 data_start = (void *)P2ROUNDUP(((uintptr_t)data_start +
1220 sa_byteswap_cb(void *hdr, void *attr_addr, sa_attr_type_t attr,
1221 uint16_t length, int length_idx, boolean_t variable_length, void *userp)
1223 sa_handle_t *hdl = userp;
1224 sa_os_t *sa = hdl->sa_os->os_sa;
1226 sa_bswap_table[sa->sa_attr_table[attr].sa_byteswap](attr_addr, length);
1230 sa_byteswap(sa_handle_t *hdl, sa_buf_type_t buftype)
1232 sa_hdr_phys_t *sa_hdr_phys = SA_GET_HDR(hdl, buftype);
1234 sa_os_t *sa = hdl->sa_os->os_sa;
1235 int num_lengths = 1;
1238 ASSERT(MUTEX_HELD(&sa->sa_lock));
1239 if (sa_hdr_phys->sa_magic == SA_MAGIC)
1242 db = SA_GET_DB(hdl, buftype);
1244 if (buftype == SA_SPILL) {
1245 arc_release(db->db_buf, NULL);
1246 arc_buf_thaw(db->db_buf);
1249 sa_hdr_phys->sa_magic = BSWAP_32(sa_hdr_phys->sa_magic);
1250 sa_hdr_phys->sa_layout_info = BSWAP_16(sa_hdr_phys->sa_layout_info);
1253 * Determine number of variable lenghts in header
1254 * The standard 8 byte header has one for free and a
1255 * 16 byte header would have 4 + 1;
1257 if (SA_HDR_SIZE(sa_hdr_phys) > 8)
1258 num_lengths += (SA_HDR_SIZE(sa_hdr_phys) - 8) >> 1;
1259 for (i = 0; i != num_lengths; i++)
1260 sa_hdr_phys->sa_lengths[i] =
1261 BSWAP_16(sa_hdr_phys->sa_lengths[i]);
1263 sa_attr_iter(hdl->sa_os, sa_hdr_phys, DMU_OT_SA,
1264 sa_byteswap_cb, NULL, hdl);
1266 if (buftype == SA_SPILL)
1267 arc_buf_freeze(((dmu_buf_impl_t *)hdl->sa_spill)->db_buf);
1271 sa_build_index(sa_handle_t *hdl, sa_buf_type_t buftype)
1273 sa_hdr_phys_t *sa_hdr_phys;
1274 dmu_buf_impl_t *db = SA_GET_DB(hdl, buftype);
1275 dmu_object_type_t bonustype = SA_BONUSTYPE_FROM_DB(db);
1276 sa_os_t *sa = hdl->sa_os->os_sa;
1277 sa_idx_tab_t *idx_tab;
1279 sa_hdr_phys = SA_GET_HDR(hdl, buftype);
1281 mutex_enter(&sa->sa_lock);
1283 /* Do we need to byteswap? */
1285 /* only check if not old znode */
1286 if (IS_SA_BONUSTYPE(bonustype) && sa_hdr_phys->sa_magic != SA_MAGIC &&
1287 sa_hdr_phys->sa_magic != 0) {
1288 VERIFY(BSWAP_32(sa_hdr_phys->sa_magic) == SA_MAGIC);
1289 sa_byteswap(hdl, buftype);
1292 idx_tab = sa_find_idx_tab(hdl->sa_os, bonustype, sa_hdr_phys);
1294 if (buftype == SA_BONUS)
1295 hdl->sa_bonus_tab = idx_tab;
1297 hdl->sa_spill_tab = idx_tab;
1299 mutex_exit(&sa->sa_lock);
1305 sa_evict(dmu_buf_t *db, void *sap)
1307 panic("evicting sa dbuf %p\n", (void *)db);
1311 sa_idx_tab_rele(objset_t *os, void *arg)
1313 sa_os_t *sa = os->os_sa;
1314 sa_idx_tab_t *idx_tab = arg;
1316 if (idx_tab == NULL)
1319 mutex_enter(&sa->sa_lock);
1320 if (refcount_remove(&idx_tab->sa_refcount, NULL) == 0) {
1321 list_remove(&idx_tab->sa_layout->lot_idx_tab, idx_tab);
1322 if (idx_tab->sa_variable_lengths)
1323 kmem_free(idx_tab->sa_variable_lengths,
1325 idx_tab->sa_layout->lot_var_sizes);
1326 refcount_destroy(&idx_tab->sa_refcount);
1327 kmem_free(idx_tab->sa_idx_tab,
1328 sizeof (uint32_t) * sa->sa_num_attrs);
1329 kmem_free(idx_tab, sizeof (sa_idx_tab_t));
1331 mutex_exit(&sa->sa_lock);
1335 sa_idx_tab_hold(objset_t *os, sa_idx_tab_t *idx_tab)
1337 sa_os_t *sa = os->os_sa;
1339 ASSERT(MUTEX_HELD(&sa->sa_lock));
1340 (void) refcount_add(&idx_tab->sa_refcount, NULL);
1344 sa_handle_destroy(sa_handle_t *hdl)
1346 mutex_enter(&hdl->sa_lock);
1347 (void) dmu_buf_update_user((dmu_buf_t *)hdl->sa_bonus, hdl,
1350 if (hdl->sa_bonus_tab) {
1351 sa_idx_tab_rele(hdl->sa_os, hdl->sa_bonus_tab);
1352 hdl->sa_bonus_tab = NULL;
1354 if (hdl->sa_spill_tab) {
1355 sa_idx_tab_rele(hdl->sa_os, hdl->sa_spill_tab);
1356 hdl->sa_spill_tab = NULL;
1359 dmu_buf_rele(hdl->sa_bonus, NULL);
1362 dmu_buf_rele((dmu_buf_t *)hdl->sa_spill, NULL);
1363 mutex_exit(&hdl->sa_lock);
1365 kmem_cache_free(sa_cache, hdl);
1369 sa_handle_get_from_db(objset_t *os, dmu_buf_t *db, void *userp,
1370 sa_handle_type_t hdl_type, sa_handle_t **handlepp)
1373 dmu_object_info_t doi;
1374 sa_handle_t *handle;
1377 dmu_object_info_from_db(db, &doi);
1378 ASSERT(doi.doi_bonus_type == DMU_OT_SA ||
1379 doi.doi_bonus_type == DMU_OT_ZNODE);
1381 /* find handle, if it exists */
1382 /* if one doesn't exist then create a new one, and initialize it */
1384 handle = (hdl_type == SA_HDL_SHARED) ? dmu_buf_get_user(db) : NULL;
1385 if (handle == NULL) {
1386 sa_handle_t *newhandle;
1387 handle = kmem_cache_alloc(sa_cache, KM_SLEEP);
1388 handle->sa_userp = userp;
1389 handle->sa_bonus = db;
1391 handle->sa_spill = NULL;
1393 error = sa_build_index(handle, SA_BONUS);
1394 newhandle = (hdl_type == SA_HDL_SHARED) ?
1395 dmu_buf_set_user_ie(db, handle,
1396 NULL, sa_evict) : NULL;
1398 if (newhandle != NULL) {
1399 kmem_cache_free(sa_cache, handle);
1409 sa_handle_get(objset_t *objset, uint64_t objid, void *userp,
1410 sa_handle_type_t hdl_type, sa_handle_t **handlepp)
1415 if (error = dmu_bonus_hold(objset, objid, NULL, &db))
1418 return (sa_handle_get_from_db(objset, db, userp, hdl_type,
1423 sa_buf_hold(objset_t *objset, uint64_t obj_num, void *tag, dmu_buf_t **db)
1425 return (dmu_bonus_hold(objset, obj_num, tag, db));
1429 sa_buf_rele(dmu_buf_t *db, void *tag)
1431 dmu_buf_rele(db, tag);
1435 sa_lookup_impl(sa_handle_t *hdl, sa_bulk_attr_t *bulk, int count)
1438 ASSERT(MUTEX_HELD(&hdl->sa_lock));
1439 return (sa_attr_op(hdl, bulk, count, SA_LOOKUP, NULL));
1443 sa_lookup(sa_handle_t *hdl, sa_attr_type_t attr, void *buf, uint32_t buflen)
1446 sa_bulk_attr_t bulk;
1448 bulk.sa_attr = attr;
1450 bulk.sa_length = buflen;
1451 bulk.sa_data_func = NULL;
1454 mutex_enter(&hdl->sa_lock);
1455 error = sa_lookup_impl(hdl, &bulk, 1);
1456 mutex_exit(&hdl->sa_lock);
1462 sa_lookup_uio(sa_handle_t *hdl, sa_attr_type_t attr, uio_t *uio)
1465 sa_bulk_attr_t bulk;
1467 bulk.sa_data = NULL;
1468 bulk.sa_attr = attr;
1469 bulk.sa_data_func = NULL;
1473 mutex_enter(&hdl->sa_lock);
1474 if ((error = sa_attr_op(hdl, &bulk, 1, SA_LOOKUP, NULL)) == 0) {
1475 error = uiomove((void *)bulk.sa_addr, MIN(bulk.sa_size,
1476 uio->uio_resid), UIO_READ, uio);
1478 mutex_exit(&hdl->sa_lock);
1485 sa_find_idx_tab(objset_t *os, dmu_object_type_t bonustype, void *data)
1487 sa_idx_tab_t *idx_tab;
1488 sa_hdr_phys_t *hdr = (sa_hdr_phys_t *)data;
1489 sa_os_t *sa = os->os_sa;
1490 sa_lot_t *tb, search;
1494 * Deterimine layout number. If SA node and header == 0 then
1495 * force the index table to the dummy "1" empty layout.
1497 * The layout number would only be zero for a newly created file
1498 * that has not added any attributes yet, or with crypto enabled which
1499 * doesn't write any attributes to the bonus buffer.
1502 search.lot_num = SA_LAYOUT_NUM(hdr, bonustype);
1504 tb = avl_find(&sa->sa_layout_num_tree, &search, &loc);
1506 /* Verify header size is consistent with layout information */
1508 ASSERT(IS_SA_BONUSTYPE(bonustype) &&
1509 SA_HDR_SIZE_MATCH_LAYOUT(hdr, tb) || !IS_SA_BONUSTYPE(bonustype) ||
1510 (IS_SA_BONUSTYPE(bonustype) && hdr->sa_layout_info == 0));
1513 * See if any of the already existing TOC entries can be reused?
1516 for (idx_tab = list_head(&tb->lot_idx_tab); idx_tab;
1517 idx_tab = list_next(&tb->lot_idx_tab, idx_tab)) {
1518 boolean_t valid_idx = B_TRUE;
1521 if (tb->lot_var_sizes != 0 &&
1522 idx_tab->sa_variable_lengths != NULL) {
1523 for (i = 0; i != tb->lot_var_sizes; i++) {
1524 if (hdr->sa_lengths[i] !=
1525 idx_tab->sa_variable_lengths[i]) {
1526 valid_idx = B_FALSE;
1532 sa_idx_tab_hold(os, idx_tab);
1537 /* No such luck, create a new entry */
1538 idx_tab = kmem_zalloc(sizeof (sa_idx_tab_t), KM_SLEEP);
1539 idx_tab->sa_idx_tab =
1540 kmem_zalloc(sizeof (uint32_t) * sa->sa_num_attrs, KM_SLEEP);
1541 idx_tab->sa_layout = tb;
1542 refcount_create(&idx_tab->sa_refcount);
1543 if (tb->lot_var_sizes)
1544 idx_tab->sa_variable_lengths = kmem_alloc(sizeof (uint16_t) *
1545 tb->lot_var_sizes, KM_SLEEP);
1547 sa_attr_iter(os, hdr, bonustype, sa_build_idx_tab,
1549 sa_idx_tab_hold(os, idx_tab); /* one hold for consumer */
1550 sa_idx_tab_hold(os, idx_tab); /* one for layout */
1551 list_insert_tail(&tb->lot_idx_tab, idx_tab);
1556 sa_default_locator(void **dataptr, uint32_t *len, uint32_t total_len,
1557 boolean_t start, void *userdata)
1561 *dataptr = userdata;
1566 sa_attr_register_sync(sa_handle_t *hdl, dmu_tx_t *tx)
1568 uint64_t attr_value = 0;
1569 sa_os_t *sa = hdl->sa_os->os_sa;
1570 sa_attr_table_t *tb = sa->sa_attr_table;
1573 mutex_enter(&sa->sa_lock);
1575 if (!sa->sa_need_attr_registration || sa->sa_master_obj == 0) {
1576 mutex_exit(&sa->sa_lock);
1580 if (sa->sa_reg_attr_obj == 0) {
1581 sa->sa_reg_attr_obj = zap_create_link(hdl->sa_os,
1582 DMU_OT_SA_ATTR_REGISTRATION,
1583 sa->sa_master_obj, SA_REGISTRY, tx);
1585 for (i = 0; i != sa->sa_num_attrs; i++) {
1586 if (sa->sa_attr_table[i].sa_registered)
1588 ATTR_ENCODE(attr_value, tb[i].sa_attr, tb[i].sa_length,
1590 VERIFY(0 == zap_update(hdl->sa_os, sa->sa_reg_attr_obj,
1591 tb[i].sa_name, 8, 1, &attr_value, tx));
1592 tb[i].sa_registered = B_TRUE;
1594 sa->sa_need_attr_registration = B_FALSE;
1595 mutex_exit(&sa->sa_lock);
1599 * Replace all attributes with attributes specified in template.
1600 * If dnode had a spill buffer then those attributes will be
1601 * also be replaced, possibly with just an empty spill block
1603 * This interface is intended to only be used for bulk adding of
1604 * attributes for a new file. It will also be used by the ZPL
1605 * when converting and old formatted znode to native SA support.
1608 sa_replace_all_by_template_locked(sa_handle_t *hdl, sa_bulk_attr_t *attr_desc,
1609 int attr_count, dmu_tx_t *tx)
1611 sa_os_t *sa = hdl->sa_os->os_sa;
1613 if (sa->sa_need_attr_registration)
1614 sa_attr_register_sync(hdl, tx);
1615 return (sa_build_layouts(hdl, attr_desc, attr_count, tx));
1619 sa_replace_all_by_template(sa_handle_t *hdl, sa_bulk_attr_t *attr_desc,
1620 int attr_count, dmu_tx_t *tx)
1624 mutex_enter(&hdl->sa_lock);
1625 error = sa_replace_all_by_template_locked(hdl, attr_desc,
1627 mutex_exit(&hdl->sa_lock);
1632 * Add/remove a single attribute or replace a variable-sized attribute value
1633 * with a value of a different size, and then rewrite the entire set
1635 * Same-length attribute value replacement (including fixed-length attributes)
1636 * is handled more efficiently by the upper layers.
1639 sa_modify_attrs(sa_handle_t *hdl, sa_attr_type_t newattr,
1640 sa_data_op_t action, sa_data_locator_t *locator, void *datastart,
1641 uint16_t buflen, dmu_tx_t *tx)
1643 sa_os_t *sa = hdl->sa_os->os_sa;
1644 dmu_buf_impl_t *db = (dmu_buf_impl_t *)hdl->sa_bonus;
1646 sa_bulk_attr_t *attr_desc;
1648 int bonus_attr_count = 0;
1649 int bonus_data_size = 0;
1650 int spill_data_size = 0;
1651 int spill_attr_count = 0;
1654 int i, j, k, length_idx;
1656 sa_idx_tab_t *idx_tab;
1660 ASSERT(MUTEX_HELD(&hdl->sa_lock));
1662 /* First make of copy of the old data */
1666 if (dn->dn_bonuslen != 0) {
1667 bonus_data_size = hdl->sa_bonus->db_size;
1668 old_data[0] = kmem_alloc(bonus_data_size, KM_SLEEP);
1669 bcopy(hdl->sa_bonus->db_data, old_data[0],
1670 hdl->sa_bonus->db_size);
1671 bonus_attr_count = hdl->sa_bonus_tab->sa_layout->lot_attr_count;
1677 /* Bring spill buffer online if it isn't currently */
1679 if ((error = sa_get_spill(hdl)) == 0) {
1680 spill_data_size = hdl->sa_spill->db_size;
1681 old_data[1] = kmem_alloc(spill_data_size, KM_SLEEP);
1682 bcopy(hdl->sa_spill->db_data, old_data[1],
1683 hdl->sa_spill->db_size);
1685 hdl->sa_spill_tab->sa_layout->lot_attr_count;
1686 } else if (error && error != ENOENT) {
1688 kmem_free(old_data[0], bonus_data_size);
1694 /* build descriptor of all attributes */
1696 attr_count = bonus_attr_count + spill_attr_count;
1697 if (action == SA_ADD)
1699 else if (action == SA_REMOVE)
1702 attr_desc = kmem_zalloc(sizeof (sa_bulk_attr_t) * attr_count, KM_SLEEP);
1705 * loop through bonus and spill buffer if it exists, and
1706 * build up new attr_descriptor to reset the attributes
1709 count = bonus_attr_count;
1710 hdr = SA_GET_HDR(hdl, SA_BONUS);
1711 idx_tab = SA_IDX_TAB_GET(hdl, SA_BONUS);
1712 for (; k != 2; k++) {
1713 /* iterate over each attribute in layout */
1714 for (i = 0, length_idx = 0; i != count; i++) {
1715 sa_attr_type_t attr;
1717 attr = idx_tab->sa_layout->lot_attrs[i];
1718 if (attr == newattr) {
1719 /* duplicate attributes are not allowed */
1720 ASSERT(action == SA_REPLACE ||
1721 action == SA_REMOVE);
1722 /* must be variable-sized to be replaced here */
1723 if (action == SA_REPLACE) {
1724 ASSERT(SA_REGISTERED_LEN(sa, attr) == 0);
1725 SA_ADD_BULK_ATTR(attr_desc, j, attr,
1726 locator, datastart, buflen);
1729 length = SA_REGISTERED_LEN(sa, attr);
1731 length = hdr->sa_lengths[length_idx];
1734 SA_ADD_BULK_ATTR(attr_desc, j, attr,
1736 (TOC_OFF(idx_tab->sa_idx_tab[attr]) +
1737 (uintptr_t)old_data[k]), length);
1739 if (SA_REGISTERED_LEN(sa, attr) == 0)
1742 if (k == 0 && hdl->sa_spill) {
1743 hdr = SA_GET_HDR(hdl, SA_SPILL);
1744 idx_tab = SA_IDX_TAB_GET(hdl, SA_SPILL);
1745 count = spill_attr_count;
1750 if (action == SA_ADD) {
1751 length = SA_REGISTERED_LEN(sa, newattr);
1755 SA_ADD_BULK_ATTR(attr_desc, j, newattr, locator,
1758 ASSERT3U(j, ==, attr_count);
1760 error = sa_build_layouts(hdl, attr_desc, attr_count, tx);
1763 kmem_free(old_data[0], bonus_data_size);
1765 kmem_free(old_data[1], spill_data_size);
1766 kmem_free(attr_desc, sizeof (sa_bulk_attr_t) * attr_count);
1772 sa_bulk_update_impl(sa_handle_t *hdl, sa_bulk_attr_t *bulk, int count,
1776 sa_os_t *sa = hdl->sa_os->os_sa;
1777 dmu_object_type_t bonustype;
1779 bonustype = SA_BONUSTYPE_FROM_DB(SA_GET_DB(hdl, SA_BONUS));
1782 ASSERT(MUTEX_HELD(&hdl->sa_lock));
1784 /* sync out registration table if necessary */
1785 if (sa->sa_need_attr_registration)
1786 sa_attr_register_sync(hdl, tx);
1788 error = sa_attr_op(hdl, bulk, count, SA_UPDATE, tx);
1789 if (error == 0 && !IS_SA_BONUSTYPE(bonustype) && sa->sa_update_cb)
1790 sa->sa_update_cb(hdl, tx);
1796 * update or add new attribute
1799 sa_update(sa_handle_t *hdl, sa_attr_type_t type,
1800 void *buf, uint32_t buflen, dmu_tx_t *tx)
1803 sa_bulk_attr_t bulk;
1805 bulk.sa_attr = type;
1806 bulk.sa_data_func = NULL;
1807 bulk.sa_length = buflen;
1810 mutex_enter(&hdl->sa_lock);
1811 error = sa_bulk_update_impl(hdl, &bulk, 1, tx);
1812 mutex_exit(&hdl->sa_lock);
1817 sa_update_from_cb(sa_handle_t *hdl, sa_attr_type_t attr,
1818 uint32_t buflen, sa_data_locator_t *locator, void *userdata, dmu_tx_t *tx)
1821 sa_bulk_attr_t bulk;
1823 bulk.sa_attr = attr;
1824 bulk.sa_data = userdata;
1825 bulk.sa_data_func = locator;
1826 bulk.sa_length = buflen;
1828 mutex_enter(&hdl->sa_lock);
1829 error = sa_bulk_update_impl(hdl, &bulk, 1, tx);
1830 mutex_exit(&hdl->sa_lock);
1835 * Return size of an attribute
1839 sa_size(sa_handle_t *hdl, sa_attr_type_t attr, int *size)
1841 sa_bulk_attr_t bulk;
1844 bulk.sa_data = NULL;
1845 bulk.sa_attr = attr;
1846 bulk.sa_data_func = NULL;
1849 mutex_enter(&hdl->sa_lock);
1850 if ((error = sa_attr_op(hdl, &bulk, 1, SA_LOOKUP, NULL)) != 0) {
1851 mutex_exit(&hdl->sa_lock);
1854 *size = bulk.sa_size;
1856 mutex_exit(&hdl->sa_lock);
1861 sa_bulk_lookup_locked(sa_handle_t *hdl, sa_bulk_attr_t *attrs, int count)
1864 ASSERT(MUTEX_HELD(&hdl->sa_lock));
1865 return (sa_lookup_impl(hdl, attrs, count));
1869 sa_bulk_lookup(sa_handle_t *hdl, sa_bulk_attr_t *attrs, int count)
1874 mutex_enter(&hdl->sa_lock);
1875 error = sa_bulk_lookup_locked(hdl, attrs, count);
1876 mutex_exit(&hdl->sa_lock);
1881 sa_bulk_update(sa_handle_t *hdl, sa_bulk_attr_t *attrs, int count, dmu_tx_t *tx)
1886 mutex_enter(&hdl->sa_lock);
1887 error = sa_bulk_update_impl(hdl, attrs, count, tx);
1888 mutex_exit(&hdl->sa_lock);
1893 sa_remove(sa_handle_t *hdl, sa_attr_type_t attr, dmu_tx_t *tx)
1897 mutex_enter(&hdl->sa_lock);
1898 error = sa_modify_attrs(hdl, attr, SA_REMOVE, NULL,
1900 mutex_exit(&hdl->sa_lock);
1905 sa_object_info(sa_handle_t *hdl, dmu_object_info_t *doi)
1907 dmu_object_info_from_db((dmu_buf_t *)hdl->sa_bonus, doi);
1911 sa_object_size(sa_handle_t *hdl, uint32_t *blksize, u_longlong_t *nblocks)
1913 dmu_object_size_from_db((dmu_buf_t *)hdl->sa_bonus,
1918 sa_update_user(sa_handle_t *newhdl, sa_handle_t *oldhdl)
1920 (void) dmu_buf_update_user((dmu_buf_t *)newhdl->sa_bonus,
1921 oldhdl, newhdl, NULL, sa_evict);
1922 oldhdl->sa_bonus = NULL;
1926 sa_set_userp(sa_handle_t *hdl, void *ptr)
1928 hdl->sa_userp = ptr;
1932 sa_get_db(sa_handle_t *hdl)
1934 return ((dmu_buf_t *)hdl->sa_bonus);
1938 sa_get_userdata(sa_handle_t *hdl)
1940 return (hdl->sa_userp);
1944 sa_register_update_callback_locked(objset_t *os, sa_update_cb_t *func)
1946 ASSERT(MUTEX_HELD(&os->os_sa->sa_lock));
1947 os->os_sa->sa_update_cb = func;
1951 sa_register_update_callback(objset_t *os, sa_update_cb_t *func)
1954 mutex_enter(&os->os_sa->sa_lock);
1955 sa_register_update_callback_locked(os, func);
1956 mutex_exit(&os->os_sa->sa_lock);
1960 sa_handle_object(sa_handle_t *hdl)
1962 return (hdl->sa_bonus->db_object);
1966 sa_enabled(objset_t *os)
1968 return (os->os_sa == NULL);
1972 sa_set_sa_object(objset_t *os, uint64_t sa_object)
1974 sa_os_t *sa = os->os_sa;
1976 if (sa->sa_master_obj)
1979 sa->sa_master_obj = sa_object;
1985 sa_hdrsize(void *arg)
1987 sa_hdr_phys_t *hdr = arg;
1989 return (SA_HDR_SIZE(hdr));
1993 sa_handle_lock(sa_handle_t *hdl)
1996 mutex_enter(&hdl->sa_lock);
2000 sa_handle_unlock(sa_handle_t *hdl)
2003 mutex_exit(&hdl->sa_lock);