xref: /freebsd/sys/geom/virstor/binstream.h (revision 2b15cb3d0922bd70ea592f0da9b4a5b167f4d53f)
1 /*-
2  * Copyright (c) 2005 Ivan Voras <ivoras@gmail.com>
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  *
26  * $FreeBSD$
27  */
28 
29 // $Id: binstream.h,v 1.1 2006/07/05 10:47:54 ivoras Exp $
30 
31 
32 #ifndef _BIN_STREAM_
33 #define _BIN_STREAM_
34 
35 #ifndef uint8_t
36 #define uint8_t unsigned char
37 #endif
38 
39 typedef struct {
40 	unsigned char  *data;
41 	int		pos;
42 }	bin_stream_t;
43 
44 
45 /* "Open" a binary stream for reading */
46 void		bs_open   (bin_stream_t * bs, void *data);
47 
48 /* "Reset" position in binary stream to zero */
49 void		bs_reset  (bin_stream_t * bs);
50 
51 
52 /* Write a zero-terminated string; return next position */
53 unsigned	bs_write_str(bin_stream_t * bs, char *data);
54 
55 /* Write an arbitrary buffer; return next position */
56 unsigned	bs_write_buf(bin_stream_t * bs, char *data, unsigned data_size);
57 
58 /* Write a 8bit uint; return next position. */
59 unsigned	bs_write_u8(bin_stream_t * bs, uint8_t data);
60 
61 /* Write a 16bit uint; return next position. */
62 unsigned	bs_write_u16(bin_stream_t * bs, uint16_t data);
63 
64 /* Write a 32bit uint; return next position. */
65 unsigned	bs_write_u32(bin_stream_t * bs, uint32_t data);
66 
67 /* Write a 64bit uint; return next position. */
68 unsigned	bs_write_u64(bin_stream_t * bs, uint64_t data);
69 
70 
71 /*
72  * Read a null-terminated string from stream into a buffer; buf_size is size
73  * of the buffer, including the final \0. Returns buf pointer or NULL if
74  * garbage input.
75  */
76 char           *bs_read_str(bin_stream_t * bs, char *buf, unsigned buf_size);
77 
78 /* Read an arbitrary buffer. */
79 void		bs_read_buf(bin_stream_t * bs, char *buf, unsigned buf_size);
80 
81 /* Read a 8bit uint * return it */
82 uint8_t		bs_read_u8(bin_stream_t * bs);
83 
84 /* Read a 16bit uint * return it */
85 uint16_t	bs_read_u16(bin_stream_t * bs);
86 
87 /* Read a 8bit uint * return it */
88 uint32_t	bs_read_u32(bin_stream_t * bs);
89 
90 /* Read a 8bit uint * return it */
91 uint64_t	bs_read_u64(bin_stream_t * bs);
92 
93 #endif
94