nilfs2_fs.h 22 KB

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