sbin/jscan/jscan.h

   1 /*
   2  * Copyright (c) 2004,2005 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/sbin/jscan/jscan.h,v 1.8 2005/09/06 22:33:00 dillon Exp $
  35  */
  36
  37 #include <sys/types.h>
  38 #include <sys/time.h>
  39 #include <sys/journal.h>
  40 #include <sys/stat.h>
  41 #include <stdio.h>
  42 #include <stdarg.h>
  43 #include <stdlib.h>
  44 #include <stddef.h>
  45 #include <unistd.h>
  46 #include <string.h>
  47 #include <limits.h>
  48 #include <time.h>
  49 #include <fcntl.h>
  50 #include <errno.h>
  51 #include <ctype.h>
  52 #include <assert.h>
  53 #include "jattr.h"
  54
  55 struct jdata;
  56
  57 enum jdirection { JD_FORWARDS, JD_BACKWARDS };
  58
  59 struct jfile {
  60     off_t               jf_pos;         /* current seek position */
  61     int                 jf_fd;          /* reading/scanning */
  62     int                 jf_write_fd;    /* appending */
  63     off_t               jf_write_pos;   /* append position */
  64     int                 jf_error;
  65     enum jdirection     jf_direction;
  66     int                 jf_open_flags;
  67     char                *jf_prefix;     /* prefix: name */
  68     unsigned int        jf_seq_beg;     /* prefix: sequence space */
  69     unsigned int        jf_seq_end;     /* prefix: sequence space */
  70     unsigned int        jf_seq;         /* prefix: current sequence number */
  71     int64_t             jf_last_transid;/* prefix: last recorded transid */
  72 };
  73
  74 /*
  75  * Output session (debug, record, output, etc)
  76  */
  77 struct jsession {
  78     struct jfile        *ss_jfin;
  79     struct jfile        *ss_jfout;
  80     const char          *ss_mirror_directory;
  81     const char          *ss_transid_file;
  82     int                 ss_transid_fd;
  83     int64_t             ss_transid;
  84 };
  85
  86 #define JF_FULL_DUPLEX  0x0001
  87
  88 struct jdata {
  89     int64_t             jd_transid;     /* transaction id from header */
  90     int                 jd_alloc;       /* allocated bytes */
  91     int                 jd_size;        /* data bytes */
  92     int                 jd_refs;        /* ref count */
  93     char                jd_data[4];     /* must be last field */
  94 };
  95
  96 struct jstream {
  97     struct jstream      *js_next;       /* linked list / same transaction */
  98     struct jsession     *js_session;
  99     char                *js_alloc_buf;
 100     int                 js_alloc_size;
 101
 102     /*
 103      * Normalized fields strip all rawrecbeg, rawrecend, and deadspace except
 104      * for the initial rawrecbeg header.
 105      */
 106     char                *js_normalized_base;
 107     int                 js_normalized_size;
 108     off_t               js_normalized_off;
 109     off_t               js_normalized_total;
 110
 111     /*
 112      * This is used by the first js record only to cache other records in the
 113      * chain.
 114      */
 115     struct jstream      *js_cache;
 116     struct jdata        *js_jdata;
 117     struct journal_rawrecbeg *js_head;
 118 };
 119
 120 struct jhash {
 121     struct jhash        *jh_hash;
 122     struct jstream      *jh_first;
 123     struct jstream      *jh_last;
 124     struct jsession     *jh_session;
 125     int16_t             jh_transid;
 126 };
 127
 128 #define JHASH_SIZE      1024
 129 #define JHASH_MASK      (JHASH_SIZE - 1)
 130
 131 #define JMODEF_DEBUG                    0x00000001
 132 #define JMODEF_MIRROR                   0x00000002
 133 #define JMODEF_UNUSED0004               0x00000004
 134 #define JMODEF_RECORD                   0x00000008
 135 #define JMODEF_RECORD_TMP               0x00000010
 136 #define JMODEF_INPUT_FULL               0x00000020
 137 #define JMODEF_INPUT_PIPE               0x00000040
 138 #define JMODEF_INPUT_PREFIX             0x00000080
 139 #define JMODEF_OUTPUT                   0x00000100
 140 #define JMODEF_OUTPUT_FULL              0x00000200
 141 #define JMODEF_MEMORY_TRACKING          0x00000400
 142 #define JMODEF_LOOP_FOREVER             0x00000800
 143
 144 #define JMODEF_OUTPUT_TRANSID_GOOD      0x00010000
 145 #define JMODEF_RECORD_TRANSID_GOOD      0x00020000
 146 #define JMODEF_MIRROR_TRANSID_GOOD      0x00040000
 147 #define JMODEF_TRANSID_GOOD_MASK        (JMODEF_OUTPUT_TRANSID_GOOD|\
 148                                          JMODEF_RECORD_TRANSID_GOOD|\
 149                                          JMODEF_MIRROR_TRANSID_GOOD)
 150 #define JMODEF_COMMAND_MASK     (JMODEF_RECORD|JMODEF_MIRROR|JMODEF_DEBUG|\
 151                                  JMODEF_OUTPUT)
 152
 153 extern int jmodes;
 154 extern int fsync_opt;
 155 extern int verbose_opt;
 156 extern off_t prefix_file_size;
 157 extern off_t trans_count;
 158
 159 const char *type_to_name(int16_t rectype);
 160 void stringout(FILE *fp, char c, int exact);
 161 void jattr_reset(struct jattr *jattr);
 162 int64_t buf_to_int64(const void *buf, int bytes);
 163 void *dupdata(const void *buf, int bytes);
 164 char *dupdatastr(const void *buf, int bytes);
 165 char *dupdatapath(const void *buf, int bytes);
 166 void get_transid_from_file(const char *path, int64_t *transid, int flags);
 167
 168 void jsession_init(struct jsession *ss, struct jfile *jfin,
 169                    const char *transid_file, int64_t transid);
 170 void jsession_update_transid(struct jsession *ss, int64_t transid);
 171 void jsession_term(struct jsession *ss);
 172
 173 struct jfile *jopen_fd(int fd, enum jdirection direction);
 174 struct jfile *jopen_prefix(const char *prefix, enum jdirection direction, int rw);
 175 void jclose(struct jfile *jf);
 176 int jread(struct jfile *jf, struct jdata **jdp, enum jdirection direction);
 177 void jwrite(struct jfile *jf, struct jdata *jd);
 178 void jseek(struct jfile *jf, int64_t transid, enum jdirection direction);
 179 struct jdata *jref(struct jdata *jd);
 180 void jfree(struct jfile *jf, struct jdata *jd);
 181 void jf_warn(struct jfile *jf, const char *ctl, ...);
 182
 183 struct jstream *jaddrecord(struct jsession *ss, struct jdata *jd);
 184 void jscan_dispose(struct jstream *js);
 185
 186 void dump_debug(struct jsession *ss, struct jdata *jd);
 187 void dump_mirror(struct jsession *ss, struct jdata *jd);
 188 void dump_record(struct jsession *ss, struct jdata *jd);
 189 void dump_output(struct jsession *ss, struct jdata *jd);
 190
 191 int jrecord_init(const char *record_prefix);
 192
 193 int jsreadany(struct jstream *js, off_t off, const void **bufp);
 194 int jsreadp(struct jstream *js, off_t off, const void **bufp, int bytes);
 195 int jsread(struct jstream *js, off_t off, void *buf, int bytes);
 196 int jsreadcallback(struct jstream *js, ssize_t (*func)(int, const void *, size_t), int fd, off_t off, int bytes);
 197