HAMMER - Implement experimental volume removal
[dragonfly.git] / sys / vfs / hammer / hammer_ioctl.h
CommitLineData
7dc57964
MD
1/*
2 * Copyright (c) 2008 The DragonFly Project. All rights reserved.
3 *
4 * This code is derived from software contributed to The DragonFly Project
5 * by Matthew Dillon <dillon@backplane.com>
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 *
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
16 * distribution.
17 * 3. Neither the name of The DragonFly Project nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific, prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25 * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26 * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
27 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
29 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
31 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 * SUCH DAMAGE.
33 *
44a83111 34 * $DragonFly: src/sys/vfs/hammer/hammer_ioctl.h,v 1.23 2008/11/13 02:18:43 dillon Exp $
7dc57964
MD
35 */
36/*
37 * HAMMER ioctl's. This file can be #included from userland
38 */
39
40#ifndef VFS_HAMMER_IOCTL_H_
41#define VFS_HAMMER_IOCTL_H_
42
43#include <sys/types.h>
44#include <sys/ioccom.h>
45#include "hammer_disk.h"
46
47/*
19619882
MD
48 * Common HAMMER ioctl header
49 *
2f85fa4d 50 * Global flags are stored in the upper 16 bits.
19619882
MD
51 */
52struct hammer_ioc_head {
53 int32_t flags;
4c038e17 54 int32_t error;
19619882
MD
55 int32_t reserved02[4];
56};
57
4c038e17 58#define HAMMER_IOC_HEAD_ERROR 0x00008000
19619882 59#define HAMMER_IOC_HEAD_INTR 0x00010000
814387f6 60#define HAMMER_IOC_DO_BTREE 0x00020000 /* reblocker */
2f85fa4d 61#define HAMMER_IOC_DO_INODES 0x00040000 /* reblocker */
814387f6 62#define HAMMER_IOC_DO_DATA 0x00080000 /* reblocker */
bf3b416b 63#define HAMMER_IOC_DO_DIRS 0x00100000 /* reblocker */
814387f6 64
2f85fa4d
MD
65#define HAMMER_IOC_DO_FLAGS (HAMMER_IOC_DO_BTREE | \
66 HAMMER_IOC_DO_INODES | \
bf3b416b
MD
67 HAMMER_IOC_DO_DATA | \
68 HAMMER_IOC_DO_DIRS)
19619882
MD
69
70/*
7dc57964
MD
71 * HAMMERIOC_PRUNE
72 *
73 * beg/end TID ranges in the element array must be sorted in descending
74 * order, with the most recent (highest) range at elms[0].
75 */
76struct hammer_ioc_prune_elm {
77 hammer_tid_t beg_tid; /* starting tid */
78 hammer_tid_t end_tid; /* ending tid (non inclusive) */
79 hammer_tid_t mod_tid; /* modulo */
80};
81
f1785283 82#define HAMMER_MAX_PRUNE_ELMS (1024*1024/24)
7dc57964
MD
83
84struct hammer_ioc_prune {
19619882 85 struct hammer_ioc_head head;
7dc57964 86 int nelms;
19619882 87 int reserved01;
dd94f1b1
MD
88
89 struct hammer_base_elm key_beg; /* stop forward scan (reverse scan) */
90 struct hammer_base_elm key_end; /* start forward scan (reverse scan) */
91 struct hammer_base_elm key_cur; /* scan interruption point */
92
7dc57964
MD
93 int64_t stat_scanrecords;/* number of records scanned */
94 int64_t stat_rawrecords; /* number of raw records pruned */
95 int64_t stat_dirrecords; /* number of dir records pruned */
96 int64_t stat_bytes; /* number of data bytes pruned */
32c90105 97 int64_t stat_realignments; /* number of raw records realigned */
855942b6
MD
98 hammer_tid_t stat_oldest_tid; /* oldest create_tid encountered */
99 int64_t reserved02[6];
f1785283 100 struct hammer_ioc_prune_elm *elms; /* user supplied array */
7dc57964
MD
101};
102
42c7d26b
MD
103#define HAMMER_IOC_PRUNE_ALL 0x0001
104
797a0b63
MD
105/*
106 * HAMMERIOC_REPACK
107 *
108 * Forward scan leaf-up B-Tree packing. The saturation point is typically
109 * set to HAMMER_BTREE_LEAF_ELMS * 2 / 3 for 2/3rds fill. Referenced nodes
110 * have to be skipped, we can't track cursors through pack ops.
111 */
112struct hammer_ioc_rebalance {
113 struct hammer_ioc_head head;
114 int saturation; /* saturation pt elements/node */
115 int reserved02;
116
117 struct hammer_base_elm key_beg; /* start forward scan */
118 struct hammer_base_elm key_end; /* stop forward scan (inclusive) */
119 struct hammer_base_elm key_cur; /* current scan index */
120
121 int64_t stat_ncount; /* number of nodes scanned */
122 int64_t stat_deletions; /* number of nodes deleted */
7ddc70d1
MD
123 int64_t stat_collisions;/* number of collision retries */
124 int64_t stat_nrebal; /* number of btree-nodes rebalanced */
125 int64_t stat_unused04;
797a0b63 126};
42c7d26b 127
7dc57964
MD
128/*
129 * HAMMERIOC_GETHISTORY
130 *
131 * Retrieve an array of ordered transaction ids >= beg and < end indicating
132 * all changes made to the specified object's inode up to the
133 * maximum.
134 *
135 * If ATKEY is set the key field indicates a particular key within the
136 * inode to retrieve the history for.
137 *
138 * On return count is set to the number of elements returned, nxt_tid is
139 * set to the tid the caller should store in beg_tid to continue the
140 * iteration, and nxt_key is set to the nearest key boundary > key
141 * indicating the range key - nxt_key (nxt_key non-inclusive) the tid
142 * array represents. Also obj_id is set to the object's inode number.
143 *
144 * nxt_key can be used to iterate the contents of a single file but should
145 * not be stored in key until all modifications at key have been retrieved.
146 * To work properly nxt_key should be initialized to HAMMER_MAX_KEY.
147 * Successive ioctl() calls will reduce nxt_key as appropriate so at the
148 * end of your iterating for 'key', key to nxt_key will represent the
149 * shortest range of keys that all returned TIDs apply to.
150 */
151
152#define HAMMER_MAX_HISTORY_ELMS 64
153
dd94f1b1
MD
154typedef struct hammer_ioc_hist_entry {
155 hammer_tid_t tid;
156 u_int32_t time32;
157 u_int32_t unused;
158} *hammer_ioc_hist_entry_t;
159
7dc57964 160struct hammer_ioc_history {
19619882 161 struct hammer_ioc_head head;
7dc57964
MD
162 int64_t obj_id;
163 hammer_tid_t beg_tid;
164 hammer_tid_t nxt_tid;
165 hammer_tid_t end_tid;
166 int64_t key;
167 int64_t nxt_key;
168 int count;
19619882 169 int reserve01;
dd94f1b1 170 struct hammer_ioc_hist_entry hist_ary[HAMMER_MAX_HISTORY_ELMS];
7dc57964
MD
171};
172
173#define HAMMER_IOC_HISTORY_ATKEY 0x0001
174#define HAMMER_IOC_HISTORY_NEXT_TID 0x0002 /* iterate via nxt_tid */
175#define HAMMER_IOC_HISTORY_NEXT_KEY 0x0004 /* iterate via nxt_key */
176#define HAMMER_IOC_HISTORY_EOF 0x0008 /* no more keys */
177#define HAMMER_IOC_HISTORY_UNSYNCED 0x0010 /* unsynced info in inode */
178
bf686dbe
MD
179/*
180 * Reblock request
181 */
182struct hammer_ioc_reblock {
19619882 183 struct hammer_ioc_head head;
2f85fa4d
MD
184 int32_t free_level; /* 0 for maximum compaction */
185 u_int32_t reserved01;
186
dd94f1b1
MD
187 struct hammer_base_elm key_beg; /* start forward scan */
188 struct hammer_base_elm key_end; /* stop forward scan */
189 struct hammer_base_elm key_cur; /* scan interruption point */
bf686dbe
MD
190
191 int64_t btree_count; /* B-Tree nodes checked */
192 int64_t record_count; /* Records checked */
193 int64_t data_count; /* Data segments checked */
194 int64_t data_byte_count; /* Data bytes checked */
195
196 int64_t btree_moves; /* B-Tree nodes moved */
197 int64_t record_moves; /* Records moved */
198 int64_t data_moves; /* Data segments moved */
199 int64_t data_byte_moves; /* Data bytes moved */
200
19619882
MD
201 int32_t unused02;
202 int32_t unused03;
bf686dbe
MD
203};
204
f36a9737 205/*
dd94f1b1 206 * HAMMERIOC_SYNCTID
f36a9737
MD
207 */
208enum hammer_synctid_op {
209 HAMMER_SYNCTID_NONE, /* no sync (TID will not be accurate) */
210 HAMMER_SYNCTID_ASYNC, /* async (TID will not be accurate) */
211 HAMMER_SYNCTID_SYNC1, /* single sync - might undo after crash */
212 HAMMER_SYNCTID_SYNC2 /* double sync - guarantee no undo */
213};
214
215struct hammer_ioc_synctid {
216 struct hammer_ioc_head head;
217 enum hammer_synctid_op op;
218 hammer_tid_t tid;
219};
220
5a930e66 221/*
b66b9421
AH
222 * HAMMERIOC_GET_INFO
223 */
224struct hammer_ioc_info {
225 struct hammer_ioc_head head;
226
227 char vol_name[64];
228 uuid_t vol_fsid;
229 uuid_t vol_fstype;
230
231 int version;
232 int nvolumes;
233 int reserved01;
234 int reserved02;
235
236 int64_t bigblocks;
237 int64_t freebigblocks;
238 int64_t rsvbigblocks;
239 int64_t inodes;
240
241 int64_t reservedext[16];
242};
243
244/*
dd94f1b1 245 * HAMMERIOC_GET_PSEUDOFS
5fa5c92f 246 * HAMMERIOC_SET_PSEUDOFS
5a930e66 247 */
5fa5c92f 248struct hammer_ioc_pseudofs_rw {
5a930e66 249 struct hammer_ioc_head head;
ea434b6f 250 int pfs_id;
5fa5c92f
MD
251 u_int32_t bytes;
252 u_int32_t version;
253 u_int32_t flags;
254 struct hammer_pseudofs_data *ondisk;
5a930e66
MD
255};
256
5fa5c92f
MD
257#define HAMMER_IOC_PSEUDOFS_VERSION 1
258
259#define HAMMER_IOC_PFS_SYNC_BEG 0x0001
260#define HAMMER_IOC_PFS_SYNC_END 0x0002
261#define HAMMER_IOC_PFS_SHARED_UUID 0x0004
262#define HAMMER_IOC_PFS_MIRROR_UUID 0x0008
263#define HAMMER_IOC_PFS_MASTER_ID 0x0010
264#define HAMMER_IOC_PFS_MIRROR_FLAGS 0x0020
265#define HAMMER_IOC_PFS_LABEL 0x0040
266
ea434b6f
MD
267#define HAMMER_MAX_PFS 65536
268
dd94f1b1
MD
269/*
270 * HAMMERIOC_MIRROR_READ/WRITE
271 */
272struct hammer_ioc_mirror_rw {
273 struct hammer_ioc_head head;
274 struct hammer_base_elm key_beg; /* start forward scan */
275 struct hammer_base_elm key_end; /* stop forward scan */
276 struct hammer_base_elm key_cur; /* interruption point */
277 hammer_tid_t tid_beg; /* filter modification range */
278 hammer_tid_t tid_end; /* filter modification range */
279 void *ubuf; /* user buffer */
280 int count; /* current size */
281 int size; /* max size */
ea434b6f
MD
282 int pfs_id; /* PFS id being read/written */
283 int reserved01;
284 uuid_t shared_uuid; /* validator for safety */
dd94f1b1
MD
285};
286
c82af904
MD
287/*
288 * NOTE: crc is for the data block starting at rec_size, not including the
289 * data[] array.
290 */
4c038e17 291struct hammer_ioc_mrecord_head {
dd94f1b1 292 u_int32_t signature; /* signature for byte order */
c82af904 293 u_int32_t rec_crc;
dd94f1b1 294 u_int32_t rec_size;
5fa5c92f 295 u_int32_t type;
4c038e17
MD
296 /* extended */
297};
298
299typedef struct hammer_ioc_mrecord_head *hammer_ioc_mrecord_head_t;
300
301struct hammer_ioc_mrecord_rec {
302 struct hammer_ioc_mrecord_head head;
303 struct hammer_btree_leaf_elm leaf;
5fa5c92f 304 /* extended by data */
4c038e17 305};
dd94f1b1 306
4c038e17
MD
307struct hammer_ioc_mrecord_skip {
308 struct hammer_ioc_mrecord_head head;
309 struct hammer_base_elm skip_beg;
310 struct hammer_base_elm skip_end;
311};
312
313struct hammer_ioc_mrecord_update {
314 struct hammer_ioc_mrecord_head head;
315 hammer_tid_t tid;
316};
5fa5c92f 317
4c038e17
MD
318struct hammer_ioc_mrecord_sync {
319 struct hammer_ioc_mrecord_head head;
320};
321
322struct hammer_ioc_mrecord_pfs {
323 struct hammer_ioc_mrecord_head head;
324 u_int32_t version;
325 u_int32_t reserved01;
326 struct hammer_pseudofs_data pfsd;
327};
328
44a83111
MD
329struct hammer_ioc_version {
330 struct hammer_ioc_head head;
331 u_int32_t cur_version;
332 u_int32_t min_version;
333 u_int32_t wip_version;
334 u_int32_t max_version;
335 char description[64];
336};
337
865c9609 338struct hammer_ioc_volume {
e27700cf
MN
339 struct hammer_ioc_head head;
340 char device_name[MAXPATHLEN];
90ecab35
MN
341 int64_t vol_size;
342 int64_t boot_area_size;
343 int64_t mem_area_size;
e27700cf
MN
344};
345
4c038e17
MD
346union hammer_ioc_mrecord_any {
347 struct hammer_ioc_mrecord_head head;
348 struct hammer_ioc_mrecord_rec rec;
349 struct hammer_ioc_mrecord_skip skip;
350 struct hammer_ioc_mrecord_update update;
351 struct hammer_ioc_mrecord_update sync;
352 struct hammer_ioc_mrecord_pfs pfs;
44a83111 353 struct hammer_ioc_version version;
4c038e17
MD
354};
355
356typedef union hammer_ioc_mrecord_any *hammer_ioc_mrecord_any_t;
357
4c286c36
MD
358/*
359 * MREC types. Flags are in the upper 16 bits but some are also included
360 * in the type mask to force them into any switch() on the type.
361 *
362 * NOTE: Any record whos data is CRC-errored will have HAMMER_MRECF_CRC set,
363 * and the bit is also part of the type mask.
364 */
4c038e17
MD
365#define HAMMER_MREC_TYPE_RESERVED 0
366#define HAMMER_MREC_TYPE_REC 1 /* record w/ data */
367#define HAMMER_MREC_TYPE_PFSD 2 /* (userland only) */
368#define HAMMER_MREC_TYPE_UPDATE 3 /* (userland only) */
369#define HAMMER_MREC_TYPE_SYNC 4 /* (userland only) */
370#define HAMMER_MREC_TYPE_SKIP 5 /* skip-range */
371#define HAMMER_MREC_TYPE_PASS 6 /* record for cmp only (pass) */
7a61b85d 372#define HAMMER_MREC_TYPE_TERM 7 /* (userland only) */
4889cbd4 373#define HAMMER_MREC_TYPE_IDLE 8 /* (userland only) */
4c038e17 374
4c286c36
MD
375#define HAMMER_MREC_TYPE_REC_BADCRC (HAMMER_MREC_TYPE_REC | \
376 HAMMER_MRECF_CRC_ERROR)
377
378#define HAMMER_MRECF_TYPE_LOMASK 0x000000FF
379#define HAMMER_MRECF_TYPE_MASK 0x800000FF
380#define HAMMER_MRECF_CRC_ERROR 0x80000000
381
382#define HAMMER_MRECF_DATA_CRC_BAD 0x40000000
383#define HAMMER_MRECF_RECD_CRC_BAD 0x20000000
384
4c038e17
MD
385#define HAMMER_MREC_CRCOFF (offsetof(struct hammer_ioc_mrecord_head, rec_size))
386#define HAMMER_MREC_HEADSIZE sizeof(struct hammer_ioc_mrecord_head)
c82af904 387
dd94f1b1
MD
388#define HAMMER_IOC_MIRROR_SIGNATURE 0x4dd97272U
389#define HAMMER_IOC_MIRROR_SIGNATURE_REV 0x7272d94dU
390
391/*
83f2a3aa
MD
392 * HAMMERIOC_ADD_SNAPSHOT - Add snapshot tid(s).
393 * HAMMERIOC_DEL_SNAPSHOT - Delete snapshot tids.
394 * HAMMERIOC_GET_SNAPSHOT - Get/continue retrieving snapshot tids.
395 * (finds restart point based on last snaps[] entry)
396 *
397 * These are per-PFS operations.
398 *
399 * NOTE: There is no limit on the number of snapshots, but there is a limit
400 * on how many can be set or returned in each ioctl.
401 *
402 * NOTE: ADD and DEL start at snap->index. If an error occurs the index will
403 * point at the errored record. snap->index must be set to 0 for GET.
404 */
405#define HAMMER_SNAPS_PER_IOCTL 16
406
407#define HAMMER_IOC_SNAPSHOT_EOF 0x0008 /* no more keys */
408
409struct hammer_ioc_snapshot {
410 struct hammer_ioc_head head;
411 int unused01;
412 u_int32_t index;
413 u_int32_t count;
414 struct hammer_snapshot_data snaps[HAMMER_SNAPS_PER_IOCTL];
415};
416
417/*
418 * HAMMERIOC_GET_CONFIG
419 * HAMMERIOC_SET_CONFIG
420 *
421 * The configuration space is a freeform nul-terminated string, typically
422 * a text file. It is per-PFS and used by the 'hammer cleanup' utility.
423 *
424 * The configuration space is NOT mirrored. mirror-write will ignore
425 * configuration space records.
dd94f1b1 426 */
83f2a3aa
MD
427struct hammer_ioc_config {
428 struct hammer_ioc_head head;
429 u_int32_t reserved01;
430 u_int32_t reserved02;
431 u_int64_t reserved03[4];
432 struct hammer_config_data config;
433};
f36a9737 434
83f2a3aa
MD
435/*
436 * Ioctl cmd ids
437 */
7dc57964
MD
438#define HAMMERIOC_PRUNE _IOWR('h',1,struct hammer_ioc_prune)
439#define HAMMERIOC_GETHISTORY _IOWR('h',2,struct hammer_ioc_history)
bf686dbe 440#define HAMMERIOC_REBLOCK _IOWR('h',3,struct hammer_ioc_reblock)
f36a9737 441#define HAMMERIOC_SYNCTID _IOWR('h',4,struct hammer_ioc_synctid)
5fa5c92f
MD
442#define HAMMERIOC_SET_PSEUDOFS _IOWR('h',5,struct hammer_ioc_pseudofs_rw)
443#define HAMMERIOC_GET_PSEUDOFS _IOWR('h',6,struct hammer_ioc_pseudofs_rw)
dd94f1b1
MD
444#define HAMMERIOC_MIRROR_READ _IOWR('h',7,struct hammer_ioc_mirror_rw)
445#define HAMMERIOC_MIRROR_WRITE _IOWR('h',8,struct hammer_ioc_mirror_rw)
842e7a70
MD
446#define HAMMERIOC_UPG_PSEUDOFS _IOWR('h',9,struct hammer_ioc_pseudofs_rw)
447#define HAMMERIOC_DGD_PSEUDOFS _IOWR('h',10,struct hammer_ioc_pseudofs_rw)
448#define HAMMERIOC_RMR_PSEUDOFS _IOWR('h',11,struct hammer_ioc_pseudofs_rw)
4889cbd4 449#define HAMMERIOC_WAI_PSEUDOFS _IOWR('h',12,struct hammer_ioc_pseudofs_rw)
44a83111
MD
450#define HAMMERIOC_GET_VERSION _IOWR('h',13,struct hammer_ioc_version)
451#define HAMMERIOC_SET_VERSION _IOWR('h',14,struct hammer_ioc_version)
797a0b63 452#define HAMMERIOC_REBALANCE _IOWR('h',15,struct hammer_ioc_rebalance)
b66b9421 453#define HAMMERIOC_GET_INFO _IOR('h',16,struct hammer_ioc_info)
865c9609 454#define HAMMERIOC_ADD_VOLUME _IOWR('h',17,struct hammer_ioc_volume)
83f2a3aa
MD
455#define HAMMERIOC_ADD_SNAPSHOT _IOWR('h',18,struct hammer_ioc_snapshot)
456#define HAMMERIOC_DEL_SNAPSHOT _IOWR('h',19,struct hammer_ioc_snapshot)
457#define HAMMERIOC_GET_SNAPSHOT _IOWR('h',20,struct hammer_ioc_snapshot)
458#define HAMMERIOC_GET_CONFIG _IOWR('h',21,struct hammer_ioc_config)
459#define HAMMERIOC_SET_CONFIG _IOWR('h',22,struct hammer_ioc_config)
865c9609 460#define HAMMERIOC_DEL_VOLUME _IOWR('h',24,struct hammer_ioc_volume)
7dc57964
MD
461
462#endif
5fa5c92f 463