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