* Fix a number of alignment errors that was causing garbage to be parsed.
[dragonfly.git] / 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.4 2005/07/05 02:38:34 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 <time.h>
48 #include <fcntl.h>
49 #include <errno.h>
50 #include <ctype.h>
51 #include <assert.h>
52 #include "jattr.h"
53
54 enum jdirection { JF_FORWARDS, JF_BACKWARDS};
55
56 struct jfile {
57     off_t               jf_pos;         /* current seek position */
58     off_t               jf_setpt;       /* saved seek position */
59     struct jdata        *jf_saved;      /* saved data */
60     FILE                *jf_fp;
61     enum jdirection     jf_direction;
62     int                 jf_error;
63 };
64
65 struct jdata {
66     struct jdata        *jd_next;
67     int                 jd_size;
68     off_t               jd_pos;
69     char                jd_data[4];     /* must be last field */
70 };
71
72 struct jstream {
73     struct jstream      *js_next;       /* linked list / same transaction */
74     int                 js_size;        /* amount of data, in bytes */
75     char                *js_alloc_buf;
76     int                 js_alloc_size;
77
78     /*
79      * Normalized fields strip all rawrecbeg, rawrecend, and deadspace except
80      * for the initial rawrecbeg header.
81      */
82     char                *js_normalized_base;
83     int                 js_normalized_size;
84     off_t               js_normalized_off;
85     off_t               js_normalized_total;
86
87     /*
88      * This is used by the first js record only to cache other records in the
89      * chain.
90      */
91     struct jstream      *js_cache;
92
93     char                js_data[4];     /* variable length (original data) */
94 };
95
96 struct jhash {
97     struct jhash        *jh_hash;
98     struct jstream      *jh_first;
99     struct jstream      *jh_last;
100     int16_t             jh_transid;
101 };
102
103 #define JHASH_SIZE      1024
104 #define JHASH_MASK      (JHASH_SIZE - 1)
105
106 extern int debug_opt;
107
108 const char *type_to_name(int16_t rectype);
109 void stringout(FILE *fp, char c, int exact);
110 void jattr_reset(struct jattr *jattr);
111 int64_t buf_to_int64(const void *buf, int bytes);
112 void *dupdata(const void *buf, int bytes);
113 char *dupdatastr(const void *buf, int bytes);
114 char *dupdatapath(const void *buf, int bytes);
115
116
117 struct jstream *jscan_stream(struct jfile *jf);
118 void jscan_dispose(struct jstream *js);
119 struct jfile *jopen_stream(const char *path, enum jdirection jdir);
120 struct jfile *jopen_fp(FILE *fp, enum jdirection jdir);
121 void jclose_stream(struct jfile *jf);
122 void jalign(struct jfile *jf);
123 int jread(struct jfile *jf, void *buf, int bytes);
124 void jset(struct jfile *jf);
125 void jreturn(struct jfile *jf);
126 void jflush(struct jfile *jf);
127 void jf_warn(struct jfile *jf, const char *ctl, ...);
128
129 void dump_debug(struct jfile *jf);
130 void dump_mirror(struct jfile *jf);
131 int dump_debug_payload(int16_t rectype, struct jstream *js, off_t off,
132                        int recsize, int level);
133
134 int jsreadany(struct jstream *js, off_t off, const void **bufp);
135 int jsreadp(struct jstream *js, off_t off, const void **bufp, int bytes);
136 int jsread(struct jstream *js, off_t off, void *buf, int bytes);
137 int jsreadcallback(struct jstream *js, ssize_t (*func)(int, const void *, size_t), int fd, off_t off, int bytes);
138
139