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