Annotation of libaitio/inc/aitio.h, revision 1.22.2.12

1.1       misho       1: /*************************************************************************
1.8       misho       2: * (C) 2010 AITNET ltd - Sofia/Bulgaria - <misho@aitnet.org>
                      3: *  by Michael Pounov <misho@elwix.org>
1.1       misho       4: *
                      5: * $Author: misho $
1.22.2.12! misho       6: * $Id: aitio.h,v 1.22.2.11 2012/07/31 13:37:51 misho Exp $
1.1       misho       7: *
1.8       misho       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.15      misho      15: Copyright 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012
1.8       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: */
1.1       misho      46: #ifndef __AITIO_H
                     47: #define __AITIO_H
                     48: 
                     49: 
1.12      misho      50: #define COMPAT_43TTY
                     51: 
1.8       misho      52: #include <assert.h>
1.7       misho      53: #include <openssl/evp.h>
1.12      misho      54: #include <openssl/aes.h>
                     55: #include <sys/tty.h>
                     56: #include <sys/ioctl_compat.h>
1.13      misho      57: #include <sys/socket.h>
                     58: #include <sys/un.h>
                     59: #include <net/if_dl.h>
                     60: #include <netinet/in.h>
1.20      misho      61: #include <atree.h>
                     62: #include <ampool.h>
1.7       misho      63: 
                     64: 
1.21      misho      65: #ifndef STRSIZ
                     66: #define STRSIZ         256
                     67: #endif
                     68: 
                     69: #ifndef be16toh
                     70: #define be16toh                betoh16
                     71: #endif
                     72: #ifndef be32toh
                     73: #define be32toh                betoh32
                     74: #endif
                     75: #ifndef be64toh
                     76: #define be64toh                betoh64
                     77: #endif
                     78: #ifndef le16toh
                     79: #define le16toh                letoh16
                     80: #endif
                     81: #ifndef le32toh
                     82: #define le32toh                letoh32
                     83: #endif
                     84: #ifndef le64toh
                     85: #define le64toh                letoh64
                     86: #endif
                     87: 
1.20      misho      88: #define IO_SYSM                0
                     89: #define IO_MPOOL       1
                     90: 
1.8       misho      91: #define VACUUM_LEFT    1
                     92: #define VACUUM_BETWEEN 2
                     93: 
1.12      misho      94: /* AIT arrays */
1.8       misho      95: 
1.9       misho      96: typedef void ** sarr_seg_t;
                     97: typedef struct _tagSplitArray {
                     98:        int             sarr_num;
                     99:        int             sarr_seg;
                    100:        int             sarr_siz;
                    101:        sarr_seg_t      *sarr_data;
                    102: } sarr_t;
                    103: 
1.8       misho     104: typedef struct _tagArray {
1.17      misho     105:        int     arr_last;
1.8       misho     106:        int     arr_num;
                    107:        void    **arr_data;
                    108: } array_t;
                    109: 
1.12      misho     110: /* AIT RPC variables and managment */
                    111: 
                    112: typedef enum {
1.16      misho     113:        empty, ptr, data,               /* empty -> variable is not set; ptr -> void*; data -> data after struct  */
1.14      misho     114:        buffer, string, blob,           /* buffer -> uint8_t*; string -> int8_t*; blob -> uint32_t blobID(+socket); */
1.12      misho     115:        f32, f64,                       /* float -> f32; double -> f64 */
                    116:        u8, u16, u32, u64,              /* unsigned integers ... */
                    117:        i8, i16, i32, i64,              /* integers ... */
                    118: } ait_type_t;
                    119: 
                    120: typedef struct {
                    121:        uint8_t         val_type;
1.21      misho     122:        union {
                    123:                struct {
                    124:                        uint8_t val_in:1;
                    125:                        uint8_t val_be:1;
                    126:                        uint8_t val_le:1;
                    127:                        uint8_t val_pad:5;
                    128:                };
                    129:                uint8_t         val_opt;
                    130:        };
1.17      misho     131:        uint16_t        val_key;
1.12      misho     132:        uint32_t        val_len;
                    133:        union {
                    134:                uint64_t        net;
                    135: 
1.14      misho     136:                void            *ptr;
1.12      misho     137:                uint8_t         *buffer;
                    138:                int8_t          *string;
                    139:                uint32_t        blob;
                    140:                float           f32;
                    141:                double          f64;
                    142:                uint8_t         u8;
                    143:                uint16_t        u16;
                    144:                uint32_t        u32;
                    145:                uint64_t        u64;
                    146:                int8_t          i8;
                    147:                int16_t         i16;
                    148:                int32_t         i32;
                    149:                int64_t         i64;
                    150:        } val;
1.16      misho     151:        uint8_t         val_data[0];
1.21      misho     152: } __packed ait_val_t;  /* sizeof 16 bytes */
1.12      misho     153: 
                    154: #define AIT_TYPE(_vl)                  ((ait_type_t) (_vl)->val_type)
                    155: #define AIT_LEN(_vl)                   (_vl)->val_len
1.17      misho     156: #define AIT_KEY(_vl)                   (_vl)->val_key
1.14      misho     157: #define AIT_RAW(_vl)                   (_vl)->val.net
1.17      misho     158: #define AIT_ADDR(_vl)                  (_vl)->val.ptr
1.21      misho     159: #define AIT_IN(_vl)                    (_vl)->val_in
                    160: #define AIT_BE(_vl)                    (_vl)->val_be
                    161: #define AIT_LE(_vl)                    (_vl)->val_le
1.17      misho     162: #define AIT_BLOB_CHUNKS(_vl, _n)       (AIT_LEN((_vl)) / _n + (AIT_LEN((_vl)) % _n) ? 1 : 0)
                    163: #define AIT_ISEMPTY(_vl)               (AIT_TYPE((_vl)) == empty)
                    164: 
1.18      misho     165: #define AIT_GET_LIKE(_vl, _type)       ((_type) AIT_ADDR((_vl)))
1.17      misho     166: 
                    167: #define AIT_GET_PTR(_vl)               (assert(AIT_TYPE((_vl)) == ptr), (_vl)->val.ptr)
                    168: #define AIT_GET_DATA(_vl)              (assert(AIT_TYPE((_vl)) == data), (_vl)->val_data)
                    169: #define AIT_GET_BUF(_vl)               (assert(AIT_TYPE((_vl)) == buffer), (_vl)->val.buffer)
                    170: #define AIT_GET_STR(_vl)               (assert(AIT_TYPE((_vl)) == string), (char*) (_vl)->val.string)
                    171: #define AIT_GET_BLOB(_vl)              (assert(AIT_TYPE((_vl)) == blob), (_vl)->val.blob)
                    172: #define AIT_GET_U8(_vl)                        (assert(AIT_TYPE((_vl)) == u8), (_vl)->val.u8)
                    173: #define AIT_GET_U16(_vl)               (assert(AIT_TYPE((_vl)) == u16), (_vl)->val.u16)
                    174: #define AIT_GET_U32(_vl)               (assert(AIT_TYPE((_vl)) == u32), (_vl)->val.u32)
                    175: #define AIT_GET_U64(_vl)               (assert(AIT_TYPE((_vl)) == u64), (_vl)->val.u64)
                    176: #define AIT_GET_I8(_vl)                        (assert(AIT_TYPE((_vl)) == i8), (_vl)->val.i8)
                    177: #define AIT_GET_I16(_vl)               (assert(AIT_TYPE((_vl)) == i16), (_vl)->val.i16)
                    178: #define AIT_GET_I32(_vl)               (assert(AIT_TYPE((_vl)) == i32), (_vl)->val.i32)
                    179: #define AIT_GET_I64(_vl)               (assert(AIT_TYPE((_vl)) == i64), (_vl)->val.i64)
                    180: #define AIT_GET_F32(_vl)               (assert(AIT_TYPE((_vl)) == f32), (_vl)->val.f32)
                    181: #define AIT_GET_F64(_vl)               (assert(AIT_TYPE((_vl)) == f64), (_vl)->val.f64)
1.12      misho     182: 
1.16      misho     183: #define AIT_SET_DATA(_vl, _p, _len)    do { ait_val_t *__val = (_vl); \
1.20      misho     184:                                                __val = io_realloc(__val, sizeof(ait_val_t) + _len); \
1.16      misho     185:                                                if (__val) { \
                    186:                                                        __val->val_type = data; AIT_LEN(__val) = _len; \
                    187:                                                        if ((_p)) \
                    188:                                                                memcpy(__val->val_data, (_p), _len); \
1.22.2.12! misho     189:                                                        (_vl) = __val; \
1.16      misho     190:                                                } \
                    191:                                        } while (0);
1.14      misho     192: #define AIT_SET_PTR(_vl, _p, _len)     do { ait_val_t *__val = (_vl); assert(__val); \
1.20      misho     193:                                                __val->val_type = ptr; __val->val.ptr = _p; \
                    194:                                                AIT_LEN(__val) = _len; } while (0)
