Annotation of libaitio/inc/aitio.h, revision 1.11.2.5
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.11.2.5! misho 6: * $Id: aitio.h,v 1.11.2.4 2011/08/29 23:27:22 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.8 misho 50: #include <assert.h>
1.7 misho 51: #include <openssl/evp.h>
52:
53:
1.8 misho 54: #define VACUUM_LEFT 1
55: #define VACUUM_BETWEEN 2
56:
1.11.2.1 misho 57: /* AIT arrays */
1.8 misho 58:
1.9 misho 59: typedef void ** sarr_seg_t;
60: typedef struct _tagSplitArray {
61: int sarr_num;
62: int sarr_seg;
63: int sarr_siz;
64: sarr_seg_t *sarr_data;
65: } sarr_t;
66:
1.8 misho 67: typedef struct _tagArray {
68: int arr_num;
69: void **arr_data;
70: } array_t;
71:
1.11.2.1 misho 72: /* URL staff ... */
73:
1.2 misho 74: typedef struct _tagURLItem {
75: int vallen;
76: char *value;
77: } url_Item_t;
78:
79: struct tagIOURL {
80: unsigned char url_line[BUFSIZ];
81:
82: url_Item_t url_tech;
83: url_Item_t url_user;
84: url_Item_t url_pass;
85: url_Item_t url_host;
86: url_Item_t url_port;
87: url_Item_t url_path;
88: url_Item_t url_args;
89:
90: char *url_reserved;
91: };
92:
1.6 misho 93: struct tagReqXML {
94: unsigned char xml_line[BUFSIZ];
95:
96: url_Item_t xml_namespace;
97: union {
98: url_Item_t container;
99: url_Item_t path;
100: } xml_node;
101: url_Item_t xml_data;
102: url_Item_t xml_attribute;
103: url_Item_t xml_value;
104: };
105:
1.11.2.2 misho 106: /* AIT RPC variables and managment */
1.11.2.1 misho 107:
108: typedef enum {
109: empty, /* empty -> variable is not set */
110: buffer, string, blob, array, /* buffer -> uint8_t*; string -> int8_t*;
111: blob -> void*(+socket); array -> array_t* */
112: u8, u16, u32, u64, /* unsigned integers ... */
1.11.2.5! misho 113: i8, i16, i32, i64, /* integers ... */
! 114: zeroCopy = 0x80 /* OR attribute used from RPC dispatcher to mark data in val union
! 115: is zero copied from network buffer */
1.11.2.1 misho 116: } ait_type_t;
117:
118: typedef struct {
119: uint8_t val_type;
120: uint32_t val_len;
121: union {
122: uint8_t *buffer,
123: *array;
124: int8_t *string;
125: uint32_t blob;
126: uint8_t u8;
127: uint16_t u16;
128: uint32_t u32;
129: uint64_t u64;
130: int8_t i8;
131: int16_t i16;
132: int32_t i32;
133: int64_t i64;
134: } val;
135: } __packed ait_val_t;
136:
1.11.2.5! misho 137: #define AIT_TYPE(_vl) ((ait_type_t) (_vl)->val_type & ~zeroCopy)
1.11.2.3 misho 138: #define AIT_LEN(_vl) (_vl)->val_len
1.11.2.5! misho 139: #define AIT_BLOB_CHUNKS(_vl, _n) (assert((_vl)), AIT_LEN((_vl)) / _n + (AIT_LEN((_vl)) % _n) ? 1 : 0)
! 140: #define AIT_ISEMPTY(_vl) (assert((_vl)), AIT_TYPE((_vl)) == empty)
1.11.2.1 misho 141:
1.11.2.5! misho 142: #define AIT_ISZCOPY(_vl) (assert((_vl)), (_vl)->val_type & zeroCopy)
! 143: #define AIT_ADDZCOPY(_vl) (assert((_vl)), (_vl)->val_type | zeroCopy)
! 144: #define AIT_DELZCOPY(_vl) (assert((_vl)), (_vl)->val_type &= ~zeroCopy)
! 145:
! 146: #define AIT_GET_ARRAY(_vl) (assert((_vl)), assert(AIT_TYPE((_vl)) == array), \
1.11.2.1 misho 147: ((array_t*) (_vl)->val.array))
1.11.2.5! misho 148: #define AIT_GET_BUF(_vl) (assert((_vl)), assert(AIT_TYPE((_vl)) == buffer), (_vl)->val.buffer)
! 149: #define AIT_GET_STR(_vl) (assert((_vl)), assert(AIT_TYPE((_vl)) == string), (_vl)->val.string)
! 150: #define AIT_GET_BLOB(_vl) (assert((_vl)), assert(AIT_TYPE((_vl)) == blob), (_vl)->val.blob)
! 151: #define AIT_GET_U8(_vl) (assert((_vl)), assert(AIT_TYPE((_vl)) == u8), (_vl)->val.u8)
! 152: #define AIT_GET_U16(_vl) (assert((_vl)), assert(AIT_TYPE((_vl)) == u16), (_vl)->val.u16)
! 153: #define AIT_GET_U32(_vl) (assert((_vl)), assert(AIT_TYPE((_vl)) == u32), (_vl)->val.u32)
! 154: #define AIT_GET_U64(_vl) (assert((_vl)), assert(AIT_TYPE((_vl)) == u64), (_vl)->val.u64)
! 155: #define AIT_GET_I8(_vl) (assert((_vl)), assert(AIT_TYPE((_vl)) == i8), (_vl)->val.i8)
! 156: #define AIT_GET_I16(_vl) (assert((_vl)), assert(AIT_TYPE((_vl)) == i16), (_vl)->val.i16)
! 157: #define AIT_GET_I32(_vl) (assert((_vl)), assert(AIT_TYPE((_vl)) == i32), (_vl)->val.i32)
! 158: #define AIT_GET_I64(_vl) (assert((_vl)), assert(AIT_TYPE((_vl)) == i64), (_vl)->val.i64)
1.11.2.1 misho 159:
160: #define AIT_SET_BUF(_vl, _v, _len) do { ait_val_t *__val = (_vl); assert(__val); assert((_v)); \
161: __val->val.buffer = malloc(_len); \
162: if (__val->val.buffer) { \
1.11.2.3 misho 163: __val->val_type = buffer; AIT_LEN(__val) = _len; \
1.11.2.1 misho 164: memcpy(__val->val.buffer, (_v), _len); \
165: } } while (0)
1.11.2.4 misho 166: #define AIT_SET_STR(_vl, _v) do { ait_val_t *__val = (_vl); assert(__val); \
1.11.2.1 misho 167: __val->val.string = (int8_t*) strdup((_v)); \
168: if (__val->val.string) { \
1.11.2.3 misho 169: __val->val_type = string; \
1.11.2.1 misho 170: AIT_LEN(__val) = strlen((_v)) + 1; \
171: } } while (0)
172: #define AIT_SET_BLOB(_vl, _n, _len) do { ait_val_t *__val = (_vl); assert(__val); \
1.11.2.3 misho 173: __val->val_type = blob; AIT_LEN(__val) = _len; \
1.11.2.1 misho 174: __val->val.blob = _n; } while (0)
175: #define AIT_SET_BLOB2(_vl, _bv) do { ait_val_t *__val = (_vl); assert(__val); assert((_bv)); \
1.11.2.3 misho 176: __val->val_type = blob; AIT_LEN(__val) = (_bv)->blob_len; \
1.11.2.1 misho 177: __val->val.blob = (_bv)->blob_var; } while (0)
178: #define AIT_SET_ARRAY(_vl, _arr) do { ait_val_t *__val = (_vl); assert(__val); assert((_arr)); \
1.11.2.3 misho 179: __val->val_type = array; AIT_LEN(__val) = io_arraySize((_arr)); \
1.11.2.2 misho 180: __val->val.array = (uint8_t*) (_arr); \
1.11.2.1 misho 181: } while (0)
182:
183: #define AIT_SET_U8(_vl, _n) do { ait_val_t *__val = (_vl); assert(__val); \
1.11.2.3 misho 184: __val->val_type = u8; __val->val.u8 = _n; \
1.11.2.1 misho 185: AIT_LEN(__val) = sizeof(uint8_t); } while (0)
186: #define AIT_SET_U16(_vl, _n) do { ait_val_t *__val = (_vl); assert(__val); \
1.11.2.3 misho 187: __val->val_type = u16; __val->val.u16 = _n; \
1.11.2.1 misho 188: AIT_LEN(__val) = sizeof(uint16_t); } while (0)
189: #define AIT_SET_U32(_vl, _n) do { ait_val_t *__val = (_vl); assert(__val); \
1.11.2.3 misho 190: __val->val_type = u32; __val->val.u32 = _n; \
1.11.2.1 misho 191: AIT_LEN(__val) = sizeof(uint32_t); } while (0)
192: #define AIT_SET_U64(_vl, _n) do { ait_val_t *__val = (_vl); assert(__val); \
1.11.2.3 misho 193: __val->val_type = u64; __val->val.u64 = _n; \
1.11.2.1 misho 194: AIT_LEN(__val) = sizeof(uint64_t); } while (0)
195: #define AIT_SET_I8(_vl, _n) do { ait_val_t *__val = (_vl); assert(__val); \
1.11.2.3 misho 196: __val->val_type = i8; __val->val.i8 = _n; \
1.11.2.1 misho 197: AIT_LEN(__val) = sizeof(int8_t); } while (0)
198: #define AIT_SET_I16(_vl, _n) do { ait_val_t *__val = (_vl); assert(__val); \
1.11.2.3 misho 199: __val->val_type = i16; __val->val.i16 = _n; \
1.11.2.1 misho 200: AIT_LEN(__val) = sizeof(int16_t); } while (0)
201: #define AIT_SET_I32(_vl, _n) do { ait_val_t *__val = (_vl); assert(__val); \
1.11.2.3 misho 202: __val->val_type = i32; __val->val.i32 = _n; \
1.11.2.1 misho 203: AIT_LEN(__val) = sizeof(int32_t); } while (0)
204: #define AIT_SET_I64(_vl, _n) do { ait_val_t *__val = (_vl); assert(__val); \
1.11.2.3 misho 205: __val->val_type = i64; __val->val.i64 = _n; \
1.11.2.1 misho 206: AIT_LEN(__val) = sizeof(int64_t); } while (0)
207:
1.11.2.5! misho 208: /* if attribute zeroCopy is set not execute free() */
1.11.2.1 misho 209: #define AIT_FREE_VAL(_vl) do { ait_val_t *__val = (_vl); assert(__val); \
1.11.2.3 misho 210: switch (__val->val_type) { \
1.11.2.1 misho 211: case buffer: \
212: if (__val->val.buffer) { \
213: free(__val->val.buffer); \
214: __val->val.buffer = NULL; \
215: } \
216: break; \
217: case string: \
218: if (__val->val.string) { \
219: free(__val->val.string); \
220: __val->val.string = NULL; \
221: } \
222: break; \
1.11.2.3 misho 223: default: \
224: break; \
1.11.2.1 misho 225: } \
1.11.2.3 misho 226: __val->val_type = empty; \
1.11.2.1 misho 227: AIT_LEN(__val) = 0; \
228: } while (0)
229:
1.3 misho 230:
1.1 misho 231: // io_GetErrno() Get error code of last operation
232: inline int io_GetErrno();
233: // io_GetError() Get error text of last operation
234: inline const char *io_GetError();
235:
236:
237: /*
238: * ioPromptRead() Read data from input h[0] with prompt to output h[1]
239: * @h = file handles h[0] = input, h[1] = output, if NULL use stdin, stdout
240: * @csPrompt = Prompt before input, may be NULL
241: * @psData = Readed data
242: * @dataLen = Length of data
243: * return: 0 EOF; -1 error:: can`t read; >0 count of readed chars
244: */
245: int ioPromptRead(int *h, const char *csPrompt, char * __restrict psData, int dataLen);
246: /*
247: * ioPromptPassword() Read password from input h[0] with prompt to output h[1]
248: * @h = file handles h[0] = input, h[1] = output, if NULL use stdin, stdout
249: * @csPrompt = Prompt before input, may be NULL
250: * @psPass = Readed password
251: * @passLen = Length of password
252: * @confirm = Confirm password, 0 - get password, !=0 Ask for confirmation
253: * return: 0 EOF; -1 error:: can`t read; >0 count of readed chars
254: */
255: int ioPromptPassword(int *h, const char *csPrompt, char * __restrict psPass, int passLen, int confirm);
256:
257: /*
258: * ioRegexVerify() Function for verify data match in regex expression
259: * @csRegex = Regulare expression pattern
260: * @csData = Data for check and verify
261: * @startPos = Return start positions
262: * @endPos = Return end positions
263: * return: NULL not match or error; !=NULL begin of matched data
264: */
265: const char *ioRegexVerify(const char *csRegex, const char *csData, int *startPos, int *endPos);
266: /*
267: * ioRegexGet() Function for get data match in regex expression
268: * @csRegex = Regulare expression pattern
269: * @csData = Data from get
270: * @psString = Returned string if match
271: * @strLen = Length of string
272: * return: 0 not match; >0 count of returned chars
273: */
274: int ioRegexGet(const char *csRegex, const char *csData, char * __restrict psString, int strLen);
275: /*
276: * ioRegexReplace() Function for replace data match in regex expression with newdata
277: * @csRegex = Regulare expression pattern
278: * @csData = Source data
279: * @csNew = Data for replace
280: * return: NULL not match or error; !=NULL allocated new string, must be free after use!
281: */
282: char *ioRegexReplace(const char *csRegex, const char *csData, const char *csNew);
283:
1.2 misho 284: /*
1.6 misho 285: * ioVarAst() Function for evaluate string like asterisk variable "{text[:[-]#[:#]]}"
286: * @csString = Input string
287: * return: NULL error, !=NULL Allocated new string evaluated from input string, must be free()
288: */
289: char *ioVarAst(const char *csString);
290:
291: /*
1.2 misho 292: * io_Path2File() Parse and make path/filename pair
293: * @csArgs = Input argument line
294: * @psPath = Output Path, if ==NULL path not returned
295: * @pathLen = Size of path array
296: * @psFile = Output File
297: * @fileLen = Size of file array
298: * return: 0 error format; -1 error:: can`t read; >0 ok, number of readed items
299: */
300: inline int io_Path2File(const char * __restrict csArgs, char * __restrict psPath, int pathLen,
301: char * __restrict psFile, int fileLen);
302:
303: /*
1.4 misho 304: * io_UnquotStr() Remove quots from input text string
305: * @psLine = Text string
306: * return: 0 nothing to do; 1 successful unquoted string
307: */
1.5 misho 308: inline int io_UnquotStr(unsigned char * __restrict psLine);
1.4 misho 309: /*
310: * io_LTrimStr() Remove left whitespaces from text string
311: * @psLine = Text string
312: * return: 0 nothing to do; !=0 Removed bytes
313: */
1.5 misho 314: inline int io_LTrimStr(unsigned char * __restrict psLine);
1.4 misho 315: /*
316: * io_RTrimStr() Remove right whitespaces from text string
317: * @psLine = Text string
318: * return: 0 nothing to do; !=0 Removed bytes
319: */
1.5 misho 320: inline int io_RTrimStr(unsigned char * __restrict psLine);
1.4 misho 321: /*
322: * io_TrimStr() Remove left and right whitespaces from text string
323: * @psLine = Text string
324: * return: 0 nothing to do; !=0 Removed bytes
325: */
1.5 misho 326: inline int io_TrimStr(unsigned char * __restrict psLine);
1.4 misho 327: /*
1.5 misho 328: * io_Ch2Hex() Convert from Char string to Hex string
1.4 misho 329: * @psLine = Text string
330: * @lineLen = Length of Text string
1.5 misho 331: * return: NULL nothing to do or error; !=0 Allocated new converted data without term\0 (must be free)
1.4 misho 332: */
1.5 misho 333: inline unsigned char *io_Ch2Hex(unsigned char *psLine, int lineLen);
1.4 misho 334: /*
1.5 misho 335: * io_Hex2Ch() Convert from Hex string to Char string
1.4 misho 336: * @psLine = Text string
337: * @lineLen = Length of Text string
338: * return: NULL nothing to do or error; !=0 Allocated new converted string(must be free)
339: */
1.5 misho 340: inline char *io_Hex2Ch(unsigned char *psLine, int lineLen);
1.4 misho 341:
342: /*
1.8 misho 343: * io_arrayInit() - Create and initialize dynamic array
344: * @numItems = Number of Items
345: * return: NULL error, != NULL allocated memory for array
346: */
347: inline array_t *io_arrayInit(int numItems);
348: /*
1.10 misho 349: * io_arrayDestroy() - Free and destroy dynamic array
1.8 misho 350: * @parr = Array
351: * return: none
352: */
353: inline void io_arrayDestroy(array_t ** __restrict parr);
354: /*
1.10 misho 355: * io_arrayFree() - Free all data in dynamic array items
1.8 misho 356: * (WARNING! If assign static array dont use this!!!)
357: * @arr = Array
358: * return: none
359: */
360: inline void io_arrayFree(array_t * __restrict arr);
361: /*
1.10 misho 362: * io_arrayFrom() - Create and fill array from array with pointers
1.11 misho 363: * @pargv = Array with pointers
1.10 misho 364: * @argc = Number of Items, if 0 walk through argv and stop when reach NULL item
1.11 misho 365: * return: NULL error, != NULL allocated new array
1.10 misho 366: */
1.11 misho 367: inline array_t *io_arrayFrom(const char *** __restrict pargv, int argc);
1.10 misho 368: /*
369: * io_arrayTo() - Create and fill array with pointers from dynamic array
370: * @arr = Array
1.11 misho 371: * return: NULL error, != NULL allocated memory for array, NULL terminated
1.10 misho 372: */
373: inline char **io_arrayTo(array_t * __restrict arr);
374: /*
1.8 misho 375: * io_arrayLen() - Get last used element in dynamic array (array Length)
376: * @arr = Array
377: * return: -1 error, 0 empty or >0 position of last used element
378: */
379: inline int io_arrayLen(array_t * __restrict arr);
380: /*
1.10 misho 381: * io_arrayConcat() Concat source array to destination array
382: * @dest = Destination array
383: * @src = Source array
384: * return: -1 error; >0 new count of destination array
385: */
386: int io_arrayConcat(array_t * __restrict dest, array_t * __restrict src);
387: /*
1.8 misho 388: * io_arrayGrow() - Grow/Shrink dynamic array, Use with care when it shrink!!!
389: * @arr = Array
390: * @newNumItems = Number of Items
391: * return: -1 error, 0 ok
392: */
393: int io_arrayGrow(array_t * __restrict arr, int newNumItems);
394: /*
395: * io_arrayVacuum() - Vacuum dynamic array, empty elements will be deleted
396: * @arr = Array
397: * @fromWhere = 1 begin, 2 ALL empty elements
398: * return: -1 error, 0 ok
399: */
400: int io_arrayVacuum(array_t * __restrict arr, int fromWhere);
401:
1.11 misho 402: #define io_arraySize(_arr) (assert((_arr)), (_arr)->arr_num)
1.8 misho 403:
1.11 misho 404: #define io_arrayGet(_arr, _d) (assert((_arr) && (_arr)->arr_num > _d), *((_arr)->arr_data + _d))
405: #define io_array(_arr, _d, _type) (assert((_arr) && (_arr)->arr_num > _d), \
406: ((_type) *((_arr)->arr_data + _d)))
1.8 misho 407: #define io_arraySet(_arr, _d, _ptr) do { \
1.11 misho 408: assert((_arr) && (_arr)->arr_num > _d); \
409: *((_arr)->arr_data + _d) = (void*) (_ptr); \
1.8 misho 410: } while (0)
1.11 misho 411: #define io_arrayDel(_arr, _d, _fri) do { \
412: assert((_arr) && (_arr)->arr_num > _d); \
413: if (_fri) \
414: free(*((_arr)->arr_data + _d)); \
415: *((_arr)->arr_data + _d) = NULL; \
1.9 misho 416: } while (0)
1.8 misho 417:
418: /*
419: * io_arrayPush() - Push element into dynamic array like stack manner, place at first empty position
420: * @arr = Array
421: * @data = Element, if set NULL return only first empty position
422: * return: -1 not found empty position, array is full!, >-1 return position of stored element into array
423: */
424: inline int io_arrayPush(array_t * __restrict arr, void **data);
425: /*
426: * io_arrayPop() - Pop element from dynamic array like stack manner, last used position
427: * @arr = Array
1.11 misho 428: * @data = Element, if set NULL return only last used position
1.8 misho 429: * @delAfter = Delete after Pop element, !=0 delete element from array after return data
430: * return: -1 not found used position, array is empty!, >-1 return element position
431: */
432: inline int io_arrayPop(array_t * __restrict arr, void ** __restrict data, int delAfter);
433:
434: /*
435: * io_argsNum() Parse and calculate number of arguments
436: * @csArgs = Input arguments line
437: * @csDelim = Delimiter(s) for separate
438: * return: 0 error format; -1 error:: can`t read; >0 ok, number of items
439: */
440: inline int io_argsNum(const char *csArgs, const char *csDelim);
441:
442: /*
443: * io_arrayMake() Parse and make array from arguments ... (input string will be modified!!!
444: * and output array must be free with io_arrayDestroy() after use!)
445: * @psArgs = Input arguments line, after execute string is modified!!!
446: * @nargs = Maximum requested count of arguments from input string psArgs, if 0 all psArgs
447: * @csDelim = Delimiter(s) for separate
448: * @parr = Output array of arguments ... (must be free with io_arrayDestroy() after use!)
449: * return: 0 error format; -1 error:: can`t read; >0 ok, number of readed items
450: */
451: int io_arrayMake(char * __restrict psArgs, int nargs, const char *csDelim,
452: array_t ** __restrict parr);
453:
454: /*
455: * io_MakeAV() Parse and make attribute/value pair
456: * @csArgs = Input argument line
457: * @csDelim = Delimiter for separate
458: * @psAttr = Output Attribute
459: * @attrLen = Size of attribute array
460: * @psValue = Output Value, if ==NULL this element not present value or not wanted for return
461: * @valLen = Size of value array
462: * return: 0 error format; -1 error:: can`t read; >0 ok, number of readed items
463: */
464: int io_MakeAV(const char * __restrict csArgs, const char *csDelim,
465: char * __restrict psAttr, int attrLen, char * __restrict psValue, int valLen);
466:
1.9 misho 467: /*
468: * io_sarrInit() - Create and initialize dynamic split-order array
469: * @numItems = Number of Items
470: * @segLen = Length of segment
471: * return: NULL error, != NULL allocated memory for array
472: */
473: inline sarr_t *io_sarrInit(int numItems, int segLen);
474: /*
475: * io_sarrDestroy() - Free all data in dynamic split-order array and Destroy array
476: * @parr = Array
477: * return: none
478: */
479: inline void io_sarrDestroy(sarr_t ** __restrict parr);
480: /*
481: * io_sarrGrow() - Grow/Shrink dynamic split-order array, Use with care when it shrink!!!
482: * @arr = Array
483: * @newNumItems = Number of Items
484: * return: -1 error, 0 ok
485: */
486: int io_sarrGrow(sarr_t * __restrict arr, int newNumItems);
487: /*
488: * io_sarrVacuum() - Vacuum dynamic split-order array, empty segments will be freed
489: * @arr = Array
490: * return: -1 error, >-1 freed segments
491: */
492: inline int io_sarrVacuum(sarr_t * __restrict arr);
1.11 misho 493: #define io_sarrSize(_arr) (assert((_arr)), (_arr)->sarr_num)
1.9 misho 494: /*
495: * io_sarrGet() - Get element from dynamic split-order array
496: * @arr = Array
497: * @idx = Index (warning 1st element is at position 1)
498: * return: NULL not found, !=NULL element
499: */
500: inline void *io_sarrGet(sarr_t * __restrict arr, unsigned int idx);
501: /*
502: * io_sarrGet2() - Always get element from dynamic split-order array
503: * Function automatic grow array. Good use for Hash tables!
504: * @arr = Array
505: * @idx = Index (warning 1st element is at position 1)
506: * return: NULL not found, !=NULL element
507: */
508: void *io_sarrGet2(sarr_t * __restrict arr, unsigned int idx);
509: /*
510: * io_sarrSet() - Set element to dynamic split-order array
511: * @arr = Array
512: * @idx = Index (warning 1st element is at position 1)
513: * @data = Value
514: * return: NULL error or empty, !=NULL old value in element
515: */
516: inline void *io_sarrSet(sarr_t * __restrict arr, unsigned int idx, void *data);
1.11 misho 517: #define io_sarrDel(_arr, _idx) io_sarrSet((_arr), _idx, NULL)
518: #define io_sarr(_arr, _idx, _type) (_type)io_sarrGet((_arr), _idx)
519: /*
520: * io_sarr2array() - Convert from split-order array to dynamic array
521: * @sa = split array
522: * @sarrFree = after convert split array !=0 will be destroyed sarray
523: * return: NULL error or != NULL new array
524: */
525: array_t *io_sarr2array(sarr_t ** __restrict sa, int sarrFree);
526: /*
527: * io_array2sarr() - Convert from dynamic array to split-order array
528: * @a = array
529: * @segLen = Length of segment
530: * @arrFree = after convert array !=0 will be destroyed
531: * return: NULL error or != NULL new sarr
532: */
533: sarr_t *io_array2sarr(array_t ** __restrict a, int segLen, int arrFree);
1.8 misho 534:
535: /*
1.10 misho 536: * io_CopyEnv() Copy environment to new environment array;
537: * @oldenv = Environment array
538: * return: NULL error; !=NULL Allocated new environment array(must be free)
539: */
540: char **io_CopyEnv(const char **oldenv);
541: /*
542: * io_ExecArgs() Build exec arguments from other array
543: * @psProg = Program name for execute
544: * @oldarg = Arguments array
545: * return: NULL error; !=NULL Allocated execution array(must be free)
546: */
547: char **io_ExecArgs(const char *psProg, const char **oldarg);
548: /*
549: * io_FreeNullTerm() Free dynamic allocated null terminated array with strings
550: * @arr = Pointer to array for free
551: * return: none
552: */
553: inline void io_FreeNullTerm(char *** __restrict arr);
554:
555: /*
1.2 misho 556: * ioURLGet() Parse and get data from input URL
557: * @csURL = Input URL line
558: * @url = Output parsed URL
559: * return: 0 error format not find tech:// and return URL like path;
560: -1 error:: can`t read; >0 ok, up bits for known elements
561: */
562: int ioURLGet(const char *csURL, struct tagIOURL *url);
563: /*
564: * ioURLGetValue() Get value from parsed URL
565: * @url = Input parsed URL
566: * @csAttr = Attribute for search
567: * @psValue = Return value of attribute, if ==NULL only check for existence of attribute
568: * @valLen = Size of psValue array
569: * return: 0 error attribute not find; -1 error:: can`t read; >0 ok, find at position
570: */
571: int ioURLGetValue(struct tagIOURL *url, const char *csAttr, char * __restrict psValue, int valLen);
572: /*
573: * ioURLGetFile() Get file from parsed URL
574: * @url = Input parsed URL
575: * @psValue = Return filename, if not specified file in url path, replace with /
576: * @valLen = Size of psValue array
577: * return: -1 error:: can`t read; 0 ok
578: */
579: int ioURLGetFile(struct tagIOURL *url, char * __restrict psValue, int valLen);
580:
1.3 misho 581:
582: /*
1.6 misho 583: * ioXMLGet() Parse and get data from input XML request string [ns:]container[|attribute[=value]][?data]
584: * @csXML = Input XML request line
585: * @xml = Output parsed XML request
586: * return: 0 error format incorrect, -1 error:: can`t read; >0 ok readed elements bits
587: */
588: int ioXMLGet(const char *csXML, struct tagReqXML *xml);
589:
590:
591: /*
1.5 misho 592: * ioMkDir() Function for racursive directory creation and validation
593: * @csDir = Full directory path
594: * @mode = Mode for directory creation if missing dir
595: * return: -1 error, 0 directory path exist, >0 created missing dirs
596: */
597: int ioMkDir(const char *csDir, int mode);
598:
1.6 misho 599: /*
600: * ioWatchDirLoop() Function for watching changes in directory and fire callback
601: * @csDir = Full directory path
602: * @callback = Callback if raise event! nOp -1 delete, 0 change/move, 1 create
603: * return: -1 error, !=-1 ok, number of total signaled events
604: */
605: int ioWatchDirLoop(const char *csDir, int (*callback)(const char *csName, int nOp));
606:
1.5 misho 607:
608: /*
609: * io_rread() Raw VFS read function
610: * @fd = File handle
611: * @buf = Read buffer
612: * @nbytes = Read buffer size
613: * @offset = Read from position, if -1 read nbytes from current position
614: * @update = Update file handle position !0
615: * return: -1 error or !=-1 readed bytes
616: */
617: inline int io_rread(int fd, void * __restrict buf, size_t nbytes, off_t offset, int update);
618: /*
619: * io_rwrite() Raw VFS write function
620: * @fd = File handle
621: * @buf = Write buffer
622: * @nbytes = Write bytes from buffer
623: * @offset = Write at position, if -1 write nbytes from current position
624: * @update = Update file handle position !0
625: * return: -1 error or !=-1 writed bytes
626: */
627: inline int io_rwrite(int fd, void * __restrict buf, size_t nbytes, off_t offset, int update);
628:
629: /* Disk I/O helper macros */
630: #define io_read(f, b, n) io_rread(f, b, n, -1, 1)
631: #define io_write(f, b, n) io_rwrite(f, b, n, -1, 1)
632:
633:
634: /* Debug helper macros */
635: extern int io_Debug;
636:
637: #define io_initDebug(x) io_Debug = (x);
638: #define io_addDebug io_Debug++
639: #define ioDEBUG(x, fmt, ...) do { \
640: assert((fmt)); \
641: char str[STRSIZ] = { 0 }; \
1.11 misho 642: snprintf(str, sizeof str, (fmt), ##__VA_ARGS__); \
1.5 misho 643: if ((x) <= io_Debug) \
644: syslog(LOG_DEBUG, "ioDebug(%d):%s(%d): %s\n", \
645: (x), __func__, __LINE__, str); \
646: } while (0)
647:
648: #define ioERROR(x, fmt, ...) do { \
649: assert((fmt)); \
650: char str[STRSIZ] = { 0 }; \
1.11 misho 651: snprintf(str, sizeof str, (fmt), ##__VA_ARGS__); \
1.5 misho 652: syslog(LOG_ERR, "ioError():%s(%d): #%d - %s\n", \
653: __func__, __LINE__, (x), str); \
654: } while (0)
655: #define io_sysERROR(x) do { \
656: if (x > 0 || errno) \
657: syslog(LOG_ERR, "ioError(sys):%s(%d): #%d - %s\n", \
658: __func__, __LINE__, x > 0 ? x : errno, \
659: strerror(x > 0 ? x : errno)); \
660: } while (0)
661: #define io_aitERROR(ait) do { \
662: if (ait##_GetErrno()) \
663: syslog(LOG_ERR, "ioError(ait):%s(%d): #%d - %s\n", \
664: __func__, __LINE__, ait##_GetErrno(), \
665: ait##_GetError()); \
666: } while (0)
1.3 misho 667:
1.1 misho 668:
1.7 misho 669: /* Crypto framework */
670:
671: /*
672: * ioCipher() Cipher wrapper for all supported crypto algorythms
673: * @pInput = input buffer
674: * @inLen = input buffer len
675: * @ppOutput = output allocated buffe, must be free after use
676: * @Cipher = cipher engine, like EVP_bf_cbc() or etc...
677: * @pKey = key
678: * @pIV = IV, salt (8 bytes)
679: * @nMode = Mode 0 - decrypting or 1 - encrypting
680: * return: 0 not present data or error!; >0 number of processed and returned bytes into ppOutput
681: */
682: int ioCipher(unsigned char *pInput, int inLen, unsigned char **ppOutput, const EVP_CIPHER *Cipher,
683: unsigned char *pKey, unsigned char *pIV, int nMode);
684:
685: /*
686: * io_Blowfish() Blowfish cipher algorythm, work with ASCII hex strings
687: * @pInput = input buffer
688: * @inLen = input buffer len
689: * @ppOutput = output allocated buffe, must be free after use
690: * @pKey = key
691: * @pIV = IV, salt (8 bytes)
692: * @nMode = Mode 0 - decrypting or 1 - encrypting
693: * return: 0 not present data or error!; >0 number of processed and returned bytes into ppOutput
694: */
1.8 misho 695: int io_Blowfish(unsigned char *pInput, int inLen, unsigned char **ppOutput,
696: unsigned char *pKey, unsigned char *pIV, int nMode);
1.7 misho 697:
698:
1.1 misho 699: #endif
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/cvsweb/back.gif){kind=icon}
Return to aitio.h CVS log ![[TXT]](/icons/cvsweb/text.gif){kind=icon}
![[DIR]](/icons/cvsweb/dir.gif){kind=icon}
Up to [ELWIX - Embedded LightWeight unIX -] / libaitio / inc