4 * The contents of this file are subject to the terms of the
5 * Common Development and Distribution License (the "License").
6 * You may not use this file except in compliance with the License.
8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 * or http://www.opensolaris.org/os/licensing.
10 * See the License for the specific language governing permissions
11 * and limitations under the License.
13 * When distributing Covered Code, include this CDDL HEADER in each
14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 * If applicable, add the following below this CDDL HEADER, with the
16 * fields enclosed by brackets "[]" replaced with your own identifying
17 * information: Portions Copyright [yyyy] [name of copyright owner]
22 * Copyright (c) 2010, Oracle and/or its affiliates. All rights reserved.
25 #include <sys/zfs_context.h>
26 #include <sys/types.h>
27 #include <sys/param.h>
28 #include <sys/systm.h>
29 #include <sys/sysmacros.h>
31 #include <sys/dmu_impl.h>
32 #include <sys/dmu_objset.h>
34 #include <sys/dnode.h>
37 #include <sys/sunddi.h>
38 #include <sys/sa_impl.h>
39 #include <sys/dnode.h>
40 #include <sys/errno.h>
41 #include <sys/zfs_context.h>
44 * ZFS System attributes:
46 * A generic mechanism to allow for arbitrary attributes
47 * to be stored in a dnode. The data will be stored in the bonus buffer of
48 * the dnode and if necessary a special "spill" block will be used to handle
49 * overflow situations. The spill block will be sized to fit the data
50 * from 512 - 128K. When a spill block is used the BP (blkptr_t) for the
51 * spill block is stored at the end of the current bonus buffer. Any
52 * attributes that would be in the way of the blkptr_t will be relocated
53 * into the spill block.
55 * Attribute registration:
57 * Stored persistently on a per dataset basis
58 * a mapping between attribute "string" names and their actual attribute
59 * numeric values, length, and byteswap function. The names are only used
60 * during registration. All attributes are known by their unique attribute
61 * id value. If an attribute can have a variable size then the value
62 * 0 will be used to indicate this.
66 * Attribute layouts are a way to compactly store multiple attributes, but
67 * without taking the overhead associated with managing each attribute
68 * individually. Since you will typically have the same set of attributes
69 * stored in the same order a single table will be used to represent that
70 * layout. The ZPL for example will usually have only about 10 different
71 * layouts (regular files, device files, symlinks,
72 * regular files + scanstamp, files/dir with extended attributes, and then
73 * you have the possibility of all of those minus ACL, because it would
74 * be kicked out into the spill block)
76 * Layouts are simply an array of the attributes and their
77 * ordering i.e. [0, 1, 4, 5, 2]
79 * Each distinct layout is given a unique layout number and that is whats
80 * stored in the header at the beginning of the SA data buffer.
82 * A layout only covers a single dbuf (bonus or spill). If a set of
83 * attributes is split up between the bonus buffer and a spill buffer then
84 * two different layouts will be used. This allows us to byteswap the
85 * spill without looking at the bonus buffer and keeps the on disk format of
86 * the bonus and spill buffer the same.
88 * Adding a single attribute will cause the entire set of attributes to
89 * be rewritten and could result in a new layout number being constructed
90 * as part of the rewrite if no such layout exists for the new set of
91 * attribues. The new attribute will be appended to the end of the already
92 * existing attributes.
94 * Both the attribute registration and attribute layout information are
95 * stored in normal ZAP attributes. Their should be a small number of
96 * known layouts and the set of attributes is assumed to typically be quite
99 * The registered attributes and layout "table" information is maintained
100 * in core and a special "sa_os_t" is attached to the objset_t.
102 * A special interface is provided to allow for quickly applying
103 * a large set of attributes at once. sa_replace_all_by_template() is
104 * used to set an array of attributes. This is used by the ZPL when
105 * creating a brand new file. The template that is passed into the function
106 * specifies the attribute, size for variable length attributes, location of
107 * data and special "data locator" function if the data isn't in a contiguous
110 * Byteswap implications:
111 * Since the SA attributes are not entirely self describing we can't do
112 * the normal byteswap processing. The special ZAP layout attribute and
113 * attribute registration attributes define the byteswap function and the
114 * size of the attributes, unless it is variable sized.
115 * The normal ZFS byteswapping infrastructure assumes you don't need
116 * to read any objects in order to do the necessary byteswapping. Whereas
117 * SA attributes can only be properly byteswapped if the dataset is opened
118 * and the layout/attribute ZAP attributes are available. Because of this
119 * the SA attributes will be byteswapped when they are first accessed by
120 * the SA code that will read the SA data.
123 typedef void (sa_iterfunc_t
)(void *hdr
, void *addr
, sa_attr_type_t
,
124 uint16_t length
, int length_idx
, boolean_t
, void *userp
);
126 static int sa_build_index(sa_handle_t
*hdl
, sa_buf_type_t buftype
);
127 static void sa_idx_tab_hold(objset_t
*os
, sa_idx_tab_t
*idx_tab
);
128 static void *sa_find_idx_tab(objset_t
*os
, dmu_object_type_t bonustype
,
130 static void sa_idx_tab_rele(objset_t
*os
, void *arg
);
131 static void sa_copy_data(sa_data_locator_t
*func
, void *start
, void *target
,
133 static int sa_modify_attrs(sa_handle_t
*hdl
, sa_attr_type_t newattr
,
134 sa_data_op_t action
, sa_data_locator_t
*locator
, void *datastart
,
135 uint16_t buflen
, dmu_tx_t
*tx
);
137 arc_byteswap_func_t
*sa_bswap_table
[] = {
138 byteswap_uint64_array
,
139 byteswap_uint32_array
,
140 byteswap_uint16_array
,
141 byteswap_uint8_array
,
145 #define SA_COPY_DATA(f, s, t, l) \
149 *(uint64_t *)t = *(uint64_t *)s; \
150 } else if (l == 16) { \
151 *(uint64_t *)t = *(uint64_t *)s; \
152 *(uint64_t *)((uintptr_t)t + 8) = \
153 *(uint64_t *)((uintptr_t)s + 8); \
158 sa_copy_data(f, s, t, l); \
162 * This table is fixed and cannot be changed. Its purpose is to
163 * allow the SA code to work with both old/new ZPL file systems.
164 * It contains the list of legacy attributes. These attributes aren't
165 * stored in the "attribute" registry zap objects, since older ZPL file systems
166 * won't have the registry. Only objsets of type ZFS_TYPE_FILESYSTEM will
167 * use this static table.
169 sa_attr_reg_t sa_legacy_attrs
[] = {
170 {"ZPL_ATIME", sizeof (uint64_t) * 2, SA_UINT64_ARRAY
, 0},
171 {"ZPL_MTIME", sizeof (uint64_t) * 2, SA_UINT64_ARRAY
, 1},
172 {"ZPL_CTIME", sizeof (uint64_t) * 2, SA_UINT64_ARRAY
, 2},
173 {"ZPL_CRTIME", sizeof (uint64_t) * 2, SA_UINT64_ARRAY
, 3},
174 {"ZPL_GEN", sizeof (uint64_t), SA_UINT64_ARRAY
, 4},
175 {"ZPL_MODE", sizeof (uint64_t), SA_UINT64_ARRAY
, 5},
176 {"ZPL_SIZE", sizeof (uint64_t), SA_UINT64_ARRAY
, 6},
177 {"ZPL_PARENT", sizeof (uint64_t), SA_UINT64_ARRAY
, 7},
178 {"ZPL_LINKS", sizeof (uint64_t), SA_UINT64_ARRAY
, 8},
179 {"ZPL_XATTR", sizeof (uint64_t), SA_UINT64_ARRAY
, 9},
180 {"ZPL_RDEV", sizeof (uint64_t), SA_UINT64_ARRAY
, 10},
181 {"ZPL_FLAGS", sizeof (uint64_t), SA_UINT64_ARRAY
, 11},
182 {"ZPL_UID", sizeof (uint64_t), SA_UINT64_ARRAY
, 12},
183 {"ZPL_GID", sizeof (uint64_t), SA_UINT64_ARRAY
, 13},
184 {"ZPL_PAD", sizeof (uint64_t) * 4, SA_UINT64_ARRAY
, 14},
185 {"ZPL_ZNODE_ACL", 88, SA_UINT8_ARRAY
, 15},
190 * This is only used for objects of type DMU_OT_ZNODE
192 sa_attr_type_t sa_legacy_zpl_layout
[] = {
193 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
197 * Special dummy layout used for buffers with no attributes.
200 sa_attr_type_t sa_dummy_zpl_layout
[] = { 0 };
202 static int sa_legacy_attr_count
= 16;
203 static kmem_cache_t
*sa_cache
= NULL
;
207 sa_cache_constructor(void *buf
, void *unused
, int kmflag
)
209 sa_handle_t
*hdl
= buf
;
211 hdl
->sa_bonus_tab
= NULL
;
212 hdl
->sa_spill_tab
= NULL
;
214 hdl
->sa_userp
= NULL
;
215 hdl
->sa_bonus
= NULL
;
216 hdl
->sa_spill
= NULL
;
217 mutex_init(&hdl
->sa_lock
, NULL
, MUTEX_DEFAULT
, NULL
);
223 sa_cache_destructor(void *buf
, void *unused
)
225 sa_handle_t
*hdl
= buf
;
226 mutex_destroy(&hdl
->sa_lock
);
232 sa_cache
= kmem_cache_create("sa_cache",
233 sizeof (sa_handle_t
), 0, sa_cache_constructor
,
234 sa_cache_destructor
, NULL
, NULL
, NULL
, 0);
241 kmem_cache_destroy(sa_cache
);
245 layout_num_compare(const void *arg1
, const void *arg2
)
247 const sa_lot_t
*node1
= arg1
;
248 const sa_lot_t
*node2
= arg2
;
250 if (node1
->lot_num
> node2
->lot_num
)
252 else if (node1
->lot_num
< node2
->lot_num
)
258 layout_hash_compare(const void *arg1
, const void *arg2
)
260 const sa_lot_t
*node1
= arg1
;
261 const sa_lot_t
*node2
= arg2
;
263 if (node1
->lot_hash
> node2
->lot_hash
)
265 if (node1
->lot_hash
< node2
->lot_hash
)
267 if (node1
->lot_instance
> node2
->lot_instance
)
269 if (node1
->lot_instance
< node2
->lot_instance
)
275 sa_layout_equal(sa_lot_t
*tbf
, sa_attr_type_t
*attrs
, int count
)
279 if (count
!= tbf
->lot_attr_count
)
282 for (i
= 0; i
!= count
; i
++) {
283 if (attrs
[i
] != tbf
->lot_attrs
[i
])
289 #define SA_ATTR_HASH(attr) (zfs_crc64_table[(-1ULL ^ attr) & 0xFF])
292 sa_layout_info_hash(sa_attr_type_t
*attrs
, int attr_count
)
295 uint64_t crc
= -1ULL;
297 for (i
= 0; i
!= attr_count
; i
++)
298 crc
^= SA_ATTR_HASH(attrs
[i
]);
304 sa_get_spill(sa_handle_t
*hdl
)
307 if (hdl
->sa_spill
== NULL
) {
308 if ((rc
= dmu_spill_hold_existing(hdl
->sa_bonus
, NULL
,
309 &hdl
->sa_spill
)) == 0)
310 VERIFY(0 == sa_build_index(hdl
, SA_SPILL
));
319 * Main attribute lookup/update function
320 * returns 0 for success or non zero for failures
322 * Operates on bulk array, first failure will abort further processing
325 sa_attr_op(sa_handle_t
*hdl
, sa_bulk_attr_t
*bulk
, int count
,
326 sa_data_op_t data_op
, dmu_tx_t
*tx
)
328 sa_os_t
*sa
= hdl
->sa_os
->os_sa
;
331 sa_buf_type_t buftypes
;
336 for (i
= 0; i
!= count
; i
++) {
337 ASSERT(bulk
[i
].sa_attr
<= hdl
->sa_os
->os_sa
->sa_num_attrs
);
339 bulk
[i
].sa_addr
= NULL
;
340 /* First check the bonus buffer */
342 if (hdl
->sa_bonus_tab
&& TOC_ATTR_PRESENT(
343 hdl
->sa_bonus_tab
->sa_idx_tab
[bulk
[i
].sa_attr
])) {
344 SA_ATTR_INFO(sa
, hdl
->sa_bonus_tab
,
345 SA_GET_HDR(hdl
, SA_BONUS
),
346 bulk
[i
].sa_attr
, bulk
[i
], SA_BONUS
, hdl
);
347 if (tx
&& !(buftypes
& SA_BONUS
)) {
348 dmu_buf_will_dirty(hdl
->sa_bonus
, tx
);
349 buftypes
|= SA_BONUS
;
352 if (bulk
[i
].sa_addr
== NULL
&&
353 ((error
= sa_get_spill(hdl
)) == 0)) {
354 if (TOC_ATTR_PRESENT(
355 hdl
->sa_spill_tab
->sa_idx_tab
[bulk
[i
].sa_attr
])) {
356 SA_ATTR_INFO(sa
, hdl
->sa_spill_tab
,
357 SA_GET_HDR(hdl
, SA_SPILL
),
358 bulk
[i
].sa_attr
, bulk
[i
], SA_SPILL
, hdl
);
359 if (tx
&& !(buftypes
& SA_SPILL
) &&
360 bulk
[i
].sa_size
== bulk
[i
].sa_length
) {
361 dmu_buf_will_dirty(hdl
->sa_spill
, tx
);
362 buftypes
|= SA_SPILL
;
366 if (error
&& error
!= ENOENT
) {
367 return ((error
== ECKSUM
) ? EIO
: error
);
372 if (bulk
[i
].sa_addr
== NULL
)
374 if (bulk
[i
].sa_data
) {
375 SA_COPY_DATA(bulk
[i
].sa_data_func
,
376 bulk
[i
].sa_addr
, bulk
[i
].sa_data
,
382 /* existing rewrite of attr */
383 if (bulk
[i
].sa_addr
&&
384 bulk
[i
].sa_size
== bulk
[i
].sa_length
) {
385 SA_COPY_DATA(bulk
[i
].sa_data_func
,
386 bulk
[i
].sa_data
, bulk
[i
].sa_addr
,
389 } else if (bulk
[i
].sa_addr
) { /* attr size change */
390 error
= sa_modify_attrs(hdl
, bulk
[i
].sa_attr
,
391 SA_REPLACE
, bulk
[i
].sa_data_func
,
392 bulk
[i
].sa_data
, bulk
[i
].sa_length
, tx
);
393 } else { /* adding new attribute */
394 error
= sa_modify_attrs(hdl
, bulk
[i
].sa_attr
,
395 SA_ADD
, bulk
[i
].sa_data_func
,
396 bulk
[i
].sa_data
, bulk
[i
].sa_length
, tx
);
409 sa_add_layout_entry(objset_t
*os
, sa_attr_type_t
*attrs
, int attr_count
,
410 uint64_t lot_num
, uint64_t hash
, boolean_t zapadd
, dmu_tx_t
*tx
)
412 sa_os_t
*sa
= os
->os_sa
;
413 sa_lot_t
*tb
, *findtb
;
417 ASSERT(MUTEX_HELD(&sa
->sa_lock
));
418 tb
= kmem_zalloc(sizeof (sa_lot_t
), KM_SLEEP
);
419 tb
->lot_attr_count
= attr_count
;
420 tb
->lot_attrs
= kmem_alloc(sizeof (sa_attr_type_t
) * attr_count
,
422 bcopy(attrs
, tb
->lot_attrs
, sizeof (sa_attr_type_t
) * attr_count
);
423 tb
->lot_num
= lot_num
;
425 tb
->lot_instance
= 0;
430 if (sa
->sa_layout_attr_obj
== 0) {
431 sa
->sa_layout_attr_obj
= zap_create(os
,
432 DMU_OT_SA_ATTR_LAYOUTS
, DMU_OT_NONE
, 0, tx
);
433 VERIFY(zap_add(os
, sa
->sa_master_obj
, SA_LAYOUTS
, 8, 1,
434 &sa
->sa_layout_attr_obj
, tx
) == 0);
437 (void) snprintf(attr_name
, sizeof (attr_name
),
439 VERIFY(0 == zap_update(os
, os
->os_sa
->sa_layout_attr_obj
,
440 attr_name
, 2, attr_count
, attrs
, tx
));
443 list_create(&tb
->lot_idx_tab
, sizeof (sa_idx_tab_t
),
444 offsetof(sa_idx_tab_t
, sa_next
));
446 for (i
= 0; i
!= attr_count
; i
++) {
447 if (sa
->sa_attr_table
[tb
->lot_attrs
[i
]].sa_length
== 0)
451 avl_add(&sa
->sa_layout_num_tree
, tb
);
453 /* verify we don't have a hash collision */
454 if ((findtb
= avl_find(&sa
->sa_layout_hash_tree
, tb
, &loc
)) != NULL
) {
455 for (; findtb
&& findtb
->lot_hash
== hash
;
456 findtb
= AVL_NEXT(&sa
->sa_layout_hash_tree
, findtb
)) {
457 if (findtb
->lot_instance
!= tb
->lot_instance
)
462 avl_add(&sa
->sa_layout_hash_tree
, tb
);
467 sa_find_layout(objset_t
*os
, uint64_t hash
, sa_attr_type_t
*attrs
,
468 int count
, dmu_tx_t
*tx
, sa_lot_t
**lot
)
470 sa_lot_t
*tb
, tbsearch
;
472 sa_os_t
*sa
= os
->os_sa
;
473 boolean_t found
= B_FALSE
;
475 mutex_enter(&sa
->sa_lock
);
476 tbsearch
.lot_hash
= hash
;
477 tbsearch
.lot_instance
= 0;
478 tb
= avl_find(&sa
->sa_layout_hash_tree
, &tbsearch
, &loc
);
480 for (; tb
&& tb
->lot_hash
== hash
;
481 tb
= AVL_NEXT(&sa
->sa_layout_hash_tree
, tb
)) {
482 if (sa_layout_equal(tb
, attrs
, count
) == 0) {
489 tb
= sa_add_layout_entry(os
, attrs
, count
,
490 avl_numnodes(&sa
->sa_layout_num_tree
), hash
, B_TRUE
, tx
);
492 mutex_exit(&sa
->sa_lock
);
497 sa_resize_spill(sa_handle_t
*hdl
, uint32_t size
, dmu_tx_t
*tx
)
503 blocksize
= SPA_MINBLOCKSIZE
;
504 } else if (size
> SPA_MAXBLOCKSIZE
) {
508 blocksize
= P2ROUNDUP_TYPED(size
, SPA_MINBLOCKSIZE
, uint32_t);
511 error
= dbuf_spill_set_blksz(hdl
->sa_spill
, blocksize
, tx
);
517 sa_copy_data(sa_data_locator_t
*func
, void *datastart
, void *target
, int buflen
)
520 bcopy(datastart
, target
, buflen
);
525 void *saptr
= target
;
530 while (bytes
< buflen
) {
531 func(&dataptr
, &length
, buflen
, start
, datastart
);
532 bcopy(dataptr
, saptr
, length
);
533 saptr
= (void *)((caddr_t
)saptr
+ length
);
541 * Determine several different sizes
542 * first the sa header size
543 * the number of bytes to be stored
544 * if spill would occur the index in the attribute array is returned
546 * the boolean will_spill will be set when spilling is necessary. It
547 * is only set when the buftype is SA_BONUS
550 sa_find_sizes(sa_os_t
*sa
, sa_bulk_attr_t
*attr_desc
, int attr_count
,
551 dmu_buf_t
*db
, sa_buf_type_t buftype
, int *index
, int *total
,
552 boolean_t
*will_spill
)
558 boolean_t done
= B_FALSE
;
560 if (buftype
== SA_BONUS
&& sa
->sa_force_spill
) {
563 *will_spill
= B_TRUE
;
570 if (buftype
== SA_BONUS
)
571 *will_spill
= B_FALSE
;
573 hdrsize
= (SA_BONUSTYPE_FROM_DB(db
) == DMU_OT_ZNODE
) ? 0 :
574 sizeof (sa_hdr_phys_t
);
576 full_space
= (buftype
== SA_BONUS
) ? DN_MAX_BONUSLEN
: db
->db_size
;
578 for (i
= 0; i
!= attr_count
; i
++) {
581 *total
+= attr_desc
[i
].sa_length
;
585 is_var_sz
= (SA_REGISTERED_LEN(sa
, attr_desc
[i
].sa_attr
) == 0);
590 if (is_var_sz
&& var_size
> 1) {
591 if (P2ROUNDUP(hdrsize
+ sizeof (uint16_t), 8) +
592 *total
< full_space
) {
593 hdrsize
+= sizeof (uint16_t);
597 if (buftype
== SA_BONUS
)
598 *will_spill
= B_TRUE
;
604 * find index of where spill *could* occur.
605 * Then continue to count of remainder attribute
606 * space. The sum is used later for sizing bonus
609 if (buftype
== SA_BONUS
&& *index
== -1 &&
610 P2ROUNDUP(*total
+ hdrsize
, 8) >
611 (full_space
- sizeof (blkptr_t
))) {
617 if (P2ROUNDUP(*total
+ hdrsize
, 8) > full_space
&&
619 *will_spill
= B_TRUE
;
622 hdrsize
= P2ROUNDUP(hdrsize
, 8);
626 #define BUF_SPACE_NEEDED(total, header) (total + header)
629 * Find layout that corresponds to ordering of attributes
630 * If not found a new layout number is created and added to
631 * persistent layout tables.
634 sa_build_layouts(sa_handle_t
*hdl
, sa_bulk_attr_t
*attr_desc
, int attr_count
,
637 sa_os_t
*sa
= hdl
->sa_os
->os_sa
;
639 sa_buf_type_t buftype
;
640 sa_hdr_phys_t
*sahdr
;
643 sa_attr_type_t
*attrs
, *attrs_start
;
645 int hdrsize
, spillhdrsize
= 0;
647 dmu_object_type_t bonustype
;
653 dmu_buf_will_dirty(hdl
->sa_bonus
, tx
);
654 bonustype
= SA_BONUSTYPE_FROM_DB(hdl
->sa_bonus
);
656 /* first determine bonus header size and sum of all attributes */
657 hdrsize
= sa_find_sizes(sa
, attr_desc
, attr_count
, hdl
->sa_bonus
,
658 SA_BONUS
, &i
, &used
, &spilling
);
660 if (used
> SPA_MAXBLOCKSIZE
)
663 VERIFY(0 == dmu_set_bonus(hdl
->sa_bonus
, spilling
?
664 MIN(DN_MAX_BONUSLEN
- sizeof (blkptr_t
), used
+ hdrsize
) :
665 used
+ hdrsize
, tx
));
667 ASSERT((bonustype
== DMU_OT_ZNODE
&& spilling
== 0) ||
668 bonustype
== DMU_OT_SA
);
670 /* setup and size spill buffer when needed */
674 if (hdl
->sa_spill
== NULL
) {
675 VERIFY(dmu_spill_hold_by_bonus(hdl
->sa_bonus
, NULL
,
676 &hdl
->sa_spill
) == 0);
678 dmu_buf_will_dirty(hdl
->sa_spill
, tx
);
680 spillhdrsize
= sa_find_sizes(sa
, &attr_desc
[i
],
681 attr_count
- i
, hdl
->sa_spill
, SA_SPILL
, &i
,
682 &spill_used
, &dummy
);
684 if (spill_used
> SPA_MAXBLOCKSIZE
)
687 buf_space
= hdl
->sa_spill
->db_size
- spillhdrsize
;
688 if (BUF_SPACE_NEEDED(spill_used
, spillhdrsize
) >
689 hdl
->sa_spill
->db_size
)
690 VERIFY(0 == sa_resize_spill(hdl
,
691 BUF_SPACE_NEEDED(spill_used
, spillhdrsize
), tx
));
694 /* setup starting pointers to lay down data */
695 data_start
= (void *)((uintptr_t)hdl
->sa_bonus
->db_data
+ hdrsize
);
696 sahdr
= (sa_hdr_phys_t
*)hdl
->sa_bonus
->db_data
;
700 buf_space
= (sa
->sa_force_spill
) ?
701 0 : SA_BLKPTR_SPACE
- hdrsize
;
703 buf_space
= hdl
->sa_bonus
->db_size
- hdrsize
;
705 attrs_start
= attrs
= kmem_alloc(sizeof (sa_attr_type_t
) * attr_count
,
709 for (i
= 0, len_idx
= 0, hash
= -1ULL; i
!= attr_count
; i
++) {
712 attrs
[i
] = attr_desc
[i
].sa_attr
;
713 length
= SA_REGISTERED_LEN(sa
, attrs
[i
]);
715 length
= attr_desc
[i
].sa_length
;
717 if (buf_space
< length
) { /* switch to spill buffer */
718 VERIFY(bonustype
== DMU_OT_SA
);
719 if (buftype
== SA_BONUS
&& !sa
->sa_force_spill
) {
720 sa_find_layout(hdl
->sa_os
, hash
, attrs_start
,
721 lot_count
, tx
, &lot
);
722 SA_SET_HDR(sahdr
, lot
->lot_num
, hdrsize
);
729 sahdr
= (sa_hdr_phys_t
*)hdl
->sa_spill
->db_data
;
730 sahdr
->sa_magic
= SA_MAGIC
;
731 data_start
= (void *)((uintptr_t)sahdr
+
733 attrs_start
= &attrs
[i
];
734 buf_space
= hdl
->sa_spill
->db_size
- spillhdrsize
;
737 hash
^= SA_ATTR_HASH(attrs
[i
]);
738 attr_desc
[i
].sa_addr
= data_start
;
739 attr_desc
[i
].sa_size
= length
;
740 SA_COPY_DATA(attr_desc
[i
].sa_data_func
, attr_desc
[i
].sa_data
,
742 if (sa
->sa_attr_table
[attrs
[i
]].sa_length
== 0) {
743 sahdr
->sa_lengths
[len_idx
++] = length
;
745 data_start
= (void *)P2ROUNDUP(((uintptr_t)data_start
+
747 buf_space
-= P2ROUNDUP(length
, 8);
751 sa_find_layout(hdl
->sa_os
, hash
, attrs_start
, lot_count
, tx
, &lot
);
754 * Verify that old znodes always have layout number 0.
755 * Must be DMU_OT_SA for arbitrary layouts
757 VERIFY((bonustype
== DMU_OT_ZNODE
&& lot
->lot_num
== 0) ||
758 (bonustype
== DMU_OT_SA
&& lot
->lot_num
> 1));
760 if (bonustype
== DMU_OT_SA
) {
761 SA_SET_HDR(sahdr
, lot
->lot_num
,
762 buftype
== SA_BONUS
? hdrsize
: spillhdrsize
);
765 kmem_free(attrs
, sizeof (sa_attr_type_t
) * attr_count
);
766 if (hdl
->sa_bonus_tab
) {
767 sa_idx_tab_rele(hdl
->sa_os
, hdl
->sa_bonus_tab
);
768 hdl
->sa_bonus_tab
= NULL
;
770 if (!sa
->sa_force_spill
)
771 VERIFY(0 == sa_build_index(hdl
, SA_BONUS
));
773 sa_idx_tab_rele(hdl
->sa_os
, hdl
->sa_spill_tab
);
776 * remove spill block that is no longer needed.
778 dmu_buf_rele(hdl
->sa_spill
, NULL
);
779 hdl
->sa_spill
= NULL
;
780 hdl
->sa_spill_tab
= NULL
;
781 VERIFY(0 == dmu_rm_spill(hdl
->sa_os
,
782 sa_handle_object(hdl
), tx
));
784 VERIFY(0 == sa_build_index(hdl
, SA_SPILL
));
792 sa_free_attr_table(sa_os_t
*sa
)
796 if (sa
->sa_attr_table
== NULL
)
799 for (i
= 0; i
!= sa
->sa_num_attrs
; i
++) {
800 if (sa
->sa_attr_table
[i
].sa_name
)
801 kmem_free(sa
->sa_attr_table
[i
].sa_name
,
802 strlen(sa
->sa_attr_table
[i
].sa_name
) + 1);
805 kmem_free(sa
->sa_attr_table
,
806 sizeof (sa_attr_table_t
) * sa
->sa_num_attrs
);
808 sa
->sa_attr_table
= NULL
;
812 sa_attr_table_setup(objset_t
*os
, sa_attr_reg_t
*reg_attrs
, int count
)
814 sa_os_t
*sa
= os
->os_sa
;
815 uint64_t sa_attr_count
= 0;
816 uint64_t sa_reg_count
= 0;
822 int registered_count
= 0;
824 dmu_objset_type_t ostype
= dmu_objset_type(os
);
827 kmem_zalloc(count
* sizeof (sa_attr_type_t
), KM_SLEEP
);
828 sa
->sa_user_table_sz
= count
* sizeof (sa_attr_type_t
);
830 if (sa
->sa_reg_attr_obj
!= 0) {
831 error
= zap_count(os
, sa
->sa_reg_attr_obj
,
835 * Make sure we retrieved a count and that it isn't zero
837 if (error
|| (error
== 0 && sa_attr_count
== 0)) {
842 sa_reg_count
= sa_attr_count
;
845 if (ostype
== DMU_OST_ZFS
&& sa_attr_count
== 0)
846 sa_attr_count
+= sa_legacy_attr_count
;
848 /* Allocate attribute numbers for attributes that aren't registered */
849 for (i
= 0; i
!= count
; i
++) {
850 boolean_t found
= B_FALSE
;
853 if (ostype
== DMU_OST_ZFS
) {
854 for (j
= 0; j
!= sa_legacy_attr_count
; j
++) {
855 if (strcmp(reg_attrs
[i
].sa_name
,
856 sa_legacy_attrs
[j
].sa_name
) == 0) {
857 sa
->sa_user_table
[i
] =
858 sa_legacy_attrs
[j
].sa_attr
;
866 if (sa
->sa_reg_attr_obj
)
867 error
= zap_lookup(os
, sa
->sa_reg_attr_obj
,
868 reg_attrs
[i
].sa_name
, 8, 1, &attr_value
);
873 sa
->sa_user_table
[i
] = (sa_attr_type_t
)sa_attr_count
;
877 sa
->sa_user_table
[i
] = ATTR_NUM(attr_value
);
884 sa
->sa_num_attrs
= sa_attr_count
;
885 tb
= sa
->sa_attr_table
=
886 kmem_zalloc(sizeof (sa_attr_table_t
) * sa_attr_count
, KM_SLEEP
);
889 * Attribute table is constructed from requested attribute list,
890 * previously foreign registered attributes, and also the legacy
891 * ZPL set of attributes.
894 if (sa
->sa_reg_attr_obj
) {
895 for (zap_cursor_init(&zc
, os
, sa
->sa_reg_attr_obj
);
896 (error
= zap_cursor_retrieve(&zc
, &za
)) == 0;
897 zap_cursor_advance(&zc
)) {
899 value
= za
.za_first_integer
;
902 tb
[ATTR_NUM(value
)].sa_attr
= ATTR_NUM(value
);
903 tb
[ATTR_NUM(value
)].sa_length
= ATTR_LENGTH(value
);
904 tb
[ATTR_NUM(value
)].sa_byteswap
= ATTR_BSWAP(value
);
905 tb
[ATTR_NUM(value
)].sa_registered
= B_TRUE
;
907 if (tb
[ATTR_NUM(value
)].sa_name
) {
910 tb
[ATTR_NUM(value
)].sa_name
=
911 kmem_zalloc(strlen(za
.za_name
) +1, KM_SLEEP
);
912 (void) strlcpy(tb
[ATTR_NUM(value
)].sa_name
, za
.za_name
,
913 strlen(za
.za_name
) +1);
915 zap_cursor_fini(&zc
);
917 * Make sure we processed the correct number of registered
920 if (registered_count
!= sa_reg_count
) {
927 if (ostype
== DMU_OST_ZFS
) {
928 for (i
= 0; i
!= sa_legacy_attr_count
; i
++) {
931 tb
[i
].sa_attr
= sa_legacy_attrs
[i
].sa_attr
;
932 tb
[i
].sa_length
= sa_legacy_attrs
[i
].sa_length
;
933 tb
[i
].sa_byteswap
= sa_legacy_attrs
[i
].sa_byteswap
;
934 tb
[i
].sa_registered
= B_FALSE
;
936 kmem_zalloc(strlen(sa_legacy_attrs
[i
].sa_name
) +1,
938 (void) strlcpy(tb
[i
].sa_name
,
939 sa_legacy_attrs
[i
].sa_name
,
940 strlen(sa_legacy_attrs
[i
].sa_name
) + 1);
944 for (i
= 0; i
!= count
; i
++) {
945 sa_attr_type_t attr_id
;
947 attr_id
= sa
->sa_user_table
[i
];
948 if (tb
[attr_id
].sa_name
)
951 tb
[attr_id
].sa_length
= reg_attrs
[i
].sa_length
;
952 tb
[attr_id
].sa_byteswap
= reg_attrs
[i
].sa_byteswap
;
953 tb
[attr_id
].sa_attr
= attr_id
;
954 tb
[attr_id
].sa_name
=
955 kmem_zalloc(strlen(reg_attrs
[i
].sa_name
) + 1, KM_SLEEP
);
956 (void) strlcpy(tb
[attr_id
].sa_name
, reg_attrs
[i
].sa_name
,
957 strlen(reg_attrs
[i
].sa_name
) + 1);
960 sa
->sa_need_attr_registration
=
961 (sa_attr_count
!= registered_count
);
965 kmem_free(sa
->sa_user_table
, count
* sizeof (sa_attr_type_t
));
966 sa
->sa_user_table
= NULL
;
967 sa_free_attr_table(sa
);
968 return ((error
!= 0) ? error
: EINVAL
);
972 sa_setup(objset_t
*os
, uint64_t sa_obj
, sa_attr_reg_t
*reg_attrs
, int count
,
973 sa_attr_type_t
**user_table
)
978 dmu_objset_type_t ostype
= dmu_objset_type(os
);
982 mutex_enter(&os
->os_lock
);
984 mutex_enter(&os
->os_sa
->sa_lock
);
985 mutex_exit(&os
->os_lock
);
986 tb
= os
->os_sa
->sa_user_table
;
987 mutex_exit(&os
->os_sa
->sa_lock
);
992 sa
= kmem_zalloc(sizeof (sa_os_t
), KM_SLEEP
);
993 mutex_init(&sa
->sa_lock
, NULL
, MUTEX_DEFAULT
, NULL
);
994 sa
->sa_master_obj
= sa_obj
;
997 mutex_enter(&sa
->sa_lock
);
998 mutex_exit(&os
->os_lock
);
999 avl_create(&sa
->sa_layout_num_tree
, layout_num_compare
,
1000 sizeof (sa_lot_t
), offsetof(sa_lot_t
, lot_num_node
));
1001 avl_create(&sa
->sa_layout_hash_tree
, layout_hash_compare
,
1002 sizeof (sa_lot_t
), offsetof(sa_lot_t
, lot_hash_node
));
1005 error
= zap_lookup(os
, sa_obj
, SA_LAYOUTS
,
1006 8, 1, &sa
->sa_layout_attr_obj
);
1007 if (error
!= 0 && error
!= ENOENT
)
1009 error
= zap_lookup(os
, sa_obj
, SA_REGISTRY
,
1010 8, 1, &sa
->sa_reg_attr_obj
);
1011 if (error
!= 0 && error
!= ENOENT
)
1015 if ((error
= sa_attr_table_setup(os
, reg_attrs
, count
)) != 0)
1018 if (sa
->sa_layout_attr_obj
!= 0) {
1019 uint64_t layout_count
;
1021 error
= zap_count(os
, sa
->sa_layout_attr_obj
,
1025 * Layout number count should be > 0
1027 if (error
|| (error
== 0 && layout_count
== 0)) {
1033 for (zap_cursor_init(&zc
, os
, sa
->sa_layout_attr_obj
);
1034 (error
= zap_cursor_retrieve(&zc
, &za
)) == 0;
1035 zap_cursor_advance(&zc
)) {
1036 sa_attr_type_t
*lot_attrs
;
1039 lot_attrs
= kmem_zalloc(sizeof (sa_attr_type_t
) *
1040 za
.za_num_integers
, KM_SLEEP
);
1042 if ((error
= (zap_lookup(os
, sa
->sa_layout_attr_obj
,
1043 za
.za_name
, 2, za
.za_num_integers
,
1044 lot_attrs
))) != 0) {
1045 kmem_free(lot_attrs
, sizeof (sa_attr_type_t
) *
1046 za
.za_num_integers
);
1049 VERIFY(ddi_strtoull(za
.za_name
, NULL
, 10,
1050 (unsigned long long *)&lot_num
) == 0);
1052 (void) sa_add_layout_entry(os
, lot_attrs
,
1053 za
.za_num_integers
, lot_num
,
1054 sa_layout_info_hash(lot_attrs
,
1055 za
.za_num_integers
), B_FALSE
, NULL
);
1056 kmem_free(lot_attrs
, sizeof (sa_attr_type_t
) *
1057 za
.za_num_integers
);
1059 zap_cursor_fini(&zc
);
1062 * Make sure layout count matches number of entries added
1065 if (avl_numnodes(&sa
->sa_layout_num_tree
) != layout_count
) {
1071 /* Add special layout number for old ZNODES */
1072 if (ostype
== DMU_OST_ZFS
) {
1073 (void) sa_add_layout_entry(os
, sa_legacy_zpl_layout
,
1074 sa_legacy_attr_count
, 0,
1075 sa_layout_info_hash(sa_legacy_zpl_layout
,
1076 sa_legacy_attr_count
), B_FALSE
, NULL
);
1078 (void) sa_add_layout_entry(os
, sa_dummy_zpl_layout
, 0, 1,
1081 *user_table
= os
->os_sa
->sa_user_table
;
1082 mutex_exit(&sa
->sa_lock
);
1086 sa_free_attr_table(sa
);
1087 if (sa
->sa_user_table
)
1088 kmem_free(sa
->sa_user_table
, sa
->sa_user_table_sz
);
1089 mutex_exit(&sa
->sa_lock
);
1090 kmem_free(sa
, sizeof (sa_os_t
));
1091 return ((error
== ECKSUM
) ? EIO
: error
);
1095 sa_tear_down(objset_t
*os
)
1097 sa_os_t
*sa
= os
->os_sa
;
1101 kmem_free(sa
->sa_user_table
, sa
->sa_user_table_sz
);
1103 /* Free up attr table */
1105 sa_free_attr_table(sa
);
1108 while ((layout
= avl_destroy_nodes(&sa
->sa_layout_hash_tree
, &cookie
))){
1110 while ((tab
= list_head(&layout
->lot_idx_tab
))) {
1111 ASSERT(refcount_count(&tab
->sa_refcount
));
1112 sa_idx_tab_rele(os
, tab
);
1117 while ((layout
= avl_destroy_nodes(&sa
->sa_layout_num_tree
, &cookie
))){
1118 kmem_free(layout
->lot_attrs
,
1119 sizeof (sa_attr_type_t
) * layout
->lot_attr_count
);
1120 kmem_free(layout
, sizeof (sa_lot_t
));
1123 avl_destroy(&sa
->sa_layout_hash_tree
);
1124 avl_destroy(&sa
->sa_layout_num_tree
);
1126 kmem_free(sa
, sizeof (sa_os_t
));
1131 sa_build_idx_tab(void *hdr
, void *attr_addr
, sa_attr_type_t attr
,
1132 uint16_t length
, int length_idx
, boolean_t var_length
, void *userp
)
1134 sa_idx_tab_t
*idx_tab
= userp
;
1137 ASSERT(idx_tab
->sa_variable_lengths
);
1138 idx_tab
->sa_variable_lengths
[length_idx
] = length
;
1140 TOC_ATTR_ENCODE(idx_tab
->sa_idx_tab
[attr
], length_idx
,
1141 (uint32_t)((uintptr_t)attr_addr
- (uintptr_t)hdr
));
1145 sa_attr_iter(objset_t
*os
, sa_hdr_phys_t
*hdr
, dmu_object_type_t type
,
1146 sa_iterfunc_t func
, sa_lot_t
*tab
, void *userp
)
1152 sa_os_t
*sa
= os
->os_sa
;
1154 uint16_t *length_start
= NULL
;
1155 uint8_t length_idx
= 0;
1158 search
.lot_num
= SA_LAYOUT_NUM(hdr
, type
);
1159 tb
= avl_find(&sa
->sa_layout_num_tree
, &search
, &loc
);
1163 if (IS_SA_BONUSTYPE(type
)) {
1164 data_start
= (void *)P2ROUNDUP(((uintptr_t)hdr
+
1165 offsetof(sa_hdr_phys_t
, sa_lengths
) +
1166 (sizeof (uint16_t) * tb
->lot_var_sizes
)), 8);
1167 length_start
= hdr
->sa_lengths
;
1172 for (i
= 0; i
!= tb
->lot_attr_count
; i
++) {
1173 int attr_length
, reg_length
;
1176 reg_length
= sa
->sa_attr_table
[tb
->lot_attrs
[i
]].sa_length
;
1178 attr_length
= reg_length
;
1181 attr_length
= length_start
[length_idx
];
1182 idx_len
= length_idx
++;
1185 func(hdr
, data_start
, tb
->lot_attrs
[i
], attr_length
,
1186 idx_len
, reg_length
== 0 ? B_TRUE
: B_FALSE
, userp
);
1188 data_start
= (void *)P2ROUNDUP(((uintptr_t)data_start
+
1195 sa_byteswap_cb(void *hdr
, void *attr_addr
, sa_attr_type_t attr
,
1196 uint16_t length
, int length_idx
, boolean_t variable_length
, void *userp
)
1198 sa_handle_t
*hdl
= userp
;
1199 sa_os_t
*sa
= hdl
->sa_os
->os_sa
;
1201 sa_bswap_table
[sa
->sa_attr_table
[attr
].sa_byteswap
](attr_addr
, length
);
1205 sa_byteswap(sa_handle_t
*hdl
, sa_buf_type_t buftype
)
1207 sa_hdr_phys_t
*sa_hdr_phys
= SA_GET_HDR(hdl
, buftype
);
1209 int num_lengths
= 1;
1211 ASSERTV(sa_os_t
*sa
= hdl
->sa_os
->os_sa
);
1213 ASSERT(MUTEX_HELD(&sa
->sa_lock
));
1214 if (sa_hdr_phys
->sa_magic
== SA_MAGIC
)
1217 db
= SA_GET_DB(hdl
, buftype
);
1219 if (buftype
== SA_SPILL
) {
1220 arc_release(db
->db_buf
, NULL
);
1221 arc_buf_thaw(db
->db_buf
);
1224 sa_hdr_phys
->sa_magic
= BSWAP_32(sa_hdr_phys
->sa_magic
);
1225 sa_hdr_phys
->sa_layout_info
= BSWAP_16(sa_hdr_phys
->sa_layout_info
);
1228 * Determine number of variable lenghts in header
1229 * The standard 8 byte header has one for free and a
1230 * 16 byte header would have 4 + 1;
1232 if (SA_HDR_SIZE(sa_hdr_phys
) > 8)
1233 num_lengths
+= (SA_HDR_SIZE(sa_hdr_phys
) - 8) >> 1;
1234 for (i
= 0; i
!= num_lengths
; i
++)
1235 sa_hdr_phys
->sa_lengths
[i
] =
1236 BSWAP_16(sa_hdr_phys
->sa_lengths
[i
]);
1238 sa_attr_iter(hdl
->sa_os
, sa_hdr_phys
, DMU_OT_SA
,
1239 sa_byteswap_cb
, NULL
, hdl
);
1241 if (buftype
== SA_SPILL
)
1242 arc_buf_freeze(((dmu_buf_impl_t
*)hdl
->sa_spill
)->db_buf
);
1246 sa_build_index(sa_handle_t
*hdl
, sa_buf_type_t buftype
)
1248 sa_hdr_phys_t
*sa_hdr_phys
;
1249 dmu_buf_impl_t
*db
= SA_GET_DB(hdl
, buftype
);
1250 dmu_object_type_t bonustype
= SA_BONUSTYPE_FROM_DB(db
);
1251 sa_os_t
*sa
= hdl
->sa_os
->os_sa
;
1252 sa_idx_tab_t
*idx_tab
;
1254 sa_hdr_phys
= SA_GET_HDR(hdl
, buftype
);
1256 mutex_enter(&sa
->sa_lock
);
1258 /* Do we need to byteswap? */
1260 /* only check if not old znode */
1261 if (IS_SA_BONUSTYPE(bonustype
) && sa_hdr_phys
->sa_magic
!= SA_MAGIC
&&
1262 sa_hdr_phys
->sa_magic
!= 0) {
1263 VERIFY(BSWAP_32(sa_hdr_phys
->sa_magic
) == SA_MAGIC
);
1264 sa_byteswap(hdl
, buftype
);
1267 idx_tab
= sa_find_idx_tab(hdl
->sa_os
, bonustype
, sa_hdr_phys
);
1269 if (buftype
== SA_BONUS
)
1270 hdl
->sa_bonus_tab
= idx_tab
;
1272 hdl
->sa_spill_tab
= idx_tab
;
1274 mutex_exit(&sa
->sa_lock
);
1280 sa_evict(dmu_buf_t
*db
, void *sap
)
1282 panic("evicting sa dbuf %p\n", (void *)db
);
1286 sa_idx_tab_rele(objset_t
*os
, void *arg
)
1288 sa_os_t
*sa
= os
->os_sa
;
1289 sa_idx_tab_t
*idx_tab
= arg
;
1291 if (idx_tab
== NULL
)
1294 mutex_enter(&sa
->sa_lock
);
1295 if (refcount_remove(&idx_tab
->sa_refcount
, NULL
) == 0) {
1296 list_remove(&idx_tab
->sa_layout
->lot_idx_tab
, idx_tab
);
1297 if (idx_tab
->sa_variable_lengths
)
1298 kmem_free(idx_tab
->sa_variable_lengths
,
1300 idx_tab
->sa_layout
->lot_var_sizes
);
1301 refcount_destroy(&idx_tab
->sa_refcount
);
1302 kmem_free(idx_tab
->sa_idx_tab
,
1303 sizeof (uint32_t) * sa
->sa_num_attrs
);
1304 kmem_free(idx_tab
, sizeof (sa_idx_tab_t
));
1306 mutex_exit(&sa
->sa_lock
);
1310 sa_idx_tab_hold(objset_t
*os
, sa_idx_tab_t
*idx_tab
)
1312 ASSERTV(sa_os_t
*sa
= os
->os_sa
);
1314 ASSERT(MUTEX_HELD(&sa
->sa_lock
));
1315 (void) refcount_add(&idx_tab
->sa_refcount
, NULL
);
1319 sa_handle_destroy(sa_handle_t
*hdl
)
1321 mutex_enter(&hdl
->sa_lock
);
1322 (void) dmu_buf_update_user((dmu_buf_t
*)hdl
->sa_bonus
, hdl
,
1325 if (hdl
->sa_bonus_tab
) {
1326 sa_idx_tab_rele(hdl
->sa_os
, hdl
->sa_bonus_tab
);
1327 hdl
->sa_bonus_tab
= NULL
;
1329 if (hdl
->sa_spill_tab
) {
1330 sa_idx_tab_rele(hdl
->sa_os
, hdl
->sa_spill_tab
);
1331 hdl
->sa_spill_tab
= NULL
;
1334 dmu_buf_rele(hdl
->sa_bonus
, NULL
);
1337 dmu_buf_rele((dmu_buf_t
*)hdl
->sa_spill
, NULL
);
1338 mutex_exit(&hdl
->sa_lock
);
1340 kmem_cache_free(sa_cache
, hdl
);
1344 sa_handle_get_from_db(objset_t
*os
, dmu_buf_t
*db
, void *userp
,
1345 sa_handle_type_t hdl_type
, sa_handle_t
**handlepp
)
1348 sa_handle_t
*handle
;
1350 dmu_object_info_t doi
;
1352 dmu_object_info_from_db(db
, &doi
);
1353 ASSERT(doi
.doi_bonus_type
== DMU_OT_SA
||
1354 doi
.doi_bonus_type
== DMU_OT_ZNODE
);
1356 /* find handle, if it exists */
1357 /* if one doesn't exist then create a new one, and initialize it */
1359 handle
= (hdl_type
== SA_HDL_SHARED
) ? dmu_buf_get_user(db
) : NULL
;
1360 if (handle
== NULL
) {
1361 sa_handle_t
*newhandle
;
1362 handle
= kmem_cache_alloc(sa_cache
, KM_SLEEP
);
1363 handle
->sa_userp
= userp
;
1364 handle
->sa_bonus
= db
;
1366 handle
->sa_spill
= NULL
;
1368 error
= sa_build_index(handle
, SA_BONUS
);
1369 newhandle
= (hdl_type
== SA_HDL_SHARED
) ?
1370 dmu_buf_set_user_ie(db
, handle
,
1371 NULL
, sa_evict
) : NULL
;
1373 if (newhandle
!= NULL
) {
1374 kmem_cache_free(sa_cache
, handle
);
1384 sa_handle_get(objset_t
*objset
, uint64_t objid
, void *userp
,
1385 sa_handle_type_t hdl_type
, sa_handle_t
**handlepp
)
1390 if ((error
= dmu_bonus_hold(objset
, objid
, NULL
, &db
)))
1393 return (sa_handle_get_from_db(objset
, db
, userp
, hdl_type
,
1398 sa_buf_hold(objset_t
*objset
, uint64_t obj_num
, void *tag
, dmu_buf_t
**db
)
1400 return (dmu_bonus_hold(objset
, obj_num
, tag
, db
));
1404 sa_buf_rele(dmu_buf_t
*db
, void *tag
)
1406 dmu_buf_rele(db
, tag
);
1410 sa_lookup_impl(sa_handle_t
*hdl
, sa_bulk_attr_t
*bulk
, int count
)
1413 ASSERT(MUTEX_HELD(&hdl
->sa_lock
));
1414 return (sa_attr_op(hdl
, bulk
, count
, SA_LOOKUP
, NULL
));
1418 sa_lookup(sa_handle_t
*hdl
, sa_attr_type_t attr
, void *buf
, uint32_t buflen
)
1421 sa_bulk_attr_t bulk
;
1423 bulk
.sa_attr
= attr
;
1425 bulk
.sa_length
= buflen
;
1426 bulk
.sa_data_func
= NULL
;
1429 mutex_enter(&hdl
->sa_lock
);
1430 error
= sa_lookup_impl(hdl
, &bulk
, 1);
1431 mutex_exit(&hdl
->sa_lock
);
1437 sa_lookup_uio(sa_handle_t
*hdl
, sa_attr_type_t attr
, uio_t
*uio
)
1440 sa_bulk_attr_t bulk
;
1442 bulk
.sa_data
= NULL
;
1443 bulk
.sa_attr
= attr
;
1444 bulk
.sa_data_func
= NULL
;
1448 mutex_enter(&hdl
->sa_lock
);
1449 if ((error
= sa_attr_op(hdl
, &bulk
, 1, SA_LOOKUP
, NULL
)) == 0) {
1450 error
= uiomove((void *)bulk
.sa_addr
, MIN(bulk
.sa_size
,
1451 uio
->uio_resid
), UIO_READ
, uio
);
1453 mutex_exit(&hdl
->sa_lock
);
1459 sa_find_idx_tab(objset_t
*os
, dmu_object_type_t bonustype
, void *data
)
1461 sa_idx_tab_t
*idx_tab
;
1462 sa_hdr_phys_t
*hdr
= (sa_hdr_phys_t
*)data
;
1463 sa_os_t
*sa
= os
->os_sa
;
1464 sa_lot_t
*tb
, search
;
1468 * Deterimine layout number. If SA node and header == 0 then
1469 * force the index table to the dummy "1" empty layout.
1471 * The layout number would only be zero for a newly created file
1472 * that has not added any attributes yet, or with crypto enabled which
1473 * doesn't write any attributes to the bonus buffer.
1476 search
.lot_num
= SA_LAYOUT_NUM(hdr
, bonustype
);
1478 tb
= avl_find(&sa
->sa_layout_num_tree
, &search
, &loc
);
1480 /* Verify header size is consistent with layout information */
1482 ASSERT((IS_SA_BONUSTYPE(bonustype
) &&
1483 SA_HDR_SIZE_MATCH_LAYOUT(hdr
, tb
)) || !IS_SA_BONUSTYPE(bonustype
) ||
1484 (IS_SA_BONUSTYPE(bonustype
) && hdr
->sa_layout_info
== 0));
1487 * See if any of the already existing TOC entries can be reused?
1490 for (idx_tab
= list_head(&tb
->lot_idx_tab
); idx_tab
;
1491 idx_tab
= list_next(&tb
->lot_idx_tab
, idx_tab
)) {
1492 boolean_t valid_idx
= B_TRUE
;
1495 if (tb
->lot_var_sizes
!= 0 &&
1496 idx_tab
->sa_variable_lengths
!= NULL
) {
1497 for (i
= 0; i
!= tb
->lot_var_sizes
; i
++) {
1498 if (hdr
->sa_lengths
[i
] !=
1499 idx_tab
->sa_variable_lengths
[i
]) {
1500 valid_idx
= B_FALSE
;
1506 sa_idx_tab_hold(os
, idx_tab
);
1511 /* No such luck, create a new entry */
1512 idx_tab
= kmem_zalloc(sizeof (sa_idx_tab_t
), KM_SLEEP
);
1513 idx_tab
->sa_idx_tab
=
1514 kmem_zalloc(sizeof (uint32_t) * sa
->sa_num_attrs
, KM_SLEEP
);
1515 idx_tab
->sa_layout
= tb
;
1516 refcount_create(&idx_tab
->sa_refcount
);
1517 if (tb
->lot_var_sizes
)
1518 idx_tab
->sa_variable_lengths
= kmem_alloc(sizeof (uint16_t) *
1519 tb
->lot_var_sizes
, KM_SLEEP
);
1521 sa_attr_iter(os
, hdr
, bonustype
, sa_build_idx_tab
,
1523 sa_idx_tab_hold(os
, idx_tab
); /* one hold for consumer */
1524 sa_idx_tab_hold(os
, idx_tab
); /* one for layout */
1525 list_insert_tail(&tb
->lot_idx_tab
, idx_tab
);
1530 sa_default_locator(void **dataptr
, uint32_t *len
, uint32_t total_len
,
1531 boolean_t start
, void *userdata
)
1535 *dataptr
= userdata
;
1540 sa_attr_register_sync(sa_handle_t
*hdl
, dmu_tx_t
*tx
)
1542 uint64_t attr_value
= 0;
1543 sa_os_t
*sa
= hdl
->sa_os
->os_sa
;
1544 sa_attr_table_t
*tb
= sa
->sa_attr_table
;
1547 mutex_enter(&sa
->sa_lock
);
1549 if (!sa
->sa_need_attr_registration
|| sa
->sa_master_obj
== 0) {
1550 mutex_exit(&sa
->sa_lock
);
1554 if (sa
->sa_reg_attr_obj
== 0) {
1555 sa
->sa_reg_attr_obj
= zap_create(hdl
->sa_os
,
1556 DMU_OT_SA_ATTR_REGISTRATION
, DMU_OT_NONE
, 0, tx
);
1557 VERIFY(zap_add(hdl
->sa_os
, sa
->sa_master_obj
,
1558 SA_REGISTRY
, 8, 1, &sa
->sa_reg_attr_obj
, tx
) == 0);
1560 for (i
= 0; i
!= sa
->sa_num_attrs
; i
++) {
1561 if (sa
->sa_attr_table
[i
].sa_registered
)
1563 ATTR_ENCODE(attr_value
, tb
[i
].sa_attr
, tb
[i
].sa_length
,
1565 VERIFY(0 == zap_update(hdl
->sa_os
, sa
->sa_reg_attr_obj
,
1566 tb
[i
].sa_name
, 8, 1, &attr_value
, tx
));
1567 tb
[i
].sa_registered
= B_TRUE
;
1569 sa
->sa_need_attr_registration
= B_FALSE
;
1570 mutex_exit(&sa
->sa_lock
);
1574 * Replace all attributes with attributes specified in template.
1575 * If dnode had a spill buffer then those attributes will be
1576 * also be replaced, possibly with just an empty spill block
1578 * This interface is intended to only be used for bulk adding of
1579 * attributes for a new file. It will also be used by the ZPL
1580 * when converting and old formatted znode to native SA support.
1583 sa_replace_all_by_template_locked(sa_handle_t
*hdl
, sa_bulk_attr_t
*attr_desc
,
1584 int attr_count
, dmu_tx_t
*tx
)
1586 sa_os_t
*sa
= hdl
->sa_os
->os_sa
;
1588 if (sa
->sa_need_attr_registration
)
1589 sa_attr_register_sync(hdl
, tx
);
1590 return (sa_build_layouts(hdl
, attr_desc
, attr_count
, tx
));
1594 sa_replace_all_by_template(sa_handle_t
*hdl
, sa_bulk_attr_t
*attr_desc
,
1595 int attr_count
, dmu_tx_t
*tx
)
1599 mutex_enter(&hdl
->sa_lock
);
1600 error
= sa_replace_all_by_template_locked(hdl
, attr_desc
,
1602 mutex_exit(&hdl
->sa_lock
);
1607 * add/remove/replace a single attribute and then rewrite the entire set
1611 sa_modify_attrs(sa_handle_t
*hdl
, sa_attr_type_t newattr
,
1612 sa_data_op_t action
, sa_data_locator_t
*locator
, void *datastart
,
1613 uint16_t buflen
, dmu_tx_t
*tx
)
1615 sa_os_t
*sa
= hdl
->sa_os
->os_sa
;
1616 dmu_buf_impl_t
*db
= (dmu_buf_impl_t
*)hdl
->sa_bonus
;
1618 sa_bulk_attr_t
*attr_desc
;
1620 int bonus_attr_count
= 0;
1621 int bonus_data_size
= 0, spill_data_size
= 0;
1622 int spill_attr_count
= 0;
1625 int i
, j
, k
, length_idx
;
1627 sa_idx_tab_t
*idx_tab
;
1631 ASSERT(MUTEX_HELD(&hdl
->sa_lock
));
1633 /* First make of copy of the old data */
1637 if (dn
->dn_bonuslen
!= 0) {
1638 bonus_data_size
= hdl
->sa_bonus
->db_size
;
1639 old_data
[0] = kmem_alloc(bonus_data_size
, KM_SLEEP
);
1640 bcopy(hdl
->sa_bonus
->db_data
, old_data
[0],
1641 hdl
->sa_bonus
->db_size
);
1642 bonus_attr_count
= hdl
->sa_bonus_tab
->sa_layout
->lot_attr_count
;
1648 /* Bring spill buffer online if it isn't currently */
1650 if ((error
= sa_get_spill(hdl
)) == 0) {
1651 spill_data_size
= hdl
->sa_spill
->db_size
;
1652 old_data
[1] = kmem_alloc(spill_data_size
, KM_SLEEP
);
1653 bcopy(hdl
->sa_spill
->db_data
, old_data
[1],
1654 hdl
->sa_spill
->db_size
);
1656 hdl
->sa_spill_tab
->sa_layout
->lot_attr_count
;
1657 } else if (error
&& error
!= ENOENT
) {
1659 kmem_free(old_data
[0], bonus_data_size
);
1665 /* build descriptor of all attributes */
1667 attr_count
= bonus_attr_count
+ spill_attr_count
;
1668 if (action
== SA_ADD
)
1670 else if (action
== SA_REMOVE
)
1673 attr_desc
= kmem_zalloc(sizeof (sa_bulk_attr_t
) * attr_count
, KM_SLEEP
);
1676 * loop through bonus and spill buffer if it exists, and
1677 * build up new attr_descriptor to reset the attributes
1680 count
= bonus_attr_count
;
1681 hdr
= SA_GET_HDR(hdl
, SA_BONUS
);
1682 idx_tab
= SA_IDX_TAB_GET(hdl
, SA_BONUS
);
1683 for (; k
!= 2; k
++) {
1684 /* iterate over each attribute in layout */
1685 for (i
= 0, length_idx
= 0; i
!= count
; i
++) {
1686 sa_attr_type_t attr
;
1688 attr
= idx_tab
->sa_layout
->lot_attrs
[i
];
1689 if (attr
== newattr
) {
1690 if (action
== SA_REMOVE
) {
1694 ASSERT(SA_REGISTERED_LEN(sa
, attr
) == 0);
1695 ASSERT(action
== SA_REPLACE
);
1696 SA_ADD_BULK_ATTR(attr_desc
, j
, attr
,
1697 locator
, datastart
, buflen
);
1699 length
= SA_REGISTERED_LEN(sa
, attr
);
1701 length
= hdr
->sa_lengths
[length_idx
++];
1704 SA_ADD_BULK_ATTR(attr_desc
, j
, attr
,
1706 (TOC_OFF(idx_tab
->sa_idx_tab
[attr
]) +
1707 (uintptr_t)old_data
[k
]), length
);
1710 if (k
== 0 && hdl
->sa_spill
) {
1711 hdr
= SA_GET_HDR(hdl
, SA_SPILL
);
1712 idx_tab
= SA_IDX_TAB_GET(hdl
, SA_SPILL
);
1713 count
= spill_attr_count
;
1718 if (action
== SA_ADD
) {
1719 length
= SA_REGISTERED_LEN(sa
, newattr
);
1723 SA_ADD_BULK_ATTR(attr_desc
, j
, newattr
, locator
,
1727 error
= sa_build_layouts(hdl
, attr_desc
, attr_count
, tx
);
1730 kmem_free(old_data
[0], bonus_data_size
);
1732 kmem_free(old_data
[1], spill_data_size
);
1733 kmem_free(attr_desc
, sizeof (sa_bulk_attr_t
) * attr_count
);
1739 sa_bulk_update_impl(sa_handle_t
*hdl
, sa_bulk_attr_t
*bulk
, int count
,
1743 sa_os_t
*sa
= hdl
->sa_os
->os_sa
;
1744 dmu_object_type_t bonustype
;
1746 bonustype
= SA_BONUSTYPE_FROM_DB(SA_GET_DB(hdl
, SA_BONUS
));
1749 ASSERT(MUTEX_HELD(&hdl
->sa_lock
));
1751 /* sync out registration table if necessary */
1752 if (sa
->sa_need_attr_registration
)
1753 sa_attr_register_sync(hdl
, tx
);
1755 error
= sa_attr_op(hdl
, bulk
, count
, SA_UPDATE
, tx
);
1756 if (error
== 0 && !IS_SA_BONUSTYPE(bonustype
) && sa
->sa_update_cb
)
1757 sa
->sa_update_cb(hdl
, tx
);
1763 * update or add new attribute
1766 sa_update(sa_handle_t
*hdl
, sa_attr_type_t type
,
1767 void *buf
, uint32_t buflen
, dmu_tx_t
*tx
)
1770 sa_bulk_attr_t bulk
;
1772 bulk
.sa_attr
= type
;
1773 bulk
.sa_data_func
= NULL
;
1774 bulk
.sa_length
= buflen
;
1777 mutex_enter(&hdl
->sa_lock
);
1778 error
= sa_bulk_update_impl(hdl
, &bulk
, 1, tx
);
1779 mutex_exit(&hdl
->sa_lock
);
1784 sa_update_from_cb(sa_handle_t
*hdl
, sa_attr_type_t attr
,
1785 uint32_t buflen
, sa_data_locator_t
*locator
, void *userdata
, dmu_tx_t
*tx
)
1788 sa_bulk_attr_t bulk
;
1790 bulk
.sa_attr
= attr
;
1791 bulk
.sa_data
= userdata
;
1792 bulk
.sa_data_func
= locator
;
1793 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 * Return size of an attribute
1806 sa_size(sa_handle_t
*hdl
, sa_attr_type_t attr
, int *size
)
1808 sa_bulk_attr_t bulk
;
1811 bulk
.sa_data
= NULL
;
1812 bulk
.sa_attr
= attr
;
1813 bulk
.sa_data_func
= NULL
;
1816 mutex_enter(&hdl
->sa_lock
);
1817 if ((error
= sa_attr_op(hdl
, &bulk
, 1, SA_LOOKUP
, NULL
)) != 0) {
1818 mutex_exit(&hdl
->sa_lock
);
1821 *size
= bulk
.sa_size
;
1823 mutex_exit(&hdl
->sa_lock
);
1828 sa_bulk_lookup_locked(sa_handle_t
*hdl
, sa_bulk_attr_t
*attrs
, int count
)
1831 ASSERT(MUTEX_HELD(&hdl
->sa_lock
));
1832 return (sa_lookup_impl(hdl
, attrs
, count
));
1836 sa_bulk_lookup(sa_handle_t
*hdl
, sa_bulk_attr_t
*attrs
, int count
)
1841 mutex_enter(&hdl
->sa_lock
);
1842 error
= sa_bulk_lookup_locked(hdl
, attrs
, count
);
1843 mutex_exit(&hdl
->sa_lock
);
1848 sa_bulk_update(sa_handle_t
*hdl
, sa_bulk_attr_t
*attrs
, int count
, dmu_tx_t
*tx
)
1853 mutex_enter(&hdl
->sa_lock
);
1854 error
= sa_bulk_update_impl(hdl
, attrs
, count
, tx
);
1855 mutex_exit(&hdl
->sa_lock
);
1860 sa_remove(sa_handle_t
*hdl
, sa_attr_type_t attr
, dmu_tx_t
*tx
)
1864 mutex_enter(&hdl
->sa_lock
);
1865 error
= sa_modify_attrs(hdl
, attr
, SA_REMOVE
, NULL
,
1867 mutex_exit(&hdl
->sa_lock
);
1872 sa_object_info(sa_handle_t
*hdl
, dmu_object_info_t
*doi
)
1874 dmu_object_info_from_db((dmu_buf_t
*)hdl
->sa_bonus
, doi
);
1878 sa_object_size(sa_handle_t
*hdl
, uint32_t *blksize
, u_longlong_t
*nblocks
)
1880 dmu_object_size_from_db((dmu_buf_t
*)hdl
->sa_bonus
,
1885 sa_update_user(sa_handle_t
*newhdl
, sa_handle_t
*oldhdl
)
1887 (void) dmu_buf_update_user((dmu_buf_t
*)newhdl
->sa_bonus
,
1888 oldhdl
, newhdl
, NULL
, sa_evict
);
1889 oldhdl
->sa_bonus
= NULL
;
1893 sa_set_userp(sa_handle_t
*hdl
, void *ptr
)
1895 hdl
->sa_userp
= ptr
;
1899 sa_get_db(sa_handle_t
*hdl
)
1901 return ((dmu_buf_t
*)hdl
->sa_bonus
);
1905 sa_get_userdata(sa_handle_t
*hdl
)
1907 return (hdl
->sa_userp
);
1911 sa_register_update_callback_locked(objset_t
*os
, sa_update_cb_t
*func
)
1913 ASSERT(MUTEX_HELD(&os
->os_sa
->sa_lock
));
1914 os
->os_sa
->sa_update_cb
= func
;
1918 sa_register_update_callback(objset_t
*os
, sa_update_cb_t
*func
)
1921 mutex_enter(&os
->os_sa
->sa_lock
);
1922 sa_register_update_callback_locked(os
, func
);
1923 mutex_exit(&os
->os_sa
->sa_lock
);
1927 sa_handle_object(sa_handle_t
*hdl
)
1929 return (hdl
->sa_bonus
->db_object
);
1933 sa_enabled(objset_t
*os
)
1935 return (os
->os_sa
== NULL
);
1939 sa_set_sa_object(objset_t
*os
, uint64_t sa_object
)
1941 sa_os_t
*sa
= os
->os_sa
;
1943 if (sa
->sa_master_obj
)
1946 sa
->sa_master_obj
= sa_object
;
1952 sa_hdrsize(void *arg
)
1954 sa_hdr_phys_t
*hdr
= arg
;
1956 return (SA_HDR_SIZE(hdr
));
1960 sa_handle_lock(sa_handle_t
*hdl
)
1963 mutex_enter(&hdl
->sa_lock
);
1967 sa_handle_unlock(sa_handle_t
*hdl
)
1970 mutex_exit(&hdl
->sa_lock
);