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

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

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