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"
19 #include "xfs_attr_sf.h"
20 #include "xfs_attr_leaf.h"
21 #include "xfs_error.h"
22 #include "xfs_trace.h"
26 xfs_attr_shortform_compare(const void *a, const void *b)
28 xfs_attr_sf_sort_t *sa, *sb;
30 sa = (xfs_attr_sf_sort_t *)a;
31 sb = (xfs_attr_sf_sort_t *)b;
32 if (sa->hash < sb->hash) {
34 } else if (sa->hash > sb->hash) {
37 return sa->entno - sb->entno;
41 #define XFS_ISRESET_CURSOR(cursor) \
42 (!((cursor)->initted) && !((cursor)->hashval) && \
43 !((cursor)->blkno) && !((cursor)->offset))
45 * Copy out entries of shortform attribute lists for attr_list().
46 * Shortform attribute lists are not stored in hashval sorted order.
47 * If the output buffer is not large enough to hold them all, then
48 * we have to calculate each entries' hashvalue and sort them before
49 * we can begin returning them to the user.
52 xfs_attr_shortform_list(
53 struct xfs_attr_list_context *context)
55 struct xfs_attrlist_cursor_kern *cursor = &context->cursor;
56 struct xfs_inode *dp = context->dp;
57 struct xfs_attr_sf_sort *sbuf, *sbp;
58 struct xfs_attr_shortform *sf;
59 struct xfs_attr_sf_entry *sfe;
60 int sbsize, nsbuf, count, i;
63 ASSERT(dp->i_afp != NULL);
64 sf = (struct xfs_attr_shortform *)dp->i_afp->if_u1.if_data;
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_afp->if_bytes + sf->hdr.count * 16) < context->bufsize)) {
83 for (i = 0, sfe = &sf->list[0]; i < sf->hdr.count; i++) {
84 if (XFS_IS_CORRUPT(context->dp->i_mount,
85 !xfs_attr_namecheck(sfe->nameval,
88 context->put_listent(context,
94 * Either search callback finished early or
95 * didn't fit it all in the buffer after all.
97 if (context->seen_enough)
99 sfe = xfs_attr_sf_nextentry(sfe);
101 trace_xfs_attr_list_sf_all(context);
105 /* do no more for a search callback */
106 if (context->bufsize == 0)
110 * It didn't all fit, so we have to sort everything on hashval.
112 sbsize = sf->hdr.count * sizeof(*sbuf);
113 sbp = sbuf = kmem_alloc(sbsize, KM_NOFS);
116 * Scan the attribute list for the rest of the entries, storing
117 * the relevant info from only those that match into a buffer.
120 for (i = 0, sfe = &sf->list[0]; i < sf->hdr.count; i++) {
122 ((char *)sfe < (char *)sf) ||
123 ((char *)sfe >= ((char *)sf + dp->i_afp->if_bytes)))) {
124 XFS_CORRUPTION_ERROR("xfs_attr_shortform_list",
126 context->dp->i_mount, sfe,
129 return -EFSCORRUPTED;
133 sbp->hash = xfs_da_hashname(sfe->nameval, sfe->namelen);
134 sbp->name = sfe->nameval;
135 sbp->namelen = sfe->namelen;
136 /* These are bytes, and both on-disk, don't endian-flip */
137 sbp->valuelen = sfe->valuelen;
138 sbp->flags = sfe->flags;
139 sfe = xfs_attr_sf_nextentry(sfe);
145 * Sort the entries on hash then entno.
147 xfs_sort(sbuf, nsbuf, sizeof(*sbuf), xfs_attr_shortform_compare);
150 * Re-find our place IN THE SORTED LIST.
155 for (sbp = sbuf, i = 0; i < nsbuf; i++, sbp++) {
156 if (sbp->hash == cursor->hashval) {
157 if (cursor->offset == count) {
161 } else if (sbp->hash > cursor->hashval) {
169 * Loop putting entries into the user buffer.
171 for ( ; i < nsbuf; i++, sbp++) {
172 if (cursor->hashval != sbp->hash) {
173 cursor->hashval = sbp->hash;
176 if (XFS_IS_CORRUPT(context->dp->i_mount,
177 !xfs_attr_namecheck(sbp->name,
179 error = -EFSCORRUPTED;
182 context->put_listent(context,
187 if (context->seen_enough)
197 * We didn't find the block & hash mentioned in the cursor state, so
198 * walk down the attr btree looking for the hash.
201 xfs_attr_node_list_lookup(
202 struct xfs_attr_list_context *context,
203 struct xfs_attrlist_cursor_kern *cursor,
204 struct xfs_buf **pbp)
206 struct xfs_da3_icnode_hdr nodehdr;
207 struct xfs_da_intnode *node;
208 struct xfs_da_node_entry *btree;
209 struct xfs_inode *dp = context->dp;
210 struct xfs_mount *mp = dp->i_mount;
211 struct xfs_trans *tp = context->tp;
215 unsigned int expected_level = 0;
218 ASSERT(*pbp == NULL);
221 error = xfs_da3_node_read(tp, dp, cursor->blkno, &bp,
226 magic = be16_to_cpu(node->hdr.info.magic);
227 if (magic == XFS_ATTR_LEAF_MAGIC ||
228 magic == XFS_ATTR3_LEAF_MAGIC)
230 if (magic != XFS_DA_NODE_MAGIC &&
231 magic != XFS_DA3_NODE_MAGIC) {
232 XFS_CORRUPTION_ERROR(__func__, XFS_ERRLEVEL_LOW, mp,
233 node, sizeof(*node));
237 xfs_da3_node_hdr_from_disk(mp, &nodehdr, node);
239 /* Tree taller than we can handle; bail out! */
240 if (nodehdr.level >= XFS_DA_NODE_MAXDEPTH)
243 /* Check the level from the root node. */
244 if (cursor->blkno == 0)
245 expected_level = nodehdr.level - 1;
246 else if (expected_level != nodehdr.level)
251 btree = nodehdr.btree;
252 for (i = 0; i < nodehdr.count; btree++, i++) {
253 if (cursor->hashval <= be32_to_cpu(btree->hashval)) {
254 cursor->blkno = be32_to_cpu(btree->before);
255 trace_xfs_attr_list_node_descend(context,
260 xfs_trans_brelse(tp, bp);
262 if (i == nodehdr.count)
265 /* We can't point back to the root. */
266 if (XFS_IS_CORRUPT(mp, cursor->blkno == 0))
267 return -EFSCORRUPTED;
270 if (expected_level != 0)
277 xfs_buf_mark_corrupt(bp);
278 xfs_trans_brelse(tp, bp);
279 return -EFSCORRUPTED;
284 struct xfs_attr_list_context *context)
286 struct xfs_attrlist_cursor_kern *cursor = &context->cursor;
287 struct xfs_attr3_icleaf_hdr leafhdr;
288 struct xfs_attr_leafblock *leaf;
289 struct xfs_da_intnode *node;
291 struct xfs_inode *dp = context->dp;
292 struct xfs_mount *mp = dp->i_mount;
295 trace_xfs_attr_node_list(context);
300 * Do all sorts of validation on the passed-in cursor structure.
301 * If anything is amiss, ignore the cursor and look up the hashval
302 * starting from the btree root.
305 if (cursor->blkno > 0) {
306 error = xfs_da3_node_read(context->tp, dp, cursor->blkno, &bp,
308 if ((error != 0) && (error != -EFSCORRUPTED))
311 struct xfs_attr_leaf_entry *entries;
314 switch (be16_to_cpu(node->hdr.info.magic)) {
315 case XFS_DA_NODE_MAGIC:
316 case XFS_DA3_NODE_MAGIC:
317 trace_xfs_attr_list_wrong_blk(context);
318 xfs_trans_brelse(context->tp, bp);
321 case XFS_ATTR_LEAF_MAGIC:
322 case XFS_ATTR3_LEAF_MAGIC:
324 xfs_attr3_leaf_hdr_from_disk(mp->m_attr_geo,
326 entries = xfs_attr3_leaf_entryp(leaf);
327 if (cursor->hashval > be32_to_cpu(
328 entries[leafhdr.count - 1].hashval)) {
329 trace_xfs_attr_list_wrong_blk(context);
330 xfs_trans_brelse(context->tp, bp);
332 } else if (cursor->hashval <= be32_to_cpu(
333 entries[0].hashval)) {
334 trace_xfs_attr_list_wrong_blk(context);
335 xfs_trans_brelse(context->tp, bp);
340 trace_xfs_attr_list_wrong_blk(context);
341 xfs_trans_brelse(context->tp, bp);
348 * We did not find what we expected given the cursor's contents,
349 * so we start from the top and work down based on the hash value.
350 * Note that start of node block is same as start of leaf block.
353 error = xfs_attr_node_list_lookup(context, cursor, &bp);
360 * Roll upward through the blocks, processing each leaf block in
361 * order. As long as there is space in the result buffer, keep
362 * adding the information.
366 error = xfs_attr3_leaf_list_int(bp, context);
369 xfs_attr3_leaf_hdr_from_disk(mp->m_attr_geo, &leafhdr, leaf);
370 if (context->seen_enough || leafhdr.forw == 0)
372 cursor->blkno = leafhdr.forw;
373 xfs_trans_brelse(context->tp, bp);
374 error = xfs_attr3_leaf_read(context->tp, dp, cursor->blkno,
379 xfs_trans_brelse(context->tp, bp);
384 * Copy out attribute list entries for attr_list(), for leaf attribute lists.
387 xfs_attr3_leaf_list_int(
389 struct xfs_attr_list_context *context)
391 struct xfs_attrlist_cursor_kern *cursor = &context->cursor;
392 struct xfs_attr_leafblock *leaf;
393 struct xfs_attr3_icleaf_hdr ichdr;
394 struct xfs_attr_leaf_entry *entries;
395 struct xfs_attr_leaf_entry *entry;
397 struct xfs_mount *mp = context->dp->i_mount;
399 trace_xfs_attr_list_leaf(context);
402 xfs_attr3_leaf_hdr_from_disk(mp->m_attr_geo, &ichdr, leaf);
403 entries = xfs_attr3_leaf_entryp(leaf);
408 * Re-find our place in the leaf block if this is a new syscall.
410 if (context->resynch) {
412 for (i = 0; i < ichdr.count; entry++, i++) {
413 if (be32_to_cpu(entry->hashval) == cursor->hashval) {
414 if (cursor->offset == context->dupcnt) {
419 } else if (be32_to_cpu(entry->hashval) >
425 if (i == ichdr.count) {
426 trace_xfs_attr_list_notfound(context);
433 context->resynch = 0;
436 * We have found our place, start copying out the new attributes.
438 for (; i < ichdr.count; entry++, i++) {
440 int namelen, valuelen;
442 if (be32_to_cpu(entry->hashval) != cursor->hashval) {
443 cursor->hashval = be32_to_cpu(entry->hashval);
447 if ((entry->flags & XFS_ATTR_INCOMPLETE) &&
448 !context->allow_incomplete)
451 if (entry->flags & XFS_ATTR_LOCAL) {
452 xfs_attr_leaf_name_local_t *name_loc;
454 name_loc = xfs_attr3_leaf_name_local(leaf, i);
455 name = name_loc->nameval;
456 namelen = name_loc->namelen;
457 valuelen = be16_to_cpu(name_loc->valuelen);
459 xfs_attr_leaf_name_remote_t *name_rmt;
461 name_rmt = xfs_attr3_leaf_name_remote(leaf, i);
462 name = name_rmt->name;
463 namelen = name_rmt->namelen;
464 valuelen = be32_to_cpu(name_rmt->valuelen);
467 if (XFS_IS_CORRUPT(context->dp->i_mount,
468 !xfs_attr_namecheck(name, namelen)))
469 return -EFSCORRUPTED;
470 context->put_listent(context, entry->flags,
471 name, namelen, valuelen);
472 if (context->seen_enough)
476 trace_xfs_attr_list_leaf_end(context);
481 * Copy out attribute entries for attr_list(), for leaf attribute lists.
485 struct xfs_attr_list_context *context)
490 trace_xfs_attr_leaf_list(context);
492 context->cursor.blkno = 0;
493 error = xfs_attr3_leaf_read(context->tp, context->dp, 0, &bp);
497 error = xfs_attr3_leaf_list_int(bp, context);
498 xfs_trans_brelse(context->tp, bp);
503 xfs_attr_list_ilocked(
504 struct xfs_attr_list_context *context)
506 struct xfs_inode *dp = context->dp;
508 ASSERT(xfs_isilocked(dp, XFS_ILOCK_SHARED | XFS_ILOCK_EXCL));
511 * Decide on what work routines to call based on the inode size.
513 if (!xfs_inode_hasattr(dp))
515 if (dp->i_afp->if_format == XFS_DINODE_FMT_LOCAL)
516 return xfs_attr_shortform_list(context);
517 if (xfs_attr_is_leaf(dp))
518 return xfs_attr_leaf_list(context);
519 return xfs_attr_node_list(context);
524 struct xfs_attr_list_context *context)
526 struct xfs_inode *dp = context->dp;
530 XFS_STATS_INC(dp->i_mount, xs_attr_list);
532 if (xfs_is_shutdown(dp->i_mount))
535 lock_mode = xfs_ilock_attr_map_shared(dp);
536 error = xfs_attr_list_ilocked(context);
537 xfs_iunlock(dp, lock_mode);