The size of a nesting record may not be known (due to the virtual stream
[dragonfly.git] / sbin / jscan / jscan.h
CommitLineData
ce5e5ac4
MD
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 *
9c118cb2 34 * $DragonFly: src/sbin/jscan/jscan.h,v 1.2 2005/03/07 05:05:04 dillon Exp $
ce5e5ac4
MD
35 */
36
37#include <sys/types.h>
38#include <sys/time.h>
39#include <sys/journal.h>
40#include <stdio.h>
41#include <stdarg.h>
42#include <stdlib.h>
43#include <stddef.h>
44#include <unistd.h>
45#include <string.h>
46#include <time.h>
47#include <fcntl.h>
48#include <errno.h>
49
50enum jdirection { JF_FORWARDS, JF_BACKWARDS};
51
52struct jfile {
53 off_t jf_pos; /* current seek position */
54 off_t jf_setpt; /* saved seek position */
55 struct jdata *jf_saved; /* saved data */
56 FILE *jf_fp;
57 enum jdirection jf_direction;
58 int jf_error;
59};
60
61struct jdata {
62 struct jdata *jd_next;
63 int jd_size;
64 off_t jd_pos;
65 char jd_data[4]; /* must be last field */
66};
67
68struct jstream {
69 struct jstream *js_next; /* linked list / same transaction */
70 int js_size; /* amount of data, in bytes */
71 off_t js_off;
72 char *js_alloc_buf;
73 int js_alloc_size;
74 struct jstream *js_cache;
75 off_t js_cache_off;
76 char js_data[4]; /* variable length */
77};
78
79struct jhash {
80 struct jhash *jh_hash;
81 struct jstream *jh_first;
82 struct jstream *jh_last;
83 int16_t jh_transid;
84};
85
86#define JHASH_SIZE 1024
87#define JHASH_MASK (JHASH_SIZE - 1)
88
89const char *type_to_name(int16_t rectype);
9c118cb2 90void stringout(FILE *fp, char c, int exact);
ce5e5ac4
MD
91
92struct jstream *jscan_stream(struct jfile *jf);
93void jscan_dispose(struct jstream *js);
94struct jfile *jopen_stream(const char *path, enum jdirection jdir);
9c118cb2 95struct jfile *jopen_fp(FILE *fp, enum jdirection jdir);
ce5e5ac4
MD
96void jclose_stream(struct jfile *jf);
97void jalign(struct jfile *jf);
98int jread(struct jfile *jf, void *buf, int bytes);
99void jset(struct jfile *jf);
100void jreturn(struct jfile *jf);
101void jflush(struct jfile *jf);
102void jf_warn(struct jfile *jf, const char *ctl, ...);
103
104void dump_debug(struct jfile *jf);
105
106int jsreadany(struct jstream *js, off_t off, const void **bufp);
107int jsreadp(struct jstream *js, off_t off, const void **bufp, int bytes);
108int jsread(struct jstream *js, off_t off, void *buf, int bytes);
109