Annotation of libelwix/inc/elwix.h, revision 1.27
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.27 ! misho 6: * $Id: elwix.h,v 1.26.4.1 2025/09/26 08:58:05 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.27 ! misho 69: #ifndef __cplusplus
! 70: #include <stdatomic.h>
! 71: #else
! 72: #include <atomic>
! 73: #define _Atomic(X) std::atomic< X >
! 74: #endif
! 75:
1.14 misho 76: #include <elwix/aqueue.h>
1.1 misho 77: #include <elwix/atree.h>
78: #include <elwix/ampool.h>
79: #include <elwix/acrc.h>
80: #include <elwix/aarray.h>
81: #include <elwix/asarr.h>
82: #include <elwix/avar.h>
83: #include <elwix/astr.h>
84: #include <elwix/aregex.h>
1.2 misho 85: #include <elwix/aav.h>
1.1 misho 86: #include <elwix/anet.h>
1.2 misho 87: #include <elwix/atime.h>
1.7 misho 88: #include <elwix/apack.h>
1.9 misho 89: #include <elwix/apio.h>
1.16 misho 90: #include <elwix/ajson.h>
1.19 misho 91: #include <elwix/aiov.h>
1.20 misho 92: #include <elwix/aindex.h>
1.27 ! misho 93: #include <elwix/aring.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:
174: /* Macros for min/max. */
175: #ifndef MIN
176: #define MIN(a, b) (((a) < (b)) ? (a) : (b))
177: #endif
178: #ifndef MAX
179: #define MAX(a, b) (((a) > (b)) ? (a) : (b))
180: #endif
181:
182: #define E_ALIGN(x, a) (((x) + ((a) - 1)) & ~((a) - 1))
1.1 misho 183:
184:
1.6 misho 185: #define ELWIX_SYSM 0
186: #define ELWIX_MPOOL 1
1.1 misho 187:
1.6 misho 188: #define VACUUM_LEFT 1
189: #define VACUUM_BETWEEN 2
1.1 misho 190:
191:
1.9 misho 192: extern int __isthreaded;
193:
1.26 misho 194: #ifdef __cplusplus
195: extern "C" {
196: #endif
1.9 misho 197:
1.1 misho 198: // elwix_SetProg() Set program memory pool name
1.3 misho 199: void elwix_SetProg(const char *csProgName);
1.1 misho 200: // elwix_GetProg() Get program memory pool name
1.3 misho 201: const char *elwix_GetProg();
1.1 misho 202:
203: // elwix_GetErrno() Get error code of last operation
1.3 misho 204: int elwix_GetErrno();
1.1 misho 205: // elwix_GetError() Get error text of last operation
1.3 misho 206: const char *elwix_GetError();
1.1 misho 207:
208:
209: // elwix_mm_inuse() Check for memory management model
1.3 misho 210: int elwix_mm_inuse();
1.1 misho 211:
212:
213: /*
214: * elwixInit() - Init libelwix library memory management
215: *
216: * @mm = memory management (IO_SYSM or IO_MPOOL)
217: * @maxmem = memory limit
218: * return: -1 error or !=-1 used memory management model
219: */
1.3 misho 220: int elwixInit(int mm, unsigned long maxmem);
1.1 misho 221: /*
222: * elwixFini() - Finish libelwix library memory management
223: *
224: * return: none
225: */
1.3 misho 226: void elwixFini();
1.1 misho 227:
1.11 misho 228: /*
229: * elwix_byteOrder() - Detect platform byte order
230: *
231: * return: 1 = little endian or 0 big endian
232: */
233: int elwix_byteOrder();
1.14 misho 234:
235: #ifndef strlcpy
236: /*
237: * Copy src to string dst of size siz. At most siz-1 characters
238: * will be copied. Always NUL terminates (unless siz == 0).
239: * Returns strlen(src); if retval >= siz, truncation occurred.
240: */
241: size_t strlcpy(char *dst, const char *src, size_t siz);
242: #endif
243: #ifndef strlcat
244: /*
245: * Appends src to string dst of size siz (unlike strncat, siz is the
246: * full size of dst, not space left). At most siz-1 characters
247: * will be copied. Always NUL terminates (unless siz <= strlen(dst)).
248: * Returns strlen(src) + MIN(siz, strlen(initial dst)).
249: * If retval >= siz, truncation occurred.
250: */
251: size_t strlcat(char *dst, const char *src, size_t siz);
252: #endif
1.11 misho 253:
1.1 misho 254: /* memory management hooks */
255: extern void *(*e_malloc)(size_t);
256: extern void *(*e_calloc)(size_t, size_t);
257: extern void *(*e_realloc)(void*, size_t);
258: extern char *(*e_strdup)(const char*);
259: extern void (*e_free)(void*);
260:
261:
262: /* Debug helper macros */
263:
264: /* Verbose macros */
265: extern int elwix_Verbose;
1.21 misho 266: #define e_Verbose elwix_Verbose
1.1 misho 267: #define e_initVerbose(x) (elwix_Verbose = (x))
268: #define e_incVerbose (elwix_Verbose++)
269: #define e_decVerbose (elwix_Verbose--)
270:
1.2 misho 271: #define EVERBS(x) if ((x) <= elwix_Verbose)
272: #define EVERBOSE(x, fmt, ...) do { assert((fmt)); \
273: if ((x) <= elwix_Verbose) { \
1.26 misho 274: char __str[BUFSIZ] = { 0 }; \
1.18 misho 275: snprintf(__str, sizeof __str, (fmt), ##__VA_ARGS__); \
276: syslog(LOG_INFO, "Verbose(%d):%s(%d): %s\n", \
277: (x), __func__, __LINE__, __str); \
278: } \
279: } while (0)
280: #define EVERBOSE2(x, fmt, ...) do { assert((fmt)); \
281: if ((x) <= elwix_Verbose) { \
1.26 misho 282: char __str[0x10000] = { 0 }; \
1.8 misho 283: snprintf(__str, sizeof __str, (fmt), ##__VA_ARGS__); \
1.16 misho 284: syslog(LOG_INFO, "Verbose(%d):%s(%d): %s\n", \
1.8 misho 285: (x), __func__, __LINE__, __str); \
1.2 misho 286: } \
287: } while (0)
1.1 misho 288:
289: /* Debug macros */
290: extern int elwix_Debug;
1.16 misho 291: #define e_Debug elwix_Debug
292:
1.1 misho 293: #define ELWIX_DEBUG_OFF 0x0
294: #define ELWIX_DEBUG_TRACE 0x1
295: #define ELWIX_DEBUG_LOG 0x2
1.22 misho 296: #define ELWIX_DEBUG_MEM 0x4
297: #define ELWIX_DEBUG_MEMORY ELWIX_DEBUG_MEM
298: #define ELWIX_DEBUG_IO 0x8
299: #define ELWIX_DEBUG_IPC 0x10
300: #define ELWIX_DEBUG_LOCK 0x20
301: #define ELWIX_DEBUG_SYS 0x40
302: #define ELWIX_DEBUG_NET 0x80
1.1 misho 303: #define ELWIX_DEBUG_ANY 0xFFFFFFFF
304:
1.24 misho 305: #define EDBG(x) (elwix_Debug & (x))
306: #define EDBGS(x) if (EDBG(x))
1.5 misho 307: #define ETRACE() if (elwix_Debug & ELWIX_DEBUG_TRACE) \
1.4 misho 308: syslog(LOG_DEBUG, "I'm in %s(%d)\n", __func__, __LINE__)
1.1 misho 309: #define EDEBUG(x, fmt, ...) do { assert((fmt)); \
310: if ((x) & elwix_Debug) { \
1.26 misho 311: char __str[BUFSIZ] = { 0 }; \
1.8 misho 312: snprintf(__str, sizeof __str, (fmt), ##__VA_ARGS__); \
1.1 misho 313: syslog(LOG_DEBUG, "Debug(%d):%s(%d): %s\n", \
1.8 misho 314: (x), __func__, __LINE__, __str); \
1.1 misho 315: } \
316: } while (0)
317:
318: /* Logger macro */
319: #define ELOGGER(x, fmt, ...) do { assert((fmt)); \
1.26 misho 320: char __str[BUFSIZ] = { 0 }; \
1.8 misho 321: snprintf(__str, sizeof __str, (fmt), ##__VA_ARGS__); \
1.26 misho 322: syslog((x), "Log:%s(%d): %s\n", \
1.8 misho 323: __func__, __LINE__, __str); \
1.1 misho 324: } while (0)
325:
1.12 misho 326: #define EWARNING(x, fmt, ...) do { assert((fmt)); \
1.26 misho 327: char __str[BUFSIZ] = { 0 }; \
1.12 misho 328: snprintf(__str, sizeof __str, (fmt), ##__VA_ARGS__); \
329: syslog(LOG_WARNING, "Warning:%s(%d): #%d - %s\n", \
330: __func__, __LINE__, (x), __str); \
331: } while (0)
1.1 misho 332: /* Error state macros */
333: #define EERROR(x, fmt, ...) do { assert((fmt)); \
1.26 misho 334: char __str[BUFSIZ] = { 0 }; \
1.8 misho 335: snprintf(__str, sizeof __str, (fmt), ##__VA_ARGS__); \
1.1 misho 336: syslog(LOG_ERR, "Error:%s(%d): #%d - %s\n", \
1.8 misho 337: __func__, __LINE__, (x), __str); \
1.1 misho 338: } while (0)
339: #define ESYSERR(x) do { \
1.17 misho 340: if (x > 0 || errno) { \
341: int _ern = errno; \
1.1 misho 342: syslog(LOG_ERR, "Error(sys):%s(%d): #%d - %s\n", \
343: __func__, __LINE__, x > 0 ? x : errno, \
344: strerror(x > 0 ? x : errno)); \
1.17 misho 345: errno = _ern; \
346: } \
1.1 misho 347: } while (0)
348: #define ELIBERR(ait) do { \
349: if (ait##_GetErrno()) \
350: syslog(LOG_ERR, "Error(lib):%s(%d): #%d - %s\n", \
351: __func__, __LINE__, ait##_GetErrno(), \
352: ait##_GetError()); \
353: } while (0)
354:
355:
1.26 misho 356: #ifdef __cplusplus
357: }
358: #endif
359:
1.1 misho 360: #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