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
41extern "C" {
42#endif
43
44#include <ext4_config.h>
45#include <ext4_types.h>
46#include <ext4_inode.h>
47
48struct ext4_xattr_info {
49 uint8_t name_index;
50 const char *name;
51 size_t name_len;
52 const void *value;
53 size_t value_len;
54};
55
56struct ext4_xattr_list_entry {
57 uint8_t name_index;
58 char *name;
59 size_t name_len;
60 struct ext4_xattr_list_entry *next;
61};
62
63struct ext4_xattr_search {
64 /* The first entry in the buffer */
65 struct ext4_xattr_entry *first;
66
67 /* The address of the buffer */
68 void *base;
69
70 /* The first inaccessible address */
71 void *end;
72
73 /* The current entry pointer */
74 struct ext4_xattr_entry *here;
75
76 /* Entry not found */
77 bool not_found;
78};
79
80const char *ext4_extract_xattr_name(const char *full_name, size_t full_name_len,
81 uint8_t *name_index, size_t *name_len,
82 bool *found);
83
84const char *ext4_get_xattr_name_prefix(uint8_t name_index,
85 size_t *ret_prefix_len);
86
87int ext4_xattr_list(struct ext4_inode_ref *inode_ref,
88 struct ext4_xattr_list_entry *list, size_t *list_len);
89
90int ext4_xattr_get(struct ext4_inode_ref *inode_ref, uint8_t name_index,
91 const char *name, size_t name_len, void *buf, size_t buf_len,
92 size_t *data_len);
93
94int ext4_xattr_remove(struct ext4_inode_ref *inode_ref, uint8_t name_index,
95 const char *name, size_t name_len);
96
97int ext4_xattr_set(struct ext4_inode_ref *inode_ref, uint8_t name_index,
98 const char *name, size_t name_len, const void *value,
99 size_t value_len);
100
101#ifdef __cplusplus
102}
103#endif
104
105#endif
106/**
107 * @}
108 */
109