--- libaitio/inc/aitio.h 2011/05/19 03:01:19 1.9.2.4 +++ libaitio/inc/aitio.h 2011/10/31 13:53:51 1.12 @@ -3,7 +3,7 @@ * by Michael Pounov * * $Author: misho $ -* $Id: aitio.h,v 1.9.2.4 2011/05/19 03:01:19 misho Exp $ +* $Id: aitio.h,v 1.12 2011/10/31 13:53:51 misho Exp $ * ************************************************************************** The ELWIX and AITNET software is distributed under the following @@ -47,13 +47,19 @@ SUCH DAMAGE. #define __AITIO_H +#define COMPAT_43TTY + #include #include +#include +#include +#include #define VACUUM_LEFT 1 #define VACUUM_BETWEEN 2 +/* AIT arrays */ typedef void ** sarr_seg_t; typedef struct _tagSplitArray { @@ -68,6 +74,8 @@ typedef struct _tagArray { void **arr_data; } array_t; +/* URL staff ... */ + typedef struct _tagURLItem { int vallen; char *value; @@ -100,7 +108,135 @@ struct tagReqXML { url_Item_t xml_value; }; +/* AIT RPC variables and managment */ +typedef enum { + empty, /* empty -> variable is not set */ + buffer, string, blob, /* buffer -> uint8_t*; string -> int8_t*; blob -> void*(+socket); */ + f32, f64, /* float -> f32; double -> f64 */ + u8, u16, u32, u64, /* unsigned integers ... */ + i8, i16, i32, i64, /* integers ... */ +} ait_type_t; + +typedef struct { + uint8_t val_type; + uint32_t val_len; + union { + uint64_t net; + + uint8_t *buffer; + int8_t *string; + uint32_t blob; + float f32; + double f64; + uint8_t u8; + uint16_t u16; + uint32_t u32; + uint64_t u64; + int8_t i8; + int16_t i16; + int32_t i32; + int64_t i64; + } val; +} __packed ait_val_t; + +#define AIT_TYPE(_vl) ((ait_type_t) (_vl)->val_type) +#define AIT_LEN(_vl) (_vl)->val_len +#define AIT_BLOB_CHUNKS(_vl, _n) (assert((_vl)), AIT_LEN((_vl)) / _n + (AIT_LEN((_vl)) % _n) ? 1 : 0) +#define AIT_ISEMPTY(_vl) (assert((_vl)), AIT_TYPE((_vl)) == empty) + +#define AIT_GET_BUF(_vl) (assert((_vl)), assert(AIT_TYPE((_vl)) == buffer), (_vl)->val.buffer) +#define AIT_GET_STR(_vl) (assert((_vl)), assert(AIT_TYPE((_vl)) == string), (_vl)->val.string) +#define AIT_GET_BLOB(_vl) (assert((_vl)), assert(AIT_TYPE((_vl)) == blob), (_vl)->val.blob) +#define AIT_GET_U8(_vl) (assert((_vl)), assert(AIT_TYPE((_vl)) == u8), (_vl)->val.u8) +#define AIT_GET_U16(_vl) (assert((_vl)), assert(AIT_TYPE((_vl)) == u16), (_vl)->val.u16) +#define AIT_GET_U32(_vl) (assert((_vl)), assert(AIT_TYPE((_vl)) == u32), (_vl)->val.u32) +#define AIT_GET_U64(_vl) (assert((_vl)), assert(AIT_TYPE((_vl)) == u64), (_vl)->val.u64) +#define AIT_GET_I8(_vl) (assert((_vl)), assert(AIT_TYPE((_vl)) == i8), (_vl)->val.i8) +#define AIT_GET_I16(_vl) (assert((_vl)), assert(AIT_TYPE((_vl)) == i16), (_vl)->val.i16) +#define AIT_GET_I32(_vl) (assert((_vl)), assert(AIT_TYPE((_vl)) == i32), (_vl)->val.i32) +#define AIT_GET_I64(_vl) (assert((_vl)), assert(AIT_TYPE((_vl)) == i64), (_vl)->val.i64) +#define AIT_GET_F32(_vl) (assert((_vl)), assert(AIT_TYPE((_vl)) == f32), (_vl)->val.f32) +#define AIT_GET_F64(_vl) (assert((_vl)), assert(AIT_TYPE((_vl)) == f64), (_vl)->val.f64) + +#define AIT_SET_BUF(_vl, _v, _len) do { ait_val_t *__val = (_vl); assert(__val); assert((_v)); \ + __val->val.buffer = malloc(_len); \ + if (__val->val.buffer) { \ + __val->val_type = buffer; AIT_LEN(__val) = _len; \ + memcpy(__val->val.buffer, (_v), _len); \ + } } while (0) +#define AIT_SET_STR(_vl, _v) do { ait_val_t *__val = (_vl); assert(__val); assert((_v)); \ + __val->val.string = (int8_t*) strdup((_v)); \ + if (__val->val.string) { \ + __val->val_type = string; \ + AIT_LEN(__val) = strlen((_v)) + 1; \ + } } while (0) +#define AIT_SET_BLOB(_vl, _n, _len) do { ait_val_t *__val = (_vl); assert(__val); \ + __val->val_type = blob; AIT_LEN(__val) = _len; \ + __val->val.blob = _n; } while (0) +#define AIT_SET_BLOB2(_vl, _bv) do { ait_val_t *__val = (_vl); assert(__val); assert((_bv)); \ + __val->val_type = blob; AIT_LEN(__val) = (_bv)->blob_len; \ + __val->val.blob = (_bv)->blob_var; } while (0) +#define AIT_NEW_BLOB(_vl, _len) AIT_SET_BLOB((_vl), 0, _len) + +#define AIT_SET_U8(_vl, _n) do { ait_val_t *__val = (_vl); assert(__val); \ + __val->val_type = u8; __val->val.u8 = _n; \ + AIT_LEN(__val) = sizeof(uint8_t); } while (0) +#define AIT_SET_U16(_vl, _n) do { ait_val_t *__val = (_vl); assert(__val); \ + __val->val_type = u16; __val->val.u16 = _n; \ + AIT_LEN(__val) = sizeof(uint16_t); } while (0) +#define AIT_SET_U32(_vl, _n) do { ait_val_t *__val = (_vl); assert(__val); \ + __val->val_type = u32; __val->val.u32 = _n; \ + AIT_LEN(__val) = sizeof(uint32_t); } while (0) +#define AIT_SET_U64(_vl, _n) do { ait_val_t *__val = (_vl); assert(__val); \ + __val->val_type = u64; __val->val.u64 = _n; \ + AIT_LEN(__val) = sizeof(uint64_t); } while (0) +#define AIT_SET_I8(_vl, _n) do { ait_val_t *__val = (_vl); assert(__val); \ + __val->val_type = i8; __val->val.i8 = _n; \ + AIT_LEN(__val) = sizeof(int8_t); } while (0) +#define AIT_SET_I16(_vl, _n) do { ait_val_t *__val = (_vl); assert(__val); \ + __val->val_type = i16; __val->val.i16 = _n; \ + AIT_LEN(__val) = sizeof(int16_t); } while (0) +#define AIT_SET_I32(_vl, _n) do { ait_val_t *__val = (_vl); assert(__val); \ + __val->val_type = i32; __val->val.i32 = _n; \ + AIT_LEN(__val) = sizeof(int32_t); } while (0) +#define AIT_SET_I64(_vl, _n) do { ait_val_t *__val = (_vl); assert(__val); \ + __val->val_type = i64; __val->val.i64 = _n; \ + AIT_LEN(__val) = sizeof(int64_t); } while (0) +#define AIT_SET_F32(_vl, _n) do { ait_val_t *__val = (_vl); assert(__val); \ + __val->val_type = f32; __val->val.f32 = _n; \ + AIT_LEN(__val) = sizeof(float); } while (0) +#define AIT_SET_F64(_vl, _n) do { ait_val_t *__val = (_vl); assert(__val); \ + __val->val_type = f64; __val->val.f64 = _n; \ + AIT_LEN(__val) = sizeof(double); } while (0) + + /* if attribute zeroCopy is set not execute free() */ +#define AIT_FREE_VAL(_vl) do { ait_val_t *__val = (_vl); assert(__val); \ + switch (__val->val_type) { \ + case buffer: \ + if (__val->val.buffer) { \ + free(__val->val.buffer); \ + __val->val.buffer = NULL; \ + } \ + break; \ + case string: \ + if (__val->val.string) { \ + free(__val->val.string); \ + __val->val.string = NULL; \ + } \ + break; \ + default: \ + break; \ + } \ + __val->val_type = empty; \ + AIT_LEN(__val) = 0; \ + } while (0) + +struct io_ether_addr { + u_int8_t ether_addr_octet[6]; +}; + + // io_GetErrno() Get error code of last operation inline int io_GetErrno(); // io_GetError() Get error text of last operation @@ -108,6 +244,59 @@ inline const char *io_GetError(); /* + * io_ether_ntoa() Convert ethernet address to string + * @n = ethernet address structure, like struct ether_addr + * @a = string + * @len = string length + * return: NULL error or !=NULL string a + */ +inline char *io_ether_ntoa(const struct io_ether_addr *n, char * __restrict a, int len); +/* + * io_ether_aton() Convert string to ethernet address + * @a = string + * @e = ethernet address structure, like struct ether_addr + * return: NULL error or !=NULL ethernet address structure + */ +inline struct io_ether_addr *io_ether_aton(const char *a, struct io_ether_addr *e); + +/* + * io_vals2buffer() Marshaling data from array with variables to buffer + * @buf = Buffer + * @buflen = Size of buffer + * @vars = Variable array + * return: -1 error, 0 nothing done or >0 size of marshaled data + */ +int io_vals2buffer(unsigned char *buf, int buflen, array_t *vars); +/* + * io_buffer2vals() De-marshaling data from buffer to array with variables + * @buf = Buffer + * @buflen = Size of buffer + * @vnum = Number of variables into buffer + * @zcpy = Zero-copy for variables, if !=0 don't use io_arrayFree() for free variables and + *DON'T MODIFY OR DESTROY BUFFER*. =0 call io_arrayFree() before io_arrayDestroy() + * return: =NULL error, !=NULL allocated variable array, after use must free with io_arrayDestroy() + */ +array_t *io_buffer2vals(unsigned char *buf, int buflen, int vnum, int zcpy); +/* + * io_vals2map() Marshaling data from array with variables to memory map + * @buf = Buffer + * @buflen = Size of buffer + * @vars = Variable array + * return: -1 error, 0 nothing done or >0 size of marshaled data + */ +int io_vals2map(u_char *buf, int buflen, array_t *vars); +/* + * io_map2vals() De-marshaling data from memory map to array with variables + * @buf = Buffer + * @buflen = Size of buffer + * @vnum = Number of variables into buffer + * @zcpy = Zero-copy for variables, if !=0 don't use io_arrayFree() for free variables and + *DON'T MODIFY OR DESTROY BUFFER*. =0 call io_arrayFree() before io_arrayDestroy() + * return: =NULL error, !=NULL allocated variable array, after use must free with io_arrayDestroy() + */ +array_t *io_map2vals(u_char *buf, int buflen, int vnum, int zcpy); + +/* * ioPromptRead() Read data from input h[0] with prompt to output h[1] * @h = file handles h[0] = input, h[1] = output, if NULL use stdin, stdout * @csPrompt = Prompt before input, may be NULL @@ -233,15 +422,15 @@ inline void io_arrayDestroy(array_t ** __restrict parr inline void io_arrayFree(array_t * __restrict arr); /* * io_arrayFrom() - Create and fill array from array with pointers - * @argv = Array with pointers + * @pargv = Array with pointers * @argc = Number of Items, if 0 walk through argv and stop when reach NULL item - * return: NULL error, != NULL allocated memory for array + * return: NULL error, != NULL allocated new array */ -inline array_t *io_arrayFrom(const char **argv, int argc); +inline array_t *io_arrayFrom(const char *** __restrict pargv, int argc); /* * io_arrayTo() - Create and fill array with pointers from dynamic array * @arr = Array - * return: NULL error, != NULL allocated memory for array + * return: NULL error, != NULL allocated memory for array, NULL terminated */ inline char **io_arrayTo(array_t * __restrict arr); /* @@ -258,12 +447,20 @@ inline int io_arrayLen(array_t * __restrict arr); */ int io_arrayConcat(array_t * __restrict dest, array_t * __restrict src); /* + * io_arrayCopy() Copy source array to destination array + * @dest = Destination array, after use free with io_arrayDestroy() + * @src = Source array + * return: -1 error; >0 count of destination array + */ +int io_arrayCopy(array_t ** __restrict dest, array_t * __restrict src); +/* * io_arrayGrow() - Grow/Shrink dynamic array, Use with care when it shrink!!! * @arr = Array * @newNumItems = Number of Items + * @freeShrink = Free elements before shrink array * return: -1 error, 0 ok */ -int io_arrayGrow(array_t * __restrict arr, int newNumItems); +int io_arrayGrow(array_t * __restrict arr, int newNumItems, int freeShrink); /* * io_arrayVacuum() - Vacuum dynamic array, empty elements will be deleted * @arr = Array @@ -272,17 +469,22 @@ int io_arrayGrow(array_t * __restrict arr, int newNumI */ int io_arrayVacuum(array_t * __restrict arr, int fromWhere); -#define io_arraySize(_arr) ((assert(_arr)), _arr->arr_num) +#define io_arraySize(_arr) ((_arr) ? (_arr)->arr_num : 0) +#define io_arrayZero(_arr) (assert((_arr)), memset((_arr)->arr_data, 0, \ + io_arraySize((_arr)) * sizeof(void*))) -#define io_arrayGet(_arr, _d, _type) ((assert(_arr && _arr->arr_num > _d)), \ - ((_type) *(_arr->arr_data + _d))) +#define io_arrayGet(_arr, _d) (assert((_arr) && (_arr)->arr_num > _d), *((_arr)->arr_data + _d)) +#define io_array(_arr, _d, _type) (assert((_arr) && (_arr)->arr_num > _d), \ + ((_type) *((_arr)->arr_data + _d))) #define io_arraySet(_arr, _d, _ptr) do { \ - assert(_arr && _arr->arr_num > _d); \ - *(_arr->arr_data + _d) = (void*) _ptr; \ + assert((_arr) && (_arr)->arr_num > _d); \ + *((_arr)->arr_data + _d) = (void*) (_ptr); \ } while (0) -#define io_arrayDel(_arr, _d) do { \ - assert(_arr && _arr->arr_num > _d); \ - *(_arr->arr_data + _d) = NULL; \ +#define io_arrayDel(_arr, _d, _fri) do { \ + assert((_arr) && (_arr)->arr_num > _d); \ + if (_fri) \ + free(*((_arr)->arr_data + _d)); \ + *((_arr)->arr_data + _d) = NULL; \ } while (0) /* @@ -295,7 +497,7 @@ inline int io_arrayPush(array_t * __restrict arr, void /* * io_arrayPop() - Pop element from dynamic array like stack manner, last used position * @arr = Array - * @data = Element, if set NULL return only first empty position + * @data = Element, if set NULL return only last used position * @delAfter = Delete after Pop element, !=0 delete element from array after return data * return: -1 not found used position, array is empty!, >-1 return element position */ @@ -360,8 +562,16 @@ int io_sarrGrow(sarr_t * __restrict arr, int newNumIte * return: -1 error, >-1 freed segments */ inline int io_sarrVacuum(sarr_t * __restrict arr); -#define io_sarrSize(_arr) ((assert(_arr)), _arr->sarr_num) +#define io_sarrSize(_arr) ((_arr) ? (_arr)->sarr_num : 0) +#define io_sarrSeg(_arr) (assert((_arr)), (_arr)->sarr_seg) /* + * io_sarrCopy() Copy source split array to destination split array + * @dest = Destination split array, after use free with io_sarrDestroy() + * @src = Source split array + * return: -1 error; >0 count of destination split array + */ +int io_sarrCopy(sarr_t ** __restrict dest, sarr_t * __restrict src); +/* * io_sarrGet() - Get element from dynamic split-order array * @arr = Array * @idx = Index (warning 1st element is at position 1) @@ -384,8 +594,23 @@ void *io_sarrGet2(sarr_t * __restrict arr, unsigned in * return: NULL error or empty, !=NULL old value in element */ inline void *io_sarrSet(sarr_t * __restrict arr, unsigned int idx, void *data); -#define io_sarrDel(_arr, _idx) io_sarrSet(_arr, _idx, NULL) -#define io_sarr(_arr, _idx, _type) (_type)io_sarrGet(_arr, _idx) +#define io_sarrDel(_arr, _idx) io_sarrSet((_arr), _idx, NULL) +#define io_sarr(_arr, _idx, _type) (_type)io_sarrGet((_arr), _idx) +/* + * io_sarr2array() - Convert from split-order array to dynamic array + * @sa = split array + * @sarrFree = after convert split array !=0 will be destroyed sarray + * return: NULL error or != NULL new array + */ +array_t *io_sarr2array(sarr_t ** __restrict sa, int sarrFree); +/* + * io_array2sarr() - Convert from dynamic array to split-order array + * @a = array + * @segLen = Length of segment + * @arrFree = after convert array !=0 will be destroyed + * return: NULL error or != NULL new sarr + */ +sarr_t *io_array2sarr(array_t ** __restrict a, int segLen, int arrFree); /* * io_CopyEnv() Copy environment to new environment array; @@ -494,7 +719,7 @@ extern int io_Debug; #define ioDEBUG(x, fmt, ...) do { \ assert((fmt)); \ char str[STRSIZ] = { 0 }; \ - snprintf(str, STRSIZ, (fmt), ##__VA_ARGS__); \ + snprintf(str, sizeof str, (fmt), ##__VA_ARGS__); \ if ((x) <= io_Debug) \ syslog(LOG_DEBUG, "ioDebug(%d):%s(%d): %s\n", \ (x), __func__, __LINE__, str); \ @@ -503,7 +728,7 @@ extern int io_Debug; #define ioERROR(x, fmt, ...) do { \ assert((fmt)); \ char str[STRSIZ] = { 0 }; \ - snprintf(str, STRSIZ, (fmt), ##__VA_ARGS__); \ + snprintf(str, sizeof str, (fmt), ##__VA_ARGS__); \ syslog(LOG_ERR, "ioError():%s(%d): #%d - %s\n", \ __func__, __LINE__, (x), str); \ } while (0) @@ -549,6 +774,98 @@ int ioCipher(unsigned char *pInput, int inLen, unsigne */ int io_Blowfish(unsigned char *pInput, int inLen, unsigned char **ppOutput, unsigned char *pKey, unsigned char *pIV, int nMode); +/* + * io_ctr_AES() Encrypt/Decrypt stream cipher CTR_AES + * @pInput = Input buffer with ASCII + * @inLen = Input buffer data length + * @ppOutput = Output buffer with cipher data, must be free after use + * @pKey = Key + * @IV = IVector/Nonce/Counter, Warning: IV must be variable, because we write there!!! + * return: -1 error or >-1 how many cipher blocks proceeded + */ +int io_ctr_AES(unsigned char *pInput, int inLen, unsigned char **ppOutput, + unsigned char *pKey, unsigned char IV[AES_BLOCK_SIZE]); + + +/* + * ioAllocPTY() Allocate new PTY and TTY + * @ptyfd = master fd, pty + * @ttyfd = slave fd, tty + * @name = tty device name if not null + * @namesiz = name length, must be above 63 bytes. + * @term = termios for terminal + * @winz = winsize for terminal + * return: -1 error or 0 ok + */ +inline int ioAllocPTY(int *ptyfd, int *ttyfd, char * __restrict name, int namesiz, + struct termios * __restrict term, struct winsize * __restrict winz); +/* + * ioFreePTY() Release PTY and TTY device + * @ptyfd = master fd, pty (==-1 skip closing pty) + * @ttyname = tty filename + * return: none + */ +inline void ioFreePTY(int ptyfd, const char *ttyname); +/* + * ioChgWinPTY() Change window size of PTY + * @ptyfd = master fd, pty + * @row = row + * @col = col + * @xpxl = x pixels + * @ypxl = y pixels + * return: -1 error or 0 ok + */ +inline int ioChgWinPTY(int ptyfd, unsigned short row, unsigned short col, + unsigned short xpxl, unsigned short ypxl); +/* + * ioSetOwnerTTY() Set owner to TTY + * @ttyname = tty filename + * @UID = uid + * @GID = gid + * return: -1 error or 0 ok + */ +int ioSetOwnerTTY(const char *ttyname, uid_t UID, gid_t GID); +/* + * ioSetSidTTY() Makes the process's controlling TTY and sets it to sane modes. + * @ttyfd = slave fd, tty + * @ttyname = tty filename + * return: -1 error or 0 ok + */ +int ioSetSidTTY(int *ttyfd, const char *ttyname); +/* + * ioSetRAWMode() Enter into RAW mode + * @fd = tty fd + * @otio = saved old termios for later restore if !=NULL + * return: -1 error or 0 ok + */ +inline int ioSetRAWMode(int fd, struct termios *otio); +/* + * ioRestoreMode() Restore termios to tty fd + * @fd = tty fd + * @tio = termios structure for restore + * return: -1 error or 0 ok + */ +inline int ioRestoreMode(int fd, struct termios tio); +/* + * ioForkPTY() Fork new process with session leader and new TTY + * @ptyfd = master fd, pty + * @name = tty device name if not null + * @namesiz = name length, must be above 63 bytes. + * @term = termios for terminal + * @winz = winsize for terminal + * @otio = old termios structure for restore + * return: -1 error, 0 child process or >0 parent: pid of child + */ +pid_t ioForkPTY(int *ptyfd, char * __restrict name, int namesiz, struct termios * __restrict term, + struct winsize * __restrict winz, struct termios * __restrict otio); + +/* + * ioCreatePIDFile() Create PID file + * @csName = PID filename + * @ifExists = !=0 if filename exists return error + * return: -1 error or 0 ok + */ +inline int ioCreatePIDFile(const char *csName, int ifExists); #endif