xref: /OK3568_Linux_fs/u-boot/fs/ext4/ext4_journal.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /*
2*4882a593Smuzhiyun  * (C) Copyright 2011 - 2012 Samsung Electronics
3*4882a593Smuzhiyun  * EXT4 filesystem implementation in Uboot by
4*4882a593Smuzhiyun  * Uma Shankar <uma.shankar@samsung.com>
5*4882a593Smuzhiyun  * Manjunatha C Achar <a.manjunatha@samsung.com>
6*4882a593Smuzhiyun  *
7*4882a593Smuzhiyun  * Journal data structures and headers for Journaling feature of ext4
8*4882a593Smuzhiyun  * have been referred from JBD2 (Journaling Block device 2)
9*4882a593Smuzhiyun  * implementation in Linux Kernel.
10*4882a593Smuzhiyun  *
11*4882a593Smuzhiyun  * Written by Stephen C. Tweedie <sct@redhat.com>
12*4882a593Smuzhiyun  *
13*4882a593Smuzhiyun  * Copyright 1998-2000 Red Hat, Inc --- All Rights Reserved
14*4882a593Smuzhiyun  * SPDX-License-Identifier:	GPL-2.0+
15*4882a593Smuzhiyun  */
16*4882a593Smuzhiyun 
17*4882a593Smuzhiyun #ifndef __EXT4_JRNL__
18*4882a593Smuzhiyun #define __EXT4_JRNL__
19*4882a593Smuzhiyun 
20*4882a593Smuzhiyun #define EXT2_JOURNAL_INO		8	/* Journal inode */
21*4882a593Smuzhiyun #define EXT2_JOURNAL_SUPERBLOCK	0	/* Journal  Superblock number */
22*4882a593Smuzhiyun 
23*4882a593Smuzhiyun #define JBD2_FEATURE_COMPAT_CHECKSUM	0x00000001
24*4882a593Smuzhiyun #define EXT3_JOURNAL_MAGIC_NUMBER	0xc03b3998U
25*4882a593Smuzhiyun #define TRANSACTION_RUNNING		1
26*4882a593Smuzhiyun #define TRANSACTION_COMPLETE		0
27*4882a593Smuzhiyun #define EXT3_FEATURE_INCOMPAT_RECOVER	0x0004	/* Needs recovery */
28*4882a593Smuzhiyun #define EXT3_JOURNAL_DESCRIPTOR_BLOCK	1
29*4882a593Smuzhiyun #define EXT3_JOURNAL_COMMIT_BLOCK	2
30*4882a593Smuzhiyun #define EXT3_JOURNAL_SUPERBLOCK_V1	3
31*4882a593Smuzhiyun #define EXT3_JOURNAL_SUPERBLOCK_V2	4
32*4882a593Smuzhiyun #define EXT3_JOURNAL_REVOKE_BLOCK	5
33*4882a593Smuzhiyun #define EXT3_JOURNAL_FLAG_ESCAPE	1
34*4882a593Smuzhiyun #define EXT3_JOURNAL_FLAG_SAME_UUID	2
35*4882a593Smuzhiyun #define EXT3_JOURNAL_FLAG_DELETED	4
36*4882a593Smuzhiyun #define EXT3_JOURNAL_FLAG_LAST_TAG	8
37*4882a593Smuzhiyun 
38*4882a593Smuzhiyun /* Maximum entries in 1 journal transaction */
39*4882a593Smuzhiyun #define MAX_JOURNAL_ENTRIES 100
40*4882a593Smuzhiyun struct journal_log {
41*4882a593Smuzhiyun 	char *buf;
42*4882a593Smuzhiyun 	int blknr;
43*4882a593Smuzhiyun };
44*4882a593Smuzhiyun 
45*4882a593Smuzhiyun struct dirty_blocks {
46*4882a593Smuzhiyun 	char *buf;
47*4882a593Smuzhiyun 	int blknr;
48*4882a593Smuzhiyun };
49*4882a593Smuzhiyun 
50*4882a593Smuzhiyun /* Standard header for all descriptor blocks: */
51*4882a593Smuzhiyun struct journal_header_t {
52*4882a593Smuzhiyun 	__be32 h_magic;
53*4882a593Smuzhiyun 	__be32 h_blocktype;
54*4882a593Smuzhiyun 	__be32 h_sequence;
55*4882a593Smuzhiyun };
56*4882a593Smuzhiyun 
57*4882a593Smuzhiyun /* The journal superblock.  All fields are in big-endian byte order. */
58*4882a593Smuzhiyun struct journal_superblock_t {
59*4882a593Smuzhiyun 	/* 0x0000 */
60*4882a593Smuzhiyun 	struct journal_header_t s_header;
61*4882a593Smuzhiyun 
62*4882a593Smuzhiyun 	/* Static information describing the journal */
63*4882a593Smuzhiyun 	__be32 s_blocksize;	/* journal device blocksize */
64*4882a593Smuzhiyun 	__be32 s_maxlen;		/* total blocks in journal file */
65*4882a593Smuzhiyun 	__be32 s_first;		/* first block of log information */
66*4882a593Smuzhiyun 
67*4882a593Smuzhiyun 	/* Dynamic information describing the current state of the log */
68*4882a593Smuzhiyun 	__be32 s_sequence;	/* first commit ID expected in log */
69*4882a593Smuzhiyun 	__be32 s_start;		/* blocknr of start of log */
70*4882a593Smuzhiyun 
71*4882a593Smuzhiyun 	/* Error value, as set by journal_abort(). */
72*4882a593Smuzhiyun 	__be32 s_errno;
73*4882a593Smuzhiyun 
74*4882a593Smuzhiyun 	/* Remaining fields are only valid in a version-2 superblock */
75*4882a593Smuzhiyun 	__be32 s_feature_compat;	/* compatible feature set */
76*4882a593Smuzhiyun 	__be32 s_feature_incompat;	/* incompatible feature set */
77*4882a593Smuzhiyun 	__be32 s_feature_ro_compat;	/* readonly-compatible feature set */
78*4882a593Smuzhiyun 	/* 0x0030 */
79*4882a593Smuzhiyun 	__u8 s_uuid[16];	/* 128-bit uuid for journal */
80*4882a593Smuzhiyun 
81*4882a593Smuzhiyun 	/* 0x0040 */
82*4882a593Smuzhiyun 	__be32 s_nr_users;	/* Nr of filesystems sharing log */
83*4882a593Smuzhiyun 
84*4882a593Smuzhiyun 	__be32 s_dynsuper;	/* Blocknr of dynamic superblock copy */
85*4882a593Smuzhiyun 
86*4882a593Smuzhiyun 	/* 0x0048 */
87*4882a593Smuzhiyun 	__be32 s_max_transaction;	/* Limit of journal blocks per trans. */
88*4882a593Smuzhiyun 	__be32 s_max_trans_data;	/* Limit of data blocks per trans. */
89*4882a593Smuzhiyun 
90*4882a593Smuzhiyun 	/* 0x0050 */
91*4882a593Smuzhiyun 	__be32 s_padding[44];
92*4882a593Smuzhiyun 
93*4882a593Smuzhiyun 	/* 0x0100 */
94*4882a593Smuzhiyun 	__u8 s_users[16 * 48];	/* ids of all fs'es sharing the log */
95*4882a593Smuzhiyun 	/* 0x0400 */
96*4882a593Smuzhiyun } ;
97*4882a593Smuzhiyun 
98*4882a593Smuzhiyun struct ext3_journal_block_tag {
99*4882a593Smuzhiyun 	__be32 block;
100*4882a593Smuzhiyun 	__be32 flags;
101*4882a593Smuzhiyun };
102*4882a593Smuzhiyun 
103*4882a593Smuzhiyun struct journal_revoke_header_t {
104*4882a593Smuzhiyun 	struct journal_header_t r_header;
105*4882a593Smuzhiyun 	__be32 r_count;		/* Count of bytes used in the block */
106*4882a593Smuzhiyun };
107*4882a593Smuzhiyun 
108*4882a593Smuzhiyun struct revoke_blk_list {
109*4882a593Smuzhiyun 	char *content;		/* revoke block itself */
110*4882a593Smuzhiyun 	struct revoke_blk_list *next;
111*4882a593Smuzhiyun };
112*4882a593Smuzhiyun 
113*4882a593Smuzhiyun extern struct ext2_data *ext4fs_root;
114*4882a593Smuzhiyun 
115*4882a593Smuzhiyun int ext4fs_init_journal(void);
116*4882a593Smuzhiyun int ext4fs_log_gdt(char *gd_table);
117*4882a593Smuzhiyun int ext4fs_check_journal_state(int recovery_flag);
118*4882a593Smuzhiyun int ext4fs_log_journal(char *journal_buffer, uint32_t blknr);
119*4882a593Smuzhiyun int ext4fs_put_metadata(char *metadata_buffer, uint32_t blknr);
120*4882a593Smuzhiyun void ext4fs_update_journal(void);
121*4882a593Smuzhiyun void ext4fs_dump_metadata(void);
122*4882a593Smuzhiyun void ext4fs_push_revoke_blk(char *buffer);
123*4882a593Smuzhiyun void ext4fs_free_journal(void);
124*4882a593Smuzhiyun void ext4fs_free_revoke_blks(void);
125*4882a593Smuzhiyun #endif
126