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]
22 * Copyright (c) 2010, Oracle and/or its affiliates. All rights reserved.
25 #include <sys/zfs_context.h>
26 #include <sys/types.h>
27 #include <sys/param.h>
28 #include <sys/systm.h>
29 #include <sys/sysmacros.h>
31 #include <sys/dmu_impl.h>
32 #include <sys/dmu_objset.h>
34 #include <sys/dnode.h>
37 #include <sys/sunddi.h>
38 #include <sys/sa_impl.h>
39 #include <sys/dnode.h>
40 #include <sys/errno.h>
41 #include <sys/zfs_context.h>
44 * ZFS System attributes:
46 * A generic mechanism to allow for arbitrary attributes
47 * to be stored in a dnode. The data will be stored in the bonus buffer of
48 * the dnode and if necessary a special "spill" block will be used to handle
49 * overflow situations. The spill block will be sized to fit the data
50 * from 512 - 128K. When a spill block is used the BP (blkptr_t) for the
51 * spill block is stored at the end of the current bonus buffer. Any
52 * attributes that would be in the way of the blkptr_t will be relocated
53 * into the spill block.
55 * Attribute registration:
57 * Stored persistently on a per dataset basis
58 * a mapping between attribute "string" names and their actual attribute
59 * numeric values, length, and byteswap function. The names are only used
60 * during registration. All attributes are known by their unique attribute
61 * id value. If an attribute can have a variable size then the value
62 * 0 will be used to indicate this.
66 * Attribute layouts are a way to compactly store multiple attributes, but
67 * without taking the overhead associated with managing each attribute
68 * individually. Since you will typically have the same set of attributes
69 * stored in the same order a single table will be used to represent that
70 * layout. The ZPL for example will usually have only about 10 different
71 * layouts (regular files, device files, symlinks,
72 * regular files + scanstamp, files/dir with extended attributes, and then
73 * you have the possibility of all of those minus ACL, because it would
74 * be kicked out into the spill block)
76 * Layouts are simply an array of the attributes and their
77 * ordering i.e. [0, 1, 4, 5, 2]
79 * Each distinct layout is given a unique layout number and that is whats
80 * stored in the header at the beginning of the SA data buffer.
82 * A layout only covers a single dbuf (bonus or spill). If a set of
83 * attributes is split up between the bonus buffer and a spill buffer then
84 * two different layouts will be used. This allows us to byteswap the
85 * spill without looking at the bonus buffer and keeps the on disk format of
86 * the bonus and spill buffer the same.
88 * Adding a single attribute will cause the entire set of attributes to
89 * be rewritten and could result in a new layout number being constructed
90 * as part of the rewrite if no such layout exists for the new set of
91 * attribues. The new attribute will be appended to the end of the already
92 * existing attributes.
94 * Both the attribute registration and attribute layout information are
95 * stored in normal ZAP attributes. Their should be a small number of
96 * known layouts and the set of attributes is assumed to typically be quite
99 * The registered attributes and layout "table" information is maintained
100 * in core and a special "sa_os_t" is attached to the objset_t.
102 * A special interface is provided to allow for quickly applying
103 * a large set of attributes at once. sa_replace_all_by_template() is
104 * used to set an array of attributes. This is used by the ZPL when
105 * creating a brand new file. The template that is passed into the function
106 * specifies the attribute, size for variable length attributes, location of
107 * data and special "data locator" function if the data isn't in a contiguous
110 * Byteswap implications:
111 * Since the SA attributes are not entirely self describing we can't do
112 * the normal byteswap processing. The special ZAP layout attribute and
113 * attribute registration attributes define the byteswap function and the
114 * size of the attributes, unless it is variable sized.
115 * The normal ZFS byteswapping infrastructure assumes you don't need
116 * to read any objects in order to do the necessary byteswapping. Whereas
117 * SA attributes can only be properly byteswapped if the dataset is opened
118 * and the layout/attribute ZAP attributes are available. Because of this
119 * the SA attributes will be byteswapped when they are first accessed by
120 * the SA code that will read the SA data.
123 typedef void (sa_iterfunc_t)(void *hdr, void *addr, sa_attr_type_t,
124 uint16_t length, int length_idx, boolean_t, void *userp);
126 static int sa_build_index(sa_handle_t *hdl, sa_buf_type_t buftype);
127 static void sa_idx_tab_hold(objset_t *os, sa_idx_tab_t *idx_tab);
128 static void *sa_find_idx_tab(objset_t *os, dmu_object_type_t bonustype,
130 static void sa_idx_tab_rele(objset_t *os, void *arg);
131 static void sa_copy_data(sa_data_locator_t *func, void *start, void *target,
133 static int sa_modify_attrs(sa_handle_t *hdl, sa_attr_type_t newattr,
134 sa_data_op_t action, sa_data_locator_t *locator, void *datastart,
135 uint16_t buflen, dmu_tx_t *tx);
137 arc_byteswap_func_t *sa_bswap_table[] = {
138 byteswap_uint64_array,
139 byteswap_uint32_array,
140 byteswap_uint16_array,
141 byteswap_uint8_array,
145 #define SA_COPY_DATA(f, s, t, l) \
149 *(uint64_t *)t = *(uint64_t *)s; \
150 } else if (l == 16) { \
151 *(uint64_t *)t = *(uint64_t *)s; \
152 *(uint64_t *)((uintptr_t)t + 8) = \
153 *(uint64_t *)((uintptr_t)s + 8); \
158 sa_copy_data(f, s, t, l); \
162 * This table is fixed and cannot be changed. Its purpose is to
163 * allow the SA code to work with both old/new ZPL file systems.
164 * It contains the list of legacy attributes. These attributes aren't
165 * stored in the "attribute" registry zap objects, since older ZPL file systems
166 * won't have the registry. Only objsets of type ZFS_TYPE_FILESYSTEM will
167 * use this static table.
169 sa_attr_reg_t sa_legacy_attrs[] = {
170 {"ZPL_ATIME", sizeof (uint64_t) * 2, SA_UINT64_ARRAY, 0},
171 {"ZPL_MTIME", sizeof (uint64_t) * 2, SA_UINT64_ARRAY, 1},
172 {"ZPL_CTIME", sizeof (uint64_t) * 2, SA_UINT64_ARRAY, 2},
173 {"ZPL_CRTIME", sizeof (uint64_t) * 2, SA_UINT64_ARRAY, 3},
174 {"ZPL_GEN", sizeof (uint64_t), SA_UINT64_ARRAY, 4},
175 {"ZPL_MODE", sizeof (uint64_t), SA_UINT64_ARRAY, 5},
176 {"ZPL_SIZE", sizeof (uint64_t), SA_UINT64_ARRAY, 6},
177 {"ZPL_PARENT", sizeof (uint64_t), SA_UINT64_ARRAY, 7},
178 {"ZPL_LINKS", sizeof (uint64_t), SA_UINT64_ARRAY, 8},
179 {"ZPL_XATTR", sizeof (uint64_t), SA_UINT64_ARRAY, 9},
180 {"ZPL_RDEV", sizeof (uint64_t), SA_UINT64_ARRAY, 10},
181 {"ZPL_FLAGS", sizeof (uint64_t), SA_UINT64_ARRAY, 11},
182 {"ZPL_UID", sizeof (uint64_t), SA_UINT64_ARRAY, 12},
183 {"ZPL_GID", sizeof (uint64_t), SA_UINT64_ARRAY, 13},
184 {"ZPL_PAD", sizeof (uint64_t) * 4, SA_UINT64_ARRAY, 14},
185 {"ZPL_ZNODE_ACL", 88, SA_UINT8_ARRAY, 15},
190 * This is only used for objects of type DMU_OT_ZNODE
192 sa_attr_type_t sa_legacy_zpl_layout[] = {
193 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
197 * Special dummy layout used for buffers with no attributes.
200 sa_attr_type_t sa_dummy_zpl_layout[] = { 0 };
202 static int sa_legacy_attr_count = 16;
203 static kmem_cache_t *sa_cache = NULL;
207 sa_cache_constructor(void *buf, void *unused, int kmflag)
209 sa_handle_t *hdl = buf;
211 hdl->sa_bonus_tab = NULL;
212 hdl->sa_spill_tab = NULL;
214 hdl->sa_userp = NULL;
215 hdl->sa_bonus = NULL;
216 hdl->sa_spill = NULL;
217 mutex_init(&hdl->sa_lock, NULL, MUTEX_DEFAULT, NULL);
223 sa_cache_destructor(void *buf, void *unused)
225 sa_handle_t *hdl = buf;
226 mutex_destroy(&hdl->sa_lock);
232 sa_cache = kmem_cache_create("sa_cache",
233 sizeof (sa_handle_t), 0, sa_cache_constructor,
234 sa_cache_destructor, NULL, NULL, NULL, 0);
241 kmem_cache_destroy(sa_cache);
245 layout_num_compare(const void *arg1, const void *arg2)
247 const sa_lot_t *node1 = arg1;
248 const sa_lot_t *node2 = arg2;
250 if (node1->lot_num > node2->lot_num)
252 else if (node1->lot_num < node2->lot_num)
258 layout_hash_compare(const void *arg1, const void *arg2)
260 const sa_lot_t *node1 = arg1;
261 const sa_lot_t *node2 = arg2;
263 if (node1->lot_hash > node2->lot_hash)
265 if (node1->lot_hash < node2->lot_hash)
267 if (node1->lot_instance > node2->lot_instance)
269 if (node1->lot_instance < node2->lot_instance)
275 sa_layout_equal(sa_lot_t *tbf, sa_attr_type_t *attrs, int count)
279 if (count != tbf->lot_attr_count)
282 for (i = 0; i != count; i++) {
283 if (attrs[i] != tbf->lot_attrs[i])
289 #define SA_ATTR_HASH(attr) (zfs_crc64_table[(-1ULL ^ attr) & 0xFF])
292 sa_layout_info_hash(sa_attr_type_t *attrs, int attr_count)
295 uint64_t crc = -1ULL;
297 for (i = 0; i != attr_count; i++)
298 crc ^= SA_ATTR_HASH(attrs[i]);
304 sa_get_spill(sa_handle_t *hdl)
307 if (hdl->sa_spill == NULL) {
308 if ((rc = dmu_spill_hold_existing(hdl->sa_bonus, NULL,
309 &hdl->sa_spill)) == 0)
310 VERIFY(0 == sa_build_index(hdl, SA_SPILL));
319 * Main attribute lookup/update function
320 * returns 0 for success or non zero for failures
322 * Operates on bulk array, first failure will abort further processing
325 sa_attr_op(sa_handle_t *hdl, sa_bulk_attr_t *bulk, int count,
326 sa_data_op_t data_op, dmu_tx_t *tx)
328 sa_os_t *sa = hdl->sa_os->os_sa;
331 sa_buf_type_t buftypes;
336 for (i = 0; i != count; i++) {
337 ASSERT(bulk[i].sa_attr <= hdl->sa_os->os_sa->sa_num_attrs);
339 bulk[i].sa_addr = NULL;
340 /* First check the bonus buffer */
342 if (hdl->sa_bonus_tab && TOC_ATTR_PRESENT(
343 hdl->sa_bonus_tab->sa_idx_tab[bulk[i].sa_attr])) {
344 SA_ATTR_INFO(sa, hdl->sa_bonus_tab,
345 SA_GET_HDR(hdl, SA_BONUS),
346 bulk[i].sa_attr, bulk[i], SA_BONUS, hdl);
347 if (tx && !(buftypes & SA_BONUS)) {
348 dmu_buf_will_dirty(hdl->sa_bonus, tx);
349 buftypes |= SA_BONUS;
352 if (bulk[i].sa_addr == NULL &&
353 ((error = sa_get_spill(hdl)) == 0)) {
354 if (TOC_ATTR_PRESENT(
355 hdl->sa_spill_tab->sa_idx_tab[bulk[i].sa_attr])) {
356 SA_ATTR_INFO(sa, hdl->sa_spill_tab,
357 SA_GET_HDR(hdl, SA_SPILL),
358 bulk[i].sa_attr, bulk[i], SA_SPILL, hdl);
359 if (tx && !(buftypes & SA_SPILL) &&
360 bulk[i].sa_size == bulk[i].sa_length) {
361 dmu_buf_will_dirty(hdl->sa_spill, tx);
362 buftypes |= SA_SPILL;
366 if (error && error != ENOENT) {
367 return ((error == ECKSUM) ? EIO : error);
372 if (bulk[i].sa_addr == NULL)
374 if (bulk[i].sa_data) {
375 SA_COPY_DATA(bulk[i].sa_data_func,
376 bulk[i].sa_addr, bulk[i].sa_data,
382 /* existing rewrite of attr */
383 if (bulk[i].sa_addr &&
384 bulk[i].sa_size == bulk[i].sa_length) {
385 SA_COPY_DATA(bulk[i].sa_data_func,
386 bulk[i].sa_data, bulk[i].sa_addr,
389 } else if (bulk[i].sa_addr) { /* attr size change */
390 error = sa_modify_attrs(hdl, bulk[i].sa_attr,
391 SA_REPLACE, bulk[i].sa_data_func,
392 bulk[i].sa_data, bulk[i].sa_length, tx);
393 } else { /* adding new attribute */
394 error = sa_modify_attrs(hdl, bulk[i].sa_attr,
395 SA_ADD, bulk[i].sa_data_func,
396 bulk[i].sa_data, bulk[i].sa_length, tx);
407 sa_add_layout_entry(objset_t *os, sa_attr_type_t *attrs, int attr_count,
408 uint64_t lot_num, uint64_t hash, boolean_t zapadd, dmu_tx_t *tx)
410 sa_os_t *sa = os->os_sa;
411 sa_lot_t *tb, *findtb;
415 ASSERT(MUTEX_HELD(&sa->sa_lock));
416 tb = kmem_zalloc(sizeof (sa_lot_t), KM_SLEEP);
417 tb->lot_attr_count = attr_count;
418 tb->lot_attrs = kmem_alloc(sizeof (sa_attr_type_t) * attr_count,
420 bcopy(attrs, tb->lot_attrs, sizeof (sa_attr_type_t) * attr_count);
421 tb->lot_num = lot_num;
423 tb->lot_instance = 0;
428 if (sa->sa_layout_attr_obj == 0) {
429 sa->sa_layout_attr_obj = zap_create(os,
430 DMU_OT_SA_ATTR_LAYOUTS, DMU_OT_NONE, 0, tx);
431 VERIFY(zap_add(os, sa->sa_master_obj, SA_LAYOUTS, 8, 1,
432 &sa->sa_layout_attr_obj, tx) == 0);
435 (void) snprintf(attr_name, sizeof (attr_name),
437 VERIFY(0 == zap_update(os, os->os_sa->sa_layout_attr_obj,
438 attr_name, 2, attr_count, attrs, tx));
441 list_create(&tb->lot_idx_tab, sizeof (sa_idx_tab_t),
442 offsetof(sa_idx_tab_t, sa_next));
444 for (i = 0; i != attr_count; i++) {
445 if (sa->sa_attr_table[tb->lot_attrs[i]].sa_length == 0)
449 avl_add(&sa->sa_layout_num_tree, tb);
451 /* verify we don't have a hash collision */
452 if ((findtb = avl_find(&sa->sa_layout_hash_tree, tb, &loc)) != NULL) {
453 for (; findtb && findtb->lot_hash == hash;
454 findtb = AVL_NEXT(&sa->sa_layout_hash_tree, findtb)) {
455 if (findtb->lot_instance != tb->lot_instance)
460 avl_add(&sa->sa_layout_hash_tree, tb);
465 sa_find_layout(objset_t *os, uint64_t hash, sa_attr_type_t *attrs,
466 int count, dmu_tx_t *tx, sa_lot_t **lot)
468 sa_lot_t *tb, tbsearch;
470 sa_os_t *sa = os->os_sa;
471 boolean_t found = B_FALSE;
473 mutex_enter(&sa->sa_lock);
474 tbsearch.lot_hash = hash;
475 tbsearch.lot_instance = 0;
476 tb = avl_find(&sa->sa_layout_hash_tree, &tbsearch, &loc);
478 for (; tb && tb->lot_hash == hash;
479 tb = AVL_NEXT(&sa->sa_layout_hash_tree, tb)) {
480 if (sa_layout_equal(tb, attrs, count) == 0) {
487 tb = sa_add_layout_entry(os, attrs, count,
488 avl_numnodes(&sa->sa_layout_num_tree), hash, B_TRUE, tx);
490 mutex_exit(&sa->sa_lock);
495 sa_resize_spill(sa_handle_t *hdl, uint32_t size, dmu_tx_t *tx)
501 blocksize = SPA_MINBLOCKSIZE;
502 } else if (size > SPA_MAXBLOCKSIZE) {
506 blocksize = P2ROUNDUP_TYPED(size, SPA_MINBLOCKSIZE, uint32_t);
509 error = dbuf_spill_set_blksz(hdl->sa_spill, blocksize, tx);
515 sa_copy_data(sa_data_locator_t *func, void *datastart, void *target, int buflen)
518 bcopy(datastart, target, buflen);
523 void *saptr = target;
528 while (bytes < buflen) {
529 func(&dataptr, &length, buflen, start, datastart);
530 bcopy(dataptr, saptr, length);
531 saptr = (void *)((caddr_t)saptr + length);
539 * Determine several different sizes
540 * first the sa header size
541 * the number of bytes to be stored
542 * if spill would occur the index in the attribute array is returned
544 * the boolean will_spill will be set when spilling is necessary. It
545 * is only set when the buftype is SA_BONUS
548 sa_find_sizes(sa_os_t *sa, sa_bulk_attr_t *attr_desc, int attr_count,
549 dmu_buf_t *db, sa_buf_type_t buftype, int *index, int *total,
550 boolean_t *will_spill)
556 boolean_t done = B_FALSE;
558 if (buftype == SA_BONUS && sa->sa_force_spill) {
561 *will_spill = B_TRUE;
568 if (buftype == SA_BONUS)
569 *will_spill = B_FALSE;
571 hdrsize = (SA_BONUSTYPE_FROM_DB(db) == DMU_OT_ZNODE) ? 0 :
572 sizeof (sa_hdr_phys_t);
574 full_space = (buftype == SA_BONUS) ? DN_MAX_BONUSLEN : db->db_size;
576 for (i = 0; i != attr_count; i++) {
579 *total += attr_desc[i].sa_length;
583 is_var_sz = (SA_REGISTERED_LEN(sa, attr_desc[i].sa_attr) == 0);
588 if (is_var_sz && var_size > 1) {
589 if (P2ROUNDUP(hdrsize + sizeof (uint16_t), 8) +
590 *total < full_space) {
591 hdrsize += sizeof (uint16_t);
595 if (buftype == SA_BONUS)
596 *will_spill = B_TRUE;
602 * find index of where spill *could* occur.
603 * Then continue to count of remainder attribute
604 * space. The sum is used later for sizing bonus
607 if (buftype == SA_BONUS && *index == -1 &&
608 P2ROUNDUP(*total + hdrsize, 8) >
609 (full_space - sizeof (blkptr_t))) {
615 if (P2ROUNDUP(*total + hdrsize, 8) > full_space &&
617 *will_spill = B_TRUE;
620 hdrsize = P2ROUNDUP(hdrsize, 8);
624 #define BUF_SPACE_NEEDED(total, header) (total + header)
627 * Find layout that corresponds to ordering of attributes
628 * If not found a new layout number is created and added to
629 * persistent layout tables.
632 sa_build_layouts(sa_handle_t *hdl, sa_bulk_attr_t *attr_desc, int attr_count,
635 sa_os_t *sa = hdl->sa_os->os_sa;
637 sa_buf_type_t buftype;
638 sa_hdr_phys_t *sahdr;
641 sa_attr_type_t *attrs, *attrs_start;
643 int hdrsize, spillhdrsize;
645 dmu_object_type_t bonustype;
651 dmu_buf_will_dirty(hdl->sa_bonus, tx);
652 bonustype = SA_BONUSTYPE_FROM_DB(hdl->sa_bonus);
654 /* first determine bonus header size and sum of all attributes */
655 hdrsize = sa_find_sizes(sa, attr_desc, attr_count, hdl->sa_bonus,
656 SA_BONUS, &i, &used, &spilling);
658 if (used > SPA_MAXBLOCKSIZE)
661 VERIFY(0 == dmu_set_bonus(hdl->sa_bonus, spilling ?
662 MIN(DN_MAX_BONUSLEN - sizeof (blkptr_t), used + hdrsize) :
663 used + hdrsize, tx));
665 ASSERT((bonustype == DMU_OT_ZNODE && spilling == 0) ||
666 bonustype == DMU_OT_SA);
668 /* setup and size spill buffer when needed */
672 if (hdl->sa_spill == NULL) {
673 VERIFY(dmu_spill_hold_by_bonus(hdl->sa_bonus, NULL,
674 &hdl->sa_spill) == 0);
676 dmu_buf_will_dirty(hdl->sa_spill, tx);
678 spillhdrsize = sa_find_sizes(sa, &attr_desc[i],
679 attr_count - i, hdl->sa_spill, SA_SPILL, &i,
680 &spill_used, &dummy);
682 if (spill_used > SPA_MAXBLOCKSIZE)
685 buf_space = hdl->sa_spill->db_size - spillhdrsize;
686 if (BUF_SPACE_NEEDED(spill_used, spillhdrsize) >
687 hdl->sa_spill->db_size)
688 VERIFY(0 == sa_resize_spill(hdl,
689 BUF_SPACE_NEEDED(spill_used, spillhdrsize), tx));
692 /* setup starting pointers to lay down data */
693 data_start = (void *)((uintptr_t)hdl->sa_bonus->db_data + hdrsize);
694 sahdr = (sa_hdr_phys_t *)hdl->sa_bonus->db_data;
698 buf_space = (sa->sa_force_spill) ?
699 0 : SA_BLKPTR_SPACE - hdrsize;
701 buf_space = hdl->sa_bonus->db_size - hdrsize;
703 attrs_start = attrs = kmem_alloc(sizeof (sa_attr_type_t) * attr_count,
707 for (i = 0, len_idx = 0, hash = -1ULL; i != attr_count; i++) {
710 attrs[i] = attr_desc[i].sa_attr;
711 length = SA_REGISTERED_LEN(sa, attrs[i]);
713 length = attr_desc[i].sa_length;
715 if (buf_space < length) { /* switch to spill buffer */
716 VERIFY(bonustype == DMU_OT_SA);
717 if (buftype == SA_BONUS && !sa->sa_force_spill) {
718 sa_find_layout(hdl->sa_os, hash, attrs_start,
719 lot_count, tx, &lot);
720 SA_SET_HDR(sahdr, lot->lot_num, hdrsize);
727 sahdr = (sa_hdr_phys_t *)hdl->sa_spill->db_data;
728 sahdr->sa_magic = SA_MAGIC;
729 data_start = (void *)((uintptr_t)sahdr +
731 attrs_start = &attrs[i];
732 buf_space = hdl->sa_spill->db_size - spillhdrsize;
735 hash ^= SA_ATTR_HASH(attrs[i]);
736 attr_desc[i].sa_addr = data_start;
737 attr_desc[i].sa_size = length;
738 SA_COPY_DATA(attr_desc[i].sa_data_func, attr_desc[i].sa_data,
740 if (sa->sa_attr_table[attrs[i]].sa_length == 0) {
741 sahdr->sa_lengths[len_idx++] = length;
743 data_start = (void *)P2ROUNDUP(((uintptr_t)data_start +
745 buf_space -= P2ROUNDUP(length, 8);
749 sa_find_layout(hdl->sa_os, hash, attrs_start, lot_count, tx, &lot);
752 * Verify that old znodes always have layout number 0.
753 * Must be DMU_OT_SA for arbitrary layouts
755 VERIFY((bonustype == DMU_OT_ZNODE && lot->lot_num == 0) ||
756 (bonustype == DMU_OT_SA && lot->lot_num > 1));
758 if (bonustype == DMU_OT_SA) {
759 SA_SET_HDR(sahdr, lot->lot_num,
760 buftype == SA_BONUS ? hdrsize : spillhdrsize);
763 kmem_free(attrs, sizeof (sa_attr_type_t) * attr_count);
764 if (hdl->sa_bonus_tab) {
765 sa_idx_tab_rele(hdl->sa_os, hdl->sa_bonus_tab);
766 hdl->sa_bonus_tab = NULL;
768 if (!sa->sa_force_spill)
769 VERIFY(0 == sa_build_index(hdl, SA_BONUS));
771 sa_idx_tab_rele(hdl->sa_os, hdl->sa_spill_tab);
774 * remove spill block that is no longer needed.
776 dmu_buf_rele(hdl->sa_spill, NULL);
777 hdl->sa_spill = NULL;
778 hdl->sa_spill_tab = NULL;
779 VERIFY(0 == dmu_rm_spill(hdl->sa_os,
780 sa_handle_object(hdl), tx));
782 VERIFY(0 == sa_build_index(hdl, SA_SPILL));
790 sa_free_attr_table(sa_os_t *sa)
794 if (sa->sa_attr_table == NULL)
797 for (i = 0; i != sa->sa_num_attrs; i++) {
798 if (sa->sa_attr_table[i].sa_name)
799 kmem_free(sa->sa_attr_table[i].sa_name,
800 strlen(sa->sa_attr_table[i].sa_name) + 1);
803 kmem_free(sa->sa_attr_table,
804 sizeof (sa_attr_table_t) * sa->sa_num_attrs);
806 sa->sa_attr_table = NULL;
810 sa_attr_table_setup(objset_t *os, sa_attr_reg_t *reg_attrs, int count)
812 sa_os_t *sa = os->os_sa;
813 uint64_t sa_attr_count = 0;
814 uint64_t sa_reg_count;
820 int registered_count = 0;
822 dmu_objset_type_t ostype = dmu_objset_type(os);
825 kmem_zalloc(count * sizeof (sa_attr_type_t), KM_SLEEP);
826 sa->sa_user_table_sz = count * sizeof (sa_attr_type_t);
828 if (sa->sa_reg_attr_obj != 0) {
829 error = zap_count(os, sa->sa_reg_attr_obj,
833 * Make sure we retrieved a count and that it isn't zero
835 if (error || (error == 0 && sa_attr_count == 0)) {
840 sa_reg_count = sa_attr_count;
843 if (ostype == DMU_OST_ZFS && sa_attr_count == 0)
844 sa_attr_count += sa_legacy_attr_count;
846 /* Allocate attribute numbers for attributes that aren't registered */
847 for (i = 0; i != count; i++) {
848 boolean_t found = B_FALSE;
851 if (ostype == DMU_OST_ZFS) {
852 for (j = 0; j != sa_legacy_attr_count; j++) {
853 if (strcmp(reg_attrs[i].sa_name,
854 sa_legacy_attrs[j].sa_name) == 0) {
855 sa->sa_user_table[i] =
856 sa_legacy_attrs[j].sa_attr;
864 if (sa->sa_reg_attr_obj)
865 error = zap_lookup(os, sa->sa_reg_attr_obj,
866 reg_attrs[i].sa_name, 8, 1, &attr_value);
871 sa->sa_user_table[i] = (sa_attr_type_t)sa_attr_count;
875 sa->sa_user_table[i] = ATTR_NUM(attr_value);
882 sa->sa_num_attrs = sa_attr_count;
883 tb = sa->sa_attr_table =
884 kmem_zalloc(sizeof (sa_attr_table_t) * sa_attr_count, KM_SLEEP);
887 * Attribute table is constructed from requested attribute list,
888 * previously foreign registered attributes, and also the legacy
889 * ZPL set of attributes.
892 if (sa->sa_reg_attr_obj) {
893 for (zap_cursor_init(&zc, os, sa->sa_reg_attr_obj);
894 (error = zap_cursor_retrieve(&zc, &za)) == 0;
895 zap_cursor_advance(&zc)) {
897 value = za.za_first_integer;
900 tb[ATTR_NUM(value)].sa_attr = ATTR_NUM(value);
901 tb[ATTR_NUM(value)].sa_length = ATTR_LENGTH(value);
902 tb[ATTR_NUM(value)].sa_byteswap = ATTR_BSWAP(value);
903 tb[ATTR_NUM(value)].sa_registered = B_TRUE;
905 if (tb[ATTR_NUM(value)].sa_name) {
908 tb[ATTR_NUM(value)].sa_name =
909 kmem_zalloc(strlen(za.za_name) +1, KM_SLEEP);
910 (void) strlcpy(tb[ATTR_NUM(value)].sa_name, za.za_name,
911 strlen(za.za_name) +1);
913 zap_cursor_fini(&zc);
915 * Make sure we processed the correct number of registered
918 if (registered_count != sa_reg_count) {
925 if (ostype == DMU_OST_ZFS) {
926 for (i = 0; i != sa_legacy_attr_count; i++) {
929 tb[i].sa_attr = sa_legacy_attrs[i].sa_attr;
930 tb[i].sa_length = sa_legacy_attrs[i].sa_length;
931 tb[i].sa_byteswap = sa_legacy_attrs[i].sa_byteswap;
932 tb[i].sa_registered = B_FALSE;
934 kmem_zalloc(strlen(sa_legacy_attrs[i].sa_name) +1,
936 (void) strlcpy(tb[i].sa_name,
937 sa_legacy_attrs[i].sa_name,
938 strlen(sa_legacy_attrs[i].sa_name) + 1);
942 for (i = 0; i != count; i++) {
943 sa_attr_type_t attr_id;
945 attr_id = sa->sa_user_table[i];
946 if (tb[attr_id].sa_name)
949 tb[attr_id].sa_length = reg_attrs[i].sa_length;
950 tb[attr_id].sa_byteswap = reg_attrs[i].sa_byteswap;
951 tb[attr_id].sa_attr = attr_id;
952 tb[attr_id].sa_name =
953 kmem_zalloc(strlen(reg_attrs[i].sa_name) + 1, KM_SLEEP);
954 (void) strlcpy(tb[attr_id].sa_name, reg_attrs[i].sa_name,
955 strlen(reg_attrs[i].sa_name) + 1);
958 sa->sa_need_attr_registration =
959 (sa_attr_count != registered_count);
963 kmem_free(sa->sa_user_table, count * sizeof (sa_attr_type_t));
964 sa->sa_user_table = NULL;
965 sa_free_attr_table(sa);
966 return ((error != 0) ? error : EINVAL);
970 sa_setup(objset_t *os, uint64_t sa_obj, sa_attr_reg_t *reg_attrs, int count,
971 sa_attr_type_t **user_table)
976 dmu_objset_type_t ostype = dmu_objset_type(os);
980 mutex_enter(&os->os_lock);
982 mutex_enter(&os->os_sa->sa_lock);
983 mutex_exit(&os->os_lock);
984 tb = os->os_sa->sa_user_table;
985 mutex_exit(&os->os_sa->sa_lock);
990 sa = kmem_zalloc(sizeof (sa_os_t), KM_SLEEP);
991 mutex_init(&sa->sa_lock, NULL, MUTEX_DEFAULT, NULL);
992 sa->sa_master_obj = sa_obj;
995 mutex_enter(&sa->sa_lock);
996 mutex_exit(&os->os_lock);
997 avl_create(&sa->sa_layout_num_tree, layout_num_compare,
998 sizeof (sa_lot_t), offsetof(sa_lot_t, lot_num_node));
999 avl_create(&sa->sa_layout_hash_tree, layout_hash_compare,
1000 sizeof (sa_lot_t), offsetof(sa_lot_t, lot_hash_node));
1003 error = zap_lookup(os, sa_obj, SA_LAYOUTS,
1004 8, 1, &sa->sa_layout_attr_obj);
1005 if (error != 0 && error != ENOENT)
1007 error = zap_lookup(os, sa_obj, SA_REGISTRY,
1008 8, 1, &sa->sa_reg_attr_obj);
1009 if (error != 0 && error != ENOENT)
1013 if ((error = sa_attr_table_setup(os, reg_attrs, count)) != 0)
1016 if (sa->sa_layout_attr_obj != 0) {
1017 uint64_t layout_count;
1019 error = zap_count(os, sa->sa_layout_attr_obj,
1023 * Layout number count should be > 0
1025 if (error || (error == 0 && layout_count == 0)) {
1031 for (zap_cursor_init(&zc, os, sa->sa_layout_attr_obj);
1032 (error = zap_cursor_retrieve(&zc, &za)) == 0;
1033 zap_cursor_advance(&zc)) {
1034 sa_attr_type_t *lot_attrs;
1037 lot_attrs = kmem_zalloc(sizeof (sa_attr_type_t) *
1038 za.za_num_integers, KM_SLEEP);
1040 if ((error = (zap_lookup(os, sa->sa_layout_attr_obj,
1041 za.za_name, 2, za.za_num_integers,
1042 lot_attrs))) != 0) {
1043 kmem_free(lot_attrs, sizeof (sa_attr_type_t) *
1044 za.za_num_integers);
1047 VERIFY(ddi_strtoull(za.za_name, NULL, 10,
1048 (unsigned long long *)&lot_num) == 0);
1050 (void) sa_add_layout_entry(os, lot_attrs,
1051 za.za_num_integers, lot_num,
1052 sa_layout_info_hash(lot_attrs,
1053 za.za_num_integers), B_FALSE, NULL);
1054 kmem_free(lot_attrs, sizeof (sa_attr_type_t) *
1055 za.za_num_integers);
1057 zap_cursor_fini(&zc);
1060 * Make sure layout count matches number of entries added
1063 if (avl_numnodes(&sa->sa_layout_num_tree) != layout_count) {
1069 /* Add special layout number for old ZNODES */
1070 if (ostype == DMU_OST_ZFS) {
1071 (void) sa_add_layout_entry(os, sa_legacy_zpl_layout,
1072 sa_legacy_attr_count, 0,
1073 sa_layout_info_hash(sa_legacy_zpl_layout,
1074 sa_legacy_attr_count), B_FALSE, NULL);
1076 (void) sa_add_layout_entry(os, sa_dummy_zpl_layout, 0, 1,
1079 *user_table = os->os_sa->sa_user_table;
1080 mutex_exit(&sa->sa_lock);
1084 sa_free_attr_table(sa);
1085 if (sa->sa_user_table)
1086 kmem_free(sa->sa_user_table, sa->sa_user_table_sz);
1087 mutex_exit(&sa->sa_lock);
1088 kmem_free(sa, sizeof (sa_os_t));
1089 return ((error == ECKSUM) ? EIO : error);
1093 sa_tear_down(objset_t *os)
1095 sa_os_t *sa = os->os_sa;
1099 kmem_free(sa->sa_user_table, sa->sa_user_table_sz);
1101 /* Free up attr table */
1103 sa_free_attr_table(sa);
1106 while (layout = avl_destroy_nodes(&sa->sa_layout_hash_tree, &cookie)) {
1108 while (tab = list_head(&layout->lot_idx_tab)) {
1109 ASSERT(refcount_count(&tab->sa_refcount));
1110 sa_idx_tab_rele(os, tab);
1115 while (layout = avl_destroy_nodes(&sa->sa_layout_num_tree, &cookie)) {
1116 kmem_free(layout->lot_attrs,
1117 sizeof (sa_attr_type_t) * layout->lot_attr_count);
1118 kmem_free(layout, sizeof (sa_lot_t));
1121 avl_destroy(&sa->sa_layout_hash_tree);
1122 avl_destroy(&sa->sa_layout_num_tree);
1124 kmem_free(sa, sizeof (sa_os_t));
1129 sa_build_idx_tab(void *hdr, void *attr_addr, sa_attr_type_t attr,
1130 uint16_t length, int length_idx, boolean_t var_length, void *userp)
1132 sa_idx_tab_t *idx_tab = userp;
1135 ASSERT(idx_tab->sa_variable_lengths);
1136 idx_tab->sa_variable_lengths[length_idx] = length;
1138 TOC_ATTR_ENCODE(idx_tab->sa_idx_tab[attr], length_idx,
1139 (uint32_t)((uintptr_t)attr_addr - (uintptr_t)hdr));
1143 sa_attr_iter(objset_t *os, sa_hdr_phys_t *hdr, dmu_object_type_t type,
1144 sa_iterfunc_t func, sa_lot_t *tab, void *userp)
1150 sa_os_t *sa = os->os_sa;
1152 uint16_t *length_start = NULL;
1153 uint8_t length_idx = 0;
1156 search.lot_num = SA_LAYOUT_NUM(hdr, type);
1157 tb = avl_find(&sa->sa_layout_num_tree, &search, &loc);
1161 if (IS_SA_BONUSTYPE(type)) {
1162 data_start = (void *)P2ROUNDUP(((uintptr_t)hdr +
1163 offsetof(sa_hdr_phys_t, sa_lengths) +
1164 (sizeof (uint16_t) * tb->lot_var_sizes)), 8);
1165 length_start = hdr->sa_lengths;
1170 for (i = 0; i != tb->lot_attr_count; i++) {
1171 int attr_length, reg_length;
1174 reg_length = sa->sa_attr_table[tb->lot_attrs[i]].sa_length;
1176 attr_length = reg_length;
1179 attr_length = length_start[length_idx];
1180 idx_len = length_idx++;
1183 func(hdr, data_start, tb->lot_attrs[i], attr_length,
1184 idx_len, reg_length == 0 ? B_TRUE : B_FALSE, userp);
1186 data_start = (void *)P2ROUNDUP(((uintptr_t)data_start +
1193 sa_byteswap_cb(void *hdr, void *attr_addr, sa_attr_type_t attr,
1194 uint16_t length, int length_idx, boolean_t variable_length, void *userp)
1196 sa_handle_t *hdl = userp;
1197 sa_os_t *sa = hdl->sa_os->os_sa;
1199 sa_bswap_table[sa->sa_attr_table[attr].sa_byteswap](attr_addr, length);
1203 sa_byteswap(sa_handle_t *hdl, sa_buf_type_t buftype)
1205 sa_hdr_phys_t *sa_hdr_phys = SA_GET_HDR(hdl, buftype);
1207 sa_os_t *sa = hdl->sa_os->os_sa;
1208 int num_lengths = 1;
1211 ASSERT(MUTEX_HELD(&sa->sa_lock));
1212 if (sa_hdr_phys->sa_magic == SA_MAGIC)
1215 db = SA_GET_DB(hdl, buftype);
1217 if (buftype == SA_SPILL) {
1218 arc_release(db->db_buf, NULL);
1219 arc_buf_thaw(db->db_buf);
1222 sa_hdr_phys->sa_magic = BSWAP_32(sa_hdr_phys->sa_magic);
1223 sa_hdr_phys->sa_layout_info = BSWAP_16(sa_hdr_phys->sa_layout_info);
1226 * Determine number of variable lenghts in header
1227 * The standard 8 byte header has one for free and a
1228 * 16 byte header would have 4 + 1;
1230 if (SA_HDR_SIZE(sa_hdr_phys) > 8)
1231 num_lengths += (SA_HDR_SIZE(sa_hdr_phys) - 8) >> 1;
1232 for (i = 0; i != num_lengths; i++)
1233 sa_hdr_phys->sa_lengths[i] =
1234 BSWAP_16(sa_hdr_phys->sa_lengths[i]);
1236 sa_attr_iter(hdl->sa_os, sa_hdr_phys, DMU_OT_SA,
1237 sa_byteswap_cb, NULL, hdl);
1239 if (buftype == SA_SPILL)
1240 arc_buf_freeze(((dmu_buf_impl_t *)hdl->sa_spill)->db_buf);
1244 sa_build_index(sa_handle_t *hdl, sa_buf_type_t buftype)
1246 sa_hdr_phys_t *sa_hdr_phys;
1247 dmu_buf_impl_t *db = SA_GET_DB(hdl, buftype);
1248 dmu_object_type_t bonustype = SA_BONUSTYPE_FROM_DB(db);
1249 sa_os_t *sa = hdl->sa_os->os_sa;
1250 sa_idx_tab_t *idx_tab;
1252 sa_hdr_phys = SA_GET_HDR(hdl, buftype);
1254 mutex_enter(&sa->sa_lock);
1256 /* Do we need to byteswap? */
1258 /* only check if not old znode */
1259 if (IS_SA_BONUSTYPE(bonustype) && sa_hdr_phys->sa_magic != SA_MAGIC &&
1260 sa_hdr_phys->sa_magic != 0) {
1261 VERIFY(BSWAP_32(sa_hdr_phys->sa_magic) == SA_MAGIC);
1262 sa_byteswap(hdl, buftype);
1265 idx_tab = sa_find_idx_tab(hdl->sa_os, bonustype, sa_hdr_phys);
1267 if (buftype == SA_BONUS)
1268 hdl->sa_bonus_tab = idx_tab;
1270 hdl->sa_spill_tab = idx_tab;
1272 mutex_exit(&sa->sa_lock);
1278 sa_evict(dmu_buf_t *db, void *sap)
1280 panic("evicting sa dbuf %p\n", (void *)db);
1284 sa_idx_tab_rele(objset_t *os, void *arg)
1286 sa_os_t *sa = os->os_sa;
1287 sa_idx_tab_t *idx_tab = arg;
1289 if (idx_tab == NULL)
1292 mutex_enter(&sa->sa_lock);
1293 if (refcount_remove(&idx_tab->sa_refcount, NULL) == 0) {
1294 list_remove(&idx_tab->sa_layout->lot_idx_tab, idx_tab);
1295 if (idx_tab->sa_variable_lengths)
1296 kmem_free(idx_tab->sa_variable_lengths,
1298 idx_tab->sa_layout->lot_var_sizes);
1299 refcount_destroy(&idx_tab->sa_refcount);
1300 kmem_free(idx_tab->sa_idx_tab,
1301 sizeof (uint32_t) * sa->sa_num_attrs);
1302 kmem_free(idx_tab, sizeof (sa_idx_tab_t));
1304 mutex_exit(&sa->sa_lock);
1308 sa_idx_tab_hold(objset_t *os, sa_idx_tab_t *idx_tab)
1310 sa_os_t *sa = os->os_sa;
1312 ASSERT(MUTEX_HELD(&sa->sa_lock));
1313 (void) refcount_add(&idx_tab->sa_refcount, NULL);
1317 sa_handle_destroy(sa_handle_t *hdl)
1319 mutex_enter(&hdl->sa_lock);
1320 (void) dmu_buf_update_user((dmu_buf_t *)hdl->sa_bonus, hdl,
1323 if (hdl->sa_bonus_tab) {
1324 sa_idx_tab_rele(hdl->sa_os, hdl->sa_bonus_tab);
1325 hdl->sa_bonus_tab = NULL;
1327 if (hdl->sa_spill_tab) {
1328 sa_idx_tab_rele(hdl->sa_os, hdl->sa_spill_tab);
1329 hdl->sa_spill_tab = NULL;
1332 dmu_buf_rele(hdl->sa_bonus, NULL);
1335 dmu_buf_rele((dmu_buf_t *)hdl->sa_spill, NULL);
1336 mutex_exit(&hdl->sa_lock);
1338 kmem_cache_free(sa_cache, hdl);
1342 sa_handle_get_from_db(objset_t *os, dmu_buf_t *db, void *userp,
1343 sa_handle_type_t hdl_type, sa_handle_t **handlepp)
1346 dmu_object_info_t doi;
1347 sa_handle_t *handle;
1350 dmu_object_info_from_db(db, &doi);
1351 ASSERT(doi.doi_bonus_type == DMU_OT_SA ||
1352 doi.doi_bonus_type == DMU_OT_ZNODE);
1354 /* find handle, if it exists */
1355 /* if one doesn't exist then create a new one, and initialize it */
1357 handle = (hdl_type == SA_HDL_SHARED) ? dmu_buf_get_user(db) : NULL;
1358 if (handle == NULL) {
1359 sa_handle_t *newhandle;
1360 handle = kmem_cache_alloc(sa_cache, KM_SLEEP);
1361 handle->sa_userp = userp;
1362 handle->sa_bonus = db;
1364 handle->sa_spill = NULL;
1366 error = sa_build_index(handle, SA_BONUS);
1367 newhandle = (hdl_type == SA_HDL_SHARED) ?
1368 dmu_buf_set_user_ie(db, handle,
1369 NULL, sa_evict) : NULL;
1371 if (newhandle != NULL) {
1372 kmem_cache_free(sa_cache, handle);
1382 sa_handle_get(objset_t *objset, uint64_t objid, void *userp,
1383 sa_handle_type_t hdl_type, sa_handle_t **handlepp)
1388 if (error = dmu_bonus_hold(objset, objid, NULL, &db))
1391 return (sa_handle_get_from_db(objset, db, userp, hdl_type,
1396 sa_buf_hold(objset_t *objset, uint64_t obj_num, void *tag, dmu_buf_t **db)
1398 return (dmu_bonus_hold(objset, obj_num, tag, db));
1402 sa_buf_rele(dmu_buf_t *db, void *tag)
1404 dmu_buf_rele(db, tag);
1408 sa_lookup_impl(sa_handle_t *hdl, sa_bulk_attr_t *bulk, int count)
1411 ASSERT(MUTEX_HELD(&hdl->sa_lock));
1412 return (sa_attr_op(hdl, bulk, count, SA_LOOKUP, NULL));
1416 sa_lookup(sa_handle_t *hdl, sa_attr_type_t attr, void *buf, uint32_t buflen)
1419 sa_bulk_attr_t bulk;
1421 bulk.sa_attr = attr;
1423 bulk.sa_length = buflen;
1424 bulk.sa_data_func = NULL;
1427 mutex_enter(&hdl->sa_lock);
1428 error = sa_lookup_impl(hdl, &bulk, 1);
1429 mutex_exit(&hdl->sa_lock);
1435 sa_lookup_uio(sa_handle_t *hdl, sa_attr_type_t attr, uio_t *uio)
1438 sa_bulk_attr_t bulk;
1440 bulk.sa_data = NULL;
1441 bulk.sa_attr = attr;
1442 bulk.sa_data_func = NULL;
1446 mutex_enter(&hdl->sa_lock);
1447 if ((error = sa_attr_op(hdl, &bulk, 1, SA_LOOKUP, NULL)) == 0) {
1448 error = uiomove((void *)bulk.sa_addr, MIN(bulk.sa_size,
1449 uio->uio_resid), UIO_READ, uio);
1451 mutex_exit(&hdl->sa_lock);
1458 sa_find_idx_tab(objset_t *os, dmu_object_type_t bonustype, void *data)
1460 sa_idx_tab_t *idx_tab;
1461 sa_hdr_phys_t *hdr = (sa_hdr_phys_t *)data;
1462 sa_os_t *sa = os->os_sa;
1463 sa_lot_t *tb, search;
1467 * Deterimine layout number. If SA node and header == 0 then
1468 * force the index table to the dummy "1" empty layout.
1470 * The layout number would only be zero for a newly created file
1471 * that has not added any attributes yet, or with crypto enabled which
1472 * doesn't write any attributes to the bonus buffer.
1475 search.lot_num = SA_LAYOUT_NUM(hdr, bonustype);
1477 tb = avl_find(&sa->sa_layout_num_tree, &search, &loc);
1479 /* Verify header size is consistent with layout information */
1481 ASSERT((IS_SA_BONUSTYPE(bonustype) &&
1482 SA_HDR_SIZE_MATCH_LAYOUT(hdr, tb)) || !IS_SA_BONUSTYPE(bonustype) ||
1483 (IS_SA_BONUSTYPE(bonustype) && hdr->sa_layout_info == 0));
1486 * See if any of the already existing TOC entries can be reused?
1489 for (idx_tab = list_head(&tb->lot_idx_tab); idx_tab;
1490 idx_tab = list_next(&tb->lot_idx_tab, idx_tab)) {
1491 boolean_t valid_idx = B_TRUE;
1494 if (tb->lot_var_sizes != 0 &&
1495 idx_tab->sa_variable_lengths != NULL) {
1496 for (i = 0; i != tb->lot_var_sizes; i++) {
1497 if (hdr->sa_lengths[i] !=
1498 idx_tab->sa_variable_lengths[i]) {
1499 valid_idx = B_FALSE;
1505 sa_idx_tab_hold(os, idx_tab);
1510 /* No such luck, create a new entry */
1511 idx_tab = kmem_zalloc(sizeof (sa_idx_tab_t), KM_SLEEP);
1512 idx_tab->sa_idx_tab =
1513 kmem_zalloc(sizeof (uint32_t) * sa->sa_num_attrs, KM_SLEEP);
1514 idx_tab->sa_layout = tb;
1515 refcount_create(&idx_tab->sa_refcount);
1516 if (tb->lot_var_sizes)
1517 idx_tab->sa_variable_lengths = kmem_alloc(sizeof (uint16_t) *
1518 tb->lot_var_sizes, KM_SLEEP);
1520 sa_attr_iter(os, hdr, bonustype, sa_build_idx_tab,
1522 sa_idx_tab_hold(os, idx_tab); /* one hold for consumer */
1523 sa_idx_tab_hold(os, idx_tab); /* one for layout */
1524 list_insert_tail(&tb->lot_idx_tab, idx_tab);
1529 sa_default_locator(void **dataptr, uint32_t *len, uint32_t total_len,
1530 boolean_t start, void *userdata)
1534 *dataptr = userdata;
1539 sa_attr_register_sync(sa_handle_t *hdl, dmu_tx_t *tx)
1541 uint64_t attr_value = 0;
1542 sa_os_t *sa = hdl->sa_os->os_sa;
1543 sa_attr_table_t *tb = sa->sa_attr_table;
1546 mutex_enter(&sa->sa_lock);
1548 if (!sa->sa_need_attr_registration || sa->sa_master_obj == 0) {
1549 mutex_exit(&sa->sa_lock);
1553 if (sa->sa_reg_attr_obj == 0) {
1554 sa->sa_reg_attr_obj = zap_create(hdl->sa_os,
1555 DMU_OT_SA_ATTR_REGISTRATION, DMU_OT_NONE, 0, tx);
1556 VERIFY(zap_add(hdl->sa_os, sa->sa_master_obj,
1557 SA_REGISTRY, 8, 1, &sa->sa_reg_attr_obj, tx) == 0);
1559 for (i = 0; i != sa->sa_num_attrs; i++) {
1560 if (sa->sa_attr_table[i].sa_registered)
1562 ATTR_ENCODE(attr_value, tb[i].sa_attr, tb[i].sa_length,
1564 VERIFY(0 == zap_update(hdl->sa_os, sa->sa_reg_attr_obj,
1565 tb[i].sa_name, 8, 1, &attr_value, tx));
1566 tb[i].sa_registered = B_TRUE;
1568 sa->sa_need_attr_registration = B_FALSE;
1569 mutex_exit(&sa->sa_lock);
1573 * Replace all attributes with attributes specified in template.
1574 * If dnode had a spill buffer then those attributes will be
1575 * also be replaced, possibly with just an empty spill block
1577 * This interface is intended to only be used for bulk adding of
1578 * attributes for a new file. It will also be used by the ZPL
1579 * when converting and old formatted znode to native SA support.
1582 sa_replace_all_by_template_locked(sa_handle_t *hdl, sa_bulk_attr_t *attr_desc,
1583 int attr_count, dmu_tx_t *tx)
1585 sa_os_t *sa = hdl->sa_os->os_sa;
1587 if (sa->sa_need_attr_registration)
1588 sa_attr_register_sync(hdl, tx);
1589 return (sa_build_layouts(hdl, attr_desc, attr_count, tx));
1593 sa_replace_all_by_template(sa_handle_t *hdl, sa_bulk_attr_t *attr_desc,
1594 int attr_count, dmu_tx_t *tx)
1598 mutex_enter(&hdl->sa_lock);
1599 error = sa_replace_all_by_template_locked(hdl, attr_desc,
1601 mutex_exit(&hdl->sa_lock);
1606 * add/remove/replace a single attribute and then rewrite the entire set
1610 sa_modify_attrs(sa_handle_t *hdl, sa_attr_type_t newattr,
1611 sa_data_op_t action, sa_data_locator_t *locator, void *datastart,
1612 uint16_t buflen, dmu_tx_t *tx)
1614 sa_os_t *sa = hdl->sa_os->os_sa;
1615 dmu_buf_impl_t *db = (dmu_buf_impl_t *)hdl->sa_bonus;
1617 sa_bulk_attr_t *attr_desc;
1619 int bonus_attr_count = 0;
1620 int bonus_data_size, spill_data_size;
1621 int spill_attr_count = 0;
1624 int i, j, k, length_idx;
1626 sa_idx_tab_t *idx_tab;
1630 ASSERT(MUTEX_HELD(&hdl->sa_lock));
1632 /* First make of copy of the old data */
1636 if (dn->dn_bonuslen != 0) {
1637 bonus_data_size = hdl->sa_bonus->db_size;
1638 old_data[0] = kmem_alloc(bonus_data_size, KM_SLEEP);
1639 bcopy(hdl->sa_bonus->db_data, old_data[0],
1640 hdl->sa_bonus->db_size);
1641 bonus_attr_count = hdl->sa_bonus_tab->sa_layout->lot_attr_count;
1647 /* Bring spill buffer online if it isn't currently */
1649 if ((error = sa_get_spill(hdl)) == 0) {
1650 spill_data_size = hdl->sa_spill->db_size;
1651 old_data[1] = kmem_alloc(spill_data_size, KM_SLEEP);
1652 bcopy(hdl->sa_spill->db_data, old_data[1],
1653 hdl->sa_spill->db_size);
1655 hdl->sa_spill_tab->sa_layout->lot_attr_count;
1656 } else if (error && error != ENOENT) {
1658 kmem_free(old_data[0], bonus_data_size);
1664 /* build descriptor of all attributes */
1666 attr_count = bonus_attr_count + spill_attr_count;
1667 if (action == SA_ADD)
1669 else if (action == SA_REMOVE)
1672 attr_desc = kmem_zalloc(sizeof (sa_bulk_attr_t) * attr_count, KM_SLEEP);
1675 * loop through bonus and spill buffer if it exists, and
1676 * build up new attr_descriptor to reset the attributes
1679 count = bonus_attr_count;
1680 hdr = SA_GET_HDR(hdl, SA_BONUS);
1681 idx_tab = SA_IDX_TAB_GET(hdl, SA_BONUS);
1682 for (; k != 2; k++) {
1683 /* iterate over each attribute in layout */
1684 for (i = 0, length_idx = 0; i != count; i++) {
1685 sa_attr_type_t attr;
1687 attr = idx_tab->sa_layout->lot_attrs[i];
1688 if (attr == newattr) {
1689 if (action == SA_REMOVE) {
1693 ASSERT(SA_REGISTERED_LEN(sa, attr) == 0);
1694 ASSERT(action == SA_REPLACE);
1695 SA_ADD_BULK_ATTR(attr_desc, j, attr,
1696 locator, datastart, buflen);
1698 length = SA_REGISTERED_LEN(sa, attr);
1700 length = hdr->sa_lengths[length_idx++];
1703 SA_ADD_BULK_ATTR(attr_desc, j, attr,
1705 (TOC_OFF(idx_tab->sa_idx_tab[attr]) +
1706 (uintptr_t)old_data[k]), length);
1709 if (k == 0 && hdl->sa_spill) {
1710 hdr = SA_GET_HDR(hdl, SA_SPILL);
1711 idx_tab = SA_IDX_TAB_GET(hdl, SA_SPILL);
1712 count = spill_attr_count;
1717 if (action == SA_ADD) {
1718 length = SA_REGISTERED_LEN(sa, newattr);
1722 SA_ADD_BULK_ATTR(attr_desc, j, newattr, locator,
1726 error = sa_build_layouts(hdl, attr_desc, attr_count, tx);
1729 kmem_free(old_data[0], bonus_data_size);
1731 kmem_free(old_data[1], spill_data_size);
1732 kmem_free(attr_desc, sizeof (sa_bulk_attr_t) * attr_count);
1738 sa_bulk_update_impl(sa_handle_t *hdl, sa_bulk_attr_t *bulk, int count,
1742 sa_os_t *sa = hdl->sa_os->os_sa;
1743 dmu_object_type_t bonustype;
1745 bonustype = SA_BONUSTYPE_FROM_DB(SA_GET_DB(hdl, SA_BONUS));
1748 ASSERT(MUTEX_HELD(&hdl->sa_lock));
1750 /* sync out registration table if necessary */
1751 if (sa->sa_need_attr_registration)
1752 sa_attr_register_sync(hdl, tx);
1754 error = sa_attr_op(hdl, bulk, count, SA_UPDATE, tx);
1755 if (error == 0 && !IS_SA_BONUSTYPE(bonustype) && sa->sa_update_cb)
1756 sa->sa_update_cb(hdl, tx);
1762 * update or add new attribute
1765 sa_update(sa_handle_t *hdl, sa_attr_type_t type,
1766 void *buf, uint32_t buflen, dmu_tx_t *tx)
1769 sa_bulk_attr_t bulk;
1771 bulk.sa_attr = type;
1772 bulk.sa_data_func = NULL;
1773 bulk.sa_length = buflen;
1776 mutex_enter(&hdl->sa_lock);
1777 error = sa_bulk_update_impl(hdl, &bulk, 1, tx);
1778 mutex_exit(&hdl->sa_lock);
1783 sa_update_from_cb(sa_handle_t *hdl, sa_attr_type_t attr,
1784 uint32_t buflen, sa_data_locator_t *locator, void *userdata, dmu_tx_t *tx)
1787 sa_bulk_attr_t bulk;
1789 bulk.sa_attr = attr;
1790 bulk.sa_data = userdata;
1791 bulk.sa_data_func = locator;
1792 bulk.sa_length = buflen;
1794 mutex_enter(&hdl->sa_lock);
1795 error = sa_bulk_update_impl(hdl, &bulk, 1, tx);
1796 mutex_exit(&hdl->sa_lock);
1801 * Return size of an attribute
1805 sa_size(sa_handle_t *hdl, sa_attr_type_t attr, int *size)
1807 sa_bulk_attr_t bulk;
1810 bulk.sa_data = NULL;
1811 bulk.sa_attr = attr;
1812 bulk.sa_data_func = NULL;
1815 mutex_enter(&hdl->sa_lock);
1816 if ((error = sa_attr_op(hdl, &bulk, 1, SA_LOOKUP, NULL)) != 0) {
1817 mutex_exit(&hdl->sa_lock);
1820 *size = bulk.sa_size;
1822 mutex_exit(&hdl->sa_lock);
1827 sa_bulk_lookup_locked(sa_handle_t *hdl, sa_bulk_attr_t *attrs, int count)
1830 ASSERT(MUTEX_HELD(&hdl->sa_lock));
1831 return (sa_lookup_impl(hdl, attrs, count));
1835 sa_bulk_lookup(sa_handle_t *hdl, sa_bulk_attr_t *attrs, int count)
1840 mutex_enter(&hdl->sa_lock);
1841 error = sa_bulk_lookup_locked(hdl, attrs, count);
1842 mutex_exit(&hdl->sa_lock);
1847 sa_bulk_update(sa_handle_t *hdl, sa_bulk_attr_t *attrs, int count, dmu_tx_t *tx)
1852 mutex_enter(&hdl->sa_lock);
1853 error = sa_bulk_update_impl(hdl, attrs, count, tx);
1854 mutex_exit(&hdl->sa_lock);
1859 sa_remove(sa_handle_t *hdl, sa_attr_type_t attr, dmu_tx_t *tx)
1863 mutex_enter(&hdl->sa_lock);
1864 error = sa_modify_attrs(hdl, attr, SA_REMOVE, NULL,
1866 mutex_exit(&hdl->sa_lock);
1871 sa_object_info(sa_handle_t *hdl, dmu_object_info_t *doi)
1873 dmu_object_info_from_db((dmu_buf_t *)hdl->sa_bonus, doi);
1877 sa_object_size(sa_handle_t *hdl, uint32_t *blksize, u_longlong_t *nblocks)
1879 dmu_object_size_from_db((dmu_buf_t *)hdl->sa_bonus,
1884 sa_update_user(sa_handle_t *newhdl, sa_handle_t *oldhdl)
1886 (void) dmu_buf_update_user((dmu_buf_t *)newhdl->sa_bonus,
1887 oldhdl, newhdl, NULL, sa_evict);
1888 oldhdl->sa_bonus = NULL;
1892 sa_set_userp(sa_handle_t *hdl, void *ptr)
1894 hdl->sa_userp = ptr;
1898 sa_get_db(sa_handle_t *hdl)
1900 return ((dmu_buf_t *)hdl->sa_bonus);
1904 sa_get_userdata(sa_handle_t *hdl)
1906 return (hdl->sa_userp);
1910 sa_register_update_callback_locked(objset_t *os, sa_update_cb_t *func)
1912 ASSERT(MUTEX_HELD(&os->os_sa->sa_lock));
1913 os->os_sa->sa_update_cb = func;
1917 sa_register_update_callback(objset_t *os, sa_update_cb_t *func)
1920 mutex_enter(&os->os_sa->sa_lock);
1921 sa_register_update_callback_locked(os, func);
1922 mutex_exit(&os->os_sa->sa_lock);
1926 sa_handle_object(sa_handle_t *hdl)
1928 return (hdl->sa_bonus->db_object);
1932 sa_enabled(objset_t *os)
1934 return (os->os_sa == NULL);
1938 sa_set_sa_object(objset_t *os, uint64_t sa_object)
1940 sa_os_t *sa = os->os_sa;
1942 if (sa->sa_master_obj)
1945 sa->sa_master_obj = sa_object;
1951 sa_hdrsize(void *arg)
1953 sa_hdr_phys_t *hdr = arg;
1955 return (SA_HDR_SIZE(hdr));
1959 sa_handle_lock(sa_handle_t *hdl)
1962 mutex_enter(&hdl->sa_lock);
1966 sa_handle_unlock(sa_handle_t *hdl)
1969 mutex_exit(&hdl->sa_lock);