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