mchain.h revision 148517
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: head/sys/sys/mchain.h 148517 2005-07-29 13:22:37Z imura $
33 */
34#ifndef _SYS_MCHAIN_H_
35#define _SYS_MCHAIN_H_
36
37#include <machine/endian.h>
38
39#ifndef _KERNEL
40/*
41 * This macros probably belongs to the endian.h
42 */
43#if (BYTE_ORDER == LITTLE_ENDIAN)
44
45#define	htoles(x)	((u_int16_t)(x))
46#define	letohs(x)	((u_int16_t)(x))
47#define	htolel(x)	((u_int32_t)(x))
48#define	letohl(x)	((u_int32_t)(x))
49#define	htoleq(x)	((int64_t)(x))
50#define	letohq(x)	((int64_t)(x))
51
52#define	htobes(x)	(__htons(x))
53#define	betohs(x)	(__ntohs(x))
54#define	htobel(x)	(__htonl(x))
55#define	betohl(x)	(__ntohl(x))
56
57static __inline int64_t
58htobeq(int64_t x)
59{
60	return (int64_t)__htonl((u_int32_t)(x >> 32)) |
61	    (int64_t)__htonl((u_int32_t)(x & 0xffffffff)) << 32;
62}
63
64static __inline int64_t
65betohq(int64_t x)
66{
67	return (int64_t)__ntohl((u_int32_t)(x >> 32)) |
68	    (int64_t)__ntohl((u_int32_t)(x & 0xffffffff)) << 32;
69}
70
71#else	/* (BYTE_ORDER == LITTLE_ENDIAN) */
72
73#error "Macros for Big-Endians are incomplete"
74
75/*
76#define	htoles(x)	((u_int16_t)(x))
77#define	letohs(x)	((u_int16_t)(x))
78#define	htolel(x)	((u_int32_t)(x))
79#define	letohl(x)	((u_int32_t)(x))
80*/
81#endif	/* (BYTE_ORDER == LITTLE_ENDIAN) */
82#endif	/* _KERNEL */
83
84
85#ifdef _KERNEL
86
87/*
88 * Type of copy for mb_{put|get}_mem()
89 */
90#define	MB_MSYSTEM	0		/* use bcopy() */
91#define	MB_MUSER	1		/* use copyin()/copyout() */
92#define	MB_MINLINE	2		/* use an inline copy loop */
93#define	MB_MZERO	3		/* bzero(), mb_put_mem only */
94#define	MB_MCUSTOM	4		/* use an user defined function */
95
96struct mbuf;
97struct mbchain;
98
99typedef int mb_copy_t(struct mbchain *mbp, c_caddr_t src, caddr_t dst,
100    size_t *srclen, size_t *dstlen);
101
102struct mbchain {
103	struct mbuf *	mb_top;		/* head of mbufs chain */
104	struct mbuf * 	mb_cur;		/* current mbuf */
105	int		mb_mleft;	/* free space in the current mbuf */
106	int		mb_count;	/* total number of bytes */
107	mb_copy_t *	mb_copy;	/* user defined copy function */
108	void *		mb_udata;	/* user data */
109};
110
111struct mdchain {
112	struct mbuf *	md_top;		/* head of mbufs chain */
113	struct mbuf * 	md_cur;		/* current mbuf */
114	u_char *	md_pos;		/* offset in the current mbuf */
115};
116
117int  mb_init(struct mbchain *mbp);
118void mb_initm(struct mbchain *mbp, struct mbuf *m);
119void mb_done(struct mbchain *mbp);
120struct mbuf *mb_detach(struct mbchain *mbp);
121int  mb_fixhdr(struct mbchain *mbp);
122caddr_t mb_reserve(struct mbchain *mbp, int size);
123
124int  mb_put_uint8(struct mbchain *mbp, u_int8_t x);
125int  mb_put_uint16be(struct mbchain *mbp, u_int16_t x);
126int  mb_put_uint16le(struct mbchain *mbp, u_int16_t x);
127int  mb_put_uint32be(struct mbchain *mbp, u_int32_t x);
128int  mb_put_uint32le(struct mbchain *mbp, u_int32_t x);
129int  mb_put_int64be(struct mbchain *mbp, int64_t x);
130int  mb_put_int64le(struct mbchain *mbp, int64_t x);
131int  mb_put_mem(struct mbchain *mbp, c_caddr_t source, int size, int type);
132int  mb_put_mbuf(struct mbchain *mbp, struct mbuf *m);
133int  mb_put_uio(struct mbchain *mbp, struct uio *uiop, int size);
134
135int  md_init(struct mdchain *mdp);
136void md_initm(struct mdchain *mbp, struct mbuf *m);
137void md_done(struct mdchain *mdp);
138void md_append_record(struct mdchain *mdp, struct mbuf *top);
139int  md_next_record(struct mdchain *mdp);
140int  md_get_uint8(struct mdchain *mdp, u_int8_t *x);
141int  md_get_uint16(struct mdchain *mdp, u_int16_t *x);
142int  md_get_uint16le(struct mdchain *mdp, u_int16_t *x);
143int  md_get_uint16be(struct mdchain *mdp, u_int16_t *x);
144int  md_get_uint32(struct mdchain *mdp, u_int32_t *x);
145int  md_get_uint32be(struct mdchain *mdp, u_int32_t *x);
146int  md_get_uint32le(struct mdchain *mdp, u_int32_t *x);
147int  md_get_int64(struct mdchain *mdp, int64_t *x);
148int  md_get_int64be(struct mdchain *mdp, int64_t *x);
149int  md_get_int64le(struct mdchain *mdp, int64_t *x);
150int  md_get_mem(struct mdchain *mdp, caddr_t target, int size, int type);
151int  md_get_mbuf(struct mdchain *mdp, int size, struct mbuf **m);
152int  md_get_uio(struct mdchain *mdp, struct uio *uiop, int size);
153
154#endif	/* ifdef _KERNEL */
155
156#endif	/* !_SYS_MCHAIN_H_ */
157