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:
115 * Since the SA attributes are not entirely self describing we can't do
116 * the normal byteswap processing. The special ZAP layout attribute and
117 * attribute registration attributes define the byteswap function and the
118 * size of the attributes, unless it is variable sized.
119 * The normal ZFS byteswapping infrastructure assumes you don't need
120 * to read any objects in order to do the necessary byteswapping. Whereas
121 * SA attributes can only be properly byteswapped if the dataset is opened
122 * and the layout/attribute ZAP attributes are available. Because of this
123 * the SA attributes will be byteswapped when they are first accessed by
124 * the SA code that will read the SA data.
127 typedef void (sa_iterfunc_t)(void *hdr, void *addr, sa_attr_type_t,
128 uint16_t length, int length_idx, boolean_t, void *userp);
130 static int sa_build_index(sa_handle_t *hdl, sa_buf_type_t buftype);
131 static void sa_idx_tab_hold(objset_t *os, sa_idx_tab_t *idx_tab);
132 static void *sa_find_idx_tab(objset_t *os, dmu_object_type_t bonustype,
134 static void sa_idx_tab_rele(objset_t *os, void *arg);
135 static void sa_copy_data(sa_data_locator_t *func, void *start, void *target,
137 static int sa_modify_attrs(sa_handle_t *hdl, sa_attr_type_t newattr,
138 sa_data_op_t action, sa_data_locator_t *locator, void *datastart,
139 uint16_t buflen, dmu_tx_t *tx);
141 arc_byteswap_func_t *sa_bswap_table[] = {
142 byteswap_uint64_array,
143 byteswap_uint32_array,
144 byteswap_uint16_array,
145 byteswap_uint8_array,
149 #define SA_COPY_DATA(f, s, t, l) \
153 *(uint64_t *)t = *(uint64_t *)s; \
154 } else if (l == 16) { \
155 *(uint64_t *)t = *(uint64_t *)s; \
156 *(uint64_t *)((uintptr_t)t + 8) = \
157 *(uint64_t *)((uintptr_t)s + 8); \
162 sa_copy_data(f, s, t, l); \
166 * This table is fixed and cannot be changed. Its purpose is to
167 * allow the SA code to work with both old/new ZPL file systems.
168 * It contains the list of legacy attributes. These attributes aren't
169 * stored in the "attribute" registry zap objects, since older ZPL file systems
170 * won't have the registry. Only objsets of type ZFS_TYPE_FILESYSTEM will
171 * use this static table.
173 sa_attr_reg_t sa_legacy_attrs[] = {
174 {"ZPL_ATIME", sizeof (uint64_t) * 2, SA_UINT64_ARRAY, 0},
175 {"ZPL_MTIME", sizeof (uint64_t) * 2, SA_UINT64_ARRAY, 1},
176 {"ZPL_CTIME", sizeof (uint64_t) * 2, SA_UINT64_ARRAY, 2},
177 {"ZPL_CRTIME", sizeof (uint64_t) * 2, SA_UINT64_ARRAY, 3},
178 {"ZPL_GEN", sizeof (uint64_t), SA_UINT64_ARRAY, 4},
179 {"ZPL_MODE", sizeof (uint64_t), SA_UINT64_ARRAY, 5},
180 {"ZPL_SIZE", sizeof (uint64_t), SA_UINT64_ARRAY, 6},
181 {"ZPL_PARENT", sizeof (uint64_t), SA_UINT64_ARRAY, 7},
182 {"ZPL_LINKS", sizeof (uint64_t), SA_UINT64_ARRAY, 8},
183 {"ZPL_XATTR", sizeof (uint64_t), SA_UINT64_ARRAY, 9},
184 {"ZPL_RDEV", sizeof (uint64_t), SA_UINT64_ARRAY, 10},
185 {"ZPL_FLAGS", sizeof (uint64_t), SA_UINT64_ARRAY, 11},
186 {"ZPL_UID", sizeof (uint64_t), SA_UINT64_ARRAY, 12},
187 {"ZPL_GID", sizeof (uint64_t), SA_UINT64_ARRAY, 13},
188 {"ZPL_PAD", sizeof (uint64_t) * 4, SA_UINT64_ARRAY, 14},
189 {"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.
202 sa_attr_type_t sa_dummy_zpl_layout[] = { 0 };
204 static int sa_legacy_attr_count = 16;
205 static kmem_cache_t *sa_cache = NULL;
209 sa_cache_constructor(void *buf, void *unused, int kmflag)
211 sa_handle_t *hdl = buf;
213 hdl->sa_bonus_tab = NULL;
214 hdl->sa_spill_tab = NULL;
216 hdl->sa_userp = NULL;
217 hdl->sa_bonus = NULL;
218 hdl->sa_spill = NULL;
219 mutex_init(&hdl->sa_lock, NULL, MUTEX_DEFAULT, NULL);
225 sa_cache_destructor(void *buf, void *unused)
227 sa_handle_t *hdl = buf;
228 mutex_destroy(&hdl->sa_lock);
234 sa_cache = kmem_cache_create("sa_cache",
235 sizeof (sa_handle_t), 0, sa_cache_constructor,
236 sa_cache_destructor, NULL, NULL, NULL, 0);
243 kmem_cache_destroy(sa_cache);
247 layout_num_compare(const void *arg1, const void *arg2)
249 const sa_lot_t *node1 = arg1;
250 const sa_lot_t *node2 = arg2;
252 if (node1->lot_num > node2->lot_num)
254 else if (node1->lot_num < node2->lot_num)
260 layout_hash_compare(const void *arg1, const void *arg2)
262 const sa_lot_t *node1 = arg1;
263 const sa_lot_t *node2 = arg2;
265 if (node1->lot_hash > node2->lot_hash)
267 if (node1->lot_hash < node2->lot_hash)
269 if (node1->lot_instance > node2->lot_instance)
271 if (node1->lot_instance < node2->lot_instance)
277 sa_layout_equal(sa_lot_t *tbf, sa_attr_type_t *attrs, int count)
281 if (count != tbf->lot_attr_count)
284 for (i = 0; i != count; i++) {
285 if (attrs[i] != tbf->lot_attrs[i])
291 #define SA_ATTR_HASH(attr) (zfs_crc64_table[(-1ULL ^ attr) & 0xFF])
294 sa_layout_info_hash(sa_attr_type_t *attrs, int attr_count)
297 uint64_t crc = -1ULL;
299 for (i = 0; i != attr_count; i++)
300 crc ^= SA_ATTR_HASH(attrs[i]);
306 sa_get_spill(sa_handle_t *hdl)
309 if (hdl->sa_spill == NULL) {
310 if ((rc = dmu_spill_hold_existing(hdl->sa_bonus, NULL,
311 &hdl->sa_spill)) == 0)
312 VERIFY(0 == sa_build_index(hdl, SA_SPILL));
321 * Main attribute lookup/update function
322 * returns 0 for success or non zero for failures
324 * Operates on bulk array, first failure will abort further processing
327 sa_attr_op(sa_handle_t *hdl, sa_bulk_attr_t *bulk, int count,
328 sa_data_op_t data_op, dmu_tx_t *tx)
330 sa_os_t *sa = hdl->sa_os->os_sa;
333 sa_buf_type_t buftypes;
338 for (i = 0; i != count; i++) {
339 ASSERT(bulk[i].sa_attr <= hdl->sa_os->os_sa->sa_num_attrs);
341 bulk[i].sa_addr = NULL;
342 /* First check the bonus buffer */
344 if (hdl->sa_bonus_tab && TOC_ATTR_PRESENT(
345 hdl->sa_bonus_tab->sa_idx_tab[bulk[i].sa_attr])) {
346 SA_ATTR_INFO(sa, hdl->sa_bonus_tab,
347 SA_GET_HDR(hdl, SA_BONUS),
348 bulk[i].sa_attr, bulk[i], SA_BONUS, hdl);
349 if (tx && !(buftypes & SA_BONUS)) {
350 dmu_buf_will_dirty(hdl->sa_bonus, tx);
351 buftypes |= SA_BONUS;
354 if (bulk[i].sa_addr == NULL &&
355 ((error = sa_get_spill(hdl)) == 0)) {
356 if (TOC_ATTR_PRESENT(
357 hdl->sa_spill_tab->sa_idx_tab[bulk[i].sa_attr])) {
358 SA_ATTR_INFO(sa, hdl->sa_spill_tab,
359 SA_GET_HDR(hdl, SA_SPILL),
360 bulk[i].sa_attr, bulk[i], SA_SPILL, hdl);
361 if (tx && !(buftypes & SA_SPILL) &&
362 bulk[i].sa_size == bulk[i].sa_length) {
363 dmu_buf_will_dirty(hdl->sa_spill, tx);
364 buftypes |= SA_SPILL;
368 if (error && error != ENOENT) {
369 return ((error == ECKSUM) ? EIO : error);
374 if (bulk[i].sa_addr == NULL)
375 return (SET_ERROR(ENOENT));
376 if (bulk[i].sa_data) {
377 SA_COPY_DATA(bulk[i].sa_data_func,
378 bulk[i].sa_addr, bulk[i].sa_data,
384 /* existing rewrite of attr */
385 if (bulk[i].sa_addr &&
386 bulk[i].sa_size == bulk[i].sa_length) {
387 SA_COPY_DATA(bulk[i].sa_data_func,
388 bulk[i].sa_data, bulk[i].sa_addr,
391 } else if (bulk[i].sa_addr) { /* attr size change */
392 error = sa_modify_attrs(hdl, bulk[i].sa_attr,
393 SA_REPLACE, bulk[i].sa_data_func,
394 bulk[i].sa_data, bulk[i].sa_length, tx);
395 } else { /* adding new attribute */
396 error = sa_modify_attrs(hdl, bulk[i].sa_attr,
397 SA_ADD, bulk[i].sa_data_func,
398 bulk[i].sa_data, bulk[i].sa_length, tx);
409 sa_add_layout_entry(objset_t *os, sa_attr_type_t *attrs, int attr_count,
410 uint64_t lot_num, uint64_t hash, boolean_t zapadd, dmu_tx_t *tx)
412 sa_os_t *sa = os->os_sa;
413 sa_lot_t *tb, *findtb;
417 ASSERT(MUTEX_HELD(&sa->sa_lock));
418 tb = kmem_zalloc(sizeof (sa_lot_t), KM_SLEEP);
419 tb->lot_attr_count = attr_count;
420 tb->lot_attrs = kmem_alloc(sizeof (sa_attr_type_t) * attr_count,
422 bcopy(attrs, tb->lot_attrs, sizeof (sa_attr_type_t) * attr_count);
423 tb->lot_num = lot_num;
425 tb->lot_instance = 0;
430 if (sa->sa_layout_attr_obj == 0) {
431 sa->sa_layout_attr_obj = zap_create_link(os,
432 DMU_OT_SA_ATTR_LAYOUTS,
433 sa->sa_master_obj, SA_LAYOUTS, tx);
436 (void) snprintf(attr_name, sizeof (attr_name),
438 VERIFY(0 == zap_update(os, os->os_sa->sa_layout_attr_obj,
439 attr_name, 2, attr_count, attrs, tx));
442 list_create(&tb->lot_idx_tab, sizeof (sa_idx_tab_t),
443 offsetof(sa_idx_tab_t, sa_next));
445 for (i = 0; i != attr_count; i++) {
446 if (sa->sa_attr_table[tb->lot_attrs[i]].sa_length == 0)
450 avl_add(&sa->sa_layout_num_tree, tb);
452 /* verify we don't have a hash collision */
453 if ((findtb = avl_find(&sa->sa_layout_hash_tree, tb, &loc)) != NULL) {
454 for (; findtb && findtb->lot_hash == hash;
455 findtb = AVL_NEXT(&sa->sa_layout_hash_tree, findtb)) {
456 if (findtb->lot_instance != tb->lot_instance)
461 avl_add(&sa->sa_layout_hash_tree, tb);
466 sa_find_layout(objset_t *os, uint64_t hash, sa_attr_type_t *attrs,
467 int count, dmu_tx_t *tx, sa_lot_t **lot)
469 sa_lot_t *tb, tbsearch;
471 sa_os_t *sa = os->os_sa;
472 boolean_t found = B_FALSE;
474 mutex_enter(&sa->sa_lock);
475 tbsearch.lot_hash = hash;
476 tbsearch.lot_instance = 0;
477 tb = avl_find(&sa->sa_layout_hash_tree, &tbsearch, &loc);
479 for (; tb && tb->lot_hash == hash;
480 tb = AVL_NEXT(&sa->sa_layout_hash_tree, tb)) {
481 if (sa_layout_equal(tb, attrs, count) == 0) {
488 tb = sa_add_layout_entry(os, attrs, count,
489 avl_numnodes(&sa->sa_layout_num_tree), hash, B_TRUE, tx);
491 mutex_exit(&sa->sa_lock);
496 sa_resize_spill(sa_handle_t *hdl, uint32_t size, dmu_tx_t *tx)
502 blocksize = SPA_MINBLOCKSIZE;
503 } else if (size > SPA_MAXBLOCKSIZE) {
505 return (SET_ERROR(EFBIG));
507 blocksize = P2ROUNDUP_TYPED(size, SPA_MINBLOCKSIZE, uint32_t);
510 error = dbuf_spill_set_blksz(hdl->sa_spill, blocksize, tx);
516 sa_copy_data(sa_data_locator_t *func, void *datastart, void *target, int buflen)
519 bcopy(datastart, target, buflen);
524 void *saptr = target;
529 while (bytes < buflen) {
530 func(&dataptr, &length, buflen, start, datastart);
531 bcopy(dataptr, saptr, length);
532 saptr = (void *)((caddr_t)saptr + length);
540 * Determine several different sizes
541 * first the sa header size
542 * the number of bytes to be stored
543 * if spill would occur the index in the attribute array is returned
545 * the boolean will_spill will be set when spilling is necessary. It
546 * is only set when the buftype is SA_BONUS
549 sa_find_sizes(sa_os_t *sa, sa_bulk_attr_t *attr_desc, int attr_count,
550 dmu_buf_t *db, sa_buf_type_t buftype, int *index, int *total,
551 boolean_t *will_spill)
558 boolean_t done = B_FALSE;
560 if (buftype == SA_BONUS && sa->sa_force_spill) {
563 *will_spill = B_TRUE;
570 if (buftype == SA_BONUS)
571 *will_spill = B_FALSE;
573 hdrsize = (SA_BONUSTYPE_FROM_DB(db) == DMU_OT_ZNODE) ? 0 :
574 sizeof (sa_hdr_phys_t);
576 full_space = (buftype == SA_BONUS) ? DN_MAX_BONUSLEN : db->db_size;
577 ASSERT(IS_P2ALIGNED(full_space, 8));
579 for (i = 0; i != attr_count; i++) {
582 *total = P2ROUNDUP(*total, 8);
583 *total += attr_desc[i].sa_length;
587 is_var_sz = (SA_REGISTERED_LEN(sa, attr_desc[i].sa_attr) == 0);
592 if (is_var_sz && var_size > 1) {
593 if (P2ROUNDUP(hdrsize + sizeof (uint16_t), 8) +
594 *total < full_space) {
596 * Account for header space used by array of
597 * optional sizes of variable-length attributes.
598 * Record the index in case this increase needs
599 * to be reversed due to spill-over.
601 hdrsize += sizeof (uint16_t);
606 if (buftype == SA_BONUS)
607 *will_spill = B_TRUE;
613 * find index of where spill *could* occur.
614 * Then continue to count of remainder attribute
615 * space. The sum is used later for sizing bonus
618 if (buftype == SA_BONUS && *index == -1 &&
619 (*total + P2ROUNDUP(hdrsize, 8)) >
620 (full_space - sizeof (blkptr_t))) {
626 if ((*total + P2ROUNDUP(hdrsize, 8)) > full_space &&
628 *will_spill = B_TRUE;
632 * j holds the index of the last variable-sized attribute for
633 * which hdrsize was increased. Reverse the increase if that
634 * attribute will be relocated to the spill block.
636 if (*will_spill && j == *index)
637 hdrsize -= sizeof (uint16_t);
639 hdrsize = P2ROUNDUP(hdrsize, 8);
643 #define BUF_SPACE_NEEDED(total, header) (total + header)
646 * Find layout that corresponds to ordering of attributes
647 * If not found a new layout number is created and added to
648 * persistent layout tables.
651 sa_build_layouts(sa_handle_t *hdl, sa_bulk_attr_t *attr_desc, int attr_count,
654 sa_os_t *sa = hdl->sa_os->os_sa;
656 sa_buf_type_t buftype;
657 sa_hdr_phys_t *sahdr;
660 sa_attr_type_t *attrs, *attrs_start;
663 int spillhdrsize = 0;
665 dmu_object_type_t bonustype;
671 dmu_buf_will_dirty(hdl->sa_bonus, tx);
672 bonustype = SA_BONUSTYPE_FROM_DB(hdl->sa_bonus);
674 /* first determine bonus header size and sum of all attributes */
675 hdrsize = sa_find_sizes(sa, attr_desc, attr_count, hdl->sa_bonus,
676 SA_BONUS, &i, &used, &spilling);
678 if (used > SPA_MAXBLOCKSIZE)
679 return (SET_ERROR(EFBIG));
681 VERIFY(0 == dmu_set_bonus(hdl->sa_bonus, spilling ?
682 MIN(DN_MAX_BONUSLEN - sizeof (blkptr_t), used + hdrsize) :
683 used + hdrsize, tx));
685 ASSERT((bonustype == DMU_OT_ZNODE && spilling == 0) ||
686 bonustype == DMU_OT_SA);
688 /* setup and size spill buffer when needed */
692 if (hdl->sa_spill == NULL) {
693 VERIFY(dmu_spill_hold_by_bonus(hdl->sa_bonus, NULL,
694 &hdl->sa_spill) == 0);
696 dmu_buf_will_dirty(hdl->sa_spill, tx);
698 spillhdrsize = sa_find_sizes(sa, &attr_desc[i],
699 attr_count - i, hdl->sa_spill, SA_SPILL, &i,
700 &spill_used, &dummy);
702 if (spill_used > SPA_MAXBLOCKSIZE)
703 return (SET_ERROR(EFBIG));
705 buf_space = hdl->sa_spill->db_size - spillhdrsize;
706 if (BUF_SPACE_NEEDED(spill_used, spillhdrsize) >
707 hdl->sa_spill->db_size)
708 VERIFY(0 == sa_resize_spill(hdl,
709 BUF_SPACE_NEEDED(spill_used, spillhdrsize), tx));
712 /* setup starting pointers to lay down data */
713 data_start = (void *)((uintptr_t)hdl->sa_bonus->db_data + hdrsize);
714 sahdr = (sa_hdr_phys_t *)hdl->sa_bonus->db_data;
718 buf_space = (sa->sa_force_spill) ?
719 0 : SA_BLKPTR_SPACE - hdrsize;
721 buf_space = hdl->sa_bonus->db_size - hdrsize;
723 attrs_start = attrs = kmem_alloc(sizeof (sa_attr_type_t) * attr_count,
727 for (i = 0, len_idx = 0, hash = -1ULL; i != attr_count; i++) {
730 ASSERT(IS_P2ALIGNED(data_start, 8));
731 ASSERT(IS_P2ALIGNED(buf_space, 8));
732 attrs[i] = attr_desc[i].sa_attr;
733 length = SA_REGISTERED_LEN(sa, attrs[i]);
735 length = attr_desc[i].sa_length;
737 VERIFY(length == attr_desc[i].sa_length);
739 if (buf_space < length) { /* switch to spill buffer */
741 VERIFY(bonustype == DMU_OT_SA);
742 if (buftype == SA_BONUS && !sa->sa_force_spill) {
743 sa_find_layout(hdl->sa_os, hash, attrs_start,
744 lot_count, tx, &lot);
745 SA_SET_HDR(sahdr, lot->lot_num, hdrsize);
752 sahdr = (sa_hdr_phys_t *)hdl->sa_spill->db_data;
753 sahdr->sa_magic = SA_MAGIC;
754 data_start = (void *)((uintptr_t)sahdr +
756 attrs_start = &attrs[i];
757 buf_space = hdl->sa_spill->db_size - spillhdrsize;
760 hash ^= SA_ATTR_HASH(attrs[i]);
761 attr_desc[i].sa_addr = data_start;
762 attr_desc[i].sa_size = length;
763 SA_COPY_DATA(attr_desc[i].sa_data_func, attr_desc[i].sa_data,
765 if (sa->sa_attr_table[attrs[i]].sa_length == 0) {
766 sahdr->sa_lengths[len_idx++] = length;
768 VERIFY((uintptr_t)data_start % 8 == 0);
769 data_start = (void *)P2ROUNDUP(((uintptr_t)data_start +
771 buf_space -= P2ROUNDUP(length, 8);
775 sa_find_layout(hdl->sa_os, hash, attrs_start, lot_count, tx, &lot);
778 * Verify that old znodes always have layout number 0.
779 * Must be DMU_OT_SA for arbitrary layouts
781 VERIFY((bonustype == DMU_OT_ZNODE && lot->lot_num == 0) ||
782 (bonustype == DMU_OT_SA && lot->lot_num > 1));
784 if (bonustype == DMU_OT_SA) {
785 SA_SET_HDR(sahdr, lot->lot_num,
786 buftype == SA_BONUS ? hdrsize : spillhdrsize);
789 kmem_free(attrs, sizeof (sa_attr_type_t) * attr_count);
790 if (hdl->sa_bonus_tab) {
791 sa_idx_tab_rele(hdl->sa_os, hdl->sa_bonus_tab);
792 hdl->sa_bonus_tab = NULL;
794 if (!sa->sa_force_spill)
795 VERIFY(0 == sa_build_index(hdl, SA_BONUS));
797 sa_idx_tab_rele(hdl->sa_os, hdl->sa_spill_tab);
800 * remove spill block that is no longer needed.
802 dmu_buf_rele(hdl->sa_spill, NULL);
803 hdl->sa_spill = NULL;
804 hdl->sa_spill_tab = NULL;
805 VERIFY(0 == dmu_rm_spill(hdl->sa_os,
806 sa_handle_object(hdl), tx));
808 VERIFY(0 == sa_build_index(hdl, SA_SPILL));
816 sa_free_attr_table(sa_os_t *sa)
820 if (sa->sa_attr_table == NULL)
823 for (i = 0; i != sa->sa_num_attrs; i++) {
824 if (sa->sa_attr_table[i].sa_name)
825 kmem_free(sa->sa_attr_table[i].sa_name,
826 strlen(sa->sa_attr_table[i].sa_name) + 1);
829 kmem_free(sa->sa_attr_table,
830 sizeof (sa_attr_table_t) * sa->sa_num_attrs);
832 sa->sa_attr_table = NULL;
836 sa_attr_table_setup(objset_t *os, sa_attr_reg_t *reg_attrs, int count)
838 sa_os_t *sa = os->os_sa;
839 uint64_t sa_attr_count = 0;
840 uint64_t sa_reg_count = 0;
846 int registered_count = 0;
848 dmu_objset_type_t ostype = dmu_objset_type(os);
851 kmem_zalloc(count * sizeof (sa_attr_type_t), KM_SLEEP);
852 sa->sa_user_table_sz = count * sizeof (sa_attr_type_t);
854 if (sa->sa_reg_attr_obj != 0) {
855 error = zap_count(os, sa->sa_reg_attr_obj,
859 * Make sure we retrieved a count and that it isn't zero
861 if (error || (error == 0 && sa_attr_count == 0)) {
863 error = SET_ERROR(EINVAL);
866 sa_reg_count = sa_attr_count;
869 if (ostype == DMU_OST_ZFS && sa_attr_count == 0)
870 sa_attr_count += sa_legacy_attr_count;
872 /* Allocate attribute numbers for attributes that aren't registered */
873 for (i = 0; i != count; i++) {
874 boolean_t found = B_FALSE;
877 if (ostype == DMU_OST_ZFS) {
878 for (j = 0; j != sa_legacy_attr_count; j++) {
879 if (strcmp(reg_attrs[i].sa_name,
880 sa_legacy_attrs[j].sa_name) == 0) {
881 sa->sa_user_table[i] =
882 sa_legacy_attrs[j].sa_attr;
890 if (sa->sa_reg_attr_obj)
891 error = zap_lookup(os, sa->sa_reg_attr_obj,
892 reg_attrs[i].sa_name, 8, 1, &attr_value);
894 error = SET_ERROR(ENOENT);
897 sa->sa_user_table[i] = (sa_attr_type_t)sa_attr_count;
901 sa->sa_user_table[i] = ATTR_NUM(attr_value);
908 sa->sa_num_attrs = sa_attr_count;
909 tb = sa->sa_attr_table =
910 kmem_zalloc(sizeof (sa_attr_table_t) * sa_attr_count, KM_SLEEP);
913 * Attribute table is constructed from requested attribute list,
914 * previously foreign registered attributes, and also the legacy
915 * ZPL set of attributes.
918 if (sa->sa_reg_attr_obj) {
919 for (zap_cursor_init(&zc, os, sa->sa_reg_attr_obj);
920 (error = zap_cursor_retrieve(&zc, &za)) == 0;
921 zap_cursor_advance(&zc)) {
923 value = za.za_first_integer;
926 tb[ATTR_NUM(value)].sa_attr = ATTR_NUM(value);
927 tb[ATTR_NUM(value)].sa_length = ATTR_LENGTH(value);
928 tb[ATTR_NUM(value)].sa_byteswap = ATTR_BSWAP(value);
929 tb[ATTR_NUM(value)].sa_registered = B_TRUE;
931 if (tb[ATTR_NUM(value)].sa_name) {
934 tb[ATTR_NUM(value)].sa_name =
935 kmem_zalloc(strlen(za.za_name) +1, KM_SLEEP);
936 (void) strlcpy(tb[ATTR_NUM(value)].sa_name, za.za_name,
937 strlen(za.za_name) +1);
939 zap_cursor_fini(&zc);
941 * Make sure we processed the correct number of registered
944 if (registered_count != sa_reg_count) {
951 if (ostype == DMU_OST_ZFS) {
952 for (i = 0; i != sa_legacy_attr_count; i++) {
955 tb[i].sa_attr = sa_legacy_attrs[i].sa_attr;
956 tb[i].sa_length = sa_legacy_attrs[i].sa_length;
957 tb[i].sa_byteswap = sa_legacy_attrs[i].sa_byteswap;
958 tb[i].sa_registered = B_FALSE;
960 kmem_zalloc(strlen(sa_legacy_attrs[i].sa_name) +1,
962 (void) strlcpy(tb[i].sa_name,
963 sa_legacy_attrs[i].sa_name,
964 strlen(sa_legacy_attrs[i].sa_name) + 1);
968 for (i = 0; i != count; i++) {
969 sa_attr_type_t attr_id;
971 attr_id = sa->sa_user_table[i];
972 if (tb[attr_id].sa_name)
975 tb[attr_id].sa_length = reg_attrs[i].sa_length;
976 tb[attr_id].sa_byteswap = reg_attrs[i].sa_byteswap;
977 tb[attr_id].sa_attr = attr_id;
978 tb[attr_id].sa_name =
979 kmem_zalloc(strlen(reg_attrs[i].sa_name) + 1, KM_SLEEP);
980 (void) strlcpy(tb[attr_id].sa_name, reg_attrs[i].sa_name,
981 strlen(reg_attrs[i].sa_name) + 1);
984 sa->sa_need_attr_registration =
985 (sa_attr_count != registered_count);
989 kmem_free(sa->sa_user_table, count * sizeof (sa_attr_type_t));
990 sa->sa_user_table = NULL;
991 sa_free_attr_table(sa);
992 return ((error != 0) ? error : EINVAL);
996 sa_setup(objset_t *os, uint64_t sa_obj, sa_attr_reg_t *reg_attrs, int count,
997 sa_attr_type_t **user_table)
1002 dmu_objset_type_t ostype = dmu_objset_type(os);
1006 mutex_enter(&os->os_user_ptr_lock);
1008 mutex_enter(&os->os_sa->sa_lock);
1009 mutex_exit(&os->os_user_ptr_lock);
1010 tb = os->os_sa->sa_user_table;
1011 mutex_exit(&os->os_sa->sa_lock);
1016 sa = kmem_zalloc(sizeof (sa_os_t), KM_SLEEP);
1017 mutex_init(&sa->sa_lock, NULL, MUTEX_DEFAULT, NULL);
1018 sa->sa_master_obj = sa_obj;
1021 mutex_enter(&sa->sa_lock);
1022 mutex_exit(&os->os_user_ptr_lock);
1023 avl_create(&sa->sa_layout_num_tree, layout_num_compare,
1024 sizeof (sa_lot_t), offsetof(sa_lot_t, lot_num_node));
1025 avl_create(&sa->sa_layout_hash_tree, layout_hash_compare,
1026 sizeof (sa_lot_t), offsetof(sa_lot_t, lot_hash_node));
1029 error = zap_lookup(os, sa_obj, SA_LAYOUTS,
1030 8, 1, &sa->sa_layout_attr_obj);
1031 if (error != 0 && error != ENOENT)
1033 error = zap_lookup(os, sa_obj, SA_REGISTRY,
1034 8, 1, &sa->sa_reg_attr_obj);
1035 if (error != 0 && error != ENOENT)
1039 if ((error = sa_attr_table_setup(os, reg_attrs, count)) != 0)
1042 if (sa->sa_layout_attr_obj != 0) {
1043 uint64_t layout_count;
1045 error = zap_count(os, sa->sa_layout_attr_obj,
1049 * Layout number count should be > 0
1051 if (error || (error == 0 && layout_count == 0)) {
1053 error = SET_ERROR(EINVAL);
1057 for (zap_cursor_init(&zc, os, sa->sa_layout_attr_obj);
1058 (error = zap_cursor_retrieve(&zc, &za)) == 0;
1059 zap_cursor_advance(&zc)) {
1060 sa_attr_type_t *lot_attrs;
1063 lot_attrs = kmem_zalloc(sizeof (sa_attr_type_t) *
1064 za.za_num_integers, KM_SLEEP);
1066 if ((error = (zap_lookup(os, sa->sa_layout_attr_obj,
1067 za.za_name, 2, za.za_num_integers,
1068 lot_attrs))) != 0) {
1069 kmem_free(lot_attrs, sizeof (sa_attr_type_t) *
1070 za.za_num_integers);
1073 VERIFY(ddi_strtoull(za.za_name, NULL, 10,
1074 (unsigned long long *)&lot_num) == 0);
1076 (void) sa_add_layout_entry(os, lot_attrs,
1077 za.za_num_integers, lot_num,
1078 sa_layout_info_hash(lot_attrs,
1079 za.za_num_integers), B_FALSE, NULL);
1080 kmem_free(lot_attrs, sizeof (sa_attr_type_t) *
1081 za.za_num_integers);
1083 zap_cursor_fini(&zc);
1086 * Make sure layout count matches number of entries added
1089 if (avl_numnodes(&sa->sa_layout_num_tree) != layout_count) {
1095 /* Add special layout number for old ZNODES */
1096 if (ostype == DMU_OST_ZFS) {
1097 (void) sa_add_layout_entry(os, sa_legacy_zpl_layout,
1098 sa_legacy_attr_count, 0,
1099 sa_layout_info_hash(sa_legacy_zpl_layout,
1100 sa_legacy_attr_count), B_FALSE, NULL);
1102 (void) sa_add_layout_entry(os, sa_dummy_zpl_layout, 0, 1,
1105 *user_table = os->os_sa->sa_user_table;
1106 mutex_exit(&sa->sa_lock);
1110 sa_free_attr_table(sa);
1111 if (sa->sa_user_table)
1112 kmem_free(sa->sa_user_table, sa->sa_user_table_sz);
1113 mutex_exit(&sa->sa_lock);
1114 avl_destroy(&sa->sa_layout_hash_tree);
1115 avl_destroy(&sa->sa_layout_num_tree);
1116 mutex_destroy(&sa->sa_lock);
1117 kmem_free(sa, sizeof (sa_os_t));
1118 return ((error == ECKSUM) ? EIO : error);
1122 sa_tear_down(objset_t *os)
1124 sa_os_t *sa = os->os_sa;
1128 kmem_free(sa->sa_user_table, sa->sa_user_table_sz);
1130 /* Free up attr table */
1132 sa_free_attr_table(sa);
1135 while (layout = avl_destroy_nodes(&sa->sa_layout_hash_tree, &cookie)) {
1137 while (tab = list_head(&layout->lot_idx_tab)) {
1138 ASSERT(refcount_count(&tab->sa_refcount));
1139 sa_idx_tab_rele(os, tab);
1144 while (layout = avl_destroy_nodes(&sa->sa_layout_num_tree, &cookie)) {
1145 kmem_free(layout->lot_attrs,
1146 sizeof (sa_attr_type_t) * layout->lot_attr_count);
1147 kmem_free(layout, sizeof (sa_lot_t));
1150 avl_destroy(&sa->sa_layout_hash_tree);
1151 avl_destroy(&sa->sa_layout_num_tree);
1152 mutex_destroy(&sa->sa_lock);
1154 kmem_free(sa, sizeof (sa_os_t));
1159 sa_build_idx_tab(void *hdr, void *attr_addr, sa_attr_type_t attr,
1160 uint16_t length, int length_idx, boolean_t var_length, void *userp)
1162 sa_idx_tab_t *idx_tab = userp;
1165 ASSERT(idx_tab->sa_variable_lengths);
1166 idx_tab->sa_variable_lengths[length_idx] = length;
1168 TOC_ATTR_ENCODE(idx_tab->sa_idx_tab[attr], length_idx,
1169 (uint32_t)((uintptr_t)attr_addr - (uintptr_t)hdr));
1173 sa_attr_iter(objset_t *os, sa_hdr_phys_t *hdr, dmu_object_type_t type,
1174 sa_iterfunc_t func, sa_lot_t *tab, void *userp)
1180 sa_os_t *sa = os->os_sa;
1182 uint16_t *length_start = NULL;
1183 uint8_t length_idx = 0;
1186 search.lot_num = SA_LAYOUT_NUM(hdr, type);
1187 tb = avl_find(&sa->sa_layout_num_tree, &search, &loc);
1191 if (IS_SA_BONUSTYPE(type)) {
1192 data_start = (void *)P2ROUNDUP(((uintptr_t)hdr +
1193 offsetof(sa_hdr_phys_t, sa_lengths) +
1194 (sizeof (uint16_t) * tb->lot_var_sizes)), 8);
1195 length_start = hdr->sa_lengths;
1200 for (i = 0; i != tb->lot_attr_count; i++) {
1201 int attr_length, reg_length;
1204 reg_length = sa->sa_attr_table[tb->lot_attrs[i]].sa_length;
1206 attr_length = reg_length;
1209 attr_length = length_start[length_idx];
1210 idx_len = length_idx++;
1213 func(hdr, data_start, tb->lot_attrs[i], attr_length,
1214 idx_len, reg_length == 0 ? B_TRUE : B_FALSE, userp);
1216 data_start = (void *)P2ROUNDUP(((uintptr_t)data_start +
1223 sa_byteswap_cb(void *hdr, void *attr_addr, sa_attr_type_t attr,
1224 uint16_t length, int length_idx, boolean_t variable_length, void *userp)
1226 sa_handle_t *hdl = userp;
1227 sa_os_t *sa = hdl->sa_os->os_sa;
1229 sa_bswap_table[sa->sa_attr_table[attr].sa_byteswap](attr_addr, length);
1233 sa_byteswap(sa_handle_t *hdl, sa_buf_type_t buftype)
1235 sa_hdr_phys_t *sa_hdr_phys = SA_GET_HDR(hdl, buftype);
1237 sa_os_t *sa = hdl->sa_os->os_sa;
1238 int num_lengths = 1;
1241 ASSERT(MUTEX_HELD(&sa->sa_lock));
1242 if (sa_hdr_phys->sa_magic == SA_MAGIC)
1245 db = SA_GET_DB(hdl, buftype);
1247 if (buftype == SA_SPILL) {
1248 arc_release(db->db_buf, NULL);
1249 arc_buf_thaw(db->db_buf);
1252 sa_hdr_phys->sa_magic = BSWAP_32(sa_hdr_phys->sa_magic);
1253 sa_hdr_phys->sa_layout_info = BSWAP_16(sa_hdr_phys->sa_layout_info);
1256 * Determine number of variable lenghts in header
1257 * The standard 8 byte header has one for free and a
1258 * 16 byte header would have 4 + 1;
1260 if (SA_HDR_SIZE(sa_hdr_phys) > 8)
1261 num_lengths += (SA_HDR_SIZE(sa_hdr_phys) - 8) >> 1;
1262 for (i = 0; i != num_lengths; i++)
1263 sa_hdr_phys->sa_lengths[i] =
1264 BSWAP_16(sa_hdr_phys->sa_lengths[i]);
1266 sa_attr_iter(hdl->sa_os, sa_hdr_phys, DMU_OT_SA,
1267 sa_byteswap_cb, NULL, hdl);
1269 if (buftype == SA_SPILL)
1270 arc_buf_freeze(((dmu_buf_impl_t *)hdl->sa_spill)->db_buf);
1274 sa_build_index(sa_handle_t *hdl, sa_buf_type_t buftype)
1276 sa_hdr_phys_t *sa_hdr_phys;
1277 dmu_buf_impl_t *db = SA_GET_DB(hdl, buftype);
1278 dmu_object_type_t bonustype = SA_BONUSTYPE_FROM_DB(db);
1279 sa_os_t *sa = hdl->sa_os->os_sa;
1280 sa_idx_tab_t *idx_tab;
1282 sa_hdr_phys = SA_GET_HDR(hdl, buftype);
1284 mutex_enter(&sa->sa_lock);
1286 /* Do we need to byteswap? */
1288 /* only check if not old znode */
1289 if (IS_SA_BONUSTYPE(bonustype) && sa_hdr_phys->sa_magic != SA_MAGIC &&
1290 sa_hdr_phys->sa_magic != 0) {
1291 VERIFY(BSWAP_32(sa_hdr_phys->sa_magic) == SA_MAGIC);
1292 sa_byteswap(hdl, buftype);
1295 idx_tab = sa_find_idx_tab(hdl->sa_os, bonustype, sa_hdr_phys);
1297 if (buftype == SA_BONUS)
1298 hdl->sa_bonus_tab = idx_tab;
1300 hdl->sa_spill_tab = idx_tab;
1302 mutex_exit(&sa->sa_lock);
1308 sa_evict(dmu_buf_t *db, void *sap)
1310 panic("evicting sa dbuf %p\n", (void *)db);
1314 sa_idx_tab_rele(objset_t *os, void *arg)
1316 sa_os_t *sa = os->os_sa;
1317 sa_idx_tab_t *idx_tab = arg;
1319 if (idx_tab == NULL)
1322 mutex_enter(&sa->sa_lock);
1323 if (refcount_remove(&idx_tab->sa_refcount, NULL) == 0) {
1324 list_remove(&idx_tab->sa_layout->lot_idx_tab, idx_tab);
1325 if (idx_tab->sa_variable_lengths)
1326 kmem_free(idx_tab->sa_variable_lengths,
1328 idx_tab->sa_layout->lot_var_sizes);
1329 refcount_destroy(&idx_tab->sa_refcount);
1330 kmem_free(idx_tab->sa_idx_tab,
1331 sizeof (uint32_t) * sa->sa_num_attrs);
1332 kmem_free(idx_tab, sizeof (sa_idx_tab_t));
1334 mutex_exit(&sa->sa_lock);
1338 sa_idx_tab_hold(objset_t *os, sa_idx_tab_t *idx_tab)
1340 sa_os_t *sa = os->os_sa;
1342 ASSERT(MUTEX_HELD(&sa->sa_lock));
1343 (void) refcount_add(&idx_tab->sa_refcount, NULL);
1347 sa_handle_destroy(sa_handle_t *hdl)
1349 mutex_enter(&hdl->sa_lock);
1350 (void) dmu_buf_update_user((dmu_buf_t *)hdl->sa_bonus, hdl,
1353 if (hdl->sa_bonus_tab) {
1354 sa_idx_tab_rele(hdl->sa_os, hdl->sa_bonus_tab);
1355 hdl->sa_bonus_tab = NULL;
1357 if (hdl->sa_spill_tab) {
1358 sa_idx_tab_rele(hdl->sa_os, hdl->sa_spill_tab);
1359 hdl->sa_spill_tab = NULL;
1362 dmu_buf_rele(hdl->sa_bonus, NULL);
1365 dmu_buf_rele((dmu_buf_t *)hdl->sa_spill, NULL);
1366 mutex_exit(&hdl->sa_lock);
1368 kmem_cache_free(sa_cache, hdl);
1372 sa_handle_get_from_db(objset_t *os, dmu_buf_t *db, void *userp,
1373 sa_handle_type_t hdl_type, sa_handle_t **handlepp)
1376 dmu_object_info_t doi;
1377 sa_handle_t *handle;
1380 dmu_object_info_from_db(db, &doi);
1381 ASSERT(doi.doi_bonus_type == DMU_OT_SA ||
1382 doi.doi_bonus_type == DMU_OT_ZNODE);
1384 /* find handle, if it exists */
1385 /* if one doesn't exist then create a new one, and initialize it */
1387 handle = (hdl_type == SA_HDL_SHARED) ? dmu_buf_get_user(db) : NULL;
1388 if (handle == NULL) {
1389 sa_handle_t *newhandle;
1390 handle = kmem_cache_alloc(sa_cache, KM_SLEEP);
1391 handle->sa_userp = userp;
1392 handle->sa_bonus = db;
1394 handle->sa_spill = NULL;
1396 error = sa_build_index(handle, SA_BONUS);
1397 newhandle = (hdl_type == SA_HDL_SHARED) ?
1398 dmu_buf_set_user_ie(db, handle,
1399 NULL, sa_evict) : NULL;
1401 if (newhandle != NULL) {
1402 kmem_cache_free(sa_cache, handle);
1412 sa_handle_get(objset_t *objset, uint64_t objid, void *userp,
1413 sa_handle_type_t hdl_type, sa_handle_t **handlepp)
1418 if (error = dmu_bonus_hold(objset, objid, NULL, &db))
1421 return (sa_handle_get_from_db(objset, db, userp, hdl_type,
1426 sa_buf_hold(objset_t *objset, uint64_t obj_num, void *tag, dmu_buf_t **db)
1428 return (dmu_bonus_hold(objset, obj_num, tag, db));
1432 sa_buf_rele(dmu_buf_t *db, void *tag)
1434 dmu_buf_rele(db, tag);
1438 sa_lookup_impl(sa_handle_t *hdl, sa_bulk_attr_t *bulk, int count)
1441 ASSERT(MUTEX_HELD(&hdl->sa_lock));
1442 return (sa_attr_op(hdl, bulk, count, SA_LOOKUP, NULL));
1446 sa_lookup(sa_handle_t *hdl, sa_attr_type_t attr, void *buf, uint32_t buflen)
1449 sa_bulk_attr_t bulk;
1451 bulk.sa_attr = attr;
1453 bulk.sa_length = buflen;
1454 bulk.sa_data_func = NULL;
1457 mutex_enter(&hdl->sa_lock);
1458 error = sa_lookup_impl(hdl, &bulk, 1);
1459 mutex_exit(&hdl->sa_lock);
1465 sa_lookup_uio(sa_handle_t *hdl, sa_attr_type_t attr, uio_t *uio)
1468 sa_bulk_attr_t bulk;
1470 bulk.sa_data = NULL;
1471 bulk.sa_attr = attr;
1472 bulk.sa_data_func = NULL;
1476 mutex_enter(&hdl->sa_lock);
1477 if ((error = sa_attr_op(hdl, &bulk, 1, SA_LOOKUP, NULL)) == 0) {
1478 error = uiomove((void *)bulk.sa_addr, MIN(bulk.sa_size,
1479 uio->uio_resid), UIO_READ, uio);
1481 mutex_exit(&hdl->sa_lock);
1488 sa_find_idx_tab(objset_t *os, dmu_object_type_t bonustype, void *data)
1490 sa_idx_tab_t *idx_tab;
1491 sa_hdr_phys_t *hdr = (sa_hdr_phys_t *)data;
1492 sa_os_t *sa = os->os_sa;
1493 sa_lot_t *tb, search;
1497 * Deterimine layout number. If SA node and header == 0 then
1498 * force the index table to the dummy "1" empty layout.
1500 * The layout number would only be zero for a newly created file
1501 * that has not added any attributes yet, or with crypto enabled which
1502 * doesn't write any attributes to the bonus buffer.
1505 search.lot_num = SA_LAYOUT_NUM(hdr, bonustype);
1507 tb = avl_find(&sa->sa_layout_num_tree, &search, &loc);
1509 /* Verify header size is consistent with layout information */
1511 ASSERT(IS_SA_BONUSTYPE(bonustype) &&
1512 SA_HDR_SIZE_MATCH_LAYOUT(hdr, tb) || !IS_SA_BONUSTYPE(bonustype) ||
1513 (IS_SA_BONUSTYPE(bonustype) && hdr->sa_layout_info == 0));
1516 * See if any of the already existing TOC entries can be reused?
1519 for (idx_tab = list_head(&tb->lot_idx_tab); idx_tab;
1520 idx_tab = list_next(&tb->lot_idx_tab, idx_tab)) {
1521 boolean_t valid_idx = B_TRUE;
1524 if (tb->lot_var_sizes != 0 &&
1525 idx_tab->sa_variable_lengths != NULL) {
1526 for (i = 0; i != tb->lot_var_sizes; i++) {
1527 if (hdr->sa_lengths[i] !=
1528 idx_tab->sa_variable_lengths[i]) {
1529 valid_idx = B_FALSE;
1535 sa_idx_tab_hold(os, idx_tab);
1540 /* No such luck, create a new entry */
1541 idx_tab = kmem_zalloc(sizeof (sa_idx_tab_t), KM_SLEEP);
1542 idx_tab->sa_idx_tab =
1543 kmem_zalloc(sizeof (uint32_t) * sa->sa_num_attrs, KM_SLEEP);
1544 idx_tab->sa_layout = tb;
1545 refcount_create(&idx_tab->sa_refcount);
1546 if (tb->lot_var_sizes)
1547 idx_tab->sa_variable_lengths = kmem_alloc(sizeof (uint16_t) *
1548 tb->lot_var_sizes, KM_SLEEP);
1550 sa_attr_iter(os, hdr, bonustype, sa_build_idx_tab,
1552 sa_idx_tab_hold(os, idx_tab); /* one hold for consumer */
1553 sa_idx_tab_hold(os, idx_tab); /* one for layout */
1554 list_insert_tail(&tb->lot_idx_tab, idx_tab);
1559 sa_default_locator(void **dataptr, uint32_t *len, uint32_t total_len,
1560 boolean_t start, void *userdata)
1564 *dataptr = userdata;
1569 sa_attr_register_sync(sa_handle_t *hdl, dmu_tx_t *tx)
1571 uint64_t attr_value = 0;
1572 sa_os_t *sa = hdl->sa_os->os_sa;
1573 sa_attr_table_t *tb = sa->sa_attr_table;
1576 mutex_enter(&sa->sa_lock);
1578 if (!sa->sa_need_attr_registration || sa->sa_master_obj == 0) {
1579 mutex_exit(&sa->sa_lock);
1583 if (sa->sa_reg_attr_obj == 0) {
1584 sa->sa_reg_attr_obj = zap_create_link(hdl->sa_os,
1585 DMU_OT_SA_ATTR_REGISTRATION,
1586 sa->sa_master_obj, SA_REGISTRY, tx);
1588 for (i = 0; i != sa->sa_num_attrs; i++) {
1589 if (sa->sa_attr_table[i].sa_registered)
1591 ATTR_ENCODE(attr_value, tb[i].sa_attr, tb[i].sa_length,
1593 VERIFY(0 == zap_update(hdl->sa_os, sa->sa_reg_attr_obj,
1594 tb[i].sa_name, 8, 1, &attr_value, tx));
1595 tb[i].sa_registered = B_TRUE;
1597 sa->sa_need_attr_registration = B_FALSE;
1598 mutex_exit(&sa->sa_lock);
1602 * Replace all attributes with attributes specified in template.
1603 * If dnode had a spill buffer then those attributes will be
1604 * also be replaced, possibly with just an empty spill block
1606 * This interface is intended to only be used for bulk adding of
1607 * attributes for a new file. It will also be used by the ZPL
1608 * when converting and old formatted znode to native SA support.
1611 sa_replace_all_by_template_locked(sa_handle_t *hdl, sa_bulk_attr_t *attr_desc,
1612 int attr_count, dmu_tx_t *tx)
1614 sa_os_t *sa = hdl->sa_os->os_sa;
1616 if (sa->sa_need_attr_registration)
1617 sa_attr_register_sync(hdl, tx);
1618 return (sa_build_layouts(hdl, attr_desc, attr_count, tx));
1622 sa_replace_all_by_template(sa_handle_t *hdl, sa_bulk_attr_t *attr_desc,
1623 int attr_count, dmu_tx_t *tx)
1627 mutex_enter(&hdl->sa_lock);
1628 error = sa_replace_all_by_template_locked(hdl, attr_desc,
1630 mutex_exit(&hdl->sa_lock);
1635 * Add/remove a single attribute or replace a variable-sized attribute value
1636 * with a value of a different size, and then rewrite the entire set
1638 * Same-length attribute value replacement (including fixed-length attributes)
1639 * is handled more efficiently by the upper layers.
1642 sa_modify_attrs(sa_handle_t *hdl, sa_attr_type_t newattr,
1643 sa_data_op_t action, sa_data_locator_t *locator, void *datastart,
1644 uint16_t buflen, dmu_tx_t *tx)
1646 sa_os_t *sa = hdl->sa_os->os_sa;
1647 dmu_buf_impl_t *db = (dmu_buf_impl_t *)hdl->sa_bonus;
1649 sa_bulk_attr_t *attr_desc;
1651 int bonus_attr_count = 0;
1652 int bonus_data_size = 0;
1653 int spill_data_size = 0;
1654 int spill_attr_count = 0;
1657 int i, j, k, length_idx;
1659 sa_idx_tab_t *idx_tab;
1663 ASSERT(MUTEX_HELD(&hdl->sa_lock));
1665 /* First make of copy of the old data */
1669 if (dn->dn_bonuslen != 0) {
1670 bonus_data_size = hdl->sa_bonus->db_size;
1671 old_data[0] = kmem_alloc(bonus_data_size, KM_SLEEP);
1672 bcopy(hdl->sa_bonus->db_data, old_data[0],
1673 hdl->sa_bonus->db_size);
1674 bonus_attr_count = hdl->sa_bonus_tab->sa_layout->lot_attr_count;
1680 /* Bring spill buffer online if it isn't currently */
1682 if ((error = sa_get_spill(hdl)) == 0) {
1683 spill_data_size = hdl->sa_spill->db_size;
1684 old_data[1] = kmem_alloc(spill_data_size, KM_SLEEP);
1685 bcopy(hdl->sa_spill->db_data, old_data[1],
1686 hdl->sa_spill->db_size);
1688 hdl->sa_spill_tab->sa_layout->lot_attr_count;
1689 } else if (error && error != ENOENT) {
1691 kmem_free(old_data[0], bonus_data_size);
1697 /* build descriptor of all attributes */
1699 attr_count = bonus_attr_count + spill_attr_count;
1700 if (action == SA_ADD)
1702 else if (action == SA_REMOVE)
1705 attr_desc = kmem_zalloc(sizeof (sa_bulk_attr_t) * attr_count, KM_SLEEP);
1708 * loop through bonus and spill buffer if it exists, and
1709 * build up new attr_descriptor to reset the attributes
1712 count = bonus_attr_count;
1713 hdr = SA_GET_HDR(hdl, SA_BONUS);
1714 idx_tab = SA_IDX_TAB_GET(hdl, SA_BONUS);
1715 for (; k != 2; k++) {
1716 /* iterate over each attribute in layout */
1717 for (i = 0, length_idx = 0; i != count; i++) {
1718 sa_attr_type_t attr;
1720 attr = idx_tab->sa_layout->lot_attrs[i];
1721 if (attr == newattr) {
1722 /* duplicate attributes are not allowed */
1723 ASSERT(action == SA_REPLACE ||
1724 action == SA_REMOVE);
1725 /* must be variable-sized to be replaced here */
1726 if (action == SA_REPLACE) {
1727 ASSERT(SA_REGISTERED_LEN(sa, attr) == 0);
1728 SA_ADD_BULK_ATTR(attr_desc, j, attr,
1729 locator, datastart, buflen);
1732 length = SA_REGISTERED_LEN(sa, attr);
1734 length = hdr->sa_lengths[length_idx];
1737 SA_ADD_BULK_ATTR(attr_desc, j, attr,
1739 (TOC_OFF(idx_tab->sa_idx_tab[attr]) +
1740 (uintptr_t)old_data[k]), length);
1742 if (SA_REGISTERED_LEN(sa, attr) == 0)
1745 if (k == 0 && hdl->sa_spill) {
1746 hdr = SA_GET_HDR(hdl, SA_SPILL);
1747 idx_tab = SA_IDX_TAB_GET(hdl, SA_SPILL);
1748 count = spill_attr_count;
1753 if (action == SA_ADD) {
1754 length = SA_REGISTERED_LEN(sa, newattr);
1758 SA_ADD_BULK_ATTR(attr_desc, j, newattr, locator,
1761 ASSERT3U(j, ==, attr_count);
1763 error = sa_build_layouts(hdl, attr_desc, attr_count, tx);
1766 kmem_free(old_data[0], bonus_data_size);
1768 kmem_free(old_data[1], spill_data_size);
1769 kmem_free(attr_desc, sizeof (sa_bulk_attr_t) * attr_count);
1775 sa_bulk_update_impl(sa_handle_t *hdl, sa_bulk_attr_t *bulk, int count,
1779 sa_os_t *sa = hdl->sa_os->os_sa;
1780 dmu_object_type_t bonustype;
1782 bonustype = SA_BONUSTYPE_FROM_DB(SA_GET_DB(hdl, SA_BONUS));
1785 ASSERT(MUTEX_HELD(&hdl->sa_lock));
1787 /* sync out registration table if necessary */
1788 if (sa->sa_need_attr_registration)
1789 sa_attr_register_sync(hdl, tx);
1791 error = sa_attr_op(hdl, bulk, count, SA_UPDATE, tx);
1792 if (error == 0 && !IS_SA_BONUSTYPE(bonustype) && sa->sa_update_cb)
1793 sa->sa_update_cb(hdl, tx);
1799 * update or add new attribute
1802 sa_update(sa_handle_t *hdl, sa_attr_type_t type,
1803 void *buf, uint32_t buflen, dmu_tx_t *tx)
1806 sa_bulk_attr_t bulk;
1808 bulk.sa_attr = type;
1809 bulk.sa_data_func = NULL;
1810 bulk.sa_length = buflen;
1813 mutex_enter(&hdl->sa_lock);
1814 error = sa_bulk_update_impl(hdl, &bulk, 1, tx);
1815 mutex_exit(&hdl->sa_lock);
1820 sa_update_from_cb(sa_handle_t *hdl, sa_attr_type_t attr,
1821 uint32_t buflen, sa_data_locator_t *locator, void *userdata, dmu_tx_t *tx)
1824 sa_bulk_attr_t bulk;
1826 bulk.sa_attr = attr;
1827 bulk.sa_data = userdata;
1828 bulk.sa_data_func = locator;
1829 bulk.sa_length = buflen;
1831 mutex_enter(&hdl->sa_lock);
1832 error = sa_bulk_update_impl(hdl, &bulk, 1, tx);
1833 mutex_exit(&hdl->sa_lock);
1838 * Return size of an attribute
1842 sa_size(sa_handle_t *hdl, sa_attr_type_t attr, int *size)
1844 sa_bulk_attr_t bulk;
1847 bulk.sa_data = NULL;
1848 bulk.sa_attr = attr;
1849 bulk.sa_data_func = NULL;
1852 mutex_enter(&hdl->sa_lock);
1853 if ((error = sa_attr_op(hdl, &bulk, 1, SA_LOOKUP, NULL)) != 0) {
1854 mutex_exit(&hdl->sa_lock);
1857 *size = bulk.sa_size;
1859 mutex_exit(&hdl->sa_lock);
1864 sa_bulk_lookup_locked(sa_handle_t *hdl, sa_bulk_attr_t *attrs, int count)
1867 ASSERT(MUTEX_HELD(&hdl->sa_lock));
1868 return (sa_lookup_impl(hdl, attrs, count));
1872 sa_bulk_lookup(sa_handle_t *hdl, sa_bulk_attr_t *attrs, int count)
1877 mutex_enter(&hdl->sa_lock);
1878 error = sa_bulk_lookup_locked(hdl, attrs, count);
1879 mutex_exit(&hdl->sa_lock);
1884 sa_bulk_update(sa_handle_t *hdl, sa_bulk_attr_t *attrs, int count, dmu_tx_t *tx)
1889 mutex_enter(&hdl->sa_lock);
1890 error = sa_bulk_update_impl(hdl, attrs, count, tx);
1891 mutex_exit(&hdl->sa_lock);
1896 sa_remove(sa_handle_t *hdl, sa_attr_type_t attr, dmu_tx_t *tx)
1900 mutex_enter(&hdl->sa_lock);
1901 error = sa_modify_attrs(hdl, attr, SA_REMOVE, NULL,
1903 mutex_exit(&hdl->sa_lock);
1908 sa_object_info(sa_handle_t *hdl, dmu_object_info_t *doi)
1910 dmu_object_info_from_db((dmu_buf_t *)hdl->sa_bonus, doi);
1914 sa_object_size(sa_handle_t *hdl, uint32_t *blksize, u_longlong_t *nblocks)
1916 dmu_object_size_from_db((dmu_buf_t *)hdl->sa_bonus,
1921 sa_update_user(sa_handle_t *newhdl, sa_handle_t *oldhdl)
1923 (void) dmu_buf_update_user((dmu_buf_t *)newhdl->sa_bonus,
1924 oldhdl, newhdl, NULL, sa_evict);
1925 oldhdl->sa_bonus = NULL;
1929 sa_set_userp(sa_handle_t *hdl, void *ptr)
1931 hdl->sa_userp = ptr;
1935 sa_get_db(sa_handle_t *hdl)
1937 return ((dmu_buf_t *)hdl->sa_bonus);
1941 sa_get_userdata(sa_handle_t *hdl)
1943 return (hdl->sa_userp);
1947 sa_register_update_callback_locked(objset_t *os, sa_update_cb_t *func)
1949 ASSERT(MUTEX_HELD(&os->os_sa->sa_lock));
1950 os->os_sa->sa_update_cb = func;
1954 sa_register_update_callback(objset_t *os, sa_update_cb_t *func)
1957 mutex_enter(&os->os_sa->sa_lock);
1958 sa_register_update_callback_locked(os, func);
1959 mutex_exit(&os->os_sa->sa_lock);
1963 sa_handle_object(sa_handle_t *hdl)
1965 return (hdl->sa_bonus->db_object);
1969 sa_enabled(objset_t *os)
1971 return (os->os_sa == NULL);
1975 sa_set_sa_object(objset_t *os, uint64_t sa_object)
1977 sa_os_t *sa = os->os_sa;
1979 if (sa->sa_master_obj)
1982 sa->sa_master_obj = sa_object;
1988 sa_hdrsize(void *arg)
1990 sa_hdr_phys_t *hdr = arg;
1992 return (SA_HDR_SIZE(hdr));
1996 sa_handle_lock(sa_handle_t *hdl)
1999 mutex_enter(&hdl->sa_lock);
2003 sa_handle_unlock(sa_handle_t *hdl)
2006 mutex_exit(&hdl->sa_lock);