Annotation of libelwix/inc/elwix.h, revision 1.15.2.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.15.2.1! misho 6: * $Id: elwix.h,v 1.15 2017/01/09 12:53:18 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.15.2.1! misho 15: Copyright 2004 - 2017
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.1 misho 81:
82:
83: #ifndef STRSIZ
84: #define STRSIZ 256
85: #endif
86:
1.6 misho 87: #ifndef NBBY
88: #define NBBY 8 /* number of bits in a byte */
89: #endif
90:
1.11 misho 91: #ifndef BYTE_ORDER
92: #ifndef LITTLE_ENDIAN
93: #define LITTLE_ENDIAN 1234
94: #endif /* LITTLE_ENDIAN */
95: #ifndef BIG_ENDIAN
96: #define BIG_ENDIAN 4321
97: #endif /* BIG_ENDIAN */
98: #ifdef WORDS_BIGENDIAN
99: #define BYTE_ORDER BIG_ENDIAN
100: #else /* WORDS_BIGENDIAN */
101: #define BYTE_ORDER LITTLE_ENDIAN
102: #endif /* WORDS_BIGENDIAN */
103: #endif /* BYTE_ORDER */
104:
1.1 misho 105: #ifndef be16toh
106: #define be16toh betoh16
107: #endif
108: #ifndef be32toh
109: #define be32toh betoh32
110: #endif
111: #ifndef be64toh
112: #define be64toh betoh64
113: #endif
114: #ifndef le16toh
115: #define le16toh letoh16
116: #endif
117: #ifndef le32toh
118: #define le32toh letoh32
119: #endif
120: #ifndef le64toh
121: #define le64toh letoh64
122: #endif
123:
1.6 misho 124: /* Bit map related macros. */
125: #ifndef setbit
126: #define setbit(a, i) (((unsigned char *)(a))[(i) / NBBY] |= 1 << ((i) % NBBY))
127: #endif
128: #ifndef clrbit
129: #define clrbit(a, i) (((unsigned char *)(a))[(i) / NBBY] &= ~(1 << ((i) % NBBY)))
130: #endif
131: #ifndef isset
132: #define isset(a, i) (((const unsigned char *)(a))[(i) / NBBY] & (1 << ((i) % NBBY)))
133: #endif
134: #ifndef isclr
135: #define isclr(a, i) ((((const unsigned char *)(a))[(i) / NBBY] & (1 << ((i) % NBBY))) == 0)
136: #endif
137:
138: /* Macros for counting and rounding. */
139: #ifndef howmany
140: #define howmany(x, y) (((x) + ((y) - 1)) / (y))
141: #endif
142: #ifndef nitems
143: #define nitems(x) (sizeof((x)) / sizeof((x)[0]))
144: #endif
145: #ifndef rounddown
146: #define rounddown(x, y) (((x) / (y)) * (y))
147: #endif
148: #ifndef rounddown2
149: #define rounddown2(x, y) ((x) & (~((y) - 1))) /* if y is power of two */
150: #endif
151: #ifndef roundup
152: #define roundup(x, y) ((((x) + ((y) - 1)) / (y)) * (y)) /* to any y */
153: #endif
154: #ifndef roundup2
155: #define roundup2(x, y) (((x) + ((y) - 1)) & (~((y) - 1))) /* if y is powers of two */
156: #endif
157: #ifndef powerof2
158: #define powerof2(x) ((((x) - 1) & (x)) == 0)
159: #endif
160:
161: /* Macros for min/max. */
162: #ifndef MIN
163: #define MIN(a, b) (((a) < (b)) ? (a) : (b))
164: #endif
165: #ifndef MAX
166: #define MAX(a, b) (((a) > (b)) ? (a) : (b))
167: #endif
168:
169: #define E_ALIGN(x, a) (((x) + ((a) - 1)) & ~((a) - 1))
1.1 misho 170:
171:
1.6 misho 172: #define ELWIX_SYSM 0
173: #define ELWIX_MPOOL 1
1.1 misho 174:
1.6 misho 175: #define VACUUM_LEFT 1
176: #define VACUUM_BETWEEN 2
1.1 misho 177:
178:
1.9 misho 179: extern int __isthreaded;
180:
181:
1.1 misho 182: // elwix_SetProg() Set program memory pool name
1.3 misho 183: void elwix_SetProg(const char *csProgName);
1.1 misho 184: // elwix_GetProg() Get program memory pool name
1.3 misho 185: const char *elwix_GetProg();
1.1 misho 186:
187: // elwix_GetErrno() Get error code of last operation
1.3 misho 188: int elwix_GetErrno();
1.1 misho 189: // elwix_GetError() Get error text of last operation
1.3 misho 190: const char *elwix_GetError();
1.1 misho 191:
192:
193: // elwix_mm_inuse() Check for memory management model
1.3 misho 194: int elwix_mm_inuse();
1.1 misho 195:
196:
197: /*
198: * elwixInit() - Init libelwix library memory management
199: *
200: * @mm = memory management (IO_SYSM or IO_MPOOL)
201: * @maxmem = memory limit
202: * return: -1 error or !=-1 used memory management model
203: */
1.3 misho 204: int elwixInit(int mm, unsigned long maxmem);
1.1 misho 205: /*
206: * elwixFini() - Finish libelwix library memory management
207: *
208: * return: none
209: */
1.3 misho 210: void elwixFini();
1.1 misho 211:
1.11 misho 212: /*
213: * elwix_byteOrder() - Detect platform byte order
214: *
215: * return: 1 = little endian or 0 big endian
216: */
217: int elwix_byteOrder();
1.14 misho 218:
219: #ifndef strlcpy
220: /*
221: * Copy src to string dst of size siz. At most siz-1 characters
222: * will be copied. Always NUL terminates (unless siz == 0).
223: * Returns strlen(src); if retval >= siz, truncation occurred.
224: */
225: size_t strlcpy(char *dst, const char *src, size_t siz);
226: #endif
227: #ifndef strlcat
228: /*
229: * Appends src to string dst of size siz (unlike strncat, siz is the
230: * full size of dst, not space left). At most siz-1 characters
231: * will be copied. Always NUL terminates (unless siz <= strlen(dst)).
232: * Returns strlen(src) + MIN(siz, strlen(initial dst)).
233: * If retval >= siz, truncation occurred.
234: */
235: size_t strlcat(char *dst, const char *src, size_t siz);
236: #endif
1.11 misho 237:
1.1 misho 238: /* memory management hooks */
239: extern void *(*e_malloc)(size_t);
240: extern void *(*e_calloc)(size_t, size_t);
241: extern void *(*e_realloc)(void*, size_t);
242: extern char *(*e_strdup)(const char*);
243: extern void (*e_free)(void*);
244:
245:
246: /* Debug helper macros */
247:
248: /* Verbose macros */
249: extern int elwix_Verbose;
250: #define e_initVerbose(x) (elwix_Verbose = (x))
251: #define e_incVerbose (elwix_Verbose++)
252: #define e_decVerbose (elwix_Verbose--)
253:
1.2 misho 254: #define EVERBS(x) if ((x) <= elwix_Verbose)
255: #define EVERBOSE(x, fmt, ...) do { assert((fmt)); \
256: if ((x) <= elwix_Verbose) { \
1.8 misho 257: char __str[BUFSIZ] = { [0 ... BUFSIZ - 1] = 0 }; \
258: snprintf(__str, sizeof __str, (fmt), ##__VA_ARGS__); \
1.15.2.1! misho 259: syslog(LOG_INFO, "Verbose(%d):%s(%d): %s\n", \
1.8 misho 260: (x), __func__, __LINE__, __str); \
1.2 misho 261: } \
262: } while (0)
1.1 misho 263:
264: /* Debug macros */
265: extern int elwix_Debug;
266: #define ELWIX_DEBUG_OFF 0x0
267: #define ELWIX_DEBUG_TRACE 0x1
268: #define ELWIX_DEBUG_LOG 0x2
269: #define ELWIX_DEBUG_ANY 0xFFFFFFFF
270:
1.5 misho 271: #define ETRACE() if (elwix_Debug & ELWIX_DEBUG_TRACE) \
1.4 misho 272: syslog(LOG_DEBUG, "I'm in %s(%d)\n", __func__, __LINE__)
1.1 misho 273: #define EDEBUG(x, fmt, ...) do { assert((fmt)); \
274: if ((x) & elwix_Debug) { \
1.8 misho 275: char __str[BUFSIZ] = { [0 ... BUFSIZ - 1] = 0 }; \
276: snprintf(__str, sizeof __str, (fmt), ##__VA_ARGS__); \
1.1 misho 277: syslog(LOG_DEBUG, "Debug(%d):%s(%d): %s\n", \
1.8 misho 278: (x), __func__, __LINE__, __str); \
1.1 misho 279: } \
280: } while (0)
281:
282: /* Logger macro */
283: #define ELOGGER(x, fmt, ...) do { assert((fmt)); \
1.8 misho 284: char __str[BUFSIZ] = { [0 ... BUFSIZ - 1] = 0 }; \
285: snprintf(__str, sizeof __str, (fmt), ##__VA_ARGS__); \
1.1 misho 286: syslog((x), "Logger:%s(%d): %s\n", \
1.8 misho 287: __func__, __LINE__, __str); \
1.1 misho 288: } while (0)
289:
1.12 misho 290: #define EWARNING(x, fmt, ...) do { assert((fmt)); \
291: char __str[BUFSIZ] = { [0 ... BUFSIZ - 1] = 0 }; \
292: snprintf(__str, sizeof __str, (fmt), ##__VA_ARGS__); \
293: syslog(LOG_WARNING, "Warning:%s(%d): #%d - %s\n", \
294: __func__, __LINE__, (x), __str); \
295: } while (0)
1.1 misho 296: /* Error state macros */
297: #define EERROR(x, fmt, ...) do { assert((fmt)); \
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_ERR, "Error:%s(%d): #%d - %s\n", \
1.8 misho 301: __func__, __LINE__, (x), __str); \
1.1 misho 302: } while (0)
303: #define ESYSERR(x) do { \
304: if (x > 0 || errno) \
305: syslog(LOG_ERR, "Error(sys):%s(%d): #%d - %s\n", \
306: __func__, __LINE__, x > 0 ? x : errno, \
307: strerror(x > 0 ? x : errno)); \
308: } while (0)
309: #define ELIBERR(ait) do { \
310: if (ait##_GetErrno()) \
311: syslog(LOG_ERR, "Error(lib):%s(%d): #%d - %s\n", \
312: __func__, __LINE__, ait##_GetErrno(), \
313: ait##_GetError()); \
314: } while (0)
315:
316:
317: #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