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