Annotation of libelwix/inc/elwix/apack.h, revision 1.8.2.2
1.4 misho 1: /*************************************************************************
2: * (C) 2013 AITNET ltd - Sofia/Bulgaria - <misho@aitnet.org>
3: * by Michael Pounov <misho@elwix.org>
4: *
5: * $Author: misho $
1.8.2.2 ! misho 6: * $Id: apack.h,v 1.8.2.1 2014/02/11 13:25:08 misho Exp $
1.4 misho 7: *
8: **************************************************************************
9: The ELWIX and AITNET software is distributed under the following
10: terms:
11:
12: All of the documentation and software included in the ELWIX and AITNET
13: Releases is copyrighted by ELWIX - Sofia/Bulgaria <info@elwix.org>
14:
1.5 misho 15: Copyright 2004 - 2014
1.4 misho 16: by Michael Pounov <misho@elwix.org>. All rights reserved.
17:
18: Redistribution and use in source and binary forms, with or without
19: modification, are permitted provided that the following conditions
20: are met:
21: 1. Redistributions of source code must retain the above copyright
22: notice, this list of conditions and the following disclaimer.
23: 2. Redistributions in binary form must reproduce the above copyright
24: notice, this list of conditions and the following disclaimer in the
25: documentation and/or other materials provided with the distribution.
26: 3. All advertising materials mentioning features or use of this software
27: must display the following acknowledgement:
28: This product includes software developed by Michael Pounov <misho@elwix.org>
29: ELWIX - Embedded LightWeight unIX and its contributors.
30: 4. Neither the name of AITNET nor the names of its contributors
31: may be used to endorse or promote products derived from this software
32: without specific prior written permission.
33:
34: THIS SOFTWARE IS PROVIDED BY AITNET AND CONTRIBUTORS ``AS IS'' AND
35: ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
36: IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
37: ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
38: FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
39: DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
40: OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
41: HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
42: LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
43: OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
44: SUCH DAMAGE.
45: */
1.2 misho 46: #ifndef __APACK_H
47: #define __APACK_H
48:
49:
50: typedef struct tagRawPacket {
51: size_t r_len;
52: uint8_t *r_buf;
53: uint8_t *r_next;
54: } rpack_t;
55:
1.3 misho 56: #define RPACK_INITIALIZER { .r_len = 0, .r_buf = NULL, .r_next = NULL }
1.2 misho 57: #define RPACK_FREE(x) (assert((x)), memset((x), 0, sizeof(rpack_t)))
58: #define RPACK_INIT(x, b, l) do { assert((x)); RPACK_FREE(x); \
59: (x)->r_buf = (b); \
60: (x)->r_len = (l); \
61: (x)->r_next = (x)->r_buf; \
62: } while (0)
63: #define RPACK_SANITY(x) ((x) && (x)->r_buf && (x)->r_next && (x)->r_next >= (x)->r_buf)
1.8.2.2 ! misho 64: #define RPACK_BUF(x) (assert((x)), (x)->r_buf)
1.2 misho 65: #define RPACK_LEN(x) (assert((x)), (x)->r_len)
66: #define RPACK_REWIND(x) (assert((x)), (x)->r_next = (x)->r_buf)
67:
68: #define RPACK_SET_16(x, n) do { assert((x)); \
69: *((uint8_t *) (x) + 1) = *((const uint8_t *) (n) + 1); \
70: *((uint8_t *) (x) + 0) = *((const uint8_t *) (n) + 0); \
71: } while (0)
72: #define RPACK_SET_24(x, n) do { assert((x)); \
73: *((uint8_t *) (x) + 2) = *((const uint8_t *) (n) + 2); \
74: *((uint8_t *) (x) + 1) = *((const uint8_t *) (n) + 1); \
75: *((uint8_t *) (x) + 0) = *((const uint8_t *) (n) + 0); \
76: } while (0)
77: #define RPACK_SET_32(x, n) do { assert((x)); \
78: *((uint8_t *) (x) + 3) = *((const uint8_t *) (n) + 3); \
79: *((uint8_t *) (x) + 2) = *((const uint8_t *) (n) + 2); \
80: *((uint8_t *) (x) + 1) = *((const uint8_t *) (n) + 1); \
81: *((uint8_t *) (x) + 0) = *((const uint8_t *) (n) + 0); \
82: } while (0)
83: #define RPACK_SET_64(x, n) do { assert((x)); \
84: *((uint8_t *) (x) + 7) = *((const uint8_t *) (n) + 7); \
85: *((uint8_t *) (x) + 6) = *((const uint8_t *) (n) + 6); \
86: *((uint8_t *) (x) + 5) = *((const uint8_t *) (n) + 5); \
87: *((uint8_t *) (x) + 4) = *((const uint8_t *) (n) + 4); \
88: *((uint8_t *) (x) + 3) = *((const uint8_t *) (n) + 3); \
89: *((uint8_t *) (x) + 2) = *((const uint8_t *) (n) + 2); \
90: *((uint8_t *) (x) + 1) = *((const uint8_t *) (n) + 1); \
91: *((uint8_t *) (x) + 0) = *((const uint8_t *) (n) + 0); \
92: } while (0)
93:
94: #define EXTRACT_LE_8(x) (assert((x)), *(x))
95: #define EXTRACT_LE_16(x) (assert((x)), (u_int16_t) ( \
96: (uint16_t) *((const uint8_t *) (x) + 1) << 8 | \
97: (uint16_t) *((const uint8_t *) (x) + 0) \
98: ))
99: #define EXTRACT_LE_24(x) (assert((x)), (u_int32_t) ( \
100: (uint32_t) *((const uint8_t *) (x) + 2) << 16 | \
101: (uint32_t) *((const uint8_t *) (x) + 1) << 8 | \
102: (uint32_t) *((const uint8_t *) (x) + 0) \
103: ))
104: #define EXTRACT_LE_32(x) (assert((x)), (u_int32_t) ( \
105: (uint32_t) *((const uint8_t *) (x) + 3) << 24 | \
106: (uint32_t) *((const uint8_t *) (x) + 2) << 16 | \
107: (uint32_t) *((const uint8_t *) (x) + 1) << 8 | \
108: (uint32_t) *((const uint8_t *) (x) + 0) \
109: ))
110: #define EXTRACT_LE_64(x) (assert((x)), (u_int64_t) ( \
111: (uint64_t) *((const uint8_t *) (x) + 7) << 56 | \
112: (uint64_t) *((const uint8_t *) (x) + 6) << 48 | \
113: (uint64_t) *((const uint8_t *) (x) + 5) << 40 | \
114: (uint64_t) *((const uint8_t *) (x) + 4) << 32 | \
115: (uint64_t) *((const uint8_t *) (x) + 3) << 24 | \
116: (uint64_t) *((const uint8_t *) (x) + 2) << 16 | \
117: (uint64_t) *((const uint8_t *) (x) + 1) << 8 | \
118: (uint64_t) *((const uint8_t *) (x) + 0) \
119: ))
120:
121: #define EXTRACT_BE_8(x) (assert((x)), *(x))
122: #define EXTRACT_BE_16(x) (assert((x)), (u_int16_t) ( \
123: (uint16_t) *((const uint8_t *) (x) + 0) << 8 | \
124: (uint16_t) *((const uint8_t *) (x) + 1) \
125: ))
126: #define EXTRACT_BE_24(x) (assert((x)), (u_int32_t) ( \
127: (uint32_t) *((const uint8_t *) (x) + 0) << 16 | \
128: (uint32_t) *((const uint8_t *) (x) + 1) << 8 | \
129: (uint32_t) *((const uint8_t *) (x) + 2) \
130: ))
131: #define EXTRACT_BE_32(x) (assert((x)), (u_int32_t) ( \
132: (uint32_t) *((const uint8_t *) (x) + 0) << 24 | \
133: (uint32_t) *((const uint8_t *) (x) + 1) << 16 | \
134: (uint32_t) *((const uint8_t *) (x) + 2) << 8 | \
135: (uint32_t) *((const uint8_t *) (x) + 3) \
136: ))
137: #define EXTRACT_BE_64(x) (assert((x)), (u_int64_t) ( \
138: (uint64_t) *((const uint8_t *) (x) + 0) << 56 | \
139: (uint64_t) *((const uint8_t *) (x) + 1) << 48 | \
140: (uint64_t) *((const uint8_t *) (x) + 2) << 40 | \
141: (uint64_t) *((const uint8_t *) (x) + 3) << 32 | \
142: (uint64_t) *((const uint8_t *) (x) + 4) << 24 | \
143: (uint64_t) *((const uint8_t *) (x) + 5) << 16 | \
144: (uint64_t) *((const uint8_t *) (x) + 6) << 8 | \
145: (uint64_t) *((const uint8_t *) (x) + 7) \
146: ))
147:
148:
149: /*
150: * rpack_align_and_reserve() - Align & reserve space
151: *
152: * @rp = raw buffer
153: * @siz = need size
154: * return: NULL error or not enough space, !=NULL next position
155: */
156: uint8_t *rpack_align_and_reserve(rpack_t * __restrict rp, size_t siz);
157:
158: /*
159: * rpack_create() - Allocate & init raw packet structure
160: *
161: * @buf = buffer
162: * @buflen = length of buffer
163: * return: NULL error or !=NULL raw packet, should be freed by rpack_destroy()
164: */
165: rpack_t *rpack_create(void * __restrict buf, size_t buflen);
166: /*
167: * rpack_destroy() - Release & free raw packet structure
168: *
169: * @rp = raw packet
170: * return: none
171: */
172: void rpack_destroy(rpack_t ** __restrict rp);
173:
174: /*
1.8.2.1 misho 175: * rpack_attach() - Attach dynamic allocating buffer at packet
176: *
177: * @rp = raw packet;
178: * @len = allocate bytes
179: * return: -1 error or 0 ok, should be detached with rpack_detach()
180: * before call rpack_destroy() after use!
181: */
182: int rpack_attach(rpack_t * __restrict rp, size_t len);
183: /*
184: * rpack_resize() - Resize dynamic allocated buffer at packet
185: *
186: * @rp = raw packet
187: * @newlen = resize buffer to bytes
188: * return: -1 error or 0 ok, should be detached with rpack_detach()
189: * before call rpack_destroy() after use!
190: */
191: int rpack_resize(rpack_t * __restrict rp, size_t newlen);
192: /*
193: * rpack_detach() - Detach and free dynamic allocated buffer from packet
194: *
195: * @rp = raw packet
196: * return: none
197: */
198: void rpack_detach(rpack_t * __restrict rp);
199:
200: /*
1.2 misho 201: * rpack_uint8() - Pack/Unpack 8bit value
202: *
203: * @rp = raw buffer
204: * @n = set value if !=NULL
205: * return: -1 error or get value
206: */
207: uint8_t rpack_uint8(rpack_t * __restrict rp, uint8_t * __restrict n);
208: /*
209: * rpack_uint16() - Pack/Unpack 16bit value
210: *
211: * @rp = raw buffer
212: * @n = set value if !=NULL
1.6 misho 213: * @be = extract in big-endian
1.2 misho 214: * return: -1 error or get value
215: */
1.6 misho 216: uint16_t rpack_uint16(rpack_t * __restrict rp, uint16_t * __restrict n, int be);
1.2 misho 217: /*
1.8 misho 218: * rpack_ruint16() - Pack/Unpack raw 16bit value
219: *
220: * @rp = raw buffer
221: * @n = set value if !=NULL
222: * @be = extract in big-endian
223: * return: -1 error or get value
224: */
225: uint16_t rpack_ruint16(rpack_t * __restrict rp, uint16_t * __restrict n, int be);
226: /*
1.2 misho 227: * rpack_uint24() - Pack/Unpack 24bit value
228: *
229: * @rp = raw buffer
230: * @n = set value if !=NULL
1.6 misho 231: * @be = extract in big-endian
1.2 misho 232: * return: -1 error or get value
233: */
1.6 misho 234: uint32_t rpack_uint24(rpack_t * __restrict rp, uint32_t * __restrict n, int be);
1.2 misho 235: /*
1.8 misho 236: * rpack_ruint24() - Pack/Unpack raw 24bit value
237: *
238: * @rp = raw buffer
239: * @n = set value if !=NULL
240: * @be = extract in big-endian
241: * return: -1 error or get value
242: */
243: uint32_t rpack_ruint24(rpack_t * __restrict rp, uint32_t * __restrict n, int be);
244: /*
1.2 misho 245: * rpack_uint32() - Pack/Unpack 32bit value
246: *
247: * @rp = raw buffer
248: * @n = set value if !=NULL
1.6 misho 249: * @be = extract in big-endian
1.2 misho 250: * return: -1 error or get value
251: */
1.6 misho 252: uint32_t rpack_uint32(rpack_t * __restrict rp, uint32_t * __restrict n, int be);
1.2 misho 253: /*
1.8 misho 254: * rpack_ruint32() - Pack/Unpack raw 32bit value
255: *
256: * @rp = raw buffer
257: * @n = set value if !=NULL
258: * @be = extract in big-endian
259: * return: -1 error or get value
260: */
261: uint32_t rpack_ruint32(rpack_t * __restrict rp, uint32_t * __restrict n, int be);
262: /*
1.2 misho 263: * rpack_uint64() - Pack/Unpack 64bit value
264: *
265: * @rp = raw buffer
266: * @n = set value if !=NULL
1.6 misho 267: * @be = extract in big-endian
1.2 misho 268: * return: -1 error or get value
269: */
1.6 misho 270: uint64_t rpack_uint64(rpack_t * __restrict rp, uint64_t * __restrict n, int be);
1.7 misho 271: /*
1.8 misho 272: * rpack_ruint64() - Pack/Unpack raw 64bit value
273: *
274: * @rp = raw buffer
275: * @n = set value if !=NULL
276: * @be = extract in big-endian
277: * return: -1 error or get value
278: */
279: uint64_t rpack_ruint64(rpack_t * __restrict rp, uint64_t * __restrict n, int be);
280: /*
1.7 misho 281: * rpack_data() - Pack/Unpack align data
282: *
283: * @rp = raw buffer
284: * @dat = data
285: * @datlen = data length
286: * return: NULL error or != NULL get data, must be e_free() after use!
287: */
288: void *rpack_data(rpack_t * __restrict rp, void * __restrict dat, size_t datlen);
289: /*
1.8 misho 290: * rpack_rdata() - Pack/Unpack raw data
1.7 misho 291: *
292: * @rp = raw buffer
293: * @dat = data
294: * @datlen = data length
295: * return: NULL error or != NULL get data, must be e_free() after use!
296: */
1.8 misho 297: void *rpack_rdata(rpack_t * __restrict rp, void * __restrict dat, size_t datlen);
1.2 misho 298:
299:
300: #endif
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/cvsweb/back.gif){kind=icon}
Return to apack.h CVS log ![[TXT]](/icons/cvsweb/text.gif){kind=icon}
![[DIR]](/icons/cvsweb/dir.gif){kind=icon}
Up to [ELWIX - Embedded LightWeight unIX -] / libelwix / inc / elwix