4 * The contents of this file are subject to the terms of the
5 * Common Development and Distribution License (the "License").
6 * You may not use this file except in compliance with the License.
8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 * or http://www.opensolaris.org/os/licensing.
10 * See the License for the specific language governing permissions
11 * and limitations under the License.
13 * When distributing Covered Code, include this CDDL HEADER in each
14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 * If applicable, add the following below this CDDL HEADER, with the
16 * fields enclosed by brackets "[]" replaced with your own identifying
17 * information: Portions Copyright [yyyy] [name of copyright owner]
23 * Copyright (c) 2010, Oracle and/or its affiliates. All rights reserved.
24 * Copyright (c) 2013 by Delphix. All rights reserved.
25 * Copyright (c) 2014 Spectra Logic Corporation, All rights reserved.
28 #include <sys/zfs_context.h>
29 #include <sys/types.h>
30 #include <sys/param.h>
31 #include <sys/systm.h>
32 #include <sys/sysmacros.h>
34 #include <sys/dmu_impl.h>
35 #include <sys/dmu_objset.h>
37 #include <sys/dnode.h>
40 #include <sys/sunddi.h>
41 #include <sys/sa_impl.h>
42 #include <sys/dnode.h>
43 #include <sys/errno.h>
44 #include <sys/zfs_context.h>
47 * ZFS System attributes:
49 * A generic mechanism to allow for arbitrary attributes
50 * to be stored in a dnode. The data will be stored in the bonus buffer of
51 * the dnode and if necessary a special "spill" block will be used to handle
52 * overflow situations. The spill block will be sized to fit the data
53 * from 512 - 128K. When a spill block is used the BP (blkptr_t) for the
54 * spill block is stored at the end of the current bonus buffer. Any
55 * attributes that would be in the way of the blkptr_t will be relocated
56 * into the spill block.
58 * Attribute registration:
60 * Stored persistently on a per dataset basis
61 * a mapping between attribute "string" names and their actual attribute
62 * numeric values, length, and byteswap function. The names are only used
63 * during registration. All attributes are known by their unique attribute
64 * id value. If an attribute can have a variable size then the value
65 * 0 will be used to indicate this.
69 * Attribute layouts are a way to compactly store multiple attributes, but
70 * without taking the overhead associated with managing each attribute
71 * individually. Since you will typically have the same set of attributes
72 * stored in the same order a single table will be used to represent that
73 * layout. The ZPL for example will usually have only about 10 different
74 * layouts (regular files, device files, symlinks,
75 * regular files + scanstamp, files/dir with extended attributes, and then
76 * you have the possibility of all of those minus ACL, because it would
77 * be kicked out into the spill block)
79 * Layouts are simply an array of the attributes and their
80 * ordering i.e. [0, 1, 4, 5, 2]
82 * Each distinct layout is given a unique layout number and that is whats
83 * stored in the header at the beginning of the SA data buffer.
85 * A layout only covers a single dbuf (bonus or spill). If a set of
86 * attributes is split up between the bonus buffer and a spill buffer then
87 * two different layouts will be used. This allows us to byteswap the
88 * spill without looking at the bonus buffer and keeps the on disk format of
89 * the bonus and spill buffer the same.
91 * Adding a single attribute will cause the entire set of attributes to
92 * be rewritten and could result in a new layout number being constructed
93 * as part of the rewrite if no such layout exists for the new set of
94 * attribues. The new attribute will be appended to the end of the already
95 * existing attributes.
97 * Both the attribute registration and attribute layout information are
98 * stored in normal ZAP attributes. Their should be a small number of
99 * known layouts and the set of attributes is assumed to typically be quite
102 * The registered attributes and layout "table" information is maintained
103 * in core and a special "sa_os_t" is attached to the objset_t.
105 * A special interface is provided to allow for quickly applying
106 * a large set of attributes at once. sa_replace_all_by_template() is
107 * used to set an array of attributes. This is used by the ZPL when
108 * creating a brand new file. The template that is passed into the function
109 * specifies the attribute, size for variable length attributes, location of
110 * data and special "data locator" function if the data isn't in a contiguous
113 * Byteswap implications:
115 * Since the SA attributes are not entirely self describing we can't do
116 * the normal byteswap processing. The special ZAP layout attribute and
117 * attribute registration attributes define the byteswap function and the
118 * size of the attributes, unless it is variable sized.
119 * The normal ZFS byteswapping infrastructure assumes you don't need
120 * to read any objects in order to do the necessary byteswapping. Whereas
121 * SA attributes can only be properly byteswapped if the dataset is opened
122 * and the layout/attribute ZAP attributes are available. Because of this
123 * the SA attributes will be byteswapped when they are first accessed by
124 * the SA code that will read the SA data.
127 typedef void (sa_iterfunc_t
)(void *hdr
, void *addr
, sa_attr_type_t
,
128 uint16_t length
, int length_idx
, boolean_t
, void *userp
);
130 static int sa_build_index(sa_handle_t
*hdl
, sa_buf_type_t buftype
);
131 static void sa_idx_tab_hold(objset_t
*os
, sa_idx_tab_t
*idx_tab
);
132 static void *sa_find_idx_tab(objset_t
*os
, dmu_object_type_t bonustype
,
134 static void sa_idx_tab_rele(objset_t
*os
, void *arg
);
135 static void sa_copy_data(sa_data_locator_t
*func
, void *start
, void *target
,
137 static int sa_modify_attrs(sa_handle_t
*hdl
, sa_attr_type_t newattr
,
138 sa_data_op_t action
, sa_data_locator_t
*locator
, void *datastart
,
139 uint16_t buflen
, dmu_tx_t
*tx
);
141 arc_byteswap_func_t sa_bswap_table
[] = {
142 byteswap_uint64_array
,
143 byteswap_uint32_array
,
144 byteswap_uint16_array
,
145 byteswap_uint8_array
,
149 #define SA_COPY_DATA(f, s, t, l) \
153 *(uint64_t *)t = *(uint64_t *)s; \
154 } else if (l == 16) { \
155 *(uint64_t *)t = *(uint64_t *)s; \
156 *(uint64_t *)((uintptr_t)t + 8) = \
157 *(uint64_t *)((uintptr_t)s + 8); \
162 sa_copy_data(f, s, t, l); \
166 * This table is fixed and cannot be changed. Its purpose is to
167 * allow the SA code to work with both old/new ZPL file systems.
168 * It contains the list of legacy attributes. These attributes aren't
169 * stored in the "attribute" registry zap objects, since older ZPL file systems
170 * won't have the registry. Only objsets of type ZFS_TYPE_FILESYSTEM will
171 * use this static table.
173 sa_attr_reg_t sa_legacy_attrs
[] = {
174 {"ZPL_ATIME", sizeof (uint64_t) * 2, SA_UINT64_ARRAY
, 0},
175 {"ZPL_MTIME", sizeof (uint64_t) * 2, SA_UINT64_ARRAY
, 1},
176 {"ZPL_CTIME", sizeof (uint64_t) * 2, SA_UINT64_ARRAY
, 2},
177 {"ZPL_CRTIME", sizeof (uint64_t) * 2, SA_UINT64_ARRAY
, 3},
178 {"ZPL_GEN", sizeof (uint64_t), SA_UINT64_ARRAY
, 4},
179 {"ZPL_MODE", sizeof (uint64_t), SA_UINT64_ARRAY
, 5},
180 {"ZPL_SIZE", sizeof (uint64_t), SA_UINT64_ARRAY
, 6},
181 {"ZPL_PARENT", sizeof (uint64_t), SA_UINT64_ARRAY
, 7},
182 {"ZPL_LINKS", sizeof (uint64_t), SA_UINT64_ARRAY
, 8},
183 {"ZPL_XATTR", sizeof (uint64_t), SA_UINT64_ARRAY
, 9},
184 {"ZPL_RDEV", sizeof (uint64_t), SA_UINT64_ARRAY
, 10},
185 {"ZPL_FLAGS", sizeof (uint64_t), SA_UINT64_ARRAY
, 11},
186 {"ZPL_UID", sizeof (uint64_t), SA_UINT64_ARRAY
, 12},
187 {"ZPL_GID", sizeof (uint64_t), SA_UINT64_ARRAY
, 13},
188 {"ZPL_PAD", sizeof (uint64_t) * 4, SA_UINT64_ARRAY
, 14},
189 {"ZPL_ZNODE_ACL", 88, SA_UINT8_ARRAY
, 15},
193 * This is only used for objects of type DMU_OT_ZNODE
195 sa_attr_type_t sa_legacy_zpl_layout
[] = {
196 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
200 * Special dummy layout used for buffers with no attributes.
202 sa_attr_type_t sa_dummy_zpl_layout
[] = { 0 };
204 static int sa_legacy_attr_count
= 16;
205 static kmem_cache_t
*sa_cache
= NULL
;
209 sa_cache_constructor(void *buf
, void *unused
, int kmflag
)
211 sa_handle_t
*hdl
= buf
;
213 mutex_init(&hdl
->sa_lock
, NULL
, MUTEX_DEFAULT
, NULL
);
219 sa_cache_destructor(void *buf
, void *unused
)
221 sa_handle_t
*hdl
= buf
;
222 mutex_destroy(&hdl
->sa_lock
);
228 sa_cache
= kmem_cache_create("sa_cache",
229 sizeof (sa_handle_t
), 0, sa_cache_constructor
,
230 sa_cache_destructor
, NULL
, NULL
, NULL
, 0);
237 kmem_cache_destroy(sa_cache
);
241 layout_num_compare(const void *arg1
, const void *arg2
)
243 const sa_lot_t
*node1
= arg1
;
244 const sa_lot_t
*node2
= arg2
;
246 if (node1
->lot_num
> node2
->lot_num
)
248 else if (node1
->lot_num
< node2
->lot_num
)
254 layout_hash_compare(const void *arg1
, const void *arg2
)
256 const sa_lot_t
*node1
= arg1
;
257 const sa_lot_t
*node2
= arg2
;
259 if (node1
->lot_hash
> node2
->lot_hash
)
261 if (node1
->lot_hash
< node2
->lot_hash
)
263 if (node1
->lot_instance
> node2
->lot_instance
)
265 if (node1
->lot_instance
< node2
->lot_instance
)
271 sa_layout_equal(sa_lot_t
*tbf
, sa_attr_type_t
*attrs
, int count
)
275 if (count
!= tbf
->lot_attr_count
)
278 for (i
= 0; i
!= count
; i
++) {
279 if (attrs
[i
] != tbf
->lot_attrs
[i
])
285 #define SA_ATTR_HASH(attr) (zfs_crc64_table[(-1ULL ^ attr) & 0xFF])
288 sa_layout_info_hash(sa_attr_type_t
*attrs
, int attr_count
)
291 uint64_t crc
= -1ULL;
293 for (i
= 0; i
!= attr_count
; i
++)
294 crc
^= SA_ATTR_HASH(attrs
[i
]);
300 sa_get_spill(sa_handle_t
*hdl
)
303 if (hdl
->sa_spill
== NULL
) {
304 if ((rc
= dmu_spill_hold_existing(hdl
->sa_bonus
, NULL
,
305 &hdl
->sa_spill
)) == 0)
306 VERIFY(0 == sa_build_index(hdl
, SA_SPILL
));
315 * Main attribute lookup/update function
316 * returns 0 for success or non zero for failures
318 * Operates on bulk array, first failure will abort further processing
321 sa_attr_op(sa_handle_t
*hdl
, sa_bulk_attr_t
*bulk
, int count
,
322 sa_data_op_t data_op
, dmu_tx_t
*tx
)
324 sa_os_t
*sa
= hdl
->sa_os
->os_sa
;
327 sa_buf_type_t buftypes
;
332 for (i
= 0; i
!= count
; i
++) {
333 ASSERT(bulk
[i
].sa_attr
<= hdl
->sa_os
->os_sa
->sa_num_attrs
);
335 bulk
[i
].sa_addr
= NULL
;
336 /* First check the bonus buffer */
338 if (hdl
->sa_bonus_tab
&& TOC_ATTR_PRESENT(
339 hdl
->sa_bonus_tab
->sa_idx_tab
[bulk
[i
].sa_attr
])) {
340 SA_ATTR_INFO(sa
, hdl
->sa_bonus_tab
,
341 SA_GET_HDR(hdl
, SA_BONUS
),
342 bulk
[i
].sa_attr
, bulk
[i
], SA_BONUS
, hdl
);
343 if (tx
&& !(buftypes
& SA_BONUS
)) {
344 dmu_buf_will_dirty(hdl
->sa_bonus
, tx
);
345 buftypes
|= SA_BONUS
;
348 if (bulk
[i
].sa_addr
== NULL
&&
349 ((error
= sa_get_spill(hdl
)) == 0)) {
350 if (TOC_ATTR_PRESENT(
351 hdl
->sa_spill_tab
->sa_idx_tab
[bulk
[i
].sa_attr
])) {
352 SA_ATTR_INFO(sa
, hdl
->sa_spill_tab
,
353 SA_GET_HDR(hdl
, SA_SPILL
),
354 bulk
[i
].sa_attr
, bulk
[i
], SA_SPILL
, hdl
);
355 if (tx
&& !(buftypes
& SA_SPILL
) &&
356 bulk
[i
].sa_size
== bulk
[i
].sa_length
) {
357 dmu_buf_will_dirty(hdl
->sa_spill
, tx
);
358 buftypes
|= SA_SPILL
;
362 if (error
&& error
!= ENOENT
) {
363 return ((error
== ECKSUM
) ? EIO
: error
);
368 if (bulk
[i
].sa_addr
== NULL
)
369 return (SET_ERROR(ENOENT
));
370 if (bulk
[i
].sa_data
) {
371 SA_COPY_DATA(bulk
[i
].sa_data_func
,
372 bulk
[i
].sa_addr
, bulk
[i
].sa_data
,
378 /* existing rewrite of attr */
379 if (bulk
[i
].sa_addr
&&
380 bulk
[i
].sa_size
== bulk
[i
].sa_length
) {
381 SA_COPY_DATA(bulk
[i
].sa_data_func
,
382 bulk
[i
].sa_data
, bulk
[i
].sa_addr
,
385 } else if (bulk
[i
].sa_addr
) { /* attr size change */
386 error
= sa_modify_attrs(hdl
, bulk
[i
].sa_attr
,
387 SA_REPLACE
, bulk
[i
].sa_data_func
,
388 bulk
[i
].sa_data
, bulk
[i
].sa_length
, tx
);
389 } else { /* adding new attribute */
390 error
= sa_modify_attrs(hdl
, bulk
[i
].sa_attr
,
391 SA_ADD
, bulk
[i
].sa_data_func
,
392 bulk
[i
].sa_data
, bulk
[i
].sa_length
, tx
);
405 sa_add_layout_entry(objset_t
*os
, sa_attr_type_t
*attrs
, int attr_count
,
406 uint64_t lot_num
, uint64_t hash
, boolean_t zapadd
, dmu_tx_t
*tx
)
408 sa_os_t
*sa
= os
->os_sa
;
409 sa_lot_t
*tb
, *findtb
;
413 ASSERT(MUTEX_HELD(&sa
->sa_lock
));
414 tb
= kmem_zalloc(sizeof (sa_lot_t
), KM_SLEEP
);
415 tb
->lot_attr_count
= attr_count
;
416 tb
->lot_attrs
= kmem_alloc(sizeof (sa_attr_type_t
) * attr_count
,
418 bcopy(attrs
, tb
->lot_attrs
, sizeof (sa_attr_type_t
) * attr_count
);
419 tb
->lot_num
= lot_num
;
421 tb
->lot_instance
= 0;
426 if (sa
->sa_layout_attr_obj
== 0) {
427 sa
->sa_layout_attr_obj
= zap_create_link(os
,
428 DMU_OT_SA_ATTR_LAYOUTS
,
429 sa
->sa_master_obj
, SA_LAYOUTS
, tx
);
432 (void) snprintf(attr_name
, sizeof (attr_name
),
434 VERIFY(0 == zap_update(os
, os
->os_sa
->sa_layout_attr_obj
,
435 attr_name
, 2, attr_count
, attrs
, tx
));
438 list_create(&tb
->lot_idx_tab
, sizeof (sa_idx_tab_t
),
439 offsetof(sa_idx_tab_t
, sa_next
));
441 for (i
= 0; i
!= attr_count
; i
++) {
442 if (sa
->sa_attr_table
[tb
->lot_attrs
[i
]].sa_length
== 0)
446 avl_add(&sa
->sa_layout_num_tree
, tb
);
448 /* verify we don't have a hash collision */
449 if ((findtb
= avl_find(&sa
->sa_layout_hash_tree
, tb
, &loc
)) != NULL
) {
450 for (; findtb
&& findtb
->lot_hash
== hash
;
451 findtb
= AVL_NEXT(&sa
->sa_layout_hash_tree
, findtb
)) {
452 if (findtb
->lot_instance
!= tb
->lot_instance
)
457 avl_add(&sa
->sa_layout_hash_tree
, tb
);
462 sa_find_layout(objset_t
*os
, uint64_t hash
, sa_attr_type_t
*attrs
,
463 int count
, dmu_tx_t
*tx
, sa_lot_t
**lot
)
465 sa_lot_t
*tb
, tbsearch
;
467 sa_os_t
*sa
= os
->os_sa
;
468 boolean_t found
= B_FALSE
;
470 mutex_enter(&sa
->sa_lock
);
471 tbsearch
.lot_hash
= hash
;
472 tbsearch
.lot_instance
= 0;
473 tb
= avl_find(&sa
->sa_layout_hash_tree
, &tbsearch
, &loc
);
475 for (; tb
&& tb
->lot_hash
== hash
;
476 tb
= AVL_NEXT(&sa
->sa_layout_hash_tree
, tb
)) {
477 if (sa_layout_equal(tb
, attrs
, count
) == 0) {
484 tb
= sa_add_layout_entry(os
, attrs
, count
,
485 avl_numnodes(&sa
->sa_layout_num_tree
), hash
, B_TRUE
, tx
);
487 mutex_exit(&sa
->sa_lock
);
492 sa_resize_spill(sa_handle_t
*hdl
, uint32_t size
, dmu_tx_t
*tx
)
498 blocksize
= SPA_MINBLOCKSIZE
;
499 } else if (size
> SPA_OLD_MAXBLOCKSIZE
) {
501 return (SET_ERROR(EFBIG
));
503 blocksize
= P2ROUNDUP_TYPED(size
, SPA_MINBLOCKSIZE
, uint32_t);
506 error
= dbuf_spill_set_blksz(hdl
->sa_spill
, blocksize
, tx
);
512 sa_copy_data(sa_data_locator_t
*func
, void *datastart
, void *target
, int buflen
)
515 bcopy(datastart
, target
, buflen
);
520 void *saptr
= target
;
525 while (bytes
< buflen
) {
526 func(&dataptr
, &length
, buflen
, start
, datastart
);
527 bcopy(dataptr
, saptr
, length
);
528 saptr
= (void *)((caddr_t
)saptr
+ length
);
536 * Determine several different values pertaining to system attribute
539 * Return the size of the sa_hdr_phys_t header for the buffer. Each
540 * variable length attribute except the first contributes two bytes to
541 * the header size, which is then rounded up to an 8-byte boundary.
543 * The following output parameters are also computed.
545 * index - The index of the first attribute in attr_desc that will
546 * spill over. Only valid if will_spill is set.
548 * total - The total number of bytes of all system attributes described
551 * will_spill - Set when spilling is necessary. It is only set when
552 * the buftype is SA_BONUS.
555 sa_find_sizes(sa_os_t
*sa
, sa_bulk_attr_t
*attr_desc
, int attr_count
,
556 dmu_buf_t
*db
, sa_buf_type_t buftype
, int *index
, int *total
,
557 boolean_t
*will_spill
)
559 int var_size_count
= 0;
565 if (buftype
== SA_BONUS
&& sa
->sa_force_spill
) {
568 *will_spill
= B_TRUE
;
574 *will_spill
= B_FALSE
;
577 hdrsize
= (SA_BONUSTYPE_FROM_DB(db
) == DMU_OT_ZNODE
) ? 0 :
578 sizeof (sa_hdr_phys_t
);
580 full_space
= (buftype
== SA_BONUS
) ? DN_MAX_BONUSLEN
: db
->db_size
;
581 ASSERT(IS_P2ALIGNED(full_space
, 8));
583 for (i
= 0; i
!= attr_count
; i
++) {
584 boolean_t is_var_sz
, might_spill_here
;
587 *total
= P2ROUNDUP(*total
, 8);
588 *total
+= attr_desc
[i
].sa_length
;
592 is_var_sz
= (SA_REGISTERED_LEN(sa
, attr_desc
[i
].sa_attr
) == 0);
597 * Calculate what the SA header size would be if this
598 * attribute doesn't spill.
600 tmp_hdrsize
= hdrsize
+ ((is_var_sz
&& var_size_count
> 1) ?
601 sizeof (uint16_t) : 0);
604 * Check whether this attribute spans into the space
605 * that would be used by the spill block pointer should
606 * a spill block be needed.
609 buftype
== SA_BONUS
&& *index
== -1 &&
610 (*total
+ P2ROUNDUP(tmp_hdrsize
, 8)) >
611 (full_space
- sizeof (blkptr_t
));
613 if (is_var_sz
&& var_size_count
> 1) {
614 if (buftype
== SA_SPILL
||
615 tmp_hdrsize
+ *total
< full_space
) {
617 * Record the extra header size in case this
618 * increase needs to be reversed due to
621 hdrsize
= tmp_hdrsize
;
622 if (*index
!= -1 || might_spill_here
)
623 extra_hdrsize
+= sizeof (uint16_t);
625 ASSERT(buftype
== SA_BONUS
);
628 *will_spill
= B_TRUE
;
634 * Store index of where spill *could* occur. Then
635 * continue to count the remaining attribute sizes. The
636 * sum is used later for sizing bonus and spill buffer.
638 if (might_spill_here
)
641 if ((*total
+ P2ROUNDUP(hdrsize
, 8)) > full_space
&&
643 *will_spill
= B_TRUE
;
647 hdrsize
-= extra_hdrsize
;
649 hdrsize
= P2ROUNDUP(hdrsize
, 8);
653 #define BUF_SPACE_NEEDED(total, header) (total + header)
656 * Find layout that corresponds to ordering of attributes
657 * If not found a new layout number is created and added to
658 * persistent layout tables.
661 sa_build_layouts(sa_handle_t
*hdl
, sa_bulk_attr_t
*attr_desc
, int attr_count
,
664 sa_os_t
*sa
= hdl
->sa_os
->os_sa
;
666 sa_buf_type_t buftype
;
667 sa_hdr_phys_t
*sahdr
;
669 sa_attr_type_t
*attrs
, *attrs_start
;
673 int spillhdrsize
= 0;
675 dmu_object_type_t bonustype
;
681 dmu_buf_will_dirty(hdl
->sa_bonus
, tx
);
682 bonustype
= SA_BONUSTYPE_FROM_DB(hdl
->sa_bonus
);
684 /* first determine bonus header size and sum of all attributes */
685 hdrsize
= sa_find_sizes(sa
, attr_desc
, attr_count
, hdl
->sa_bonus
,
686 SA_BONUS
, &spill_idx
, &used
, &spilling
);
688 if (used
> SPA_OLD_MAXBLOCKSIZE
)
689 return (SET_ERROR(EFBIG
));
691 VERIFY(0 == dmu_set_bonus(hdl
->sa_bonus
, spilling
?
692 MIN(DN_MAX_BONUSLEN
- sizeof (blkptr_t
), used
+ hdrsize
) :
693 used
+ hdrsize
, tx
));
695 ASSERT((bonustype
== DMU_OT_ZNODE
&& spilling
== 0) ||
696 bonustype
== DMU_OT_SA
);
698 /* setup and size spill buffer when needed */
702 if (hdl
->sa_spill
== NULL
) {
703 VERIFY(dmu_spill_hold_by_bonus(hdl
->sa_bonus
, NULL
,
704 &hdl
->sa_spill
) == 0);
706 dmu_buf_will_dirty(hdl
->sa_spill
, tx
);
708 spillhdrsize
= sa_find_sizes(sa
, &attr_desc
[spill_idx
],
709 attr_count
- spill_idx
, hdl
->sa_spill
, SA_SPILL
, &i
,
710 &spill_used
, &dummy
);
712 if (spill_used
> SPA_OLD_MAXBLOCKSIZE
)
713 return (SET_ERROR(EFBIG
));
715 if (BUF_SPACE_NEEDED(spill_used
, spillhdrsize
) >
716 hdl
->sa_spill
->db_size
)
717 VERIFY(0 == sa_resize_spill(hdl
,
718 BUF_SPACE_NEEDED(spill_used
, spillhdrsize
), tx
));
721 /* setup starting pointers to lay down data */
722 data_start
= (void *)((uintptr_t)hdl
->sa_bonus
->db_data
+ hdrsize
);
723 sahdr
= (sa_hdr_phys_t
*)hdl
->sa_bonus
->db_data
;
726 attrs_start
= attrs
= kmem_alloc(sizeof (sa_attr_type_t
) * attr_count
,
730 for (i
= 0, len_idx
= 0, hash
= -1ULL; i
!= attr_count
; i
++) {
733 ASSERT(IS_P2ALIGNED(data_start
, 8));
734 attrs
[i
] = attr_desc
[i
].sa_attr
;
735 length
= SA_REGISTERED_LEN(sa
, attrs
[i
]);
737 length
= attr_desc
[i
].sa_length
;
739 if (spilling
&& i
== spill_idx
) { /* switch to spill buffer */
740 VERIFY(bonustype
== DMU_OT_SA
);
741 if (buftype
== SA_BONUS
&& !sa
->sa_force_spill
) {
742 sa_find_layout(hdl
->sa_os
, hash
, attrs_start
,
743 lot_count
, tx
, &lot
);
744 SA_SET_HDR(sahdr
, lot
->lot_num
, hdrsize
);
751 sahdr
= (sa_hdr_phys_t
*)hdl
->sa_spill
->db_data
;
752 sahdr
->sa_magic
= SA_MAGIC
;
753 data_start
= (void *)((uintptr_t)sahdr
+
755 attrs_start
= &attrs
[i
];
758 hash
^= SA_ATTR_HASH(attrs
[i
]);
759 attr_desc
[i
].sa_addr
= data_start
;
760 attr_desc
[i
].sa_size
= length
;
761 SA_COPY_DATA(attr_desc
[i
].sa_data_func
, attr_desc
[i
].sa_data
,
763 if (sa
->sa_attr_table
[attrs
[i
]].sa_length
== 0) {
764 sahdr
->sa_lengths
[len_idx
++] = length
;
766 data_start
= (void *)P2ROUNDUP(((uintptr_t)data_start
+
771 sa_find_layout(hdl
->sa_os
, hash
, attrs_start
, lot_count
, tx
, &lot
);
774 * Verify that old znodes always have layout number 0.
775 * Must be DMU_OT_SA for arbitrary layouts
777 VERIFY((bonustype
== DMU_OT_ZNODE
&& lot
->lot_num
== 0) ||
778 (bonustype
== DMU_OT_SA
&& lot
->lot_num
> 1));
780 if (bonustype
== DMU_OT_SA
) {
781 SA_SET_HDR(sahdr
, lot
->lot_num
,
782 buftype
== SA_BONUS
? hdrsize
: spillhdrsize
);
785 kmem_free(attrs
, sizeof (sa_attr_type_t
) * attr_count
);
786 if (hdl
->sa_bonus_tab
) {
787 sa_idx_tab_rele(hdl
->sa_os
, hdl
->sa_bonus_tab
);
788 hdl
->sa_bonus_tab
= NULL
;
790 if (!sa
->sa_force_spill
)
791 VERIFY(0 == sa_build_index(hdl
, SA_BONUS
));
793 sa_idx_tab_rele(hdl
->sa_os
, hdl
->sa_spill_tab
);
796 * remove spill block that is no longer needed.
798 dmu_buf_rele(hdl
->sa_spill
, NULL
);
799 hdl
->sa_spill
= NULL
;
800 hdl
->sa_spill_tab
= NULL
;
801 VERIFY(0 == dmu_rm_spill(hdl
->sa_os
,
802 sa_handle_object(hdl
), tx
));
804 VERIFY(0 == sa_build_index(hdl
, SA_SPILL
));
812 sa_free_attr_table(sa_os_t
*sa
)
816 if (sa
->sa_attr_table
== NULL
)
819 for (i
= 0; i
!= sa
->sa_num_attrs
; i
++) {
820 if (sa
->sa_attr_table
[i
].sa_name
)
821 kmem_free(sa
->sa_attr_table
[i
].sa_name
,
822 strlen(sa
->sa_attr_table
[i
].sa_name
) + 1);
825 kmem_free(sa
->sa_attr_table
,
826 sizeof (sa_attr_table_t
) * sa
->sa_num_attrs
);
828 sa
->sa_attr_table
= NULL
;
832 sa_attr_table_setup(objset_t
*os
, sa_attr_reg_t
*reg_attrs
, int count
)
834 sa_os_t
*sa
= os
->os_sa
;
835 uint64_t sa_attr_count
= 0;
836 uint64_t sa_reg_count
= 0;
842 int registered_count
= 0;
844 dmu_objset_type_t ostype
= dmu_objset_type(os
);
847 kmem_zalloc(count
* sizeof (sa_attr_type_t
), KM_SLEEP
);
848 sa
->sa_user_table_sz
= count
* sizeof (sa_attr_type_t
);
850 if (sa
->sa_reg_attr_obj
!= 0) {
851 error
= zap_count(os
, sa
->sa_reg_attr_obj
,
855 * Make sure we retrieved a count and that it isn't zero
857 if (error
|| (error
== 0 && sa_attr_count
== 0)) {
859 error
= SET_ERROR(EINVAL
);
862 sa_reg_count
= sa_attr_count
;
865 if (ostype
== DMU_OST_ZFS
&& sa_attr_count
== 0)
866 sa_attr_count
+= sa_legacy_attr_count
;
868 /* Allocate attribute numbers for attributes that aren't registered */
869 for (i
= 0; i
!= count
; i
++) {
870 boolean_t found
= B_FALSE
;
873 if (ostype
== DMU_OST_ZFS
) {
874 for (j
= 0; j
!= sa_legacy_attr_count
; j
++) {
875 if (strcmp(reg_attrs
[i
].sa_name
,
876 sa_legacy_attrs
[j
].sa_name
) == 0) {
877 sa
->sa_user_table
[i
] =
878 sa_legacy_attrs
[j
].sa_attr
;
886 if (sa
->sa_reg_attr_obj
)
887 error
= zap_lookup(os
, sa
->sa_reg_attr_obj
,
888 reg_attrs
[i
].sa_name
, 8, 1, &attr_value
);
890 error
= SET_ERROR(ENOENT
);
893 sa
->sa_user_table
[i
] = (sa_attr_type_t
)sa_attr_count
;
897 sa
->sa_user_table
[i
] = ATTR_NUM(attr_value
);
904 sa
->sa_num_attrs
= sa_attr_count
;
905 tb
= sa
->sa_attr_table
=
906 kmem_zalloc(sizeof (sa_attr_table_t
) * sa_attr_count
, KM_SLEEP
);
909 * Attribute table is constructed from requested attribute list,
910 * previously foreign registered attributes, and also the legacy
911 * ZPL set of attributes.
914 if (sa
->sa_reg_attr_obj
) {
915 for (zap_cursor_init(&zc
, os
, sa
->sa_reg_attr_obj
);
916 (error
= zap_cursor_retrieve(&zc
, &za
)) == 0;
917 zap_cursor_advance(&zc
)) {
919 value
= za
.za_first_integer
;
922 tb
[ATTR_NUM(value
)].sa_attr
= ATTR_NUM(value
);
923 tb
[ATTR_NUM(value
)].sa_length
= ATTR_LENGTH(value
);
924 tb
[ATTR_NUM(value
)].sa_byteswap
= ATTR_BSWAP(value
);
925 tb
[ATTR_NUM(value
)].sa_registered
= B_TRUE
;
927 if (tb
[ATTR_NUM(value
)].sa_name
) {
930 tb
[ATTR_NUM(value
)].sa_name
=
931 kmem_zalloc(strlen(za
.za_name
) +1, KM_SLEEP
);
932 (void) strlcpy(tb
[ATTR_NUM(value
)].sa_name
, za
.za_name
,
933 strlen(za
.za_name
) +1);
935 zap_cursor_fini(&zc
);
937 * Make sure we processed the correct number of registered
940 if (registered_count
!= sa_reg_count
) {
947 if (ostype
== DMU_OST_ZFS
) {
948 for (i
= 0; i
!= sa_legacy_attr_count
; i
++) {
951 tb
[i
].sa_attr
= sa_legacy_attrs
[i
].sa_attr
;
952 tb
[i
].sa_length
= sa_legacy_attrs
[i
].sa_length
;
953 tb
[i
].sa_byteswap
= sa_legacy_attrs
[i
].sa_byteswap
;
954 tb
[i
].sa_registered
= B_FALSE
;
956 kmem_zalloc(strlen(sa_legacy_attrs
[i
].sa_name
) +1,
958 (void) strlcpy(tb
[i
].sa_name
,
959 sa_legacy_attrs
[i
].sa_name
,
960 strlen(sa_legacy_attrs
[i
].sa_name
) + 1);
964 for (i
= 0; i
!= count
; i
++) {
965 sa_attr_type_t attr_id
;
967 attr_id
= sa
->sa_user_table
[i
];
968 if (tb
[attr_id
].sa_name
)
971 tb
[attr_id
].sa_length
= reg_attrs
[i
].sa_length
;
972 tb
[attr_id
].sa_byteswap
= reg_attrs
[i
].sa_byteswap
;
973 tb
[attr_id
].sa_attr
= attr_id
;
974 tb
[attr_id
].sa_name
=
975 kmem_zalloc(strlen(reg_attrs
[i
].sa_name
) + 1, KM_SLEEP
);
976 (void) strlcpy(tb
[attr_id
].sa_name
, reg_attrs
[i
].sa_name
,
977 strlen(reg_attrs
[i
].sa_name
) + 1);
980 sa
->sa_need_attr_registration
=
981 (sa_attr_count
!= registered_count
);
985 kmem_free(sa
->sa_user_table
, count
* sizeof (sa_attr_type_t
));
986 sa
->sa_user_table
= NULL
;
987 sa_free_attr_table(sa
);
988 return ((error
!= 0) ? error
: EINVAL
);
992 sa_setup(objset_t
*os
, uint64_t sa_obj
, sa_attr_reg_t
*reg_attrs
, int count
,
993 sa_attr_type_t
**user_table
)
998 dmu_objset_type_t ostype
= dmu_objset_type(os
);
1002 mutex_enter(&os
->os_user_ptr_lock
);
1004 mutex_enter(&os
->os_sa
->sa_lock
);
1005 mutex_exit(&os
->os_user_ptr_lock
);
1006 tb
= os
->os_sa
->sa_user_table
;
1007 mutex_exit(&os
->os_sa
->sa_lock
);
1012 sa
= kmem_zalloc(sizeof (sa_os_t
), KM_SLEEP
);
1013 mutex_init(&sa
->sa_lock
, NULL
, MUTEX_DEFAULT
, NULL
);
1014 sa
->sa_master_obj
= sa_obj
;
1017 mutex_enter(&sa
->sa_lock
);
1018 mutex_exit(&os
->os_user_ptr_lock
);
1019 avl_create(&sa
->sa_layout_num_tree
, layout_num_compare
,
1020 sizeof (sa_lot_t
), offsetof(sa_lot_t
, lot_num_node
));
1021 avl_create(&sa
->sa_layout_hash_tree
, layout_hash_compare
,
1022 sizeof (sa_lot_t
), offsetof(sa_lot_t
, lot_hash_node
));
1025 error
= zap_lookup(os
, sa_obj
, SA_LAYOUTS
,
1026 8, 1, &sa
->sa_layout_attr_obj
);
1027 if (error
!= 0 && error
!= ENOENT
)
1029 error
= zap_lookup(os
, sa_obj
, SA_REGISTRY
,
1030 8, 1, &sa
->sa_reg_attr_obj
);
1031 if (error
!= 0 && error
!= ENOENT
)
1035 if ((error
= sa_attr_table_setup(os
, reg_attrs
, count
)) != 0)
1038 if (sa
->sa_layout_attr_obj
!= 0) {
1039 uint64_t layout_count
;
1041 error
= zap_count(os
, sa
->sa_layout_attr_obj
,
1045 * Layout number count should be > 0
1047 if (error
|| (error
== 0 && layout_count
== 0)) {
1049 error
= SET_ERROR(EINVAL
);
1053 for (zap_cursor_init(&zc
, os
, sa
->sa_layout_attr_obj
);
1054 (error
= zap_cursor_retrieve(&zc
, &za
)) == 0;
1055 zap_cursor_advance(&zc
)) {
1056 sa_attr_type_t
*lot_attrs
;
1059 lot_attrs
= kmem_zalloc(sizeof (sa_attr_type_t
) *
1060 za
.za_num_integers
, KM_SLEEP
);
1062 if ((error
= (zap_lookup(os
, sa
->sa_layout_attr_obj
,
1063 za
.za_name
, 2, za
.za_num_integers
,
1064 lot_attrs
))) != 0) {
1065 kmem_free(lot_attrs
, sizeof (sa_attr_type_t
) *
1066 za
.za_num_integers
);
1069 VERIFY(ddi_strtoull(za
.za_name
, NULL
, 10,
1070 (unsigned long long *)&lot_num
) == 0);
1072 (void) sa_add_layout_entry(os
, lot_attrs
,
1073 za
.za_num_integers
, lot_num
,
1074 sa_layout_info_hash(lot_attrs
,
1075 za
.za_num_integers
), B_FALSE
, NULL
);
1076 kmem_free(lot_attrs
, sizeof (sa_attr_type_t
) *
1077 za
.za_num_integers
);
1079 zap_cursor_fini(&zc
);
1082 * Make sure layout count matches number of entries added
1085 if (avl_numnodes(&sa
->sa_layout_num_tree
) != layout_count
) {
1091 /* Add special layout number for old ZNODES */
1092 if (ostype
== DMU_OST_ZFS
) {
1093 (void) sa_add_layout_entry(os
, sa_legacy_zpl_layout
,
1094 sa_legacy_attr_count
, 0,
1095 sa_layout_info_hash(sa_legacy_zpl_layout
,
1096 sa_legacy_attr_count
), B_FALSE
, NULL
);
1098 (void) sa_add_layout_entry(os
, sa_dummy_zpl_layout
, 0, 1,
1101 *user_table
= os
->os_sa
->sa_user_table
;
1102 mutex_exit(&sa
->sa_lock
);
1106 sa_free_attr_table(sa
);
1107 if (sa
->sa_user_table
)
1108 kmem_free(sa
->sa_user_table
, sa
->sa_user_table_sz
);
1109 mutex_exit(&sa
->sa_lock
);
1110 avl_destroy(&sa
->sa_layout_hash_tree
);
1111 avl_destroy(&sa
->sa_layout_num_tree
);
1112 mutex_destroy(&sa
->sa_lock
);
1113 kmem_free(sa
, sizeof (sa_os_t
));
1114 return ((error
== ECKSUM
) ? EIO
: error
);
1118 sa_tear_down(objset_t
*os
)
1120 sa_os_t
*sa
= os
->os_sa
;
1124 kmem_free(sa
->sa_user_table
, sa
->sa_user_table_sz
);
1126 /* Free up attr table */
1128 sa_free_attr_table(sa
);
1132 avl_destroy_nodes(&sa
->sa_layout_hash_tree
, &cookie
))) {
1134 while ((tab
= list_head(&layout
->lot_idx_tab
))) {
1135 ASSERT(refcount_count(&tab
->sa_refcount
));
1136 sa_idx_tab_rele(os
, tab
);
1141 while ((layout
= avl_destroy_nodes(&sa
->sa_layout_num_tree
, &cookie
))) {
1142 kmem_free(layout
->lot_attrs
,
1143 sizeof (sa_attr_type_t
) * layout
->lot_attr_count
);
1144 kmem_free(layout
, sizeof (sa_lot_t
));
1147 avl_destroy(&sa
->sa_layout_hash_tree
);
1148 avl_destroy(&sa
->sa_layout_num_tree
);
1149 mutex_destroy(&sa
->sa_lock
);
1151 kmem_free(sa
, sizeof (sa_os_t
));
1156 sa_build_idx_tab(void *hdr
, void *attr_addr
, sa_attr_type_t attr
,
1157 uint16_t length
, int length_idx
, boolean_t var_length
, void *userp
)
1159 sa_idx_tab_t
*idx_tab
= userp
;
1162 ASSERT(idx_tab
->sa_variable_lengths
);
1163 idx_tab
->sa_variable_lengths
[length_idx
] = length
;
1165 TOC_ATTR_ENCODE(idx_tab
->sa_idx_tab
[attr
], length_idx
,
1166 (uint32_t)((uintptr_t)attr_addr
- (uintptr_t)hdr
));
1170 sa_attr_iter(objset_t
*os
, sa_hdr_phys_t
*hdr
, dmu_object_type_t type
,
1171 sa_iterfunc_t func
, sa_lot_t
*tab
, void *userp
)
1177 sa_os_t
*sa
= os
->os_sa
;
1179 uint16_t *length_start
= NULL
;
1180 uint8_t length_idx
= 0;
1183 search
.lot_num
= SA_LAYOUT_NUM(hdr
, type
);
1184 tb
= avl_find(&sa
->sa_layout_num_tree
, &search
, &loc
);
1188 if (IS_SA_BONUSTYPE(type
)) {
1189 data_start
= (void *)P2ROUNDUP(((uintptr_t)hdr
+
1190 offsetof(sa_hdr_phys_t
, sa_lengths
) +
1191 (sizeof (uint16_t) * tb
->lot_var_sizes
)), 8);
1192 length_start
= hdr
->sa_lengths
;
1197 for (i
= 0; i
!= tb
->lot_attr_count
; i
++) {
1198 int attr_length
, reg_length
;
1201 reg_length
= sa
->sa_attr_table
[tb
->lot_attrs
[i
]].sa_length
;
1203 attr_length
= reg_length
;
1206 attr_length
= length_start
[length_idx
];
1207 idx_len
= length_idx
++;
1210 func(hdr
, data_start
, tb
->lot_attrs
[i
], attr_length
,
1211 idx_len
, reg_length
== 0 ? B_TRUE
: B_FALSE
, userp
);
1213 data_start
= (void *)P2ROUNDUP(((uintptr_t)data_start
+
1220 sa_byteswap_cb(void *hdr
, void *attr_addr
, sa_attr_type_t attr
,
1221 uint16_t length
, int length_idx
, boolean_t variable_length
, void *userp
)
1223 sa_handle_t
*hdl
= userp
;
1224 sa_os_t
*sa
= hdl
->sa_os
->os_sa
;
1226 sa_bswap_table
[sa
->sa_attr_table
[attr
].sa_byteswap
](attr_addr
, length
);
1230 sa_byteswap(sa_handle_t
*hdl
, sa_buf_type_t buftype
)
1232 sa_hdr_phys_t
*sa_hdr_phys
= SA_GET_HDR(hdl
, buftype
);
1234 int num_lengths
= 1;
1236 ASSERTV(sa_os_t
*sa
= hdl
->sa_os
->os_sa
);
1238 ASSERT(MUTEX_HELD(&sa
->sa_lock
));
1239 if (sa_hdr_phys
->sa_magic
== SA_MAGIC
)
1242 db
= SA_GET_DB(hdl
, buftype
);
1244 if (buftype
== SA_SPILL
) {
1245 arc_release(db
->db_buf
, NULL
);
1246 arc_buf_thaw(db
->db_buf
);
1249 sa_hdr_phys
->sa_magic
= BSWAP_32(sa_hdr_phys
->sa_magic
);
1250 sa_hdr_phys
->sa_layout_info
= BSWAP_16(sa_hdr_phys
->sa_layout_info
);
1253 * Determine number of variable lenghts in header
1254 * The standard 8 byte header has one for free and a
1255 * 16 byte header would have 4 + 1;
1257 if (SA_HDR_SIZE(sa_hdr_phys
) > 8)
1258 num_lengths
+= (SA_HDR_SIZE(sa_hdr_phys
) - 8) >> 1;
1259 for (i
= 0; i
!= num_lengths
; i
++)
1260 sa_hdr_phys
->sa_lengths
[i
] =
1261 BSWAP_16(sa_hdr_phys
->sa_lengths
[i
]);
1263 sa_attr_iter(hdl
->sa_os
, sa_hdr_phys
, DMU_OT_SA
,
1264 sa_byteswap_cb
, NULL
, hdl
);
1266 if (buftype
== SA_SPILL
)
1267 arc_buf_freeze(((dmu_buf_impl_t
*)hdl
->sa_spill
)->db_buf
);
1271 sa_build_index(sa_handle_t
*hdl
, sa_buf_type_t buftype
)
1273 sa_hdr_phys_t
*sa_hdr_phys
;
1274 dmu_buf_impl_t
*db
= SA_GET_DB(hdl
, buftype
);
1275 dmu_object_type_t bonustype
= SA_BONUSTYPE_FROM_DB(db
);
1276 sa_os_t
*sa
= hdl
->sa_os
->os_sa
;
1277 sa_idx_tab_t
*idx_tab
;
1279 sa_hdr_phys
= SA_GET_HDR(hdl
, buftype
);
1281 mutex_enter(&sa
->sa_lock
);
1283 /* Do we need to byteswap? */
1285 /* only check if not old znode */
1286 if (IS_SA_BONUSTYPE(bonustype
) && sa_hdr_phys
->sa_magic
!= SA_MAGIC
&&
1287 sa_hdr_phys
->sa_magic
!= 0) {
1288 VERIFY(BSWAP_32(sa_hdr_phys
->sa_magic
) == SA_MAGIC
);
1289 sa_byteswap(hdl
, buftype
);
1292 idx_tab
= sa_find_idx_tab(hdl
->sa_os
, bonustype
, sa_hdr_phys
);
1294 if (buftype
== SA_BONUS
)
1295 hdl
->sa_bonus_tab
= idx_tab
;
1297 hdl
->sa_spill_tab
= idx_tab
;
1299 mutex_exit(&sa
->sa_lock
);
1307 panic("evicting sa dbuf\n");
1311 sa_idx_tab_rele(objset_t
*os
, void *arg
)
1313 sa_os_t
*sa
= os
->os_sa
;
1314 sa_idx_tab_t
*idx_tab
= arg
;
1316 if (idx_tab
== NULL
)
1319 mutex_enter(&sa
->sa_lock
);
1320 if (refcount_remove(&idx_tab
->sa_refcount
, NULL
) == 0) {
1321 list_remove(&idx_tab
->sa_layout
->lot_idx_tab
, idx_tab
);
1322 if (idx_tab
->sa_variable_lengths
)
1323 kmem_free(idx_tab
->sa_variable_lengths
,
1325 idx_tab
->sa_layout
->lot_var_sizes
);
1326 refcount_destroy(&idx_tab
->sa_refcount
);
1327 kmem_free(idx_tab
->sa_idx_tab
,
1328 sizeof (uint32_t) * sa
->sa_num_attrs
);
1329 kmem_free(idx_tab
, sizeof (sa_idx_tab_t
));
1331 mutex_exit(&sa
->sa_lock
);
1335 sa_idx_tab_hold(objset_t
*os
, sa_idx_tab_t
*idx_tab
)
1337 ASSERTV(sa_os_t
*sa
= os
->os_sa
);
1339 ASSERT(MUTEX_HELD(&sa
->sa_lock
));
1340 (void) refcount_add(&idx_tab
->sa_refcount
, NULL
);
1344 sa_spill_rele(sa_handle_t
*hdl
)
1346 mutex_enter(&hdl
->sa_lock
);
1347 if (hdl
->sa_spill
) {
1348 sa_idx_tab_rele(hdl
->sa_os
, hdl
->sa_spill_tab
);
1349 dmu_buf_rele(hdl
->sa_spill
, NULL
);
1350 hdl
->sa_spill
= NULL
;
1351 hdl
->sa_spill_tab
= NULL
;
1353 mutex_exit(&hdl
->sa_lock
);
1357 sa_handle_destroy(sa_handle_t
*hdl
)
1359 dmu_buf_t
*db
= hdl
->sa_bonus
;
1361 mutex_enter(&hdl
->sa_lock
);
1362 (void) dmu_buf_remove_user(db
, &hdl
->sa_dbu
);
1364 if (hdl
->sa_bonus_tab
)
1365 sa_idx_tab_rele(hdl
->sa_os
, hdl
->sa_bonus_tab
);
1367 if (hdl
->sa_spill_tab
)
1368 sa_idx_tab_rele(hdl
->sa_os
, hdl
->sa_spill_tab
);
1370 dmu_buf_rele(hdl
->sa_bonus
, NULL
);
1373 dmu_buf_rele((dmu_buf_t
*)hdl
->sa_spill
, NULL
);
1374 mutex_exit(&hdl
->sa_lock
);
1376 kmem_cache_free(sa_cache
, hdl
);
1380 sa_handle_get_from_db(objset_t
*os
, dmu_buf_t
*db
, void *userp
,
1381 sa_handle_type_t hdl_type
, sa_handle_t
**handlepp
)
1384 sa_handle_t
*handle
= NULL
;
1386 dmu_object_info_t doi
;
1388 dmu_object_info_from_db(db
, &doi
);
1389 ASSERT(doi
.doi_bonus_type
== DMU_OT_SA
||
1390 doi
.doi_bonus_type
== DMU_OT_ZNODE
);
1392 /* find handle, if it exists */
1393 /* if one doesn't exist then create a new one, and initialize it */
1395 if (hdl_type
== SA_HDL_SHARED
)
1396 handle
= dmu_buf_get_user(db
);
1398 if (handle
== NULL
) {
1399 sa_handle_t
*winner
= NULL
;
1401 handle
= kmem_cache_alloc(sa_cache
, KM_SLEEP
);
1402 handle
->sa_dbu
.dbu_evict_func
= NULL
;
1403 handle
->sa_userp
= userp
;
1404 handle
->sa_bonus
= db
;
1406 handle
->sa_spill
= NULL
;
1407 handle
->sa_bonus_tab
= NULL
;
1408 handle
->sa_spill_tab
= NULL
;
1410 error
= sa_build_index(handle
, SA_BONUS
);
1412 if (hdl_type
== SA_HDL_SHARED
) {
1413 dmu_buf_init_user(&handle
->sa_dbu
, sa_evict
, NULL
);
1414 winner
= dmu_buf_set_user_ie(db
, &handle
->sa_dbu
);
1417 if (winner
!= NULL
) {
1418 kmem_cache_free(sa_cache
, handle
);
1428 sa_handle_get(objset_t
*objset
, uint64_t objid
, void *userp
,
1429 sa_handle_type_t hdl_type
, sa_handle_t
**handlepp
)
1434 if ((error
= dmu_bonus_hold(objset
, objid
, NULL
, &db
)))
1437 return (sa_handle_get_from_db(objset
, db
, userp
, hdl_type
,
1442 sa_buf_hold(objset_t
*objset
, uint64_t obj_num
, void *tag
, dmu_buf_t
**db
)
1444 return (dmu_bonus_hold(objset
, obj_num
, tag
, db
));
1448 sa_buf_rele(dmu_buf_t
*db
, void *tag
)
1450 dmu_buf_rele(db
, tag
);
1454 sa_lookup_impl(sa_handle_t
*hdl
, sa_bulk_attr_t
*bulk
, int count
)
1457 ASSERT(MUTEX_HELD(&hdl
->sa_lock
));
1458 return (sa_attr_op(hdl
, bulk
, count
, SA_LOOKUP
, NULL
));
1462 sa_lookup(sa_handle_t
*hdl
, sa_attr_type_t attr
, void *buf
, uint32_t buflen
)
1465 sa_bulk_attr_t bulk
;
1467 VERIFY3U(buflen
, <=, SA_ATTR_MAX_LEN
);
1469 bulk
.sa_attr
= attr
;
1471 bulk
.sa_length
= buflen
;
1472 bulk
.sa_data_func
= NULL
;
1475 mutex_enter(&hdl
->sa_lock
);
1476 error
= sa_lookup_impl(hdl
, &bulk
, 1);
1477 mutex_exit(&hdl
->sa_lock
);
1483 sa_lookup_uio(sa_handle_t
*hdl
, sa_attr_type_t attr
, uio_t
*uio
)
1486 sa_bulk_attr_t bulk
;
1488 bulk
.sa_data
= NULL
;
1489 bulk
.sa_attr
= attr
;
1490 bulk
.sa_data_func
= NULL
;
1494 mutex_enter(&hdl
->sa_lock
);
1495 if ((error
= sa_attr_op(hdl
, &bulk
, 1, SA_LOOKUP
, NULL
)) == 0) {
1496 error
= uiomove((void *)bulk
.sa_addr
, MIN(bulk
.sa_size
,
1497 uio
->uio_resid
), UIO_READ
, uio
);
1499 mutex_exit(&hdl
->sa_lock
);
1505 sa_find_idx_tab(objset_t
*os
, dmu_object_type_t bonustype
, void *data
)
1507 sa_idx_tab_t
*idx_tab
;
1508 sa_hdr_phys_t
*hdr
= (sa_hdr_phys_t
*)data
;
1509 sa_os_t
*sa
= os
->os_sa
;
1510 sa_lot_t
*tb
, search
;
1514 * Deterimine layout number. If SA node and header == 0 then
1515 * force the index table to the dummy "1" empty layout.
1517 * The layout number would only be zero for a newly created file
1518 * that has not added any attributes yet, or with crypto enabled which
1519 * doesn't write any attributes to the bonus buffer.
1522 search
.lot_num
= SA_LAYOUT_NUM(hdr
, bonustype
);
1524 tb
= avl_find(&sa
->sa_layout_num_tree
, &search
, &loc
);
1526 /* Verify header size is consistent with layout information */
1528 ASSERT((IS_SA_BONUSTYPE(bonustype
) &&
1529 SA_HDR_SIZE_MATCH_LAYOUT(hdr
, tb
)) || !IS_SA_BONUSTYPE(bonustype
) ||
1530 (IS_SA_BONUSTYPE(bonustype
) && hdr
->sa_layout_info
== 0));
1533 * See if any of the already existing TOC entries can be reused?
1536 for (idx_tab
= list_head(&tb
->lot_idx_tab
); idx_tab
;
1537 idx_tab
= list_next(&tb
->lot_idx_tab
, idx_tab
)) {
1538 boolean_t valid_idx
= B_TRUE
;
1541 if (tb
->lot_var_sizes
!= 0 &&
1542 idx_tab
->sa_variable_lengths
!= NULL
) {
1543 for (i
= 0; i
!= tb
->lot_var_sizes
; i
++) {
1544 if (hdr
->sa_lengths
[i
] !=
1545 idx_tab
->sa_variable_lengths
[i
]) {
1546 valid_idx
= B_FALSE
;
1552 sa_idx_tab_hold(os
, idx_tab
);
1557 /* No such luck, create a new entry */
1558 idx_tab
= kmem_zalloc(sizeof (sa_idx_tab_t
), KM_SLEEP
);
1559 idx_tab
->sa_idx_tab
=
1560 kmem_zalloc(sizeof (uint32_t) * sa
->sa_num_attrs
, KM_SLEEP
);
1561 idx_tab
->sa_layout
= tb
;
1562 refcount_create(&idx_tab
->sa_refcount
);
1563 if (tb
->lot_var_sizes
)
1564 idx_tab
->sa_variable_lengths
= kmem_alloc(sizeof (uint16_t) *
1565 tb
->lot_var_sizes
, KM_SLEEP
);
1567 sa_attr_iter(os
, hdr
, bonustype
, sa_build_idx_tab
,
1569 sa_idx_tab_hold(os
, idx_tab
); /* one hold for consumer */
1570 sa_idx_tab_hold(os
, idx_tab
); /* one for layout */
1571 list_insert_tail(&tb
->lot_idx_tab
, idx_tab
);
1576 sa_default_locator(void **dataptr
, uint32_t *len
, uint32_t total_len
,
1577 boolean_t start
, void *userdata
)
1581 *dataptr
= userdata
;
1586 sa_attr_register_sync(sa_handle_t
*hdl
, dmu_tx_t
*tx
)
1588 uint64_t attr_value
= 0;
1589 sa_os_t
*sa
= hdl
->sa_os
->os_sa
;
1590 sa_attr_table_t
*tb
= sa
->sa_attr_table
;
1593 mutex_enter(&sa
->sa_lock
);
1595 if (!sa
->sa_need_attr_registration
|| sa
->sa_master_obj
== 0) {
1596 mutex_exit(&sa
->sa_lock
);
1600 if (sa
->sa_reg_attr_obj
== 0) {
1601 sa
->sa_reg_attr_obj
= zap_create_link(hdl
->sa_os
,
1602 DMU_OT_SA_ATTR_REGISTRATION
,
1603 sa
->sa_master_obj
, SA_REGISTRY
, tx
);
1605 for (i
= 0; i
!= sa
->sa_num_attrs
; i
++) {
1606 if (sa
->sa_attr_table
[i
].sa_registered
)
1608 ATTR_ENCODE(attr_value
, tb
[i
].sa_attr
, tb
[i
].sa_length
,
1610 VERIFY(0 == zap_update(hdl
->sa_os
, sa
->sa_reg_attr_obj
,
1611 tb
[i
].sa_name
, 8, 1, &attr_value
, tx
));
1612 tb
[i
].sa_registered
= B_TRUE
;
1614 sa
->sa_need_attr_registration
= B_FALSE
;
1615 mutex_exit(&sa
->sa_lock
);
1619 * Replace all attributes with attributes specified in template.
1620 * If dnode had a spill buffer then those attributes will be
1621 * also be replaced, possibly with just an empty spill block
1623 * This interface is intended to only be used for bulk adding of
1624 * attributes for a new file. It will also be used by the ZPL
1625 * when converting and old formatted znode to native SA support.
1628 sa_replace_all_by_template_locked(sa_handle_t
*hdl
, sa_bulk_attr_t
*attr_desc
,
1629 int attr_count
, dmu_tx_t
*tx
)
1631 sa_os_t
*sa
= hdl
->sa_os
->os_sa
;
1633 if (sa
->sa_need_attr_registration
)
1634 sa_attr_register_sync(hdl
, tx
);
1635 return (sa_build_layouts(hdl
, attr_desc
, attr_count
, tx
));
1639 sa_replace_all_by_template(sa_handle_t
*hdl
, sa_bulk_attr_t
*attr_desc
,
1640 int attr_count
, dmu_tx_t
*tx
)
1644 mutex_enter(&hdl
->sa_lock
);
1645 error
= sa_replace_all_by_template_locked(hdl
, attr_desc
,
1647 mutex_exit(&hdl
->sa_lock
);
1652 * add/remove/replace a single attribute and then rewrite the entire set
1656 sa_modify_attrs(sa_handle_t
*hdl
, sa_attr_type_t newattr
,
1657 sa_data_op_t action
, sa_data_locator_t
*locator
, void *datastart
,
1658 uint16_t buflen
, dmu_tx_t
*tx
)
1660 sa_os_t
*sa
= hdl
->sa_os
->os_sa
;
1661 dmu_buf_impl_t
*db
= (dmu_buf_impl_t
*)hdl
->sa_bonus
;
1663 sa_bulk_attr_t
*attr_desc
;
1665 int bonus_attr_count
= 0;
1666 int bonus_data_size
= 0;
1667 int spill_data_size
= 0;
1668 int spill_attr_count
= 0;
1671 int i
, j
, k
, length_idx
;
1673 sa_idx_tab_t
*idx_tab
;
1677 ASSERT(MUTEX_HELD(&hdl
->sa_lock
));
1679 /* First make of copy of the old data */
1683 if (dn
->dn_bonuslen
!= 0) {
1684 bonus_data_size
= hdl
->sa_bonus
->db_size
;
1685 old_data
[0] = kmem_alloc(bonus_data_size
, KM_SLEEP
);
1686 bcopy(hdl
->sa_bonus
->db_data
, old_data
[0],
1687 hdl
->sa_bonus
->db_size
);
1688 bonus_attr_count
= hdl
->sa_bonus_tab
->sa_layout
->lot_attr_count
;
1694 /* Bring spill buffer online if it isn't currently */
1696 if ((error
= sa_get_spill(hdl
)) == 0) {
1697 spill_data_size
= hdl
->sa_spill
->db_size
;
1698 old_data
[1] = zio_buf_alloc(spill_data_size
);
1699 bcopy(hdl
->sa_spill
->db_data
, old_data
[1],
1700 hdl
->sa_spill
->db_size
);
1702 hdl
->sa_spill_tab
->sa_layout
->lot_attr_count
;
1703 } else if (error
&& error
!= ENOENT
) {
1705 kmem_free(old_data
[0], bonus_data_size
);
1711 /* build descriptor of all attributes */
1713 attr_count
= bonus_attr_count
+ spill_attr_count
;
1714 if (action
== SA_ADD
)
1716 else if (action
== SA_REMOVE
)
1719 attr_desc
= kmem_zalloc(sizeof (sa_bulk_attr_t
) * attr_count
, KM_SLEEP
);
1722 * loop through bonus and spill buffer if it exists, and
1723 * build up new attr_descriptor to reset the attributes
1726 count
= bonus_attr_count
;
1727 hdr
= SA_GET_HDR(hdl
, SA_BONUS
);
1728 idx_tab
= SA_IDX_TAB_GET(hdl
, SA_BONUS
);
1729 for (; k
!= 2; k
++) {
1731 * Iterate over each attribute in layout. Fetch the
1732 * size of variable-length attributes needing rewrite
1733 * from sa_lengths[].
1735 for (i
= 0, length_idx
= 0; i
!= count
; i
++) {
1736 sa_attr_type_t attr
;
1738 attr
= idx_tab
->sa_layout
->lot_attrs
[i
];
1739 length
= SA_REGISTERED_LEN(sa
, attr
);
1740 if (attr
== newattr
) {
1743 if (action
== SA_REMOVE
)
1745 ASSERT(length
== 0);
1746 ASSERT(action
== SA_REPLACE
);
1747 SA_ADD_BULK_ATTR(attr_desc
, j
, attr
,
1748 locator
, datastart
, buflen
);
1751 length
= hdr
->sa_lengths
[length_idx
++];
1753 SA_ADD_BULK_ATTR(attr_desc
, j
, attr
,
1755 (TOC_OFF(idx_tab
->sa_idx_tab
[attr
]) +
1756 (uintptr_t)old_data
[k
]), length
);
1759 if (k
== 0 && hdl
->sa_spill
) {
1760 hdr
= SA_GET_HDR(hdl
, SA_SPILL
);
1761 idx_tab
= SA_IDX_TAB_GET(hdl
, SA_SPILL
);
1762 count
= spill_attr_count
;
1767 if (action
== SA_ADD
) {
1768 length
= SA_REGISTERED_LEN(sa
, newattr
);
1772 SA_ADD_BULK_ATTR(attr_desc
, j
, newattr
, locator
,
1776 error
= sa_build_layouts(hdl
, attr_desc
, attr_count
, tx
);
1779 kmem_free(old_data
[0], bonus_data_size
);
1781 zio_buf_free(old_data
[1], spill_data_size
);
1782 kmem_free(attr_desc
, sizeof (sa_bulk_attr_t
) * attr_count
);
1788 sa_bulk_update_impl(sa_handle_t
*hdl
, sa_bulk_attr_t
*bulk
, int count
,
1792 sa_os_t
*sa
= hdl
->sa_os
->os_sa
;
1793 dmu_object_type_t bonustype
;
1794 dmu_buf_t
*saved_spill
;
1797 ASSERT(MUTEX_HELD(&hdl
->sa_lock
));
1799 bonustype
= SA_BONUSTYPE_FROM_DB(SA_GET_DB(hdl
, SA_BONUS
));
1800 saved_spill
= hdl
->sa_spill
;
1802 /* sync out registration table if necessary */
1803 if (sa
->sa_need_attr_registration
)
1804 sa_attr_register_sync(hdl
, tx
);
1806 error
= sa_attr_op(hdl
, bulk
, count
, SA_UPDATE
, tx
);
1807 if (error
== 0 && !IS_SA_BONUSTYPE(bonustype
) && sa
->sa_update_cb
)
1808 sa
->sa_update_cb(hdl
, tx
);
1811 * If saved_spill is NULL and current sa_spill is not NULL that
1812 * means we increased the refcount of the spill buffer through
1813 * sa_get_spill() or dmu_spill_hold_by_dnode(). Therefore we
1814 * must release the hold before calling dmu_tx_commit() to avoid
1815 * making a copy of this buffer in dbuf_sync_leaf() due to the
1816 * reference count now being greater than 1.
1818 if (!saved_spill
&& hdl
->sa_spill
) {
1819 if (hdl
->sa_spill_tab
) {
1820 sa_idx_tab_rele(hdl
->sa_os
, hdl
->sa_spill_tab
);
1821 hdl
->sa_spill_tab
= NULL
;
1824 dmu_buf_rele((dmu_buf_t
*)hdl
->sa_spill
, NULL
);
1825 hdl
->sa_spill
= NULL
;
1832 * update or add new attribute
1835 sa_update(sa_handle_t
*hdl
, sa_attr_type_t type
,
1836 void *buf
, uint32_t buflen
, dmu_tx_t
*tx
)
1839 sa_bulk_attr_t bulk
;
1841 VERIFY3U(buflen
, <=, SA_ATTR_MAX_LEN
);
1843 bulk
.sa_attr
= type
;
1844 bulk
.sa_data_func
= NULL
;
1845 bulk
.sa_length
= buflen
;
1848 mutex_enter(&hdl
->sa_lock
);
1849 error
= sa_bulk_update_impl(hdl
, &bulk
, 1, tx
);
1850 mutex_exit(&hdl
->sa_lock
);
1855 sa_update_from_cb(sa_handle_t
*hdl
, sa_attr_type_t attr
,
1856 uint32_t buflen
, sa_data_locator_t
*locator
, void *userdata
, dmu_tx_t
*tx
)
1859 sa_bulk_attr_t bulk
;
1861 VERIFY3U(buflen
, <=, SA_ATTR_MAX_LEN
);
1863 bulk
.sa_attr
= attr
;
1864 bulk
.sa_data
= userdata
;
1865 bulk
.sa_data_func
= locator
;
1866 bulk
.sa_length
= buflen
;
1868 mutex_enter(&hdl
->sa_lock
);
1869 error
= sa_bulk_update_impl(hdl
, &bulk
, 1, tx
);
1870 mutex_exit(&hdl
->sa_lock
);
1875 * Return size of an attribute
1879 sa_size(sa_handle_t
*hdl
, sa_attr_type_t attr
, int *size
)
1881 sa_bulk_attr_t bulk
;
1884 bulk
.sa_data
= NULL
;
1885 bulk
.sa_attr
= attr
;
1886 bulk
.sa_data_func
= NULL
;
1889 mutex_enter(&hdl
->sa_lock
);
1890 if ((error
= sa_attr_op(hdl
, &bulk
, 1, SA_LOOKUP
, NULL
)) != 0) {
1891 mutex_exit(&hdl
->sa_lock
);
1894 *size
= bulk
.sa_size
;
1896 mutex_exit(&hdl
->sa_lock
);
1901 sa_bulk_lookup_locked(sa_handle_t
*hdl
, sa_bulk_attr_t
*attrs
, int count
)
1904 ASSERT(MUTEX_HELD(&hdl
->sa_lock
));
1905 return (sa_lookup_impl(hdl
, attrs
, count
));
1909 sa_bulk_lookup(sa_handle_t
*hdl
, sa_bulk_attr_t
*attrs
, int count
)
1914 mutex_enter(&hdl
->sa_lock
);
1915 error
= sa_bulk_lookup_locked(hdl
, attrs
, count
);
1916 mutex_exit(&hdl
->sa_lock
);
1921 sa_bulk_update(sa_handle_t
*hdl
, sa_bulk_attr_t
*attrs
, int count
, dmu_tx_t
*tx
)
1926 mutex_enter(&hdl
->sa_lock
);
1927 error
= sa_bulk_update_impl(hdl
, attrs
, count
, tx
);
1928 mutex_exit(&hdl
->sa_lock
);
1933 sa_remove(sa_handle_t
*hdl
, sa_attr_type_t attr
, dmu_tx_t
*tx
)
1937 mutex_enter(&hdl
->sa_lock
);
1938 error
= sa_modify_attrs(hdl
, attr
, SA_REMOVE
, NULL
,
1940 mutex_exit(&hdl
->sa_lock
);
1945 sa_object_info(sa_handle_t
*hdl
, dmu_object_info_t
*doi
)
1947 dmu_object_info_from_db((dmu_buf_t
*)hdl
->sa_bonus
, doi
);
1951 sa_object_size(sa_handle_t
*hdl
, uint32_t *blksize
, u_longlong_t
*nblocks
)
1953 dmu_object_size_from_db((dmu_buf_t
*)hdl
->sa_bonus
,
1958 sa_set_userp(sa_handle_t
*hdl
, void *ptr
)
1960 hdl
->sa_userp
= ptr
;
1964 sa_get_db(sa_handle_t
*hdl
)
1966 return ((dmu_buf_t
*)hdl
->sa_bonus
);
1970 sa_get_userdata(sa_handle_t
*hdl
)
1972 return (hdl
->sa_userp
);
1976 sa_register_update_callback_locked(objset_t
*os
, sa_update_cb_t
*func
)
1978 ASSERT(MUTEX_HELD(&os
->os_sa
->sa_lock
));
1979 os
->os_sa
->sa_update_cb
= func
;
1983 sa_register_update_callback(objset_t
*os
, sa_update_cb_t
*func
)
1986 mutex_enter(&os
->os_sa
->sa_lock
);
1987 sa_register_update_callback_locked(os
, func
);
1988 mutex_exit(&os
->os_sa
->sa_lock
);
1992 sa_handle_object(sa_handle_t
*hdl
)
1994 return (hdl
->sa_bonus
->db_object
);
1998 sa_enabled(objset_t
*os
)
2000 return (os
->os_sa
== NULL
);
2004 sa_set_sa_object(objset_t
*os
, uint64_t sa_object
)
2006 sa_os_t
*sa
= os
->os_sa
;
2008 if (sa
->sa_master_obj
)
2011 sa
->sa_master_obj
= sa_object
;
2017 sa_hdrsize(void *arg
)
2019 sa_hdr_phys_t
*hdr
= arg
;
2021 return (SA_HDR_SIZE(hdr
));
2025 sa_handle_lock(sa_handle_t
*hdl
)
2028 mutex_enter(&hdl
->sa_lock
);
2032 sa_handle_unlock(sa_handle_t
*hdl
)
2035 mutex_exit(&hdl
->sa_lock
);
2039 EXPORT_SYMBOL(sa_handle_get
);
2040 EXPORT_SYMBOL(sa_handle_get_from_db
);
2041 EXPORT_SYMBOL(sa_handle_destroy
);
2042 EXPORT_SYMBOL(sa_buf_hold
);
2043 EXPORT_SYMBOL(sa_buf_rele
);
2044 EXPORT_SYMBOL(sa_spill_rele
);
2045 EXPORT_SYMBOL(sa_lookup
);
2046 EXPORT_SYMBOL(sa_update
);
2047 EXPORT_SYMBOL(sa_remove
);
2048 EXPORT_SYMBOL(sa_bulk_lookup
);
2049 EXPORT_SYMBOL(sa_bulk_lookup_locked
);
2050 EXPORT_SYMBOL(sa_bulk_update
);
2051 EXPORT_SYMBOL(sa_size
);
2052 EXPORT_SYMBOL(sa_update_from_cb
);
2053 EXPORT_SYMBOL(sa_object_info
);
2054 EXPORT_SYMBOL(sa_object_size
);
2055 EXPORT_SYMBOL(sa_get_userdata
);
2056 EXPORT_SYMBOL(sa_set_userp
);
2057 EXPORT_SYMBOL(sa_get_db
);
2058 EXPORT_SYMBOL(sa_handle_object
);
2059 EXPORT_SYMBOL(sa_register_update_callback
);
2060 EXPORT_SYMBOL(sa_setup
);
2061 EXPORT_SYMBOL(sa_replace_all_by_template
);
2062 EXPORT_SYMBOL(sa_replace_all_by_template_locked
);
2063 EXPORT_SYMBOL(sa_enabled
);
2064 EXPORT_SYMBOL(sa_cache_init
);
2065 EXPORT_SYMBOL(sa_cache_fini
);
2066 EXPORT_SYMBOL(sa_set_sa_object
);
2067 EXPORT_SYMBOL(sa_hdrsize
);
2068 EXPORT_SYMBOL(sa_handle_lock
);
2069 EXPORT_SYMBOL(sa_handle_unlock
);
2070 EXPORT_SYMBOL(sa_lookup_uio
);
2071 #endif /* _KERNEL */