Update directory tree.
[lwext4.git] / lwext4 / ext4_dir.h
1 /*\r
2  * Copyright (c) 2013 Grzegorz Kostka (kostka.grzegorz@gmail.com)\r
3  *\r
4  *\r
5  * HelenOS:\r
6  * Copyright (c) 2012 Martin Sucha\r
7  * Copyright (c) 2012 Frantisek Princ\r
8  * All rights reserved.\r
9  *\r
10  * Redistribution and use in source and binary forms, with or without\r
11  * modification, are permitted provided that the following conditions\r
12  * are met:\r
13  *\r
14  * - Redistributions of source code must retain the above copyright\r
15  *   notice, this list of conditions and the following disclaimer.\r
16  * - Redistributions in binary form must reproduce the above copyright\r
17  *   notice, this list of conditions and the following disclaimer in the\r
18  *   documentation and/or other materials provided with the distribution.\r
19  * - The name of the author may not be used to endorse or promote products\r
20  *   derived from this software without specific prior written permission.\r
21  *\r
22  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR\r
23  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES\r
24  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.\r
25  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,\r
26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT\r
27  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,\r
28  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY\r
29  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\r
30  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF\r
31  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\r
32  */\r
33 \r
34 /** @addtogroup lwext4\r
35  * @{\r
36  */\r
37 /**\r
38  * @file  ext4_dir.h\r
39  * @brief Directory handle procedures.\r
40  */\r
41 \r
42 #ifndef EXT4_DIR_H_\r
43 #define EXT4_DIR_H_\r
44 \r
45 #include <ext4_config.h>\r
46 #include <ext4_types.h>\r
47 #include <ext4_blockdev.h>\r
48 #include <ext4_super.h>\r
49 \r
50 \r
51 #include <stdint.h>\r
52 \r
53 uint32_t ext4_dir_entry_ll_get_inode(struct ext4_directory_entry_ll *de);\r
54 \r
55 void ext4_dir_entry_ll_set_inode(struct ext4_directory_entry_ll *de,\r
56     uint32_t inode);\r
57 \r
58 \r
59 uint16_t ext4_dir_entry_ll_get_entry_length(struct ext4_directory_entry_ll *de);\r
60 void ext4_dir_entry_ll_set_entry_length(struct ext4_directory_entry_ll *de,\r
61     uint16_t len);\r
62 \r
63 \r
64 uint16_t ext4_dir_entry_ll_get_name_length(struct ext4_sblock *sb,\r
65     struct ext4_directory_entry_ll *de);\r
66 void ext4_dir_entry_ll_set_name_length(struct ext4_sblock *sb,\r
67     struct ext4_directory_entry_ll *de, uint16_t len);\r
68 \r
69 \r
70 \r
71 uint8_t ext4_dir_entry_ll_get_inode_type(struct ext4_sblock *sb,\r
72     struct ext4_directory_entry_ll *de);\r
73 void    ext4_dir_entry_ll_set_inode_type(struct ext4_sblock *sb,\r
74     struct ext4_directory_entry_ll *de, uint8_t type);\r
75 \r
76 \r
77 int ext4_dir_iterator_init(struct ext4_directory_iterator *it,\r
78     struct ext4_inode_ref *inode_ref, uint64_t pos);\r
79 \r
80 int ext4_dir_iterator_next(struct ext4_directory_iterator *it);\r
81 int ext4_dir_iterator_fini(struct ext4_directory_iterator *it);\r
82 \r
83 void ext4_dir_write_entry(struct ext4_sblock *sb,\r
84     struct ext4_directory_entry_ll *entry, uint16_t entry_len,\r
85     struct ext4_inode_ref *child,  const char *name, size_t name_len);\r
86 \r
87 int ext4_dir_add_entry(struct ext4_inode_ref *parent, const char *name,\r
88         uint32_t name_len, struct ext4_inode_ref *child);\r
89 \r
90 int ext4_dir_find_entry(struct ext4_directory_search_result *result,\r
91         struct ext4_inode_ref *parent, const char *name, uint32_t name_len);\r
92 \r
93 int ext4_dir_remove_entry(struct ext4_inode_ref *parent, const char *name,\r
94     uint32_t name_len);\r
95 \r
96 int ext4_dir_try_insert_entry(struct ext4_sblock *sb,\r
97     struct ext4_block *target_block, struct ext4_inode_ref *child,\r
98     const char *name, uint32_t name_len);\r
99 \r
100 int ext4_dir_find_in_block(struct ext4_block *block, struct ext4_sblock *sb,\r
101     size_t name_len, const char *name,\r
102     struct ext4_directory_entry_ll **res_entry);\r
103 \r
104 int ext4_dir_destroy_result(struct ext4_inode_ref *parent,\r
105     struct ext4_directory_search_result *result);\r
106 \r
107 \r
108 #endif /* EXT4_DIR_H_ */\r
109 \r
110 /**\r
111  * @}\r
112  */\r
113 \r
114 \r