ext4_fs_inode_checksum: fix checksum calculation
[lwext4.git] / lwext4 / ext4_fs.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 /** @addtogroup lwext4
34  * @{
35  */
36 /**
37  * @file  ext4_fs.c
38  * @brief More complex filesystem functions.
39  */
40
41 #include "ext4_config.h"
42 #include "ext4_types.h"
43 #include "ext4_fs.h"
44 #include "ext4_errno.h"
45 #include "ext4_blockdev.h"
46 #include "ext4_super.h"
47 #include "ext4_crc32c.h"
48 #include "ext4_debug.h"
49 #include "ext4_block_group.h"
50 #include "ext4_balloc.h"
51 #include "ext4_bitmap.h"
52 #include "ext4_inode.h"
53 #include "ext4_ialloc.h"
54 #include "ext4_extent.h"
55
56 #include <string.h>
57
58 int ext4_fs_init(struct ext4_fs *fs, struct ext4_blockdev *bdev)
59 {
60         int r, i;
61         uint16_t tmp;
62         uint32_t bsize;
63         bool read_only = false;
64
65         ext4_assert(fs && bdev);
66
67         fs->bdev = bdev;
68
69         r = ext4_sb_read(fs->bdev, &fs->sb);
70         if (r != EOK)
71                 return r;
72
73         if (!ext4_sb_check(&fs->sb))
74                 return ENOTSUP;
75
76         bsize = ext4_sb_get_block_size(&fs->sb);
77         if (bsize > EXT4_MAX_BLOCK_SIZE)
78                 return ENXIO;
79
80         r = ext4_fs_check_features(fs, &read_only);
81         if (r != EOK)
82                 return r;
83
84         if (read_only)
85                 return ENOTSUP;
86
87         /* Compute limits for indirect block levels */
88         uint32_t blocks_id = bsize / sizeof(uint32_t);
89
90         fs->inode_block_limits[0] = EXT4_INODE_DIRECT_BLOCK_COUNT;
91         fs->inode_blocks_per_level[0] = 1;
92
93         for (i = 1; i < 4; i++) {
94                 fs->inode_blocks_per_level[i] =
95                     fs->inode_blocks_per_level[i - 1] * blocks_id;
96                 fs->inode_block_limits[i] = fs->inode_block_limits[i - 1] +
97                                             fs->inode_blocks_per_level[i];
98         }
99
100         /*Validate FS*/
101         tmp = ext4_get16(&fs->sb, state);
102         if (tmp & EXT4_SUPERBLOCK_STATE_ERROR_FS)
103                 ext4_dbg(DEBUG_FS, DBG_WARN
104                                 "last umount error: superblock fs_error flag\n");
105
106
107         /* Mark system as mounted */
108         ext4_set16(&fs->sb, state, EXT4_SUPERBLOCK_STATE_ERROR_FS);
109         r = ext4_sb_write(fs->bdev, &fs->sb);
110         if (r != EOK)
111                 return r;
112
113         /*Update mount count*/
114         ext4_set16(&fs->sb, mount_count, ext4_get16(&fs->sb, mount_count) + 1);
115
116         return r;
117 }
118
119 int ext4_fs_fini(struct ext4_fs *fs)
120 {
121         ext4_assert(fs);
122
123         /*Set superblock state*/
124         ext4_set16(&fs->sb, state, EXT4_SUPERBLOCK_STATE_VALID_FS);
125
126         return ext4_sb_write(fs->bdev, &fs->sb);
127 }
128
129 static void ext4_fs_debug_features_inc(uint32_t features_incompatible)
130 {
131         if (features_incompatible & EXT4_FINCOM_COMPRESSION)
132                 ext4_dbg(DEBUG_FS, DBG_NONE "compression\n");
133         if (features_incompatible & EXT4_FINCOM_FILETYPE)
134                 ext4_dbg(DEBUG_FS, DBG_NONE "filetype\n");
135         if (features_incompatible & EXT4_FINCOM_RECOVER)
136                 ext4_dbg(DEBUG_FS, DBG_NONE "recover\n");
137         if (features_incompatible & EXT4_FINCOM_JOURNAL_DEV)
138                 ext4_dbg(DEBUG_FS, DBG_NONE "journal_dev\n");
139         if (features_incompatible & EXT4_FINCOM_META_BG)
140                 ext4_dbg(DEBUG_FS, DBG_NONE "meta_bg\n");
141         if (features_incompatible & EXT4_FINCOM_EXTENTS)
142                 ext4_dbg(DEBUG_FS, DBG_NONE "extents\n");
143         if (features_incompatible & EXT4_FINCOM_64BIT)
144                 ext4_dbg(DEBUG_FS, DBG_NONE "64bit\n");
145         if (features_incompatible & EXT4_FINCOM_MMP)
146                 ext4_dbg(DEBUG_FS, DBG_NONE "mnp\n");
147         if (features_incompatible & EXT4_FINCOM_FLEX_BG)
148                 ext4_dbg(DEBUG_FS, DBG_NONE "flex_bg\n");
149         if (features_incompatible & EXT4_FINCOM_EA_INODE)
150                 ext4_dbg(DEBUG_FS, DBG_NONE "ea_inode\n");
151         if (features_incompatible & EXT4_FINCOM_DIRDATA)
152                 ext4_dbg(DEBUG_FS, DBG_NONE "dirdata\n");
153         if (features_incompatible & EXT4_FINCOM_BG_USE_META_CSUM)
154                 ext4_dbg(DEBUG_FS, DBG_NONE "meta_csum\n");
155         if (features_incompatible & EXT4_FINCOM_LARGEDIR)
156                 ext4_dbg(DEBUG_FS, DBG_NONE "largedir\n");
157         if (features_incompatible & EXT4_FINCOM_INLINE_DATA)
158                 ext4_dbg(DEBUG_FS, DBG_NONE "inline_data\n");
159 }
160 static void ext4_fs_debug_features_comp(uint32_t features_compatible)
161 {
162         if (features_compatible & EXT4_FCOM_DIR_PREALLOC)
163                 ext4_dbg(DEBUG_FS, DBG_NONE "dir_prealloc\n");
164         if (features_compatible & EXT4_FCOM_IMAGIC_INODES)
165                 ext4_dbg(DEBUG_FS, DBG_NONE "imagic_inodes\n");
166         if (features_compatible & EXT4_FCOM_HAS_JOURNAL)
167                 ext4_dbg(DEBUG_FS, DBG_NONE "has_journal\n");
168         if (features_compatible & EXT4_FCOM_EXT_ATTR)
169                 ext4_dbg(DEBUG_FS, DBG_NONE "ext_attr\n");
170         if (features_compatible & EXT4_FCOM_RESIZE_INODE)
171                 ext4_dbg(DEBUG_FS, DBG_NONE "resize_inode\n");
172         if (features_compatible & EXT4_FCOM_DIR_INDEX)
173                 ext4_dbg(DEBUG_FS, DBG_NONE "dir_index\n");
174 }
175
176 static void ext4_fs_debug_features_ro(uint32_t features_ro)
177 {
178         if (features_ro & EXT4_FRO_COM_SPARSE_SUPER)
179                 ext4_dbg(DEBUG_FS, DBG_NONE "sparse_super\n");
180         if (features_ro & EXT4_FRO_COM_LARGE_FILE)
181                 ext4_dbg(DEBUG_FS, DBG_NONE "large_file\n");
182         if (features_ro & EXT4_FRO_COM_BTREE_DIR)
183                 ext4_dbg(DEBUG_FS, DBG_NONE "btree_dir\n");
184         if (features_ro & EXT4_FRO_COM_HUGE_FILE)
185                 ext4_dbg(DEBUG_FS, DBG_NONE "huge_file\n");
186         if (features_ro & EXT4_FRO_COM_GDT_CSUM)
187                 ext4_dbg(DEBUG_FS, DBG_NONE "gtd_csum\n");
188         if (features_ro & EXT4_FRO_COM_DIR_NLINK)
189                 ext4_dbg(DEBUG_FS, DBG_NONE "dir_nlink\n");
190         if (features_ro & EXT4_FRO_COM_EXTRA_ISIZE)
191                 ext4_dbg(DEBUG_FS, DBG_NONE "extra_isize\n");
192         if (features_ro & EXT4_FRO_COM_QUOTA)
193                 ext4_dbg(DEBUG_FS, DBG_NONE "quota\n");
194         if (features_ro & EXT4_FRO_COM_BIGALLOC)
195                 ext4_dbg(DEBUG_FS, DBG_NONE "bigalloc\n");
196         if (features_ro & EXT4_FRO_COM_METADATA_CSUM)
197                 ext4_dbg(DEBUG_FS, DBG_NONE "metadata_csum\n");
198 }
199
200 int ext4_fs_check_features(struct ext4_fs *fs, bool *read_only)
201 {
202         ext4_assert(fs && read_only);
203         uint32_t v;
204         if (ext4_get32(&fs->sb, rev_level) == 0) {
205                 *read_only = false;
206                 return EOK;
207         }
208
209         ext4_dbg(DEBUG_FS, DBG_INFO "sblock features_incompatible:\n");
210         ext4_fs_debug_features_inc(ext4_get32(&fs->sb, features_incompatible));
211
212         ext4_dbg(DEBUG_FS, DBG_INFO "sblock features_compatible:\n");
213         ext4_fs_debug_features_comp(ext4_get32(&fs->sb, features_compatible));
214
215         ext4_dbg(DEBUG_FS, DBG_INFO "sblock features_read_only:\n");
216         ext4_fs_debug_features_ro(ext4_get32(&fs->sb, features_read_only));
217
218         /*Check features_incompatible*/
219         v = (ext4_get32(&fs->sb, features_incompatible) &
220              (~CONFIG_SUPPORTED_FINCOM));
221         if (v) {
222                 ext4_dbg(DEBUG_FS, DBG_ERROR
223                                 "sblock has unsupported features incompatible:\n");
224                 ext4_fs_debug_features_inc(v);
225                 return ENOTSUP;
226         }
227
228         /*Check features_read_only*/
229         v = (ext4_get32(&fs->sb, features_read_only) &
230              (~CONFIG_SUPPORTED_FRO_COM));
231         if (v) {
232                 ext4_dbg(DEBUG_FS, DBG_WARN
233                                 "sblock has unsupported features read only:\n");
234                 ext4_fs_debug_features_ro(v);
235                 *read_only = true;
236                 return EOK;
237         }
238         *read_only = false;
239
240         return EOK;
241 }
242
243 /**@brief Determine whether the block is inside the group.
244  * @param baddr   block address
245  * @param bgid    block group id
246  * @return Error code
247  */
248 static int ext4_block_in_group(struct ext4_sblock *s,
249                                ext4_fsblk_t baddr,
250                                uint32_t bgid)
251 {
252         uint32_t actual_bgid;
253         actual_bgid = ext4_balloc_get_bgid_of_block(s, baddr);
254         if (actual_bgid == bgid)
255                 return 1;
256         return 0;
257 }
258
259 /**@brief   To avoid calling the atomic setbit hundreds or thousands of times, we only
260  *          need to use it within a single byte (to ensure we get endianness right).
261  *          We can use memset for the rest of the bitmap as there are no other users.
262  */
263 static void ext4_fs_mark_bitmap_end(int start_bit, int end_bit, void *bitmap)
264 {
265         int i;
266
267         if (start_bit >= end_bit)
268                 return;
269
270         for (i = start_bit; (unsigned)i < ((start_bit + 7) & ~7UL); i++)
271                 ext4_bmap_bit_set(bitmap, i);
272
273         if (i < end_bit)
274                 memset((char *)bitmap + (i >> 3), 0xff, (end_bit - i) >> 3);
275 }
276
277 /**@brief Initialize block bitmap in block group.
278  * @param bg_ref Reference to block group
279  * @return Error code
280  */
281 static int ext4_fs_init_block_bitmap(struct ext4_block_group_ref *bg_ref)
282 {
283         uint32_t i, bit, bit_max;
284         uint32_t group_blocks;
285         uint16_t inode_size = ext4_get16(&bg_ref->fs->sb, inode_size);
286         uint32_t block_size = ext4_sb_get_block_size(&bg_ref->fs->sb);
287         uint32_t inodes_per_group = ext4_get32(&bg_ref->fs->sb, inodes_per_group);
288         ext4_fsblk_t bitmap_block_addr =
289             ext4_bg_get_block_bitmap(bg_ref->block_group, &bg_ref->fs->sb);
290         ext4_fsblk_t bitmap_inode_addr =
291             ext4_bg_get_inode_bitmap(bg_ref->block_group, &bg_ref->fs->sb);
292         ext4_fsblk_t inode_table_addr =
293             ext4_bg_get_inode_table_first_block(bg_ref->block_group,
294                                                 &bg_ref->fs->sb);
295         ext4_fsblk_t first_group_addr =
296             ext4_balloc_get_block_of_bgid(&bg_ref->fs->sb, bg_ref->index);
297
298         uint32_t dsc_per_block =
299             ext4_sb_get_block_size(&bg_ref->fs->sb) /
300             ext4_sb_get_desc_size(&bg_ref->fs->sb);
301
302         bool flex_bg =
303                 ext4_sb_feature_incom(&bg_ref->fs->sb, EXT4_FINCOM_FLEX_BG);
304
305         uint32_t inode_table_bcnt = inodes_per_group * inode_size / block_size;
306
307         struct ext4_block block_bitmap;
308         int rc =
309             ext4_block_get(bg_ref->fs->bdev, &block_bitmap, bitmap_block_addr);
310         if (rc != EOK)
311                 return rc;
312
313         memset(block_bitmap.data, 0, block_size);
314
315         bit_max = ext4_sb_is_super_in_bg(&bg_ref->fs->sb, bg_ref->index);
316         if (!ext4_sb_feature_incom(&bg_ref->fs->sb, EXT4_FINCOM_META_BG) ||
317                         bg_ref->index < ext4_sb_first_meta_bg(&bg_ref->fs->sb) *
318                         dsc_per_block) {
319                 if (bit_max) {
320                         bit_max += ext4_bg_num_gdb(&bg_ref->fs->sb,
321                                                    bg_ref->index);
322                         bit_max +=
323                                 ext4_get16(&bg_ref->fs->sb,
324                                            s_reserved_gdt_blocks);
325                 }
326         } else { /* For META_BG_BLOCK_GROUPS */
327                 bit_max += ext4_bg_num_gdb(&bg_ref->fs->sb,
328                                            bg_ref->index);
329         }
330         for (bit = 0; bit < bit_max; bit++)
331                 ext4_bmap_bit_set(block_bitmap.data, bit);
332
333         if (bg_ref->index == ext4_block_group_cnt(&bg_ref->fs->sb) - 1) {
334                 /*
335                  * Even though mke2fs always initialize first and last group
336                  * if some other tool enabled the EXT4_BG_BLOCK_UNINIT we need
337                  * to make sure we calculate the right free blocks
338                  */
339                 group_blocks = (ext4_sb_get_blocks_cnt(&bg_ref->fs->sb) -
340                                 ext4_get32(&bg_ref->fs->sb, first_data_block) -
341                                 (ext4_get32(&bg_ref->fs->sb, blocks_per_group) *
342                                  (ext4_block_group_cnt(&bg_ref->fs->sb) - 1)));
343         } else {
344                 group_blocks = ext4_get32(&bg_ref->fs->sb, blocks_per_group);
345         }
346         if (!flex_bg ||
347             ext4_block_in_group(&bg_ref->fs->sb,
348                                 bitmap_block_addr, bg_ref->index))
349                 ext4_bmap_bit_set(block_bitmap.data,
350                                   bitmap_block_addr - first_group_addr);
351
352         if (!flex_bg ||
353             ext4_block_in_group(&bg_ref->fs->sb,
354                                 bitmap_inode_addr, bg_ref->index))
355                 ext4_bmap_bit_set(block_bitmap.data,
356                                   bitmap_inode_addr - first_group_addr);
357
358         for (i = inode_table_addr;
359                 i < inode_table_addr + inode_table_bcnt; i++) {
360                 if (!flex_bg ||
361                     ext4_block_in_group(&bg_ref->fs->sb,
362                                         i,
363                                         bg_ref->index))
364                         ext4_bmap_bit_set(block_bitmap.data,
365                                         i - first_group_addr);
366         }
367         /*
368          * Also if the number of blocks within the group is
369          * less than the blocksize * 8 ( which is the size
370          * of bitmap ), set rest of the block bitmap to 1
371          */
372         ext4_fs_mark_bitmap_end(group_blocks, block_size * 8, block_bitmap.data);
373         block_bitmap.dirty = true;
374
375         ext4_balloc_set_bitmap_csum(&bg_ref->fs->sb,
376                                     bg_ref->block_group,
377                                     block_bitmap.data);
378         bg_ref->dirty = true;
379
380         /* Save bitmap */
381         return ext4_block_set(bg_ref->fs->bdev, &block_bitmap);
382 }
383
384 /**@brief Initialize i-node bitmap in block group.
385  * @param bg_ref Reference to block group
386  * @return Error code
387  */
388 static int ext4_fs_init_inode_bitmap(struct ext4_block_group_ref *bg_ref)
389 {
390         /* Load bitmap */
391         ext4_fsblk_t bitmap_block_addr =
392             ext4_bg_get_inode_bitmap(bg_ref->block_group, &bg_ref->fs->sb);
393
394         struct ext4_block block_bitmap;
395         int rc =
396             ext4_block_get(bg_ref->fs->bdev, &block_bitmap, bitmap_block_addr);
397         if (rc != EOK)
398                 return rc;
399
400         /* Initialize all bitmap bits to zero */
401         uint32_t block_size = ext4_sb_get_block_size(&bg_ref->fs->sb);
402         uint32_t inodes_per_group =
403             ext4_get32(&bg_ref->fs->sb, inodes_per_group);
404
405         memset(block_bitmap.data, 0, (inodes_per_group + 7) / 8);
406
407         uint32_t start_bit = inodes_per_group;
408         uint32_t end_bit = block_size * 8;
409
410         uint32_t i;
411         for (i = start_bit; i < ((start_bit + 7) & ~7UL); i++)
412                 ext4_bmap_bit_set(block_bitmap.data, i);
413
414         if (i < end_bit)
415                 memset(block_bitmap.data + (i >> 3), 0xff, (end_bit - i) >> 3);
416
417         block_bitmap.dirty = true;
418
419         ext4_ialloc_set_bitmap_csum(&bg_ref->fs->sb,
420                                     bg_ref->block_group,
421                                     block_bitmap.data);
422         bg_ref->dirty = true;
423
424         /* Save bitmap */
425         return ext4_block_set(bg_ref->fs->bdev, &block_bitmap);
426 }
427
428 /**@brief Initialize i-node table in block group.
429  * @param bg_ref Reference to block group
430  * @return Error code
431  */
432 static int ext4_fs_init_inode_table(struct ext4_block_group_ref *bg_ref)
433 {
434         struct ext4_sblock *sb = &bg_ref->fs->sb;
435
436         uint32_t inode_size = ext4_get32(sb, inode_size);
437         uint32_t block_size = ext4_sb_get_block_size(sb);
438         uint32_t inodes_per_block = block_size / inode_size;
439         uint32_t inodes_in_group = ext4_inodes_in_group_cnt(sb, bg_ref->index);
440         uint32_t table_blocks = inodes_in_group / inodes_per_block;
441         ext4_fsblk_t fblock;
442
443         if (inodes_in_group % inodes_per_block)
444                 table_blocks++;
445
446         /* Compute initialization bounds */
447         ext4_fsblk_t first_block =
448             ext4_bg_get_inode_table_first_block(bg_ref->block_group, sb);
449
450         ext4_fsblk_t last_block = first_block + table_blocks - 1;
451
452         /* Initialization of all itable blocks */
453         for (fblock = first_block; fblock <= last_block; ++fblock) {
454
455                 struct ext4_block block;
456                 int rc = ext4_block_get(bg_ref->fs->bdev, &block, fblock);
457                 if (rc != EOK)
458                         return rc;
459
460                 memset(block.data, 0, block_size);
461                 block.dirty = true;
462
463                 ext4_block_set(bg_ref->fs->bdev, &block);
464                 if (rc != EOK)
465                         return rc;
466         }
467
468         return EOK;
469 }
470
471 static ext4_fsblk_t ext4_fs_get_descriptor_block(struct ext4_sblock *s,
472                                              uint32_t bgid,
473                                              uint32_t dsc_per_block)
474 {
475         uint32_t first_meta_bg, dsc_id;
476
477         int has_super = 0;
478
479         dsc_id = bgid / dsc_per_block;
480         first_meta_bg = ext4_sb_first_meta_bg(s);
481
482         if (!ext4_sb_feature_incom(s, EXT4_FINCOM_META_BG) ||
483             dsc_id < first_meta_bg)
484                 return ext4_get32(s, first_data_block) + dsc_id + 1;
485
486         if (ext4_sb_is_super_in_bg(s, bgid))
487                 has_super = 1;
488
489         return (has_super + ext4_fs_first_bg_block_no(s, bgid));
490 }
491
492 /**@brief  Compute checksum of block group descriptor.
493  * @param sb   Superblock
494  * @param bgid Index of block group in the filesystem
495  * @param bg   Block group to compute checksum for
496  * @return Checksum value
497  */
498 static uint16_t ext4_fs_bg_checksum(struct ext4_sblock *sb, uint32_t bgid,
499                                     struct ext4_bgroup *bg)
500 {
501         /* If checksum not supported, 0 will be returned */
502         uint16_t crc = 0;
503 #if CONFIG_META_CSUM_ENABLE
504         /* Compute the checksum only if the filesystem supports it */
505         if (ext4_sb_feature_ro_com(sb, EXT4_FRO_COM_METADATA_CSUM)) {
506                 /* Use metadata_csum algorithm instead */
507                 uint32_t le32_bgid = to_le32(bgid);
508                 uint32_t orig_checksum, checksum;
509
510                 /* Preparation: temporarily set bg checksum to 0 */
511                 orig_checksum = bg->checksum;
512                 bg->checksum = 0;
513
514                 /* First calculate crc32 checksum against fs uuid */
515                 checksum = ext4_crc32c(EXT4_CRC32_INIT, sb->uuid,
516                                 sizeof(sb->uuid));
517                 /* Then calculate crc32 checksum against bgid */
518                 checksum = ext4_crc32c(checksum, &le32_bgid,
519                                      sizeof(bgid));
520                 /* Finally calculate crc32 checksum against block_group_desc */
521                 checksum = ext4_crc32c(checksum, bg,
522                                      ext4_sb_get_desc_size(sb));
523                 bg->checksum = orig_checksum;
524
525                 crc = checksum & 0xFFFF;
526                 return crc;
527         }
528 #endif
529         if (ext4_sb_feature_ro_com(sb, EXT4_FRO_COM_GDT_CSUM)) {
530                 uint8_t *base = (uint8_t *)bg;
531                 uint8_t *checksum = (uint8_t *)&bg->checksum;
532
533                 uint32_t offset = (uint32_t)(checksum - base);
534
535                 /* Convert block group index to little endian */
536                 uint32_t le_group = to_le32(bgid);
537
538                 /* Initialization */
539                 crc = ext4_bg_crc16(~0, sb->uuid, sizeof(sb->uuid));
540
541                 /* Include index of block group */
542                 crc =
543                     ext4_bg_crc16(crc, (uint8_t *)&le_group, sizeof(le_group));
544
545                 /* Compute crc from the first part (stop before checksum field)
546                  */
547                 crc = ext4_bg_crc16(crc, (uint8_t *)bg, offset);
548
549                 /* Skip checksum */
550                 offset += sizeof(bg->checksum);
551
552                 /* Checksum of the rest of block group descriptor */
553                 if ((ext4_sb_feature_incom(sb, EXT4_FINCOM_64BIT)) &&
554                     (offset < ext4_sb_get_desc_size(sb)))
555
556                         crc = ext4_bg_crc16(crc, ((uint8_t *)bg) + offset,
557                                             ext4_sb_get_desc_size(sb) - offset);
558         }
559         return crc;
560 }
561
562 #if CONFIG_META_CSUM_ENABLE
563 static bool ext4_fs_verify_bg_csum(struct ext4_sblock *sb,
564                                    uint32_t bgid,
565                                    struct ext4_bgroup *bg)
566 {
567         if (!ext4_sb_feature_ro_com(sb, EXT4_FRO_COM_METADATA_CSUM))
568                 return true;
569
570         return ext4_fs_bg_checksum(sb,
571                                    bgid,
572                                    bg) ==
573                 to_le16(bg->checksum);
574 }
575 #else
576 #define ext4_fs_verify_bg_csum(...) true
577 #endif
578
579 int ext4_fs_get_block_group_ref(struct ext4_fs *fs, uint32_t bgid,
580                                 struct ext4_block_group_ref *ref)
581 {
582         /* Compute number of descriptors, that fits in one data block */
583         uint32_t dsc_per_block =
584             ext4_sb_get_block_size(&fs->sb) / ext4_sb_get_desc_size(&fs->sb);
585
586         /* Block group descriptor table starts at the next block after
587          * superblock */
588         uint64_t block_id =
589             ext4_fs_get_descriptor_block(&fs->sb, bgid, dsc_per_block);
590
591         uint32_t offset =
592             (bgid % dsc_per_block) * ext4_sb_get_desc_size(&fs->sb);
593
594         int rc = ext4_block_get(fs->bdev, &ref->block, block_id);
595         if (rc != EOK)
596                 return rc;
597
598         ref->block_group = (void *)(ref->block.data + offset);
599         ref->fs = fs;
600         ref->index = bgid;
601         ref->dirty = false;
602
603         if (!ext4_fs_verify_bg_csum(&fs->sb,
604                                     bgid,
605                                     ref->block_group)) {
606                 ext4_dbg(DEBUG_FS,
607                          DBG_WARN "Block group descriptor checksum failed."
608                          "Block group index: %" PRIu32"\n",
609                          bgid);
610         }
611
612         if (ext4_bg_has_flag(ref->block_group, EXT4_BLOCK_GROUP_BLOCK_UNINIT)) {
613                 rc = ext4_fs_init_block_bitmap(ref);
614                 if (rc != EOK) {
615                         ext4_block_set(fs->bdev, &ref->block);
616                         return rc;
617                 }
618                 ext4_bg_clear_flag(ref->block_group,
619                                    EXT4_BLOCK_GROUP_BLOCK_UNINIT);
620
621                 ref->dirty = true;
622         }
623
624         if (ext4_bg_has_flag(ref->block_group, EXT4_BLOCK_GROUP_INODE_UNINIT)) {
625                 rc = ext4_fs_init_inode_bitmap(ref);
626                 if (rc != EOK) {
627                         ext4_block_set(ref->fs->bdev, &ref->block);
628                         return rc;
629                 }
630
631                 ext4_bg_clear_flag(ref->block_group,
632                                    EXT4_BLOCK_GROUP_INODE_UNINIT);
633
634                 if (!ext4_bg_has_flag(ref->block_group,
635                                       EXT4_BLOCK_GROUP_ITABLE_ZEROED)) {
636                         rc = ext4_fs_init_inode_table(ref);
637                         if (rc != EOK) {
638                                 ext4_block_set(fs->bdev, &ref->block);
639                                 return rc;
640                         }
641
642                         ext4_bg_set_flag(ref->block_group,
643                                          EXT4_BLOCK_GROUP_ITABLE_ZEROED);
644                 }
645
646                 ref->dirty = true;
647         }
648
649         return EOK;
650 }
651
652 int ext4_fs_put_block_group_ref(struct ext4_block_group_ref *ref)
653 {
654         /* Check if reference modified */
655         if (ref->dirty) {
656                 /* Compute new checksum of block group */
657                 uint16_t checksum = ext4_fs_bg_checksum(
658                     &ref->fs->sb, ref->index, ref->block_group);
659
660                 ref->block_group->checksum = to_le16(checksum);
661
662                 /* Mark block dirty for writing changes to physical device */
663                 ref->block.dirty = true;
664         }
665
666         /* Put back block, that contains block group descriptor */
667         return ext4_block_set(ref->fs->bdev, &ref->block);
668 }
669
670 #if CONFIG_META_CSUM_ENABLE
671 static uint32_t ext4_fs_inode_checksum(struct ext4_inode_ref *inode_ref)
672 {
673         uint32_t checksum = 0;
674         struct ext4_sblock *sb = &inode_ref->fs->sb;
675         uint16_t inode_size = ext4_get16(sb, inode_size);
676
677         if (ext4_sb_feature_ro_com(sb, EXT4_FRO_COM_METADATA_CSUM)) {
678                 uint32_t orig_checksum;
679
680                 uint32_t ino_index = to_le32(inode_ref->index);
681                 uint32_t ino_gen =
682                         to_le32(ext4_inode_get_generation(inode_ref->inode));
683
684                 /* Preparation: temporarily set bg checksum to 0 */
685                 orig_checksum = ext4_inode_get_checksum(sb, inode_ref->inode);
686                 ext4_inode_set_checksum(sb, inode_ref->inode, 0);
687
688                 /* First calculate crc32 checksum against fs uuid */
689                 checksum = ext4_crc32c(EXT4_CRC32_INIT, sb->uuid,
690                                 sizeof(sb->uuid));
691                 /* Then calculate crc32 checksum against inode number
692                  * and inode generation */
693                 checksum = ext4_crc32c(checksum, &ino_index,
694                                      sizeof(ino_index));
695                 checksum = ext4_crc32c(checksum, &ino_gen,
696                                      sizeof(ino_gen));
697                 /* Finally calculate crc32 checksum against 
698                  * the entire inode */
699                 checksum = ext4_crc32c(checksum, inode_ref->inode,
700                                 inode_size);
701                 ext4_inode_set_checksum(sb, inode_ref->inode,
702                                 orig_checksum);
703
704                 /* If inode size is not large enough to hold the
705                  * upper 16bit of the checksum */
706                 if (inode_size == EXT4_GOOD_OLD_INODE_SIZE)
707                         checksum &= 0xFFFF;
708
709         }
710         return checksum;
711 }
712 #else
713 #define ext4_fs_inode_checksum(...) 0
714 #endif
715
716 static void ext4_fs_set_inode_checksum(struct ext4_inode_ref *inode_ref)
717 {
718         struct ext4_sblock *sb = &inode_ref->fs->sb;
719         if (!ext4_sb_feature_ro_com(sb, EXT4_FRO_COM_METADATA_CSUM))
720                 return;
721
722         ext4_inode_set_checksum(sb, inode_ref->inode,
723                                 ext4_fs_inode_checksum(inode_ref));
724 }
725
726 #if CONFIG_META_CSUM_ENABLE
727 static bool ext4_fs_verify_inode_csum(struct ext4_inode_ref *inode_ref)
728 {
729         struct ext4_sblock *sb = &inode_ref->fs->sb;
730         if (!ext4_sb_feature_ro_com(sb, EXT4_FRO_COM_METADATA_CSUM))
731                 return true;
732
733         return ext4_inode_get_checksum(sb, inode_ref->inode) ==
734                 ext4_fs_inode_checksum(inode_ref);
735 }
736 #else
737 #define ext4_fs_verify_inode_csum(...) true
738 #endif
739
740 static int
741 __ext4_fs_get_inode_ref(struct ext4_fs *fs, uint32_t index,
742                         struct ext4_inode_ref *ref,
743                         bool initialized)
744 {
745         /* Compute number of i-nodes, that fits in one data block */
746         uint32_t inodes_per_group = ext4_get32(&fs->sb, inodes_per_group);
747
748         /*
749          * Inode numbers are 1-based, but it is simpler to work with 0-based
750          * when computing indices
751          */
752         index -= 1;
753         uint32_t block_group = index / inodes_per_group;
754         uint32_t offset_in_group = index % inodes_per_group;
755
756         /* Load block group, where i-node is located */
757         struct ext4_block_group_ref bg_ref;
758
759         int rc = ext4_fs_get_block_group_ref(fs, block_group, &bg_ref);
760         if (rc != EOK) {
761                 return rc;
762         }
763
764         /* Load block address, where i-node table is located */
765         uint32_t inode_table_start =
766             ext4_bg_get_inode_table_first_block(bg_ref.block_group, &fs->sb);
767
768         /* Put back block group reference (not needed more) */
769         rc = ext4_fs_put_block_group_ref(&bg_ref);
770         if (rc != EOK) {
771                 return rc;
772         }
773
774         /* Compute position of i-node in the block group */
775         uint16_t inode_size = ext4_get16(&fs->sb, inode_size);
776         uint32_t block_size = ext4_sb_get_block_size(&fs->sb);
777         uint32_t byte_offset_in_group = offset_in_group * inode_size;
778
779         /* Compute block address */
780         ext4_fsblk_t block_id =
781             inode_table_start + (byte_offset_in_group / block_size);
782
783         rc = ext4_block_get(fs->bdev, &ref->block, block_id);
784         if (rc != EOK) {
785                 return rc;
786         }
787
788         /* Compute position of i-node in the data block */
789         uint32_t offset_in_block = byte_offset_in_group % block_size;
790         ref->inode = (struct ext4_inode *)(ref->block.data + offset_in_block);
791
792         /* We need to store the original value of index in the reference */
793         ref->index = index + 1;
794         ref->fs = fs;
795         ref->dirty = false;
796
797         if (initialized && !ext4_fs_verify_inode_csum(ref)) {
798                 ext4_dbg(DEBUG_FS,
799                         DBG_WARN "Inode checksum failed."
800                         "Inode: %" PRIu32"\n",
801                         ref->index);
802         }
803
804         return EOK;
805 }
806
807 int ext4_fs_get_inode_ref(struct ext4_fs *fs, uint32_t index,
808                           struct ext4_inode_ref *ref)
809 {
810         return __ext4_fs_get_inode_ref(fs, index, ref, true);
811 }
812
813 int ext4_fs_put_inode_ref(struct ext4_inode_ref *ref)
814 {
815         /* Check if reference modified */
816         if (ref->dirty) {
817                 /* Mark block dirty for writing changes to physical device */
818                 ext4_fs_set_inode_checksum(ref);
819                 ref->block.dirty = true;
820         }
821
822         /* Put back block, that contains i-node */
823         return ext4_block_set(ref->fs->bdev, &ref->block);
824 }
825
826 void ext4_fs_inode_blocks_init(struct ext4_fs *fs, struct ext4_inode_ref *inode_ref)
827 {
828         int i;
829         struct ext4_inode *inode = inode_ref->inode;
830
831         for (i = 0; i < EXT4_INODE_BLOCKS; i++)
832                 inode->blocks[i] = 0;
833
834         (void)fs;
835 #if CONFIG_EXTENT_ENABLE
836         /* Initialize extents if needed */
837         if (ext4_sb_feature_incom(&fs->sb, EXT4_FINCOM_EXTENTS)) {
838                 ext4_inode_set_flag(inode, EXT4_INODE_FLAG_EXTENTS);
839
840                 /* Initialize extent root header */
841                 ext4_extent_tree_init(inode_ref);
842         }
843 #endif
844 }
845
846 uint32_t ext4_fs_correspond_inode_mode(int filetype)
847 {
848         switch (filetype) {
849         case EXT4_DIRENTRY_DIR:
850                 return EXT4_INODE_MODE_DIRECTORY;
851         case EXT4_DIRENTRY_REG_FILE:
852                 return EXT4_INODE_MODE_FILE;
853         case EXT4_DIRENTRY_SYMLINK:
854                 return EXT4_INODE_MODE_SOFTLINK;
855         default:
856                 /* FIXME: right now we only support 3 file type. */
857                 ext4_assert(0);
858         }
859         return 0;
860 }
861
862 int ext4_fs_alloc_inode(struct ext4_fs *fs, struct ext4_inode_ref *inode_ref,
863                         int filetype)
864 {
865         /* Check if newly allocated i-node will be a directory */
866         bool is_dir;
867         uint16_t inode_size = ext4_get16(&fs->sb, inode_size);
868
869         is_dir = (filetype == EXT4_DIRENTRY_DIR);
870
871         /* Allocate inode by allocation algorithm */
872         uint32_t index;
873         int rc = ext4_ialloc_alloc_inode(fs, &index, is_dir);
874         if (rc != EOK)
875                 return rc;
876
877         /* Load i-node from on-disk i-node table */
878         rc = __ext4_fs_get_inode_ref(fs, index, inode_ref, false);
879         if (rc != EOK) {
880                 ext4_ialloc_free_inode(fs, index, is_dir);
881                 return rc;
882         }
883
884         /* Initialize i-node */
885         struct ext4_inode *inode = inode_ref->inode;
886
887         uint32_t mode;
888         if (is_dir) {
889                 /*
890                  * Default directory permissions to be compatible with other
891                  * systems
892                  * 0777 (octal) == rwxrwxrwx
893                  */
894
895                 mode = 0777;
896                 mode |= EXT4_INODE_MODE_DIRECTORY;
897         } else {
898                 /*
899                  * Default file permissions to be compatible with other systems
900                  * 0666 (octal) == rw-rw-rw-
901                  */
902
903                 mode = 0666;
904                 mode |= ext4_fs_correspond_inode_mode(filetype);
905         }
906         ext4_inode_set_mode(&fs->sb, inode, mode);
907
908         ext4_inode_set_links_count(inode, 0);
909         ext4_inode_set_uid(inode, 0);
910         ext4_inode_set_gid(inode, 0);
911         ext4_inode_set_size(inode, 0);
912         ext4_inode_set_access_time(inode, 0);
913         ext4_inode_set_change_inode_time(inode, 0);
914         ext4_inode_set_modification_time(inode, 0);
915         ext4_inode_set_deletion_time(inode, 0);
916         ext4_inode_set_blocks_count(&fs->sb, inode, 0);
917         ext4_inode_set_flags(inode, 0);
918         ext4_inode_set_generation(inode, 0);
919         if (inode_size > EXT4_GOOD_OLD_INODE_SIZE)
920                 ext4_inode_set_extra_isize(inode,
921                                 sizeof(struct ext4_inode) -
922                                 offsetof(struct ext4_inode,
923                                         extra_isize));
924
925         /* Reset blocks array. For symbolic link inode, just
926          * fill in blocks with 0 */
927         if (ext4_inode_is_type(&fs->sb, inode, EXT4_INODE_MODE_SOFTLINK)) {
928                 for (int i = 0; i < EXT4_INODE_BLOCKS; i++)
929                         inode->blocks[i] = 0;
930
931         } else
932                 ext4_fs_inode_blocks_init(fs, inode_ref);
933
934         inode_ref->dirty = true;
935
936         return EOK;
937 }
938
939 int ext4_fs_free_inode(struct ext4_inode_ref *inode_ref)
940 {
941         struct ext4_fs *fs = inode_ref->fs;
942         uint32_t offset;
943         uint32_t suboff;
944         int rc;
945 #if CONFIG_EXTENT_ENABLE
946         /* For extents must be data block destroyed by other way */
947         if ((ext4_sb_feature_incom(&fs->sb, EXT4_FINCOM_EXTENTS)) &&
948             (ext4_inode_has_flag(inode_ref->inode, EXT4_INODE_FLAG_EXTENTS))) {
949                 /* Data structures are released during truncate operation... */
950                 goto finish;
951         }
952 #endif
953         /* Release all indirect (no data) blocks */
954
955         /* 1) Single indirect */
956         ext4_fsblk_t fblock = ext4_inode_get_indirect_block(inode_ref->inode, 0);
957         if (fblock != 0) {
958                 int rc = ext4_balloc_free_block(inode_ref, fblock);
959                 if (rc != EOK)
960                         return rc;
961
962                 ext4_inode_set_indirect_block(inode_ref->inode, 0, 0);
963         }
964
965         uint32_t block_size = ext4_sb_get_block_size(&fs->sb);
966         uint32_t count = block_size / sizeof(uint32_t);
967
968         struct ext4_block block;
969
970         /* 2) Double indirect */
971         fblock = ext4_inode_get_indirect_block(inode_ref->inode, 1);
972         if (fblock != 0) {
973                 int rc = ext4_block_get(fs->bdev, &block, fblock);
974                 if (rc != EOK)
975                         return rc;
976
977                 ext4_fsblk_t ind_block;
978                 for (offset = 0; offset < count; ++offset) {
979                         ind_block = to_le32(((uint32_t *)block.data)[offset]);
980
981                         if (ind_block == 0)
982                                 continue;
983                         rc = ext4_balloc_free_block(inode_ref, ind_block);
984                         if (rc != EOK) {
985                                 ext4_block_set(fs->bdev, &block);
986                                 return rc;
987                         }
988
989                 }
990
991                 ext4_block_set(fs->bdev, &block);
992                 rc = ext4_balloc_free_block(inode_ref, fblock);
993                 if (rc != EOK)
994                         return rc;
995
996                 ext4_inode_set_indirect_block(inode_ref->inode, 1, 0);
997         }
998
999         /* 3) Tripple indirect */
1000         struct ext4_block subblock;
1001         fblock = ext4_inode_get_indirect_block(inode_ref->inode, 2);
1002         if (fblock == 0)
1003                 goto finish;
1004         rc = ext4_block_get(fs->bdev, &block, fblock);
1005         if (rc != EOK)
1006                 return rc;
1007
1008         ext4_fsblk_t ind_block;
1009         for (offset = 0; offset < count; ++offset) {
1010                 ind_block = to_le32(((uint32_t *)block.data)[offset]);
1011
1012                 if (ind_block == 0)
1013                         continue;
1014                 rc = ext4_block_get(fs->bdev, &subblock,
1015                                 ind_block);
1016                 if (rc != EOK) {
1017                         ext4_block_set(fs->bdev, &block);
1018                         return rc;
1019                 }
1020
1021                 ext4_fsblk_t ind_subblk;
1022                 for (suboff = 0; suboff < count; ++suboff) {
1023                         ind_subblk = to_le32(((uint32_t *)subblock.data)[suboff]);
1024
1025                         if (ind_subblk == 0)
1026                                 continue;
1027                         rc = ext4_balloc_free_block(inode_ref, ind_subblk);
1028                         if (rc != EOK) {
1029                                 ext4_block_set(fs->bdev, &subblock);
1030                                 ext4_block_set(fs->bdev, &block);
1031                                 return rc;
1032                         }
1033
1034                 }
1035
1036                 ext4_block_set(fs->bdev, &subblock);
1037
1038                 rc = ext4_balloc_free_block(inode_ref,
1039                                 ind_block);
1040                 if (rc != EOK) {
1041                         ext4_block_set(fs->bdev, &block);
1042                         return rc;
1043                 }
1044
1045         }
1046
1047         ext4_block_set(fs->bdev, &block);
1048         rc = ext4_balloc_free_block(inode_ref, fblock);
1049         if (rc != EOK)
1050                 return rc;
1051
1052         ext4_inode_set_indirect_block(inode_ref->inode, 2, 0);
1053 finish:
1054         /* Mark inode dirty for writing to the physical device */
1055         inode_ref->dirty = true;
1056
1057         /* Free block with extended attributes if present */
1058         ext4_fsblk_t xattr_block =
1059             ext4_inode_get_file_acl(inode_ref->inode, &fs->sb);
1060         if (xattr_block) {
1061                 int rc = ext4_balloc_free_block(inode_ref, xattr_block);
1062                 if (rc != EOK)
1063                         return rc;
1064
1065                 ext4_inode_set_file_acl(inode_ref->inode, &fs->sb, 0);
1066         }
1067
1068         /* Free inode by allocator */
1069         if (ext4_inode_is_type(&fs->sb, inode_ref->inode,
1070                                EXT4_INODE_MODE_DIRECTORY))
1071                 rc = ext4_ialloc_free_inode(fs, inode_ref->index, true);
1072         else
1073                 rc = ext4_ialloc_free_inode(fs, inode_ref->index, false);
1074
1075         return rc;
1076 }
1077
1078
1079 /**@brief Release data block from i-node
1080  * @param inode_ref I-node to release block from
1081  * @param iblock    Logical block to be released
1082  * @return Error code
1083  */
1084 static int ext4_fs_release_inode_block(struct ext4_inode_ref *inode_ref,
1085                                 uint32_t iblock)
1086 {
1087         ext4_fsblk_t fblock;
1088
1089         struct ext4_fs *fs = inode_ref->fs;
1090
1091         /* Extents are handled otherwise = there is not support in this function
1092          */
1093         ext4_assert(!(
1094             ext4_sb_feature_incom(&fs->sb, EXT4_FINCOM_EXTENTS) &&
1095             (ext4_inode_has_flag(inode_ref->inode, EXT4_INODE_FLAG_EXTENTS))));
1096
1097         struct ext4_inode *inode = inode_ref->inode;
1098
1099         /* Handle simple case when we are dealing with direct reference */
1100         if (iblock < EXT4_INODE_DIRECT_BLOCK_COUNT) {
1101                 fblock = ext4_inode_get_direct_block(inode, iblock);
1102
1103                 /* Sparse file */
1104                 if (fblock == 0)
1105                         return EOK;
1106
1107                 ext4_inode_set_direct_block(inode, iblock, 0);
1108                 return ext4_balloc_free_block(inode_ref, fblock);
1109         }
1110
1111         /* Determine the indirection level needed to get the desired block */
1112         unsigned int level = 0;
1113         unsigned int i;
1114         for (i = 1; i < 4; i++) {
1115                 if (iblock < fs->inode_block_limits[i]) {
1116                         level = i;
1117                         break;
1118                 }
1119         }
1120
1121         if (level == 0)
1122                 return EIO;
1123
1124         /* Compute offsets for the topmost level */
1125         uint64_t block_offset_in_level =
1126             iblock - fs->inode_block_limits[level - 1];
1127         ext4_fsblk_t current_block =
1128             ext4_inode_get_indirect_block(inode, level - 1);
1129         uint32_t offset_in_block =
1130             block_offset_in_level / fs->inode_blocks_per_level[level - 1];
1131
1132         /*
1133          * Navigate through other levels, until we find the block number
1134          * or find null reference meaning we are dealing with sparse file
1135          */
1136         struct ext4_block block;
1137
1138         while (level > 0) {
1139
1140                 /* Sparse check */
1141                 if (current_block == 0)
1142                         return EOK;
1143
1144                 int rc = ext4_block_get(fs->bdev, &block, current_block);
1145                 if (rc != EOK)
1146                         return rc;
1147
1148                 current_block =
1149                     to_le32(((uint32_t *)block.data)[offset_in_block]);
1150
1151                 /* Set zero if physical data block address found */
1152                 if (level == 1) {
1153                         ((uint32_t *)block.data)[offset_in_block] = to_le32(0);
1154                         block.dirty = true;
1155                 }
1156
1157                 rc = ext4_block_set(fs->bdev, &block);
1158                 if (rc != EOK)
1159                         return rc;
1160
1161                 level--;
1162
1163                 /*
1164                  * If we are on the last level, break here as
1165                  * there is no next level to visit
1166                  */
1167                 if (level == 0)
1168                         break;
1169
1170                 /* Visit the next level */
1171                 block_offset_in_level %= fs->inode_blocks_per_level[level];
1172                 offset_in_block = block_offset_in_level /
1173                                   fs->inode_blocks_per_level[level - 1];
1174         }
1175
1176         fblock = current_block;
1177         if (fblock == 0)
1178                 return EOK;
1179
1180         /* Physical block is not referenced, it can be released */
1181         return ext4_balloc_free_block(inode_ref, fblock);
1182 }
1183
1184 int ext4_fs_truncate_inode(struct ext4_inode_ref *inode_ref, uint64_t new_size)
1185 {
1186         struct ext4_sblock *sb = &inode_ref->fs->sb;
1187         uint32_t i;
1188
1189         /* Check flags, if i-node can be truncated */
1190         if (!ext4_inode_can_truncate(sb, inode_ref->inode))
1191                 return EINVAL;
1192
1193         /* If sizes are equal, nothing has to be done. */
1194         uint64_t old_size = ext4_inode_get_size(sb, inode_ref->inode);
1195         if (old_size == new_size)
1196                 return EOK;
1197
1198         /* It's not supported to make the larger file by truncate operation */
1199         if (old_size < new_size)
1200                 return EINVAL;
1201
1202         if (ext4_inode_is_type(sb, inode_ref->inode, EXT4_INODE_MODE_SOFTLINK)
1203                         && old_size < sizeof(inode_ref->inode->blocks)
1204                         && !ext4_inode_get_blocks_count(sb, inode_ref->inode)) {
1205                 char *content = (char *)inode_ref->inode->blocks;
1206                 memset(content + new_size, 0,
1207                         sizeof(inode_ref->inode->blocks) - new_size);
1208                 ext4_inode_set_size(inode_ref->inode, new_size);
1209                 inode_ref->dirty = true;
1210
1211                 return EOK;
1212         }
1213
1214         /* Compute how many blocks will be released */
1215         uint32_t block_size = ext4_sb_get_block_size(sb);
1216         uint32_t new_blocks_count = (new_size + block_size - 1) /
1217                                     block_size;
1218         uint32_t old_blocks_count = (old_size + block_size - 1) /
1219                                     block_size;
1220         uint32_t diff_blocks_count = old_blocks_count - new_blocks_count;
1221 #if CONFIG_EXTENT_ENABLE
1222         if ((ext4_sb_feature_incom(sb, EXT4_FINCOM_EXTENTS)) &&
1223             (ext4_inode_has_flag(inode_ref->inode, EXT4_INODE_FLAG_EXTENTS))) {
1224
1225                 /* Extents require special operation */
1226                 if (diff_blocks_count) {
1227                         int rc = ext4_extent_remove_space(inode_ref,
1228                                         new_blocks_count, EXT_MAX_BLOCKS);
1229                         if (rc != EOK)
1230                                 return rc;
1231
1232                 }
1233         } else
1234 #endif
1235         {
1236                 /* Release data blocks from the end of file */
1237
1238                 /* Starting from 1 because of logical blocks are numbered from 0
1239                  */
1240                 for (i = 0; i < diff_blocks_count; ++i) {
1241                         int rc = ext4_fs_release_inode_block(
1242                             inode_ref, new_blocks_count + i);
1243                         if (rc != EOK)
1244                                 return rc;
1245                 }
1246         }
1247
1248         /* Update i-node */
1249         ext4_inode_set_size(inode_ref->inode, new_size);
1250         inode_ref->dirty = true;
1251
1252         return EOK;
1253 }
1254
1255 /**@brief Compute 'goal' for inode index
1256  * @param inode_ref Reference to inode, to allocate block for
1257  * @return goal
1258  */
1259 ext4_fsblk_t ext4_fs_inode_to_goal_block(struct ext4_inode_ref *inode_ref)
1260 {
1261         uint32_t group_inodes =
1262                 ext4_get32(&inode_ref->fs->sb, inodes_per_group);
1263         return (inode_ref->index - 1) / group_inodes;
1264 }
1265
1266 /**@brief Compute 'goal' for allocation algorithm (For blockmap).
1267  * @param inode_ref Reference to inode, to allocate block for
1268  * @param goal
1269  * @return error code
1270  */
1271 int ext4_fs_indirect_find_goal(struct ext4_inode_ref *inode_ref,
1272                                 ext4_fsblk_t *goal)
1273 {
1274         struct ext4_sblock *sb = &inode_ref->fs->sb;
1275         *goal = 0;
1276
1277         uint64_t inode_size = ext4_inode_get_size(sb, inode_ref->inode);
1278         uint32_t block_size = ext4_sb_get_block_size(sb);
1279         uint32_t inode_block_count = inode_size / block_size;
1280
1281         if (inode_size % block_size != 0)
1282                 inode_block_count++;
1283
1284         /* If inode has some blocks, get last block address + 1 */
1285         if (inode_block_count > 0) {
1286                 int rc = ext4_fs_get_inode_data_block_index(
1287                     inode_ref, inode_block_count - 1, goal, false);
1288                 if (rc != EOK)
1289                         return rc;
1290
1291                 if (*goal != 0) {
1292                         (*goal)++;
1293                         return rc;
1294                 }
1295
1296                 /* If goal == 0, sparse file -> continue */
1297         }
1298
1299         /* Identify block group of inode */
1300
1301         uint32_t inodes_per_group = ext4_get32(sb, inodes_per_group);
1302         uint32_t block_group = (inode_ref->index - 1) / inodes_per_group;
1303         block_size = ext4_sb_get_block_size(sb);
1304
1305         /* Load block group reference */
1306         struct ext4_block_group_ref bg_ref;
1307         int rc =
1308             ext4_fs_get_block_group_ref(inode_ref->fs, block_group, &bg_ref);
1309         if (rc != EOK)
1310                 return rc;
1311
1312         /* Compute indexes */
1313         uint32_t block_group_count = ext4_block_group_cnt(sb);
1314         ext4_fsblk_t inode_table_first_block =
1315             ext4_bg_get_inode_table_first_block(bg_ref.block_group, sb);
1316         uint16_t inode_table_item_size = ext4_get16(sb, inode_size);
1317         uint32_t inode_table_bytes;
1318
1319         /* Check for last block group */
1320         if (block_group < block_group_count - 1) {
1321                 inode_table_bytes = inodes_per_group * inode_table_item_size;
1322         } else {
1323                 /* Last block group could be smaller */
1324                 uint32_t inodes_count_total = ext4_get32(sb, inodes_count);
1325
1326                 inode_table_bytes =
1327                     (inodes_count_total -
1328                      ((block_group_count - 1) * inodes_per_group)) *
1329                     inode_table_item_size;
1330         }
1331
1332         ext4_fsblk_t inode_table_blocks = inode_table_bytes / block_size;
1333
1334         if (inode_table_bytes % block_size)
1335                 inode_table_blocks++;
1336
1337         *goal = inode_table_first_block + inode_table_blocks;
1338
1339         return ext4_fs_put_block_group_ref(&bg_ref);
1340 }
1341
1342 static int ext4_fs_get_inode_data_block_idx(struct ext4_inode_ref *inode_ref,
1343                                        uint64_t iblock, ext4_fsblk_t *fblock,
1344                                        bool extent_create,
1345                                        bool support_unwritten __unused)
1346 {
1347         struct ext4_fs *fs = inode_ref->fs;
1348
1349         /* For empty file is situation simple */
1350         if (ext4_inode_get_size(&fs->sb, inode_ref->inode) == 0) {
1351                 *fblock = 0;
1352                 return EOK;
1353         }
1354
1355         ext4_fsblk_t current_block;
1356
1357         (void)extent_create;
1358 #if CONFIG_EXTENT_ENABLE
1359         /* Handle i-node using extents */
1360         if ((ext4_sb_feature_incom(&fs->sb, EXT4_FINCOM_EXTENTS)) &&
1361             (ext4_inode_has_flag(inode_ref->inode, EXT4_INODE_FLAG_EXTENTS))) {
1362
1363                 ext4_fsblk_t current_fsblk;
1364                 int rc = ext4_extent_get_blocks(inode_ref, iblock, 1,
1365                                 &current_fsblk, extent_create, NULL);
1366                 if (rc != EOK)
1367                         return rc;
1368
1369                 current_block = current_fsblk;
1370                 *fblock = current_block;
1371
1372                 ext4_assert(*fblock || support_unwritten);
1373                 return EOK;
1374         }
1375 #endif
1376
1377         struct ext4_inode *inode = inode_ref->inode;
1378
1379         /* Direct block are read directly from array in i-node structure */
1380         if (iblock < EXT4_INODE_DIRECT_BLOCK_COUNT) {
1381                 current_block =
1382                     ext4_inode_get_direct_block(inode, (uint32_t)iblock);
1383                 *fblock = current_block;
1384                 return EOK;
1385         }
1386
1387         /* Determine indirection level of the target block */
1388         unsigned int level = 0;
1389         unsigned int i;
1390         for (i = 1; i < 4; i++) {
1391                 if (iblock < fs->inode_block_limits[i]) {
1392                         level = i;
1393                         break;
1394                 }
1395         }
1396
1397         if (level == 0)
1398                 return EIO;
1399
1400         /* Compute offsets for the topmost level */
1401         uint64_t block_offset_in_level =
1402             iblock - fs->inode_block_limits[level - 1];
1403         current_block = ext4_inode_get_indirect_block(inode, level - 1);
1404         uint32_t offset_in_block =
1405             block_offset_in_level / fs->inode_blocks_per_level[level - 1];
1406
1407         /* Sparse file */
1408         if (current_block == 0) {
1409                 *fblock = 0;
1410                 return EOK;
1411         }
1412
1413         struct ext4_block block;
1414
1415         /*
1416          * Navigate through other levels, until we find the block number
1417          * or find null reference meaning we are dealing with sparse file
1418          */
1419         while (level > 0) {
1420                 /* Load indirect block */
1421                 int rc = ext4_block_get(fs->bdev, &block, current_block);
1422                 if (rc != EOK)
1423                         return rc;
1424
1425                 /* Read block address from indirect block */
1426                 current_block =
1427                     to_le32(((uint32_t *)block.data)[offset_in_block]);
1428
1429                 /* Put back indirect block untouched */
1430                 rc = ext4_block_set(fs->bdev, &block);
1431                 if (rc != EOK)
1432                         return rc;
1433
1434                 /* Check for sparse file */
1435                 if (current_block == 0) {
1436                         *fblock = 0;
1437                         return EOK;
1438                 }
1439
1440                 /* Jump to the next level */
1441                 level--;
1442
1443                 /* Termination condition - we have address of data block loaded
1444                  */
1445                 if (level == 0)
1446                         break;
1447
1448                 /* Visit the next level */
1449                 block_offset_in_level %= fs->inode_blocks_per_level[level];
1450                 offset_in_block = block_offset_in_level /
1451                                   fs->inode_blocks_per_level[level - 1];
1452         }
1453
1454         *fblock = current_block;
1455
1456         return EOK;
1457 }
1458
1459
1460 int ext4_fs_get_inode_data_block_index(struct ext4_inode_ref *inode_ref,
1461                                        uint64_t iblock, ext4_fsblk_t *fblock,
1462                                        bool support_unwritten)
1463 {
1464         return ext4_fs_get_inode_data_block_idx(inode_ref, iblock, fblock,
1465                         false, support_unwritten);
1466 }
1467
1468 int ext4_fs_init_inode_data_block_index(struct ext4_inode_ref *inode_ref,
1469                                        uint64_t iblock, ext4_fsblk_t *fblock)
1470 {
1471         return ext4_fs_get_inode_data_block_idx(inode_ref, iblock, fblock,
1472                         true, true);
1473 }
1474
1475 static int ext4_fs_set_inode_data_block_index(struct ext4_inode_ref *inode_ref,
1476                                        uint64_t iblock, ext4_fsblk_t fblock)
1477 {
1478         struct ext4_fs *fs = inode_ref->fs;
1479
1480 #if CONFIG_EXTENT_ENABLE
1481         /* Handle inode using extents */
1482         if ((ext4_sb_feature_incom(&fs->sb, EXT4_FINCOM_EXTENTS)) &&
1483             (ext4_inode_has_flag(inode_ref->inode, EXT4_INODE_FLAG_EXTENTS))) {
1484                 /* Not reachable */
1485                 return ENOTSUP;
1486         }
1487 #endif
1488
1489         /* Handle simple case when we are dealing with direct reference */
1490         if (iblock < EXT4_INODE_DIRECT_BLOCK_COUNT) {
1491                 ext4_inode_set_direct_block(inode_ref->inode, (uint32_t)iblock,
1492                                             (uint32_t)fblock);
1493                 inode_ref->dirty = true;
1494
1495                 return EOK;
1496         }
1497
1498         /* Determine the indirection level needed to get the desired block */
1499         unsigned int level = 0;
1500         unsigned int i;
1501         for (i = 1; i < 4; i++) {
1502                 if (iblock < fs->inode_block_limits[i]) {
1503                         level = i;
1504                         break;
1505                 }
1506         }
1507
1508         if (level == 0)
1509                 return EIO;
1510
1511         uint32_t block_size = ext4_sb_get_block_size(&fs->sb);
1512
1513         /* Compute offsets for the topmost level */
1514         uint64_t block_offset_in_level =
1515             iblock - fs->inode_block_limits[level - 1];
1516         ext4_fsblk_t current_block =
1517             ext4_inode_get_indirect_block(inode_ref->inode, level - 1);
1518         uint32_t offset_in_block =
1519             block_offset_in_level / fs->inode_blocks_per_level[level - 1];
1520
1521         ext4_fsblk_t new_block_addr;
1522
1523         struct ext4_block block;
1524         struct ext4_block new_block;
1525
1526         /* Is needed to allocate indirect block on the i-node level */
1527         if (current_block == 0) {
1528                 /* Allocate new indirect block */
1529                 ext4_fsblk_t goal;
1530                 int rc = ext4_fs_indirect_find_goal(inode_ref, &goal);
1531                 if (rc != EOK)
1532                         return rc;
1533
1534                 rc = ext4_balloc_alloc_block(inode_ref,
1535                                              goal,
1536                                              &new_block_addr);
1537                 if (rc != EOK)
1538                         return rc;
1539
1540                 /* Update i-node */
1541                 ext4_inode_set_indirect_block(inode_ref->inode, level - 1,
1542                                               (uint32_t)new_block_addr);
1543                 inode_ref->dirty = true;
1544
1545                 /* Load newly allocated block */
1546                 rc = ext4_block_get(fs->bdev, &new_block, new_block_addr);
1547                 if (rc != EOK) {
1548                         ext4_balloc_free_block(inode_ref, new_block_addr);
1549                         return rc;
1550                 }
1551
1552                 /* Initialize new block */
1553                 memset(new_block.data, 0, block_size);
1554                 new_block.dirty = true;
1555
1556                 /* Put back the allocated block */
1557                 rc = ext4_block_set(fs->bdev, &new_block);
1558                 if (rc != EOK)
1559                         return rc;
1560
1561                 current_block = new_block_addr;
1562         }
1563
1564         /*
1565          * Navigate through other levels, until we find the block number
1566          * or find null reference meaning we are dealing with sparse file
1567          */
1568         while (level > 0) {
1569                 int rc = ext4_block_get(fs->bdev, &block, current_block);
1570                 if (rc != EOK)
1571                         return rc;
1572
1573                 current_block =
1574                     to_le32(((uint32_t *)block.data)[offset_in_block]);
1575
1576                 if ((level > 1) && (current_block == 0)) {
1577                         ext4_fsblk_t goal;
1578                         rc = ext4_fs_indirect_find_goal(inode_ref, &goal);
1579                         if (rc != EOK) {
1580                                 ext4_block_set(fs->bdev, &block);
1581                                 return rc;
1582                         }
1583
1584                         /* Allocate new block */
1585                         rc =
1586                             ext4_balloc_alloc_block(inode_ref, goal, &new_block_addr);
1587                         if (rc != EOK) {
1588                                 ext4_block_set(fs->bdev, &block);
1589                                 return rc;
1590                         }
1591
1592                         /* Load newly allocated block */
1593                         rc = ext4_block_get(fs->bdev, &new_block,
1594                                             new_block_addr);
1595
1596                         if (rc != EOK) {
1597                                 ext4_block_set(fs->bdev, &block);
1598                                 return rc;
1599                         }
1600
1601                         /* Initialize allocated block */
1602                         memset(new_block.data, 0, block_size);
1603                         new_block.dirty = true;
1604
1605                         rc = ext4_block_set(fs->bdev, &new_block);
1606                         if (rc != EOK) {
1607                                 ext4_block_set(fs->bdev, &block);
1608                                 return rc;
1609                         }
1610
1611                         /* Write block address to the parent */
1612                         ((uint32_t *)block.data)[offset_in_block] =
1613                             to_le32((uint32_t)new_block_addr);
1614                         block.dirty = true;
1615                         current_block = new_block_addr;
1616                 }
1617
1618                 /* Will be finished, write the fblock address */
1619                 if (level == 1) {
1620                         ((uint32_t *)block.data)[offset_in_block] =
1621                             to_le32((uint32_t)fblock);
1622                         block.dirty = true;
1623                 }
1624
1625                 rc = ext4_block_set(fs->bdev, &block);
1626                 if (rc != EOK)
1627                         return rc;
1628
1629                 level--;
1630
1631                 /*
1632                  * If we are on the last level, break here as
1633                  * there is no next level to visit
1634                  */
1635                 if (level == 0)
1636                         break;
1637
1638                 /* Visit the next level */
1639                 block_offset_in_level %= fs->inode_blocks_per_level[level];
1640                 offset_in_block = block_offset_in_level /
1641                                   fs->inode_blocks_per_level[level - 1];
1642         }
1643
1644         return EOK;
1645 }
1646
1647
1648 int ext4_fs_append_inode_block(struct ext4_inode_ref *inode_ref,
1649                                ext4_fsblk_t *fblock, uint32_t *iblock)
1650 {
1651 #if CONFIG_EXTENT_ENABLE
1652         /* Handle extents separately */
1653         if ((ext4_sb_feature_incom(&inode_ref->fs->sb, EXT4_FINCOM_EXTENTS)) &&
1654             (ext4_inode_has_flag(inode_ref->inode, EXT4_INODE_FLAG_EXTENTS))) {
1655                 int rc;
1656                 ext4_fsblk_t current_fsblk;
1657                 struct ext4_sblock *sb = &inode_ref->fs->sb;
1658                 uint64_t inode_size = ext4_inode_get_size(sb, inode_ref->inode);
1659                 uint32_t block_size = ext4_sb_get_block_size(sb);
1660                 *iblock = (inode_size + block_size - 1) /
1661                                     block_size;
1662
1663                 rc = ext4_extent_get_blocks(inode_ref, *iblock, 1,
1664                                 &current_fsblk, true, NULL);
1665
1666
1667                 *fblock = current_fsblk;
1668                 ext4_assert(*fblock);
1669
1670                 ext4_inode_set_size(inode_ref->inode,
1671                                     inode_size + block_size);
1672                 inode_ref->dirty = true;
1673
1674
1675                 return rc;
1676         }
1677 #endif
1678         struct ext4_sblock *sb = &inode_ref->fs->sb;
1679
1680         /* Compute next block index and allocate data block */
1681         uint64_t inode_size = ext4_inode_get_size(sb, inode_ref->inode);
1682         uint32_t block_size = ext4_sb_get_block_size(sb);
1683
1684         /* Align size i-node size */
1685         if ((inode_size % block_size) != 0)
1686                 inode_size += block_size - (inode_size % block_size);
1687
1688         /* Logical blocks are numbered from 0 */
1689         uint32_t new_block_idx = inode_size / block_size;
1690
1691         /* Allocate new physical block */
1692         ext4_fsblk_t goal, phys_block;
1693         int rc = ext4_fs_indirect_find_goal(inode_ref, &goal);
1694         if (rc != EOK)
1695                 return rc;
1696
1697         rc = ext4_balloc_alloc_block(inode_ref, goal, &phys_block);
1698         if (rc != EOK)
1699                 return rc;
1700
1701         /* Add physical block address to the i-node */
1702         rc = ext4_fs_set_inode_data_block_index(inode_ref, new_block_idx,
1703                                                 phys_block);
1704         if (rc != EOK) {
1705                 ext4_balloc_free_block(inode_ref, phys_block);
1706                 return rc;
1707         }
1708
1709         /* Update i-node */
1710         ext4_inode_set_size(inode_ref->inode, inode_size + block_size);
1711         inode_ref->dirty = true;
1712
1713         *fblock = phys_block;
1714         *iblock = new_block_idx;
1715
1716         return EOK;
1717 }
1718
1719 void ext4_fs_inode_links_count_inc(struct ext4_inode_ref *inode_ref)
1720 {
1721         uint16_t link;
1722
1723         link = ext4_inode_get_links_count(inode_ref->inode);
1724         link++;
1725         ext4_inode_set_links_count(inode_ref->inode, link);
1726
1727         bool is_dx =
1728             ext4_sb_feature_com(&inode_ref->fs->sb, EXT4_FCOM_DIR_INDEX) &&
1729             ext4_inode_has_flag(inode_ref->inode, EXT4_INODE_FLAG_INDEX);
1730
1731         if (is_dx && link > 1) {
1732                 if (link >= EXT4_LINK_MAX || link == 2) {
1733                         ext4_inode_set_links_count(inode_ref->inode, 1);
1734
1735                         uint32_t v =
1736                             ext4_get32(&inode_ref->fs->sb, features_read_only);
1737                         v |= EXT4_FRO_COM_DIR_NLINK;
1738                         ext4_set32(&inode_ref->fs->sb, features_read_only, v);
1739                 }
1740         }
1741 }
1742
1743 void ext4_fs_inode_links_count_dec(struct ext4_inode_ref *inode_ref)
1744 {
1745         uint16_t links = ext4_inode_get_links_count(inode_ref->inode);
1746         if (!ext4_inode_is_type(&inode_ref->fs->sb, inode_ref->inode,
1747                                 EXT4_INODE_MODE_DIRECTORY)) {
1748                 if (links > 0)
1749                         ext4_inode_set_links_count(inode_ref->inode, links - 1);
1750                 return;
1751         }
1752
1753         if (links > 2)
1754                 ext4_inode_set_links_count(inode_ref->inode, links - 1);
1755 }
1756
1757 /**
1758  * @}
1759  */