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