]>
git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blob - include/linux/xattr.h
1 /* SPDX-License-Identifier: GPL-2.0 */
5 Extended attributes handling.
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>
11 #ifndef _LINUX_XATTR_H
12 #define _LINUX_XATTR_H
15 #include <linux/slab.h>
16 #include <linux/types.h>
17 #include <linux/spinlock.h>
19 #include <linux/user_namespace.h>
20 #include <uapi/linux/xattr.h>
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.
30 struct xattr_handler
{
33 int flags
; /* fs private flags */
34 bool (*list
)(struct dentry
*dentry
);
35 int (*get
)(const struct xattr_handler
*, struct dentry
*dentry
,
36 struct inode
*inode
, const char *name
, void *buffer
,
38 int (*set
)(const struct xattr_handler
*,
39 struct user_namespace
*mnt_userns
, struct dentry
*dentry
,
40 struct inode
*inode
, const char *name
, const void *buffer
,
41 size_t size
, int flags
);
44 const char *xattr_full_name(const struct xattr_handler
*, const char *);
52 ssize_t
__vfs_getxattr(struct dentry
*, struct inode
*, const char *, void *, size_t);
53 ssize_t
vfs_getxattr(struct user_namespace
*, struct dentry
*, const char *,
55 ssize_t
vfs_listxattr(struct dentry
*d
, char *list
, size_t size
);
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,
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 *);
70 ssize_t
generic_listxattr(struct dentry
*dentry
, char *buffer
, size_t buffer_size
);
71 ssize_t
vfs_getxattr_alloc(struct user_namespace
*mnt_userns
,
72 struct dentry
*dentry
, const char *name
,
73 char **xattr_value
, size_t size
, gfp_t flags
);
75 int xattr_supported_namespace(struct inode
*inode
, const char *prefix
);
77 static inline const char *xattr_prefix(const struct xattr_handler
*handler
)
79 return handler
->prefix
?: handler
->name
;
82 struct simple_xattrs
{
83 struct list_head head
;
88 struct list_head list
;
95 * initialize the simple_xattrs structure
97 static inline void simple_xattrs_init(struct simple_xattrs
*xattrs
)
99 INIT_LIST_HEAD(&xattrs
->head
);
100 spin_lock_init(&xattrs
->lock
);
104 * free all the xattrs
106 static inline void simple_xattrs_free(struct simple_xattrs
*xattrs
)
108 struct simple_xattr
*xattr
, *node
;
110 list_for_each_entry_safe(xattr
, node
, &xattrs
->head
, list
) {
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
,
120 const void *value
, size_t size
, int flags
,
121 ssize_t
*removed_size
);
122 ssize_t
simple_xattr_list(struct inode
*inode
, struct simple_xattrs
*xattrs
, char *buffer
,
124 void simple_xattr_list_add(struct simple_xattrs
*xattrs
,
125 struct simple_xattr
*new_xattr
);
127 #endif /* _LINUX_XATTR_H */