2 * Copyright (c) 2004,2005 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/sbin/jscan/jscan.h,v 1.3 2005/07/05 00:26:03 dillon Exp $
37 #include <sys/types.h>
39 #include <sys/journal.h>
54 enum jdirection { JF_FORWARDS, JF_BACKWARDS};
57 off_t jf_pos; /* current seek position */
58 off_t jf_setpt; /* saved seek position */
59 struct jdata *jf_saved; /* saved data */
61 enum jdirection jf_direction;
66 struct jdata *jd_next;
69 char jd_data[4]; /* must be last field */
73 struct jstream *js_next; /* linked list / same transaction */
74 int js_size; /* amount of data, in bytes */
79 * Normalized fields strip all rawrecbeg, rawrecend, and deadspace except
80 * for the initial rawrecbeg header.
82 char *js_normalized_base;
83 int js_normalized_size;
84 off_t js_normalized_off;
85 off_t js_normalized_total;
88 * This is used by the first js record only to cache other records in the
91 struct jstream *js_cache;
94 char js_data[4]; /* variable length (original data) */
98 struct jhash *jh_hash;
99 struct jstream *jh_first;
100 struct jstream *jh_last;
104 #define JHASH_SIZE 1024
105 #define JHASH_MASK (JHASH_SIZE - 1)
107 extern int debug_opt;
109 const char *type_to_name(int16_t rectype);
110 void stringout(FILE *fp, char c, int exact);
111 void jattr_reset(struct jattr *jattr);
112 int64_t buf_to_int64(const void *buf, int bytes);
113 void *dupdata(const void *buf, int bytes);
114 char *dupdatastr(const void *buf, int bytes);
115 char *dupdatapath(const void *buf, int bytes);
118 struct jstream *jscan_stream(struct jfile *jf);
119 void jscan_dispose(struct jstream *js);
120 struct jfile *jopen_stream(const char *path, enum jdirection jdir);
121 struct jfile *jopen_fp(FILE *fp, enum jdirection jdir);
122 void jclose_stream(struct jfile *jf);
123 void jalign(struct jfile *jf);
124 int jread(struct jfile *jf, void *buf, int bytes);
125 void jset(struct jfile *jf);
126 void jreturn(struct jfile *jf);
127 void jflush(struct jfile *jf);
128 void jf_warn(struct jfile *jf, const char *ctl, ...);
130 void dump_debug(struct jfile *jf);
131 void dump_mirror(struct jfile *jf);
132 int dump_debug_payload(int16_t rectype, struct jstream *js, off_t off,
133 int recsize, int level);
135 int jsreadany(struct jstream *js, off_t off, const void **bufp);
136 int jsreadp(struct jstream *js, off_t off, const void **bufp, int bytes);
137 int jsread(struct jstream *js, off_t off, void *buf, int bytes);