Annotation of libelwix/inc/elwix.h, revision 1.33
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.33 ! misho 6: * $Id: elwix.h,v 1.32.4.2 2026/07/29 01:09:33 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.30 misho 15: Copyright 2004 - 2026
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>
1.32 misho 59: #ifndef __cplusplus
60: #include <stdatomic.h>
61: #else
62: #include <atomic>
63: #define _Atomic(X) std::atomic<X>
64: #endif
1.14 misho 65: #ifndef __linux__
1.6 misho 66: #include <sys/limits.h>
1.8 misho 67: #include <sys/endian.h>
1.1 misho 68: #include <net/if_dl.h>
1.15 misho 69: #else
70: #include <linux/if_packet.h>
1.14 misho 71: #endif
1.1 misho 72: #include <netinet/in.h>
73: #include <arpa/inet.h>
74:
1.14 misho 75: #include <elwix/aqueue.h>
1.1 misho 76: #include <elwix/atree.h>
77: #include <elwix/ampool.h>
78: #include <elwix/acrc.h>
79: #include <elwix/aarray.h>
80: #include <elwix/asarr.h>
81: #include <elwix/avar.h>
82: #include <elwix/astr.h>
83: #include <elwix/aregex.h>
1.2 misho 84: #include <elwix/aav.h>
1.1 misho 85: #include <elwix/anet.h>
1.2 misho 86: #include <elwix/atime.h>
1.7 misho 87: #include <elwix/apack.h>
1.9 misho 88: #include <elwix/apio.h>
1.16 misho 89: #include <elwix/ajson.h>
1.19 misho 90: #include <elwix/aiov.h>
1.20 misho 91: #include <elwix/aindex.h>
1.27 misho 92: #include <elwix/aring.h>
1.29 misho 93: #include <elwix/auuid.h>
1.1 misho 94:
95:
96: #ifndef STRSIZ
97: #define STRSIZ 256
98: #endif
99:
1.6 misho 100: #ifndef NBBY
101: #define NBBY 8 /* number of bits in a byte */
102: #endif
103:
1.11 misho 104: #ifndef BYTE_ORDER
105: #ifndef LITTLE_ENDIAN
106: #define LITTLE_ENDIAN 1234
107: #endif /* LITTLE_ENDIAN */
108: #ifndef BIG_ENDIAN
109: #define BIG_ENDIAN 4321
110: #endif /* BIG_ENDIAN */
111: #ifdef WORDS_BIGENDIAN
112: #define BYTE_ORDER BIG_ENDIAN
113: #else /* WORDS_BIGENDIAN */
114: #define BYTE_ORDER LITTLE_ENDIAN
115: #endif /* WORDS_BIGENDIAN */
116: #endif /* BYTE_ORDER */
117:
1.1 misho 118: #ifndef be16toh
119: #define be16toh betoh16
120: #endif
121: #ifndef be32toh
122: #define be32toh betoh32
123: #endif
124: #ifndef be64toh
125: #define be64toh betoh64
126: #endif
127: #ifndef le16toh
128: #define le16toh letoh16
129: #endif
130: #ifndef le32toh
131: #define le32toh letoh32
132: #endif
133: #ifndef le64toh
134: #define le64toh letoh64
135: #endif
136:
1.6 misho 137: /* Bit map related macros. */
138: #ifndef setbit
139: #define setbit(a, i) (((unsigned char *)(a))[(i) / NBBY] |= 1 << ((i) % NBBY))
140: #endif
141: #ifndef clrbit
142: #define clrbit(a, i) (((unsigned char *)(a))[(i) / NBBY] &= ~(1 << ((i) % NBBY)))
143: #endif
144: #ifndef isset
145: #define isset(a, i) (((const unsigned char *)(a))[(i) / NBBY] & (1 << ((i) % NBBY)))
146: #endif
147: #ifndef isclr
148: #define isclr(a, i) ((((const unsigned char *)(a))[(i) / NBBY] & (1 << ((i) % NBBY))) == 0)
149: #endif
150:
151: /* Macros for counting and rounding. */
152: #ifndef howmany
153: #define howmany(x, y) (((x) + ((y) - 1)) / (y))
154: #endif
155: #ifndef nitems
156: #define nitems(x) (sizeof((x)) / sizeof((x)[0]))
157: #endif
158: #ifndef rounddown
159: #define rounddown(x, y) (((x) / (y)) * (y))
160: #endif
161: #ifndef rounddown2
162: #define rounddown2(x, y) ((x) & (~((y) - 1))) /* if y is power of two */
163: #endif
164: #ifndef roundup
165: #define roundup(x, y) ((((x) + ((y) - 1)) / (y)) * (y)) /* to any y */
166: #endif
167: #ifndef roundup2
168: #define roundup2(x, y) (((x) + ((y) - 1)) & (~((y) - 1))) /* if y is powers of two */
169: #endif
170: #ifndef powerof2
171: #define powerof2(x) ((((x) - 1) & (x)) == 0)
172: #endif
173:
1.33 ! misho 174: /* timespec helpers */
! 175: /* Operations on timevals. */
! 176: #ifndef timerclear
! 177: #define timerclear(tvp) ((tvp)->tv_sec = (tvp)->tv_usec = 0)
! 178: #endif
! 179:
! 180: #ifndef timerisset
! 181: #define timerisset(tvp) ((tvp)->tv_sec || (tvp)->tv_usec)
! 182: #endif
! 183:
! 184: #ifndef timercmp
! 185: #define timercmp(tvp, uvp, cmp) \
! 186: (((tvp)->tv_sec == (uvp)->tv_sec) ? \
! 187: ((tvp)->tv_usec cmp (uvp)->tv_usec) : \
! 188: ((tvp)->tv_sec cmp (uvp)->tv_sec))
! 189: #endif
! 190:
! 191: #ifndef timeradd
! 192: #define timeradd(tvp, uvp, vvp) \
! 193: do { \
! 194: (vvp)->tv_sec = (tvp)->tv_sec + (uvp)->tv_sec; \
! 195: (vvp)->tv_usec = (tvp)->tv_usec + (uvp)->tv_usec; \
! 196: if ((vvp)->tv_usec >= 1000000) { \
! 197: (vvp)->tv_sec++; \
! 198: (vvp)->tv_usec -= 1000000; \
! 199: } \
! 200: } while (0)
! 201: #endif
! 202:
! 203: #ifndef timersub
! 204: #define timersub(tvp, uvp, vvp) \
! 205: do { \
! 206: (vvp)->tv_sec = (tvp)->tv_sec - (uvp)->tv_sec; \
! 207: (vvp)->tv_usec = (tvp)->tv_usec - (uvp)->tv_usec; \
! 208: if ((vvp)->tv_usec < 0) { \
! 209: (vvp)->tv_sec--; \
! 210: (vvp)->tv_usec += 1000000; \
! 211: } \
! 212: } while (0)
! 213: #endif
! 214:
! 215: /* Operations on timespecs. */
! 216: #ifndef timespecclear
! 217: #define timespecclear(tsp) ((tsp)->tv_sec = (tsp)->tv_nsec = 0)
! 218: #endif
! 219:
! 220: #ifndef timespecisset
! 221: #define timespecisset(tsp) ((tsp)->tv_sec || (tsp)->tv_nsec)
! 222: #endif
! 223:
! 224: #ifndef timespeccmp
! 225: #define timespeccmp(tsp, usp, cmp) \
! 226: (((tsp)->tv_sec == (usp)->tv_sec) ? \
! 227: ((tsp)->tv_nsec cmp (usp)->tv_nsec) : \
! 228: ((tsp)->tv_sec cmp (usp)->tv_sec))
! 229: #endif
! 230:
! 231: #ifndef timespecadd
! 232: #define timespecadd(tsp, usp, vsp) \
! 233: do { \
! 234: (vsp)->tv_sec = (tsp)->tv_sec + (usp)->tv_sec; \
! 235: (vsp)->tv_nsec = (tsp)->tv_nsec + (usp)->tv_nsec; \
! 236: if ((vsp)->tv_nsec >= 1000000000L) { \
! 237: (vsp)->tv_sec++; \
! 238: (vsp)->tv_nsec -= 1000000000L; \
! 239: } \
! 240: } while (0)
! 241: #endif
! 242:
! 243: #ifndef timespecsub
! 244: #define timespecsub(tsp, usp, vsp) \
! 245: do { \
! 246: (vsp)->tv_sec = (tsp)->tv_sec - (usp)->tv_sec; \
! 247: (vsp)->tv_nsec = (tsp)->tv_nsec - (usp)->tv_nsec; \
! 248: if ((vsp)->tv_nsec < 0) { \
! 249: (vsp)->tv_sec--; \
! 250: (vsp)->tv_nsec += 1000000000L; \
! 251: } \
! 252: } while (0)
! 253: #endif
! 254:
1.6 misho 255: /* Macros for min/max. */
256: #ifndef MIN
257: #define MIN(a, b) (((a) < (b)) ? (a) : (b))
258: #endif
259: #ifndef MAX
260: #define MAX(a, b) (((a) > (b)) ? (a) : (b))
261: #endif
262:
263: #define E_ALIGN(x, a) (((x) + ((a) - 1)) & ~((a) - 1))
1.1 misho 264:
265:
1.6 misho 266: #define ELWIX_SYSM 0
267: #define ELWIX_MPOOL 1
1.1 misho 268:
1.6 misho 269: #define VACUUM_LEFT 1
270: #define VACUUM_BETWEEN 2
1.1 misho 271:
272:
1.28 misho 273: typedef struct {
274: E_ATOMIC_ALIGN int value;
275: } e_atomic_int;
1.9 misho 276:
1.26 misho 277: #ifdef __cplusplus
278: extern "C" {
279: #endif
1.9 misho 280:
1.28 misho 281: extern int __isthreaded;
282:
1.1 misho 283: // elwix_SetProg() Set program memory pool name
1.3 misho 284: void elwix_SetProg(const char *csProgName);
1.1 misho 285: // elwix_GetProg() Get program memory pool name
1.3 misho 286: const char *elwix_GetProg();
1.1 misho 287:
288: // elwix_GetErrno() Get error code of last operation
1.3 misho 289: int elwix_GetErrno();
1.1 misho 290: // elwix_GetError() Get error text of last operation
1.3 misho 291: const char *elwix_GetError();
1.1 misho 292:
293:
294: // elwix_mm_inuse() Check for memory management model
1.3 misho 295: int elwix_mm_inuse();
1.1 misho 296:
297:
298: /*
299: * elwixInit() - Init libelwix library memory management
300: *
301: * @mm = memory management (IO_SYSM or IO_MPOOL)
302: * @maxmem = memory limit
303: * return: -1 error or !=-1 used memory management model
304: */
1.3 misho 305: int elwixInit(int mm, unsigned long maxmem);
1.1 misho 306: /*
307: * elwixFini() - Finish libelwix library memory management
308: *
309: * return: none
310: */
1.3 misho 311: void elwixFini();
1.1 misho 312:
1.11 misho 313: /*
314: * elwix_byteOrder() - Detect platform byte order
315: *
316: * return: 1 = little endian or 0 big endian
317: */
318: int elwix_byteOrder();
1.14 misho 319:
320: #ifndef strlcpy
321: /*
322: * Copy src to string dst of size siz. At most siz-1 characters
323: * will be copied. Always NUL terminates (unless siz == 0).
324: * Returns strlen(src); if retval >= siz, truncation occurred.
325: */
326: size_t strlcpy(char *dst, const char *src, size_t siz);
327: #endif
328: #ifndef strlcat
329: /*
330: * Appends src to string dst of size siz (unlike strncat, siz is the
331: * full size of dst, not space left). At most siz-1 characters
332: * will be copied. Always NUL terminates (unless siz <= strlen(dst)).
333: * Returns strlen(src) + MIN(siz, strlen(initial dst)).
334: * If retval >= siz, truncation occurred.
335: */
336: size_t strlcat(char *dst, const char *src, size_t siz);
337: #endif
1.11 misho 338:
1.1 misho 339: /* memory management hooks */
340: extern void *(*e_malloc)(size_t);
341: extern void *(*e_calloc)(size_t, size_t);
342: extern void *(*e_realloc)(void*, size_t);
343: extern char *(*e_strdup)(const char*);
344: extern void (*e_free)(void*);
345:
346:
347: /* Debug helper macros */
348:
349: /* Verbose macros */
350: extern int elwix_Verbose;
1.21 misho 351: #define e_Verbose elwix_Verbose
1.1 misho 352: #define e_initVerbose(x) (elwix_Verbose = (x))
353: #define e_incVerbose (elwix_Verbose++)
354: #define e_decVerbose (elwix_Verbose--)
355:
1.2 misho 356: #define EVERBS(x) if ((x) <= elwix_Verbose)
357: #define EVERBOSE(x, fmt, ...) do { assert((fmt)); \
358: if ((x) <= elwix_Verbose) { \
1.26 misho 359: char __str[BUFSIZ] = { 0 }; \
1.18 misho 360: snprintf(__str, sizeof __str, (fmt), ##__VA_ARGS__); \
361: syslog(LOG_INFO, "Verbose(%d):%s(%d): %s\n", \
362: (x), __func__, __LINE__, __str); \
363: } \
364: } while (0)
365: #define EVERBOSE2(x, fmt, ...) do { assert((fmt)); \
366: if ((x) <= elwix_Verbose) { \
1.26 misho 367: char __str[0x10000] = { 0 }; \
1.8 misho 368: snprintf(__str, sizeof __str, (fmt), ##__VA_ARGS__); \
1.16 misho 369: syslog(LOG_INFO, "Verbose(%d):%s(%d): %s\n", \
1.8 misho 370: (x), __func__, __LINE__, __str); \
1.2 misho 371: } \
372: } while (0)
1.1 misho 373:
374: /* Debug macros */
375: extern int elwix_Debug;
1.16 misho 376: #define e_Debug elwix_Debug
377:
1.1 misho 378: #define ELWIX_DEBUG_OFF 0x0
379: #define ELWIX_DEBUG_TRACE 0x1
380: #define ELWIX_DEBUG_LOG 0x2
1.22 misho 381: #define ELWIX_DEBUG_MEM 0x4
382: #define ELWIX_DEBUG_MEMORY ELWIX_DEBUG_MEM
383: #define ELWIX_DEBUG_IO 0x8
384: #define ELWIX_DEBUG_IPC 0x10
385: #define ELWIX_DEBUG_LOCK 0x20
386: #define ELWIX_DEBUG_SYS 0x40
387: #define ELWIX_DEBUG_NET 0x80
1.31 misho 388: #define ELWIX_DEBUG_1 0x100
389: #define ELWIX_DEBUG_2 0x200
390: #define ELWIX_DEBUG_3 0x400
391: #define ELWIX_DEBUG_4 0x800
1.1 misho 392: #define ELWIX_DEBUG_ANY 0xFFFFFFFF
393:
1.24 misho 394: #define EDBG(x) (elwix_Debug & (x))
395: #define EDBGS(x) if (EDBG(x))
1.5 misho 396: #define ETRACE() if (elwix_Debug & ELWIX_DEBUG_TRACE) \
1.4 misho 397: syslog(LOG_DEBUG, "I'm in %s(%d)\n", __func__, __LINE__)
1.1 misho 398: #define EDEBUG(x, fmt, ...) do { assert((fmt)); \
399: if ((x) & elwix_Debug) { \
1.26 misho 400: char __str[BUFSIZ] = { 0 }; \
1.8 misho 401: snprintf(__str, sizeof __str, (fmt), ##__VA_ARGS__); \
1.1 misho 402: syslog(LOG_DEBUG, "Debug(%d):%s(%d): %s\n", \
1.8 misho 403: (x), __func__, __LINE__, __str); \
1.1 misho 404: } \
405: } while (0)
406:
407: /* Logger macro */
408: #define ELOGGER(x, fmt, ...) do { assert((fmt)); \
1.26 misho 409: char __str[BUFSIZ] = { 0 }; \
1.8 misho 410: snprintf(__str, sizeof __str, (fmt), ##__VA_ARGS__); \
1.26 misho 411: syslog((x), "Log:%s(%d): %s\n", \
1.8 misho 412: __func__, __LINE__, __str); \
1.1 misho 413: } while (0)
414:
1.12 misho 415: #define EWARNING(x, fmt, ...) do { assert((fmt)); \
1.26 misho 416: char __str[BUFSIZ] = { 0 }; \
1.12 misho 417: snprintf(__str, sizeof __str, (fmt), ##__VA_ARGS__); \
418: syslog(LOG_WARNING, "Warning:%s(%d): #%d - %s\n", \
419: __func__, __LINE__, (x), __str); \
420: } while (0)
1.1 misho 421: /* Error state macros */
422: #define EERROR(x, fmt, ...) do { assert((fmt)); \
1.26 misho 423: char __str[BUFSIZ] = { 0 }; \
1.8 misho 424: snprintf(__str, sizeof __str, (fmt), ##__VA_ARGS__); \
1.1 misho 425: syslog(LOG_ERR, "Error:%s(%d): #%d - %s\n", \
1.8 misho 426: __func__, __LINE__, (x), __str); \
1.1 misho 427: } while (0)
428: #define ESYSERR(x) do { \
1.17 misho 429: if (x > 0 || errno) { \
430: int _ern = errno; \
1.1 misho 431: syslog(LOG_ERR, "Error(sys):%s(%d): #%d - %s\n", \
432: __func__, __LINE__, x > 0 ? x : errno, \
433: strerror(x > 0 ? x : errno)); \
1.17 misho 434: errno = _ern; \
435: } \
1.1 misho 436: } while (0)
437: #define ELIBERR(ait) do { \
438: if (ait##_GetErrno()) \
439: syslog(LOG_ERR, "Error(lib):%s(%d): #%d - %s\n", \
440: __func__, __LINE__, ait##_GetErrno(), \
441: ait##_GetError()); \
442: } while (0)
443:
444:
1.26 misho 445: #ifdef __cplusplus
446: }
447: #endif
448:
1.1 misho 449: #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