lwext4/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
  47 int ext4_fs_get_xattr_ref(struct ext4_fs *fs, struct ext4_inode_ref *inode_ref,
  48                           struct ext4_xattr_ref *ref);
  49
  50 void ext4_fs_put_xattr_ref(struct ext4_xattr_ref *ref);
  51
  52 int ext4_fs_set_xattr(struct ext4_xattr_ref *ref, uint8_t name_index,
  53                       const char *name, size_t name_len, const void *data,
  54                       size_t data_size, bool replace);
  55
  56 int ext4_fs_remove_xattr(struct ext4_xattr_ref *ref, uint8_t name_index,
  57                          const char *name, size_t name_len);
  58
  59 int ext4_fs_get_xattr(struct ext4_xattr_ref *ref, uint8_t name_index,
  60                       const char *name, size_t name_len, void *buf,
  61                       size_t buf_size, size_t *data_size);
  62
  63 void ext4_fs_xattr_iterate(struct ext4_xattr_ref *ref,
  64                            int (*iter)(struct ext4_xattr_ref *ref,
  65                                      struct ext4_xattr_item *item));
  66
  67 void ext4_fs_xattr_iterate_reset(struct ext4_xattr_ref *ref);
  68
  69 const char *ext4_extract_xattr_name(const char *full_name, size_t full_name_len,
  70                               uint8_t *name_index, size_t *name_len);
  71
  72 const char *ext4_get_xattr_name_prefix(uint8_t name_index,
  73                                         size_t *ret_prefix_len);
  74
  75 #ifdef __cplusplus
  76 }
  77 #endif
  78
  79 #endif
  80 /**
  81  * @}
  82  */