nilfs2_fs.h 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816
  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
  7. * it under the terms of the GNU General Public License as published by
  8. * the Free Software Foundation; either version 2 of the License, or
  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
  14. * GNU General Public License for more details.
  15. *
  16. * You should have received a copy of the GNU General Public License
  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. #ifndef _LINUX_NILFS_FS_H
  38. #define _LINUX_NILFS_FS_H
  39. #include <linux/types.h>
  40. #include <linux/ioctl.h>
  41. /*
  42. * Inode flags stored in nilfs_inode and on-memory nilfs inode
  43. *
  44. * We define these flags based on ext2-fs because of the
  45. * compatibility reason; to avoid problems in chattr(1)
  46. */
  47. #define NILFS_SECRM_FL 0x00000001 /* Secure deletion */
  48. #define NILFS_UNRM_FL 0x00000002 /* Undelete */
  49. #define NILFS_SYNC_FL 0x00000008 /* Synchronous updates */
  50. #define NILFS_IMMUTABLE_FL 0x00000010 /* Immutable file */
  51. #define NILFS_APPEND_FL 0x00000020 /* writes to file may only append */
  52. #define NILFS_NODUMP_FL 0x00000040 /* do not dump file */
  53. #define NILFS_NOATIME_FL 0x00000080 /* do not update atime */
  54. /* Reserved for compression usage... */
  55. #define NILFS_NOTAIL_FL 0x00008000 /* file tail should not be merged */
  56. #define NILFS_DIRSYNC_FL 0x00010000 /* dirsync behaviour */
  57. #define NILFS_FL_USER_VISIBLE 0x0003DFFF /* User visible flags */
  58. #define NILFS_FL_USER_MODIFIABLE 0x000380FF /* User modifiable flags */
  59. #define NILFS_INODE_BMAP_SIZE 7
  60. /**
  61. * struct nilfs_inode - structure of an inode on disk
  62. * @i_blocks: blocks count
  63. * @i_size: size in bytes
  64. * @i_ctime: creation time (seconds)
  65. * @i_mtime: modification time (seconds)
  66. * @i_ctime_nsec: creation time (nano seconds)
  67. * @i_mtime_nsec: modification time (nano seconds)
  68. * @i_uid: user id
  69. * @i_gid: group id
  70. * @i_mode: file mode
  71. * @i_links_count: links count
  72. * @i_flags: file flags
  73. * @i_bmap: block mapping
  74. * @i_xattr: extended attributes
  75. * @i_generation: file generation (for NFS)
  76. * @i_pad: padding
  77. */
  78. struct nilfs_inode {
  79. __le64 i_blocks;
  80. __le64 i_size;
  81. __le64 i_ctime;
  82. __le64 i_mtime;
  83. __le32 i_ctime_nsec;
  84. __le32 i_mtime_nsec;
  85. __le32 i_uid;
  86. __le32 i_gid;
  87. __le16 i_mode;
  88. __le16 i_links_count;
  89. __le32 i_flags;
  90. __le64 i_bmap[NILFS_INODE_BMAP_SIZE];
  91. #define i_device_code i_bmap[0]
  92. __le64 i_xattr;
  93. __le32 i_generation;
  94. __le32 i_pad;
  95. };
  96. /**
  97. * struct nilfs_super_root - structure of super root
  98. * @sr_sum: check sum
  99. * @sr_bytes: byte count of the structure
  100. * @sr_flags: flags (reserved)
  101. * @sr_nongc_ctime: write time of the last segment not for cleaner operation
  102. * @sr_dat: DAT file inode
  103. * @sr_cpfile: checkpoint file inode
  104. * @sr_sufile: segment usage file inode
  105. */
  106. struct nilfs_super_root {
  107. __le32 sr_sum;
  108. __le16 sr_bytes;
  109. __le16 sr_flags;
  110. __le64 sr_nongc_ctime;
  111. struct nilfs_inode sr_dat;
  112. struct nilfs_inode sr_cpfile;
  113. struct nilfs_inode sr_sufile;
  114. };
  115. #define NILFS_SR_MDT_OFFSET(inode_size, i) \
  116. ((unsigned long)&((struct nilfs_super_root *)0)->sr_dat + \
  117. (inode_size) * (i))
  118. #define NILFS_SR_DAT_OFFSET(inode_size) NILFS_SR_MDT_OFFSET(inode_size, 0)
  119. #define NILFS_SR_CPFILE_OFFSET(inode_size) NILFS_SR_MDT_OFFSET(inode_size, 1)
  120. #define NILFS_SR_SUFILE_OFFSET(inode_size) NILFS_SR_MDT_OFFSET(inode_size, 2)
  121. #define NILFS_SR_BYTES (sizeof(struct nilfs_super_root))
  122. /*
  123. * Maximal mount counts
  124. */
  125. #define NILFS_DFL_MAX_MNT_COUNT 50 /* 50 mounts */
  126. /*
  127. * File system states (sbp->s_state, nilfs->ns_mount_state)
  128. */
  129. #define NILFS_VALID_FS 0x0001 /* Unmounted cleanly */
  130. #define NILFS_ERROR_FS 0x0002 /* Errors detected */
  131. #define NILFS_RESIZE_FS 0x0004 /* Resize required */
  132. /*
  133. * Mount flags (sbi->s_mount_opt)
  134. */
  135. #define NILFS_MOUNT_ERROR_MODE 0x0070 /* Error mode mask */
  136. #define NILFS_MOUNT_ERRORS_CONT 0x0010 /* Continue on errors */
  137. #define NILFS_MOUNT_ERRORS_RO 0x0020 /* Remount fs ro on errors */
  138. #define NILFS_MOUNT_ERRORS_PANIC 0x0040 /* Panic on errors */
  139. #define NILFS_MOUNT_SNAPSHOT 0x0080 /* Snapshot flag */
  140. #define NILFS_MOUNT_BARRIER 0x1000 /* Use block barriers */
  141. #define NILFS_MOUNT_STRICT_ORDER 0x2000 /* Apply strict in-order
  142. semantics also for data */
  143. #define NILFS_MOUNT_NORECOVERY 0x4000 /* Disable write access during
  144. mount-time recovery */
  145. /**
  146. * struct nilfs_super_block - structure of super block on disk
  147. */
  148. struct nilfs_super_block {
  149. __le32 s_rev_level; /* Revision level */
  150. __le16 s_minor_rev_level; /* minor revision level */
  151. __le16 s_magic; /* Magic signature */
  152. __le16 s_bytes; /* Bytes count of CRC calculation
  153. for this structure. s_reserved
  154. is excluded. */
  155. __le16 s_flags; /* flags */
  156. __le32 s_crc_seed; /* Seed value of CRC calculation */
  157. __le32 s_sum; /* Check sum of super block */
  158. __le32 s_log_block_size; /* Block size represented as follows
  159. blocksize =
  160. 1 << (s_log_block_size + 10) */
  161. __le64 s_nsegments; /* Number of segments in filesystem */
  162. __le64 s_dev_size; /* block device size in bytes */
  163. __le64 s_first_data_block; /* 1st seg disk block number */
  164. __le32 s_blocks_per_segment; /* number of blocks per full segment */
  165. __le32 s_r_segments_percentage; /* Reserved segments percentage */
  166. __le64 s_last_cno; /* Last checkpoint number */
  167. __le64 s_last_pseg; /* disk block addr pseg written last */
  168. __le64 s_last_seq; /* seq. number of seg written last */
  169. __le64 s_free_blocks_count; /* Free blocks count */
  170. __le64 s_ctime; /* Creation time (execution time of
  171. newfs) */
  172. __le64 s_mtime; /* Mount time */
  173. __le64 s_wtime; /* Write time */
  174. __le16 s_mnt_count; /* Mount count */
  175. __le16 s_max_mnt_count; /* Maximal mount count */
  176. __le16 s_state; /* File system state */
  177. __le16 s_errors; /* Behaviour when detecting errors */
  178. __le64 s_lastcheck; /* time of last check */
  179. __le32 s_checkinterval; /* max. time between checks */
  180. __le32 s_creator_os; /* OS */
  181. __le16 s_def_resuid; /* Default uid for reserved blocks */
  182. __le16 s_def_resgid; /* Default gid for reserved blocks */
  183. __le32 s_first_ino; /* First non-reserved inode */
  184. __le16 s_inode_size; /* Size of an inode */
  185. __le16 s_dat_entry_size; /* Size of a dat entry */
  186. __le16 s_checkpoint_size; /* Size of a checkpoint */
  187. __le16 s_segment_usage_size; /* Size of a segment usage */
  188. __u8 s_uuid[16]; /* 128-bit uuid for volume */
  189. char s_volume_name[16]; /* volume name */
  190. char s_last_mounted[64]; /* directory where last mounted */
  191. __le32 s_c_interval; /* Commit interval of segment */
  192. __le32 s_c_block_max; /* Threshold of data amount for
  193. the segment construction */
  194. __u32 s_reserved[192]; /* padding to the end of the block */
  195. };
  196. /*
  197. * Codes for operating systems
  198. */
  199. #define NILFS_OS_LINUX 0
  200. /* Codes from 1 to 4 are reserved to keep compatibility with ext2 creator-OS */
  201. /*
  202. * Revision levels
  203. */
  204. #define NILFS_CURRENT_REV 2 /* current major revision */
  205. #define NILFS_MINOR_REV 0 /* minor revision */
  206. /*
  207. * Bytes count of super_block for CRC-calculation
  208. */
  209. #define NILFS_SB_BYTES \
  210. ((long)&((struct nilfs_super_block *)0)->s_reserved)
  211. /*
  212. * Special inode number
  213. */
  214. #define NILFS_ROOT_INO 2 /* Root file inode */
  215. #define NILFS_DAT_INO 3 /* DAT file */
  216. #define NILFS_CPFILE_INO 4 /* checkpoint file */
  217. #define NILFS_SUFILE_INO 5 /* segment usage file */
  218. #define NILFS_IFILE_INO 6 /* ifile */
  219. #define NILFS_ATIME_INO 7 /* Atime file (reserved) */
  220. #define NILFS_XATTR_INO 8 /* Xattribute file (reserved) */
  221. #define NILFS_SKETCH_INO 10 /* Sketch file */
  222. #define NILFS_USER_INO 11 /* Fisrt user's file inode number */
  223. #define NILFS_SB_OFFSET_BYTES 1024 /* byte offset of nilfs superblock */
  224. #define NILFS_SUPER_MAGIC 0x3434 /* NILFS filesystem magic number */
  225. #define NILFS_SEG_MIN_BLOCKS 16 /* Minimum number of blocks in
  226. a full segment */
  227. #define NILFS_PSEG_MIN_BLOCKS 2 /* Minimum number of blocks in
  228. a partial segment */
  229. #define NILFS_MIN_NRSVSEGS 8 /* Minimum number of reserved
  230. segments */
  231. /*
  232. * bytes offset of secondary super block
  233. */
  234. #define NILFS_SB2_OFFSET_BYTES(devsize) ((((devsize) >> 12) - 1) << 12)
  235. /*
  236. * Maximal count of links to a file
  237. */
  238. #define NILFS_LINK_MAX 32000
  239. /*
  240. * Structure of a directory entry
  241. * (Same as ext2)
  242. */
  243. #define NILFS_NAME_LEN 255
  244. /*
  245. * The new version of the directory entry. Since V0 structures are
  246. * stored in intel byte order, and the name_len field could never be
  247. * bigger than 255 chars, it's safe to reclaim the extra byte for the
  248. * file_type field.
  249. */
  250. struct nilfs_dir_entry {
  251. __le64 inode; /* Inode number */
  252. __le16 rec_len; /* Directory entry length */
  253. __u8 name_len; /* Name length */
  254. __u8 file_type;
  255. char name[NILFS_NAME_LEN]; /* File name */
  256. char pad;
  257. };
  258. /*
  259. * NILFS directory file types. Only the low 3 bits are used. The
  260. * other bits are reserved for now.
  261. */
  262. enum {
  263. NILFS_FT_UNKNOWN,
  264. NILFS_FT_REG_FILE,
  265. NILFS_FT_DIR,
  266. NILFS_FT_CHRDEV,
  267. NILFS_FT_BLKDEV,
  268. NILFS_FT_FIFO,
  269. NILFS_FT_SOCK,
  270. NILFS_FT_SYMLINK,
  271. NILFS_FT_MAX
  272. };
  273. /*
  274. * NILFS_DIR_PAD defines the directory entries boundaries
  275. *
  276. * NOTE: It must be a multiple of 8
  277. */
  278. #define NILFS_DIR_PAD 8
  279. #define NILFS_DIR_ROUND (NILFS_DIR_PAD - 1)
  280. #define NILFS_DIR_REC_LEN(name_len) (((name_len) + 12 + NILFS_DIR_ROUND) & \
  281. ~NILFS_DIR_ROUND)
  282. /**
  283. * struct nilfs_finfo - file information
  284. * @fi_ino: inode number
  285. * @fi_cno: checkpoint number
  286. * @fi_nblocks: number of blocks (including intermediate blocks)
  287. * @fi_ndatablk: number of file data blocks
  288. */
  289. struct nilfs_finfo {
  290. __le64 fi_ino;
  291. __le64 fi_cno;
  292. __le32 fi_nblocks;
  293. __le32 fi_ndatablk;
  294. /* array of virtual block numbers */
  295. };
  296. /**
  297. * struct nilfs_binfo_v - information for the block to which a virtual block number is assigned
  298. * @bi_vblocknr: virtual block number
  299. * @bi_blkoff: block offset
  300. */
  301. struct nilfs_binfo_v {
  302. __le64 bi_vblocknr;
  303. __le64 bi_blkoff;
  304. };
  305. /**
  306. * struct nilfs_binfo_dat - information for the block which belongs to the DAT file
  307. * @bi_blkoff: block offset
  308. * @bi_level: level
  309. * @bi_pad: padding
  310. */
  311. struct nilfs_binfo_dat {
  312. __le64 bi_blkoff;
  313. __u8 bi_level;
  314. __u8 bi_pad[7];
  315. };
  316. /**
  317. * union nilfs_binfo: block information
  318. * @bi_v: nilfs_binfo_v structure
  319. * @bi_dat: nilfs_binfo_dat structure
  320. */
  321. union nilfs_binfo {
  322. struct nilfs_binfo_v bi_v;
  323. struct nilfs_binfo_dat bi_dat;
  324. };
  325. /**
  326. * struct nilfs_segment_summary - segment summary
  327. * @ss_datasum: checksum of data
  328. * @ss_sumsum: checksum of segment summary
  329. * @ss_magic: magic number
  330. * @ss_bytes: size of this structure in bytes
  331. * @ss_flags: flags
  332. * @ss_seq: sequence number
  333. * @ss_create: creation timestamp
  334. * @ss_next: next segment
  335. * @ss_nblocks: number of blocks
  336. * @ss_nfinfo: number of finfo structures
  337. * @ss_sumbytes: total size of segment summary in bytes
  338. * @ss_pad: padding
  339. */
  340. struct nilfs_segment_summary {
  341. __le32 ss_datasum;
  342. __le32 ss_sumsum;
  343. __le32 ss_magic;
  344. __le16 ss_bytes;
  345. __le16 ss_flags;
  346. __le64 ss_seq;
  347. __le64 ss_create;
  348. __le64 ss_next;
  349. __le32 ss_nblocks;
  350. __le32 ss_nfinfo;
  351. __le32 ss_sumbytes;
  352. __le32 ss_pad;
  353. /* array of finfo structures */
  354. };
  355. #define NILFS_SEGSUM_MAGIC 0x1eaffa11 /* segment summary magic number */
  356. /*
  357. * Segment summary flags
  358. */
  359. #define NILFS_SS_LOGBGN 0x0001 /* begins a logical segment */
  360. #define NILFS_SS_LOGEND 0x0002 /* ends a logical segment */
  361. #define NILFS_SS_SR 0x0004 /* has super root */
  362. #define NILFS_SS_SYNDT 0x0008 /* includes data only updates */
  363. #define NILFS_SS_GC 0x0010 /* segment written for cleaner operation */
  364. /**
  365. * struct nilfs_btree_node - B-tree node
  366. * @bn_flags: flags
  367. * @bn_level: level
  368. * @bn_nchildren: number of children
  369. * @bn_pad: padding
  370. */
  371. struct nilfs_btree_node {
  372. __u8 bn_flags;
  373. __u8 bn_level;
  374. __le16 bn_nchildren;
  375. __le32 bn_pad;
  376. };
  377. /* flags */
  378. #define NILFS_BTREE_NODE_ROOT 0x01
  379. /* level */
  380. #define NILFS_BTREE_LEVEL_DATA 0
  381. #define NILFS_BTREE_LEVEL_NODE_MIN (NILFS_BTREE_LEVEL_DATA + 1)
  382. #define NILFS_BTREE_LEVEL_MAX 14
  383. /**
  384. * struct nilfs_palloc_group_desc - block group descriptor
  385. * @pg_nfrees: number of free entries in block group
  386. */
  387. struct nilfs_palloc_group_desc {
  388. __le32 pg_nfrees;
  389. };
  390. /**
  391. * struct nilfs_dat_entry - disk address translation entry
  392. * @dt_blocknr: block number
  393. * @dt_start: start checkpoint number
  394. * @dt_end: end checkpoint number
  395. * @dt_rsv: reserved for future use
  396. */
  397. struct nilfs_dat_entry {
  398. __le64 de_blocknr;
  399. __le64 de_start;
  400. __le64 de_end;
  401. __le64 de_rsv;
  402. };
  403. /**
  404. * struct nilfs_snapshot_list - snapshot list
  405. * @ssl_next: next checkpoint number on snapshot list
  406. * @ssl_prev: previous checkpoint number on snapshot list
  407. */
  408. struct nilfs_snapshot_list {
  409. __le64 ssl_next;
  410. __le64 ssl_prev;
  411. };
  412. /**
  413. * struct nilfs_checkpoint - checkpoint structure
  414. * @cp_flags: flags
  415. * @cp_checkpoints_count: checkpoints count in a block
  416. * @cp_snapshot_list: snapshot list
  417. * @cp_cno: checkpoint number
  418. * @cp_create: creation timestamp
  419. * @cp_nblk_inc: number of blocks incremented by this checkpoint
  420. * @cp_inodes_count: inodes count
  421. * @cp_blocks_count: blocks count
  422. * @cp_ifile_inode: inode of ifile
  423. */
  424. struct nilfs_checkpoint {
  425. __le32 cp_flags;
  426. __le32 cp_checkpoints_count;
  427. struct nilfs_snapshot_list cp_snapshot_list;
  428. __le64 cp_cno;
  429. __le64 cp_create;
  430. __le64 cp_nblk_inc;
  431. __le64 cp_inodes_count;
  432. __le64 cp_blocks_count; /* Reserved (might be deleted) */
  433. /* Do not change the byte offset of ifile inode.
  434. To keep the compatibility of the disk format,
  435. additional fields should be added behind cp_ifile_inode. */
  436. struct nilfs_inode cp_ifile_inode;
  437. };
  438. /* checkpoint flags */
  439. enum {
  440. NILFS_CHECKPOINT_SNAPSHOT,
  441. NILFS_CHECKPOINT_INVALID,
  442. NILFS_CHECKPOINT_SKETCH,
  443. NILFS_CHECKPOINT_MINOR,
  444. };
  445. #define NILFS_CHECKPOINT_FNS(flag, name) \
  446. static inline void \
  447. nilfs_checkpoint_set_##name(struct nilfs_checkpoint *cp) \
  448. { \
  449. cp->cp_flags = cpu_to_le32(le32_to_cpu(cp->cp_flags) | \
  450. (1UL << NILFS_CHECKPOINT_##flag)); \
  451. } \
  452. static inline void \
  453. nilfs_checkpoint_clear_##name(struct nilfs_checkpoint *cp) \
  454. { \
  455. cp->cp_flags = cpu_to_le32(le32_to_cpu(cp->cp_flags) & \
  456. ~(1UL << NILFS_CHECKPOINT_##flag)); \
  457. } \
  458. static inline int \
  459. nilfs_checkpoint_##name(const struct nilfs_checkpoint *cp) \
  460. { \
  461. return !!(le32_to_cpu(cp->cp_flags) & \
  462. (1UL << NILFS_CHECKPOINT_##flag)); \
  463. }
  464. NILFS_CHECKPOINT_FNS(SNAPSHOT, snapshot)
  465. NILFS_CHECKPOINT_FNS(INVALID, invalid)
  466. NILFS_CHECKPOINT_FNS(MINOR, minor)
  467. /**
  468. * struct nilfs_cpinfo - checkpoint information
  469. * @ci_flags: flags
  470. * @ci_pad: padding
  471. * @ci_cno: checkpoint number
  472. * @ci_create: creation timestamp
  473. * @ci_nblk_inc: number of blocks incremented by this checkpoint
  474. * @ci_inodes_count: inodes count
  475. * @ci_blocks_count: blocks count
  476. * @ci_next: next checkpoint number in snapshot list
  477. */
  478. struct nilfs_cpinfo {
  479. __u32 ci_flags;
  480. __u32 ci_pad;
  481. __u64 ci_cno;
  482. __u64 ci_create;
  483. __u64 ci_nblk_inc;
  484. __u64 ci_inodes_count;
  485. __u64 ci_blocks_count;
  486. __u64 ci_next;
  487. };
  488. #define NILFS_CPINFO_FNS(flag, name) \
  489. static inline int \
  490. nilfs_cpinfo_##name(const struct nilfs_cpinfo *cpinfo) \
  491. { \
  492. return !!(cpinfo->ci_flags & (1UL << NILFS_CHECKPOINT_##flag)); \
  493. }
  494. NILFS_CPINFO_FNS(SNAPSHOT, snapshot)
  495. NILFS_CPINFO_FNS(INVALID, invalid)
  496. NILFS_CPINFO_FNS(MINOR, minor)
  497. /**
  498. * struct nilfs_cpfile_header - checkpoint file header
  499. * @ch_ncheckpoints: number of checkpoints
  500. * @ch_nsnapshots: number of snapshots
  501. * @ch_snapshot_list: snapshot list
  502. */
  503. struct nilfs_cpfile_header {
  504. __le64 ch_ncheckpoints;
  505. __le64 ch_nsnapshots;
  506. struct nilfs_snapshot_list ch_snapshot_list;
  507. };
  508. #define NILFS_CPFILE_FIRST_CHECKPOINT_OFFSET \
  509. ((sizeof(struct nilfs_cpfile_header) + \
  510. sizeof(struct nilfs_checkpoint) - 1) / \
  511. sizeof(struct nilfs_checkpoint))
  512. /**
  513. * struct nilfs_segment_usage - segment usage
  514. * @su_lastmod: last modified timestamp
  515. * @su_nblocks: number of blocks in segment
  516. * @su_flags: flags
  517. */
  518. struct nilfs_segment_usage {
  519. __le64 su_lastmod;
  520. __le32 su_nblocks;
  521. __le32 su_flags;
  522. };
  523. /* segment usage flag */
  524. enum {
  525. NILFS_SEGMENT_USAGE_ACTIVE,
  526. NILFS_SEGMENT_USAGE_DIRTY,
  527. NILFS_SEGMENT_USAGE_ERROR,
  528. /* ... */
  529. };
  530. #define NILFS_SEGMENT_USAGE_FNS(flag, name) \
  531. static inline void \
  532. nilfs_segment_usage_set_##name(struct nilfs_segment_usage *su) \
  533. { \
  534. su->su_flags = cpu_to_le32(le32_to_cpu(su->su_flags) | \
  535. (1UL << NILFS_SEGMENT_USAGE_##flag));\
  536. } \
  537. static inline void \
  538. nilfs_segment_usage_clear_##name(struct nilfs_segment_usage *su) \
  539. { \
  540. su->su_flags = \
  541. cpu_to_le32(le32_to_cpu(su->su_flags) & \
  542. ~(1UL << NILFS_SEGMENT_USAGE_##flag)); \
  543. } \
  544. static inline int \
  545. nilfs_segment_usage_##name(const struct nilfs_segment_usage *su) \
  546. { \
  547. return !!(le32_to_cpu(su->su_flags) & \
  548. (1UL << NILFS_SEGMENT_USAGE_##flag)); \
  549. }
  550. NILFS_SEGMENT_USAGE_FNS(ACTIVE, active)
  551. NILFS_SEGMENT_USAGE_FNS(DIRTY, dirty)
  552. NILFS_SEGMENT_USAGE_FNS(ERROR, error)
  553. static inline void
  554. nilfs_segment_usage_set_clean(struct nilfs_segment_usage *su)
  555. {
  556. su->su_lastmod = cpu_to_le64(0);
  557. su->su_nblocks = cpu_to_le32(0);
  558. su->su_flags = cpu_to_le32(0);
  559. }
  560. static inline int
  561. nilfs_segment_usage_clean(const struct nilfs_segment_usage *su)
  562. {
  563. return !le32_to_cpu(su->su_flags);
  564. }
  565. /**
  566. * struct nilfs_sufile_header - segment usage file header
  567. * @sh_ncleansegs: number of clean segments
  568. * @sh_ndirtysegs: number of dirty segments
  569. * @sh_last_alloc: last allocated segment number
  570. */
  571. struct nilfs_sufile_header {
  572. __le64 sh_ncleansegs;
  573. __le64 sh_ndirtysegs;
  574. __le64 sh_last_alloc;
  575. /* ... */
  576. };
  577. #define NILFS_SUFILE_FIRST_SEGMENT_USAGE_OFFSET \
  578. ((sizeof(struct nilfs_sufile_header) + \
  579. sizeof(struct nilfs_segment_usage) - 1) / \
  580. sizeof(struct nilfs_segment_usage))
  581. /**
  582. * nilfs_suinfo - segment usage information
  583. * @sui_lastmod:
  584. * @sui_nblocks:
  585. * @sui_flags:
  586. */
  587. struct nilfs_suinfo {
  588. __u64 sui_lastmod;
  589. __u32 sui_nblocks;
  590. __u32 sui_flags;
  591. };
  592. #define NILFS_SUINFO_FNS(flag, name) \
  593. static inline int \
  594. nilfs_suinfo_##name(const struct nilfs_suinfo *si) \
  595. { \
  596. return si->sui_flags & (1UL << NILFS_SEGMENT_USAGE_##flag); \
  597. }
  598. NILFS_SUINFO_FNS(ACTIVE, active)
  599. NILFS_SUINFO_FNS(DIRTY, dirty)
  600. NILFS_SUINFO_FNS(ERROR, error)
  601. static inline int nilfs_suinfo_clean(const struct nilfs_suinfo *si)
  602. {
  603. return !si->sui_flags;
  604. }
  605. /* ioctl */
  606. enum {
  607. NILFS_CHECKPOINT,
  608. NILFS_SNAPSHOT,
  609. };
  610. /**
  611. * struct nilfs_cpmode -
  612. * @cc_cno:
  613. * @cc_mode:
  614. */
  615. struct nilfs_cpmode {
  616. __u64 cm_cno;
  617. __u32 cm_mode;
  618. __u32 cm_pad;
  619. };
  620. /**
  621. * struct nilfs_argv - argument vector
  622. * @v_base:
  623. * @v_nmembs:
  624. * @v_size:
  625. * @v_flags:
  626. * @v_index:
  627. */
  628. struct nilfs_argv {
  629. __u64 v_base;
  630. __u32 v_nmembs; /* number of members */
  631. __u16 v_size; /* size of members */
  632. __u16 v_flags;
  633. __u64 v_index;
  634. };
  635. /**
  636. * struct nilfs_period -
  637. * @p_start:
  638. * @p_end:
  639. */
  640. struct nilfs_period {
  641. __u64 p_start;
  642. __u64 p_end;
  643. };
  644. /**
  645. * struct nilfs_cpstat -
  646. * @cs_cno: checkpoint number
  647. * @cs_ncps: number of checkpoints
  648. * @cs_nsss: number of snapshots
  649. */
  650. struct nilfs_cpstat {
  651. __u64 cs_cno;
  652. __u64 cs_ncps;
  653. __u64 cs_nsss;
  654. };
  655. /**
  656. * struct nilfs_sustat -
  657. * @ss_nsegs: number of segments
  658. * @ss_ncleansegs: number of clean segments
  659. * @ss_ndirtysegs: number of dirty segments
  660. * @ss_ctime: creation time of the last segment
  661. * @ss_nongc_ctime: creation time of the last segment not for GC
  662. * @ss_prot_seq: least sequence number of segments which must not be reclaimed
  663. */
  664. struct nilfs_sustat {
  665. __u64 ss_nsegs;
  666. __u64 ss_ncleansegs;
  667. __u64 ss_ndirtysegs;
  668. __u64 ss_ctime;
  669. __u64 ss_nongc_ctime;
  670. __u64 ss_prot_seq;
  671. };
  672. /**
  673. * struct nilfs_vinfo - virtual block number information
  674. * @vi_vblocknr:
  675. * @vi_start:
  676. * @vi_end:
  677. * @vi_blocknr:
  678. */
  679. struct nilfs_vinfo {
  680. __u64 vi_vblocknr;
  681. __u64 vi_start;
  682. __u64 vi_end;
  683. __u64 vi_blocknr;
  684. };
  685. /**
  686. * struct nilfs_vdesc -
  687. */
  688. struct nilfs_vdesc {
  689. __u64 vd_ino;
  690. __u64 vd_cno;
  691. __u64 vd_vblocknr;
  692. struct nilfs_period vd_period;
  693. __u64 vd_blocknr;
  694. __u64 vd_offset;
  695. __u32 vd_flags;
  696. __u32 vd_pad;
  697. };
  698. /**
  699. * struct nilfs_bdesc -
  700. */
  701. struct nilfs_bdesc {
  702. __u64 bd_ino;
  703. __u64 bd_oblocknr;
  704. __u64 bd_blocknr;
  705. __u64 bd_offset;
  706. __u32 bd_level;
  707. __u32 bd_pad;
  708. };
  709. #define NILFS_IOCTL_IDENT 'n'
  710. #define NILFS_IOCTL_CHANGE_CPMODE \
  711. _IOW(NILFS_IOCTL_IDENT, 0x80, struct nilfs_cpmode)
  712. #define NILFS_IOCTL_DELETE_CHECKPOINT \
  713. _IOW(NILFS_IOCTL_IDENT, 0x81, __u64)
  714. #define NILFS_IOCTL_GET_CPINFO \
  715. _IOR(NILFS_IOCTL_IDENT, 0x82, struct nilfs_argv)
  716. #define NILFS_IOCTL_GET_CPSTAT \
  717. _IOR(NILFS_IOCTL_IDENT, 0x83, struct nilfs_cpstat)
  718. #define NILFS_IOCTL_GET_SUINFO \
  719. _IOR(NILFS_IOCTL_IDENT, 0x84, struct nilfs_argv)
  720. #define NILFS_IOCTL_GET_SUSTAT \
  721. _IOR(NILFS_IOCTL_IDENT, 0x85, struct nilfs_sustat)
  722. #define NILFS_IOCTL_GET_VINFO \
  723. _IOWR(NILFS_IOCTL_IDENT, 0x86, struct nilfs_argv)
  724. #define NILFS_IOCTL_GET_BDESCS \
  725. _IOWR(NILFS_IOCTL_IDENT, 0x87, struct nilfs_argv)
  726. #define NILFS_IOCTL_CLEAN_SEGMENTS \
  727. _IOW(NILFS_IOCTL_IDENT, 0x88, struct nilfs_argv[5])
  728. #define NILFS_IOCTL_SYNC \
  729. _IOR(NILFS_IOCTL_IDENT, 0x8A, __u64)
  730. #define NILFS_IOCTL_RESIZE \
  731. _IOW(NILFS_IOCTL_IDENT, 0x8B, __u64)
  732. #endif /* _LINUX_NILFS_FS_H */