1.18      misho     195: #define AIT_RE_BUF(_vl, _len)          do { ait_val_t *__val = (_vl); assert(__val); \
1.20      misho     196:                                                void *__ptr = io_realloc(AIT_GET_BUF(__val), _len); \
1.18      misho     197:                                                if (__ptr) { \
                    198:                                                        __val->val.buffer = __ptr; AIT_LEN(__val) = _len; \
                    199:                                                } } while (0)
                    200: #define AIT_SET_BUF2(_vl, _c, _len)    do { ait_val_t *__val = (_vl); assert(__val); \
1.20      misho     201:                                                __val->val.buffer = io_malloc(_len); \
1.18      misho     202:                                                if (__val->val.buffer) { \
                    203:                                                        __val->val_type = buffer; AIT_LEN(__val) = _len; \
                    204:                                                        memset(__val->val.buffer, _c, _len); \
                    205:                                                } } while (0)
1.14      misho     206: #define AIT_SET_BUF(_vl, _v, _len)     do { ait_val_t *__val = (_vl); assert(__val); \
1.20      misho     207:                                                __val->val.buffer = io_malloc(_len); \
1.12      misho     208:                                                if (__val->val.buffer) { \
                    209:                                                        __val->val_type = buffer; AIT_LEN(__val) = _len; \
1.18      misho     210:                                                        if ((_v)) \
                    211:                                                                memcpy(__val->val.buffer, (_v), _len); \
                    212:                                                        else \
                    213:                                                                memset(__val->val.buffer, 0, _len); \
1.12      misho     214:                                                } } while (0)
1.19      misho     215: #define AIT_SET_STR(_vl, _v)           do { ait_val_t *__val = (_vl); assert(__val); \
1.22.2.9  misho     216:                                                __val->val_type = string; \
                    217:                                                if ((_v)) { \
                    218:                                                        __val->val.string = (int8_t*) io_strdup((_v)); \
1.22.2.12! misho     219:                                                        AIT_LEN(__val) = strlen((const char*) \
        !           220:                                                                        __val->val.string) + 1; \
1.22.2.9  misho     221:                                                } else { \
                    222:                                                        __val->val.string = NULL; \
                    223:                                                        AIT_LEN(__val) = 0; \
                    224:                                                } \
                    225:                                        } while (0)
1.22.2.10  misho     226: #define AIT_SET_STRSIZ(_vl, _len)      do { ait_val_t *__val = (_vl); assert(__val); \
                    227:                                                __val->val.string = (int8_t*) io_malloc(_len); \
                    228:                                                if (__val->val.string) { \
                    229:                                                        __val->val_type = string; AIT_LEN(__val) = _len; \
                    230:                                                        memset(__val->val.string, 0, _len); \
                    231:                                                } \
                    232:                                        } while (0)
1.14      misho     233: #define AIT_SET_STRCAT(_vl, _v)                do { ait_val_t *__val = (_vl); assert(__val); \
                    234:                                                assert(AIT_TYPE(__val) == string); \
1.22.2.8  misho     235:                                                if (!__val->val.string) \
                    236:                                                        AIT_LEN(__val) = 1; \
1.20      misho     237:                                                void *__p = io_realloc(__val->val.string, \
1.17      misho     238:                                                                AIT_LEN(__val) + strlen((_v))); \
1.14      misho     239:                                                if (__p) { \
                    240:                                                        AIT_LEN(__val) += strlen((_v)); \
1.22.2.8  misho     241:                                                        if (!__val->val.string) \
                    242:                                                                memset(__p, 0, AIT_LEN(__val)); \
                    243:                                                        __val->val.string = __p; \
1.17      misho     244:                                                        strlcat((char*) __val->val.string, (_v), \
                    245:                                                                        AIT_LEN(__val)); \
1.22.2.8  misho     246:                                                } else \
                    247:                                                        if (!__val->val.string) \
                    248:                                                                AIT_LEN(__val) = 0; \
                    249:                                        } while (0)
1.22.2.1  misho     250: #define AIT_SET_STRCPY(_vl, _v)                do { ait_val_t *__val = (_vl); assert(__val); \
                    251:                                                assert(AIT_TYPE(__val) == string); \
                    252:                                                void *__p = io_realloc(__val->val.string, \
                    253:                                                                strlen((_v)) + 1); \
                    254:                                                if (__p) { \
                    255:                                                        __val->val.string = __p; \
                    256:                                                        AIT_LEN(__val) = strlen((_v)) + 1; \
                    257:                                                        strlcpy((char*) __val->val.string, (_v), \
                    258:                                                                        AIT_LEN(__val)); \
                    259:                                                } } while (0)
1.22.2.11  misho     260: #define AIT_SET_STRLCPY(_vl, _v, _len) do { ait_val_t *__val = (_vl); assert(__val); \
                    261:                                                assert(AIT_TYPE(__val) == string); \
                    262:                                                void *__p = io_realloc(__val->val.string, _len); \
                    263:                                                if (__p) { \
                    264:                                                        __val->val.string = __p; AIT_LEN(__val) = _len; \
                    265:                                                        strlcpy((char*) __val->val.string, (_v), \
                    266:                                                                        AIT_LEN(__val)); \
                    267:                                                } } while (0)
1.12      misho     268: #define AIT_SET_BLOB(_vl, _n, _len)    do { ait_val_t *__val = (_vl); assert(__val); \
1.20      misho     269:                                                __val->val_type = blob; __val->val.blob = _n; \
                    270:                                                AIT_LEN(__val) = _len; } while (0)
1.12      misho     271: #define AIT_SET_BLOB2(_vl, _bv)                do { ait_val_t *__val = (_vl); assert(__val); assert((_bv)); \
1.22.2.2  misho     272:                                                __val->val_type = blob; AIT_LEN(__val) = \
                    273:                                                        (_bv)->blob_len; \
1.12      misho     274:                                                __val->val.blob = (_bv)->blob_var; } while (0)
                    275: #define AIT_NEW_BLOB(_vl, _len)                AIT_SET_BLOB((_vl), 0, _len)
                    276: 
                    277: #define AIT_SET_U8(_vl, _n)            do { ait_val_t *__val = (_vl); assert(__val); \
                    278:                                                __val->val_type = u8; __val->val.u8 = _n; \
                    279:                                                AIT_LEN(__val) = sizeof(uint8_t); } while (0)
                    280: #define AIT_SET_U16(_vl, _n)           do { ait_val_t *__val = (_vl); assert(__val); \
                    281:                                                __val->val_type = u16; __val->val.u16 = _n; \
                    282:                                                AIT_LEN(__val) = sizeof(uint16_t); } while (0)
                    283: #define AIT_SET_U32(_vl, _n)           do { ait_val_t *__val = (_vl); assert(__val); \
                    284:                                                __val->val_type = u32; __val->val.u32 = _n; \
                    285:                                                AIT_LEN(__val) = sizeof(uint32_t); } while (0)
                    286: #define AIT_SET_U64(_vl, _n)           do { ait_val_t *__val = (_vl); assert(__val); \
                    287:                                                __val->val_type = u64; __val->val.u64 = _n; \
                    288:                                                AIT_LEN(__val) = sizeof(uint64_t); } while (0)
                    289: #define AIT_SET_I8(_vl, _n)            do { ait_val_t *__val = (_vl); assert(__val); \
                    290:                                                __val->val_type = i8; __val->val.i8 = _n; \
                    291:                                                AIT_LEN(__val) = sizeof(int8_t); } while (0)
                    292: #define AIT_SET_I16(_vl, _n)           do { ait_val_t *__val = (_vl); assert(__val); \
                    293:                                                __val->val_type = i16; __val->val.i16 = _n; \
                    294:                                                AIT_LEN(__val) = sizeof(int16_t); } while (0)
                    295: #define AIT_SET_I32(_vl, _n)           do { ait_val_t *__val = (_vl); assert(__val); \
                    296:                                                __val->val_type = i32; __val->val.i32 = _n; \
                    297:                                                AIT_LEN(__val) = sizeof(int32_t); } while (0)
                    298: #define AIT_SET_I64(_vl, _n)           do { ait_val_t *__val = (_vl); assert(__val); \
                    299:                                                __val->val_type = i64; __val->val.i64 = _n; \
                    300:                                                AIT_LEN(__val) = sizeof(int64_t); } while (0)
                    301: #define AIT_SET_F32(_vl, _n)           do { ait_val_t *__val = (_vl); assert(__val); \
                    302:                                                __val->val_type = f32; __val->val.f32 = _n; \
                    303:                                                AIT_LEN(__val) = sizeof(float); } while (0)
                    304: #define AIT_SET_F64(_vl, _n)           do { ait_val_t *__val = (_vl); assert(__val); \
                    305:                                                __val->val_type = f64; __val->val.f64 = _n; \
                    306:                                                AIT_LEN(__val) = sizeof(double); } while (0)
                    307: 
