pnpinfo(8): Oops, add missing semicolons.
[dragonfly.git] / sys / vfs / hammer / hammer_ioctl.h
blob46eaa8f4bedc61f1474056e1686c31f88a7dc1e7
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:
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.
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.
34 * $DragonFly: src/sys/vfs/hammer/hammer_ioctl.h,v 1.23 2008/11/13 02:18:43 dillon Exp $
37 * HAMMER ioctl's. This file can be #included from userland
40 #ifndef VFS_HAMMER_IOCTL_H_
41 #define VFS_HAMMER_IOCTL_H_
43 #include <sys/types.h>
44 #include <sys/ioccom.h>
45 #include "hammer_disk.h"
48 * Common HAMMER ioctl header
50 * Global flags are stored in the upper 16 bits.
52 struct hammer_ioc_head {
53 int32_t flags;
54 int32_t error;
55 int32_t reserved02[4];
58 #define HAMMER_IOC_HEAD_ERROR 0x00008000
59 #define HAMMER_IOC_HEAD_INTR 0x00010000
60 #define HAMMER_IOC_DO_BTREE 0x00020000 /* reblocker */
61 #define HAMMER_IOC_DO_INODES 0x00040000 /* reblocker */
62 #define HAMMER_IOC_DO_DATA 0x00080000 /* reblocker */
63 #define HAMMER_IOC_DO_DIRS 0x00100000 /* reblocker */
65 #define HAMMER_IOC_DO_FLAGS (HAMMER_IOC_DO_BTREE | \
66 HAMMER_IOC_DO_INODES | \
67 HAMMER_IOC_DO_DATA | \
68 HAMMER_IOC_DO_DIRS)
71 * HAMMERIOC_PRUNE
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].
76 struct 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 */
82 #define HAMMER_MAX_PRUNE_ELMS (1024*1024/24)
84 struct hammer_ioc_prune {
85 struct hammer_ioc_head head;
86 int nelms;
87 int reserved01;
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 */
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 */
97 int64_t stat_realignments; /* number of raw records realigned */
98 hammer_tid_t stat_oldest_tid; /* oldest create_tid encountered */
99 int64_t reserved02[6];
100 struct hammer_ioc_prune_elm *elms; /* user supplied array */
103 #define HAMMER_IOC_PRUNE_ALL 0x0001
106 * HAMMERIOC_REPACK
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.
112 struct hammer_ioc_rebalance {
113 struct hammer_ioc_head head;
114 int saturation; /* saturation pt elements/node */
115 int reserved02;
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 */
121 int64_t stat_ncount; /* number of nodes scanned */
122 int64_t stat_deletions; /* number of nodes deleted */
123 int64_t stat_collisions;/* number of collision retries */
124 int64_t stat_nrebal; /* number of btree-nodes rebalanced */
125 int64_t stat_unused04;
129 * HAMMERIOC_GETHISTORY
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.
135 * If ATKEY is set the key field indicates a particular key within the
136 * inode to retrieve the history for.
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.
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.
152 #define HAMMER_MAX_HISTORY_ELMS 64
154 typedef 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;
160 struct hammer_ioc_history {
161 struct hammer_ioc_head head;
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;
169 int reserve01;
170 struct hammer_ioc_hist_entry hist_ary[HAMMER_MAX_HISTORY_ELMS];
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 */
180 * Reblock request
182 struct hammer_ioc_reblock {
183 struct hammer_ioc_head head;
184 int32_t free_level; /* 0 for maximum compaction */
185 u_int32_t reserved01;
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 */
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 */
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 */
201 int32_t unused02;
202 int32_t unused03;
206 * HAMMERIOC_SYNCTID
208 enum 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 */
215 struct hammer_ioc_synctid {
216 struct hammer_ioc_head head;
217 enum hammer_synctid_op op;
218 hammer_tid_t tid;
222 * HAMMERIOC_GET_PSEUDOFS
223 * HAMMERIOC_SET_PSEUDOFS
225 struct hammer_ioc_pseudofs_rw {
226 struct hammer_ioc_head head;
227 int pfs_id;
228 u_int32_t bytes;
229 u_int32_t version;
230 u_int32_t flags;
231 struct hammer_pseudofs_data *ondisk;
234 #define HAMMER_IOC_PSEUDOFS_VERSION 1
236 #define HAMMER_IOC_PFS_SYNC_BEG 0x0001
237 #define HAMMER_IOC_PFS_SYNC_END 0x0002
238 #define HAMMER_IOC_PFS_SHARED_UUID 0x0004
239 #define HAMMER_IOC_PFS_MIRROR_UUID 0x0008
240 #define HAMMER_IOC_PFS_MASTER_ID 0x0010
241 #define HAMMER_IOC_PFS_MIRROR_FLAGS 0x0020
242 #define HAMMER_IOC_PFS_LABEL 0x0040
244 #define HAMMER_MAX_PFS 65536
247 * HAMMERIOC_MIRROR_READ/WRITE
249 struct hammer_ioc_mirror_rw {
250 struct hammer_ioc_head head;
251 struct hammer_base_elm key_beg; /* start forward scan */
252 struct hammer_base_elm key_end; /* stop forward scan */
253 struct hammer_base_elm key_cur; /* interruption point */
254 hammer_tid_t tid_beg; /* filter modification range */
255 hammer_tid_t tid_end; /* filter modification range */
256 void *ubuf; /* user buffer */
257 int count; /* current size */
258 int size; /* max size */
259 int pfs_id; /* PFS id being read/written */
260 int reserved01;
261 uuid_t shared_uuid; /* validator for safety */
265 * NOTE: crc is for the data block starting at rec_size, not including the
266 * data[] array.
268 struct hammer_ioc_mrecord_head {
269 u_int32_t signature; /* signature for byte order */
270 u_int32_t rec_crc;
271 u_int32_t rec_size;
272 u_int32_t type;
273 /* extended */
276 typedef struct hammer_ioc_mrecord_head *hammer_ioc_mrecord_head_t;
278 struct hammer_ioc_mrecord_rec {
279 struct hammer_ioc_mrecord_head head;
280 struct hammer_btree_leaf_elm leaf;
281 /* extended by data */
284 struct hammer_ioc_mrecord_skip {
285 struct hammer_ioc_mrecord_head head;
286 struct hammer_base_elm skip_beg;
287 struct hammer_base_elm skip_end;
290 struct hammer_ioc_mrecord_update {
291 struct hammer_ioc_mrecord_head head;
292 hammer_tid_t tid;
295 struct hammer_ioc_mrecord_sync {
296 struct hammer_ioc_mrecord_head head;
299 struct hammer_ioc_mrecord_pfs {
300 struct hammer_ioc_mrecord_head head;
301 u_int32_t version;
302 u_int32_t reserved01;
303 struct hammer_pseudofs_data pfsd;
306 struct hammer_ioc_version {
307 struct hammer_ioc_head head;
308 u_int32_t cur_version;
309 u_int32_t min_version;
310 u_int32_t wip_version;
311 u_int32_t max_version;
312 char description[64];
315 union hammer_ioc_mrecord_any {
316 struct hammer_ioc_mrecord_head head;
317 struct hammer_ioc_mrecord_rec rec;
318 struct hammer_ioc_mrecord_skip skip;
319 struct hammer_ioc_mrecord_update update;
320 struct hammer_ioc_mrecord_update sync;
321 struct hammer_ioc_mrecord_pfs pfs;
322 struct hammer_ioc_version version;
325 typedef union hammer_ioc_mrecord_any *hammer_ioc_mrecord_any_t;
328 * MREC types. Flags are in the upper 16 bits but some are also included
329 * in the type mask to force them into any switch() on the type.
331 * NOTE: Any record whos data is CRC-errored will have HAMMER_MRECF_CRC set,
332 * and the bit is also part of the type mask.
334 #define HAMMER_MREC_TYPE_RESERVED 0
335 #define HAMMER_MREC_TYPE_REC 1 /* record w/ data */
336 #define HAMMER_MREC_TYPE_PFSD 2 /* (userland only) */
337 #define HAMMER_MREC_TYPE_UPDATE 3 /* (userland only) */
338 #define HAMMER_MREC_TYPE_SYNC 4 /* (userland only) */
339 #define HAMMER_MREC_TYPE_SKIP 5 /* skip-range */
340 #define HAMMER_MREC_TYPE_PASS 6 /* record for cmp only (pass) */
341 #define HAMMER_MREC_TYPE_TERM 7 /* (userland only) */
342 #define HAMMER_MREC_TYPE_IDLE 8 /* (userland only) */
344 #define HAMMER_MREC_TYPE_REC_BADCRC (HAMMER_MREC_TYPE_REC | \
345 HAMMER_MRECF_CRC_ERROR)
347 #define HAMMER_MRECF_TYPE_LOMASK 0x000000FF
348 #define HAMMER_MRECF_TYPE_MASK 0x800000FF
349 #define HAMMER_MRECF_CRC_ERROR 0x80000000
351 #define HAMMER_MRECF_DATA_CRC_BAD 0x40000000
352 #define HAMMER_MRECF_RECD_CRC_BAD 0x20000000
354 #define HAMMER_MREC_CRCOFF (offsetof(struct hammer_ioc_mrecord_head, rec_size))
355 #define HAMMER_MREC_HEADSIZE sizeof(struct hammer_ioc_mrecord_head)
357 #define HAMMER_IOC_MIRROR_SIGNATURE 0x4dd97272U
358 #define HAMMER_IOC_MIRROR_SIGNATURE_REV 0x7272d94dU
361 * Ioctl cmd ids
364 #define HAMMERIOC_PRUNE _IOWR('h',1,struct hammer_ioc_prune)
365 #define HAMMERIOC_GETHISTORY _IOWR('h',2,struct hammer_ioc_history)
366 #define HAMMERIOC_REBLOCK _IOWR('h',3,struct hammer_ioc_reblock)
367 #define HAMMERIOC_SYNCTID _IOWR('h',4,struct hammer_ioc_synctid)
368 #define HAMMERIOC_SET_PSEUDOFS _IOWR('h',5,struct hammer_ioc_pseudofs_rw)
369 #define HAMMERIOC_GET_PSEUDOFS _IOWR('h',6,struct hammer_ioc_pseudofs_rw)
370 #define HAMMERIOC_MIRROR_READ _IOWR('h',7,struct hammer_ioc_mirror_rw)
371 #define HAMMERIOC_MIRROR_WRITE _IOWR('h',8,struct hammer_ioc_mirror_rw)
372 #define HAMMERIOC_UPG_PSEUDOFS _IOWR('h',9,struct hammer_ioc_pseudofs_rw)
373 #define HAMMERIOC_DGD_PSEUDOFS _IOWR('h',10,struct hammer_ioc_pseudofs_rw)
374 #define HAMMERIOC_RMR_PSEUDOFS _IOWR('h',11,struct hammer_ioc_pseudofs_rw)
375 #define HAMMERIOC_WAI_PSEUDOFS _IOWR('h',12,struct hammer_ioc_pseudofs_rw)
376 #define HAMMERIOC_GET_VERSION _IOWR('h',13,struct hammer_ioc_version)
377 #define HAMMERIOC_SET_VERSION _IOWR('h',14,struct hammer_ioc_version)
378 #define HAMMERIOC_REBALANCE _IOWR('h',15,struct hammer_ioc_rebalance)
380 #endif