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