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