1.18      misho     308: #define AIT_COPY_VAL(_vl, _v)          do { memcpy((_vl), (_v), sizeof(ait_val_t)); \
                    309:                                                switch (AIT_TYPE((_vl))) { \
                    310:                                                        case buffer: \
1.22.2.2  misho     311:                                                                AIT_SET_BUF((_vl), \
                    312:                                                                                AIT_GET_BUF((_v)), \
                    313:                                                                                AIT_LEN((_v))); \
1.18      misho     314:                                                                break; \
                    315:                                                        case string: \
1.22.2.2  misho     316:                                                                AIT_SET_STR((_vl), \
                    317:                                                                                AIT_GET_STR((_v))); \
1.18      misho     318:                                                                break; \
                    319:                                                        default: \
                    320:                                                                break; \
                    321:                                                } \
                    322:                                        } while (0)
                    323: #define AIT_COPY_VAL2(_vl, _v)         do { AIT_COPY_VAL((_vl), (_v)); \
                    324:                                                if (AIT_TYPE((_vl)) == data) \
1.22.2.2  misho     325:                                                        AIT_SET_DATA((_vl), AIT_GET_DATA((_v)), \
                    326:                                                                        AIT_LEN((_v))); \
1.18      misho     327:                                        } while (0)
                    328: 
1.17      misho     329: #define AIT_INIT_VAL(_vl)              (memset((_vl), 0, sizeof(ait_val_t)))
1.22.2.1  misho     330: #define AIT_INIT_VAL2(_vl, _t)         do { \
                    331:                                                AIT_INIT_VAL((_vl)); \
1.22.2.2  misho     332:                                                (_vl)->val_type = _t; \
1.22.2.1  misho     333:                                        } while (0)
1.20      misho     334:                                        /* if attribute zeroCopy is set not execute io_free() */
1.16      misho     335: #define AIT_FREE_VAL(_vl)              do { ait_val_t *__val = (_vl); assert(__val); \
                    336:                                                switch (AIT_TYPE(__val)) { \
1.12      misho     337:                                                        case buffer: \
1.21      misho     338:                                                                if (!__val->val_in && \
                    339:                                                                                __val->val.buffer) \
1.20      misho     340:                                                                        io_free(__val->val.buffer); \
1.21      misho     341:                                                                __val->val.buffer = NULL; \
1.12      misho     342:                                                                break; \
                    343:                                                        case string: \
1.21      misho     344:                                                                if (!__val->val_in && \
                    345:                                                                                __val->val.string) \
1.20      misho     346:                                                                        io_free(__val->val.string); \
1.21      misho     347:                                                                __val->val.string = NULL; \
1.12      misho     348:                                                                break; \
                    349:                                                        default: \
                    350:                                                                break; \
                    351:                                                } \
                    352:                                                __val->val_type = empty; \
1.21      misho     353:                                                __val->val_opt ^= __val->val_opt; \
1.12      misho     354:                                                AIT_LEN(__val) = 0; \
1.21      misho     355:                                                AIT_KEY(__val) = 0; \
1.12      misho     356:                                        } while (0)
1.22      misho     357: #define AIT_ZERO_VAL(_vl)              do { ait_val_t *__val = (_vl); assert(__val); \
                    358:                                                switch (AIT_TYPE(__val)) { \
                    359:                                                        case buffer: \
                    360:                                                        case string: \
1.22.2.6  misho     361:                                                                if (__val->val.buffer) \
                    362:                                                                        memset(__val->val.buffer, 0, \
1.22      misho     363:                                                                                AIT_LEN(__val)); \
                    364:                                                                break; \
                    365:                                                        default: \
                    366:                                                                __val->val.net = 0LL; \
                    367:                                                                break; \
                    368:                                                } \
                    369:                                                AIT_KEY(__val) = 0; \
                    370:                                        } while (0)
1.22.2.7  misho     371: #define AIT_ZERO_VAL2(_vl)             do { assert((_vl)); \
                    372:                                                if (AIT_TYPE((_vl)) == data) \
                    373:                                                        memset((_vl)->val_data, 0, AIT_LEN((_vl))); \
                    374:                                        } while (0)
1.12      misho     375: 
                    376: struct io_ether_addr {
                    377:        u_int8_t ether_addr_octet[6];
                    378: };
1.13      misho     379: typedef struct io_ether_addr io_ether_addr_t;
                    380: 
                    381: typedef union {
                    382:        struct sockaddr_storage ss;
                    383:        struct sockaddr         sa;
                    384:        struct sockaddr_un      sun;
                    385:        struct sockaddr_in      sin;
                    386:        struct sockaddr_in6     sin6;
                    387:        struct sockaddr_dl      sdl;
                    388: } io_sockaddr_t;
1.21      misho     389: #define IO_SOCKADDR_INIT       { .ss = { 0 } }
1.12      misho     390: 
1.3       misho     391: 
1.15      misho     392: #define io_align(x, a)         (((x) + (a)) & ~(a))
                    393: 
                    394: 
1.1       misho     395: // io_GetErrno() Get error code of last operation
                    396: inline int io_GetErrno();
                    397: // io_GetError() Get error text of last operation
                    398: inline const char *io_GetError();
                    399: 
                    400: 
1.20      misho     401: // io_mm_inuse() Check for memory management model
                    402: inline int io_mm_inuse();
                    403: 
                    404: /*
                    405:  * ioLibInit() - Init libaitio library memory management
                    406:  *
                    407:  * @mm = memory management (IO_SYSM or IO_MPOOL)
                    408:  * @maxmem = memory limit
                    409:  * return: -1 error or !=-1 used memory management model
                    410:  */
                    411: inline int ioLibInit(int mm, unsigned long maxmem);
                    412: /*
                    413:  * ioLibFini() - Finish libaitio library memory management
                    414:  *
                    415:  * return: none
                    416:  */
                    417: inline void ioLibFini();
                    418: 
                    419: /* memory management hooks */
                    420: extern void *(*io_malloc)(size_t);
                    421: extern void *(*io_calloc)(size_t, size_t);
                    422: extern void *(*io_realloc)(void*, size_t);
                    423: extern char *(*io_strdup)(const char*);
                    424: extern void (*io_free)(void*);
                    425: 
                    426: 
1.1       misho     427: /*
1.17      misho     428:  * io_ether_ntoa() - Convert ethernet address to string
1.16      misho     429:  *
1.12      misho     430:  * @n = ethernet address structure, like struct ether_addr
                    431:  * @a = string
                    432:  * @len = string length
                    433:  * return: NULL error or !=NULL string a
                    434:  */
                    435: inline char *io_ether_ntoa(const struct io_ether_addr *n, char * __restrict a, int len);
                    436: /*
1.17      misho     437:  * io_ether_aton() - Convert string to ethernet address
1.16      misho     438:  *
1.12      misho     439:  * @a = string
                    440:  * @e = ethernet address structure, like struct ether_addr
                    441:  * return: NULL error or !=NULL ethernet address structure
                    442:  */
                    443: inline struct io_ether_addr *io_ether_aton(const char *a, struct io_ether_addr *e);
1.13      misho     444: /*
1.17      misho     445:  * io_n2port() - Extract port from network structure
1.16      misho     446:  *
1.13      misho     447:  * @addr = Address
                    448:  * return: 0 not supported family type or port number
                    449:  */
                    450: inline u_short io_n2port(io_sockaddr_t * __restrict addr);
                    451: /*
1.17      misho     452:  * io_n2addr() - Extract address from network structure
1.16      misho     453:  *
1.13      misho     454:  * @addr = Address
                    455:  * @val = Value for store string address
                    456:  * return: NULL error or !=NULL string address from val
                    457:  */
                    458: const char *io_n2addr(io_sockaddr_t * __restrict addr, ait_val_t * __restrict val);
                    459: /*
1.17      misho     460:  * io_gethostbyname() - Get host and port and make network structure
1.16      misho     461:  *
1.13      misho     462:  * @psHost = Hostname
                    463:  * @port = Port
                    464:  * @addr = Network address structure
                    465:  * return: NULL error or !=NULL network structure
                    466:  */
                    467: io_sockaddr_t *io_gethostbyname(const char *psHost, unsigned short port, 
                    468:                io_sockaddr_t * __restrict addr);
1.12      misho     469: 
                    470: /*
1.17      misho     471:  * io_vars2buffer() - Marshaling data from array with variables to buffer
1.16      misho     472:  *
1.12      misho     473:  * @buf = Buffer
                    474:  * @buflen = Size of buffer
                    475:  * @vars = Variable array
                    476:  * return: -1 error, 0 nothing done or >0 size of marshaled data
                    477:  */
