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.10 2005/09/07 19:10:09 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, JD_SEQFIRST, JD_SEQLAST }; 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 int jf_open_flags; 66 char *jf_prefix; /* prefix: name */ 67 unsigned int jf_seq_beg; /* prefix: sequence space */ 68 unsigned int jf_seq_end; /* prefix: sequence space */ 69 unsigned int jf_seq; /* prefix: current sequence number */ 70 int64_t jf_last_transid;/* prefix: last recorded transid */ 71 }; 72 73 /* 74 * Output session (debug, record, output, etc) 75 */ 76 struct jsession { 77 struct jfile *ss_jfin; 78 struct jfile *ss_jfout; 79 enum jdirection ss_direction; 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 unsigned int jd_seq; /* location data */ 94 off_t jd_pos; /* location data */ 95 char jd_data[4]; /* must be last field */ 96 }; 97 98 struct jstream { 99 struct jstream *js_next; /* linked list / same transaction */ 100 struct jsession *js_session; 101 char *js_alloc_buf; 102 int js_alloc_size; 103 104 /* 105 * Normalized fields strip all rawrecbeg, rawrecend, and deadspace except 106 * for the initial rawrecbeg header. 107 */ 108 char *js_normalized_base; 109 int js_normalized_size; 110 off_t js_normalized_off; 111 off_t js_normalized_total; 112 113 /* 114 * This is used by the first js record only to cache other records in the 115 * chain. 116 */ 117 struct jstream *js_cache; 118 struct jdata *js_jdata; 119 struct journal_rawrecbeg *js_head; 120 }; 121 122 struct jhash { 123 struct jhash *jh_hash; 124 struct jstream *jh_first; 125 struct jstream *jh_last; 126 struct jsession *jh_session; 127 int16_t jh_transid; 128 }; 129 130 #define JHASH_SIZE 1024 131 #define JHASH_MASK (JHASH_SIZE - 1) 132 133 #define JMODEF_DEBUG 0x00000001 134 #define JMODEF_MIRROR 0x00000002 135 #define JMODEF_UNUSED0004 0x00000004 136 #define JMODEF_RECORD 0x00000008 137 #define JMODEF_RECORD_TMP 0x00000010 138 #define JMODEF_INPUT_FULL 0x00000020 139 #define JMODEF_INPUT_PIPE 0x00000040 140 #define JMODEF_INPUT_PREFIX 0x00000080 141 #define JMODEF_OUTPUT 0x00000100 142 #define JMODEF_OUTPUT_FULL 0x00000200 143 #define JMODEF_MEMORY_TRACKING 0x00000400 144 #define JMODEF_LOOP_FOREVER 0x00000800 145 146 #define JMODEF_OUTPUT_TRANSID_GOOD 0x00010000 147 #define JMODEF_RECORD_TRANSID_GOOD 0x00020000 148 #define JMODEF_MIRROR_TRANSID_GOOD 0x00040000 149 #define JMODEF_TRANSID_GOOD_MASK (JMODEF_OUTPUT_TRANSID_GOOD|\ 150 JMODEF_RECORD_TRANSID_GOOD|\ 151 JMODEF_MIRROR_TRANSID_GOOD) 152 #define JMODEF_COMMAND_MASK (JMODEF_RECORD|JMODEF_MIRROR|JMODEF_DEBUG|\ 153 JMODEF_OUTPUT) 154 155 extern int jmodes; 156 extern int fsync_opt; 157 extern int verbose_opt; 158 extern off_t prefix_file_size; 159 extern off_t trans_count; 160 161 const char *type_to_name(int16_t rectype); 162 void stringout(FILE *fp, char c, int exact); 163 void jattr_reset(struct jattr *jattr); 164 int64_t buf_to_int64(const void *buf, int bytes); 165 void *dupdata(const void *buf, int bytes); 166 char *dupdatastr(const void *buf, int bytes); 167 char *dupdatapath(const void *buf, int bytes); 168 void get_transid_from_file(const char *path, int64_t *transid, int flags); 169 170 void jsession_init(struct jsession *ss, struct jfile *jfin, 171 enum jdirection direction, 172 const char *transid_file, int64_t transid); 173 void jsession_update_transid(struct jsession *ss, int64_t transid); 174 int jsession_check(struct jsession *ss, struct jdata *jd); 175 void jsession_term(struct jsession *ss); 176 177 struct jfile *jopen_fd(int fd); 178 struct jfile *jopen_prefix(const char *prefix, int rw); 179 void jclose(struct jfile *jf); 180 struct jdata *jread(struct jfile *jf, struct jdata *jd, 181 enum jdirection direction); 182 struct jdata *jseek(struct jfile *jf, int64_t transid, 183 enum jdirection direction); 184 void jwrite(struct jfile *jf, struct jdata *jd); 185 struct jdata *jref(struct jdata *jd); 186 void jfree(struct jfile *jf, struct jdata *jd); 187 void jf_warn(struct jfile *jf, const char *ctl, ...) __printflike(2, 3); 188 189 struct jstream *jaddrecord(struct jsession *ss, struct jdata *jd); 190 void jscan_dispose(struct jstream *js); 191 192 void dump_debug(struct jsession *ss, struct jdata *jd); 193 void dump_mirror(struct jsession *ss, struct jdata *jd); 194 void dump_record(struct jsession *ss, struct jdata *jd); 195 void dump_output(struct jsession *ss, struct jdata *jd); 196 197 int jrecord_init(const char *record_prefix); 198 199 int jsreadany(struct jstream *js, off_t off, const void **bufp); 200 int jsreadp(struct jstream *js, off_t off, const void **bufp, int bytes); 201 int jsread(struct jstream *js, off_t off, void *buf, int bytes); 202 int jsreadcallback(struct jstream *js, ssize_t (*func)(int, const void *, size_t), int fd, off_t off, int bytes); 203 204