2 * Copyright (c) 2004 The DragonFly Project. All rights reserved.
4 * This code is derived from software contributed to The DragonFly Project
5 * by Matthew Dillon <dillon@backplane.com>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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
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
34 * $DragonFly: src/sys/sys/mountctl.h,v 1.15 2008/06/01 19:27:37 dillon Exp $
37 #ifndef _SYS_MOUNTCTL_H_
38 #define _SYS_MOUNTCTL_H_
41 #include <sys/types.h>
47 #include <sys/queue.h>
52 #ifndef _SYS_THREAD_H_
53 #include <sys/thread.h>
55 #ifndef _SYS_MALLOC_H_
56 #include <sys/malloc.h>
65 #define JIDMAX 32 /* id string buf[] size (incls \0) */
67 #define MOUNTCTL_INSTALL_VFS_JOURNAL 1
68 #define MOUNTCTL_REMOVE_VFS_JOURNAL 2
69 #define MOUNTCTL_RESYNC_VFS_JOURNAL 3
70 #define MOUNTCTL_STATUS_VFS_JOURNAL 4
71 #define MOUNTCTL_RESTART_VFS_JOURNAL 5
73 #define MOUNTCTL_INSTALL_BLK_JOURNAL 8
74 #define MOUNTCTL_REMOVE_BLK_JOURNAL 9
75 #define MOUNTCTL_RESYNC_BLK_JOURNAL 10
76 #define MOUNTCTL_STATUS_BLK_JOURNAL 11
78 #define MOUNTCTL_SET_EXPORT 16 /* sys/mount.h:export_args */
79 #define MOUNTCTL_STATVFS 17 /* get extended stats */
80 #define MOUNTCTL_MOUNTFLAGS 18 /* extract mountflags */
83 * Data structures for the journaling API
86 struct mountctl_install_journal {
88 int flags; /* journaling flags */
90 int64_t membufsize; /* backing store */
91 int64_t swapbufsize; /* backing store */
92 int64_t transid; /* starting with specified transaction id */
94 int stallwarn; /* stall warning (seconds) */
95 int stallerror; /* stall error (seconds) */
100 #define MC_JOURNAL_UNUSED0001 0x00000001
101 #define MC_JOURNAL_STOP_REQ 0x00000002 /* stop request pend */
102 #define MC_JOURNAL_STOP_IMM 0x00000004 /* STOP+trash fifo */
103 #define MC_JOURNAL_WACTIVE 0x00000008 /* wthread running */
104 #define MC_JOURNAL_RACTIVE 0x00000010 /* rthread running */
105 #define MC_JOURNAL_WWAIT 0x00000040 /* write stall */
106 #define MC_JOURNAL_WANT_AUDIT 0x00010000 /* audit trail */
107 #define MC_JOURNAL_WANT_REVERSABLE 0x00020000 /* reversable stream */
108 #define MC_JOURNAL_WANT_FULLDUPLEX 0x00040000 /* has ack stream */
110 struct mountctl_restart_journal {
116 struct mountctl_remove_journal {
121 #define MC_JOURNAL_REMOVE_TRASH 0x00000001 /* data -> trash */
122 #define MC_JOURNAL_REMOVE_ASSYNC 0x00000002 /* asynchronous op */
124 struct mountctl_status_journal {
129 #define MC_JOURNAL_INDEX_ALL -2
130 #define MC_JOURNAL_INDEX_ID -1
132 struct mountctl_journal_ret_status {
139 int64_t membufunacked;
142 int64_t swapbufunacked;
143 int64_t transidstart;
144 int64_t transidcurrent;
145 int64_t transidunacked;
146 int64_t transidacked;
151 struct timeval lastack;
154 #define MC_JOURNAL_STATUS_MORETOCOME 0x00000001
156 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
159 * Support structures for the generic journaling structure
161 struct journal_memfifo {
162 int size; /* size (power of two) */
163 int mask; /* index mask (size - 1) */
164 int rindex; /* stream reader index (track fd writes) */
165 int xindex; /* last acked / reader restart */
166 int windex; /* stream writer index */
167 char *membase; /* memory buffer representing the FIFO */
171 * Generic journaling structure attached to a mount point.
174 TAILQ_ENTRY(journal) jentry;
177 int flags; /* journaling flags */
181 struct journal_memfifo fifo;
182 struct thread wthread;
183 struct thread rthread;
188 * The jrecord structure is used to build a journaling transaction. Since
189 * a single journaling transaction might encompass very large buffers it
190 * is possible for multiple transactions to be written out to the FIFO
191 * in parallel and in peacemeal.
198 struct journal_rawrecbeg *rawp;
199 struct journal_subrecord *parent;
200 struct journal_subrecord *last;
208 * These fields are not used by the jrecord routines. They may
209 * be used by higher level routines to manage multiple jrecords.
210 * See the jreclist_*() functions.
212 TAILQ_ENTRY(jrecord) user_entry;
216 struct jrecord_list {
217 TAILQ_HEAD(, jrecord) list;
221 #endif /* kernel or kernel structures */
233 void journal_create_threads(struct journal *jo);
234 void journal_destroy_threads(struct journal *jo, int flags);
237 * Primary journal record support procedures
239 void jrecord_init(struct journal *jo,
240 struct jrecord *jrec, int16_t streamid);
241 struct journal_subrecord *jrecord_push(
242 struct jrecord *jrec, int16_t rectype);
243 void jrecord_pop(struct jrecord *jrec, struct journal_subrecord *parent);
244 void jrecord_leaf(struct jrecord *jrec,
245 int16_t rectype, void *ptr, int bytes);
246 void jrecord_leaf_uio(struct jrecord *jrec,
247 int16_t rectype, struct uio *uio);
248 void jrecord_leaf_xio(struct jrecord *jrec,
249 int16_t rectype, struct xio *xio);
250 struct journal_subrecord *jrecord_write(struct jrecord *jrec,
251 int16_t rectype, int bytes);
252 void jrecord_done(struct jrecord *jrec, int abortit);
255 * Rollup journal record support procedures
257 void jrecord_write_path(struct jrecord *jrec,
258 int16_t rectype, struct namecache *ncp);
259 void jrecord_write_vattr(struct jrecord *jrec, struct vattr *vat);
260 void jrecord_write_cred(struct jrecord *jrec, struct thread *td,
262 void jrecord_write_vnode_ref(struct jrecord *jrec, struct vnode *vp);
263 void jrecord_write_vnode_link(struct jrecord *jrec, struct vnode *vp,
264 struct namecache *notncp);
265 void jrecord_write_pagelist(struct jrecord *jrec, int16_t rectype,
266 struct vm_page **pglist, int *rtvals, int pgcount,
268 void jrecord_write_uio(struct jrecord *jrec, int16_t rectype, struct uio *uio);
269 void jrecord_file_data(struct jrecord *jrec, struct vnode *vp,
270 off_t off, off_t bytes);
272 MALLOC_DECLARE(M_JOURNAL);
273 MALLOC_DECLARE(M_JFIFO);
277 #include <sys/cdefs.h>
280 int mountctl (const char *path, int op, int fd, void *ctl, int ctllen,
281 void *buf, int buflen);