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