1.21      misho     478: inline int io_vars2buffer(unsigned char * __restrict buf, int buflen, 
                    479:                array_t * __restrict vars);
1.12      misho     480: /*
1.17      misho     481:  * io_buffer2vars() - De-marshaling data from buffer to array with variables
1.16      misho     482:  *
1.12      misho     483:  * @buf = Buffer
                    484:  * @buflen = Size of buffer
                    485:  * @vnum = Number of variables into buffer
                    486:  * @zcpy = Zero-copy for variables, if !=0 don't use io_arrayFree() for free variables and 
                    487:                *DON'T MODIFY OR DESTROY BUFFER*. =0 call io_arrayFree() before io_arrayDestroy()
                    488:  * return: =NULL error, !=NULL allocated variable array, after use must free with io_arrayDestroy()
                    489:  */
1.21      misho     490: inline array_t *io_buffer2vars(unsigned char * __restrict buf, int buflen, int vnum, int zcpy);
1.12      misho     491: /*
1.17      misho     492:  * io_vars2map() - Marshaling data from array with variables to memory map
1.16      misho     493:  *
1.12      misho     494:  * @buf = Buffer
                    495:  * @buflen = Size of buffer
                    496:  * @vars = Variable array
                    497:  * return: -1 error, 0 nothing done or >0 size of marshaled data
                    498:  */
1.21      misho     499: inline int io_vars2map(unsigned char * __restrict buf, int buflen, 
                    500:                array_t * __restrict vars);
1.12      misho     501: /*
1.17      misho     502:  * io_map2vars() - De-marshaling data from memory map to array with variables
1.16      misho     503:  *
1.12      misho     504:  * @buf = Buffer
                    505:  * @buflen = Size of buffer
                    506:  * @vnum = Number of variables into buffer
                    507:  * @zcpy = Zero-copy for variables, if !=0 don't use io_arrayFree() for free variables and 
                    508:                *DON'T MODIFY OR DESTROY BUFFER*. =0 call io_arrayFree() before io_arrayDestroy()
                    509:  * return: =NULL error, !=NULL allocated variable array, after use must free with io_arrayDestroy()
                    510:  */
1.21      misho     511: inline array_t *io_map2vars(unsigned char * __restrict buf, int buflen, int vnum, int zcpy);
1.13      misho     512: 
                    513: /*
1.17      misho     514:  * io_allocVar() - Allocate memory for variable
1.16      misho     515:  *
1.14      misho     516:  * return: NULL error or new variable, after use free variable with io_freeVar()
                    517:  */
                    518: inline ait_val_t *io_allocVar(void);
                    519: /*
1.17      misho     520:  * io_freeVar() - Free allocated memory for variable
1.16      misho     521:  *
1.14      misho     522:  * @val = Variable
                    523:  * return: none
                    524:  */
1.17      misho     525: inline void io_freeVar(ait_val_t ** __restrict val);
1.14      misho     526: /*
1.17      misho     527:  * io_allocVars() - Allocate ait_val_t array
1.16      misho     528:  *
1.13      misho     529:  * @varnum = Number of variables
                    530:  * return: =NULL error or !=NULL allocated array
                    531:  */
                    532: inline array_t *io_allocVars(int varnum);
                    533: /*
1.17      misho     534:  * io_clrVars() - Clear ait_val_t elements from array
1.16      misho     535:  *
1.13      misho     536:  * @vars = Variable array
                    537:  * return: -1 error or size of array
                    538:  */
                    539: inline int io_clrVars(array_t * __restrict vars);
                    540: /*
1.17      misho     541:  * io_freeVars() - Free ait_val_t array
1.16      misho     542:  *
1.13      misho     543:  * @vars = Variable array
                    544:  * return: none
                    545:  */
                    546: inline void io_freeVars(array_t ** __restrict vars);
1.17      misho     547: /*
1.18      misho     548:  * io_getVars() - Get ait_val_t element from array and if not exists allocate it
                    549:  *
                    550:  * @vars = Variable array
                    551:  * @n = index of variable into array
                    552:  * return: NULL error or !=NULL ait_val_t element
                    553:  */
                    554: inline ait_val_t *io_getVars(array_t ** __restrict vars, int n);
                    555: /*
1.21      misho     556:  * io_sortVarsByKey() - Sorting array with variables by key
                    557:  *
                    558:  * @vars = Variable array
                    559:  * @order = Sort order. If =0 ascend or !=0 descend
                    560:  * return: none
                    561:  */
                    562: inline void io_sortVarsByKey(array_t * __restrict vars, int order);
                    563: /*
                    564:  * io_sortVarsByVal() - Sorting array with variables by value
1.17      misho     565:  *
                    566:  * @vars = Variable array
1.21      misho     567:  * @order = Sort order. If =0 ascend or !=0 descend
                    568:  * @cmp = Custom compare function for sorting. If =NULL compare by value
1.17      misho     569:  * return: none
                    570:  */
1.21      misho     571: inline void io_sortVarsByVal(array_t * __restrict vars, int order,  
1.17      misho     572:                int (*cmp)(const void*, const void*));
                    573: /*
                    574:  * io_findKeyVars() - Find variable by key from array
                    575:  *
                    576:  * @vars = Variables
                    577:  * @key = Search key
                    578:  * return: NULL error or not found, !=NULL valid element
                    579:  */
                    580: ait_val_t *io_findKeyVars(array_t * __restrict vars, u_short key);
1.13      misho     581: 
1.12      misho     582: 
                    583: /*
1.17      misho     584:  * ioPromptRead() - Read data from input h[0] with prompt to output h[1]
1.16      misho     585:  *
1.1       misho     586:  * @h = file handles h[0] = input, h[1] = output, if NULL use stdin, stdout
                    587:  * @csPrompt = Prompt before input, may be NULL
                    588:  * @psData = Readed data
                    589:  * @dataLen = Length of data
                    590:  * return: 0 EOF; -1 error:: can`t read; >0 count of readed chars
                    591: */
                    592: int ioPromptRead(int *h, const char *csPrompt, char * __restrict psData, int dataLen);
                    593: /*
1.17      misho     594:  * ioPromptPassword() - Read password from input h[0] with prompt to output h[1]
1.16      misho     595:  *
1.1       misho     596:  * @h = file handles h[0] = input, h[1] = output, if NULL use stdin, stdout
                    597:  * @csPrompt = Prompt before input, may be NULL
                    598:  * @psPass = Readed password
                    599:  * @passLen = Length of password
                    600:  * @confirm = Confirm password, 0 - get password, !=0 Ask for confirmation
                    601:  * return: 0 EOF; -1 error:: can`t read; >0 count of readed chars
                    602: */
                    603: int ioPromptPassword(int *h, const char *csPrompt, char * __restrict psPass, int passLen, int confirm);
                    604: 
                    605: /*
1.17      misho     606:  * ioRegexVerify() - Function for verify data match in regex expression
1.16      misho     607:  *
1.1       misho     608:  * @csRegex = Regulare expression pattern
                    609:  * @csData = Data for check and verify
                    610:  * @startPos = Return start positions
                    611:  * @endPos = Return end positions
                    612:  * return: NULL not match or error; !=NULL begin of matched data
                    613: */
                    614: const char *ioRegexVerify(const char *csRegex, const char *csData, int *startPos, int *endPos);
                    615: /*
1.17      misho     616:  * ioRegexGet() - Function for get data match in regex expression
1.16      misho     617:  *
1.1       misho     618:  * @csRegex = Regulare expression pattern
                    619:  * @csData = Data from get
                    620:  * @psString = Returned string if match
                    621:  * @strLen = Length of string
                    622:  * return: 0 not match; >0 count of returned chars
                    623: */
                    624: int ioRegexGet(const char *csRegex, const char *csData, char * __restrict psString, int strLen);
                    625: /*
1.17      misho     626:  * ioRegexReplace() - Function for replace data match in regex expression with newdata
1.16      misho     627:  *
1.1       misho     628:  * @csRegex = Regulare expression pattern
                    629:  * @csData = Source data
                    630:  * @csNew = Data for replace
1.20      misho     631:  * return: NULL not match or error; !=NULL allocated new string, must be io_free after use!
1.1       misho     632: */
                    633: char *ioRegexReplace(const char *csRegex, const char *csData, const char *csNew);
                    634: 
1.2       misho     635: /*
1.17      misho     636:  * ioStrAst() - Function for evaluate string like asterisk variable "{text[:[-]#[:#]]}"
1.16      misho     637:  *
1.6       misho     638:  * @csString = Input string
1.20      misho     639:  * return: NULL error, !=NULL Allocated new string evaluated from input string, must be io_free()
1.6       misho     640: */
1.13      misho     641: char *ioStrAst(const char *csString);
1.6       misho     642: 
                    643: /*
1.17      misho     644:  * io_UnquotStr() - Remove quots from input text string 
1.16      misho     645:  *
1.4       misho     646:  * @psLine = Text string
                    647:  * return: 0 nothing to do; 1 successful unquoted string
                    648: */
