fix the support for AN985 chip, which does not set the RXSTATE to STOPPED,
[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 *
cbeb73b9 34 * $DragonFly: src/sbin/jscan/jscan.h,v 1.8 2005/09/06 22:33:00 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>
c2b2044a 47#include <limits.h>
ce5e5ac4
MD
48#include <time.h>
49#include <fcntl.h>
50#include <errno.h>
712e03b0
MD
51#include <ctype.h>
52#include <assert.h>
53#include "jattr.h"
ce5e5ac4 54
c2b2044a
MD
55struct jdata;
56
57enum jdirection { JD_FORWARDS, JD_BACKWARDS };
ce5e5ac4
MD
58
59struct jfile {
60 off_t jf_pos; /* current seek position */
bb406b71
MD
61 int jf_fd; /* reading/scanning */
62 int jf_write_fd; /* appending */
63 off_t jf_write_pos; /* append position */
ce5e5ac4 64 int jf_error;
c2b2044a
MD
65 enum jdirection jf_direction;
66 int jf_open_flags;
c2b2044a
MD
67 char *jf_prefix; /* prefix: name */
68 unsigned int jf_seq_beg; /* prefix: sequence space */
69 unsigned int jf_seq_end; /* prefix: sequence space */
70 unsigned int jf_seq; /* prefix: current sequence number */
bb406b71
MD
71 int64_t jf_last_transid;/* prefix: last recorded transid */
72};
73
74/*
75 * Output session (debug, record, output, etc)
76 */
77struct jsession {
78 struct jfile *ss_jfin;
79 struct jfile *ss_jfout;
80 const char *ss_mirror_directory;
81 const char *ss_transid_file;
82 int ss_transid_fd;
83 int64_t ss_transid;
ce5e5ac4
MD
84};
85
5adba82e
MD
86#define JF_FULL_DUPLEX 0x0001
87
ce5e5ac4 88struct jdata {
c2b2044a
MD
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 */
ce5e5ac4
MD
93 char jd_data[4]; /* must be last field */
94};
95
96struct jstream {
97 struct jstream *js_next; /* linked list / same transaction */
bb406b71 98 struct jsession *js_session;
ce5e5ac4
MD
99 char *js_alloc_buf;
100 int js_alloc_size;
712e03b0
MD
101
102 /*
103 * Normalized fields strip all rawrecbeg, rawrecend, and deadspace except
104 * for the initial rawrecbeg header.
105 */
106 char *js_normalized_base;
107 int js_normalized_size;
108 off_t js_normalized_off;
109 off_t js_normalized_total;
110
111 /*
112 * This is used by the first js record only to cache other records in the
113 * chain.
114 */
ce5e5ac4 115 struct jstream *js_cache;
c2b2044a
MD
116 struct jdata *js_jdata;
117 struct journal_rawrecbeg *js_head;
ce5e5ac4
MD
118};
119
120struct jhash {
121 struct jhash *jh_hash;
122 struct jstream *jh_first;
123 struct jstream *jh_last;
bb406b71 124 struct jsession *jh_session;
ce5e5ac4
MD
125 int16_t jh_transid;
126};
127
128#define JHASH_SIZE 1024
129#define JHASH_MASK (JHASH_SIZE - 1)
130
c2b2044a
MD
131#define JMODEF_DEBUG 0x00000001
132#define JMODEF_MIRROR 0x00000002
133#define JMODEF_UNUSED0004 0x00000004
134#define JMODEF_RECORD 0x00000008
135#define JMODEF_RECORD_TMP 0x00000010
136#define JMODEF_INPUT_FULL 0x00000020
137#define JMODEF_INPUT_PIPE 0x00000040
138#define JMODEF_INPUT_PREFIX 0x00000080
139#define JMODEF_OUTPUT 0x00000100
140#define JMODEF_OUTPUT_FULL 0x00000200
141#define JMODEF_MEMORY_TRACKING 0x00000400
cbeb73b9 142#define JMODEF_LOOP_FOREVER 0x00000800
c2b2044a
MD
143
144#define JMODEF_OUTPUT_TRANSID_GOOD 0x00010000
145#define JMODEF_RECORD_TRANSID_GOOD 0x00020000
146#define JMODEF_MIRROR_TRANSID_GOOD 0x00040000
147#define JMODEF_TRANSID_GOOD_MASK (JMODEF_OUTPUT_TRANSID_GOOD|\
148 JMODEF_RECORD_TRANSID_GOOD|\
149 JMODEF_MIRROR_TRANSID_GOOD)
150#define JMODEF_COMMAND_MASK (JMODEF_RECORD|JMODEF_MIRROR|JMODEF_DEBUG|\
151 JMODEF_OUTPUT)
152
153extern int jmodes;
154extern int fsync_opt;
bb406b71
MD
155extern int verbose_opt;
156extern off_t prefix_file_size;
c2b2044a 157extern off_t trans_count;
712e03b0 158
ce5e5ac4 159const char *type_to_name(int16_t rectype);
9c118cb2 160void stringout(FILE *fp, char c, int exact);
712e03b0
MD
161void jattr_reset(struct jattr *jattr);
162int64_t buf_to_int64(const void *buf, int bytes);
163void *dupdata(const void *buf, int bytes);
164char *dupdatastr(const void *buf, int bytes);
165char *dupdatapath(const void *buf, int bytes);
c2b2044a
MD
166void get_transid_from_file(const char *path, int64_t *transid, int flags);
167
bb406b71
MD
168void jsession_init(struct jsession *ss, struct jfile *jfin,
169 const char *transid_file, int64_t transid);
170void jsession_update_transid(struct jsession *ss, int64_t transid);
171void jsession_term(struct jsession *ss);
172
c2b2044a
MD
173struct jfile *jopen_fd(int fd, enum jdirection direction);
174struct jfile *jopen_prefix(const char *prefix, enum jdirection direction, int rw);
175void jclose(struct jfile *jf);
176int jread(struct jfile *jf, struct jdata **jdp, enum jdirection direction);
bb406b71 177void jwrite(struct jfile *jf, struct jdata *jd);
c2b2044a
MD
178void jseek(struct jfile *jf, int64_t transid, enum jdirection direction);
179struct jdata *jref(struct jdata *jd);
180void jfree(struct jfile *jf, struct jdata *jd);
181void jf_warn(struct jfile *jf, const char *ctl, ...);
712e03b0 182
bb406b71 183struct jstream *jaddrecord(struct jsession *ss, struct jdata *jd);
ce5e5ac4 184void jscan_dispose(struct jstream *js);
ce5e5ac4 185
bb406b71
MD
186void dump_debug(struct jsession *ss, struct jdata *jd);
187void dump_mirror(struct jsession *ss, struct jdata *jd);
188void dump_record(struct jsession *ss, struct jdata *jd);
189void dump_output(struct jsession *ss, struct jdata *jd);
c2b2044a
MD
190
191int jrecord_init(const char *record_prefix);
ce5e5ac4
MD
192
193int jsreadany(struct jstream *js, off_t off, const void **bufp);
194int jsreadp(struct jstream *js, off_t off, const void **bufp, int bytes);
195int jsread(struct jstream *js, off_t off, void *buf, int bytes);
36d6bdee
MD
196int jsreadcallback(struct jstream *js, ssize_t (*func)(int, const void *, size_t), int fd, off_t off, int bytes);
197