Return to elwix.h CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / libelwix / inc

version 2.7

    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.10 2014/01/29 14:16:53 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 - 2014
   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>
   53: #include <sys/param.h>
   54: #include <sys/limits.h>
   55: #include <sys/socket.h>
   56: #include <sys/endian.h>
   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>
   70: #include <elwix/aav.h>
   71: #include <elwix/anet.h>
   72: #include <elwix/atime.h>
   73: #include <elwix/apack.h>
   74: #include <elwix/apio.h>
   75: 
   76: 
   77: #ifndef STRSIZ
   78: #define STRSIZ		256
   79: #endif
   80: 
   81: #ifndef NBBY
   82: #define	NBBY		8		/* number of bits in a byte */
   83: #endif
   84: 
   85: #ifndef be16toh
   86: #define be16toh		betoh16
   87: #endif
   88: #ifndef be32toh
   89: #define be32toh		betoh32
   90: #endif
   91: #ifndef be64toh
   92: #define be64toh		betoh64
   93: #endif
   94: #ifndef le16toh
   95: #define le16toh		letoh16
   96: #endif
   97: #ifndef le32toh
   98: #define le32toh		letoh32
   99: #endif
  100: #ifndef le64toh
  101: #define le64toh		letoh64
  102: #endif
  103: 
  104: /* Bit map related macros. */
  105: #ifndef setbit
  106: #define	setbit(a, i)		(((unsigned char *)(a))[(i) / NBBY] |= 1 << ((i) % NBBY))
  107: #endif
  108: #ifndef clrbit
  109: #define	clrbit(a, i)		(((unsigned char *)(a))[(i) / NBBY] &= ~(1 << ((i) % NBBY)))
  110: #endif
  111: #ifndef isset
  112: #define	isset(a, i)		(((const unsigned char *)(a))[(i) / NBBY] & (1 << ((i) % NBBY)))
  113: #endif
  114: #ifndef isclr
  115: #define	isclr(a, i)		((((const unsigned char *)(a))[(i) / NBBY] & (1 << ((i) % NBBY))) == 0)
  116: #endif
  117: 
  118: /* Macros for counting and rounding. */
  119: #ifndef howmany
  120: #define	howmany(x, y)		(((x) + ((y) - 1)) / (y))
  121: #endif
  122: #ifndef nitems
  123: #define	nitems(x)		(sizeof((x)) / sizeof((x)[0]))
  124: #endif
  125: #ifndef rounddown
  126: #define	rounddown(x, y)		(((x) / (y)) * (y))
  127: #endif
  128: #ifndef rounddown2
  129: #define	rounddown2(x, y)	((x) & (~((y) - 1))) /* if y is power of two */
  130: #endif
  131: #ifndef roundup
  132: #define	roundup(x, y)		((((x) + ((y) - 1)) / (y)) * (y)) /* to any y */
  133: #endif
  134: #ifndef roundup2
  135: #define	roundup2(x, y)		(((x) + ((y) - 1)) & (~((y) - 1))) /* if y is powers of two */
  136: #endif
  137: #ifndef powerof2
  138: #define powerof2(x)		((((x) - 1) & (x)) == 0)
  139: #endif
  140: 
  141: /* Macros for min/max. */
  142: #ifndef MIN
  143: #define	MIN(a, b)		(((a) < (b)) ? (a) : (b))
  144: #endif
  145: #ifndef MAX
  146: #define	MAX(a, b)		(((a) > (b)) ? (a) : (b))
  147: #endif
  148: 
  149: #define E_ALIGN(x, a)		(((x) + ((a) - 1)) & ~((a) - 1))
  150: 
  151: 
  152: #define ELWIX_SYSM		0
  153: #define ELWIX_MPOOL		1
  154: 
  155: #define VACUUM_LEFT		1
  156: #define VACUUM_BETWEEN		2
  157: 
  158: 
  159: extern int __isthreaded;
  160: 
  161: 
  162: // elwix_SetProg() Set program memory pool name
  163: void elwix_SetProg(const char *csProgName);
  164: // elwix_GetProg() Get program memory pool name
  165: const char *elwix_GetProg();
  166: 
  167: // elwix_GetErrno() Get error code of last operation
  168: int elwix_GetErrno();
  169: // elwix_GetError() Get error text of last operation
  170: const char *elwix_GetError();
  171: 
  172: 
  173: // elwix_mm_inuse() Check for memory management model
  174: int elwix_mm_inuse();
  175: 
  176: 
  177: /*
  178:  * elwixInit() - Init libelwix library memory management
  179:  *
  180:  * @mm = memory management (IO_SYSM or IO_MPOOL)
  181:  * @maxmem = memory limit
  182:  * return: -1 error or !=-1 used memory management model
  183:  */
  184: int elwixInit(int mm, unsigned long maxmem);
  185: /*
  186:  * elwixFini() - Finish libelwix library memory management
  187:  *
  188:  * return: none
  189:  */
  190: void elwixFini();
  191: 
  192: /* memory management hooks */
  193: extern void *(*e_malloc)(size_t);
  194: extern void *(*e_calloc)(size_t, size_t);
  195: extern void *(*e_realloc)(void*, size_t);
  196: extern char *(*e_strdup)(const char*);
  197: extern void (*e_free)(void*);
  198: 
  199: 
  200: /* Debug helper macros */
  201: 
  202: /* Verbose macros */
  203: extern int elwix_Verbose;
  204: #define e_initVerbose(x)	(elwix_Verbose = (x))
  205: #define e_incVerbose		(elwix_Verbose++)
  206: #define e_decVerbose		(elwix_Verbose--)
  207: 
  208: #define EVERBS(x)		if ((x) <= elwix_Verbose)
  209: #define EVERBOSE(x, fmt, ...)	do { assert((fmt)); \
  210: 					if ((x) <= elwix_Verbose) { \
  211: 						char __str[BUFSIZ] = { [0 ... BUFSIZ - 1] = 0 }; \
  212: 						snprintf(__str, sizeof __str, (fmt), ##__VA_ARGS__); \
  213: 						syslog(LOG_DEBUG, "Verbose(%d):%s(%d): %s\n", \
  214: 								(x), __func__, __LINE__, __str); \
  215: 					} \
  216: 				} while (0)
  217: 
  218: /* Debug macros */
  219: extern int elwix_Debug;
  220: #define ELWIX_DEBUG_OFF		0x0
  221: #define ELWIX_DEBUG_TRACE	0x1
  222: #define ELWIX_DEBUG_LOG		0x2
  223: #define ELWIX_DEBUG_ANY		0xFFFFFFFF
  224: 
  225: #define ETRACE()		if (elwix_Debug & ELWIX_DEBUG_TRACE) \
  226: 					   syslog(LOG_DEBUG, "I'm in %s(%d)\n", __func__, __LINE__)
  227: #define EDEBUG(x, fmt, ...)	do { assert((fmt)); \
  228: 					if ((x) & elwix_Debug) { \
  229: 						char __str[BUFSIZ] = { [0 ... BUFSIZ - 1] = 0 }; \
  230: 						snprintf(__str, sizeof __str, (fmt), ##__VA_ARGS__); \
  231: 						syslog(LOG_DEBUG, "Debug(%d):%s(%d): %s\n", \
  232: 								(x), __func__, __LINE__, __str); \
  233: 					} \
  234: 				} while (0)
  235: 
  236: /* Logger macro */
  237: #define ELOGGER(x, fmt, ...)	do { assert((fmt)); \
  238: 					char __str[BUFSIZ] = { [0 ... BUFSIZ - 1] = 0 }; \
  239: 					snprintf(__str, sizeof __str, (fmt), ##__VA_ARGS__); \
  240: 					syslog((x), "Logger:%s(%d): %s\n", \
  241: 								__func__, __LINE__, __str); \
  242: 				} while (0)
  243: 
  244: /* Error state macros */
  245: #define EERROR(x, fmt, ...)	do { assert((fmt)); \
  246: 					char __str[BUFSIZ] = { [0 ... BUFSIZ - 1] = 0 }; \
  247: 					snprintf(__str, sizeof __str, (fmt), ##__VA_ARGS__); \
  248: 					syslog(LOG_ERR, "Error:%s(%d): #%d - %s\n", \
  249: 							 __func__, __LINE__, (x), __str); \
  250: 				} while (0)
  251: #define ESYSERR(x)		do { \
  252: 					if (x > 0 || errno) \
  253: 						syslog(LOG_ERR, "Error(sys):%s(%d): #%d - %s\n", \
  254: 								__func__, __LINE__, x > 0 ? x : errno, \
  255: 								strerror(x > 0 ? x : errno)); \
  256: 				} while (0)
  257: #define ELIBERR(ait)		do { \
  258: 					if (ait##_GetErrno()) \
  259: 						syslog(LOG_ERR, "Error(lib):%s(%d): #%d - %s\n", \
  260: 								__func__, __LINE__, ait##_GetErrno(), \
  261: 								ait##_GetError()); \
  262: 				} while (0)
  263: 
  264: 
  265: #endif