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