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