Introduce EXT4_CRC32_INIT instead of ~0
[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(EXT4_CRC32_INIT, sb->uuid,
91                                 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_feature_incom(sb, EXT4_FINCOM_FLEX_BG)) {
200                 /*It is not possible without flex_bg that blocks are continuous
201                  * and and last block belongs to other bg.*/
202                 ext4_assert(block_group_first == ext4_balloc_get_bgid_of_block(
203                                                      sb, first + count - 1));
204         }
205
206         /* Load block group reference */
207         struct ext4_block_group_ref bg_ref;
208         while (block_group_first <= block_group_last) {
209
210                 rc =
211                     ext4_fs_get_block_group_ref(fs, block_group_first, &bg_ref);
212                 if (rc != EOK)
213                         return rc;
214
215                 uint32_t index_in_group_first =
216                     ext4_fs_baddr2_index_in_group(sb, first);
217
218                 /* Load block with bitmap */
219                 ext4_fsblk_t bitmap_block_addr =
220                     ext4_bg_get_block_bitmap(bg_ref.block_group, sb);
221
222                 struct ext4_block bitmap_block;
223
224                 rc = ext4_block_get(fs->bdev, &bitmap_block, bitmap_block_addr);
225                 if (rc != EOK) {
226                         ext4_fs_put_block_group_ref(&bg_ref);
227                         return rc;
228                 }
229
230                 uint32_t free_cnt =
231                     ext4_sb_get_block_size(sb) * 8 - index_in_group_first;
232
233                 /*If last block, free only count blocks*/
234                 free_cnt = count > free_cnt ? free_cnt : count;
235
236                 /* Modify bitmap */
237                 ext4_bmap_bits_free(bitmap_block.data, index_in_group_first,
238                                     free_cnt);
239                 ext4_balloc_set_bitmap_csum(sb, bg_ref.block_group,
240                                             bitmap_block.data);
241                 bitmap_block.dirty = true;
242
243                 count -= free_cnt;
244                 first += free_cnt;
245
246                 /* Release block with bitmap */
247                 rc = ext4_block_set(fs->bdev, &bitmap_block);
248                 if (rc != EOK) {
249                         ext4_fs_put_block_group_ref(&bg_ref);
250                         return rc;
251                 }
252
253                 uint32_t block_size = ext4_sb_get_block_size(sb);
254
255                 /* Update superblock free blocks count */
256                 uint64_t sb_free_blocks = ext4_sb_get_free_blocks_cnt(sb);
257                 sb_free_blocks += free_cnt;
258                 ext4_sb_set_free_blocks_cnt(sb, sb_free_blocks);
259
260                 /* Update inode blocks count */
261                 uint64_t ino_blocks =
262                     ext4_inode_get_blocks_count(sb, inode_ref->inode);
263                 ino_blocks -= free_cnt * (block_size / EXT4_INODE_BLOCK_SIZE);
264                 ext4_inode_set_blocks_count(sb, inode_ref->inode, ino_blocks);
265                 inode_ref->dirty = true;
266
267                 /* Update block group free blocks count */
268                 uint32_t free_blocks =
269                     ext4_bg_get_free_blocks_count(bg_ref.block_group, sb);
270                 free_blocks += free_cnt;
271                 ext4_bg_set_free_blocks_count(bg_ref.block_group, sb,
272                                               free_blocks);
273                 bg_ref.dirty = true;
274
275                 /* Release block group reference */
276                 rc = ext4_fs_put_block_group_ref(&bg_ref);
277                 if (rc != EOK)
278                         break;
279
280                 block_group_first++;
281         }
282
283         /*All blocks should be released*/
284         ext4_assert(count == 0);
285         return rc;
286 }
287
288 int ext4_balloc_alloc_block(struct ext4_inode_ref *inode_ref,
289                             ext4_fsblk_t goal,
290                             ext4_fsblk_t *fblock)
291 {
292         ext4_fsblk_t allocated_block = 0;
293         ext4_fsblk_t bitmap_block_addr;
294         uint32_t rel_block_idx = 0;
295         uint64_t free_blocks;
296         struct ext4_block bitmap_block;
297         int rc;
298
299         struct ext4_sblock *sb = &inode_ref->fs->sb;
300
301         /* Load block group number for goal and relative index */
302         uint32_t block_group = ext4_balloc_get_bgid_of_block(sb, goal);
303         uint32_t index_in_group = ext4_fs_baddr2_index_in_group(sb, goal);
304
305         /* Load block group reference */
306         struct ext4_block_group_ref bg_ref;
307         rc = ext4_fs_get_block_group_ref(inode_ref->fs, block_group, &bg_ref);
308         if (rc != EOK)
309                 return rc;
310
311         free_blocks = ext4_bg_get_free_blocks_count(bg_ref.block_group, sb);
312         if (free_blocks == 0) {
313                 /* This group has no free blocks */
314                 goto goal_failed;
315         }
316
317         /* Compute indexes */
318         ext4_fsblk_t first_in_group = ext4_balloc_get_block_of_bgid(sb, bg_ref.index);
319
320         uint32_t first_in_group_index =
321             ext4_fs_baddr2_index_in_group(sb, first_in_group);
322
323         if (index_in_group < first_in_group_index)
324                 index_in_group = first_in_group_index;
325
326         /* Load block with bitmap */
327         bitmap_block_addr = ext4_bg_get_block_bitmap(bg_ref.block_group, sb);
328
329         rc = ext4_block_get(inode_ref->fs->bdev, &bitmap_block,
330                             bitmap_block_addr);
331         if (rc != EOK) {
332                 ext4_fs_put_block_group_ref(&bg_ref);
333                 return rc;
334         }
335
336         /* Check if goal is free */
337         if (ext4_bmap_is_bit_clr(bitmap_block.data, index_in_group)) {
338                 ext4_bmap_bit_set(bitmap_block.data, index_in_group);
339                 ext4_balloc_set_bitmap_csum(sb, bg_ref.block_group,
340                                             bitmap_block.data);
341                 bitmap_block.dirty = true;
342                 rc = ext4_block_set(inode_ref->fs->bdev, &bitmap_block);
343                 if (rc != EOK) {
344                         ext4_fs_put_block_group_ref(&bg_ref);
345                         return rc;
346                 }
347
348                 allocated_block = ext4_fs_index_in_group2_baddr(
349                     sb, index_in_group, block_group);
350
351                 goto success;
352         }
353
354         uint32_t blocks_in_group = ext4_blocks_in_group_cnt(sb, block_group);
355
356         uint32_t end_idx = (index_in_group + 63) & ~63;
357         if (end_idx > blocks_in_group)
358                 end_idx = blocks_in_group;
359
360         /* Try to find free block near to goal */
361         uint32_t tmp_idx;
362         for (tmp_idx = index_in_group + 1; tmp_idx < end_idx; ++tmp_idx) {
363                 if (ext4_bmap_is_bit_clr(bitmap_block.data, tmp_idx)) {
364                         ext4_bmap_bit_set(bitmap_block.data, tmp_idx);
365
366                         ext4_balloc_set_bitmap_csum(sb, bg_ref.block_group,
367                                                     bitmap_block.data);
368                         bitmap_block.dirty = true;
369                         rc = ext4_block_set(inode_ref->fs->bdev, &bitmap_block);
370                         if (rc != EOK)
371                                 return rc;
372
373                         allocated_block = ext4_fs_index_in_group2_baddr(
374                             sb, tmp_idx, block_group);
375
376                         goto success;
377                 }
378         }
379
380         /* Find free bit in bitmap */
381         rc = ext4_bmap_bit_find_clr(bitmap_block.data, index_in_group,
382                                     blocks_in_group, &rel_block_idx);
383         if (rc == EOK) {
384                 ext4_bmap_bit_set(bitmap_block.data, rel_block_idx);
385                 ext4_balloc_set_bitmap_csum(sb, bg_ref.block_group,
386                                             bitmap_block.data);
387                 bitmap_block.dirty = true;
388                 rc = ext4_block_set(inode_ref->fs->bdev, &bitmap_block);
389                 if (rc != EOK)
390                         return rc;
391
392                 allocated_block = ext4_fs_index_in_group2_baddr(
393                     sb, rel_block_idx, block_group);
394
395                 goto success;
396         }
397
398         /* No free block found yet */
399         rc = ext4_block_set(inode_ref->fs->bdev, &bitmap_block);
400         if (rc != EOK) {
401                 ext4_fs_put_block_group_ref(&bg_ref);
402                 return rc;
403         }
404
405 goal_failed:
406
407         rc = ext4_fs_put_block_group_ref(&bg_ref);
408         if (rc != EOK)
409                 return rc;
410
411         /* Try other block groups */
412         uint32_t block_group_count = ext4_block_group_cnt(sb);
413
414         uint32_t bgid = (block_group + 1) % block_group_count;
415         uint32_t count = block_group_count;
416
417         while (count > 0) {
418                 rc = ext4_fs_get_block_group_ref(inode_ref->fs, bgid, &bg_ref);
419                 if (rc != EOK)
420                         return rc;
421
422                 free_blocks =
423                     ext4_bg_get_free_blocks_count(bg_ref.block_group, sb);
424                 if (free_blocks == 0) {
425                         /* This group has no free blocks */
426                         goto next_group;
427                 }
428
429                 /* Load block with bitmap */
430                 bitmap_block_addr =
431                     ext4_bg_get_block_bitmap(bg_ref.block_group, sb);
432
433                 rc = ext4_block_get(inode_ref->fs->bdev, &bitmap_block,
434                                     bitmap_block_addr);
435
436                 if (rc != EOK) {
437                         ext4_fs_put_block_group_ref(&bg_ref);
438                         return rc;
439                 }
440
441                 /* Compute indexes */
442                 first_in_group = ext4_balloc_get_block_of_bgid(sb, bgid);
443                 index_in_group =
444                     ext4_fs_baddr2_index_in_group(sb, first_in_group);
445                 blocks_in_group = ext4_blocks_in_group_cnt(sb, bgid);
446
447                 first_in_group_index =
448                     ext4_fs_baddr2_index_in_group(sb, first_in_group);
449
450                 if (index_in_group < first_in_group_index)
451                         index_in_group = first_in_group_index;
452
453                 rc = ext4_bmap_bit_find_clr(bitmap_block.data, index_in_group,
454                                             blocks_in_group, &rel_block_idx);
455
456                 if (rc == EOK) {
457
458                         ext4_bmap_bit_set(bitmap_block.data, rel_block_idx);
459
460                         ext4_balloc_set_bitmap_csum(sb, bg_ref.block_group,
461                                                     bitmap_block.data);
462                         bitmap_block.dirty = true;
463                         rc = ext4_block_set(inode_ref->fs->bdev, &bitmap_block);
464                         if (rc != EOK) {
465                                 ext4_fs_put_block_group_ref(&bg_ref);
466                                 return rc;
467                         }
468
469                         allocated_block = ext4_fs_index_in_group2_baddr(
470                             sb, rel_block_idx, bgid);
471
472                         goto success;
473                 }
474
475                 rc = ext4_block_set(inode_ref->fs->bdev, &bitmap_block);
476                 if (rc != EOK) {
477                         ext4_fs_put_block_group_ref(&bg_ref);
478                         return rc;
479                 }
480
481         next_group:
482                 rc = ext4_fs_put_block_group_ref(&bg_ref);
483                 if (rc != EOK) {
484                         return rc;
485                 }
486
487                 /* Goto next group */
488                 bgid = (bgid + 1) % block_group_count;
489                 count--;
490         }
491
492         return ENOSPC;
493
494 success:
495     /* Empty command - because of syntax */
496     ;
497
498         uint32_t block_size = ext4_sb_get_block_size(sb);
499
500         /* Update superblock free blocks count */
501         uint64_t sb_free_blocks = ext4_sb_get_free_blocks_cnt(sb);
502         sb_free_blocks--;
503         ext4_sb_set_free_blocks_cnt(sb, sb_free_blocks);
504
505         /* Update inode blocks (different block size!) count */
506         uint64_t ino_blocks = ext4_inode_get_blocks_count(sb, inode_ref->inode);
507         ino_blocks += block_size / EXT4_INODE_BLOCK_SIZE;
508         ext4_inode_set_blocks_count(sb, inode_ref->inode, ino_blocks);
509         inode_ref->dirty = true;
510
511         /* Update block group free blocks count */
512         uint64_t bg_free_blocks =
513             ext4_bg_get_free_blocks_count(bg_ref.block_group, sb);
514         bg_free_blocks--;
515         ext4_bg_set_free_blocks_count(bg_ref.block_group, sb, bg_free_blocks);
516
517         bg_ref.dirty = true;
518
519         rc = ext4_fs_put_block_group_ref(&bg_ref);
520
521         *fblock = allocated_block;
522         return rc;
523 }
524
525 int ext4_balloc_try_alloc_block(struct ext4_inode_ref *inode_ref,
526                                 ext4_fsblk_t baddr, bool *free)
527 {
528         int rc;
529
530         struct ext4_fs *fs = inode_ref->fs;
531         struct ext4_sblock *sb = &fs->sb;
532
533         /* Compute indexes */
534         uint32_t block_group = ext4_balloc_get_bgid_of_block(sb, baddr);
535         uint32_t index_in_group = ext4_fs_baddr2_index_in_group(sb, baddr);
536
537         /* Load block group reference */
538         struct ext4_block_group_ref bg_ref;
539         rc = ext4_fs_get_block_group_ref(fs, block_group, &bg_ref);
540         if (rc != EOK)
541                 return rc;
542
543         /* Load block with bitmap */
544         ext4_fsblk_t bitmap_block_addr =
545             ext4_bg_get_block_bitmap(bg_ref.block_group, sb);
546
547         struct ext4_block bitmap_block;
548
549         rc = ext4_block_get(fs->bdev, &bitmap_block, bitmap_block_addr);
550         if (rc != EOK) {
551                 ext4_fs_put_block_group_ref(&bg_ref);
552                 return rc;
553         }
554
555         /* Check if block is free */
556         *free = ext4_bmap_is_bit_clr(bitmap_block.data, index_in_group);
557
558         /* Allocate block if possible */
559         if (*free) {
560                 ext4_bmap_bit_set(bitmap_block.data, index_in_group);
561                 ext4_balloc_set_bitmap_csum(sb, bg_ref.block_group,
562                                             bitmap_block.data);
563                 bitmap_block.dirty = true;
564         }
565
566         /* Release block with bitmap */
567         rc = ext4_block_set(fs->bdev, &bitmap_block);
568         if (rc != EOK) {
569                 /* Error in saving bitmap */
570                 ext4_fs_put_block_group_ref(&bg_ref);
571                 return rc;
572         }
573
574         /* If block is not free, return */
575         if (!(*free))
576                 goto terminate;
577
578         uint32_t block_size = ext4_sb_get_block_size(sb);
579
580         /* Update superblock free blocks count */
581         uint64_t sb_free_blocks = ext4_sb_get_free_blocks_cnt(sb);
582         sb_free_blocks--;
583         ext4_sb_set_free_blocks_cnt(sb, sb_free_blocks);
584
585         /* Update inode blocks count */
586         uint64_t ino_blocks = ext4_inode_get_blocks_count(sb, inode_ref->inode);
587         ino_blocks += block_size / EXT4_INODE_BLOCK_SIZE;
588         ext4_inode_set_blocks_count(sb, inode_ref->inode, ino_blocks);
589         inode_ref->dirty = true;
590
591         /* Update block group free blocks count */
592         uint32_t free_blocks =
593             ext4_bg_get_free_blocks_count(bg_ref.block_group, sb);
594         free_blocks--;
595         ext4_bg_set_free_blocks_count(bg_ref.block_group, sb, free_blocks);
596
597         bg_ref.dirty = true;
598
599 terminate:
600         return ext4_fs_put_block_group_ref(&bg_ref);
601 }
602
603 /**
604  * @}
605  */