Documentation.
[lwext4.git] / lwext4 / ext4_ialloc.c
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_ialloc.c\r
39  * @brief Inode allocation procedures.\r
40  */\r
41 \r
42 #include <ext4_config.h>\r
43 #include <ext4_types.h>\r
44 #include <ext4_ialloc.h>\r
45 #include <ext4_super.h>\r
46 #include <ext4_fs.h>\r
47 #include <ext4_blockdev.h>\r
48 #include <ext4_block_group.h>\r
49 #include <ext4_bitmap.h>\r
50 \r
51 \r
52 /**@brief  Convert i-node number to relative index in block group.\r
53  * @param sb    Superblock\r
54  * @param inode I-node number to be converted\r
55  * @return Index of the i-node in the block group\r
56  */\r
57 static uint32_t ext4_ialloc_inode2index_in_group(struct ext4_sblock *sb,\r
58     uint32_t inode)\r
59 {\r
60     uint32_t inodes_per_group = ext4_get32(sb, inodes_per_group);\r
61     return (inode - 1) % inodes_per_group;\r
62 }\r
63 \r
64 /**@brief Convert relative index of i-node to absolute i-node number.\r
65  * @param sb    Superblock\r
66  * @param index Index to be converted\r
67  * @return Absolute number of the i-node\r
68  *\r
69  */\r
70 static uint32_t ext4_ialloc_index_in_group2inode(struct ext4_sblock *sb,\r
71         uint32_t index, uint32_t bgid)\r
72 {\r
73     uint32_t inodes_per_group = ext4_get32(sb, inodes_per_group);\r
74     return bgid * inodes_per_group + (index + 1);\r
75 }\r
76 \r
77 \r
78 /**@brief Compute block group number from the i-node number.\r
79  * @param sb    Superblock\r
80  * @param inode I-node number to be found the block group for\r
81  * @return Block group number computed from i-node number\r
82  */\r
83 static uint32_t ext4_ialloc_get_bgid_of_inode(struct ext4_sblock *sb,\r
84         uint32_t inode)\r
85 {\r
86     uint32_t inodes_per_group = ext4_get32(sb, inodes_per_group);\r
87     return (inode - 1) / inodes_per_group;\r
88 }\r
89 \r
90 \r
91 int ext4_ialloc_free_inode(struct ext4_fs *fs, uint32_t index, bool is_dir)\r
92 {\r
93     struct ext4_sblock *sb = &fs->sb;\r
94 \r
95     /* Compute index of block group and load it */\r
96     uint32_t block_group = ext4_ialloc_get_bgid_of_inode(sb, index);\r
97 \r
98     struct ext4_block_group_ref bg_ref;\r
99     int rc = ext4_fs_get_block_group_ref(fs, block_group, &bg_ref);\r
100     if (rc != EOK)\r
101         return rc;\r
102 \r
103     /* Load i-node bitmap */\r
104     uint32_t bitmap_block_addr = ext4_bg_get_inode_bitmap(\r
105             bg_ref.block_group, sb);\r
106 \r
107     struct ext4_block bitmap_block;\r
108     rc = ext4_block_get(fs->bdev, &bitmap_block, bitmap_block_addr);\r
109     if (rc != EOK)\r
110         return rc;\r
111 \r
112     /* Free i-node in the bitmap */\r
113     uint32_t index_in_group = ext4_ialloc_inode2index_in_group(sb, index);\r
114     ext4_bmap_bit_clr(bitmap_block.data, index_in_group);\r
115     bitmap_block.dirty = true;\r
116 \r
117     /* Put back the block with bitmap */\r
118     rc = ext4_block_set(fs->bdev, &bitmap_block);\r
119     if (rc != EOK) {\r
120         /* Error in saving bitmap */\r
121         ext4_fs_put_block_group_ref(&bg_ref);\r
122         return rc;\r
123     }\r
124 \r
125     /* If released i-node is a directory, decrement used directories count */\r
126     if (is_dir) {\r
127         uint32_t bg_used_dirs = ext4_bg_get_used_dirs_count(\r
128                 bg_ref.block_group, sb);\r
129         bg_used_dirs--;\r
130         ext4_bg_set_used_dirs_count(bg_ref.block_group, sb,\r
131                 bg_used_dirs);\r
132     }\r
133 \r
134     /* Update block group free inodes count */\r
135     uint32_t free_inodes = ext4_bg_get_free_inodes_count(\r
136             bg_ref.block_group, sb);\r
137     free_inodes++;\r
138     ext4_bg_set_free_inodes_count(bg_ref.block_group, sb,\r
139             free_inodes);\r
140 \r
141     bg_ref.dirty = true;\r
142 \r
143     /* Put back the modified block group */\r
144     rc = ext4_fs_put_block_group_ref(&bg_ref);\r
145     if (rc != EOK)\r
146         return rc;\r
147 \r
148     /* Update superblock free inodes count */\r
149     ext4_set32(sb, free_inodes_count, ext4_get32(sb, free_inodes_count) + 1);\r
150 \r
151     return EOK;\r
152 }\r
153 \r
154 int ext4_ialloc_alloc_inode(struct ext4_fs *fs, uint32_t *index, bool is_dir)\r
155 {\r
156     struct ext4_sblock *sb = &fs->sb;\r
157 \r
158     uint32_t bgid = fs->last_inode_bg_id;\r
159     uint32_t bg_count = ext4_block_group_cnt(sb);\r
160     uint32_t sb_free_inodes = ext4_get32(sb, free_inodes_count);\r
161     uint32_t avg_free_inodes = sb_free_inodes / bg_count;\r
162     bool     rewind = false;\r
163 \r
164     /* Try to find free i-node in all block groups */\r
165     while (bgid <= bg_count) {\r
166 \r
167         if(bgid == bg_count){\r
168             if(rewind)\r
169                 break;\r
170             bg_count = fs->last_inode_bg_id;\r
171             bgid = 0;\r
172             rewind = true;\r
173             continue;\r
174         }\r
175 \r
176         /* Load block group to check */\r
177         struct ext4_block_group_ref bg_ref;\r
178         int rc = ext4_fs_get_block_group_ref(fs, bgid, &bg_ref);\r
179         if (rc != EOK)\r
180             return rc;\r
181 \r
182         struct ext4_bgroup *bg = bg_ref.block_group;\r
183 \r
184         /* Read necessary values for algorithm */\r
185         uint32_t free_inodes = ext4_bg_get_free_inodes_count(bg, sb);\r
186         uint32_t used_dirs = ext4_bg_get_used_dirs_count(bg, sb);\r
187 \r
188         /* Check if this block group is good candidate for allocation */\r
189         if (free_inodes >= avg_free_inodes) {\r
190             /* Load block with bitmap */\r
191             uint32_t bitmap_block_addr = ext4_bg_get_inode_bitmap(\r
192                     bg_ref.block_group, sb);\r
193 \r
194             struct ext4_block bitmap_block;\r
195             rc = ext4_block_get(fs->bdev, &bitmap_block, bitmap_block_addr);\r
196             if (rc != EOK)\r
197                 return rc;\r
198 \r
199             /* Try to allocate i-node in the bitmap */\r
200             uint32_t inodes_in_group = ext4_inodes_in_group_cnt(sb, bgid);\r
201             uint32_t index_in_group;\r
202 \r
203             rc = ext4_bmap_bit_find_clr(bitmap_block.data, 0, inodes_in_group,\r
204                     &index_in_group);\r
205             /* Block group has not any free i-node */\r
206             if (rc == ENOSPC) {\r
207                 ext4_block_set(fs->bdev, &bitmap_block);\r
208                 ext4_fs_put_block_group_ref(&bg_ref);\r
209                 continue;\r
210             }\r
211 \r
212             ext4_bmap_bit_set(bitmap_block.data, index_in_group);\r
213 \r
214             /* Free i-node found, save the bitmap */\r
215             bitmap_block.dirty = true;\r
216 \r
217             ext4_block_set(fs->bdev, &bitmap_block);\r
218             if (rc != EOK)\r
219                 return rc;\r
220 \r
221             /* Modify filesystem counters */\r
222             free_inodes--;\r
223             ext4_bg_set_free_inodes_count(bg, sb, free_inodes);\r
224 \r
225             /* Increment used directories counter */\r
226             if (is_dir) {\r
227                 used_dirs++;\r
228                 ext4_bg_set_used_dirs_count(bg, sb, used_dirs);\r
229             }\r
230 \r
231             /* Decrease unused inodes count */\r
232             if (ext4_bg_has_flag(bg,\r
233                     EXT4_BLOCK_GROUP_ITABLE_ZEROED)) {\r
234                 uint32_t unused =\r
235                         ext4_bg_get_itable_unused(bg, sb);\r
236 \r
237                 uint32_t inodes_in_group =\r
238                         ext4_inodes_in_group_cnt(sb, bgid);\r
239 \r
240                 uint32_t free = inodes_in_group - unused;\r
241 \r
242                 if (index_in_group >= free) {\r
243                     unused = inodes_in_group - (index_in_group + 1);\r
244                     ext4_bg_set_itable_unused(bg, sb, unused);\r
245                 }\r
246             }\r
247 \r
248             /* Save modified block group */\r
249             bg_ref.dirty = true;\r
250 \r
251             rc = ext4_fs_put_block_group_ref(&bg_ref);\r
252             if (rc != EOK)\r
253                 return rc;\r
254 \r
255             /* Update superblock */\r
256             sb_free_inodes--;\r
257             ext4_set32(sb, free_inodes_count, sb_free_inodes);\r
258 \r
259 \r
260             /* Compute the absolute i-nodex number */\r
261             *index = ext4_ialloc_index_in_group2inode(sb,\r
262                     index_in_group, bgid);\r
263 \r
264             fs->last_inode_bg_id = bgid;\r
265 \r
266             return EOK;\r
267         }\r
268 \r
269         /* Block group not modified, put it and jump to the next block group */\r
270         ext4_fs_put_block_group_ref(&bg_ref);\r
271         ++bgid;\r
272     }\r
273 \r
274     return ENOSPC;\r
275 }\r
276 \r
277 /**\r
278  * @}\r
279  */\r
280 \r