include/linux/xattr.h

   1 /*
   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
  13
  14 #include <linux/slab.h>
  15 #include <linux/types.h>
  16 #include <linux/spinlock.h>
  17 #include <uapi/linux/xattr.h>
  18
  19 struct inode;
  20 struct dentry;
  21
  22 /*
  23  * struct xattr_handler: When @name is set, match attributes with exactly that
  24  * name.  When @prefix is set instead, match attributes with that prefix and
  25  * with a non-empty suffix.
  26  */
  27 struct xattr_handler {
  28         const char *name;
  29         const char *prefix;
  30         int flags;      /* fs private flags */
  31         bool (*list)(struct dentry *dentry);
  32         int (*get)(const struct xattr_handler *, struct dentry *dentry,
  33                    struct inode *inode, const char *name, void *buffer,
  34                    size_t size);
  35         int (*set)(const struct xattr_handler *, struct dentry *dentry,
  36                    struct inode *inode, const char *name, const void *buffer,
  37                    size_t size, int flags);
  38 };
  39
  40 const char *xattr_full_name(const struct xattr_handler *, const char *);
  41
  42 struct xattr {
  43         const char *name;
  44         void *value;
  45         size_t value_len;
  46 };
  47
  48 ssize_t xattr_getsecurity(struct inode *, const char *, void *, size_t);
  49 ssize_t __vfs_getxattr(struct dentry *, struct inode *, const char *, void *, size_t);
  50 ssize_t vfs_getxattr(struct dentry *, const char *, void *, size_t);
  51 ssize_t vfs_listxattr(struct dentry *d, char *list, size_t size);
  52 int __vfs_setxattr(struct dentry *, struct inode *, const char *, const void *, size_t, int);
  53 int __vfs_setxattr_noperm(struct dentry *, const char *, const void *, size_t, int);
  54 int vfs_setxattr(struct dentry *, const char *, const void *, size_t, int);
  55 int __vfs_removexattr(struct dentry *, const char *);
  56 int vfs_removexattr(struct dentry *, const char *);
  57
  58 ssize_t generic_getxattr(struct dentry *dentry, struct inode *inode, const char *name, void *buffer, size_t size);
  59 ssize_t generic_listxattr(struct dentry *dentry, char *buffer, size_t buffer_size);
  60 int generic_setxattr(struct dentry *dentry, struct inode *inode,
  61                      const char *name, const void *value, size_t size, int flags);
  62 int generic_removexattr(struct dentry *dentry, const char *name);
  63 ssize_t vfs_getxattr_alloc(struct dentry *dentry, const char *name,
  64                            char **xattr_value, size_t size, gfp_t flags);
  65
  66 static inline const char *xattr_prefix(const struct xattr_handler *handler)
  67 {
  68         return handler->prefix ?: handler->name;
  69 }
  70
  71 struct simple_xattrs {
  72         struct list_head head;
  73         spinlock_t lock;
  74 };
  75
  76 struct simple_xattr {
  77         struct list_head list;
  78         char *name;
  79         size_t size;
  80         char value[0];
  81 };
  82
  83 /*
  84  * initialize the simple_xattrs structure
  85  */
  86 static inline void simple_xattrs_init(struct simple_xattrs *xattrs)
  87 {
  88         INIT_LIST_HEAD(&xattrs->head);
  89         spin_lock_init(&xattrs->lock);
  90 }
  91
  92 /*
  93  * free all the xattrs
  94  */
  95 static inline void simple_xattrs_free(struct simple_xattrs *xattrs)
  96 {
  97         struct simple_xattr *xattr, *node;
  98
  99         list_for_each_entry_safe(xattr, node, &xattrs->head, list) {
 100                 kfree(xattr->name);
 101                 kfree(xattr);
 102         }
 103 }
 104
 105 struct simple_xattr *simple_xattr_alloc(const void *value, size_t size);
 106 int simple_xattr_get(struct simple_xattrs *xattrs, const char *name,
 107                      void *buffer, size_t size);
 108 int simple_xattr_set(struct simple_xattrs *xattrs, const char *name,
 109                      const void *value, size_t size, int flags);
 110 ssize_t simple_xattr_list(struct inode *inode, struct simple_xattrs *xattrs, char *buffer,
 111                           size_t size);
 112 void simple_xattr_list_add(struct simple_xattrs *xattrs,
 113                            struct simple_xattr *new_xattr);
 114
 115 #endif  /* _LINUX_XATTR_H */