1 // SPDX-License-Identifier: GPL-2.0+
3 * (C) Copyright 2011 - 2012 Samsung Electronics
4 * EXT4 filesystem implementation in Uboot by
5 * Uma Shankar <uma.shankar@samsung.com>
6 * Manjunatha C Achar <a.manjunatha@samsung.com>
8 * Journal data structures and headers for Journaling feature of ext4
9 * have been referred from JBD2 (Journaling Block device 2)
10 * implementation in Linux Kernel.
11 * Written by Stephen C. Tweedie <sct@redhat.com>
13 * Copyright 1998-2000 Red Hat, Inc --- All Rights Reserved
21 #include <ext_common.h>
22 #include "ext4_common.h"
24 static struct revoke_blk_list *revk_blk_list;
25 static struct revoke_blk_list *prev_node;
26 static int first_node = true;
31 struct journal_log *journal_ptr[MAX_JOURNAL_ENTRIES];
32 struct dirty_blocks *dirty_block_ptr[MAX_JOURNAL_ENTRIES];
34 int ext4fs_init_journal(void)
38 struct ext_filesystem *fs = get_fs();
47 for (i = 0; i < MAX_JOURNAL_ENTRIES; i++) {
48 journal_ptr[i] = zalloc(sizeof(struct journal_log));
51 dirty_block_ptr[i] = zalloc(sizeof(struct dirty_blocks));
52 if (!dirty_block_ptr[i])
54 journal_ptr[i]->buf = NULL;
55 journal_ptr[i]->blknr = -1;
57 dirty_block_ptr[i]->buf = NULL;
58 dirty_block_ptr[i]->blknr = -1;
61 if (fs->blksz == 4096) {
62 temp = zalloc(fs->blksz);
65 journal_ptr[gindex]->buf = zalloc(fs->blksz);
66 if (!journal_ptr[gindex]->buf)
68 ext4fs_devread(0, 0, fs->blksz, temp);
69 memcpy(temp + SUPERBLOCK_SIZE, fs->sb, SUPERBLOCK_SIZE);
70 memcpy(journal_ptr[gindex]->buf, temp, fs->blksz);
71 journal_ptr[gindex++]->blknr = 0;
74 journal_ptr[gindex]->buf = zalloc(fs->blksz);
75 if (!journal_ptr[gindex]->buf)
77 memcpy(journal_ptr[gindex]->buf, fs->sb, SUPERBLOCK_SIZE);
78 journal_ptr[gindex++]->blknr = 1;
81 /* Check the file system state using journal super block */
82 if (ext4fs_check_journal_state(SCAN))
84 /* Check the file system state using journal super block */
85 if (ext4fs_check_journal_state(RECOVER))
93 void ext4fs_dump_metadata(void)
95 struct ext_filesystem *fs = get_fs();
97 for (i = 0; i < MAX_JOURNAL_ENTRIES; i++) {
98 if (dirty_block_ptr[i]->blknr == -1)
100 put_ext4((uint64_t) ((uint64_t)dirty_block_ptr[i]->blknr *
101 (uint64_t)fs->blksz), dirty_block_ptr[i]->buf,
106 void ext4fs_free_journal(void)
109 for (i = 0; i < MAX_JOURNAL_ENTRIES; i++) {
110 if (dirty_block_ptr[i]->blknr == -1)
112 free(dirty_block_ptr[i]->buf);
115 for (i = 0; i < MAX_JOURNAL_ENTRIES; i++) {
116 if (journal_ptr[i]->blknr == -1)
118 free(journal_ptr[i]->buf);
121 for (i = 0; i < MAX_JOURNAL_ENTRIES; i++) {
122 free(journal_ptr[i]);
123 free(dirty_block_ptr[i]);
130 int ext4fs_log_gdt(char *gd_table)
132 struct ext_filesystem *fs = get_fs();
134 long int var = fs->gdtable_blkno;
135 for (i = 0; i < fs->no_blk_pergdt; i++) {
136 journal_ptr[gindex]->buf = zalloc(fs->blksz);
137 if (!journal_ptr[gindex]->buf)
139 memcpy(journal_ptr[gindex]->buf, gd_table, fs->blksz);
140 gd_table += fs->blksz;
141 journal_ptr[gindex++]->blknr = var++;
148 * This function stores the backup copy of meta data in RAM
149 * journal_buffer -- Buffer containing meta data
150 * blknr -- Block number on disk of the meta data buffer
152 int ext4fs_log_journal(char *journal_buffer, uint32_t blknr)
154 struct ext_filesystem *fs = get_fs();
157 if (!journal_buffer) {
158 printf("Invalid input arguments %s\n", __func__);
162 for (i = 0; i < MAX_JOURNAL_ENTRIES; i++) {
163 if (journal_ptr[i]->blknr == -1)
165 if (journal_ptr[i]->blknr == blknr)
169 journal_ptr[gindex]->buf = zalloc(fs->blksz);
170 if (!journal_ptr[gindex]->buf)
173 memcpy(journal_ptr[gindex]->buf, journal_buffer, fs->blksz);
174 journal_ptr[gindex++]->blknr = blknr;
180 * This function stores the modified meta data in RAM
181 * metadata_buffer -- Buffer containing meta data
182 * blknr -- Block number on disk of the meta data buffer
184 int ext4fs_put_metadata(char *metadata_buffer, uint32_t blknr)
186 struct ext_filesystem *fs = get_fs();
187 if (!metadata_buffer) {
188 printf("Invalid input arguments %s\n", __func__);
191 if (dirty_block_ptr[gd_index]->buf)
192 assert(dirty_block_ptr[gd_index]->blknr == blknr);
194 dirty_block_ptr[gd_index]->buf = zalloc(fs->blksz);
196 if (!dirty_block_ptr[gd_index]->buf)
198 memcpy(dirty_block_ptr[gd_index]->buf, metadata_buffer, fs->blksz);
199 dirty_block_ptr[gd_index++]->blknr = blknr;
204 void print_revoke_blks(char *revk_blk)
209 struct journal_revoke_header_t *header;
211 if (revk_blk == NULL)
214 header = (struct journal_revoke_header_t *) revk_blk;
215 offset = sizeof(struct journal_revoke_header_t);
216 max = be32_to_cpu(header->r_count);
217 printf("total bytes %d\n", max);
219 while (offset < max) {
220 blocknr = be32_to_cpu(*((__be32 *)(revk_blk + offset)));
221 printf("revoke blknr is %ld\n", blocknr);
226 static struct revoke_blk_list *_get_node(void)
228 struct revoke_blk_list *tmp_node;
229 tmp_node = zalloc(sizeof(struct revoke_blk_list));
230 if (tmp_node == NULL)
232 tmp_node->content = NULL;
233 tmp_node->next = NULL;
238 void ext4fs_push_revoke_blk(char *buffer)
240 struct revoke_blk_list *node = NULL;
241 struct ext_filesystem *fs = get_fs();
242 if (buffer == NULL) {
243 printf("buffer ptr is NULL\n");
248 printf("_get_node: malloc failed\n");
252 node->content = zalloc(fs->blksz);
253 if (node->content == NULL)
255 memcpy(node->content, buffer, fs->blksz);
257 if (first_node == true) {
258 revk_blk_list = node;
262 prev_node->next = node;
267 void ext4fs_free_revoke_blks(void)
269 struct revoke_blk_list *tmp_node = revk_blk_list;
270 struct revoke_blk_list *next_node = NULL;
272 while (tmp_node != NULL) {
273 free(tmp_node->content);
274 tmp_node = tmp_node->next;
277 tmp_node = revk_blk_list;
278 while (tmp_node != NULL) {
279 next_node = tmp_node->next;
281 tmp_node = next_node;
284 revk_blk_list = NULL;
289 int check_blknr_for_revoke(long int blknr, int sequence_no)
291 struct journal_revoke_header_t *header;
296 struct revoke_blk_list *tmp_revk_node = revk_blk_list;
297 while (tmp_revk_node != NULL) {
298 revk_blk = tmp_revk_node->content;
300 header = (struct journal_revoke_header_t *) revk_blk;
301 if (sequence_no < be32_to_cpu(header->r_header.h_sequence)) {
302 offset = sizeof(struct journal_revoke_header_t);
303 max = be32_to_cpu(header->r_count);
305 while (offset < max) {
306 blocknr = be32_to_cpu(*((__be32 *)
307 (revk_blk + offset)));
308 if (blocknr == blknr)
313 tmp_revk_node = tmp_revk_node->next;
323 * This function parses the journal blocks and replays the
324 * suceessful transactions. A transaction is successfull
325 * if commit block is found for a descriptor block
326 * The tags in descriptor block contain the disk block
327 * numbers of the metadata to be replayed
329 void recover_transaction(int prev_desc_logical_no)
331 struct ext2_inode inode_journal;
332 struct ext_filesystem *fs = get_fs();
333 struct journal_header_t *jdb;
338 struct ext3_journal_block_tag *tag;
339 char *temp_buff = zalloc(fs->blksz);
340 char *metadata_buff = zalloc(fs->blksz);
341 if (!temp_buff || !metadata_buff)
343 i = prev_desc_logical_no;
344 ext4fs_read_inode(ext4fs_root, EXT2_JOURNAL_INO,
345 (struct ext2_inode *)&inode_journal);
346 blknr = read_allocated_block((struct ext2_inode *)
347 &inode_journal, i, NULL);
348 ext4fs_devread((lbaint_t)blknr * fs->sect_perblk, 0, fs->blksz,
350 p_jdb = (char *)temp_buff;
351 jdb = (struct journal_header_t *) temp_buff;
352 ofs = sizeof(struct journal_header_t);
355 tag = (struct ext3_journal_block_tag *)(p_jdb + ofs);
356 ofs += sizeof(struct ext3_journal_block_tag);
361 flags = be32_to_cpu(tag->flags);
362 if (!(flags & EXT3_JOURNAL_FLAG_SAME_UUID))
366 debug("\t\ttag %u\n", be32_to_cpu(tag->block));
367 if (revk_blk_list != NULL) {
368 if (check_blknr_for_revoke(be32_to_cpu(tag->block),
369 be32_to_cpu(jdb->h_sequence)) == 0)
372 blknr = read_allocated_block(&inode_journal, i, NULL);
373 ext4fs_devread((lbaint_t)blknr * fs->sect_perblk, 0,
374 fs->blksz, metadata_buff);
375 put_ext4((uint64_t)((uint64_t)be32_to_cpu(tag->block) * (uint64_t)fs->blksz),
376 metadata_buff, (uint32_t) fs->blksz);
377 } while (!(flags & EXT3_JOURNAL_FLAG_LAST_TAG));
383 void print_jrnl_status(int recovery_flag)
385 if (recovery_flag == RECOVER)
386 printf("Journal Recovery Completed\n");
388 printf("Journal Scan Completed\n");
391 int ext4fs_check_journal_state(int recovery_flag)
396 int transaction_state = TRANSACTION_COMPLETE;
397 int prev_desc_logical_no = 0;
398 int curr_desc_logical_no = 0;
400 struct ext2_inode inode_journal;
401 struct journal_superblock_t *jsb = NULL;
402 struct journal_header_t *jdb = NULL;
404 struct ext3_journal_block_tag *tag = NULL;
405 char *temp_buff = NULL;
406 char *temp_buff1 = NULL;
407 struct ext_filesystem *fs = get_fs();
409 if (le32_to_cpu(fs->sb->feature_ro_compat) & EXT4_FEATURE_RO_COMPAT_METADATA_CSUM)
412 temp_buff = zalloc(fs->blksz);
415 temp_buff1 = zalloc(fs->blksz);
421 ext4fs_read_inode(ext4fs_root, EXT2_JOURNAL_INO, &inode_journal);
422 blknr = read_allocated_block(&inode_journal, EXT2_JOURNAL_SUPERBLOCK,
424 ext4fs_devread((lbaint_t)blknr * fs->sect_perblk, 0, fs->blksz,
426 jsb = (struct journal_superblock_t *) temp_buff;
428 if (le32_to_cpu(fs->sb->feature_incompat) & EXT3_FEATURE_INCOMPAT_RECOVER) {
429 if (recovery_flag == RECOVER)
430 printf("Recovery required\n");
432 if (recovery_flag == RECOVER)
433 printf("File System is consistent\n");
437 if (be32_to_cpu(jsb->s_start) == 0)
440 if (!(jsb->s_feature_compat &
441 cpu_to_be32(JBD2_FEATURE_COMPAT_CHECKSUM)))
442 jsb->s_feature_compat |=
443 cpu_to_be32(JBD2_FEATURE_COMPAT_CHECKSUM);
445 i = be32_to_cpu(jsb->s_first);
447 blknr = read_allocated_block(&inode_journal, i, NULL);
448 memset(temp_buff1, '\0', fs->blksz);
449 ext4fs_devread((lbaint_t)blknr * fs->sect_perblk,
450 0, fs->blksz, temp_buff1);
451 jdb = (struct journal_header_t *) temp_buff1;
453 if (be32_to_cpu(jdb->h_blocktype) ==
454 EXT3_JOURNAL_DESCRIPTOR_BLOCK) {
455 if (be32_to_cpu(jdb->h_sequence) !=
456 be32_to_cpu(jsb->s_sequence)) {
457 print_jrnl_status(recovery_flag);
461 curr_desc_logical_no = i;
462 if (transaction_state == TRANSACTION_COMPLETE)
463 transaction_state = TRANSACTION_RUNNING;
466 p_jdb = (char *)temp_buff1;
467 ofs = sizeof(struct journal_header_t);
469 tag = (struct ext3_journal_block_tag *)
471 ofs += sizeof(struct ext3_journal_block_tag);
474 flags = be32_to_cpu(tag->flags);
475 if (!(flags & EXT3_JOURNAL_FLAG_SAME_UUID))
478 debug("\t\ttag %u\n", be32_to_cpu(tag->block));
479 } while (!(flags & EXT3_JOURNAL_FLAG_LAST_TAG));
482 } else if (be32_to_cpu(jdb->h_blocktype) ==
483 EXT3_JOURNAL_COMMIT_BLOCK) {
484 if (be32_to_cpu(jdb->h_sequence) !=
485 be32_to_cpu(jsb->s_sequence)) {
486 print_jrnl_status(recovery_flag);
490 if (transaction_state == TRANSACTION_RUNNING ||
492 transaction_state = TRANSACTION_COMPLETE;
495 cpu_to_be32(be32_to_cpu(
496 jsb->s_sequence) + 1);
498 prev_desc_logical_no = curr_desc_logical_no;
499 if ((recovery_flag == RECOVER) && (DB_FOUND == YES))
500 recover_transaction(prev_desc_logical_no);
503 } else if (be32_to_cpu(jdb->h_blocktype) ==
504 EXT3_JOURNAL_REVOKE_BLOCK) {
505 if (be32_to_cpu(jdb->h_sequence) !=
506 be32_to_cpu(jsb->s_sequence)) {
507 print_jrnl_status(recovery_flag);
510 if (recovery_flag == SCAN)
511 ext4fs_push_revoke_blk((char *)jdb);
514 debug("Else Case\n");
515 if (be32_to_cpu(jdb->h_sequence) !=
516 be32_to_cpu(jsb->s_sequence)) {
517 print_jrnl_status(recovery_flag);
524 if (recovery_flag == RECOVER) {
525 uint32_t new_feature_incompat;
526 jsb->s_start = cpu_to_be32(1);
527 jsb->s_sequence = cpu_to_be32(be32_to_cpu(jsb->s_sequence) + 1);
528 /* get the superblock */
529 ext4_read_superblock((char *)fs->sb);
530 new_feature_incompat = le32_to_cpu(fs->sb->feature_incompat);
531 new_feature_incompat |= EXT3_FEATURE_INCOMPAT_RECOVER;
532 fs->sb->feature_incompat = cpu_to_le32(new_feature_incompat);
534 /* Update the super block */
535 put_ext4((uint64_t) (SUPERBLOCK_SIZE),
536 (struct ext2_sblock *)fs->sb,
537 (uint32_t) SUPERBLOCK_SIZE);
538 ext4_read_superblock((char *)fs->sb);
540 blknr = read_allocated_block(&inode_journal,
541 EXT2_JOURNAL_SUPERBLOCK, NULL);
542 put_ext4((uint64_t) ((uint64_t)blknr * (uint64_t)fs->blksz),
543 (struct journal_superblock_t *)temp_buff,
544 (uint32_t) fs->blksz);
545 ext4fs_free_revoke_blks();
553 static void update_descriptor_block(long int blknr)
557 struct journal_header_t jdb;
558 struct ext3_journal_block_tag tag;
559 struct ext2_inode inode_journal;
560 struct journal_superblock_t *jsb = NULL;
563 struct ext_filesystem *fs = get_fs();
564 char *temp_buff = zalloc(fs->blksz);
568 ext4fs_read_inode(ext4fs_root, EXT2_JOURNAL_INO, &inode_journal);
569 jsb_blknr = read_allocated_block(&inode_journal,
570 EXT2_JOURNAL_SUPERBLOCK, NULL);
571 ext4fs_devread((lbaint_t)jsb_blknr * fs->sect_perblk, 0, fs->blksz,
573 jsb = (struct journal_superblock_t *) temp_buff;
575 jdb.h_blocktype = cpu_to_be32(EXT3_JOURNAL_DESCRIPTOR_BLOCK);
576 jdb.h_magic = cpu_to_be32(EXT3_JOURNAL_MAGIC_NUMBER);
577 jdb.h_sequence = jsb->s_sequence;
578 buf = zalloc(fs->blksz);
584 memcpy(buf, &jdb, sizeof(struct journal_header_t));
585 temp += sizeof(struct journal_header_t);
587 for (i = 0; i < MAX_JOURNAL_ENTRIES; i++) {
588 if (journal_ptr[i]->blknr == -1)
591 tag.block = cpu_to_be32(journal_ptr[i]->blknr);
592 tag.flags = cpu_to_be32(EXT3_JOURNAL_FLAG_SAME_UUID);
593 memcpy(temp, &tag, sizeof(struct ext3_journal_block_tag));
594 temp = temp + sizeof(struct ext3_journal_block_tag);
597 tag.block = cpu_to_be32(journal_ptr[--i]->blknr);
598 tag.flags = cpu_to_be32(EXT3_JOURNAL_FLAG_LAST_TAG);
599 memcpy(temp - sizeof(struct ext3_journal_block_tag), &tag,
600 sizeof(struct ext3_journal_block_tag));
601 put_ext4((uint64_t) ((uint64_t)blknr * (uint64_t)fs->blksz), buf, (uint32_t) fs->blksz);
607 static void update_commit_block(long int blknr)
609 struct journal_header_t jdb;
610 struct ext_filesystem *fs = get_fs();
612 struct ext2_inode inode_journal;
613 struct journal_superblock_t *jsb;
615 char *temp_buff = zalloc(fs->blksz);
619 ext4fs_read_inode(ext4fs_root, EXT2_JOURNAL_INO,
621 jsb_blknr = read_allocated_block(&inode_journal,
622 EXT2_JOURNAL_SUPERBLOCK, NULL);
623 ext4fs_devread((lbaint_t)jsb_blknr * fs->sect_perblk, 0, fs->blksz,
625 jsb = (struct journal_superblock_t *) temp_buff;
627 jdb.h_blocktype = cpu_to_be32(EXT3_JOURNAL_COMMIT_BLOCK);
628 jdb.h_magic = cpu_to_be32(EXT3_JOURNAL_MAGIC_NUMBER);
629 jdb.h_sequence = jsb->s_sequence;
630 buf = zalloc(fs->blksz);
635 memcpy(buf, &jdb, sizeof(struct journal_header_t));
636 put_ext4((uint64_t) ((uint64_t)blknr * (uint64_t)fs->blksz), buf, (uint32_t) fs->blksz);
642 void ext4fs_update_journal(void)
644 struct ext2_inode inode_journal;
645 struct ext_filesystem *fs = get_fs();
649 if (!(fs->sb->feature_compatibility & EXT4_FEATURE_COMPAT_HAS_JOURNAL))
652 ext4fs_read_inode(ext4fs_root, EXT2_JOURNAL_INO, &inode_journal);
653 blknr = read_allocated_block(&inode_journal, jrnl_blk_idx++, NULL);
654 update_descriptor_block(blknr);
655 for (i = 0; i < MAX_JOURNAL_ENTRIES; i++) {
656 if (journal_ptr[i]->blknr == -1)
658 blknr = read_allocated_block(&inode_journal, jrnl_blk_idx++,
660 put_ext4((uint64_t) ((uint64_t)blknr * (uint64_t)fs->blksz),
661 journal_ptr[i]->buf, fs->blksz);
663 blknr = read_allocated_block(&inode_journal, jrnl_blk_idx++, NULL);
664 update_commit_block(blknr);
665 printf("update journal finished\n");