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