Annotation of libelwix/inc/elwix.h, revision 1.28
1.1 misho 1: /*************************************************************************
2: * (C) 2013 AITNET ltd - Sofia/Bulgaria - <misho@aitnet.org>
3: * by Michael Pounov <misho@elwix.org>
4: *
5: * $Author: misho $
1.28 ! misho 6: * $Id: elwix.h,v 1.27.2.1 2025/09/26 15:51:31 misho Exp $
1.1 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.26 misho 15: Copyright 2004 - 2025
1.1 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: */
46: #ifndef __ELWIX_H
47: #define __ELWIX_H
48:
49:
1.25 misho 50: #include <stdio.h>
1.1 misho 51: #include <assert.h>
52: #include <syslog.h>
1.14 misho 53: #include <stdarg.h>
1.27 misho 54: #include <stdalign.h>
1.1 misho 55: #include <sys/types.h>
1.6 misho 56: #include <sys/param.h>
1.14 misho 57: #include <sys/socket.h>
58: #include <sys/un.h>
59: #ifndef __linux__
1.6 misho 60: #include <sys/limits.h>
1.8 misho 61: #include <sys/endian.h>
1.1 misho 62: #include <net/if_dl.h>
1.15 misho 63: #else
64: #include <linux/if_packet.h>
1.14 misho 65: #endif
1.1 misho 66: #include <netinet/in.h>
67: #include <arpa/inet.h>
68:
1.14 misho 69: #include <elwix/aqueue.h>
1.1 misho 70: #include <elwix/atree.h>
71: #include <elwix/ampool.h>
72: #include <elwix/acrc.h>
73: #include <elwix/aarray.h>
74: #include <elwix/asarr.h>
75: #include <elwix/avar.h>
76: #include <elwix/astr.h>
77: #include <elwix/aregex.h>
1.2 misho 78: #include <elwix/aav.h>
1.1 misho 79: #include <elwix/anet.h>
1.2 misho 80: #include <elwix/atime.h>
1.7 misho 81: #include <elwix/apack.h>
1.9 misho 82: #include <elwix/apio.h>
1.16 misho 83: #include <elwix/ajson.h>
1.19 misho 84: #include <elwix/aiov.h>
1.20 misho 85: #include <elwix/aindex.h>
1.27 misho 86: #include <elwix/aring.h>
1.1 misho 87:
88:
89: #ifndef STRSIZ
90: #define STRSIZ 256
91: #endif
92:
1.6 misho 93: #ifndef NBBY
94: #define NBBY 8 /* number of bits in a byte */
95: #endif
96:
1.11 misho 97: #ifndef BYTE_ORDER
98: #ifndef LITTLE_ENDIAN
99: #define LITTLE_ENDIAN 1234
100: #endif /* LITTLE_ENDIAN */
101: #ifndef BIG_ENDIAN
102: #define BIG_ENDIAN 4321
103: #endif /* BIG_ENDIAN */
104: #ifdef WORDS_BIGENDIAN
105: #define BYTE_ORDER BIG_ENDIAN
106: #else /* WORDS_BIGENDIAN */
107: #define BYTE_ORDER LITTLE_ENDIAN
108: #endif /* WORDS_BIGENDIAN */
109: #endif /* BYTE_ORDER */
110:
1.1 misho 111: #ifndef be16toh
112: #define be16toh betoh16
113: #endif
114: #ifndef be32toh
115: #define be32toh betoh32
116: #endif
117: #ifndef be64toh
118: #define be64toh betoh64
119: #endif
120: #ifndef le16toh
121: #define le16toh letoh16
122: #endif
123: #ifndef le32toh
124: #define le32toh letoh32
125: #endif
126: #ifndef le64toh
127: #define le64toh letoh64
128: #endif
129:
1.6 misho 130: /* Bit map related macros. */
131: #ifndef setbit
132: #define setbit(a, i) (((unsigned char *)(a))[(i) / NBBY] |= 1 << ((i) % NBBY))
133: #endif
134: #ifndef clrbit
135: #define clrbit(a, i) (((unsigned char *)(a))[(i) / NBBY] &= ~(1 << ((i) % NBBY)))
136: #endif
137: #ifndef isset
138: #define isset(a, i) (((const unsigned char *)(a))[(i) / NBBY] & (1 << ((i) % NBBY)))
139: #endif
140: #ifndef isclr
141: #define isclr(a, i) ((((const unsigned char *)(a))[(i) / NBBY] & (1 << ((i) % NBBY))) == 0)
142: #endif
143:
144: /* Macros for counting and rounding. */
145: #ifndef howmany
146: #define howmany(x, y) (((x) + ((y) - 1)) / (y))
147: #endif
148: #ifndef nitems
149: #define nitems(x) (sizeof((x)) / sizeof((x)[0]))
150: #endif
151: #ifndef rounddown
152: #define rounddown(x, y) (((x) / (y)) * (y))
153: #endif
154: #ifndef rounddown2
155: #define rounddown2(x, y) ((x) & (~((y) - 1))) /* if y is power of two */
156: #endif
157: #ifndef roundup
158: #define roundup(x, y) ((((x) + ((y) - 1)) / (y)) * (y)) /* to any y */
159: #endif
160: #ifndef roundup2
161: #define roundup2(x, y) (((x) + ((y) - 1)) & (~((y) - 1))) /* if y is powers of two */
162: #endif
163: #ifndef powerof2
164: #define powerof2(x) ((((x) - 1) & (x)) == 0)
165: #endif
166:
167: /* Macros for min/max. */
168: #ifndef MIN
169: #define MIN(a, b) (((a) < (b)) ? (a) : (b))
170: #endif
171: #ifndef MAX
172: #define MAX(a, b) (((a) > (b)) ? (a) : (b))
173: #endif
174:
175: #define E_ALIGN(x, a) (((x) + ((a) - 1)) & ~((a) - 1))
1.1 misho 176:
177:
1.6 misho 178: #define ELWIX_SYSM 0
179: #define ELWIX_MPOOL 1
1.1 misho 180:
1.6 misho 181: #define VACUUM_LEFT 1
182: #define VACUUM_BETWEEN 2
1.1 misho 183:
184:
1.28 ! misho 185: typedef struct {
! 186: E_ATOMIC_ALIGN int value;
! 187: } e_atomic_int;
1.9 misho 188:
1.26 misho 189: #ifdef __cplusplus
190: extern "C" {
191: #endif
1.9 misho 192:
1.28 ! misho 193: extern int __isthreaded;
! 194:
1.1 misho 195: // elwix_SetProg() Set program memory pool name
1.3 misho 196: void elwix_SetProg(const char *csProgName);
1.1 misho 197: // elwix_GetProg() Get program memory pool name
1.3 misho 198: const char *elwix_GetProg();
1.1 misho 199:
200: // elwix_GetErrno() Get error code of last operation
1.3 misho 201: int elwix_GetErrno();
1.1 misho 202: // elwix_GetError() Get error text of last operation
1.3 misho 203: const char *elwix_GetError();
1.1 misho 204:
205:
206: // elwix_mm_inuse() Check for memory management model
1.3 misho 207: int elwix_mm_inuse();
1.1 misho 208:
209:
210: /*
211: * elwixInit() - Init libelwix library memory management
212: *
213: * @mm = memory management (IO_SYSM or IO_MPOOL)
214: * @maxmem = memory limit
215: * return: -1 error or !=-1 used memory management model
216: */
1.3 misho 217: int elwixInit(int mm, unsigned long maxmem);
1.1 misho 218: /*
219: * elwixFini() - Finish libelwix library memory management
220: *
221: * return: none
222: */
1.3 misho 223: void elwixFini();
1.1 misho 224:
1.11 misho 225: /*
226: * elwix_byteOrder() - Detect platform byte order
227: *
228: * return: 1 = little endian or 0 big endian
229: */
230: int elwix_byteOrder();
1.14 misho 231:
232: #ifndef strlcpy
233: /*
234: * Copy src to string dst of size siz. At most siz-1 characters
235: * will be copied. Always NUL terminates (unless siz == 0).
236: * Returns strlen(src); if retval >= siz, truncation occurred.
237: */
238: size_t strlcpy(char *dst, const char *src, size_t siz);
239: #endif
240: #ifndef strlcat
241: /*
242: * Appends src to string dst of size siz (unlike strncat, siz is the
243: * full size of dst, not space left). At most siz-1 characters
244: * will be copied. Always NUL terminates (unless siz <= strlen(dst)).
245: * Returns strlen(src) + MIN(siz, strlen(initial dst)).
246: * If retval >= siz, truncation occurred.
247: */
248: size_t strlcat(char *dst, const char *src, size_t siz);
249: #endif
1.11 misho 250:
1.1 misho 251: /* memory management hooks */
252: extern void *(*e_malloc)(size_t);
253: extern void *(*e_calloc)(size_t, size_t);
254: extern void *(*e_realloc)(void*, size_t);
255: extern char *(*e_strdup)(const char*);
256: extern void (*e_free)(void*);
257:
258:
259: /* Debug helper macros */
260:
261: /* Verbose macros */
262: extern int elwix_Verbose;
1.21 misho 263: #define e_Verbose elwix_Verbose
1.1 misho 264: #define e_initVerbose(x) (elwix_Verbose = (x))
265: #define e_incVerbose (elwix_Verbose++)
266: #define e_decVerbose (elwix_Verbose--)
267:
1.2 misho 268: #define EVERBS(x) if ((x) <= elwix_Verbose)
269: #define EVERBOSE(x, fmt, ...) do { assert((fmt)); \
270: if ((x) <= elwix_Verbose) { \
1.26 misho 271: char __str[BUFSIZ] = { 0 }; \
1.18 misho 272: snprintf(__str, sizeof __str, (fmt), ##__VA_ARGS__); \
273: syslog(LOG_INFO, "Verbose(%d):%s(%d): %s\n", \
274: (x), __func__, __LINE__, __str); \
275: } \
276: } while (0)
277: #define EVERBOSE2(x, fmt, ...) do { assert((fmt)); \
278: if ((x) <= elwix_Verbose) { \
1.26 misho 279: char __str[0x10000] = { 0 }; \
1.8 misho 280: snprintf(__str, sizeof __str, (fmt), ##__VA_ARGS__); \
1.16 misho 281: syslog(LOG_INFO, "Verbose(%d):%s(%d): %s\n", \
1.8 misho 282: (x), __func__, __LINE__, __str); \
1.2 misho 283: } \
284: } while (0)
1.1 misho 285:
286: /* Debug macros */
287: extern int elwix_Debug;
1.16 misho 288: #define e_Debug elwix_Debug
289:
1.1 misho 290: #define ELWIX_DEBUG_OFF 0x0
291: #define ELWIX_DEBUG_TRACE 0x1
292: #define ELWIX_DEBUG_LOG 0x2
1.22 misho 293: #define ELWIX_DEBUG_MEM 0x4
294: #define ELWIX_DEBUG_MEMORY ELWIX_DEBUG_MEM
295: #define ELWIX_DEBUG_IO 0x8
296: #define ELWIX_DEBUG_IPC 0x10
297: #define ELWIX_DEBUG_LOCK 0x20
298: #define ELWIX_DEBUG_SYS 0x40
299: #define ELWIX_DEBUG_NET 0x80
1.1 misho 300: #define ELWIX_DEBUG_ANY 0xFFFFFFFF
301:
1.24 misho 302: #define EDBG(x) (elwix_Debug & (x))
303: #define EDBGS(x) if (EDBG(x))
1.5 misho 304: #define ETRACE() if (elwix_Debug & ELWIX_DEBUG_TRACE) \
1.4 misho 305: syslog(LOG_DEBUG, "I'm in %s(%d)\n", __func__, __LINE__)
1.1 misho 306: #define EDEBUG(x, fmt, ...) do { assert((fmt)); \
307: if ((x) & elwix_Debug) { \
1.26 misho 308: char __str[BUFSIZ] = { 0 }; \
1.8 misho 309: snprintf(__str, sizeof __str, (fmt), ##__VA_ARGS__); \
1.1 misho 310: syslog(LOG_DEBUG, "Debug(%d):%s(%d): %s\n", \
1.8 misho 311: (x), __func__, __LINE__, __str); \
1.1 misho 312: } \
313: } while (0)
314:
315: /* Logger macro */
316: #define ELOGGER(x, fmt, ...) do { assert((fmt)); \
1.26 misho 317: char __str[BUFSIZ] = { 0 }; \
1.8 misho 318: snprintf(__str, sizeof __str, (fmt), ##__VA_ARGS__); \
1.26 misho 319: syslog((x), "Log:%s(%d): %s\n", \
1.8 misho 320: __func__, __LINE__, __str); \
1.1 misho 321: } while (0)
322:
1.12 misho 323: #define EWARNING(x, fmt, ...) do { assert((fmt)); \
1.26 misho 324: char __str[BUFSIZ] = { 0 }; \
1.12 misho 325: snprintf(__str, sizeof __str, (fmt), ##__VA_ARGS__); \
326: syslog(LOG_WARNING, "Warning:%s(%d): #%d - %s\n", \
327: __func__, __LINE__, (x), __str); \
328: } while (0)
1.1 misho 329: /* Error state macros */
330: #define EERROR(x, fmt, ...) do { assert((fmt)); \
1.26 misho 331: char __str[BUFSIZ] = { 0 }; \
1.8 misho 332: snprintf(__str, sizeof __str, (fmt), ##__VA_ARGS__); \
1.1 misho 333: syslog(LOG_ERR, "Error:%s(%d): #%d - %s\n", \
1.8 misho 334: __func__, __LINE__, (x), __str); \
1.1 misho 335: } while (0)
336: #define ESYSERR(x) do { \
1.17 misho 337: if (x > 0 || errno) { \
338: int _ern = errno; \
1.1 misho 339: syslog(LOG_ERR, "Error(sys):%s(%d): #%d - %s\n", \
340: __func__, __LINE__, x > 0 ? x : errno, \
341: strerror(x > 0 ? x : errno)); \
1.17 misho 342: errno = _ern; \
343: } \
1.1 misho 344: } while (0)
345: #define ELIBERR(ait) do { \
346: if (ait##_GetErrno()) \
347: syslog(LOG_ERR, "Error(lib):%s(%d): #%d - %s\n", \
348: __func__, __LINE__, ait##_GetErrno(), \
349: ait##_GetError()); \
350: } while (0)
351:
352:
1.26 misho 353: #ifdef __cplusplus
354: }
355: #endif
356:
1.1 misho 357: #endif
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/cvsweb/back.gif){kind=icon}
Return to elwix.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