1.17      misho     649: inline int io_UnquotStr(char * __restrict psLine);
1.4       misho     650: /*
1.17      misho     651:  * io_LTrimStr() - Remove left whitespaces from text string
1.16      misho     652:  *
1.4       misho     653:  * @psLine = Text string
                    654:  * return: 0 nothing to do; !=0 Removed bytes
                    655: */
1.17      misho     656: inline int io_LTrimStr(char * __restrict psLine);
1.4       misho     657: /*
1.17      misho     658:  * io_RTrimStr() - Remove right whitespaces from text string
1.16      misho     659:  *
1.4       misho     660:  * @psLine = Text string
                    661:  * return: 0 nothing to do; !=0 Removed bytes
                    662: */
1.17      misho     663: inline int io_RTrimStr(char * __restrict psLine);
1.4       misho     664: /*
1.17      misho     665:  * io_TrimStr() - Remove left and right whitespaces from text string
1.16      misho     666:  *
1.4       misho     667:  * @psLine = Text string
                    668:  * return: 0 nothing to do; !=0 Removed bytes
                    669: */
1.17      misho     670: inline int io_TrimStr(char * __restrict psLine);
1.4       misho     671: /*
1.17      misho     672:  * io_Ch2Hex() - Convert from Char string to Hex string
1.16      misho     673:  *
1.4       misho     674:  * @psLine = Text string
                    675:  * @lineLen = Length of Text string
1.20      misho     676:  * return: NULL nothing to do or error; !=0 Allocated new converted data without term\0 (must be io_free)
1.4       misho     677: */
1.5       misho     678: inline unsigned char *io_Ch2Hex(unsigned char *psLine, int lineLen);
1.4       misho     679: /*
1.17      misho     680:  * io_Hex2Ch() - Convert from Hex string to Char string
1.16      misho     681:  *
1.4       misho     682:  * @psLine = Text string
                    683:  * @lineLen = Length of Text string
1.20      misho     684:  * return: NULL nothing to do or error; !=0 Allocated new converted string(must be io_free)
1.4       misho     685: */
1.5       misho     686: inline char *io_Hex2Ch(unsigned char *psLine, int lineLen);
1.4       misho     687: 
                    688: /*
1.15      misho     689:  * io_Path2File() - Parse and make path/filename pair
                    690:  *
                    691:  * @csArgs = Input argument line
                    692:  * @psPath = Output Path, if ==NULL path not returned
                    693:  * @pathLen = Size of path array
                    694:  * @psFile = Output File
                    695:  * @fileLen = Size of file array
                    696:  * return: 0 error format; -1 error:: can`t read; >0 ok, number of readed items
                    697:  */
                    698: inline int
                    699: io_Path2File(const char * __restrict csArgs, char * __restrict psPath, 
                    700:                int pathLen, char * __restrict psFile, int fileLen);
                    701: 
                    702: /*
1.8       misho     703:  * io_arrayInit() - Create and initialize dynamic array
1.16      misho     704:  *
1.8       misho     705:  * @numItems = Number of Items
                    706:  * return: NULL error, != NULL allocated memory for array
                    707:  */
                    708: inline array_t *io_arrayInit(int numItems);
                    709: /*
1.10      misho     710:  * io_arrayDestroy() - Free and destroy dynamic array
1.16      misho     711:  *
1.8       misho     712:  * @parr = Array
                    713:  * return: none
                    714:  */
                    715: inline void io_arrayDestroy(array_t ** __restrict parr);
                    716: /*
1.10      misho     717:  * io_arrayFree() - Free all data in dynamic array items
1.8       misho     718:  *     (WARNING! If assign static array dont use this!!!)
1.16      misho     719:  *
1.8       misho     720:  * @arr = Array
                    721:  * return: none
                    722:  */
                    723: inline void io_arrayFree(array_t * __restrict arr);
                    724: /*
1.10      misho     725:  * io_arrayFrom() - Create and fill array from array with pointers
1.16      misho     726:  *
1.11      misho     727:  * @pargv = Array with pointers
1.10      misho     728:  * @argc = Number of Items, if 0 walk through argv and stop when reach NULL item
1.11      misho     729:  * return: NULL error, != NULL allocated new array
1.10      misho     730:  */
1.11      misho     731: inline array_t *io_arrayFrom(const char *** __restrict pargv, int argc);
1.10      misho     732: /*
                    733:  * io_arrayTo() - Create and fill array with pointers from dynamic array
1.16      misho     734:  *
1.10      misho     735:  * @arr = Array
1.11      misho     736:  * return: NULL error, != NULL allocated memory for array, NULL terminated
1.10      misho     737:  */
                    738: inline char **io_arrayTo(array_t * __restrict arr);
                    739: /*
1.8       misho     740:  * io_arrayLen() - Get last used element in dynamic array (array Length)
1.16      misho     741:  *
1.8       misho     742:  * @arr = Array
1.17      misho     743:  * return: -1 empty or >-1 position of last used element
1.8       misho     744:  */
                    745: inline int io_arrayLen(array_t * __restrict arr);
                    746: /*
1.10      misho     747:  * io_arrayConcat() Concat source array to destination array
1.16      misho     748:  *
1.10      misho     749:  * @dest = Destination array
                    750:  * @src = Source array
                    751:  * return: -1 error; >0 new count of destination array
                    752:  */
                    753: int io_arrayConcat(array_t * __restrict dest, array_t * __restrict src);
                    754: /*
1.12      misho     755:  * io_arrayCopy() Copy source array to destination array
1.16      misho     756:  *
1.12      misho     757:  * @dest = Destination array, after use free with io_arrayDestroy()
                    758:  * @src = Source array
                    759:  * return: -1 error; >0 count of destination array
                    760:  */
                    761: int io_arrayCopy(array_t ** __restrict dest, array_t * __restrict src);
                    762: /*
1.8       misho     763:  * io_arrayGrow() - Grow/Shrink dynamic array, Use with care when it shrink!!!
1.16      misho     764:  *
1.8       misho     765:  * @arr = Array
                    766:  * @newNumItems = Number of Items
1.12      misho     767:  * @freeShrink = Free elements before shrink array
1.8       misho     768:  * return: -1 error, 0 ok
                    769:  */
1.12      misho     770: int io_arrayGrow(array_t * __restrict arr, int newNumItems, int freeShrink);
1.8       misho     771: /*
                    772:  * io_arrayVacuum() - Vacuum dynamic array, empty elements will be deleted
1.16      misho     773:  *
1.8       misho     774:  * @arr = Array
                    775:  * @fromWhere = 1 begin, 2 ALL empty elements
                    776:  * return: -1 error, 0 ok
                    777:  */
                    778: int io_arrayVacuum(array_t * __restrict arr, int fromWhere);
                    779: 
1.12      misho     780: #define io_arraySize(_arr)             ((_arr) ? (_arr)->arr_num : 0)
1.17      misho     781: #define io_arrayLast(_arr)             (io_arraySize((_arr)) ? (_arr)->arr_last : -1)
1.12      misho     782: #define io_arrayZero(_arr)             (assert((_arr)), memset((_arr)->arr_data, 0, \
                    783:                                                io_arraySize((_arr)) * sizeof(void*)))
1.8       misho     784: 
1.17      misho     785: #define io_arrayGet2(_arr, _d)         (assert((_arr) && (_arr)->arr_num > _d), ((_arr)->arr_data + _d))
1.18      misho     786: #define io_arrayGet(_arr, _d)          (assert((_arr) && (_arr)->arr_num > _d), (_arr)->arr_data[_d])
1.11      misho     787: #define io_array(_arr, _d, _type)      (assert((_arr) && (_arr)->arr_num > _d), \
1.18      misho     788:                                                ((_type) (_arr)->arr_data[_d]))
1.8       misho     789: #define io_arraySet(_arr, _d, _ptr)    do { \
1.11      misho     790:                                                assert((_arr) && (_arr)->arr_num > _d); \
1.17      misho     791:                                                if ((_arr)->arr_last < _d) \
                    792:                                                        (_arr)->arr_last = _d; \
1.18      misho     793:                                                (_arr)->arr_data[_d] = (void*) (_ptr); \
1.8       misho     794:                                        } while (0)
1.11      misho     795: #define io_arrayDel(_arr, _d, _fri)    do { \
                    796:                                                assert((_arr) && (_arr)->arr_num > _d); \
1.18      misho     797:                                                if (_fri && (_arr)->arr_data[_d]) \
                    798:                                                        free((_arr)->arr_data[_d]); \
                    799:                                                (_arr)->arr_data[_d] = NULL; \
