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) 2013 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:
114 * Since the SA attributes are not entirely self describing we can't do
115 * the normal byteswap processing. The special ZAP layout attribute and
116 * attribute registration attributes define the byteswap function and the
117 * size of the attributes, unless it is variable sized.
118 * The normal ZFS byteswapping infrastructure assumes you don't need
119 * to read any objects in order to do the necessary byteswapping. Whereas
120 * SA attributes can only be properly byteswapped if the dataset is opened
121 * and the layout/attribute ZAP attributes are available. Because of this
122 * the SA attributes will be byteswapped when they are first accessed by
123 * the SA code that will read the SA data.
126 typedef void (sa_iterfunc_t)(void *hdr, void *addr, sa_attr_type_t,
127 uint16_t length, int length_idx, boolean_t, void *userp);
129 static int sa_build_index(sa_handle_t *hdl, sa_buf_type_t buftype);
130 static void sa_idx_tab_hold(objset_t *os, sa_idx_tab_t *idx_tab);
131 static void *sa_find_idx_tab(objset_t *os, dmu_object_type_t bonustype,
133 static void sa_idx_tab_rele(objset_t *os, void *arg);
134 static void sa_copy_data(sa_data_locator_t *func, void *start, void *target,
136 static int sa_modify_attrs(sa_handle_t *hdl, sa_attr_type_t newattr,
137 sa_data_op_t action, sa_data_locator_t *locator, void *datastart,
138 uint16_t buflen, dmu_tx_t *tx);
140 arc_byteswap_func_t sa_bswap_table[] = {
141 byteswap_uint64_array,
142 byteswap_uint32_array,
143 byteswap_uint16_array,
144 byteswap_uint8_array,
148 #define SA_COPY_DATA(f, s, t, l) \
152 *(uint64_t *)t = *(uint64_t *)s; \
153 } else if (l == 16) { \
154 *(uint64_t *)t = *(uint64_t *)s; \
155 *(uint64_t *)((uintptr_t)t + 8) = \
156 *(uint64_t *)((uintptr_t)s + 8); \
161 sa_copy_data(f, s, t, l); \
165 * This table is fixed and cannot be changed. Its purpose is to
166 * allow the SA code to work with both old/new ZPL file systems.
167 * It contains the list of legacy attributes. These attributes aren't
168 * stored in the "attribute" registry zap objects, since older ZPL file systems
169 * won't have the registry. Only objsets of type ZFS_TYPE_FILESYSTEM will
170 * use this static table.
172 sa_attr_reg_t sa_legacy_attrs[] = {
173 {"ZPL_ATIME", sizeof (uint64_t) * 2, SA_UINT64_ARRAY, 0},
174 {"ZPL_MTIME", sizeof (uint64_t) * 2, SA_UINT64_ARRAY, 1},
175 {"ZPL_CTIME", sizeof (uint64_t) * 2, SA_UINT64_ARRAY, 2},
176 {"ZPL_CRTIME", sizeof (uint64_t) * 2, SA_UINT64_ARRAY, 3},
177 {"ZPL_GEN", sizeof (uint64_t), SA_UINT64_ARRAY, 4},
178 {"ZPL_MODE", sizeof (uint64_t), SA_UINT64_ARRAY, 5},
179 {"ZPL_SIZE", sizeof (uint64_t), SA_UINT64_ARRAY, 6},
180 {"ZPL_PARENT", sizeof (uint64_t), SA_UINT64_ARRAY, 7},
181 {"ZPL_LINKS", sizeof (uint64_t), SA_UINT64_ARRAY, 8},
182 {"ZPL_XATTR", sizeof (uint64_t), SA_UINT64_ARRAY, 9},
183 {"ZPL_RDEV", sizeof (uint64_t), SA_UINT64_ARRAY, 10},
184 {"ZPL_FLAGS", sizeof (uint64_t), SA_UINT64_ARRAY, 11},
185 {"ZPL_UID", sizeof (uint64_t), SA_UINT64_ARRAY, 12},
186 {"ZPL_GID", sizeof (uint64_t), SA_UINT64_ARRAY, 13},
187 {"ZPL_PAD", sizeof (uint64_t) * 4, SA_UINT64_ARRAY, 14},
188 {"ZPL_ZNODE_ACL", 88, SA_UINT8_ARRAY, 15},
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.
201 sa_attr_type_t sa_dummy_zpl_layout[] = { 0 };
203 static int sa_legacy_attr_count = 16;
204 static kmem_cache_t *sa_cache = NULL;
205 static kmem_cache_t *spill_cache = NULL;
209 sa_cache_constructor(void *buf, void *unused, int kmflag)
211 sa_handle_t *hdl = buf;
213 hdl->sa_bonus_tab = NULL;
214 hdl->sa_spill_tab = NULL;
216 hdl->sa_userp = NULL;
217 hdl->sa_bonus = NULL;
218 hdl->sa_spill = NULL;
219 mutex_init(&hdl->sa_lock, NULL, MUTEX_DEFAULT, NULL);
225 sa_cache_destructor(void *buf, void *unused)
227 sa_handle_t *hdl = buf;
228 mutex_destroy(&hdl->sa_lock);
234 sa_cache = kmem_cache_create("sa_cache",
235 sizeof (sa_handle_t), 0, sa_cache_constructor,
236 sa_cache_destructor, NULL, NULL, NULL, 0);
237 spill_cache = kmem_cache_create("spill_cache",
238 SPA_MAXBLOCKSIZE, 0, NULL, NULL, NULL, NULL, NULL, 0);
245 kmem_cache_destroy(sa_cache);
248 kmem_cache_destroy(spill_cache);
252 sa_spill_alloc(int flags)
254 return (kmem_cache_alloc(spill_cache, flags));
258 sa_spill_free(void *obj)
260 kmem_cache_free(spill_cache, obj);
264 layout_num_compare(const void *arg1, const void *arg2)
266 const sa_lot_t *node1 = arg1;
267 const sa_lot_t *node2 = arg2;
269 if (node1->lot_num > node2->lot_num)
271 else if (node1->lot_num < node2->lot_num)
277 layout_hash_compare(const void *arg1, const void *arg2)
279 const sa_lot_t *node1 = arg1;
280 const sa_lot_t *node2 = arg2;
282 if (node1->lot_hash > node2->lot_hash)
284 if (node1->lot_hash < node2->lot_hash)
286 if (node1->lot_instance > node2->lot_instance)
288 if (node1->lot_instance < node2->lot_instance)
294 sa_layout_equal(sa_lot_t *tbf, sa_attr_type_t *attrs, int count)
298 if (count != tbf->lot_attr_count)
301 for (i = 0; i != count; i++) {
302 if (attrs[i] != tbf->lot_attrs[i])
308 #define SA_ATTR_HASH(attr) (zfs_crc64_table[(-1ULL ^ attr) & 0xFF])
311 sa_layout_info_hash(sa_attr_type_t *attrs, int attr_count)
314 uint64_t crc = -1ULL;
316 for (i = 0; i != attr_count; i++)
317 crc ^= SA_ATTR_HASH(attrs[i]);
323 sa_get_spill(sa_handle_t *hdl)
326 if (hdl->sa_spill == NULL) {
327 if ((rc = dmu_spill_hold_existing(hdl->sa_bonus, NULL,
328 &hdl->sa_spill)) == 0)
329 VERIFY(0 == sa_build_index(hdl, SA_SPILL));
338 * Main attribute lookup/update function
339 * returns 0 for success or non zero for failures
341 * Operates on bulk array, first failure will abort further processing
344 sa_attr_op(sa_handle_t *hdl, sa_bulk_attr_t *bulk, int count,
345 sa_data_op_t data_op, dmu_tx_t *tx)
347 sa_os_t *sa = hdl->sa_os->os_sa;
350 sa_buf_type_t buftypes;
355 for (i = 0; i != count; i++) {
356 ASSERT(bulk[i].sa_attr <= hdl->sa_os->os_sa->sa_num_attrs);
358 bulk[i].sa_addr = NULL;
359 /* First check the bonus buffer */
361 if (hdl->sa_bonus_tab && TOC_ATTR_PRESENT(
362 hdl->sa_bonus_tab->sa_idx_tab[bulk[i].sa_attr])) {
363 SA_ATTR_INFO(sa, hdl->sa_bonus_tab,
364 SA_GET_HDR(hdl, SA_BONUS),
365 bulk[i].sa_attr, bulk[i], SA_BONUS, hdl);
366 if (tx && !(buftypes & SA_BONUS)) {
367 dmu_buf_will_dirty(hdl->sa_bonus, tx);
368 buftypes |= SA_BONUS;
371 if (bulk[i].sa_addr == NULL &&
372 ((error = sa_get_spill(hdl)) == 0)) {
373 if (TOC_ATTR_PRESENT(
374 hdl->sa_spill_tab->sa_idx_tab[bulk[i].sa_attr])) {
375 SA_ATTR_INFO(sa, hdl->sa_spill_tab,
376 SA_GET_HDR(hdl, SA_SPILL),
377 bulk[i].sa_attr, bulk[i], SA_SPILL, hdl);
378 if (tx && !(buftypes & SA_SPILL) &&
379 bulk[i].sa_size == bulk[i].sa_length) {
380 dmu_buf_will_dirty(hdl->sa_spill, tx);
381 buftypes |= SA_SPILL;
385 if (error && error != ENOENT) {
386 return ((error == ECKSUM) ? EIO : error);
391 if (bulk[i].sa_addr == NULL)
392 return (SET_ERROR(ENOENT));
393 if (bulk[i].sa_data) {
394 SA_COPY_DATA(bulk[i].sa_data_func,
395 bulk[i].sa_addr, bulk[i].sa_data,
401 /* existing rewrite of attr */
402 if (bulk[i].sa_addr &&
403 bulk[i].sa_size == bulk[i].sa_length) {
404 SA_COPY_DATA(bulk[i].sa_data_func,
405 bulk[i].sa_data, bulk[i].sa_addr,
408 } else if (bulk[i].sa_addr) { /* attr size change */
409 error = sa_modify_attrs(hdl, bulk[i].sa_attr,
410 SA_REPLACE, bulk[i].sa_data_func,
411 bulk[i].sa_data, bulk[i].sa_length, tx);
412 } else { /* adding new attribute */
413 error = sa_modify_attrs(hdl, bulk[i].sa_attr,
414 SA_ADD, bulk[i].sa_data_func,
415 bulk[i].sa_data, bulk[i].sa_length, tx);
428 sa_add_layout_entry(objset_t *os, sa_attr_type_t *attrs, int attr_count,
429 uint64_t lot_num, uint64_t hash, boolean_t zapadd, dmu_tx_t *tx)
431 sa_os_t *sa = os->os_sa;
432 sa_lot_t *tb, *findtb;
436 ASSERT(MUTEX_HELD(&sa->sa_lock));
437 tb = kmem_zalloc(sizeof (sa_lot_t), KM_PUSHPAGE);
438 tb->lot_attr_count = attr_count;
439 tb->lot_attrs = kmem_alloc(sizeof (sa_attr_type_t) * attr_count,
441 bcopy(attrs, tb->lot_attrs, sizeof (sa_attr_type_t) * attr_count);
442 tb->lot_num = lot_num;
444 tb->lot_instance = 0;
449 if (sa->sa_layout_attr_obj == 0) {
450 sa->sa_layout_attr_obj = zap_create_link(os,
451 DMU_OT_SA_ATTR_LAYOUTS,
452 sa->sa_master_obj, SA_LAYOUTS, tx);
455 (void) snprintf(attr_name, sizeof (attr_name),
457 VERIFY(0 == zap_update(os, os->os_sa->sa_layout_attr_obj,
458 attr_name, 2, attr_count, attrs, tx));
461 list_create(&tb->lot_idx_tab, sizeof (sa_idx_tab_t),
462 offsetof(sa_idx_tab_t, sa_next));
464 for (i = 0; i != attr_count; i++) {
465 if (sa->sa_attr_table[tb->lot_attrs[i]].sa_length == 0)
469 avl_add(&sa->sa_layout_num_tree, tb);
471 /* verify we don't have a hash collision */
472 if ((findtb = avl_find(&sa->sa_layout_hash_tree, tb, &loc)) != NULL) {
473 for (; findtb && findtb->lot_hash == hash;
474 findtb = AVL_NEXT(&sa->sa_layout_hash_tree, findtb)) {
475 if (findtb->lot_instance != tb->lot_instance)
480 avl_add(&sa->sa_layout_hash_tree, tb);
485 sa_find_layout(objset_t *os, uint64_t hash, sa_attr_type_t *attrs,
486 int count, dmu_tx_t *tx, sa_lot_t **lot)
488 sa_lot_t *tb, tbsearch;
490 sa_os_t *sa = os->os_sa;
491 boolean_t found = B_FALSE;
493 mutex_enter(&sa->sa_lock);
494 tbsearch.lot_hash = hash;
495 tbsearch.lot_instance = 0;
496 tb = avl_find(&sa->sa_layout_hash_tree, &tbsearch, &loc);
498 for (; tb && tb->lot_hash == hash;
499 tb = AVL_NEXT(&sa->sa_layout_hash_tree, tb)) {
500 if (sa_layout_equal(tb, attrs, count) == 0) {
507 tb = sa_add_layout_entry(os, attrs, count,
508 avl_numnodes(&sa->sa_layout_num_tree), hash, B_TRUE, tx);
510 mutex_exit(&sa->sa_lock);
515 sa_resize_spill(sa_handle_t *hdl, uint32_t size, dmu_tx_t *tx)
521 blocksize = SPA_MINBLOCKSIZE;
522 } else if (size > SPA_MAXBLOCKSIZE) {
524 return (SET_ERROR(EFBIG));
526 blocksize = P2ROUNDUP_TYPED(size, SPA_MINBLOCKSIZE, uint32_t);
529 error = dbuf_spill_set_blksz(hdl->sa_spill, blocksize, tx);
535 sa_copy_data(sa_data_locator_t *func, void *datastart, void *target, int buflen)
538 bcopy(datastart, target, buflen);
543 void *saptr = target;
548 while (bytes < buflen) {
549 func(&dataptr, &length, buflen, start, datastart);
550 bcopy(dataptr, saptr, length);
551 saptr = (void *)((caddr_t)saptr + length);
559 * Determine several different sizes
560 * first the sa header size
561 * the number of bytes to be stored
562 * if spill would occur the index in the attribute array is returned
564 * the boolean will_spill will be set when spilling is necessary. It
565 * is only set when the buftype is SA_BONUS
568 sa_find_sizes(sa_os_t *sa, sa_bulk_attr_t *attr_desc, int attr_count,
569 dmu_buf_t *db, sa_buf_type_t buftype, int *index, int *total,
570 boolean_t *will_spill)
578 if (buftype == SA_BONUS && sa->sa_force_spill) {
581 *will_spill = B_TRUE;
587 *will_spill = B_FALSE;
590 hdrsize = (SA_BONUSTYPE_FROM_DB(db) == DMU_OT_ZNODE) ? 0 :
591 sizeof (sa_hdr_phys_t);
593 full_space = (buftype == SA_BONUS) ? DN_MAX_BONUSLEN : db->db_size;
594 ASSERT(IS_P2ALIGNED(full_space, 8));
596 for (i = 0; i != attr_count; i++) {
597 boolean_t is_var_sz, might_spill_here;
599 *total = P2ROUNDUP(*total, 8);
600 *total += attr_desc[i].sa_length;
604 is_var_sz = (SA_REGISTERED_LEN(sa, attr_desc[i].sa_attr) == 0);
610 buftype == SA_BONUS && *index == -1 &&
611 (*total + P2ROUNDUP(hdrsize, 8)) >
612 (full_space - sizeof (blkptr_t));
614 if (is_var_sz && var_size > 1) {
616 * Don't worry that the spill block might overflow.
617 * It will be resized if needed in sa_build_layouts().
619 if (buftype == SA_SPILL ||
620 P2ROUNDUP(hdrsize + sizeof (uint16_t), 8) +
621 *total < full_space) {
623 * Account for header space used by array of
624 * optional sizes of variable-length attributes.
625 * Record the extra header size in case this
626 * increase needs to be reversed due to
629 hdrsize += sizeof (uint16_t);
630 if (*index != -1 || might_spill_here)
631 extra_hdrsize += sizeof (uint16_t);
633 ASSERT(buftype == SA_BONUS);
636 *will_spill = B_TRUE;
642 * find index of where spill *could* occur.
643 * Then continue to count of remainder attribute
644 * space. The sum is used later for sizing bonus
647 if (might_spill_here)
650 if ((*total + P2ROUNDUP(hdrsize, 8)) > full_space &&
652 *will_spill = B_TRUE;
656 hdrsize -= extra_hdrsize;
658 hdrsize = P2ROUNDUP(hdrsize, 8);
662 #define BUF_SPACE_NEEDED(total, header) (total + header)
665 * Find layout that corresponds to ordering of attributes
666 * If not found a new layout number is created and added to
667 * persistent layout tables.
670 sa_build_layouts(sa_handle_t *hdl, sa_bulk_attr_t *attr_desc, int attr_count,
673 sa_os_t *sa = hdl->sa_os->os_sa;
675 sa_buf_type_t buftype;
676 sa_hdr_phys_t *sahdr;
679 sa_attr_type_t *attrs, *attrs_start;
682 int 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)
698 return (SET_ERROR(EFBIG));
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)
722 return (SET_ERROR(EFBIG));
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)) {
879 error = SET_ERROR(EINVAL);
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);
910 error = SET_ERROR(ENOENT);
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_user_ptr_lock);
1024 mutex_enter(&os->os_sa->sa_lock);
1025 mutex_exit(&os->os_user_ptr_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_user_ptr_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)) {
1069 error = SET_ERROR(EINVAL);
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);
1149 avl_destroy_nodes(&sa->sa_layout_hash_tree, &cookie))) {
1151 while ((tab = list_head(&layout->lot_idx_tab))) {
1152 ASSERT(refcount_count(&tab->sa_refcount));
1153 sa_idx_tab_rele(os, tab);
1158 while ((layout = avl_destroy_nodes(&sa->sa_layout_num_tree, &cookie))) {
1159 kmem_free(layout->lot_attrs,
1160 sizeof (sa_attr_type_t) * layout->lot_attr_count);
1161 kmem_free(layout, sizeof (sa_lot_t));
1164 avl_destroy(&sa->sa_layout_hash_tree);
1165 avl_destroy(&sa->sa_layout_num_tree);
1167 kmem_free(sa, sizeof (sa_os_t));
1172 sa_build_idx_tab(void *hdr, void *attr_addr, sa_attr_type_t attr,
1173 uint16_t length, int length_idx, boolean_t var_length, void *userp)
1175 sa_idx_tab_t *idx_tab = userp;
1178 ASSERT(idx_tab->sa_variable_lengths);
1179 idx_tab->sa_variable_lengths[length_idx] = length;
1181 TOC_ATTR_ENCODE(idx_tab->sa_idx_tab[attr], length_idx,
1182 (uint32_t)((uintptr_t)attr_addr - (uintptr_t)hdr));
1186 sa_attr_iter(objset_t *os, sa_hdr_phys_t *hdr, dmu_object_type_t type,
1187 sa_iterfunc_t func, sa_lot_t *tab, void *userp)
1193 sa_os_t *sa = os->os_sa;
1195 uint16_t *length_start = NULL;
1196 uint8_t length_idx = 0;
1199 search.lot_num = SA_LAYOUT_NUM(hdr, type);
1200 tb = avl_find(&sa->sa_layout_num_tree, &search, &loc);
1204 if (IS_SA_BONUSTYPE(type)) {
1205 data_start = (void *)P2ROUNDUP(((uintptr_t)hdr +
1206 offsetof(sa_hdr_phys_t, sa_lengths) +
1207 (sizeof (uint16_t) * tb->lot_var_sizes)), 8);
1208 length_start = hdr->sa_lengths;
1213 for (i = 0; i != tb->lot_attr_count; i++) {
1214 int attr_length, reg_length;
1217 reg_length = sa->sa_attr_table[tb->lot_attrs[i]].sa_length;
1219 attr_length = reg_length;
1222 attr_length = length_start[length_idx];
1223 idx_len = length_idx++;
1226 func(hdr, data_start, tb->lot_attrs[i], attr_length,
1227 idx_len, reg_length == 0 ? B_TRUE : B_FALSE, userp);
1229 data_start = (void *)P2ROUNDUP(((uintptr_t)data_start +
1236 sa_byteswap_cb(void *hdr, void *attr_addr, sa_attr_type_t attr,
1237 uint16_t length, int length_idx, boolean_t variable_length, void *userp)
1239 sa_handle_t *hdl = userp;
1240 sa_os_t *sa = hdl->sa_os->os_sa;
1242 sa_bswap_table[sa->sa_attr_table[attr].sa_byteswap](attr_addr, length);
1246 sa_byteswap(sa_handle_t *hdl, sa_buf_type_t buftype)
1248 sa_hdr_phys_t *sa_hdr_phys = SA_GET_HDR(hdl, buftype);
1250 int num_lengths = 1;
1252 ASSERTV(sa_os_t *sa = hdl->sa_os->os_sa);
1254 ASSERT(MUTEX_HELD(&sa->sa_lock));
1255 if (sa_hdr_phys->sa_magic == SA_MAGIC)
1258 db = SA_GET_DB(hdl, buftype);
1260 if (buftype == SA_SPILL) {
1261 arc_release(db->db_buf, NULL);
1262 arc_buf_thaw(db->db_buf);
1265 sa_hdr_phys->sa_magic = BSWAP_32(sa_hdr_phys->sa_magic);
1266 sa_hdr_phys->sa_layout_info = BSWAP_16(sa_hdr_phys->sa_layout_info);
1269 * Determine number of variable lenghts in header
1270 * The standard 8 byte header has one for free and a
1271 * 16 byte header would have 4 + 1;
1273 if (SA_HDR_SIZE(sa_hdr_phys) > 8)
1274 num_lengths += (SA_HDR_SIZE(sa_hdr_phys) - 8) >> 1;
1275 for (i = 0; i != num_lengths; i++)
1276 sa_hdr_phys->sa_lengths[i] =
1277 BSWAP_16(sa_hdr_phys->sa_lengths[i]);
1279 sa_attr_iter(hdl->sa_os, sa_hdr_phys, DMU_OT_SA,
1280 sa_byteswap_cb, NULL, hdl);
1282 if (buftype == SA_SPILL)
1283 arc_buf_freeze(((dmu_buf_impl_t *)hdl->sa_spill)->db_buf);
1287 sa_build_index(sa_handle_t *hdl, sa_buf_type_t buftype)
1289 sa_hdr_phys_t *sa_hdr_phys;
1290 dmu_buf_impl_t *db = SA_GET_DB(hdl, buftype);
1291 dmu_object_type_t bonustype = SA_BONUSTYPE_FROM_DB(db);
1292 sa_os_t *sa = hdl->sa_os->os_sa;
1293 sa_idx_tab_t *idx_tab;
1295 sa_hdr_phys = SA_GET_HDR(hdl, buftype);
1297 mutex_enter(&sa->sa_lock);
1299 /* Do we need to byteswap? */
1301 /* only check if not old znode */
1302 if (IS_SA_BONUSTYPE(bonustype) && sa_hdr_phys->sa_magic != SA_MAGIC &&
1303 sa_hdr_phys->sa_magic != 0) {
1304 VERIFY(BSWAP_32(sa_hdr_phys->sa_magic) == SA_MAGIC);
1305 sa_byteswap(hdl, buftype);
1308 idx_tab = sa_find_idx_tab(hdl->sa_os, bonustype, sa_hdr_phys);
1310 if (buftype == SA_BONUS)
1311 hdl->sa_bonus_tab = idx_tab;
1313 hdl->sa_spill_tab = idx_tab;
1315 mutex_exit(&sa->sa_lock);
1321 sa_evict(dmu_buf_t *db, void *sap)
1323 panic("evicting sa dbuf %p\n", (void *)db);
1327 sa_idx_tab_rele(objset_t *os, void *arg)
1329 sa_os_t *sa = os->os_sa;
1330 sa_idx_tab_t *idx_tab = arg;
1332 if (idx_tab == NULL)
1335 mutex_enter(&sa->sa_lock);
1336 if (refcount_remove(&idx_tab->sa_refcount, NULL) == 0) {
1337 list_remove(&idx_tab->sa_layout->lot_idx_tab, idx_tab);
1338 if (idx_tab->sa_variable_lengths)
1339 kmem_free(idx_tab->sa_variable_lengths,
1341 idx_tab->sa_layout->lot_var_sizes);
1342 refcount_destroy(&idx_tab->sa_refcount);
1343 kmem_free(idx_tab->sa_idx_tab,
1344 sizeof (uint32_t) * sa->sa_num_attrs);
1345 kmem_free(idx_tab, sizeof (sa_idx_tab_t));
1347 mutex_exit(&sa->sa_lock);
1351 sa_idx_tab_hold(objset_t *os, sa_idx_tab_t *idx_tab)
1353 ASSERTV(sa_os_t *sa = os->os_sa);
1355 ASSERT(MUTEX_HELD(&sa->sa_lock));
1356 (void) refcount_add(&idx_tab->sa_refcount, NULL);
1360 sa_spill_rele(sa_handle_t *hdl)
1362 mutex_enter(&hdl->sa_lock);
1363 if (hdl->sa_spill) {
1364 sa_idx_tab_rele(hdl->sa_os, hdl->sa_spill_tab);
1365 dmu_buf_rele(hdl->sa_spill, NULL);
1366 hdl->sa_spill = NULL;
1367 hdl->sa_spill_tab = NULL;
1369 mutex_exit(&hdl->sa_lock);
1373 sa_handle_destroy(sa_handle_t *hdl)
1375 mutex_enter(&hdl->sa_lock);
1376 (void) dmu_buf_update_user((dmu_buf_t *)hdl->sa_bonus, hdl,
1379 if (hdl->sa_bonus_tab) {
1380 sa_idx_tab_rele(hdl->sa_os, hdl->sa_bonus_tab);
1381 hdl->sa_bonus_tab = NULL;
1383 if (hdl->sa_spill_tab) {
1384 sa_idx_tab_rele(hdl->sa_os, hdl->sa_spill_tab);
1385 hdl->sa_spill_tab = NULL;
1388 dmu_buf_rele(hdl->sa_bonus, NULL);
1391 dmu_buf_rele((dmu_buf_t *)hdl->sa_spill, NULL);
1392 mutex_exit(&hdl->sa_lock);
1394 kmem_cache_free(sa_cache, hdl);
1398 sa_handle_get_from_db(objset_t *os, dmu_buf_t *db, void *userp,
1399 sa_handle_type_t hdl_type, sa_handle_t **handlepp)
1402 sa_handle_t *handle;
1404 dmu_object_info_t doi;
1406 dmu_object_info_from_db(db, &doi);
1407 ASSERT(doi.doi_bonus_type == DMU_OT_SA ||
1408 doi.doi_bonus_type == DMU_OT_ZNODE);
1410 /* find handle, if it exists */
1411 /* if one doesn't exist then create a new one, and initialize it */
1413 handle = (hdl_type == SA_HDL_SHARED) ? dmu_buf_get_user(db) : NULL;
1414 if (handle == NULL) {
1415 sa_handle_t *newhandle;
1416 handle = kmem_cache_alloc(sa_cache, KM_SLEEP);
1417 handle->sa_userp = userp;
1418 handle->sa_bonus = db;
1420 handle->sa_spill = NULL;
1422 error = sa_build_index(handle, SA_BONUS);
1423 newhandle = (hdl_type == SA_HDL_SHARED) ?
1424 dmu_buf_set_user_ie(db, handle,
1425 NULL, sa_evict) : NULL;
1427 if (newhandle != NULL) {
1428 kmem_cache_free(sa_cache, handle);
1438 sa_handle_get(objset_t *objset, uint64_t objid, void *userp,
1439 sa_handle_type_t hdl_type, sa_handle_t **handlepp)
1444 if ((error = dmu_bonus_hold(objset, objid, NULL, &db)))
1447 return (sa_handle_get_from_db(objset, db, userp, hdl_type,
1452 sa_buf_hold(objset_t *objset, uint64_t obj_num, void *tag, dmu_buf_t **db)
1454 return (dmu_bonus_hold(objset, obj_num, tag, db));
1458 sa_buf_rele(dmu_buf_t *db, void *tag)
1460 dmu_buf_rele(db, tag);
1464 sa_lookup_impl(sa_handle_t *hdl, sa_bulk_attr_t *bulk, int count)
1467 ASSERT(MUTEX_HELD(&hdl->sa_lock));
1468 return (sa_attr_op(hdl, bulk, count, SA_LOOKUP, NULL));
1472 sa_lookup(sa_handle_t *hdl, sa_attr_type_t attr, void *buf, uint32_t buflen)
1475 sa_bulk_attr_t bulk;
1477 bulk.sa_attr = attr;
1479 bulk.sa_length = buflen;
1480 bulk.sa_data_func = NULL;
1483 mutex_enter(&hdl->sa_lock);
1484 error = sa_lookup_impl(hdl, &bulk, 1);
1485 mutex_exit(&hdl->sa_lock);
1491 sa_lookup_uio(sa_handle_t *hdl, sa_attr_type_t attr, uio_t *uio)
1494 sa_bulk_attr_t bulk;
1496 bulk.sa_data = NULL;
1497 bulk.sa_attr = attr;
1498 bulk.sa_data_func = NULL;
1502 mutex_enter(&hdl->sa_lock);
1503 if ((error = sa_attr_op(hdl, &bulk, 1, SA_LOOKUP, NULL)) == 0) {
1504 error = uiomove((void *)bulk.sa_addr, MIN(bulk.sa_size,
1505 uio->uio_resid), UIO_READ, uio);
1507 mutex_exit(&hdl->sa_lock);
1513 sa_find_idx_tab(objset_t *os, dmu_object_type_t bonustype, void *data)
1515 sa_idx_tab_t *idx_tab;
1516 sa_hdr_phys_t *hdr = (sa_hdr_phys_t *)data;
1517 sa_os_t *sa = os->os_sa;
1518 sa_lot_t *tb, search;
1522 * Deterimine layout number. If SA node and header == 0 then
1523 * force the index table to the dummy "1" empty layout.
1525 * The layout number would only be zero for a newly created file
1526 * that has not added any attributes yet, or with crypto enabled which
1527 * doesn't write any attributes to the bonus buffer.
1530 search.lot_num = SA_LAYOUT_NUM(hdr, bonustype);
1532 tb = avl_find(&sa->sa_layout_num_tree, &search, &loc);
1534 /* Verify header size is consistent with layout information */
1536 ASSERT((IS_SA_BONUSTYPE(bonustype) &&
1537 SA_HDR_SIZE_MATCH_LAYOUT(hdr, tb)) || !IS_SA_BONUSTYPE(bonustype) ||
1538 (IS_SA_BONUSTYPE(bonustype) && hdr->sa_layout_info == 0));
1541 * See if any of the already existing TOC entries can be reused?
1544 for (idx_tab = list_head(&tb->lot_idx_tab); idx_tab;
1545 idx_tab = list_next(&tb->lot_idx_tab, idx_tab)) {
1546 boolean_t valid_idx = B_TRUE;
1549 if (tb->lot_var_sizes != 0 &&
1550 idx_tab->sa_variable_lengths != NULL) {
1551 for (i = 0; i != tb->lot_var_sizes; i++) {
1552 if (hdr->sa_lengths[i] !=
1553 idx_tab->sa_variable_lengths[i]) {
1554 valid_idx = B_FALSE;
1560 sa_idx_tab_hold(os, idx_tab);
1565 /* No such luck, create a new entry */
1566 idx_tab = kmem_zalloc(sizeof (sa_idx_tab_t), KM_PUSHPAGE);
1567 idx_tab->sa_idx_tab =
1568 kmem_zalloc(sizeof (uint32_t) * sa->sa_num_attrs, KM_PUSHPAGE);
1569 idx_tab->sa_layout = tb;
1570 refcount_create(&idx_tab->sa_refcount);
1571 if (tb->lot_var_sizes)
1572 idx_tab->sa_variable_lengths = kmem_alloc(sizeof (uint16_t) *
1573 tb->lot_var_sizes, KM_PUSHPAGE);
1575 sa_attr_iter(os, hdr, bonustype, sa_build_idx_tab,
1577 sa_idx_tab_hold(os, idx_tab); /* one hold for consumer */
1578 sa_idx_tab_hold(os, idx_tab); /* one for layout */
1579 list_insert_tail(&tb->lot_idx_tab, idx_tab);
1584 sa_default_locator(void **dataptr, uint32_t *len, uint32_t total_len,
1585 boolean_t start, void *userdata)
1589 *dataptr = userdata;
1594 sa_attr_register_sync(sa_handle_t *hdl, dmu_tx_t *tx)
1596 uint64_t attr_value = 0;
1597 sa_os_t *sa = hdl->sa_os->os_sa;
1598 sa_attr_table_t *tb = sa->sa_attr_table;
1601 mutex_enter(&sa->sa_lock);
1603 if (!sa->sa_need_attr_registration || sa->sa_master_obj == 0) {
1604 mutex_exit(&sa->sa_lock);
1608 if (sa->sa_reg_attr_obj == 0) {
1609 sa->sa_reg_attr_obj = zap_create_link(hdl->sa_os,
1610 DMU_OT_SA_ATTR_REGISTRATION,
1611 sa->sa_master_obj, SA_REGISTRY, tx);
1613 for (i = 0; i != sa->sa_num_attrs; i++) {
1614 if (sa->sa_attr_table[i].sa_registered)
1616 ATTR_ENCODE(attr_value, tb[i].sa_attr, tb[i].sa_length,
1618 VERIFY(0 == zap_update(hdl->sa_os, sa->sa_reg_attr_obj,
1619 tb[i].sa_name, 8, 1, &attr_value, tx));
1620 tb[i].sa_registered = B_TRUE;
1622 sa->sa_need_attr_registration = B_FALSE;
1623 mutex_exit(&sa->sa_lock);
1627 * Replace all attributes with attributes specified in template.
1628 * If dnode had a spill buffer then those attributes will be
1629 * also be replaced, possibly with just an empty spill block
1631 * This interface is intended to only be used for bulk adding of
1632 * attributes for a new file. It will also be used by the ZPL
1633 * when converting and old formatted znode to native SA support.
1636 sa_replace_all_by_template_locked(sa_handle_t *hdl, sa_bulk_attr_t *attr_desc,
1637 int attr_count, dmu_tx_t *tx)
1639 sa_os_t *sa = hdl->sa_os->os_sa;
1641 if (sa->sa_need_attr_registration)
1642 sa_attr_register_sync(hdl, tx);
1643 return (sa_build_layouts(hdl, attr_desc, attr_count, tx));
1647 sa_replace_all_by_template(sa_handle_t *hdl, sa_bulk_attr_t *attr_desc,
1648 int attr_count, dmu_tx_t *tx)
1652 mutex_enter(&hdl->sa_lock);
1653 error = sa_replace_all_by_template_locked(hdl, attr_desc,
1655 mutex_exit(&hdl->sa_lock);
1660 * add/remove/replace a single attribute and then rewrite the entire set
1664 sa_modify_attrs(sa_handle_t *hdl, sa_attr_type_t newattr,
1665 sa_data_op_t action, sa_data_locator_t *locator, void *datastart,
1666 uint16_t buflen, dmu_tx_t *tx)
1668 sa_os_t *sa = hdl->sa_os->os_sa;
1669 dmu_buf_impl_t *db = (dmu_buf_impl_t *)hdl->sa_bonus;
1671 sa_bulk_attr_t *attr_desc;
1673 int bonus_attr_count = 0;
1674 int bonus_data_size = 0;
1675 int spill_attr_count = 0;
1678 int i, j, k, length_idx;
1680 sa_idx_tab_t *idx_tab;
1684 ASSERT(MUTEX_HELD(&hdl->sa_lock));
1686 /* First make of copy of the old data */
1690 if (dn->dn_bonuslen != 0) {
1691 bonus_data_size = hdl->sa_bonus->db_size;
1692 old_data[0] = kmem_alloc(bonus_data_size, KM_SLEEP);
1693 bcopy(hdl->sa_bonus->db_data, old_data[0],
1694 hdl->sa_bonus->db_size);
1695 bonus_attr_count = hdl->sa_bonus_tab->sa_layout->lot_attr_count;
1701 /* Bring spill buffer online if it isn't currently */
1703 if ((error = sa_get_spill(hdl)) == 0) {
1704 ASSERT3U(hdl->sa_spill->db_size, <=, SPA_MAXBLOCKSIZE);
1705 old_data[1] = sa_spill_alloc(KM_SLEEP);
1706 bcopy(hdl->sa_spill->db_data, old_data[1],
1707 hdl->sa_spill->db_size);
1709 hdl->sa_spill_tab->sa_layout->lot_attr_count;
1710 } else if (error && error != ENOENT) {
1712 kmem_free(old_data[0], bonus_data_size);
1718 /* build descriptor of all attributes */
1720 attr_count = bonus_attr_count + spill_attr_count;
1721 if (action == SA_ADD)
1723 else if (action == SA_REMOVE)
1726 attr_desc = kmem_zalloc(sizeof (sa_bulk_attr_t) * attr_count, KM_SLEEP);
1729 * loop through bonus and spill buffer if it exists, and
1730 * build up new attr_descriptor to reset the attributes
1733 count = bonus_attr_count;
1734 hdr = SA_GET_HDR(hdl, SA_BONUS);
1735 idx_tab = SA_IDX_TAB_GET(hdl, SA_BONUS);
1736 for (; k != 2; k++) {
1738 * Iterate over each attribute in layout. Fetch the
1739 * size of variable-length attributes needing rewrite
1740 * from sa_lengths[].
1742 for (i = 0, length_idx = 0; i != count; i++) {
1743 sa_attr_type_t attr;
1745 attr = idx_tab->sa_layout->lot_attrs[i];
1746 length = SA_REGISTERED_LEN(sa, attr);
1747 if (attr == newattr) {
1750 if (action == SA_REMOVE) {
1754 ASSERT(length == 0);
1755 ASSERT(action == SA_REPLACE);
1756 SA_ADD_BULK_ATTR(attr_desc, j, attr,
1757 locator, datastart, buflen);
1760 length = hdr->sa_lengths[length_idx++];
1762 SA_ADD_BULK_ATTR(attr_desc, j, attr,
1764 (TOC_OFF(idx_tab->sa_idx_tab[attr]) +
1765 (uintptr_t)old_data[k]), length);
1768 if (k == 0 && hdl->sa_spill) {
1769 hdr = SA_GET_HDR(hdl, SA_SPILL);
1770 idx_tab = SA_IDX_TAB_GET(hdl, SA_SPILL);
1771 count = spill_attr_count;
1776 if (action == SA_ADD) {
1777 length = SA_REGISTERED_LEN(sa, newattr);
1781 SA_ADD_BULK_ATTR(attr_desc, j, newattr, locator,
1785 error = sa_build_layouts(hdl, attr_desc, attr_count, tx);
1788 kmem_free(old_data[0], bonus_data_size);
1790 sa_spill_free(old_data[1]);
1791 kmem_free(attr_desc, sizeof (sa_bulk_attr_t) * attr_count);
1797 sa_bulk_update_impl(sa_handle_t *hdl, sa_bulk_attr_t *bulk, int count,
1801 sa_os_t *sa = hdl->sa_os->os_sa;
1802 dmu_object_type_t bonustype;
1803 dmu_buf_t *saved_spill;
1806 ASSERT(MUTEX_HELD(&hdl->sa_lock));
1808 bonustype = SA_BONUSTYPE_FROM_DB(SA_GET_DB(hdl, SA_BONUS));
1809 saved_spill = hdl->sa_spill;
1811 /* sync out registration table if necessary */
1812 if (sa->sa_need_attr_registration)
1813 sa_attr_register_sync(hdl, tx);
1815 error = sa_attr_op(hdl, bulk, count, SA_UPDATE, tx);
1816 if (error == 0 && !IS_SA_BONUSTYPE(bonustype) && sa->sa_update_cb)
1817 sa->sa_update_cb(hdl, tx);
1820 * If saved_spill is NULL and current sa_spill is not NULL that
1821 * means we increased the refcount of the spill buffer through
1822 * sa_get_spill() or dmu_spill_hold_by_dnode(). Therefore we
1823 * must release the hold before calling dmu_tx_commit() to avoid
1824 * making a copy of this buffer in dbuf_sync_leaf() due to the
1825 * reference count now being greater than 1.
1827 if (!saved_spill && hdl->sa_spill) {
1828 if (hdl->sa_spill_tab) {
1829 sa_idx_tab_rele(hdl->sa_os, hdl->sa_spill_tab);
1830 hdl->sa_spill_tab = NULL;
1833 dmu_buf_rele((dmu_buf_t *)hdl->sa_spill, NULL);
1834 hdl->sa_spill = NULL;
1841 * update or add new attribute
1844 sa_update(sa_handle_t *hdl, sa_attr_type_t type,
1845 void *buf, uint32_t buflen, dmu_tx_t *tx)
1848 sa_bulk_attr_t bulk;
1850 bulk.sa_attr = type;
1851 bulk.sa_data_func = NULL;
1852 bulk.sa_length = buflen;
1855 mutex_enter(&hdl->sa_lock);
1856 error = sa_bulk_update_impl(hdl, &bulk, 1, tx);
1857 mutex_exit(&hdl->sa_lock);
1862 sa_update_from_cb(sa_handle_t *hdl, sa_attr_type_t attr,
1863 uint32_t buflen, sa_data_locator_t *locator, void *userdata, dmu_tx_t *tx)
1866 sa_bulk_attr_t bulk;
1868 bulk.sa_attr = attr;
1869 bulk.sa_data = userdata;
1870 bulk.sa_data_func = locator;
1871 bulk.sa_length = buflen;
1873 mutex_enter(&hdl->sa_lock);
1874 error = sa_bulk_update_impl(hdl, &bulk, 1, tx);
1875 mutex_exit(&hdl->sa_lock);
1880 * Return size of an attribute
1884 sa_size(sa_handle_t *hdl, sa_attr_type_t attr, int *size)
1886 sa_bulk_attr_t bulk;
1889 bulk.sa_data = NULL;
1890 bulk.sa_attr = attr;
1891 bulk.sa_data_func = NULL;
1894 mutex_enter(&hdl->sa_lock);
1895 if ((error = sa_attr_op(hdl, &bulk, 1, SA_LOOKUP, NULL)) != 0) {
1896 mutex_exit(&hdl->sa_lock);
1899 *size = bulk.sa_size;
1901 mutex_exit(&hdl->sa_lock);
1906 sa_bulk_lookup_locked(sa_handle_t *hdl, sa_bulk_attr_t *attrs, int count)
1909 ASSERT(MUTEX_HELD(&hdl->sa_lock));
1910 return (sa_lookup_impl(hdl, attrs, count));
1914 sa_bulk_lookup(sa_handle_t *hdl, sa_bulk_attr_t *attrs, int count)
1919 mutex_enter(&hdl->sa_lock);
1920 error = sa_bulk_lookup_locked(hdl, attrs, count);
1921 mutex_exit(&hdl->sa_lock);
1926 sa_bulk_update(sa_handle_t *hdl, sa_bulk_attr_t *attrs, int count, dmu_tx_t *tx)
1931 mutex_enter(&hdl->sa_lock);
1932 error = sa_bulk_update_impl(hdl, attrs, count, tx);
1933 mutex_exit(&hdl->sa_lock);
1938 sa_remove(sa_handle_t *hdl, sa_attr_type_t attr, dmu_tx_t *tx)
1942 mutex_enter(&hdl->sa_lock);
1943 error = sa_modify_attrs(hdl, attr, SA_REMOVE, NULL,
1945 mutex_exit(&hdl->sa_lock);
1950 sa_object_info(sa_handle_t *hdl, dmu_object_info_t *doi)
1952 dmu_object_info_from_db((dmu_buf_t *)hdl->sa_bonus, doi);
1956 sa_object_size(sa_handle_t *hdl, uint32_t *blksize, u_longlong_t *nblocks)
1958 dmu_object_size_from_db((dmu_buf_t *)hdl->sa_bonus,
1963 sa_update_user(sa_handle_t *newhdl, sa_handle_t *oldhdl)
1965 (void) dmu_buf_update_user((dmu_buf_t *)newhdl->sa_bonus,
1966 oldhdl, newhdl, NULL, sa_evict);
1967 oldhdl->sa_bonus = NULL;
1971 sa_set_userp(sa_handle_t *hdl, void *ptr)
1973 hdl->sa_userp = ptr;
1977 sa_get_db(sa_handle_t *hdl)
1979 return ((dmu_buf_t *)hdl->sa_bonus);
1983 sa_get_userdata(sa_handle_t *hdl)
1985 return (hdl->sa_userp);
1989 sa_register_update_callback_locked(objset_t *os, sa_update_cb_t *func)
1991 ASSERT(MUTEX_HELD(&os->os_sa->sa_lock));
1992 os->os_sa->sa_update_cb = func;
1996 sa_register_update_callback(objset_t *os, sa_update_cb_t *func)
1999 mutex_enter(&os->os_sa->sa_lock);
2000 sa_register_update_callback_locked(os, func);
2001 mutex_exit(&os->os_sa->sa_lock);
2005 sa_handle_object(sa_handle_t *hdl)
2007 return (hdl->sa_bonus->db_object);
2011 sa_enabled(objset_t *os)
2013 return (os->os_sa == NULL);
2017 sa_set_sa_object(objset_t *os, uint64_t sa_object)
2019 sa_os_t *sa = os->os_sa;
2021 if (sa->sa_master_obj)
2024 sa->sa_master_obj = sa_object;
2030 sa_hdrsize(void *arg)
2032 sa_hdr_phys_t *hdr = arg;
2034 return (SA_HDR_SIZE(hdr));
2038 sa_handle_lock(sa_handle_t *hdl)
2041 mutex_enter(&hdl->sa_lock);
2045 sa_handle_unlock(sa_handle_t *hdl)
2048 mutex_exit(&hdl->sa_lock);
2052 EXPORT_SYMBOL(sa_handle_get);
2053 EXPORT_SYMBOL(sa_handle_get_from_db);
2054 EXPORT_SYMBOL(sa_handle_destroy);
2055 EXPORT_SYMBOL(sa_buf_hold);
2056 EXPORT_SYMBOL(sa_buf_rele);
2057 EXPORT_SYMBOL(sa_spill_rele);
2058 EXPORT_SYMBOL(sa_lookup);
2059 EXPORT_SYMBOL(sa_update);
2060 EXPORT_SYMBOL(sa_remove);
2061 EXPORT_SYMBOL(sa_bulk_lookup);
2062 EXPORT_SYMBOL(sa_bulk_lookup_locked);
2063 EXPORT_SYMBOL(sa_bulk_update);
2064 EXPORT_SYMBOL(sa_size);
2065 EXPORT_SYMBOL(sa_update_from_cb);
2066 EXPORT_SYMBOL(sa_object_info);
2067 EXPORT_SYMBOL(sa_object_size);
2068 EXPORT_SYMBOL(sa_update_user);
2069 EXPORT_SYMBOL(sa_get_userdata);
2070 EXPORT_SYMBOL(sa_set_userp);
2071 EXPORT_SYMBOL(sa_get_db);
2072 EXPORT_SYMBOL(sa_handle_object);
2073 EXPORT_SYMBOL(sa_register_update_callback);
2074 EXPORT_SYMBOL(sa_setup);
2075 EXPORT_SYMBOL(sa_replace_all_by_template);
2076 EXPORT_SYMBOL(sa_replace_all_by_template_locked);
2077 EXPORT_SYMBOL(sa_enabled);
2078 EXPORT_SYMBOL(sa_cache_init);
2079 EXPORT_SYMBOL(sa_cache_fini);
2080 EXPORT_SYMBOL(sa_spill_alloc);
2081 EXPORT_SYMBOL(sa_spill_free);
2082 EXPORT_SYMBOL(sa_set_sa_object);
2083 EXPORT_SYMBOL(sa_hdrsize);
2084 EXPORT_SYMBOL(sa_handle_lock);
2085 EXPORT_SYMBOL(sa_handle_unlock);
2086 EXPORT_SYMBOL(sa_lookup_uio);
2087 #endif /* _KERNEL */