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