Commit | Line | Data |
---|---|---|
b2441318 | 1 | /* SPDX-License-Identifier: GPL-2.0 */ |
1da177e4 LT |
2 | /* |
3 | File: linux/xattr.h | |
4 | ||
5 | Extended attributes handling. | |
6 | ||
7 | Copyright (C) 2001 by Andreas Gruenbacher <a.gruenbacher@computer.org> | |
8 | Copyright (c) 2001-2002 Silicon Graphics, Inc. All Rights Reserved. | |
9 | Copyright (c) 2004 Red Hat, Inc., James Morris <jmorris@redhat.com> | |
10 | */ | |
11 | #ifndef _LINUX_XATTR_H | |
12 | #define _LINUX_XATTR_H | |
13 | ||
1dbe3942 | 14 | |
38f38657 | 15 | #include <linux/slab.h> |
1dbe3942 | 16 | #include <linux/types.h> |
38f38657 | 17 | #include <linux/spinlock.h> |
3bef735a | 18 | #include <linux/mm.h> |
c7c7a1a1 | 19 | #include <linux/user_namespace.h> |
607ca46e | 20 | #include <uapi/linux/xattr.h> |
1dbe3942 | 21 | |
5b0a2075 AB |
22 | struct inode; |
23 | struct dentry; | |
1da177e4 | 24 | |
31acceb9 CB |
25 | static inline bool is_posix_acl_xattr(const char *name) |
26 | { | |
27 | return (strcmp(name, XATTR_NAME_POSIX_ACL_ACCESS) == 0) || | |
28 | (strcmp(name, XATTR_NAME_POSIX_ACL_DEFAULT) == 0); | |
29 | } | |
30 | ||
98e9cb57 AG |
31 | /* |
32 | * struct xattr_handler: When @name is set, match attributes with exactly that | |
33 | * name. When @prefix is set instead, match attributes with that prefix and | |
34 | * with a non-empty suffix. | |
35 | */ | |
1da177e4 | 36 | struct xattr_handler { |
98e9cb57 | 37 | const char *name; |
bb435453 | 38 | const char *prefix; |
e409de99 | 39 | int flags; /* fs private flags */ |
764a5c6b | 40 | bool (*list)(struct dentry *dentry); |
e409de99 | 41 | int (*get)(const struct xattr_handler *, struct dentry *dentry, |
b296821a AV |
42 | struct inode *inode, const char *name, void *buffer, |
43 | size_t size); | |
e65ce2a5 | 44 | int (*set)(const struct xattr_handler *, |
39f60c1c | 45 | struct mnt_idmap *idmap, struct dentry *dentry, |
59301226 AV |
46 | struct inode *inode, const char *name, const void *buffer, |
47 | size_t size, int flags); | |
1da177e4 LT |
48 | }; |
49 | ||
2db8a948 CB |
50 | /** |
51 | * xattr_handler_can_list - check whether xattr can be listed | |
52 | * @handler: handler for this type of xattr | |
53 | * @dentry: dentry whose inode xattr to list | |
54 | * | |
55 | * Determine whether the xattr associated with @dentry can be listed given | |
56 | * @handler. | |
57 | * | |
58 | * Return: true if xattr can be listed, false if not. | |
59 | */ | |
60 | static inline bool xattr_handler_can_list(const struct xattr_handler *handler, | |
61 | struct dentry *dentry) | |
62 | { | |
63 | return handler && (!handler->list || handler->list(dentry)); | |
64 | } | |
65 | ||
e409de99 AG |
66 | const char *xattr_full_name(const struct xattr_handler *, const char *); |
67 | ||
9d8f13ba | 68 | struct xattr { |
9548906b | 69 | const char *name; |
9d8f13ba MZ |
70 | void *value; |
71 | size_t value_len; | |
72 | }; | |
73 | ||
5d6c3191 | 74 | ssize_t __vfs_getxattr(struct dentry *, struct inode *, const char *, void *, size_t); |
4609e1f1 | 75 | ssize_t vfs_getxattr(struct mnt_idmap *, struct dentry *, const char *, |
c7c7a1a1 | 76 | void *, size_t); |
659564c8 | 77 | ssize_t vfs_listxattr(struct dentry *d, char *list, size_t size); |
39f60c1c | 78 | int __vfs_setxattr(struct mnt_idmap *, struct dentry *, struct inode *, |
c7c7a1a1 | 79 | const char *, const void *, size_t, int); |
39f60c1c | 80 | int __vfs_setxattr_noperm(struct mnt_idmap *, struct dentry *, |
c7c7a1a1 | 81 | const char *, const void *, size_t, int); |
4609e1f1 | 82 | int __vfs_setxattr_locked(struct mnt_idmap *, struct dentry *, |
c7c7a1a1 TA |
83 | const char *, const void *, size_t, int, |
84 | struct inode **); | |
4609e1f1 | 85 | int vfs_setxattr(struct mnt_idmap *, struct dentry *, const char *, |
6344e669 | 86 | const void *, size_t, int); |
39f60c1c | 87 | int __vfs_removexattr(struct mnt_idmap *, struct dentry *, const char *); |
4609e1f1 | 88 | int __vfs_removexattr_locked(struct mnt_idmap *, struct dentry *, |
c7c7a1a1 | 89 | const char *, struct inode **); |
4609e1f1 | 90 | int vfs_removexattr(struct mnt_idmap *, struct dentry *, const char *); |
5be196e5 | 91 | |
1da177e4 | 92 | ssize_t generic_listxattr(struct dentry *dentry, char *buffer, size_t buffer_size); |
4609e1f1 | 93 | int vfs_getxattr_alloc(struct mnt_idmap *idmap, |
f6fbd8cb PM |
94 | struct dentry *dentry, const char *name, |
95 | char **xattr_value, size_t size, gfp_t flags); | |
38f38657 | 96 | |
831be973 | 97 | int xattr_supports_user_prefix(struct inode *inode); |
cab8d289 | 98 | |
98e9cb57 AG |
99 | static inline const char *xattr_prefix(const struct xattr_handler *handler) |
100 | { | |
101 | return handler->prefix ?: handler->name; | |
102 | } | |
103 | ||
38f38657 | 104 | struct simple_xattrs { |
3b4c7bc0 CB |
105 | struct rb_root rb_root; |
106 | rwlock_t lock; | |
38f38657 AR |
107 | }; |
108 | ||
109 | struct simple_xattr { | |
3b4c7bc0 | 110 | struct rb_node rb_node; |
38f38657 AR |
111 | char *name; |
112 | size_t size; | |
43951585 | 113 | char value[]; |
38f38657 AR |
114 | }; |
115 | ||
3b4c7bc0 CB |
116 | void simple_xattrs_init(struct simple_xattrs *xattrs); |
117 | void simple_xattrs_free(struct simple_xattrs *xattrs); | |
38f38657 AR |
118 | struct simple_xattr *simple_xattr_alloc(const void *value, size_t size); |
119 | int simple_xattr_get(struct simple_xattrs *xattrs, const char *name, | |
120 | void *buffer, size_t size); | |
121 | int simple_xattr_set(struct simple_xattrs *xattrs, const char *name, | |
a46a2295 DX |
122 | const void *value, size_t size, int flags, |
123 | ssize_t *removed_size); | |
3b4c7bc0 CB |
124 | ssize_t simple_xattr_list(struct inode *inode, struct simple_xattrs *xattrs, |
125 | char *buffer, size_t size); | |
126 | void simple_xattr_add(struct simple_xattrs *xattrs, | |
127 | struct simple_xattr *new_xattr); | |
f2620f16 | 128 | int xattr_list_one(char **buffer, ssize_t *remaining_size, const char *name); |
38f38657 | 129 | |
1da177e4 | 130 | #endif /* _LINUX_XATTR_H */ |