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;
204 static kmem_cache_t *spill_cache = NULL;
208 sa_cache_constructor(void *buf, void *unused, int kmflag)
210 sa_handle_t *hdl = buf;
212 hdl->sa_bonus_tab = NULL;
213 hdl->sa_spill_tab = NULL;
215 hdl->sa_userp = NULL;
216 hdl->sa_bonus = NULL;
217 hdl->sa_spill = NULL;
218 mutex_init(&hdl->sa_lock, NULL, MUTEX_DEFAULT, NULL);
224 sa_cache_destructor(void *buf, void *unused)
226 sa_handle_t *hdl = buf;
227 mutex_destroy(&hdl->sa_lock);
233 sa_cache = kmem_cache_create("sa_cache",
234 sizeof (sa_handle_t), 0, sa_cache_constructor,
235 sa_cache_destructor, NULL, NULL, NULL, 0);
236 spill_cache = kmem_cache_create("spill_cache",
237 SPA_MAXBLOCKSIZE, 0, NULL, NULL, NULL, NULL, NULL, 0);
244 kmem_cache_destroy(sa_cache);
247 kmem_cache_destroy(spill_cache);
251 sa_spill_alloc(int flags)
253 return kmem_cache_alloc(spill_cache, flags);
257 sa_spill_free(void *obj)
259 kmem_cache_free(spill_cache, obj);
263 layout_num_compare(const void *arg1, const void *arg2)
265 const sa_lot_t *node1 = arg1;
266 const sa_lot_t *node2 = arg2;
268 if (node1->lot_num > node2->lot_num)
270 else if (node1->lot_num < node2->lot_num)
276 layout_hash_compare(const void *arg1, const void *arg2)
278 const sa_lot_t *node1 = arg1;
279 const sa_lot_t *node2 = arg2;
281 if (node1->lot_hash > node2->lot_hash)
283 if (node1->lot_hash < node2->lot_hash)
285 if (node1->lot_instance > node2->lot_instance)
287 if (node1->lot_instance < node2->lot_instance)
293 sa_layout_equal(sa_lot_t *tbf, sa_attr_type_t *attrs, int count)
297 if (count != tbf->lot_attr_count)
300 for (i = 0; i != count; i++) {
301 if (attrs[i] != tbf->lot_attrs[i])
307 #define SA_ATTR_HASH(attr) (zfs_crc64_table[(-1ULL ^ attr) & 0xFF])
310 sa_layout_info_hash(sa_attr_type_t *attrs, int attr_count)
313 uint64_t crc = -1ULL;
315 for (i = 0; i != attr_count; i++)
316 crc ^= SA_ATTR_HASH(attrs[i]);
322 sa_get_spill(sa_handle_t *hdl)
325 if (hdl->sa_spill == NULL) {
326 if ((rc = dmu_spill_hold_existing(hdl->sa_bonus, NULL,
327 &hdl->sa_spill)) == 0)
328 VERIFY(0 == sa_build_index(hdl, SA_SPILL));
337 * Main attribute lookup/update function
338 * returns 0 for success or non zero for failures
340 * Operates on bulk array, first failure will abort further processing
343 sa_attr_op(sa_handle_t *hdl, sa_bulk_attr_t *bulk, int count,
344 sa_data_op_t data_op, dmu_tx_t *tx)
346 sa_os_t *sa = hdl->sa_os->os_sa;
349 sa_buf_type_t buftypes;
354 for (i = 0; i != count; i++) {
355 ASSERT(bulk[i].sa_attr <= hdl->sa_os->os_sa->sa_num_attrs);
357 bulk[i].sa_addr = NULL;
358 /* First check the bonus buffer */
360 if (hdl->sa_bonus_tab && TOC_ATTR_PRESENT(
361 hdl->sa_bonus_tab->sa_idx_tab[bulk[i].sa_attr])) {
362 SA_ATTR_INFO(sa, hdl->sa_bonus_tab,
363 SA_GET_HDR(hdl, SA_BONUS),
364 bulk[i].sa_attr, bulk[i], SA_BONUS, hdl);
365 if (tx && !(buftypes & SA_BONUS)) {
366 dmu_buf_will_dirty(hdl->sa_bonus, tx);
367 buftypes |= SA_BONUS;
370 if (bulk[i].sa_addr == NULL &&
371 ((error = sa_get_spill(hdl)) == 0)) {
372 if (TOC_ATTR_PRESENT(
373 hdl->sa_spill_tab->sa_idx_tab[bulk[i].sa_attr])) {
374 SA_ATTR_INFO(sa, hdl->sa_spill_tab,
375 SA_GET_HDR(hdl, SA_SPILL),
376 bulk[i].sa_attr, bulk[i], SA_SPILL, hdl);
377 if (tx && !(buftypes & SA_SPILL) &&
378 bulk[i].sa_size == bulk[i].sa_length) {
379 dmu_buf_will_dirty(hdl->sa_spill, tx);
380 buftypes |= SA_SPILL;
384 if (error && error != ENOENT) {
385 return ((error == ECKSUM) ? EIO : error);
390 if (bulk[i].sa_addr == NULL)
392 if (bulk[i].sa_data) {
393 SA_COPY_DATA(bulk[i].sa_data_func,
394 bulk[i].sa_addr, bulk[i].sa_data,
400 /* existing rewrite of attr */
401 if (bulk[i].sa_addr &&
402 bulk[i].sa_size == bulk[i].sa_length) {
403 SA_COPY_DATA(bulk[i].sa_data_func,
404 bulk[i].sa_data, bulk[i].sa_addr,
407 } else if (bulk[i].sa_addr) { /* attr size change */
408 error = sa_modify_attrs(hdl, bulk[i].sa_attr,
409 SA_REPLACE, bulk[i].sa_data_func,
410 bulk[i].sa_data, bulk[i].sa_length, tx);
411 } else { /* adding new attribute */
412 error = sa_modify_attrs(hdl, bulk[i].sa_attr,
413 SA_ADD, bulk[i].sa_data_func,
414 bulk[i].sa_data, bulk[i].sa_length, tx);
427 sa_add_layout_entry(objset_t *os, sa_attr_type_t *attrs, int attr_count,
428 uint64_t lot_num, uint64_t hash, boolean_t zapadd, dmu_tx_t *tx)
430 sa_os_t *sa = os->os_sa;
431 sa_lot_t *tb, *findtb;
435 ASSERT(MUTEX_HELD(&sa->sa_lock));
436 tb = kmem_zalloc(sizeof (sa_lot_t), KM_SLEEP);
437 tb->lot_attr_count = attr_count;
438 tb->lot_attrs = kmem_alloc(sizeof (sa_attr_type_t) * attr_count,
440 bcopy(attrs, tb->lot_attrs, sizeof (sa_attr_type_t) * attr_count);
441 tb->lot_num = lot_num;
443 tb->lot_instance = 0;
448 if (sa->sa_layout_attr_obj == 0) {
449 sa->sa_layout_attr_obj = zap_create(os,
450 DMU_OT_SA_ATTR_LAYOUTS, DMU_OT_NONE, 0, tx);
451 VERIFY(zap_add(os, sa->sa_master_obj, SA_LAYOUTS, 8, 1,
452 &sa->sa_layout_attr_obj, tx) == 0);
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) {
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)
576 boolean_t done = B_FALSE;
578 if (buftype == SA_BONUS && sa->sa_force_spill) {
581 *will_spill = B_TRUE;
588 if (buftype == SA_BONUS)
589 *will_spill = B_FALSE;
591 hdrsize = (SA_BONUSTYPE_FROM_DB(db) == DMU_OT_ZNODE) ? 0 :
592 sizeof (sa_hdr_phys_t);
594 full_space = (buftype == SA_BONUS) ? DN_MAX_BONUSLEN : db->db_size;
596 for (i = 0; i != attr_count; i++) {
599 *total += attr_desc[i].sa_length;
603 is_var_sz = (SA_REGISTERED_LEN(sa, attr_desc[i].sa_attr) == 0);
608 if (is_var_sz && var_size > 1) {
609 if (P2ROUNDUP(hdrsize + sizeof (uint16_t), 8) +
610 *total < full_space) {
611 hdrsize += sizeof (uint16_t);
615 if (buftype == SA_BONUS)
616 *will_spill = B_TRUE;
622 * find index of where spill *could* occur.
623 * Then continue to count of remainder attribute
624 * space. The sum is used later for sizing bonus
627 if (buftype == SA_BONUS && *index == -1 &&
628 (*total + P2ROUNDUP(hdrsize, 8)) >
629 (full_space - sizeof (blkptr_t))) {
635 if ((*total + P2ROUNDUP(hdrsize, 8)) > full_space &&
637 *will_spill = B_TRUE;
640 hdrsize = P2ROUNDUP(hdrsize, 8);
644 #define BUF_SPACE_NEEDED(total, header) (total + header)
647 * Find layout that corresponds to ordering of attributes
648 * If not found a new layout number is created and added to
649 * persistent layout tables.
652 sa_build_layouts(sa_handle_t *hdl, sa_bulk_attr_t *attr_desc, int attr_count,
655 sa_os_t *sa = hdl->sa_os->os_sa;
657 sa_buf_type_t buftype;
658 sa_hdr_phys_t *sahdr;
661 sa_attr_type_t *attrs, *attrs_start;
663 int hdrsize, spillhdrsize = 0;
665 dmu_object_type_t bonustype;
671 dmu_buf_will_dirty(hdl->sa_bonus, tx);
672 bonustype = SA_BONUSTYPE_FROM_DB(hdl->sa_bonus);
674 /* first determine bonus header size and sum of all attributes */
675 hdrsize = sa_find_sizes(sa, attr_desc, attr_count, hdl->sa_bonus,
676 SA_BONUS, &i, &used, &spilling);
678 if (used > SPA_MAXBLOCKSIZE)
681 VERIFY(0 == dmu_set_bonus(hdl->sa_bonus, spilling ?
682 MIN(DN_MAX_BONUSLEN - sizeof (blkptr_t), used + hdrsize) :
683 used + hdrsize, tx));
685 ASSERT((bonustype == DMU_OT_ZNODE && spilling == 0) ||
686 bonustype == DMU_OT_SA);
688 /* setup and size spill buffer when needed */
692 if (hdl->sa_spill == NULL) {
693 VERIFY(dmu_spill_hold_by_bonus(hdl->sa_bonus, NULL,
694 &hdl->sa_spill) == 0);
696 dmu_buf_will_dirty(hdl->sa_spill, tx);
698 spillhdrsize = sa_find_sizes(sa, &attr_desc[i],
699 attr_count - i, hdl->sa_spill, SA_SPILL, &i,
700 &spill_used, &dummy);
702 if (spill_used > SPA_MAXBLOCKSIZE)
705 buf_space = hdl->sa_spill->db_size - spillhdrsize;
706 if (BUF_SPACE_NEEDED(spill_used, spillhdrsize) >
707 hdl->sa_spill->db_size)
708 VERIFY(0 == sa_resize_spill(hdl,
709 BUF_SPACE_NEEDED(spill_used, spillhdrsize), tx));
712 /* setup starting pointers to lay down data */
713 data_start = (void *)((uintptr_t)hdl->sa_bonus->db_data + hdrsize);
714 sahdr = (sa_hdr_phys_t *)hdl->sa_bonus->db_data;
718 buf_space = (sa->sa_force_spill) ?
719 0 : SA_BLKPTR_SPACE - hdrsize;
721 buf_space = hdl->sa_bonus->db_size - hdrsize;
723 attrs_start = attrs = kmem_alloc(sizeof (sa_attr_type_t) * attr_count,
727 for (i = 0, len_idx = 0, hash = -1ULL; i != attr_count; i++) {
730 attrs[i] = attr_desc[i].sa_attr;
731 length = SA_REGISTERED_LEN(sa, attrs[i]);
733 length = attr_desc[i].sa_length;
735 if (buf_space < length) { /* switch to spill buffer */
736 VERIFY(bonustype == DMU_OT_SA);
737 if (buftype == SA_BONUS && !sa->sa_force_spill) {
738 sa_find_layout(hdl->sa_os, hash, attrs_start,
739 lot_count, tx, &lot);
740 SA_SET_HDR(sahdr, lot->lot_num, hdrsize);
747 sahdr = (sa_hdr_phys_t *)hdl->sa_spill->db_data;
748 sahdr->sa_magic = SA_MAGIC;
749 data_start = (void *)((uintptr_t)sahdr +
751 attrs_start = &attrs[i];
752 buf_space = hdl->sa_spill->db_size - spillhdrsize;
755 hash ^= SA_ATTR_HASH(attrs[i]);
756 attr_desc[i].sa_addr = data_start;
757 attr_desc[i].sa_size = length;
758 SA_COPY_DATA(attr_desc[i].sa_data_func, attr_desc[i].sa_data,
760 if (sa->sa_attr_table[attrs[i]].sa_length == 0) {
761 sahdr->sa_lengths[len_idx++] = length;
763 data_start = (void *)P2ROUNDUP(((uintptr_t)data_start +
765 buf_space -= P2ROUNDUP(length, 8);
769 sa_find_layout(hdl->sa_os, hash, attrs_start, lot_count, tx, &lot);
772 * Verify that old znodes always have layout number 0.
773 * Must be DMU_OT_SA for arbitrary layouts
775 VERIFY((bonustype == DMU_OT_ZNODE && lot->lot_num == 0) ||
776 (bonustype == DMU_OT_SA && lot->lot_num > 1));
778 if (bonustype == DMU_OT_SA) {
779 SA_SET_HDR(sahdr, lot->lot_num,
780 buftype == SA_BONUS ? hdrsize : spillhdrsize);
783 kmem_free(attrs, sizeof (sa_attr_type_t) * attr_count);
784 if (hdl->sa_bonus_tab) {
785 sa_idx_tab_rele(hdl->sa_os, hdl->sa_bonus_tab);
786 hdl->sa_bonus_tab = NULL;
788 if (!sa->sa_force_spill)
789 VERIFY(0 == sa_build_index(hdl, SA_BONUS));
791 sa_idx_tab_rele(hdl->sa_os, hdl->sa_spill_tab);
794 * remove spill block that is no longer needed.
796 dmu_buf_rele(hdl->sa_spill, NULL);
797 hdl->sa_spill = NULL;
798 hdl->sa_spill_tab = NULL;
799 VERIFY(0 == dmu_rm_spill(hdl->sa_os,
800 sa_handle_object(hdl), tx));
802 VERIFY(0 == sa_build_index(hdl, SA_SPILL));
810 sa_free_attr_table(sa_os_t *sa)
814 if (sa->sa_attr_table == NULL)
817 for (i = 0; i != sa->sa_num_attrs; i++) {
818 if (sa->sa_attr_table[i].sa_name)
819 kmem_free(sa->sa_attr_table[i].sa_name,
820 strlen(sa->sa_attr_table[i].sa_name) + 1);
823 kmem_free(sa->sa_attr_table,
824 sizeof (sa_attr_table_t) * sa->sa_num_attrs);
826 sa->sa_attr_table = NULL;
830 sa_attr_table_setup(objset_t *os, sa_attr_reg_t *reg_attrs, int count)
832 sa_os_t *sa = os->os_sa;
833 uint64_t sa_attr_count = 0;
834 uint64_t sa_reg_count = 0;
840 int registered_count = 0;
842 dmu_objset_type_t ostype = dmu_objset_type(os);
845 kmem_zalloc(count * sizeof (sa_attr_type_t), KM_SLEEP);
846 sa->sa_user_table_sz = count * sizeof (sa_attr_type_t);
848 if (sa->sa_reg_attr_obj != 0) {
849 error = zap_count(os, sa->sa_reg_attr_obj,
853 * Make sure we retrieved a count and that it isn't zero
855 if (error || (error == 0 && sa_attr_count == 0)) {
860 sa_reg_count = sa_attr_count;
863 if (ostype == DMU_OST_ZFS && sa_attr_count == 0)
864 sa_attr_count += sa_legacy_attr_count;
866 /* Allocate attribute numbers for attributes that aren't registered */
867 for (i = 0; i != count; i++) {
868 boolean_t found = B_FALSE;
871 if (ostype == DMU_OST_ZFS) {
872 for (j = 0; j != sa_legacy_attr_count; j++) {
873 if (strcmp(reg_attrs[i].sa_name,
874 sa_legacy_attrs[j].sa_name) == 0) {
875 sa->sa_user_table[i] =
876 sa_legacy_attrs[j].sa_attr;
884 if (sa->sa_reg_attr_obj)
885 error = zap_lookup(os, sa->sa_reg_attr_obj,
886 reg_attrs[i].sa_name, 8, 1, &attr_value);
891 sa->sa_user_table[i] = (sa_attr_type_t)sa_attr_count;
895 sa->sa_user_table[i] = ATTR_NUM(attr_value);
902 sa->sa_num_attrs = sa_attr_count;
903 tb = sa->sa_attr_table =
904 kmem_zalloc(sizeof (sa_attr_table_t) * sa_attr_count, KM_SLEEP);
907 * Attribute table is constructed from requested attribute list,
908 * previously foreign registered attributes, and also the legacy
909 * ZPL set of attributes.
912 if (sa->sa_reg_attr_obj) {
913 for (zap_cursor_init(&zc, os, sa->sa_reg_attr_obj);
914 (error = zap_cursor_retrieve(&zc, &za)) == 0;
915 zap_cursor_advance(&zc)) {
917 value = za.za_first_integer;
920 tb[ATTR_NUM(value)].sa_attr = ATTR_NUM(value);
921 tb[ATTR_NUM(value)].sa_length = ATTR_LENGTH(value);
922 tb[ATTR_NUM(value)].sa_byteswap = ATTR_BSWAP(value);
923 tb[ATTR_NUM(value)].sa_registered = B_TRUE;
925 if (tb[ATTR_NUM(value)].sa_name) {
928 tb[ATTR_NUM(value)].sa_name =
929 kmem_zalloc(strlen(za.za_name) +1, KM_SLEEP);
930 (void) strlcpy(tb[ATTR_NUM(value)].sa_name, za.za_name,
931 strlen(za.za_name) +1);
933 zap_cursor_fini(&zc);
935 * Make sure we processed the correct number of registered
938 if (registered_count != sa_reg_count) {
945 if (ostype == DMU_OST_ZFS) {
946 for (i = 0; i != sa_legacy_attr_count; i++) {
949 tb[i].sa_attr = sa_legacy_attrs[i].sa_attr;
950 tb[i].sa_length = sa_legacy_attrs[i].sa_length;
951 tb[i].sa_byteswap = sa_legacy_attrs[i].sa_byteswap;
952 tb[i].sa_registered = B_FALSE;
954 kmem_zalloc(strlen(sa_legacy_attrs[i].sa_name) +1,
956 (void) strlcpy(tb[i].sa_name,
957 sa_legacy_attrs[i].sa_name,
958 strlen(sa_legacy_attrs[i].sa_name) + 1);
962 for (i = 0; i != count; i++) {
963 sa_attr_type_t attr_id;
965 attr_id = sa->sa_user_table[i];
966 if (tb[attr_id].sa_name)
969 tb[attr_id].sa_length = reg_attrs[i].sa_length;
970 tb[attr_id].sa_byteswap = reg_attrs[i].sa_byteswap;
971 tb[attr_id].sa_attr = attr_id;
972 tb[attr_id].sa_name =
973 kmem_zalloc(strlen(reg_attrs[i].sa_name) + 1, KM_SLEEP);
974 (void) strlcpy(tb[attr_id].sa_name, reg_attrs[i].sa_name,
975 strlen(reg_attrs[i].sa_name) + 1);
978 sa->sa_need_attr_registration =
979 (sa_attr_count != registered_count);
983 kmem_free(sa->sa_user_table, count * sizeof (sa_attr_type_t));
984 sa->sa_user_table = NULL;
985 sa_free_attr_table(sa);
986 return ((error != 0) ? error : EINVAL);
990 sa_setup(objset_t *os, uint64_t sa_obj, sa_attr_reg_t *reg_attrs, int count,
991 sa_attr_type_t **user_table)
996 dmu_objset_type_t ostype = dmu_objset_type(os);
1000 mutex_enter(&os->os_lock);
1002 mutex_enter(&os->os_sa->sa_lock);
1003 mutex_exit(&os->os_lock);
1004 tb = os->os_sa->sa_user_table;
1005 mutex_exit(&os->os_sa->sa_lock);
1010 sa = kmem_zalloc(sizeof (sa_os_t), KM_SLEEP);
1011 mutex_init(&sa->sa_lock, NULL, MUTEX_DEFAULT, NULL);
1012 sa->sa_master_obj = sa_obj;
1015 mutex_enter(&sa->sa_lock);
1016 mutex_exit(&os->os_lock);
1017 avl_create(&sa->sa_layout_num_tree, layout_num_compare,
1018 sizeof (sa_lot_t), offsetof(sa_lot_t, lot_num_node));
1019 avl_create(&sa->sa_layout_hash_tree, layout_hash_compare,
1020 sizeof (sa_lot_t), offsetof(sa_lot_t, lot_hash_node));
1023 error = zap_lookup(os, sa_obj, SA_LAYOUTS,
1024 8, 1, &sa->sa_layout_attr_obj);
1025 if (error != 0 && error != ENOENT)
1027 error = zap_lookup(os, sa_obj, SA_REGISTRY,
1028 8, 1, &sa->sa_reg_attr_obj);
1029 if (error != 0 && error != ENOENT)
1033 if ((error = sa_attr_table_setup(os, reg_attrs, count)) != 0)
1036 if (sa->sa_layout_attr_obj != 0) {
1037 uint64_t layout_count;
1039 error = zap_count(os, sa->sa_layout_attr_obj,
1043 * Layout number count should be > 0
1045 if (error || (error == 0 && layout_count == 0)) {
1051 for (zap_cursor_init(&zc, os, sa->sa_layout_attr_obj);
1052 (error = zap_cursor_retrieve(&zc, &za)) == 0;
1053 zap_cursor_advance(&zc)) {
1054 sa_attr_type_t *lot_attrs;
1057 lot_attrs = kmem_zalloc(sizeof (sa_attr_type_t) *
1058 za.za_num_integers, KM_SLEEP);
1060 if ((error = (zap_lookup(os, sa->sa_layout_attr_obj,
1061 za.za_name, 2, za.za_num_integers,
1062 lot_attrs))) != 0) {
1063 kmem_free(lot_attrs, sizeof (sa_attr_type_t) *
1064 za.za_num_integers);
1067 VERIFY(ddi_strtoull(za.za_name, NULL, 10,
1068 (unsigned long long *)&lot_num) == 0);
1070 (void) sa_add_layout_entry(os, lot_attrs,
1071 za.za_num_integers, lot_num,
1072 sa_layout_info_hash(lot_attrs,
1073 za.za_num_integers), B_FALSE, NULL);
1074 kmem_free(lot_attrs, sizeof (sa_attr_type_t) *
1075 za.za_num_integers);
1077 zap_cursor_fini(&zc);
1080 * Make sure layout count matches number of entries added
1083 if (avl_numnodes(&sa->sa_layout_num_tree) != layout_count) {
1089 /* Add special layout number for old ZNODES */
1090 if (ostype == DMU_OST_ZFS) {
1091 (void) sa_add_layout_entry(os, sa_legacy_zpl_layout,
1092 sa_legacy_attr_count, 0,
1093 sa_layout_info_hash(sa_legacy_zpl_layout,
1094 sa_legacy_attr_count), B_FALSE, NULL);
1096 (void) sa_add_layout_entry(os, sa_dummy_zpl_layout, 0, 1,
1099 *user_table = os->os_sa->sa_user_table;
1100 mutex_exit(&sa->sa_lock);
1104 sa_free_attr_table(sa);
1105 if (sa->sa_user_table)
1106 kmem_free(sa->sa_user_table, sa->sa_user_table_sz);
1107 mutex_exit(&sa->sa_lock);
1108 kmem_free(sa, sizeof (sa_os_t));
1109 return ((error == ECKSUM) ? EIO : error);
1113 sa_tear_down(objset_t *os)
1115 sa_os_t *sa = os->os_sa;
1119 kmem_free(sa->sa_user_table, sa->sa_user_table_sz);
1121 /* Free up attr table */
1123 sa_free_attr_table(sa);
1126 while ((layout = avl_destroy_nodes(&sa->sa_layout_hash_tree, &cookie))){
1128 while ((tab = list_head(&layout->lot_idx_tab))) {
1129 ASSERT(refcount_count(&tab->sa_refcount));
1130 sa_idx_tab_rele(os, tab);
1135 while ((layout = avl_destroy_nodes(&sa->sa_layout_num_tree, &cookie))){
1136 kmem_free(layout->lot_attrs,
1137 sizeof (sa_attr_type_t) * layout->lot_attr_count);
1138 kmem_free(layout, sizeof (sa_lot_t));
1141 avl_destroy(&sa->sa_layout_hash_tree);
1142 avl_destroy(&sa->sa_layout_num_tree);
1144 kmem_free(sa, sizeof (sa_os_t));
1149 sa_build_idx_tab(void *hdr, void *attr_addr, sa_attr_type_t attr,
1150 uint16_t length, int length_idx, boolean_t var_length, void *userp)
1152 sa_idx_tab_t *idx_tab = userp;
1155 ASSERT(idx_tab->sa_variable_lengths);
1156 idx_tab->sa_variable_lengths[length_idx] = length;
1158 TOC_ATTR_ENCODE(idx_tab->sa_idx_tab[attr], length_idx,
1159 (uint32_t)((uintptr_t)attr_addr - (uintptr_t)hdr));
1163 sa_attr_iter(objset_t *os, sa_hdr_phys_t *hdr, dmu_object_type_t type,
1164 sa_iterfunc_t func, sa_lot_t *tab, void *userp)
1170 sa_os_t *sa = os->os_sa;
1172 uint16_t *length_start = NULL;
1173 uint8_t length_idx = 0;
1176 search.lot_num = SA_LAYOUT_NUM(hdr, type);
1177 tb = avl_find(&sa->sa_layout_num_tree, &search, &loc);
1181 if (IS_SA_BONUSTYPE(type)) {
1182 data_start = (void *)P2ROUNDUP(((uintptr_t)hdr +
1183 offsetof(sa_hdr_phys_t, sa_lengths) +
1184 (sizeof (uint16_t) * tb->lot_var_sizes)), 8);
1185 length_start = hdr->sa_lengths;
1190 for (i = 0; i != tb->lot_attr_count; i++) {
1191 int attr_length, reg_length;
1194 reg_length = sa->sa_attr_table[tb->lot_attrs[i]].sa_length;
1196 attr_length = reg_length;
1199 attr_length = length_start[length_idx];
1200 idx_len = length_idx++;
1203 func(hdr, data_start, tb->lot_attrs[i], attr_length,
1204 idx_len, reg_length == 0 ? B_TRUE : B_FALSE, userp);
1206 data_start = (void *)P2ROUNDUP(((uintptr_t)data_start +
1213 sa_byteswap_cb(void *hdr, void *attr_addr, sa_attr_type_t attr,
1214 uint16_t length, int length_idx, boolean_t variable_length, void *userp)
1216 sa_handle_t *hdl = userp;
1217 sa_os_t *sa = hdl->sa_os->os_sa;
1219 sa_bswap_table[sa->sa_attr_table[attr].sa_byteswap](attr_addr, length);
1223 sa_byteswap(sa_handle_t *hdl, sa_buf_type_t buftype)
1225 sa_hdr_phys_t *sa_hdr_phys = SA_GET_HDR(hdl, buftype);
1227 int num_lengths = 1;
1229 ASSERTV(sa_os_t *sa = hdl->sa_os->os_sa);
1231 ASSERT(MUTEX_HELD(&sa->sa_lock));
1232 if (sa_hdr_phys->sa_magic == SA_MAGIC)
1235 db = SA_GET_DB(hdl, buftype);
1237 if (buftype == SA_SPILL) {
1238 arc_release(db->db_buf, NULL);
1239 arc_buf_thaw(db->db_buf);
1242 sa_hdr_phys->sa_magic = BSWAP_32(sa_hdr_phys->sa_magic);
1243 sa_hdr_phys->sa_layout_info = BSWAP_16(sa_hdr_phys->sa_layout_info);
1246 * Determine number of variable lenghts in header
1247 * The standard 8 byte header has one for free and a
1248 * 16 byte header would have 4 + 1;
1250 if (SA_HDR_SIZE(sa_hdr_phys) > 8)
1251 num_lengths += (SA_HDR_SIZE(sa_hdr_phys) - 8) >> 1;
1252 for (i = 0; i != num_lengths; i++)
1253 sa_hdr_phys->sa_lengths[i] =
1254 BSWAP_16(sa_hdr_phys->sa_lengths[i]);
1256 sa_attr_iter(hdl->sa_os, sa_hdr_phys, DMU_OT_SA,
1257 sa_byteswap_cb, NULL, hdl);
1259 if (buftype == SA_SPILL)
1260 arc_buf_freeze(((dmu_buf_impl_t *)hdl->sa_spill)->db_buf);
1264 sa_build_index(sa_handle_t *hdl, sa_buf_type_t buftype)
1266 sa_hdr_phys_t *sa_hdr_phys;
1267 dmu_buf_impl_t *db = SA_GET_DB(hdl, buftype);
1268 dmu_object_type_t bonustype = SA_BONUSTYPE_FROM_DB(db);
1269 sa_os_t *sa = hdl->sa_os->os_sa;
1270 sa_idx_tab_t *idx_tab;
1272 sa_hdr_phys = SA_GET_HDR(hdl, buftype);
1274 mutex_enter(&sa->sa_lock);
1276 /* Do we need to byteswap? */
1278 /* only check if not old znode */
1279 if (IS_SA_BONUSTYPE(bonustype) && sa_hdr_phys->sa_magic != SA_MAGIC &&
1280 sa_hdr_phys->sa_magic != 0) {
1281 VERIFY(BSWAP_32(sa_hdr_phys->sa_magic) == SA_MAGIC);
1282 sa_byteswap(hdl, buftype);
1285 idx_tab = sa_find_idx_tab(hdl->sa_os, bonustype, sa_hdr_phys);
1287 if (buftype == SA_BONUS)
1288 hdl->sa_bonus_tab = idx_tab;
1290 hdl->sa_spill_tab = idx_tab;
1292 mutex_exit(&sa->sa_lock);
1298 sa_evict(dmu_buf_t *db, void *sap)
1300 panic("evicting sa dbuf %p\n", (void *)db);
1304 sa_idx_tab_rele(objset_t *os, void *arg)
1306 sa_os_t *sa = os->os_sa;
1307 sa_idx_tab_t *idx_tab = arg;
1309 if (idx_tab == NULL)
1312 mutex_enter(&sa->sa_lock);
1313 if (refcount_remove(&idx_tab->sa_refcount, NULL) == 0) {
1314 list_remove(&idx_tab->sa_layout->lot_idx_tab, idx_tab);
1315 if (idx_tab->sa_variable_lengths)
1316 kmem_free(idx_tab->sa_variable_lengths,
1318 idx_tab->sa_layout->lot_var_sizes);
1319 refcount_destroy(&idx_tab->sa_refcount);
1320 kmem_free(idx_tab->sa_idx_tab,
1321 sizeof (uint32_t) * sa->sa_num_attrs);
1322 kmem_free(idx_tab, sizeof (sa_idx_tab_t));
1324 mutex_exit(&sa->sa_lock);
1328 sa_idx_tab_hold(objset_t *os, sa_idx_tab_t *idx_tab)
1330 ASSERTV(sa_os_t *sa = os->os_sa);
1332 ASSERT(MUTEX_HELD(&sa->sa_lock));
1333 (void) refcount_add(&idx_tab->sa_refcount, NULL);
1337 sa_handle_destroy(sa_handle_t *hdl)
1339 mutex_enter(&hdl->sa_lock);
1340 (void) dmu_buf_update_user((dmu_buf_t *)hdl->sa_bonus, hdl,
1343 if (hdl->sa_bonus_tab) {
1344 sa_idx_tab_rele(hdl->sa_os, hdl->sa_bonus_tab);
1345 hdl->sa_bonus_tab = NULL;
1347 if (hdl->sa_spill_tab) {
1348 sa_idx_tab_rele(hdl->sa_os, hdl->sa_spill_tab);
1349 hdl->sa_spill_tab = NULL;
1352 dmu_buf_rele(hdl->sa_bonus, NULL);
1355 dmu_buf_rele((dmu_buf_t *)hdl->sa_spill, NULL);
1356 mutex_exit(&hdl->sa_lock);
1358 kmem_cache_free(sa_cache, hdl);
1362 sa_handle_get_from_db(objset_t *os, dmu_buf_t *db, void *userp,
1363 sa_handle_type_t hdl_type, sa_handle_t **handlepp)
1366 sa_handle_t *handle;
1368 dmu_object_info_t doi;
1370 dmu_object_info_from_db(db, &doi);
1371 ASSERT(doi.doi_bonus_type == DMU_OT_SA ||
1372 doi.doi_bonus_type == DMU_OT_ZNODE);
1374 /* find handle, if it exists */
1375 /* if one doesn't exist then create a new one, and initialize it */
1377 handle = (hdl_type == SA_HDL_SHARED) ? dmu_buf_get_user(db) : NULL;
1378 if (handle == NULL) {
1379 sa_handle_t *newhandle;
1380 handle = kmem_cache_alloc(sa_cache, KM_SLEEP);
1381 handle->sa_userp = userp;
1382 handle->sa_bonus = db;
1384 handle->sa_spill = NULL;
1386 error = sa_build_index(handle, SA_BONUS);
1387 newhandle = (hdl_type == SA_HDL_SHARED) ?
1388 dmu_buf_set_user_ie(db, handle,
1389 NULL, sa_evict) : NULL;
1391 if (newhandle != NULL) {
1392 kmem_cache_free(sa_cache, handle);
1402 sa_handle_get(objset_t *objset, uint64_t objid, void *userp,
1403 sa_handle_type_t hdl_type, sa_handle_t **handlepp)
1408 if ((error = dmu_bonus_hold(objset, objid, NULL, &db)))
1411 return (sa_handle_get_from_db(objset, db, userp, hdl_type,
1416 sa_buf_hold(objset_t *objset, uint64_t obj_num, void *tag, dmu_buf_t **db)
1418 return (dmu_bonus_hold(objset, obj_num, tag, db));
1422 sa_buf_rele(dmu_buf_t *db, void *tag)
1424 dmu_buf_rele(db, tag);
1428 sa_lookup_impl(sa_handle_t *hdl, sa_bulk_attr_t *bulk, int count)
1431 ASSERT(MUTEX_HELD(&hdl->sa_lock));
1432 return (sa_attr_op(hdl, bulk, count, SA_LOOKUP, NULL));
1436 sa_lookup(sa_handle_t *hdl, sa_attr_type_t attr, void *buf, uint32_t buflen)
1439 sa_bulk_attr_t bulk;
1441 bulk.sa_attr = attr;
1443 bulk.sa_length = buflen;
1444 bulk.sa_data_func = NULL;
1447 mutex_enter(&hdl->sa_lock);
1448 error = sa_lookup_impl(hdl, &bulk, 1);
1449 mutex_exit(&hdl->sa_lock);
1455 sa_lookup_uio(sa_handle_t *hdl, sa_attr_type_t attr, uio_t *uio)
1458 sa_bulk_attr_t bulk;
1460 bulk.sa_data = NULL;
1461 bulk.sa_attr = attr;
1462 bulk.sa_data_func = NULL;
1466 mutex_enter(&hdl->sa_lock);
1467 if ((error = sa_attr_op(hdl, &bulk, 1, SA_LOOKUP, NULL)) == 0) {
1468 error = uiomove((void *)bulk.sa_addr, MIN(bulk.sa_size,
1469 uio->uio_resid), UIO_READ, uio);
1471 mutex_exit(&hdl->sa_lock);
1477 sa_find_idx_tab(objset_t *os, dmu_object_type_t bonustype, void *data)
1479 sa_idx_tab_t *idx_tab;
1480 sa_hdr_phys_t *hdr = (sa_hdr_phys_t *)data;
1481 sa_os_t *sa = os->os_sa;
1482 sa_lot_t *tb, search;
1486 * Deterimine layout number. If SA node and header == 0 then
1487 * force the index table to the dummy "1" empty layout.
1489 * The layout number would only be zero for a newly created file
1490 * that has not added any attributes yet, or with crypto enabled which
1491 * doesn't write any attributes to the bonus buffer.
1494 search.lot_num = SA_LAYOUT_NUM(hdr, bonustype);
1496 tb = avl_find(&sa->sa_layout_num_tree, &search, &loc);
1498 /* Verify header size is consistent with layout information */
1500 ASSERT((IS_SA_BONUSTYPE(bonustype) &&
1501 SA_HDR_SIZE_MATCH_LAYOUT(hdr, tb)) || !IS_SA_BONUSTYPE(bonustype) ||
1502 (IS_SA_BONUSTYPE(bonustype) && hdr->sa_layout_info == 0));
1505 * See if any of the already existing TOC entries can be reused?
1508 for (idx_tab = list_head(&tb->lot_idx_tab); idx_tab;
1509 idx_tab = list_next(&tb->lot_idx_tab, idx_tab)) {
1510 boolean_t valid_idx = B_TRUE;
1513 if (tb->lot_var_sizes != 0 &&
1514 idx_tab->sa_variable_lengths != NULL) {
1515 for (i = 0; i != tb->lot_var_sizes; i++) {
1516 if (hdr->sa_lengths[i] !=
1517 idx_tab->sa_variable_lengths[i]) {
1518 valid_idx = B_FALSE;
1524 sa_idx_tab_hold(os, idx_tab);
1529 /* No such luck, create a new entry */
1530 idx_tab = kmem_zalloc(sizeof (sa_idx_tab_t), KM_SLEEP);
1531 idx_tab->sa_idx_tab =
1532 kmem_zalloc(sizeof (uint32_t) * sa->sa_num_attrs, KM_SLEEP);
1533 idx_tab->sa_layout = tb;
1534 refcount_create(&idx_tab->sa_refcount);
1535 if (tb->lot_var_sizes)
1536 idx_tab->sa_variable_lengths = kmem_alloc(sizeof (uint16_t) *
1537 tb->lot_var_sizes, KM_SLEEP);
1539 sa_attr_iter(os, hdr, bonustype, sa_build_idx_tab,
1541 sa_idx_tab_hold(os, idx_tab); /* one hold for consumer */
1542 sa_idx_tab_hold(os, idx_tab); /* one for layout */
1543 list_insert_tail(&tb->lot_idx_tab, idx_tab);
1548 sa_default_locator(void **dataptr, uint32_t *len, uint32_t total_len,
1549 boolean_t start, void *userdata)
1553 *dataptr = userdata;
1558 sa_attr_register_sync(sa_handle_t *hdl, dmu_tx_t *tx)
1560 uint64_t attr_value = 0;
1561 sa_os_t *sa = hdl->sa_os->os_sa;
1562 sa_attr_table_t *tb = sa->sa_attr_table;
1565 mutex_enter(&sa->sa_lock);
1567 if (!sa->sa_need_attr_registration || sa->sa_master_obj == 0) {
1568 mutex_exit(&sa->sa_lock);
1572 if (sa->sa_reg_attr_obj == 0) {
1573 sa->sa_reg_attr_obj = zap_create(hdl->sa_os,
1574 DMU_OT_SA_ATTR_REGISTRATION, DMU_OT_NONE, 0, tx);
1575 VERIFY(zap_add(hdl->sa_os, sa->sa_master_obj,
1576 SA_REGISTRY, 8, 1, &sa->sa_reg_attr_obj, tx) == 0);
1578 for (i = 0; i != sa->sa_num_attrs; i++) {
1579 if (sa->sa_attr_table[i].sa_registered)
1581 ATTR_ENCODE(attr_value, tb[i].sa_attr, tb[i].sa_length,
1583 VERIFY(0 == zap_update(hdl->sa_os, sa->sa_reg_attr_obj,
1584 tb[i].sa_name, 8, 1, &attr_value, tx));
1585 tb[i].sa_registered = B_TRUE;
1587 sa->sa_need_attr_registration = B_FALSE;
1588 mutex_exit(&sa->sa_lock);
1592 * Replace all attributes with attributes specified in template.
1593 * If dnode had a spill buffer then those attributes will be
1594 * also be replaced, possibly with just an empty spill block
1596 * This interface is intended to only be used for bulk adding of
1597 * attributes for a new file. It will also be used by the ZPL
1598 * when converting and old formatted znode to native SA support.
1601 sa_replace_all_by_template_locked(sa_handle_t *hdl, sa_bulk_attr_t *attr_desc,
1602 int attr_count, dmu_tx_t *tx)
1604 sa_os_t *sa = hdl->sa_os->os_sa;
1606 if (sa->sa_need_attr_registration)
1607 sa_attr_register_sync(hdl, tx);
1608 return (sa_build_layouts(hdl, attr_desc, attr_count, tx));
1612 sa_replace_all_by_template(sa_handle_t *hdl, sa_bulk_attr_t *attr_desc,
1613 int attr_count, dmu_tx_t *tx)
1617 mutex_enter(&hdl->sa_lock);
1618 error = sa_replace_all_by_template_locked(hdl, attr_desc,
1620 mutex_exit(&hdl->sa_lock);
1625 * add/remove/replace a single attribute and then rewrite the entire set
1629 sa_modify_attrs(sa_handle_t *hdl, sa_attr_type_t newattr,
1630 sa_data_op_t action, sa_data_locator_t *locator, void *datastart,
1631 uint16_t buflen, dmu_tx_t *tx)
1633 sa_os_t *sa = hdl->sa_os->os_sa;
1634 dmu_buf_impl_t *db = (dmu_buf_impl_t *)hdl->sa_bonus;
1636 sa_bulk_attr_t *attr_desc;
1638 int bonus_attr_count = 0;
1639 int bonus_data_size = 0;
1640 int spill_attr_count = 0;
1643 int i, j, k, length_idx;
1645 sa_idx_tab_t *idx_tab;
1649 ASSERT(MUTEX_HELD(&hdl->sa_lock));
1651 /* First make of copy of the old data */
1655 if (dn->dn_bonuslen != 0) {
1656 bonus_data_size = hdl->sa_bonus->db_size;
1657 old_data[0] = kmem_alloc(bonus_data_size, KM_SLEEP);
1658 bcopy(hdl->sa_bonus->db_data, old_data[0],
1659 hdl->sa_bonus->db_size);
1660 bonus_attr_count = hdl->sa_bonus_tab->sa_layout->lot_attr_count;
1666 /* Bring spill buffer online if it isn't currently */
1668 if ((error = sa_get_spill(hdl)) == 0) {
1669 ASSERT3U(hdl->sa_spill->db_size, <=, SPA_MAXBLOCKSIZE);
1670 old_data[1] = sa_spill_alloc(KM_SLEEP);
1671 bcopy(hdl->sa_spill->db_data, old_data[1],
1672 hdl->sa_spill->db_size);
1674 hdl->sa_spill_tab->sa_layout->lot_attr_count;
1675 } else if (error && error != ENOENT) {
1677 kmem_free(old_data[0], bonus_data_size);
1683 /* build descriptor of all attributes */
1685 attr_count = bonus_attr_count + spill_attr_count;
1686 if (action == SA_ADD)
1688 else if (action == SA_REMOVE)
1691 attr_desc = kmem_zalloc(sizeof (sa_bulk_attr_t) * attr_count, KM_SLEEP);
1694 * loop through bonus and spill buffer if it exists, and
1695 * build up new attr_descriptor to reset the attributes
1698 count = bonus_attr_count;
1699 hdr = SA_GET_HDR(hdl, SA_BONUS);
1700 idx_tab = SA_IDX_TAB_GET(hdl, SA_BONUS);
1701 for (; k != 2; k++) {
1702 /* iterate over each attribute in layout */
1703 for (i = 0, length_idx = 0; i != count; i++) {
1704 sa_attr_type_t attr;
1706 attr = idx_tab->sa_layout->lot_attrs[i];
1707 if (attr == newattr) {
1708 if (action == SA_REMOVE) {
1712 ASSERT(SA_REGISTERED_LEN(sa, attr) == 0);
1713 ASSERT(action == SA_REPLACE);
1714 SA_ADD_BULK_ATTR(attr_desc, j, attr,
1715 locator, datastart, buflen);
1717 length = SA_REGISTERED_LEN(sa, attr);
1719 length = hdr->sa_lengths[length_idx++];
1722 SA_ADD_BULK_ATTR(attr_desc, j, attr,
1724 (TOC_OFF(idx_tab->sa_idx_tab[attr]) +
1725 (uintptr_t)old_data[k]), length);
1728 if (k == 0 && hdl->sa_spill) {
1729 hdr = SA_GET_HDR(hdl, SA_SPILL);
1730 idx_tab = SA_IDX_TAB_GET(hdl, SA_SPILL);
1731 count = spill_attr_count;
1736 if (action == SA_ADD) {
1737 length = SA_REGISTERED_LEN(sa, newattr);
1741 SA_ADD_BULK_ATTR(attr_desc, j, newattr, locator,
1745 error = sa_build_layouts(hdl, attr_desc, attr_count, tx);
1748 kmem_free(old_data[0], bonus_data_size);
1750 sa_spill_free(old_data[1]);
1751 kmem_free(attr_desc, sizeof (sa_bulk_attr_t) * attr_count);
1757 sa_bulk_update_impl(sa_handle_t *hdl, sa_bulk_attr_t *bulk, int count,
1761 sa_os_t *sa = hdl->sa_os->os_sa;
1762 dmu_object_type_t bonustype;
1764 bonustype = SA_BONUSTYPE_FROM_DB(SA_GET_DB(hdl, SA_BONUS));
1767 ASSERT(MUTEX_HELD(&hdl->sa_lock));
1769 /* sync out registration table if necessary */
1770 if (sa->sa_need_attr_registration)
1771 sa_attr_register_sync(hdl, tx);
1773 error = sa_attr_op(hdl, bulk, count, SA_UPDATE, tx);
1774 if (error == 0 && !IS_SA_BONUSTYPE(bonustype) && sa->sa_update_cb)
1775 sa->sa_update_cb(hdl, tx);
1781 * update or add new attribute
1784 sa_update(sa_handle_t *hdl, sa_attr_type_t type,
1785 void *buf, uint32_t buflen, dmu_tx_t *tx)
1788 sa_bulk_attr_t bulk;
1790 bulk.sa_attr = type;
1791 bulk.sa_data_func = NULL;
1792 bulk.sa_length = buflen;
1795 mutex_enter(&hdl->sa_lock);
1796 error = sa_bulk_update_impl(hdl, &bulk, 1, tx);
1797 mutex_exit(&hdl->sa_lock);
1802 sa_update_from_cb(sa_handle_t *hdl, sa_attr_type_t attr,
1803 uint32_t buflen, sa_data_locator_t *locator, void *userdata, dmu_tx_t *tx)
1806 sa_bulk_attr_t bulk;
1808 bulk.sa_attr = attr;
1809 bulk.sa_data = userdata;
1810 bulk.sa_data_func = locator;
1811 bulk.sa_length = buflen;
1813 mutex_enter(&hdl->sa_lock);
1814 error = sa_bulk_update_impl(hdl, &bulk, 1, tx);
1815 mutex_exit(&hdl->sa_lock);
1820 * Return size of an attribute
1824 sa_size(sa_handle_t *hdl, sa_attr_type_t attr, int *size)
1826 sa_bulk_attr_t bulk;
1829 bulk.sa_data = NULL;
1830 bulk.sa_attr = attr;
1831 bulk.sa_data_func = NULL;
1834 mutex_enter(&hdl->sa_lock);
1835 if ((error = sa_attr_op(hdl, &bulk, 1, SA_LOOKUP, NULL)) != 0) {
1836 mutex_exit(&hdl->sa_lock);
1839 *size = bulk.sa_size;
1841 mutex_exit(&hdl->sa_lock);
1846 sa_bulk_lookup_locked(sa_handle_t *hdl, sa_bulk_attr_t *attrs, int count)
1849 ASSERT(MUTEX_HELD(&hdl->sa_lock));
1850 return (sa_lookup_impl(hdl, attrs, count));
1854 sa_bulk_lookup(sa_handle_t *hdl, sa_bulk_attr_t *attrs, int count)
1859 mutex_enter(&hdl->sa_lock);
1860 error = sa_bulk_lookup_locked(hdl, attrs, count);
1861 mutex_exit(&hdl->sa_lock);
1866 sa_bulk_update(sa_handle_t *hdl, sa_bulk_attr_t *attrs, int count, dmu_tx_t *tx)
1871 mutex_enter(&hdl->sa_lock);
1872 error = sa_bulk_update_impl(hdl, attrs, count, tx);
1873 mutex_exit(&hdl->sa_lock);
1878 sa_remove(sa_handle_t *hdl, sa_attr_type_t attr, dmu_tx_t *tx)
1882 mutex_enter(&hdl->sa_lock);
1883 error = sa_modify_attrs(hdl, attr, SA_REMOVE, NULL,
1885 mutex_exit(&hdl->sa_lock);
1890 sa_object_info(sa_handle_t *hdl, dmu_object_info_t *doi)
1892 dmu_object_info_from_db((dmu_buf_t *)hdl->sa_bonus, doi);
1896 sa_object_size(sa_handle_t *hdl, uint32_t *blksize, u_longlong_t *nblocks)
1898 dmu_object_size_from_db((dmu_buf_t *)hdl->sa_bonus,
1903 sa_update_user(sa_handle_t *newhdl, sa_handle_t *oldhdl)
1905 (void) dmu_buf_update_user((dmu_buf_t *)newhdl->sa_bonus,
1906 oldhdl, newhdl, NULL, sa_evict);
1907 oldhdl->sa_bonus = NULL;
1911 sa_set_userp(sa_handle_t *hdl, void *ptr)
1913 hdl->sa_userp = ptr;
1917 sa_get_db(sa_handle_t *hdl)
1919 return ((dmu_buf_t *)hdl->sa_bonus);
1923 sa_get_userdata(sa_handle_t *hdl)
1925 return (hdl->sa_userp);
1929 sa_register_update_callback_locked(objset_t *os, sa_update_cb_t *func)
1931 ASSERT(MUTEX_HELD(&os->os_sa->sa_lock));
1932 os->os_sa->sa_update_cb = func;
1936 sa_register_update_callback(objset_t *os, sa_update_cb_t *func)
1939 mutex_enter(&os->os_sa->sa_lock);
1940 sa_register_update_callback_locked(os, func);
1941 mutex_exit(&os->os_sa->sa_lock);
1945 sa_handle_object(sa_handle_t *hdl)
1947 return (hdl->sa_bonus->db_object);
1951 sa_enabled(objset_t *os)
1953 return (os->os_sa == NULL);
1957 sa_set_sa_object(objset_t *os, uint64_t sa_object)
1959 sa_os_t *sa = os->os_sa;
1961 if (sa->sa_master_obj)
1964 sa->sa_master_obj = sa_object;
1970 sa_hdrsize(void *arg)
1972 sa_hdr_phys_t *hdr = arg;
1974 return (SA_HDR_SIZE(hdr));
1978 sa_handle_lock(sa_handle_t *hdl)
1981 mutex_enter(&hdl->sa_lock);
1985 sa_handle_unlock(sa_handle_t *hdl)
1988 mutex_exit(&hdl->sa_lock);
1992 EXPORT_SYMBOL(sa_handle_get);
1993 EXPORT_SYMBOL(sa_handle_get_from_db);
1994 EXPORT_SYMBOL(sa_handle_destroy);
1995 EXPORT_SYMBOL(sa_buf_hold);
1996 EXPORT_SYMBOL(sa_buf_rele);
1997 EXPORT_SYMBOL(sa_lookup);
1998 EXPORT_SYMBOL(sa_update);
1999 EXPORT_SYMBOL(sa_remove);
2000 EXPORT_SYMBOL(sa_bulk_lookup);
2001 EXPORT_SYMBOL(sa_bulk_lookup_locked);
2002 EXPORT_SYMBOL(sa_bulk_update);
2003 EXPORT_SYMBOL(sa_size);
2004 EXPORT_SYMBOL(sa_update_from_cb);
2005 EXPORT_SYMBOL(sa_object_info);
2006 EXPORT_SYMBOL(sa_object_size);
2007 EXPORT_SYMBOL(sa_update_user);
2008 EXPORT_SYMBOL(sa_get_userdata);
2009 EXPORT_SYMBOL(sa_set_userp);
2010 EXPORT_SYMBOL(sa_get_db);
2011 EXPORT_SYMBOL(sa_handle_object);
2012 EXPORT_SYMBOL(sa_register_update_callback);
2013 EXPORT_SYMBOL(sa_setup);
2014 EXPORT_SYMBOL(sa_replace_all_by_template);
2015 EXPORT_SYMBOL(sa_replace_all_by_template_locked);
2016 EXPORT_SYMBOL(sa_enabled);
2017 EXPORT_SYMBOL(sa_cache_init);
2018 EXPORT_SYMBOL(sa_cache_fini);
2019 EXPORT_SYMBOL(sa_spill_alloc);
2020 EXPORT_SYMBOL(sa_spill_free);
2021 EXPORT_SYMBOL(sa_set_sa_object);
2022 EXPORT_SYMBOL(sa_hdrsize);
2023 EXPORT_SYMBOL(sa_handle_lock);
2024 EXPORT_SYMBOL(sa_handle_unlock);
2025 EXPORT_SYMBOL(sa_lookup_uio);
2026 #endif /* _KERNEL */