d124b4c51179686bc1d8e462c80a6dba04c098be
[firefly-linux-kernel-4.4.55.git] / fs / befs / befs_fs_types.h
1 /*
2  * fs/befs/befs_fs_types.h
3  *
4  * Copyright (C) 2001 Will Dyson (will@cs.earlham.edu)
5  *
6  *
7  *
8  * from linux/include/linux/befs_fs.h
9  *
10  * Copyright (C) 1999 Makoto Kato (m_kato@ga2.so-net.ne.jp)
11  *
12  */
13
14 #ifndef _LINUX_BEFS_FS_TYPES
15 #define _LINUX_BEFS_FS_TYPES
16
17 #ifdef __KERNEL__
18 #include <linux/types.h>
19 #endif /*__KERNEL__*/
20
21 #define PACKED __attribute__ ((__packed__))
22
23 /*
24  * Max name lengths of BFS
25  */
26
27 #define BEFS_NAME_LEN 255
28
29 #define BEFS_SYMLINK_LEN 144
30 #define BEFS_NUM_DIRECT_BLOCKS 12
31 #define B_OS_NAME_LENGTH 32
32
33 /* The datastream blocks mapped by the double-indirect
34  * block are always 4 fs blocks long.
35  * This eliminates the need for linear searches among
36  * the potentially huge number of indirect blocks
37  *
38  * Err. Should that be 4 fs blocks or 4k???
39  * It matters on large blocksize volumes
40  */
41 #define BEFS_DBLINDIR_BRUN_LEN 4
42
43 /*
44  * Flags of superblock
45  */
46
47 enum super_flags {
48         BEFS_BYTESEX_BE,
49         BEFS_BYTESEX_LE,
50         BEFS_CLEAN = 0x434c454e,
51         BEFS_DIRTY = 0x44495254,
52         BEFS_SUPER_MAGIC1 = 0x42465331, /* BFS1 */
53         BEFS_SUPER_MAGIC2 = 0xdd121031,
54         BEFS_SUPER_MAGIC3 = 0x15b6830e,
55 };
56
57 #define BEFS_BYTEORDER_NATIVE 0x42494745
58
59 #define BEFS_SUPER_MAGIC BEFS_SUPER_MAGIC1
60
61 /*
62  * Flags of inode
63  */
64
65 #define BEFS_INODE_MAGIC1 0x3bbe0ad9
66
67 enum inode_flags {
68         BEFS_INODE_IN_USE = 0x00000001,
69         BEFS_ATTR_INODE = 0x00000004,
70         BEFS_INODE_LOGGED = 0x00000008,
71         BEFS_INODE_DELETED = 0x00000010,
72         BEFS_LONG_SYMLINK = 0x00000040,
73         BEFS_PERMANENT_FLAG = 0x0000ffff,
74         BEFS_INODE_NO_CREATE = 0x00010000,
75         BEFS_INODE_WAS_WRITTEN = 0x00020000,
76         BEFS_NO_TRANSACTION = 0x00040000,
77 };
78 /* 
79  * On-Disk datastructures of BeFS
80  */
81
82 typedef u64 befs_off_t;
83 typedef u64 befs_time_t;
84
85 /* Block runs */
86 typedef struct {
87         u32 allocation_group;
88         u16 start;
89         u16 len;
90 } PACKED befs_block_run;
91
92 typedef befs_block_run befs_inode_addr;
93
94 /*
95  * The Superblock Structure
96  */
97 typedef struct {
98         char name[B_OS_NAME_LENGTH];
99         u32 magic1;
100         u32 fs_byte_order;
101
102         u32 block_size;
103         u32 block_shift;
104
105         befs_off_t num_blocks;
106         befs_off_t used_blocks;
107
108         u32 inode_size;
109
110         u32 magic2;
111         u32 blocks_per_ag;
112         u32 ag_shift;
113         u32 num_ags;
114
115         u32 flags;
116
117         befs_block_run log_blocks;
118         befs_off_t log_start;
119         befs_off_t log_end;
120
121         u32 magic3;
122         befs_inode_addr root_dir;
123         befs_inode_addr indices;
124
125 } PACKED befs_super_block;
126
127 /* 
128  * Note: the indirect and dbl_indir block_runs may
129  * be longer than one block!
130  */
131 typedef struct {
132         befs_block_run direct[BEFS_NUM_DIRECT_BLOCKS];
133         befs_off_t max_direct_range;
134         befs_block_run indirect;
135         befs_off_t max_indirect_range;
136         befs_block_run double_indirect;
137         befs_off_t max_double_indirect_range;
138         befs_off_t size;
139 } PACKED befs_data_stream;
140
141 /* Attribute */
142 typedef struct {
143         u32 type;
144         u16 name_size;
145         u16 data_size;
146         char name[1];
147 } PACKED befs_small_data;
148
149 /* Inode structure */
150 typedef struct {
151         u32 magic1;
152         befs_inode_addr inode_num;
153         u32 uid;
154         u32 gid;
155         u32 mode;
156         u32 flags;
157         befs_time_t create_time;
158         befs_time_t last_modified_time;
159         befs_inode_addr parent;
160         befs_inode_addr attributes;
161         u32 type;
162
163         u32 inode_size;
164         u32 etc;                /* not use */
165
166         union {
167                 befs_data_stream datastream;
168                 char symlink[BEFS_SYMLINK_LEN];
169         } data;
170
171         u32 pad[4];             /* not use */
172         befs_small_data small_data[1];
173 } PACKED befs_inode;
174
175 /*
176  * B+tree superblock
177  */
178
179 #define BEFS_BTREE_MAGIC 0x69f6c2e8
180
181 enum btree_types {
182         BTREE_STRING_TYPE = 0,
183         BTREE_INT32_TYPE = 1,
184         BTREE_UINT32_TYPE = 2,
185         BTREE_INT64_TYPE = 3,
186         BTREE_UINT64_TYPE = 4,
187         BTREE_FLOAT_TYPE = 5,
188         BTREE_DOUBLE_TYPE = 6
189 };
190
191 typedef struct {
192         u32 magic;
193         u32 node_size;
194         u32 max_depth;
195         u32 data_type;
196         befs_off_t root_node_ptr;
197         befs_off_t free_node_ptr;
198         befs_off_t max_size;
199 } PACKED befs_btree_super;
200
201 /*
202  * Header stucture of each btree node
203  */
204 typedef struct {
205         befs_off_t left;
206         befs_off_t right;
207         befs_off_t overflow;
208         u16 all_key_count;
209         u16 all_key_length;
210 } PACKED befs_btree_nodehead;
211
212 #endif                          /* _LINUX_BEFS_FS_TYPES */