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

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>