Bring mountctl up-to-date with memory fifo statistics structural changes.
[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 *
36d6bdee 34 * $DragonFly: src/sbin/jscan/jscan.h,v 1.4 2005/07/05 02:38:34 dillon Exp $
ce5e5ac4
MD
35 */
36
37#include <sys/types.h>
38#include <sys/time.h>
39#include <sys/journal.h>
712e03b0 40#include <sys/stat.h>
ce5e5ac4
MD
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>
712e03b0
MD
50#include <ctype.h>
51#include <assert.h>
52#include "jattr.h"
ce5e5ac4
MD
53
54enum jdirection { JF_FORWARDS, JF_BACKWARDS};
55
56struct 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
65struct 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
72struct jstream {
73 struct jstream *js_next; /* linked list / same transaction */
74 int js_size; /* amount of data, in bytes */
ce5e5ac4
MD
75 char *js_alloc_buf;
76 int js_alloc_size;
712e03b0
MD
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 */
ce5e5ac4 91 struct jstream *js_cache;
712e03b0
MD
92
93 char js_data[4]; /* variable length (original data) */
ce5e5ac4
MD
94};
95
96struct 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
712e03b0
MD
106extern int debug_opt;
107
ce5e5ac4 108const char *type_to_name(int16_t rectype);
9c118cb2 109void stringout(FILE *fp, char c, int exact);
712e03b0
MD
110void jattr_reset(struct jattr *jattr);
111int64_t buf_to_int64(const void *buf, int bytes);
112void *dupdata(const void *buf, int bytes);
113char *dupdatastr(const void *buf, int bytes);
114char *dupdatapath(const void *buf, int bytes);
115
ce5e5ac4
MD
116
117struct jstream *jscan_stream(struct jfile *jf);
118void jscan_dispose(struct jstream *js);
119struct jfile *jopen_stream(const char *path, enum jdirection jdir);
9c118cb2 120struct jfile *jopen_fp(FILE *fp, enum jdirection jdir);
ce5e5ac4
MD
121void jclose_stream(struct jfile *jf);
122void jalign(struct jfile *jf);
123int jread(struct jfile *jf, void *buf, int bytes);
124void jset(struct jfile *jf);
125void jreturn(struct jfile *jf);
126void jflush(struct jfile *jf);
127void jf_warn(struct jfile *jf, const char *ctl, ...);
128
129void dump_debug(struct jfile *jf);
712e03b0
MD
130void dump_mirror(struct jfile *jf);
131int dump_debug_payload(int16_t rectype, struct jstream *js, off_t off,
132 int recsize, int level);
ce5e5ac4
MD
133
134int jsreadany(struct jstream *js, off_t off, const void **bufp);
135int jsreadp(struct jstream *js, off_t off, const void **bufp, int bytes);
136int jsread(struct jstream *js, off_t off, void *buf, int bytes);
36d6bdee
MD
137int jsreadcallback(struct jstream *js, ssize_t (*func)(int, const void *, size_t), int fd, off_t off, int bytes);
138
ce5e5ac4 139