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, GFP_KERNEL | __GFP_NOFAIL);
120 * Scan the attribute list for the rest of the entries, storing
121 * the relevant info from only those that match into a buffer.
124 for (i = 0, sfe = xfs_attr_sf_firstentry(sf); i < sf->count; i++) {
126 ((char *)sfe < (char *)sf) ||
127 ((char *)sfe >= ((char *)sf + dp->i_af.if_bytes)) ||
128 !xfs_attr_check_namespace(sfe->flags))) {
129 XFS_CORRUPTION_ERROR("xfs_attr_shortform_list",
131 context->dp->i_mount, sfe,
134 xfs_dirattr_mark_sick(dp, XFS_ATTR_FORK);
135 return -EFSCORRUPTED;
139 sbp->name = sfe->nameval;
140 sbp->namelen = sfe->namelen;
141 /* These are bytes, and both on-disk, don't endian-flip */
142 sbp->value = &sfe->nameval[sfe->namelen];
143 sbp->valuelen = sfe->valuelen;
144 sbp->flags = sfe->flags;
145 sbp->hash = xfs_attr_hashval(dp->i_mount, sfe->flags,
146 sfe->nameval, sfe->namelen,
147 sfe->nameval + sfe->namelen,
149 sfe = xfs_attr_sf_nextentry(sfe);
155 * Sort the entries on hash then entno.
157 xfs_sort(sbuf, nsbuf, sizeof(*sbuf), xfs_attr_shortform_compare);
160 * Re-find our place IN THE SORTED LIST.
165 for (sbp = sbuf, i = 0; i < nsbuf; i++, sbp++) {
166 if (sbp->hash == cursor->hashval) {
167 if (cursor->offset == count) {
171 } else if (sbp->hash > cursor->hashval) {
179 * Loop putting entries into the user buffer.
181 for ( ; i < nsbuf; i++, sbp++) {
182 if (cursor->hashval != sbp->hash) {
183 cursor->hashval = sbp->hash;
186 if (XFS_IS_CORRUPT(context->dp->i_mount,
187 !xfs_attr_namecheck(sbp->flags, sbp->name,
189 xfs_dirattr_mark_sick(context->dp, XFS_ATTR_FORK);
190 error = -EFSCORRUPTED;
193 context->put_listent(context,
199 if (context->seen_enough)
209 * We didn't find the block & hash mentioned in the cursor state, so
210 * walk down the attr btree looking for the hash.
213 xfs_attr_node_list_lookup(
214 struct xfs_attr_list_context *context,
215 struct xfs_attrlist_cursor_kern *cursor,
216 struct xfs_buf **pbp)
218 struct xfs_da3_icnode_hdr nodehdr;
219 struct xfs_da_intnode *node;
220 struct xfs_da_node_entry *btree;
221 struct xfs_inode *dp = context->dp;
222 struct xfs_mount *mp = dp->i_mount;
223 struct xfs_trans *tp = context->tp;
228 unsigned int expected_level = 0;
231 ASSERT(*pbp == NULL);
234 error = xfs_da3_node_read(tp, dp, cursor->blkno, &bp,
239 magic = be16_to_cpu(node->hdr.info.magic);
240 if (magic == XFS_ATTR_LEAF_MAGIC ||
241 magic == XFS_ATTR3_LEAF_MAGIC)
243 if (magic != XFS_DA_NODE_MAGIC &&
244 magic != XFS_DA3_NODE_MAGIC) {
245 XFS_CORRUPTION_ERROR(__func__, XFS_ERRLEVEL_LOW, mp,
246 node, sizeof(*node));
250 fa = xfs_da3_node_header_check(bp, dp->i_ino);
254 xfs_da3_node_hdr_from_disk(mp, &nodehdr, node);
256 /* Tree taller than we can handle; bail out! */
257 if (nodehdr.level >= XFS_DA_NODE_MAXDEPTH)
260 /* Check the level from the root node. */
261 if (cursor->blkno == 0)
262 expected_level = nodehdr.level - 1;
263 else if (expected_level != nodehdr.level)
268 btree = nodehdr.btree;
269 for (i = 0; i < nodehdr.count; btree++, i++) {
270 if (cursor->hashval <= be32_to_cpu(btree->hashval)) {
271 cursor->blkno = be32_to_cpu(btree->before);
272 trace_xfs_attr_list_node_descend(context,
277 xfs_trans_brelse(tp, bp);
279 if (i == nodehdr.count)
282 /* We can't point back to the root. */
283 if (XFS_IS_CORRUPT(mp, cursor->blkno == 0)) {
284 xfs_dirattr_mark_sick(dp, XFS_ATTR_FORK);
285 return -EFSCORRUPTED;
289 fa = xfs_attr3_leaf_header_check(bp, dp->i_ino);
291 __xfs_buf_mark_corrupt(bp, fa);
295 if (expected_level != 0)
302 xfs_buf_mark_corrupt(bp);
304 xfs_trans_brelse(tp, bp);
305 xfs_dirattr_mark_sick(dp, XFS_ATTR_FORK);
306 return -EFSCORRUPTED;
311 struct xfs_attr_list_context *context)
313 struct xfs_attrlist_cursor_kern *cursor = &context->cursor;
314 struct xfs_attr3_icleaf_hdr leafhdr;
315 struct xfs_attr_leafblock *leaf;
316 struct xfs_da_intnode *node;
318 struct xfs_inode *dp = context->dp;
319 struct xfs_mount *mp = dp->i_mount;
323 trace_xfs_attr_node_list(context);
328 * Do all sorts of validation on the passed-in cursor structure.
329 * If anything is amiss, ignore the cursor and look up the hashval
330 * starting from the btree root.
333 if (cursor->blkno > 0) {
334 struct xfs_attr_leaf_entry *entries;
336 error = xfs_da3_node_read(context->tp, dp, cursor->blkno, &bp,
338 if (xfs_metadata_is_sick(error))
339 xfs_dirattr_mark_sick(dp, XFS_ATTR_FORK);
340 if (error != 0 && error != -EFSCORRUPTED)
346 switch (be16_to_cpu(node->hdr.info.magic)) {
347 case XFS_DA_NODE_MAGIC:
348 case XFS_DA3_NODE_MAGIC:
349 trace_xfs_attr_list_wrong_blk(context);
350 fa = xfs_da3_node_header_check(bp, dp->i_ino);
352 __xfs_buf_mark_corrupt(bp, fa);
353 xfs_dirattr_mark_sick(dp, XFS_ATTR_FORK);
355 xfs_trans_brelse(context->tp, bp);
358 case XFS_ATTR_LEAF_MAGIC:
359 case XFS_ATTR3_LEAF_MAGIC:
361 fa = xfs_attr3_leaf_header_check(bp, dp->i_ino);
363 __xfs_buf_mark_corrupt(bp, fa);
364 xfs_trans_brelse(context->tp, bp);
365 xfs_dirattr_mark_sick(dp, XFS_ATTR_FORK);
369 xfs_attr3_leaf_hdr_from_disk(mp->m_attr_geo,
371 entries = xfs_attr3_leaf_entryp(leaf);
372 if (cursor->hashval > be32_to_cpu(
373 entries[leafhdr.count - 1].hashval)) {
374 trace_xfs_attr_list_wrong_blk(context);
375 xfs_trans_brelse(context->tp, bp);
377 } else if (cursor->hashval <= be32_to_cpu(
378 entries[0].hashval)) {
379 trace_xfs_attr_list_wrong_blk(context);
380 xfs_trans_brelse(context->tp, bp);
385 trace_xfs_attr_list_wrong_blk(context);
386 xfs_trans_brelse(context->tp, bp);
392 * We did not find what we expected given the cursor's contents,
393 * so we start from the top and work down based on the hash value.
394 * Note that start of node block is same as start of leaf block.
398 error = xfs_attr_node_list_lookup(context, cursor, &bp);
405 * Roll upward through the blocks, processing each leaf block in
406 * order. As long as there is space in the result buffer, keep
407 * adding the information.
411 error = xfs_attr3_leaf_list_int(bp, context);
414 xfs_attr3_leaf_hdr_from_disk(mp->m_attr_geo, &leafhdr, leaf);
415 if (context->seen_enough || leafhdr.forw == 0)
417 cursor->blkno = leafhdr.forw;
418 xfs_trans_brelse(context->tp, bp);
419 error = xfs_attr3_leaf_read(context->tp, dp, dp->i_ino,
424 xfs_trans_brelse(context->tp, bp);
429 * Copy out attribute list entries for attr_list(), for leaf attribute lists.
432 xfs_attr3_leaf_list_int(
434 struct xfs_attr_list_context *context)
436 struct xfs_attrlist_cursor_kern *cursor = &context->cursor;
437 struct xfs_attr_leafblock *leaf;
438 struct xfs_attr3_icleaf_hdr ichdr;
439 struct xfs_attr_leaf_entry *entries;
440 struct xfs_attr_leaf_entry *entry;
442 struct xfs_mount *mp = context->dp->i_mount;
444 trace_xfs_attr_list_leaf(context);
447 xfs_attr3_leaf_hdr_from_disk(mp->m_attr_geo, &ichdr, leaf);
448 entries = xfs_attr3_leaf_entryp(leaf);
453 * Re-find our place in the leaf block if this is a new syscall.
455 if (context->resynch) {
457 for (i = 0; i < ichdr.count; entry++, i++) {
458 if (be32_to_cpu(entry->hashval) == cursor->hashval) {
459 if (cursor->offset == context->dupcnt) {
464 } else if (be32_to_cpu(entry->hashval) >
470 if (i == ichdr.count) {
471 trace_xfs_attr_list_notfound(context);
478 context->resynch = 0;
481 * We have found our place, start copying out the new attributes.
483 for (; i < ichdr.count; entry++, i++) {
486 int namelen, valuelen;
488 if (be32_to_cpu(entry->hashval) != cursor->hashval) {
489 cursor->hashval = be32_to_cpu(entry->hashval);
493 if ((entry->flags & XFS_ATTR_INCOMPLETE) &&
494 !context->allow_incomplete)
497 if (entry->flags & XFS_ATTR_LOCAL) {
498 xfs_attr_leaf_name_local_t *name_loc;
500 name_loc = xfs_attr3_leaf_name_local(leaf, i);
501 name = name_loc->nameval;
502 namelen = name_loc->namelen;
503 value = &name_loc->nameval[name_loc->namelen];
504 valuelen = be16_to_cpu(name_loc->valuelen);
506 xfs_attr_leaf_name_remote_t *name_rmt;
508 name_rmt = xfs_attr3_leaf_name_remote(leaf, i);
509 name = name_rmt->name;
510 namelen = name_rmt->namelen;
512 valuelen = be32_to_cpu(name_rmt->valuelen);
515 if (XFS_IS_CORRUPT(context->dp->i_mount,
516 !xfs_attr_namecheck(entry->flags, name,
518 xfs_dirattr_mark_sick(context->dp, XFS_ATTR_FORK);
519 return -EFSCORRUPTED;
521 context->put_listent(context, entry->flags,
522 name, namelen, value, valuelen);
523 if (context->seen_enough)
527 trace_xfs_attr_list_leaf_end(context);
532 * Copy out attribute entries for attr_list(), for leaf attribute lists.
536 struct xfs_attr_list_context *context)
541 trace_xfs_attr_leaf_list(context);
543 context->cursor.blkno = 0;
544 error = xfs_attr3_leaf_read(context->tp, context->dp,
545 context->dp->i_ino, 0, &bp);
549 error = xfs_attr3_leaf_list_int(bp, context);
550 xfs_trans_brelse(context->tp, bp);
555 xfs_attr_list_ilocked(
556 struct xfs_attr_list_context *context)
558 struct xfs_inode *dp = context->dp;
561 xfs_assert_ilocked(dp, XFS_ILOCK_SHARED | XFS_ILOCK_EXCL);
564 * Decide on what work routines to call based on the inode size.
566 if (!xfs_inode_hasattr(dp))
568 if (dp->i_af.if_format == XFS_DINODE_FMT_LOCAL)
569 return xfs_attr_shortform_list(context);
571 /* Prerequisite for xfs_attr_is_leaf */
572 error = xfs_iread_extents(NULL, dp, XFS_ATTR_FORK);
576 if (xfs_attr_is_leaf(dp))
577 return xfs_attr_leaf_list(context);
578 return xfs_attr_node_list(context);
583 struct xfs_attr_list_context *context)
585 struct xfs_inode *dp = context->dp;
589 XFS_STATS_INC(dp->i_mount, xs_attr_list);
591 if (xfs_is_shutdown(dp->i_mount))
594 lock_mode = xfs_ilock_attr_map_shared(dp);
595 error = xfs_attr_list_ilocked(context);
596 xfs_iunlock(dp, lock_mode);