1 // SPDX-License-Identifier: GPL-2.0
3 * Copyright (c) 2000-2005 Silicon Graphics, Inc.
8 #include "xfs_shared.h"
9 #include "xfs_format.h"
10 #include "xfs_log_format.h"
11 #include "xfs_trans_resv.h"
12 #include "xfs_mount.h"
13 #include "xfs_defer.h"
14 #include "xfs_da_format.h"
15 #include "xfs_da_btree.h"
16 #include "xfs_attr_sf.h"
17 #include "xfs_inode.h"
18 #include "xfs_trans.h"
20 #include "xfs_bmap_btree.h"
22 #include "xfs_attr_leaf.h"
23 #include "xfs_attr_remote.h"
24 #include "xfs_quota.h"
25 #include "xfs_trans_space.h"
26 #include "xfs_trace.h"
27 #include "xfs_attr_item.h"
28 #include "xfs_xattr.h"
30 struct kmem_cache *xfs_attr_intent_cache;
35 * Provide the external interfaces to manage attribute lists.
38 /*========================================================================
39 * Function prototypes for the kernel.
40 *========================================================================*/
43 * Internal routines when attribute list fits inside the inode.
45 STATIC int xfs_attr_shortform_addname(xfs_da_args_t *args);
48 * Internal routines when attribute list is one block.
50 STATIC int xfs_attr_leaf_get(xfs_da_args_t *args);
51 STATIC int xfs_attr_leaf_removename(xfs_da_args_t *args);
52 STATIC int xfs_attr_leaf_hasname(struct xfs_da_args *args, struct xfs_buf **bp);
53 STATIC int xfs_attr_leaf_try_add(struct xfs_da_args *args);
56 * Internal routines when attribute list is more than one block.
58 STATIC int xfs_attr_node_get(xfs_da_args_t *args);
59 STATIC void xfs_attr_restore_rmt_blk(struct xfs_da_args *args);
60 static int xfs_attr_node_try_addname(struct xfs_attr_intent *attr);
61 STATIC int xfs_attr_node_addname_find_attr(struct xfs_attr_intent *attr);
62 STATIC int xfs_attr_node_remove_attr(struct xfs_attr_intent *attr);
63 STATIC int xfs_attr_node_lookup(struct xfs_da_args *args,
64 struct xfs_da_state *state);
70 if (!xfs_inode_has_attr_fork(ip))
72 if (ip->i_af.if_format == XFS_DINODE_FMT_EXTENTS &&
73 ip->i_af.if_nextents == 0)
79 * Returns true if the there is exactly only block in the attr fork, in which
80 * case the attribute fork consists of a single leaf block entry.
86 struct xfs_ifork *ifp = &ip->i_af;
87 struct xfs_iext_cursor icur;
88 struct xfs_bmbt_irec imap;
90 if (ifp->if_nextents != 1 || ifp->if_format != XFS_DINODE_FMT_EXTENTS)
93 xfs_iext_first(ifp, &icur);
94 xfs_iext_get_extent(ifp, &icur, &imap);
95 return imap.br_startoff == 0 && imap.br_blockcount == 1;
99 * XXX (dchinner): name path state saving and refilling is an optimisation to
100 * avoid needing to look up name entries after rolling transactions removing
101 * remote xattr blocks between the name entry lookup and name entry removal.
102 * This optimisation got sidelined when combining the set and remove state
103 * machines, but the code has been left in place because it is worthwhile to
104 * restore the optimisation once the combined state machine paths have settled.
106 * This comment is a public service announcement to remind Future Dave that he
107 * still needs to restore this code to working order.
111 * Fill in the disk block numbers in the state structure for the buffers
112 * that are attached to the state structure.
113 * This is done so that we can quickly reattach ourselves to those buffers
114 * after some set of transaction commits have released these buffers.
117 xfs_attr_fillstate(xfs_da_state_t *state)
119 xfs_da_state_path_t *path;
120 xfs_da_state_blk_t *blk;
123 trace_xfs_attr_fillstate(state->args);
126 * Roll down the "path" in the state structure, storing the on-disk
127 * block number for those buffers in the "path".
130 ASSERT((path->active >= 0) && (path->active < XFS_DA_NODE_MAXDEPTH));
131 for (blk = path->blk, level = 0; level < path->active; blk++, level++) {
133 blk->disk_blkno = xfs_buf_daddr(blk->bp);
141 * Roll down the "altpath" in the state structure, storing the on-disk
142 * block number for those buffers in the "altpath".
144 path = &state->altpath;
145 ASSERT((path->active >= 0) && (path->active < XFS_DA_NODE_MAXDEPTH));
146 for (blk = path->blk, level = 0; level < path->active; blk++, level++) {
148 blk->disk_blkno = xfs_buf_daddr(blk->bp);
159 * Reattach the buffers to the state structure based on the disk block
160 * numbers stored in the state structure.
161 * This is done after some set of transaction commits have released those
162 * buffers from our grip.
165 xfs_attr_refillstate(xfs_da_state_t *state)
167 xfs_da_state_path_t *path;
168 xfs_da_state_blk_t *blk;
171 trace_xfs_attr_refillstate(state->args);
174 * Roll down the "path" in the state structure, storing the on-disk
175 * block number for those buffers in the "path".
178 ASSERT((path->active >= 0) && (path->active < XFS_DA_NODE_MAXDEPTH));
179 for (blk = path->blk, level = 0; level < path->active; blk++, level++) {
180 if (blk->disk_blkno) {
181 error = xfs_da3_node_read_mapped(state->args->trans,
182 state->args->dp, blk->disk_blkno,
183 &blk->bp, XFS_ATTR_FORK);
192 * Roll down the "altpath" in the state structure, storing the on-disk
193 * block number for those buffers in the "altpath".
195 path = &state->altpath;
196 ASSERT((path->active >= 0) && (path->active < XFS_DA_NODE_MAXDEPTH));
197 for (blk = path->blk, level = 0; level < path->active; blk++, level++) {
198 if (blk->disk_blkno) {
199 error = xfs_da3_node_read_mapped(state->args->trans,
200 state->args->dp, blk->disk_blkno,
201 &blk->bp, XFS_ATTR_FORK);
212 static int xfs_attr_fillstate(xfs_da_state_t *state) { return 0; }
215 /*========================================================================
216 * Overall external interface routines.
217 *========================================================================*/
220 * Retrieve an extended attribute and its value. Must have ilock.
221 * Returns 0 on successful retrieval, otherwise an error.
224 xfs_attr_get_ilocked(
225 struct xfs_da_args *args)
227 ASSERT(xfs_isilocked(args->dp, XFS_ILOCK_SHARED | XFS_ILOCK_EXCL));
229 if (!xfs_inode_hasattr(args->dp))
232 if (args->dp->i_af.if_format == XFS_DINODE_FMT_LOCAL)
233 return xfs_attr_shortform_getvalue(args);
234 if (xfs_attr_is_leaf(args->dp))
235 return xfs_attr_leaf_get(args);
236 return xfs_attr_node_get(args);
240 * Retrieve an extended attribute by name, and its value if requested.
242 * If args->valuelen is zero, then the caller does not want the value, just an
243 * indication whether the attribute exists and the size of the value if it
244 * exists. The size is returned in args.valuelen.
246 * If args->value is NULL but args->valuelen is non-zero, allocate the buffer
247 * for the value after existence of the attribute has been determined. The
248 * caller always has to free args->value if it is set, no matter if this
249 * function was successful or not.
251 * If the attribute is found, but exceeds the size limit set by the caller in
252 * args->valuelen, return -ERANGE with the size of the attribute that was found
257 struct xfs_da_args *args)
262 XFS_STATS_INC(args->dp->i_mount, xs_attr_get);
264 if (xfs_is_shutdown(args->dp->i_mount))
267 args->geo = args->dp->i_mount->m_attr_geo;
268 args->whichfork = XFS_ATTR_FORK;
269 args->hashval = xfs_da_hashname(args->name, args->namelen);
271 /* Entirely possible to look up a name which doesn't exist */
272 args->op_flags = XFS_DA_OP_OKNOENT;
274 lock_mode = xfs_ilock_attr_map_shared(args->dp);
275 error = xfs_attr_get_ilocked(args);
276 xfs_iunlock(args->dp, lock_mode);
282 * Calculate how many blocks we need for the new attribute,
286 struct xfs_da_args *args,
289 struct xfs_mount *mp = args->dp->i_mount;
294 * Determine space new attribute will use, and if it would be
295 * "local" or "remote" (note: local != inline).
297 size = xfs_attr_leaf_newentsize(args, local);
298 nblks = XFS_DAENTER_SPACE_RES(mp, XFS_ATTR_FORK);
300 if (size > (args->geo->blksize / 2)) {
301 /* Double split possible */
306 * Out of line attribute, cannot double split, but
307 * make room for the attribute value itself.
309 uint dblocks = xfs_attr3_rmt_blocks(mp, args->valuelen);
311 nblks += XFS_NEXTENTADD_SPACE_RES(mp, dblocks, XFS_ATTR_FORK);
317 /* Initialize transaction reservation for attr operations */
320 struct xfs_da_args *args,
321 struct xfs_trans_res *tres,
324 struct xfs_mount *mp = args->dp->i_mount;
327 tres->tr_logres = M_RES(mp)->tr_attrsetm.tr_logres +
328 M_RES(mp)->tr_attrsetrt.tr_logres *
330 tres->tr_logcount = XFS_ATTRSET_LOG_COUNT;
331 tres->tr_logflags = XFS_TRANS_PERM_LOG_RES;
332 *total = args->total;
334 *tres = M_RES(mp)->tr_attrrm;
335 *total = XFS_ATTRRM_SPACE_RES(mp);
340 * Add an attr to a shortform fork. If there is no space,
341 * xfs_attr_shortform_addname() will convert to leaf format and return -ENOSPC.
345 xfs_attr_try_sf_addname(
346 struct xfs_inode *dp,
347 struct xfs_da_args *args)
353 * Build initial attribute list (if required).
355 if (dp->i_af.if_format == XFS_DINODE_FMT_EXTENTS)
356 xfs_attr_shortform_create(args);
358 error = xfs_attr_shortform_addname(args);
359 if (error == -ENOSPC)
363 * Commit the shortform mods, and we're done.
364 * NOTE: this is also the error path (EEXIST, etc).
366 if (!error && !(args->op_flags & XFS_DA_OP_NOTIME))
367 xfs_trans_ichgtime(args->trans, dp, XFS_ICHGTIME_CHG);
369 if (xfs_has_wsync(dp->i_mount))
370 xfs_trans_set_sync(args->trans);
377 struct xfs_attr_intent *attr)
379 struct xfs_da_args *args = attr->xattri_da_args;
380 struct xfs_inode *dp = args->dp;
383 error = xfs_attr_try_sf_addname(dp, args);
384 if (error != -ENOSPC) {
385 ASSERT(!error || error == -EEXIST);
386 attr->xattri_dela_state = XFS_DAS_DONE;
391 * It won't fit in the shortform, transform to a leaf block. GROT:
392 * another possible req'mt for a double-split btree op.
394 error = xfs_attr_shortform_to_leaf(args);
398 attr->xattri_dela_state = XFS_DAS_LEAF_ADD;
400 trace_xfs_attr_sf_addname_return(attr->xattri_dela_state, args->dp);
405 * Handle the state change on completion of a multi-state attr operation.
407 * If the XFS_DA_OP_REPLACE flag is set, this means the operation was the first
408 * modification in a attr replace operation and we still have to do the second
409 * state, indicated by @replace_state.
411 * We consume the XFS_DA_OP_REPLACE flag so that when we are called again on
412 * completion of the second half of the attr replace operation we correctly
413 * signal that it is done.
415 static enum xfs_delattr_state
416 xfs_attr_complete_op(
417 struct xfs_attr_intent *attr,
418 enum xfs_delattr_state replace_state)
420 struct xfs_da_args *args = attr->xattri_da_args;
421 bool do_replace = args->op_flags & XFS_DA_OP_REPLACE;
423 args->op_flags &= ~XFS_DA_OP_REPLACE;
425 args->attr_filter &= ~XFS_ATTR_INCOMPLETE;
426 return replace_state;
432 xfs_attr_leaf_addname(
433 struct xfs_attr_intent *attr)
435 struct xfs_da_args *args = attr->xattri_da_args;
438 ASSERT(xfs_attr_is_leaf(args->dp));
441 * Use the leaf buffer we may already hold locked as a result of
442 * a sf-to-leaf conversion.
444 error = xfs_attr_leaf_try_add(args);
446 if (error == -ENOSPC) {
447 error = xfs_attr3_leaf_to_node(args);
452 * We're not in leaf format anymore, so roll the transaction and
453 * retry the add to the newly allocated node block.
455 attr->xattri_dela_state = XFS_DAS_NODE_ADD;
462 * We need to commit and roll if we need to allocate remote xattr blocks
463 * or perform more xattr manipulations. Otherwise there is nothing more
464 * to do and we can return success.
467 attr->xattri_dela_state = XFS_DAS_LEAF_SET_RMT;
469 attr->xattri_dela_state = xfs_attr_complete_op(attr,
470 XFS_DAS_LEAF_REPLACE);
472 trace_xfs_attr_leaf_addname_return(attr->xattri_dela_state, args->dp);
477 * Add an entry to a node format attr tree.
479 * Note that we might still have a leaf here - xfs_attr_is_leaf() cannot tell
480 * the difference between leaf + remote attr blocks and a node format tree,
481 * so we may still end up having to convert from leaf to node format here.
484 xfs_attr_node_addname(
485 struct xfs_attr_intent *attr)
487 struct xfs_da_args *args = attr->xattri_da_args;
490 error = xfs_attr_node_addname_find_attr(attr);
494 error = xfs_attr_node_try_addname(attr);
495 if (error == -ENOSPC) {
496 error = xfs_attr3_leaf_to_node(args);
500 * No state change, we really are in node form now
501 * but we need the transaction rolled to continue.
509 attr->xattri_dela_state = XFS_DAS_NODE_SET_RMT;
511 attr->xattri_dela_state = xfs_attr_complete_op(attr,
512 XFS_DAS_NODE_REPLACE);
514 trace_xfs_attr_node_addname_return(attr->xattri_dela_state, args->dp);
519 xfs_attr_rmtval_alloc(
520 struct xfs_attr_intent *attr)
522 struct xfs_da_args *args = attr->xattri_da_args;
526 * If there was an out-of-line value, allocate the blocks we
527 * identified for its storage and copy the value. This is done
528 * after we create the attribute so that we don't overflow the
529 * maximum size of a transaction and/or hit a deadlock.
531 if (attr->xattri_blkcnt > 0) {
532 error = xfs_attr_rmtval_set_blk(attr);
535 /* Roll the transaction only if there is more to allocate. */
536 if (attr->xattri_blkcnt > 0)
540 error = xfs_attr_rmtval_set_value(args);
544 attr->xattri_dela_state = xfs_attr_complete_op(attr,
545 ++attr->xattri_dela_state);
547 * If we are not doing a rename, we've finished the operation but still
548 * have to clear the incomplete flag protecting the new attr from
549 * exposing partially initialised state if we crash during creation.
551 if (attr->xattri_dela_state == XFS_DAS_DONE)
552 error = xfs_attr3_leaf_clearflag(args);
554 trace_xfs_attr_rmtval_alloc(attr->xattri_dela_state, args->dp);
559 * Mark an attribute entry INCOMPLETE and save pointers to the relevant buffers
560 * for later deletion of the entry.
563 xfs_attr_leaf_mark_incomplete(
564 struct xfs_da_args *args,
565 struct xfs_da_state *state)
570 * Fill in disk block numbers in the state structure
571 * so that we can get the buffers back after we commit
572 * several transactions in the following calls.
574 error = xfs_attr_fillstate(state);
579 * Mark the attribute as INCOMPLETE
581 return xfs_attr3_leaf_setflag(args);
584 /* Ensure the da state of an xattr deferred work item is ready to go. */
586 xfs_attr_item_init_da_state(
587 struct xfs_attr_intent *attr)
589 struct xfs_da_args *args = attr->xattri_da_args;
591 if (!attr->xattri_da_state)
592 attr->xattri_da_state = xfs_da_state_alloc(args);
594 xfs_da_state_reset(attr->xattri_da_state, args);
598 * Initial setup for xfs_attr_node_removename. Make sure the attr is there and
599 * the blocks are valid. Attr keys with remote blocks will be marked
603 int xfs_attr_node_removename_setup(
604 struct xfs_attr_intent *attr)
606 struct xfs_da_args *args = attr->xattri_da_args;
607 struct xfs_da_state *state;
610 xfs_attr_item_init_da_state(attr);
611 error = xfs_attr_node_lookup(args, attr->xattri_da_state);
612 if (error != -EEXIST)
616 state = attr->xattri_da_state;
617 ASSERT(state->path.blk[state->path.active - 1].bp != NULL);
618 ASSERT(state->path.blk[state->path.active - 1].magic ==
619 XFS_ATTR_LEAF_MAGIC);
621 error = xfs_attr_leaf_mark_incomplete(args, state);
624 if (args->rmtblkno > 0)
625 error = xfs_attr_rmtval_invalidate(args);
628 xfs_da_state_free(attr->xattri_da_state);
629 attr->xattri_da_state = NULL;
636 * Remove the original attr we have just replaced. This is dependent on the
637 * original lookup and insert placing the old attr in args->blkno/args->index
638 * and the new attr in args->blkno2/args->index2.
641 xfs_attr_leaf_remove_attr(
642 struct xfs_attr_intent *attr)
644 struct xfs_da_args *args = attr->xattri_da_args;
645 struct xfs_inode *dp = args->dp;
646 struct xfs_buf *bp = NULL;
650 error = xfs_attr3_leaf_read(args->trans, args->dp, args->blkno,
655 xfs_attr3_leaf_remove(bp, args);
657 forkoff = xfs_attr_shortform_allfit(bp, dp);
659 error = xfs_attr3_leaf_to_shortform(bp, args, forkoff);
660 /* bp is gone due to xfs_da_shrink_inode */
666 * Shrink an attribute from leaf to shortform. Used by the node format remove
667 * path when the node format collapses to a single block and so we have to check
668 * if it can be collapsed further.
671 xfs_attr_leaf_shrink(
672 struct xfs_da_args *args)
674 struct xfs_inode *dp = args->dp;
679 if (!xfs_attr_is_leaf(dp))
682 error = xfs_attr3_leaf_read(args->trans, args->dp, 0, &bp);
686 forkoff = xfs_attr_shortform_allfit(bp, dp);
688 error = xfs_attr3_leaf_to_shortform(bp, args, forkoff);
689 /* bp is gone due to xfs_da_shrink_inode */
691 xfs_trans_brelse(args->trans, bp);
698 * Run the attribute operation specified in @attr.
700 * This routine is meant to function as a delayed operation and will set the
701 * state to XFS_DAS_DONE when the operation is complete. Calling functions will
702 * need to handle this, and recall the function until either an error or
703 * XFS_DAS_DONE is detected.
707 struct xfs_attr_intent *attr)
709 struct xfs_da_args *args = attr->xattri_da_args;
712 /* State machine switch */
714 switch (attr->xattri_dela_state) {
717 return -EFSCORRUPTED;
719 return xfs_attr_sf_addname(attr);
720 case XFS_DAS_LEAF_ADD:
721 return xfs_attr_leaf_addname(attr);
722 case XFS_DAS_NODE_ADD:
723 return xfs_attr_node_addname(attr);
725 case XFS_DAS_SF_REMOVE:
726 error = xfs_attr_sf_removename(args);
727 attr->xattri_dela_state = xfs_attr_complete_op(attr,
728 xfs_attr_init_add_state(args));
730 case XFS_DAS_LEAF_REMOVE:
731 error = xfs_attr_leaf_removename(args);
732 attr->xattri_dela_state = xfs_attr_complete_op(attr,
733 xfs_attr_init_add_state(args));
735 case XFS_DAS_NODE_REMOVE:
736 error = xfs_attr_node_removename_setup(attr);
737 if (error == -ENOATTR &&
738 (args->op_flags & XFS_DA_OP_RECOVERY)) {
739 attr->xattri_dela_state = xfs_attr_complete_op(attr,
740 xfs_attr_init_add_state(args));
746 attr->xattri_dela_state = XFS_DAS_NODE_REMOVE_RMT;
747 if (args->rmtblkno == 0)
748 attr->xattri_dela_state++;
751 case XFS_DAS_LEAF_SET_RMT:
752 case XFS_DAS_NODE_SET_RMT:
753 error = xfs_attr_rmtval_find_space(attr);
756 attr->xattri_dela_state++;
759 case XFS_DAS_LEAF_ALLOC_RMT:
760 case XFS_DAS_NODE_ALLOC_RMT:
761 error = xfs_attr_rmtval_alloc(attr);
764 if (attr->xattri_dela_state == XFS_DAS_DONE)
768 case XFS_DAS_LEAF_REPLACE:
769 case XFS_DAS_NODE_REPLACE:
771 * We must "flip" the incomplete flags on the "new" and "old"
772 * attribute/value pairs so that one disappears and one appears
775 error = xfs_attr3_leaf_flipflags(args);
779 * We must commit the flag value change now to make it atomic
780 * and then we can start the next trans in series at REMOVE_OLD.
782 attr->xattri_dela_state++;
785 case XFS_DAS_LEAF_REMOVE_OLD:
786 case XFS_DAS_NODE_REMOVE_OLD:
788 * If we have a remote attr, start the process of removing it
789 * by invalidating any cached buffers.
791 * If we don't have a remote attr, we skip the remote block
792 * removal state altogether with a second state increment.
794 xfs_attr_restore_rmt_blk(args);
795 if (args->rmtblkno) {
796 error = xfs_attr_rmtval_invalidate(args);
800 attr->xattri_dela_state++;
803 attr->xattri_dela_state++;
806 case XFS_DAS_LEAF_REMOVE_RMT:
807 case XFS_DAS_NODE_REMOVE_RMT:
808 error = xfs_attr_rmtval_remove(attr);
809 if (error == -EAGAIN) {
817 * We've finished removing the remote attr blocks, so commit the
818 * transaction and move on to removing the attr name from the
819 * leaf/node block. Removing the attr might require a full
820 * transaction reservation for btree block freeing, so we
821 * can't do that in the same transaction where we removed the
822 * remote attr blocks.
824 attr->xattri_dela_state++;
827 case XFS_DAS_LEAF_REMOVE_ATTR:
828 error = xfs_attr_leaf_remove_attr(attr);
829 attr->xattri_dela_state = xfs_attr_complete_op(attr,
830 xfs_attr_init_add_state(args));
833 case XFS_DAS_NODE_REMOVE_ATTR:
834 error = xfs_attr_node_remove_attr(attr);
836 error = xfs_attr_leaf_shrink(args);
837 attr->xattri_dela_state = xfs_attr_complete_op(attr,
838 xfs_attr_init_add_state(args));
845 trace_xfs_attr_set_iter_return(attr->xattri_dela_state, args->dp);
851 * Return EEXIST if attr is found, or ENOATTR if not
855 struct xfs_da_args *args)
857 struct xfs_inode *dp = args->dp;
858 struct xfs_buf *bp = NULL;
859 struct xfs_da_state *state;
862 if (!xfs_inode_hasattr(dp))
865 if (dp->i_af.if_format == XFS_DINODE_FMT_LOCAL)
866 return xfs_attr_sf_findname(args, NULL, NULL);
868 if (xfs_attr_is_leaf(dp)) {
869 error = xfs_attr_leaf_hasname(args, &bp);
872 xfs_trans_brelse(args->trans, bp);
877 state = xfs_da_state_alloc(args);
878 error = xfs_attr_node_lookup(args, state);
879 xfs_da_state_free(state);
884 xfs_attr_intent_init(
885 struct xfs_da_args *args,
886 unsigned int op_flags, /* op flag (set or remove) */
887 struct xfs_attr_intent **attr) /* new xfs_attr_intent */
890 struct xfs_attr_intent *new;
892 new = kmem_cache_zalloc(xfs_attr_intent_cache, GFP_NOFS | __GFP_NOFAIL);
893 new->xattri_op_flags = op_flags;
894 new->xattri_da_args = args;
900 /* Sets an attribute for an inode as a deferred operation */
903 struct xfs_da_args *args)
905 struct xfs_attr_intent *new;
908 error = xfs_attr_intent_init(args, XFS_ATTRI_OP_FLAGS_SET, &new);
912 new->xattri_dela_state = xfs_attr_init_add_state(args);
913 xfs_defer_add(args->trans, XFS_DEFER_OPS_TYPE_ATTR, &new->xattri_list);
914 trace_xfs_attr_defer_add(new->xattri_dela_state, args->dp);
919 /* Sets an attribute for an inode as a deferred operation */
921 xfs_attr_defer_replace(
922 struct xfs_da_args *args)
924 struct xfs_attr_intent *new;
927 error = xfs_attr_intent_init(args, XFS_ATTRI_OP_FLAGS_REPLACE, &new);
931 new->xattri_dela_state = xfs_attr_init_replace_state(args);
932 xfs_defer_add(args->trans, XFS_DEFER_OPS_TYPE_ATTR, &new->xattri_list);
933 trace_xfs_attr_defer_replace(new->xattri_dela_state, args->dp);
938 /* Removes an attribute for an inode as a deferred operation */
940 xfs_attr_defer_remove(
941 struct xfs_da_args *args)
944 struct xfs_attr_intent *new;
947 error = xfs_attr_intent_init(args, XFS_ATTRI_OP_FLAGS_REMOVE, &new);
951 new->xattri_dela_state = xfs_attr_init_remove_state(args);
952 xfs_defer_add(args->trans, XFS_DEFER_OPS_TYPE_ATTR, &new->xattri_list);
953 trace_xfs_attr_defer_remove(new->xattri_dela_state, args->dp);
959 * Note: If args->value is NULL the attribute will be removed, just like the
960 * Linux ->setattr API.
964 struct xfs_da_args *args)
966 struct xfs_inode *dp = args->dp;
967 struct xfs_mount *mp = dp->i_mount;
968 struct xfs_trans_res tres;
969 bool rsvd = (args->attr_filter & XFS_ATTR_ROOT);
974 if (xfs_is_shutdown(dp->i_mount))
977 error = xfs_qm_dqattach(dp);
981 args->geo = mp->m_attr_geo;
982 args->whichfork = XFS_ATTR_FORK;
983 args->hashval = xfs_da_hashname(args->name, args->namelen);
986 * We have no control over the attribute names that userspace passes us
987 * to remove, so we have to allow the name lookup prior to attribute
988 * removal to fail as well. Preserve the logged flag, since we need
989 * to pass that through to the logging code.
991 args->op_flags = XFS_DA_OP_OKNOENT |
992 (args->op_flags & XFS_DA_OP_LOGGED);
995 XFS_STATS_INC(mp, xs_attr_set);
996 args->total = xfs_attr_calc_size(args, &local);
999 * If the inode doesn't have an attribute fork, add one.
1000 * (inode must not be locked when we call this routine)
1002 if (xfs_inode_has_attr_fork(dp) == 0) {
1003 int sf_size = sizeof(struct xfs_attr_sf_hdr) +
1004 xfs_attr_sf_entsize_byname(args->namelen,
1007 error = xfs_bmap_add_attrfork(dp, sf_size, rsvd);
1013 rmt_blks = xfs_attr3_rmt_blocks(mp, args->valuelen);
1015 XFS_STATS_INC(mp, xs_attr_remove);
1016 rmt_blks = xfs_attr3_rmt_blocks(mp, XFS_XATTR_SIZE_MAX);
1020 * Root fork attributes can use reserved data blocks for this
1021 * operation if necessary
1023 xfs_init_attr_trans(args, &tres, &total);
1024 error = xfs_trans_alloc_inode(dp, &tres, total, 0, rsvd, &args->trans);
1028 if (args->value || xfs_inode_hasattr(dp)) {
1029 error = xfs_iext_count_may_overflow(dp, XFS_ATTR_FORK,
1030 XFS_IEXT_ATTR_MANIP_CNT(rmt_blks));
1031 if (error == -EFBIG)
1032 error = xfs_iext_count_upgrade(args->trans, dp,
1033 XFS_IEXT_ATTR_MANIP_CNT(rmt_blks));
1035 goto out_trans_cancel;
1038 error = xfs_attr_lookup(args);
1041 /* if no value, we are performing a remove operation */
1043 error = xfs_attr_defer_remove(args);
1046 /* Pure create fails if the attr already exists */
1047 if (args->attr_flags & XATTR_CREATE)
1048 goto out_trans_cancel;
1050 error = xfs_attr_defer_replace(args);
1053 /* Can't remove what isn't there. */
1055 goto out_trans_cancel;
1057 /* Pure replace fails if no existing attr to replace. */
1058 if (args->attr_flags & XATTR_REPLACE)
1059 goto out_trans_cancel;
1061 error = xfs_attr_defer_add(args);
1064 goto out_trans_cancel;
1067 goto out_trans_cancel;
1070 * If this is a synchronous mount, make sure that the
1071 * transaction goes to disk before returning to the user.
1073 if (xfs_has_wsync(mp))
1074 xfs_trans_set_sync(args->trans);
1076 if (!(args->op_flags & XFS_DA_OP_NOTIME))
1077 xfs_trans_ichgtime(args->trans, dp, XFS_ICHGTIME_CHG);
1080 * Commit the last in the sequence of transactions.
1082 xfs_trans_log_inode(args->trans, dp, XFS_ILOG_CORE);
1083 error = xfs_trans_commit(args->trans);
1085 xfs_iunlock(dp, XFS_ILOCK_EXCL);
1090 xfs_trans_cancel(args->trans);
1094 /*========================================================================
1095 * External routines when attribute list is inside the inode
1096 *========================================================================*/
1098 static inline int xfs_attr_sf_totsize(struct xfs_inode *dp)
1100 struct xfs_attr_shortform *sf;
1102 sf = (struct xfs_attr_shortform *)dp->i_af.if_u1.if_data;
1103 return be16_to_cpu(sf->hdr.totsize);
1107 * Add a name to the shortform attribute list structure
1108 * This is the external routine.
1111 xfs_attr_shortform_addname(
1112 struct xfs_da_args *args)
1114 int newsize, forkoff;
1117 trace_xfs_attr_sf_addname(args);
1119 error = xfs_attr_shortform_lookup(args);
1122 if (args->op_flags & XFS_DA_OP_REPLACE)
1126 if (!(args->op_flags & XFS_DA_OP_REPLACE))
1129 error = xfs_attr_sf_removename(args);
1134 * Since we have removed the old attr, clear XFS_DA_OP_REPLACE
1135 * so that the new attr doesn't fit in shortform format, the
1136 * leaf format add routine won't trip over the attr not being
1139 args->op_flags &= ~XFS_DA_OP_REPLACE;
1147 if (args->namelen >= XFS_ATTR_SF_ENTSIZE_MAX ||
1148 args->valuelen >= XFS_ATTR_SF_ENTSIZE_MAX)
1151 newsize = xfs_attr_sf_totsize(args->dp);
1152 newsize += xfs_attr_sf_entsize_byname(args->namelen, args->valuelen);
1154 forkoff = xfs_attr_shortform_bytesfit(args->dp, newsize);
1158 xfs_attr_shortform_add(args, forkoff);
1163 /*========================================================================
1164 * External routines when attribute list is one block
1165 *========================================================================*/
1167 /* Save the current remote block info and clear the current pointers. */
1169 xfs_attr_save_rmt_blk(
1170 struct xfs_da_args *args)
1172 args->blkno2 = args->blkno;
1173 args->index2 = args->index;
1174 args->rmtblkno2 = args->rmtblkno;
1175 args->rmtblkcnt2 = args->rmtblkcnt;
1176 args->rmtvaluelen2 = args->rmtvaluelen;
1178 args->rmtblkcnt = 0;
1179 args->rmtvaluelen = 0;
1182 /* Set stored info about a remote block */
1184 xfs_attr_restore_rmt_blk(
1185 struct xfs_da_args *args)
1187 args->blkno = args->blkno2;
1188 args->index = args->index2;
1189 args->rmtblkno = args->rmtblkno2;
1190 args->rmtblkcnt = args->rmtblkcnt2;
1191 args->rmtvaluelen = args->rmtvaluelen2;
1195 * Tries to add an attribute to an inode in leaf form
1197 * This function is meant to execute as part of a delayed operation and leaves
1198 * the transaction handling to the caller. On success the attribute is added
1199 * and the inode and transaction are left dirty. If there is not enough space,
1200 * the attr data is converted to node format and -ENOSPC is returned. Caller is
1201 * responsible for handling the dirty inode and transaction or adding the attr
1205 xfs_attr_leaf_try_add(
1206 struct xfs_da_args *args)
1211 error = xfs_attr3_leaf_read(args->trans, args->dp, 0, &bp);
1216 * Look up the xattr name to set the insertion point for the new xattr.
1218 error = xfs_attr3_leaf_lookup_int(bp, args);
1221 if (args->op_flags & XFS_DA_OP_REPLACE)
1225 if (!(args->op_flags & XFS_DA_OP_REPLACE))
1228 trace_xfs_attr_leaf_replace(args);
1230 * Save the existing remote attr state so that the current
1231 * values reflect the state of the new attribute we are about to
1232 * add, not the attribute we just found and will remove later.
1234 xfs_attr_save_rmt_blk(args);
1242 return xfs_attr3_leaf_add(bp, args);
1245 xfs_trans_brelse(args->trans, bp);
1250 * Return EEXIST if attr is found, or ENOATTR if not
1253 xfs_attr_leaf_hasname(
1254 struct xfs_da_args *args,
1255 struct xfs_buf **bp)
1259 error = xfs_attr3_leaf_read(args->trans, args->dp, 0, bp);
1263 error = xfs_attr3_leaf_lookup_int(*bp, args);
1264 if (error != -ENOATTR && error != -EEXIST)
1265 xfs_trans_brelse(args->trans, *bp);
1271 * Remove a name from the leaf attribute list structure
1273 * This leaf block cannot have a "remote" value, we only call this routine
1274 * if bmap_one_block() says there is only one block (ie: no remote blks).
1277 xfs_attr_leaf_removename(
1278 struct xfs_da_args *args)
1280 struct xfs_inode *dp;
1284 trace_xfs_attr_leaf_removename(args);
1287 * Remove the attribute.
1291 error = xfs_attr_leaf_hasname(args, &bp);
1292 if (error == -ENOATTR) {
1293 xfs_trans_brelse(args->trans, bp);
1294 if (args->op_flags & XFS_DA_OP_RECOVERY)
1297 } else if (error != -EEXIST)
1300 xfs_attr3_leaf_remove(bp, args);
1303 * If the result is small enough, shrink it all into the inode.
1305 forkoff = xfs_attr_shortform_allfit(bp, dp);
1307 return xfs_attr3_leaf_to_shortform(bp, args, forkoff);
1308 /* bp is gone due to xfs_da_shrink_inode */
1314 * Look up a name in a leaf attribute list structure.
1316 * This leaf block cannot have a "remote" value, we only call this routine
1317 * if bmap_one_block() says there is only one block (ie: no remote blks).
1319 * Returns 0 on successful retrieval, otherwise an error.
1322 xfs_attr_leaf_get(xfs_da_args_t *args)
1327 trace_xfs_attr_leaf_get(args);
1329 error = xfs_attr_leaf_hasname(args, &bp);
1331 if (error == -ENOATTR) {
1332 xfs_trans_brelse(args->trans, bp);
1334 } else if (error != -EEXIST)
1338 error = xfs_attr3_leaf_getvalue(bp, args);
1339 xfs_trans_brelse(args->trans, bp);
1343 /* Return EEXIST if attr is found, or ENOATTR if not. */
1345 xfs_attr_node_lookup(
1346 struct xfs_da_args *args,
1347 struct xfs_da_state *state)
1352 * Search to see if name exists, and get back a pointer to it.
1354 error = xfs_da3_node_lookup_int(state, &retval);
1361 /*========================================================================
1362 * External routines when attribute list size > geo->blksize
1363 *========================================================================*/
1366 xfs_attr_node_addname_find_attr(
1367 struct xfs_attr_intent *attr)
1369 struct xfs_da_args *args = attr->xattri_da_args;
1373 * Search to see if name already exists, and get back a pointer
1374 * to where it should go.
1376 xfs_attr_item_init_da_state(attr);
1377 error = xfs_attr_node_lookup(args, attr->xattri_da_state);
1380 if (args->op_flags & XFS_DA_OP_REPLACE)
1384 if (!(args->op_flags & XFS_DA_OP_REPLACE))
1388 trace_xfs_attr_node_replace(args);
1390 * Save the existing remote attr state so that the current
1391 * values reflect the state of the new attribute we are about to
1392 * add, not the attribute we just found and will remove later.
1394 xfs_attr_save_rmt_blk(args);
1404 if (attr->xattri_da_state) {
1405 xfs_da_state_free(attr->xattri_da_state);
1406 attr->xattri_da_state = NULL;
1412 * Add a name to a Btree-format attribute list.
1414 * This will involve walking down the Btree, and may involve splitting
1415 * leaf nodes and even splitting intermediate nodes up to and including
1416 * the root node (a special case of an intermediate node).
1419 xfs_attr_node_try_addname(
1420 struct xfs_attr_intent *attr)
1422 struct xfs_da_state *state = attr->xattri_da_state;
1423 struct xfs_da_state_blk *blk;
1426 trace_xfs_attr_node_addname(state->args);
1428 blk = &state->path.blk[state->path.active-1];
1429 ASSERT(blk->magic == XFS_ATTR_LEAF_MAGIC);
1431 error = xfs_attr3_leaf_add(blk->bp, state->args);
1432 if (error == -ENOSPC) {
1433 if (state->path.active == 1) {
1435 * Its really a single leaf node, but it had
1436 * out-of-line values so it looked like it *might*
1437 * have been a b-tree. Let the caller deal with this.
1443 * Split as many Btree elements as required.
1444 * This code tracks the new and old attr's location
1445 * in the index/blkno/rmtblkno/rmtblkcnt fields and
1446 * in the index2/blkno2/rmtblkno2/rmtblkcnt2 fields.
1448 error = xfs_da3_split(state);
1453 * Addition succeeded, update Btree hashvals.
1455 xfs_da3_fixhashpath(state, &state->path);
1459 xfs_da_state_free(state);
1460 attr->xattri_da_state = NULL;
1465 xfs_attr_node_removename(
1466 struct xfs_da_args *args,
1467 struct xfs_da_state *state)
1469 struct xfs_da_state_blk *blk;
1473 * Remove the name and update the hashvals in the tree.
1475 blk = &state->path.blk[state->path.active-1];
1476 ASSERT(blk->magic == XFS_ATTR_LEAF_MAGIC);
1477 retval = xfs_attr3_leaf_remove(blk->bp, args);
1478 xfs_da3_fixhashpath(state, &state->path);
1484 xfs_attr_node_remove_attr(
1485 struct xfs_attr_intent *attr)
1487 struct xfs_da_args *args = attr->xattri_da_args;
1488 struct xfs_da_state *state = xfs_da_state_alloc(args);
1493 * The attr we are removing has already been marked incomplete, so
1494 * we need to set the filter appropriately to re-find the "old"
1495 * attribute entry after any split ops.
1497 args->attr_filter |= XFS_ATTR_INCOMPLETE;
1498 error = xfs_da3_node_lookup_int(state, &retval);
1502 error = xfs_attr_node_removename(args, state);
1505 * Check to see if the tree needs to be collapsed.
1507 if (retval && (state->path.active > 1)) {
1508 error = xfs_da3_join(state);
1515 xfs_da_state_free(state);
1522 * Retrieve the attribute data from a node attribute list.
1524 * This routine gets called for any attribute fork that has more than one
1525 * block, ie: both true Btree attr lists and for single-leaf-blocks with
1526 * "remote" values taking up more blocks.
1528 * Returns 0 on successful retrieval, otherwise an error.
1532 struct xfs_da_args *args)
1534 struct xfs_da_state *state;
1535 struct xfs_da_state_blk *blk;
1539 trace_xfs_attr_node_get(args);
1542 * Search to see if name exists, and get back a pointer to it.
1544 state = xfs_da_state_alloc(args);
1545 error = xfs_attr_node_lookup(args, state);
1546 if (error != -EEXIST)
1550 * Get the value, local or "remote"
1552 blk = &state->path.blk[state->path.active - 1];
1553 error = xfs_attr3_leaf_getvalue(blk->bp, args);
1556 * If not in a transaction, we have to release all the buffers.
1559 for (i = 0; i < state->path.active; i++) {
1560 xfs_trans_brelse(args->trans, state->path.blk[i].bp);
1561 state->path.blk[i].bp = NULL;
1564 xfs_da_state_free(state);
1568 /* Returns true if the attribute entry name is valid. */
1575 * MAXNAMELEN includes the trailing null, but (name/length) leave it
1576 * out, so use >= for the length check.
1578 if (length >= MAXNAMELEN)
1581 /* There shouldn't be any nulls here */
1582 return !memchr(name, 0, length);
1586 xfs_attr_intent_init_cache(void)
1588 xfs_attr_intent_cache = kmem_cache_create("xfs_attr_intent",
1589 sizeof(struct xfs_attr_intent),
1592 return xfs_attr_intent_cache != NULL ? 0 : -ENOMEM;
1596 xfs_attr_intent_destroy_cache(void)
1598 kmem_cache_destroy(xfs_attr_intent_cache);
1599 xfs_attr_intent_cache = NULL;