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

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

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