blob: 3fe02cf8b65a3097785fd1543097b9cdadf3116e [file] [log] [blame]
Koji Satoeed10e32009-04-06 19:01:21 -07001/*
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
Ryusuke Konishi61239232009-04-06 19:02:00 -070070 * @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)
Koji Satoeed10e32009-04-06 19:01:21 -070074 * @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;
Ryusuke Konishi61239232009-04-06 19:02:00 -070089 __le32 i_ctime_nsec;
90 __le32 i_mtime_nsec;
Koji Satoeed10e32009-04-06 19:01:21 -070091 __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 */
Ryusuke Konishi02345762009-11-20 03:28:01 +0900154#define NILFS_MOUNT_NORECOVERY 0x4000 /* Disable write access during
155 mount-time recovery */
Koji Satoeed10e32009-04-06 19:01:21 -0700156
157
158/**
159 * struct nilfs_super_block - structure of super block on disk
160 */
161struct nilfs_super_block {
162 __le32 s_rev_level; /* Revision level */
163 __le16 s_minor_rev_level; /* minor revision level */
164 __le16 s_magic; /* Magic signature */
165
166 __le16 s_bytes; /* Bytes count of CRC calculation
167 for this structure. s_reserved
168 is excluded. */
169 __le16 s_flags; /* flags */
170 __le32 s_crc_seed; /* Seed value of CRC calculation */
171 __le32 s_sum; /* Check sum of super block */
172
173 __le32 s_log_block_size; /* Block size represented as follows
174 blocksize =
175 1 << (s_log_block_size + 10) */
176 __le64 s_nsegments; /* Number of segments in filesystem */
177 __le64 s_dev_size; /* block device size in bytes */
178 __le64 s_first_data_block; /* 1st seg disk block number */
179 __le32 s_blocks_per_segment; /* number of blocks per full segment */
180 __le32 s_r_segments_percentage; /* Reserved segments percentage */
181
182 __le64 s_last_cno; /* Last checkpoint number */
183 __le64 s_last_pseg; /* disk block addr pseg written last */
184 __le64 s_last_seq; /* seq. number of seg written last */
185 __le64 s_free_blocks_count; /* Free blocks count */
186
187 __le64 s_ctime; /* Creation time (execution time of
188 newfs) */
189 __le64 s_mtime; /* Mount time */
190 __le64 s_wtime; /* Write time */
191 __le16 s_mnt_count; /* Mount count */
192 __le16 s_max_mnt_count; /* Maximal mount count */
193 __le16 s_state; /* File system state */
194 __le16 s_errors; /* Behaviour when detecting errors */
195 __le64 s_lastcheck; /* time of last check */
196
197 __le32 s_checkinterval; /* max. time between checks */
198 __le32 s_creator_os; /* OS */
199 __le16 s_def_resuid; /* Default uid for reserved blocks */
200 __le16 s_def_resgid; /* Default gid for reserved blocks */
201 __le32 s_first_ino; /* First non-reserved inode */
202
203 __le16 s_inode_size; /* Size of an inode */
204 __le16 s_dat_entry_size; /* Size of a dat entry */
205 __le16 s_checkpoint_size; /* Size of a checkpoint */
206 __le16 s_segment_usage_size; /* Size of a segment usage */
207
208 __u8 s_uuid[16]; /* 128-bit uuid for volume */
209 char s_volume_name[16]; /* volume name */
210 char s_last_mounted[64]; /* directory where last mounted */
211
212 __le32 s_c_interval; /* Commit interval of segment */
213 __le32 s_c_block_max; /* Threshold of data amount for
214 the segment construction */
215 __u32 s_reserved[192]; /* padding to the end of the block */
216};
217
218/*
219 * Codes for operating systems
220 */
221#define NILFS_OS_LINUX 0
222/* Codes from 1 to 4 are reserved to keep compatibility with ext2 creator-OS */
223
224/*
225 * Revision levels
226 */
227#define NILFS_CURRENT_REV 2 /* current major revision */
228#define NILFS_MINOR_REV 0 /* minor revision */
229
230/*
231 * Bytes count of super_block for CRC-calculation
232 */
233#define NILFS_SB_BYTES \
234 ((long)&((struct nilfs_super_block *)0)->s_reserved)
235
236/*
237 * Special inode number
238 */
239#define NILFS_ROOT_INO 2 /* Root file inode */
240#define NILFS_DAT_INO 3 /* DAT file */
241#define NILFS_CPFILE_INO 4 /* checkpoint file */
242#define NILFS_SUFILE_INO 5 /* segment usage file */
243#define NILFS_IFILE_INO 6 /* ifile */
244#define NILFS_ATIME_INO 7 /* Atime file (reserved) */
245#define NILFS_XATTR_INO 8 /* Xattribute file (reserved) */
246#define NILFS_SKETCH_INO 10 /* Sketch file */
247#define NILFS_USER_INO 11 /* Fisrt user's file inode number */
248
249#define NILFS_SB_OFFSET_BYTES 1024 /* byte offset of nilfs superblock */
250#define NILFS_SUPER_MAGIC 0x3434 /* NILFS filesystem magic number */
251
252#define NILFS_SEG_MIN_BLOCKS 16 /* Minimum number of blocks in
253 a full segment */
254#define NILFS_PSEG_MIN_BLOCKS 2 /* Minimum number of blocks in
255 a partial segment */
256#define NILFS_MIN_NRSVSEGS 8 /* Minimum number of reserved
257 segments */
258
Ryusuke Konishie339ad32009-04-06 19:01:59 -0700259/*
260 * bytes offset of secondary super block
261 */
262#define NILFS_SB2_OFFSET_BYTES(devsize) ((((devsize) >> 12) - 1) << 12)
Koji Satoeed10e32009-04-06 19:01:21 -0700263
264/*
265 * Maximal count of links to a file
266 */
267#define NILFS_LINK_MAX 32000
268
269/*
270 * Structure of a directory entry
271 * (Same as ext2)
272 */
273
274#define NILFS_NAME_LEN 255
275
276/*
277 * The new version of the directory entry. Since V0 structures are
278 * stored in intel byte order, and the name_len field could never be
279 * bigger than 255 chars, it's safe to reclaim the extra byte for the
280 * file_type field.
281 */
282struct nilfs_dir_entry {
283 __le64 inode; /* Inode number */
284 __le16 rec_len; /* Directory entry length */
285 __u8 name_len; /* Name length */
286 __u8 file_type;
287 char name[NILFS_NAME_LEN]; /* File name */
288 char pad;
289};
290
291/*
292 * NILFS directory file types. Only the low 3 bits are used. The
293 * other bits are reserved for now.
294 */
295enum {
296 NILFS_FT_UNKNOWN,
297 NILFS_FT_REG_FILE,
298 NILFS_FT_DIR,
299 NILFS_FT_CHRDEV,
300 NILFS_FT_BLKDEV,
301 NILFS_FT_FIFO,
302 NILFS_FT_SOCK,
303 NILFS_FT_SYMLINK,
304 NILFS_FT_MAX
305};
306
307/*
308 * NILFS_DIR_PAD defines the directory entries boundaries
309 *
310 * NOTE: It must be a multiple of 8
311 */
312#define NILFS_DIR_PAD 8
313#define NILFS_DIR_ROUND (NILFS_DIR_PAD - 1)
314#define NILFS_DIR_REC_LEN(name_len) (((name_len) + 12 + NILFS_DIR_ROUND) & \
315 ~NILFS_DIR_ROUND)
316
317
318/**
319 * struct nilfs_finfo - file information
320 * @fi_ino: inode number
321 * @fi_cno: checkpoint number
322 * @fi_nblocks: number of blocks (including intermediate blocks)
323 * @fi_ndatablk: number of file data blocks
324 */
325struct nilfs_finfo {
326 __le64 fi_ino;
327 __le64 fi_cno;
328 __le32 fi_nblocks;
329 __le32 fi_ndatablk;
330 /* array of virtual block numbers */
331};
332
333/**
334 * struct nilfs_binfo_v - information for the block to which a virtual block number is assigned
335 * @bi_vblocknr: virtual block number
336 * @bi_blkoff: block offset
337 */
338struct nilfs_binfo_v {
339 __le64 bi_vblocknr;
340 __le64 bi_blkoff;
341};
342
343/**
344 * struct nilfs_binfo_dat - information for the block which belongs to the DAT file
345 * @bi_blkoff: block offset
346 * @bi_level: level
347 * @bi_pad: padding
348 */
349struct nilfs_binfo_dat {
350 __le64 bi_blkoff;
351 __u8 bi_level;
352 __u8 bi_pad[7];
353};
354
355/**
356 * union nilfs_binfo: block information
357 * @bi_v: nilfs_binfo_v structure
358 * @bi_dat: nilfs_binfo_dat structure
359 */
360union nilfs_binfo {
361 struct nilfs_binfo_v bi_v;
362 struct nilfs_binfo_dat bi_dat;
363};
364
365/**
366 * struct nilfs_segment_summary - segment summary
367 * @ss_datasum: checksum of data
368 * @ss_sumsum: checksum of segment summary
369 * @ss_magic: magic number
370 * @ss_bytes: size of this structure in bytes
371 * @ss_flags: flags
372 * @ss_seq: sequence number
373 * @ss_create: creation timestamp
374 * @ss_next: next segment
375 * @ss_nblocks: number of blocks
376 * @ss_nfinfo: number of finfo structures
377 * @ss_sumbytes: total size of segment summary in bytes
378 * @ss_pad: padding
379 */
380struct nilfs_segment_summary {
381 __le32 ss_datasum;
382 __le32 ss_sumsum;
383 __le32 ss_magic;
384 __le16 ss_bytes;
385 __le16 ss_flags;
386 __le64 ss_seq;
387 __le64 ss_create;
388 __le64 ss_next;
389 __le32 ss_nblocks;
390 __le32 ss_nfinfo;
391 __le32 ss_sumbytes;
392 __le32 ss_pad;
393 /* array of finfo structures */
394};
395
396#define NILFS_SEGSUM_MAGIC 0x1eaffa11 /* segment summary magic number */
397
398/*
399 * Segment summary flags
400 */
401#define NILFS_SS_LOGBGN 0x0001 /* begins a logical segment */
402#define NILFS_SS_LOGEND 0x0002 /* ends a logical segment */
403#define NILFS_SS_SR 0x0004 /* has super root */
404#define NILFS_SS_SYNDT 0x0008 /* includes data only updates */
405#define NILFS_SS_GC 0x0010 /* segment written for cleaner operation */
406
407/**
Jiro SEKIBA6600b9d2009-11-09 19:10:11 +0900408 * struct nilfs_btree_node - B-tree node
409 * @bn_flags: flags
410 * @bn_level: level
411 * @bn_nchildren: number of children
412 * @bn_pad: padding
413 */
414struct nilfs_btree_node {
415 __u8 bn_flags;
416 __u8 bn_level;
417 __le16 bn_nchildren;
418 __le32 bn_pad;
419};
420
421/* flags */
422#define NILFS_BTREE_NODE_ROOT 0x01
423
424/* level */
425#define NILFS_BTREE_LEVEL_DATA 0
426#define NILFS_BTREE_LEVEL_NODE_MIN (NILFS_BTREE_LEVEL_DATA + 1)
427#define NILFS_BTREE_LEVEL_MAX 14
428
429/**
Koji Satoeed10e32009-04-06 19:01:21 -0700430 * struct nilfs_palloc_group_desc - block group descriptor
431 * @pg_nfrees: number of free entries in block group
432 */
433struct nilfs_palloc_group_desc {
434 __le32 pg_nfrees;
435};
436
437/**
438 * struct nilfs_dat_entry - disk address translation entry
439 * @dt_blocknr: block number
440 * @dt_start: start checkpoint number
441 * @dt_end: end checkpoint number
442 * @dt_rsv: reserved for future use
443 */
444struct nilfs_dat_entry {
445 __le64 de_blocknr;
446 __le64 de_start;
447 __le64 de_end;
448 __le64 de_rsv;
449};
450
451/**
Koji Satoeed10e32009-04-06 19:01:21 -0700452 * struct nilfs_snapshot_list - snapshot list
453 * @ssl_next: next checkpoint number on snapshot list
454 * @ssl_prev: previous checkpoint number on snapshot list
455 */
456struct nilfs_snapshot_list {
457 __le64 ssl_next;
458 __le64 ssl_prev;
459};
460
461/**
462 * struct nilfs_checkpoint - checkpoint structure
463 * @cp_flags: flags
464 * @cp_checkpoints_count: checkpoints count in a block
465 * @cp_snapshot_list: snapshot list
466 * @cp_cno: checkpoint number
467 * @cp_create: creation timestamp
468 * @cp_nblk_inc: number of blocks incremented by this checkpoint
469 * @cp_inodes_count: inodes count
470 * @cp_blocks_count: blocks count
471 * @cp_ifile_inode: inode of ifile
472 */
473struct nilfs_checkpoint {
474 __le32 cp_flags;
475 __le32 cp_checkpoints_count;
476 struct nilfs_snapshot_list cp_snapshot_list;
477 __le64 cp_cno;
478 __le64 cp_create;
479 __le64 cp_nblk_inc;
480 __le64 cp_inodes_count;
481 __le64 cp_blocks_count; /* Reserved (might be deleted) */
482
483 /* Do not change the byte offset of ifile inode.
484 To keep the compatibility of the disk format,
485 additional fields should be added behind cp_ifile_inode. */
486 struct nilfs_inode cp_ifile_inode;
487};
488
489/* checkpoint flags */
490enum {
491 NILFS_CHECKPOINT_SNAPSHOT,
492 NILFS_CHECKPOINT_INVALID,
493 NILFS_CHECKPOINT_SKETCH,
Ryusuke Konishic96fa462009-04-06 19:01:57 -0700494 NILFS_CHECKPOINT_MINOR,
Koji Satoeed10e32009-04-06 19:01:21 -0700495};
496
497#define NILFS_CHECKPOINT_FNS(flag, name) \
498static inline void \
499nilfs_checkpoint_set_##name(struct nilfs_checkpoint *cp) \
500{ \
501 cp->cp_flags = cpu_to_le32(le32_to_cpu(cp->cp_flags) | \
502 (1UL << NILFS_CHECKPOINT_##flag)); \
503} \
504static inline void \
505nilfs_checkpoint_clear_##name(struct nilfs_checkpoint *cp) \
506{ \
507 cp->cp_flags = cpu_to_le32(le32_to_cpu(cp->cp_flags) & \
508 ~(1UL << NILFS_CHECKPOINT_##flag)); \
509} \
510static inline int \
511nilfs_checkpoint_##name(const struct nilfs_checkpoint *cp) \
512{ \
513 return !!(le32_to_cpu(cp->cp_flags) & \
514 (1UL << NILFS_CHECKPOINT_##flag)); \
515}
516
517NILFS_CHECKPOINT_FNS(SNAPSHOT, snapshot)
518NILFS_CHECKPOINT_FNS(INVALID, invalid)
Ryusuke Konishic96fa462009-04-06 19:01:57 -0700519NILFS_CHECKPOINT_FNS(MINOR, minor)
Koji Satoeed10e32009-04-06 19:01:21 -0700520
521/**
522 * struct nilfs_cpinfo - checkpoint information
523 * @ci_flags: flags
Ryusuke Konishidc498d02009-04-06 19:01:52 -0700524 * @ci_pad: padding
Koji Satoeed10e32009-04-06 19:01:21 -0700525 * @ci_cno: checkpoint number
526 * @ci_create: creation timestamp
527 * @ci_nblk_inc: number of blocks incremented by this checkpoint
528 * @ci_inodes_count: inodes count
529 * @ci_blocks_count: blocks count
530 * @ci_next: next checkpoint number in snapshot list
531 */
532struct nilfs_cpinfo {
533 __u32 ci_flags;
Ryusuke Konishidc498d02009-04-06 19:01:52 -0700534 __u32 ci_pad;
Koji Satoeed10e32009-04-06 19:01:21 -0700535 __u64 ci_cno;
536 __u64 ci_create;
537 __u64 ci_nblk_inc;
538 __u64 ci_inodes_count;
539 __u64 ci_blocks_count;
540 __u64 ci_next;
541};
542
543#define NILFS_CPINFO_FNS(flag, name) \
544static inline int \
545nilfs_cpinfo_##name(const struct nilfs_cpinfo *cpinfo) \
546{ \
547 return !!(cpinfo->ci_flags & (1UL << NILFS_CHECKPOINT_##flag)); \
548}
549
550NILFS_CPINFO_FNS(SNAPSHOT, snapshot)
551NILFS_CPINFO_FNS(INVALID, invalid)
Ryusuke Konishic96fa462009-04-06 19:01:57 -0700552NILFS_CPINFO_FNS(MINOR, minor)
Koji Satoeed10e32009-04-06 19:01:21 -0700553
554
555/**
556 * struct nilfs_cpfile_header - checkpoint file header
557 * @ch_ncheckpoints: number of checkpoints
558 * @ch_nsnapshots: number of snapshots
559 * @ch_snapshot_list: snapshot list
560 */
561struct nilfs_cpfile_header {
562 __le64 ch_ncheckpoints;
563 __le64 ch_nsnapshots;
564 struct nilfs_snapshot_list ch_snapshot_list;
565};
566
567#define NILFS_CPFILE_FIRST_CHECKPOINT_OFFSET \
568 ((sizeof(struct nilfs_cpfile_header) + \
569 sizeof(struct nilfs_checkpoint) - 1) / \
570 sizeof(struct nilfs_checkpoint))
571
572/**
573 * struct nilfs_segment_usage - segment usage
574 * @su_lastmod: last modified timestamp
575 * @su_nblocks: number of blocks in segment
576 * @su_flags: flags
577 */
578struct nilfs_segment_usage {
579 __le64 su_lastmod;
580 __le32 su_nblocks;
581 __le32 su_flags;
582};
583
584/* segment usage flag */
585enum {
586 NILFS_SEGMENT_USAGE_ACTIVE,
587 NILFS_SEGMENT_USAGE_DIRTY,
588 NILFS_SEGMENT_USAGE_ERROR,
589
Koji Satoeed10e32009-04-06 19:01:21 -0700590 /* ... */
591};
592
593#define NILFS_SEGMENT_USAGE_FNS(flag, name) \
594static inline void \
595nilfs_segment_usage_set_##name(struct nilfs_segment_usage *su) \
596{ \
597 su->su_flags = cpu_to_le32(le32_to_cpu(su->su_flags) | \
598 (1UL << NILFS_SEGMENT_USAGE_##flag));\
599} \
600static inline void \
601nilfs_segment_usage_clear_##name(struct nilfs_segment_usage *su) \
602{ \
603 su->su_flags = \
604 cpu_to_le32(le32_to_cpu(su->su_flags) & \
605 ~(1UL << NILFS_SEGMENT_USAGE_##flag)); \
606} \
607static inline int \
608nilfs_segment_usage_##name(const struct nilfs_segment_usage *su) \
609{ \
610 return !!(le32_to_cpu(su->su_flags) & \
611 (1UL << NILFS_SEGMENT_USAGE_##flag)); \
612}
613
614NILFS_SEGMENT_USAGE_FNS(ACTIVE, active)
615NILFS_SEGMENT_USAGE_FNS(DIRTY, dirty)
616NILFS_SEGMENT_USAGE_FNS(ERROR, error)
Koji Satoeed10e32009-04-06 19:01:21 -0700617
618static inline void
619nilfs_segment_usage_set_clean(struct nilfs_segment_usage *su)
620{
621 su->su_lastmod = cpu_to_le64(0);
622 su->su_nblocks = cpu_to_le32(0);
623 su->su_flags = cpu_to_le32(0);
624}
625
626static inline int
627nilfs_segment_usage_clean(const struct nilfs_segment_usage *su)
628{
629 return !le32_to_cpu(su->su_flags);
630}
631
632/**
633 * struct nilfs_sufile_header - segment usage file header
634 * @sh_ncleansegs: number of clean segments
635 * @sh_ndirtysegs: number of dirty segments
636 * @sh_last_alloc: last allocated segment number
637 */
638struct nilfs_sufile_header {
639 __le64 sh_ncleansegs;
640 __le64 sh_ndirtysegs;
641 __le64 sh_last_alloc;
642 /* ... */
643};
644
645#define NILFS_SUFILE_FIRST_SEGMENT_USAGE_OFFSET \
646 ((sizeof(struct nilfs_sufile_header) + \
647 sizeof(struct nilfs_segment_usage) - 1) / \
648 sizeof(struct nilfs_segment_usage))
649
650/**
651 * nilfs_suinfo - segment usage information
652 * @sui_lastmod:
653 * @sui_nblocks:
654 * @sui_flags:
655 */
656struct nilfs_suinfo {
657 __u64 sui_lastmod;
658 __u32 sui_nblocks;
659 __u32 sui_flags;
660};
661
662#define NILFS_SUINFO_FNS(flag, name) \
663static inline int \
664nilfs_suinfo_##name(const struct nilfs_suinfo *si) \
665{ \
666 return si->sui_flags & (1UL << NILFS_SEGMENT_USAGE_##flag); \
667}
668
669NILFS_SUINFO_FNS(ACTIVE, active)
670NILFS_SUINFO_FNS(DIRTY, dirty)
671NILFS_SUINFO_FNS(ERROR, error)
Koji Satoeed10e32009-04-06 19:01:21 -0700672
673static inline int nilfs_suinfo_clean(const struct nilfs_suinfo *si)
674{
675 return !si->sui_flags;
676}
677
678/* ioctl */
679enum {
680 NILFS_CHECKPOINT,
681 NILFS_SNAPSHOT,
682};
683
684/**
685 * struct nilfs_cpmode -
686 * @cc_cno:
687 * @cc_mode:
688 */
689struct nilfs_cpmode {
690 __u64 cm_cno;
Ryusuke Konishidc498d02009-04-06 19:01:52 -0700691 __u32 cm_mode;
692 __u32 cm_pad;
Koji Satoeed10e32009-04-06 19:01:21 -0700693};
694
695/**
696 * struct nilfs_argv - argument vector
697 * @v_base:
698 * @v_nmembs:
699 * @v_size:
Koji Satoeed10e32009-04-06 19:01:21 -0700700 * @v_flags:
Ryusuke Konishidc498d02009-04-06 19:01:52 -0700701 * @v_index:
Koji Satoeed10e32009-04-06 19:01:21 -0700702 */
703struct nilfs_argv {
Ryusuke Konishidc498d02009-04-06 19:01:52 -0700704 __u64 v_base;
705 __u32 v_nmembs; /* number of members */
706 __u16 v_size; /* size of members */
707 __u16 v_flags;
708 __u64 v_index;
Koji Satoeed10e32009-04-06 19:01:21 -0700709};
710
711/**
712 * struct nilfs_period -
713 * @p_start:
714 * @p_end:
715 */
716struct nilfs_period {
717 __u64 p_start;
718 __u64 p_end;
719};
720
721/**
722 * struct nilfs_cpstat -
723 * @cs_cno: checkpoint number
724 * @cs_ncps: number of checkpoints
725 * @cs_nsss: number of snapshots
726 */
727struct nilfs_cpstat {
728 __u64 cs_cno;
729 __u64 cs_ncps;
730 __u64 cs_nsss;
731};
732
733/**
734 * struct nilfs_sustat -
735 * @ss_nsegs: number of segments
736 * @ss_ncleansegs: number of clean segments
737 * @ss_ndirtysegs: number of dirty segments
Ryusuke Konishi2c2e52f2009-04-06 19:01:54 -0700738 * @ss_ctime: creation time of the last segment
739 * @ss_nongc_ctime: creation time of the last segment not for GC
740 * @ss_prot_seq: least sequence number of segments which must not be reclaimed
Koji Satoeed10e32009-04-06 19:01:21 -0700741 */
742struct nilfs_sustat {
743 __u64 ss_nsegs;
744 __u64 ss_ncleansegs;
745 __u64 ss_ndirtysegs;
Ryusuke Konishidc498d02009-04-06 19:01:52 -0700746 __u64 ss_ctime;
747 __u64 ss_nongc_ctime;
Ryusuke Konishi2c2e52f2009-04-06 19:01:54 -0700748 __u64 ss_prot_seq;
Koji Satoeed10e32009-04-06 19:01:21 -0700749};
750
751/**
752 * struct nilfs_vinfo - virtual block number information
753 * @vi_vblocknr:
754 * @vi_start:
755 * @vi_end:
756 * @vi_blocknr:
757 */
758struct nilfs_vinfo {
759 __u64 vi_vblocknr;
760 __u64 vi_start;
761 __u64 vi_end;
762 __u64 vi_blocknr;
763};
764
765/**
766 * struct nilfs_vdesc -
767 */
768struct nilfs_vdesc {
769 __u64 vd_ino;
770 __u64 vd_cno;
771 __u64 vd_vblocknr;
772 struct nilfs_period vd_period;
773 __u64 vd_blocknr;
774 __u64 vd_offset;
775 __u32 vd_flags;
Ryusuke Konishidc498d02009-04-06 19:01:52 -0700776 __u32 vd_pad;
Koji Satoeed10e32009-04-06 19:01:21 -0700777};
778
779/**
780 * struct nilfs_bdesc -
781 */
782struct nilfs_bdesc {
783 __u64 bd_ino;
784 __u64 bd_oblocknr;
785 __u64 bd_blocknr;
786 __u64 bd_offset;
787 __u32 bd_level;
Ryusuke Konishidc498d02009-04-06 19:01:52 -0700788 __u32 bd_pad;
Koji Satoeed10e32009-04-06 19:01:21 -0700789};
790
Koji Satoeed10e32009-04-06 19:01:21 -0700791#define NILFS_IOCTL_IDENT 'n'
792
793#define NILFS_IOCTL_CHANGE_CPMODE \
794 _IOW(NILFS_IOCTL_IDENT, 0x80, struct nilfs_cpmode)
795#define NILFS_IOCTL_DELETE_CHECKPOINT \
796 _IOW(NILFS_IOCTL_IDENT, 0x81, __u64)
797#define NILFS_IOCTL_GET_CPINFO \
798 _IOR(NILFS_IOCTL_IDENT, 0x82, struct nilfs_argv)
799#define NILFS_IOCTL_GET_CPSTAT \
800 _IOR(NILFS_IOCTL_IDENT, 0x83, struct nilfs_cpstat)
801#define NILFS_IOCTL_GET_SUINFO \
802 _IOR(NILFS_IOCTL_IDENT, 0x84, struct nilfs_argv)
803#define NILFS_IOCTL_GET_SUSTAT \
804 _IOR(NILFS_IOCTL_IDENT, 0x85, struct nilfs_sustat)
805#define NILFS_IOCTL_GET_VINFO \
806 _IOWR(NILFS_IOCTL_IDENT, 0x86, struct nilfs_argv)
807#define NILFS_IOCTL_GET_BDESCS \
808 _IOWR(NILFS_IOCTL_IDENT, 0x87, struct nilfs_argv)
809#define NILFS_IOCTL_CLEAN_SEGMENTS \
810 _IOW(NILFS_IOCTL_IDENT, 0x88, struct nilfs_argv[5])
Koji Satoeed10e32009-04-06 19:01:21 -0700811#define NILFS_IOCTL_SYNC \
812 _IOR(NILFS_IOCTL_IDENT, 0x8A, __u64)
813#define NILFS_IOCTL_RESIZE \
814 _IOW(NILFS_IOCTL_IDENT, 0x8B, __u64)
815
Koji Satoeed10e32009-04-06 19:01:21 -0700816#endif /* _LINUX_NILFS_FS_H */