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 | |
98e9cb57 AG |
25 | /* |
26 | * struct xattr_handler: When @name is set, match attributes with exactly that | |
27 | * name. When @prefix is set instead, match attributes with that prefix and | |
28 | * with a non-empty suffix. | |
29 | */ | |
1da177e4 | 30 | struct xattr_handler { |
98e9cb57 | 31 | const char *name; |
bb435453 | 32 | const char *prefix; |
e409de99 | 33 | int flags; /* fs private flags */ |
764a5c6b | 34 | bool (*list)(struct dentry *dentry); |
e409de99 | 35 | int (*get)(const struct xattr_handler *, struct dentry *dentry, |
b296821a AV |
36 | struct inode *inode, const char *name, void *buffer, |
37 | size_t size); | |
e65ce2a5 CB |
38 | int (*set)(const struct xattr_handler *, |
39 | struct user_namespace *mnt_userns, struct dentry *dentry, | |
59301226 AV |
40 | struct inode *inode, const char *name, const void *buffer, |
41 | size_t size, int flags); | |
1da177e4 LT |
42 | }; |
43 | ||
e409de99 AG |
44 | const char *xattr_full_name(const struct xattr_handler *, const char *); |
45 | ||
9d8f13ba | 46 | struct xattr { |
9548906b | 47 | const char *name; |
9d8f13ba MZ |
48 | void *value; |
49 | size_t value_len; | |
50 | }; | |
51 | ||
5d6c3191 | 52 | ssize_t __vfs_getxattr(struct dentry *, struct inode *, const char *, void *, size_t); |
c7c7a1a1 TA |
53 | ssize_t vfs_getxattr(struct user_namespace *, struct dentry *, const char *, |
54 | void *, size_t); | |
659564c8 | 55 | ssize_t vfs_listxattr(struct dentry *d, char *list, size_t size); |
c7c7a1a1 TA |
56 | int __vfs_setxattr(struct user_namespace *, struct dentry *, struct inode *, |
57 | const char *, const void *, size_t, int); | |
58 | int __vfs_setxattr_noperm(struct user_namespace *, struct dentry *, | |
59 | const char *, const void *, size_t, int); | |
60 | int __vfs_setxattr_locked(struct user_namespace *, struct dentry *, | |
61 | const char *, const void *, size_t, int, | |
62 | struct inode **); | |
63 | int vfs_setxattr(struct user_namespace *, struct dentry *, const char *, | |
64 | const void *, size_t, int); | |
65 | int __vfs_removexattr(struct user_namespace *, struct dentry *, const char *); | |
66 | int __vfs_removexattr_locked(struct user_namespace *, struct dentry *, | |
67 | const char *, struct inode **); | |
68 | int vfs_removexattr(struct user_namespace *, struct dentry *, const char *); | |
5be196e5 | 69 | |
1da177e4 | 70 | ssize_t generic_listxattr(struct dentry *dentry, char *buffer, size_t buffer_size); |
c7c7a1a1 TA |
71 | ssize_t vfs_getxattr_alloc(struct user_namespace *mnt_userns, |
72 | struct dentry *dentry, const char *name, | |
1601fbad | 73 | char **xattr_value, size_t size, gfp_t flags); |
38f38657 | 74 | |
cab8d289 FL |
75 | int xattr_supported_namespace(struct inode *inode, const char *prefix); |
76 | ||
98e9cb57 AG |
77 | static inline const char *xattr_prefix(const struct xattr_handler *handler) |
78 | { | |
79 | return handler->prefix ?: handler->name; | |
80 | } | |
81 | ||
38f38657 AR |
82 | struct simple_xattrs { |
83 | struct list_head head; | |
84 | spinlock_t lock; | |
85 | }; | |
86 | ||
87 | struct simple_xattr { | |
88 | struct list_head list; | |
89 | char *name; | |
90 | size_t size; | |
43951585 | 91 | char value[]; |
38f38657 AR |
92 | }; |
93 | ||
94 | /* | |
95 | * initialize the simple_xattrs structure | |
96 | */ | |
97 | static inline void simple_xattrs_init(struct simple_xattrs *xattrs) | |
98 | { | |
99 | INIT_LIST_HEAD(&xattrs->head); | |
100 | spin_lock_init(&xattrs->lock); | |
101 | } | |
102 | ||
103 | /* | |
104 | * free all the xattrs | |
105 | */ | |
106 | static inline void simple_xattrs_free(struct simple_xattrs *xattrs) | |
107 | { | |
108 | struct simple_xattr *xattr, *node; | |
109 | ||
110 | list_for_each_entry_safe(xattr, node, &xattrs->head, list) { | |
111 | kfree(xattr->name); | |
3bef735a | 112 | kvfree(xattr); |
38f38657 AR |
113 | } |
114 | } | |
115 | ||
116 | struct simple_xattr *simple_xattr_alloc(const void *value, size_t size); | |
117 | int simple_xattr_get(struct simple_xattrs *xattrs, const char *name, | |
118 | void *buffer, size_t size); | |
119 | int simple_xattr_set(struct simple_xattrs *xattrs, const char *name, | |
a46a2295 DX |
120 | const void *value, size_t size, int flags, |
121 | ssize_t *removed_size); | |
786534b9 AG |
122 | ssize_t simple_xattr_list(struct inode *inode, struct simple_xattrs *xattrs, char *buffer, |
123 | size_t size); | |
38f38657 AR |
124 | void simple_xattr_list_add(struct simple_xattrs *xattrs, |
125 | struct simple_xattr *new_xattr); | |
126 | ||
1da177e4 | 127 | #endif /* _LINUX_XATTR_H */ |