1 // SPDX-License-Identifier: GPL-2.0
3 * Copyright (c) 2000-2005 Silicon Graphics, Inc.
4 * Copyright (c) 2013 Red Hat, Inc.
9 #include "xfs_shared.h"
10 #include "xfs_format.h"
11 #include "xfs_log_format.h"
12 #include "xfs_trans_resv.h"
13 #include "xfs_mount.h"
14 #include "xfs_da_format.h"
15 #include "xfs_inode.h"
16 #include "xfs_trans.h"
18 #include "xfs_da_btree.h"
20 #include "xfs_attr_sf.h"
21 #include "xfs_attr_leaf.h"
22 #include "xfs_error.h"
23 #include "xfs_trace.h"
25 #include "xfs_health.h"
28 xfs_attr_shortform_compare(const void *a
, const void *b
)
30 xfs_attr_sf_sort_t
*sa
, *sb
;
32 sa
= (xfs_attr_sf_sort_t
*)a
;
33 sb
= (xfs_attr_sf_sort_t
*)b
;
34 if (sa
->hash
< sb
->hash
) {
36 } else if (sa
->hash
> sb
->hash
) {
39 return sa
->entno
- sb
->entno
;
43 #define XFS_ISRESET_CURSOR(cursor) \
44 (!((cursor)->initted) && !((cursor)->hashval) && \
45 !((cursor)->blkno) && !((cursor)->offset))
47 * Copy out entries of shortform attribute lists for attr_list().
48 * Shortform attribute lists are not stored in hashval sorted order.
49 * If the output buffer is not large enough to hold them all, then
50 * we have to calculate each entries' hashvalue and sort them before
51 * we can begin returning them to the user.
54 xfs_attr_shortform_list(
55 struct xfs_attr_list_context
*context
)
57 struct xfs_attrlist_cursor_kern
*cursor
= &context
->cursor
;
58 struct xfs_inode
*dp
= context
->dp
;
59 struct xfs_attr_sf_sort
*sbuf
, *sbp
;
60 struct xfs_attr_sf_hdr
*sf
= dp
->i_af
.if_data
;
61 struct xfs_attr_sf_entry
*sfe
;
62 int sbsize
, nsbuf
, count
, i
;
69 trace_xfs_attr_list_sf(context
);
72 * If the buffer is large enough and the cursor is at the start,
73 * do not bother with sorting since we will return everything in
74 * one buffer and another call using the cursor won't need to be
76 * Note the generous fudge factor of 16 overhead bytes per entry.
77 * If bufsize is zero then put_listent must be a search function
78 * and can just scan through what we have.
80 if (context
->bufsize
== 0 ||
81 (XFS_ISRESET_CURSOR(cursor
) &&
82 (dp
->i_af
.if_bytes
+ sf
->count
* 16) < context
->bufsize
)) {
83 for (i
= 0, sfe
= xfs_attr_sf_firstentry(sf
); i
< sf
->count
; i
++) {
84 if (XFS_IS_CORRUPT(context
->dp
->i_mount
,
85 !xfs_attr_namecheck(sfe
->flags
,
88 xfs_dirattr_mark_sick(context
->dp
, XFS_ATTR_FORK
);
91 context
->put_listent(context
,
95 &sfe
->nameval
[sfe
->namelen
],
98 * Either search callback finished early or
99 * didn't fit it all in the buffer after all.
101 if (context
->seen_enough
)
103 sfe
= xfs_attr_sf_nextentry(sfe
);
105 trace_xfs_attr_list_sf_all(context
);
109 /* do no more for a search callback */
110 if (context
->bufsize
== 0)
114 * It didn't all fit, so we have to sort everything on hashval.
116 sbsize
= sf
->count
* sizeof(*sbuf
);
117 sbp
= sbuf
= kmalloc(sbsize
,
118 GFP_KERNEL
| __GFP_NOLOCKDEP
| __GFP_NOFAIL
);
121 * Scan the attribute list for the rest of the entries, storing
122 * the relevant info from only those that match into a buffer.
125 for (i
= 0, sfe
= xfs_attr_sf_firstentry(sf
); i
< sf
->count
; i
++) {
127 ((char *)sfe
< (char *)sf
) ||
128 ((char *)sfe
>= ((char *)sf
+ dp
->i_af
.if_bytes
)) ||
129 !xfs_attr_check_namespace(sfe
->flags
))) {
130 XFS_CORRUPTION_ERROR("xfs_attr_shortform_list",
132 context
->dp
->i_mount
, sfe
,
135 xfs_dirattr_mark_sick(dp
, XFS_ATTR_FORK
);
136 return -EFSCORRUPTED
;
140 sbp
->name
= sfe
->nameval
;
141 sbp
->namelen
= sfe
->namelen
;
142 /* These are bytes, and both on-disk, don't endian-flip */
143 sbp
->value
= &sfe
->nameval
[sfe
->namelen
];
144 sbp
->valuelen
= sfe
->valuelen
;
145 sbp
->flags
= sfe
->flags
;
146 sbp
->hash
= xfs_attr_hashval(dp
->i_mount
, sfe
->flags
,
147 sfe
->nameval
, sfe
->namelen
,
148 sfe
->nameval
+ sfe
->namelen
,
150 sfe
= xfs_attr_sf_nextentry(sfe
);
156 * Sort the entries on hash then entno.
158 xfs_sort(sbuf
, nsbuf
, sizeof(*sbuf
), xfs_attr_shortform_compare
);
161 * Re-find our place IN THE SORTED LIST.
166 for (sbp
= sbuf
, i
= 0; i
< nsbuf
; i
++, sbp
++) {
167 if (sbp
->hash
== cursor
->hashval
) {
168 if (cursor
->offset
== count
) {
172 } else if (sbp
->hash
> cursor
->hashval
) {
180 * Loop putting entries into the user buffer.
182 for ( ; i
< nsbuf
; i
++, sbp
++) {
183 if (cursor
->hashval
!= sbp
->hash
) {
184 cursor
->hashval
= sbp
->hash
;
187 if (XFS_IS_CORRUPT(context
->dp
->i_mount
,
188 !xfs_attr_namecheck(sbp
->flags
, sbp
->name
,
190 xfs_dirattr_mark_sick(context
->dp
, XFS_ATTR_FORK
);
191 error
= -EFSCORRUPTED
;
194 context
->put_listent(context
,
200 if (context
->seen_enough
)
210 * We didn't find the block & hash mentioned in the cursor state, so
211 * walk down the attr btree looking for the hash.
214 xfs_attr_node_list_lookup(
215 struct xfs_attr_list_context
*context
,
216 struct xfs_attrlist_cursor_kern
*cursor
,
217 struct xfs_buf
**pbp
)
219 struct xfs_da3_icnode_hdr nodehdr
;
220 struct xfs_da_intnode
*node
;
221 struct xfs_da_node_entry
*btree
;
222 struct xfs_inode
*dp
= context
->dp
;
223 struct xfs_mount
*mp
= dp
->i_mount
;
224 struct xfs_trans
*tp
= context
->tp
;
229 unsigned int expected_level
= 0;
232 ASSERT(*pbp
== NULL
);
235 error
= xfs_da3_node_read(tp
, dp
, cursor
->blkno
, &bp
,
240 magic
= be16_to_cpu(node
->hdr
.info
.magic
);
241 if (magic
== XFS_ATTR_LEAF_MAGIC
||
242 magic
== XFS_ATTR3_LEAF_MAGIC
)
244 if (magic
!= XFS_DA_NODE_MAGIC
&&
245 magic
!= XFS_DA3_NODE_MAGIC
) {
246 XFS_CORRUPTION_ERROR(__func__
, XFS_ERRLEVEL_LOW
, mp
,
247 node
, sizeof(*node
));
251 fa
= xfs_da3_node_header_check(bp
, dp
->i_ino
);
255 xfs_da3_node_hdr_from_disk(mp
, &nodehdr
, node
);
257 /* Tree taller than we can handle; bail out! */
258 if (nodehdr
.level
>= XFS_DA_NODE_MAXDEPTH
)
261 /* Check the level from the root node. */
262 if (cursor
->blkno
== 0)
263 expected_level
= nodehdr
.level
- 1;
264 else if (expected_level
!= nodehdr
.level
)
269 btree
= nodehdr
.btree
;
270 for (i
= 0; i
< nodehdr
.count
; btree
++, i
++) {
271 if (cursor
->hashval
<= be32_to_cpu(btree
->hashval
)) {
272 cursor
->blkno
= be32_to_cpu(btree
->before
);
273 trace_xfs_attr_list_node_descend(context
,
278 xfs_trans_brelse(tp
, bp
);
280 if (i
== nodehdr
.count
)
283 /* We can't point back to the root. */
284 if (XFS_IS_CORRUPT(mp
, cursor
->blkno
== 0)) {
285 xfs_dirattr_mark_sick(dp
, XFS_ATTR_FORK
);
286 return -EFSCORRUPTED
;
290 fa
= xfs_attr3_leaf_header_check(bp
, dp
->i_ino
);
292 __xfs_buf_mark_corrupt(bp
, fa
);
296 if (expected_level
!= 0)
303 xfs_buf_mark_corrupt(bp
);
305 xfs_trans_brelse(tp
, bp
);
306 xfs_dirattr_mark_sick(dp
, XFS_ATTR_FORK
);
307 return -EFSCORRUPTED
;
312 struct xfs_attr_list_context
*context
)
314 struct xfs_attrlist_cursor_kern
*cursor
= &context
->cursor
;
315 struct xfs_attr3_icleaf_hdr leafhdr
;
316 struct xfs_attr_leafblock
*leaf
;
317 struct xfs_da_intnode
*node
;
319 struct xfs_inode
*dp
= context
->dp
;
320 struct xfs_mount
*mp
= dp
->i_mount
;
324 trace_xfs_attr_node_list(context
);
329 * Do all sorts of validation on the passed-in cursor structure.
330 * If anything is amiss, ignore the cursor and look up the hashval
331 * starting from the btree root.
334 if (cursor
->blkno
> 0) {
335 struct xfs_attr_leaf_entry
*entries
;
337 error
= xfs_da3_node_read(context
->tp
, dp
, cursor
->blkno
, &bp
,
339 if (xfs_metadata_is_sick(error
))
340 xfs_dirattr_mark_sick(dp
, XFS_ATTR_FORK
);
341 if (error
!= 0 && error
!= -EFSCORRUPTED
)
347 switch (be16_to_cpu(node
->hdr
.info
.magic
)) {
348 case XFS_DA_NODE_MAGIC
:
349 case XFS_DA3_NODE_MAGIC
:
350 trace_xfs_attr_list_wrong_blk(context
);
351 fa
= xfs_da3_node_header_check(bp
, dp
->i_ino
);
353 __xfs_buf_mark_corrupt(bp
, fa
);
354 xfs_dirattr_mark_sick(dp
, XFS_ATTR_FORK
);
356 xfs_trans_brelse(context
->tp
, bp
);
359 case XFS_ATTR_LEAF_MAGIC
:
360 case XFS_ATTR3_LEAF_MAGIC
:
362 fa
= xfs_attr3_leaf_header_check(bp
, dp
->i_ino
);
364 __xfs_buf_mark_corrupt(bp
, fa
);
365 xfs_trans_brelse(context
->tp
, bp
);
366 xfs_dirattr_mark_sick(dp
, XFS_ATTR_FORK
);
370 xfs_attr3_leaf_hdr_from_disk(mp
->m_attr_geo
,
372 entries
= xfs_attr3_leaf_entryp(leaf
);
373 if (cursor
->hashval
> be32_to_cpu(
374 entries
[leafhdr
.count
- 1].hashval
)) {
375 trace_xfs_attr_list_wrong_blk(context
);
376 xfs_trans_brelse(context
->tp
, bp
);
378 } else if (cursor
->hashval
<= be32_to_cpu(
379 entries
[0].hashval
)) {
380 trace_xfs_attr_list_wrong_blk(context
);
381 xfs_trans_brelse(context
->tp
, bp
);
386 trace_xfs_attr_list_wrong_blk(context
);
387 xfs_trans_brelse(context
->tp
, bp
);
393 * We did not find what we expected given the cursor's contents,
394 * so we start from the top and work down based on the hash value.
395 * Note that start of node block is same as start of leaf block.
399 error
= xfs_attr_node_list_lookup(context
, cursor
, &bp
);
406 * Roll upward through the blocks, processing each leaf block in
407 * order. As long as there is space in the result buffer, keep
408 * adding the information.
412 error
= xfs_attr3_leaf_list_int(bp
, context
);
415 xfs_attr3_leaf_hdr_from_disk(mp
->m_attr_geo
, &leafhdr
, leaf
);
416 if (context
->seen_enough
|| leafhdr
.forw
== 0)
418 cursor
->blkno
= leafhdr
.forw
;
419 xfs_trans_brelse(context
->tp
, bp
);
420 error
= xfs_attr3_leaf_read(context
->tp
, dp
, dp
->i_ino
,
425 xfs_trans_brelse(context
->tp
, bp
);
430 * Copy out attribute list entries for attr_list(), for leaf attribute lists.
433 xfs_attr3_leaf_list_int(
435 struct xfs_attr_list_context
*context
)
437 struct xfs_attrlist_cursor_kern
*cursor
= &context
->cursor
;
438 struct xfs_attr_leafblock
*leaf
;
439 struct xfs_attr3_icleaf_hdr ichdr
;
440 struct xfs_attr_leaf_entry
*entries
;
441 struct xfs_attr_leaf_entry
*entry
;
443 struct xfs_mount
*mp
= context
->dp
->i_mount
;
445 trace_xfs_attr_list_leaf(context
);
448 xfs_attr3_leaf_hdr_from_disk(mp
->m_attr_geo
, &ichdr
, leaf
);
449 entries
= xfs_attr3_leaf_entryp(leaf
);
454 * Re-find our place in the leaf block if this is a new syscall.
456 if (context
->resynch
) {
458 for (i
= 0; i
< ichdr
.count
; entry
++, i
++) {
459 if (be32_to_cpu(entry
->hashval
) == cursor
->hashval
) {
460 if (cursor
->offset
== context
->dupcnt
) {
465 } else if (be32_to_cpu(entry
->hashval
) >
471 if (i
== ichdr
.count
) {
472 trace_xfs_attr_list_notfound(context
);
479 context
->resynch
= 0;
482 * We have found our place, start copying out the new attributes.
484 for (; i
< ichdr
.count
; entry
++, i
++) {
487 int namelen
, valuelen
;
489 if (be32_to_cpu(entry
->hashval
) != cursor
->hashval
) {
490 cursor
->hashval
= be32_to_cpu(entry
->hashval
);
494 if ((entry
->flags
& XFS_ATTR_INCOMPLETE
) &&
495 !context
->allow_incomplete
)
498 if (entry
->flags
& XFS_ATTR_LOCAL
) {
499 xfs_attr_leaf_name_local_t
*name_loc
;
501 name_loc
= xfs_attr3_leaf_name_local(leaf
, i
);
502 name
= name_loc
->nameval
;
503 namelen
= name_loc
->namelen
;
504 value
= &name_loc
->nameval
[name_loc
->namelen
];
505 valuelen
= be16_to_cpu(name_loc
->valuelen
);
507 xfs_attr_leaf_name_remote_t
*name_rmt
;
509 name_rmt
= xfs_attr3_leaf_name_remote(leaf
, i
);
510 name
= name_rmt
->name
;
511 namelen
= name_rmt
->namelen
;
513 valuelen
= be32_to_cpu(name_rmt
->valuelen
);
516 if (XFS_IS_CORRUPT(context
->dp
->i_mount
,
517 !xfs_attr_namecheck(entry
->flags
, name
,
519 xfs_dirattr_mark_sick(context
->dp
, XFS_ATTR_FORK
);
520 return -EFSCORRUPTED
;
522 context
->put_listent(context
, entry
->flags
,
523 name
, namelen
, value
, valuelen
);
524 if (context
->seen_enough
)
528 trace_xfs_attr_list_leaf_end(context
);
533 * Copy out attribute entries for attr_list(), for leaf attribute lists.
537 struct xfs_attr_list_context
*context
)
542 trace_xfs_attr_leaf_list(context
);
544 context
->cursor
.blkno
= 0;
545 error
= xfs_attr3_leaf_read(context
->tp
, context
->dp
,
546 context
->dp
->i_ino
, 0, &bp
);
550 error
= xfs_attr3_leaf_list_int(bp
, context
);
551 xfs_trans_brelse(context
->tp
, bp
);
556 xfs_attr_list_ilocked(
557 struct xfs_attr_list_context
*context
)
559 struct xfs_inode
*dp
= context
->dp
;
562 xfs_assert_ilocked(dp
, XFS_ILOCK_SHARED
| XFS_ILOCK_EXCL
);
565 * Decide on what work routines to call based on the inode size.
567 if (!xfs_inode_hasattr(dp
))
569 if (dp
->i_af
.if_format
== XFS_DINODE_FMT_LOCAL
)
570 return xfs_attr_shortform_list(context
);
572 /* Prerequisite for xfs_attr_is_leaf */
573 error
= xfs_iread_extents(NULL
, dp
, XFS_ATTR_FORK
);
577 if (xfs_attr_is_leaf(dp
))
578 return xfs_attr_leaf_list(context
);
579 return xfs_attr_node_list(context
);
584 struct xfs_attr_list_context
*context
)
586 struct xfs_inode
*dp
= context
->dp
;
590 XFS_STATS_INC(dp
->i_mount
, xs_attr_list
);
592 if (xfs_is_shutdown(dp
->i_mount
))
595 lock_mode
= xfs_ilock_attr_map_shared(dp
);
596 error
= xfs_attr_list_ilocked(context
);
597 xfs_iunlock(dp
, lock_mode
);