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

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

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