--- libaitio/inc/aitio.h 2012/03/27 20:53:37 1.15.2.1 +++ libaitio/inc/aitio.h 2012/03/27 21:37:56 1.15.2.2 @@ -3,7 +3,7 @@ * by Michael Pounov * * $Author: misho $ -* $Id: aitio.h,v 1.15.2.1 2012/03/27 20:53:37 misho Exp $ +* $Id: aitio.h,v 1.15.2.2 2012/03/27 21:37:56 misho Exp $ * ************************************************************************** The ELWIX and AITNET software is distributed under the following @@ -90,7 +90,8 @@ typedef enum { typedef struct { uint8_t val_type; - uint8_t val_pad[3]; + uint8_t val_pad; + uint16_t val_hash; uint32_t val_len; union { uint64_t net; @@ -115,6 +116,7 @@ typedef struct { #define AIT_TYPE(_vl) ((ait_type_t) (_vl)->val_type) #define AIT_LEN(_vl) (_vl)->val_len +#define AIT_HASH(_vl) (_vl)->val_hash #define AIT_RAW(_vl) (_vl)->val.net #define AIT_VOID(_vl) (_vl)->val.ptr #define AIT_BLOB_CHUNKS(_vl, _n) (assert((_vl)), AIT_LEN((_vl)) / _n + (AIT_LEN((_vl)) % _n) ? 1 : 0) @@ -262,6 +264,7 @@ 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 @@ -270,6 +273,7 @@ inline const char *io_GetError(); 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 @@ -277,12 +281,14 @@ inline char *io_ether_ntoa(const struct io_ether_addr inline struct io_ether_addr *io_ether_aton(const char *a, struct io_ether_addr *e); /* * io_n2port() Extract port from network structure + * * @addr = Address * return: 0 not supported family type or port number */ inline u_short io_n2port(io_sockaddr_t * __restrict addr); /* * io_n2addr() Extract address from network structure + * * @addr = Address * @val = Value for store string address * return: NULL error or !=NULL string address from val @@ -290,6 +296,7 @@ inline u_short io_n2port(io_sockaddr_t * __restrict ad const char *io_n2addr(io_sockaddr_t * __restrict addr, ait_val_t * __restrict val); /* * io_gethostbyname() Get host and port and make network structure + * * @psHost = Hostname * @port = Port * @addr = Network address structure @@ -300,6 +307,7 @@ io_sockaddr_t *io_gethostbyname(const char *psHost, un /* * io_vars2buffer() Marshaling data from array with variables to buffer + * * @buf = Buffer * @buflen = Size of buffer * @vars = Variable array @@ -308,6 +316,7 @@ io_sockaddr_t *io_gethostbyname(const char *psHost, un int io_vars2buffer(unsigned char *buf, int buflen, array_t *vars); /* * io_buffer2vars() De-marshaling data from buffer to array with variables + * * @buf = Buffer * @buflen = Size of buffer * @vnum = Number of variables into buffer @@ -318,6 +327,7 @@ int io_vars2buffer(unsigned char *buf, int buflen, arr array_t *io_buffer2vars(unsigned char *buf, int buflen, int vnum, int zcpy); /* * io_vars2map() Marshaling data from array with variables to memory map + * * @buf = Buffer * @buflen = Size of buffer * @vars = Variable array @@ -326,6 +336,7 @@ array_t *io_buffer2vars(unsigned char *buf, int buflen int io_vars2map(unsigned char *buf, int buflen, array_t *vars); /* * io_map2vars() De-marshaling data from memory map to array with variables + * * @buf = Buffer * @buflen = Size of buffer * @vnum = Number of variables into buffer @@ -337,29 +348,34 @@ array_t *io_map2vars(unsigned char *buf, int buflen, i /* * io_allocVar() Allocate memory for variable + * * return: NULL error or new variable, after use free variable with io_freeVar() */ inline ait_val_t *io_allocVar(void); /* * io_freeVar() Free allocated memory for variable + * * @val = Variable * return: none */ inline void io_freeVar(ait_val_t * __restrict val); /* * io_allocVars() Allocate ait_val_t array + * * @varnum = Number of variables * return: =NULL error or !=NULL allocated array */ inline array_t *io_allocVars(int varnum); /* * io_clrVars() Clear ait_val_t elements from array + * * @vars = Variable array * return: -1 error or size of array */ inline int io_clrVars(array_t * __restrict vars); /* * io_freeVars() Free ait_val_t array + * * @vars = Variable array * return: none */ @@ -368,6 +384,7 @@ inline void io_freeVars(array_t ** __restrict vars); /* * 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 * @psData = Readed data @@ -377,6 +394,7 @@ inline void io_freeVars(array_t ** __restrict vars); int ioPromptRead(int *h, const char *csPrompt, char * __restrict psData, int dataLen); /* * ioPromptPassword() Read password 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 * @psPass = Readed password @@ -388,6 +406,7 @@ int ioPromptPassword(int *h, const char *csPrompt, cha /* * ioRegexVerify() Function for verify data match in regex expression + * * @csRegex = Regulare expression pattern * @csData = Data for check and verify * @startPos = Return start positions @@ -397,6 +416,7 @@ int ioPromptPassword(int *h, const char *csPrompt, cha const char *ioRegexVerify(const char *csRegex, const char *csData, int *startPos, int *endPos); /* * ioRegexGet() Function for get data match in regex expression + * * @csRegex = Regulare expression pattern * @csData = Data from get * @psString = Returned string if match @@ -406,6 +426,7 @@ const char *ioRegexVerify(const char *csRegex, const c int ioRegexGet(const char *csRegex, const char *csData, char * __restrict psString, int strLen); /* * ioRegexReplace() Function for replace data match in regex expression with newdata + * * @csRegex = Regulare expression pattern * @csData = Source data * @csNew = Data for replace @@ -415,6 +436,7 @@ char *ioRegexReplace(const char *csRegex, const char * /* * ioStrAst() Function for evaluate string like asterisk variable "{text[:[-]#[:#]]}" + * * @csString = Input string * return: NULL error, !=NULL Allocated new string evaluated from input string, must be free() */ @@ -422,30 +444,35 @@ char *ioStrAst(const char *csString); /* * io_UnquotStr() Remove quots from input text string + * * @psLine = Text string * return: 0 nothing to do; 1 successful unquoted string */ inline int io_UnquotStr(unsigned char * __restrict psLine); /* * io_LTrimStr() Remove left whitespaces from text string + * * @psLine = Text string * return: 0 nothing to do; !=0 Removed bytes */ inline int io_LTrimStr(unsigned char * __restrict psLine); /* * io_RTrimStr() Remove right whitespaces from text string + * * @psLine = Text string * return: 0 nothing to do; !=0 Removed bytes */ inline int io_RTrimStr(unsigned char * __restrict psLine); /* * io_TrimStr() Remove left and right whitespaces from text string + * * @psLine = Text string * return: 0 nothing to do; !=0 Removed bytes */ inline int io_TrimStr(unsigned char * __restrict psLine); /* * io_Ch2Hex() Convert from Char string to Hex string + * * @psLine = Text string * @lineLen = Length of Text string * return: NULL nothing to do or error; !=0 Allocated new converted data without term\0 (must be free) @@ -453,6 +480,7 @@ inline int io_TrimStr(unsigned char * __restrict psLin inline unsigned char *io_Ch2Hex(unsigned char *psLine, int lineLen); /* * io_Hex2Ch() Convert from Hex string to Char string + * * @psLine = Text string * @lineLen = Length of Text string * return: NULL nothing to do or error; !=0 Allocated new converted string(must be free) @@ -475,12 +503,14 @@ io_Path2File(const char * __restrict csArgs, char * __ /* * io_arrayInit() - Create and initialize dynamic array + * * @numItems = Number of Items * return: NULL error, != NULL allocated memory for array */ inline array_t *io_arrayInit(int numItems); /* * io_arrayDestroy() - Free and destroy dynamic array + * * @parr = Array * return: none */ @@ -488,12 +518,14 @@ inline void io_arrayDestroy(array_t ** __restrict parr /* * io_arrayFree() - Free all data in dynamic array items * (WARNING! If assign static array dont use this!!!) + * * @arr = Array * return: none */ inline void io_arrayFree(array_t * __restrict arr); /* * io_arrayFrom() - Create and fill array from 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 new array @@ -501,18 +533,21 @@ inline void io_arrayFree(array_t * __restrict arr); 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, NULL terminated */ inline char **io_arrayTo(array_t * __restrict arr); /* * io_arrayLen() - Get last used element in dynamic array (array Length) + * * @arr = Array * return: -1 error, 0 empty or >0 position of last used element */ inline int io_arrayLen(array_t * __restrict arr); /* * io_arrayConcat() Concat source array to destination array + * * @dest = Destination array * @src = Source array * return: -1 error; >0 new count of destination array @@ -520,6 +555,7 @@ 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 @@ -527,6 +563,7 @@ int io_arrayConcat(array_t * __restrict dest, array_t 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 @@ -535,6 +572,7 @@ int io_arrayCopy(array_t ** __restrict dest, array_t * int io_arrayGrow(array_t * __restrict arr, int newNumItems, int freeShrink); /* * io_arrayVacuum() - Vacuum dynamic array, empty elements will be deleted + * * @arr = Array * @fromWhere = 1 begin, 2 ALL empty elements * return: -1 error, 0 ok @@ -561,6 +599,7 @@ int io_arrayVacuum(array_t * __restrict arr, int fromW /* * io_arrayElem() - Always GET/PUT element into dynamic array, if not enough elements grow array + * * @arr = Array * @n = Position * @data = Element, if set NULL GET element at position or !=NULL PUT element at position @@ -569,6 +608,7 @@ int io_arrayVacuum(array_t * __restrict arr, int fromW inline void *io_arrayElem(array_t * __restrict arr, int n, void *data); /* * io_arrayPush() - Push element into dynamic array like stack manner, place at first empty position + * * @arr = Array * @data = Element, if set NULL return only first empty position * return: -1 not found empty position, array is full!, >-1 return position of stored element into array @@ -576,6 +616,7 @@ inline void *io_arrayElem(array_t * __restrict arr, in inline int io_arrayPush(array_t * __restrict arr, void **data); /* * io_arrayPop() - Pop element from dynamic array like stack manner, last used position + * * @arr = Array * @data = Element, if set NULL return only last used position * @delAfter = Delete after Pop element, !=0 delete element from array after return data @@ -585,6 +626,7 @@ inline int io_arrayPop(array_t * __restrict arr, void /* * io_argsNum() Parse and calculate number of arguments + * * @csArgs = Input arguments line * @csDelim = Delimiter(s) for separate * return: 0 error format; -1 error:: can`t read; >0 ok, number of items @@ -594,6 +636,7 @@ inline int io_argsNum(const char *csArgs, const char * /* * io_arrayMake() Parse and make array from arguments ... (input string will be modified!!! * and output array must be free with io_arrayDestroy() after use!) + * * @psArgs = Input arguments line, after execute string is modified!!! * @nargs = Maximum requested count of arguments from input string psArgs, if 0 all psArgs * @csDelim = Delimiter(s) for separate @@ -605,6 +648,7 @@ int io_arrayMake(char * __restrict psArgs, int nargs, /* * io_MakeAV() Parse and make attribute/value pair + * * @csArgs = Input argument line * @csDelim = Delimiter for separate * @psAttr = Output Attribute @@ -618,6 +662,7 @@ int io_MakeAV(const char * __restrict csArgs, const ch /* * io_sarrInit() - Create and initialize dynamic split-order array + * * @numItems = Number of Items * @segLen = Length of segment * return: NULL error, != NULL allocated memory for array @@ -625,12 +670,14 @@ int io_MakeAV(const char * __restrict csArgs, const ch inline sarr_t *io_sarrInit(int numItems, int segLen); /* * io_sarrDestroy() - Free all data in dynamic split-order array and Destroy array + * * @parr = Array * return: none */ inline void io_sarrDestroy(sarr_t ** __restrict parr); /* * io_sarrGrow() - Grow/Shrink dynamic split-order array, Use with care when it shrink!!! + * * @arr = Array * @newNumItems = Number of Items * return: -1 error, 0 ok @@ -638,6 +685,7 @@ inline void io_sarrDestroy(sarr_t ** __restrict parr); int io_sarrGrow(sarr_t * __restrict arr, int newNumItems); /* * io_sarrVacuum() - Vacuum dynamic split-order array, empty segments will be freed + * * @arr = Array * return: -1 error, >-1 freed segments */ @@ -646,6 +694,7 @@ inline int io_sarrVacuum(sarr_t * __restrict arr); #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 @@ -653,6 +702,7 @@ inline int io_sarrVacuum(sarr_t * __restrict arr); 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) * return: NULL not found, !=NULL element @@ -661,6 +711,7 @@ inline void *io_sarrGet(sarr_t * __restrict arr, unsig /* * io_sarrGet2() - Always get element from dynamic split-order array * Function automatic grow array. Good use for Hash tables! + * * @arr = Array * @idx = Index (warning 1st element is at position 1) * return: NULL not found, !=NULL element @@ -668,6 +719,7 @@ inline void *io_sarrGet(sarr_t * __restrict arr, unsig void *io_sarrGet2(sarr_t * __restrict arr, unsigned int idx); /* * io_sarrSet() - Set element to dynamic split-order array + * * @arr = Array * @idx = Index (warning 1st element is at position 1) * @data = Value @@ -678,6 +730,7 @@ inline void *io_sarrSet(sarr_t * __restrict arr, unsig #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 @@ -685,6 +738,7 @@ inline void *io_sarrSet(sarr_t * __restrict arr, unsig 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 @@ -694,12 +748,14 @@ sarr_t *io_array2sarr(array_t ** __restrict a, int seg /* * io_CopyEnv() Copy environment to new environment array; + * * @oldenv = Environment array * return: NULL error; !=NULL Allocated new environment array(must be free) */ char **io_CopyEnv(const char **oldenv); /* * io_ExecArgs() Build exec arguments from other array + * * @psProg = Program name for execute * @oldarg = Arguments array * return: NULL error; !=NULL Allocated execution array(must be free) @@ -707,6 +763,7 @@ char **io_CopyEnv(const char **oldenv); char **io_ExecArgs(const char *psProg, const char **oldarg); /* * io_FreeNullTerm() Free dynamic allocated null terminated array with strings + * * @arr = Pointer to array for free * return: none */ @@ -714,6 +771,7 @@ inline void io_FreeNullTerm(char *** __restrict arr); /* * ioMkDir() Function for racursive directory creation and validation + * * @csDir = Full directory path * @mode = Mode for directory creation if missing dir * return: -1 error, 0 directory path exist, >0 created missing dirs @@ -722,6 +780,7 @@ int ioMkDir(const char *csDir, int mode); /* * ioWatchDirLoop() Function for watching changes in directory and fire callback + * * @csDir = Full directory path * @callback = Callback if raise event! nOp -1 delete, 0 change/move, 1 create * return: -1 error, !=-1 ok, number of total signaled events @@ -731,6 +790,7 @@ int ioWatchDirLoop(const char *csDir, int (*callback)( /* * io_rread() Raw VFS read function + * * @fd = File handle * @buf = Read buffer * @nbytes = Read buffer size @@ -741,6 +801,7 @@ int ioWatchDirLoop(const char *csDir, int (*callback)( inline int io_rread(int fd, void * __restrict buf, size_t nbytes, off_t offset, int update); /* * io_rwrite() Raw VFS write function + * * @fd = File handle * @buf = Write buffer * @nbytes = Write bytes from buffer @@ -811,6 +872,7 @@ extern int io_Debug; /* * ioCipher() Cipher wrapper for all supported crypto algorythms + * * @pInput = input buffer * @inLen = input buffer len * @ppOutput = output allocated buffe, must be free after use @@ -825,6 +887,7 @@ int ioCipher(unsigned char *pInput, int inLen, unsigne /* * io_Blowfish() Blowfish cipher algorythm, work with ASCII hex strings + * * @pInput = input buffer * @inLen = input buffer len * @ppOutput = output allocated buffe, must be free after use @@ -837,6 +900,7 @@ int io_Blowfish(unsigned char *pInput, int inLen, unsi 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 @@ -850,6 +914,7 @@ int io_ctr_AES(unsigned char *pInput, int inLen, unsig /* * ioAllocPTY() Allocate new PTY and TTY + * * @ptyfd = master fd, pty * @ttyfd = slave fd, tty * @name = tty device name if not null @@ -862,6 +927,7 @@ inline int ioAllocPTY(int *ptyfd, int *ttyfd, char * _ 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 @@ -869,6 +935,7 @@ inline int ioAllocPTY(int *ptyfd, int *ttyfd, char * _ inline void ioFreePTY(int ptyfd, const char *ttyname); /* * ioChgWinPTY() Change window size of PTY + * * @ptyfd = master fd, pty * @row = row * @col = col @@ -880,6 +947,7 @@ inline int ioChgWinPTY(int ptyfd, unsigned short row, unsigned short xpxl, unsigned short ypxl); /* * ioSetOwnerTTY() Set owner to TTY + * * @ttyname = tty filename * @UID = uid * @GID = gid @@ -888,6 +956,7 @@ inline int ioChgWinPTY(int ptyfd, unsigned short row, 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 @@ -895,6 +964,7 @@ int ioSetOwnerTTY(const char *ttyname, uid_t UID, gid_ 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 @@ -902,6 +972,7 @@ int ioSetSidTTY(int *ttyfd, const char *ttyname); 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 @@ -909,6 +980,7 @@ inline int ioSetRAWMode(int fd, struct termios *otio); 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. @@ -922,6 +994,7 @@ pid_t ioForkPTY(int *ptyfd, char * __restrict name, in /* * ioCreatePIDFile() Create PID file + * * @csName = PID filename * @ifExists = !=0 if filename exists return error * return: -1 error or 0 ok @@ -930,6 +1003,7 @@ inline int ioCreatePIDFile(const char *csName, int ifE /* * ioSendFile() AITNET sendfile() userland implementation, not dependant from OS + * * @s = socket * @csFile = file for send * @sendLen = bytes to send, if 0 send all data @@ -940,6 +1014,7 @@ inline int ioCreatePIDFile(const char *csName, int ifE size_t ioSendFile(int s, const char *csFile, size_t sendLen, off_t offset, int sndbuf); /* * ioRecvFile() Receive file from socket, fastest (zero-copy) way + * * @s = socket * @csFile = file for receive * @recvLen = receive bytes