blob: fdbafc6841cfd609cfd0c810ddcf4c3df7a33ed2 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 File: linux/xattr.h
3
4 Extended attributes handling.
5
6 Copyright (C) 2001 by Andreas Gruenbacher <a.gruenbacher@computer.org>
7 Copyright (c) 2001-2002 Silicon Graphics, Inc. All Rights Reserved.
8 Copyright (c) 2004 Red Hat, Inc., James Morris <jmorris@redhat.com>
9*/
10#ifndef _LINUX_XATTR_H
11#define _LINUX_XATTR_H
12
Eric Paris1dbe3942011-05-24 17:13:13 -070013
Aristeu Rozanski38f38652012-08-23 16:53:28 -040014#include <linux/slab.h>
Eric Paris1dbe3942011-05-24 17:13:13 -070015#include <linux/types.h>
Aristeu Rozanski38f38652012-08-23 16:53:28 -040016#include <linux/spinlock.h>
David Howells607ca462012-10-13 10:46:48 +010017#include <uapi/linux/xattr.h>
Eric Paris1dbe3942011-05-24 17:13:13 -070018
Adrian Bunk5b0a2072007-02-10 01:46:24 -080019struct inode;
20struct dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -070021
22struct xattr_handler {
Stephen Hemmingerbb435452010-05-13 17:53:14 -070023 const char *prefix;
Christoph Hellwig431547b2009-11-13 09:52:56 +000024 int flags; /* fs private flags passed back to the handlers */
25 size_t (*list)(struct dentry *dentry, char *list, size_t list_size,
26 const char *name, size_t name_len, int handler_flags);
27 int (*get)(struct dentry *dentry, const char *name, void *buffer,
28 size_t size, int handler_flags);
29 int (*set)(struct dentry *dentry, const char *name, const void *buffer,
30 size_t size, int flags, int handler_flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -070031};
32
Mimi Zohar9d8f13b2011-06-06 15:29:25 -040033struct xattr {
34 char *name;
35 void *value;
36 size_t value_len;
37};
38
David P. Quigley42492592008-02-04 22:29:39 -080039ssize_t xattr_getsecurity(struct inode *, const char *, void *, size_t);
David Howells8f0cfa52008-04-29 00:59:41 -070040ssize_t vfs_getxattr(struct dentry *, const char *, void *, size_t);
Bill Nottingham659564c2006-10-09 16:10:48 -040041ssize_t vfs_listxattr(struct dentry *d, char *list, size_t size);
David P. Quigleyb1ab7e42009-09-03 14:25:56 -040042int __vfs_setxattr_noperm(struct dentry *, const char *, const void *, size_t, int);
David Howells8f0cfa52008-04-29 00:59:41 -070043int vfs_setxattr(struct dentry *, const char *, const void *, size_t, int);
44int vfs_removexattr(struct dentry *, const char *);
Christoph Hellwig5be196e2006-01-09 20:51:55 -080045
Linus Torvalds1da177e2005-04-16 15:20:36 -070046ssize_t generic_getxattr(struct dentry *dentry, const char *name, void *buffer, size_t size);
47ssize_t generic_listxattr(struct dentry *dentry, char *buffer, size_t buffer_size);
48int generic_setxattr(struct dentry *dentry, const char *name, const void *value, size_t size, int flags);
49int generic_removexattr(struct dentry *dentry, const char *name);
Mimi Zohar1601fba2011-03-09 14:23:34 -050050ssize_t vfs_getxattr_alloc(struct dentry *dentry, const char *name,
51 char **xattr_value, size_t size, gfp_t flags);
52int vfs_xattr_cmp(struct dentry *dentry, const char *xattr_name,
53 const char *value, size_t size, gfp_t flags);
Aristeu Rozanski38f38652012-08-23 16:53:28 -040054
55struct simple_xattrs {
56 struct list_head head;
57 spinlock_t lock;
58};
59
60struct simple_xattr {
61 struct list_head list;
62 char *name;
63 size_t size;
64 char value[0];
65};
66
67/*
68 * initialize the simple_xattrs structure
69 */
70static inline void simple_xattrs_init(struct simple_xattrs *xattrs)
71{
72 INIT_LIST_HEAD(&xattrs->head);
73 spin_lock_init(&xattrs->lock);
74}
75
76/*
77 * free all the xattrs
78 */
79static inline void simple_xattrs_free(struct simple_xattrs *xattrs)
80{
81 struct simple_xattr *xattr, *node;
82
83 list_for_each_entry_safe(xattr, node, &xattrs->head, list) {
84 kfree(xattr->name);
85 kfree(xattr);
86 }
87}
88
89struct simple_xattr *simple_xattr_alloc(const void *value, size_t size);
90int simple_xattr_get(struct simple_xattrs *xattrs, const char *name,
91 void *buffer, size_t size);
92int simple_xattr_set(struct simple_xattrs *xattrs, const char *name,
93 const void *value, size_t size, int flags);
94int simple_xattr_remove(struct simple_xattrs *xattrs, const char *name);
95ssize_t simple_xattr_list(struct simple_xattrs *xattrs, char *buffer,
96 size_t size);
97void simple_xattr_list_add(struct simple_xattrs *xattrs,
98 struct simple_xattr *new_xattr);
99
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100#endif /* _LINUX_XATTR_H */