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