xref: /freebsd/sys/sys/mchain.h (revision 39beb93c)
1 /*-
2  * Copyright (c) 2000, 2001 Boris Popov
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  * 3. All advertising materials mentioning features or use of this software
14  *    must display the following acknowledgement:
15  *    This product includes software developed by Boris Popov.
16  * 4. Neither the name of the author nor the names of any co-contributors
17  *    may be used to endorse or promote products derived from this software
18  *    without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30  * SUCH DAMAGE.
31  *
32  * $FreeBSD$
33  */
34 #ifndef _SYS_MCHAIN_H_
35 #define _SYS_MCHAIN_H_
36 
37 #ifdef _KERNEL
38 
39 /*
40  * Type of copy for mb_{put|get}_mem()
41  */
42 #define	MB_MSYSTEM	0		/* use bcopy() */
43 #define	MB_MUSER	1		/* use copyin()/copyout() */
44 #define	MB_MINLINE	2		/* use an inline copy loop */
45 #define	MB_MZERO	3		/* bzero(), mb_put_mem only */
46 #define	MB_MCUSTOM	4		/* use an user defined function */
47 
48 struct mbuf;
49 struct mbchain;
50 
51 typedef int mb_copy_t(struct mbchain *mbp, c_caddr_t src, caddr_t dst,
52     size_t *srclen, size_t *dstlen);
53 
54 struct mbchain {
55 	struct mbuf *	mb_top;		/* head of mbufs chain */
56 	struct mbuf * 	mb_cur;		/* current mbuf */
57 	int		mb_mleft;	/* free space in the current mbuf */
58 	int		mb_count;	/* total number of bytes */
59 	mb_copy_t *	mb_copy;	/* user defined copy function */
60 	void *		mb_udata;	/* user data */
61 };
62 
63 struct mdchain {
64 	struct mbuf *	md_top;		/* head of mbufs chain */
65 	struct mbuf * 	md_cur;		/* current mbuf */
66 	u_char *	md_pos;		/* offset in the current mbuf */
67 };
68 
69 int  mb_init(struct mbchain *mbp);
70 void mb_initm(struct mbchain *mbp, struct mbuf *m);
71 void mb_done(struct mbchain *mbp);
72 struct mbuf *mb_detach(struct mbchain *mbp);
73 int  mb_fixhdr(struct mbchain *mbp);
74 caddr_t mb_reserve(struct mbchain *mbp, int size);
75 
76 int  mb_put_uint8(struct mbchain *mbp, u_int8_t x);
77 int  mb_put_uint16be(struct mbchain *mbp, u_int16_t x);
78 int  mb_put_uint16le(struct mbchain *mbp, u_int16_t x);
79 int  mb_put_uint32be(struct mbchain *mbp, u_int32_t x);
80 int  mb_put_uint32le(struct mbchain *mbp, u_int32_t x);
81 int  mb_put_int64be(struct mbchain *mbp, int64_t x);
82 int  mb_put_int64le(struct mbchain *mbp, int64_t x);
83 int  mb_put_mem(struct mbchain *mbp, c_caddr_t source, int size, int type);
84 int  mb_put_mbuf(struct mbchain *mbp, struct mbuf *m);
85 int  mb_put_uio(struct mbchain *mbp, struct uio *uiop, int size);
86 
87 int  md_init(struct mdchain *mdp);
88 void md_initm(struct mdchain *mbp, struct mbuf *m);
89 void md_done(struct mdchain *mdp);
90 void md_append_record(struct mdchain *mdp, struct mbuf *top);
91 int  md_next_record(struct mdchain *mdp);
92 int  md_get_uint8(struct mdchain *mdp, u_int8_t *x);
93 int  md_get_uint16(struct mdchain *mdp, u_int16_t *x);
94 int  md_get_uint16le(struct mdchain *mdp, u_int16_t *x);
95 int  md_get_uint16be(struct mdchain *mdp, u_int16_t *x);
96 int  md_get_uint32(struct mdchain *mdp, u_int32_t *x);
97 int  md_get_uint32be(struct mdchain *mdp, u_int32_t *x);
98 int  md_get_uint32le(struct mdchain *mdp, u_int32_t *x);
99 int  md_get_int64(struct mdchain *mdp, int64_t *x);
100 int  md_get_int64be(struct mdchain *mdp, int64_t *x);
101 int  md_get_int64le(struct mdchain *mdp, int64_t *x);
102 int  md_get_mem(struct mdchain *mdp, caddr_t target, int size, int type);
103 int  md_get_mbuf(struct mdchain *mdp, int size, struct mbuf **m);
104 int  md_get_uio(struct mdchain *mdp, struct uio *uiop, int size);
105 
106 #endif	/* ifdef _KERNEL */
107 
108 #endif	/* !_SYS_MCHAIN_H_ */
109