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)
578 boolean_t done = B_FALSE;
580 if (buftype == SA_BONUS && sa->sa_force_spill) {
583 *will_spill = B_TRUE;
590 if (buftype == SA_BONUS)
591 *will_spill = B_FALSE;
593 hdrsize = (SA_BONUSTYPE_FROM_DB(db) == DMU_OT_ZNODE) ? 0 :
594 sizeof (sa_hdr_phys_t);
596 full_space = (buftype == SA_BONUS) ? DN_MAX_BONUSLEN : db->db_size;
597 ASSERT(IS_P2ALIGNED(full_space, 8));
599 for (i = 0; i != attr_count; i++) {
602 *total = P2ROUNDUP(*total, 8);
603 *total += attr_desc[i].sa_length;
607 is_var_sz = (SA_REGISTERED_LEN(sa, attr_desc[i].sa_attr) == 0);
612 if (is_var_sz && var_size > 1) {
613 if (P2ROUNDUP(hdrsize + sizeof (uint16_t), 8) +
614 *total < full_space) {
616 * Account for header space used by array of
617 * optional sizes of variable-length attributes.
618 * Record the index in case this increase needs
619 * to be reversed due to spill-over.
621 hdrsize += sizeof (uint16_t);
626 if (buftype == SA_BONUS)
627 *will_spill = B_TRUE;
633 * find index of where spill *could* occur.
634 * Then continue to count of remainder attribute
635 * space. The sum is used later for sizing bonus
638 if (buftype == SA_BONUS && *index == -1 &&
639 (*total + P2ROUNDUP(hdrsize, 8)) >
640 (full_space - sizeof (blkptr_t))) {
646 if ((*total + P2ROUNDUP(hdrsize, 8)) > full_space &&
648 *will_spill = B_TRUE;
652 * j holds the index of the last variable-sized attribute for
653 * which hdrsize was increased. Reverse the increase if that
654 * attribute will be relocated to the spill block.
656 if (*will_spill && j == *index)
657 hdrsize -= sizeof (uint16_t);
659 hdrsize = P2ROUNDUP(hdrsize, 8);
663 #define BUF_SPACE_NEEDED(total, header) (total + header)
666 * Find layout that corresponds to ordering of attributes
667 * If not found a new layout number is created and added to
668 * persistent layout tables.
671 sa_build_layouts(sa_handle_t *hdl, sa_bulk_attr_t *attr_desc, int attr_count,
674 sa_os_t *sa = hdl->sa_os->os_sa;
676 sa_buf_type_t buftype;
677 sa_hdr_phys_t *sahdr;
680 sa_attr_type_t *attrs, *attrs_start;
682 int hdrsize, spillhdrsize = 0;
684 dmu_object_type_t bonustype;
690 dmu_buf_will_dirty(hdl->sa_bonus, tx);
691 bonustype = SA_BONUSTYPE_FROM_DB(hdl->sa_bonus);
693 /* first determine bonus header size and sum of all attributes */
694 hdrsize = sa_find_sizes(sa, attr_desc, attr_count, hdl->sa_bonus,
695 SA_BONUS, &i, &used, &spilling);
697 if (used > SPA_MAXBLOCKSIZE)
700 VERIFY(0 == dmu_set_bonus(hdl->sa_bonus, spilling ?
701 MIN(DN_MAX_BONUSLEN - sizeof (blkptr_t), used + hdrsize) :
702 used + hdrsize, tx));
704 ASSERT((bonustype == DMU_OT_ZNODE && spilling == 0) ||
705 bonustype == DMU_OT_SA);
707 /* setup and size spill buffer when needed */
711 if (hdl->sa_spill == NULL) {
712 VERIFY(dmu_spill_hold_by_bonus(hdl->sa_bonus, NULL,
713 &hdl->sa_spill) == 0);
715 dmu_buf_will_dirty(hdl->sa_spill, tx);
717 spillhdrsize = sa_find_sizes(sa, &attr_desc[i],
718 attr_count - i, hdl->sa_spill, SA_SPILL, &i,
719 &spill_used, &dummy);
721 if (spill_used > SPA_MAXBLOCKSIZE)
724 buf_space = hdl->sa_spill->db_size - spillhdrsize;
725 if (BUF_SPACE_NEEDED(spill_used, spillhdrsize) >
726 hdl->sa_spill->db_size)
727 VERIFY(0 == sa_resize_spill(hdl,
728 BUF_SPACE_NEEDED(spill_used, spillhdrsize), tx));
731 /* setup starting pointers to lay down data */
732 data_start = (void *)((uintptr_t)hdl->sa_bonus->db_data + hdrsize);
733 sahdr = (sa_hdr_phys_t *)hdl->sa_bonus->db_data;
737 buf_space = (sa->sa_force_spill) ?
738 0 : SA_BLKPTR_SPACE - hdrsize;
740 buf_space = hdl->sa_bonus->db_size - hdrsize;
742 attrs_start = attrs = kmem_alloc(sizeof (sa_attr_type_t) * attr_count,
746 for (i = 0, len_idx = 0, hash = -1ULL; i != attr_count; i++) {
749 ASSERT(IS_P2ALIGNED(data_start, 8));
750 ASSERT(IS_P2ALIGNED(buf_space, 8));
751 attrs[i] = attr_desc[i].sa_attr;
752 length = SA_REGISTERED_LEN(sa, attrs[i]);
754 length = attr_desc[i].sa_length;
756 if (buf_space < length) { /* switch to spill buffer */
758 VERIFY(bonustype == DMU_OT_SA);
759 if (buftype == SA_BONUS && !sa->sa_force_spill) {
760 sa_find_layout(hdl->sa_os, hash, attrs_start,
761 lot_count, tx, &lot);
762 SA_SET_HDR(sahdr, lot->lot_num, hdrsize);
769 sahdr = (sa_hdr_phys_t *)hdl->sa_spill->db_data;
770 sahdr->sa_magic = SA_MAGIC;
771 data_start = (void *)((uintptr_t)sahdr +
773 attrs_start = &attrs[i];
774 buf_space = hdl->sa_spill->db_size - spillhdrsize;
777 hash ^= SA_ATTR_HASH(attrs[i]);
778 attr_desc[i].sa_addr = data_start;
779 attr_desc[i].sa_size = length;
780 SA_COPY_DATA(attr_desc[i].sa_data_func, attr_desc[i].sa_data,
782 if (sa->sa_attr_table[attrs[i]].sa_length == 0) {
783 sahdr->sa_lengths[len_idx++] = length;
785 data_start = (void *)P2ROUNDUP(((uintptr_t)data_start +
787 buf_space -= P2ROUNDUP(length, 8);
791 sa_find_layout(hdl->sa_os, hash, attrs_start, lot_count, tx, &lot);
794 * Verify that old znodes always have layout number 0.
795 * Must be DMU_OT_SA for arbitrary layouts
797 VERIFY((bonustype == DMU_OT_ZNODE && lot->lot_num == 0) ||
798 (bonustype == DMU_OT_SA && lot->lot_num > 1));
800 if (bonustype == DMU_OT_SA) {
801 SA_SET_HDR(sahdr, lot->lot_num,
802 buftype == SA_BONUS ? hdrsize : spillhdrsize);
805 kmem_free(attrs, sizeof (sa_attr_type_t) * attr_count);
806 if (hdl->sa_bonus_tab) {
807 sa_idx_tab_rele(hdl->sa_os, hdl->sa_bonus_tab);
808 hdl->sa_bonus_tab = NULL;
810 if (!sa->sa_force_spill)
811 VERIFY(0 == sa_build_index(hdl, SA_BONUS));
813 sa_idx_tab_rele(hdl->sa_os, hdl->sa_spill_tab);
816 * remove spill block that is no longer needed.
818 dmu_buf_rele(hdl->sa_spill, NULL);
819 hdl->sa_spill = NULL;
820 hdl->sa_spill_tab = NULL;
821 VERIFY(0 == dmu_rm_spill(hdl->sa_os,
822 sa_handle_object(hdl), tx));
824 VERIFY(0 == sa_build_index(hdl, SA_SPILL));
832 sa_free_attr_table(sa_os_t *sa)
836 if (sa->sa_attr_table == NULL)
839 for (i = 0; i != sa->sa_num_attrs; i++) {
840 if (sa->sa_attr_table[i].sa_name)
841 kmem_free(sa->sa_attr_table[i].sa_name,
842 strlen(sa->sa_attr_table[i].sa_name) + 1);
845 kmem_free(sa->sa_attr_table,
846 sizeof (sa_attr_table_t) * sa->sa_num_attrs);
848 sa->sa_attr_table = NULL;
852 sa_attr_table_setup(objset_t *os, sa_attr_reg_t *reg_attrs, int count)
854 sa_os_t *sa = os->os_sa;
855 uint64_t sa_attr_count = 0;
856 uint64_t sa_reg_count = 0;
862 int registered_count = 0;
864 dmu_objset_type_t ostype = dmu_objset_type(os);
867 kmem_zalloc(count * sizeof (sa_attr_type_t), KM_PUSHPAGE);
868 sa->sa_user_table_sz = count * sizeof (sa_attr_type_t);
870 if (sa->sa_reg_attr_obj != 0) {
871 error = zap_count(os, sa->sa_reg_attr_obj,
875 * Make sure we retrieved a count and that it isn't zero
877 if (error || (error == 0 && sa_attr_count == 0)) {
882 sa_reg_count = sa_attr_count;
885 if (ostype == DMU_OST_ZFS && sa_attr_count == 0)
886 sa_attr_count += sa_legacy_attr_count;
888 /* Allocate attribute numbers for attributes that aren't registered */
889 for (i = 0; i != count; i++) {
890 boolean_t found = B_FALSE;
893 if (ostype == DMU_OST_ZFS) {
894 for (j = 0; j != sa_legacy_attr_count; j++) {
895 if (strcmp(reg_attrs[i].sa_name,
896 sa_legacy_attrs[j].sa_name) == 0) {
897 sa->sa_user_table[i] =
898 sa_legacy_attrs[j].sa_attr;
906 if (sa->sa_reg_attr_obj)
907 error = zap_lookup(os, sa->sa_reg_attr_obj,
908 reg_attrs[i].sa_name, 8, 1, &attr_value);
913 sa->sa_user_table[i] = (sa_attr_type_t)sa_attr_count;
917 sa->sa_user_table[i] = ATTR_NUM(attr_value);
924 sa->sa_num_attrs = sa_attr_count;
925 tb = sa->sa_attr_table =
926 kmem_zalloc(sizeof (sa_attr_table_t) * sa_attr_count, KM_PUSHPAGE);
929 * Attribute table is constructed from requested attribute list,
930 * previously foreign registered attributes, and also the legacy
931 * ZPL set of attributes.
934 if (sa->sa_reg_attr_obj) {
935 for (zap_cursor_init(&zc, os, sa->sa_reg_attr_obj);
936 (error = zap_cursor_retrieve(&zc, &za)) == 0;
937 zap_cursor_advance(&zc)) {
939 value = za.za_first_integer;
942 tb[ATTR_NUM(value)].sa_attr = ATTR_NUM(value);
943 tb[ATTR_NUM(value)].sa_length = ATTR_LENGTH(value);
944 tb[ATTR_NUM(value)].sa_byteswap = ATTR_BSWAP(value);
945 tb[ATTR_NUM(value)].sa_registered = B_TRUE;
947 if (tb[ATTR_NUM(value)].sa_name) {
950 tb[ATTR_NUM(value)].sa_name =
951 kmem_zalloc(strlen(za.za_name) +1, KM_PUSHPAGE);
952 (void) strlcpy(tb[ATTR_NUM(value)].sa_name, za.za_name,
953 strlen(za.za_name) +1);
955 zap_cursor_fini(&zc);
957 * Make sure we processed the correct number of registered
960 if (registered_count != sa_reg_count) {
967 if (ostype == DMU_OST_ZFS) {
968 for (i = 0; i != sa_legacy_attr_count; i++) {
971 tb[i].sa_attr = sa_legacy_attrs[i].sa_attr;
972 tb[i].sa_length = sa_legacy_attrs[i].sa_length;
973 tb[i].sa_byteswap = sa_legacy_attrs[i].sa_byteswap;
974 tb[i].sa_registered = B_FALSE;
976 kmem_zalloc(strlen(sa_legacy_attrs[i].sa_name) +1,
978 (void) strlcpy(tb[i].sa_name,
979 sa_legacy_attrs[i].sa_name,
980 strlen(sa_legacy_attrs[i].sa_name) + 1);
984 for (i = 0; i != count; i++) {
985 sa_attr_type_t attr_id;
987 attr_id = sa->sa_user_table[i];
988 if (tb[attr_id].sa_name)
991 tb[attr_id].sa_length = reg_attrs[i].sa_length;
992 tb[attr_id].sa_byteswap = reg_attrs[i].sa_byteswap;
993 tb[attr_id].sa_attr = attr_id;
994 tb[attr_id].sa_name =
995 kmem_zalloc(strlen(reg_attrs[i].sa_name) + 1, KM_PUSHPAGE);
996 (void) strlcpy(tb[attr_id].sa_name, reg_attrs[i].sa_name,
997 strlen(reg_attrs[i].sa_name) + 1);
1000 sa->sa_need_attr_registration =
1001 (sa_attr_count != registered_count);
1005 kmem_free(sa->sa_user_table, count * sizeof (sa_attr_type_t));
1006 sa->sa_user_table = NULL;
1007 sa_free_attr_table(sa);
1008 return ((error != 0) ? error : EINVAL);
1012 sa_setup(objset_t *os, uint64_t sa_obj, sa_attr_reg_t *reg_attrs, int count,
1013 sa_attr_type_t **user_table)
1018 dmu_objset_type_t ostype = dmu_objset_type(os);
1022 mutex_enter(&os->os_lock);
1024 mutex_enter(&os->os_sa->sa_lock);
1025 mutex_exit(&os->os_lock);
1026 tb = os->os_sa->sa_user_table;
1027 mutex_exit(&os->os_sa->sa_lock);
1032 sa = kmem_zalloc(sizeof (sa_os_t), KM_PUSHPAGE);
1033 mutex_init(&sa->sa_lock, NULL, MUTEX_DEFAULT, NULL);
1034 sa->sa_master_obj = sa_obj;
1037 mutex_enter(&sa->sa_lock);
1038 mutex_exit(&os->os_lock);
1039 avl_create(&sa->sa_layout_num_tree, layout_num_compare,
1040 sizeof (sa_lot_t), offsetof(sa_lot_t, lot_num_node));
1041 avl_create(&sa->sa_layout_hash_tree, layout_hash_compare,
1042 sizeof (sa_lot_t), offsetof(sa_lot_t, lot_hash_node));
1045 error = zap_lookup(os, sa_obj, SA_LAYOUTS,
1046 8, 1, &sa->sa_layout_attr_obj);
1047 if (error != 0 && error != ENOENT)
1049 error = zap_lookup(os, sa_obj, SA_REGISTRY,
1050 8, 1, &sa->sa_reg_attr_obj);
1051 if (error != 0 && error != ENOENT)
1055 if ((error = sa_attr_table_setup(os, reg_attrs, count)) != 0)
1058 if (sa->sa_layout_attr_obj != 0) {
1059 uint64_t layout_count;
1061 error = zap_count(os, sa->sa_layout_attr_obj,
1065 * Layout number count should be > 0
1067 if (error || (error == 0 && layout_count == 0)) {
1073 for (zap_cursor_init(&zc, os, sa->sa_layout_attr_obj);
1074 (error = zap_cursor_retrieve(&zc, &za)) == 0;
1075 zap_cursor_advance(&zc)) {
1076 sa_attr_type_t *lot_attrs;
1079 lot_attrs = kmem_zalloc(sizeof (sa_attr_type_t) *
1080 za.za_num_integers, KM_PUSHPAGE);
1082 if ((error = (zap_lookup(os, sa->sa_layout_attr_obj,
1083 za.za_name, 2, za.za_num_integers,
1084 lot_attrs))) != 0) {
1085 kmem_free(lot_attrs, sizeof (sa_attr_type_t) *
1086 za.za_num_integers);
1089 VERIFY(ddi_strtoull(za.za_name, NULL, 10,
1090 (unsigned long long *)&lot_num) == 0);
1092 (void) sa_add_layout_entry(os, lot_attrs,
1093 za.za_num_integers, lot_num,
1094 sa_layout_info_hash(lot_attrs,
1095 za.za_num_integers), B_FALSE, NULL);
1096 kmem_free(lot_attrs, sizeof (sa_attr_type_t) *
1097 za.za_num_integers);
1099 zap_cursor_fini(&zc);
1102 * Make sure layout count matches number of entries added
1105 if (avl_numnodes(&sa->sa_layout_num_tree) != layout_count) {
1111 /* Add special layout number for old ZNODES */
1112 if (ostype == DMU_OST_ZFS) {
1113 (void) sa_add_layout_entry(os, sa_legacy_zpl_layout,
1114 sa_legacy_attr_count, 0,
1115 sa_layout_info_hash(sa_legacy_zpl_layout,
1116 sa_legacy_attr_count), B_FALSE, NULL);
1118 (void) sa_add_layout_entry(os, sa_dummy_zpl_layout, 0, 1,
1121 *user_table = os->os_sa->sa_user_table;
1122 mutex_exit(&sa->sa_lock);
1126 sa_free_attr_table(sa);
1127 if (sa->sa_user_table)
1128 kmem_free(sa->sa_user_table, sa->sa_user_table_sz);
1129 mutex_exit(&sa->sa_lock);
1130 kmem_free(sa, sizeof (sa_os_t));
1131 return ((error == ECKSUM) ? EIO : error);
1135 sa_tear_down(objset_t *os)
1137 sa_os_t *sa = os->os_sa;
1141 kmem_free(sa->sa_user_table, sa->sa_user_table_sz);
1143 /* Free up attr table */
1145 sa_free_attr_table(sa);
1148 while ((layout = avl_destroy_nodes(&sa->sa_layout_hash_tree, &cookie))){
1150 while ((tab = list_head(&layout->lot_idx_tab))) {
1151 ASSERT(refcount_count(&tab->sa_refcount));
1152 sa_idx_tab_rele(os, tab);
1157 while ((layout = avl_destroy_nodes(&sa->sa_layout_num_tree, &cookie))){
1158 kmem_free(layout->lot_attrs,
1159 sizeof (sa_attr_type_t) * layout->lot_attr_count);
1160 kmem_free(layout, sizeof (sa_lot_t));
1163 avl_destroy(&sa->sa_layout_hash_tree);
1164 avl_destroy(&sa->sa_layout_num_tree);
1166 kmem_free(sa, sizeof (sa_os_t));
1171 sa_build_idx_tab(void *hdr, void *attr_addr, sa_attr_type_t attr,
1172 uint16_t length, int length_idx, boolean_t var_length, void *userp)
1174 sa_idx_tab_t *idx_tab = userp;
1177 ASSERT(idx_tab->sa_variable_lengths);
1178 idx_tab->sa_variable_lengths[length_idx] = length;
1180 TOC_ATTR_ENCODE(idx_tab->sa_idx_tab[attr], length_idx,
1181 (uint32_t)((uintptr_t)attr_addr - (uintptr_t)hdr));
1185 sa_attr_iter(objset_t *os, sa_hdr_phys_t *hdr, dmu_object_type_t type,
1186 sa_iterfunc_t func, sa_lot_t *tab, void *userp)
1192 sa_os_t *sa = os->os_sa;
1194 uint16_t *length_start = NULL;
1195 uint8_t length_idx = 0;
1198 search.lot_num = SA_LAYOUT_NUM(hdr, type);
1199 tb = avl_find(&sa->sa_layout_num_tree, &search, &loc);
1203 if (IS_SA_BONUSTYPE(type)) {
1204 data_start = (void *)P2ROUNDUP(((uintptr_t)hdr +
1205 offsetof(sa_hdr_phys_t, sa_lengths) +
1206 (sizeof (uint16_t) * tb->lot_var_sizes)), 8);
1207 length_start = hdr->sa_lengths;
1212 for (i = 0; i != tb->lot_attr_count; i++) {
1213 int attr_length, reg_length;
1216 reg_length = sa->sa_attr_table[tb->lot_attrs[i]].sa_length;
1218 attr_length = reg_length;
1221 attr_length = length_start[length_idx];
1222 idx_len = length_idx++;
1225 func(hdr, data_start, tb->lot_attrs[i], attr_length,
1226 idx_len, reg_length == 0 ? B_TRUE : B_FALSE, userp);
1228 data_start = (void *)P2ROUNDUP(((uintptr_t)data_start +
1235 sa_byteswap_cb(void *hdr, void *attr_addr, sa_attr_type_t attr,
1236 uint16_t length, int length_idx, boolean_t variable_length, void *userp)
1238 sa_handle_t *hdl = userp;
1239 sa_os_t *sa = hdl->sa_os->os_sa;
1241 sa_bswap_table[sa->sa_attr_table[attr].sa_byteswap](attr_addr, length);
1245 sa_byteswap(sa_handle_t *hdl, sa_buf_type_t buftype)
1247 sa_hdr_phys_t *sa_hdr_phys = SA_GET_HDR(hdl, buftype);
1249 int num_lengths = 1;
1251 ASSERTV(sa_os_t *sa = hdl->sa_os->os_sa);
1253 ASSERT(MUTEX_HELD(&sa->sa_lock));
1254 if (sa_hdr_phys->sa_magic == SA_MAGIC)
1257 db = SA_GET_DB(hdl, buftype);
1259 if (buftype == SA_SPILL) {
1260 arc_release(db->db_buf, NULL);
1261 arc_buf_thaw(db->db_buf);
1264 sa_hdr_phys->sa_magic = BSWAP_32(sa_hdr_phys->sa_magic);
1265 sa_hdr_phys->sa_layout_info = BSWAP_16(sa_hdr_phys->sa_layout_info);
1268 * Determine number of variable lenghts in header
1269 * The standard 8 byte header has one for free and a
1270 * 16 byte header would have 4 + 1;
1272 if (SA_HDR_SIZE(sa_hdr_phys) > 8)
1273 num_lengths += (SA_HDR_SIZE(sa_hdr_phys) - 8) >> 1;
1274 for (i = 0; i != num_lengths; i++)
1275 sa_hdr_phys->sa_lengths[i] =
1276 BSWAP_16(sa_hdr_phys->sa_lengths[i]);
1278 sa_attr_iter(hdl->sa_os, sa_hdr_phys, DMU_OT_SA,
1279 sa_byteswap_cb, NULL, hdl);
1281 if (buftype == SA_SPILL)
1282 arc_buf_freeze(((dmu_buf_impl_t *)hdl->sa_spill)->db_buf);
1286 sa_build_index(sa_handle_t *hdl, sa_buf_type_t buftype)
1288 sa_hdr_phys_t *sa_hdr_phys;
1289 dmu_buf_impl_t *db = SA_GET_DB(hdl, buftype);
1290 dmu_object_type_t bonustype = SA_BONUSTYPE_FROM_DB(db);
1291 sa_os_t *sa = hdl->sa_os->os_sa;
1292 sa_idx_tab_t *idx_tab;
1294 sa_hdr_phys = SA_GET_HDR(hdl, buftype);
1296 mutex_enter(&sa->sa_lock);
1298 /* Do we need to byteswap? */
1300 /* only check if not old znode */
1301 if (IS_SA_BONUSTYPE(bonustype) && sa_hdr_phys->sa_magic != SA_MAGIC &&
1302 sa_hdr_phys->sa_magic != 0) {
1303 VERIFY(BSWAP_32(sa_hdr_phys->sa_magic) == SA_MAGIC);
1304 sa_byteswap(hdl, buftype);
1307 idx_tab = sa_find_idx_tab(hdl->sa_os, bonustype, sa_hdr_phys);
1309 if (buftype == SA_BONUS)
1310 hdl->sa_bonus_tab = idx_tab;
1312 hdl->sa_spill_tab = idx_tab;
1314 mutex_exit(&sa->sa_lock);
1320 sa_evict(dmu_buf_t *db, void *sap)
1322 panic("evicting sa dbuf %p\n", (void *)db);
1326 sa_idx_tab_rele(objset_t *os, void *arg)
1328 sa_os_t *sa = os->os_sa;
1329 sa_idx_tab_t *idx_tab = arg;
1331 if (idx_tab == NULL)
1334 mutex_enter(&sa->sa_lock);
1335 if (refcount_remove(&idx_tab->sa_refcount, NULL) == 0) {
1336 list_remove(&idx_tab->sa_layout->lot_idx_tab, idx_tab);
1337 if (idx_tab->sa_variable_lengths)
1338 kmem_free(idx_tab->sa_variable_lengths,
1340 idx_tab->sa_layout->lot_var_sizes);
1341 refcount_destroy(&idx_tab->sa_refcount);
1342 kmem_free(idx_tab->sa_idx_tab,
1343 sizeof (uint32_t) * sa->sa_num_attrs);
1344 kmem_free(idx_tab, sizeof (sa_idx_tab_t));
1346 mutex_exit(&sa->sa_lock);
1350 sa_idx_tab_hold(objset_t *os, sa_idx_tab_t *idx_tab)
1352 ASSERTV(sa_os_t *sa = os->os_sa);
1354 ASSERT(MUTEX_HELD(&sa->sa_lock));
1355 (void) refcount_add(&idx_tab->sa_refcount, NULL);
1359 sa_spill_rele(sa_handle_t *hdl)
1361 mutex_enter(&hdl->sa_lock);
1362 if (hdl->sa_spill) {
1363 sa_idx_tab_rele(hdl->sa_os, hdl->sa_spill_tab);
1364 dmu_buf_rele(hdl->sa_spill, NULL);
1365 hdl->sa_spill = NULL;
1366 hdl->sa_spill_tab = NULL;
1368 mutex_exit(&hdl->sa_lock);
1372 sa_handle_destroy(sa_handle_t *hdl)
1374 mutex_enter(&hdl->sa_lock);
1375 (void) dmu_buf_update_user((dmu_buf_t *)hdl->sa_bonus, hdl,
1378 if (hdl->sa_bonus_tab) {
1379 sa_idx_tab_rele(hdl->sa_os, hdl->sa_bonus_tab);
1380 hdl->sa_bonus_tab = NULL;
1382 if (hdl->sa_spill_tab) {
1383 sa_idx_tab_rele(hdl->sa_os, hdl->sa_spill_tab);
1384 hdl->sa_spill_tab = NULL;
1387 dmu_buf_rele(hdl->sa_bonus, NULL);
1390 dmu_buf_rele((dmu_buf_t *)hdl->sa_spill, NULL);
1391 mutex_exit(&hdl->sa_lock);
1393 kmem_cache_free(sa_cache, hdl);
1397 sa_handle_get_from_db(objset_t *os, dmu_buf_t *db, void *userp,
1398 sa_handle_type_t hdl_type, sa_handle_t **handlepp)
1401 sa_handle_t *handle;
1403 dmu_object_info_t doi;
1405 dmu_object_info_from_db(db, &doi);
1406 ASSERT(doi.doi_bonus_type == DMU_OT_SA ||
1407 doi.doi_bonus_type == DMU_OT_ZNODE);
1409 /* find handle, if it exists */
1410 /* if one doesn't exist then create a new one, and initialize it */
1412 handle = (hdl_type == SA_HDL_SHARED) ? dmu_buf_get_user(db) : NULL;
1413 if (handle == NULL) {
1414 sa_handle_t *newhandle;
1415 handle = kmem_cache_alloc(sa_cache, KM_SLEEP);
1416 handle->sa_userp = userp;
1417 handle->sa_bonus = db;
1419 handle->sa_spill = NULL;
1421 error = sa_build_index(handle, SA_BONUS);
1422 newhandle = (hdl_type == SA_HDL_SHARED) ?
1423 dmu_buf_set_user_ie(db, handle,
1424 NULL, sa_evict) : NULL;
1426 if (newhandle != NULL) {
1427 kmem_cache_free(sa_cache, handle);
1437 sa_handle_get(objset_t *objset, uint64_t objid, void *userp,
1438 sa_handle_type_t hdl_type, sa_handle_t **handlepp)
1443 if ((error = dmu_bonus_hold(objset, objid, NULL, &db)))
1446 return (sa_handle_get_from_db(objset, db, userp, hdl_type,
1451 sa_buf_hold(objset_t *objset, uint64_t obj_num, void *tag, dmu_buf_t **db)
1453 return (dmu_bonus_hold(objset, obj_num, tag, db));
1457 sa_buf_rele(dmu_buf_t *db, void *tag)
1459 dmu_buf_rele(db, tag);
1463 sa_lookup_impl(sa_handle_t *hdl, sa_bulk_attr_t *bulk, int count)
1466 ASSERT(MUTEX_HELD(&hdl->sa_lock));
1467 return (sa_attr_op(hdl, bulk, count, SA_LOOKUP, NULL));
1471 sa_lookup(sa_handle_t *hdl, sa_attr_type_t attr, void *buf, uint32_t buflen)
1474 sa_bulk_attr_t bulk;
1476 bulk.sa_attr = attr;
1478 bulk.sa_length = buflen;
1479 bulk.sa_data_func = NULL;
1482 mutex_enter(&hdl->sa_lock);
1483 error = sa_lookup_impl(hdl, &bulk, 1);
1484 mutex_exit(&hdl->sa_lock);
1490 sa_lookup_uio(sa_handle_t *hdl, sa_attr_type_t attr, uio_t *uio)
1493 sa_bulk_attr_t bulk;
1495 bulk.sa_data = NULL;
1496 bulk.sa_attr = attr;
1497 bulk.sa_data_func = NULL;
1501 mutex_enter(&hdl->sa_lock);
1502 if ((error = sa_attr_op(hdl, &bulk, 1, SA_LOOKUP, NULL)) == 0) {
1503 error = uiomove((void *)bulk.sa_addr, MIN(bulk.sa_size,
1504 uio->uio_resid), UIO_READ, uio);
1506 mutex_exit(&hdl->sa_lock);
1512 sa_find_idx_tab(objset_t *os, dmu_object_type_t bonustype, void *data)
1514 sa_idx_tab_t *idx_tab;
1515 sa_hdr_phys_t *hdr = (sa_hdr_phys_t *)data;
1516 sa_os_t *sa = os->os_sa;
1517 sa_lot_t *tb, search;
1521 * Deterimine layout number. If SA node and header == 0 then
1522 * force the index table to the dummy "1" empty layout.
1524 * The layout number would only be zero for a newly created file
1525 * that has not added any attributes yet, or with crypto enabled which
1526 * doesn't write any attributes to the bonus buffer.
1529 search.lot_num = SA_LAYOUT_NUM(hdr, bonustype);
1531 tb = avl_find(&sa->sa_layout_num_tree, &search, &loc);
1533 /* Verify header size is consistent with layout information */
1535 ASSERT((IS_SA_BONUSTYPE(bonustype) &&
1536 SA_HDR_SIZE_MATCH_LAYOUT(hdr, tb)) || !IS_SA_BONUSTYPE(bonustype) ||
1537 (IS_SA_BONUSTYPE(bonustype) && hdr->sa_layout_info == 0));
1540 * See if any of the already existing TOC entries can be reused?
1543 for (idx_tab = list_head(&tb->lot_idx_tab); idx_tab;
1544 idx_tab = list_next(&tb->lot_idx_tab, idx_tab)) {
1545 boolean_t valid_idx = B_TRUE;
1548 if (tb->lot_var_sizes != 0 &&
1549 idx_tab->sa_variable_lengths != NULL) {
1550 for (i = 0; i != tb->lot_var_sizes; i++) {
1551 if (hdr->sa_lengths[i] !=
1552 idx_tab->sa_variable_lengths[i]) {
1553 valid_idx = B_FALSE;
1559 sa_idx_tab_hold(os, idx_tab);
1564 /* No such luck, create a new entry */
1565 idx_tab = kmem_zalloc(sizeof (sa_idx_tab_t), KM_PUSHPAGE);
1566 idx_tab->sa_idx_tab =
1567 kmem_zalloc(sizeof (uint32_t) * sa->sa_num_attrs, KM_PUSHPAGE);
1568 idx_tab->sa_layout = tb;
1569 refcount_create(&idx_tab->sa_refcount);
1570 if (tb->lot_var_sizes)
1571 idx_tab->sa_variable_lengths = kmem_alloc(sizeof (uint16_t) *
1572 tb->lot_var_sizes, KM_PUSHPAGE);
1574 sa_attr_iter(os, hdr, bonustype, sa_build_idx_tab,
1576 sa_idx_tab_hold(os, idx_tab); /* one hold for consumer */
1577 sa_idx_tab_hold(os, idx_tab); /* one for layout */
1578 list_insert_tail(&tb->lot_idx_tab, idx_tab);
1583 sa_default_locator(void **dataptr, uint32_t *len, uint32_t total_len,
1584 boolean_t start, void *userdata)
1588 *dataptr = userdata;
1593 sa_attr_register_sync(sa_handle_t *hdl, dmu_tx_t *tx)
1595 uint64_t attr_value = 0;
1596 sa_os_t *sa = hdl->sa_os->os_sa;
1597 sa_attr_table_t *tb = sa->sa_attr_table;
1600 mutex_enter(&sa->sa_lock);
1602 if (!sa->sa_need_attr_registration || sa->sa_master_obj == 0) {
1603 mutex_exit(&sa->sa_lock);
1607 if (sa->sa_reg_attr_obj == 0) {
1608 sa->sa_reg_attr_obj = zap_create_link(hdl->sa_os,
1609 DMU_OT_SA_ATTR_REGISTRATION,
1610 sa->sa_master_obj, SA_REGISTRY, tx);
1612 for (i = 0; i != sa->sa_num_attrs; i++) {
1613 if (sa->sa_attr_table[i].sa_registered)
1615 ATTR_ENCODE(attr_value, tb[i].sa_attr, tb[i].sa_length,
1617 VERIFY(0 == zap_update(hdl->sa_os, sa->sa_reg_attr_obj,
1618 tb[i].sa_name, 8, 1, &attr_value, tx));
1619 tb[i].sa_registered = B_TRUE;
1621 sa->sa_need_attr_registration = B_FALSE;
1622 mutex_exit(&sa->sa_lock);
1626 * Replace all attributes with attributes specified in template.
1627 * If dnode had a spill buffer then those attributes will be
1628 * also be replaced, possibly with just an empty spill block
1630 * This interface is intended to only be used for bulk adding of
1631 * attributes for a new file. It will also be used by the ZPL
1632 * when converting and old formatted znode to native SA support.
1635 sa_replace_all_by_template_locked(sa_handle_t *hdl, sa_bulk_attr_t *attr_desc,
1636 int attr_count, dmu_tx_t *tx)
1638 sa_os_t *sa = hdl->sa_os->os_sa;
1640 if (sa->sa_need_attr_registration)
1641 sa_attr_register_sync(hdl, tx);
1642 return (sa_build_layouts(hdl, attr_desc, attr_count, tx));
1646 sa_replace_all_by_template(sa_handle_t *hdl, sa_bulk_attr_t *attr_desc,
1647 int attr_count, dmu_tx_t *tx)
1651 mutex_enter(&hdl->sa_lock);
1652 error = sa_replace_all_by_template_locked(hdl, attr_desc,
1654 mutex_exit(&hdl->sa_lock);
1659 * add/remove/replace a single attribute and then rewrite the entire set
1663 sa_modify_attrs(sa_handle_t *hdl, sa_attr_type_t newattr,
1664 sa_data_op_t action, sa_data_locator_t *locator, void *datastart,
1665 uint16_t buflen, dmu_tx_t *tx)
1667 sa_os_t *sa = hdl->sa_os->os_sa;
1668 dmu_buf_impl_t *db = (dmu_buf_impl_t *)hdl->sa_bonus;
1670 sa_bulk_attr_t *attr_desc;
1672 int bonus_attr_count = 0;
1673 int bonus_data_size = 0;
1674 int spill_attr_count = 0;
1677 int i, j, k, length_idx;
1679 sa_idx_tab_t *idx_tab;
1683 ASSERT(MUTEX_HELD(&hdl->sa_lock));
1685 /* First make of copy of the old data */
1689 if (dn->dn_bonuslen != 0) {
1690 bonus_data_size = hdl->sa_bonus->db_size;
1691 old_data[0] = kmem_alloc(bonus_data_size, KM_SLEEP);
1692 bcopy(hdl->sa_bonus->db_data, old_data[0],
1693 hdl->sa_bonus->db_size);
1694 bonus_attr_count = hdl->sa_bonus_tab->sa_layout->lot_attr_count;
1700 /* Bring spill buffer online if it isn't currently */
1702 if ((error = sa_get_spill(hdl)) == 0) {
1703 ASSERT3U(hdl->sa_spill->db_size, <=, SPA_MAXBLOCKSIZE);
1704 old_data[1] = sa_spill_alloc(KM_SLEEP);
1705 bcopy(hdl->sa_spill->db_data, old_data[1],
1706 hdl->sa_spill->db_size);
1708 hdl->sa_spill_tab->sa_layout->lot_attr_count;
1709 } else if (error && error != ENOENT) {
1711 kmem_free(old_data[0], bonus_data_size);
1717 /* build descriptor of all attributes */
1719 attr_count = bonus_attr_count + spill_attr_count;
1720 if (action == SA_ADD)
1722 else if (action == SA_REMOVE)
1725 attr_desc = kmem_zalloc(sizeof (sa_bulk_attr_t) * attr_count, KM_SLEEP);
1728 * loop through bonus and spill buffer if it exists, and
1729 * build up new attr_descriptor to reset the attributes
1732 count = bonus_attr_count;
1733 hdr = SA_GET_HDR(hdl, SA_BONUS);
1734 idx_tab = SA_IDX_TAB_GET(hdl, SA_BONUS);
1735 for (; k != 2; k++) {
1736 /* iterate over each attribute in layout */
1737 for (i = 0, length_idx = 0; i != count; i++) {
1738 sa_attr_type_t attr;
1740 attr = idx_tab->sa_layout->lot_attrs[i];
1741 if (attr == newattr) {
1742 if (action == SA_REMOVE) {
1746 ASSERT(SA_REGISTERED_LEN(sa, attr) == 0);
1747 ASSERT(action == SA_REPLACE);
1748 SA_ADD_BULK_ATTR(attr_desc, j, attr,
1749 locator, datastart, buflen);
1751 length = SA_REGISTERED_LEN(sa, attr);
1753 length = hdr->sa_lengths[length_idx++];
1756 SA_ADD_BULK_ATTR(attr_desc, j, attr,
1758 (TOC_OFF(idx_tab->sa_idx_tab[attr]) +
1759 (uintptr_t)old_data[k]), length);
1762 if (k == 0 && hdl->sa_spill) {
1763 hdr = SA_GET_HDR(hdl, SA_SPILL);
1764 idx_tab = SA_IDX_TAB_GET(hdl, SA_SPILL);
1765 count = spill_attr_count;
1770 if (action == SA_ADD) {
1771 length = SA_REGISTERED_LEN(sa, newattr);
1775 SA_ADD_BULK_ATTR(attr_desc, j, newattr, locator,
1779 error = sa_build_layouts(hdl, attr_desc, attr_count, tx);
1782 kmem_free(old_data[0], bonus_data_size);
1784 sa_spill_free(old_data[1]);
1785 kmem_free(attr_desc, sizeof (sa_bulk_attr_t) * attr_count);
1791 sa_bulk_update_impl(sa_handle_t *hdl, sa_bulk_attr_t *bulk, int count,
1795 sa_os_t *sa = hdl->sa_os->os_sa;
1796 dmu_object_type_t bonustype;
1797 dmu_buf_t *saved_spill;
1800 ASSERT(MUTEX_HELD(&hdl->sa_lock));
1802 bonustype = SA_BONUSTYPE_FROM_DB(SA_GET_DB(hdl, SA_BONUS));
1803 saved_spill = hdl->sa_spill;
1805 /* sync out registration table if necessary */
1806 if (sa->sa_need_attr_registration)
1807 sa_attr_register_sync(hdl, tx);
1809 error = sa_attr_op(hdl, bulk, count, SA_UPDATE, tx);
1810 if (error == 0 && !IS_SA_BONUSTYPE(bonustype) && sa->sa_update_cb)
1811 sa->sa_update_cb(hdl, tx);
1814 * If saved_spill is NULL and current sa_spill is not NULL that
1815 * means we increased the refcount of the spill buffer through
1816 * sa_get_spill() or dmu_spill_hold_by_dnode(). Therefore we
1817 * must release the hold before calling dmu_tx_commit() to avoid
1818 * making a copy of this buffer in dbuf_sync_leaf() due to the
1819 * reference count now being greater than 1.
1821 if (!saved_spill && hdl->sa_spill) {
1822 if (hdl->sa_spill_tab) {
1823 sa_idx_tab_rele(hdl->sa_os, hdl->sa_spill_tab);
1824 hdl->sa_spill_tab = NULL;
1827 dmu_buf_rele((dmu_buf_t *)hdl->sa_spill, NULL);
1828 hdl->sa_spill = NULL;
1835 * update or add new attribute
1838 sa_update(sa_handle_t *hdl, sa_attr_type_t type,
1839 void *buf, uint32_t buflen, dmu_tx_t *tx)
1842 sa_bulk_attr_t bulk;
1844 bulk.sa_attr = type;
1845 bulk.sa_data_func = NULL;
1846 bulk.sa_length = buflen;
1849 mutex_enter(&hdl->sa_lock);
1850 error = sa_bulk_update_impl(hdl, &bulk, 1, tx);
1851 mutex_exit(&hdl->sa_lock);
1856 sa_update_from_cb(sa_handle_t *hdl, sa_attr_type_t attr,
1857 uint32_t buflen, sa_data_locator_t *locator, void *userdata, dmu_tx_t *tx)
1860 sa_bulk_attr_t bulk;
1862 bulk.sa_attr = attr;
1863 bulk.sa_data = userdata;
1864 bulk.sa_data_func = locator;
1865 bulk.sa_length = buflen;
1867 mutex_enter(&hdl->sa_lock);
1868 error = sa_bulk_update_impl(hdl, &bulk, 1, tx);
1869 mutex_exit(&hdl->sa_lock);
1874 * Return size of an attribute
1878 sa_size(sa_handle_t *hdl, sa_attr_type_t attr, int *size)
1880 sa_bulk_attr_t bulk;
1883 bulk.sa_data = NULL;
1884 bulk.sa_attr = attr;
1885 bulk.sa_data_func = NULL;
1888 mutex_enter(&hdl->sa_lock);
1889 if ((error = sa_attr_op(hdl, &bulk, 1, SA_LOOKUP, NULL)) != 0) {
1890 mutex_exit(&hdl->sa_lock);
1893 *size = bulk.sa_size;
1895 mutex_exit(&hdl->sa_lock);
1900 sa_bulk_lookup_locked(sa_handle_t *hdl, sa_bulk_attr_t *attrs, int count)
1903 ASSERT(MUTEX_HELD(&hdl->sa_lock));
1904 return (sa_lookup_impl(hdl, attrs, count));
1908 sa_bulk_lookup(sa_handle_t *hdl, sa_bulk_attr_t *attrs, int count)
1913 mutex_enter(&hdl->sa_lock);
1914 error = sa_bulk_lookup_locked(hdl, attrs, count);
1915 mutex_exit(&hdl->sa_lock);
1920 sa_bulk_update(sa_handle_t *hdl, sa_bulk_attr_t *attrs, int count, dmu_tx_t *tx)
1925 mutex_enter(&hdl->sa_lock);
1926 error = sa_bulk_update_impl(hdl, attrs, count, tx);
1927 mutex_exit(&hdl->sa_lock);
1932 sa_remove(sa_handle_t *hdl, sa_attr_type_t attr, dmu_tx_t *tx)
1936 mutex_enter(&hdl->sa_lock);
1937 error = sa_modify_attrs(hdl, attr, SA_REMOVE, NULL,
1939 mutex_exit(&hdl->sa_lock);
1944 sa_object_info(sa_handle_t *hdl, dmu_object_info_t *doi)
1946 dmu_object_info_from_db((dmu_buf_t *)hdl->sa_bonus, doi);
1950 sa_object_size(sa_handle_t *hdl, uint32_t *blksize, u_longlong_t *nblocks)
1952 dmu_object_size_from_db((dmu_buf_t *)hdl->sa_bonus,
1957 sa_update_user(sa_handle_t *newhdl, sa_handle_t *oldhdl)
1959 (void) dmu_buf_update_user((dmu_buf_t *)newhdl->sa_bonus,
1960 oldhdl, newhdl, NULL, sa_evict);
1961 oldhdl->sa_bonus = NULL;
1965 sa_set_userp(sa_handle_t *hdl, void *ptr)
1967 hdl->sa_userp = ptr;
1971 sa_get_db(sa_handle_t *hdl)
1973 return ((dmu_buf_t *)hdl->sa_bonus);
1977 sa_get_userdata(sa_handle_t *hdl)
1979 return (hdl->sa_userp);
1983 sa_register_update_callback_locked(objset_t *os, sa_update_cb_t *func)
1985 ASSERT(MUTEX_HELD(&os->os_sa->sa_lock));
1986 os->os_sa->sa_update_cb = func;
1990 sa_register_update_callback(objset_t *os, sa_update_cb_t *func)
1993 mutex_enter(&os->os_sa->sa_lock);
1994 sa_register_update_callback_locked(os, func);
1995 mutex_exit(&os->os_sa->sa_lock);
1999 sa_handle_object(sa_handle_t *hdl)
2001 return (hdl->sa_bonus->db_object);
2005 sa_enabled(objset_t *os)
2007 return (os->os_sa == NULL);
2011 sa_set_sa_object(objset_t *os, uint64_t sa_object)
2013 sa_os_t *sa = os->os_sa;
2015 if (sa->sa_master_obj)
2018 sa->sa_master_obj = sa_object;
2024 sa_hdrsize(void *arg)
2026 sa_hdr_phys_t *hdr = arg;
2028 return (SA_HDR_SIZE(hdr));
2032 sa_handle_lock(sa_handle_t *hdl)
2035 mutex_enter(&hdl->sa_lock);
2039 sa_handle_unlock(sa_handle_t *hdl)
2042 mutex_exit(&hdl->sa_lock);
2046 EXPORT_SYMBOL(sa_handle_get);
2047 EXPORT_SYMBOL(sa_handle_get_from_db);
2048 EXPORT_SYMBOL(sa_handle_destroy);
2049 EXPORT_SYMBOL(sa_buf_hold);
2050 EXPORT_SYMBOL(sa_buf_rele);
2051 EXPORT_SYMBOL(sa_spill_rele);
2052 EXPORT_SYMBOL(sa_lookup);
2053 EXPORT_SYMBOL(sa_update);
2054 EXPORT_SYMBOL(sa_remove);
2055 EXPORT_SYMBOL(sa_bulk_lookup);
2056 EXPORT_SYMBOL(sa_bulk_lookup_locked);
2057 EXPORT_SYMBOL(sa_bulk_update);
2058 EXPORT_SYMBOL(sa_size);
2059 EXPORT_SYMBOL(sa_update_from_cb);
2060 EXPORT_SYMBOL(sa_object_info);
2061 EXPORT_SYMBOL(sa_object_size);
2062 EXPORT_SYMBOL(sa_update_user);
2063 EXPORT_SYMBOL(sa_get_userdata);
2064 EXPORT_SYMBOL(sa_set_userp);
2065 EXPORT_SYMBOL(sa_get_db);
2066 EXPORT_SYMBOL(sa_handle_object);
2067 EXPORT_SYMBOL(sa_register_update_callback);
2068 EXPORT_SYMBOL(sa_setup);
2069 EXPORT_SYMBOL(sa_replace_all_by_template);
2070 EXPORT_SYMBOL(sa_replace_all_by_template_locked);
2071 EXPORT_SYMBOL(sa_enabled);
2072 EXPORT_SYMBOL(sa_cache_init);
2073 EXPORT_SYMBOL(sa_cache_fini);
2074 EXPORT_SYMBOL(sa_spill_alloc);
2075 EXPORT_SYMBOL(sa_spill_free);
2076 EXPORT_SYMBOL(sa_set_sa_object);
2077 EXPORT_SYMBOL(sa_hdrsize);
2078 EXPORT_SYMBOL(sa_handle_lock);
2079 EXPORT_SYMBOL(sa_handle_unlock);
2080 EXPORT_SYMBOL(sa_lookup_uio);
2081 #endif /* _KERNEL */