1.17      misho     800:                                        } while (0)
1.8       misho     801: 
                    802: /*
1.13      misho     803:  * io_arrayElem() - Always GET/PUT element into dynamic array, if not enough elements grow array
1.16      misho     804:  *
1.13      misho     805:  * @arr = Array
                    806:  * @n = Position
                    807:  * @data = Element, if set NULL GET element at position or !=NULL PUT element at position
                    808:  * return: -1 error or !=-1 return element at position
                    809:  */
1.14      misho     810: inline void *io_arrayElem(array_t * __restrict arr, int n, void *data);
1.13      misho     811: /*
1.8       misho     812:  * io_arrayPush() - Push element into dynamic array like stack manner, place at first empty position
1.16      misho     813:  *
1.8       misho     814:  * @arr = Array
                    815:  * @data = Element, if set NULL return only first empty position
1.17      misho     816:  * @mayGrow = Array may to grow, if not enough room for new element
1.8       misho     817:  * return: -1 not found empty position, array is full!, >-1 return position of stored element into array
                    818:  */
1.17      misho     819: inline int io_arrayPush(array_t * __restrict arr, void **data, int mayGrow);
1.8       misho     820: /*
                    821:  * io_arrayPop() - Pop element from dynamic array like stack manner, last used position
1.16      misho     822:  *
1.8       misho     823:  * @arr = Array
1.11      misho     824:  * @data = Element, if set NULL return only last used position
1.8       misho     825:  * @delAfter = Delete after Pop element, !=0 delete element from array after return data
                    826:  * return: -1 not found used position, array is empty!, >-1 return element position
                    827:  */
                    828: inline int io_arrayPop(array_t * __restrict arr, void ** __restrict data, int delAfter);
                    829: 
                    830: /*
1.17      misho     831:  * io_argsNum() - Parse and calculate number of arguments
1.16      misho     832:  *
1.8       misho     833:  * @csArgs = Input arguments line
                    834:  * @csDelim = Delimiter(s) for separate
                    835:  * return: 0 error format; -1 error:: can`t read; >0 ok, number of items
                    836:  */
                    837: inline int io_argsNum(const char *csArgs, const char *csDelim);
                    838: 
                    839: /*
1.17      misho     840:  * io_arrayMake() - Parse and make array from arguments ... (input string will be modified!!! 
1.8       misho     841:  *     and output array must be free with io_arrayDestroy() after use!)
1.16      misho     842:  *
1.8       misho     843:  * @psArgs = Input arguments line, after execute string is modified!!!
                    844:  * @nargs = Maximum requested count of arguments from input string psArgs, if 0 all psArgs
                    845:  * @csDelim = Delimiter(s) for separate
1.20      misho     846:  * @parr = Output array of arguments ... (must be io_free with io_arrayDestroy() after use!)
1.8       misho     847:  * return: 0 error format; -1 error:: can`t read; >0 ok, number of readed items
                    848:  */
                    849: int io_arrayMake(char * __restrict psArgs, int nargs, const char *csDelim, 
                    850:                array_t ** __restrict parr);
                    851: 
                    852: /*
1.17      misho     853:  * io_MakeAV() - Parse and make attribute/value pair
1.16      misho     854:  *
1.8       misho     855:  * @csArgs = Input argument line
                    856:  * @csDelim = Delimiter for separate
                    857:  * @psAttr = Output Attribute
                    858:  * @attrLen = Size of attribute array
                    859:  * @psValue = Output Value, if ==NULL this element not present value or not wanted for return
                    860:  * @valLen = Size of value array
                    861:  * return: 0 error format; -1 error:: can`t read; >0 ok, number of readed items
                    862: */
                    863: int io_MakeAV(const char * __restrict csArgs, const char *csDelim, 
                    864:                char * __restrict psAttr, int attrLen, char * __restrict psValue, int valLen);
1.22.2.3  misho     865: /*
                    866:  * io_MakeAV2() Parse and make attribute/value pair over input string
                    867:  *
                    868:  * @csArgs = Input argument line, will be modified!
                    869:  * @csDelim = Delimiter for separate
                    870:  * @psAttr = Output Attribute
                    871:  * @psValue = Output Value, if ==NULL this element not present value or not wanted for return
                    872:  * return: 0 error format; -1 error:: can`t read; >0 ok, number of readed items
                    873: */
1.22.2.4  misho     874: int io_MakeAV2(char * __restrict psArgs, const char *csDelim, 
1.22.2.5  misho     875:                char ** __restrict psAttr, char ** __restrict psValue);
1.8       misho     876: 
1.9       misho     877: /*
                    878:  * io_sarrInit() - Create and initialize dynamic split-order array
1.16      misho     879:  *
1.9       misho     880:  * @numItems = Number of Items
                    881:  * @segLen = Length of segment
                    882:  * return: NULL error, != NULL allocated memory for array
                    883:  */
                    884: inline sarr_t *io_sarrInit(int numItems, int segLen);
                    885: /*
                    886:  * io_sarrDestroy() - Free all data in dynamic split-order array and Destroy array
1.16      misho     887:  *
1.9       misho     888:  * @parr = Array
                    889:  * return: none
                    890:  */
                    891: inline void io_sarrDestroy(sarr_t ** __restrict parr);
                    892: /*
                    893:  * io_sarrGrow() - Grow/Shrink dynamic split-order array, Use with care when it shrink!!!
1.16      misho     894:  *
1.9       misho     895:  * @arr = Array
                    896:  * @newNumItems = Number of Items
                    897:  * return: -1 error, 0 ok
                    898:  */
                    899: int io_sarrGrow(sarr_t * __restrict arr, int newNumItems);
                    900: /*
                    901:  * io_sarrVacuum() - Vacuum dynamic split-order array, empty segments will be freed
1.16      misho     902:  *
1.9       misho     903:  * @arr = Array
                    904:  * return: -1 error, >-1 freed segments
                    905:  */
                    906: inline int io_sarrVacuum(sarr_t * __restrict arr);
1.12      misho     907: #define io_sarrSize(_arr)              ((_arr) ? (_arr)->sarr_num : 0)
                    908: #define io_sarrSeg(_arr)               (assert((_arr)), (_arr)->sarr_seg)
                    909: /*
                    910:  * io_sarrCopy() Copy source split array to destination split array
1.16      misho     911:  *
1.12      misho     912:  * @dest = Destination split array, after use free with io_sarrDestroy()
                    913:  * @src = Source split array
                    914:  * return: -1 error; >0 count of destination split array
                    915:  */
                    916: int io_sarrCopy(sarr_t ** __restrict dest, sarr_t * __restrict src);
1.9       misho     917: /*
                    918:  * io_sarrGet() - Get element from dynamic split-order array
1.16      misho     919:  *
1.9       misho     920:  * @arr = Array
                    921:  * @idx = Index (warning 1st element is at position 1)
                    922:  * return: NULL not found, !=NULL element
                    923:  */
                    924: inline void *io_sarrGet(sarr_t * __restrict arr, unsigned int idx);
                    925: /*
                    926:  * io_sarrGet2() - Always get element from dynamic split-order array
                    927:  *     Function automatic grow array. Good use for Hash tables! 
1.16      misho     928:  *
1.9       misho     929:  * @arr = Array
                    930:  * @idx = Index (warning 1st element is at position 1)
                    931:  * return: NULL not found, !=NULL element
                    932:  */
                    933: void *io_sarrGet2(sarr_t * __restrict arr, unsigned int idx);
                    934: /*
                    935:  * io_sarrSet() - Set element to dynamic split-order array
1.16      misho     936:  *
1.9       misho     937:  * @arr = Array
                    938:  * @idx = Index (warning 1st element is at position 1)
                    939:  * @data = Value
                    940:  * return: NULL error or empty, !=NULL old value in element
                    941:  */
                    942: inline void *io_sarrSet(sarr_t * __restrict arr, unsigned int idx, void *data);
1.11      misho     943: #define io_sarrDel(_arr, _idx)         io_sarrSet((_arr), _idx, NULL)
                    944: #define io_sarr(_arr, _idx, _type)     (_type)io_sarrGet((_arr), _idx)
                    945: /*
                    946:  * io_sarr2array() - Convert from split-order array to dynamic array
1.16      misho     947:  *
1.11      misho     948:  * @sa = split array
                    949:  * @sarrFree = after convert split array !=0 will be destroyed sarray
                    950:  * return: NULL error or != NULL new array
                    951:  */
                    952: array_t *io_sarr2array(sarr_t ** __restrict sa, int sarrFree);
                    953: /*
                    954:  * io_array2sarr() - Convert from dynamic array to split-order array
1.16      misho     955:  *
1.11      misho     956:  * @a = array
                    957:  * @segLen = Length of segment
                    958:  * @arrFree = after convert array !=0 will be destroyed
                    959:  * return: NULL error or != NULL new sarr
                    960:  */
                    961: sarr_t *io_array2sarr(array_t ** __restrict a, int segLen, int arrFree);
