xref: /OK3568_Linux_fs/u-boot/fs/jffs2/summary.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /*
2*4882a593Smuzhiyun  * JFFS2 -- Journalling Flash File System, Version 2.
3*4882a593Smuzhiyun  *
4*4882a593Smuzhiyun  * Copyright © 2004  Ferenc Havasi <havasi@inf.u-szeged.hu>,
5*4882a593Smuzhiyun  *		     Zoltan Sogor <weth@inf.u-szeged.hu>,
6*4882a593Smuzhiyun  *		     Patrik Kluba <pajko@halom.u-szeged.hu>,
7*4882a593Smuzhiyun  *		     University of Szeged, Hungary
8*4882a593Smuzhiyun  *
9*4882a593Smuzhiyun  * For licensing information, see the file 'LICENCE' in this directory.
10*4882a593Smuzhiyun  *
11*4882a593Smuzhiyun  */
12*4882a593Smuzhiyun 
13*4882a593Smuzhiyun #ifndef JFFS2_SUMMARY_H
14*4882a593Smuzhiyun #define JFFS2_SUMMARY_H
15*4882a593Smuzhiyun 
16*4882a593Smuzhiyun #define BLK_STATE_ALLFF		0
17*4882a593Smuzhiyun #define BLK_STATE_CLEAN		1
18*4882a593Smuzhiyun #define BLK_STATE_PARTDIRTY	2
19*4882a593Smuzhiyun #define BLK_STATE_CLEANMARKER	3
20*4882a593Smuzhiyun #define BLK_STATE_ALLDIRTY	4
21*4882a593Smuzhiyun #define BLK_STATE_BADBLOCK	5
22*4882a593Smuzhiyun 
23*4882a593Smuzhiyun #define JFFS2_SUMMARY_NOSUM_SIZE 0xffffffff
24*4882a593Smuzhiyun #define JFFS2_SUMMARY_INODE_SIZE (sizeof(struct jffs2_sum_inode_flash))
25*4882a593Smuzhiyun #define JFFS2_SUMMARY_DIRENT_SIZE(x) (sizeof(struct jffs2_sum_dirent_flash) + (x))
26*4882a593Smuzhiyun #define JFFS2_SUMMARY_XATTR_SIZE (sizeof(struct jffs2_sum_xattr_flash))
27*4882a593Smuzhiyun #define JFFS2_SUMMARY_XREF_SIZE (sizeof(struct jffs2_sum_xref_flash))
28*4882a593Smuzhiyun 
29*4882a593Smuzhiyun /* Summary structures used on flash */
30*4882a593Smuzhiyun 
31*4882a593Smuzhiyun struct jffs2_sum_unknown_flash
32*4882a593Smuzhiyun {
33*4882a593Smuzhiyun 	__u16 nodetype;	/* node type */
34*4882a593Smuzhiyun };
35*4882a593Smuzhiyun 
36*4882a593Smuzhiyun struct jffs2_sum_inode_flash
37*4882a593Smuzhiyun {
38*4882a593Smuzhiyun 	__u16 nodetype;	/* node type */
39*4882a593Smuzhiyun 	__u32 inode;		/* inode number */
40*4882a593Smuzhiyun 	__u32 version;	/* inode version */
41*4882a593Smuzhiyun 	__u32 offset;	/* offset on jeb */
42*4882a593Smuzhiyun 	__u32 totlen; 	/* record length */
43*4882a593Smuzhiyun } __attribute__((packed));
44*4882a593Smuzhiyun 
45*4882a593Smuzhiyun struct jffs2_sum_dirent_flash
46*4882a593Smuzhiyun {
47*4882a593Smuzhiyun 	__u16 nodetype;	/* == JFFS_NODETYPE_DIRENT */
48*4882a593Smuzhiyun 	__u32 totlen;	/* record length */
49*4882a593Smuzhiyun 	__u32 offset;	/* offset on jeb */
50*4882a593Smuzhiyun 	__u32 pino;		/* parent inode */
51*4882a593Smuzhiyun 	__u32 version;	/* dirent version */
52*4882a593Smuzhiyun 	__u32 ino; 		/* == zero for unlink */
53*4882a593Smuzhiyun 	uint8_t nsize;		/* dirent name size */
54*4882a593Smuzhiyun 	uint8_t type;		/* dirent type */
55*4882a593Smuzhiyun 	uint8_t name[0];	/* dirent name */
56*4882a593Smuzhiyun } __attribute__((packed));
57*4882a593Smuzhiyun 
58*4882a593Smuzhiyun struct jffs2_sum_xattr_flash
59*4882a593Smuzhiyun {
60*4882a593Smuzhiyun 	__u16 nodetype;	/* == JFFS2_NODETYPE_XATR */
61*4882a593Smuzhiyun 	__u32 xid;		/* xattr identifier */
62*4882a593Smuzhiyun 	__u32 version;	/* version number */
63*4882a593Smuzhiyun 	__u32 offset;	/* offset on jeb */
64*4882a593Smuzhiyun 	__u32 totlen;	/* node length */
65*4882a593Smuzhiyun } __attribute__((packed));
66*4882a593Smuzhiyun 
67*4882a593Smuzhiyun struct jffs2_sum_xref_flash
68*4882a593Smuzhiyun {
69*4882a593Smuzhiyun 	__u16 nodetype;	/* == JFFS2_NODETYPE_XREF */
70*4882a593Smuzhiyun 	__u32 offset;	/* offset on jeb */
71*4882a593Smuzhiyun } __attribute__((packed));
72*4882a593Smuzhiyun 
73*4882a593Smuzhiyun union jffs2_sum_flash
74*4882a593Smuzhiyun {
75*4882a593Smuzhiyun 	struct jffs2_sum_unknown_flash u;
76*4882a593Smuzhiyun 	struct jffs2_sum_inode_flash i;
77*4882a593Smuzhiyun 	struct jffs2_sum_dirent_flash d;
78*4882a593Smuzhiyun 	struct jffs2_sum_xattr_flash x;
79*4882a593Smuzhiyun 	struct jffs2_sum_xref_flash r;
80*4882a593Smuzhiyun };
81*4882a593Smuzhiyun 
82*4882a593Smuzhiyun /* Summary structures used in the memory */
83*4882a593Smuzhiyun 
84*4882a593Smuzhiyun struct jffs2_sum_unknown_mem
85*4882a593Smuzhiyun {
86*4882a593Smuzhiyun 	union jffs2_sum_mem *next;
87*4882a593Smuzhiyun 	__u16 nodetype;	/* node type */
88*4882a593Smuzhiyun };
89*4882a593Smuzhiyun 
90*4882a593Smuzhiyun struct jffs2_sum_inode_mem
91*4882a593Smuzhiyun {
92*4882a593Smuzhiyun 	union jffs2_sum_mem *next;
93*4882a593Smuzhiyun 	__u16 nodetype;	/* node type */
94*4882a593Smuzhiyun 	__u32 inode;		/* inode number */
95*4882a593Smuzhiyun 	__u32 version;	/* inode version */
96*4882a593Smuzhiyun 	__u32 offset;	/* offset on jeb */
97*4882a593Smuzhiyun 	__u32 totlen; 	/* record length */
98*4882a593Smuzhiyun } __attribute__((packed));
99*4882a593Smuzhiyun 
100*4882a593Smuzhiyun struct jffs2_sum_dirent_mem
101*4882a593Smuzhiyun {
102*4882a593Smuzhiyun 	union jffs2_sum_mem *next;
103*4882a593Smuzhiyun 	__u16 nodetype;	/* == JFFS_NODETYPE_DIRENT */
104*4882a593Smuzhiyun 	__u32 totlen;	/* record length */
105*4882a593Smuzhiyun 	__u32 offset;	/* ofset on jeb */
106*4882a593Smuzhiyun 	__u32 pino;		/* parent inode */
107*4882a593Smuzhiyun 	__u32 version;	/* dirent version */
108*4882a593Smuzhiyun 	__u32 ino; 		/* == zero for unlink */
109*4882a593Smuzhiyun 	uint8_t nsize;		/* dirent name size */
110*4882a593Smuzhiyun 	uint8_t type;		/* dirent type */
111*4882a593Smuzhiyun 	uint8_t name[0];	/* dirent name */
112*4882a593Smuzhiyun } __attribute__((packed));
113*4882a593Smuzhiyun 
114*4882a593Smuzhiyun struct jffs2_sum_xattr_mem
115*4882a593Smuzhiyun {
116*4882a593Smuzhiyun 	union jffs2_sum_mem *next;
117*4882a593Smuzhiyun 	__u16 nodetype;
118*4882a593Smuzhiyun 	__u32 xid;
119*4882a593Smuzhiyun 	__u32 version;
120*4882a593Smuzhiyun 	__u32 offset;
121*4882a593Smuzhiyun 	__u32 totlen;
122*4882a593Smuzhiyun } __attribute__((packed));
123*4882a593Smuzhiyun 
124*4882a593Smuzhiyun struct jffs2_sum_xref_mem
125*4882a593Smuzhiyun {
126*4882a593Smuzhiyun 	union jffs2_sum_mem *next;
127*4882a593Smuzhiyun 	__u16 nodetype;
128*4882a593Smuzhiyun 	__u32 offset;
129*4882a593Smuzhiyun } __attribute__((packed));
130*4882a593Smuzhiyun 
131*4882a593Smuzhiyun union jffs2_sum_mem
132*4882a593Smuzhiyun {
133*4882a593Smuzhiyun 	struct jffs2_sum_unknown_mem u;
134*4882a593Smuzhiyun 	struct jffs2_sum_inode_mem i;
135*4882a593Smuzhiyun 	struct jffs2_sum_dirent_mem d;
136*4882a593Smuzhiyun 	struct jffs2_sum_xattr_mem x;
137*4882a593Smuzhiyun 	struct jffs2_sum_xref_mem r;
138*4882a593Smuzhiyun };
139*4882a593Smuzhiyun 
140*4882a593Smuzhiyun /* Summary related information stored in superblock */
141*4882a593Smuzhiyun 
142*4882a593Smuzhiyun struct jffs2_summary
143*4882a593Smuzhiyun {
144*4882a593Smuzhiyun 	uint32_t sum_size;      /* collected summary information for nextblock */
145*4882a593Smuzhiyun 	uint32_t sum_num;
146*4882a593Smuzhiyun 	uint32_t sum_padded;
147*4882a593Smuzhiyun 	union jffs2_sum_mem *sum_list_head;
148*4882a593Smuzhiyun 	union jffs2_sum_mem *sum_list_tail;
149*4882a593Smuzhiyun 
150*4882a593Smuzhiyun 	__u32 *sum_buf;	/* buffer for writing out summary */
151*4882a593Smuzhiyun };
152*4882a593Smuzhiyun 
153*4882a593Smuzhiyun /* Summary marker is stored at the end of every sumarized erase block */
154*4882a593Smuzhiyun 
155*4882a593Smuzhiyun struct jffs2_sum_marker
156*4882a593Smuzhiyun {
157*4882a593Smuzhiyun 	__u32 offset;	/* offset of the summary node in the jeb */
158*4882a593Smuzhiyun 	__u32 magic; 	/* == JFFS2_SUM_MAGIC */
159*4882a593Smuzhiyun };
160*4882a593Smuzhiyun 
161*4882a593Smuzhiyun #define JFFS2_SUMMARY_FRAME_SIZE (sizeof(struct jffs2_raw_summary) + sizeof(struct jffs2_sum_marker))
162*4882a593Smuzhiyun 
163*4882a593Smuzhiyun #endif /* JFFS2_SUMMARY_H */
164