Annotation of libelwix/inc/elwix.h, revision 1.12.4.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.12.4.1! misho 6: * $Id: elwix.h,v 1.12 2015/01/19 23:21:12 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.12.4.1! misho 15: Copyright 2004 - 2015
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>
52: #include <sys/types.h>
1.6 misho 53: #include <sys/param.h>
54: #include <sys/limits.h>
1.1 misho 55: #include <sys/socket.h>
1.8 misho 56: #include <sys/endian.h>
1.1 misho 57: #include <sys/un.h>
58: #include <net/if_dl.h>
59: #include <netinet/in.h>
60: #include <arpa/inet.h>
61:
62: #include <elwix/atree.h>
63: #include <elwix/ampool.h>
64: #include <elwix/acrc.h>
65: #include <elwix/aarray.h>
66: #include <elwix/asarr.h>
67: #include <elwix/avar.h>
68: #include <elwix/astr.h>
69: #include <elwix/aregex.h>
1.2 misho 70: #include <elwix/aav.h>
1.1 misho 71: #include <elwix/anet.h>
1.2 misho 72: #include <elwix/atime.h>
1.7 misho 73: #include <elwix/apack.h>
1.9 misho 74: #include <elwix/apio.h>
1.1 misho 75:
76:
77: #ifndef STRSIZ
78: #define STRSIZ 256
79: #endif
80:
1.6 misho 81: #ifndef NBBY
82: #define NBBY 8 /* number of bits in a byte */
83: #endif
84:
1.11 misho 85: #ifndef BYTE_ORDER
86: #ifndef LITTLE_ENDIAN
87: #define LITTLE_ENDIAN 1234
88: #endif /* LITTLE_ENDIAN */
89: #ifndef BIG_ENDIAN
90: #define BIG_ENDIAN 4321
91: #endif /* BIG_ENDIAN */
92: #ifdef WORDS_BIGENDIAN
93: #define BYTE_ORDER BIG_ENDIAN
94: #else /* WORDS_BIGENDIAN */
95: #define BYTE_ORDER LITTLE_ENDIAN
96: #endif /* WORDS_BIGENDIAN */
97: #endif /* BYTE_ORDER */
98:
1.1 misho 99: #ifndef be16toh
100: #define be16toh betoh16
101: #endif
102: #ifndef be32toh
103: #define be32toh betoh32
104: #endif
105: #ifndef be64toh
106: #define be64toh betoh64
107: #endif
108: #ifndef le16toh
109: #define le16toh letoh16
110: #endif
111: #ifndef le32toh
112: #define le32toh letoh32
113: #endif
114: #ifndef le64toh
115: #define le64toh letoh64
116: #endif
117:
1.6 misho 118: /* Bit map related macros. */
119: #ifndef setbit
120: #define setbit(a, i) (((unsigned char *)(a))[(i) / NBBY] |= 1 << ((i) % NBBY))
121: #endif
122: #ifndef clrbit
123: #define clrbit(a, i) (((unsigned char *)(a))[(i) / NBBY] &= ~(1 << ((i) % NBBY)))
124: #endif
125: #ifndef isset
126: #define isset(a, i) (((const unsigned char *)(a))[(i) / NBBY] & (1 << ((i) % NBBY)))
127: #endif
128: #ifndef isclr
129: #define isclr(a, i) ((((const unsigned char *)(a))[(i) / NBBY] & (1 << ((i) % NBBY))) == 0)
130: #endif
131:
132: /* Macros for counting and rounding. */
133: #ifndef howmany
134: #define howmany(x, y) (((x) + ((y) - 1)) / (y))
135: #endif
136: #ifndef nitems
137: #define nitems(x) (sizeof((x)) / sizeof((x)[0]))
138: #endif
139: #ifndef rounddown
140: #define rounddown(x, y) (((x) / (y)) * (y))
141: #endif
142: #ifndef rounddown2
143: #define rounddown2(x, y) ((x) & (~((y) - 1))) /* if y is power of two */
144: #endif
145: #ifndef roundup
146: #define roundup(x, y) ((((x) + ((y) - 1)) / (y)) * (y)) /* to any y */
147: #endif
148: #ifndef roundup2
149: #define roundup2(x, y) (((x) + ((y) - 1)) & (~((y) - 1))) /* if y is powers of two */
150: #endif
151: #ifndef powerof2
152: #define powerof2(x) ((((x) - 1) & (x)) == 0)
153: #endif
154:
155: /* Macros for min/max. */
156: #ifndef MIN
157: #define MIN(a, b) (((a) < (b)) ? (a) : (b))
158: #endif
159: #ifndef MAX
160: #define MAX(a, b) (((a) > (b)) ? (a) : (b))
161: #endif
162:
163: #define E_ALIGN(x, a) (((x) + ((a) - 1)) & ~((a) - 1))
1.1 misho 164:
165:
1.6 misho 166: #define ELWIX_SYSM 0
167: #define ELWIX_MPOOL 1
1.1 misho 168:
1.6 misho 169: #define VACUUM_LEFT 1
170: #define VACUUM_BETWEEN 2
1.1 misho 171:
172:
1.9 misho 173: extern int __isthreaded;
174:
175:
1.1 misho 176: // elwix_SetProg() Set program memory pool name
1.3 misho 177: void elwix_SetProg(const char *csProgName);
1.1 misho 178: // elwix_GetProg() Get program memory pool name
1.3 misho 179: const char *elwix_GetProg();
1.1 misho 180:
181: // elwix_GetErrno() Get error code of last operation
1.3 misho 182: int elwix_GetErrno();
1.1 misho 183: // elwix_GetError() Get error text of last operation
1.3 misho 184: const char *elwix_GetError();
1.1 misho 185:
186:
187: // elwix_mm_inuse() Check for memory management model
1.3 misho 188: int elwix_mm_inuse();
1.1 misho 189:
190:
191: /*
192: * elwixInit() - Init libelwix library memory management
193: *
194: * @mm = memory management (IO_SYSM or IO_MPOOL)
195: * @maxmem = memory limit
196: * return: -1 error or !=-1 used memory management model
197: */
1.3 misho 198: int elwixInit(int mm, unsigned long maxmem);
1.1 misho 199: /*
200: * elwixFini() - Finish libelwix library memory management
201: *
202: * return: none
203: */
1.3 misho 204: void elwixFini();
1.1 misho 205:
1.11 misho 206: /*
207: * elwix_byteOrder() - Detect platform byte order
208: *
209: * return: 1 = little endian or 0 big endian
210: */
211: int elwix_byteOrder();
212:
1.1 misho 213: /* memory management hooks */
214: extern void *(*e_malloc)(size_t);
215: extern void *(*e_calloc)(size_t, size_t);
216: extern void *(*e_realloc)(void*, size_t);
217: extern char *(*e_strdup)(const char*);
218: extern void (*e_free)(void*);
219:
220:
221: /* Debug helper macros */
222:
223: /* Verbose macros */
224: extern int elwix_Verbose;
225: #define e_initVerbose(x) (elwix_Verbose = (x))
226: #define e_incVerbose (elwix_Verbose++)
227: #define e_decVerbose (elwix_Verbose--)
228:
1.2 misho 229: #define EVERBS(x) if ((x) <= elwix_Verbose)
230: #define EVERBOSE(x, fmt, ...) do { assert((fmt)); \
231: if ((x) <= elwix_Verbose) { \
1.8 misho 232: char __str[BUFSIZ] = { [0 ... BUFSIZ - 1] = 0 }; \
233: snprintf(__str, sizeof __str, (fmt), ##__VA_ARGS__); \
1.2 misho 234: syslog(LOG_DEBUG, "Verbose(%d):%s(%d): %s\n", \
1.8 misho 235: (x), __func__, __LINE__, __str); \
1.2 misho 236: } \
237: } while (0)
1.1 misho 238:
239: /* Debug macros */
240: extern int elwix_Debug;
241: #define ELWIX_DEBUG_OFF 0x0
242: #define ELWIX_DEBUG_TRACE 0x1
243: #define ELWIX_DEBUG_LOG 0x2
244: #define ELWIX_DEBUG_ANY 0xFFFFFFFF
245:
1.5 misho 246: #define ETRACE() if (elwix_Debug & ELWIX_DEBUG_TRACE) \
1.4 misho 247: syslog(LOG_DEBUG, "I'm in %s(%d)\n", __func__, __LINE__)
1.1 misho 248: #define EDEBUG(x, fmt, ...) do { assert((fmt)); \
249: if ((x) & elwix_Debug) { \
1.8 misho 250: char __str[BUFSIZ] = { [0 ... BUFSIZ - 1] = 0 }; \
251: snprintf(__str, sizeof __str, (fmt), ##__VA_ARGS__); \
1.1 misho 252: syslog(LOG_DEBUG, "Debug(%d):%s(%d): %s\n", \
1.8 misho 253: (x), __func__, __LINE__, __str); \
1.1 misho 254: } \
255: } while (0)
256:
257: /* Logger macro */
258: #define ELOGGER(x, fmt, ...) do { assert((fmt)); \
1.8 misho 259: char __str[BUFSIZ] = { [0 ... BUFSIZ - 1] = 0 }; \
260: snprintf(__str, sizeof __str, (fmt), ##__VA_ARGS__); \
1.1 misho 261: syslog((x), "Logger:%s(%d): %s\n", \
1.8 misho 262: __func__, __LINE__, __str); \
1.1 misho 263: } while (0)
264:
1.12 misho 265: #define EWARNING(x, fmt, ...) do { assert((fmt)); \
266: char __str[BUFSIZ] = { [0 ... BUFSIZ - 1] = 0 }; \
267: snprintf(__str, sizeof __str, (fmt), ##__VA_ARGS__); \
268: syslog(LOG_WARNING, "Warning:%s(%d): #%d - %s\n", \
269: __func__, __LINE__, (x), __str); \
270: } while (0)
1.1 misho 271: /* Error state macros */
272: #define EERROR(x, fmt, ...) do { assert((fmt)); \
1.8 misho 273: char __str[BUFSIZ] = { [0 ... BUFSIZ - 1] = 0 }; \
274: snprintf(__str, sizeof __str, (fmt), ##__VA_ARGS__); \
1.1 misho 275: syslog(LOG_ERR, "Error:%s(%d): #%d - %s\n", \
1.8 misho 276: __func__, __LINE__, (x), __str); \
1.1 misho 277: } while (0)
278: #define ESYSERR(x) do { \
279: if (x > 0 || errno) \
280: syslog(LOG_ERR, "Error(sys):%s(%d): #%d - %s\n", \
281: __func__, __LINE__, x > 0 ? x : errno, \
282: strerror(x > 0 ? x : errno)); \
283: } while (0)
284: #define ELIBERR(ait) do { \
285: if (ait##_GetErrno()) \
286: syslog(LOG_ERR, "Error(lib):%s(%d): #%d - %s\n", \
287: __func__, __LINE__, ait##_GetErrno(), \
288: ait##_GetError()); \
289: } while (0)
290:
291:
292: #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