sys/sys/mountctl.h

   1 /*
   2  * Copyright (c) 2004 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  *
  34  * $DragonFly: src/sys/sys/mountctl.h,v 1.7 2005/03/22 22:13:33 dillon Exp $
  35  */
  36
  37 #ifndef _SYS_MOUNTCTL_H_
  38 #define _SYS_MOUNTCTL_H_
  39 /*
  40  * General constants
  41  */
  42
  43 #define JIDMAX          32      /* id string buf[] size (incls \0) */
  44
  45 /*
  46  * Data structures for the journaling API
  47  */
  48
  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
  54 #define MOUNTCTL_INSTALL_BLK_JOURNAL    8
  55 #define MOUNTCTL_REMOVE_BLK_JOURNAL     9
  56 #define MOUNTCTL_RESYNC_BLK_JOURNAL     10
  57 #define MOUNTCTL_STATUS_BLK_JOURNAL     11
  58
  59 struct mountctl_install_journal {
  60         char    id[JIDMAX];
  61         int     flags;          /* journaling flags */
  62         int     unused01;
  63         int64_t membufsize;     /* backing store */
  64         int64_t swapbufsize;    /* backing store */
  65         int64_t transid;        /* starting with specified transaction id */
  66         int64_t unused02;
  67         int     stallwarn;      /* stall warning (seconds) */
  68         int     stallerror;     /* stall error (seconds) */
  69         int     unused03;
  70         int     unused04;
  71 };
  72
  73 #define MC_JOURNAL_UNUSED0001           0x00000001
  74 #define MC_JOURNAL_STOP_REQ             0x00000002      /* stop request pend */
  75 #define MC_JOURNAL_STOP_IMM             0x00000004      /* STOP+trash fifo */
  76 #define MC_JOURNAL_WACTIVE              0x00000008      /* wthread running */
  77 #define MC_JOURNAL_RACTIVE              0x00000010      /* rthread running */
  78 #define MC_JOURNAL_WWAIT                0x00000040      /* write stall */
  79 #define MC_JOURNAL_WANT_AUDIT           0x00010000      /* audit trail */
  80 #define MC_JOURNAL_WANT_REVERSABLE      0x00020000      /* reversable stream */
  81 #define MC_JOURNAL_WANT_FULLDUPLEX      0x00040000      /* has ack stream */
  82
  83 struct mountctl_remove_journal {
  84         char    id[JIDMAX];
  85         int     flags;
  86 };
  87
  88 #define MC_JOURNAL_REMOVE_TRASH         0x00000001      /* data -> trash */
  89 #define MC_JOURNAL_REMOVE_ASSYNC        0x00000002      /* asynchronous op */
  90
  91 struct mountctl_status_journal {
  92         char    id[JIDMAX];
  93         int     index;
  94 };
  95
  96 #define MC_JOURNAL_INDEX_ALL            -2
  97 #define MC_JOURNAL_INDEX_ID             -1
  98
  99 struct mountctl_journal_ret_status {
 100         int     recsize;
 101         char    id[JIDMAX];
 102         int     index;
 103         int     flags;
 104         int64_t membufsize;
 105         int64_t membufused;
 106         int64_t membufiopend;
 107         int64_t swapbufsize;
 108         int64_t swapbufused;
 109         int64_t swapbufiopend;
 110         int64_t transidstart;
 111         int64_t transidcurrent;
 112         int64_t transidiopend;
 113         int64_t transidacked;
 114         int64_t bytessent;
 115         int64_t bytesacked;
 116         struct timeval lastack;
 117 };
 118
 119 #define MC_JOURNAL_STATUS_MORETOCOME    0x00000001
 120
 121 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
 122
 123 /*
 124  * Support structures for the generic journaling structure
 125  */
 126 struct journal_memfifo {
 127         int     size;           /* size (power of two) */
 128         int     mask;           /* index mask (size - 1) */
 129         int     rindex;         /* stream reader index (track fd writes) */
 130         int     xindex;         /* last acked / reader restart */
 131         int     windex;         /* stream writer index */
 132         char    *membase;       /* memory buffer representing the FIFO */
 133 };
 134
 135 /*
 136  * Generic journaling structure attached to a mount point.
 137  */
 138 struct journal {
 139         TAILQ_ENTRY(journal) jentry;
 140         struct file     *fp;
 141         char            id[JIDMAX];
 142         int             flags;          /* journaling flags */
 143         int64_t         transid;
 144         int64_t         total_acked;
 145         struct journal_memfifo fifo;
 146         struct thread   wthread;
 147         struct thread   rthread;
 148 };
 149
 150 /*
 151  * The jrecord structure is used to build a journaling transaction.  Since
 152  * a single journaling transaction might encompass very large buffers it
 153  * is possible for multiple transactions to be written out to the FIFO
 154  * in parallel and in peacemeal.
 155  */
 156 struct jrecord {
 157         struct journal  *jo;
 158         char            *stream_ptr;
 159         int             stream_residual;
 160         int             stream_reserved;
 161         struct journal_rawrecbeg *rawp;
 162         struct journal_subrecord *parent;
 163         struct journal_subrecord *last;
 164         int16_t         streamid;
 165         int             pushcount;
 166         int             pushptrgood;
 167         int             residual;
 168         int             residual_align;
 169 };
 170
 171 #endif
 172 #endif