1 /* SPDX-License-Identifier: GPL-2.0 */
3 * Copyright (c) 2000,2002-2003,2005 Silicon Graphics, Inc.
11 struct xfs_attr_list_context;
14 * Large attribute lists are structured around Btrees where all the data
15 * elements are in the leaf nodes. Attribute names are hashed into an int,
16 * then that int is used as the index into the Btree. Since the hashval
17 * of an attribute name may not be unique, we may have duplicate keys.
18 * The internal links in the Btree are logical block offsets into the file.
20 * Small attribute lists use a different format and are packed as tightly
21 * as possible so as to fit into the literal area of the inode.
25 * The maximum size (into the kernel or returned from the kernel) of an
26 * attribute value or the buffer used for an attr_list() call. Larger
27 * sizes will result in an ERANGE return code.
29 #define ATTR_MAX_VALUELEN (64*1024) /* max length of a value */
32 * Kernel-internal version of the attrlist cursor.
34 struct xfs_attrlist_cursor_kern {
35 __u32 hashval; /* hash value of next entry to add */
36 __u32 blkno; /* block containing entry (suggestion) */
37 __u32 offset; /* offset in list of equal-hashvals */
38 __u16 pad1; /* padding to match user-level */
39 __u8 pad2; /* padding to match user-level */
40 __u8 initted; /* T/F: cursor has been initialized */
44 /*========================================================================
45 * Structure used to pass context around among the routines.
46 *========================================================================*/
49 /* void; state communicated via *context */
50 typedef void (*put_listent_func_t)(struct xfs_attr_list_context *context,
51 int flags, unsigned char *name, int namelen, void *value,
54 struct xfs_attr_list_context {
56 struct xfs_inode *dp; /* inode */
57 struct xfs_attrlist_cursor_kern cursor; /* position in list */
58 void *buffer; /* output buffer */
61 * Abort attribute list iteration if non-zero. Can be used to pass
62 * error values to the xfs_attr_list caller.
65 bool allow_incomplete;
67 ssize_t count; /* num used entries */
68 int dupcnt; /* count dup hashvals seen */
69 int bufsize; /* total buffer size */
70 int firstu; /* first used byte in buffer */
71 unsigned int attr_filter; /* XFS_ATTR_{ROOT,SECURE} */
72 int resynch; /* T/F: resynch with cursor */
73 put_listent_func_t put_listent; /* list output fmt function */
74 int index; /* index into output buffer */
79 * ========================================================================
80 * Structure used to pass context around among the delayed routines.
81 * ========================================================================
85 * Below is a state machine diagram for attr remove operations. The XFS_DAS_*
86 * states indicate places where the function would return -EAGAIN, and then
87 * immediately resume from after being called by the calling function. States
88 * marked as a "subroutine state" indicate that they belong to a subroutine, and
89 * so the calling function needs to pass them back to that subroutine to allow
90 * it to finish where it left off. But they otherwise do not have a role in the
91 * calling function other than just passing through.
93 * xfs_attr_remove_iter()
96 * have attr to remove? ──n──> done
101 * are we short form? ──y──> xfs_attr_shortform_remove ──> done
106 * are we leaf form? ──y──> xfs_attr_leaf_removename ──> done
111 * ┌── need to setup state?
116 * │ find attr and get state
117 * │ attr has remote blks? ──n─┐
119 * │ │ find and invalidate
120 * │ y the remote blocks.
121 * │ │ mark attr incomplete
122 * │ ├────────────────┘
126 * Have remote blks to remove? ───y─────┐
127 * │ ^ remove the blks
130 * │ XFS_DAS_RMTBLK <─n── done?
132 * │ one less blk to y
140 * ├─────────────────────────┘
145 * xfs_attr_node_remove_cleanup
157 * XFS_DAS_RM_SHRINK │
169 * Below is a state machine diagram for attr set operations.
171 * It seems the challenge with understanding this system comes from trying to
172 * absorb the state machine all at once, when really one should only be looking
173 * at it with in the context of a single function. Once a state sensitive
174 * function is called, the idea is that it "takes ownership" of the
175 * state machine. It isn't concerned with the states that may have belonged to
176 * it's calling parent. Only the states relevant to itself or any other
177 * subroutines there in. Once a calling function hands off the state machine to
178 * a subroutine, it needs to respect the simple rule that it doesn't "own" the
179 * state machine anymore, and it's the responsibility of that calling function
180 * to propagate the -EAGAIN back up the call stack. Upon reentry, it is
181 * committed to re-calling that subroutine until it returns something other than
182 * -EAGAIN. Once that subroutine signals completion (by returning anything other
183 * than -EAGAIN), the calling function can resume using the state machine.
185 * xfs_attr_set_iter()
188 * ┌─y─ has an attr fork?
206 * │ xfs_attr_try_sf_addname
209 * │ had enough ──y──> done
215 * │ transform to leaf
218 * │ hold the leaf buffer
225 * └─> release leaf buffer
235 * │ xfs_attr_leaf_try_add()
238 * │ had enough ──────────────y─────────────┐
251 * xfs_attr_node_addname_find_attr │
252 * determines if this │
253 * is create or rename │
254 * find space to store attr │
257 * xfs_attr_node_addname │
260 * fits in a node leaf? ────n─────┐ │
262 * │ │ single leaf node? │
267 * update │ grow the leaf split if │
268 * hashvals └── return -EAGAIN needed │
269 * │ retry leaf add │ │
271 * ├────────────────────────────┘ │
275 * ┌─y── or flip flag? │
283 * │ XFS_DAS_FOUND_LBLK <────────────────┘
286 * │ xfs_attr_leaf_addname()
289 * │ ┌──first time through?
294 * │ │ if we have rmt blks
295 * │ │ find space for them
301 * │ ┌─n─ blks to alloc? <──┐
306 * │ │ alloc one blk │
307 * │ │ return -EAGAIN ──┘
308 * │ │ re-enter with one
309 * │ │ less blk to alloc
312 * │ └───> set the rmt
322 * │ flip incomplete │
326 * │ XFS_DAS_FLIP_LFLAG │
338 * │ XFS_DAS_RM_LBLK │ │
347 * │ XFS_DAS_RD_LEAF │
359 * └──────> XFS_DAS_FOUND_NBLK
371 * │ ┌─>XFS_DAS_ALLOC_NODE
377 * │ └──y── need to alloc
383 * │ set the rmt value
387 * └────────> a rename? ──n─┐
396 * XFS_DAS_FLIP_NFLAG │
406 * ┌────────> old blks │
408 * XFS_DAS_RM_NBLK │ │
411 * └──────y── more to │
429 * Enum values for xfs_attr_intent.xattri_da_state
431 * These values are used by delayed attribute operations to keep track of where
432 * they were before they returned -EAGAIN. A return code of -EAGAIN signals the
433 * calling function to roll the transaction, and then call the subroutine to
434 * finish the operation. The enum is then used by the subroutine to jump back
435 * to where it was and resume executing where it left off.
437 enum xfs_delattr_state {
438 XFS_DAS_UNINIT = 0, /* No state has been set yet */
441 * Initial sequence states. The replace setup code relies on the
442 * ADD and REMOVE states for a specific format to be sequential so
443 * that we can transform the initial operation to be performed
444 * according to the xfs_has_larp() state easily.
446 XFS_DAS_SF_ADD, /* Initial sf add state */
447 XFS_DAS_SF_REMOVE, /* Initial sf replace/remove state */
449 XFS_DAS_LEAF_ADD, /* Initial leaf add state */
450 XFS_DAS_LEAF_REMOVE, /* Initial leaf replace/remove state */
452 XFS_DAS_NODE_ADD, /* Initial node add state */
453 XFS_DAS_NODE_REMOVE, /* Initial node replace/remove state */
455 /* Leaf state set/replace/remove sequence */
456 XFS_DAS_LEAF_SET_RMT, /* set a remote xattr from a leaf */
457 XFS_DAS_LEAF_ALLOC_RMT, /* We are allocating remote blocks */
458 XFS_DAS_LEAF_REPLACE, /* Perform replace ops on a leaf */
459 XFS_DAS_LEAF_REMOVE_OLD, /* Start removing old attr from leaf */
460 XFS_DAS_LEAF_REMOVE_RMT, /* A rename is removing remote blocks */
461 XFS_DAS_LEAF_REMOVE_ATTR, /* Remove the old attr from a leaf */
463 /* Node state sequence, must match leaf state above */
464 XFS_DAS_NODE_SET_RMT, /* set a remote xattr from a node */
465 XFS_DAS_NODE_ALLOC_RMT, /* We are allocating remote blocks */
466 XFS_DAS_NODE_REPLACE, /* Perform replace ops on a node */
467 XFS_DAS_NODE_REMOVE_OLD, /* Start removing old attr from node */
468 XFS_DAS_NODE_REMOVE_RMT, /* A rename is removing remote blocks */
469 XFS_DAS_NODE_REMOVE_ATTR, /* Remove the old attr from a node */
471 XFS_DAS_DONE, /* finished operation */
474 #define XFS_DAS_STRINGS \
475 { XFS_DAS_UNINIT, "XFS_DAS_UNINIT" }, \
476 { XFS_DAS_SF_ADD, "XFS_DAS_SF_ADD" }, \
477 { XFS_DAS_SF_REMOVE, "XFS_DAS_SF_REMOVE" }, \
478 { XFS_DAS_LEAF_ADD, "XFS_DAS_LEAF_ADD" }, \
479 { XFS_DAS_LEAF_REMOVE, "XFS_DAS_LEAF_REMOVE" }, \
480 { XFS_DAS_NODE_ADD, "XFS_DAS_NODE_ADD" }, \
481 { XFS_DAS_NODE_REMOVE, "XFS_DAS_NODE_REMOVE" }, \
482 { XFS_DAS_LEAF_SET_RMT, "XFS_DAS_LEAF_SET_RMT" }, \
483 { XFS_DAS_LEAF_ALLOC_RMT, "XFS_DAS_LEAF_ALLOC_RMT" }, \
484 { XFS_DAS_LEAF_REPLACE, "XFS_DAS_LEAF_REPLACE" }, \
485 { XFS_DAS_LEAF_REMOVE_OLD, "XFS_DAS_LEAF_REMOVE_OLD" }, \
486 { XFS_DAS_LEAF_REMOVE_RMT, "XFS_DAS_LEAF_REMOVE_RMT" }, \
487 { XFS_DAS_LEAF_REMOVE_ATTR, "XFS_DAS_LEAF_REMOVE_ATTR" }, \
488 { XFS_DAS_NODE_SET_RMT, "XFS_DAS_NODE_SET_RMT" }, \
489 { XFS_DAS_NODE_ALLOC_RMT, "XFS_DAS_NODE_ALLOC_RMT" }, \
490 { XFS_DAS_NODE_REPLACE, "XFS_DAS_NODE_REPLACE" }, \
491 { XFS_DAS_NODE_REMOVE_OLD, "XFS_DAS_NODE_REMOVE_OLD" }, \
492 { XFS_DAS_NODE_REMOVE_RMT, "XFS_DAS_NODE_REMOVE_RMT" }, \
493 { XFS_DAS_NODE_REMOVE_ATTR, "XFS_DAS_NODE_REMOVE_ATTR" }, \
494 { XFS_DAS_DONE, "XFS_DAS_DONE" }
496 struct xfs_attri_log_nameval;
499 * Context used for keeping track of delayed attribute operations
501 struct xfs_attr_intent {
503 * used to log this item to an intent containing a list of attrs to
506 struct list_head xattri_list;
508 /* Used in xfs_attr_node_removename to roll through removing blocks */
509 struct xfs_da_state *xattri_da_state;
511 struct xfs_da_args *xattri_da_args;
514 * Shared buffer containing the attr name, new name, and value so that
515 * the logging code can share large memory buffers between log items.
517 struct xfs_attri_log_nameval *xattri_nameval;
519 /* Used to keep track of current state of delayed operation */
520 enum xfs_delattr_state xattri_dela_state;
523 * Attr operation being performed - XFS_ATTRI_OP_FLAGS_*
525 unsigned int xattri_op_flags;
527 /* Used in xfs_attr_rmtval_set_blk to roll through allocating blocks */
528 xfs_dablk_t xattri_lblkno;
530 struct xfs_bmbt_irec xattri_map;
533 static inline unsigned int
534 xfs_attr_intent_op(const struct xfs_attr_intent *attr)
536 return attr->xattri_op_flags & XFS_ATTRI_OP_FLAGS_TYPE_MASK;
539 /*========================================================================
540 * Function prototypes for the kernel.
541 *========================================================================*/
544 * Overall external interface routines.
546 int xfs_attr_inactive(struct xfs_inode *dp);
547 int xfs_attr_list_ilocked(struct xfs_attr_list_context *);
548 int xfs_attr_list(struct xfs_attr_list_context *);
549 int xfs_inode_hasattr(struct xfs_inode *ip);
550 bool xfs_attr_is_leaf(struct xfs_inode *ip);
551 int xfs_attr_get_ilocked(struct xfs_da_args *args);
552 int xfs_attr_get(struct xfs_da_args *args);
554 enum xfs_attr_update {
555 XFS_ATTRUPDATE_REMOVE, /* remove attr */
556 XFS_ATTRUPDATE_UPSERT, /* set value, replace any existing attr */
557 XFS_ATTRUPDATE_CREATE, /* set value, fail if attr already exists */
558 XFS_ATTRUPDATE_REPLACE, /* set value, fail if attr does not exist */
561 int xfs_attr_set(struct xfs_da_args *args, enum xfs_attr_update op, bool rsvd);
562 int xfs_attr_set_iter(struct xfs_attr_intent *attr);
563 int xfs_attr_remove_iter(struct xfs_attr_intent *attr);
564 bool xfs_attr_check_namespace(unsigned int attr_flags);
565 bool xfs_attr_namecheck(unsigned int attr_flags, const void *name,
567 int xfs_attr_calc_size(struct xfs_da_args *args, int *local);
568 void xfs_init_attr_trans(struct xfs_da_args *args, struct xfs_trans_res *tres,
569 unsigned int *total);
572 * Check to see if the attr should be upgraded from non-existent or shortform to
573 * single-leaf-block attribute list.
576 xfs_attr_is_shortform(
577 struct xfs_inode *ip)
579 return ip->i_af.if_format == XFS_DINODE_FMT_LOCAL ||
580 (ip->i_af.if_format == XFS_DINODE_FMT_EXTENTS &&
581 ip->i_af.if_nextents == 0);
584 static inline enum xfs_delattr_state
585 xfs_attr_init_add_state(struct xfs_da_args *args)
588 * When called from the completion of a attr remove to determine the
589 * next state, the attribute fork may be null. This can occur only occur
590 * on a pure remove, but we grab the next state before we check if a
591 * replace operation is being performed. If we are called from any other
592 * context, i_af is guaranteed to exist. Hence if the attr fork is
593 * null, we were called from a pure remove operation and so we are done.
595 if (!xfs_inode_has_attr_fork(args->dp))
598 args->op_flags |= XFS_DA_OP_ADDNAME;
599 if (xfs_attr_is_shortform(args->dp))
600 return XFS_DAS_SF_ADD;
601 if (xfs_attr_is_leaf(args->dp))
602 return XFS_DAS_LEAF_ADD;
603 return XFS_DAS_NODE_ADD;
606 static inline enum xfs_delattr_state
607 xfs_attr_init_remove_state(struct xfs_da_args *args)
609 if (xfs_attr_is_shortform(args->dp))
610 return XFS_DAS_SF_REMOVE;
611 if (xfs_attr_is_leaf(args->dp))
612 return XFS_DAS_LEAF_REMOVE;
613 return XFS_DAS_NODE_REMOVE;
617 * If we are logging the attributes, then we have to start with removal of the
618 * old attribute so that there is always consistent state that we can recover
619 * from if the system goes down part way through. We always log the new attr
620 * value, so even when we remove the attr first we still have the information in
621 * the log to finish the replace operation atomically.
623 static inline enum xfs_delattr_state
624 xfs_attr_init_replace_state(struct xfs_da_args *args)
626 args->op_flags |= XFS_DA_OP_ADDNAME | XFS_DA_OP_REPLACE;
627 if (args->op_flags & XFS_DA_OP_LOGGED)
628 return xfs_attr_init_remove_state(args);
629 return xfs_attr_init_add_state(args);
632 xfs_dahash_t xfs_attr_hashname(const uint8_t *name, int namelen);
634 xfs_dahash_t xfs_attr_hashval(struct xfs_mount *mp, unsigned int attr_flags,
635 const uint8_t *name, int namelen, const void *value,
638 /* Set the hash value for any extended attribute from any namespace. */
639 static inline void xfs_attr_sethash(struct xfs_da_args *args)
641 args->hashval = xfs_attr_hashval(args->dp->i_mount, args->attr_filter,
642 args->name, args->namelen,
643 args->value, args->valuelen);
646 extern struct kmem_cache *xfs_attr_intent_cache;
647 int __init xfs_attr_intent_init_cache(void);
648 void xfs_attr_intent_destroy_cache(void);
650 int xfs_attr_sf_totsize(struct xfs_inode *dp);
651 int xfs_attr_add_fork(struct xfs_inode *ip, int size, int rsvd);
653 #endif /* __XFS_ATTR_H__ */