1.8       misho     962: 
                    963: /*
1.17      misho     964:  * io_CopyEnv() - Copy environment to new environment array;
1.16      misho     965:  *
1.10      misho     966:  * @oldenv = Environment array
1.20      misho     967:  * return: NULL error; !=NULL Allocated new environment array(must be io_free)
1.10      misho     968: */
                    969: char **io_CopyEnv(const char **oldenv);
                    970: /*
1.17      misho     971:  * io_ExecArgs() - Build exec arguments from other array
1.16      misho     972:  *
1.10      misho     973:  * @psProg = Program name for execute
                    974:  * @oldarg = Arguments array
1.20      misho     975:  * return: NULL error; !=NULL Allocated execution array(must be io_free)
1.10      misho     976: */
                    977: char **io_ExecArgs(const char *psProg, const char **oldarg);
                    978: /*
1.17      misho     979:  * io_FreeNullTerm() - Free dynamic allocated null terminated array with strings
1.16      misho     980:  *
1.10      misho     981:  * @arr = Pointer to array for free
                    982:  * return: none
                    983: */
                    984: inline void io_FreeNullTerm(char *** __restrict arr);
                    985: 
                    986: /*
1.17      misho     987:  * ioMkDir() - Function for racursive directory creation and validation
1.16      misho     988:  *
1.5       misho     989:  * @csDir = Full directory path
                    990:  * @mode = Mode for directory creation if missing dir
                    991:  * return: -1 error, 0 directory path exist, >0 created missing dirs
                    992: */
                    993: int ioMkDir(const char *csDir, int mode);
                    994: 
1.6       misho     995: /*
1.17      misho     996:  * ioWatchDirLoop() - Function for watching changes in directory and fire callback
1.16      misho     997:  *
1.6       misho     998:  * @csDir = Full directory path
                    999:  * @callback = Callback if raise event! nOp -1 delete, 0 change/move, 1 create
                   1000:  * return: -1 error, !=-1 ok, number of total signaled events
                   1001: */
                   1002: int ioWatchDirLoop(const char *csDir, int (*callback)(const char *csName, int nOp));
                   1003: 
1.5       misho    1004: 
                   1005: /*
1.17      misho    1006:  * io_rread() - Raw VFS read function
1.16      misho    1007:  *
1.5       misho    1008:  * @fd = File handle
                   1009:  * @buf = Read buffer
                   1010:  * @nbytes = Read buffer size
                   1011:  * @offset = Read from position, if -1 read nbytes from current position
                   1012:  * @update = Update file handle position !0
                   1013:  * return: -1 error or !=-1 readed bytes
                   1014:  */
                   1015: inline int io_rread(int fd, void * __restrict buf, size_t nbytes, off_t offset, int update);
                   1016: /*
1.17      misho    1017:  * io_rwrite() - Raw VFS write function
1.16      misho    1018:  *
1.5       misho    1019:  * @fd = File handle
                   1020:  * @buf = Write buffer
                   1021:  * @nbytes = Write bytes from buffer
                   1022:  * @offset = Write at position, if -1 write nbytes from current position
                   1023:  * @update = Update file handle position !0
                   1024:  * return: -1 error or !=-1 writed bytes
                   1025:  */
                   1026: inline int io_rwrite(int fd, void * __restrict buf, size_t nbytes, off_t offset, int update);
                   1027: 
                   1028: /* Disk I/O helper macros */
                   1029: #define io_read(f, b, n) io_rread(f, b, n, -1, 1)
                   1030: #define io_write(f, b, n) io_rwrite(f, b, n, -1, 1)
                   1031: 
                   1032: 
                   1033: /* Debug helper macros */
                   1034: extern int io_Debug;
                   1035: 
1.14      misho    1036: #define io_enableDEBUG         int io_Debug
                   1037: #define io_initDebug(x)                (io_Debug = (x))
                   1038: #define io_incDebug            (io_Debug++)
                   1039: #define io_decDebug            (io_Debug--)
                   1040: 
                   1041: /* Debug macros */
                   1042: #define ioVERBOSE(x)           if ((x) <= io_Debug)
                   1043: #define ioTRACE(x)             if ((x) <= io_Debug) \
                   1044:                                           syslog(LOG_DEBUG, "I'm in %s(%d)", __func__, __LINE__)
1.5       misho    1045: #define ioDEBUG(x, fmt, ...)   do { \
                   1046:                                        assert((fmt)); \
                   1047:                                        char str[STRSIZ] = { 0 }; \
1.11      misho    1048:                                        snprintf(str, sizeof str, (fmt), ##__VA_ARGS__); \
1.5       misho    1049:                                        if ((x) <= io_Debug) \
1.14      misho    1050:                                                syslog(LOG_DEBUG, "Debug(%d):%s(%d): %s\n", \
1.5       misho    1051:                                                                (x), __func__, __LINE__, str); \
                   1052:                                } while (0)
                   1053: 
1.14      misho    1054: /* Logger macro */
                   1055: #define ioLOGGER(x, fmt, ...)  do { \
                   1056:                                        assert((fmt)); \
                   1057:                                        char str[STRSIZ] = { 0 }; \
                   1058:                                        snprintf(str, sizeof str, (fmt), ##__VA_ARGS__); \
                   1059:                                        syslog((x), "Logger:%s(%d): %s\n", \
                   1060:                                                                __func__, __LINE__, str); \
                   1061:                                } while (0)
                   1062: 
                   1063: /* Error state macros */
1.5       misho    1064: #define ioERROR(x, fmt, ...)   do { \
                   1065:                                        assert((fmt)); \
                   1066:                                        char str[STRSIZ] = { 0 }; \
1.11      misho    1067:                                        snprintf(str, sizeof str, (fmt), ##__VA_ARGS__); \
1.14      misho    1068:                                        syslog(LOG_ERR, "Error:%s(%d): #%d - %s\n", \
1.5       misho    1069:                                                         __func__, __LINE__, (x), str); \
                   1070:                                } while (0)
1.14      misho    1071: #define ioSYSERR(x)            do { \
1.5       misho    1072:                                        if (x > 0 || errno) \
1.14      misho    1073:                                                syslog(LOG_ERR, "Error(sys):%s(%d): #%d - %s\n", \
1.5       misho    1074:                                                                __func__, __LINE__, x > 0 ? x : errno, \
                   1075:                                                                strerror(x > 0 ? x : errno)); \
                   1076:                                } while (0)
