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 * Copyright (c) 2012 by Delphix. All rights reserved.
27 #include <sys/zfs_context.h>
28 #include <sys/types.h>
29 #include <sys/param.h>
30 #include <sys/systm.h>
31 #include <sys/sysmacros.h>
33 #include <sys/dmu_impl.h>
34 #include <sys/dmu_objset.h>
36 #include <sys/dnode.h>
39 #include <sys/sunddi.h>
40 #include <sys/sa_impl.h>
41 #include <sys/dnode.h>
42 #include <sys/errno.h>
43 #include <sys/zfs_context.h>
46 * ZFS System attributes:
48 * A generic mechanism to allow for arbitrary attributes
49 * to be stored in a dnode. The data will be stored in the bonus buffer of
50 * the dnode and if necessary a special "spill" block will be used to handle
51 * overflow situations. The spill block will be sized to fit the data
52 * from 512 - 128K. When a spill block is used the BP (blkptr_t) for the
53 * spill block is stored at the end of the current bonus buffer. Any
54 * attributes that would be in the way of the blkptr_t will be relocated
55 * into the spill block.
57 * Attribute registration:
59 * Stored persistently on a per dataset basis
60 * a mapping between attribute "string" names and their actual attribute
61 * numeric values, length, and byteswap function. The names are only used
62 * during registration. All attributes are known by their unique attribute
63 * id value. If an attribute can have a variable size then the value
64 * 0 will be used to indicate this.
68 * Attribute layouts are a way to compactly store multiple attributes, but
69 * without taking the overhead associated with managing each attribute
70 * individually. Since you will typically have the same set of attributes
71 * stored in the same order a single table will be used to represent that
72 * layout. The ZPL for example will usually have only about 10 different
73 * layouts (regular files, device files, symlinks,
74 * regular files + scanstamp, files/dir with extended attributes, and then
75 * you have the possibility of all of those minus ACL, because it would
76 * be kicked out into the spill block)
78 * Layouts are simply an array of the attributes and their
79 * ordering i.e. [0, 1, 4, 5, 2]
81 * Each distinct layout is given a unique layout number and that is whats
82 * stored in the header at the beginning of the SA data buffer.
84 * A layout only covers a single dbuf (bonus or spill). If a set of
85 * attributes is split up between the bonus buffer and a spill buffer then
86 * two different layouts will be used. This allows us to byteswap the
87 * spill without looking at the bonus buffer and keeps the on disk format of
88 * the bonus and spill buffer the same.
90 * Adding a single attribute will cause the entire set of attributes to
91 * be rewritten and could result in a new layout number being constructed
92 * as part of the rewrite if no such layout exists for the new set of
93 * attribues. The new attribute will be appended to the end of the already
94 * existing attributes.
96 * Both the attribute registration and attribute layout information are
97 * stored in normal ZAP attributes. Their should be a small number of
98 * known layouts and the set of attributes is assumed to typically be quite
101 * The registered attributes and layout "table" information is maintained
102 * in core and a special "sa_os_t" is attached to the objset_t.
104 * A special interface is provided to allow for quickly applying
105 * a large set of attributes at once. sa_replace_all_by_template() is
106 * used to set an array of attributes. This is used by the ZPL when
107 * creating a brand new file. The template that is passed into the function
108 * specifies the attribute, size for variable length attributes, location of
109 * data and special "data locator" function if the data isn't in a contiguous
112 * Byteswap implications:
113 * Since the SA attributes are not entirely self describing we can't do
114 * the normal byteswap processing. The special ZAP layout attribute and
115 * attribute registration attributes define the byteswap function and the
116 * size of the attributes, unless it is variable sized.
117 * The normal ZFS byteswapping infrastructure assumes you don't need
118 * to read any objects in order to do the necessary byteswapping. Whereas
119 * SA attributes can only be properly byteswapped if the dataset is opened
120 * and the layout/attribute ZAP attributes are available. Because of this
121 * the SA attributes will be byteswapped when they are first accessed by
122 * the SA code that will read the SA data.
125 typedef void (sa_iterfunc_t)(void *hdr, void *addr, sa_attr_type_t,
126 uint16_t length, int length_idx, boolean_t, void *userp);
128 static int sa_build_index(sa_handle_t *hdl, sa_buf_type_t buftype);
129 static void sa_idx_tab_hold(objset_t *os, sa_idx_tab_t *idx_tab);
130 static void *sa_find_idx_tab(objset_t *os, dmu_object_type_t bonustype,
132 static void sa_idx_tab_rele(objset_t *os, void *arg);
133 static void sa_copy_data(sa_data_locator_t *func, void *start, void *target,
135 static int sa_modify_attrs(sa_handle_t *hdl, sa_attr_type_t newattr,
136 sa_data_op_t action, sa_data_locator_t *locator, void *datastart,
137 uint16_t buflen, dmu_tx_t *tx);
139 arc_byteswap_func_t *sa_bswap_table[] = {
140 byteswap_uint64_array,
141 byteswap_uint32_array,
142 byteswap_uint16_array,
143 byteswap_uint8_array,
147 #define SA_COPY_DATA(f, s, t, l) \
151 *(uint64_t *)t = *(uint64_t *)s; \
152 } else if (l == 16) { \
153 *(uint64_t *)t = *(uint64_t *)s; \
154 *(uint64_t *)((uintptr_t)t + 8) = \
155 *(uint64_t *)((uintptr_t)s + 8); \
160 sa_copy_data(f, s, t, l); \
164 * This table is fixed and cannot be changed. Its purpose is to
165 * allow the SA code to work with both old/new ZPL file systems.
166 * It contains the list of legacy attributes. These attributes aren't
167 * stored in the "attribute" registry zap objects, since older ZPL file systems
168 * won't have the registry. Only objsets of type ZFS_TYPE_FILESYSTEM will
169 * use this static table.
171 sa_attr_reg_t sa_legacy_attrs[] = {
172 {"ZPL_ATIME", sizeof (uint64_t) * 2, SA_UINT64_ARRAY, 0},
173 {"ZPL_MTIME", sizeof (uint64_t) * 2, SA_UINT64_ARRAY, 1},
174 {"ZPL_CTIME", sizeof (uint64_t) * 2, SA_UINT64_ARRAY, 2},
175 {"ZPL_CRTIME", sizeof (uint64_t) * 2, SA_UINT64_ARRAY, 3},
176 {"ZPL_GEN", sizeof (uint64_t), SA_UINT64_ARRAY, 4},
177 {"ZPL_MODE", sizeof (uint64_t), SA_UINT64_ARRAY, 5},
178 {"ZPL_SIZE", sizeof (uint64_t), SA_UINT64_ARRAY, 6},
179 {"ZPL_PARENT", sizeof (uint64_t), SA_UINT64_ARRAY, 7},
180 {"ZPL_LINKS", sizeof (uint64_t), SA_UINT64_ARRAY, 8},
181 {"ZPL_XATTR", sizeof (uint64_t), SA_UINT64_ARRAY, 9},
182 {"ZPL_RDEV", sizeof (uint64_t), SA_UINT64_ARRAY, 10},
183 {"ZPL_FLAGS", sizeof (uint64_t), SA_UINT64_ARRAY, 11},
184 {"ZPL_UID", sizeof (uint64_t), SA_UINT64_ARRAY, 12},
185 {"ZPL_GID", sizeof (uint64_t), SA_UINT64_ARRAY, 13},
186 {"ZPL_PAD", sizeof (uint64_t) * 4, SA_UINT64_ARRAY, 14},
187 {"ZPL_ZNODE_ACL", 88, SA_UINT8_ARRAY, 15},
192 * This is only used for objects of type DMU_OT_ZNODE
194 sa_attr_type_t sa_legacy_zpl_layout[] = {
195 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
199 * 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;
206 static kmem_cache_t *spill_cache = NULL;
210 sa_cache_constructor(void *buf, void *unused, int kmflag)
212 sa_handle_t *hdl = buf;
214 hdl->sa_bonus_tab = NULL;
215 hdl->sa_spill_tab = NULL;
217 hdl->sa_userp = NULL;
218 hdl->sa_bonus = NULL;
219 hdl->sa_spill = NULL;
220 mutex_init(&hdl->sa_lock, NULL, MUTEX_DEFAULT, NULL);
226 sa_cache_destructor(void *buf, void *unused)
228 sa_handle_t *hdl = buf;
229 mutex_destroy(&hdl->sa_lock);
235 sa_cache = kmem_cache_create("sa_cache",
236 sizeof (sa_handle_t), 0, sa_cache_constructor,
237 sa_cache_destructor, NULL, NULL, NULL, 0);
238 spill_cache = kmem_cache_create("spill_cache",
239 SPA_MAXBLOCKSIZE, 0, NULL, NULL, NULL, NULL, NULL, 0);
246 kmem_cache_destroy(sa_cache);
249 kmem_cache_destroy(spill_cache);
253 sa_spill_alloc(int flags)
255 return kmem_cache_alloc(spill_cache, flags);
259 sa_spill_free(void *obj)
261 kmem_cache_free(spill_cache, obj);
265 layout_num_compare(const void *arg1, const void *arg2)
267 const sa_lot_t *node1 = arg1;
268 const sa_lot_t *node2 = arg2;
270 if (node1->lot_num > node2->lot_num)
272 else if (node1->lot_num < node2->lot_num)
278 layout_hash_compare(const void *arg1, const void *arg2)
280 const sa_lot_t *node1 = arg1;
281 const sa_lot_t *node2 = arg2;
283 if (node1->lot_hash > node2->lot_hash)
285 if (node1->lot_hash < node2->lot_hash)
287 if (node1->lot_instance > node2->lot_instance)
289 if (node1->lot_instance < node2->lot_instance)
295 sa_layout_equal(sa_lot_t *tbf, sa_attr_type_t *attrs, int count)
299 if (count != tbf->lot_attr_count)
302 for (i = 0; i != count; i++) {
303 if (attrs[i] != tbf->lot_attrs[i])
309 #define SA_ATTR_HASH(attr) (zfs_crc64_table[(-1ULL ^ attr) & 0xFF])
312 sa_layout_info_hash(sa_attr_type_t *attrs, int attr_count)
315 uint64_t crc = -1ULL;
317 for (i = 0; i != attr_count; i++)
318 crc ^= SA_ATTR_HASH(attrs[i]);
324 sa_get_spill(sa_handle_t *hdl)
327 if (hdl->sa_spill == NULL) {
328 if ((rc = dmu_spill_hold_existing(hdl->sa_bonus, NULL,
329 &hdl->sa_spill)) == 0)
330 VERIFY(0 == sa_build_index(hdl, SA_SPILL));
339 * Main attribute lookup/update function
340 * returns 0 for success or non zero for failures
342 * Operates on bulk array, first failure will abort further processing
345 sa_attr_op(sa_handle_t *hdl, sa_bulk_attr_t *bulk, int count,
346 sa_data_op_t data_op, dmu_tx_t *tx)
348 sa_os_t *sa = hdl->sa_os->os_sa;
351 sa_buf_type_t buftypes;
356 for (i = 0; i != count; i++) {
357 ASSERT(bulk[i].sa_attr <= hdl->sa_os->os_sa->sa_num_attrs);
359 bulk[i].sa_addr = NULL;
360 /* First check the bonus buffer */
362 if (hdl->sa_bonus_tab && TOC_ATTR_PRESENT(
363 hdl->sa_bonus_tab->sa_idx_tab[bulk[i].sa_attr])) {
364 SA_ATTR_INFO(sa, hdl->sa_bonus_tab,
365 SA_GET_HDR(hdl, SA_BONUS),
366 bulk[i].sa_attr, bulk[i], SA_BONUS, hdl);
367 if (tx && !(buftypes & SA_BONUS)) {
368 dmu_buf_will_dirty(hdl->sa_bonus, tx);
369 buftypes |= SA_BONUS;
372 if (bulk[i].sa_addr == NULL &&
373 ((error = sa_get_spill(hdl)) == 0)) {
374 if (TOC_ATTR_PRESENT(
375 hdl->sa_spill_tab->sa_idx_tab[bulk[i].sa_attr])) {
376 SA_ATTR_INFO(sa, hdl->sa_spill_tab,
377 SA_GET_HDR(hdl, SA_SPILL),
378 bulk[i].sa_attr, bulk[i], SA_SPILL, hdl);
379 if (tx && !(buftypes & SA_SPILL) &&
380 bulk[i].sa_size == bulk[i].sa_length) {
381 dmu_buf_will_dirty(hdl->sa_spill, tx);
382 buftypes |= SA_SPILL;
386 if (error && error != ENOENT) {
387 return ((error == ECKSUM) ? EIO : error);
392 if (bulk[i].sa_addr == NULL)
394 if (bulk[i].sa_data) {
395 SA_COPY_DATA(bulk[i].sa_data_func,
396 bulk[i].sa_addr, bulk[i].sa_data,
402 /* existing rewrite of attr */
403 if (bulk[i].sa_addr &&
404 bulk[i].sa_size == bulk[i].sa_length) {
405 SA_COPY_DATA(bulk[i].sa_data_func,
406 bulk[i].sa_data, bulk[i].sa_addr,
409 } else if (bulk[i].sa_addr) { /* attr size change */
410 error = sa_modify_attrs(hdl, bulk[i].sa_attr,
411 SA_REPLACE, bulk[i].sa_data_func,
412 bulk[i].sa_data, bulk[i].sa_length, tx);
413 } else { /* adding new attribute */
414 error = sa_modify_attrs(hdl, bulk[i].sa_attr,
415 SA_ADD, bulk[i].sa_data_func,
416 bulk[i].sa_data, bulk[i].sa_length, tx);
429 sa_add_layout_entry(objset_t *os, sa_attr_type_t *attrs, int attr_count,
430 uint64_t lot_num, uint64_t hash, boolean_t zapadd, dmu_tx_t *tx)
432 sa_os_t *sa = os->os_sa;
433 sa_lot_t *tb, *findtb;
437 ASSERT(MUTEX_HELD(&sa->sa_lock));
438 tb = kmem_zalloc(sizeof (sa_lot_t), KM_PUSHPAGE);
439 tb->lot_attr_count = attr_count;
440 tb->lot_attrs = kmem_alloc(sizeof (sa_attr_type_t) * attr_count,
442 bcopy(attrs, tb->lot_attrs, sizeof (sa_attr_type_t) * attr_count);
443 tb->lot_num = lot_num;
445 tb->lot_instance = 0;
450 if (sa->sa_layout_attr_obj == 0) {
451 sa->sa_layout_attr_obj = zap_create_link(os,
452 DMU_OT_SA_ATTR_LAYOUTS,
453 sa->sa_master_obj, SA_LAYOUTS, tx);
456 (void) snprintf(attr_name, sizeof (attr_name),
458 VERIFY(0 == zap_update(os, os->os_sa->sa_layout_attr_obj,
459 attr_name, 2, attr_count, attrs, tx));
462 list_create(&tb->lot_idx_tab, sizeof (sa_idx_tab_t),
463 offsetof(sa_idx_tab_t, sa_next));
465 for (i = 0; i != attr_count; i++) {
466 if (sa->sa_attr_table[tb->lot_attrs[i]].sa_length == 0)
470 avl_add(&sa->sa_layout_num_tree, tb);
472 /* verify we don't have a hash collision */
473 if ((findtb = avl_find(&sa->sa_layout_hash_tree, tb, &loc)) != NULL) {
474 for (; findtb && findtb->lot_hash == hash;
475 findtb = AVL_NEXT(&sa->sa_layout_hash_tree, findtb)) {
476 if (findtb->lot_instance != tb->lot_instance)
481 avl_add(&sa->sa_layout_hash_tree, tb);
486 sa_find_layout(objset_t *os, uint64_t hash, sa_attr_type_t *attrs,
487 int count, dmu_tx_t *tx, sa_lot_t **lot)
489 sa_lot_t *tb, tbsearch;
491 sa_os_t *sa = os->os_sa;
492 boolean_t found = B_FALSE;
494 mutex_enter(&sa->sa_lock);
495 tbsearch.lot_hash = hash;
496 tbsearch.lot_instance = 0;
497 tb = avl_find(&sa->sa_layout_hash_tree, &tbsearch, &loc);
499 for (; tb && tb->lot_hash == hash;
500 tb = AVL_NEXT(&sa->sa_layout_hash_tree, tb)) {
501 if (sa_layout_equal(tb, attrs, count) == 0) {
508 tb = sa_add_layout_entry(os, attrs, count,
509 avl_numnodes(&sa->sa_layout_num_tree), hash, B_TRUE, tx);
511 mutex_exit(&sa->sa_lock);
516 sa_resize_spill(sa_handle_t *hdl, uint32_t size, dmu_tx_t *tx)
522 blocksize = SPA_MINBLOCKSIZE;
523 } else if (size > SPA_MAXBLOCKSIZE) {
527 blocksize = P2ROUNDUP_TYPED(size, SPA_MINBLOCKSIZE, uint32_t);
530 error = dbuf_spill_set_blksz(hdl->sa_spill, blocksize, tx);
536 sa_copy_data(sa_data_locator_t *func, void *datastart, void *target, int buflen)
539 bcopy(datastart, target, buflen);
544 void *saptr = target;
549 while (bytes < buflen) {
550 func(&dataptr, &length, buflen, start, datastart);
551 bcopy(dataptr, saptr, length);
552 saptr = (void *)((caddr_t)saptr + length);
560 * Determine several different sizes
561 * first the sa header size
562 * the number of bytes to be stored
563 * if spill would occur the index in the attribute array is returned
565 * the boolean will_spill will be set when spilling is necessary. It
566 * is only set when the buftype is SA_BONUS
569 sa_find_sizes(sa_os_t *sa, sa_bulk_attr_t *attr_desc, int attr_count,
570 dmu_buf_t *db, sa_buf_type_t buftype, int *index, int *total,
571 boolean_t *will_spill)
577 boolean_t done = B_FALSE;
579 if (buftype == SA_BONUS && sa->sa_force_spill) {
582 *will_spill = B_TRUE;
589 if (buftype == SA_BONUS)
590 *will_spill = B_FALSE;
592 hdrsize = (SA_BONUSTYPE_FROM_DB(db) == DMU_OT_ZNODE) ? 0 :
593 sizeof (sa_hdr_phys_t);
595 full_space = (buftype == SA_BONUS) ? DN_MAX_BONUSLEN : db->db_size;
596 ASSERT(IS_P2ALIGNED(full_space, 8));
598 for (i = 0; i != attr_count; i++) {
601 *total = P2ROUNDUP(*total, 8);
602 *total += attr_desc[i].sa_length;
606 is_var_sz = (SA_REGISTERED_LEN(sa, attr_desc[i].sa_attr) == 0);
611 if (is_var_sz && var_size > 1) {
612 if (P2ROUNDUP(hdrsize + sizeof (uint16_t), 8) +
613 *total < full_space) {
614 hdrsize += sizeof (uint16_t);
618 if (buftype == SA_BONUS)
619 *will_spill = B_TRUE;
625 * find index of where spill *could* occur.
626 * Then continue to count of remainder attribute
627 * space. The sum is used later for sizing bonus
630 if (buftype == SA_BONUS && *index == -1 &&
631 (*total + P2ROUNDUP(hdrsize, 8)) >
632 (full_space - sizeof (blkptr_t))) {
638 if ((*total + P2ROUNDUP(hdrsize, 8)) > full_space &&
640 *will_spill = B_TRUE;
643 hdrsize = P2ROUNDUP(hdrsize, 8);
647 #define BUF_SPACE_NEEDED(total, header) (total + header)
650 * Find layout that corresponds to ordering of attributes
651 * If not found a new layout number is created and added to
652 * persistent layout tables.
655 sa_build_layouts(sa_handle_t *hdl, sa_bulk_attr_t *attr_desc, int attr_count,
658 sa_os_t *sa = hdl->sa_os->os_sa;
660 sa_buf_type_t buftype;
661 sa_hdr_phys_t *sahdr;
664 sa_attr_type_t *attrs, *attrs_start;
666 int hdrsize, spillhdrsize = 0;
668 dmu_object_type_t bonustype;
674 dmu_buf_will_dirty(hdl->sa_bonus, tx);
675 bonustype = SA_BONUSTYPE_FROM_DB(hdl->sa_bonus);
677 /* first determine bonus header size and sum of all attributes */
678 hdrsize = sa_find_sizes(sa, attr_desc, attr_count, hdl->sa_bonus,
679 SA_BONUS, &i, &used, &spilling);
681 if (used > SPA_MAXBLOCKSIZE)
684 VERIFY(0 == dmu_set_bonus(hdl->sa_bonus, spilling ?
685 MIN(DN_MAX_BONUSLEN - sizeof (blkptr_t), used + hdrsize) :
686 used + hdrsize, tx));
688 ASSERT((bonustype == DMU_OT_ZNODE && spilling == 0) ||
689 bonustype == DMU_OT_SA);
691 /* setup and size spill buffer when needed */
695 if (hdl->sa_spill == NULL) {
696 VERIFY(dmu_spill_hold_by_bonus(hdl->sa_bonus, NULL,
697 &hdl->sa_spill) == 0);
699 dmu_buf_will_dirty(hdl->sa_spill, tx);
701 spillhdrsize = sa_find_sizes(sa, &attr_desc[i],
702 attr_count - i, hdl->sa_spill, SA_SPILL, &i,
703 &spill_used, &dummy);
705 if (spill_used > SPA_MAXBLOCKSIZE)
708 buf_space = hdl->sa_spill->db_size - spillhdrsize;
709 if (BUF_SPACE_NEEDED(spill_used, spillhdrsize) >
710 hdl->sa_spill->db_size)
711 VERIFY(0 == sa_resize_spill(hdl,
712 BUF_SPACE_NEEDED(spill_used, spillhdrsize), tx));
715 /* setup starting pointers to lay down data */
716 data_start = (void *)((uintptr_t)hdl->sa_bonus->db_data + hdrsize);
717 sahdr = (sa_hdr_phys_t *)hdl->sa_bonus->db_data;
721 buf_space = (sa->sa_force_spill) ?
722 0 : SA_BLKPTR_SPACE - hdrsize;
724 buf_space = hdl->sa_bonus->db_size - hdrsize;
726 attrs_start = attrs = kmem_alloc(sizeof (sa_attr_type_t) * attr_count,
730 for (i = 0, len_idx = 0, hash = -1ULL; i != attr_count; i++) {
733 ASSERT(IS_P2ALIGNED(data_start, 8));
734 ASSERT(IS_P2ALIGNED(buf_space, 8));
735 attrs[i] = attr_desc[i].sa_attr;
736 length = SA_REGISTERED_LEN(sa, attrs[i]);
738 length = attr_desc[i].sa_length;
740 if (buf_space < length) { /* switch to spill buffer */
742 VERIFY(bonustype == DMU_OT_SA);
743 if (buftype == SA_BONUS && !sa->sa_force_spill) {
744 sa_find_layout(hdl->sa_os, hash, attrs_start,
745 lot_count, tx, &lot);
746 SA_SET_HDR(sahdr, lot->lot_num, hdrsize);
753 sahdr = (sa_hdr_phys_t *)hdl->sa_spill->db_data;
754 sahdr->sa_magic = SA_MAGIC;
755 data_start = (void *)((uintptr_t)sahdr +
757 attrs_start = &attrs[i];
758 buf_space = hdl->sa_spill->db_size - spillhdrsize;
761 hash ^= SA_ATTR_HASH(attrs[i]);
762 attr_desc[i].sa_addr = data_start;
763 attr_desc[i].sa_size = length;
764 SA_COPY_DATA(attr_desc[i].sa_data_func, attr_desc[i].sa_data,
766 if (sa->sa_attr_table[attrs[i]].sa_length == 0) {
767 sahdr->sa_lengths[len_idx++] = length;
769 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_PUSHPAGE);
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)) {
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);
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_PUSHPAGE);
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_PUSHPAGE);
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_PUSHPAGE);
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_lock);
1008 mutex_enter(&os->os_sa->sa_lock);
1009 mutex_exit(&os->os_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_PUSHPAGE);
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_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)) {
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_PUSHPAGE);
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 kmem_free(sa, sizeof (sa_os_t));
1115 return ((error == ECKSUM) ? EIO : error);
1119 sa_tear_down(objset_t *os)
1121 sa_os_t *sa = os->os_sa;
1125 kmem_free(sa->sa_user_table, sa->sa_user_table_sz);
1127 /* Free up attr table */
1129 sa_free_attr_table(sa);
1132 while ((layout = avl_destroy_nodes(&sa->sa_layout_hash_tree, &cookie))){
1134 while ((tab = list_head(&layout->lot_idx_tab))) {
1135 ASSERT(refcount_count(&tab->sa_refcount));
1136 sa_idx_tab_rele(os, tab);
1141 while ((layout = avl_destroy_nodes(&sa->sa_layout_num_tree, &cookie))){
1142 kmem_free(layout->lot_attrs,
1143 sizeof (sa_attr_type_t) * layout->lot_attr_count);
1144 kmem_free(layout, sizeof (sa_lot_t));
1147 avl_destroy(&sa->sa_layout_hash_tree);
1148 avl_destroy(&sa->sa_layout_num_tree);
1150 kmem_free(sa, sizeof (sa_os_t));
1155 sa_build_idx_tab(void *hdr, void *attr_addr, sa_attr_type_t attr,
1156 uint16_t length, int length_idx, boolean_t var_length, void *userp)
1158 sa_idx_tab_t *idx_tab = userp;
1161 ASSERT(idx_tab->sa_variable_lengths);
1162 idx_tab->sa_variable_lengths[length_idx] = length;
1164 TOC_ATTR_ENCODE(idx_tab->sa_idx_tab[attr], length_idx,
1165 (uint32_t)((uintptr_t)attr_addr - (uintptr_t)hdr));
1169 sa_attr_iter(objset_t *os, sa_hdr_phys_t *hdr, dmu_object_type_t type,
1170 sa_iterfunc_t func, sa_lot_t *tab, void *userp)
1176 sa_os_t *sa = os->os_sa;
1178 uint16_t *length_start = NULL;
1179 uint8_t length_idx = 0;
1182 search.lot_num = SA_LAYOUT_NUM(hdr, type);
1183 tb = avl_find(&sa->sa_layout_num_tree, &search, &loc);
1187 if (IS_SA_BONUSTYPE(type)) {
1188 data_start = (void *)P2ROUNDUP(((uintptr_t)hdr +
1189 offsetof(sa_hdr_phys_t, sa_lengths) +
1190 (sizeof (uint16_t) * tb->lot_var_sizes)), 8);
1191 length_start = hdr->sa_lengths;
1196 for (i = 0; i != tb->lot_attr_count; i++) {
1197 int attr_length, reg_length;
1200 reg_length = sa->sa_attr_table[tb->lot_attrs[i]].sa_length;
1202 attr_length = reg_length;
1205 attr_length = length_start[length_idx];
1206 idx_len = length_idx++;
1209 func(hdr, data_start, tb->lot_attrs[i], attr_length,
1210 idx_len, reg_length == 0 ? B_TRUE : B_FALSE, userp);
1212 data_start = (void *)P2ROUNDUP(((uintptr_t)data_start +
1219 sa_byteswap_cb(void *hdr, void *attr_addr, sa_attr_type_t attr,
1220 uint16_t length, int length_idx, boolean_t variable_length, void *userp)
1222 sa_handle_t *hdl = userp;
1223 sa_os_t *sa = hdl->sa_os->os_sa;
1225 sa_bswap_table[sa->sa_attr_table[attr].sa_byteswap](attr_addr, length);
1229 sa_byteswap(sa_handle_t *hdl, sa_buf_type_t buftype)
1231 sa_hdr_phys_t *sa_hdr_phys = SA_GET_HDR(hdl, buftype);
1233 int num_lengths = 1;
1235 ASSERTV(sa_os_t *sa = hdl->sa_os->os_sa);
1237 ASSERT(MUTEX_HELD(&sa->sa_lock));
1238 if (sa_hdr_phys->sa_magic == SA_MAGIC)
1241 db = SA_GET_DB(hdl, buftype);
1243 if (buftype == SA_SPILL) {
1244 arc_release(db->db_buf, NULL);
1245 arc_buf_thaw(db->db_buf);
1248 sa_hdr_phys->sa_magic = BSWAP_32(sa_hdr_phys->sa_magic);
1249 sa_hdr_phys->sa_layout_info = BSWAP_16(sa_hdr_phys->sa_layout_info);
1252 * Determine number of variable lenghts in header
1253 * The standard 8 byte header has one for free and a
1254 * 16 byte header would have 4 + 1;
1256 if (SA_HDR_SIZE(sa_hdr_phys) > 8)
1257 num_lengths += (SA_HDR_SIZE(sa_hdr_phys) - 8) >> 1;
1258 for (i = 0; i != num_lengths; i++)
1259 sa_hdr_phys->sa_lengths[i] =
1260 BSWAP_16(sa_hdr_phys->sa_lengths[i]);
1262 sa_attr_iter(hdl->sa_os, sa_hdr_phys, DMU_OT_SA,
1263 sa_byteswap_cb, NULL, hdl);
1265 if (buftype == SA_SPILL)
1266 arc_buf_freeze(((dmu_buf_impl_t *)hdl->sa_spill)->db_buf);
1270 sa_build_index(sa_handle_t *hdl, sa_buf_type_t buftype)
1272 sa_hdr_phys_t *sa_hdr_phys;
1273 dmu_buf_impl_t *db = SA_GET_DB(hdl, buftype);
1274 dmu_object_type_t bonustype = SA_BONUSTYPE_FROM_DB(db);
1275 sa_os_t *sa = hdl->sa_os->os_sa;
1276 sa_idx_tab_t *idx_tab;
1278 sa_hdr_phys = SA_GET_HDR(hdl, buftype);
1280 mutex_enter(&sa->sa_lock);
1282 /* Do we need to byteswap? */
1284 /* only check if not old znode */
1285 if (IS_SA_BONUSTYPE(bonustype) && sa_hdr_phys->sa_magic != SA_MAGIC &&
1286 sa_hdr_phys->sa_magic != 0) {
1287 VERIFY(BSWAP_32(sa_hdr_phys->sa_magic) == SA_MAGIC);
1288 sa_byteswap(hdl, buftype);
1291 idx_tab = sa_find_idx_tab(hdl->sa_os, bonustype, sa_hdr_phys);
1293 if (buftype == SA_BONUS)
1294 hdl->sa_bonus_tab = idx_tab;
1296 hdl->sa_spill_tab = idx_tab;
1298 mutex_exit(&sa->sa_lock);
1304 sa_evict(dmu_buf_t *db, void *sap)
1306 panic("evicting sa dbuf %p\n", (void *)db);
1310 sa_idx_tab_rele(objset_t *os, void *arg)
1312 sa_os_t *sa = os->os_sa;
1313 sa_idx_tab_t *idx_tab = arg;
1315 if (idx_tab == NULL)
1318 mutex_enter(&sa->sa_lock);
1319 if (refcount_remove(&idx_tab->sa_refcount, NULL) == 0) {
1320 list_remove(&idx_tab->sa_layout->lot_idx_tab, idx_tab);
1321 if (idx_tab->sa_variable_lengths)
1322 kmem_free(idx_tab->sa_variable_lengths,
1324 idx_tab->sa_layout->lot_var_sizes);
1325 refcount_destroy(&idx_tab->sa_refcount);
1326 kmem_free(idx_tab->sa_idx_tab,
1327 sizeof (uint32_t) * sa->sa_num_attrs);
1328 kmem_free(idx_tab, sizeof (sa_idx_tab_t));
1330 mutex_exit(&sa->sa_lock);
1334 sa_idx_tab_hold(objset_t *os, sa_idx_tab_t *idx_tab)
1336 ASSERTV(sa_os_t *sa = os->os_sa);
1338 ASSERT(MUTEX_HELD(&sa->sa_lock));
1339 (void) refcount_add(&idx_tab->sa_refcount, NULL);
1343 sa_spill_rele(sa_handle_t *hdl)
1345 mutex_enter(&hdl->sa_lock);
1346 if (hdl->sa_spill) {
1347 sa_idx_tab_rele(hdl->sa_os, hdl->sa_spill_tab);
1348 dmu_buf_rele(hdl->sa_spill, NULL);
1349 hdl->sa_spill = NULL;
1350 hdl->sa_spill_tab = NULL;
1352 mutex_exit(&hdl->sa_lock);
1356 sa_handle_destroy(sa_handle_t *hdl)
1358 mutex_enter(&hdl->sa_lock);
1359 (void) dmu_buf_update_user((dmu_buf_t *)hdl->sa_bonus, hdl,
1362 if (hdl->sa_bonus_tab) {
1363 sa_idx_tab_rele(hdl->sa_os, hdl->sa_bonus_tab);
1364 hdl->sa_bonus_tab = NULL;
1366 if (hdl->sa_spill_tab) {
1367 sa_idx_tab_rele(hdl->sa_os, hdl->sa_spill_tab);
1368 hdl->sa_spill_tab = NULL;
1371 dmu_buf_rele(hdl->sa_bonus, NULL);
1374 dmu_buf_rele((dmu_buf_t *)hdl->sa_spill, NULL);
1375 mutex_exit(&hdl->sa_lock);
1377 kmem_cache_free(sa_cache, hdl);
1381 sa_handle_get_from_db(objset_t *os, dmu_buf_t *db, void *userp,
1382 sa_handle_type_t hdl_type, sa_handle_t **handlepp)
1385 sa_handle_t *handle;
1387 dmu_object_info_t doi;
1389 dmu_object_info_from_db(db, &doi);
1390 ASSERT(doi.doi_bonus_type == DMU_OT_SA ||
1391 doi.doi_bonus_type == DMU_OT_ZNODE);
1393 /* find handle, if it exists */
1394 /* if one doesn't exist then create a new one, and initialize it */
1396 handle = (hdl_type == SA_HDL_SHARED) ? dmu_buf_get_user(db) : NULL;
1397 if (handle == NULL) {
1398 sa_handle_t *newhandle;
1399 handle = kmem_cache_alloc(sa_cache, KM_SLEEP);
1400 handle->sa_userp = userp;
1401 handle->sa_bonus = db;
1403 handle->sa_spill = NULL;
1405 error = sa_build_index(handle, SA_BONUS);
1406 newhandle = (hdl_type == SA_HDL_SHARED) ?
1407 dmu_buf_set_user_ie(db, handle,
1408 NULL, sa_evict) : NULL;
1410 if (newhandle != NULL) {
1411 kmem_cache_free(sa_cache, handle);
1421 sa_handle_get(objset_t *objset, uint64_t objid, void *userp,
1422 sa_handle_type_t hdl_type, sa_handle_t **handlepp)
1427 if ((error = dmu_bonus_hold(objset, objid, NULL, &db)))
1430 return (sa_handle_get_from_db(objset, db, userp, hdl_type,
1435 sa_buf_hold(objset_t *objset, uint64_t obj_num, void *tag, dmu_buf_t **db)
1437 return (dmu_bonus_hold(objset, obj_num, tag, db));
1441 sa_buf_rele(dmu_buf_t *db, void *tag)
1443 dmu_buf_rele(db, tag);
1447 sa_lookup_impl(sa_handle_t *hdl, sa_bulk_attr_t *bulk, int count)
1450 ASSERT(MUTEX_HELD(&hdl->sa_lock));
1451 return (sa_attr_op(hdl, bulk, count, SA_LOOKUP, NULL));
1455 sa_lookup(sa_handle_t *hdl, sa_attr_type_t attr, void *buf, uint32_t buflen)
1458 sa_bulk_attr_t bulk;
1460 bulk.sa_attr = attr;
1462 bulk.sa_length = buflen;
1463 bulk.sa_data_func = NULL;
1466 mutex_enter(&hdl->sa_lock);
1467 error = sa_lookup_impl(hdl, &bulk, 1);
1468 mutex_exit(&hdl->sa_lock);
1474 sa_lookup_uio(sa_handle_t *hdl, sa_attr_type_t attr, uio_t *uio)
1477 sa_bulk_attr_t bulk;
1479 bulk.sa_data = NULL;
1480 bulk.sa_attr = attr;
1481 bulk.sa_data_func = NULL;
1485 mutex_enter(&hdl->sa_lock);
1486 if ((error = sa_attr_op(hdl, &bulk, 1, SA_LOOKUP, NULL)) == 0) {
1487 error = uiomove((void *)bulk.sa_addr, MIN(bulk.sa_size,
1488 uio->uio_resid), UIO_READ, uio);
1490 mutex_exit(&hdl->sa_lock);
1496 sa_find_idx_tab(objset_t *os, dmu_object_type_t bonustype, void *data)
1498 sa_idx_tab_t *idx_tab;
1499 sa_hdr_phys_t *hdr = (sa_hdr_phys_t *)data;
1500 sa_os_t *sa = os->os_sa;
1501 sa_lot_t *tb, search;
1505 * Deterimine layout number. If SA node and header == 0 then
1506 * force the index table to the dummy "1" empty layout.
1508 * The layout number would only be zero for a newly created file
1509 * that has not added any attributes yet, or with crypto enabled which
1510 * doesn't write any attributes to the bonus buffer.
1513 search.lot_num = SA_LAYOUT_NUM(hdr, bonustype);
1515 tb = avl_find(&sa->sa_layout_num_tree, &search, &loc);
1517 /* Verify header size is consistent with layout information */
1519 ASSERT((IS_SA_BONUSTYPE(bonustype) &&
1520 SA_HDR_SIZE_MATCH_LAYOUT(hdr, tb)) || !IS_SA_BONUSTYPE(bonustype) ||
1521 (IS_SA_BONUSTYPE(bonustype) && hdr->sa_layout_info == 0));
1524 * See if any of the already existing TOC entries can be reused?
1527 for (idx_tab = list_head(&tb->lot_idx_tab); idx_tab;
1528 idx_tab = list_next(&tb->lot_idx_tab, idx_tab)) {
1529 boolean_t valid_idx = B_TRUE;
1532 if (tb->lot_var_sizes != 0 &&
1533 idx_tab->sa_variable_lengths != NULL) {
1534 for (i = 0; i != tb->lot_var_sizes; i++) {
1535 if (hdr->sa_lengths[i] !=
1536 idx_tab->sa_variable_lengths[i]) {
1537 valid_idx = B_FALSE;
1543 sa_idx_tab_hold(os, idx_tab);
1548 /* No such luck, create a new entry */
1549 idx_tab = kmem_zalloc(sizeof (sa_idx_tab_t), KM_PUSHPAGE);
1550 idx_tab->sa_idx_tab =
1551 kmem_zalloc(sizeof (uint32_t) * sa->sa_num_attrs, KM_PUSHPAGE);
1552 idx_tab->sa_layout = tb;
1553 refcount_create(&idx_tab->sa_refcount);
1554 if (tb->lot_var_sizes)
1555 idx_tab->sa_variable_lengths = kmem_alloc(sizeof (uint16_t) *
1556 tb->lot_var_sizes, KM_PUSHPAGE);
1558 sa_attr_iter(os, hdr, bonustype, sa_build_idx_tab,
1560 sa_idx_tab_hold(os, idx_tab); /* one hold for consumer */
1561 sa_idx_tab_hold(os, idx_tab); /* one for layout */
1562 list_insert_tail(&tb->lot_idx_tab, idx_tab);
1567 sa_default_locator(void **dataptr, uint32_t *len, uint32_t total_len,
1568 boolean_t start, void *userdata)
1572 *dataptr = userdata;
1577 sa_attr_register_sync(sa_handle_t *hdl, dmu_tx_t *tx)
1579 uint64_t attr_value = 0;
1580 sa_os_t *sa = hdl->sa_os->os_sa;
1581 sa_attr_table_t *tb = sa->sa_attr_table;
1584 mutex_enter(&sa->sa_lock);
1586 if (!sa->sa_need_attr_registration || sa->sa_master_obj == 0) {
1587 mutex_exit(&sa->sa_lock);
1591 if (sa->sa_reg_attr_obj == 0) {
1592 sa->sa_reg_attr_obj = zap_create_link(hdl->sa_os,
1593 DMU_OT_SA_ATTR_REGISTRATION,
1594 sa->sa_master_obj, SA_REGISTRY, tx);
1596 for (i = 0; i != sa->sa_num_attrs; i++) {
1597 if (sa->sa_attr_table[i].sa_registered)
1599 ATTR_ENCODE(attr_value, tb[i].sa_attr, tb[i].sa_length,
1601 VERIFY(0 == zap_update(hdl->sa_os, sa->sa_reg_attr_obj,
1602 tb[i].sa_name, 8, 1, &attr_value, tx));
1603 tb[i].sa_registered = B_TRUE;
1605 sa->sa_need_attr_registration = B_FALSE;
1606 mutex_exit(&sa->sa_lock);
1610 * Replace all attributes with attributes specified in template.
1611 * If dnode had a spill buffer then those attributes will be
1612 * also be replaced, possibly with just an empty spill block
1614 * This interface is intended to only be used for bulk adding of
1615 * attributes for a new file. It will also be used by the ZPL
1616 * when converting and old formatted znode to native SA support.
1619 sa_replace_all_by_template_locked(sa_handle_t *hdl, sa_bulk_attr_t *attr_desc,
1620 int attr_count, dmu_tx_t *tx)
1622 sa_os_t *sa = hdl->sa_os->os_sa;
1624 if (sa->sa_need_attr_registration)
1625 sa_attr_register_sync(hdl, tx);
1626 return (sa_build_layouts(hdl, attr_desc, attr_count, tx));
1630 sa_replace_all_by_template(sa_handle_t *hdl, sa_bulk_attr_t *attr_desc,
1631 int attr_count, dmu_tx_t *tx)
1635 mutex_enter(&hdl->sa_lock);
1636 error = sa_replace_all_by_template_locked(hdl, attr_desc,
1638 mutex_exit(&hdl->sa_lock);
1643 * add/remove/replace a single attribute and then rewrite the entire set
1647 sa_modify_attrs(sa_handle_t *hdl, sa_attr_type_t newattr,
1648 sa_data_op_t action, sa_data_locator_t *locator, void *datastart,
1649 uint16_t buflen, dmu_tx_t *tx)
1651 sa_os_t *sa = hdl->sa_os->os_sa;
1652 dmu_buf_impl_t *db = (dmu_buf_impl_t *)hdl->sa_bonus;
1654 sa_bulk_attr_t *attr_desc;
1656 int bonus_attr_count = 0;
1657 int bonus_data_size = 0;
1658 int spill_attr_count = 0;
1661 int i, j, k, length_idx;
1663 sa_idx_tab_t *idx_tab;
1667 ASSERT(MUTEX_HELD(&hdl->sa_lock));
1669 /* First make of copy of the old data */
1673 if (dn->dn_bonuslen != 0) {
1674 bonus_data_size = hdl->sa_bonus->db_size;
1675 old_data[0] = kmem_alloc(bonus_data_size, KM_SLEEP);
1676 bcopy(hdl->sa_bonus->db_data, old_data[0],
1677 hdl->sa_bonus->db_size);
1678 bonus_attr_count = hdl->sa_bonus_tab->sa_layout->lot_attr_count;
1684 /* Bring spill buffer online if it isn't currently */
1686 if ((error = sa_get_spill(hdl)) == 0) {
1687 ASSERT3U(hdl->sa_spill->db_size, <=, SPA_MAXBLOCKSIZE);
1688 old_data[1] = sa_spill_alloc(KM_SLEEP);
1689 bcopy(hdl->sa_spill->db_data, old_data[1],
1690 hdl->sa_spill->db_size);
1692 hdl->sa_spill_tab->sa_layout->lot_attr_count;
1693 } else if (error && error != ENOENT) {
1695 kmem_free(old_data[0], bonus_data_size);
1701 /* build descriptor of all attributes */
1703 attr_count = bonus_attr_count + spill_attr_count;
1704 if (action == SA_ADD)
1706 else if (action == SA_REMOVE)
1709 attr_desc = kmem_zalloc(sizeof (sa_bulk_attr_t) * attr_count, KM_SLEEP);
1712 * loop through bonus and spill buffer if it exists, and
1713 * build up new attr_descriptor to reset the attributes
1716 count = bonus_attr_count;
1717 hdr = SA_GET_HDR(hdl, SA_BONUS);
1718 idx_tab = SA_IDX_TAB_GET(hdl, SA_BONUS);
1719 for (; k != 2; k++) {
1720 /* iterate over each attribute in layout */
1721 for (i = 0, length_idx = 0; i != count; i++) {
1722 sa_attr_type_t attr;
1724 attr = idx_tab->sa_layout->lot_attrs[i];
1725 if (attr == newattr) {
1726 if (action == SA_REMOVE) {
1730 ASSERT(SA_REGISTERED_LEN(sa, attr) == 0);
1731 ASSERT(action == SA_REPLACE);
1732 SA_ADD_BULK_ATTR(attr_desc, j, attr,
1733 locator, datastart, buflen);
1735 length = SA_REGISTERED_LEN(sa, attr);
1737 length = hdr->sa_lengths[length_idx++];
1740 SA_ADD_BULK_ATTR(attr_desc, j, attr,
1742 (TOC_OFF(idx_tab->sa_idx_tab[attr]) +
1743 (uintptr_t)old_data[k]), length);
1746 if (k == 0 && hdl->sa_spill) {
1747 hdr = SA_GET_HDR(hdl, SA_SPILL);
1748 idx_tab = SA_IDX_TAB_GET(hdl, SA_SPILL);
1749 count = spill_attr_count;
1754 if (action == SA_ADD) {
1755 length = SA_REGISTERED_LEN(sa, newattr);
1759 SA_ADD_BULK_ATTR(attr_desc, j, newattr, locator,
1763 error = sa_build_layouts(hdl, attr_desc, attr_count, tx);
1766 kmem_free(old_data[0], bonus_data_size);
1768 sa_spill_free(old_data[1]);
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;
1781 dmu_buf_t *saved_spill;
1784 ASSERT(MUTEX_HELD(&hdl->sa_lock));
1786 bonustype = SA_BONUSTYPE_FROM_DB(SA_GET_DB(hdl, SA_BONUS));
1787 saved_spill = hdl->sa_spill;
1789 /* sync out registration table if necessary */
1790 if (sa->sa_need_attr_registration)
1791 sa_attr_register_sync(hdl, tx);
1793 error = sa_attr_op(hdl, bulk, count, SA_UPDATE, tx);
1794 if (error == 0 && !IS_SA_BONUSTYPE(bonustype) && sa->sa_update_cb)
1795 sa->sa_update_cb(hdl, tx);
1798 * If saved_spill is NULL and current sa_spill is not NULL that
1799 * means we increased the refcount of the spill buffer through
1800 * sa_get_spill() or dmu_spill_hold_by_dnode(). Therefore we
1801 * must release the hold before calling dmu_tx_commit() to avoid
1802 * making a copy of this buffer in dbuf_sync_leaf() due to the
1803 * reference count now being greater than 1.
1805 if (!saved_spill && hdl->sa_spill) {
1806 if (hdl->sa_spill_tab) {
1807 sa_idx_tab_rele(hdl->sa_os, hdl->sa_spill_tab);
1808 hdl->sa_spill_tab = NULL;
1811 dmu_buf_rele((dmu_buf_t *)hdl->sa_spill, NULL);
1812 hdl->sa_spill = NULL;
1819 * update or add new attribute
1822 sa_update(sa_handle_t *hdl, sa_attr_type_t type,
1823 void *buf, uint32_t buflen, dmu_tx_t *tx)
1826 sa_bulk_attr_t bulk;
1828 bulk.sa_attr = type;
1829 bulk.sa_data_func = NULL;
1830 bulk.sa_length = buflen;
1833 mutex_enter(&hdl->sa_lock);
1834 error = sa_bulk_update_impl(hdl, &bulk, 1, tx);
1835 mutex_exit(&hdl->sa_lock);
1840 sa_update_from_cb(sa_handle_t *hdl, sa_attr_type_t attr,
1841 uint32_t buflen, sa_data_locator_t *locator, void *userdata, dmu_tx_t *tx)
1844 sa_bulk_attr_t bulk;
1846 bulk.sa_attr = attr;
1847 bulk.sa_data = userdata;
1848 bulk.sa_data_func = locator;
1849 bulk.sa_length = buflen;
1851 mutex_enter(&hdl->sa_lock);
1852 error = sa_bulk_update_impl(hdl, &bulk, 1, tx);
1853 mutex_exit(&hdl->sa_lock);
1858 * Return size of an attribute
1862 sa_size(sa_handle_t *hdl, sa_attr_type_t attr, int *size)
1864 sa_bulk_attr_t bulk;
1867 bulk.sa_data = NULL;
1868 bulk.sa_attr = attr;
1869 bulk.sa_data_func = NULL;
1872 mutex_enter(&hdl->sa_lock);
1873 if ((error = sa_attr_op(hdl, &bulk, 1, SA_LOOKUP, NULL)) != 0) {
1874 mutex_exit(&hdl->sa_lock);
1877 *size = bulk.sa_size;
1879 mutex_exit(&hdl->sa_lock);
1884 sa_bulk_lookup_locked(sa_handle_t *hdl, sa_bulk_attr_t *attrs, int count)
1887 ASSERT(MUTEX_HELD(&hdl->sa_lock));
1888 return (sa_lookup_impl(hdl, attrs, count));
1892 sa_bulk_lookup(sa_handle_t *hdl, sa_bulk_attr_t *attrs, int count)
1897 mutex_enter(&hdl->sa_lock);
1898 error = sa_bulk_lookup_locked(hdl, attrs, count);
1899 mutex_exit(&hdl->sa_lock);
1904 sa_bulk_update(sa_handle_t *hdl, sa_bulk_attr_t *attrs, int count, dmu_tx_t *tx)
1909 mutex_enter(&hdl->sa_lock);
1910 error = sa_bulk_update_impl(hdl, attrs, count, tx);
1911 mutex_exit(&hdl->sa_lock);
1916 sa_remove(sa_handle_t *hdl, sa_attr_type_t attr, dmu_tx_t *tx)
1920 mutex_enter(&hdl->sa_lock);
1921 error = sa_modify_attrs(hdl, attr, SA_REMOVE, NULL,
1923 mutex_exit(&hdl->sa_lock);
1928 sa_object_info(sa_handle_t *hdl, dmu_object_info_t *doi)
1930 dmu_object_info_from_db((dmu_buf_t *)hdl->sa_bonus, doi);
1934 sa_object_size(sa_handle_t *hdl, uint32_t *blksize, u_longlong_t *nblocks)
1936 dmu_object_size_from_db((dmu_buf_t *)hdl->sa_bonus,
1941 sa_update_user(sa_handle_t *newhdl, sa_handle_t *oldhdl)
1943 (void) dmu_buf_update_user((dmu_buf_t *)newhdl->sa_bonus,
1944 oldhdl, newhdl, NULL, sa_evict);
1945 oldhdl->sa_bonus = NULL;
1949 sa_set_userp(sa_handle_t *hdl, void *ptr)
1951 hdl->sa_userp = ptr;
1955 sa_get_db(sa_handle_t *hdl)
1957 return ((dmu_buf_t *)hdl->sa_bonus);
1961 sa_get_userdata(sa_handle_t *hdl)
1963 return (hdl->sa_userp);
1967 sa_register_update_callback_locked(objset_t *os, sa_update_cb_t *func)
1969 ASSERT(MUTEX_HELD(&os->os_sa->sa_lock));
1970 os->os_sa->sa_update_cb = func;
1974 sa_register_update_callback(objset_t *os, sa_update_cb_t *func)
1977 mutex_enter(&os->os_sa->sa_lock);
1978 sa_register_update_callback_locked(os, func);
1979 mutex_exit(&os->os_sa->sa_lock);
1983 sa_handle_object(sa_handle_t *hdl)
1985 return (hdl->sa_bonus->db_object);
1989 sa_enabled(objset_t *os)
1991 return (os->os_sa == NULL);
1995 sa_set_sa_object(objset_t *os, uint64_t sa_object)
1997 sa_os_t *sa = os->os_sa;
1999 if (sa->sa_master_obj)
2002 sa->sa_master_obj = sa_object;
2008 sa_hdrsize(void *arg)
2010 sa_hdr_phys_t *hdr = arg;
2012 return (SA_HDR_SIZE(hdr));
2016 sa_handle_lock(sa_handle_t *hdl)
2019 mutex_enter(&hdl->sa_lock);
2023 sa_handle_unlock(sa_handle_t *hdl)
2026 mutex_exit(&hdl->sa_lock);
2030 EXPORT_SYMBOL(sa_handle_get);
2031 EXPORT_SYMBOL(sa_handle_get_from_db);
2032 EXPORT_SYMBOL(sa_handle_destroy);
2033 EXPORT_SYMBOL(sa_buf_hold);
2034 EXPORT_SYMBOL(sa_buf_rele);
2035 EXPORT_SYMBOL(sa_spill_rele);
2036 EXPORT_SYMBOL(sa_lookup);
2037 EXPORT_SYMBOL(sa_update);
2038 EXPORT_SYMBOL(sa_remove);
2039 EXPORT_SYMBOL(sa_bulk_lookup);
2040 EXPORT_SYMBOL(sa_bulk_lookup_locked);
2041 EXPORT_SYMBOL(sa_bulk_update);
2042 EXPORT_SYMBOL(sa_size);
2043 EXPORT_SYMBOL(sa_update_from_cb);
2044 EXPORT_SYMBOL(sa_object_info);
2045 EXPORT_SYMBOL(sa_object_size);
2046 EXPORT_SYMBOL(sa_update_user);
2047 EXPORT_SYMBOL(sa_get_userdata);
2048 EXPORT_SYMBOL(sa_set_userp);
2049 EXPORT_SYMBOL(sa_get_db);
2050 EXPORT_SYMBOL(sa_handle_object);
2051 EXPORT_SYMBOL(sa_register_update_callback);
2052 EXPORT_SYMBOL(sa_setup);
2053 EXPORT_SYMBOL(sa_replace_all_by_template);
2054 EXPORT_SYMBOL(sa_replace_all_by_template_locked);
2055 EXPORT_SYMBOL(sa_enabled);
2056 EXPORT_SYMBOL(sa_cache_init);
2057 EXPORT_SYMBOL(sa_cache_fini);
2058 EXPORT_SYMBOL(sa_spill_alloc);
2059 EXPORT_SYMBOL(sa_spill_free);
2060 EXPORT_SYMBOL(sa_set_sa_object);
2061 EXPORT_SYMBOL(sa_hdrsize);
2062 EXPORT_SYMBOL(sa_handle_lock);
2063 EXPORT_SYMBOL(sa_handle_unlock);
2064 EXPORT_SYMBOL(sa_lookup_uio);
2065 #endif /* _KERNEL */