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 "misc/tree.h"
  47 #include "misc/queue.h"
  48
  49 struct ext4_xattr_item {
  50         /* This attribute should be stored in inode body */
  51         bool in_inode;
  52
  53         uint8_t name_index;
  54         char  *name;
  55         size_t name_len;
  56         void  *data;
  57         size_t data_size;
  58
  59         RB_ENTRY(ext4_xattr_item) node;
  60 };
  61
  62 struct ext4_xattr_ref {
  63         bool block_loaded;
  64         struct ext4_block block;
  65         struct ext4_inode_ref *inode_ref;
  66         bool   dirty;
  67         size_t ea_size;
  68         struct ext4_fs *fs;
  69
  70         void *iter_arg;
  71         struct ext4_xattr_item *iter_from;
  72
  73         RB_HEAD(ext4_xattr_tree,
  74                 ext4_xattr_item) root;
  75 };
  76
  77 #define EXT4_XATTR_ITERATE_CONT 0
  78 #define EXT4_XATTR_ITERATE_STOP 1
  79 #define EXT4_XATTR_ITERATE_PAUSE 2
  80
  81 int ext4_fs_get_xattr_ref(struct ext4_fs *fs, struct ext4_inode_ref *inode_ref,
  82                           struct ext4_xattr_ref *ref);
  83
  84 void ext4_fs_put_xattr_ref(struct ext4_xattr_ref *ref);
  85
  86 int ext4_fs_set_xattr(struct ext4_xattr_ref *ref, uint8_t name_index,
  87                       const char *name, size_t name_len, const void *data,
  88                       size_t data_size, bool replace);
  89
  90 int ext4_fs_remove_xattr(struct ext4_xattr_ref *ref, uint8_t name_index,
  91                          const char *name, size_t name_len);
  92
  93 int ext4_fs_get_xattr(struct ext4_xattr_ref *ref, uint8_t name_index,
  94                       const char *name, size_t name_len, void *buf,
  95                       size_t buf_size, size_t *data_size);
  96
  97 void ext4_fs_xattr_iterate(struct ext4_xattr_ref *ref,
  98                            int (*iter)(struct ext4_xattr_ref *ref,
  99                                      struct ext4_xattr_item *item));
 100
 101 void ext4_fs_xattr_iterate_reset(struct ext4_xattr_ref *ref);
 102
 103 const char *ext4_extract_xattr_name(const char *full_name, size_t full_name_len,
 104                               uint8_t *name_index, size_t *name_len);
 105
 106 const char *ext4_get_xattr_name_prefix(uint8_t name_index,
 107                                        size_t *ret_prefix_len);
 108
 109 #ifdef __cplusplus
 110 }
 111 #endif
 112
 113 #endif
 114 /**
 115  * @}
 116  */