Annotation of libelwix/inc/elwix/apack.h, revision 1.8.2.6
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.6 ! misho 6: * $Id: apack.h,v 1.8.2.5 2014/02/13 14:58:55 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.8.2.4 misho 65: #define RPACK_NEXT(x) (assert((x)), (x)->r_next)
1.2 misho 66: #define RPACK_LEN(x) (assert((x)), (x)->r_len)
67: #define RPACK_REWIND(x) (assert((x)), (x)->r_next = (x)->r_buf)
1.8.2.3 misho 68: #define RPACK_OFF(x) (assert((x)), (x)->r_next - (x)->r_buf)
1.8.2.4 misho 69: #define RPACK_REMAIN(x) (assert((x)), (x)->r_len - ((x)->r_next - (x)->r_buf))
1.2 misho 70:
71: #define RPACK_SET_16(x, n) do { assert((x)); \
72: *((uint8_t *) (x) + 1) = *((const uint8_t *) (n) + 1); \
73: *((uint8_t *) (x) + 0) = *((const uint8_t *) (n) + 0); \
74: } while (0)
75: #define RPACK_SET_24(x, n) do { assert((x)); \
76: *((uint8_t *) (x) + 2) = *((const uint8_t *) (n) + 2); \
77: *((uint8_t *) (x) + 1) = *((const uint8_t *) (n) + 1); \
78: *((uint8_t *) (x) + 0) = *((const uint8_t *) (n) + 0); \
79: } while (0)
80: #define RPACK_SET_32(x, n) do { assert((x)); \
81: *((uint8_t *) (x) + 3) = *((const uint8_t *) (n) + 3); \
82: *((uint8_t *) (x) + 2) = *((const uint8_t *) (n) + 2); \
83: *((uint8_t *) (x) + 1) = *((const uint8_t *) (n) + 1); \
84: *((uint8_t *) (x) + 0) = *((const uint8_t *) (n) + 0); \
85: } while (0)
86: #define RPACK_SET_64(x, n) do { assert((x)); \
87: *((uint8_t *) (x) + 7) = *((const uint8_t *) (n) + 7); \
88: *((uint8_t *) (x) + 6) = *((const uint8_t *) (n) + 6); \
89: *((uint8_t *) (x) + 5) = *((const uint8_t *) (n) + 5); \
90: *((uint8_t *) (x) + 4) = *((const uint8_t *) (n) + 4); \
91: *((uint8_t *) (x) + 3) = *((const uint8_t *) (n) + 3); \
92: *((uint8_t *) (x) + 2) = *((const uint8_t *) (n) + 2); \
93: *((uint8_t *) (x) + 1) = *((const uint8_t *) (n) + 1); \
94: *((uint8_t *) (x) + 0) = *((const uint8_t *) (n) + 0); \
95: } while (0)
96:
97: #define EXTRACT_LE_8(x) (assert((x)), *(x))
98: #define EXTRACT_LE_16(x) (assert((x)), (u_int16_t) ( \
99: (uint16_t) *((const uint8_t *) (x) + 1) << 8 | \
100: (uint16_t) *((const uint8_t *) (x) + 0) \
101: ))
102: #define EXTRACT_LE_24(x) (assert((x)), (u_int32_t) ( \
103: (uint32_t) *((const uint8_t *) (x) + 2) << 16 | \
104: (uint32_t) *((const uint8_t *) (x) + 1) << 8 | \
105: (uint32_t) *((const uint8_t *) (x) + 0) \
106: ))
107: #define EXTRACT_LE_32(x) (assert((x)), (u_int32_t) ( \
108: (uint32_t) *((const uint8_t *) (x) + 3) << 24 | \
109: (uint32_t) *((const uint8_t *) (x) + 2) << 16 | \
110: (uint32_t) *((const uint8_t *) (x) + 1) << 8 | \
111: (uint32_t) *((const uint8_t *) (x) + 0) \
112: ))
113: #define EXTRACT_LE_64(x) (assert((x)), (u_int64_t) ( \
114: (uint64_t) *((const uint8_t *) (x) + 7) << 56 | \
115: (uint64_t) *((const uint8_t *) (x) + 6) << 48 | \
116: (uint64_t) *((const uint8_t *) (x) + 5) << 40 | \
117: (uint64_t) *((const uint8_t *) (x) + 4) << 32 | \
118: (uint64_t) *((const uint8_t *) (x) + 3) << 24 | \
119: (uint64_t) *((const uint8_t *) (x) + 2) << 16 | \
120: (uint64_t) *((const uint8_t *) (x) + 1) << 8 | \
121: (uint64_t) *((const uint8_t *) (x) + 0) \
122: ))
123:
124: #define EXTRACT_BE_8(x) (assert((x)), *(x))
125: #define EXTRACT_BE_16(x) (assert((x)), (u_int16_t) ( \
126: (uint16_t) *((const uint8_t *) (x) + 0) << 8 | \
127: (uint16_t) *((const uint8_t *) (x) + 1) \
128: ))
129: #define EXTRACT_BE_24(x) (assert((x)), (u_int32_t) ( \
130: (uint32_t) *((const uint8_t *) (x) + 0) << 16 | \
131: (uint32_t) *((const uint8_t *) (x) + 1) << 8 | \
132: (uint32_t) *((const uint8_t *) (x) + 2) \
133: ))
134: #define EXTRACT_BE_32(x) (assert((x)), (u_int32_t) ( \
135: (uint32_t) *((const uint8_t *) (x) + 0) << 24 | \
136: (uint32_t) *((const uint8_t *) (x) + 1) << 16 | \
137: (uint32_t) *((const uint8_t *) (x) + 2) << 8 | \
138: (uint32_t) *((const uint8_t *) (x) + 3) \
139: ))
140: #define EXTRACT_BE_64(x) (assert((x)), (u_int64_t) ( \
141: (uint64_t) *((const uint8_t *) (x) + 0) << 56 | \
142: (uint64_t) *((const uint8_t *) (x) + 1) << 48 | \
143: (uint64_t) *((const uint8_t *) (x) + 2) << 40 | \
144: (uint64_t) *((const uint8_t *) (x) + 3) << 32 | \
145: (uint64_t) *((const uint8_t *) (x) + 4) << 24 | \
146: (uint64_t) *((const uint8_t *) (x) + 5) << 16 | \
147: (uint64_t) *((const uint8_t *) (x) + 6) << 8 | \
148: (uint64_t) *((const uint8_t *) (x) + 7) \
149: ))
150:
151:
152: /*
153: * rpack_align_and_reserve() - Align & reserve space
154: *
155: * @rp = raw buffer
156: * @siz = need size
157: * return: NULL error or not enough space, !=NULL next position
158: */
159: uint8_t *rpack_align_and_reserve(rpack_t * __restrict rp, size_t siz);
1.8.2.5 misho 160: /*
161: * rpack_next() - Get and set current position
162: *
163: * @rp = raw packet
1.8.2.6 ! misho 164: * @after_len = move aligned current position after length
1.8.2.5 misho 165: * return: NULL error or current position
166: */
167: uint8_t *rpack_next(rpack_t * __restrict rp, size_t after_len);
1.8.2.6 ! misho 168: /*
! 169: * rpack_rnext() - Get and set raw current position
! 170: *
! 171: * @rp = raw packet
! 172: * @after_len = !=0 move current position after length
! 173: * return: NULL error or raw current position
! 174: */
! 175: uint8_t *rpack_rnext(rpack_t * __restrict rp, size_t after_len);
1.2 misho 176:
177: /*
178: * rpack_create() - Allocate & init raw packet structure
179: *
180: * @buf = buffer
181: * @buflen = length of buffer
182: * return: NULL error or !=NULL raw packet, should be freed by rpack_destroy()
183: */
184: rpack_t *rpack_create(void * __restrict buf, size_t buflen);
185: /*
186: * rpack_destroy() - Release & free raw packet structure
187: *
188: * @rp = raw packet
189: * return: none
190: */
191: void rpack_destroy(rpack_t ** __restrict rp);
192:
193: /*
1.8.2.1 misho 194: * rpack_attach() - Attach dynamic allocating buffer at packet
195: *
196: * @rp = raw packet;
197: * @len = allocate bytes
198: * return: -1 error or 0 ok, should be detached with rpack_detach()
199: * before call rpack_destroy() after use!
200: */
201: int rpack_attach(rpack_t * __restrict rp, size_t len);
202: /*
203: * rpack_resize() - Resize dynamic allocated buffer at packet
204: *
205: * @rp = raw packet
206: * @newlen = resize buffer to bytes
207: * return: -1 error or 0 ok, should be detached with rpack_detach()
208: * before call rpack_destroy() after use!
209: */
210: int rpack_resize(rpack_t * __restrict rp, size_t newlen);
211: /*
212: * rpack_detach() - Detach and free dynamic allocated buffer from packet
213: *
214: * @rp = raw packet
215: * return: none
216: */
217: void rpack_detach(rpack_t * __restrict rp);
218:
219: /*
1.2 misho 220: * rpack_uint8() - Pack/Unpack 8bit value
221: *
222: * @rp = raw buffer
223: * @n = set value if !=NULL
224: * return: -1 error or get value
225: */
226: uint8_t rpack_uint8(rpack_t * __restrict rp, uint8_t * __restrict n);
227: /*
228: * rpack_uint16() - Pack/Unpack 16bit value
229: *
230: * @rp = raw buffer
231: * @n = set value if !=NULL
1.6 misho 232: * @be = extract in big-endian
1.2 misho 233: * return: -1 error or get value
234: */
1.6 misho 235: uint16_t rpack_uint16(rpack_t * __restrict rp, uint16_t * __restrict n, int be);
1.2 misho 236: /*
1.8 misho 237: * rpack_ruint16() - Pack/Unpack raw 16bit value
238: *
239: * @rp = raw buffer
240: * @n = set value if !=NULL
241: * @be = extract in big-endian
242: * return: -1 error or get value
243: */
244: uint16_t rpack_ruint16(rpack_t * __restrict rp, uint16_t * __restrict n, int be);
245: /*
1.2 misho 246: * rpack_uint24() - Pack/Unpack 24bit value
247: *
248: * @rp = raw buffer
249: * @n = set value if !=NULL
1.6 misho 250: * @be = extract in big-endian
1.2 misho 251: * return: -1 error or get value
252: */
1.6 misho 253: uint32_t rpack_uint24(rpack_t * __restrict rp, uint32_t * __restrict n, int be);
1.2 misho 254: /*
1.8 misho 255: * rpack_ruint24() - Pack/Unpack raw 24bit value
256: *
257: * @rp = raw buffer
258: * @n = set value if !=NULL
259: * @be = extract in big-endian
260: * return: -1 error or get value
261: */
262: uint32_t rpack_ruint24(rpack_t * __restrict rp, uint32_t * __restrict n, int be);
263: /*
1.2 misho 264: * rpack_uint32() - Pack/Unpack 32bit value
265: *
266: * @rp = raw buffer
267: * @n = set value if !=NULL
1.6 misho 268: * @be = extract in big-endian
1.2 misho 269: * return: -1 error or get value
270: */
1.6 misho 271: uint32_t rpack_uint32(rpack_t * __restrict rp, uint32_t * __restrict n, int be);
1.2 misho 272: /*
1.8 misho 273: * rpack_ruint32() - Pack/Unpack raw 32bit value
274: *
275: * @rp = raw buffer
276: * @n = set value if !=NULL
277: * @be = extract in big-endian
278: * return: -1 error or get value
279: */
280: uint32_t rpack_ruint32(rpack_t * __restrict rp, uint32_t * __restrict n, int be);
281: /*
1.2 misho 282: * rpack_uint64() - Pack/Unpack 64bit value
283: *
284: * @rp = raw buffer
285: * @n = set value if !=NULL
1.6 misho 286: * @be = extract in big-endian
1.2 misho 287: * return: -1 error or get value
288: */
1.6 misho 289: uint64_t rpack_uint64(rpack_t * __restrict rp, uint64_t * __restrict n, int be);
1.7 misho 290: /*
1.8 misho 291: * rpack_ruint64() - Pack/Unpack raw 64bit value
292: *
293: * @rp = raw buffer
294: * @n = set value if !=NULL
295: * @be = extract in big-endian
296: * return: -1 error or get value
297: */
298: uint64_t rpack_ruint64(rpack_t * __restrict rp, uint64_t * __restrict n, int be);
299: /*
1.7 misho 300: * rpack_data() - Pack/Unpack align data
301: *
302: * @rp = raw buffer
303: * @dat = data
304: * @datlen = data length
305: * return: NULL error or != NULL get data, must be e_free() after use!
306: */
307: void *rpack_data(rpack_t * __restrict rp, void * __restrict dat, size_t datlen);
308: /*
1.8 misho 309: * rpack_rdata() - Pack/Unpack raw data
1.7 misho 310: *
311: * @rp = raw buffer
312: * @dat = data
313: * @datlen = data length
314: * return: NULL error or != NULL get data, must be e_free() after use!
315: */
1.8 misho 316: void *rpack_rdata(rpack_t * __restrict rp, void * __restrict dat, size_t datlen);
1.2 misho 317:
318:
319: #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