4 * The contents of this file are subject to the terms of the
5 * Common Development and Distribution License (the "License").
6 * You may not use this file except in compliance with the License.
8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 * or http://www.opensolaris.org/os/licensing.
10 * See the License for the specific language governing permissions
11 * and limitations under the License.
13 * When distributing Covered Code, include this CDDL HEADER in each
14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 * If applicable, add the following below this CDDL HEADER, with the
16 * fields enclosed by brackets "[]" replaced with your own identifying
17 * information: Portions Copyright [yyyy] [name of copyright owner]
23 * Copyright (c) 2010, Oracle and/or its affiliates. All rights reserved.
24 * Copyright (c) 2013 by Delphix. All rights reserved.
27 #include <sys/zfs_context.h>
28 #include <sys/types.h>
29 #include <sys/param.h>
30 #include <sys/systm.h>
31 #include <sys/sysmacros.h>
33 #include <sys/dmu_impl.h>
34 #include <sys/dmu_objset.h>
36 #include <sys/dnode.h>
39 #include <sys/sunddi.h>
40 #include <sys/sa_impl.h>
41 #include <sys/dnode.h>
42 #include <sys/errno.h>
43 #include <sys/zfs_context.h>
46 * ZFS System attributes:
48 * A generic mechanism to allow for arbitrary attributes
49 * to be stored in a dnode. The data will be stored in the bonus buffer of
50 * the dnode and if necessary a special "spill" block will be used to handle
51 * overflow situations. The spill block will be sized to fit the data
52 * from 512 - 128K. When a spill block is used the BP (blkptr_t) for the
53 * spill block is stored at the end of the current bonus buffer. Any
54 * attributes that would be in the way of the blkptr_t will be relocated
55 * into the spill block.
57 * Attribute registration:
59 * Stored persistently on a per dataset basis
60 * a mapping between attribute "string" names and their actual attribute
61 * numeric values, length, and byteswap function. The names are only used
62 * during registration. All attributes are known by their unique attribute
63 * id value. If an attribute can have a variable size then the value
64 * 0 will be used to indicate this.
68 * Attribute layouts are a way to compactly store multiple attributes, but
69 * without taking the overhead associated with managing each attribute
70 * individually. Since you will typically have the same set of attributes
71 * stored in the same order a single table will be used to represent that
72 * layout. The ZPL for example will usually have only about 10 different
73 * layouts (regular files, device files, symlinks,
74 * regular files + scanstamp, files/dir with extended attributes, and then
75 * you have the possibility of all of those minus ACL, because it would
76 * be kicked out into the spill block)
78 * Layouts are simply an array of the attributes and their
79 * ordering i.e. [0, 1, 4, 5, 2]
81 * Each distinct layout is given a unique layout number and that is whats
82 * stored in the header at the beginning of the SA data buffer.
84 * A layout only covers a single dbuf (bonus or spill). If a set of
85 * attributes is split up between the bonus buffer and a spill buffer then
86 * two different layouts will be used. This allows us to byteswap the
87 * spill without looking at the bonus buffer and keeps the on disk format of
88 * the bonus and spill buffer the same.
90 * Adding a single attribute will cause the entire set of attributes to
91 * be rewritten and could result in a new layout number being constructed
92 * as part of the rewrite if no such layout exists for the new set of
93 * attribues. The new attribute will be appended to the end of the already
94 * existing attributes.
96 * Both the attribute registration and attribute layout information are
97 * stored in normal ZAP attributes. Their should be a small number of
98 * known layouts and the set of attributes is assumed to typically be quite
101 * The registered attributes and layout "table" information is maintained
102 * in core and a special "sa_os_t" is attached to the objset_t.
104 * A special interface is provided to allow for quickly applying
105 * a large set of attributes at once. sa_replace_all_by_template() is
106 * used to set an array of attributes. This is used by the ZPL when
107 * creating a brand new file. The template that is passed into the function
108 * specifies the attribute, size for variable length attributes, location of
109 * data and special "data locator" function if the data isn't in a contiguous
112 * Byteswap implications:
114 * Since the SA attributes are not entirely self describing we can't do
115 * the normal byteswap processing. The special ZAP layout attribute and
116 * attribute registration attributes define the byteswap function and the
117 * size of the attributes, unless it is variable sized.
118 * The normal ZFS byteswapping infrastructure assumes you don't need
119 * to read any objects in order to do the necessary byteswapping. Whereas
120 * SA attributes can only be properly byteswapped if the dataset is opened
121 * and the layout/attribute ZAP attributes are available. Because of this
122 * the SA attributes will be byteswapped when they are first accessed by
123 * the SA code that will read the SA data.
126 typedef void (sa_iterfunc_t
)(void *hdr
, void *addr
, sa_attr_type_t
,
127 uint16_t length
, int length_idx
, boolean_t
, void *userp
);
129 static int sa_build_index(sa_handle_t
*hdl
, sa_buf_type_t buftype
);
130 static void sa_idx_tab_hold(objset_t
*os
, sa_idx_tab_t
*idx_tab
);
131 static void *sa_find_idx_tab(objset_t
*os
, dmu_object_type_t bonustype
,
133 static void sa_idx_tab_rele(objset_t
*os
, void *arg
);
134 static void sa_copy_data(sa_data_locator_t
*func
, void *start
, void *target
,
136 static int sa_modify_attrs(sa_handle_t
*hdl
, sa_attr_type_t newattr
,
137 sa_data_op_t action
, sa_data_locator_t
*locator
, void *datastart
,
138 uint16_t buflen
, dmu_tx_t
*tx
);
140 arc_byteswap_func_t sa_bswap_table
[] = {
141 byteswap_uint64_array
,
142 byteswap_uint32_array
,
143 byteswap_uint16_array
,
144 byteswap_uint8_array
,
148 #define SA_COPY_DATA(f, s, t, l) \
152 *(uint64_t *)t = *(uint64_t *)s; \
153 } else if (l == 16) { \
154 *(uint64_t *)t = *(uint64_t *)s; \
155 *(uint64_t *)((uintptr_t)t + 8) = \
156 *(uint64_t *)((uintptr_t)s + 8); \
161 sa_copy_data(f, s, t, l); \
165 * This table is fixed and cannot be changed. Its purpose is to
166 * allow the SA code to work with both old/new ZPL file systems.
167 * It contains the list of legacy attributes. These attributes aren't
168 * stored in the "attribute" registry zap objects, since older ZPL file systems
169 * won't have the registry. Only objsets of type ZFS_TYPE_FILESYSTEM will
170 * use this static table.
172 sa_attr_reg_t sa_legacy_attrs
[] = {
173 {"ZPL_ATIME", sizeof (uint64_t) * 2, SA_UINT64_ARRAY
, 0},
174 {"ZPL_MTIME", sizeof (uint64_t) * 2, SA_UINT64_ARRAY
, 1},
175 {"ZPL_CTIME", sizeof (uint64_t) * 2, SA_UINT64_ARRAY
, 2},
176 {"ZPL_CRTIME", sizeof (uint64_t) * 2, SA_UINT64_ARRAY
, 3},
177 {"ZPL_GEN", sizeof (uint64_t), SA_UINT64_ARRAY
, 4},
178 {"ZPL_MODE", sizeof (uint64_t), SA_UINT64_ARRAY
, 5},
179 {"ZPL_SIZE", sizeof (uint64_t), SA_UINT64_ARRAY
, 6},
180 {"ZPL_PARENT", sizeof (uint64_t), SA_UINT64_ARRAY
, 7},
181 {"ZPL_LINKS", sizeof (uint64_t), SA_UINT64_ARRAY
, 8},
182 {"ZPL_XATTR", sizeof (uint64_t), SA_UINT64_ARRAY
, 9},
183 {"ZPL_RDEV", sizeof (uint64_t), SA_UINT64_ARRAY
, 10},
184 {"ZPL_FLAGS", sizeof (uint64_t), SA_UINT64_ARRAY
, 11},
185 {"ZPL_UID", sizeof (uint64_t), SA_UINT64_ARRAY
, 12},
186 {"ZPL_GID", sizeof (uint64_t), SA_UINT64_ARRAY
, 13},
187 {"ZPL_PAD", sizeof (uint64_t) * 4, SA_UINT64_ARRAY
, 14},
188 {"ZPL_ZNODE_ACL", 88, SA_UINT8_ARRAY
, 15},
192 * This is only used for objects of type DMU_OT_ZNODE
194 sa_attr_type_t sa_legacy_zpl_layout
[] = {
195 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
199 * Special dummy layout used for buffers with no attributes.
201 sa_attr_type_t sa_dummy_zpl_layout
[] = { 0 };
203 static int sa_legacy_attr_count
= 16;
204 static kmem_cache_t
*sa_cache
= NULL
;
208 sa_cache_constructor(void *buf
, void *unused
, int kmflag
)
210 sa_handle_t
*hdl
= buf
;
212 hdl
->sa_bonus_tab
= NULL
;
213 hdl
->sa_spill_tab
= NULL
;
215 hdl
->sa_userp
= NULL
;
216 hdl
->sa_bonus
= NULL
;
217 hdl
->sa_spill
= NULL
;
218 mutex_init(&hdl
->sa_lock
, NULL
, MUTEX_DEFAULT
, NULL
);
224 sa_cache_destructor(void *buf
, void *unused
)
226 sa_handle_t
*hdl
= buf
;
227 mutex_destroy(&hdl
->sa_lock
);
233 sa_cache
= kmem_cache_create("sa_cache",
234 sizeof (sa_handle_t
), 0, sa_cache_constructor
,
235 sa_cache_destructor
, NULL
, NULL
, NULL
, 0);
242 kmem_cache_destroy(sa_cache
);
246 layout_num_compare(const void *arg1
, const void *arg2
)
248 const sa_lot_t
*node1
= arg1
;
249 const sa_lot_t
*node2
= arg2
;
251 if (node1
->lot_num
> node2
->lot_num
)
253 else if (node1
->lot_num
< node2
->lot_num
)
259 layout_hash_compare(const void *arg1
, const void *arg2
)
261 const sa_lot_t
*node1
= arg1
;
262 const sa_lot_t
*node2
= arg2
;
264 if (node1
->lot_hash
> node2
->lot_hash
)
266 if (node1
->lot_hash
< node2
->lot_hash
)
268 if (node1
->lot_instance
> node2
->lot_instance
)
270 if (node1
->lot_instance
< node2
->lot_instance
)
276 sa_layout_equal(sa_lot_t
*tbf
, sa_attr_type_t
*attrs
, int count
)
280 if (count
!= tbf
->lot_attr_count
)
283 for (i
= 0; i
!= count
; i
++) {
284 if (attrs
[i
] != tbf
->lot_attrs
[i
])
290 #define SA_ATTR_HASH(attr) (zfs_crc64_table[(-1ULL ^ attr) & 0xFF])
293 sa_layout_info_hash(sa_attr_type_t
*attrs
, int attr_count
)
296 uint64_t crc
= -1ULL;
298 for (i
= 0; i
!= attr_count
; i
++)
299 crc
^= SA_ATTR_HASH(attrs
[i
]);
305 sa_get_spill(sa_handle_t
*hdl
)
308 if (hdl
->sa_spill
== NULL
) {
309 if ((rc
= dmu_spill_hold_existing(hdl
->sa_bonus
, NULL
,
310 &hdl
->sa_spill
)) == 0)
311 VERIFY(0 == sa_build_index(hdl
, SA_SPILL
));
320 * Main attribute lookup/update function
321 * returns 0 for success or non zero for failures
323 * Operates on bulk array, first failure will abort further processing
326 sa_attr_op(sa_handle_t
*hdl
, sa_bulk_attr_t
*bulk
, int count
,
327 sa_data_op_t data_op
, dmu_tx_t
*tx
)
329 sa_os_t
*sa
= hdl
->sa_os
->os_sa
;
332 sa_buf_type_t buftypes
;
337 for (i
= 0; i
!= count
; i
++) {
338 ASSERT(bulk
[i
].sa_attr
<= hdl
->sa_os
->os_sa
->sa_num_attrs
);
340 bulk
[i
].sa_addr
= NULL
;
341 /* First check the bonus buffer */
343 if (hdl
->sa_bonus_tab
&& TOC_ATTR_PRESENT(
344 hdl
->sa_bonus_tab
->sa_idx_tab
[bulk
[i
].sa_attr
])) {
345 SA_ATTR_INFO(sa
, hdl
->sa_bonus_tab
,
346 SA_GET_HDR(hdl
, SA_BONUS
),
347 bulk
[i
].sa_attr
, bulk
[i
], SA_BONUS
, hdl
);
348 if (tx
&& !(buftypes
& SA_BONUS
)) {
349 dmu_buf_will_dirty(hdl
->sa_bonus
, tx
);
350 buftypes
|= SA_BONUS
;
353 if (bulk
[i
].sa_addr
== NULL
&&
354 ((error
= sa_get_spill(hdl
)) == 0)) {
355 if (TOC_ATTR_PRESENT(
356 hdl
->sa_spill_tab
->sa_idx_tab
[bulk
[i
].sa_attr
])) {
357 SA_ATTR_INFO(sa
, hdl
->sa_spill_tab
,
358 SA_GET_HDR(hdl
, SA_SPILL
),
359 bulk
[i
].sa_attr
, bulk
[i
], SA_SPILL
, hdl
);
360 if (tx
&& !(buftypes
& SA_SPILL
) &&
361 bulk
[i
].sa_size
== bulk
[i
].sa_length
) {
362 dmu_buf_will_dirty(hdl
->sa_spill
, tx
);
363 buftypes
|= SA_SPILL
;
367 if (error
&& error
!= ENOENT
) {
368 return ((error
== ECKSUM
) ? EIO
: error
);
373 if (bulk
[i
].sa_addr
== NULL
)
374 return (SET_ERROR(ENOENT
));
375 if (bulk
[i
].sa_data
) {
376 SA_COPY_DATA(bulk
[i
].sa_data_func
,
377 bulk
[i
].sa_addr
, bulk
[i
].sa_data
,
383 /* existing rewrite of attr */
384 if (bulk
[i
].sa_addr
&&
385 bulk
[i
].sa_size
== bulk
[i
].sa_length
) {
386 SA_COPY_DATA(bulk
[i
].sa_data_func
,
387 bulk
[i
].sa_data
, bulk
[i
].sa_addr
,
390 } else if (bulk
[i
].sa_addr
) { /* attr size change */
391 error
= sa_modify_attrs(hdl
, bulk
[i
].sa_attr
,
392 SA_REPLACE
, bulk
[i
].sa_data_func
,
393 bulk
[i
].sa_data
, bulk
[i
].sa_length
, tx
);
394 } else { /* adding new attribute */
395 error
= sa_modify_attrs(hdl
, bulk
[i
].sa_attr
,
396 SA_ADD
, bulk
[i
].sa_data_func
,
397 bulk
[i
].sa_data
, bulk
[i
].sa_length
, tx
);
410 sa_add_layout_entry(objset_t
*os
, sa_attr_type_t
*attrs
, int attr_count
,
411 uint64_t lot_num
, uint64_t hash
, boolean_t zapadd
, dmu_tx_t
*tx
)
413 sa_os_t
*sa
= os
->os_sa
;
414 sa_lot_t
*tb
, *findtb
;
418 ASSERT(MUTEX_HELD(&sa
->sa_lock
));
419 tb
= kmem_zalloc(sizeof (sa_lot_t
), KM_SLEEP
);
420 tb
->lot_attr_count
= attr_count
;
421 tb
->lot_attrs
= kmem_alloc(sizeof (sa_attr_type_t
) * attr_count
,
423 bcopy(attrs
, tb
->lot_attrs
, sizeof (sa_attr_type_t
) * attr_count
);
424 tb
->lot_num
= lot_num
;
426 tb
->lot_instance
= 0;
431 if (sa
->sa_layout_attr_obj
== 0) {
432 sa
->sa_layout_attr_obj
= zap_create_link(os
,
433 DMU_OT_SA_ATTR_LAYOUTS
,
434 sa
->sa_master_obj
, SA_LAYOUTS
, tx
);
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
) {
506 return (SET_ERROR(EFBIG
));
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
)
560 if (buftype
== SA_BONUS
&& sa
->sa_force_spill
) {
563 *will_spill
= B_TRUE
;
569 *will_spill
= B_FALSE
;
572 hdrsize
= (SA_BONUSTYPE_FROM_DB(db
) == DMU_OT_ZNODE
) ? 0 :
573 sizeof (sa_hdr_phys_t
);
575 full_space
= (buftype
== SA_BONUS
) ? DN_MAX_BONUSLEN
: db
->db_size
;
576 ASSERT(IS_P2ALIGNED(full_space
, 8));
578 for (i
= 0; i
!= attr_count
; i
++) {
579 boolean_t is_var_sz
, might_spill_here
;
581 *total
= P2ROUNDUP(*total
, 8);
582 *total
+= attr_desc
[i
].sa_length
;
586 is_var_sz
= (SA_REGISTERED_LEN(sa
, attr_desc
[i
].sa_attr
) == 0);
592 buftype
== SA_BONUS
&& *index
== -1 &&
593 (*total
+ P2ROUNDUP(hdrsize
, 8)) >
594 (full_space
- sizeof (blkptr_t
));
596 if (is_var_sz
&& var_size
> 1) {
598 * Don't worry that the spill block might overflow.
599 * It will be resized if needed in sa_build_layouts().
601 if (buftype
== SA_SPILL
||
602 P2ROUNDUP(hdrsize
+ sizeof (uint16_t), 8) +
603 *total
< full_space
) {
605 * Account for header space used by array of
606 * optional sizes of variable-length attributes.
607 * Record the extra header size in case this
608 * increase needs to be reversed due to
611 hdrsize
+= sizeof (uint16_t);
612 if (*index
!= -1 || might_spill_here
)
613 extra_hdrsize
+= sizeof (uint16_t);
615 ASSERT(buftype
== SA_BONUS
);
618 *will_spill
= B_TRUE
;
624 * find index of where spill *could* occur.
625 * Then continue to count of remainder attribute
626 * space. The sum is used later for sizing bonus
629 if (might_spill_here
)
632 if ((*total
+ P2ROUNDUP(hdrsize
, 8)) > full_space
&&
634 *will_spill
= B_TRUE
;
638 hdrsize
-= extra_hdrsize
;
640 hdrsize
= P2ROUNDUP(hdrsize
, 8);
644 #define BUF_SPACE_NEEDED(total, header) (total + header)
647 * Find layout that corresponds to ordering of attributes
648 * If not found a new layout number is created and added to
649 * persistent layout tables.
652 sa_build_layouts(sa_handle_t
*hdl
, sa_bulk_attr_t
*attr_desc
, int attr_count
,
655 sa_os_t
*sa
= hdl
->sa_os
->os_sa
;
657 sa_buf_type_t buftype
;
658 sa_hdr_phys_t
*sahdr
;
661 sa_attr_type_t
*attrs
, *attrs_start
;
664 int spillhdrsize
= 0;
666 dmu_object_type_t bonustype
;
672 dmu_buf_will_dirty(hdl
->sa_bonus
, tx
);
673 bonustype
= SA_BONUSTYPE_FROM_DB(hdl
->sa_bonus
);
675 /* first determine bonus header size and sum of all attributes */
676 hdrsize
= sa_find_sizes(sa
, attr_desc
, attr_count
, hdl
->sa_bonus
,
677 SA_BONUS
, &i
, &used
, &spilling
);
679 if (used
> SPA_MAXBLOCKSIZE
)
680 return (SET_ERROR(EFBIG
));
682 VERIFY(0 == dmu_set_bonus(hdl
->sa_bonus
, spilling
?
683 MIN(DN_MAX_BONUSLEN
- sizeof (blkptr_t
), used
+ hdrsize
) :
684 used
+ hdrsize
, tx
));
686 ASSERT((bonustype
== DMU_OT_ZNODE
&& spilling
== 0) ||
687 bonustype
== DMU_OT_SA
);
689 /* setup and size spill buffer when needed */
693 if (hdl
->sa_spill
== NULL
) {
694 VERIFY(dmu_spill_hold_by_bonus(hdl
->sa_bonus
, NULL
,
695 &hdl
->sa_spill
) == 0);
697 dmu_buf_will_dirty(hdl
->sa_spill
, tx
);
699 spillhdrsize
= sa_find_sizes(sa
, &attr_desc
[i
],
700 attr_count
- i
, hdl
->sa_spill
, SA_SPILL
, &i
,
701 &spill_used
, &dummy
);
703 if (spill_used
> SPA_MAXBLOCKSIZE
)
704 return (SET_ERROR(EFBIG
));
706 buf_space
= hdl
->sa_spill
->db_size
- spillhdrsize
;
707 if (BUF_SPACE_NEEDED(spill_used
, spillhdrsize
) >
708 hdl
->sa_spill
->db_size
)
709 VERIFY(0 == sa_resize_spill(hdl
,
710 BUF_SPACE_NEEDED(spill_used
, spillhdrsize
), tx
));
713 /* setup starting pointers to lay down data */
714 data_start
= (void *)((uintptr_t)hdl
->sa_bonus
->db_data
+ hdrsize
);
715 sahdr
= (sa_hdr_phys_t
*)hdl
->sa_bonus
->db_data
;
719 buf_space
= (sa
->sa_force_spill
) ?
720 0 : SA_BLKPTR_SPACE
- hdrsize
;
722 buf_space
= hdl
->sa_bonus
->db_size
- hdrsize
;
724 attrs_start
= attrs
= kmem_alloc(sizeof (sa_attr_type_t
) * attr_count
,
728 for (i
= 0, len_idx
= 0, hash
= -1ULL; i
!= attr_count
; i
++) {
731 ASSERT(IS_P2ALIGNED(data_start
, 8));
732 ASSERT(IS_P2ALIGNED(buf_space
, 8));
733 attrs
[i
] = attr_desc
[i
].sa_attr
;
734 length
= SA_REGISTERED_LEN(sa
, attrs
[i
]);
736 length
= attr_desc
[i
].sa_length
;
738 if (buf_space
< length
) { /* 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
];
756 buf_space
= hdl
->sa_spill
->db_size
- spillhdrsize
;
759 hash
^= SA_ATTR_HASH(attrs
[i
]);
760 attr_desc
[i
].sa_addr
= data_start
;
761 attr_desc
[i
].sa_size
= length
;
762 SA_COPY_DATA(attr_desc
[i
].sa_data_func
, attr_desc
[i
].sa_data
,
764 if (sa
->sa_attr_table
[attrs
[i
]].sa_length
== 0) {
765 sahdr
->sa_lengths
[len_idx
++] = length
;
767 data_start
= (void *)P2ROUNDUP(((uintptr_t)data_start
+
769 buf_space
-= P2ROUNDUP(length
, 8);
773 sa_find_layout(hdl
->sa_os
, hash
, attrs_start
, lot_count
, tx
, &lot
);
776 * Verify that old znodes always have layout number 0.
777 * Must be DMU_OT_SA for arbitrary layouts
779 VERIFY((bonustype
== DMU_OT_ZNODE
&& lot
->lot_num
== 0) ||
780 (bonustype
== DMU_OT_SA
&& lot
->lot_num
> 1));
782 if (bonustype
== DMU_OT_SA
) {
783 SA_SET_HDR(sahdr
, lot
->lot_num
,
784 buftype
== SA_BONUS
? hdrsize
: spillhdrsize
);
787 kmem_free(attrs
, sizeof (sa_attr_type_t
) * attr_count
);
788 if (hdl
->sa_bonus_tab
) {
789 sa_idx_tab_rele(hdl
->sa_os
, hdl
->sa_bonus_tab
);
790 hdl
->sa_bonus_tab
= NULL
;
792 if (!sa
->sa_force_spill
)
793 VERIFY(0 == sa_build_index(hdl
, SA_BONUS
));
795 sa_idx_tab_rele(hdl
->sa_os
, hdl
->sa_spill_tab
);
798 * remove spill block that is no longer needed.
800 dmu_buf_rele(hdl
->sa_spill
, NULL
);
801 hdl
->sa_spill
= NULL
;
802 hdl
->sa_spill_tab
= NULL
;
803 VERIFY(0 == dmu_rm_spill(hdl
->sa_os
,
804 sa_handle_object(hdl
), tx
));
806 VERIFY(0 == sa_build_index(hdl
, SA_SPILL
));
814 sa_free_attr_table(sa_os_t
*sa
)
818 if (sa
->sa_attr_table
== NULL
)
821 for (i
= 0; i
!= sa
->sa_num_attrs
; i
++) {
822 if (sa
->sa_attr_table
[i
].sa_name
)
823 kmem_free(sa
->sa_attr_table
[i
].sa_name
,
824 strlen(sa
->sa_attr_table
[i
].sa_name
) + 1);
827 kmem_free(sa
->sa_attr_table
,
828 sizeof (sa_attr_table_t
) * sa
->sa_num_attrs
);
830 sa
->sa_attr_table
= NULL
;
834 sa_attr_table_setup(objset_t
*os
, sa_attr_reg_t
*reg_attrs
, int count
)
836 sa_os_t
*sa
= os
->os_sa
;
837 uint64_t sa_attr_count
= 0;
838 uint64_t sa_reg_count
= 0;
844 int registered_count
= 0;
846 dmu_objset_type_t ostype
= dmu_objset_type(os
);
849 kmem_zalloc(count
* sizeof (sa_attr_type_t
), KM_SLEEP
);
850 sa
->sa_user_table_sz
= count
* sizeof (sa_attr_type_t
);
852 if (sa
->sa_reg_attr_obj
!= 0) {
853 error
= zap_count(os
, sa
->sa_reg_attr_obj
,
857 * Make sure we retrieved a count and that it isn't zero
859 if (error
|| (error
== 0 && sa_attr_count
== 0)) {
861 error
= SET_ERROR(EINVAL
);
864 sa_reg_count
= sa_attr_count
;
867 if (ostype
== DMU_OST_ZFS
&& sa_attr_count
== 0)
868 sa_attr_count
+= sa_legacy_attr_count
;
870 /* Allocate attribute numbers for attributes that aren't registered */
871 for (i
= 0; i
!= count
; i
++) {
872 boolean_t found
= B_FALSE
;
875 if (ostype
== DMU_OST_ZFS
) {
876 for (j
= 0; j
!= sa_legacy_attr_count
; j
++) {
877 if (strcmp(reg_attrs
[i
].sa_name
,
878 sa_legacy_attrs
[j
].sa_name
) == 0) {
879 sa
->sa_user_table
[i
] =
880 sa_legacy_attrs
[j
].sa_attr
;
888 if (sa
->sa_reg_attr_obj
)
889 error
= zap_lookup(os
, sa
->sa_reg_attr_obj
,
890 reg_attrs
[i
].sa_name
, 8, 1, &attr_value
);
892 error
= SET_ERROR(ENOENT
);
895 sa
->sa_user_table
[i
] = (sa_attr_type_t
)sa_attr_count
;
899 sa
->sa_user_table
[i
] = ATTR_NUM(attr_value
);
906 sa
->sa_num_attrs
= sa_attr_count
;
907 tb
= sa
->sa_attr_table
=
908 kmem_zalloc(sizeof (sa_attr_table_t
) * sa_attr_count
, KM_SLEEP
);
911 * Attribute table is constructed from requested attribute list,
912 * previously foreign registered attributes, and also the legacy
913 * ZPL set of attributes.
916 if (sa
->sa_reg_attr_obj
) {
917 for (zap_cursor_init(&zc
, os
, sa
->sa_reg_attr_obj
);
918 (error
= zap_cursor_retrieve(&zc
, &za
)) == 0;
919 zap_cursor_advance(&zc
)) {
921 value
= za
.za_first_integer
;
924 tb
[ATTR_NUM(value
)].sa_attr
= ATTR_NUM(value
);
925 tb
[ATTR_NUM(value
)].sa_length
= ATTR_LENGTH(value
);
926 tb
[ATTR_NUM(value
)].sa_byteswap
= ATTR_BSWAP(value
);
927 tb
[ATTR_NUM(value
)].sa_registered
= B_TRUE
;
929 if (tb
[ATTR_NUM(value
)].sa_name
) {
932 tb
[ATTR_NUM(value
)].sa_name
=
933 kmem_zalloc(strlen(za
.za_name
) +1, KM_SLEEP
);
934 (void) strlcpy(tb
[ATTR_NUM(value
)].sa_name
, za
.za_name
,
935 strlen(za
.za_name
) +1);
937 zap_cursor_fini(&zc
);
939 * Make sure we processed the correct number of registered
942 if (registered_count
!= sa_reg_count
) {
949 if (ostype
== DMU_OST_ZFS
) {
950 for (i
= 0; i
!= sa_legacy_attr_count
; i
++) {
953 tb
[i
].sa_attr
= sa_legacy_attrs
[i
].sa_attr
;
954 tb
[i
].sa_length
= sa_legacy_attrs
[i
].sa_length
;
955 tb
[i
].sa_byteswap
= sa_legacy_attrs
[i
].sa_byteswap
;
956 tb
[i
].sa_registered
= B_FALSE
;
958 kmem_zalloc(strlen(sa_legacy_attrs
[i
].sa_name
) +1,
960 (void) strlcpy(tb
[i
].sa_name
,
961 sa_legacy_attrs
[i
].sa_name
,
962 strlen(sa_legacy_attrs
[i
].sa_name
) + 1);
966 for (i
= 0; i
!= count
; i
++) {
967 sa_attr_type_t attr_id
;
969 attr_id
= sa
->sa_user_table
[i
];
970 if (tb
[attr_id
].sa_name
)
973 tb
[attr_id
].sa_length
= reg_attrs
[i
].sa_length
;
974 tb
[attr_id
].sa_byteswap
= reg_attrs
[i
].sa_byteswap
;
975 tb
[attr_id
].sa_attr
= attr_id
;
976 tb
[attr_id
].sa_name
=
977 kmem_zalloc(strlen(reg_attrs
[i
].sa_name
) + 1, KM_SLEEP
);
978 (void) strlcpy(tb
[attr_id
].sa_name
, reg_attrs
[i
].sa_name
,
979 strlen(reg_attrs
[i
].sa_name
) + 1);
982 sa
->sa_need_attr_registration
=
983 (sa_attr_count
!= registered_count
);
987 kmem_free(sa
->sa_user_table
, count
* sizeof (sa_attr_type_t
));
988 sa
->sa_user_table
= NULL
;
989 sa_free_attr_table(sa
);
990 return ((error
!= 0) ? error
: EINVAL
);
994 sa_setup(objset_t
*os
, uint64_t sa_obj
, sa_attr_reg_t
*reg_attrs
, int count
,
995 sa_attr_type_t
**user_table
)
1000 dmu_objset_type_t ostype
= dmu_objset_type(os
);
1004 mutex_enter(&os
->os_user_ptr_lock
);
1006 mutex_enter(&os
->os_sa
->sa_lock
);
1007 mutex_exit(&os
->os_user_ptr_lock
);
1008 tb
= os
->os_sa
->sa_user_table
;
1009 mutex_exit(&os
->os_sa
->sa_lock
);
1014 sa
= kmem_zalloc(sizeof (sa_os_t
), KM_SLEEP
);
1015 mutex_init(&sa
->sa_lock
, NULL
, MUTEX_DEFAULT
, NULL
);
1016 sa
->sa_master_obj
= sa_obj
;
1019 mutex_enter(&sa
->sa_lock
);
1020 mutex_exit(&os
->os_user_ptr_lock
);
1021 avl_create(&sa
->sa_layout_num_tree
, layout_num_compare
,
1022 sizeof (sa_lot_t
), offsetof(sa_lot_t
, lot_num_node
));
1023 avl_create(&sa
->sa_layout_hash_tree
, layout_hash_compare
,
1024 sizeof (sa_lot_t
), offsetof(sa_lot_t
, lot_hash_node
));
1027 error
= zap_lookup(os
, sa_obj
, SA_LAYOUTS
,
1028 8, 1, &sa
->sa_layout_attr_obj
);
1029 if (error
!= 0 && error
!= ENOENT
)
1031 error
= zap_lookup(os
, sa_obj
, SA_REGISTRY
,
1032 8, 1, &sa
->sa_reg_attr_obj
);
1033 if (error
!= 0 && error
!= ENOENT
)
1037 if ((error
= sa_attr_table_setup(os
, reg_attrs
, count
)) != 0)
1040 if (sa
->sa_layout_attr_obj
!= 0) {
1041 uint64_t layout_count
;
1043 error
= zap_count(os
, sa
->sa_layout_attr_obj
,
1047 * Layout number count should be > 0
1049 if (error
|| (error
== 0 && layout_count
== 0)) {
1051 error
= SET_ERROR(EINVAL
);
1055 for (zap_cursor_init(&zc
, os
, sa
->sa_layout_attr_obj
);
1056 (error
= zap_cursor_retrieve(&zc
, &za
)) == 0;
1057 zap_cursor_advance(&zc
)) {
1058 sa_attr_type_t
*lot_attrs
;
1061 lot_attrs
= kmem_zalloc(sizeof (sa_attr_type_t
) *
1062 za
.za_num_integers
, KM_SLEEP
);
1064 if ((error
= (zap_lookup(os
, sa
->sa_layout_attr_obj
,
1065 za
.za_name
, 2, za
.za_num_integers
,
1066 lot_attrs
))) != 0) {
1067 kmem_free(lot_attrs
, sizeof (sa_attr_type_t
) *
1068 za
.za_num_integers
);
1071 VERIFY(ddi_strtoull(za
.za_name
, NULL
, 10,
1072 (unsigned long long *)&lot_num
) == 0);
1074 (void) sa_add_layout_entry(os
, lot_attrs
,
1075 za
.za_num_integers
, lot_num
,
1076 sa_layout_info_hash(lot_attrs
,
1077 za
.za_num_integers
), B_FALSE
, NULL
);
1078 kmem_free(lot_attrs
, sizeof (sa_attr_type_t
) *
1079 za
.za_num_integers
);
1081 zap_cursor_fini(&zc
);
1084 * Make sure layout count matches number of entries added
1087 if (avl_numnodes(&sa
->sa_layout_num_tree
) != layout_count
) {
1093 /* Add special layout number for old ZNODES */
1094 if (ostype
== DMU_OST_ZFS
) {
1095 (void) sa_add_layout_entry(os
, sa_legacy_zpl_layout
,
1096 sa_legacy_attr_count
, 0,
1097 sa_layout_info_hash(sa_legacy_zpl_layout
,
1098 sa_legacy_attr_count
), B_FALSE
, NULL
);
1100 (void) sa_add_layout_entry(os
, sa_dummy_zpl_layout
, 0, 1,
1103 *user_table
= os
->os_sa
->sa_user_table
;
1104 mutex_exit(&sa
->sa_lock
);
1108 sa_free_attr_table(sa
);
1109 if (sa
->sa_user_table
)
1110 kmem_free(sa
->sa_user_table
, sa
->sa_user_table_sz
);
1111 mutex_exit(&sa
->sa_lock
);
1112 kmem_free(sa
, sizeof (sa_os_t
));
1113 return ((error
== ECKSUM
) ? EIO
: error
);
1117 sa_tear_down(objset_t
*os
)
1119 sa_os_t
*sa
= os
->os_sa
;
1123 kmem_free(sa
->sa_user_table
, sa
->sa_user_table_sz
);
1125 /* Free up attr table */
1127 sa_free_attr_table(sa
);
1131 avl_destroy_nodes(&sa
->sa_layout_hash_tree
, &cookie
))) {
1133 while ((tab
= list_head(&layout
->lot_idx_tab
))) {
1134 ASSERT(refcount_count(&tab
->sa_refcount
));
1135 sa_idx_tab_rele(os
, tab
);
1140 while ((layout
= avl_destroy_nodes(&sa
->sa_layout_num_tree
, &cookie
))) {
1141 kmem_free(layout
->lot_attrs
,
1142 sizeof (sa_attr_type_t
) * layout
->lot_attr_count
);
1143 kmem_free(layout
, sizeof (sa_lot_t
));
1146 avl_destroy(&sa
->sa_layout_hash_tree
);
1147 avl_destroy(&sa
->sa_layout_num_tree
);
1149 kmem_free(sa
, sizeof (sa_os_t
));
1154 sa_build_idx_tab(void *hdr
, void *attr_addr
, sa_attr_type_t attr
,
1155 uint16_t length
, int length_idx
, boolean_t var_length
, void *userp
)
1157 sa_idx_tab_t
*idx_tab
= userp
;
1160 ASSERT(idx_tab
->sa_variable_lengths
);
1161 idx_tab
->sa_variable_lengths
[length_idx
] = length
;
1163 TOC_ATTR_ENCODE(idx_tab
->sa_idx_tab
[attr
], length_idx
,
1164 (uint32_t)((uintptr_t)attr_addr
- (uintptr_t)hdr
));
1168 sa_attr_iter(objset_t
*os
, sa_hdr_phys_t
*hdr
, dmu_object_type_t type
,
1169 sa_iterfunc_t func
, sa_lot_t
*tab
, void *userp
)
1175 sa_os_t
*sa
= os
->os_sa
;
1177 uint16_t *length_start
= NULL
;
1178 uint8_t length_idx
= 0;
1181 search
.lot_num
= SA_LAYOUT_NUM(hdr
, type
);
1182 tb
= avl_find(&sa
->sa_layout_num_tree
, &search
, &loc
);
1186 if (IS_SA_BONUSTYPE(type
)) {
1187 data_start
= (void *)P2ROUNDUP(((uintptr_t)hdr
+
1188 offsetof(sa_hdr_phys_t
, sa_lengths
) +
1189 (sizeof (uint16_t) * tb
->lot_var_sizes
)), 8);
1190 length_start
= hdr
->sa_lengths
;
1195 for (i
= 0; i
!= tb
->lot_attr_count
; i
++) {
1196 int attr_length
, reg_length
;
1199 reg_length
= sa
->sa_attr_table
[tb
->lot_attrs
[i
]].sa_length
;
1201 attr_length
= reg_length
;
1204 attr_length
= length_start
[length_idx
];
1205 idx_len
= length_idx
++;
1208 func(hdr
, data_start
, tb
->lot_attrs
[i
], attr_length
,
1209 idx_len
, reg_length
== 0 ? B_TRUE
: B_FALSE
, userp
);
1211 data_start
= (void *)P2ROUNDUP(((uintptr_t)data_start
+
1218 sa_byteswap_cb(void *hdr
, void *attr_addr
, sa_attr_type_t attr
,
1219 uint16_t length
, int length_idx
, boolean_t variable_length
, void *userp
)
1221 sa_handle_t
*hdl
= userp
;
1222 sa_os_t
*sa
= hdl
->sa_os
->os_sa
;
1224 sa_bswap_table
[sa
->sa_attr_table
[attr
].sa_byteswap
](attr_addr
, length
);
1228 sa_byteswap(sa_handle_t
*hdl
, sa_buf_type_t buftype
)
1230 sa_hdr_phys_t
*sa_hdr_phys
= SA_GET_HDR(hdl
, buftype
);
1232 int num_lengths
= 1;
1234 ASSERTV(sa_os_t
*sa
= hdl
->sa_os
->os_sa
);
1236 ASSERT(MUTEX_HELD(&sa
->sa_lock
));
1237 if (sa_hdr_phys
->sa_magic
== SA_MAGIC
)
1240 db
= SA_GET_DB(hdl
, buftype
);
1242 if (buftype
== SA_SPILL
) {
1243 arc_release(db
->db_buf
, NULL
);
1244 arc_buf_thaw(db
->db_buf
);
1247 sa_hdr_phys
->sa_magic
= BSWAP_32(sa_hdr_phys
->sa_magic
);
1248 sa_hdr_phys
->sa_layout_info
= BSWAP_16(sa_hdr_phys
->sa_layout_info
);
1251 * Determine number of variable lenghts in header
1252 * The standard 8 byte header has one for free and a
1253 * 16 byte header would have 4 + 1;
1255 if (SA_HDR_SIZE(sa_hdr_phys
) > 8)
1256 num_lengths
+= (SA_HDR_SIZE(sa_hdr_phys
) - 8) >> 1;
1257 for (i
= 0; i
!= num_lengths
; i
++)
1258 sa_hdr_phys
->sa_lengths
[i
] =
1259 BSWAP_16(sa_hdr_phys
->sa_lengths
[i
]);
1261 sa_attr_iter(hdl
->sa_os
, sa_hdr_phys
, DMU_OT_SA
,
1262 sa_byteswap_cb
, NULL
, hdl
);
1264 if (buftype
== SA_SPILL
)
1265 arc_buf_freeze(((dmu_buf_impl_t
*)hdl
->sa_spill
)->db_buf
);
1269 sa_build_index(sa_handle_t
*hdl
, sa_buf_type_t buftype
)
1271 sa_hdr_phys_t
*sa_hdr_phys
;
1272 dmu_buf_impl_t
*db
= SA_GET_DB(hdl
, buftype
);
1273 dmu_object_type_t bonustype
= SA_BONUSTYPE_FROM_DB(db
);
1274 sa_os_t
*sa
= hdl
->sa_os
->os_sa
;
1275 sa_idx_tab_t
*idx_tab
;
1277 sa_hdr_phys
= SA_GET_HDR(hdl
, buftype
);
1279 mutex_enter(&sa
->sa_lock
);
1281 /* Do we need to byteswap? */
1283 /* only check if not old znode */
1284 if (IS_SA_BONUSTYPE(bonustype
) && sa_hdr_phys
->sa_magic
!= SA_MAGIC
&&
1285 sa_hdr_phys
->sa_magic
!= 0) {
1286 VERIFY(BSWAP_32(sa_hdr_phys
->sa_magic
) == SA_MAGIC
);
1287 sa_byteswap(hdl
, buftype
);
1290 idx_tab
= sa_find_idx_tab(hdl
->sa_os
, bonustype
, sa_hdr_phys
);
1292 if (buftype
== SA_BONUS
)
1293 hdl
->sa_bonus_tab
= idx_tab
;
1295 hdl
->sa_spill_tab
= idx_tab
;
1297 mutex_exit(&sa
->sa_lock
);
1303 sa_evict(dmu_buf_t
*db
, void *sap
)
1305 panic("evicting sa dbuf %p\n", (void *)db
);
1309 sa_idx_tab_rele(objset_t
*os
, void *arg
)
1311 sa_os_t
*sa
= os
->os_sa
;
1312 sa_idx_tab_t
*idx_tab
= arg
;
1314 if (idx_tab
== NULL
)
1317 mutex_enter(&sa
->sa_lock
);
1318 if (refcount_remove(&idx_tab
->sa_refcount
, NULL
) == 0) {
1319 list_remove(&idx_tab
->sa_layout
->lot_idx_tab
, idx_tab
);
1320 if (idx_tab
->sa_variable_lengths
)
1321 kmem_free(idx_tab
->sa_variable_lengths
,
1323 idx_tab
->sa_layout
->lot_var_sizes
);
1324 refcount_destroy(&idx_tab
->sa_refcount
);
1325 kmem_free(idx_tab
->sa_idx_tab
,
1326 sizeof (uint32_t) * sa
->sa_num_attrs
);
1327 kmem_free(idx_tab
, sizeof (sa_idx_tab_t
));
1329 mutex_exit(&sa
->sa_lock
);
1333 sa_idx_tab_hold(objset_t
*os
, sa_idx_tab_t
*idx_tab
)
1335 ASSERTV(sa_os_t
*sa
= os
->os_sa
);
1337 ASSERT(MUTEX_HELD(&sa
->sa_lock
));
1338 (void) refcount_add(&idx_tab
->sa_refcount
, NULL
);
1342 sa_spill_rele(sa_handle_t
*hdl
)
1344 mutex_enter(&hdl
->sa_lock
);
1345 if (hdl
->sa_spill
) {
1346 sa_idx_tab_rele(hdl
->sa_os
, hdl
->sa_spill_tab
);
1347 dmu_buf_rele(hdl
->sa_spill
, NULL
);
1348 hdl
->sa_spill
= NULL
;
1349 hdl
->sa_spill_tab
= NULL
;
1351 mutex_exit(&hdl
->sa_lock
);
1355 sa_handle_destroy(sa_handle_t
*hdl
)
1357 mutex_enter(&hdl
->sa_lock
);
1358 (void) dmu_buf_update_user((dmu_buf_t
*)hdl
->sa_bonus
, hdl
,
1361 if (hdl
->sa_bonus_tab
) {
1362 sa_idx_tab_rele(hdl
->sa_os
, hdl
->sa_bonus_tab
);
1363 hdl
->sa_bonus_tab
= NULL
;
1365 if (hdl
->sa_spill_tab
) {
1366 sa_idx_tab_rele(hdl
->sa_os
, hdl
->sa_spill_tab
);
1367 hdl
->sa_spill_tab
= NULL
;
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
;
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 handle
= (hdl_type
== SA_HDL_SHARED
) ? dmu_buf_get_user(db
) : NULL
;
1396 if (handle
== NULL
) {
1397 sa_handle_t
*newhandle
;
1398 handle
= kmem_cache_alloc(sa_cache
, KM_SLEEP
);
1399 handle
->sa_userp
= userp
;
1400 handle
->sa_bonus
= db
;
1402 handle
->sa_spill
= NULL
;
1404 error
= sa_build_index(handle
, SA_BONUS
);
1405 newhandle
= (hdl_type
== SA_HDL_SHARED
) ?
1406 dmu_buf_set_user_ie(db
, handle
,
1407 NULL
, sa_evict
) : NULL
;
1409 if (newhandle
!= NULL
) {
1410 kmem_cache_free(sa_cache
, handle
);
1420 sa_handle_get(objset_t
*objset
, uint64_t objid
, void *userp
,
1421 sa_handle_type_t hdl_type
, sa_handle_t
**handlepp
)
1426 if ((error
= dmu_bonus_hold(objset
, objid
, NULL
, &db
)))
1429 return (sa_handle_get_from_db(objset
, db
, userp
, hdl_type
,
1434 sa_buf_hold(objset_t
*objset
, uint64_t obj_num
, void *tag
, dmu_buf_t
**db
)
1436 return (dmu_bonus_hold(objset
, obj_num
, tag
, db
));
1440 sa_buf_rele(dmu_buf_t
*db
, void *tag
)
1442 dmu_buf_rele(db
, tag
);
1446 sa_lookup_impl(sa_handle_t
*hdl
, sa_bulk_attr_t
*bulk
, int count
)
1449 ASSERT(MUTEX_HELD(&hdl
->sa_lock
));
1450 return (sa_attr_op(hdl
, bulk
, count
, SA_LOOKUP
, NULL
));
1454 sa_lookup(sa_handle_t
*hdl
, sa_attr_type_t attr
, void *buf
, uint32_t buflen
)
1457 sa_bulk_attr_t bulk
;
1459 bulk
.sa_attr
= attr
;
1461 bulk
.sa_length
= buflen
;
1462 bulk
.sa_data_func
= NULL
;
1465 mutex_enter(&hdl
->sa_lock
);
1466 error
= sa_lookup_impl(hdl
, &bulk
, 1);
1467 mutex_exit(&hdl
->sa_lock
);
1473 sa_lookup_uio(sa_handle_t
*hdl
, sa_attr_type_t attr
, uio_t
*uio
)
1476 sa_bulk_attr_t bulk
;
1478 bulk
.sa_data
= NULL
;
1479 bulk
.sa_attr
= attr
;
1480 bulk
.sa_data_func
= NULL
;
1484 mutex_enter(&hdl
->sa_lock
);
1485 if ((error
= sa_attr_op(hdl
, &bulk
, 1, SA_LOOKUP
, NULL
)) == 0) {
1486 error
= uiomove((void *)bulk
.sa_addr
, MIN(bulk
.sa_size
,
1487 uio
->uio_resid
), UIO_READ
, uio
);
1489 mutex_exit(&hdl
->sa_lock
);
1495 sa_find_idx_tab(objset_t
*os
, dmu_object_type_t bonustype
, void *data
)
1497 sa_idx_tab_t
*idx_tab
;
1498 sa_hdr_phys_t
*hdr
= (sa_hdr_phys_t
*)data
;
1499 sa_os_t
*sa
= os
->os_sa
;
1500 sa_lot_t
*tb
, search
;
1504 * Deterimine layout number. If SA node and header == 0 then
1505 * force the index table to the dummy "1" empty layout.
1507 * The layout number would only be zero for a newly created file
1508 * that has not added any attributes yet, or with crypto enabled which
1509 * doesn't write any attributes to the bonus buffer.
1512 search
.lot_num
= SA_LAYOUT_NUM(hdr
, bonustype
);
1514 tb
= avl_find(&sa
->sa_layout_num_tree
, &search
, &loc
);
1516 /* Verify header size is consistent with layout information */
1518 ASSERT((IS_SA_BONUSTYPE(bonustype
) &&
1519 SA_HDR_SIZE_MATCH_LAYOUT(hdr
, tb
)) || !IS_SA_BONUSTYPE(bonustype
) ||
1520 (IS_SA_BONUSTYPE(bonustype
) && hdr
->sa_layout_info
== 0));
1523 * See if any of the already existing TOC entries can be reused?
1526 for (idx_tab
= list_head(&tb
->lot_idx_tab
); idx_tab
;
1527 idx_tab
= list_next(&tb
->lot_idx_tab
, idx_tab
)) {
1528 boolean_t valid_idx
= B_TRUE
;
1531 if (tb
->lot_var_sizes
!= 0 &&
1532 idx_tab
->sa_variable_lengths
!= NULL
) {
1533 for (i
= 0; i
!= tb
->lot_var_sizes
; i
++) {
1534 if (hdr
->sa_lengths
[i
] !=
1535 idx_tab
->sa_variable_lengths
[i
]) {
1536 valid_idx
= B_FALSE
;
1542 sa_idx_tab_hold(os
, idx_tab
);
1547 /* No such luck, create a new entry */
1548 idx_tab
= kmem_zalloc(sizeof (sa_idx_tab_t
), KM_SLEEP
);
1549 idx_tab
->sa_idx_tab
=
1550 kmem_zalloc(sizeof (uint32_t) * sa
->sa_num_attrs
, KM_SLEEP
);
1551 idx_tab
->sa_layout
= tb
;
1552 refcount_create(&idx_tab
->sa_refcount
);
1553 if (tb
->lot_var_sizes
)
1554 idx_tab
->sa_variable_lengths
= kmem_alloc(sizeof (uint16_t) *
1555 tb
->lot_var_sizes
, KM_SLEEP
);
1557 sa_attr_iter(os
, hdr
, bonustype
, sa_build_idx_tab
,
1559 sa_idx_tab_hold(os
, idx_tab
); /* one hold for consumer */
1560 sa_idx_tab_hold(os
, idx_tab
); /* one for layout */
1561 list_insert_tail(&tb
->lot_idx_tab
, idx_tab
);
1566 sa_default_locator(void **dataptr
, uint32_t *len
, uint32_t total_len
,
1567 boolean_t start
, void *userdata
)
1571 *dataptr
= userdata
;
1576 sa_attr_register_sync(sa_handle_t
*hdl
, dmu_tx_t
*tx
)
1578 uint64_t attr_value
= 0;
1579 sa_os_t
*sa
= hdl
->sa_os
->os_sa
;
1580 sa_attr_table_t
*tb
= sa
->sa_attr_table
;
1583 mutex_enter(&sa
->sa_lock
);
1585 if (!sa
->sa_need_attr_registration
|| sa
->sa_master_obj
== 0) {
1586 mutex_exit(&sa
->sa_lock
);
1590 if (sa
->sa_reg_attr_obj
== 0) {
1591 sa
->sa_reg_attr_obj
= zap_create_link(hdl
->sa_os
,
1592 DMU_OT_SA_ATTR_REGISTRATION
,
1593 sa
->sa_master_obj
, SA_REGISTRY
, tx
);
1595 for (i
= 0; i
!= sa
->sa_num_attrs
; i
++) {
1596 if (sa
->sa_attr_table
[i
].sa_registered
)
1598 ATTR_ENCODE(attr_value
, tb
[i
].sa_attr
, tb
[i
].sa_length
,
1600 VERIFY(0 == zap_update(hdl
->sa_os
, sa
->sa_reg_attr_obj
,
1601 tb
[i
].sa_name
, 8, 1, &attr_value
, tx
));
1602 tb
[i
].sa_registered
= B_TRUE
;
1604 sa
->sa_need_attr_registration
= B_FALSE
;
1605 mutex_exit(&sa
->sa_lock
);
1609 * Replace all attributes with attributes specified in template.
1610 * If dnode had a spill buffer then those attributes will be
1611 * also be replaced, possibly with just an empty spill block
1613 * This interface is intended to only be used for bulk adding of
1614 * attributes for a new file. It will also be used by the ZPL
1615 * when converting and old formatted znode to native SA support.
1618 sa_replace_all_by_template_locked(sa_handle_t
*hdl
, sa_bulk_attr_t
*attr_desc
,
1619 int attr_count
, dmu_tx_t
*tx
)
1621 sa_os_t
*sa
= hdl
->sa_os
->os_sa
;
1623 if (sa
->sa_need_attr_registration
)
1624 sa_attr_register_sync(hdl
, tx
);
1625 return (sa_build_layouts(hdl
, attr_desc
, attr_count
, tx
));
1629 sa_replace_all_by_template(sa_handle_t
*hdl
, sa_bulk_attr_t
*attr_desc
,
1630 int attr_count
, dmu_tx_t
*tx
)
1634 mutex_enter(&hdl
->sa_lock
);
1635 error
= sa_replace_all_by_template_locked(hdl
, attr_desc
,
1637 mutex_exit(&hdl
->sa_lock
);
1642 * add/remove/replace a single attribute and then rewrite the entire set
1646 sa_modify_attrs(sa_handle_t
*hdl
, sa_attr_type_t newattr
,
1647 sa_data_op_t action
, sa_data_locator_t
*locator
, void *datastart
,
1648 uint16_t buflen
, dmu_tx_t
*tx
)
1650 sa_os_t
*sa
= hdl
->sa_os
->os_sa
;
1651 dmu_buf_impl_t
*db
= (dmu_buf_impl_t
*)hdl
->sa_bonus
;
1653 sa_bulk_attr_t
*attr_desc
;
1655 int bonus_attr_count
= 0;
1656 int bonus_data_size
= 0;
1657 int spill_data_size
= 0;
1658 int spill_attr_count
= 0;
1661 int i
, j
, k
, length_idx
;
1663 sa_idx_tab_t
*idx_tab
;
1667 ASSERT(MUTEX_HELD(&hdl
->sa_lock
));
1669 /* First make of copy of the old data */
1673 if (dn
->dn_bonuslen
!= 0) {
1674 bonus_data_size
= hdl
->sa_bonus
->db_size
;
1675 old_data
[0] = kmem_alloc(bonus_data_size
, KM_SLEEP
);
1676 bcopy(hdl
->sa_bonus
->db_data
, old_data
[0],
1677 hdl
->sa_bonus
->db_size
);
1678 bonus_attr_count
= hdl
->sa_bonus_tab
->sa_layout
->lot_attr_count
;
1684 /* Bring spill buffer online if it isn't currently */
1686 if ((error
= sa_get_spill(hdl
)) == 0) {
1687 spill_data_size
= hdl
->sa_spill
->db_size
;
1688 old_data
[1] = zio_buf_alloc(spill_data_size
);
1689 bcopy(hdl
->sa_spill
->db_data
, old_data
[1],
1690 hdl
->sa_spill
->db_size
);
1692 hdl
->sa_spill_tab
->sa_layout
->lot_attr_count
;
1693 } else if (error
&& error
!= ENOENT
) {
1695 kmem_free(old_data
[0], bonus_data_size
);
1701 /* build descriptor of all attributes */
1703 attr_count
= bonus_attr_count
+ spill_attr_count
;
1704 if (action
== SA_ADD
)
1706 else if (action
== SA_REMOVE
)
1709 attr_desc
= kmem_zalloc(sizeof (sa_bulk_attr_t
) * attr_count
, KM_SLEEP
);
1712 * loop through bonus and spill buffer if it exists, and
1713 * build up new attr_descriptor to reset the attributes
1716 count
= bonus_attr_count
;
1717 hdr
= SA_GET_HDR(hdl
, SA_BONUS
);
1718 idx_tab
= SA_IDX_TAB_GET(hdl
, SA_BONUS
);
1719 for (; k
!= 2; k
++) {
1721 * Iterate over each attribute in layout. Fetch the
1722 * size of variable-length attributes needing rewrite
1723 * from sa_lengths[].
1725 for (i
= 0, length_idx
= 0; i
!= count
; i
++) {
1726 sa_attr_type_t attr
;
1728 attr
= idx_tab
->sa_layout
->lot_attrs
[i
];
1729 length
= SA_REGISTERED_LEN(sa
, attr
);
1730 if (attr
== newattr
) {
1733 if (action
== SA_REMOVE
) {
1737 ASSERT(length
== 0);
1738 ASSERT(action
== SA_REPLACE
);
1739 SA_ADD_BULK_ATTR(attr_desc
, j
, attr
,
1740 locator
, datastart
, buflen
);
1743 length
= hdr
->sa_lengths
[length_idx
++];
1745 SA_ADD_BULK_ATTR(attr_desc
, j
, attr
,
1747 (TOC_OFF(idx_tab
->sa_idx_tab
[attr
]) +
1748 (uintptr_t)old_data
[k
]), length
);
1751 if (k
== 0 && hdl
->sa_spill
) {
1752 hdr
= SA_GET_HDR(hdl
, SA_SPILL
);
1753 idx_tab
= SA_IDX_TAB_GET(hdl
, SA_SPILL
);
1754 count
= spill_attr_count
;
1759 if (action
== SA_ADD
) {
1760 length
= SA_REGISTERED_LEN(sa
, newattr
);
1764 SA_ADD_BULK_ATTR(attr_desc
, j
, newattr
, locator
,
1768 error
= sa_build_layouts(hdl
, attr_desc
, attr_count
, tx
);
1771 kmem_free(old_data
[0], bonus_data_size
);
1773 zio_buf_free(old_data
[1], spill_data_size
);
1774 kmem_free(attr_desc
, sizeof (sa_bulk_attr_t
) * attr_count
);
1780 sa_bulk_update_impl(sa_handle_t
*hdl
, sa_bulk_attr_t
*bulk
, int count
,
1784 sa_os_t
*sa
= hdl
->sa_os
->os_sa
;
1785 dmu_object_type_t bonustype
;
1786 dmu_buf_t
*saved_spill
;
1789 ASSERT(MUTEX_HELD(&hdl
->sa_lock
));
1791 bonustype
= SA_BONUSTYPE_FROM_DB(SA_GET_DB(hdl
, SA_BONUS
));
1792 saved_spill
= hdl
->sa_spill
;
1794 /* sync out registration table if necessary */
1795 if (sa
->sa_need_attr_registration
)
1796 sa_attr_register_sync(hdl
, tx
);
1798 error
= sa_attr_op(hdl
, bulk
, count
, SA_UPDATE
, tx
);
1799 if (error
== 0 && !IS_SA_BONUSTYPE(bonustype
) && sa
->sa_update_cb
)
1800 sa
->sa_update_cb(hdl
, tx
);
1803 * If saved_spill is NULL and current sa_spill is not NULL that
1804 * means we increased the refcount of the spill buffer through
1805 * sa_get_spill() or dmu_spill_hold_by_dnode(). Therefore we
1806 * must release the hold before calling dmu_tx_commit() to avoid
1807 * making a copy of this buffer in dbuf_sync_leaf() due to the
1808 * reference count now being greater than 1.
1810 if (!saved_spill
&& hdl
->sa_spill
) {
1811 if (hdl
->sa_spill_tab
) {
1812 sa_idx_tab_rele(hdl
->sa_os
, hdl
->sa_spill_tab
);
1813 hdl
->sa_spill_tab
= NULL
;
1816 dmu_buf_rele((dmu_buf_t
*)hdl
->sa_spill
, NULL
);
1817 hdl
->sa_spill
= NULL
;
1824 * update or add new attribute
1827 sa_update(sa_handle_t
*hdl
, sa_attr_type_t type
,
1828 void *buf
, uint32_t buflen
, dmu_tx_t
*tx
)
1831 sa_bulk_attr_t bulk
;
1833 bulk
.sa_attr
= type
;
1834 bulk
.sa_data_func
= NULL
;
1835 bulk
.sa_length
= buflen
;
1838 mutex_enter(&hdl
->sa_lock
);
1839 error
= sa_bulk_update_impl(hdl
, &bulk
, 1, tx
);
1840 mutex_exit(&hdl
->sa_lock
);
1845 sa_update_from_cb(sa_handle_t
*hdl
, sa_attr_type_t attr
,
1846 uint32_t buflen
, sa_data_locator_t
*locator
, void *userdata
, dmu_tx_t
*tx
)
1849 sa_bulk_attr_t bulk
;
1851 bulk
.sa_attr
= attr
;
1852 bulk
.sa_data
= userdata
;
1853 bulk
.sa_data_func
= locator
;
1854 bulk
.sa_length
= buflen
;
1856 mutex_enter(&hdl
->sa_lock
);
1857 error
= sa_bulk_update_impl(hdl
, &bulk
, 1, tx
);
1858 mutex_exit(&hdl
->sa_lock
);
1863 * Return size of an attribute
1867 sa_size(sa_handle_t
*hdl
, sa_attr_type_t attr
, int *size
)
1869 sa_bulk_attr_t bulk
;
1872 bulk
.sa_data
= NULL
;
1873 bulk
.sa_attr
= attr
;
1874 bulk
.sa_data_func
= NULL
;
1877 mutex_enter(&hdl
->sa_lock
);
1878 if ((error
= sa_attr_op(hdl
, &bulk
, 1, SA_LOOKUP
, NULL
)) != 0) {
1879 mutex_exit(&hdl
->sa_lock
);
1882 *size
= bulk
.sa_size
;
1884 mutex_exit(&hdl
->sa_lock
);
1889 sa_bulk_lookup_locked(sa_handle_t
*hdl
, sa_bulk_attr_t
*attrs
, int count
)
1892 ASSERT(MUTEX_HELD(&hdl
->sa_lock
));
1893 return (sa_lookup_impl(hdl
, attrs
, count
));
1897 sa_bulk_lookup(sa_handle_t
*hdl
, sa_bulk_attr_t
*attrs
, int count
)
1902 mutex_enter(&hdl
->sa_lock
);
1903 error
= sa_bulk_lookup_locked(hdl
, attrs
, count
);
1904 mutex_exit(&hdl
->sa_lock
);
1909 sa_bulk_update(sa_handle_t
*hdl
, sa_bulk_attr_t
*attrs
, int count
, dmu_tx_t
*tx
)
1914 mutex_enter(&hdl
->sa_lock
);
1915 error
= sa_bulk_update_impl(hdl
, attrs
, count
, tx
);
1916 mutex_exit(&hdl
->sa_lock
);
1921 sa_remove(sa_handle_t
*hdl
, sa_attr_type_t attr
, dmu_tx_t
*tx
)
1925 mutex_enter(&hdl
->sa_lock
);
1926 error
= sa_modify_attrs(hdl
, attr
, SA_REMOVE
, NULL
,
1928 mutex_exit(&hdl
->sa_lock
);
1933 sa_object_info(sa_handle_t
*hdl
, dmu_object_info_t
*doi
)
1935 dmu_object_info_from_db((dmu_buf_t
*)hdl
->sa_bonus
, doi
);
1939 sa_object_size(sa_handle_t
*hdl
, uint32_t *blksize
, u_longlong_t
*nblocks
)
1941 dmu_object_size_from_db((dmu_buf_t
*)hdl
->sa_bonus
,
1946 sa_update_user(sa_handle_t
*newhdl
, sa_handle_t
*oldhdl
)
1948 (void) dmu_buf_update_user((dmu_buf_t
*)newhdl
->sa_bonus
,
1949 oldhdl
, newhdl
, NULL
, sa_evict
);
1950 oldhdl
->sa_bonus
= NULL
;
1954 sa_set_userp(sa_handle_t
*hdl
, void *ptr
)
1956 hdl
->sa_userp
= ptr
;
1960 sa_get_db(sa_handle_t
*hdl
)
1962 return ((dmu_buf_t
*)hdl
->sa_bonus
);
1966 sa_get_userdata(sa_handle_t
*hdl
)
1968 return (hdl
->sa_userp
);
1972 sa_register_update_callback_locked(objset_t
*os
, sa_update_cb_t
*func
)
1974 ASSERT(MUTEX_HELD(&os
->os_sa
->sa_lock
));
1975 os
->os_sa
->sa_update_cb
= func
;
1979 sa_register_update_callback(objset_t
*os
, sa_update_cb_t
*func
)
1982 mutex_enter(&os
->os_sa
->sa_lock
);
1983 sa_register_update_callback_locked(os
, func
);
1984 mutex_exit(&os
->os_sa
->sa_lock
);
1988 sa_handle_object(sa_handle_t
*hdl
)
1990 return (hdl
->sa_bonus
->db_object
);
1994 sa_enabled(objset_t
*os
)
1996 return (os
->os_sa
== NULL
);
2000 sa_set_sa_object(objset_t
*os
, uint64_t sa_object
)
2002 sa_os_t
*sa
= os
->os_sa
;
2004 if (sa
->sa_master_obj
)
2007 sa
->sa_master_obj
= sa_object
;
2013 sa_hdrsize(void *arg
)
2015 sa_hdr_phys_t
*hdr
= arg
;
2017 return (SA_HDR_SIZE(hdr
));
2021 sa_handle_lock(sa_handle_t
*hdl
)
2024 mutex_enter(&hdl
->sa_lock
);
2028 sa_handle_unlock(sa_handle_t
*hdl
)
2031 mutex_exit(&hdl
->sa_lock
);
2035 EXPORT_SYMBOL(sa_handle_get
);
2036 EXPORT_SYMBOL(sa_handle_get_from_db
);
2037 EXPORT_SYMBOL(sa_handle_destroy
);
2038 EXPORT_SYMBOL(sa_buf_hold
);
2039 EXPORT_SYMBOL(sa_buf_rele
);
2040 EXPORT_SYMBOL(sa_spill_rele
);
2041 EXPORT_SYMBOL(sa_lookup
);
2042 EXPORT_SYMBOL(sa_update
);
2043 EXPORT_SYMBOL(sa_remove
);
2044 EXPORT_SYMBOL(sa_bulk_lookup
);
2045 EXPORT_SYMBOL(sa_bulk_lookup_locked
);
2046 EXPORT_SYMBOL(sa_bulk_update
);
2047 EXPORT_SYMBOL(sa_size
);
2048 EXPORT_SYMBOL(sa_update_from_cb
);
2049 EXPORT_SYMBOL(sa_object_info
);
2050 EXPORT_SYMBOL(sa_object_size
);
2051 EXPORT_SYMBOL(sa_update_user
);
2052 EXPORT_SYMBOL(sa_get_userdata
);
2053 EXPORT_SYMBOL(sa_set_userp
);
2054 EXPORT_SYMBOL(sa_get_db
);
2055 EXPORT_SYMBOL(sa_handle_object
);
2056 EXPORT_SYMBOL(sa_register_update_callback
);
2057 EXPORT_SYMBOL(sa_setup
);
2058 EXPORT_SYMBOL(sa_replace_all_by_template
);
2059 EXPORT_SYMBOL(sa_replace_all_by_template_locked
);
2060 EXPORT_SYMBOL(sa_enabled
);
2061 EXPORT_SYMBOL(sa_cache_init
);
2062 EXPORT_SYMBOL(sa_cache_fini
);
2063 EXPORT_SYMBOL(sa_set_sa_object
);
2064 EXPORT_SYMBOL(sa_hdrsize
);
2065 EXPORT_SYMBOL(sa_handle_lock
);
2066 EXPORT_SYMBOL(sa_handle_unlock
);
2067 EXPORT_SYMBOL(sa_lookup_uio
);
2068 #endif /* _KERNEL */