Refactoring superblock features getters
[lwext4.git] / lwext4 / ext4_balloc.c
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_balloc.c
39  * @brief Physical block allocator.
40  */
41
42 #include "ext4_config.h"
43 #include "ext4_balloc.h"
44 #include "ext4_super.h"
45 #include "ext4_crc32c.h"
46 #include "ext4_block_group.h"
47 #include "ext4_fs.h"
48 #include "ext4_bitmap.h"
49 #include "ext4_inode.h"
50
51 /**@brief Compute number of block group from block address.
52  * @param sb superblock pointer.
53  * @param baddr Absolute address of block.
54  * @return Block group index
55  */
56 uint32_t ext4_balloc_get_bgid_of_block(struct ext4_sblock *s,
57                                        uint64_t baddr)
58 {
59         if (ext4_get32(s, first_data_block) && baddr)
60                 baddr--;
61
62         return baddr / ext4_get32(s, blocks_per_group);
63 }
64
65 /**@brief Compute the starting block address of a block group
66  * @param sb   superblock pointer.
67  * @param bgid block group index
68  * @return Block address
69  */
70 uint64_t ext4_balloc_get_block_of_bgid(struct ext4_sblock *s,
71                                        uint32_t bgid)
72 {
73         uint64_t baddr = 0;
74         if (ext4_get32(s, first_data_block))
75                 baddr++;
76
77         baddr += bgid * ext4_get32(s, blocks_per_group);
78         return baddr;
79 }
80
81 static uint32_t ext4_balloc_bitmap_csum(struct ext4_sblock *sb,
82                                         void *bitmap)
83 {
84         uint32_t checksum = 0;
85         if (ext4_sb_feature_ro_com(sb, EXT4_FRO_COM_METADATA_CSUM)) {
86                 uint32_t blocks_per_group =
87                         ext4_get32(sb, blocks_per_group);
88
89                 /* First calculate crc32 checksum against fs uuid */
90                 checksum = ext4_crc32c(~0, sb->uuid, sizeof(sb->uuid));
91                 /* Then calculate crc32 checksum against block_group_desc */
92                 checksum = ext4_crc32c(checksum, bitmap,
93                                      blocks_per_group / 8);
94         }
95         return checksum;
96 }
97
98 /*
99  * BIG FAT NOTES:
100  *       Currently we do not verify the checksum of bitmaps.
101  */
102
103 void ext4_balloc_set_bitmap_csum(struct ext4_sblock *sb,
104                                  struct ext4_bgroup *bg,
105                                  void *bitmap)
106 {
107         int desc_size = ext4_sb_get_desc_size(sb);
108         uint32_t checksum = ext4_balloc_bitmap_csum(sb, bitmap);
109         uint16_t lo_checksum = to_le16(checksum & 0xFFFF),
110                  hi_checksum = to_le16(checksum >> 16);
111         
112         /* See if we need to assign a 32bit checksum */
113         bg->block_bitmap_csum_lo = lo_checksum;
114         if (desc_size == EXT4_MAX_BLOCK_GROUP_DESCRIPTOR_SIZE)
115                 bg->block_bitmap_csum_hi = hi_checksum;
116
117 }
118
119 int ext4_balloc_free_block(struct ext4_inode_ref *inode_ref, ext4_fsblk_t baddr)
120 {
121         struct ext4_fs *fs = inode_ref->fs;
122         struct ext4_sblock *sb = &fs->sb;
123
124         uint32_t block_group = ext4_balloc_get_bgid_of_block(sb, baddr);
125         uint32_t index_in_group = ext4_fs_baddr2_index_in_group(sb, baddr);
126
127         /* Load block group reference */
128         struct ext4_block_group_ref bg_ref;
129         int rc = ext4_fs_get_block_group_ref(fs, block_group, &bg_ref);
130         if (rc != EOK)
131                 return rc;
132
133         /* Load block with bitmap */
134         ext4_fsblk_t bitmap_block_addr =
135             ext4_bg_get_block_bitmap(bg_ref.block_group, sb);
136
137         struct ext4_block bitmap_block;
138
139         rc = ext4_block_get(fs->bdev, &bitmap_block, bitmap_block_addr);
140         if (rc != EOK) {
141                 ext4_fs_put_block_group_ref(&bg_ref);
142                 return rc;
143         }
144
145         /* Modify bitmap */
146         ext4_bmap_bit_clr(bitmap_block.data, index_in_group);
147         ext4_balloc_set_bitmap_csum(sb, bg_ref.block_group,
148                                     bitmap_block.data);
149         bitmap_block.dirty = true;
150
151         /* Release block with bitmap */
152         rc = ext4_block_set(fs->bdev, &bitmap_block);
153         if (rc != EOK) {
154                 /* Error in saving bitmap */
155                 ext4_fs_put_block_group_ref(&bg_ref);
156                 return rc;
157         }
158
159         uint32_t block_size = ext4_sb_get_block_size(sb);
160
161         /* Update superblock free blocks count */
162         uint64_t sb_free_blocks = ext4_sb_get_free_blocks_cnt(sb);
163         sb_free_blocks++;
164         ext4_sb_set_free_blocks_cnt(sb, sb_free_blocks);
165
166         /* Update inode blocks count */
167         uint64_t ino_blocks = ext4_inode_get_blocks_count(sb, inode_ref->inode);
168         ino_blocks -= block_size / EXT4_INODE_BLOCK_SIZE;
169         ext4_inode_set_blocks_count(sb, inode_ref->inode, ino_blocks);
170         inode_ref->dirty = true;
171
172         /* Update block group free blocks count */
173         uint32_t free_blocks =
174             ext4_bg_get_free_blocks_count(bg_ref.block_group, sb);
175         free_blocks++;
176         ext4_bg_set_free_blocks_count(bg_ref.block_group, sb, free_blocks);
177
178         bg_ref.dirty = true;
179
180         /* Release block group reference */
181         return ext4_fs_put_block_group_ref(&bg_ref);
182 }
183
184 int ext4_balloc_free_blocks(struct ext4_inode_ref *inode_ref, ext4_fsblk_t first,
185                             uint32_t count)
186 {
187         int rc = EOK;
188         struct ext4_fs *fs = inode_ref->fs;
189         struct ext4_sblock *sb = &fs->sb;
190
191         /* Compute indexes */
192         uint32_t block_group_first = ext4_balloc_get_bgid_of_block(sb, first);
193
194         /* Compute indexes */
195         uint32_t block_group_last =
196             ext4_balloc_get_bgid_of_block(sb, first + count - 1);
197
198         if (!ext4_sb_feature_incom(sb, EXT4_FINCOM_FLEX_BG)) {
199                 /*It is not possible without flex_bg that blocks are continuous
200                  * and and last block belongs to other bg.*/
201                 ext4_assert(block_group_first == ext4_balloc_get_bgid_of_block(
202                                                      sb, first + count - 1));
203         }
204
205         /* Load block group reference */
206         struct ext4_block_group_ref bg_ref;
207         while (block_group_first <= block_group_last) {
208
209                 rc =
210                     ext4_fs_get_block_group_ref(fs, block_group_first, &bg_ref);
211                 if (rc != EOK)
212                         return rc;
213
214                 uint32_t index_in_group_first =
215                     ext4_fs_baddr2_index_in_group(sb, first);
216
217                 /* Load block with bitmap */
218                 ext4_fsblk_t bitmap_block_addr =
219                     ext4_bg_get_block_bitmap(bg_ref.block_group, sb);
220
221                 struct ext4_block bitmap_block;
222
223                 rc = ext4_block_get(fs->bdev, &bitmap_block, bitmap_block_addr);
224                 if (rc != EOK) {
225                         ext4_fs_put_block_group_ref(&bg_ref);
226                         return rc;
227                 }
228
229                 uint32_t free_cnt =
230                     ext4_sb_get_block_size(sb) * 8 - index_in_group_first;
231
232                 /*If last block, free only count blocks*/
233                 free_cnt = count > free_cnt ? free_cnt : count;
234
235                 /* Modify bitmap */
236                 ext4_bmap_bits_free(bitmap_block.data, index_in_group_first,
237                                     free_cnt);
238                 ext4_balloc_set_bitmap_csum(sb, bg_ref.block_group,
239                                             bitmap_block.data);
240                 bitmap_block.dirty = true;
241
242                 count -= free_cnt;
243                 first += free_cnt;
244
245                 /* Release block with bitmap */
246                 rc = ext4_block_set(fs->bdev, &bitmap_block);
247                 if (rc != EOK) {
248                         ext4_fs_put_block_group_ref(&bg_ref);
249                         return rc;
250                 }
251
252                 uint32_t block_size = ext4_sb_get_block_size(sb);
253
254                 /* Update superblock free blocks count */
255                 uint64_t sb_free_blocks = ext4_sb_get_free_blocks_cnt(sb);
256                 sb_free_blocks += free_cnt;
257                 ext4_sb_set_free_blocks_cnt(sb, sb_free_blocks);
258
259                 /* Update inode blocks count */
260                 uint64_t ino_blocks =
261                     ext4_inode_get_blocks_count(sb, inode_ref->inode);
262                 ino_blocks -= free_cnt * (block_size / EXT4_INODE_BLOCK_SIZE);
263                 ext4_inode_set_blocks_count(sb, inode_ref->inode, ino_blocks);
264                 inode_ref->dirty = true;
265
266                 /* Update block group free blocks count */
267                 uint32_t free_blocks =
268                     ext4_bg_get_free_blocks_count(bg_ref.block_group, sb);
269                 free_blocks += free_cnt;
270                 ext4_bg_set_free_blocks_count(bg_ref.block_group, sb,
271                                               free_blocks);
272                 bg_ref.dirty = true;
273
274                 /* Release block group reference */
275                 rc = ext4_fs_put_block_group_ref(&bg_ref);
276                 if (rc != EOK)
277                         break;
278
279                 block_group_first++;
280         }
281
282         /*All blocks should be released*/
283         ext4_assert(count == 0);
284         return rc;
285 }
286
287 int ext4_balloc_alloc_block(struct ext4_inode_ref *inode_ref,
288                             ext4_fsblk_t goal,
289                             ext4_fsblk_t *fblock)
290 {
291         ext4_fsblk_t allocated_block = 0;
292         ext4_fsblk_t bitmap_block_addr;
293         uint32_t rel_block_idx = 0;
294         uint64_t free_blocks;
295         struct ext4_block bitmap_block;
296         int rc;
297
298         struct ext4_sblock *sb = &inode_ref->fs->sb;
299
300         /* Load block group number for goal and relative index */
301         uint32_t block_group = ext4_balloc_get_bgid_of_block(sb, goal);
302         uint32_t index_in_group = ext4_fs_baddr2_index_in_group(sb, goal);
303
304         /* Load block group reference */
305         struct ext4_block_group_ref bg_ref;
306         rc = ext4_fs_get_block_group_ref(inode_ref->fs, block_group, &bg_ref);
307         if (rc != EOK)
308                 return rc;
309
310         free_blocks = ext4_bg_get_free_blocks_count(bg_ref.block_group, sb);
311         if (free_blocks == 0) {
312                 /* This group has no free blocks */
313                 goto goal_failed;
314         }
315
316         /* Compute indexes */
317         ext4_fsblk_t first_in_group = ext4_balloc_get_block_of_bgid(sb, bg_ref.index);
318
319         uint32_t first_in_group_index =
320             ext4_fs_baddr2_index_in_group(sb, first_in_group);
321
322         if (index_in_group < first_in_group_index)
323                 index_in_group = first_in_group_index;
324
325         /* Load block with bitmap */
326         bitmap_block_addr = ext4_bg_get_block_bitmap(bg_ref.block_group, sb);
327
328         rc = ext4_block_get(inode_ref->fs->bdev, &bitmap_block,
329                             bitmap_block_addr);
330         if (rc != EOK) {
331                 ext4_fs_put_block_group_ref(&bg_ref);
332                 return rc;
333         }
334
335         /* Check if goal is free */
336         if (ext4_bmap_is_bit_clr(bitmap_block.data, index_in_group)) {
337                 ext4_bmap_bit_set(bitmap_block.data, index_in_group);
338                 ext4_balloc_set_bitmap_csum(sb, bg_ref.block_group,
339                                             bitmap_block.data);
340                 bitmap_block.dirty = true;
341                 rc = ext4_block_set(inode_ref->fs->bdev, &bitmap_block);
342                 if (rc != EOK) {
343                         ext4_fs_put_block_group_ref(&bg_ref);
344                         return rc;
345                 }
346
347                 allocated_block = ext4_fs_index_in_group2_baddr(
348                     sb, index_in_group, block_group);
349
350                 goto success;
351         }
352
353         uint32_t blocks_in_group = ext4_blocks_in_group_cnt(sb, block_group);
354
355         uint32_t end_idx = (index_in_group + 63) & ~63;
356         if (end_idx > blocks_in_group)
357                 end_idx = blocks_in_group;
358
359         /* Try to find free block near to goal */
360         uint32_t tmp_idx;
361         for (tmp_idx = index_in_group + 1; tmp_idx < end_idx; ++tmp_idx) {
362                 if (ext4_bmap_is_bit_clr(bitmap_block.data, tmp_idx)) {
363                         ext4_bmap_bit_set(bitmap_block.data, tmp_idx);
364
365                         ext4_balloc_set_bitmap_csum(sb, bg_ref.block_group,
366                                                     bitmap_block.data);
367                         bitmap_block.dirty = true;
368                         rc = ext4_block_set(inode_ref->fs->bdev, &bitmap_block);
369                         if (rc != EOK)
370                                 return rc;
371
372                         allocated_block = ext4_fs_index_in_group2_baddr(
373                             sb, tmp_idx, block_group);
374
375                         goto success;
376                 }
377         }
378
379         /* Find free bit in bitmap */
380         rc = ext4_bmap_bit_find_clr(bitmap_block.data, index_in_group,
381                                     blocks_in_group, &rel_block_idx);
382         if (rc == EOK) {
383                 ext4_bmap_bit_set(bitmap_block.data, rel_block_idx);
384                 ext4_balloc_set_bitmap_csum(sb, bg_ref.block_group,
385                                             bitmap_block.data);
386                 bitmap_block.dirty = true;
387                 rc = ext4_block_set(inode_ref->fs->bdev, &bitmap_block);
388                 if (rc != EOK)
389                         return rc;
390
391                 allocated_block = ext4_fs_index_in_group2_baddr(
392                     sb, rel_block_idx, block_group);
393
394                 goto success;
395         }
396
397         /* No free block found yet */
398         rc = ext4_block_set(inode_ref->fs->bdev, &bitmap_block);
399         if (rc != EOK) {
400                 ext4_fs_put_block_group_ref(&bg_ref);
401                 return rc;
402         }
403
404 goal_failed:
405
406         rc = ext4_fs_put_block_group_ref(&bg_ref);
407         if (rc != EOK)
408                 return rc;
409
410         /* Try other block groups */
411         uint32_t block_group_count = ext4_block_group_cnt(sb);
412
413         uint32_t bgid = (block_group + 1) % block_group_count;
414         uint32_t count = block_group_count;
415
416         while (count > 0) {
417                 rc = ext4_fs_get_block_group_ref(inode_ref->fs, bgid, &bg_ref);
418                 if (rc != EOK)
419                         return rc;
420
421                 free_blocks =
422                     ext4_bg_get_free_blocks_count(bg_ref.block_group, sb);
423                 if (free_blocks == 0) {
424                         /* This group has no free blocks */
425                         goto next_group;
426                 }
427
428                 /* Load block with bitmap */
429                 bitmap_block_addr =
430                     ext4_bg_get_block_bitmap(bg_ref.block_group, sb);
431
432                 rc = ext4_block_get(inode_ref->fs->bdev, &bitmap_block,
433                                     bitmap_block_addr);
434
435                 if (rc != EOK) {
436                         ext4_fs_put_block_group_ref(&bg_ref);
437                         return rc;
438                 }
439
440                 /* Compute indexes */
441                 first_in_group = ext4_balloc_get_block_of_bgid(sb, bgid);
442                 index_in_group =
443                     ext4_fs_baddr2_index_in_group(sb, first_in_group);
444                 blocks_in_group = ext4_blocks_in_group_cnt(sb, bgid);
445
446                 first_in_group_index =
447                     ext4_fs_baddr2_index_in_group(sb, first_in_group);
448
449                 if (index_in_group < first_in_group_index)
450                         index_in_group = first_in_group_index;
451
452                 rc = ext4_bmap_bit_find_clr(bitmap_block.data, index_in_group,
453                                             blocks_in_group, &rel_block_idx);
454
455                 if (rc == EOK) {
456
457                         ext4_bmap_bit_set(bitmap_block.data, rel_block_idx);
458
459                         ext4_balloc_set_bitmap_csum(sb, bg_ref.block_group,
460                                                     bitmap_block.data);
461                         bitmap_block.dirty = true;
462                         rc = ext4_block_set(inode_ref->fs->bdev, &bitmap_block);
463                         if (rc != EOK) {
464                                 ext4_fs_put_block_group_ref(&bg_ref);
465                                 return rc;
466                         }
467
468                         allocated_block = ext4_fs_index_in_group2_baddr(
469                             sb, rel_block_idx, bgid);
470
471                         goto success;
472                 }
473
474                 rc = ext4_block_set(inode_ref->fs->bdev, &bitmap_block);
475                 if (rc != EOK) {
476                         ext4_fs_put_block_group_ref(&bg_ref);
477                         return rc;
478                 }
479
480         next_group:
481                 rc = ext4_fs_put_block_group_ref(&bg_ref);
482                 if (rc != EOK) {
483                         return rc;
484                 }
485
486                 /* Goto next group */
487                 bgid = (bgid + 1) % block_group_count;
488                 count--;
489         }
490
491         return ENOSPC;
492
493 success:
494     /* Empty command - because of syntax */
495     ;
496
497         uint32_t block_size = ext4_sb_get_block_size(sb);
498
499         /* Update superblock free blocks count */
500         uint64_t sb_free_blocks = ext4_sb_get_free_blocks_cnt(sb);
501         sb_free_blocks--;
502         ext4_sb_set_free_blocks_cnt(sb, sb_free_blocks);
503
504         /* Update inode blocks (different block size!) count */
505         uint64_t ino_blocks = ext4_inode_get_blocks_count(sb, inode_ref->inode);
506         ino_blocks += block_size / EXT4_INODE_BLOCK_SIZE;
507         ext4_inode_set_blocks_count(sb, inode_ref->inode, ino_blocks);
508         inode_ref->dirty = true;
509
510         /* Update block group free blocks count */
511         uint64_t bg_free_blocks =
512             ext4_bg_get_free_blocks_count(bg_ref.block_group, sb);
513         bg_free_blocks--;
514         ext4_bg_set_free_blocks_count(bg_ref.block_group, sb, bg_free_blocks);
515
516         bg_ref.dirty = true;
517
518         rc = ext4_fs_put_block_group_ref(&bg_ref);
519
520         *fblock = allocated_block;
521         return rc;
522 }
523
524 int ext4_balloc_try_alloc_block(struct ext4_inode_ref *inode_ref,
525                                 ext4_fsblk_t baddr, bool *free)
526 {
527         int rc;
528
529         struct ext4_fs *fs = inode_ref->fs;
530         struct ext4_sblock *sb = &fs->sb;
531
532         /* Compute indexes */
533         uint32_t block_group = ext4_balloc_get_bgid_of_block(sb, baddr);
534         uint32_t index_in_group = ext4_fs_baddr2_index_in_group(sb, baddr);
535
536         /* Load block group reference */
537         struct ext4_block_group_ref bg_ref;
538         rc = ext4_fs_get_block_group_ref(fs, block_group, &bg_ref);
539         if (rc != EOK)
540                 return rc;
541
542         /* Load block with bitmap */
543         ext4_fsblk_t bitmap_block_addr =
544             ext4_bg_get_block_bitmap(bg_ref.block_group, sb);
545
546         struct ext4_block bitmap_block;
547
548         rc = ext4_block_get(fs->bdev, &bitmap_block, bitmap_block_addr);
549         if (rc != EOK) {
550                 ext4_fs_put_block_group_ref(&bg_ref);
551                 return rc;
552         }
553
554         /* Check if block is free */
555         *free = ext4_bmap_is_bit_clr(bitmap_block.data, index_in_group);
556
557         /* Allocate block if possible */
558         if (*free) {
559                 ext4_bmap_bit_set(bitmap_block.data, index_in_group);
560                 ext4_balloc_set_bitmap_csum(sb, bg_ref.block_group,
561                                             bitmap_block.data);
562                 bitmap_block.dirty = true;
563         }
564
565         /* Release block with bitmap */
566         rc = ext4_block_set(fs->bdev, &bitmap_block);
567         if (rc != EOK) {
568                 /* Error in saving bitmap */
569                 ext4_fs_put_block_group_ref(&bg_ref);
570                 return rc;
571         }
572
573         /* If block is not free, return */
574         if (!(*free))
575                 goto terminate;
576
577         uint32_t block_size = ext4_sb_get_block_size(sb);
578
579         /* Update superblock free blocks count */
580         uint64_t sb_free_blocks = ext4_sb_get_free_blocks_cnt(sb);
581         sb_free_blocks--;
582         ext4_sb_set_free_blocks_cnt(sb, sb_free_blocks);
583
584         /* Update inode blocks count */
585         uint64_t ino_blocks = ext4_inode_get_blocks_count(sb, inode_ref->inode);
586         ino_blocks += block_size / EXT4_INODE_BLOCK_SIZE;
587         ext4_inode_set_blocks_count(sb, inode_ref->inode, ino_blocks);
588         inode_ref->dirty = true;
589
590         /* Update block group free blocks count */
591         uint32_t free_blocks =
592             ext4_bg_get_free_blocks_count(bg_ref.block_group, sb);
593         free_blocks--;
594         ext4_bg_set_free_blocks_count(bg_ref.block_group, sb, free_blocks);
595
596         bg_ref.dirty = true;
597
598 terminate:
599         return ext4_fs_put_block_group_ref(&bg_ref);
600 }
601
602 /**
603  * @}
604  */