Annotation of libelwix/inc/elwix.h, revision 1.2.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.2.4.1 ! misho       6: * $Id: elwix.h,v 1.2 2013/03/07 16:24:32 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>
                     53: #include <sys/socket.h>
                     54: #include <sys/un.h>
                     55: #include <net/if_dl.h>
                     56: #include <netinet/in.h>
                     57: #include <arpa/inet.h>
                     58: 
                     59: #include <elwix/atree.h>
                     60: #include <elwix/ampool.h>
                     61: #include <elwix/acrc.h>
                     62: #include <elwix/aarray.h>
                     63: #include <elwix/asarr.h>
                     64: #include <elwix/avar.h>
                     65: #include <elwix/astr.h>
                     66: #include <elwix/aregex.h>
1.2       misho      67: #include <elwix/aav.h>
1.1       misho      68: #include <elwix/anet.h>
1.2       misho      69: #include <elwix/atime.h>
1.1       misho      70: 
                     71: 
                     72: #ifndef STRSIZ
                     73: #define STRSIZ         256
                     74: #endif
                     75: 
                     76: #ifndef be16toh
                     77: #define be16toh                betoh16
                     78: #endif
                     79: #ifndef be32toh
                     80: #define be32toh                betoh32
                     81: #endif
                     82: #ifndef be64toh
                     83: #define be64toh                betoh64
                     84: #endif
                     85: #ifndef le16toh
                     86: #define le16toh                letoh16
                     87: #endif
                     88: #ifndef le32toh
                     89: #define le32toh                letoh32
                     90: #endif
                     91: #ifndef le64toh
                     92: #define le64toh                letoh64
                     93: #endif
                     94: 
                     95: #define E_ALIGN(x, a)  (((x) + ((a) - 1)) & ~((a) - 1))
                     96: 
                     97: 
                     98: #define ELWIX_SYSM     0
                     99: #define ELWIX_MPOOL    1
                    100: 
                    101: #define VACUUM_LEFT    1
                    102: #define VACUUM_BETWEEN 2
                    103: 
                    104: 
                    105: // elwix_SetProg() Set program memory pool name
1.2.4.1 ! misho     106: void elwix_SetProg(const char *csProgName);
1.1       misho     107: // elwix_GetProg() Get program memory pool name
1.2.4.1 ! misho     108: const char *elwix_GetProg();
1.1       misho     109: 
                    110: // elwix_GetErrno() Get error code of last operation
1.2.4.1 ! misho     111: int elwix_GetErrno();
1.1       misho     112: // elwix_GetError() Get error text of last operation
1.2.4.1 ! misho     113: const char *elwix_GetError();
1.1       misho     114: 
                    115: 
                    116: // elwix_mm_inuse() Check for memory management model
1.2.4.1 ! misho     117: int elwix_mm_inuse();
1.1       misho     118: 
                    119: 
                    120: /*
                    121:  * elwixInit() - Init libelwix library memory management
                    122:  *
                    123:  * @mm = memory management (IO_SYSM or IO_MPOOL)
                    124:  * @maxmem = memory limit
                    125:  * return: -1 error or !=-1 used memory management model
                    126:  */
1.2.4.1 ! misho     127: int elwixInit(int mm, unsigned long maxmem);
1.1       misho     128: /*
                    129:  * elwixFini() - Finish libelwix library memory management
                    130:  *
                    131:  * return: none
                    132:  */
1.2.4.1 ! misho     133: void elwixFini();
1.1       misho     134: 
                    135: /* memory management hooks */
                    136: extern void *(*e_malloc)(size_t);
                    137: extern void *(*e_calloc)(size_t, size_t);
                    138: extern void *(*e_realloc)(void*, size_t);
                    139: extern char *(*e_strdup)(const char*);
                    140: extern void (*e_free)(void*);
                    141: 
                    142: 
                    143: /* Debug helper macros */
                    144: 
                    145: /* Verbose macros */
                    146: extern int elwix_Verbose;
                    147: #define e_initVerbose(x)       (elwix_Verbose = (x))
                    148: #define e_incVerbose           (elwix_Verbose++)
                    149: #define e_decVerbose           (elwix_Verbose--)
                    150: 