1.14      misho    1077: #define ioLIBERR(ait)          do { \
1.5       misho    1078:                                        if (ait##_GetErrno()) \
1.14      misho    1079:                                                syslog(LOG_ERR, "Error(lib):%s(%d): #%d - %s\n", \
1.5       misho    1080:                                                                __func__, __LINE__, ait##_GetErrno(), \
                   1081:                                                                ait##_GetError()); \
                   1082:                                } while (0)
1.3       misho    1083: 
1.1       misho    1084: 
1.7       misho    1085: /* Crypto framework */
                   1086: 
                   1087: /*
1.17      misho    1088:  * ioCipher() - Cipher wrapper for all supported crypto algorythms
1.16      misho    1089:  *
1.7       misho    1090:  * @pInput = input buffer
                   1091:  * @inLen = input buffer len
1.20      misho    1092:  * @ppOutput = output allocated buffe, must be io_free after use
1.7       misho    1093:  * @Cipher = cipher engine, like EVP_bf_cbc() or etc...
                   1094:  * @pKey = key
                   1095:  * @pIV = IV, salt (8 bytes)
                   1096:  * @nMode = Mode 0 - decrypting or 1 - encrypting
                   1097:  * return: 0 not present data or error!; >0 number of processed and returned bytes into ppOutput
                   1098: */
                   1099: int ioCipher(unsigned char *pInput, int inLen, unsigned char **ppOutput, const EVP_CIPHER *Cipher, 
                   1100:                unsigned char *pKey, unsigned char *pIV, int nMode);
                   1101: 
                   1102: /*
1.17      misho    1103:  * io_Blowfish() - Blowfish cipher algorythm, work with ASCII hex strings
1.16      misho    1104:  *
1.7       misho    1105:  * @pInput = input buffer
                   1106:  * @inLen = input buffer len
1.20      misho    1107:  * @ppOutput = output allocated buffe, must be io_free after use
1.7       misho    1108:  * @pKey = key
                   1109:  * @pIV = IV, salt (8 bytes)
                   1110:  * @nMode = Mode 0 - decrypting or 1 - encrypting
                   1111:  * return: 0 not present data or error!; >0 number of processed and returned bytes into ppOutput
                   1112: */
1.8       misho    1113: int io_Blowfish(unsigned char *pInput, int inLen, unsigned char **ppOutput, 
                   1114:                unsigned char *pKey, unsigned char *pIV, int nMode);
1.12      misho    1115: /*
1.17      misho    1116:  * io_ctr_AES() - Encrypt/Decrypt stream cipher CTR_AES
1.16      misho    1117:  *
1.12      misho    1118:  * @pInput = Input buffer with ASCII
                   1119:  * @inLen = Input buffer data length
1.20      misho    1120:  * @ppOutput = Output buffer with cipher data, must be io_free after use
1.12      misho    1121:  * @pKey = Key
                   1122:  * @IV = IVector/Nonce/Counter, Warning: IV must be variable, because we write there!!!
                   1123:  * return: -1 error or >-1 how many cipher blocks proceeded
                   1124:  */
                   1125: int io_ctr_AES(unsigned char *pInput, int inLen, unsigned char **ppOutput, 
                   1126:                unsigned char *pKey, unsigned char IV[AES_BLOCK_SIZE]);
                   1127: 
                   1128: 
                   1129: /*
1.17      misho    1130:  * ioAllocPTY() - Allocate new PTY and TTY
1.16      misho    1131:  *
1.12      misho    1132:  * @ptyfd = master fd, pty
                   1133:  * @ttyfd = slave fd, tty
                   1134:  * @name = tty device name if not null
                   1135:  * @namesiz = name length, must be above 63 bytes.
                   1136:  * @term = termios for terminal
                   1137:  * @winz = winsize for terminal
                   1138:  * return: -1 error or 0 ok
                   1139:  */
                   1140: inline int ioAllocPTY(int *ptyfd, int *ttyfd, char * __restrict name, int namesiz, 
                   1141:                struct termios * __restrict term, struct winsize * __restrict winz);
                   1142: /*
1.17      misho    1143:  * ioFreePTY() - Release PTY and TTY device
1.16      misho    1144:  *
1.12      misho    1145:  * @ptyfd = master fd, pty (==-1 skip closing pty)
                   1146:  * @ttyname = tty filename
                   1147:  * return: none
                   1148:  */
                   1149: inline void ioFreePTY(int ptyfd, const char *ttyname);
                   1150: /*
1.17      misho    1151:  * ioChgWinPTY() - Change window size of PTY
1.16      misho    1152:  *
1.12      misho    1153:  * @ptyfd = master fd, pty
                   1154:  * @row = row
                   1155:  * @col = col
                   1156:  * @xpxl = x pixels
                   1157:  * @ypxl = y pixels
                   1158:  * return: -1 error or 0 ok
                   1159:  */
                   1160: inline int ioChgWinPTY(int ptyfd, unsigned short row, unsigned short col, 
                   1161:                unsigned short xpxl, unsigned short ypxl);
                   1162: /*
1.17      misho    1163:  * ioSetOwnerTTY() - Set owner to TTY
1.16      misho    1164:  *
1.12      misho    1165:  * @ttyname = tty filename
                   1166:  * @UID = uid
                   1167:  * @GID = gid
                   1168:  * return: -1 error or 0 ok
                   1169:  */
                   1170: int ioSetOwnerTTY(const char *ttyname, uid_t UID, gid_t GID);
                   1171: /*
1.17      misho    1172:  * ioSetSidTTY() - Makes the process's controlling TTY and sets it to sane modes.
1.16      misho    1173:  *
1.12      misho    1174:  * @ttyfd = slave fd, tty
                   1175:  * @ttyname = tty filename
                   1176:  * return: -1 error or 0 ok
                   1177:  */
                   1178: int ioSetSidTTY(int *ttyfd, const char *ttyname);
                   1179: /*
1.17      misho    1180:  * ioSetRAWMode() - Enter into RAW mode
1.16      misho    1181:  *
1.12      misho    1182:  * @fd = tty fd
                   1183:  * @otio = saved old termios for later restore if !=NULL
                   1184:  * return: -1 error or 0 ok
                   1185:  */
                   1186: inline int ioSetRAWMode(int fd, struct termios *otio);
                   1187: /*
1.17      misho    1188:  * ioRestoreMode() - Restore termios to tty fd
1.16      misho    1189:  *
1.12      misho    1190:  * @fd = tty fd
                   1191:  * @tio = termios structure for restore
                   1192:  * return: -1 error or 0 ok
                   1193:  */
                   1194: inline int ioRestoreMode(int fd, struct termios tio);
                   1195: /*
1.17      misho    1196:  * ioForkPTY() - Fork new process with session leader and new TTY
1.16      misho    1197:  *
1.12      misho    1198:  * @ptyfd = master fd, pty
                   1199:  * @name = tty device name if not null
                   1200:  * @namesiz = name length, must be above 63 bytes.
                   1201:  * @term = termios for terminal
                   1202:  * @winz = winsize for terminal
                   1203:  * @otio = old termios structure for restore
                   1204:  * return: -1 error, 0 child process or >0 parent: pid of child
                   1205:  */
                   1206: pid_t ioForkPTY(int *ptyfd, char * __restrict name, int namesiz, struct termios * __restrict term, 
                   1207:                struct winsize * __restrict winz, struct termios * __restrict otio);
                   1208: 
                   1209: /*
1.17      misho    1210:  * ioCreatePIDFile() - Create PID file
1.16      misho    1211:  *
1.12      misho    1212:  * @csName = PID filename
                   1213:  * @ifExists = !=0 if filename exists return error
                   1214:  * return: -1 error or 0 ok
                   1215:  */
                   1216: inline int ioCreatePIDFile(const char *csName, int ifExists);
1.7       misho    1217: 
1.13      misho    1218: /*
1.17      misho    1219:  * ioSendFile() - AITNET sendfile() userland implementation, not dependant from OS
1.16      misho    1220:  *
1.13      misho    1221:  * @s = socket
                   1222:  * @csFile = file for send
                   1223:  * @sendLen = bytes to send, if 0 send all data
                   1224:  * @offset = start file offset
                   1225:  * @sndbuf = SO_SNDBUF value, if 0 use default
                   1226:  * return: 0 error, >0 ok, sended bytes
                   1227:  */
                   1228: size_t ioSendFile(int s, const char *csFile, size_t sendLen, off_t offset, int sndbuf);
                   1229: /*
1.17      misho    1230:  * ioRecvFile() - Receive file from socket, fastest (zero-copy) way
1.16      misho    1231:  *
1.13      misho    1232:  * @s = socket
                   1233:  * @csFile = file for receive
                   1234:  * @recvLen = receive bytes
                   1235:  * @over = overwrite file if exists with mode like 0644
                   1236:  * @rcvbuf = SO_RCVBUF value, if 0 use default
                   1237:  * return: 0 error, >0 ok, received bytes
                   1238:  */
                   1239: size_t ioRecvFile(int s, const char *csFile, size_t recvLen, int over, int rcvbuf);
                   1240: 
1.7       misho    1241: 
1.14      misho    1242: /* Buffered file access over memory block */
                   1243: 
                   1244: /*
1.17      misho    1245:  * io_fmemopen() - File buffered stream operations over memory block
1.14      misho    1246:  *
                   1247:  * @base = Base address of memory block, if =NULL Infinit length(auto-grow)
                   1248:  * @basesize = Size of memory block
                   1249:  * return: NULL error or !=NULL Opened file resource
                   1250:  */
                   1251: FILE *io_fmemopen(void ** __restrict base, off_t basesize);
                   1252: /*
1.17      misho    1253:  * io_fmapopen() - File buffered stream operations over MMAP block
1.14      misho    1254:  *
                   1255:  * @csFile = Filename for MMAP, if =NULL private MMAP block
                   1256:  * @mode = File open mode
                   1257:  * @perm = If file not exists will be created with this access permissions
                   1258:  * @prot = MMAP protection
                   1259:  * @flags = MMAP mode flags
                   1260:  * @offset = Map from file offset, if csFile==NULL then this is size of MMAP private block
                   1261:  * return: NULL error or !=NULL Opened file resource
                   1262:  */
                   1263: FILE *io_fmapopen(const char *csFile, int mode, int perm, int prot, int flags, off_t offset);
                   1264: /*
1.17      misho    1265:  * io_fd2buf() - Convert open file handle to buffered file I/O
1.14      misho    1266:  *
                   1267:  * @fd = File handle
                   1268:  * @mode = Permissions for new buffered file I/O
                   1269:  * return: NULL error or open buffered file
                   1270:  */
                   1271: inline FILE *io_fd2buf(int fd, const char *mode);
                   1272: /*
1.17      misho    1273:  * io_dumbFile() - Create empry or dumb file with fixed size
1.14      misho    1274:  *
                   1275:  * @csFile = Filename for create
                   1276:  * @mode = File access permissions
                   1277:  * @size = File size
                   1278:  * return: -1 error or open file handle
                   1279:  */
                   1280: int io_dumbFile(const char *csFile, int mode, off_t size);
                   1281: 
                   1282: 
1.1       misho    1283: #endif

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