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