1.2       misho     151: #define EVERBS(x)              if ((x) <= elwix_Verbose)
                    152: #define EVERBOSE(x, fmt, ...)  do { assert((fmt)); \
                    153:                                        if ((x) <= elwix_Verbose) { \
                    154:                                                char str[BUFSIZ] = { 0 }; \
                    155:                                                snprintf(str, sizeof str, (fmt), ##__VA_ARGS__); \
                    156:                                                syslog(LOG_DEBUG, "Verbose(%d):%s(%d): %s\n", \
                    157:                                                                (x), __func__, __LINE__, str); \
                    158:                                        } \
                    159:                                } while (0)
1.1       misho     160: 
                    161: /* Debug macros */
                    162: extern int elwix_Debug;
                    163: #define ELWIX_DEBUG_OFF                0x0
                    164: #define ELWIX_DEBUG_TRACE      0x1
                    165: #define ELWIX_DEBUG_LOG                0x2
                    166: #define ELWIX_DEBUG_ANY                0xFFFFFFFF
                    167: 
                    168: #define ETRACE(x)              if (elwix_Debug & ELWIX_DEBUG_TRACE) \
                    169:                                           syslog(LOG_DEBUG, "I'm in %s(%d)", __func__, __LINE__)
                    170: #define EDEBUG(x, fmt, ...)    do { assert((fmt)); \
                    171:                                        if ((x) & elwix_Debug) { \
                    172:                                                char str[BUFSIZ] = { 0 }; \
                    173:                                                snprintf(str, sizeof str, (fmt), ##__VA_ARGS__); \
                    174:                                                syslog(LOG_DEBUG, "Debug(%d):%s(%d): %s\n", \
                    175:                                                                (x), __func__, __LINE__, str); \
                    176:                                        } \
                    177:                                } while (0)
                    178: 
                    179: /* Logger macro */
                    180: #define ELOGGER(x, fmt, ...)   do { assert((fmt)); \
                    181:                                        char str[BUFSIZ] = { 0 }; \
                    182:                                        snprintf(str, sizeof str, (fmt), ##__VA_ARGS__); \
                    183:                                        syslog((x), "Logger:%s(%d): %s\n", \
                    184:                                                                __func__, __LINE__, str); \
                    185:                                } while (0)
                    186: 
                    187: /* Error state macros */
                    188: #define EERROR(x, fmt, ...)    do { assert((fmt)); \
                    189:                                        char str[BUFSIZ] = { 0 }; \
                    190:                                        snprintf(str, sizeof str, (fmt), ##__VA_ARGS__); \
                    191:                                        syslog(LOG_ERR, "Error:%s(%d): #%d - %s\n", \
                    192:                                                         __func__, __LINE__, (x), str); \
                    193:                                } while (0)
                    194: #define ESYSERR(x)             do { \
                    195:                                        if (x > 0 || errno) \
                    196:                                                syslog(LOG_ERR, "Error(sys):%s(%d): #%d - %s\n", \
                    197:                                                                __func__, __LINE__, x > 0 ? x : errno, \
                    198:                                                                strerror(x > 0 ? x : errno)); \
                    199:                                } while (0)
                    200: #define ELIBERR(ait)           do { \
                    201:                                        if (ait##_GetErrno()) \
                    202:                                                syslog(LOG_ERR, "Error(lib):%s(%d): #%d - %s\n", \
                    203:                                                                __func__, __LINE__, ait##_GetErrno(), \
                    204:                                                                ait##_GetError()); \
                    205:                                } while (0)
                    206: 
                    207: 
                    208: #endif

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