1 | /* |
2 | * Copyright (c) 2013 Grzegorz Kostka (kostka.grzegorz@gmail.com) |
3 | * |
4 | * |
5 | * HelenOS: |
6 | * Copyright (c) 2012 Martin Sucha |
7 | * Copyright (c) 2012 Frantisek Princ |
8 | * All rights reserved. |
9 | * |
10 | * Redistribution and use in source and binary forms, with or without |
11 | * modification, are permitted provided that the following conditions |
12 | * are met: |
13 | * |
14 | * - Redistributions of source code must retain the above copyright |
15 | * notice, this list of conditions and the following disclaimer. |
16 | * - Redistributions in binary form must reproduce the above copyright |
17 | * notice, this list of conditions and the following disclaimer in the |
18 | * documentation and/or other materials provided with the distribution. |
19 | * - The name of the author may not be used to endorse or promote products |
20 | * derived from this software without specific prior written permission. |
21 | * |
22 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR |
23 | * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
24 | * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. |
25 | * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, |
26 | * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT |
27 | * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
28 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
29 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
30 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF |
31 | * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
32 | */ |
33 | |
34 | /** @addtogroup lwext4 |
35 | * @{ |
36 | */ |
37 | /** |
38 | * @file ext4_dir_idx.h |
39 | * @brief Directory indexing procedures. |
40 | */ |
41 | |
42 | #ifndef EXT4_DIR_IDX_H_ |
43 | #define EXT4_DIR_IDX_H_ |
44 | |
45 | #ifdef __cplusplus |
46 | extern "C" { |
47 | #endif |
48 | |
49 | #include <ext4_config.h> |
50 | #include <ext4_types.h> |
51 | |
52 | #include <ext4_fs.h> |
53 | #include <ext4_dir.h> |
54 | |
55 | #include <stdint.h> |
56 | #include <stdbool.h> |
57 | |
58 | struct ext4_dir_idx_block { |
59 | struct ext4_block b; |
60 | struct ext4_dir_idx_entry *entries; |
61 | struct ext4_dir_idx_entry *position; |
62 | }; |
63 | |
64 | #define EXT4_DIR_DX_INIT_BCNT 2 |
65 | |
66 | |
67 | /**@brief Initialize index structure of new directory. |
68 | * @param dir Pointer to directory i-node |
69 | * @param parent Pointer to parent directory i-node |
70 | * @return Error code |
71 | */ |
72 | int ext4_dir_dx_init(struct ext4_inode_ref *dir, |
73 | struct ext4_inode_ref *parent); |
74 | |
75 | /**@brief Try to find directory entry using directory index. |
76 | * @param result Output value - if entry will be found, |
77 | * than will be passed through this parameter |
78 | * @param inode_ref Directory i-node |
79 | * @param name_len Length of name to be found |
80 | * @param name Name to be found |
81 | * @return Error code |
82 | */ |
83 | int ext4_dir_dx_find_entry(struct ext4_dir_search_result *result, |
84 | struct ext4_inode_ref *inode_ref, size_t name_len, |
85 | const char *name); |
86 | |
87 | /**@brief Add new entry to indexed directory |
88 | * @param parent Directory i-node |
89 | * @param child I-node to be referenced from directory entry |
90 | * @param name Name of new directory entry |
91 | * @return Error code |
92 | */ |
93 | int ext4_dir_dx_add_entry(struct ext4_inode_ref *parent, |
94 | struct ext4_inode_ref *child, const char *name, uint32_t name_len); |
95 | |
96 | /**@brief Add new entry to indexed directory |
97 | * @param dir Directory i-node |
98 | * @param parent_inode parent inode index |
99 | * @return Error code |
100 | */ |
101 | int ext4_dir_dx_reset_parent_inode(struct ext4_inode_ref *dir, |
102 | uint32_t parent_inode); |
103 | |
104 | #ifdef __cplusplus |
105 | } |
106 | #endif |
107 | |
108 | #endif /* EXT4_DIR_IDX_H_ */ |
109 | |
110 | /** |
111 | * @} |
112 | */ |
113 | |