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.10 2005/08/24 20:28:33 dillon Exp $
37 #ifndef _SYS_MOUNTCTL_H_
38 #define _SYS_MOUNTCTL_H_
43 #define JIDMAX 32 /* id string buf[] size (incls \0) */
46 * Data structures for the journaling API
49 #define MOUNTCTL_INSTALL_VFS_JOURNAL 1
50 #define MOUNTCTL_REMOVE_VFS_JOURNAL 2
51 #define MOUNTCTL_RESYNC_VFS_JOURNAL 3
52 #define MOUNTCTL_STATUS_VFS_JOURNAL 4
53 #define MOUNTCTL_RESTART_VFS_JOURNAL 5
55 #define MOUNTCTL_INSTALL_BLK_JOURNAL 8
56 #define MOUNTCTL_REMOVE_BLK_JOURNAL 9
57 #define MOUNTCTL_RESYNC_BLK_JOURNAL 10
58 #define MOUNTCTL_STATUS_BLK_JOURNAL 11
60 struct mountctl_install_journal
{
62 int flags
; /* journaling flags */
64 int64_t membufsize
; /* backing store */
65 int64_t swapbufsize
; /* backing store */
66 int64_t transid
; /* starting with specified transaction id */
68 int stallwarn
; /* stall warning (seconds) */
69 int stallerror
; /* stall error (seconds) */
74 #define MC_JOURNAL_UNUSED0001 0x00000001
75 #define MC_JOURNAL_STOP_REQ 0x00000002 /* stop request pend */
76 #define MC_JOURNAL_STOP_IMM 0x00000004 /* STOP+trash fifo */
77 #define MC_JOURNAL_WACTIVE 0x00000008 /* wthread running */
78 #define MC_JOURNAL_RACTIVE 0x00000010 /* rthread running */
79 #define MC_JOURNAL_WWAIT 0x00000040 /* write stall */
80 #define MC_JOURNAL_WANT_AUDIT 0x00010000 /* audit trail */
81 #define MC_JOURNAL_WANT_REVERSABLE 0x00020000 /* reversable stream */
82 #define MC_JOURNAL_WANT_FULLDUPLEX 0x00040000 /* has ack stream */
84 struct mountctl_restart_journal
{
90 struct mountctl_remove_journal
{
95 #define MC_JOURNAL_REMOVE_TRASH 0x00000001 /* data -> trash */
96 #define MC_JOURNAL_REMOVE_ASSYNC 0x00000002 /* asynchronous op */
98 struct mountctl_status_journal
{
103 #define MC_JOURNAL_INDEX_ALL -2
104 #define MC_JOURNAL_INDEX_ID -1
106 struct mountctl_journal_ret_status
{
113 int64_t membufunacked
;
116 int64_t swapbufunacked
;
117 int64_t transidstart
;
118 int64_t transidcurrent
;
119 int64_t transidunacked
;
120 int64_t transidacked
;
125 struct timeval lastack
;
128 #define MC_JOURNAL_STATUS_MORETOCOME 0x00000001
130 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
133 * Support structures for the generic journaling structure
135 struct journal_memfifo
{
136 int size
; /* size (power of two) */
137 int mask
; /* index mask (size - 1) */
138 int rindex
; /* stream reader index (track fd writes) */
139 int xindex
; /* last acked / reader restart */
140 int windex
; /* stream writer index */
141 char *membase
; /* memory buffer representing the FIFO */
145 * Generic journaling structure attached to a mount point.
148 TAILQ_ENTRY(journal
) jentry
;
151 int flags
; /* journaling flags */
155 struct journal_memfifo fifo
;
156 struct thread wthread
;
157 struct thread rthread
;
162 * The jrecord structure is used to build a journaling transaction. Since
163 * a single journaling transaction might encompass very large buffers it
164 * is possible for multiple transactions to be written out to the FIFO
165 * in parallel and in peacemeal.
172 struct journal_rawrecbeg
*rawp
;
173 struct journal_subrecord
*parent
;
174 struct journal_subrecord
*last
;
182 * These fields are not used by the jrecord routines. They may
183 * be used by higher level routines to manage multiple jrecords.
184 * See the jreclist_*() functions.
186 TAILQ_ENTRY(jrecord
) user_entry
;
190 TAILQ_HEAD(jrecord_list
, jrecord
);