libelwix/inc/elwix.h - view

File: [ELWIX - Embedded LightWeight unIX -] / libelwix / inc / elwix.h
Revision 1.18: download - view: text, annotated - select for diffs - revision graph
Mon Dec 30 18:11:16 2019 UTC (4 years, 4 months ago) by misho
Branches: MAIN
CVS tags: elwix4_26, elwix4_25, elwix4_24, elwix4_23, HEAD, ELWIX4_25, ELWIX4_24, ELWIX4_23, ELWIX4_22

ver 4.22

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