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