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

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

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