include/ext4_xattr.h

   1 /*
   2  * Copyright (c) 2015 Grzegorz Kostka (kostka.grzegorz@gmail.com)
   3  * Copyright (c) 2015 Kaho Ng (ngkaho1234@gmail.com)
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  *
   9  * - Redistributions of source code must retain the above copyright
  10  *   notice, this list of conditions and the following disclaimer.
  11  * - Redistributions in binary form must reproduce the above copyright
  12  *   notice, this list of conditions and the following disclaimer in the
  13  *   documentation and/or other materials provided with the distribution.
  14  * - The name of the author may not be used to endorse or promote products
  15  *   derived from this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 /** @addtogroup lwext4
  30  * @{
  31  */
  32 /**
  33  * @file  ext4_xattr.h
  34  * @brief Extended Attribute manipulation.
  35  */
  36
  37 #ifndef EXT4_XATTR_H_
  38 #define EXT4_XATTR_H_
  39
  40 #ifdef __cplusplus
  41 extern "C" {
  42 #endif
  43
  44 #include "ext4_config.h"
  45 #include "ext4_types.h"
  46 #include "ext4_inode.h"
  47 #include "misc/tree.h"
  48 #include "misc/queue.h"
  49
  50 struct ext4_xattr_item {
  51         /* This attribute should be stored in inode body */
  52         bool in_inode;
  53
  54         uint8_t name_index;
  55         char  *name;
  56         size_t name_len;
  57         void  *data;
  58         size_t data_size;
  59
  60         RB_ENTRY(ext4_xattr_item) node;
  61 };
  62
  63 struct ext4_xattr_ref {
  64         bool block_loaded;
  65         struct ext4_block block;
  66         struct ext4_inode_ref *inode_ref;
  67         bool   dirty;
  68         size_t ea_size;
  69         struct ext4_fs *fs;
  70
  71         void *iter_arg;
  72         struct ext4_xattr_item *iter_from;
  73
  74         RB_HEAD(ext4_xattr_tree,
  75                 ext4_xattr_item) root;
  76 };
  77
  78 #define EXT4_XATTR_PAD_BITS             2
  79 #define EXT4_XATTR_PAD          (1<<EXT4_XATTR_PAD_BITS)
  80 #define EXT4_XATTR_ROUND                (EXT4_XATTR_PAD-1)
  81 #define EXT4_XATTR_LEN(name_len) \
  82         (((name_len) + EXT4_XATTR_ROUND + \
  83         sizeof(struct ext4_xattr_entry)) & ~EXT4_XATTR_ROUND)
  84 #define EXT4_XATTR_NEXT(entry) \
  85         ((struct ext4_xattr_entry *)( \
  86          (char *)(entry) + EXT4_XATTR_LEN((entry)->e_name_len)))
  87 #define EXT4_XATTR_SIZE(size) \
  88         (((size) + EXT4_XATTR_ROUND) & ~EXT4_XATTR_ROUND)
  89 #define EXT4_XATTR_NAME(entry) \
  90         ((char *)((entry) + 1))
  91
  92 #define EXT4_XATTR_IHDR(sb, raw_inode) \
  93         ((struct ext4_xattr_ibody_header *) \
  94                 ((char *)raw_inode + \
  95                 EXT4_GOOD_OLD_INODE_SIZE + \
  96                 ext4_inode_get_extra_isize(sb, raw_inode)))
  97 #define EXT4_XATTR_IFIRST(hdr) \
  98         ((struct ext4_xattr_entry *)((hdr)+1))
  99
 100 #define EXT4_XATTR_BHDR(block) \
 101         ((struct ext4_xattr_header *)((block)->data))
 102 #define EXT4_XATTR_ENTRY(ptr) \
 103         ((struct ext4_xattr_entry *)(ptr))
 104 #define EXT4_XATTR_BFIRST(block) \
 105         EXT4_XATTR_ENTRY(EXT4_XATTR_BHDR(block)+1)
 106 #define EXT4_XATTR_IS_LAST_ENTRY(entry) \
 107         (*(uint32_t *)(entry) == 0)
 108
 109 #define EXT4_ZERO_XATTR_VALUE ((void *)-1)
 110
 111
 112 #define EXT4_XATTR_ITERATE_CONT 0
 113 #define EXT4_XATTR_ITERATE_STOP 1
 114 #define EXT4_XATTR_ITERATE_PAUSE 2
 115
 116 int ext4_fs_get_xattr_ref(struct ext4_fs *fs, struct ext4_inode_ref *inode_ref,
 117                           struct ext4_xattr_ref *ref);
 118
 119 void ext4_fs_put_xattr_ref(struct ext4_xattr_ref *ref);
 120
 121 int ext4_fs_set_xattr(struct ext4_xattr_ref *ref, uint8_t name_index,
 122                       const char *name, size_t name_len, const void *data,
 123                       size_t data_size, bool replace);
 124
 125 int ext4_fs_remove_xattr(struct ext4_xattr_ref *ref, uint8_t name_index,
 126                          const char *name, size_t name_len);
 127
 128 int ext4_fs_get_xattr(struct ext4_xattr_ref *ref, uint8_t name_index,
 129                       const char *name, size_t name_len, void *buf,
 130                       size_t buf_size, size_t *data_size);
 131
 132 void ext4_fs_xattr_iterate(struct ext4_xattr_ref *ref,
 133                            int (*iter)(struct ext4_xattr_ref *ref,
 134                                      struct ext4_xattr_item *item));
 135
 136 void ext4_fs_xattr_iterate_reset(struct ext4_xattr_ref *ref);
 137
 138 const char *ext4_extract_xattr_name(const char *full_name, size_t full_name_len,
 139                               uint8_t *name_index, size_t *name_len,
 140                               bool *found);
 141
 142 const char *ext4_get_xattr_name_prefix(uint8_t name_index,
 143                                        size_t *ret_prefix_len);
 144
 145 #ifdef __cplusplus
 146 }
 147 #endif
 148
 149 #endif
 150 /**
 151  * @}
 152  */