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 CB |
44 | int (*set)(const struct xattr_handler *, |
45 | struct user_namespace *mnt_userns, 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 | ||
e409de99 AG |
50 | const char *xattr_full_name(const struct xattr_handler *, const char *); |
51 | ||
9d8f13ba | 52 | struct xattr { |
9548906b | 53 | const char *name; |
9d8f13ba MZ |
54 | void *value; |
55 | size_t value_len; | |
56 | }; | |
57 | ||
5d6c3191 | 58 | ssize_t __vfs_getxattr(struct dentry *, struct inode *, const char *, void *, size_t); |
c7c7a1a1 TA |
59 | ssize_t vfs_getxattr(struct user_namespace *, struct dentry *, const char *, |
60 | void *, size_t); | |
659564c8 | 61 | ssize_t vfs_listxattr(struct dentry *d, char *list, size_t size); |
c7c7a1a1 TA |
62 | int __vfs_setxattr(struct user_namespace *, struct dentry *, struct inode *, |
63 | const char *, const void *, size_t, int); | |
64 | int __vfs_setxattr_noperm(struct user_namespace *, struct dentry *, | |
65 | const char *, const void *, size_t, int); | |
66 | int __vfs_setxattr_locked(struct user_namespace *, struct dentry *, | |
67 | const char *, const void *, size_t, int, | |
68 | struct inode **); | |
69 | int vfs_setxattr(struct user_namespace *, struct dentry *, const char *, | |
6344e669 | 70 | const void *, size_t, int); |
c7c7a1a1 TA |
71 | int __vfs_removexattr(struct user_namespace *, struct dentry *, const char *); |
72 | int __vfs_removexattr_locked(struct user_namespace *, struct dentry *, | |
73 | const char *, struct inode **); | |
74 | int vfs_removexattr(struct user_namespace *, struct dentry *, const char *); | |
5be196e5 | 75 | |
1da177e4 | 76 | ssize_t generic_listxattr(struct dentry *dentry, char *buffer, size_t buffer_size); |
c7c7a1a1 TA |
77 | ssize_t vfs_getxattr_alloc(struct user_namespace *mnt_userns, |
78 | struct dentry *dentry, const char *name, | |
1601fbad | 79 | char **xattr_value, size_t size, gfp_t flags); |
38f38657 | 80 | |
cab8d289 FL |
81 | int xattr_supported_namespace(struct inode *inode, const char *prefix); |
82 | ||
98e9cb57 AG |
83 | static inline const char *xattr_prefix(const struct xattr_handler *handler) |
84 | { | |
85 | return handler->prefix ?: handler->name; | |
86 | } | |
87 | ||
38f38657 AR |
88 | struct simple_xattrs { |
89 | struct list_head head; | |
90 | spinlock_t lock; | |
91 | }; | |
92 | ||
93 | struct simple_xattr { | |
94 | struct list_head list; | |
95 | char *name; | |
96 | size_t size; | |
43951585 | 97 | char value[]; |
38f38657 AR |
98 | }; |
99 | ||
100 | /* | |
101 | * initialize the simple_xattrs structure | |
102 | */ | |
103 | static inline void simple_xattrs_init(struct simple_xattrs *xattrs) | |
104 | { | |
105 | INIT_LIST_HEAD(&xattrs->head); | |
106 | spin_lock_init(&xattrs->lock); | |
107 | } | |
108 | ||
109 | /* | |
110 | * free all the xattrs | |
111 | */ | |
112 | static inline void simple_xattrs_free(struct simple_xattrs *xattrs) | |
113 | { | |
114 | struct simple_xattr *xattr, *node; | |
115 | ||
116 | list_for_each_entry_safe(xattr, node, &xattrs->head, list) { | |
117 | kfree(xattr->name); | |
3bef735a | 118 | kvfree(xattr); |
38f38657 AR |
119 | } |
120 | } | |
121 | ||
122 | struct simple_xattr *simple_xattr_alloc(const void *value, size_t size); | |
123 | int simple_xattr_get(struct simple_xattrs *xattrs, const char *name, | |
124 | void *buffer, size_t size); | |
125 | int simple_xattr_set(struct simple_xattrs *xattrs, const char *name, | |
a46a2295 DX |
126 | const void *value, size_t size, int flags, |
127 | ssize_t *removed_size); | |
786534b9 AG |
128 | ssize_t simple_xattr_list(struct inode *inode, struct simple_xattrs *xattrs, char *buffer, |
129 | size_t size); | |
38f38657 AR |
130 | void simple_xattr_list_add(struct simple_xattrs *xattrs, |
131 | struct simple_xattr *new_xattr); | |
132 | ||
1da177e4 | 133 | #endif /* _LINUX_XATTR_H */ |