1*e2be04c7SGreg Kroah-Hartman /* SPDX-License-Identifier: LGPL-2.1+ WITH Linux-syscall-note */
2e63e88bcSRyusuke Konishi /*
3e63e88bcSRyusuke Konishi * nilfs2_api.h - NILFS2 user space API
4e63e88bcSRyusuke Konishi *
5e63e88bcSRyusuke Konishi * Copyright (C) 2005-2008 Nippon Telegraph and Telephone Corporation.
6e63e88bcSRyusuke Konishi *
7e63e88bcSRyusuke Konishi * This program is free software; you can redistribute it and/or modify
8e63e88bcSRyusuke Konishi * it under the terms of the GNU Lesser General Public License as published
9e63e88bcSRyusuke Konishi * by the Free Software Foundation; either version 2.1 of the License, or
10e63e88bcSRyusuke Konishi * (at your option) any later version.
11e63e88bcSRyusuke Konishi */
12e63e88bcSRyusuke Konishi
13e63e88bcSRyusuke Konishi #ifndef _LINUX_NILFS2_API_H
14e63e88bcSRyusuke Konishi #define _LINUX_NILFS2_API_H
15e63e88bcSRyusuke Konishi
16e63e88bcSRyusuke Konishi #include <linux/types.h>
17e63e88bcSRyusuke Konishi #include <linux/ioctl.h>
18e63e88bcSRyusuke Konishi
19e63e88bcSRyusuke Konishi /**
20e63e88bcSRyusuke Konishi * struct nilfs_cpinfo - checkpoint information
21e63e88bcSRyusuke Konishi * @ci_flags: flags
22e63e88bcSRyusuke Konishi * @ci_pad: padding
23e63e88bcSRyusuke Konishi * @ci_cno: checkpoint number
24e63e88bcSRyusuke Konishi * @ci_create: creation timestamp
25e63e88bcSRyusuke Konishi * @ci_nblk_inc: number of blocks incremented by this checkpoint
26e63e88bcSRyusuke Konishi * @ci_inodes_count: inodes count
27e63e88bcSRyusuke Konishi * @ci_blocks_count: blocks count
28e63e88bcSRyusuke Konishi * @ci_next: next checkpoint number in snapshot list
29e63e88bcSRyusuke Konishi */
30e63e88bcSRyusuke Konishi struct nilfs_cpinfo {
31e63e88bcSRyusuke Konishi __u32 ci_flags;
32e63e88bcSRyusuke Konishi __u32 ci_pad;
33e63e88bcSRyusuke Konishi __u64 ci_cno;
34e63e88bcSRyusuke Konishi __u64 ci_create;
35e63e88bcSRyusuke Konishi __u64 ci_nblk_inc;
36e63e88bcSRyusuke Konishi __u64 ci_inodes_count;
37e63e88bcSRyusuke Konishi __u64 ci_blocks_count;
38e63e88bcSRyusuke Konishi __u64 ci_next;
39e63e88bcSRyusuke Konishi };
40e63e88bcSRyusuke Konishi
41e63e88bcSRyusuke Konishi /* checkpoint flags */
42e63e88bcSRyusuke Konishi enum {
43e63e88bcSRyusuke Konishi NILFS_CPINFO_SNAPSHOT,
44e63e88bcSRyusuke Konishi NILFS_CPINFO_INVALID,
45e63e88bcSRyusuke Konishi NILFS_CPINFO_SKETCH,
46e63e88bcSRyusuke Konishi NILFS_CPINFO_MINOR,
47e63e88bcSRyusuke Konishi };
48e63e88bcSRyusuke Konishi
49e63e88bcSRyusuke Konishi #define NILFS_CPINFO_FNS(flag, name) \
50e63e88bcSRyusuke Konishi static inline int \
51e63e88bcSRyusuke Konishi nilfs_cpinfo_##name(const struct nilfs_cpinfo *cpinfo) \
52e63e88bcSRyusuke Konishi { \
53e63e88bcSRyusuke Konishi return !!(cpinfo->ci_flags & (1UL << NILFS_CPINFO_##flag)); \
54e63e88bcSRyusuke Konishi }
55e63e88bcSRyusuke Konishi
56e63e88bcSRyusuke Konishi NILFS_CPINFO_FNS(SNAPSHOT, snapshot)
57e63e88bcSRyusuke Konishi NILFS_CPINFO_FNS(INVALID, invalid)
58e63e88bcSRyusuke Konishi NILFS_CPINFO_FNS(MINOR, minor)
59e63e88bcSRyusuke Konishi
60e63e88bcSRyusuke Konishi /**
61e63e88bcSRyusuke Konishi * nilfs_suinfo - segment usage information
62e63e88bcSRyusuke Konishi * @sui_lastmod: timestamp of last modification
63e63e88bcSRyusuke Konishi * @sui_nblocks: number of written blocks in segment
64e63e88bcSRyusuke Konishi * @sui_flags: segment usage flags
65e63e88bcSRyusuke Konishi */
66e63e88bcSRyusuke Konishi struct nilfs_suinfo {
67e63e88bcSRyusuke Konishi __u64 sui_lastmod;
68e63e88bcSRyusuke Konishi __u32 sui_nblocks;
69e63e88bcSRyusuke Konishi __u32 sui_flags;
70e63e88bcSRyusuke Konishi };
71e63e88bcSRyusuke Konishi
72e63e88bcSRyusuke Konishi /* segment usage flags */
73e63e88bcSRyusuke Konishi enum {
74e63e88bcSRyusuke Konishi NILFS_SUINFO_ACTIVE,
75e63e88bcSRyusuke Konishi NILFS_SUINFO_DIRTY,
76e63e88bcSRyusuke Konishi NILFS_SUINFO_ERROR,
77e63e88bcSRyusuke Konishi };
78e63e88bcSRyusuke Konishi
79e63e88bcSRyusuke Konishi #define NILFS_SUINFO_FNS(flag, name) \
80e63e88bcSRyusuke Konishi static inline int \
81e63e88bcSRyusuke Konishi nilfs_suinfo_##name(const struct nilfs_suinfo *si) \
82e63e88bcSRyusuke Konishi { \
83e63e88bcSRyusuke Konishi return si->sui_flags & (1UL << NILFS_SUINFO_##flag); \
84e63e88bcSRyusuke Konishi }
85e63e88bcSRyusuke Konishi
NILFS_SUINFO_FNS(ACTIVE,active)86e63e88bcSRyusuke Konishi NILFS_SUINFO_FNS(ACTIVE, active)
87e63e88bcSRyusuke Konishi NILFS_SUINFO_FNS(DIRTY, dirty)
88e63e88bcSRyusuke Konishi NILFS_SUINFO_FNS(ERROR, error)
89e63e88bcSRyusuke Konishi
90e63e88bcSRyusuke Konishi static inline int nilfs_suinfo_clean(const struct nilfs_suinfo *si)
91e63e88bcSRyusuke Konishi {
92e63e88bcSRyusuke Konishi return !si->sui_flags;
93e63e88bcSRyusuke Konishi }
94e63e88bcSRyusuke Konishi
95e63e88bcSRyusuke Konishi /**
96e63e88bcSRyusuke Konishi * nilfs_suinfo_update - segment usage information update
97e63e88bcSRyusuke Konishi * @sup_segnum: segment number
98e63e88bcSRyusuke Konishi * @sup_flags: flags for which fields are active in sup_sui
99e63e88bcSRyusuke Konishi * @sup_reserved: reserved necessary for alignment
100e63e88bcSRyusuke Konishi * @sup_sui: segment usage information
101e63e88bcSRyusuke Konishi */
102e63e88bcSRyusuke Konishi struct nilfs_suinfo_update {
103e63e88bcSRyusuke Konishi __u64 sup_segnum;
104e63e88bcSRyusuke Konishi __u32 sup_flags;
105e63e88bcSRyusuke Konishi __u32 sup_reserved;
106e63e88bcSRyusuke Konishi struct nilfs_suinfo sup_sui;
107e63e88bcSRyusuke Konishi };
108e63e88bcSRyusuke Konishi
109e63e88bcSRyusuke Konishi enum {
110e63e88bcSRyusuke Konishi NILFS_SUINFO_UPDATE_LASTMOD,
111e63e88bcSRyusuke Konishi NILFS_SUINFO_UPDATE_NBLOCKS,
112e63e88bcSRyusuke Konishi NILFS_SUINFO_UPDATE_FLAGS,
113e63e88bcSRyusuke Konishi __NR_NILFS_SUINFO_UPDATE_FIELDS,
114e63e88bcSRyusuke Konishi };
115e63e88bcSRyusuke Konishi
116e63e88bcSRyusuke Konishi #define NILFS_SUINFO_UPDATE_FNS(flag, name) \
117e63e88bcSRyusuke Konishi static inline void \
118e63e88bcSRyusuke Konishi nilfs_suinfo_update_set_##name(struct nilfs_suinfo_update *sup) \
119e63e88bcSRyusuke Konishi { \
120e63e88bcSRyusuke Konishi sup->sup_flags |= 1UL << NILFS_SUINFO_UPDATE_##flag; \
121e63e88bcSRyusuke Konishi } \
122e63e88bcSRyusuke Konishi static inline void \
123e63e88bcSRyusuke Konishi nilfs_suinfo_update_clear_##name(struct nilfs_suinfo_update *sup) \
124e63e88bcSRyusuke Konishi { \
125e63e88bcSRyusuke Konishi sup->sup_flags &= ~(1UL << NILFS_SUINFO_UPDATE_##flag); \
126e63e88bcSRyusuke Konishi } \
127e63e88bcSRyusuke Konishi static inline int \
128e63e88bcSRyusuke Konishi nilfs_suinfo_update_##name(const struct nilfs_suinfo_update *sup) \
129e63e88bcSRyusuke Konishi { \
130e63e88bcSRyusuke Konishi return !!(sup->sup_flags & (1UL << NILFS_SUINFO_UPDATE_##flag));\
131e63e88bcSRyusuke Konishi }
132e63e88bcSRyusuke Konishi
133e63e88bcSRyusuke Konishi NILFS_SUINFO_UPDATE_FNS(LASTMOD, lastmod)
134e63e88bcSRyusuke Konishi NILFS_SUINFO_UPDATE_FNS(NBLOCKS, nblocks)
135e63e88bcSRyusuke Konishi NILFS_SUINFO_UPDATE_FNS(FLAGS, flags)
136e63e88bcSRyusuke Konishi
137e63e88bcSRyusuke Konishi enum {
138e63e88bcSRyusuke Konishi NILFS_CHECKPOINT,
139e63e88bcSRyusuke Konishi NILFS_SNAPSHOT,
140e63e88bcSRyusuke Konishi };
141e63e88bcSRyusuke Konishi
142e63e88bcSRyusuke Konishi /**
143e63e88bcSRyusuke Konishi * struct nilfs_cpmode - change checkpoint mode structure
144e63e88bcSRyusuke Konishi * @cm_cno: checkpoint number
145e63e88bcSRyusuke Konishi * @cm_mode: mode of checkpoint
146e63e88bcSRyusuke Konishi * @cm_pad: padding
147e63e88bcSRyusuke Konishi */
148e63e88bcSRyusuke Konishi struct nilfs_cpmode {
149e63e88bcSRyusuke Konishi __u64 cm_cno;
150e63e88bcSRyusuke Konishi __u32 cm_mode;
151e63e88bcSRyusuke Konishi __u32 cm_pad;
152e63e88bcSRyusuke Konishi };
153e63e88bcSRyusuke Konishi
154e63e88bcSRyusuke Konishi /**
155e63e88bcSRyusuke Konishi * struct nilfs_argv - argument vector
156e63e88bcSRyusuke Konishi * @v_base: pointer on data array from userspace
157e63e88bcSRyusuke Konishi * @v_nmembs: number of members in data array
158e63e88bcSRyusuke Konishi * @v_size: size of data array in bytes
159e63e88bcSRyusuke Konishi * @v_flags: flags
160e63e88bcSRyusuke Konishi * @v_index: start number of target data items
161e63e88bcSRyusuke Konishi */
162e63e88bcSRyusuke Konishi struct nilfs_argv {
163e63e88bcSRyusuke Konishi __u64 v_base;
164e63e88bcSRyusuke Konishi __u32 v_nmembs; /* number of members */
165e63e88bcSRyusuke Konishi __u16 v_size; /* size of members */
166e63e88bcSRyusuke Konishi __u16 v_flags;
167e63e88bcSRyusuke Konishi __u64 v_index;
168e63e88bcSRyusuke Konishi };
169e63e88bcSRyusuke Konishi
170e63e88bcSRyusuke Konishi /**
171e63e88bcSRyusuke Konishi * struct nilfs_period - period of checkpoint numbers
172e63e88bcSRyusuke Konishi * @p_start: start checkpoint number (inclusive)
173e63e88bcSRyusuke Konishi * @p_end: end checkpoint number (exclusive)
174e63e88bcSRyusuke Konishi */
175e63e88bcSRyusuke Konishi struct nilfs_period {
176e63e88bcSRyusuke Konishi __u64 p_start;
177e63e88bcSRyusuke Konishi __u64 p_end;
178e63e88bcSRyusuke Konishi };
179e63e88bcSRyusuke Konishi
180e63e88bcSRyusuke Konishi /**
181e63e88bcSRyusuke Konishi * struct nilfs_cpstat - checkpoint statistics
182e63e88bcSRyusuke Konishi * @cs_cno: checkpoint number
183e63e88bcSRyusuke Konishi * @cs_ncps: number of checkpoints
184e63e88bcSRyusuke Konishi * @cs_nsss: number of snapshots
185e63e88bcSRyusuke Konishi */
186e63e88bcSRyusuke Konishi struct nilfs_cpstat {
187e63e88bcSRyusuke Konishi __u64 cs_cno;
188e63e88bcSRyusuke Konishi __u64 cs_ncps;
189e63e88bcSRyusuke Konishi __u64 cs_nsss;
190e63e88bcSRyusuke Konishi };
191e63e88bcSRyusuke Konishi
192e63e88bcSRyusuke Konishi /**
193e63e88bcSRyusuke Konishi * struct nilfs_sustat - segment usage statistics
194e63e88bcSRyusuke Konishi * @ss_nsegs: number of segments
195e63e88bcSRyusuke Konishi * @ss_ncleansegs: number of clean segments
196e63e88bcSRyusuke Konishi * @ss_ndirtysegs: number of dirty segments
197e63e88bcSRyusuke Konishi * @ss_ctime: creation time of the last segment
198e63e88bcSRyusuke Konishi * @ss_nongc_ctime: creation time of the last segment not for GC
199e63e88bcSRyusuke Konishi * @ss_prot_seq: least sequence number of segments which must not be reclaimed
200e63e88bcSRyusuke Konishi */
201e63e88bcSRyusuke Konishi struct nilfs_sustat {
202e63e88bcSRyusuke Konishi __u64 ss_nsegs;
203e63e88bcSRyusuke Konishi __u64 ss_ncleansegs;
204e63e88bcSRyusuke Konishi __u64 ss_ndirtysegs;
205e63e88bcSRyusuke Konishi __u64 ss_ctime;
206e63e88bcSRyusuke Konishi __u64 ss_nongc_ctime;
207e63e88bcSRyusuke Konishi __u64 ss_prot_seq;
208e63e88bcSRyusuke Konishi };
209e63e88bcSRyusuke Konishi
210e63e88bcSRyusuke Konishi /**
211e63e88bcSRyusuke Konishi * struct nilfs_vinfo - virtual block number information
212e63e88bcSRyusuke Konishi * @vi_vblocknr: virtual block number
213e63e88bcSRyusuke Konishi * @vi_start: start checkpoint number (inclusive)
214e63e88bcSRyusuke Konishi * @vi_end: end checkpoint number (exclusive)
215e63e88bcSRyusuke Konishi * @vi_blocknr: disk block number
216e63e88bcSRyusuke Konishi */
217e63e88bcSRyusuke Konishi struct nilfs_vinfo {
218e63e88bcSRyusuke Konishi __u64 vi_vblocknr;
219e63e88bcSRyusuke Konishi __u64 vi_start;
220e63e88bcSRyusuke Konishi __u64 vi_end;
221e63e88bcSRyusuke Konishi __u64 vi_blocknr;
222e63e88bcSRyusuke Konishi };
223e63e88bcSRyusuke Konishi
224e63e88bcSRyusuke Konishi /**
225e63e88bcSRyusuke Konishi * struct nilfs_vdesc - descriptor of virtual block number
226e63e88bcSRyusuke Konishi * @vd_ino: inode number
227e63e88bcSRyusuke Konishi * @vd_cno: checkpoint number
228e63e88bcSRyusuke Konishi * @vd_vblocknr: virtual block number
229e63e88bcSRyusuke Konishi * @vd_period: period of checkpoint numbers
230e63e88bcSRyusuke Konishi * @vd_blocknr: disk block number
231e63e88bcSRyusuke Konishi * @vd_offset: logical block offset inside a file
232e63e88bcSRyusuke Konishi * @vd_flags: flags (data or node block)
233e63e88bcSRyusuke Konishi * @vd_pad: padding
234e63e88bcSRyusuke Konishi */
235e63e88bcSRyusuke Konishi struct nilfs_vdesc {
236e63e88bcSRyusuke Konishi __u64 vd_ino;
237e63e88bcSRyusuke Konishi __u64 vd_cno;
238e63e88bcSRyusuke Konishi __u64 vd_vblocknr;
239e63e88bcSRyusuke Konishi struct nilfs_period vd_period;
240e63e88bcSRyusuke Konishi __u64 vd_blocknr;
241e63e88bcSRyusuke Konishi __u64 vd_offset;
242e63e88bcSRyusuke Konishi __u32 vd_flags;
243e63e88bcSRyusuke Konishi __u32 vd_pad;
244e63e88bcSRyusuke Konishi };
245e63e88bcSRyusuke Konishi
246e63e88bcSRyusuke Konishi /**
247e63e88bcSRyusuke Konishi * struct nilfs_bdesc - descriptor of disk block number
248e63e88bcSRyusuke Konishi * @bd_ino: inode number
249e63e88bcSRyusuke Konishi * @bd_oblocknr: disk block address (for skipping dead blocks)
250e63e88bcSRyusuke Konishi * @bd_blocknr: disk block address
251e63e88bcSRyusuke Konishi * @bd_offset: logical block offset inside a file
252e63e88bcSRyusuke Konishi * @bd_level: level in the b-tree organization
253e63e88bcSRyusuke Konishi * @bd_pad: padding
254e63e88bcSRyusuke Konishi */
255e63e88bcSRyusuke Konishi struct nilfs_bdesc {
256e63e88bcSRyusuke Konishi __u64 bd_ino;
257e63e88bcSRyusuke Konishi __u64 bd_oblocknr;
258e63e88bcSRyusuke Konishi __u64 bd_blocknr;
259e63e88bcSRyusuke Konishi __u64 bd_offset;
260e63e88bcSRyusuke Konishi __u32 bd_level;
261e63e88bcSRyusuke Konishi __u32 bd_pad;
262e63e88bcSRyusuke Konishi };
263e63e88bcSRyusuke Konishi
264e63e88bcSRyusuke Konishi #define NILFS_IOCTL_IDENT 'n'
265e63e88bcSRyusuke Konishi
266e63e88bcSRyusuke Konishi #define NILFS_IOCTL_CHANGE_CPMODE \
267e63e88bcSRyusuke Konishi _IOW(NILFS_IOCTL_IDENT, 0x80, struct nilfs_cpmode)
268e63e88bcSRyusuke Konishi #define NILFS_IOCTL_DELETE_CHECKPOINT \
269e63e88bcSRyusuke Konishi _IOW(NILFS_IOCTL_IDENT, 0x81, __u64)
270e63e88bcSRyusuke Konishi #define NILFS_IOCTL_GET_CPINFO \
271e63e88bcSRyusuke Konishi _IOR(NILFS_IOCTL_IDENT, 0x82, struct nilfs_argv)
272e63e88bcSRyusuke Konishi #define NILFS_IOCTL_GET_CPSTAT \
273e63e88bcSRyusuke Konishi _IOR(NILFS_IOCTL_IDENT, 0x83, struct nilfs_cpstat)
274e63e88bcSRyusuke Konishi #define NILFS_IOCTL_GET_SUINFO \
275e63e88bcSRyusuke Konishi _IOR(NILFS_IOCTL_IDENT, 0x84, struct nilfs_argv)
276e63e88bcSRyusuke Konishi #define NILFS_IOCTL_GET_SUSTAT \
277e63e88bcSRyusuke Konishi _IOR(NILFS_IOCTL_IDENT, 0x85, struct nilfs_sustat)
278e63e88bcSRyusuke Konishi #define NILFS_IOCTL_GET_VINFO \
279e63e88bcSRyusuke Konishi _IOWR(NILFS_IOCTL_IDENT, 0x86, struct nilfs_argv)
280e63e88bcSRyusuke Konishi #define NILFS_IOCTL_GET_BDESCS \
281e63e88bcSRyusuke Konishi _IOWR(NILFS_IOCTL_IDENT, 0x87, struct nilfs_argv)
282e63e88bcSRyusuke Konishi #define NILFS_IOCTL_CLEAN_SEGMENTS \
283e63e88bcSRyusuke Konishi _IOW(NILFS_IOCTL_IDENT, 0x88, struct nilfs_argv[5])
284e63e88bcSRyusuke Konishi #define NILFS_IOCTL_SYNC \
285e63e88bcSRyusuke Konishi _IOR(NILFS_IOCTL_IDENT, 0x8A, __u64)
286e63e88bcSRyusuke Konishi #define NILFS_IOCTL_RESIZE \
287e63e88bcSRyusuke Konishi _IOW(NILFS_IOCTL_IDENT, 0x8B, __u64)
288e63e88bcSRyusuke Konishi #define NILFS_IOCTL_SET_ALLOC_RANGE \
289e63e88bcSRyusuke Konishi _IOW(NILFS_IOCTL_IDENT, 0x8C, __u64[2])
290e63e88bcSRyusuke Konishi #define NILFS_IOCTL_SET_SUINFO \
291e63e88bcSRyusuke Konishi _IOW(NILFS_IOCTL_IDENT, 0x8D, struct nilfs_argv)
292e63e88bcSRyusuke Konishi
293e63e88bcSRyusuke Konishi #endif /* _LINUX_NILFS2_API_H */
294