sys/vfs/hammer/hammer_ioctl.h

   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  *
  34  * $DragonFly: src/sys/vfs/hammer/hammer_ioctl.h,v 1.9 2008/05/18 01:48:50 dillon Exp $
  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 /*
  48  * Common HAMMER ioctl header
  49  *
  50  * Global flags are stored in the upper 16 bits.
  51  */
  52 struct hammer_ioc_head {
  53         int32_t         flags;
  54         int32_t         reserved01;
  55         int32_t         reserved02[4];
  56 };
  57
  58 #define HAMMER_IOC_HEAD_INTR    0x00010000
  59 #define HAMMER_IOC_DO_BTREE     0x00020000      /* reblocker */
  60 #define HAMMER_IOC_DO_INODES    0x00040000      /* reblocker */
  61 #define HAMMER_IOC_DO_DATA      0x00080000      /* reblocker */
  62
  63 #define HAMMER_IOC_DO_FLAGS     (HAMMER_IOC_DO_BTREE |  \
  64                                  HAMMER_IOC_DO_INODES | \
  65                                  HAMMER_IOC_DO_DATA)
  66
  67 /*
  68  * HAMMERIOC_PRUNE
  69  *
  70  * beg/end TID ranges in the element array must be sorted in descending
  71  * order, with the most recent (highest) range at elms[0].
  72  */
  73 struct hammer_ioc_prune_elm {
  74         hammer_tid_t    beg_tid;        /* starting tid */
  75         hammer_tid_t    end_tid;        /* ending tid (non inclusive) */
  76         hammer_tid_t    mod_tid;        /* modulo */
  77 };
  78
  79 #define HAMMER_MAX_PRUNE_ELMS   64
  80
  81 struct hammer_ioc_prune {
  82         struct hammer_ioc_head head;
  83         int             nelms;
  84         int             reserved01;
  85         u_int32_t       beg_localization;
  86         u_int32_t       cur_localization;
  87         u_int32_t       end_localization;
  88         u_int32_t       reserved03;
  89         int64_t         beg_obj_id;
  90         int64_t         cur_obj_id;
  91         int64_t         cur_key;
  92         int64_t         end_obj_id;      /* (range-exclusive) */
  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[HAMMER_MAX_PRUNE_ELMS];
 101 };
 102
 103 #define HAMMER_IOC_PRUNE_ALL    0x0001
 104
 105
 106 /*
 107  * HAMMERIOC_GETHISTORY
 108  *
 109  * Retrieve an array of ordered transaction ids >= beg and < end indicating
 110  * all changes made to the specified object's inode up to the
 111  * maximum.
 112  *
 113  * If ATKEY is set the key field indicates a particular key within the
 114  * inode to retrieve the history for.
 115  *
 116  * On return count is set to the number of elements returned, nxt_tid is
 117  * set to the tid the caller should store in beg_tid to continue the
 118  * iteration, and nxt_key is set to the nearest key boundary > key
 119  * indicating the range key - nxt_key (nxt_key non-inclusive) the tid
 120  * array represents.  Also obj_id is set to the object's inode number.
 121  *
 122  * nxt_key can be used to iterate the contents of a single file but should
 123  * not be stored in key until all modifications at key have been retrieved.
 124  * To work properly nxt_key should be initialized to HAMMER_MAX_KEY.
 125  * Successive ioctl() calls will reduce nxt_key as appropriate so at the
 126  * end of your iterating for 'key', key to nxt_key will represent the
 127  * shortest range of keys that all returned TIDs apply to.
 128  */
 129
 130 #define HAMMER_MAX_HISTORY_ELMS 64
 131
 132 struct hammer_ioc_history {
 133         struct hammer_ioc_head head;
 134         int64_t         obj_id;
 135         hammer_tid_t    beg_tid;
 136         hammer_tid_t    nxt_tid;
 137         hammer_tid_t    end_tid;
 138         int64_t         key;
 139         int64_t         nxt_key;
 140         int             count;
 141         int             reserve01;
 142         hammer_tid_t    tid_ary[HAMMER_MAX_HISTORY_ELMS];
 143 };
 144
 145 #define HAMMER_IOC_HISTORY_ATKEY        0x0001
 146 #define HAMMER_IOC_HISTORY_NEXT_TID     0x0002  /* iterate via nxt_tid */
 147 #define HAMMER_IOC_HISTORY_NEXT_KEY     0x0004  /* iterate via nxt_key */
 148 #define HAMMER_IOC_HISTORY_EOF          0x0008  /* no more keys */
 149 #define HAMMER_IOC_HISTORY_UNSYNCED     0x0010  /* unsynced info in inode */
 150
 151 /*
 152  * Reblock request
 153  */
 154 struct hammer_ioc_reblock {
 155         struct hammer_ioc_head head;
 156         int32_t         free_level;             /* 0 for maximum compaction */
 157         u_int32_t       reserved01;
 158
 159         u_int32_t       beg_localization;
 160         u_int32_t       cur_localization;
 161         u_int32_t       end_localization;
 162         u_int32_t       reserved03;
 163
 164         int64_t         beg_obj_id;
 165         int64_t         cur_obj_id;             /* Stopped at (interrupt) */
 166         int64_t         end_obj_id;
 167
 168         int64_t         btree_count;            /* B-Tree nodes checked */
 169         int64_t         record_count;           /* Records checked */
 170         int64_t         data_count;             /* Data segments checked */
 171         int64_t         data_byte_count;        /* Data bytes checked */
 172
 173         int64_t         btree_moves;            /* B-Tree nodes moved */
 174         int64_t         record_moves;           /* Records moved */
 175         int64_t         data_moves;             /* Data segments moved */
 176         int64_t         data_byte_moves;        /* Data bytes moved */
 177
 178         int32_t         unused02;
 179         int32_t         unused03;
 180 };
 181
 182 /*
 183  * HAMMER_IOC_SYNCTID
 184  */
 185 enum hammer_synctid_op {
 186         HAMMER_SYNCTID_NONE,    /* no sync (TID will not be accurate) */
 187         HAMMER_SYNCTID_ASYNC,   /* async (TID will not be accurate) */
 188         HAMMER_SYNCTID_SYNC1,   /* single sync - might undo after crash */
 189         HAMMER_SYNCTID_SYNC2    /* double sync - guarantee no undo */
 190 };
 191
 192 struct hammer_ioc_synctid {
 193         struct hammer_ioc_head  head;
 194         enum hammer_synctid_op  op;
 195         hammer_tid_t            tid;
 196 };
 197
 198
 199 #define HAMMERIOC_PRUNE         _IOWR('h',1,struct hammer_ioc_prune)
 200 #define HAMMERIOC_GETHISTORY    _IOWR('h',2,struct hammer_ioc_history)
 201 #define HAMMERIOC_REBLOCK       _IOWR('h',3,struct hammer_ioc_reblock)
 202 #define HAMMERIOC_SYNCTID       _IOWR('h',4,struct hammer_ioc_synctid)
 203
 204 #endif