Commit | Line | Data |
---|---|---|
eed10e39 KS |
1 | /* |
2 | * nilfs2_fs.h - NILFS2 on-disk structures and common declarations. | |
3 | * | |
4 | * Copyright (C) 2005-2008 Nippon Telegraph and Telephone Corporation. | |
5 | * | |
6 | * This program is free software; you can redistribute it and/or modify | |
c486f389 RK |
7 | * it under the terms of the GNU Lesser General Public License as published |
8 | * by the Free Software Foundation; either version 2.1 of the License, or | |
eed10e39 KS |
9 | * (at your option) any later version. |
10 | * | |
11 | * This program is distributed in the hope that it will be useful, | |
12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
c486f389 | 14 | * GNU Lesser General Public License for more details. |
eed10e39 | 15 | * |
c486f389 | 16 | * You should have received a copy of the GNU Lesser General Public License |
eed10e39 KS |
17 | * along with this program; if not, write to the Free Software |
18 | * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA | |
19 | * | |
20 | * Written by Koji Sato <koji@osrg.net> | |
21 | * Ryusuke Konishi <ryusuke@osrg.net> | |
22 | */ | |
23 | /* | |
24 | * linux/include/linux/ext2_fs.h | |
25 | * | |
26 | * Copyright (C) 1992, 1993, 1994, 1995 | |
27 | * Remy Card (card@masi.ibp.fr) | |
28 | * Laboratoire MASI - Institut Blaise Pascal | |
29 | * Universite Pierre et Marie Curie (Paris VI) | |
30 | * | |
31 | * from | |
32 | * | |
33 | * linux/include/linux/minix_fs.h | |
34 | * | |
35 | * Copyright (C) 1991, 1992 Linus Torvalds | |
36 | */ | |
37 | ||
38 | #ifndef _LINUX_NILFS_FS_H | |
39 | #define _LINUX_NILFS_FS_H | |
40 | ||
41 | #include <linux/types.h> | |
42 | #include <linux/ioctl.h> | |
43 | ||
eed10e39 KS |
44 | |
45 | #define NILFS_INODE_BMAP_SIZE 7 | |
46 | /** | |
47 | * struct nilfs_inode - structure of an inode on disk | |
48 | * @i_blocks: blocks count | |
49 | * @i_size: size in bytes | |
61239230 RK |
50 | * @i_ctime: creation time (seconds) |
51 | * @i_mtime: modification time (seconds) | |
52 | * @i_ctime_nsec: creation time (nano seconds) | |
53 | * @i_mtime_nsec: modification time (nano seconds) | |
eed10e39 KS |
54 | * @i_uid: user id |
55 | * @i_gid: group id | |
56 | * @i_mode: file mode | |
57 | * @i_links_count: links count | |
58 | * @i_flags: file flags | |
59 | * @i_bmap: block mapping | |
60 | * @i_xattr: extended attributes | |
61 | * @i_generation: file generation (for NFS) | |
62 | * @i_pad: padding | |
63 | */ | |
64 | struct nilfs_inode { | |
65 | __le64 i_blocks; | |
66 | __le64 i_size; | |
67 | __le64 i_ctime; | |
68 | __le64 i_mtime; | |
61239230 RK |
69 | __le32 i_ctime_nsec; |
70 | __le32 i_mtime_nsec; | |
eed10e39 KS |
71 | __le32 i_uid; |
72 | __le32 i_gid; | |
73 | __le16 i_mode; | |
74 | __le16 i_links_count; | |
75 | __le32 i_flags; | |
76 | __le64 i_bmap[NILFS_INODE_BMAP_SIZE]; | |
77 | #define i_device_code i_bmap[0] | |
78 | __le64 i_xattr; | |
79 | __le32 i_generation; | |
80 | __le32 i_pad; | |
81 | }; | |
82 | ||
83 | /** | |
84 | * struct nilfs_super_root - structure of super root | |
85 | * @sr_sum: check sum | |
86 | * @sr_bytes: byte count of the structure | |
87 | * @sr_flags: flags (reserved) | |
88 | * @sr_nongc_ctime: write time of the last segment not for cleaner operation | |
89 | * @sr_dat: DAT file inode | |
90 | * @sr_cpfile: checkpoint file inode | |
91 | * @sr_sufile: segment usage file inode | |
92 | */ | |
93 | struct nilfs_super_root { | |
94 | __le32 sr_sum; | |
95 | __le16 sr_bytes; | |
96 | __le16 sr_flags; | |
97 | __le64 sr_nongc_ctime; | |
98 | struct nilfs_inode sr_dat; | |
99 | struct nilfs_inode sr_cpfile; | |
100 | struct nilfs_inode sr_sufile; | |
101 | }; | |
102 | ||
103 | #define NILFS_SR_MDT_OFFSET(inode_size, i) \ | |
104 | ((unsigned long)&((struct nilfs_super_root *)0)->sr_dat + \ | |
105 | (inode_size) * (i)) | |
106 | #define NILFS_SR_DAT_OFFSET(inode_size) NILFS_SR_MDT_OFFSET(inode_size, 0) | |
107 | #define NILFS_SR_CPFILE_OFFSET(inode_size) NILFS_SR_MDT_OFFSET(inode_size, 1) | |
108 | #define NILFS_SR_SUFILE_OFFSET(inode_size) NILFS_SR_MDT_OFFSET(inode_size, 2) | |
109 | #define NILFS_SR_BYTES (sizeof(struct nilfs_super_root)) | |
110 | ||
111 | /* | |
112 | * Maximal mount counts | |
113 | */ | |
114 | #define NILFS_DFL_MAX_MNT_COUNT 50 /* 50 mounts */ | |
115 | ||
116 | /* | |
117 | * File system states (sbp->s_state, nilfs->ns_mount_state) | |
118 | */ | |
119 | #define NILFS_VALID_FS 0x0001 /* Unmounted cleanly */ | |
120 | #define NILFS_ERROR_FS 0x0002 /* Errors detected */ | |
121 | #define NILFS_RESIZE_FS 0x0004 /* Resize required */ | |
122 | ||
123 | /* | |
124 | * Mount flags (sbi->s_mount_opt) | |
125 | */ | |
126 | #define NILFS_MOUNT_ERROR_MODE 0x0070 /* Error mode mask */ | |
127 | #define NILFS_MOUNT_ERRORS_CONT 0x0010 /* Continue on errors */ | |
128 | #define NILFS_MOUNT_ERRORS_RO 0x0020 /* Remount fs ro on errors */ | |
129 | #define NILFS_MOUNT_ERRORS_PANIC 0x0040 /* Panic on errors */ | |
eed10e39 KS |
130 | #define NILFS_MOUNT_BARRIER 0x1000 /* Use block barriers */ |
131 | #define NILFS_MOUNT_STRICT_ORDER 0x2000 /* Apply strict in-order | |
132 | semantics also for data */ | |
0234576d RK |
133 | #define NILFS_MOUNT_NORECOVERY 0x4000 /* Disable write access during |
134 | mount-time recovery */ | |
e902ec99 | 135 | #define NILFS_MOUNT_DISCARD 0x8000 /* Issue DISCARD requests */ |
eed10e39 KS |
136 | |
137 | ||
138 | /** | |
139 | * struct nilfs_super_block - structure of super block on disk | |
140 | */ | |
141 | struct nilfs_super_block { | |
2f1b7cd2 | 142 | /*00*/ __le32 s_rev_level; /* Revision level */ |
eed10e39 KS |
143 | __le16 s_minor_rev_level; /* minor revision level */ |
144 | __le16 s_magic; /* Magic signature */ | |
145 | ||
146 | __le16 s_bytes; /* Bytes count of CRC calculation | |
147 | for this structure. s_reserved | |
148 | is excluded. */ | |
149 | __le16 s_flags; /* flags */ | |
150 | __le32 s_crc_seed; /* Seed value of CRC calculation */ | |
2f1b7cd2 | 151 | /*10*/ __le32 s_sum; /* Check sum of super block */ |
eed10e39 KS |
152 | |
153 | __le32 s_log_block_size; /* Block size represented as follows | |
154 | blocksize = | |
155 | 1 << (s_log_block_size + 10) */ | |
156 | __le64 s_nsegments; /* Number of segments in filesystem */ | |
2f1b7cd2 | 157 | /*20*/ __le64 s_dev_size; /* block device size in bytes */ |
eed10e39 | 158 | __le64 s_first_data_block; /* 1st seg disk block number */ |
2f1b7cd2 | 159 | /*30*/ __le32 s_blocks_per_segment; /* number of blocks per full segment */ |
eed10e39 KS |
160 | __le32 s_r_segments_percentage; /* Reserved segments percentage */ |
161 | ||
162 | __le64 s_last_cno; /* Last checkpoint number */ | |
2f1b7cd2 | 163 | /*40*/ __le64 s_last_pseg; /* disk block addr pseg written last */ |
eed10e39 | 164 | __le64 s_last_seq; /* seq. number of seg written last */ |
2f1b7cd2 | 165 | /*50*/ __le64 s_free_blocks_count; /* Free blocks count */ |
eed10e39 KS |
166 | |
167 | __le64 s_ctime; /* Creation time (execution time of | |
168 | newfs) */ | |
2f1b7cd2 | 169 | /*60*/ __le64 s_mtime; /* Mount time */ |
eed10e39 | 170 | __le64 s_wtime; /* Write time */ |
2f1b7cd2 | 171 | /*70*/ __le16 s_mnt_count; /* Mount count */ |
eed10e39 KS |
172 | __le16 s_max_mnt_count; /* Maximal mount count */ |
173 | __le16 s_state; /* File system state */ | |
174 | __le16 s_errors; /* Behaviour when detecting errors */ | |
175 | __le64 s_lastcheck; /* time of last check */ | |
176 | ||
2f1b7cd2 | 177 | /*80*/ __le32 s_checkinterval; /* max. time between checks */ |
eed10e39 KS |
178 | __le32 s_creator_os; /* OS */ |
179 | __le16 s_def_resuid; /* Default uid for reserved blocks */ | |
180 | __le16 s_def_resgid; /* Default gid for reserved blocks */ | |
0d9cc233 | 181 | __le32 s_first_ino; /* First non-reserved inode */ |
eed10e39 | 182 | |
2f1b7cd2 | 183 | /*90*/ __le16 s_inode_size; /* Size of an inode */ |
eed10e39 KS |
184 | __le16 s_dat_entry_size; /* Size of a dat entry */ |
185 | __le16 s_checkpoint_size; /* Size of a checkpoint */ | |
186 | __le16 s_segment_usage_size; /* Size of a segment usage */ | |
187 | ||
2f1b7cd2 RK |
188 | /*98*/ __u8 s_uuid[16]; /* 128-bit uuid for volume */ |
189 | /*A8*/ char s_volume_name[80]; /* volume name */ | |
eed10e39 | 190 | |
2f1b7cd2 | 191 | /*F8*/ __le32 s_c_interval; /* Commit interval of segment */ |
eed10e39 KS |
192 | __le32 s_c_block_max; /* Threshold of data amount for |
193 | the segment construction */ | |
1a80a176 RK |
194 | /*100*/ __le64 s_feature_compat; /* Compatible feature set */ |
195 | __le64 s_feature_compat_ro; /* Read-only compatible feature set */ | |
196 | __le64 s_feature_incompat; /* Incompatible feature set */ | |
197 | __u32 s_reserved[186]; /* padding to the end of the block */ | |
eed10e39 KS |
198 | }; |
199 | ||
200 | /* | |
201 | * Codes for operating systems | |
202 | */ | |
203 | #define NILFS_OS_LINUX 0 | |
204 | /* Codes from 1 to 4 are reserved to keep compatibility with ext2 creator-OS */ | |
205 | ||
206 | /* | |
207 | * Revision levels | |
208 | */ | |
209 | #define NILFS_CURRENT_REV 2 /* current major revision */ | |
210 | #define NILFS_MINOR_REV 0 /* minor revision */ | |
9566a7a8 | 211 | #define NILFS_MIN_SUPP_REV 2 /* minimum supported revision */ |
eed10e39 | 212 | |
1a80a176 RK |
213 | /* |
214 | * Feature set definitions | |
215 | * | |
216 | * If there is a bit set in the incompatible feature set that the kernel | |
217 | * doesn't know about, it should refuse to mount the filesystem. | |
218 | */ | |
219 | #define NILFS_FEATURE_COMPAT_SUPP 0ULL | |
220 | #define NILFS_FEATURE_COMPAT_RO_SUPP 0ULL | |
221 | #define NILFS_FEATURE_INCOMPAT_SUPP 0ULL | |
222 | ||
eed10e39 KS |
223 | /* |
224 | * Bytes count of super_block for CRC-calculation | |
225 | */ | |
226 | #define NILFS_SB_BYTES \ | |
227 | ((long)&((struct nilfs_super_block *)0)->s_reserved) | |
228 | ||
229 | /* | |
230 | * Special inode number | |
231 | */ | |
232 | #define NILFS_ROOT_INO 2 /* Root file inode */ | |
233 | #define NILFS_DAT_INO 3 /* DAT file */ | |
234 | #define NILFS_CPFILE_INO 4 /* checkpoint file */ | |
235 | #define NILFS_SUFILE_INO 5 /* segment usage file */ | |
236 | #define NILFS_IFILE_INO 6 /* ifile */ | |
237 | #define NILFS_ATIME_INO 7 /* Atime file (reserved) */ | |
238 | #define NILFS_XATTR_INO 8 /* Xattribute file (reserved) */ | |
239 | #define NILFS_SKETCH_INO 10 /* Sketch file */ | |
240 | #define NILFS_USER_INO 11 /* Fisrt user's file inode number */ | |
241 | ||
242 | #define NILFS_SB_OFFSET_BYTES 1024 /* byte offset of nilfs superblock */ | |
243 | #define NILFS_SUPER_MAGIC 0x3434 /* NILFS filesystem magic number */ | |
244 | ||
245 | #define NILFS_SEG_MIN_BLOCKS 16 /* Minimum number of blocks in | |
246 | a full segment */ | |
247 | #define NILFS_PSEG_MIN_BLOCKS 2 /* Minimum number of blocks in | |
248 | a partial segment */ | |
249 | #define NILFS_MIN_NRSVSEGS 8 /* Minimum number of reserved | |
250 | segments */ | |
251 | ||
6c43f410 RK |
252 | /* |
253 | * We call DAT, cpfile, and sufile root metadata files. Inodes of | |
254 | * these files are written in super root block instead of ifile, and | |
255 | * garbage collector doesn't keep any past versions of these files. | |
256 | */ | |
257 | #define NILFS_ROOT_METADATA_FILE(ino) \ | |
258 | ((ino) >= NILFS_DAT_INO && (ino) <= NILFS_SUFILE_INO) | |
259 | ||
e339ad31 RK |
260 | /* |
261 | * bytes offset of secondary super block | |
262 | */ | |
263 | #define NILFS_SB2_OFFSET_BYTES(devsize) ((((devsize) >> 12) - 1) << 12) | |
eed10e39 KS |
264 | |
265 | /* | |
266 | * Maximal count of links to a file | |
267 | */ | |
268 | #define NILFS_LINK_MAX 32000 | |
269 | ||
270 | /* | |
271 | * Structure of a directory entry | |
272 | * (Same as ext2) | |
273 | */ | |
274 | ||
275 | #define NILFS_NAME_LEN 255 | |
276 | ||
89c0fd01 RK |
277 | /* |
278 | * Block size limitations | |
279 | */ | |
280 | #define NILFS_MIN_BLOCK_SIZE 1024 | |
281 | #define NILFS_MAX_BLOCK_SIZE 65536 | |
282 | ||
eed10e39 KS |
283 | /* |
284 | * The new version of the directory entry. Since V0 structures are | |
285 | * stored in intel byte order, and the name_len field could never be | |
286 | * bigger than 255 chars, it's safe to reclaim the extra byte for the | |
287 | * file_type field. | |
288 | */ | |
289 | struct nilfs_dir_entry { | |
290 | __le64 inode; /* Inode number */ | |
291 | __le16 rec_len; /* Directory entry length */ | |
292 | __u8 name_len; /* Name length */ | |
293 | __u8 file_type; | |
294 | char name[NILFS_NAME_LEN]; /* File name */ | |
295 | char pad; | |
296 | }; | |
297 | ||
298 | /* | |
299 | * NILFS directory file types. Only the low 3 bits are used. The | |
300 | * other bits are reserved for now. | |
301 | */ | |
302 | enum { | |
303 | NILFS_FT_UNKNOWN, | |
304 | NILFS_FT_REG_FILE, | |
305 | NILFS_FT_DIR, | |
306 | NILFS_FT_CHRDEV, | |
307 | NILFS_FT_BLKDEV, | |
308 | NILFS_FT_FIFO, | |
309 | NILFS_FT_SOCK, | |
310 | NILFS_FT_SYMLINK, | |
311 | NILFS_FT_MAX | |
312 | }; | |
313 | ||
314 | /* | |
315 | * NILFS_DIR_PAD defines the directory entries boundaries | |
316 | * | |
317 | * NOTE: It must be a multiple of 8 | |
318 | */ | |
319 | #define NILFS_DIR_PAD 8 | |
320 | #define NILFS_DIR_ROUND (NILFS_DIR_PAD - 1) | |
321 | #define NILFS_DIR_REC_LEN(name_len) (((name_len) + 12 + NILFS_DIR_ROUND) & \ | |
322 | ~NILFS_DIR_ROUND) | |
6cda9fa2 RK |
323 | #define NILFS_MAX_REC_LEN ((1<<16)-1) |
324 | ||
325 | static inline unsigned nilfs_rec_len_from_disk(__le16 dlen) | |
326 | { | |
327 | unsigned len = le16_to_cpu(dlen); | |
328 | ||
329 | if (len == NILFS_MAX_REC_LEN) | |
330 | return 1 << 16; | |
331 | return len; | |
332 | } | |
333 | ||
334 | static inline __le16 nilfs_rec_len_to_disk(unsigned len) | |
335 | { | |
336 | if (len == (1 << 16)) | |
337 | return cpu_to_le16(NILFS_MAX_REC_LEN); | |
338 | else if (len > (1 << 16)) | |
339 | BUG(); | |
340 | return cpu_to_le16(len); | |
341 | } | |
eed10e39 KS |
342 | |
343 | /** | |
344 | * struct nilfs_finfo - file information | |
345 | * @fi_ino: inode number | |
346 | * @fi_cno: checkpoint number | |
347 | * @fi_nblocks: number of blocks (including intermediate blocks) | |
348 | * @fi_ndatablk: number of file data blocks | |
349 | */ | |
350 | struct nilfs_finfo { | |
351 | __le64 fi_ino; | |
352 | __le64 fi_cno; | |
353 | __le32 fi_nblocks; | |
354 | __le32 fi_ndatablk; | |
355 | /* array of virtual block numbers */ | |
356 | }; | |
357 | ||
358 | /** | |
359 | * struct nilfs_binfo_v - information for the block to which a virtual block number is assigned | |
360 | * @bi_vblocknr: virtual block number | |
361 | * @bi_blkoff: block offset | |
362 | */ | |
363 | struct nilfs_binfo_v { | |
364 | __le64 bi_vblocknr; | |
365 | __le64 bi_blkoff; | |
366 | }; | |
367 | ||
368 | /** | |
369 | * struct nilfs_binfo_dat - information for the block which belongs to the DAT file | |
370 | * @bi_blkoff: block offset | |
371 | * @bi_level: level | |
372 | * @bi_pad: padding | |
373 | */ | |
374 | struct nilfs_binfo_dat { | |
375 | __le64 bi_blkoff; | |
376 | __u8 bi_level; | |
377 | __u8 bi_pad[7]; | |
378 | }; | |
379 | ||
380 | /** | |
381 | * union nilfs_binfo: block information | |
382 | * @bi_v: nilfs_binfo_v structure | |
383 | * @bi_dat: nilfs_binfo_dat structure | |
384 | */ | |
385 | union nilfs_binfo { | |
386 | struct nilfs_binfo_v bi_v; | |
387 | struct nilfs_binfo_dat bi_dat; | |
388 | }; | |
389 | ||
390 | /** | |
391 | * struct nilfs_segment_summary - segment summary | |
392 | * @ss_datasum: checksum of data | |
393 | * @ss_sumsum: checksum of segment summary | |
394 | * @ss_magic: magic number | |
395 | * @ss_bytes: size of this structure in bytes | |
396 | * @ss_flags: flags | |
397 | * @ss_seq: sequence number | |
398 | * @ss_create: creation timestamp | |
399 | * @ss_next: next segment | |
400 | * @ss_nblocks: number of blocks | |
401 | * @ss_nfinfo: number of finfo structures | |
402 | * @ss_sumbytes: total size of segment summary in bytes | |
403 | * @ss_pad: padding | |
50614bcf | 404 | * @ss_cno: checkpoint number |
eed10e39 KS |
405 | */ |
406 | struct nilfs_segment_summary { | |
407 | __le32 ss_datasum; | |
408 | __le32 ss_sumsum; | |
409 | __le32 ss_magic; | |
410 | __le16 ss_bytes; | |
411 | __le16 ss_flags; | |
412 | __le64 ss_seq; | |
413 | __le64 ss_create; | |
414 | __le64 ss_next; | |
415 | __le32 ss_nblocks; | |
416 | __le32 ss_nfinfo; | |
417 | __le32 ss_sumbytes; | |
418 | __le32 ss_pad; | |
50614bcf | 419 | __le64 ss_cno; |
eed10e39 KS |
420 | /* array of finfo structures */ |
421 | }; | |
422 | ||
423 | #define NILFS_SEGSUM_MAGIC 0x1eaffa11 /* segment summary magic number */ | |
424 | ||
425 | /* | |
426 | * Segment summary flags | |
427 | */ | |
428 | #define NILFS_SS_LOGBGN 0x0001 /* begins a logical segment */ | |
429 | #define NILFS_SS_LOGEND 0x0002 /* ends a logical segment */ | |
430 | #define NILFS_SS_SR 0x0004 /* has super root */ | |
431 | #define NILFS_SS_SYNDT 0x0008 /* includes data only updates */ | |
432 | #define NILFS_SS_GC 0x0010 /* segment written for cleaner operation */ | |
433 | ||
6600b9dd JS |
434 | /** |
435 | * struct nilfs_btree_node - B-tree node | |
436 | * @bn_flags: flags | |
437 | * @bn_level: level | |
438 | * @bn_nchildren: number of children | |
439 | * @bn_pad: padding | |
440 | */ | |
441 | struct nilfs_btree_node { | |
442 | __u8 bn_flags; | |
443 | __u8 bn_level; | |
444 | __le16 bn_nchildren; | |
445 | __le32 bn_pad; | |
446 | }; | |
447 | ||
448 | /* flags */ | |
449 | #define NILFS_BTREE_NODE_ROOT 0x01 | |
450 | ||
451 | /* level */ | |
452 | #define NILFS_BTREE_LEVEL_DATA 0 | |
453 | #define NILFS_BTREE_LEVEL_NODE_MIN (NILFS_BTREE_LEVEL_DATA + 1) | |
454 | #define NILFS_BTREE_LEVEL_MAX 14 | |
455 | ||
eed10e39 KS |
456 | /** |
457 | * struct nilfs_palloc_group_desc - block group descriptor | |
458 | * @pg_nfrees: number of free entries in block group | |
459 | */ | |
460 | struct nilfs_palloc_group_desc { | |
461 | __le32 pg_nfrees; | |
462 | }; | |
463 | ||
464 | /** | |
465 | * struct nilfs_dat_entry - disk address translation entry | |
37e11f33 QF |
466 | * @de_blocknr: block number |
467 | * @de_start: start checkpoint number | |
468 | * @de_end: end checkpoint number | |
469 | * @de_rsv: reserved for future use | |
eed10e39 KS |
470 | */ |
471 | struct nilfs_dat_entry { | |
472 | __le64 de_blocknr; | |
473 | __le64 de_start; | |
474 | __le64 de_end; | |
475 | __le64 de_rsv; | |
476 | }; | |
477 | ||
eed10e39 KS |
478 | /** |
479 | * struct nilfs_snapshot_list - snapshot list | |
480 | * @ssl_next: next checkpoint number on snapshot list | |
481 | * @ssl_prev: previous checkpoint number on snapshot list | |
482 | */ | |
483 | struct nilfs_snapshot_list { | |
484 | __le64 ssl_next; | |
485 | __le64 ssl_prev; | |
486 | }; | |
487 | ||
488 | /** | |
489 | * struct nilfs_checkpoint - checkpoint structure | |
490 | * @cp_flags: flags | |
491 | * @cp_checkpoints_count: checkpoints count in a block | |
492 | * @cp_snapshot_list: snapshot list | |
493 | * @cp_cno: checkpoint number | |
494 | * @cp_create: creation timestamp | |
495 | * @cp_nblk_inc: number of blocks incremented by this checkpoint | |
496 | * @cp_inodes_count: inodes count | |
497 | * @cp_blocks_count: blocks count | |
498 | * @cp_ifile_inode: inode of ifile | |
499 | */ | |
500 | struct nilfs_checkpoint { | |
501 | __le32 cp_flags; | |
502 | __le32 cp_checkpoints_count; | |
503 | struct nilfs_snapshot_list cp_snapshot_list; | |
504 | __le64 cp_cno; | |
505 | __le64 cp_create; | |
506 | __le64 cp_nblk_inc; | |
507 | __le64 cp_inodes_count; | |
508 | __le64 cp_blocks_count; /* Reserved (might be deleted) */ | |
509 | ||
510 | /* Do not change the byte offset of ifile inode. | |
511 | To keep the compatibility of the disk format, | |
512 | additional fields should be added behind cp_ifile_inode. */ | |
513 | struct nilfs_inode cp_ifile_inode; | |
514 | }; | |
515 | ||
516 | /* checkpoint flags */ | |
517 | enum { | |
518 | NILFS_CHECKPOINT_SNAPSHOT, | |
519 | NILFS_CHECKPOINT_INVALID, | |
520 | NILFS_CHECKPOINT_SKETCH, | |
c96fa464 | 521 | NILFS_CHECKPOINT_MINOR, |
eed10e39 KS |
522 | }; |
523 | ||
524 | #define NILFS_CHECKPOINT_FNS(flag, name) \ | |
525 | static inline void \ | |
526 | nilfs_checkpoint_set_##name(struct nilfs_checkpoint *cp) \ | |
527 | { \ | |
528 | cp->cp_flags = cpu_to_le32(le32_to_cpu(cp->cp_flags) | \ | |
529 | (1UL << NILFS_CHECKPOINT_##flag)); \ | |
530 | } \ | |
531 | static inline void \ | |
532 | nilfs_checkpoint_clear_##name(struct nilfs_checkpoint *cp) \ | |
533 | { \ | |
534 | cp->cp_flags = cpu_to_le32(le32_to_cpu(cp->cp_flags) & \ | |
535 | ~(1UL << NILFS_CHECKPOINT_##flag)); \ | |
536 | } \ | |
537 | static inline int \ | |
538 | nilfs_checkpoint_##name(const struct nilfs_checkpoint *cp) \ | |
539 | { \ | |
540 | return !!(le32_to_cpu(cp->cp_flags) & \ | |
541 | (1UL << NILFS_CHECKPOINT_##flag)); \ | |
542 | } | |
543 | ||
544 | NILFS_CHECKPOINT_FNS(SNAPSHOT, snapshot) | |
545 | NILFS_CHECKPOINT_FNS(INVALID, invalid) | |
c96fa464 | 546 | NILFS_CHECKPOINT_FNS(MINOR, minor) |
eed10e39 KS |
547 | |
548 | /** | |
549 | * struct nilfs_cpinfo - checkpoint information | |
550 | * @ci_flags: flags | |
dc498d09 | 551 | * @ci_pad: padding |
eed10e39 KS |
552 | * @ci_cno: checkpoint number |
553 | * @ci_create: creation timestamp | |
554 | * @ci_nblk_inc: number of blocks incremented by this checkpoint | |
555 | * @ci_inodes_count: inodes count | |
556 | * @ci_blocks_count: blocks count | |
557 | * @ci_next: next checkpoint number in snapshot list | |
558 | */ | |
559 | struct nilfs_cpinfo { | |
560 | __u32 ci_flags; | |
dc498d09 | 561 | __u32 ci_pad; |
eed10e39 KS |
562 | __u64 ci_cno; |
563 | __u64 ci_create; | |
564 | __u64 ci_nblk_inc; | |
565 | __u64 ci_inodes_count; | |
566 | __u64 ci_blocks_count; | |
567 | __u64 ci_next; | |
568 | }; | |
569 | ||
570 | #define NILFS_CPINFO_FNS(flag, name) \ | |
571 | static inline int \ | |
572 | nilfs_cpinfo_##name(const struct nilfs_cpinfo *cpinfo) \ | |
573 | { \ | |
574 | return !!(cpinfo->ci_flags & (1UL << NILFS_CHECKPOINT_##flag)); \ | |
575 | } | |
576 | ||
577 | NILFS_CPINFO_FNS(SNAPSHOT, snapshot) | |
578 | NILFS_CPINFO_FNS(INVALID, invalid) | |
c96fa464 | 579 | NILFS_CPINFO_FNS(MINOR, minor) |
eed10e39 KS |
580 | |
581 | ||
582 | /** | |
583 | * struct nilfs_cpfile_header - checkpoint file header | |
584 | * @ch_ncheckpoints: number of checkpoints | |
585 | * @ch_nsnapshots: number of snapshots | |
586 | * @ch_snapshot_list: snapshot list | |
587 | */ | |
588 | struct nilfs_cpfile_header { | |
589 | __le64 ch_ncheckpoints; | |
590 | __le64 ch_nsnapshots; | |
591 | struct nilfs_snapshot_list ch_snapshot_list; | |
592 | }; | |
593 | ||
594 | #define NILFS_CPFILE_FIRST_CHECKPOINT_OFFSET \ | |
595 | ((sizeof(struct nilfs_cpfile_header) + \ | |
596 | sizeof(struct nilfs_checkpoint) - 1) / \ | |
597 | sizeof(struct nilfs_checkpoint)) | |
598 | ||
599 | /** | |
600 | * struct nilfs_segment_usage - segment usage | |
601 | * @su_lastmod: last modified timestamp | |
602 | * @su_nblocks: number of blocks in segment | |
603 | * @su_flags: flags | |
604 | */ | |
605 | struct nilfs_segment_usage { | |
606 | __le64 su_lastmod; | |
607 | __le32 su_nblocks; | |
608 | __le32 su_flags; | |
609 | }; | |
610 | ||
611 | /* segment usage flag */ | |
612 | enum { | |
613 | NILFS_SEGMENT_USAGE_ACTIVE, | |
614 | NILFS_SEGMENT_USAGE_DIRTY, | |
615 | NILFS_SEGMENT_USAGE_ERROR, | |
616 | ||
eed10e39 KS |
617 | /* ... */ |
618 | }; | |
619 | ||
620 | #define NILFS_SEGMENT_USAGE_FNS(flag, name) \ | |
621 | static inline void \ | |
622 | nilfs_segment_usage_set_##name(struct nilfs_segment_usage *su) \ | |
623 | { \ | |
624 | su->su_flags = cpu_to_le32(le32_to_cpu(su->su_flags) | \ | |
625 | (1UL << NILFS_SEGMENT_USAGE_##flag));\ | |
626 | } \ | |
627 | static inline void \ | |
628 | nilfs_segment_usage_clear_##name(struct nilfs_segment_usage *su) \ | |
629 | { \ | |
630 | su->su_flags = \ | |
631 | cpu_to_le32(le32_to_cpu(su->su_flags) & \ | |
632 | ~(1UL << NILFS_SEGMENT_USAGE_##flag)); \ | |
633 | } \ | |
634 | static inline int \ | |
635 | nilfs_segment_usage_##name(const struct nilfs_segment_usage *su) \ | |
636 | { \ | |
637 | return !!(le32_to_cpu(su->su_flags) & \ | |
638 | (1UL << NILFS_SEGMENT_USAGE_##flag)); \ | |
639 | } | |
640 | ||
641 | NILFS_SEGMENT_USAGE_FNS(ACTIVE, active) | |
642 | NILFS_SEGMENT_USAGE_FNS(DIRTY, dirty) | |
643 | NILFS_SEGMENT_USAGE_FNS(ERROR, error) | |
eed10e39 KS |
644 | |
645 | static inline void | |
646 | nilfs_segment_usage_set_clean(struct nilfs_segment_usage *su) | |
647 | { | |
648 | su->su_lastmod = cpu_to_le64(0); | |
649 | su->su_nblocks = cpu_to_le32(0); | |
650 | su->su_flags = cpu_to_le32(0); | |
651 | } | |
652 | ||
653 | static inline int | |
654 | nilfs_segment_usage_clean(const struct nilfs_segment_usage *su) | |
655 | { | |
656 | return !le32_to_cpu(su->su_flags); | |
657 | } | |
658 | ||
659 | /** | |
660 | * struct nilfs_sufile_header - segment usage file header | |
661 | * @sh_ncleansegs: number of clean segments | |
662 | * @sh_ndirtysegs: number of dirty segments | |
663 | * @sh_last_alloc: last allocated segment number | |
664 | */ | |
665 | struct nilfs_sufile_header { | |
666 | __le64 sh_ncleansegs; | |
667 | __le64 sh_ndirtysegs; | |
668 | __le64 sh_last_alloc; | |
669 | /* ... */ | |
670 | }; | |
671 | ||
672 | #define NILFS_SUFILE_FIRST_SEGMENT_USAGE_OFFSET \ | |
673 | ((sizeof(struct nilfs_sufile_header) + \ | |
674 | sizeof(struct nilfs_segment_usage) - 1) / \ | |
675 | sizeof(struct nilfs_segment_usage)) | |
676 | ||
677 | /** | |
678 | * nilfs_suinfo - segment usage information | |
679 | * @sui_lastmod: | |
680 | * @sui_nblocks: | |
681 | * @sui_flags: | |
682 | */ | |
683 | struct nilfs_suinfo { | |
684 | __u64 sui_lastmod; | |
685 | __u32 sui_nblocks; | |
686 | __u32 sui_flags; | |
687 | }; | |
688 | ||
689 | #define NILFS_SUINFO_FNS(flag, name) \ | |
690 | static inline int \ | |
691 | nilfs_suinfo_##name(const struct nilfs_suinfo *si) \ | |
692 | { \ | |
693 | return si->sui_flags & (1UL << NILFS_SEGMENT_USAGE_##flag); \ | |
694 | } | |
695 | ||
696 | NILFS_SUINFO_FNS(ACTIVE, active) | |
697 | NILFS_SUINFO_FNS(DIRTY, dirty) | |
698 | NILFS_SUINFO_FNS(ERROR, error) | |
eed10e39 KS |
699 | |
700 | static inline int nilfs_suinfo_clean(const struct nilfs_suinfo *si) | |
701 | { | |
702 | return !si->sui_flags; | |
703 | } | |
704 | ||
705 | /* ioctl */ | |
706 | enum { | |
707 | NILFS_CHECKPOINT, | |
708 | NILFS_SNAPSHOT, | |
709 | }; | |
710 | ||
711 | /** | |
712 | * struct nilfs_cpmode - | |
713 | * @cc_cno: | |
714 | * @cc_mode: | |
715 | */ | |
716 | struct nilfs_cpmode { | |
717 | __u64 cm_cno; | |
dc498d09 RK |
718 | __u32 cm_mode; |
719 | __u32 cm_pad; | |
eed10e39 KS |
720 | }; |
721 | ||
722 | /** | |
723 | * struct nilfs_argv - argument vector | |
724 | * @v_base: | |
725 | * @v_nmembs: | |
726 | * @v_size: | |
eed10e39 | 727 | * @v_flags: |
dc498d09 | 728 | * @v_index: |
eed10e39 KS |
729 | */ |
730 | struct nilfs_argv { | |
dc498d09 RK |
731 | __u64 v_base; |
732 | __u32 v_nmembs; /* number of members */ | |
733 | __u16 v_size; /* size of members */ | |
734 | __u16 v_flags; | |
735 | __u64 v_index; | |
eed10e39 KS |
736 | }; |
737 | ||
738 | /** | |
739 | * struct nilfs_period - | |
740 | * @p_start: | |
741 | * @p_end: | |
742 | */ | |
743 | struct nilfs_period { | |
744 | __u64 p_start; | |
745 | __u64 p_end; | |
746 | }; | |
747 | ||
748 | /** | |
749 | * struct nilfs_cpstat - | |
750 | * @cs_cno: checkpoint number | |
751 | * @cs_ncps: number of checkpoints | |
752 | * @cs_nsss: number of snapshots | |
753 | */ | |
754 | struct nilfs_cpstat { | |
755 | __u64 cs_cno; | |
756 | __u64 cs_ncps; | |
757 | __u64 cs_nsss; | |
758 | }; | |
759 | ||
760 | /** | |
761 | * struct nilfs_sustat - | |
762 | * @ss_nsegs: number of segments | |
763 | * @ss_ncleansegs: number of clean segments | |
764 | * @ss_ndirtysegs: number of dirty segments | |
2c2e52fc RK |
765 | * @ss_ctime: creation time of the last segment |
766 | * @ss_nongc_ctime: creation time of the last segment not for GC | |
767 | * @ss_prot_seq: least sequence number of segments which must not be reclaimed | |
eed10e39 KS |
768 | */ |
769 | struct nilfs_sustat { | |
770 | __u64 ss_nsegs; | |
771 | __u64 ss_ncleansegs; | |
772 | __u64 ss_ndirtysegs; | |
dc498d09 RK |
773 | __u64 ss_ctime; |
774 | __u64 ss_nongc_ctime; | |
2c2e52fc | 775 | __u64 ss_prot_seq; |
eed10e39 KS |
776 | }; |
777 | ||
778 | /** | |
779 | * struct nilfs_vinfo - virtual block number information | |
780 | * @vi_vblocknr: | |
781 | * @vi_start: | |
782 | * @vi_end: | |
783 | * @vi_blocknr: | |
784 | */ | |
785 | struct nilfs_vinfo { | |
786 | __u64 vi_vblocknr; | |
787 | __u64 vi_start; | |
788 | __u64 vi_end; | |
789 | __u64 vi_blocknr; | |
790 | }; | |
791 | ||
792 | /** | |
793 | * struct nilfs_vdesc - | |
794 | */ | |
795 | struct nilfs_vdesc { | |
796 | __u64 vd_ino; | |
797 | __u64 vd_cno; | |
798 | __u64 vd_vblocknr; | |
799 | struct nilfs_period vd_period; | |
800 | __u64 vd_blocknr; | |
801 | __u64 vd_offset; | |
802 | __u32 vd_flags; | |
dc498d09 | 803 | __u32 vd_pad; |
eed10e39 KS |
804 | }; |
805 | ||
806 | /** | |
807 | * struct nilfs_bdesc - | |
808 | */ | |
809 | struct nilfs_bdesc { | |
810 | __u64 bd_ino; | |
811 | __u64 bd_oblocknr; | |
812 | __u64 bd_blocknr; | |
813 | __u64 bd_offset; | |
814 | __u32 bd_level; | |
dc498d09 | 815 | __u32 bd_pad; |
eed10e39 KS |
816 | }; |
817 | ||
eed10e39 KS |
818 | #define NILFS_IOCTL_IDENT 'n' |
819 | ||
820 | #define NILFS_IOCTL_CHANGE_CPMODE \ | |
821 | _IOW(NILFS_IOCTL_IDENT, 0x80, struct nilfs_cpmode) | |
822 | #define NILFS_IOCTL_DELETE_CHECKPOINT \ | |
823 | _IOW(NILFS_IOCTL_IDENT, 0x81, __u64) | |
824 | #define NILFS_IOCTL_GET_CPINFO \ | |
825 | _IOR(NILFS_IOCTL_IDENT, 0x82, struct nilfs_argv) | |
826 | #define NILFS_IOCTL_GET_CPSTAT \ | |
827 | _IOR(NILFS_IOCTL_IDENT, 0x83, struct nilfs_cpstat) | |
828 | #define NILFS_IOCTL_GET_SUINFO \ | |
829 | _IOR(NILFS_IOCTL_IDENT, 0x84, struct nilfs_argv) | |
830 | #define NILFS_IOCTL_GET_SUSTAT \ | |
831 | _IOR(NILFS_IOCTL_IDENT, 0x85, struct nilfs_sustat) | |
832 | #define NILFS_IOCTL_GET_VINFO \ | |
833 | _IOWR(NILFS_IOCTL_IDENT, 0x86, struct nilfs_argv) | |
834 | #define NILFS_IOCTL_GET_BDESCS \ | |
835 | _IOWR(NILFS_IOCTL_IDENT, 0x87, struct nilfs_argv) | |
836 | #define NILFS_IOCTL_CLEAN_SEGMENTS \ | |
837 | _IOW(NILFS_IOCTL_IDENT, 0x88, struct nilfs_argv[5]) | |
eed10e39 KS |
838 | #define NILFS_IOCTL_SYNC \ |
839 | _IOR(NILFS_IOCTL_IDENT, 0x8A, __u64) | |
840 | #define NILFS_IOCTL_RESIZE \ | |
841 | _IOW(NILFS_IOCTL_IDENT, 0x8B, __u64) | |
842 | ||
eed10e39 | 843 | #endif /* _LINUX_NILFS_FS_H */ |