xref: /netbsd-src/usr.bin/vndcompress/offtab.h (revision b7b7574d3bf8eeb51a1fa3977b59142ec6434a55)
1 /*	$NetBSD: offtab.h,v 1.2 2014/01/22 06:15:22 riastradh Exp $	*/
2 
3 /*-
4  * Copyright (c) 2014 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Taylor R. Campbell.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  */
31 
32 #ifndef	VNDCOMPRESS_OFFTAB_H
33 #define	VNDCOMPRESS_OFFTAB_H
34 
35 #include <sys/cdefs.h>
36 
37 #include <stdbool.h>
38 #include <stdint.h>
39 
40 struct offtab {
41 	uint32_t	ot_n_offsets;
42 	uint32_t	ot_window_size;
43 	uint32_t	ot_window_start;
44 	uint64_t	*ot_window;
45 	uint32_t	ot_blkno;
46 	int		ot_fd;
47 	off_t		ot_fdpos;
48 	void		(*ot_report)(const char *, ...) __printflike(1,2);
49 	void		(*ot_reportx)(const char *, ...) __printflike(1,2);
50 	enum offtab_mode {
51 		OFFTAB_MODE_NONE,
52 		OFFTAB_MODE_READ,
53 		OFFTAB_MODE_WRITE,
54 	}		ot_mode;
55 };
56 
57 void		offtab_init(struct offtab *, uint32_t, uint32_t, int, off_t);
58 void		offtab_destroy(struct offtab *);
59 
60 bool		offtab_transmogrify_read_to_write(struct offtab *, uint32_t);
61 
62 bool		offtab_reset_read(struct offtab *,
63 		    void (*)(const char *, ...) __printflike(1,2),
64 		    void (*)(const char *, ...) __printflike(1,2));
65 bool		offtab_prepare_get(struct offtab *, uint32_t);
66 uint64_t	offtab_get(struct offtab *, uint32_t);
67 
68 void		offtab_reset_write(struct offtab *);
69 void		offtab_checkpoint(struct offtab *, uint32_t, int);
70 #define	OFFTAB_CHECKPOINT_SYNC	1
71 void		offtab_prepare_put(struct offtab *, uint32_t);
72 void		offtab_put(struct offtab *, uint32_t, uint64_t);
73 
74 #endif	/* VNDCOMPRESS_OFFTAB_H */
75