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