Loading...
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * Copyright (c) 2000-2005 Silicon Graphics, Inc.
4 * All Rights Reserved.
5 */
6#include "xfs.h"
7#include "xfs_fs.h"
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"
19#include "xfs_bmap.h"
20#include "xfs_bmap_btree.h"
21#include "xfs_attr.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"
29
30struct kmem_cache *xfs_attr_intent_cache;
31
32/*
33 * xfs_attr.c
34 *
35 * Provide the external interfaces to manage attribute lists.
36 */
37
38/*========================================================================
39 * Function prototypes for the kernel.
40 *========================================================================*/
41
42/*
43 * Internal routines when attribute list fits inside the inode.
44 */
45STATIC int xfs_attr_shortform_addname(xfs_da_args_t *args);
46
47/*
48 * Internal routines when attribute list is one block.
49 */
50STATIC int xfs_attr_leaf_get(xfs_da_args_t *args);
51STATIC int xfs_attr_leaf_removename(xfs_da_args_t *args);
52STATIC int xfs_attr_leaf_hasname(struct xfs_da_args *args, struct xfs_buf **bp);
53STATIC int xfs_attr_leaf_try_add(struct xfs_da_args *args);
54
55/*
56 * Internal routines when attribute list is more than one block.
57 */
58STATIC int xfs_attr_node_get(xfs_da_args_t *args);
59STATIC void xfs_attr_restore_rmt_blk(struct xfs_da_args *args);
60static int xfs_attr_node_try_addname(struct xfs_attr_intent *attr);
61STATIC int xfs_attr_node_addname_find_attr(struct xfs_attr_intent *attr);
62STATIC int xfs_attr_node_remove_attr(struct xfs_attr_intent *attr);
63STATIC int xfs_attr_node_lookup(struct xfs_da_args *args,
64 struct xfs_da_state *state);
65
66int
67xfs_inode_hasattr(
68 struct xfs_inode *ip)
69{
70 if (!xfs_inode_has_attr_fork(ip))
71 return 0;
72 if (ip->i_af.if_format == XFS_DINODE_FMT_EXTENTS &&
73 ip->i_af.if_nextents == 0)
74 return 0;
75 return 1;
76}
77
78/*
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.
81 */
82bool
83xfs_attr_is_leaf(
84 struct xfs_inode *ip)
85{
86 struct xfs_ifork *ifp = &ip->i_af;
87 struct xfs_iext_cursor icur;
88 struct xfs_bmbt_irec imap;
89
90 if (ifp->if_nextents != 1 || ifp->if_format != XFS_DINODE_FMT_EXTENTS)
91 return false;
92
93 xfs_iext_first(ifp, &icur);
94 xfs_iext_get_extent(ifp, &icur, &imap);
95 return imap.br_startoff == 0 && imap.br_blockcount == 1;
96}
97
98/*
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.
105 *
106 * This comment is a public service announcement to remind Future Dave that he
107 * still needs to restore this code to working order.
108 */
109#if 0
110/*
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.
115 */
116static int
117xfs_attr_fillstate(xfs_da_state_t *state)
118{
119 xfs_da_state_path_t *path;
120 xfs_da_state_blk_t *blk;
121 int level;
122
123 trace_xfs_attr_fillstate(state->args);
124
125 /*
126 * Roll down the "path" in the state structure, storing the on-disk
127 * block number for those buffers in the "path".
128 */
129 path = &state->path;
130 ASSERT((path->active >= 0) && (path->active < XFS_DA_NODE_MAXDEPTH));
131 for (blk = path->blk, level = 0; level < path->active; blk++, level++) {
132 if (blk->bp) {
133 blk->disk_blkno = xfs_buf_daddr(blk->bp);
134 blk->bp = NULL;
135 } else {
136 blk->disk_blkno = 0;
137 }
138 }
139
140 /*
141 * Roll down the "altpath" in the state structure, storing the on-disk
142 * block number for those buffers in the "altpath".
143 */
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++) {
147 if (blk->bp) {
148 blk->disk_blkno = xfs_buf_daddr(blk->bp);
149 blk->bp = NULL;
150 } else {
151 blk->disk_blkno = 0;
152 }
153 }
154
155 return 0;
156}
157
158/*
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.
163 */
164static int
165xfs_attr_refillstate(xfs_da_state_t *state)
166{
167 xfs_da_state_path_t *path;
168 xfs_da_state_blk_t *blk;
169 int level, error;
170
171 trace_xfs_attr_refillstate(state->args);
172
173 /*
174 * Roll down the "path" in the state structure, storing the on-disk
175 * block number for those buffers in the "path".
176 */
177 path = &state->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);
184 if (error)
185 return error;
186 } else {
187 blk->bp = NULL;
188 }
189 }
190
191 /*
192 * Roll down the "altpath" in the state structure, storing the on-disk
193 * block number for those buffers in the "altpath".
194 */
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);
202 if (error)
203 return error;
204 } else {
205 blk->bp = NULL;
206 }
207 }
208
209 return 0;
210}
211#else
212static int xfs_attr_fillstate(xfs_da_state_t *state) { return 0; }
213#endif
214
215/*========================================================================
216 * Overall external interface routines.
217 *========================================================================*/
218
219/*
220 * Retrieve an extended attribute and its value. Must have ilock.
221 * Returns 0 on successful retrieval, otherwise an error.
222 */
223int
224xfs_attr_get_ilocked(
225 struct xfs_da_args *args)
226{
227 ASSERT(xfs_isilocked(args->dp, XFS_ILOCK_SHARED | XFS_ILOCK_EXCL));
228
229 if (!xfs_inode_hasattr(args->dp))
230 return -ENOATTR;
231
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);
237}
238
239/*
240 * Retrieve an extended attribute by name, and its value if requested.
241 *
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.
245 *
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.
250 *
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
253 * in args->valuelen.
254 */
255int
256xfs_attr_get(
257 struct xfs_da_args *args)
258{
259 uint lock_mode;
260 int error;
261
262 XFS_STATS_INC(args->dp->i_mount, xs_attr_get);
263
264 if (xfs_is_shutdown(args->dp->i_mount))
265 return -EIO;
266
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);
270
271 /* Entirely possible to look up a name which doesn't exist */
272 args->op_flags = XFS_DA_OP_OKNOENT;
273
274 lock_mode = xfs_ilock_attr_map_shared(args->dp);
275 error = xfs_attr_get_ilocked(args);
276 xfs_iunlock(args->dp, lock_mode);
277
278 return error;
279}
280
281/*
282 * Calculate how many blocks we need for the new attribute,
283 */
284int
285xfs_attr_calc_size(
286 struct xfs_da_args *args,
287 int *local)
288{
289 struct xfs_mount *mp = args->dp->i_mount;
290 int size;
291 int nblks;
292
293 /*
294 * Determine space new attribute will use, and if it would be
295 * "local" or "remote" (note: local != inline).
296 */
297 size = xfs_attr_leaf_newentsize(args, local);
298 nblks = XFS_DAENTER_SPACE_RES(mp, XFS_ATTR_FORK);
299 if (*local) {
300 if (size > (args->geo->blksize / 2)) {
301 /* Double split possible */
302 nblks *= 2;
303 }
304 } else {
305 /*
306 * Out of line attribute, cannot double split, but
307 * make room for the attribute value itself.
308 */
309 uint dblocks = xfs_attr3_rmt_blocks(mp, args->valuelen);
310 nblks += dblocks;
311 nblks += XFS_NEXTENTADD_SPACE_RES(mp, dblocks, XFS_ATTR_FORK);
312 }
313
314 return nblks;
315}
316
317/* Initialize transaction reservation for attr operations */
318void
319xfs_init_attr_trans(
320 struct xfs_da_args *args,
321 struct xfs_trans_res *tres,
322 unsigned int *total)
323{
324 struct xfs_mount *mp = args->dp->i_mount;
325
326 if (args->value) {
327 tres->tr_logres = M_RES(mp)->tr_attrsetm.tr_logres +
328 M_RES(mp)->tr_attrsetrt.tr_logres *
329 args->total;
330 tres->tr_logcount = XFS_ATTRSET_LOG_COUNT;
331 tres->tr_logflags = XFS_TRANS_PERM_LOG_RES;
332 *total = args->total;
333 } else {
334 *tres = M_RES(mp)->tr_attrrm;
335 *total = XFS_ATTRRM_SPACE_RES(mp);
336 }
337}
338
339/*
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.
342 * to use.
343 */
344STATIC int
345xfs_attr_try_sf_addname(
346 struct xfs_inode *dp,
347 struct xfs_da_args *args)
348{
349
350 int error;
351
352 /*
353 * Build initial attribute list (if required).
354 */
355 if (dp->i_af.if_format == XFS_DINODE_FMT_EXTENTS)
356 xfs_attr_shortform_create(args);
357
358 error = xfs_attr_shortform_addname(args);
359 if (error == -ENOSPC)
360 return error;
361
362 /*
363 * Commit the shortform mods, and we're done.
364 * NOTE: this is also the error path (EEXIST, etc).
365 */
366 if (!error && !(args->op_flags & XFS_DA_OP_NOTIME))
367 xfs_trans_ichgtime(args->trans, dp, XFS_ICHGTIME_CHG);
368
369 if (xfs_has_wsync(dp->i_mount))
370 xfs_trans_set_sync(args->trans);
371
372 return error;
373}
374
375static int
376xfs_attr_sf_addname(
377 struct xfs_attr_intent *attr)
378{
379 struct xfs_da_args *args = attr->xattri_da_args;
380 struct xfs_inode *dp = args->dp;
381 int error = 0;
382
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;
387 goto out;
388 }
389
390 /*
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.
393 */
394 error = xfs_attr_shortform_to_leaf(args);
395 if (error)
396 return error;
397
398 attr->xattri_dela_state = XFS_DAS_LEAF_ADD;
399out:
400 trace_xfs_attr_sf_addname_return(attr->xattri_dela_state, args->dp);
401 return error;
402}
403
404/*
405 * Handle the state change on completion of a multi-state attr operation.
406 *
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.
410 *
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.
414 */
415static enum xfs_delattr_state
416xfs_attr_complete_op(
417 struct xfs_attr_intent *attr,
418 enum xfs_delattr_state replace_state)
419{
420 struct xfs_da_args *args = attr->xattri_da_args;
421 bool do_replace = args->op_flags & XFS_DA_OP_REPLACE;
422
423 args->op_flags &= ~XFS_DA_OP_REPLACE;
424 args->attr_filter &= ~XFS_ATTR_INCOMPLETE;
425 if (do_replace)
426 return replace_state;
427
428 return XFS_DAS_DONE;
429}
430
431static int
432xfs_attr_leaf_addname(
433 struct xfs_attr_intent *attr)
434{
435 struct xfs_da_args *args = attr->xattri_da_args;
436 int error;
437
438 ASSERT(xfs_attr_is_leaf(args->dp));
439
440 /*
441 * Use the leaf buffer we may already hold locked as a result of
442 * a sf-to-leaf conversion.
443 */
444 error = xfs_attr_leaf_try_add(args);
445
446 if (error == -ENOSPC) {
447 error = xfs_attr3_leaf_to_node(args);
448 if (error)
449 return error;
450
451 /*
452 * We're not in leaf format anymore, so roll the transaction and
453 * retry the add to the newly allocated node block.
454 */
455 attr->xattri_dela_state = XFS_DAS_NODE_ADD;
456 goto out;
457 }
458 if (error)
459 return error;
460
461 /*
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.
465 */
466 if (args->rmtblkno)
467 attr->xattri_dela_state = XFS_DAS_LEAF_SET_RMT;
468 else
469 attr->xattri_dela_state = xfs_attr_complete_op(attr,
470 XFS_DAS_LEAF_REPLACE);
471out:
472 trace_xfs_attr_leaf_addname_return(attr->xattri_dela_state, args->dp);
473 return error;
474}
475
476/*
477 * Add an entry to a node format attr tree.
478 *
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.
482 */
483static int
484xfs_attr_node_addname(
485 struct xfs_attr_intent *attr)
486{
487 struct xfs_da_args *args = attr->xattri_da_args;
488 int error;
489
490 error = xfs_attr_node_addname_find_attr(attr);
491 if (error)
492 return error;
493
494 error = xfs_attr_node_try_addname(attr);
495 if (error == -ENOSPC) {
496 error = xfs_attr3_leaf_to_node(args);
497 if (error)
498 return error;
499 /*
500 * No state change, we really are in node form now
501 * but we need the transaction rolled to continue.
502 */
503 goto out;
504 }
505 if (error)
506 return error;
507
508 if (args->rmtblkno)
509 attr->xattri_dela_state = XFS_DAS_NODE_SET_RMT;
510 else
511 attr->xattri_dela_state = xfs_attr_complete_op(attr,
512 XFS_DAS_NODE_REPLACE);
513out:
514 trace_xfs_attr_node_addname_return(attr->xattri_dela_state, args->dp);
515 return error;
516}
517
518static int
519xfs_attr_rmtval_alloc(
520 struct xfs_attr_intent *attr)
521{
522 struct xfs_da_args *args = attr->xattri_da_args;
523 int error = 0;
524
525 /*
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.
530 */
531 if (attr->xattri_blkcnt > 0) {
532 error = xfs_attr_rmtval_set_blk(attr);
533 if (error)
534 return error;
535 /* Roll the transaction only if there is more to allocate. */
536 if (attr->xattri_blkcnt > 0)
537 goto out;
538 }
539
540 error = xfs_attr_rmtval_set_value(args);
541 if (error)
542 return error;
543
544 attr->xattri_dela_state = xfs_attr_complete_op(attr,
545 ++attr->xattri_dela_state);
546 /*
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.
550 */
551 if (attr->xattri_dela_state == XFS_DAS_DONE)
552 error = xfs_attr3_leaf_clearflag(args);
553out:
554 trace_xfs_attr_rmtval_alloc(attr->xattri_dela_state, args->dp);
555 return error;
556}
557
558/*
559 * Mark an attribute entry INCOMPLETE and save pointers to the relevant buffers
560 * for later deletion of the entry.
561 */
562static int
563xfs_attr_leaf_mark_incomplete(
564 struct xfs_da_args *args,
565 struct xfs_da_state *state)
566{
567 int error;
568
569 /*
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.
573 */
574 error = xfs_attr_fillstate(state);
575 if (error)
576 return error;
577
578 /*
579 * Mark the attribute as INCOMPLETE
580 */
581 return xfs_attr3_leaf_setflag(args);
582}
583
584/* Ensure the da state of an xattr deferred work item is ready to go. */
585static inline void
586xfs_attr_item_init_da_state(
587 struct xfs_attr_intent *attr)
588{
589 struct xfs_da_args *args = attr->xattri_da_args;
590
591 if (!attr->xattri_da_state)
592 attr->xattri_da_state = xfs_da_state_alloc(args);
593 else
594 xfs_da_state_reset(attr->xattri_da_state, args);
595}
596
597/*
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
600 * incomplete.
601 */
602static
603int xfs_attr_node_removename_setup(
604 struct xfs_attr_intent *attr)
605{
606 struct xfs_da_args *args = attr->xattri_da_args;
607 struct xfs_da_state *state;
608 int error;
609
610 xfs_attr_item_init_da_state(attr);
611 error = xfs_attr_node_lookup(args, attr->xattri_da_state);
612 if (error != -EEXIST)
613 goto out;
614 error = 0;
615
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);
620
621 error = xfs_attr_leaf_mark_incomplete(args, state);
622 if (error)
623 goto out;
624 if (args->rmtblkno > 0)
625 error = xfs_attr_rmtval_invalidate(args);
626out:
627 if (error) {
628 xfs_da_state_free(attr->xattri_da_state);
629 attr->xattri_da_state = NULL;
630 }
631
632 return error;
633}
634
635/*
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.
639 */
640static int
641xfs_attr_leaf_remove_attr(
642 struct xfs_attr_intent *attr)
643{
644 struct xfs_da_args *args = attr->xattri_da_args;
645 struct xfs_inode *dp = args->dp;
646 struct xfs_buf *bp = NULL;
647 int forkoff;
648 int error;
649
650 error = xfs_attr3_leaf_read(args->trans, args->dp, args->blkno,
651 &bp);
652 if (error)
653 return error;
654
655 xfs_attr3_leaf_remove(bp, args);
656
657 forkoff = xfs_attr_shortform_allfit(bp, dp);
658 if (forkoff)
659 error = xfs_attr3_leaf_to_shortform(bp, args, forkoff);
660 /* bp is gone due to xfs_da_shrink_inode */
661
662 return error;
663}
664
665/*
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.
669 */
670static int
671xfs_attr_leaf_shrink(
672 struct xfs_da_args *args)
673{
674 struct xfs_inode *dp = args->dp;
675 struct xfs_buf *bp;
676 int forkoff;
677 int error;
678
679 if (!xfs_attr_is_leaf(dp))
680 return 0;
681
682 error = xfs_attr3_leaf_read(args->trans, args->dp, 0, &bp);
683 if (error)
684 return error;
685
686 forkoff = xfs_attr_shortform_allfit(bp, dp);
687 if (forkoff) {
688 error = xfs_attr3_leaf_to_shortform(bp, args, forkoff);
689 /* bp is gone due to xfs_da_shrink_inode */
690 } else {
691 xfs_trans_brelse(args->trans, bp);
692 }
693
694 return error;
695}
696
697/*
698 * Run the attribute operation specified in @attr.
699 *
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.
704 */
705int
706xfs_attr_set_iter(
707 struct xfs_attr_intent *attr)
708{
709 struct xfs_da_args *args = attr->xattri_da_args;
710 int error = 0;
711
712 /* State machine switch */
713next_state:
714 switch (attr->xattri_dela_state) {
715 case XFS_DAS_UNINIT:
716 ASSERT(0);
717 return -EFSCORRUPTED;
718 case XFS_DAS_SF_ADD:
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);
724
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));
729 break;
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));
734 break;
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));
741 error = 0;
742 break;
743 }
744 if (error)
745 return error;
746 attr->xattri_dela_state = XFS_DAS_NODE_REMOVE_RMT;
747 if (args->rmtblkno == 0)
748 attr->xattri_dela_state++;
749 break;
750
751 case XFS_DAS_LEAF_SET_RMT:
752 case XFS_DAS_NODE_SET_RMT:
753 error = xfs_attr_rmtval_find_space(attr);
754 if (error)
755 return error;
756 attr->xattri_dela_state++;
757 fallthrough;
758
759 case XFS_DAS_LEAF_ALLOC_RMT:
760 case XFS_DAS_NODE_ALLOC_RMT:
761 error = xfs_attr_rmtval_alloc(attr);
762 if (error)
763 return error;
764 if (attr->xattri_dela_state == XFS_DAS_DONE)
765 break;
766 goto next_state;
767
768 case XFS_DAS_LEAF_REPLACE:
769 case XFS_DAS_NODE_REPLACE:
770 /*
771 * We must "flip" the incomplete flags on the "new" and "old"
772 * attribute/value pairs so that one disappears and one appears
773 * atomically.
774 */
775 error = xfs_attr3_leaf_flipflags(args);
776 if (error)
777 return error;
778 /*
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.
781 */
782 attr->xattri_dela_state++;
783 break;
784
785 case XFS_DAS_LEAF_REMOVE_OLD:
786 case XFS_DAS_NODE_REMOVE_OLD:
787 /*
788 * If we have a remote attr, start the process of removing it
789 * by invalidating any cached buffers.
790 *
791 * If we don't have a remote attr, we skip the remote block
792 * removal state altogether with a second state increment.
793 */
794 xfs_attr_restore_rmt_blk(args);
795 if (args->rmtblkno) {
796 error = xfs_attr_rmtval_invalidate(args);
797 if (error)
798 return error;
799 } else {
800 attr->xattri_dela_state++;
801 }
802
803 attr->xattri_dela_state++;
804 goto next_state;
805
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) {
810 error = 0;
811 break;
812 }
813 if (error)
814 return error;
815
816 /*
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.
823 */
824 attr->xattri_dela_state++;
825 break;
826
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));
831 break;
832
833 case XFS_DAS_NODE_REMOVE_ATTR:
834 error = xfs_attr_node_remove_attr(attr);
835 if (!error)
836 error = xfs_attr_leaf_shrink(args);
837 attr->xattri_dela_state = xfs_attr_complete_op(attr,
838 xfs_attr_init_add_state(args));
839 break;
840 default:
841 ASSERT(0);
842 break;
843 }
844
845 trace_xfs_attr_set_iter_return(attr->xattri_dela_state, args->dp);
846 return error;
847}
848
849
850/*
851 * Return EEXIST if attr is found, or ENOATTR if not
852 */
853static int
854xfs_attr_lookup(
855 struct xfs_da_args *args)
856{
857 struct xfs_inode *dp = args->dp;
858 struct xfs_buf *bp = NULL;
859 struct xfs_da_state *state;
860 int error;
861
862 if (!xfs_inode_hasattr(dp))
863 return -ENOATTR;
864
865 if (dp->i_af.if_format == XFS_DINODE_FMT_LOCAL) {
866 if (xfs_attr_sf_findname(args))
867 return -EEXIST;
868 return -ENOATTR;
869 }
870
871 if (xfs_attr_is_leaf(dp)) {
872 error = xfs_attr_leaf_hasname(args, &bp);
873
874 if (bp)
875 xfs_trans_brelse(args->trans, bp);
876
877 return error;
878 }
879
880 state = xfs_da_state_alloc(args);
881 error = xfs_attr_node_lookup(args, state);
882 xfs_da_state_free(state);
883 return error;
884}
885
886static void
887xfs_attr_defer_add(
888 struct xfs_da_args *args,
889 unsigned int op_flags)
890{
891
892 struct xfs_attr_intent *new;
893
894 new = kmem_cache_zalloc(xfs_attr_intent_cache, GFP_NOFS | __GFP_NOFAIL);
895 new->xattri_op_flags = op_flags;
896 new->xattri_da_args = args;
897
898 switch (op_flags) {
899 case XFS_ATTRI_OP_FLAGS_SET:
900 new->xattri_dela_state = xfs_attr_init_add_state(args);
901 break;
902 case XFS_ATTRI_OP_FLAGS_REPLACE:
903 new->xattri_dela_state = xfs_attr_init_replace_state(args);
904 break;
905 case XFS_ATTRI_OP_FLAGS_REMOVE:
906 new->xattri_dela_state = xfs_attr_init_remove_state(args);
907 break;
908 default:
909 ASSERT(0);
910 }
911
912 xfs_defer_add(args->trans, &new->xattri_list, &xfs_attr_defer_type);
913 trace_xfs_attr_defer_add(new->xattri_dela_state, args->dp);
914}
915
916/*
917 * Note: If args->value is NULL the attribute will be removed, just like the
918 * Linux ->setattr API.
919 */
920int
921xfs_attr_set(
922 struct xfs_da_args *args)
923{
924 struct xfs_inode *dp = args->dp;
925 struct xfs_mount *mp = dp->i_mount;
926 struct xfs_trans_res tres;
927 bool rsvd = (args->attr_filter & XFS_ATTR_ROOT);
928 int error, local;
929 int rmt_blks = 0;
930 unsigned int total;
931
932 if (xfs_is_shutdown(dp->i_mount))
933 return -EIO;
934
935 error = xfs_qm_dqattach(dp);
936 if (error)
937 return error;
938
939 args->geo = mp->m_attr_geo;
940 args->whichfork = XFS_ATTR_FORK;
941 args->hashval = xfs_da_hashname(args->name, args->namelen);
942
943 /*
944 * We have no control over the attribute names that userspace passes us
945 * to remove, so we have to allow the name lookup prior to attribute
946 * removal to fail as well. Preserve the logged flag, since we need
947 * to pass that through to the logging code.
948 */
949 args->op_flags = XFS_DA_OP_OKNOENT |
950 (args->op_flags & XFS_DA_OP_LOGGED);
951
952 if (args->value) {
953 XFS_STATS_INC(mp, xs_attr_set);
954 args->total = xfs_attr_calc_size(args, &local);
955
956 /*
957 * If the inode doesn't have an attribute fork, add one.
958 * (inode must not be locked when we call this routine)
959 */
960 if (xfs_inode_has_attr_fork(dp) == 0) {
961 int sf_size = sizeof(struct xfs_attr_sf_hdr) +
962 xfs_attr_sf_entsize_byname(args->namelen,
963 args->valuelen);
964
965 error = xfs_bmap_add_attrfork(dp, sf_size, rsvd);
966 if (error)
967 return error;
968 }
969
970 if (!local)
971 rmt_blks = xfs_attr3_rmt_blocks(mp, args->valuelen);
972 } else {
973 XFS_STATS_INC(mp, xs_attr_remove);
974 rmt_blks = xfs_attr3_rmt_blocks(mp, XFS_XATTR_SIZE_MAX);
975 }
976
977 /*
978 * Root fork attributes can use reserved data blocks for this
979 * operation if necessary
980 */
981 xfs_init_attr_trans(args, &tres, &total);
982 error = xfs_trans_alloc_inode(dp, &tres, total, 0, rsvd, &args->trans);
983 if (error)
984 return error;
985
986 if (args->value || xfs_inode_hasattr(dp)) {
987 error = xfs_iext_count_may_overflow(dp, XFS_ATTR_FORK,
988 XFS_IEXT_ATTR_MANIP_CNT(rmt_blks));
989 if (error == -EFBIG)
990 error = xfs_iext_count_upgrade(args->trans, dp,
991 XFS_IEXT_ATTR_MANIP_CNT(rmt_blks));
992 if (error)
993 goto out_trans_cancel;
994 }
995
996 error = xfs_attr_lookup(args);
997 switch (error) {
998 case -EEXIST:
999 if (!args->value) {
1000 /* if no value, we are performing a remove operation */
1001 xfs_attr_defer_add(args, XFS_ATTRI_OP_FLAGS_REMOVE);
1002 break;
1003 }
1004
1005 /* Pure create fails if the attr already exists */
1006 if (args->attr_flags & XATTR_CREATE)
1007 goto out_trans_cancel;
1008 xfs_attr_defer_add(args, XFS_ATTRI_OP_FLAGS_REPLACE);
1009 break;
1010 case -ENOATTR:
1011 /* Can't remove what isn't there. */
1012 if (!args->value)
1013 goto out_trans_cancel;
1014
1015 /* Pure replace fails if no existing attr to replace. */
1016 if (args->attr_flags & XATTR_REPLACE)
1017 goto out_trans_cancel;
1018 xfs_attr_defer_add(args, XFS_ATTRI_OP_FLAGS_SET);
1019 break;
1020 default:
1021 goto out_trans_cancel;
1022 }
1023
1024 /*
1025 * If this is a synchronous mount, make sure that the
1026 * transaction goes to disk before returning to the user.
1027 */
1028 if (xfs_has_wsync(mp))
1029 xfs_trans_set_sync(args->trans);
1030
1031 if (!(args->op_flags & XFS_DA_OP_NOTIME))
1032 xfs_trans_ichgtime(args->trans, dp, XFS_ICHGTIME_CHG);
1033
1034 /*
1035 * Commit the last in the sequence of transactions.
1036 */
1037 xfs_trans_log_inode(args->trans, dp, XFS_ILOG_CORE);
1038 error = xfs_trans_commit(args->trans);
1039out_unlock:
1040 xfs_iunlock(dp, XFS_ILOCK_EXCL);
1041 return error;
1042
1043out_trans_cancel:
1044 if (args->trans)
1045 xfs_trans_cancel(args->trans);
1046 goto out_unlock;
1047}
1048
1049/*========================================================================
1050 * External routines when attribute list is inside the inode
1051 *========================================================================*/
1052
1053static inline int xfs_attr_sf_totsize(struct xfs_inode *dp)
1054{
1055 struct xfs_attr_sf_hdr *sf = dp->i_af.if_data;
1056
1057 return be16_to_cpu(sf->totsize);
1058}
1059
1060/*
1061 * Add a name to the shortform attribute list structure
1062 * This is the external routine.
1063 */
1064static int
1065xfs_attr_shortform_addname(
1066 struct xfs_da_args *args)
1067{
1068 int newsize, forkoff;
1069
1070 trace_xfs_attr_sf_addname(args);
1071
1072 if (xfs_attr_sf_findname(args)) {
1073 int error;
1074
1075 ASSERT(args->op_flags & XFS_DA_OP_REPLACE);
1076
1077 error = xfs_attr_sf_removename(args);
1078 if (error)
1079 return error;
1080
1081 /*
1082 * Since we have removed the old attr, clear XFS_DA_OP_REPLACE
1083 * so that the new attr doesn't fit in shortform format, the
1084 * leaf format add routine won't trip over the attr not being
1085 * around.
1086 */
1087 args->op_flags &= ~XFS_DA_OP_REPLACE;
1088 } else {
1089 ASSERT(!(args->op_flags & XFS_DA_OP_REPLACE));
1090 }
1091
1092 if (args->namelen >= XFS_ATTR_SF_ENTSIZE_MAX ||
1093 args->valuelen >= XFS_ATTR_SF_ENTSIZE_MAX)
1094 return -ENOSPC;
1095
1096 newsize = xfs_attr_sf_totsize(args->dp);
1097 newsize += xfs_attr_sf_entsize_byname(args->namelen, args->valuelen);
1098
1099 forkoff = xfs_attr_shortform_bytesfit(args->dp, newsize);
1100 if (!forkoff)
1101 return -ENOSPC;
1102
1103 xfs_attr_shortform_add(args, forkoff);
1104 return 0;
1105}
1106
1107
1108/*========================================================================
1109 * External routines when attribute list is one block
1110 *========================================================================*/
1111
1112/* Save the current remote block info and clear the current pointers. */
1113static void
1114xfs_attr_save_rmt_blk(
1115 struct xfs_da_args *args)
1116{
1117 args->blkno2 = args->blkno;
1118 args->index2 = args->index;
1119 args->rmtblkno2 = args->rmtblkno;
1120 args->rmtblkcnt2 = args->rmtblkcnt;
1121 args->rmtvaluelen2 = args->rmtvaluelen;
1122 args->rmtblkno = 0;
1123 args->rmtblkcnt = 0;
1124 args->rmtvaluelen = 0;
1125}
1126
1127/* Set stored info about a remote block */
1128static void
1129xfs_attr_restore_rmt_blk(
1130 struct xfs_da_args *args)
1131{
1132 args->blkno = args->blkno2;
1133 args->index = args->index2;
1134 args->rmtblkno = args->rmtblkno2;
1135 args->rmtblkcnt = args->rmtblkcnt2;
1136 args->rmtvaluelen = args->rmtvaluelen2;
1137}
1138
1139/*
1140 * Tries to add an attribute to an inode in leaf form
1141 *
1142 * This function is meant to execute as part of a delayed operation and leaves
1143 * the transaction handling to the caller. On success the attribute is added
1144 * and the inode and transaction are left dirty. If there is not enough space,
1145 * the attr data is converted to node format and -ENOSPC is returned. Caller is
1146 * responsible for handling the dirty inode and transaction or adding the attr
1147 * in node format.
1148 */
1149STATIC int
1150xfs_attr_leaf_try_add(
1151 struct xfs_da_args *args)
1152{
1153 struct xfs_buf *bp;
1154 int error;
1155
1156 error = xfs_attr3_leaf_read(args->trans, args->dp, 0, &bp);
1157 if (error)
1158 return error;
1159
1160 /*
1161 * Look up the xattr name to set the insertion point for the new xattr.
1162 */
1163 error = xfs_attr3_leaf_lookup_int(bp, args);
1164 switch (error) {
1165 case -ENOATTR:
1166 if (args->op_flags & XFS_DA_OP_REPLACE)
1167 goto out_brelse;
1168 break;
1169 case -EEXIST:
1170 if (!(args->op_flags & XFS_DA_OP_REPLACE))
1171 goto out_brelse;
1172
1173 trace_xfs_attr_leaf_replace(args);
1174 /*
1175 * Save the existing remote attr state so that the current
1176 * values reflect the state of the new attribute we are about to
1177 * add, not the attribute we just found and will remove later.
1178 */
1179 xfs_attr_save_rmt_blk(args);
1180 break;
1181 case 0:
1182 break;
1183 default:
1184 goto out_brelse;
1185 }
1186
1187 return xfs_attr3_leaf_add(bp, args);
1188
1189out_brelse:
1190 xfs_trans_brelse(args->trans, bp);
1191 return error;
1192}
1193
1194/*
1195 * Return EEXIST if attr is found, or ENOATTR if not
1196 */
1197STATIC int
1198xfs_attr_leaf_hasname(
1199 struct xfs_da_args *args,
1200 struct xfs_buf **bp)
1201{
1202 int error = 0;
1203
1204 error = xfs_attr3_leaf_read(args->trans, args->dp, 0, bp);
1205 if (error)
1206 return error;
1207
1208 error = xfs_attr3_leaf_lookup_int(*bp, args);
1209 if (error != -ENOATTR && error != -EEXIST)
1210 xfs_trans_brelse(args->trans, *bp);
1211
1212 return error;
1213}
1214
1215/*
1216 * Remove a name from the leaf attribute list structure
1217 *
1218 * This leaf block cannot have a "remote" value, we only call this routine
1219 * if bmap_one_block() says there is only one block (ie: no remote blks).
1220 */
1221STATIC int
1222xfs_attr_leaf_removename(
1223 struct xfs_da_args *args)
1224{
1225 struct xfs_inode *dp;
1226 struct xfs_buf *bp;
1227 int error, forkoff;
1228
1229 trace_xfs_attr_leaf_removename(args);
1230
1231 /*
1232 * Remove the attribute.
1233 */
1234 dp = args->dp;
1235
1236 error = xfs_attr_leaf_hasname(args, &bp);
1237 if (error == -ENOATTR) {
1238 xfs_trans_brelse(args->trans, bp);
1239 if (args->op_flags & XFS_DA_OP_RECOVERY)
1240 return 0;
1241 return error;
1242 } else if (error != -EEXIST)
1243 return error;
1244
1245 xfs_attr3_leaf_remove(bp, args);
1246
1247 /*
1248 * If the result is small enough, shrink it all into the inode.
1249 */
1250 forkoff = xfs_attr_shortform_allfit(bp, dp);
1251 if (forkoff)
1252 return xfs_attr3_leaf_to_shortform(bp, args, forkoff);
1253 /* bp is gone due to xfs_da_shrink_inode */
1254
1255 return 0;
1256}
1257
1258/*
1259 * Look up a name in a leaf attribute list structure.
1260 *
1261 * This leaf block cannot have a "remote" value, we only call this routine
1262 * if bmap_one_block() says there is only one block (ie: no remote blks).
1263 *
1264 * Returns 0 on successful retrieval, otherwise an error.
1265 */
1266STATIC int
1267xfs_attr_leaf_get(xfs_da_args_t *args)
1268{
1269 struct xfs_buf *bp;
1270 int error;
1271
1272 trace_xfs_attr_leaf_get(args);
1273
1274 error = xfs_attr_leaf_hasname(args, &bp);
1275
1276 if (error == -ENOATTR) {
1277 xfs_trans_brelse(args->trans, bp);
1278 return error;
1279 } else if (error != -EEXIST)
1280 return error;
1281
1282
1283 error = xfs_attr3_leaf_getvalue(bp, args);
1284 xfs_trans_brelse(args->trans, bp);
1285 return error;
1286}
1287
1288/* Return EEXIST if attr is found, or ENOATTR if not. */
1289STATIC int
1290xfs_attr_node_lookup(
1291 struct xfs_da_args *args,
1292 struct xfs_da_state *state)
1293{
1294 int retval, error;
1295
1296 /*
1297 * Search to see if name exists, and get back a pointer to it.
1298 */
1299 error = xfs_da3_node_lookup_int(state, &retval);
1300 if (error)
1301 return error;
1302
1303 return retval;
1304}
1305
1306/*========================================================================
1307 * External routines when attribute list size > geo->blksize
1308 *========================================================================*/
1309
1310STATIC int
1311xfs_attr_node_addname_find_attr(
1312 struct xfs_attr_intent *attr)
1313{
1314 struct xfs_da_args *args = attr->xattri_da_args;
1315 int error;
1316
1317 /*
1318 * Search to see if name already exists, and get back a pointer
1319 * to where it should go.
1320 */
1321 xfs_attr_item_init_da_state(attr);
1322 error = xfs_attr_node_lookup(args, attr->xattri_da_state);
1323 switch (error) {
1324 case -ENOATTR:
1325 if (args->op_flags & XFS_DA_OP_REPLACE)
1326 goto error;
1327 break;
1328 case -EEXIST:
1329 if (!(args->op_flags & XFS_DA_OP_REPLACE))
1330 goto error;
1331
1332
1333 trace_xfs_attr_node_replace(args);
1334 /*
1335 * Save the existing remote attr state so that the current
1336 * values reflect the state of the new attribute we are about to
1337 * add, not the attribute we just found and will remove later.
1338 */
1339 xfs_attr_save_rmt_blk(args);
1340 break;
1341 case 0:
1342 break;
1343 default:
1344 goto error;
1345 }
1346
1347 return 0;
1348error:
1349 if (attr->xattri_da_state) {
1350 xfs_da_state_free(attr->xattri_da_state);
1351 attr->xattri_da_state = NULL;
1352 }
1353 return error;
1354}
1355
1356/*
1357 * Add a name to a Btree-format attribute list.
1358 *
1359 * This will involve walking down the Btree, and may involve splitting
1360 * leaf nodes and even splitting intermediate nodes up to and including
1361 * the root node (a special case of an intermediate node).
1362 */
1363static int
1364xfs_attr_node_try_addname(
1365 struct xfs_attr_intent *attr)
1366{
1367 struct xfs_da_state *state = attr->xattri_da_state;
1368 struct xfs_da_state_blk *blk;
1369 int error;
1370
1371 trace_xfs_attr_node_addname(state->args);
1372
1373 blk = &state->path.blk[state->path.active-1];
1374 ASSERT(blk->magic == XFS_ATTR_LEAF_MAGIC);
1375
1376 error = xfs_attr3_leaf_add(blk->bp, state->args);
1377 if (error == -ENOSPC) {
1378 if (state->path.active == 1) {
1379 /*
1380 * Its really a single leaf node, but it had
1381 * out-of-line values so it looked like it *might*
1382 * have been a b-tree. Let the caller deal with this.
1383 */
1384 goto out;
1385 }
1386
1387 /*
1388 * Split as many Btree elements as required.
1389 * This code tracks the new and old attr's location
1390 * in the index/blkno/rmtblkno/rmtblkcnt fields and
1391 * in the index2/blkno2/rmtblkno2/rmtblkcnt2 fields.
1392 */
1393 error = xfs_da3_split(state);
1394 if (error)
1395 goto out;
1396 } else {
1397 /*
1398 * Addition succeeded, update Btree hashvals.
1399 */
1400 xfs_da3_fixhashpath(state, &state->path);
1401 }
1402
1403out:
1404 xfs_da_state_free(state);
1405 attr->xattri_da_state = NULL;
1406 return error;
1407}
1408
1409static int
1410xfs_attr_node_removename(
1411 struct xfs_da_args *args,
1412 struct xfs_da_state *state)
1413{
1414 struct xfs_da_state_blk *blk;
1415 int retval;
1416
1417 /*
1418 * Remove the name and update the hashvals in the tree.
1419 */
1420 blk = &state->path.blk[state->path.active-1];
1421 ASSERT(blk->magic == XFS_ATTR_LEAF_MAGIC);
1422 retval = xfs_attr3_leaf_remove(blk->bp, args);
1423 xfs_da3_fixhashpath(state, &state->path);
1424
1425 return retval;
1426}
1427
1428static int
1429xfs_attr_node_remove_attr(
1430 struct xfs_attr_intent *attr)
1431{
1432 struct xfs_da_args *args = attr->xattri_da_args;
1433 struct xfs_da_state *state = xfs_da_state_alloc(args);
1434 int retval = 0;
1435 int error = 0;
1436
1437 /*
1438 * The attr we are removing has already been marked incomplete, so
1439 * we need to set the filter appropriately to re-find the "old"
1440 * attribute entry after any split ops.
1441 */
1442 args->attr_filter |= XFS_ATTR_INCOMPLETE;
1443 error = xfs_da3_node_lookup_int(state, &retval);
1444 if (error)
1445 goto out;
1446
1447 error = xfs_attr_node_removename(args, state);
1448
1449 /*
1450 * Check to see if the tree needs to be collapsed.
1451 */
1452 if (retval && (state->path.active > 1)) {
1453 error = xfs_da3_join(state);
1454 if (error)
1455 goto out;
1456 }
1457 retval = error = 0;
1458
1459out:
1460 xfs_da_state_free(state);
1461 if (error)
1462 return error;
1463 return retval;
1464}
1465
1466/*
1467 * Retrieve the attribute data from a node attribute list.
1468 *
1469 * This routine gets called for any attribute fork that has more than one
1470 * block, ie: both true Btree attr lists and for single-leaf-blocks with
1471 * "remote" values taking up more blocks.
1472 *
1473 * Returns 0 on successful retrieval, otherwise an error.
1474 */
1475STATIC int
1476xfs_attr_node_get(
1477 struct xfs_da_args *args)
1478{
1479 struct xfs_da_state *state;
1480 struct xfs_da_state_blk *blk;
1481 int i;
1482 int error;
1483
1484 trace_xfs_attr_node_get(args);
1485
1486 /*
1487 * Search to see if name exists, and get back a pointer to it.
1488 */
1489 state = xfs_da_state_alloc(args);
1490 error = xfs_attr_node_lookup(args, state);
1491 if (error != -EEXIST)
1492 goto out_release;
1493
1494 /*
1495 * Get the value, local or "remote"
1496 */
1497 blk = &state->path.blk[state->path.active - 1];
1498 error = xfs_attr3_leaf_getvalue(blk->bp, args);
1499
1500 /*
1501 * If not in a transaction, we have to release all the buffers.
1502 */
1503out_release:
1504 for (i = 0; i < state->path.active; i++) {
1505 xfs_trans_brelse(args->trans, state->path.blk[i].bp);
1506 state->path.blk[i].bp = NULL;
1507 }
1508
1509 xfs_da_state_free(state);
1510 return error;
1511}
1512
1513/* Returns true if the attribute entry name is valid. */
1514bool
1515xfs_attr_namecheck(
1516 const void *name,
1517 size_t length)
1518{
1519 /*
1520 * MAXNAMELEN includes the trailing null, but (name/length) leave it
1521 * out, so use >= for the length check.
1522 */
1523 if (length >= MAXNAMELEN)
1524 return false;
1525
1526 /* There shouldn't be any nulls here */
1527 return !memchr(name, 0, length);
1528}
1529
1530int __init
1531xfs_attr_intent_init_cache(void)
1532{
1533 xfs_attr_intent_cache = kmem_cache_create("xfs_attr_intent",
1534 sizeof(struct xfs_attr_intent),
1535 0, 0, NULL);
1536
1537 return xfs_attr_intent_cache != NULL ? 0 : -ENOMEM;
1538}
1539
1540void
1541xfs_attr_intent_destroy_cache(void)
1542{
1543 kmem_cache_destroy(xfs_attr_intent_cache);
1544 xfs_attr_intent_cache = NULL;
1545}
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * Copyright (c) 2000-2005 Silicon Graphics, Inc.
4 * All Rights Reserved.
5 */
6#include "xfs.h"
7#include "xfs_fs.h"
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"
19#include "xfs_bmap.h"
20#include "xfs_bmap_btree.h"
21#include "xfs_attr.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
28/*
29 * xfs_attr.c
30 *
31 * Provide the external interfaces to manage attribute lists.
32 */
33
34/*========================================================================
35 * Function prototypes for the kernel.
36 *========================================================================*/
37
38/*
39 * Internal routines when attribute list fits inside the inode.
40 */
41STATIC int xfs_attr_shortform_addname(xfs_da_args_t *args);
42
43/*
44 * Internal routines when attribute list is one block.
45 */
46STATIC int xfs_attr_leaf_get(xfs_da_args_t *args);
47STATIC int xfs_attr_leaf_addname(xfs_da_args_t *args);
48STATIC int xfs_attr_leaf_removename(xfs_da_args_t *args);
49
50/*
51 * Internal routines when attribute list is more than one block.
52 */
53STATIC int xfs_attr_node_get(xfs_da_args_t *args);
54STATIC int xfs_attr_node_addname(xfs_da_args_t *args);
55STATIC int xfs_attr_node_removename(xfs_da_args_t *args);
56STATIC int xfs_attr_fillstate(xfs_da_state_t *state);
57STATIC int xfs_attr_refillstate(xfs_da_state_t *state);
58
59
60STATIC int
61xfs_attr_args_init(
62 struct xfs_da_args *args,
63 struct xfs_inode *dp,
64 const unsigned char *name,
65 int flags)
66{
67
68 if (!name)
69 return -EINVAL;
70
71 memset(args, 0, sizeof(*args));
72 args->geo = dp->i_mount->m_attr_geo;
73 args->whichfork = XFS_ATTR_FORK;
74 args->dp = dp;
75 args->flags = flags;
76 args->name = name;
77 args->namelen = strlen((const char *)name);
78 if (args->namelen >= MAXNAMELEN)
79 return -EFAULT; /* match IRIX behaviour */
80
81 args->hashval = xfs_da_hashname(args->name, args->namelen);
82 return 0;
83}
84
85int
86xfs_inode_hasattr(
87 struct xfs_inode *ip)
88{
89 if (!XFS_IFORK_Q(ip) ||
90 (ip->i_d.di_aformat == XFS_DINODE_FMT_EXTENTS &&
91 ip->i_d.di_anextents == 0))
92 return 0;
93 return 1;
94}
95
96/*========================================================================
97 * Overall external interface routines.
98 *========================================================================*/
99
100/*
101 * Retrieve an extended attribute and its value. Must have ilock.
102 * Returns 0 on successful retrieval, otherwise an error.
103 */
104int
105xfs_attr_get_ilocked(
106 struct xfs_inode *ip,
107 struct xfs_da_args *args)
108{
109 ASSERT(xfs_isilocked(ip, XFS_ILOCK_SHARED | XFS_ILOCK_EXCL));
110
111 if (!xfs_inode_hasattr(ip))
112 return -ENOATTR;
113 else if (ip->i_d.di_aformat == XFS_DINODE_FMT_LOCAL)
114 return xfs_attr_shortform_getvalue(args);
115 else if (xfs_bmap_one_block(ip, XFS_ATTR_FORK))
116 return xfs_attr_leaf_get(args);
117 else
118 return xfs_attr_node_get(args);
119}
120
121/*
122 * Retrieve an extended attribute by name, and its value if requested.
123 *
124 * If ATTR_KERNOVAL is set in @flags, then the caller does not want the value,
125 * just an indication whether the attribute exists and the size of the value if
126 * it exists. The size is returned in @valuelenp,
127 *
128 * If the attribute is found, but exceeds the size limit set by the caller in
129 * @valuelenp, return -ERANGE with the size of the attribute that was found in
130 * @valuelenp.
131 *
132 * If ATTR_ALLOC is set in @flags, allocate the buffer for the value after
133 * existence of the attribute has been determined. On success, return that
134 * buffer to the caller and leave them to free it. On failure, free any
135 * allocated buffer and ensure the buffer pointer returned to the caller is
136 * null.
137 */
138int
139xfs_attr_get(
140 struct xfs_inode *ip,
141 const unsigned char *name,
142 unsigned char **value,
143 int *valuelenp,
144 int flags)
145{
146 struct xfs_da_args args;
147 uint lock_mode;
148 int error;
149
150 ASSERT((flags & (ATTR_ALLOC | ATTR_KERNOVAL)) || *value);
151
152 XFS_STATS_INC(ip->i_mount, xs_attr_get);
153
154 if (XFS_FORCED_SHUTDOWN(ip->i_mount))
155 return -EIO;
156
157 error = xfs_attr_args_init(&args, ip, name, flags);
158 if (error)
159 return error;
160
161 /* Entirely possible to look up a name which doesn't exist */
162 args.op_flags = XFS_DA_OP_OKNOENT;
163 if (flags & ATTR_ALLOC)
164 args.op_flags |= XFS_DA_OP_ALLOCVAL;
165 else
166 args.value = *value;
167 args.valuelen = *valuelenp;
168
169 lock_mode = xfs_ilock_attr_map_shared(ip);
170 error = xfs_attr_get_ilocked(ip, &args);
171 xfs_iunlock(ip, lock_mode);
172 *valuelenp = args.valuelen;
173
174 /* on error, we have to clean up allocated value buffers */
175 if (error) {
176 if (flags & ATTR_ALLOC) {
177 kmem_free(args.value);
178 *value = NULL;
179 }
180 return error;
181 }
182 *value = args.value;
183 return 0;
184}
185
186/*
187 * Calculate how many blocks we need for the new attribute,
188 */
189STATIC int
190xfs_attr_calc_size(
191 struct xfs_da_args *args,
192 int *local)
193{
194 struct xfs_mount *mp = args->dp->i_mount;
195 int size;
196 int nblks;
197
198 /*
199 * Determine space new attribute will use, and if it would be
200 * "local" or "remote" (note: local != inline).
201 */
202 size = xfs_attr_leaf_newentsize(args, local);
203 nblks = XFS_DAENTER_SPACE_RES(mp, XFS_ATTR_FORK);
204 if (*local) {
205 if (size > (args->geo->blksize / 2)) {
206 /* Double split possible */
207 nblks *= 2;
208 }
209 } else {
210 /*
211 * Out of line attribute, cannot double split, but
212 * make room for the attribute value itself.
213 */
214 uint dblocks = xfs_attr3_rmt_blocks(mp, args->valuelen);
215 nblks += dblocks;
216 nblks += XFS_NEXTENTADD_SPACE_RES(mp, dblocks, XFS_ATTR_FORK);
217 }
218
219 return nblks;
220}
221
222STATIC int
223xfs_attr_try_sf_addname(
224 struct xfs_inode *dp,
225 struct xfs_da_args *args)
226{
227
228 struct xfs_mount *mp = dp->i_mount;
229 int error, error2;
230
231 error = xfs_attr_shortform_addname(args);
232 if (error == -ENOSPC)
233 return error;
234
235 /*
236 * Commit the shortform mods, and we're done.
237 * NOTE: this is also the error path (EEXIST, etc).
238 */
239 if (!error && (args->flags & ATTR_KERNOTIME) == 0)
240 xfs_trans_ichgtime(args->trans, dp, XFS_ICHGTIME_CHG);
241
242 if (mp->m_flags & XFS_MOUNT_WSYNC)
243 xfs_trans_set_sync(args->trans);
244
245 error2 = xfs_trans_commit(args->trans);
246 args->trans = NULL;
247 return error ? error : error2;
248}
249
250/*
251 * Set the attribute specified in @args.
252 */
253int
254xfs_attr_set_args(
255 struct xfs_da_args *args)
256{
257 struct xfs_inode *dp = args->dp;
258 struct xfs_buf *leaf_bp = NULL;
259 int error;
260
261 /*
262 * If the attribute list is non-existent or a shortform list,
263 * upgrade it to a single-leaf-block attribute list.
264 */
265 if (dp->i_d.di_aformat == XFS_DINODE_FMT_LOCAL ||
266 (dp->i_d.di_aformat == XFS_DINODE_FMT_EXTENTS &&
267 dp->i_d.di_anextents == 0)) {
268
269 /*
270 * Build initial attribute list (if required).
271 */
272 if (dp->i_d.di_aformat == XFS_DINODE_FMT_EXTENTS)
273 xfs_attr_shortform_create(args);
274
275 /*
276 * Try to add the attr to the attribute list in the inode.
277 */
278 error = xfs_attr_try_sf_addname(dp, args);
279 if (error != -ENOSPC)
280 return error;
281
282 /*
283 * It won't fit in the shortform, transform to a leaf block.
284 * GROT: another possible req'mt for a double-split btree op.
285 */
286 error = xfs_attr_shortform_to_leaf(args, &leaf_bp);
287 if (error)
288 return error;
289
290 /*
291 * Prevent the leaf buffer from being unlocked so that a
292 * concurrent AIL push cannot grab the half-baked leaf
293 * buffer and run into problems with the write verifier.
294 * Once we're done rolling the transaction we can release
295 * the hold and add the attr to the leaf.
296 */
297 xfs_trans_bhold(args->trans, leaf_bp);
298 error = xfs_defer_finish(&args->trans);
299 xfs_trans_bhold_release(args->trans, leaf_bp);
300 if (error) {
301 xfs_trans_brelse(args->trans, leaf_bp);
302 return error;
303 }
304 }
305
306 if (xfs_bmap_one_block(dp, XFS_ATTR_FORK))
307 error = xfs_attr_leaf_addname(args);
308 else
309 error = xfs_attr_node_addname(args);
310 return error;
311}
312
313/*
314 * Remove the attribute specified in @args.
315 */
316int
317xfs_attr_remove_args(
318 struct xfs_da_args *args)
319{
320 struct xfs_inode *dp = args->dp;
321 int error;
322
323 if (!xfs_inode_hasattr(dp)) {
324 error = -ENOATTR;
325 } else if (dp->i_d.di_aformat == XFS_DINODE_FMT_LOCAL) {
326 ASSERT(dp->i_afp->if_flags & XFS_IFINLINE);
327 error = xfs_attr_shortform_remove(args);
328 } else if (xfs_bmap_one_block(dp, XFS_ATTR_FORK)) {
329 error = xfs_attr_leaf_removename(args);
330 } else {
331 error = xfs_attr_node_removename(args);
332 }
333
334 return error;
335}
336
337int
338xfs_attr_set(
339 struct xfs_inode *dp,
340 const unsigned char *name,
341 unsigned char *value,
342 int valuelen,
343 int flags)
344{
345 struct xfs_mount *mp = dp->i_mount;
346 struct xfs_da_args args;
347 struct xfs_trans_res tres;
348 int rsvd = (flags & ATTR_ROOT) != 0;
349 int error, local;
350
351 XFS_STATS_INC(mp, xs_attr_set);
352
353 if (XFS_FORCED_SHUTDOWN(dp->i_mount))
354 return -EIO;
355
356 error = xfs_attr_args_init(&args, dp, name, flags);
357 if (error)
358 return error;
359
360 args.value = value;
361 args.valuelen = valuelen;
362 args.op_flags = XFS_DA_OP_ADDNAME | XFS_DA_OP_OKNOENT;
363 args.total = xfs_attr_calc_size(&args, &local);
364
365 error = xfs_qm_dqattach(dp);
366 if (error)
367 return error;
368
369 /*
370 * If the inode doesn't have an attribute fork, add one.
371 * (inode must not be locked when we call this routine)
372 */
373 if (XFS_IFORK_Q(dp) == 0) {
374 int sf_size = sizeof(xfs_attr_sf_hdr_t) +
375 XFS_ATTR_SF_ENTSIZE_BYNAME(args.namelen, valuelen);
376
377 error = xfs_bmap_add_attrfork(dp, sf_size, rsvd);
378 if (error)
379 return error;
380 }
381
382 tres.tr_logres = M_RES(mp)->tr_attrsetm.tr_logres +
383 M_RES(mp)->tr_attrsetrt.tr_logres * args.total;
384 tres.tr_logcount = XFS_ATTRSET_LOG_COUNT;
385 tres.tr_logflags = XFS_TRANS_PERM_LOG_RES;
386
387 /*
388 * Root fork attributes can use reserved data blocks for this
389 * operation if necessary
390 */
391 error = xfs_trans_alloc(mp, &tres, args.total, 0,
392 rsvd ? XFS_TRANS_RESERVE : 0, &args.trans);
393 if (error)
394 return error;
395
396 xfs_ilock(dp, XFS_ILOCK_EXCL);
397 error = xfs_trans_reserve_quota_nblks(args.trans, dp, args.total, 0,
398 rsvd ? XFS_QMOPT_RES_REGBLKS | XFS_QMOPT_FORCE_RES :
399 XFS_QMOPT_RES_REGBLKS);
400 if (error)
401 goto out_trans_cancel;
402
403 xfs_trans_ijoin(args.trans, dp, 0);
404 error = xfs_attr_set_args(&args);
405 if (error)
406 goto out_trans_cancel;
407 if (!args.trans) {
408 /* shortform attribute has already been committed */
409 goto out_unlock;
410 }
411
412 /*
413 * If this is a synchronous mount, make sure that the
414 * transaction goes to disk before returning to the user.
415 */
416 if (mp->m_flags & XFS_MOUNT_WSYNC)
417 xfs_trans_set_sync(args.trans);
418
419 if ((flags & ATTR_KERNOTIME) == 0)
420 xfs_trans_ichgtime(args.trans, dp, XFS_ICHGTIME_CHG);
421
422 /*
423 * Commit the last in the sequence of transactions.
424 */
425 xfs_trans_log_inode(args.trans, dp, XFS_ILOG_CORE);
426 error = xfs_trans_commit(args.trans);
427out_unlock:
428 xfs_iunlock(dp, XFS_ILOCK_EXCL);
429 return error;
430
431out_trans_cancel:
432 if (args.trans)
433 xfs_trans_cancel(args.trans);
434 goto out_unlock;
435}
436
437/*
438 * Generic handler routine to remove a name from an attribute list.
439 * Transitions attribute list from Btree to shortform as necessary.
440 */
441int
442xfs_attr_remove(
443 struct xfs_inode *dp,
444 const unsigned char *name,
445 int flags)
446{
447 struct xfs_mount *mp = dp->i_mount;
448 struct xfs_da_args args;
449 int error;
450
451 XFS_STATS_INC(mp, xs_attr_remove);
452
453 if (XFS_FORCED_SHUTDOWN(dp->i_mount))
454 return -EIO;
455
456 error = xfs_attr_args_init(&args, dp, name, flags);
457 if (error)
458 return error;
459
460 /*
461 * we have no control over the attribute names that userspace passes us
462 * to remove, so we have to allow the name lookup prior to attribute
463 * removal to fail.
464 */
465 args.op_flags = XFS_DA_OP_OKNOENT;
466
467 error = xfs_qm_dqattach(dp);
468 if (error)
469 return error;
470
471 /*
472 * Root fork attributes can use reserved data blocks for this
473 * operation if necessary
474 */
475 error = xfs_trans_alloc(mp, &M_RES(mp)->tr_attrrm,
476 XFS_ATTRRM_SPACE_RES(mp), 0,
477 (flags & ATTR_ROOT) ? XFS_TRANS_RESERVE : 0,
478 &args.trans);
479 if (error)
480 return error;
481
482 xfs_ilock(dp, XFS_ILOCK_EXCL);
483 /*
484 * No need to make quota reservations here. We expect to release some
485 * blocks not allocate in the common case.
486 */
487 xfs_trans_ijoin(args.trans, dp, 0);
488
489 error = xfs_attr_remove_args(&args);
490 if (error)
491 goto out;
492
493 /*
494 * If this is a synchronous mount, make sure that the
495 * transaction goes to disk before returning to the user.
496 */
497 if (mp->m_flags & XFS_MOUNT_WSYNC)
498 xfs_trans_set_sync(args.trans);
499
500 if ((flags & ATTR_KERNOTIME) == 0)
501 xfs_trans_ichgtime(args.trans, dp, XFS_ICHGTIME_CHG);
502
503 /*
504 * Commit the last in the sequence of transactions.
505 */
506 xfs_trans_log_inode(args.trans, dp, XFS_ILOG_CORE);
507 error = xfs_trans_commit(args.trans);
508 xfs_iunlock(dp, XFS_ILOCK_EXCL);
509
510 return error;
511
512out:
513 if (args.trans)
514 xfs_trans_cancel(args.trans);
515 xfs_iunlock(dp, XFS_ILOCK_EXCL);
516 return error;
517}
518
519/*========================================================================
520 * External routines when attribute list is inside the inode
521 *========================================================================*/
522
523/*
524 * Add a name to the shortform attribute list structure
525 * This is the external routine.
526 */
527STATIC int
528xfs_attr_shortform_addname(xfs_da_args_t *args)
529{
530 int newsize, forkoff, retval;
531
532 trace_xfs_attr_sf_addname(args);
533
534 retval = xfs_attr_shortform_lookup(args);
535 if ((args->flags & ATTR_REPLACE) && (retval == -ENOATTR)) {
536 return retval;
537 } else if (retval == -EEXIST) {
538 if (args->flags & ATTR_CREATE)
539 return retval;
540 retval = xfs_attr_shortform_remove(args);
541 if (retval)
542 return retval;
543 /*
544 * Since we have removed the old attr, clear ATTR_REPLACE so
545 * that the leaf format add routine won't trip over the attr
546 * not being around.
547 */
548 args->flags &= ~ATTR_REPLACE;
549 }
550
551 if (args->namelen >= XFS_ATTR_SF_ENTSIZE_MAX ||
552 args->valuelen >= XFS_ATTR_SF_ENTSIZE_MAX)
553 return -ENOSPC;
554
555 newsize = XFS_ATTR_SF_TOTSIZE(args->dp);
556 newsize += XFS_ATTR_SF_ENTSIZE_BYNAME(args->namelen, args->valuelen);
557
558 forkoff = xfs_attr_shortform_bytesfit(args->dp, newsize);
559 if (!forkoff)
560 return -ENOSPC;
561
562 xfs_attr_shortform_add(args, forkoff);
563 return 0;
564}
565
566
567/*========================================================================
568 * External routines when attribute list is one block
569 *========================================================================*/
570
571/*
572 * Add a name to the leaf attribute list structure
573 *
574 * This leaf block cannot have a "remote" value, we only call this routine
575 * if bmap_one_block() says there is only one block (ie: no remote blks).
576 */
577STATIC int
578xfs_attr_leaf_addname(
579 struct xfs_da_args *args)
580{
581 struct xfs_inode *dp;
582 struct xfs_buf *bp;
583 int retval, error, forkoff;
584
585 trace_xfs_attr_leaf_addname(args);
586
587 /*
588 * Read the (only) block in the attribute list in.
589 */
590 dp = args->dp;
591 args->blkno = 0;
592 error = xfs_attr3_leaf_read(args->trans, args->dp, args->blkno, -1, &bp);
593 if (error)
594 return error;
595
596 /*
597 * Look up the given attribute in the leaf block. Figure out if
598 * the given flags produce an error or call for an atomic rename.
599 */
600 retval = xfs_attr3_leaf_lookup_int(bp, args);
601 if ((args->flags & ATTR_REPLACE) && (retval == -ENOATTR)) {
602 xfs_trans_brelse(args->trans, bp);
603 return retval;
604 } else if (retval == -EEXIST) {
605 if (args->flags & ATTR_CREATE) { /* pure create op */
606 xfs_trans_brelse(args->trans, bp);
607 return retval;
608 }
609
610 trace_xfs_attr_leaf_replace(args);
611
612 /* save the attribute state for later removal*/
613 args->op_flags |= XFS_DA_OP_RENAME; /* an atomic rename */
614 args->blkno2 = args->blkno; /* set 2nd entry info*/
615 args->index2 = args->index;
616 args->rmtblkno2 = args->rmtblkno;
617 args->rmtblkcnt2 = args->rmtblkcnt;
618 args->rmtvaluelen2 = args->rmtvaluelen;
619
620 /*
621 * clear the remote attr state now that it is saved so that the
622 * values reflect the state of the attribute we are about to
623 * add, not the attribute we just found and will remove later.
624 */
625 args->rmtblkno = 0;
626 args->rmtblkcnt = 0;
627 args->rmtvaluelen = 0;
628 }
629
630 /*
631 * Add the attribute to the leaf block, transitioning to a Btree
632 * if required.
633 */
634 retval = xfs_attr3_leaf_add(bp, args);
635 if (retval == -ENOSPC) {
636 /*
637 * Promote the attribute list to the Btree format, then
638 * Commit that transaction so that the node_addname() call
639 * can manage its own transactions.
640 */
641 error = xfs_attr3_leaf_to_node(args);
642 if (error)
643 return error;
644 error = xfs_defer_finish(&args->trans);
645 if (error)
646 return error;
647
648 /*
649 * Commit the current trans (including the inode) and start
650 * a new one.
651 */
652 error = xfs_trans_roll_inode(&args->trans, dp);
653 if (error)
654 return error;
655
656 /*
657 * Fob the whole rest of the problem off on the Btree code.
658 */
659 error = xfs_attr_node_addname(args);
660 return error;
661 }
662
663 /*
664 * Commit the transaction that added the attr name so that
665 * later routines can manage their own transactions.
666 */
667 error = xfs_trans_roll_inode(&args->trans, dp);
668 if (error)
669 return error;
670
671 /*
672 * If there was an out-of-line value, allocate the blocks we
673 * identified for its storage and copy the value. This is done
674 * after we create the attribute so that we don't overflow the
675 * maximum size of a transaction and/or hit a deadlock.
676 */
677 if (args->rmtblkno > 0) {
678 error = xfs_attr_rmtval_set(args);
679 if (error)
680 return error;
681 }
682
683 /*
684 * If this is an atomic rename operation, we must "flip" the
685 * incomplete flags on the "new" and "old" attribute/value pairs
686 * so that one disappears and one appears atomically. Then we
687 * must remove the "old" attribute/value pair.
688 */
689 if (args->op_flags & XFS_DA_OP_RENAME) {
690 /*
691 * In a separate transaction, set the incomplete flag on the
692 * "old" attr and clear the incomplete flag on the "new" attr.
693 */
694 error = xfs_attr3_leaf_flipflags(args);
695 if (error)
696 return error;
697
698 /*
699 * Dismantle the "old" attribute/value pair by removing
700 * a "remote" value (if it exists).
701 */
702 args->index = args->index2;
703 args->blkno = args->blkno2;
704 args->rmtblkno = args->rmtblkno2;
705 args->rmtblkcnt = args->rmtblkcnt2;
706 args->rmtvaluelen = args->rmtvaluelen2;
707 if (args->rmtblkno) {
708 error = xfs_attr_rmtval_remove(args);
709 if (error)
710 return error;
711 }
712
713 /*
714 * Read in the block containing the "old" attr, then
715 * remove the "old" attr from that block (neat, huh!)
716 */
717 error = xfs_attr3_leaf_read(args->trans, args->dp, args->blkno,
718 -1, &bp);
719 if (error)
720 return error;
721
722 xfs_attr3_leaf_remove(bp, args);
723
724 /*
725 * If the result is small enough, shrink it all into the inode.
726 */
727 if ((forkoff = xfs_attr_shortform_allfit(bp, dp))) {
728 error = xfs_attr3_leaf_to_shortform(bp, args, forkoff);
729 /* bp is gone due to xfs_da_shrink_inode */
730 if (error)
731 return error;
732 error = xfs_defer_finish(&args->trans);
733 if (error)
734 return error;
735 }
736
737 /*
738 * Commit the remove and start the next trans in series.
739 */
740 error = xfs_trans_roll_inode(&args->trans, dp);
741
742 } else if (args->rmtblkno > 0) {
743 /*
744 * Added a "remote" value, just clear the incomplete flag.
745 */
746 error = xfs_attr3_leaf_clearflag(args);
747 }
748 return error;
749}
750
751/*
752 * Remove a name from the leaf attribute list structure
753 *
754 * This leaf block cannot have a "remote" value, we only call this routine
755 * if bmap_one_block() says there is only one block (ie: no remote blks).
756 */
757STATIC int
758xfs_attr_leaf_removename(
759 struct xfs_da_args *args)
760{
761 struct xfs_inode *dp;
762 struct xfs_buf *bp;
763 int error, forkoff;
764
765 trace_xfs_attr_leaf_removename(args);
766
767 /*
768 * Remove the attribute.
769 */
770 dp = args->dp;
771 args->blkno = 0;
772 error = xfs_attr3_leaf_read(args->trans, args->dp, args->blkno, -1, &bp);
773 if (error)
774 return error;
775
776 error = xfs_attr3_leaf_lookup_int(bp, args);
777 if (error == -ENOATTR) {
778 xfs_trans_brelse(args->trans, bp);
779 return error;
780 }
781
782 xfs_attr3_leaf_remove(bp, args);
783
784 /*
785 * If the result is small enough, shrink it all into the inode.
786 */
787 if ((forkoff = xfs_attr_shortform_allfit(bp, dp))) {
788 error = xfs_attr3_leaf_to_shortform(bp, args, forkoff);
789 /* bp is gone due to xfs_da_shrink_inode */
790 if (error)
791 return error;
792 error = xfs_defer_finish(&args->trans);
793 if (error)
794 return error;
795 }
796 return 0;
797}
798
799/*
800 * Look up a name in a leaf attribute list structure.
801 *
802 * This leaf block cannot have a "remote" value, we only call this routine
803 * if bmap_one_block() says there is only one block (ie: no remote blks).
804 *
805 * Returns 0 on successful retrieval, otherwise an error.
806 */
807STATIC int
808xfs_attr_leaf_get(xfs_da_args_t *args)
809{
810 struct xfs_buf *bp;
811 int error;
812
813 trace_xfs_attr_leaf_get(args);
814
815 args->blkno = 0;
816 error = xfs_attr3_leaf_read(args->trans, args->dp, args->blkno, -1, &bp);
817 if (error)
818 return error;
819
820 error = xfs_attr3_leaf_lookup_int(bp, args);
821 if (error != -EEXIST) {
822 xfs_trans_brelse(args->trans, bp);
823 return error;
824 }
825 error = xfs_attr3_leaf_getvalue(bp, args);
826 xfs_trans_brelse(args->trans, bp);
827 return error;
828}
829
830/*========================================================================
831 * External routines when attribute list size > geo->blksize
832 *========================================================================*/
833
834/*
835 * Add a name to a Btree-format attribute list.
836 *
837 * This will involve walking down the Btree, and may involve splitting
838 * leaf nodes and even splitting intermediate nodes up to and including
839 * the root node (a special case of an intermediate node).
840 *
841 * "Remote" attribute values confuse the issue and atomic rename operations
842 * add a whole extra layer of confusion on top of that.
843 */
844STATIC int
845xfs_attr_node_addname(
846 struct xfs_da_args *args)
847{
848 struct xfs_da_state *state;
849 struct xfs_da_state_blk *blk;
850 struct xfs_inode *dp;
851 struct xfs_mount *mp;
852 int retval, error;
853
854 trace_xfs_attr_node_addname(args);
855
856 /*
857 * Fill in bucket of arguments/results/context to carry around.
858 */
859 dp = args->dp;
860 mp = dp->i_mount;
861restart:
862 state = xfs_da_state_alloc();
863 state->args = args;
864 state->mp = mp;
865
866 /*
867 * Search to see if name already exists, and get back a pointer
868 * to where it should go.
869 */
870 error = xfs_da3_node_lookup_int(state, &retval);
871 if (error)
872 goto out;
873 blk = &state->path.blk[ state->path.active-1 ];
874 ASSERT(blk->magic == XFS_ATTR_LEAF_MAGIC);
875 if ((args->flags & ATTR_REPLACE) && (retval == -ENOATTR)) {
876 goto out;
877 } else if (retval == -EEXIST) {
878 if (args->flags & ATTR_CREATE)
879 goto out;
880
881 trace_xfs_attr_node_replace(args);
882
883 /* save the attribute state for later removal*/
884 args->op_flags |= XFS_DA_OP_RENAME; /* atomic rename op */
885 args->blkno2 = args->blkno; /* set 2nd entry info*/
886 args->index2 = args->index;
887 args->rmtblkno2 = args->rmtblkno;
888 args->rmtblkcnt2 = args->rmtblkcnt;
889 args->rmtvaluelen2 = args->rmtvaluelen;
890
891 /*
892 * clear the remote attr state now that it is saved so that the
893 * values reflect the state of the attribute we are about to
894 * add, not the attribute we just found and will remove later.
895 */
896 args->rmtblkno = 0;
897 args->rmtblkcnt = 0;
898 args->rmtvaluelen = 0;
899 }
900
901 retval = xfs_attr3_leaf_add(blk->bp, state->args);
902 if (retval == -ENOSPC) {
903 if (state->path.active == 1) {
904 /*
905 * Its really a single leaf node, but it had
906 * out-of-line values so it looked like it *might*
907 * have been a b-tree.
908 */
909 xfs_da_state_free(state);
910 state = NULL;
911 error = xfs_attr3_leaf_to_node(args);
912 if (error)
913 goto out;
914 error = xfs_defer_finish(&args->trans);
915 if (error)
916 goto out;
917
918 /*
919 * Commit the node conversion and start the next
920 * trans in the chain.
921 */
922 error = xfs_trans_roll_inode(&args->trans, dp);
923 if (error)
924 goto out;
925
926 goto restart;
927 }
928
929 /*
930 * Split as many Btree elements as required.
931 * This code tracks the new and old attr's location
932 * in the index/blkno/rmtblkno/rmtblkcnt fields and
933 * in the index2/blkno2/rmtblkno2/rmtblkcnt2 fields.
934 */
935 error = xfs_da3_split(state);
936 if (error)
937 goto out;
938 error = xfs_defer_finish(&args->trans);
939 if (error)
940 goto out;
941 } else {
942 /*
943 * Addition succeeded, update Btree hashvals.
944 */
945 xfs_da3_fixhashpath(state, &state->path);
946 }
947
948 /*
949 * Kill the state structure, we're done with it and need to
950 * allow the buffers to come back later.
951 */
952 xfs_da_state_free(state);
953 state = NULL;
954
955 /*
956 * Commit the leaf addition or btree split and start the next
957 * trans in the chain.
958 */
959 error = xfs_trans_roll_inode(&args->trans, dp);
960 if (error)
961 goto out;
962
963 /*
964 * If there was an out-of-line value, allocate the blocks we
965 * identified for its storage and copy the value. This is done
966 * after we create the attribute so that we don't overflow the
967 * maximum size of a transaction and/or hit a deadlock.
968 */
969 if (args->rmtblkno > 0) {
970 error = xfs_attr_rmtval_set(args);
971 if (error)
972 return error;
973 }
974
975 /*
976 * If this is an atomic rename operation, we must "flip" the
977 * incomplete flags on the "new" and "old" attribute/value pairs
978 * so that one disappears and one appears atomically. Then we
979 * must remove the "old" attribute/value pair.
980 */
981 if (args->op_flags & XFS_DA_OP_RENAME) {
982 /*
983 * In a separate transaction, set the incomplete flag on the
984 * "old" attr and clear the incomplete flag on the "new" attr.
985 */
986 error = xfs_attr3_leaf_flipflags(args);
987 if (error)
988 goto out;
989
990 /*
991 * Dismantle the "old" attribute/value pair by removing
992 * a "remote" value (if it exists).
993 */
994 args->index = args->index2;
995 args->blkno = args->blkno2;
996 args->rmtblkno = args->rmtblkno2;
997 args->rmtblkcnt = args->rmtblkcnt2;
998 args->rmtvaluelen = args->rmtvaluelen2;
999 if (args->rmtblkno) {
1000 error = xfs_attr_rmtval_remove(args);
1001 if (error)
1002 return error;
1003 }
1004
1005 /*
1006 * Re-find the "old" attribute entry after any split ops.
1007 * The INCOMPLETE flag means that we will find the "old"
1008 * attr, not the "new" one.
1009 */
1010 args->flags |= XFS_ATTR_INCOMPLETE;
1011 state = xfs_da_state_alloc();
1012 state->args = args;
1013 state->mp = mp;
1014 state->inleaf = 0;
1015 error = xfs_da3_node_lookup_int(state, &retval);
1016 if (error)
1017 goto out;
1018
1019 /*
1020 * Remove the name and update the hashvals in the tree.
1021 */
1022 blk = &state->path.blk[ state->path.active-1 ];
1023 ASSERT(blk->magic == XFS_ATTR_LEAF_MAGIC);
1024 error = xfs_attr3_leaf_remove(blk->bp, args);
1025 xfs_da3_fixhashpath(state, &state->path);
1026
1027 /*
1028 * Check to see if the tree needs to be collapsed.
1029 */
1030 if (retval && (state->path.active > 1)) {
1031 error = xfs_da3_join(state);
1032 if (error)
1033 goto out;
1034 error = xfs_defer_finish(&args->trans);
1035 if (error)
1036 goto out;
1037 }
1038
1039 /*
1040 * Commit and start the next trans in the chain.
1041 */
1042 error = xfs_trans_roll_inode(&args->trans, dp);
1043 if (error)
1044 goto out;
1045
1046 } else if (args->rmtblkno > 0) {
1047 /*
1048 * Added a "remote" value, just clear the incomplete flag.
1049 */
1050 error = xfs_attr3_leaf_clearflag(args);
1051 if (error)
1052 goto out;
1053 }
1054 retval = error = 0;
1055
1056out:
1057 if (state)
1058 xfs_da_state_free(state);
1059 if (error)
1060 return error;
1061 return retval;
1062}
1063
1064/*
1065 * Remove a name from a B-tree attribute list.
1066 *
1067 * This will involve walking down the Btree, and may involve joining
1068 * leaf nodes and even joining intermediate nodes up to and including
1069 * the root node (a special case of an intermediate node).
1070 */
1071STATIC int
1072xfs_attr_node_removename(
1073 struct xfs_da_args *args)
1074{
1075 struct xfs_da_state *state;
1076 struct xfs_da_state_blk *blk;
1077 struct xfs_inode *dp;
1078 struct xfs_buf *bp;
1079 int retval, error, forkoff;
1080
1081 trace_xfs_attr_node_removename(args);
1082
1083 /*
1084 * Tie a string around our finger to remind us where we are.
1085 */
1086 dp = args->dp;
1087 state = xfs_da_state_alloc();
1088 state->args = args;
1089 state->mp = dp->i_mount;
1090
1091 /*
1092 * Search to see if name exists, and get back a pointer to it.
1093 */
1094 error = xfs_da3_node_lookup_int(state, &retval);
1095 if (error || (retval != -EEXIST)) {
1096 if (error == 0)
1097 error = retval;
1098 goto out;
1099 }
1100
1101 /*
1102 * If there is an out-of-line value, de-allocate the blocks.
1103 * This is done before we remove the attribute so that we don't
1104 * overflow the maximum size of a transaction and/or hit a deadlock.
1105 */
1106 blk = &state->path.blk[ state->path.active-1 ];
1107 ASSERT(blk->bp != NULL);
1108 ASSERT(blk->magic == XFS_ATTR_LEAF_MAGIC);
1109 if (args->rmtblkno > 0) {
1110 /*
1111 * Fill in disk block numbers in the state structure
1112 * so that we can get the buffers back after we commit
1113 * several transactions in the following calls.
1114 */
1115 error = xfs_attr_fillstate(state);
1116 if (error)
1117 goto out;
1118
1119 /*
1120 * Mark the attribute as INCOMPLETE, then bunmapi() the
1121 * remote value.
1122 */
1123 error = xfs_attr3_leaf_setflag(args);
1124 if (error)
1125 goto out;
1126 error = xfs_attr_rmtval_remove(args);
1127 if (error)
1128 goto out;
1129
1130 /*
1131 * Refill the state structure with buffers, the prior calls
1132 * released our buffers.
1133 */
1134 error = xfs_attr_refillstate(state);
1135 if (error)
1136 goto out;
1137 }
1138
1139 /*
1140 * Remove the name and update the hashvals in the tree.
1141 */
1142 blk = &state->path.blk[ state->path.active-1 ];
1143 ASSERT(blk->magic == XFS_ATTR_LEAF_MAGIC);
1144 retval = xfs_attr3_leaf_remove(blk->bp, args);
1145 xfs_da3_fixhashpath(state, &state->path);
1146
1147 /*
1148 * Check to see if the tree needs to be collapsed.
1149 */
1150 if (retval && (state->path.active > 1)) {
1151 error = xfs_da3_join(state);
1152 if (error)
1153 goto out;
1154 error = xfs_defer_finish(&args->trans);
1155 if (error)
1156 goto out;
1157 /*
1158 * Commit the Btree join operation and start a new trans.
1159 */
1160 error = xfs_trans_roll_inode(&args->trans, dp);
1161 if (error)
1162 goto out;
1163 }
1164
1165 /*
1166 * If the result is small enough, push it all into the inode.
1167 */
1168 if (xfs_bmap_one_block(dp, XFS_ATTR_FORK)) {
1169 /*
1170 * Have to get rid of the copy of this dabuf in the state.
1171 */
1172 ASSERT(state->path.active == 1);
1173 ASSERT(state->path.blk[0].bp);
1174 state->path.blk[0].bp = NULL;
1175
1176 error = xfs_attr3_leaf_read(args->trans, args->dp, 0, -1, &bp);
1177 if (error)
1178 goto out;
1179
1180 if ((forkoff = xfs_attr_shortform_allfit(bp, dp))) {
1181 error = xfs_attr3_leaf_to_shortform(bp, args, forkoff);
1182 /* bp is gone due to xfs_da_shrink_inode */
1183 if (error)
1184 goto out;
1185 error = xfs_defer_finish(&args->trans);
1186 if (error)
1187 goto out;
1188 } else
1189 xfs_trans_brelse(args->trans, bp);
1190 }
1191 error = 0;
1192
1193out:
1194 xfs_da_state_free(state);
1195 return error;
1196}
1197
1198/*
1199 * Fill in the disk block numbers in the state structure for the buffers
1200 * that are attached to the state structure.
1201 * This is done so that we can quickly reattach ourselves to those buffers
1202 * after some set of transaction commits have released these buffers.
1203 */
1204STATIC int
1205xfs_attr_fillstate(xfs_da_state_t *state)
1206{
1207 xfs_da_state_path_t *path;
1208 xfs_da_state_blk_t *blk;
1209 int level;
1210
1211 trace_xfs_attr_fillstate(state->args);
1212
1213 /*
1214 * Roll down the "path" in the state structure, storing the on-disk
1215 * block number for those buffers in the "path".
1216 */
1217 path = &state->path;
1218 ASSERT((path->active >= 0) && (path->active < XFS_DA_NODE_MAXDEPTH));
1219 for (blk = path->blk, level = 0; level < path->active; blk++, level++) {
1220 if (blk->bp) {
1221 blk->disk_blkno = XFS_BUF_ADDR(blk->bp);
1222 blk->bp = NULL;
1223 } else {
1224 blk->disk_blkno = 0;
1225 }
1226 }
1227
1228 /*
1229 * Roll down the "altpath" in the state structure, storing the on-disk
1230 * block number for those buffers in the "altpath".
1231 */
1232 path = &state->altpath;
1233 ASSERT((path->active >= 0) && (path->active < XFS_DA_NODE_MAXDEPTH));
1234 for (blk = path->blk, level = 0; level < path->active; blk++, level++) {
1235 if (blk->bp) {
1236 blk->disk_blkno = XFS_BUF_ADDR(blk->bp);
1237 blk->bp = NULL;
1238 } else {
1239 blk->disk_blkno = 0;
1240 }
1241 }
1242
1243 return 0;
1244}
1245
1246/*
1247 * Reattach the buffers to the state structure based on the disk block
1248 * numbers stored in the state structure.
1249 * This is done after some set of transaction commits have released those
1250 * buffers from our grip.
1251 */
1252STATIC int
1253xfs_attr_refillstate(xfs_da_state_t *state)
1254{
1255 xfs_da_state_path_t *path;
1256 xfs_da_state_blk_t *blk;
1257 int level, error;
1258
1259 trace_xfs_attr_refillstate(state->args);
1260
1261 /*
1262 * Roll down the "path" in the state structure, storing the on-disk
1263 * block number for those buffers in the "path".
1264 */
1265 path = &state->path;
1266 ASSERT((path->active >= 0) && (path->active < XFS_DA_NODE_MAXDEPTH));
1267 for (blk = path->blk, level = 0; level < path->active; blk++, level++) {
1268 if (blk->disk_blkno) {
1269 error = xfs_da3_node_read(state->args->trans,
1270 state->args->dp,
1271 blk->blkno, blk->disk_blkno,
1272 &blk->bp, XFS_ATTR_FORK);
1273 if (error)
1274 return error;
1275 } else {
1276 blk->bp = NULL;
1277 }
1278 }
1279
1280 /*
1281 * Roll down the "altpath" in the state structure, storing the on-disk
1282 * block number for those buffers in the "altpath".
1283 */
1284 path = &state->altpath;
1285 ASSERT((path->active >= 0) && (path->active < XFS_DA_NODE_MAXDEPTH));
1286 for (blk = path->blk, level = 0; level < path->active; blk++, level++) {
1287 if (blk->disk_blkno) {
1288 error = xfs_da3_node_read(state->args->trans,
1289 state->args->dp,
1290 blk->blkno, blk->disk_blkno,
1291 &blk->bp, XFS_ATTR_FORK);
1292 if (error)
1293 return error;
1294 } else {
1295 blk->bp = NULL;
1296 }
1297 }
1298
1299 return 0;
1300}
1301
1302/*
1303 * Retrieve the attribute data from a node attribute list.
1304 *
1305 * This routine gets called for any attribute fork that has more than one
1306 * block, ie: both true Btree attr lists and for single-leaf-blocks with
1307 * "remote" values taking up more blocks.
1308 *
1309 * Returns 0 on successful retrieval, otherwise an error.
1310 */
1311STATIC int
1312xfs_attr_node_get(xfs_da_args_t *args)
1313{
1314 xfs_da_state_t *state;
1315 xfs_da_state_blk_t *blk;
1316 int error, retval;
1317 int i;
1318
1319 trace_xfs_attr_node_get(args);
1320
1321 state = xfs_da_state_alloc();
1322 state->args = args;
1323 state->mp = args->dp->i_mount;
1324
1325 /*
1326 * Search to see if name exists, and get back a pointer to it.
1327 */
1328 error = xfs_da3_node_lookup_int(state, &retval);
1329 if (error) {
1330 retval = error;
1331 goto out_release;
1332 }
1333 if (retval != -EEXIST)
1334 goto out_release;
1335
1336 /*
1337 * Get the value, local or "remote"
1338 */
1339 blk = &state->path.blk[state->path.active - 1];
1340 retval = xfs_attr3_leaf_getvalue(blk->bp, args);
1341
1342 /*
1343 * If not in a transaction, we have to release all the buffers.
1344 */
1345out_release:
1346 for (i = 0; i < state->path.active; i++) {
1347 xfs_trans_brelse(args->trans, state->path.blk[i].bp);
1348 state->path.blk[i].bp = NULL;
1349 }
1350
1351 xfs_da_state_free(state);
1352 return retval;
1353}
1354
1355/* Returns true if the attribute entry name is valid. */
1356bool
1357xfs_attr_namecheck(
1358 const void *name,
1359 size_t length)
1360{
1361 /*
1362 * MAXNAMELEN includes the trailing null, but (name/length) leave it
1363 * out, so use >= for the length check.
1364 */
1365 if (length >= MAXNAMELEN)
1366 return false;
1367
1368 /* There shouldn't be any nulls here */
1369 return !memchr(name, 0, length);
1370}