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.
26 * Copyright (c) 2014 Spectra Logic Corporation, All rights reserved.
29 #include <sys/zfs_context.h>
30 #include <sys/types.h>
31 #include <sys/param.h>
32 #include <sys/systm.h>
33 #include <sys/sysmacros.h>
35 #include <sys/dmu_impl.h>
36 #include <sys/dmu_objset.h>
38 #include <sys/dnode.h>
41 #include <sys/sunddi.h>
42 #include <sys/sa_impl.h>
43 #include <sys/dnode.h>
44 #include <sys/errno.h>
45 #include <sys/zfs_context.h>
48 * ZFS System attributes:
50 * A generic mechanism to allow for arbitrary attributes
51 * to be stored in a dnode. The data will be stored in the bonus buffer of
52 * the dnode and if necessary a special "spill" block will be used to handle
53 * overflow situations. The spill block will be sized to fit the data
54 * from 512 - 128K. When a spill block is used the BP (blkptr_t) for the
55 * spill block is stored at the end of the current bonus buffer. Any
56 * attributes that would be in the way of the blkptr_t will be relocated
57 * into the spill block.
59 * Attribute registration:
61 * Stored persistently on a per dataset basis
62 * a mapping between attribute "string" names and their actual attribute
63 * numeric values, length, and byteswap function. The names are only used
64 * during registration. All attributes are known by their unique attribute
65 * id value. If an attribute can have a variable size then the value
66 * 0 will be used to indicate this.
70 * Attribute layouts are a way to compactly store multiple attributes, but
71 * without taking the overhead associated with managing each attribute
72 * individually. Since you will typically have the same set of attributes
73 * stored in the same order a single table will be used to represent that
74 * layout. The ZPL for example will usually have only about 10 different
75 * layouts (regular files, device files, symlinks,
76 * regular files + scanstamp, files/dir with extended attributes, and then
77 * you have the possibility of all of those minus ACL, because it would
78 * be kicked out into the spill block)
80 * Layouts are simply an array of the attributes and their
81 * ordering i.e. [0, 1, 4, 5, 2]
83 * Each distinct layout is given a unique layout number and that is whats
84 * stored in the header at the beginning of the SA data buffer.
86 * A layout only covers a single dbuf (bonus or spill). If a set of
87 * attributes is split up between the bonus buffer and a spill buffer then
88 * two different layouts will be used. This allows us to byteswap the
89 * spill without looking at the bonus buffer and keeps the on disk format of
90 * the bonus and spill buffer the same.
92 * Adding a single attribute will cause the entire set of attributes to
93 * be rewritten and could result in a new layout number being constructed
94 * as part of the rewrite if no such layout exists for the new set of
95 * attribues. The new attribute will be appended to the end of the already
96 * existing attributes.
98 * Both the attribute registration and attribute layout information are
99 * stored in normal ZAP attributes. Their should be a small number of
100 * known layouts and the set of attributes is assumed to typically be quite
103 * The registered attributes and layout "table" information is maintained
104 * in core and a special "sa_os_t" is attached to the objset_t.
106 * A special interface is provided to allow for quickly applying
107 * a large set of attributes at once. sa_replace_all_by_template() is
108 * used to set an array of attributes. This is used by the ZPL when
109 * creating a brand new file. The template that is passed into the function
110 * specifies the attribute, size for variable length attributes, location of
111 * data and special "data locator" function if the data isn't in a contiguous
114 * Byteswap implications:
116 * Since the SA attributes are not entirely self describing we can't do
117 * the normal byteswap processing. The special ZAP layout attribute and
118 * attribute registration attributes define the byteswap function and the
119 * size of the attributes, unless it is variable sized.
120 * The normal ZFS byteswapping infrastructure assumes you don't need
121 * to read any objects in order to do the necessary byteswapping. Whereas
122 * SA attributes can only be properly byteswapped if the dataset is opened
123 * and the layout/attribute ZAP attributes are available. Because of this
124 * the SA attributes will be byteswapped when they are first accessed by
125 * the SA code that will read the SA data.
128 typedef void (sa_iterfunc_t)(void *hdr, void *addr, sa_attr_type_t,
129 uint16_t length, int length_idx, boolean_t, void *userp);
131 static int sa_build_index(sa_handle_t *hdl, sa_buf_type_t buftype);
132 static void sa_idx_tab_hold(objset_t *os, sa_idx_tab_t *idx_tab);
133 static void *sa_find_idx_tab(objset_t *os, dmu_object_type_t bonustype,
135 static void sa_idx_tab_rele(objset_t *os, void *arg);
136 static void sa_copy_data(sa_data_locator_t *func, void *start, void *target,
138 static int sa_modify_attrs(sa_handle_t *hdl, sa_attr_type_t newattr,
139 sa_data_op_t action, sa_data_locator_t *locator, void *datastart,
140 uint16_t buflen, dmu_tx_t *tx);
142 arc_byteswap_func_t *sa_bswap_table[] = {
143 byteswap_uint64_array,
144 byteswap_uint32_array,
145 byteswap_uint16_array,
146 byteswap_uint8_array,
150 #define SA_COPY_DATA(f, s, t, l) \
154 *(uint64_t *)t = *(uint64_t *)s; \
155 } else if (l == 16) { \
156 *(uint64_t *)t = *(uint64_t *)s; \
157 *(uint64_t *)((uintptr_t)t + 8) = \
158 *(uint64_t *)((uintptr_t)s + 8); \
163 sa_copy_data(f, s, t, l); \
167 * This table is fixed and cannot be changed. Its purpose is to
168 * allow the SA code to work with both old/new ZPL file systems.
169 * It contains the list of legacy attributes. These attributes aren't
170 * stored in the "attribute" registry zap objects, since older ZPL file systems
171 * won't have the registry. Only objsets of type ZFS_TYPE_FILESYSTEM will
172 * use this static table.
174 sa_attr_reg_t sa_legacy_attrs[] = {
175 {"ZPL_ATIME", sizeof (uint64_t) * 2, SA_UINT64_ARRAY, 0},
176 {"ZPL_MTIME", sizeof (uint64_t) * 2, SA_UINT64_ARRAY, 1},
177 {"ZPL_CTIME", sizeof (uint64_t) * 2, SA_UINT64_ARRAY, 2},
178 {"ZPL_CRTIME", sizeof (uint64_t) * 2, SA_UINT64_ARRAY, 3},
179 {"ZPL_GEN", sizeof (uint64_t), SA_UINT64_ARRAY, 4},
180 {"ZPL_MODE", sizeof (uint64_t), SA_UINT64_ARRAY, 5},
181 {"ZPL_SIZE", sizeof (uint64_t), SA_UINT64_ARRAY, 6},
182 {"ZPL_PARENT", sizeof (uint64_t), SA_UINT64_ARRAY, 7},
183 {"ZPL_LINKS", sizeof (uint64_t), SA_UINT64_ARRAY, 8},
184 {"ZPL_XATTR", sizeof (uint64_t), SA_UINT64_ARRAY, 9},
185 {"ZPL_RDEV", sizeof (uint64_t), SA_UINT64_ARRAY, 10},
186 {"ZPL_FLAGS", sizeof (uint64_t), SA_UINT64_ARRAY, 11},
187 {"ZPL_UID", sizeof (uint64_t), SA_UINT64_ARRAY, 12},
188 {"ZPL_GID", sizeof (uint64_t), SA_UINT64_ARRAY, 13},
189 {"ZPL_PAD", sizeof (uint64_t) * 4, SA_UINT64_ARRAY, 14},
190 {"ZPL_ZNODE_ACL", 88, SA_UINT8_ARRAY, 15},
194 * This is only used for objects of type DMU_OT_ZNODE
196 sa_attr_type_t sa_legacy_zpl_layout[] = {
197 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
201 * 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 mutex_init(&hdl->sa_lock, NULL, MUTEX_DEFAULT, NULL);
220 sa_cache_destructor(void *buf, void *unused)
222 sa_handle_t *hdl = buf;
223 mutex_destroy(&hdl->sa_lock);
229 sa_cache = kmem_cache_create("sa_cache",
230 sizeof (sa_handle_t), 0, sa_cache_constructor,
231 sa_cache_destructor, NULL, NULL, NULL, 0);
238 kmem_cache_destroy(sa_cache);
242 layout_num_compare(const void *arg1, const void *arg2)
244 const sa_lot_t *node1 = arg1;
245 const sa_lot_t *node2 = arg2;
247 if (node1->lot_num > node2->lot_num)
249 else if (node1->lot_num < node2->lot_num)
255 layout_hash_compare(const void *arg1, const void *arg2)
257 const sa_lot_t *node1 = arg1;
258 const sa_lot_t *node2 = arg2;
260 if (node1->lot_hash > node2->lot_hash)
262 if (node1->lot_hash < node2->lot_hash)
264 if (node1->lot_instance > node2->lot_instance)
266 if (node1->lot_instance < node2->lot_instance)
272 sa_layout_equal(sa_lot_t *tbf, sa_attr_type_t *attrs, int count)
276 if (count != tbf->lot_attr_count)
279 for (i = 0; i != count; i++) {
280 if (attrs[i] != tbf->lot_attrs[i])
286 #define SA_ATTR_HASH(attr) (zfs_crc64_table[(-1ULL ^ attr) & 0xFF])
289 sa_layout_info_hash(sa_attr_type_t *attrs, int attr_count)
292 uint64_t crc = -1ULL;
294 for (i = 0; i != attr_count; i++)
295 crc ^= SA_ATTR_HASH(attrs[i]);
301 sa_get_spill(sa_handle_t *hdl)
304 if (hdl->sa_spill == NULL) {
305 if ((rc = dmu_spill_hold_existing(hdl->sa_bonus, NULL,
306 &hdl->sa_spill)) == 0)
307 VERIFY(0 == sa_build_index(hdl, SA_SPILL));
316 * Main attribute lookup/update function
317 * returns 0 for success or non zero for failures
319 * Operates on bulk array, first failure will abort further processing
322 sa_attr_op(sa_handle_t *hdl, sa_bulk_attr_t *bulk, int count,
323 sa_data_op_t data_op, dmu_tx_t *tx)
325 sa_os_t *sa = hdl->sa_os->os_sa;
328 sa_buf_type_t buftypes;
333 for (i = 0; i != count; i++) {
334 ASSERT(bulk[i].sa_attr <= hdl->sa_os->os_sa->sa_num_attrs);
336 bulk[i].sa_addr = NULL;
337 /* First check the bonus buffer */
339 if (hdl->sa_bonus_tab && TOC_ATTR_PRESENT(
340 hdl->sa_bonus_tab->sa_idx_tab[bulk[i].sa_attr])) {
341 SA_ATTR_INFO(sa, hdl->sa_bonus_tab,
342 SA_GET_HDR(hdl, SA_BONUS),
343 bulk[i].sa_attr, bulk[i], SA_BONUS, hdl);
344 if (tx && !(buftypes & SA_BONUS)) {
345 dmu_buf_will_dirty(hdl->sa_bonus, tx);
346 buftypes |= SA_BONUS;
349 if (bulk[i].sa_addr == NULL &&
350 ((error = sa_get_spill(hdl)) == 0)) {
351 if (TOC_ATTR_PRESENT(
352 hdl->sa_spill_tab->sa_idx_tab[bulk[i].sa_attr])) {
353 SA_ATTR_INFO(sa, hdl->sa_spill_tab,
354 SA_GET_HDR(hdl, SA_SPILL),
355 bulk[i].sa_attr, bulk[i], SA_SPILL, hdl);
356 if (tx && !(buftypes & SA_SPILL) &&
357 bulk[i].sa_size == bulk[i].sa_length) {
358 dmu_buf_will_dirty(hdl->sa_spill, tx);
359 buftypes |= SA_SPILL;
363 if (error && error != ENOENT) {
364 return ((error == ECKSUM) ? EIO : error);
369 if (bulk[i].sa_addr == NULL)
370 return (SET_ERROR(ENOENT));
371 if (bulk[i].sa_data) {
372 SA_COPY_DATA(bulk[i].sa_data_func,
373 bulk[i].sa_addr, bulk[i].sa_data,
379 /* existing rewrite of attr */
380 if (bulk[i].sa_addr &&
381 bulk[i].sa_size == bulk[i].sa_length) {
382 SA_COPY_DATA(bulk[i].sa_data_func,
383 bulk[i].sa_data, bulk[i].sa_addr,
386 } else if (bulk[i].sa_addr) { /* attr size change */
387 error = sa_modify_attrs(hdl, bulk[i].sa_attr,
388 SA_REPLACE, bulk[i].sa_data_func,
389 bulk[i].sa_data, bulk[i].sa_length, tx);
390 } else { /* adding new attribute */
391 error = sa_modify_attrs(hdl, bulk[i].sa_attr,
392 SA_ADD, bulk[i].sa_data_func,
393 bulk[i].sa_data, bulk[i].sa_length, tx);
404 sa_add_layout_entry(objset_t *os, sa_attr_type_t *attrs, int attr_count,
405 uint64_t lot_num, uint64_t hash, boolean_t zapadd, dmu_tx_t *tx)
407 sa_os_t *sa = os->os_sa;
408 sa_lot_t *tb, *findtb;
412 ASSERT(MUTEX_HELD(&sa->sa_lock));
413 tb = kmem_zalloc(sizeof (sa_lot_t), KM_SLEEP);
414 tb->lot_attr_count = attr_count;
415 tb->lot_attrs = kmem_alloc(sizeof (sa_attr_type_t) * attr_count,
417 bcopy(attrs, tb->lot_attrs, sizeof (sa_attr_type_t) * attr_count);
418 tb->lot_num = lot_num;
420 tb->lot_instance = 0;
425 if (sa->sa_layout_attr_obj == 0) {
426 sa->sa_layout_attr_obj = zap_create_link(os,
427 DMU_OT_SA_ATTR_LAYOUTS,
428 sa->sa_master_obj, SA_LAYOUTS, tx);
431 (void) snprintf(attr_name, sizeof (attr_name),
433 VERIFY(0 == zap_update(os, os->os_sa->sa_layout_attr_obj,
434 attr_name, 2, attr_count, attrs, tx));
437 list_create(&tb->lot_idx_tab, sizeof (sa_idx_tab_t),
438 offsetof(sa_idx_tab_t, sa_next));
440 for (i = 0; i != attr_count; i++) {
441 if (sa->sa_attr_table[tb->lot_attrs[i]].sa_length == 0)
445 avl_add(&sa->sa_layout_num_tree, tb);
447 /* verify we don't have a hash collision */
448 if ((findtb = avl_find(&sa->sa_layout_hash_tree, tb, &loc)) != NULL) {
449 for (; findtb && findtb->lot_hash == hash;
450 findtb = AVL_NEXT(&sa->sa_layout_hash_tree, findtb)) {
451 if (findtb->lot_instance != tb->lot_instance)
456 avl_add(&sa->sa_layout_hash_tree, tb);
461 sa_find_layout(objset_t *os, uint64_t hash, sa_attr_type_t *attrs,
462 int count, dmu_tx_t *tx, sa_lot_t **lot)
464 sa_lot_t *tb, tbsearch;
466 sa_os_t *sa = os->os_sa;
467 boolean_t found = B_FALSE;
469 mutex_enter(&sa->sa_lock);
470 tbsearch.lot_hash = hash;
471 tbsearch.lot_instance = 0;
472 tb = avl_find(&sa->sa_layout_hash_tree, &tbsearch, &loc);
474 for (; tb && tb->lot_hash == hash;
475 tb = AVL_NEXT(&sa->sa_layout_hash_tree, tb)) {
476 if (sa_layout_equal(tb, attrs, count) == 0) {
483 tb = sa_add_layout_entry(os, attrs, count,
484 avl_numnodes(&sa->sa_layout_num_tree), hash, B_TRUE, tx);
486 mutex_exit(&sa->sa_lock);
491 sa_resize_spill(sa_handle_t *hdl, uint32_t size, dmu_tx_t *tx)
497 blocksize = SPA_MINBLOCKSIZE;
498 } else if (size > SPA_OLD_MAXBLOCKSIZE) {
500 return (SET_ERROR(EFBIG));
502 blocksize = P2ROUNDUP_TYPED(size, SPA_MINBLOCKSIZE, uint32_t);
505 error = dbuf_spill_set_blksz(hdl->sa_spill, blocksize, tx);
511 sa_copy_data(sa_data_locator_t *func, void *datastart, void *target, int buflen)
514 bcopy(datastart, target, buflen);
519 void *saptr = target;
524 while (bytes < buflen) {
525 func(&dataptr, &length, buflen, start, datastart);
526 bcopy(dataptr, saptr, length);
527 saptr = (void *)((caddr_t)saptr + length);
535 * Determine several different sizes
536 * first the sa header size
537 * the number of bytes to be stored
538 * if spill would occur the index in the attribute array is returned
540 * the boolean will_spill will be set when spilling is necessary. It
541 * is only set when the buftype is SA_BONUS
544 sa_find_sizes(sa_os_t *sa, sa_bulk_attr_t *attr_desc, int attr_count,
545 dmu_buf_t *db, sa_buf_type_t buftype, int *index, int *total,
546 boolean_t *will_spill)
554 if (buftype == SA_BONUS && sa->sa_force_spill) {
557 *will_spill = B_TRUE;
563 *will_spill = B_FALSE;
566 hdrsize = (SA_BONUSTYPE_FROM_DB(db) == DMU_OT_ZNODE) ? 0 :
567 sizeof (sa_hdr_phys_t);
569 full_space = (buftype == SA_BONUS) ? DN_MAX_BONUSLEN : db->db_size;
570 ASSERT(IS_P2ALIGNED(full_space, 8));
572 for (i = 0; i != attr_count; i++) {
575 *total = P2ROUNDUP(*total, 8);
576 *total += attr_desc[i].sa_length;
580 is_var_sz = (SA_REGISTERED_LEN(sa, attr_desc[i].sa_attr) == 0);
585 if (is_var_sz && var_size > 1) {
587 * Don't worry that the spill block might overflow.
588 * It will be resized if needed in sa_build_layouts().
590 if (buftype == SA_SPILL ||
591 P2ROUNDUP(hdrsize + sizeof (uint16_t), 8) +
592 *total < full_space) {
594 * Account for header space used by array of
595 * optional sizes of variable-length attributes.
596 * Record the extra header size in case this
597 * increase needs to be reversed due to
600 hdrsize += sizeof (uint16_t);
602 extra_hdrsize += sizeof (uint16_t);
604 ASSERT(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))) {
624 if ((*total + P2ROUNDUP(hdrsize, 8)) > full_space &&
626 *will_spill = B_TRUE;
630 hdrsize -= extra_hdrsize;
632 hdrsize = P2ROUNDUP(hdrsize, 8);
636 #define BUF_SPACE_NEEDED(total, header) (total + header)
639 * Find layout that corresponds to ordering of attributes
640 * If not found a new layout number is created and added to
641 * persistent layout tables.
644 sa_build_layouts(sa_handle_t *hdl, sa_bulk_attr_t *attr_desc, int attr_count,
647 sa_os_t *sa = hdl->sa_os->os_sa;
649 sa_buf_type_t buftype;
650 sa_hdr_phys_t *sahdr;
653 sa_attr_type_t *attrs, *attrs_start;
656 int spillhdrsize = 0;
658 dmu_object_type_t bonustype;
664 dmu_buf_will_dirty(hdl->sa_bonus, tx);
665 bonustype = SA_BONUSTYPE_FROM_DB(hdl->sa_bonus);
667 /* first determine bonus header size and sum of all attributes */
668 hdrsize = sa_find_sizes(sa, attr_desc, attr_count, hdl->sa_bonus,
669 SA_BONUS, &i, &used, &spilling);
671 if (used > SPA_OLD_MAXBLOCKSIZE)
672 return (SET_ERROR(EFBIG));
674 VERIFY(0 == dmu_set_bonus(hdl->sa_bonus, spilling ?
675 MIN(DN_MAX_BONUSLEN - sizeof (blkptr_t), used + hdrsize) :
676 used + hdrsize, tx));
678 ASSERT((bonustype == DMU_OT_ZNODE && spilling == 0) ||
679 bonustype == DMU_OT_SA);
681 /* setup and size spill buffer when needed */
685 if (hdl->sa_spill == NULL) {
686 VERIFY(dmu_spill_hold_by_bonus(hdl->sa_bonus, NULL,
687 &hdl->sa_spill) == 0);
689 dmu_buf_will_dirty(hdl->sa_spill, tx);
691 spillhdrsize = sa_find_sizes(sa, &attr_desc[i],
692 attr_count - i, hdl->sa_spill, SA_SPILL, &i,
693 &spill_used, &dummy);
695 if (spill_used > SPA_OLD_MAXBLOCKSIZE)
696 return (SET_ERROR(EFBIG));
698 buf_space = hdl->sa_spill->db_size - spillhdrsize;
699 if (BUF_SPACE_NEEDED(spill_used, spillhdrsize) >
700 hdl->sa_spill->db_size)
701 VERIFY(0 == sa_resize_spill(hdl,
702 BUF_SPACE_NEEDED(spill_used, spillhdrsize), tx));
705 /* setup starting pointers to lay down data */
706 data_start = (void *)((uintptr_t)hdl->sa_bonus->db_data + hdrsize);
707 sahdr = (sa_hdr_phys_t *)hdl->sa_bonus->db_data;
711 buf_space = (sa->sa_force_spill) ?
712 0 : SA_BLKPTR_SPACE - hdrsize;
714 buf_space = hdl->sa_bonus->db_size - hdrsize;
716 attrs_start = attrs = kmem_alloc(sizeof (sa_attr_type_t) * attr_count,
720 for (i = 0, len_idx = 0, hash = -1ULL; i != attr_count; i++) {
723 ASSERT(IS_P2ALIGNED(data_start, 8));
724 ASSERT(IS_P2ALIGNED(buf_space, 8));
725 attrs[i] = attr_desc[i].sa_attr;
726 length = SA_REGISTERED_LEN(sa, attrs[i]);
728 length = attr_desc[i].sa_length;
730 VERIFY(length == attr_desc[i].sa_length);
732 if (buf_space < length) { /* switch to spill buffer */
734 VERIFY(bonustype == DMU_OT_SA);
735 if (buftype == SA_BONUS && !sa->sa_force_spill) {
736 sa_find_layout(hdl->sa_os, hash, attrs_start,
737 lot_count, tx, &lot);
738 SA_SET_HDR(sahdr, lot->lot_num, hdrsize);
745 sahdr = (sa_hdr_phys_t *)hdl->sa_spill->db_data;
746 sahdr->sa_magic = SA_MAGIC;
747 data_start = (void *)((uintptr_t)sahdr +
749 attrs_start = &attrs[i];
750 buf_space = hdl->sa_spill->db_size - spillhdrsize;
753 hash ^= SA_ATTR_HASH(attrs[i]);
754 attr_desc[i].sa_addr = data_start;
755 attr_desc[i].sa_size = length;
756 SA_COPY_DATA(attr_desc[i].sa_data_func, attr_desc[i].sa_data,
758 if (sa->sa_attr_table[attrs[i]].sa_length == 0) {
759 sahdr->sa_lengths[len_idx++] = length;
761 VERIFY((uintptr_t)data_start % 8 == 0);
762 data_start = (void *)P2ROUNDUP(((uintptr_t)data_start +
764 buf_space -= P2ROUNDUP(length, 8);
768 sa_find_layout(hdl->sa_os, hash, attrs_start, lot_count, tx, &lot);
771 * Verify that old znodes always have layout number 0.
772 * Must be DMU_OT_SA for arbitrary layouts
774 VERIFY((bonustype == DMU_OT_ZNODE && lot->lot_num == 0) ||
775 (bonustype == DMU_OT_SA && lot->lot_num > 1));
777 if (bonustype == DMU_OT_SA) {
778 SA_SET_HDR(sahdr, lot->lot_num,
779 buftype == SA_BONUS ? hdrsize : spillhdrsize);
782 kmem_free(attrs, sizeof (sa_attr_type_t) * attr_count);
783 if (hdl->sa_bonus_tab) {
784 sa_idx_tab_rele(hdl->sa_os, hdl->sa_bonus_tab);
785 hdl->sa_bonus_tab = NULL;
787 if (!sa->sa_force_spill)
788 VERIFY(0 == sa_build_index(hdl, SA_BONUS));
790 sa_idx_tab_rele(hdl->sa_os, hdl->sa_spill_tab);
793 * remove spill block that is no longer needed.
795 dmu_buf_rele(hdl->sa_spill, NULL);
796 hdl->sa_spill = NULL;
797 hdl->sa_spill_tab = NULL;
798 VERIFY(0 == dmu_rm_spill(hdl->sa_os,
799 sa_handle_object(hdl), tx));
801 VERIFY(0 == sa_build_index(hdl, SA_SPILL));
809 sa_free_attr_table(sa_os_t *sa)
813 if (sa->sa_attr_table == NULL)
816 for (i = 0; i != sa->sa_num_attrs; i++) {
817 if (sa->sa_attr_table[i].sa_name)
818 kmem_free(sa->sa_attr_table[i].sa_name,
819 strlen(sa->sa_attr_table[i].sa_name) + 1);
822 kmem_free(sa->sa_attr_table,
823 sizeof (sa_attr_table_t) * sa->sa_num_attrs);
825 sa->sa_attr_table = NULL;
829 sa_attr_table_setup(objset_t *os, sa_attr_reg_t *reg_attrs, int count)
831 sa_os_t *sa = os->os_sa;
832 uint64_t sa_attr_count = 0;
833 uint64_t sa_reg_count = 0;
839 int registered_count = 0;
841 dmu_objset_type_t ostype = dmu_objset_type(os);
844 kmem_zalloc(count * sizeof (sa_attr_type_t), KM_SLEEP);
845 sa->sa_user_table_sz = count * sizeof (sa_attr_type_t);
847 if (sa->sa_reg_attr_obj != 0) {
848 error = zap_count(os, sa->sa_reg_attr_obj,
852 * Make sure we retrieved a count and that it isn't zero
854 if (error || (error == 0 && sa_attr_count == 0)) {
856 error = SET_ERROR(EINVAL);
859 sa_reg_count = sa_attr_count;
862 if (ostype == DMU_OST_ZFS && sa_attr_count == 0)
863 sa_attr_count += sa_legacy_attr_count;
865 /* Allocate attribute numbers for attributes that aren't registered */
866 for (i = 0; i != count; i++) {
867 boolean_t found = B_FALSE;
870 if (ostype == DMU_OST_ZFS) {
871 for (j = 0; j != sa_legacy_attr_count; j++) {
872 if (strcmp(reg_attrs[i].sa_name,
873 sa_legacy_attrs[j].sa_name) == 0) {
874 sa->sa_user_table[i] =
875 sa_legacy_attrs[j].sa_attr;
883 if (sa->sa_reg_attr_obj)
884 error = zap_lookup(os, sa->sa_reg_attr_obj,
885 reg_attrs[i].sa_name, 8, 1, &attr_value);
887 error = SET_ERROR(ENOENT);
890 sa->sa_user_table[i] = (sa_attr_type_t)sa_attr_count;
894 sa->sa_user_table[i] = ATTR_NUM(attr_value);
901 sa->sa_num_attrs = sa_attr_count;
902 tb = sa->sa_attr_table =
903 kmem_zalloc(sizeof (sa_attr_table_t) * sa_attr_count, KM_SLEEP);
906 * Attribute table is constructed from requested attribute list,
907 * previously foreign registered attributes, and also the legacy
908 * ZPL set of attributes.
911 if (sa->sa_reg_attr_obj) {
912 for (zap_cursor_init(&zc, os, sa->sa_reg_attr_obj);
913 (error = zap_cursor_retrieve(&zc, &za)) == 0;
914 zap_cursor_advance(&zc)) {
916 value = za.za_first_integer;
919 tb[ATTR_NUM(value)].sa_attr = ATTR_NUM(value);
920 tb[ATTR_NUM(value)].sa_length = ATTR_LENGTH(value);
921 tb[ATTR_NUM(value)].sa_byteswap = ATTR_BSWAP(value);
922 tb[ATTR_NUM(value)].sa_registered = B_TRUE;
924 if (tb[ATTR_NUM(value)].sa_name) {
927 tb[ATTR_NUM(value)].sa_name =
928 kmem_zalloc(strlen(za.za_name) +1, KM_SLEEP);
929 (void) strlcpy(tb[ATTR_NUM(value)].sa_name, za.za_name,
930 strlen(za.za_name) +1);
932 zap_cursor_fini(&zc);
934 * Make sure we processed the correct number of registered
937 if (registered_count != sa_reg_count) {
944 if (ostype == DMU_OST_ZFS) {
945 for (i = 0; i != sa_legacy_attr_count; i++) {
948 tb[i].sa_attr = sa_legacy_attrs[i].sa_attr;
949 tb[i].sa_length = sa_legacy_attrs[i].sa_length;
950 tb[i].sa_byteswap = sa_legacy_attrs[i].sa_byteswap;
951 tb[i].sa_registered = B_FALSE;
953 kmem_zalloc(strlen(sa_legacy_attrs[i].sa_name) +1,
955 (void) strlcpy(tb[i].sa_name,
956 sa_legacy_attrs[i].sa_name,
957 strlen(sa_legacy_attrs[i].sa_name) + 1);
961 for (i = 0; i != count; i++) {
962 sa_attr_type_t attr_id;
964 attr_id = sa->sa_user_table[i];
965 if (tb[attr_id].sa_name)
968 tb[attr_id].sa_length = reg_attrs[i].sa_length;
969 tb[attr_id].sa_byteswap = reg_attrs[i].sa_byteswap;
970 tb[attr_id].sa_attr = attr_id;
971 tb[attr_id].sa_name =
972 kmem_zalloc(strlen(reg_attrs[i].sa_name) + 1, KM_SLEEP);
973 (void) strlcpy(tb[attr_id].sa_name, reg_attrs[i].sa_name,
974 strlen(reg_attrs[i].sa_name) + 1);
977 sa->sa_need_attr_registration =
978 (sa_attr_count != registered_count);
982 kmem_free(sa->sa_user_table, count * sizeof (sa_attr_type_t));
983 sa->sa_user_table = NULL;
984 sa_free_attr_table(sa);
985 return ((error != 0) ? error : EINVAL);
989 sa_setup(objset_t *os, uint64_t sa_obj, sa_attr_reg_t *reg_attrs, int count,
990 sa_attr_type_t **user_table)
995 dmu_objset_type_t ostype = dmu_objset_type(os);
999 mutex_enter(&os->os_user_ptr_lock);
1001 mutex_enter(&os->os_sa->sa_lock);
1002 mutex_exit(&os->os_user_ptr_lock);
1003 tb = os->os_sa->sa_user_table;
1004 mutex_exit(&os->os_sa->sa_lock);
1009 sa = kmem_zalloc(sizeof (sa_os_t), KM_SLEEP);
1010 mutex_init(&sa->sa_lock, NULL, MUTEX_DEFAULT, NULL);
1011 sa->sa_master_obj = sa_obj;
1014 mutex_enter(&sa->sa_lock);
1015 mutex_exit(&os->os_user_ptr_lock);
1016 avl_create(&sa->sa_layout_num_tree, layout_num_compare,
1017 sizeof (sa_lot_t), offsetof(sa_lot_t, lot_num_node));
1018 avl_create(&sa->sa_layout_hash_tree, layout_hash_compare,
1019 sizeof (sa_lot_t), offsetof(sa_lot_t, lot_hash_node));
1022 error = zap_lookup(os, sa_obj, SA_LAYOUTS,
1023 8, 1, &sa->sa_layout_attr_obj);
1024 if (error != 0 && error != ENOENT)
1026 error = zap_lookup(os, sa_obj, SA_REGISTRY,
1027 8, 1, &sa->sa_reg_attr_obj);
1028 if (error != 0 && error != ENOENT)
1032 if ((error = sa_attr_table_setup(os, reg_attrs, count)) != 0)
1035 if (sa->sa_layout_attr_obj != 0) {
1036 uint64_t layout_count;
1038 error = zap_count(os, sa->sa_layout_attr_obj,
1042 * Layout number count should be > 0
1044 if (error || (error == 0 && layout_count == 0)) {
1046 error = SET_ERROR(EINVAL);
1050 for (zap_cursor_init(&zc, os, sa->sa_layout_attr_obj);
1051 (error = zap_cursor_retrieve(&zc, &za)) == 0;
1052 zap_cursor_advance(&zc)) {
1053 sa_attr_type_t *lot_attrs;
1056 lot_attrs = kmem_zalloc(sizeof (sa_attr_type_t) *
1057 za.za_num_integers, KM_SLEEP);
1059 if ((error = (zap_lookup(os, sa->sa_layout_attr_obj,
1060 za.za_name, 2, za.za_num_integers,
1061 lot_attrs))) != 0) {
1062 kmem_free(lot_attrs, sizeof (sa_attr_type_t) *
1063 za.za_num_integers);
1066 VERIFY(ddi_strtoull(za.za_name, NULL, 10,
1067 (unsigned long long *)&lot_num) == 0);
1069 (void) sa_add_layout_entry(os, lot_attrs,
1070 za.za_num_integers, lot_num,
1071 sa_layout_info_hash(lot_attrs,
1072 za.za_num_integers), B_FALSE, NULL);
1073 kmem_free(lot_attrs, sizeof (sa_attr_type_t) *
1074 za.za_num_integers);
1076 zap_cursor_fini(&zc);
1079 * Make sure layout count matches number of entries added
1082 if (avl_numnodes(&sa->sa_layout_num_tree) != layout_count) {
1088 /* Add special layout number for old ZNODES */
1089 if (ostype == DMU_OST_ZFS) {
1090 (void) sa_add_layout_entry(os, sa_legacy_zpl_layout,
1091 sa_legacy_attr_count, 0,
1092 sa_layout_info_hash(sa_legacy_zpl_layout,
1093 sa_legacy_attr_count), B_FALSE, NULL);
1095 (void) sa_add_layout_entry(os, sa_dummy_zpl_layout, 0, 1,
1098 *user_table = os->os_sa->sa_user_table;
1099 mutex_exit(&sa->sa_lock);
1103 sa_free_attr_table(sa);
1104 if (sa->sa_user_table)
1105 kmem_free(sa->sa_user_table, sa->sa_user_table_sz);
1106 mutex_exit(&sa->sa_lock);
1107 avl_destroy(&sa->sa_layout_hash_tree);
1108 avl_destroy(&sa->sa_layout_num_tree);
1109 mutex_destroy(&sa->sa_lock);
1110 kmem_free(sa, sizeof (sa_os_t));
1111 return ((error == ECKSUM) ? EIO : error);
1115 sa_tear_down(objset_t *os)
1117 sa_os_t *sa = os->os_sa;
1121 kmem_free(sa->sa_user_table, sa->sa_user_table_sz);
1123 /* Free up attr table */
1125 sa_free_attr_table(sa);
1128 while (layout = avl_destroy_nodes(&sa->sa_layout_hash_tree, &cookie)) {
1130 while (tab = list_head(&layout->lot_idx_tab)) {
1131 ASSERT(refcount_count(&tab->sa_refcount));
1132 sa_idx_tab_rele(os, tab);
1137 while (layout = avl_destroy_nodes(&sa->sa_layout_num_tree, &cookie)) {
1138 kmem_free(layout->lot_attrs,
1139 sizeof (sa_attr_type_t) * layout->lot_attr_count);
1140 kmem_free(layout, sizeof (sa_lot_t));
1143 avl_destroy(&sa->sa_layout_hash_tree);
1144 avl_destroy(&sa->sa_layout_num_tree);
1145 mutex_destroy(&sa->sa_lock);
1147 kmem_free(sa, sizeof (sa_os_t));
1152 sa_build_idx_tab(void *hdr, void *attr_addr, sa_attr_type_t attr,
1153 uint16_t length, int length_idx, boolean_t var_length, void *userp)
1155 sa_idx_tab_t *idx_tab = userp;
1158 ASSERT(idx_tab->sa_variable_lengths);
1159 idx_tab->sa_variable_lengths[length_idx] = length;
1161 TOC_ATTR_ENCODE(idx_tab->sa_idx_tab[attr], length_idx,
1162 (uint32_t)((uintptr_t)attr_addr - (uintptr_t)hdr));
1166 sa_attr_iter(objset_t *os, sa_hdr_phys_t *hdr, dmu_object_type_t type,
1167 sa_iterfunc_t func, sa_lot_t *tab, void *userp)
1173 sa_os_t *sa = os->os_sa;
1175 uint16_t *length_start = NULL;
1176 uint8_t length_idx = 0;
1179 search.lot_num = SA_LAYOUT_NUM(hdr, type);
1180 tb = avl_find(&sa->sa_layout_num_tree, &search, &loc);
1184 if (IS_SA_BONUSTYPE(type)) {
1185 data_start = (void *)P2ROUNDUP(((uintptr_t)hdr +
1186 offsetof(sa_hdr_phys_t, sa_lengths) +
1187 (sizeof (uint16_t) * tb->lot_var_sizes)), 8);
1188 length_start = hdr->sa_lengths;
1193 for (i = 0; i != tb->lot_attr_count; i++) {
1194 int attr_length, reg_length;
1197 reg_length = sa->sa_attr_table[tb->lot_attrs[i]].sa_length;
1199 attr_length = reg_length;
1202 attr_length = length_start[length_idx];
1203 idx_len = length_idx++;
1206 func(hdr, data_start, tb->lot_attrs[i], attr_length,
1207 idx_len, reg_length == 0 ? B_TRUE : B_FALSE, userp);
1209 data_start = (void *)P2ROUNDUP(((uintptr_t)data_start +
1216 sa_byteswap_cb(void *hdr, void *attr_addr, sa_attr_type_t attr,
1217 uint16_t length, int length_idx, boolean_t variable_length, void *userp)
1219 sa_handle_t *hdl = userp;
1220 sa_os_t *sa = hdl->sa_os->os_sa;
1222 sa_bswap_table[sa->sa_attr_table[attr].sa_byteswap](attr_addr, length);
1226 sa_byteswap(sa_handle_t *hdl, sa_buf_type_t buftype)
1228 sa_hdr_phys_t *sa_hdr_phys = SA_GET_HDR(hdl, buftype);
1230 sa_os_t *sa = hdl->sa_os->os_sa;
1231 int num_lengths = 1;
1234 ASSERT(MUTEX_HELD(&sa->sa_lock));
1235 if (sa_hdr_phys->sa_magic == SA_MAGIC)
1238 db = SA_GET_DB(hdl, buftype);
1240 if (buftype == SA_SPILL) {
1241 arc_release(db->db_buf, NULL);
1242 arc_buf_thaw(db->db_buf);
1245 sa_hdr_phys->sa_magic = BSWAP_32(sa_hdr_phys->sa_magic);
1246 sa_hdr_phys->sa_layout_info = BSWAP_16(sa_hdr_phys->sa_layout_info);
1249 * Determine number of variable lenghts in header
1250 * The standard 8 byte header has one for free and a
1251 * 16 byte header would have 4 + 1;
1253 if (SA_HDR_SIZE(sa_hdr_phys) > 8)
1254 num_lengths += (SA_HDR_SIZE(sa_hdr_phys) - 8) >> 1;
1255 for (i = 0; i != num_lengths; i++)
1256 sa_hdr_phys->sa_lengths[i] =
1257 BSWAP_16(sa_hdr_phys->sa_lengths[i]);
1259 sa_attr_iter(hdl->sa_os, sa_hdr_phys, DMU_OT_SA,
1260 sa_byteswap_cb, NULL, hdl);
1262 if (buftype == SA_SPILL)
1263 arc_buf_freeze(((dmu_buf_impl_t *)hdl->sa_spill)->db_buf);
1267 sa_build_index(sa_handle_t *hdl, sa_buf_type_t buftype)
1269 sa_hdr_phys_t *sa_hdr_phys;
1270 dmu_buf_impl_t *db = SA_GET_DB(hdl, buftype);
1271 dmu_object_type_t bonustype = SA_BONUSTYPE_FROM_DB(db);
1272 sa_os_t *sa = hdl->sa_os->os_sa;
1273 sa_idx_tab_t *idx_tab;
1275 sa_hdr_phys = SA_GET_HDR(hdl, buftype);
1277 mutex_enter(&sa->sa_lock);
1279 /* Do we need to byteswap? */
1281 /* only check if not old znode */
1282 if (IS_SA_BONUSTYPE(bonustype) && sa_hdr_phys->sa_magic != SA_MAGIC &&
1283 sa_hdr_phys->sa_magic != 0) {
1284 VERIFY(BSWAP_32(sa_hdr_phys->sa_magic) == SA_MAGIC);
1285 sa_byteswap(hdl, buftype);
1288 idx_tab = sa_find_idx_tab(hdl->sa_os, bonustype, sa_hdr_phys);
1290 if (buftype == SA_BONUS)
1291 hdl->sa_bonus_tab = idx_tab;
1293 hdl->sa_spill_tab = idx_tab;
1295 mutex_exit(&sa->sa_lock);
1303 panic("evicting sa dbuf\n");
1307 sa_idx_tab_rele(objset_t *os, void *arg)
1309 sa_os_t *sa = os->os_sa;
1310 sa_idx_tab_t *idx_tab = arg;
1312 if (idx_tab == NULL)
1315 mutex_enter(&sa->sa_lock);
1316 if (refcount_remove(&idx_tab->sa_refcount, NULL) == 0) {
1317 list_remove(&idx_tab->sa_layout->lot_idx_tab, idx_tab);
1318 if (idx_tab->sa_variable_lengths)
1319 kmem_free(idx_tab->sa_variable_lengths,
1321 idx_tab->sa_layout->lot_var_sizes);
1322 refcount_destroy(&idx_tab->sa_refcount);
1323 kmem_free(idx_tab->sa_idx_tab,
1324 sizeof (uint32_t) * sa->sa_num_attrs);
1325 kmem_free(idx_tab, sizeof (sa_idx_tab_t));
1327 mutex_exit(&sa->sa_lock);
1331 sa_idx_tab_hold(objset_t *os, sa_idx_tab_t *idx_tab)
1333 sa_os_t *sa = os->os_sa;
1335 ASSERT(MUTEX_HELD(&sa->sa_lock));
1336 (void) refcount_add(&idx_tab->sa_refcount, NULL);
1340 sa_handle_destroy(sa_handle_t *hdl)
1342 dmu_buf_t *db = hdl->sa_bonus;
1344 mutex_enter(&hdl->sa_lock);
1345 (void) dmu_buf_remove_user(db, &hdl->sa_dbu);
1347 if (hdl->sa_bonus_tab)
1348 sa_idx_tab_rele(hdl->sa_os, hdl->sa_bonus_tab);
1350 if (hdl->sa_spill_tab)
1351 sa_idx_tab_rele(hdl->sa_os, hdl->sa_spill_tab);
1353 dmu_buf_rele(hdl->sa_bonus, NULL);
1356 dmu_buf_rele((dmu_buf_t *)hdl->sa_spill, NULL);
1357 mutex_exit(&hdl->sa_lock);
1359 kmem_cache_free(sa_cache, hdl);
1363 sa_handle_get_from_db(objset_t *os, dmu_buf_t *db, void *userp,
1364 sa_handle_type_t hdl_type, sa_handle_t **handlepp)
1367 dmu_object_info_t doi;
1368 sa_handle_t *handle = NULL;
1371 dmu_object_info_from_db(db, &doi);
1372 ASSERT(doi.doi_bonus_type == DMU_OT_SA ||
1373 doi.doi_bonus_type == DMU_OT_ZNODE);
1375 /* find handle, if it exists */
1376 /* if one doesn't exist then create a new one, and initialize it */
1378 if (hdl_type == SA_HDL_SHARED)
1379 handle = dmu_buf_get_user(db);
1381 if (handle == NULL) {
1382 sa_handle_t *winner = NULL;
1384 handle = kmem_cache_alloc(sa_cache, KM_SLEEP);
1385 handle->sa_dbu.dbu_evict_func = NULL;
1386 handle->sa_userp = userp;
1387 handle->sa_bonus = db;
1389 handle->sa_spill = NULL;
1390 handle->sa_bonus_tab = NULL;
1391 handle->sa_spill_tab = NULL;
1393 error = sa_build_index(handle, SA_BONUS);
1395 if (hdl_type == SA_HDL_SHARED) {
1396 dmu_buf_init_user(&handle->sa_dbu, sa_evict, NULL);
1397 winner = dmu_buf_set_user_ie(db, &handle->sa_dbu);
1400 if (winner != NULL) {
1401 kmem_cache_free(sa_cache, handle);
1411 sa_handle_get(objset_t *objset, uint64_t objid, void *userp,
1412 sa_handle_type_t hdl_type, sa_handle_t **handlepp)
1417 if (error = dmu_bonus_hold(objset, objid, NULL, &db))
1420 return (sa_handle_get_from_db(objset, db, userp, hdl_type,
1425 sa_buf_hold(objset_t *objset, uint64_t obj_num, void *tag, dmu_buf_t **db)
1427 return (dmu_bonus_hold(objset, obj_num, tag, db));
1431 sa_buf_rele(dmu_buf_t *db, void *tag)
1433 dmu_buf_rele(db, tag);
1437 sa_lookup_impl(sa_handle_t *hdl, sa_bulk_attr_t *bulk, int count)
1440 ASSERT(MUTEX_HELD(&hdl->sa_lock));
1441 return (sa_attr_op(hdl, bulk, count, SA_LOOKUP, NULL));
1445 sa_lookup(sa_handle_t *hdl, sa_attr_type_t attr, void *buf, uint32_t buflen)
1448 sa_bulk_attr_t bulk;
1450 bulk.sa_attr = attr;
1452 bulk.sa_length = buflen;
1453 bulk.sa_data_func = NULL;
1456 mutex_enter(&hdl->sa_lock);
1457 error = sa_lookup_impl(hdl, &bulk, 1);
1458 mutex_exit(&hdl->sa_lock);
1464 sa_lookup_uio(sa_handle_t *hdl, sa_attr_type_t attr, uio_t *uio)
1467 sa_bulk_attr_t bulk;
1469 bulk.sa_data = NULL;
1470 bulk.sa_attr = attr;
1471 bulk.sa_data_func = NULL;
1475 mutex_enter(&hdl->sa_lock);
1476 if ((error = sa_attr_op(hdl, &bulk, 1, SA_LOOKUP, NULL)) == 0) {
1477 error = uiomove((void *)bulk.sa_addr, MIN(bulk.sa_size,
1478 uio->uio_resid), UIO_READ, uio);
1480 mutex_exit(&hdl->sa_lock);
1487 sa_find_idx_tab(objset_t *os, dmu_object_type_t bonustype, void *data)
1489 sa_idx_tab_t *idx_tab;
1490 sa_hdr_phys_t *hdr = (sa_hdr_phys_t *)data;
1491 sa_os_t *sa = os->os_sa;
1492 sa_lot_t *tb, search;
1496 * Deterimine layout number. If SA node and header == 0 then
1497 * force the index table to the dummy "1" empty layout.
1499 * The layout number would only be zero for a newly created file
1500 * that has not added any attributes yet, or with crypto enabled which
1501 * doesn't write any attributes to the bonus buffer.
1504 search.lot_num = SA_LAYOUT_NUM(hdr, bonustype);
1506 tb = avl_find(&sa->sa_layout_num_tree, &search, &loc);
1508 /* Verify header size is consistent with layout information */
1510 ASSERT(IS_SA_BONUSTYPE(bonustype) &&
1511 SA_HDR_SIZE_MATCH_LAYOUT(hdr, tb) || !IS_SA_BONUSTYPE(bonustype) ||
1512 (IS_SA_BONUSTYPE(bonustype) && hdr->sa_layout_info == 0));
1515 * See if any of the already existing TOC entries can be reused?
1518 for (idx_tab = list_head(&tb->lot_idx_tab); idx_tab;
1519 idx_tab = list_next(&tb->lot_idx_tab, idx_tab)) {
1520 boolean_t valid_idx = B_TRUE;
1523 if (tb->lot_var_sizes != 0 &&
1524 idx_tab->sa_variable_lengths != NULL) {
1525 for (i = 0; i != tb->lot_var_sizes; i++) {
1526 if (hdr->sa_lengths[i] !=
1527 idx_tab->sa_variable_lengths[i]) {
1528 valid_idx = B_FALSE;
1534 sa_idx_tab_hold(os, idx_tab);
1539 /* No such luck, create a new entry */
1540 idx_tab = kmem_zalloc(sizeof (sa_idx_tab_t), KM_SLEEP);
1541 idx_tab->sa_idx_tab =
1542 kmem_zalloc(sizeof (uint32_t) * sa->sa_num_attrs, KM_SLEEP);
1543 idx_tab->sa_layout = tb;
1544 refcount_create(&idx_tab->sa_refcount);
1545 if (tb->lot_var_sizes)
1546 idx_tab->sa_variable_lengths = kmem_alloc(sizeof (uint16_t) *
1547 tb->lot_var_sizes, KM_SLEEP);
1549 sa_attr_iter(os, hdr, bonustype, sa_build_idx_tab,
1551 sa_idx_tab_hold(os, idx_tab); /* one hold for consumer */
1552 sa_idx_tab_hold(os, idx_tab); /* one for layout */
1553 list_insert_tail(&tb->lot_idx_tab, idx_tab);
1558 sa_default_locator(void **dataptr, uint32_t *len, uint32_t total_len,
1559 boolean_t start, void *userdata)
1563 *dataptr = userdata;
1568 sa_attr_register_sync(sa_handle_t *hdl, dmu_tx_t *tx)
1570 uint64_t attr_value = 0;
1571 sa_os_t *sa = hdl->sa_os->os_sa;
1572 sa_attr_table_t *tb = sa->sa_attr_table;
1575 mutex_enter(&sa->sa_lock);
1577 if (!sa->sa_need_attr_registration || sa->sa_master_obj == 0) {
1578 mutex_exit(&sa->sa_lock);
1582 if (sa->sa_reg_attr_obj == 0) {
1583 sa->sa_reg_attr_obj = zap_create_link(hdl->sa_os,
1584 DMU_OT_SA_ATTR_REGISTRATION,
1585 sa->sa_master_obj, SA_REGISTRY, tx);
1587 for (i = 0; i != sa->sa_num_attrs; i++) {
1588 if (sa->sa_attr_table[i].sa_registered)
1590 ATTR_ENCODE(attr_value, tb[i].sa_attr, tb[i].sa_length,
1592 VERIFY(0 == zap_update(hdl->sa_os, sa->sa_reg_attr_obj,
1593 tb[i].sa_name, 8, 1, &attr_value, tx));
1594 tb[i].sa_registered = B_TRUE;
1596 sa->sa_need_attr_registration = B_FALSE;
1597 mutex_exit(&sa->sa_lock);
1601 * Replace all attributes with attributes specified in template.
1602 * If dnode had a spill buffer then those attributes will be
1603 * also be replaced, possibly with just an empty spill block
1605 * This interface is intended to only be used for bulk adding of
1606 * attributes for a new file. It will also be used by the ZPL
1607 * when converting and old formatted znode to native SA support.
1610 sa_replace_all_by_template_locked(sa_handle_t *hdl, sa_bulk_attr_t *attr_desc,
1611 int attr_count, dmu_tx_t *tx)
1613 sa_os_t *sa = hdl->sa_os->os_sa;
1615 if (sa->sa_need_attr_registration)
1616 sa_attr_register_sync(hdl, tx);
1617 return (sa_build_layouts(hdl, attr_desc, attr_count, tx));
1621 sa_replace_all_by_template(sa_handle_t *hdl, sa_bulk_attr_t *attr_desc,
1622 int attr_count, dmu_tx_t *tx)
1626 mutex_enter(&hdl->sa_lock);
1627 error = sa_replace_all_by_template_locked(hdl, attr_desc,
1629 mutex_exit(&hdl->sa_lock);
1634 * Add/remove a single attribute or replace a variable-sized attribute value
1635 * with a value of a different size, and then rewrite the entire set
1637 * Same-length attribute value replacement (including fixed-length attributes)
1638 * is handled more efficiently by the upper layers.
1641 sa_modify_attrs(sa_handle_t *hdl, sa_attr_type_t newattr,
1642 sa_data_op_t action, sa_data_locator_t *locator, void *datastart,
1643 uint16_t buflen, dmu_tx_t *tx)
1645 sa_os_t *sa = hdl->sa_os->os_sa;
1646 dmu_buf_impl_t *db = (dmu_buf_impl_t *)hdl->sa_bonus;
1648 sa_bulk_attr_t *attr_desc;
1650 int bonus_attr_count = 0;
1651 int bonus_data_size = 0;
1652 int spill_data_size = 0;
1653 int spill_attr_count = 0;
1655 uint16_t length, reg_length;
1656 int i, j, k, length_idx;
1658 sa_idx_tab_t *idx_tab;
1662 ASSERT(MUTEX_HELD(&hdl->sa_lock));
1664 /* First make of copy of the old data */
1668 if (dn->dn_bonuslen != 0) {
1669 bonus_data_size = hdl->sa_bonus->db_size;
1670 old_data[0] = kmem_alloc(bonus_data_size, KM_SLEEP);
1671 bcopy(hdl->sa_bonus->db_data, old_data[0],
1672 hdl->sa_bonus->db_size);
1673 bonus_attr_count = hdl->sa_bonus_tab->sa_layout->lot_attr_count;
1679 /* Bring spill buffer online if it isn't currently */
1681 if ((error = sa_get_spill(hdl)) == 0) {
1682 spill_data_size = hdl->sa_spill->db_size;
1683 old_data[1] = kmem_alloc(spill_data_size, KM_SLEEP);
1684 bcopy(hdl->sa_spill->db_data, old_data[1],
1685 hdl->sa_spill->db_size);
1687 hdl->sa_spill_tab->sa_layout->lot_attr_count;
1688 } else if (error && error != ENOENT) {
1690 kmem_free(old_data[0], bonus_data_size);
1696 /* build descriptor of all attributes */
1698 attr_count = bonus_attr_count + spill_attr_count;
1699 if (action == SA_ADD)
1701 else if (action == SA_REMOVE)
1704 attr_desc = kmem_zalloc(sizeof (sa_bulk_attr_t) * attr_count, KM_SLEEP);
1707 * loop through bonus and spill buffer if it exists, and
1708 * build up new attr_descriptor to reset the attributes
1711 count = bonus_attr_count;
1712 hdr = SA_GET_HDR(hdl, SA_BONUS);
1713 idx_tab = SA_IDX_TAB_GET(hdl, SA_BONUS);
1714 for (; k != 2; k++) {
1716 * Iterate over each attribute in layout. Fetch the
1717 * size of variable-length attributes needing rewrite
1718 * from sa_lengths[].
1720 for (i = 0, length_idx = 0; i != count; i++) {
1721 sa_attr_type_t attr;
1723 attr = idx_tab->sa_layout->lot_attrs[i];
1724 reg_length = SA_REGISTERED_LEN(sa, attr);
1725 if (reg_length == 0) {
1726 length = hdr->sa_lengths[length_idx];
1729 length = reg_length;
1731 if (attr == newattr) {
1733 * There is nothing to do for SA_REMOVE,
1734 * so it is just skipped.
1736 if (action == SA_REMOVE)
1740 * Duplicate attributes are not allowed, so the
1741 * action can not be SA_ADD here.
1743 ASSERT3S(action, ==, SA_REPLACE);
1746 * Only a variable-sized attribute can be
1747 * replaced here, and its size must be changing.
1749 ASSERT3U(reg_length, ==, 0);
1750 ASSERT3U(length, !=, buflen);
1751 SA_ADD_BULK_ATTR(attr_desc, j, attr,
1752 locator, datastart, buflen);
1754 SA_ADD_BULK_ATTR(attr_desc, j, attr,
1756 (TOC_OFF(idx_tab->sa_idx_tab[attr]) +
1757 (uintptr_t)old_data[k]), length);
1760 if (k == 0 && hdl->sa_spill) {
1761 hdr = SA_GET_HDR(hdl, SA_SPILL);
1762 idx_tab = SA_IDX_TAB_GET(hdl, SA_SPILL);
1763 count = spill_attr_count;
1768 if (action == SA_ADD) {
1769 reg_length = SA_REGISTERED_LEN(sa, newattr);
1770 IMPLY(reg_length != 0, reg_length == buflen);
1771 SA_ADD_BULK_ATTR(attr_desc, j, newattr, locator,
1774 ASSERT3U(j, ==, attr_count);
1776 error = sa_build_layouts(hdl, attr_desc, attr_count, tx);
1779 kmem_free(old_data[0], bonus_data_size);
1781 kmem_free(old_data[1], spill_data_size);
1782 kmem_free(attr_desc, sizeof (sa_bulk_attr_t) * attr_count);
1788 sa_bulk_update_impl(sa_handle_t *hdl, sa_bulk_attr_t *bulk, int count,
1792 sa_os_t *sa = hdl->sa_os->os_sa;
1793 dmu_object_type_t bonustype;
1795 bonustype = SA_BONUSTYPE_FROM_DB(SA_GET_DB(hdl, SA_BONUS));
1798 ASSERT(MUTEX_HELD(&hdl->sa_lock));
1800 /* sync out registration table if necessary */
1801 if (sa->sa_need_attr_registration)
1802 sa_attr_register_sync(hdl, tx);
1804 error = sa_attr_op(hdl, bulk, count, SA_UPDATE, tx);
1805 if (error == 0 && !IS_SA_BONUSTYPE(bonustype) && sa->sa_update_cb)
1806 sa->sa_update_cb(hdl, tx);
1812 * update or add new attribute
1815 sa_update(sa_handle_t *hdl, sa_attr_type_t type,
1816 void *buf, uint32_t buflen, dmu_tx_t *tx)
1819 sa_bulk_attr_t bulk;
1821 bulk.sa_attr = type;
1822 bulk.sa_data_func = NULL;
1823 bulk.sa_length = buflen;
1826 mutex_enter(&hdl->sa_lock);
1827 error = sa_bulk_update_impl(hdl, &bulk, 1, tx);
1828 mutex_exit(&hdl->sa_lock);
1833 sa_update_from_cb(sa_handle_t *hdl, sa_attr_type_t attr,
1834 uint32_t buflen, sa_data_locator_t *locator, void *userdata, dmu_tx_t *tx)
1837 sa_bulk_attr_t bulk;
1839 bulk.sa_attr = attr;
1840 bulk.sa_data = userdata;
1841 bulk.sa_data_func = locator;
1842 bulk.sa_length = buflen;
1844 mutex_enter(&hdl->sa_lock);
1845 error = sa_bulk_update_impl(hdl, &bulk, 1, tx);
1846 mutex_exit(&hdl->sa_lock);
1851 * Return size of an attribute
1855 sa_size(sa_handle_t *hdl, sa_attr_type_t attr, int *size)
1857 sa_bulk_attr_t bulk;
1860 bulk.sa_data = NULL;
1861 bulk.sa_attr = attr;
1862 bulk.sa_data_func = NULL;
1865 mutex_enter(&hdl->sa_lock);
1866 if ((error = sa_attr_op(hdl, &bulk, 1, SA_LOOKUP, NULL)) != 0) {
1867 mutex_exit(&hdl->sa_lock);
1870 *size = bulk.sa_size;
1872 mutex_exit(&hdl->sa_lock);
1877 sa_bulk_lookup_locked(sa_handle_t *hdl, sa_bulk_attr_t *attrs, int count)
1880 ASSERT(MUTEX_HELD(&hdl->sa_lock));
1881 return (sa_lookup_impl(hdl, attrs, count));
1885 sa_bulk_lookup(sa_handle_t *hdl, sa_bulk_attr_t *attrs, int count)
1890 mutex_enter(&hdl->sa_lock);
1891 error = sa_bulk_lookup_locked(hdl, attrs, count);
1892 mutex_exit(&hdl->sa_lock);
1897 sa_bulk_update(sa_handle_t *hdl, sa_bulk_attr_t *attrs, int count, dmu_tx_t *tx)
1902 mutex_enter(&hdl->sa_lock);
1903 error = sa_bulk_update_impl(hdl, attrs, count, tx);
1904 mutex_exit(&hdl->sa_lock);
1909 sa_remove(sa_handle_t *hdl, sa_attr_type_t attr, dmu_tx_t *tx)
1913 mutex_enter(&hdl->sa_lock);
1914 error = sa_modify_attrs(hdl, attr, SA_REMOVE, NULL,
1916 mutex_exit(&hdl->sa_lock);
1921 sa_object_info(sa_handle_t *hdl, dmu_object_info_t *doi)
1923 dmu_object_info_from_db((dmu_buf_t *)hdl->sa_bonus, doi);
1927 sa_object_size(sa_handle_t *hdl, uint32_t *blksize, u_longlong_t *nblocks)
1929 dmu_object_size_from_db((dmu_buf_t *)hdl->sa_bonus,
1934 sa_set_userp(sa_handle_t *hdl, void *ptr)
1936 hdl->sa_userp = ptr;
1940 sa_get_db(sa_handle_t *hdl)
1942 return ((dmu_buf_t *)hdl->sa_bonus);
1946 sa_get_userdata(sa_handle_t *hdl)
1948 return (hdl->sa_userp);
1952 sa_register_update_callback_locked(objset_t *os, sa_update_cb_t *func)
1954 ASSERT(MUTEX_HELD(&os->os_sa->sa_lock));
1955 os->os_sa->sa_update_cb = func;
1959 sa_register_update_callback(objset_t *os, sa_update_cb_t *func)
1962 mutex_enter(&os->os_sa->sa_lock);
1963 sa_register_update_callback_locked(os, func);
1964 mutex_exit(&os->os_sa->sa_lock);
1968 sa_handle_object(sa_handle_t *hdl)
1970 return (hdl->sa_bonus->db_object);
1974 sa_enabled(objset_t *os)
1976 return (os->os_sa == NULL);
1980 sa_set_sa_object(objset_t *os, uint64_t sa_object)
1982 sa_os_t *sa = os->os_sa;
1984 if (sa->sa_master_obj)
1987 sa->sa_master_obj = sa_object;
1993 sa_hdrsize(void *arg)
1995 sa_hdr_phys_t *hdr = arg;
1997 return (SA_HDR_SIZE(hdr));
2001 sa_handle_lock(sa_handle_t *hdl)
2004 mutex_enter(&hdl->sa_lock);
2008 sa_handle_unlock(sa_handle_t *hdl)
2011 mutex_exit(&hdl->sa_lock);