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