Annotation of libaitio/inc/aitio.h, revision 1.11.2.18
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.18! misho 6: * $Id: aitio.h,v 1.11.2.17 2011/09/19 23:30:50 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 */
1.11.2.6 misho 110: buffer, string, blob, /* buffer -> uint8_t*; string -> int8_t*; blob -> void*(+socket); */
111: f32, f64, /* float -> f32; double -> f64 */
1.11.2.1 misho 112: u8, u16, u32, u64, /* unsigned integers ... */
1.11.2.5 misho 113: i8, i16, i32, i64, /* integers ... */
1.11.2.1 misho 114: } ait_type_t;
115:
116: typedef struct {
117: uint8_t val_type;
118: uint32_t val_len;
119: union {
1.11.2.6 misho 120: uint64_t net;
121:
122: uint8_t *buffer;
1.11.2.1 misho 123: int8_t *string;
124: uint32_t blob;
1.11.2.6 misho 125: float f32;
126: double f64;
1.11.2.1 misho 127: uint8_t u8;
128: uint16_t u16;
129: uint32_t u32;
130: uint64_t u64;
131: int8_t i8;
132: int16_t i16;
133: int32_t i32;
134: int64_t i64;
135: } val;
136: } __packed ait_val_t;
137:
1.11.2.6 misho 138: #define AIT_TYPE(_vl) ((ait_type_t) (_vl)->val_type)
1.11.2.3 misho 139: #define AIT_LEN(_vl) (_vl)->val_len
1.11.2.5 misho 140: #define AIT_BLOB_CHUNKS(_vl, _n) (assert((_vl)), AIT_LEN((_vl)) / _n + (AIT_LEN((_vl)) % _n) ? 1 : 0)
141: #define AIT_ISEMPTY(_vl) (assert((_vl)), AIT_TYPE((_vl)) == empty)
1.11.2.1 misho 142:
1.11.2.5 misho 143: #define AIT_GET_BUF(_vl) (assert((_vl)), assert(AIT_TYPE((_vl)) == buffer), (_vl)->val.buffer)
144: #define AIT_GET_STR(_vl) (assert((_vl)), assert(AIT_TYPE((_vl)) == string), (_vl)->val.string)
145: #define AIT_GET_BLOB(_vl) (assert((_vl)), assert(AIT_TYPE((_vl)) == blob), (_vl)->val.blob)
146: #define AIT_GET_U8(_vl) (assert((_vl)), assert(AIT_TYPE((_vl)) == u8), (_vl)->val.u8)
147: #define AIT_GET_U16(_vl) (assert((_vl)), assert(AIT_TYPE((_vl)) == u16), (_vl)->val.u16)
148: #define AIT_GET_U32(_vl) (assert((_vl)), assert(AIT_TYPE((_vl)) == u32), (_vl)->val.u32)
149: #define AIT_GET_U64(_vl) (assert((_vl)), assert(AIT_TYPE((_vl)) == u64), (_vl)->val.u64)
150: #define AIT_GET_I8(_vl) (assert((_vl)), assert(AIT_TYPE((_vl)) == i8), (_vl)->val.i8)
151: #define AIT_GET_I16(_vl) (assert((_vl)), assert(AIT_TYPE((_vl)) == i16), (_vl)->val.i16)
152: #define AIT_GET_I32(_vl) (assert((_vl)), assert(AIT_TYPE((_vl)) == i32), (_vl)->val.i32)
153: #define AIT_GET_I64(_vl) (assert((_vl)), assert(AIT_TYPE((_vl)) == i64), (_vl)->val.i64)
1.11.2.6 misho 154: #define AIT_GET_F32(_vl) (assert((_vl)), assert(AIT_TYPE((_vl)) == f32), (_vl)->val.f32)
155: #define AIT_GET_F64(_vl) (assert((_vl)), assert(AIT_TYPE((_vl)) == f64), (_vl)->val.f64)
1.11.2.1 misho 156:
157: #define AIT_SET_BUF(_vl, _v, _len) do { ait_val_t *__val = (_vl); assert(__val); assert((_v)); \
158: __val->val.buffer = malloc(_len); \
159: if (__val->val.buffer) { \
1.11.2.3 misho 160: __val->val_type = buffer; AIT_LEN(__val) = _len; \
1.11.2.1 misho 161: memcpy(__val->val.buffer, (_v), _len); \
162: } } while (0)
1.11.2.12 misho 163: #define AIT_SET_STR(_vl, _v) do { ait_val_t *__val = (_vl); assert(__val); assert((_v)); \
1.11.2.1 misho 164: __val->val.string = (int8_t*) strdup((_v)); \
165: if (__val->val.string) { \
1.11.2.3 misho 166: __val->val_type = string; \
1.11.2.1 misho 167: AIT_LEN(__val) = strlen((_v)) + 1; \
168: } } while (0)
169: #define AIT_SET_BLOB(_vl, _n, _len) do { ait_val_t *__val = (_vl); assert(__val); \
1.11.2.3 misho 170: __val->val_type = blob; AIT_LEN(__val) = _len; \
1.11.2.1 misho 171: __val->val.blob = _n; } while (0)
172: #define AIT_SET_BLOB2(_vl, _bv) do { ait_val_t *__val = (_vl); assert(__val); assert((_bv)); \
1.11.2.3 misho 173: __val->val_type = blob; AIT_LEN(__val) = (_bv)->blob_len; \
1.11.2.1 misho 174: __val->val.blob = (_bv)->blob_var; } while (0)
1.11.2.11 misho 175: #define AIT_NEW_BLOB(_vl, _len) AIT_SET_BLOB((_vl), 0, _len)
1.11.2.1 misho 176:
177: #define AIT_SET_U8(_vl, _n) do { ait_val_t *__val = (_vl); assert(__val); \
1.11.2.3 misho 178: __val->val_type = u8; __val->val.u8 = _n; \
1.11.2.1 misho 179: AIT_LEN(__val) = sizeof(uint8_t); } while (0)
180: #define AIT_SET_U16(_vl, _n) do { ait_val_t *__val = (_vl); assert(__val); \
1.11.2.3 misho 181: __val->val_type = u16; __val->val.u16 = _n; \
1.11.2.1 misho 182: AIT_LEN(__val) = sizeof(uint16_t); } while (0)
183: #define AIT_SET_U32(_vl, _n) do { ait_val_t *__val = (_vl); assert(__val); \
1.11.2.3 misho 184: __val->val_type = u32; __val->val.u32 = _n; \
1.11.2.1 misho 185: AIT_LEN(__val) = sizeof(uint32_t); } while (0)
186: #define AIT_SET_U64(_vl, _n) do { ait_val_t *__val = (_vl); assert(__val); \
1.11.2.3 misho 187: __val->val_type = u64; __val->val.u64 = _n; \
1.11.2.1 misho 188: AIT_LEN(__val) = sizeof(uint64_t); } while (0)
189: #define AIT_SET_I8(_vl, _n) do { ait_val_t *__val = (_vl); assert(__val); \
1.11.2.3 misho 190: __val->val_type = i8; __val->val.i8 = _n; \
1.11.2.1 misho 191: AIT_LEN(__val) = sizeof(int8_t); } while (0)
192: #define AIT_SET_I16(_vl, _n) do { ait_val_t *__val = (_vl); assert(__val); \
1.11.2.3 misho 193: __val->val_type = i16; __val->val.i16 = _n; \
1.11.2.1 misho 194: AIT_LEN(__val) = sizeof(int16_t); } while (0)
195: #define AIT_SET_I32(_vl, _n) do { ait_val_t *__val = (_vl); assert(__val); \
1.11.2.3 misho 196: __val->val_type = i32; __val->val.i32 = _n; \
1.11.2.1 misho 197: AIT_LEN(__val) = sizeof(int32_t); } while (0)
198: #define AIT_SET_I64(_vl, _n) do { ait_val_t *__val = (_vl); assert(__val); \
1.11.2.3 misho 199: __val->val_type = i64; __val->val.i64 = _n; \
1.11.2.1 misho 200: AIT_LEN(__val) = sizeof(int64_t); } while (0)
1.11.2.6 misho 201: #define AIT_SET_F32(_vl, _n) do { ait_val_t *__val = (_vl); assert(__val); \
202: __val->val_type = f32; __val->val.f32 = _n; \
203: AIT_LEN(__val) = sizeof(float); } while (0)
204: #define AIT_SET_F64(_vl, _n) do { ait_val_t *__val = (_vl); assert(__val); \
205: __val->val_type = f64; __val->val.f64 = _n; \
206: AIT_LEN(__val) = sizeof(double); } while (0)
1.11.2.1 misho 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: /*
1.11.2.6 misho 238: * io_vals2buffer() Marshaling data from array with variables to buffer
239: * @buf = Buffer
240: * @buflen = Size of buffer
241: * @vars = Variable array
242: * return: -1 error, 0 nothing done or >0 size of marshaled data
243: */
1.11.2.9 misho 244: int io_vals2buffer(unsigned char *buf, int buflen, array_t *vars);
1.11.2.6 misho 245: /*
246: * io_buffer2vals() De-marshaling data from buffer to array with variables
247: * @buf = Buffer
248: * @buflen = Size of buffer
249: * @vnum = Number of variables into buffer
250: * @zcpy = Zero-copy for variables, if !=0 don't use io_arrayFree() for free variables and
251: *DON'T MODIFY OR DESTROY BUFFER*. =0 call io_arrayFree() before io_arrayDestroy()
252: * return: =NULL error, !=NULL allocated variable array, after use must free with io_arrayDestroy()
253: */
254: array_t *io_buffer2vals(unsigned char *buf, int buflen, int vnum, int zcpy);
1.11.2.13 misho 255: /*
256: * io_vals2map() Marshaling data from array with variables to memory map
257: * @buf = Buffer
258: * @buflen = Size of buffer
259: * @vars = Variable array
260: * return: -1 error, 0 nothing done or >0 size of marshaled data
261: */
262: int io_vals2map(u_char *buf, int buflen, array_t *vars);
263: /*
264: * io_map2vals() De-marshaling data from memory map to array with variables
265: * @buf = Buffer
266: * @buflen = Size of buffer
267: * @vnum = Number of variables into buffer
268: * @zcpy = Zero-copy for variables, if !=0 don't use io_arrayFree() for free variables and
269: *DON'T MODIFY OR DESTROY BUFFER*. =0 call io_arrayFree() before io_arrayDestroy()
270: * return: =NULL error, !=NULL allocated variable array, after use must free with io_arrayDestroy()
271: */
272: array_t *io_map2vals(u_char *buf, int buflen, int vnum, int zcpy);
1.11.2.6 misho 273:
274: /*
1.1 misho 275: * ioPromptRead() Read data from input h[0] with prompt to output h[1]
276: * @h = file handles h[0] = input, h[1] = output, if NULL use stdin, stdout
277: * @csPrompt = Prompt before input, may be NULL
278: * @psData = Readed data
279: * @dataLen = Length of data
280: * return: 0 EOF; -1 error:: can`t read; >0 count of readed chars
281: */
282: int ioPromptRead(int *h, const char *csPrompt, char * __restrict psData, int dataLen);
283: /*
284: * ioPromptPassword() Read password from input h[0] with prompt to output h[1]
285: * @h = file handles h[0] = input, h[1] = output, if NULL use stdin, stdout
286: * @csPrompt = Prompt before input, may be NULL
287: * @psPass = Readed password
288: * @passLen = Length of password
289: * @confirm = Confirm password, 0 - get password, !=0 Ask for confirmation
290: * return: 0 EOF; -1 error:: can`t read; >0 count of readed chars
291: */
292: int ioPromptPassword(int *h, const char *csPrompt, char * __restrict psPass, int passLen, int confirm);
293:
294: /*
295: * ioRegexVerify() Function for verify data match in regex expression
296: * @csRegex = Regulare expression pattern
297: * @csData = Data for check and verify
298: * @startPos = Return start positions
299: * @endPos = Return end positions
300: * return: NULL not match or error; !=NULL begin of matched data
301: */
302: const char *ioRegexVerify(const char *csRegex, const char *csData, int *startPos, int *endPos);
303: /*
304: * ioRegexGet() Function for get data match in regex expression
305: * @csRegex = Regulare expression pattern
306: * @csData = Data from get
307: * @psString = Returned string if match
308: * @strLen = Length of string
309: * return: 0 not match; >0 count of returned chars
310: */
311: int ioRegexGet(const char *csRegex, const char *csData, char * __restrict psString, int strLen);
312: /*
313: * ioRegexReplace() Function for replace data match in regex expression with newdata
314: * @csRegex = Regulare expression pattern
315: * @csData = Source data
316: * @csNew = Data for replace
317: * return: NULL not match or error; !=NULL allocated new string, must be free after use!
318: */
319: char *ioRegexReplace(const char *csRegex, const char *csData, const char *csNew);
320:
1.2 misho 321: /*
1.6 misho 322: * ioVarAst() Function for evaluate string like asterisk variable "{text[:[-]#[:#]]}"
323: * @csString = Input string
324: * return: NULL error, !=NULL Allocated new string evaluated from input string, must be free()
325: */
326: char *ioVarAst(const char *csString);
327:
328: /*
1.2 misho 329: * io_Path2File() Parse and make path/filename pair
330: * @csArgs = Input argument line
331: * @psPath = Output Path, if ==NULL path not returned
332: * @pathLen = Size of path array
333: * @psFile = Output File
334: * @fileLen = Size of file array
335: * return: 0 error format; -1 error:: can`t read; >0 ok, number of readed items
336: */
337: inline int io_Path2File(const char * __restrict csArgs, char * __restrict psPath, int pathLen,
338: char * __restrict psFile, int fileLen);
339:
340: /*
1.4 misho 341: * io_UnquotStr() Remove quots from input text string
342: * @psLine = Text string
343: * return: 0 nothing to do; 1 successful unquoted string
344: */
1.5 misho 345: inline int io_UnquotStr(unsigned char * __restrict psLine);
1.4 misho 346: /*
347: * io_LTrimStr() Remove left whitespaces from text string
348: * @psLine = Text string
349: * return: 0 nothing to do; !=0 Removed bytes
350: */
1.5 misho 351: inline int io_LTrimStr(unsigned char * __restrict psLine);
1.4 misho 352: /*
353: * io_RTrimStr() Remove right whitespaces from text string
354: * @psLine = Text string
355: * return: 0 nothing to do; !=0 Removed bytes
356: */
1.5 misho 357: inline int io_RTrimStr(unsigned char * __restrict psLine);
1.4 misho 358: /*
359: * io_TrimStr() Remove left and right whitespaces from text string
360: * @psLine = Text string
361: * return: 0 nothing to do; !=0 Removed bytes
362: */
1.5 misho 363: inline int io_TrimStr(unsigned char * __restrict psLine);
1.4 misho 364: /*
1.5 misho 365: * io_Ch2Hex() Convert from Char string to Hex string
1.4 misho 366: * @psLine = Text string
367: * @lineLen = Length of Text string
1.5 misho 368: * return: NULL nothing to do or error; !=0 Allocated new converted data without term\0 (must be free)
1.4 misho 369: */
1.5 misho 370: inline unsigned char *io_Ch2Hex(unsigned char *psLine, int lineLen);
1.4 misho 371: /*
1.5 misho 372: * io_Hex2Ch() Convert from Hex string to Char string
1.4 misho 373: * @psLine = Text string
374: * @lineLen = Length of Text string
375: * return: NULL nothing to do or error; !=0 Allocated new converted string(must be free)
376: */
1.5 misho 377: inline char *io_Hex2Ch(unsigned char *psLine, int lineLen);
1.4 misho 378:
379: /*
1.8 misho 380: * io_arrayInit() - Create and initialize dynamic array
381: * @numItems = Number of Items
382: * return: NULL error, != NULL allocated memory for array
383: */
384: inline array_t *io_arrayInit(int numItems);
385: /*
1.10 misho 386: * io_arrayDestroy() - Free and destroy dynamic array
1.8 misho 387: * @parr = Array
388: * return: none
389: */
390: inline void io_arrayDestroy(array_t ** __restrict parr);
391: /*
1.10 misho 392: * io_arrayFree() - Free all data in dynamic array items
1.8 misho 393: * (WARNING! If assign static array dont use this!!!)
394: * @arr = Array
395: * return: none
396: */
397: inline void io_arrayFree(array_t * __restrict arr);
398: /*
1.10 misho 399: * io_arrayFrom() - Create and fill array from array with pointers
1.11 misho 400: * @pargv = Array with pointers
1.10 misho 401: * @argc = Number of Items, if 0 walk through argv and stop when reach NULL item
1.11 misho 402: * return: NULL error, != NULL allocated new array
1.10 misho 403: */
1.11 misho 404: inline array_t *io_arrayFrom(const char *** __restrict pargv, int argc);
1.10 misho 405: /*
406: * io_arrayTo() - Create and fill array with pointers from dynamic array
407: * @arr = Array
1.11 misho 408: * return: NULL error, != NULL allocated memory for array, NULL terminated
1.10 misho 409: */
410: inline char **io_arrayTo(array_t * __restrict arr);
411: /*
1.8 misho 412: * io_arrayLen() - Get last used element in dynamic array (array Length)
413: * @arr = Array
414: * return: -1 error, 0 empty or >0 position of last used element
415: */
416: inline int io_arrayLen(array_t * __restrict arr);
417: /*
1.10 misho 418: * io_arrayConcat() Concat source array to destination array
419: * @dest = Destination array
420: * @src = Source array
421: * return: -1 error; >0 new count of destination array
422: */
423: int io_arrayConcat(array_t * __restrict dest, array_t * __restrict src);
424: /*
1.11.2.7 misho 425: * io_arrayCopy() Copy source array to destination array
426: * @dest = Destination array, after use free with io_arrayDestroy()
427: * @src = Source array
428: * return: -1 error; >0 count of destination array
429: */
430: int io_arrayCopy(array_t ** __restrict dest, array_t * __restrict src);
431: /*
1.8 misho 432: * io_arrayGrow() - Grow/Shrink dynamic array, Use with care when it shrink!!!
433: * @arr = Array
434: * @newNumItems = Number of Items
1.11.2.6 misho 435: * @freeShrink = Free elements before shrink array
1.8 misho 436: * return: -1 error, 0 ok
437: */
1.11.2.6 misho 438: int io_arrayGrow(array_t * __restrict arr, int newNumItems, int freeShrink);
1.8 misho 439: /*
440: * io_arrayVacuum() - Vacuum dynamic array, empty elements will be deleted
441: * @arr = Array
442: * @fromWhere = 1 begin, 2 ALL empty elements
443: * return: -1 error, 0 ok
444: */
445: int io_arrayVacuum(array_t * __restrict arr, int fromWhere);
446:
1.11.2.10 misho 447: #define io_arraySize(_arr) ((_arr) ? (_arr)->arr_num : 0)
1.11.2.6 misho 448: #define io_arrayZero(_arr) (assert((_arr)), memset((_arr)->arr_data, 0, \
449: io_arraySize((_arr)) * sizeof(void*)))
1.8 misho 450:
1.11 misho 451: #define io_arrayGet(_arr, _d) (assert((_arr) && (_arr)->arr_num > _d), *((_arr)->arr_data + _d))
452: #define io_array(_arr, _d, _type) (assert((_arr) && (_arr)->arr_num > _d), \
453: ((_type) *((_arr)->arr_data + _d)))
1.8 misho 454: #define io_arraySet(_arr, _d, _ptr) do { \
1.11 misho 455: assert((_arr) && (_arr)->arr_num > _d); \
456: *((_arr)->arr_data + _d) = (void*) (_ptr); \
1.8 misho 457: } while (0)
1.11 misho 458: #define io_arrayDel(_arr, _d, _fri) do { \
459: assert((_arr) && (_arr)->arr_num > _d); \
460: if (_fri) \
461: free(*((_arr)->arr_data + _d)); \
462: *((_arr)->arr_data + _d) = NULL; \
1.9 misho 463: } while (0)
1.8 misho 464:
465: /*
466: * io_arrayPush() - Push element into dynamic array like stack manner, place at first empty position
467: * @arr = Array
468: * @data = Element, if set NULL return only first empty position
469: * return: -1 not found empty position, array is full!, >-1 return position of stored element into array
470: */
471: inline int io_arrayPush(array_t * __restrict arr, void **data);
472: /*
473: * io_arrayPop() - Pop element from dynamic array like stack manner, last used position
474: * @arr = Array
1.11 misho 475: * @data = Element, if set NULL return only last used position
1.8 misho 476: * @delAfter = Delete after Pop element, !=0 delete element from array after return data
477: * return: -1 not found used position, array is empty!, >-1 return element position
478: */
479: inline int io_arrayPop(array_t * __restrict arr, void ** __restrict data, int delAfter);
480:
481: /*
482: * io_argsNum() Parse and calculate number of arguments
483: * @csArgs = Input arguments line
484: * @csDelim = Delimiter(s) for separate
485: * return: 0 error format; -1 error:: can`t read; >0 ok, number of items
486: */
487: inline int io_argsNum(const char *csArgs, const char *csDelim);
488:
489: /*
490: * io_arrayMake() Parse and make array from arguments ... (input string will be modified!!!
491: * and output array must be free with io_arrayDestroy() after use!)
492: * @psArgs = Input arguments line, after execute string is modified!!!
493: * @nargs = Maximum requested count of arguments from input string psArgs, if 0 all psArgs
494: * @csDelim = Delimiter(s) for separate
495: * @parr = Output array of arguments ... (must be free with io_arrayDestroy() after use!)
496: * return: 0 error format; -1 error:: can`t read; >0 ok, number of readed items
497: */
498: int io_arrayMake(char * __restrict psArgs, int nargs, const char *csDelim,
499: array_t ** __restrict parr);
500:
501: /*
502: * io_MakeAV() Parse and make attribute/value pair
503: * @csArgs = Input argument line
504: * @csDelim = Delimiter for separate
505: * @psAttr = Output Attribute
506: * @attrLen = Size of attribute array
507: * @psValue = Output Value, if ==NULL this element not present value or not wanted for return
508: * @valLen = Size of value array
509: * return: 0 error format; -1 error:: can`t read; >0 ok, number of readed items
510: */
511: int io_MakeAV(const char * __restrict csArgs, const char *csDelim,
512: char * __restrict psAttr, int attrLen, char * __restrict psValue, int valLen);
513:
1.9 misho 514: /*
515: * io_sarrInit() - Create and initialize dynamic split-order array
516: * @numItems = Number of Items
517: * @segLen = Length of segment
518: * return: NULL error, != NULL allocated memory for array
519: */
520: inline sarr_t *io_sarrInit(int numItems, int segLen);
521: /*
522: * io_sarrDestroy() - Free all data in dynamic split-order array and Destroy array
523: * @parr = Array
524: * return: none
525: */
526: inline void io_sarrDestroy(sarr_t ** __restrict parr);
527: /*
528: * io_sarrGrow() - Grow/Shrink dynamic split-order array, Use with care when it shrink!!!
529: * @arr = Array
530: * @newNumItems = Number of Items
531: * return: -1 error, 0 ok
532: */
533: int io_sarrGrow(sarr_t * __restrict arr, int newNumItems);
534: /*
535: * io_sarrVacuum() - Vacuum dynamic split-order array, empty segments will be freed
536: * @arr = Array
537: * return: -1 error, >-1 freed segments
538: */
539: inline int io_sarrVacuum(sarr_t * __restrict arr);
1.11.2.10 misho 540: #define io_sarrSize(_arr) ((_arr) ? (_arr)->sarr_num : 0)
1.11.2.8 misho 541: #define io_sarrSeg(_arr) (assert((_arr)), (_arr)->sarr_seg)
542: /*
543: * io_sarrCopy() Copy source split array to destination split array
544: * @dest = Destination split array, after use free with io_sarrDestroy()
545: * @src = Source split array
546: * return: -1 error; >0 count of destination split array
547: */
548: int io_sarrCopy(sarr_t ** __restrict dest, sarr_t * __restrict src);
1.9 misho 549: /*
550: * io_sarrGet() - Get element from dynamic split-order array
551: * @arr = Array
552: * @idx = Index (warning 1st element is at position 1)
553: * return: NULL not found, !=NULL element
554: */
555: inline void *io_sarrGet(sarr_t * __restrict arr, unsigned int idx);
556: /*
557: * io_sarrGet2() - Always get element from dynamic split-order array
558: * Function automatic grow array. Good use for Hash tables!
559: * @arr = Array
560: * @idx = Index (warning 1st element is at position 1)
561: * return: NULL not found, !=NULL element
562: */
563: void *io_sarrGet2(sarr_t * __restrict arr, unsigned int idx);
564: /*
565: * io_sarrSet() - Set element to dynamic split-order array
566: * @arr = Array
567: * @idx = Index (warning 1st element is at position 1)
568: * @data = Value
569: * return: NULL error or empty, !=NULL old value in element
570: */
571: inline void *io_sarrSet(sarr_t * __restrict arr, unsigned int idx, void *data);
1.11 misho 572: #define io_sarrDel(_arr, _idx) io_sarrSet((_arr), _idx, NULL)
573: #define io_sarr(_arr, _idx, _type) (_type)io_sarrGet((_arr), _idx)
574: /*
575: * io_sarr2array() - Convert from split-order array to dynamic array
576: * @sa = split array
577: * @sarrFree = after convert split array !=0 will be destroyed sarray
578: * return: NULL error or != NULL new array
579: */
580: array_t *io_sarr2array(sarr_t ** __restrict sa, int sarrFree);
581: /*
582: * io_array2sarr() - Convert from dynamic array to split-order array
583: * @a = array
584: * @segLen = Length of segment
585: * @arrFree = after convert array !=0 will be destroyed
586: * return: NULL error or != NULL new sarr
587: */
588: sarr_t *io_array2sarr(array_t ** __restrict a, int segLen, int arrFree);
1.8 misho 589:
590: /*
1.10 misho 591: * io_CopyEnv() Copy environment to new environment array;
592: * @oldenv = Environment array
593: * return: NULL error; !=NULL Allocated new environment array(must be free)
594: */
595: char **io_CopyEnv(const char **oldenv);
596: /*
597: * io_ExecArgs() Build exec arguments from other array
598: * @psProg = Program name for execute
599: * @oldarg = Arguments array
600: * return: NULL error; !=NULL Allocated execution array(must be free)
601: */
602: char **io_ExecArgs(const char *psProg, const char **oldarg);
603: /*
604: * io_FreeNullTerm() Free dynamic allocated null terminated array with strings
605: * @arr = Pointer to array for free
606: * return: none
607: */
608: inline void io_FreeNullTerm(char *** __restrict arr);
609:
610: /*
1.2 misho 611: * ioURLGet() Parse and get data from input URL
612: * @csURL = Input URL line
613: * @url = Output parsed URL
614: * return: 0 error format not find tech:// and return URL like path;
615: -1 error:: can`t read; >0 ok, up bits for known elements
616: */
617: int ioURLGet(const char *csURL, struct tagIOURL *url);
618: /*
619: * ioURLGetValue() Get value from parsed URL
620: * @url = Input parsed URL
621: * @csAttr = Attribute for search
622: * @psValue = Return value of attribute, if ==NULL only check for existence of attribute
623: * @valLen = Size of psValue array
624: * return: 0 error attribute not find; -1 error:: can`t read; >0 ok, find at position
625: */
626: int ioURLGetValue(struct tagIOURL *url, const char *csAttr, char * __restrict psValue, int valLen);
627: /*
628: * ioURLGetFile() Get file from parsed URL
629: * @url = Input parsed URL
630: * @psValue = Return filename, if not specified file in url path, replace with /
631: * @valLen = Size of psValue array
632: * return: -1 error:: can`t read; 0 ok
633: */
634: int ioURLGetFile(struct tagIOURL *url, char * __restrict psValue, int valLen);
635:
1.3 misho 636:
637: /*
1.6 misho 638: * ioXMLGet() Parse and get data from input XML request string [ns:]container[|attribute[=value]][?data]
639: * @csXML = Input XML request line
640: * @xml = Output parsed XML request
641: * return: 0 error format incorrect, -1 error:: can`t read; >0 ok readed elements bits
642: */
643: int ioXMLGet(const char *csXML, struct tagReqXML *xml);
644:
645:
646: /*
1.5 misho 647: * ioMkDir() Function for racursive directory creation and validation
648: * @csDir = Full directory path
649: * @mode = Mode for directory creation if missing dir
650: * return: -1 error, 0 directory path exist, >0 created missing dirs
651: */
652: int ioMkDir(const char *csDir, int mode);
653:
1.6 misho 654: /*
655: * ioWatchDirLoop() Function for watching changes in directory and fire callback
656: * @csDir = Full directory path
657: * @callback = Callback if raise event! nOp -1 delete, 0 change/move, 1 create
658: * return: -1 error, !=-1 ok, number of total signaled events
659: */
660: int ioWatchDirLoop(const char *csDir, int (*callback)(const char *csName, int nOp));
661:
1.5 misho 662:
663: /*
664: * io_rread() Raw VFS read function
665: * @fd = File handle
666: * @buf = Read buffer
667: * @nbytes = Read buffer size
668: * @offset = Read from position, if -1 read nbytes from current position
669: * @update = Update file handle position !0
670: * return: -1 error or !=-1 readed bytes
671: */
672: inline int io_rread(int fd, void * __restrict buf, size_t nbytes, off_t offset, int update);
673: /*
674: * io_rwrite() Raw VFS write function
675: * @fd = File handle
676: * @buf = Write buffer
677: * @nbytes = Write bytes from buffer
678: * @offset = Write at position, if -1 write nbytes from current position
679: * @update = Update file handle position !0
680: * return: -1 error or !=-1 writed bytes
681: */
682: inline int io_rwrite(int fd, void * __restrict buf, size_t nbytes, off_t offset, int update);
683:
684: /* Disk I/O helper macros */
685: #define io_read(f, b, n) io_rread(f, b, n, -1, 1)
686: #define io_write(f, b, n) io_rwrite(f, b, n, -1, 1)
687:
688:
689: /* Debug helper macros */
690: extern int io_Debug;
691:
692: #define io_initDebug(x) io_Debug = (x);
693: #define io_addDebug io_Debug++
694: #define ioDEBUG(x, fmt, ...) do { \
695: assert((fmt)); \
696: char str[STRSIZ] = { 0 }; \
1.11 misho 697: snprintf(str, sizeof str, (fmt), ##__VA_ARGS__); \
1.5 misho 698: if ((x) <= io_Debug) \
699: syslog(LOG_DEBUG, "ioDebug(%d):%s(%d): %s\n", \
700: (x), __func__, __LINE__, str); \
701: } while (0)
702:
703: #define ioERROR(x, fmt, ...) do { \
704: assert((fmt)); \
705: char str[STRSIZ] = { 0 }; \
1.11 misho 706: snprintf(str, sizeof str, (fmt), ##__VA_ARGS__); \
1.5 misho 707: syslog(LOG_ERR, "ioError():%s(%d): #%d - %s\n", \
708: __func__, __LINE__, (x), str); \
709: } while (0)
710: #define io_sysERROR(x) do { \
711: if (x > 0 || errno) \
712: syslog(LOG_ERR, "ioError(sys):%s(%d): #%d - %s\n", \
713: __func__, __LINE__, x > 0 ? x : errno, \
714: strerror(x > 0 ? x : errno)); \
715: } while (0)
716: #define io_aitERROR(ait) do { \
717: if (ait##_GetErrno()) \
718: syslog(LOG_ERR, "ioError(ait):%s(%d): #%d - %s\n", \
719: __func__, __LINE__, ait##_GetErrno(), \
720: ait##_GetError()); \
721: } while (0)
1.3 misho 722:
1.1 misho 723:
1.7 misho 724: /* Crypto framework */
725:
726: /*
727: * ioCipher() Cipher wrapper for all supported crypto algorythms
728: * @pInput = input buffer
729: * @inLen = input buffer len
730: * @ppOutput = output allocated buffe, must be free after use
731: * @Cipher = cipher engine, like EVP_bf_cbc() or etc...
732: * @pKey = key
733: * @pIV = IV, salt (8 bytes)
734: * @nMode = Mode 0 - decrypting or 1 - encrypting
735: * return: 0 not present data or error!; >0 number of processed and returned bytes into ppOutput
736: */
737: int ioCipher(unsigned char *pInput, int inLen, unsigned char **ppOutput, const EVP_CIPHER *Cipher,
738: unsigned char *pKey, unsigned char *pIV, int nMode);
739:
740: /*
741: * io_Blowfish() Blowfish cipher algorythm, work with ASCII hex strings
742: * @pInput = input buffer
743: * @inLen = input buffer len
744: * @ppOutput = output allocated buffe, must be free after use
745: * @pKey = key
746: * @pIV = IV, salt (8 bytes)
747: * @nMode = Mode 0 - decrypting or 1 - encrypting
748: * return: 0 not present data or error!; >0 number of processed and returned bytes into ppOutput
749: */
1.8 misho 750: int io_Blowfish(unsigned char *pInput, int inLen, unsigned char **ppOutput,
751: unsigned char *pKey, unsigned char *pIV, int nMode);
1.7 misho 752:
753:
1.11.2.14 misho 754: /*
1.11.2.16 misho 755: * ioAllocPTY() Allocate new PTY and TTY
1.11.2.14 misho 756: * @ptyfd = master fd, pty
757: * @ttyfd = slave fd, tty
758: * @name = tty device name if not null
759: * @namesiz = name length, must be above 63 bytes.
760: * @term = termios for terminal
761: * @winz = winsize for terminal
762: * return: -1 error or 0 ok
763: */
764: inline int ioAllocPTY(int *ptyfd, int *ttyfd, char * __restrict name, int namesiz,
765: struct termios * __restrict term, struct winsize * __restrict winz);
766: /*
1.11.2.16 misho 767: * ioFreeTTY() Release TTY
1.11.2.14 misho 768: * @ttyname = tty filename
769: * return: none
770: */
1.11.2.16 misho 771: inline void ioFreeTTY(const char *ttyname);
1.11.2.15 misho 772: /*
773: * ioChgWinPTY() Change window size of PTY
774: * @ptyfd = master fd, pty
775: * @row = row
776: * @col = col
777: * @xpxl = x pixels
778: * @ypxl = y pixels
779: * return: -1 error or 0 ok
780: */
781: inline int ioChgWinPTY(int ptyfd, u_short row, u_short col, u_short xpxl, u_short ypxl);
782: /*
1.11.2.16 misho 783: * ioSetOwnerTTY() Set owner to TTY
1.11.2.15 misho 784: * @ttyname = tty filename
785: * @UID = uid
786: * @GID = gid
787: * return: -1 error or 0 ok
788: */
1.11.2.16 misho 789: int ioSetOwnerTTY(const char *ttyname, uid_t UID, gid_t GID);
790: /*
791: * ioSetSidTTY() Makes the process's controlling TTY and sets it to sane modes.
792: * @ttyfd = slave fd, tty
793: * @ttyname = tty filename
794: * return: -1 error or 0 ok
795: */
796: int ioSetSidTTY(int *ttyfd, const char *ttyname);
1.11.2.17 misho 797: /*
798: * ioSetRAWMode() Enter into RAW mode
799: * @fd = tty fd
800: * @otio = saved old termios for later restore if !=NULL
801: * return: -1 error or 0 ok
802: */
803: inline int ioSetRAWMode(int fd, struct termios *otio);
804: /*
805: * ioRestoreMode() Restore termios to tty fd
806: * @fd = tty fd
807: * @tio = termios structure for restore
808: * return: -1 error or 0 ok
809: */
810: inline int ioRestoreMode(int fd, struct termios tio);
1.11.2.18! misho 811: /*
! 812: * ioForkPTY() Fork new process with session leader and new TTY
! 813: * @ptyfd = master fd, pty
! 814: * @name = tty device name if not null
! 815: * @namesiz = name length, must be above 63 bytes.
! 816: * @term = termios for terminal
! 817: * @winz = winsize for terminal
! 818: * @otio = old termios structure for restore
! 819: * return: -1 error, 0 child process or >0 parent: pid of child
! 820: */
! 821: pid_t ioForkPTY(int *ptyfd, char * __restrict name, int namesiz, struct termios * __restrict term,
! 822: struct winsize * __restrict winz, struct termios * __restrict otio);
1.11.2.14 misho 823:
824:
1.1 misho 825: #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