Annotation of libaitio/inc/aitio.h, revision 1.14.2.3
1.1 misho 1: /*************************************************************************
1.8 misho 2: * (C) 2010 AITNET ltd - Sofia/Bulgaria - <misho@aitnet.org>
3: * by Michael Pounov <misho@elwix.org>
1.1 misho 4: *
5: * $Author: misho $
1.14.2.3! misho 6: * $Id: aitio.h,v 1.14.2.2 2012/02/24 14:10:09 misho Exp $
1.1 misho 7: *
1.8 misho 8: **************************************************************************
9: The ELWIX and AITNET software is distributed under the following
10: terms:
11:
12: All of the documentation and software included in the ELWIX and AITNET
13: Releases is copyrighted by ELWIX - Sofia/Bulgaria <info@elwix.org>
14:
15: Copyright 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
16: by Michael Pounov <misho@elwix.org>. All rights reserved.
17:
18: Redistribution and use in source and binary forms, with or without
19: modification, are permitted provided that the following conditions
20: are met:
21: 1. Redistributions of source code must retain the above copyright
22: notice, this list of conditions and the following disclaimer.
23: 2. Redistributions in binary form must reproduce the above copyright
24: notice, this list of conditions and the following disclaimer in the
25: documentation and/or other materials provided with the distribution.
26: 3. All advertising materials mentioning features or use of this software
27: must display the following acknowledgement:
28: This product includes software developed by Michael Pounov <misho@elwix.org>
29: ELWIX - Embedded LightWeight unIX and its contributors.
30: 4. Neither the name of AITNET nor the names of its contributors
31: may be used to endorse or promote products derived from this software
32: without specific prior written permission.
33:
34: THIS SOFTWARE IS PROVIDED BY AITNET AND CONTRIBUTORS ``AS IS'' AND
35: ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
36: IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
37: ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
38: FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
39: DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
40: OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
41: HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
42: LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
43: OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
44: SUCH DAMAGE.
45: */
1.1 misho 46: #ifndef __AITIO_H
47: #define __AITIO_H
48:
49:
1.12 misho 50: #define COMPAT_43TTY
51:
1.8 misho 52: #include <assert.h>
1.7 misho 53: #include <openssl/evp.h>
1.12 misho 54: #include <openssl/aes.h>
55: #include <sys/tty.h>
56: #include <sys/ioctl_compat.h>
1.13 misho 57: #include <sys/socket.h>
58: #include <sys/un.h>
59: #include <net/if_dl.h>
60: #include <netinet/in.h>
1.7 misho 61:
62:
1.8 misho 63: #define VACUUM_LEFT 1
64: #define VACUUM_BETWEEN 2
65:
1.12 misho 66: /* AIT arrays */
1.8 misho 67:
1.9 misho 68: typedef void ** sarr_seg_t;
69: typedef struct _tagSplitArray {
70: int sarr_num;
71: int sarr_seg;
72: int sarr_siz;
73: sarr_seg_t *sarr_data;
74: } sarr_t;
75:
1.8 misho 76: typedef struct _tagArray {
77: int arr_num;
78: void **arr_data;
79: } array_t;
80:
1.12 misho 81: /* 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.12 misho 118: #define AIT_BLOB_CHUNKS(_vl, _n) (assert((_vl)), AIT_LEN((_vl)) / _n + (AIT_LEN((_vl)) % _n) ? 1 : 0)
119: #define AIT_ISEMPTY(_vl) (assert((_vl)), AIT_TYPE((_vl)) == empty)
120:
1.14 misho 121: #define AIT_GET_LIKE(_vl, _type) (assert((_vl)), (_type) (_vl)->val.net)
122:
123: #define AIT_GET_PTR(_vl) (assert((_vl)), assert(AIT_TYPE((_vl)) == ptr), (_vl)->val.ptr)
124: #define AIT_GET_PTR2(_vl) (assert((_vl)), (_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.1 misho 238: // io_GetErrno() Get error code of last operation
239: inline int io_GetErrno();
240: // io_GetError() Get error text of last operation
241: inline const char *io_GetError();
242:
243:
244: /*
1.12 misho 245: * io_ether_ntoa() Convert ethernet address to string
246: * @n = ethernet address structure, like struct ether_addr
247: * @a = string
248: * @len = string length
249: * return: NULL error or !=NULL string a
250: */
251: inline char *io_ether_ntoa(const struct io_ether_addr *n, char * __restrict a, int len);
252: /*
253: * io_ether_aton() Convert string to ethernet address
254: * @a = string
255: * @e = ethernet address structure, like struct ether_addr
256: * return: NULL error or !=NULL ethernet address structure
257: */
258: inline struct io_ether_addr *io_ether_aton(const char *a, struct io_ether_addr *e);
1.13 misho 259: /*
260: * io_n2port() Extract port from network structure
261: * @addr = Address
262: * return: 0 not supported family type or port number
263: */
264: inline u_short io_n2port(io_sockaddr_t * __restrict addr);
265: /*
266: * io_n2addr() Extract address from network structure
267: * @addr = Address
268: * @val = Value for store string address
269: * return: NULL error or !=NULL string address from val
270: */
271: const char *io_n2addr(io_sockaddr_t * __restrict addr, ait_val_t * __restrict val);
272: /*
273: * io_gethostbyname() Get host and port and make network structure
274: * @psHost = Hostname
275: * @port = Port
276: * @addr = Network address structure
277: * return: NULL error or !=NULL network structure
278: */
279: io_sockaddr_t *io_gethostbyname(const char *psHost, unsigned short port,
280: io_sockaddr_t * __restrict addr);
1.12 misho 281:
282: /*
1.13 misho 283: * io_vars2buffer() Marshaling data from array with variables to buffer
1.12 misho 284: * @buf = Buffer
285: * @buflen = Size of buffer
286: * @vars = Variable array
287: * return: -1 error, 0 nothing done or >0 size of marshaled data
288: */
1.13 misho 289: int io_vars2buffer(unsigned char *buf, int buflen, array_t *vars);
1.12 misho 290: /*
1.13 misho 291: * io_buffer2vars() De-marshaling data from buffer to array with variables
1.12 misho 292: * @buf = Buffer
293: * @buflen = Size of buffer
294: * @vnum = Number of variables into buffer
295: * @zcpy = Zero-copy for variables, if !=0 don't use io_arrayFree() for free variables and
296: *DON'T MODIFY OR DESTROY BUFFER*. =0 call io_arrayFree() before io_arrayDestroy()
297: * return: =NULL error, !=NULL allocated variable array, after use must free with io_arrayDestroy()
298: */
1.13 misho 299: array_t *io_buffer2vars(unsigned char *buf, int buflen, int vnum, int zcpy);
1.12 misho 300: /*
1.13 misho 301: * io_vars2map() Marshaling data from array with variables to memory map
1.12 misho 302: * @buf = Buffer
303: * @buflen = Size of buffer
304: * @vars = Variable array
305: * return: -1 error, 0 nothing done or >0 size of marshaled data
306: */
1.13 misho 307: int io_vars2map(unsigned char *buf, int buflen, array_t *vars);
1.12 misho 308: /*
1.13 misho 309: * io_map2vars() De-marshaling data from memory map to array with variables
1.12 misho 310: * @buf = Buffer
311: * @buflen = Size of buffer
312: * @vnum = Number of variables into buffer
313: * @zcpy = Zero-copy for variables, if !=0 don't use io_arrayFree() for free variables and
314: *DON'T MODIFY OR DESTROY BUFFER*. =0 call io_arrayFree() before io_arrayDestroy()
315: * return: =NULL error, !=NULL allocated variable array, after use must free with io_arrayDestroy()
316: */
1.13 misho 317: array_t *io_map2vars(unsigned char *buf, int buflen, int vnum, int zcpy);
318:
319: /*
1.14 misho 320: * io_allocVar() Allocate memory for variable
321: * return: NULL error or new variable, after use free variable with io_freeVar()
322: */
323: inline ait_val_t *io_allocVar(void);
324: /*
325: * io_freeVar() Free allocated memory for variable
326: * @val = Variable
327: * return: none
328: */
329: inline void io_freeVar(ait_val_t * __restrict val);
330: /*
1.13 misho 331: * io_allocVars() Allocate ait_val_t array
332: * @varnum = Number of variables
333: * return: =NULL error or !=NULL allocated array
334: */
335: inline array_t *io_allocVars(int varnum);
336: /*
337: * io_clrVars() Clear ait_val_t elements from array
338: * @vars = Variable array
339: * return: -1 error or size of array
340: */
341: inline int io_clrVars(array_t * __restrict vars);
342: /*
343: * io_freeVars() Free ait_val_t array
344: * @vars = Variable array
345: * return: none
346: */
347: inline void io_freeVars(array_t ** __restrict vars);
348:
1.12 misho 349:
350: /*
1.1 misho 351: * ioPromptRead() Read data from input h[0] with prompt to output h[1]
352: * @h = file handles h[0] = input, h[1] = output, if NULL use stdin, stdout
353: * @csPrompt = Prompt before input, may be NULL
354: * @psData = Readed data
355: * @dataLen = Length of data
356: * return: 0 EOF; -1 error:: can`t read; >0 count of readed chars
357: */
358: int ioPromptRead(int *h, const char *csPrompt, char * __restrict psData, int dataLen);
359: /*
360: * ioPromptPassword() Read password from input h[0] with prompt to output h[1]
361: * @h = file handles h[0] = input, h[1] = output, if NULL use stdin, stdout
362: * @csPrompt = Prompt before input, may be NULL
363: * @psPass = Readed password
364: * @passLen = Length of password
365: * @confirm = Confirm password, 0 - get password, !=0 Ask for confirmation
366: * return: 0 EOF; -1 error:: can`t read; >0 count of readed chars
367: */
368: int ioPromptPassword(int *h, const char *csPrompt, char * __restrict psPass, int passLen, int confirm);
369:
370: /*
371: * ioRegexVerify() Function for verify data match in regex expression
372: * @csRegex = Regulare expression pattern
373: * @csData = Data for check and verify
374: * @startPos = Return start positions
375: * @endPos = Return end positions
376: * return: NULL not match or error; !=NULL begin of matched data
377: */
378: const char *ioRegexVerify(const char *csRegex, const char *csData, int *startPos, int *endPos);
379: /*
380: * ioRegexGet() Function for get data match in regex expression
381: * @csRegex = Regulare expression pattern
382: * @csData = Data from get
383: * @psString = Returned string if match
384: * @strLen = Length of string
385: * return: 0 not match; >0 count of returned chars
386: */
387: int ioRegexGet(const char *csRegex, const char *csData, char * __restrict psString, int strLen);
388: /*
389: * ioRegexReplace() Function for replace data match in regex expression with newdata
390: * @csRegex = Regulare expression pattern
391: * @csData = Source data
392: * @csNew = Data for replace
393: * return: NULL not match or error; !=NULL allocated new string, must be free after use!
394: */
395: char *ioRegexReplace(const char *csRegex, const char *csData, const char *csNew);
396:
1.2 misho 397: /*
1.13 misho 398: * ioStrAst() Function for evaluate string like asterisk variable "{text[:[-]#[:#]]}"
1.6 misho 399: * @csString = Input string
400: * return: NULL error, !=NULL Allocated new string evaluated from input string, must be free()
401: */
1.13 misho 402: char *ioStrAst(const char *csString);
1.6 misho 403:
404: /*
1.4 misho 405: * io_UnquotStr() Remove quots from input text string
406: * @psLine = Text string
407: * return: 0 nothing to do; 1 successful unquoted string
408: */
1.5 misho 409: inline int io_UnquotStr(unsigned char * __restrict psLine);
1.4 misho 410: /*
411: * io_LTrimStr() Remove left whitespaces from text string
412: * @psLine = Text string
413: * return: 0 nothing to do; !=0 Removed bytes
414: */
1.5 misho 415: inline int io_LTrimStr(unsigned char * __restrict psLine);
1.4 misho 416: /*
417: * io_RTrimStr() Remove right whitespaces from text string
418: * @psLine = Text string
419: * return: 0 nothing to do; !=0 Removed bytes
420: */
1.5 misho 421: inline int io_RTrimStr(unsigned char * __restrict psLine);
1.4 misho 422: /*
423: * io_TrimStr() Remove left and right whitespaces from text string
424: * @psLine = Text string
425: * return: 0 nothing to do; !=0 Removed bytes
426: */
1.5 misho 427: inline int io_TrimStr(unsigned char * __restrict psLine);
1.4 misho 428: /*
1.5 misho 429: * io_Ch2Hex() Convert from Char string to Hex string
1.4 misho 430: * @psLine = Text string
431: * @lineLen = Length of Text string
1.5 misho 432: * return: NULL nothing to do or error; !=0 Allocated new converted data without term\0 (must be free)
1.4 misho 433: */
1.5 misho 434: inline unsigned char *io_Ch2Hex(unsigned char *psLine, int lineLen);
1.4 misho 435: /*
1.5 misho 436: * io_Hex2Ch() Convert from Hex string to Char string
1.4 misho 437: * @psLine = Text string
438: * @lineLen = Length of Text string
439: * return: NULL nothing to do or error; !=0 Allocated new converted string(must be free)
440: */
1.5 misho 441: inline char *io_Hex2Ch(unsigned char *psLine, int lineLen);
1.4 misho 442:
443: /*
1.8 misho 444: * io_arrayInit() - Create and initialize dynamic array
445: * @numItems = Number of Items
446: * return: NULL error, != NULL allocated memory for array
447: */
448: inline array_t *io_arrayInit(int numItems);
449: /*
1.10 misho 450: * io_arrayDestroy() - Free and destroy dynamic array
1.8 misho 451: * @parr = Array
452: * return: none
453: */
454: inline void io_arrayDestroy(array_t ** __restrict parr);
455: /*
1.10 misho 456: * io_arrayFree() - Free all data in dynamic array items
1.8 misho 457: * (WARNING! If assign static array dont use this!!!)
458: * @arr = Array
459: * return: none
460: */
461: inline void io_arrayFree(array_t * __restrict arr);
462: /*
1.10 misho 463: * io_arrayFrom() - Create and fill array from array with pointers
1.11 misho 464: * @pargv = Array with pointers
1.10 misho 465: * @argc = Number of Items, if 0 walk through argv and stop when reach NULL item
1.11 misho 466: * return: NULL error, != NULL allocated new array
1.10 misho 467: */
1.11 misho 468: inline array_t *io_arrayFrom(const char *** __restrict pargv, int argc);
1.10 misho 469: /*
470: * io_arrayTo() - Create and fill array with pointers from dynamic array
471: * @arr = Array
1.11 misho 472: * return: NULL error, != NULL allocated memory for array, NULL terminated
1.10 misho 473: */
474: inline char **io_arrayTo(array_t * __restrict arr);
475: /*
1.8 misho 476: * io_arrayLen() - Get last used element in dynamic array (array Length)
477: * @arr = Array
478: * return: -1 error, 0 empty or >0 position of last used element
479: */
480: inline int io_arrayLen(array_t * __restrict arr);
481: /*
1.10 misho 482: * io_arrayConcat() Concat source array to destination array
483: * @dest = Destination array
484: * @src = Source array
485: * return: -1 error; >0 new count of destination array
486: */
487: int io_arrayConcat(array_t * __restrict dest, array_t * __restrict src);
488: /*
1.12 misho 489: * io_arrayCopy() Copy source array to destination array
490: * @dest = Destination array, after use free with io_arrayDestroy()
491: * @src = Source array
492: * return: -1 error; >0 count of destination array
493: */
494: int io_arrayCopy(array_t ** __restrict dest, array_t * __restrict src);
495: /*
1.8 misho 496: * io_arrayGrow() - Grow/Shrink dynamic array, Use with care when it shrink!!!
497: * @arr = Array
498: * @newNumItems = Number of Items
1.12 misho 499: * @freeShrink = Free elements before shrink array
1.8 misho 500: * return: -1 error, 0 ok
501: */
1.12 misho 502: int io_arrayGrow(array_t * __restrict arr, int newNumItems, int freeShrink);
1.8 misho 503: /*
504: * io_arrayVacuum() - Vacuum dynamic array, empty elements will be deleted
505: * @arr = Array
506: * @fromWhere = 1 begin, 2 ALL empty elements
507: * return: -1 error, 0 ok
508: */
509: int io_arrayVacuum(array_t * __restrict arr, int fromWhere);
510:
1.12 misho 511: #define io_arraySize(_arr) ((_arr) ? (_arr)->arr_num : 0)
512: #define io_arrayZero(_arr) (assert((_arr)), memset((_arr)->arr_data, 0, \
513: io_arraySize((_arr)) * sizeof(void*)))
1.8 misho 514:
1.11 misho 515: #define io_arrayGet(_arr, _d) (assert((_arr) && (_arr)->arr_num > _d), *((_arr)->arr_data + _d))
516: #define io_array(_arr, _d, _type) (assert((_arr) && (_arr)->arr_num > _d), \
517: ((_type) *((_arr)->arr_data + _d)))
1.8 misho 518: #define io_arraySet(_arr, _d, _ptr) do { \
1.11 misho 519: assert((_arr) && (_arr)->arr_num > _d); \
520: *((_arr)->arr_data + _d) = (void*) (_ptr); \
1.8 misho 521: } while (0)
1.11 misho 522: #define io_arrayDel(_arr, _d, _fri) do { \
523: assert((_arr) && (_arr)->arr_num > _d); \
524: if (_fri) \
525: free(*((_arr)->arr_data + _d)); \
526: *((_arr)->arr_data + _d) = NULL; \
1.9 misho 527: } while (0)
1.8 misho 528:
529: /*
1.13 misho 530: * io_arrayElem() - Always GET/PUT element into dynamic array, if not enough elements grow array
531: * @arr = Array
532: * @n = Position
533: * @data = Element, if set NULL GET element at position or !=NULL PUT element at position
534: * return: -1 error or !=-1 return element at position
535: */
1.14 misho 536: inline void *io_arrayElem(array_t * __restrict arr, int n, void *data);
1.13 misho 537: /*
1.8 misho 538: * io_arrayPush() - Push element into dynamic array like stack manner, place at first empty position
539: * @arr = Array
540: * @data = Element, if set NULL return only first empty position
541: * return: -1 not found empty position, array is full!, >-1 return position of stored element into array
542: */
543: inline int io_arrayPush(array_t * __restrict arr, void **data);
544: /*
545: * io_arrayPop() - Pop element from dynamic array like stack manner, last used position
546: * @arr = Array
1.11 misho 547: * @data = Element, if set NULL return only last used position
1.8 misho 548: * @delAfter = Delete after Pop element, !=0 delete element from array after return data
549: * return: -1 not found used position, array is empty!, >-1 return element position
550: */
551: inline int io_arrayPop(array_t * __restrict arr, void ** __restrict data, int delAfter);
552:
553: /*
554: * io_argsNum() Parse and calculate number of arguments
555: * @csArgs = Input arguments line
556: * @csDelim = Delimiter(s) for separate
557: * return: 0 error format; -1 error:: can`t read; >0 ok, number of items
558: */
559: inline int io_argsNum(const char *csArgs, const char *csDelim);
560:
561: /*
562: * io_arrayMake() Parse and make array from arguments ... (input string will be modified!!!
563: * and output array must be free with io_arrayDestroy() after use!)
564: * @psArgs = Input arguments line, after execute string is modified!!!
565: * @nargs = Maximum requested count of arguments from input string psArgs, if 0 all psArgs
566: * @csDelim = Delimiter(s) for separate
567: * @parr = Output array of arguments ... (must be free with io_arrayDestroy() after use!)
568: * return: 0 error format; -1 error:: can`t read; >0 ok, number of readed items
569: */
570: int io_arrayMake(char * __restrict psArgs, int nargs, const char *csDelim,
571: array_t ** __restrict parr);
572:
573: /*
574: * io_MakeAV() Parse and make attribute/value pair
575: * @csArgs = Input argument line
576: * @csDelim = Delimiter for separate
577: * @psAttr = Output Attribute
578: * @attrLen = Size of attribute array
579: * @psValue = Output Value, if ==NULL this element not present value or not wanted for return
580: * @valLen = Size of value array
581: * return: 0 error format; -1 error:: can`t read; >0 ok, number of readed items
582: */
583: int io_MakeAV(const char * __restrict csArgs, const char *csDelim,
584: char * __restrict psAttr, int attrLen, char * __restrict psValue, int valLen);
585:
1.9 misho 586: /*
587: * io_sarrInit() - Create and initialize dynamic split-order array
588: * @numItems = Number of Items
589: * @segLen = Length of segment
590: * return: NULL error, != NULL allocated memory for array
591: */
592: inline sarr_t *io_sarrInit(int numItems, int segLen);
593: /*
594: * io_sarrDestroy() - Free all data in dynamic split-order array and Destroy array
595: * @parr = Array
596: * return: none
597: */
598: inline void io_sarrDestroy(sarr_t ** __restrict parr);
599: /*
600: * io_sarrGrow() - Grow/Shrink dynamic split-order array, Use with care when it shrink!!!
601: * @arr = Array
602: * @newNumItems = Number of Items
603: * return: -1 error, 0 ok
604: */
605: int io_sarrGrow(sarr_t * __restrict arr, int newNumItems);
606: /*
607: * io_sarrVacuum() - Vacuum dynamic split-order array, empty segments will be freed
608: * @arr = Array
609: * return: -1 error, >-1 freed segments
610: */
611: inline int io_sarrVacuum(sarr_t * __restrict arr);
1.12 misho 612: #define io_sarrSize(_arr) ((_arr) ? (_arr)->sarr_num : 0)
613: #define io_sarrSeg(_arr) (assert((_arr)), (_arr)->sarr_seg)
614: /*
615: * io_sarrCopy() Copy source split array to destination split array
616: * @dest = Destination split array, after use free with io_sarrDestroy()
617: * @src = Source split array
618: * return: -1 error; >0 count of destination split array
619: */
620: int io_sarrCopy(sarr_t ** __restrict dest, sarr_t * __restrict src);
1.9 misho 621: /*
622: * io_sarrGet() - Get element from dynamic split-order array
623: * @arr = Array
624: * @idx = Index (warning 1st element is at position 1)
625: * return: NULL not found, !=NULL element
626: */
627: inline void *io_sarrGet(sarr_t * __restrict arr, unsigned int idx);
628: /*
629: * io_sarrGet2() - Always get element from dynamic split-order array
630: * Function automatic grow array. Good use for Hash tables!
631: * @arr = Array
632: * @idx = Index (warning 1st element is at position 1)
633: * return: NULL not found, !=NULL element
634: */
635: void *io_sarrGet2(sarr_t * __restrict arr, unsigned int idx);
636: /*
637: * io_sarrSet() - Set element to dynamic split-order array
638: * @arr = Array
639: * @idx = Index (warning 1st element is at position 1)
640: * @data = Value
641: * return: NULL error or empty, !=NULL old value in element
642: */
643: inline void *io_sarrSet(sarr_t * __restrict arr, unsigned int idx, void *data);
1.11 misho 644: #define io_sarrDel(_arr, _idx) io_sarrSet((_arr), _idx, NULL)
645: #define io_sarr(_arr, _idx, _type) (_type)io_sarrGet((_arr), _idx)
646: /*
647: * io_sarr2array() - Convert from split-order array to dynamic array
648: * @sa = split array
649: * @sarrFree = after convert split array !=0 will be destroyed sarray
650: * return: NULL error or != NULL new array
651: */
652: array_t *io_sarr2array(sarr_t ** __restrict sa, int sarrFree);
653: /*
654: * io_array2sarr() - Convert from dynamic array to split-order array
655: * @a = array
656: * @segLen = Length of segment
657: * @arrFree = after convert array !=0 will be destroyed
658: * return: NULL error or != NULL new sarr
659: */
660: sarr_t *io_array2sarr(array_t ** __restrict a, int segLen, int arrFree);
1.8 misho 661:
662: /*
1.10 misho 663: * io_CopyEnv() Copy environment to new environment array;
664: * @oldenv = Environment array
665: * return: NULL error; !=NULL Allocated new environment array(must be free)
666: */
667: char **io_CopyEnv(const char **oldenv);
668: /*
669: * io_ExecArgs() Build exec arguments from other array
670: * @psProg = Program name for execute
671: * @oldarg = Arguments array
672: * return: NULL error; !=NULL Allocated execution array(must be free)
673: */
674: char **io_ExecArgs(const char *psProg, const char **oldarg);
675: /*
676: * io_FreeNullTerm() Free dynamic allocated null terminated array with strings
677: * @arr = Pointer to array for free
678: * return: none
679: */
680: inline void io_FreeNullTerm(char *** __restrict arr);
681:
682: /*
1.5 misho 683: * ioMkDir() Function for racursive directory creation and validation
684: * @csDir = Full directory path
685: * @mode = Mode for directory creation if missing dir
686: * return: -1 error, 0 directory path exist, >0 created missing dirs
687: */
688: int ioMkDir(const char *csDir, int mode);
689:
1.6 misho 690: /*
691: * ioWatchDirLoop() Function for watching changes in directory and fire callback
692: * @csDir = Full directory path
693: * @callback = Callback if raise event! nOp -1 delete, 0 change/move, 1 create
694: * return: -1 error, !=-1 ok, number of total signaled events
695: */
696: int ioWatchDirLoop(const char *csDir, int (*callback)(const char *csName, int nOp));
697:
1.5 misho 698:
699: /*
700: * io_rread() Raw VFS read function
701: * @fd = File handle
702: * @buf = Read buffer
703: * @nbytes = Read buffer size
704: * @offset = Read from position, if -1 read nbytes from current position
705: * @update = Update file handle position !0
706: * return: -1 error or !=-1 readed bytes
707: */
708: inline int io_rread(int fd, void * __restrict buf, size_t nbytes, off_t offset, int update);
709: /*
710: * io_rwrite() Raw VFS write function
711: * @fd = File handle
712: * @buf = Write buffer
713: * @nbytes = Write bytes from buffer
714: * @offset = Write at position, if -1 write nbytes from current position
715: * @update = Update file handle position !0
716: * return: -1 error or !=-1 writed bytes
717: */
718: inline int io_rwrite(int fd, void * __restrict buf, size_t nbytes, off_t offset, int update);
719:
720: /* Disk I/O helper macros */
721: #define io_read(f, b, n) io_rread(f, b, n, -1, 1)
722: #define io_write(f, b, n) io_rwrite(f, b, n, -1, 1)
723:
724:
725: /* Debug helper macros */
726: extern int io_Debug;
727:
1.14 misho 728: #define io_enableDEBUG int io_Debug
729: #define io_initDebug(x) (io_Debug = (x))
730: #define io_incDebug (io_Debug++)
731: #define io_decDebug (io_Debug--)
732:
733: /* Debug macros */
734: #define ioVERBOSE(x) if ((x) <= io_Debug)
735: #define ioTRACE(x) if ((x) <= io_Debug) \
736: syslog(LOG_DEBUG, "I'm in %s(%d)", __func__, __LINE__)
1.5 misho 737: #define ioDEBUG(x, fmt, ...) do { \
738: assert((fmt)); \
739: char str[STRSIZ] = { 0 }; \
1.11 misho 740: snprintf(str, sizeof str, (fmt), ##__VA_ARGS__); \
1.5 misho 741: if ((x) <= io_Debug) \
1.14 misho 742: syslog(LOG_DEBUG, "Debug(%d):%s(%d): %s\n", \
1.5 misho 743: (x), __func__, __LINE__, str); \
744: } while (0)
745:
1.14 misho 746: /* Logger macro */
747: #define ioLOGGER(x, fmt, ...) do { \
748: assert((fmt)); \
749: char str[STRSIZ] = { 0 }; \
750: snprintf(str, sizeof str, (fmt), ##__VA_ARGS__); \
751: syslog((x), "Logger:%s(%d): %s\n", \
752: __func__, __LINE__, str); \
753: } while (0)
754:
755: /* Error state macros */
1.5 misho 756: #define ioERROR(x, fmt, ...) do { \
757: assert((fmt)); \
758: char str[STRSIZ] = { 0 }; \
1.11 misho 759: snprintf(str, sizeof str, (fmt), ##__VA_ARGS__); \
1.14 misho 760: syslog(LOG_ERR, "Error:%s(%d): #%d - %s\n", \
1.5 misho 761: __func__, __LINE__, (x), str); \
762: } while (0)
1.14 misho 763: #define ioSYSERR(x) do { \
1.5 misho 764: if (x > 0 || errno) \
1.14 misho 765: syslog(LOG_ERR, "Error(sys):%s(%d): #%d - %s\n", \
1.5 misho 766: __func__, __LINE__, x > 0 ? x : errno, \
767: strerror(x > 0 ? x : errno)); \
768: } while (0)
1.14 misho 769: #define ioLIBERR(ait) do { \
1.5 misho 770: if (ait##_GetErrno()) \
1.14 misho 771: syslog(LOG_ERR, "Error(lib):%s(%d): #%d - %s\n", \
1.5 misho 772: __func__, __LINE__, ait##_GetErrno(), \
773: ait##_GetError()); \
774: } while (0)
1.3 misho 775:
1.1 misho 776:
1.7 misho 777: /* Crypto framework */
778:
779: /*
780: * ioCipher() Cipher wrapper for all supported crypto algorythms
781: * @pInput = input buffer
782: * @inLen = input buffer len
783: * @ppOutput = output allocated buffe, must be free after use
784: * @Cipher = cipher engine, like EVP_bf_cbc() or etc...
785: * @pKey = key
786: * @pIV = IV, salt (8 bytes)
787: * @nMode = Mode 0 - decrypting or 1 - encrypting
788: * return: 0 not present data or error!; >0 number of processed and returned bytes into ppOutput
789: */
790: int ioCipher(unsigned char *pInput, int inLen, unsigned char **ppOutput, const EVP_CIPHER *Cipher,
791: unsigned char *pKey, unsigned char *pIV, int nMode);
792:
793: /*
794: * io_Blowfish() Blowfish cipher algorythm, work with ASCII hex strings
795: * @pInput = input buffer
796: * @inLen = input buffer len
797: * @ppOutput = output allocated buffe, must be free after use
798: * @pKey = key
799: * @pIV = IV, salt (8 bytes)
800: * @nMode = Mode 0 - decrypting or 1 - encrypting
801: * return: 0 not present data or error!; >0 number of processed and returned bytes into ppOutput
802: */
1.8 misho 803: int io_Blowfish(unsigned char *pInput, int inLen, unsigned char **ppOutput,
804: unsigned char *pKey, unsigned char *pIV, int nMode);
1.12 misho 805: /*
806: * io_ctr_AES() Encrypt/Decrypt stream cipher CTR_AES
807: * @pInput = Input buffer with ASCII
808: * @inLen = Input buffer data length
809: * @ppOutput = Output buffer with cipher data, must be free after use
810: * @pKey = Key
811: * @IV = IVector/Nonce/Counter, Warning: IV must be variable, because we write there!!!
812: * return: -1 error or >-1 how many cipher blocks proceeded
813: */
814: int io_ctr_AES(unsigned char *pInput, int inLen, unsigned char **ppOutput,
815: unsigned char *pKey, unsigned char IV[AES_BLOCK_SIZE]);
816:
817:
818: /*
819: * ioAllocPTY() Allocate new PTY and TTY
820: * @ptyfd = master fd, pty
821: * @ttyfd = slave fd, tty
822: * @name = tty device name if not null
823: * @namesiz = name length, must be above 63 bytes.
824: * @term = termios for terminal
825: * @winz = winsize for terminal
826: * return: -1 error or 0 ok
827: */
828: inline int ioAllocPTY(int *ptyfd, int *ttyfd, char * __restrict name, int namesiz,
829: struct termios * __restrict term, struct winsize * __restrict winz);
830: /*
831: * ioFreePTY() Release PTY and TTY device
832: * @ptyfd = master fd, pty (==-1 skip closing pty)
833: * @ttyname = tty filename
834: * return: none
835: */
836: inline void ioFreePTY(int ptyfd, const char *ttyname);
837: /*
838: * ioChgWinPTY() Change window size of PTY
839: * @ptyfd = master fd, pty
840: * @row = row
841: * @col = col
842: * @xpxl = x pixels
843: * @ypxl = y pixels
844: * return: -1 error or 0 ok
845: */
846: inline int ioChgWinPTY(int ptyfd, unsigned short row, unsigned short col,
847: unsigned short xpxl, unsigned short ypxl);
848: /*
849: * ioSetOwnerTTY() Set owner to TTY
850: * @ttyname = tty filename
851: * @UID = uid
852: * @GID = gid
853: * return: -1 error or 0 ok
854: */
855: int ioSetOwnerTTY(const char *ttyname, uid_t UID, gid_t GID);
856: /*
857: * ioSetSidTTY() Makes the process's controlling TTY and sets it to sane modes.
858: * @ttyfd = slave fd, tty
859: * @ttyname = tty filename
860: * return: -1 error or 0 ok
861: */
862: int ioSetSidTTY(int *ttyfd, const char *ttyname);
863: /*
864: * ioSetRAWMode() Enter into RAW mode
865: * @fd = tty fd
866: * @otio = saved old termios for later restore if !=NULL
867: * return: -1 error or 0 ok
868: */
869: inline int ioSetRAWMode(int fd, struct termios *otio);
870: /*
871: * ioRestoreMode() Restore termios to tty fd
872: * @fd = tty fd
873: * @tio = termios structure for restore
874: * return: -1 error or 0 ok
875: */
876: inline int ioRestoreMode(int fd, struct termios tio);
877: /*
878: * ioForkPTY() Fork new process with session leader and new TTY
879: * @ptyfd = master fd, pty
880: * @name = tty device name if not null
881: * @namesiz = name length, must be above 63 bytes.
882: * @term = termios for terminal
883: * @winz = winsize for terminal
884: * @otio = old termios structure for restore
885: * return: -1 error, 0 child process or >0 parent: pid of child
886: */
887: pid_t ioForkPTY(int *ptyfd, char * __restrict name, int namesiz, struct termios * __restrict term,
888: struct winsize * __restrict winz, struct termios * __restrict otio);
889:
890: /*
891: * ioCreatePIDFile() Create PID file
892: * @csName = PID filename
893: * @ifExists = !=0 if filename exists return error
894: * return: -1 error or 0 ok
895: */
896: inline int ioCreatePIDFile(const char *csName, int ifExists);
1.7 misho 897:
1.13 misho 898: /*
899: * ioSendFile() AITNET sendfile() userland implementation, not dependant from OS
900: * @s = socket
901: * @csFile = file for send
902: * @sendLen = bytes to send, if 0 send all data
903: * @offset = start file offset
904: * @sndbuf = SO_SNDBUF value, if 0 use default
905: * return: 0 error, >0 ok, sended bytes
906: */
907: size_t ioSendFile(int s, const char *csFile, size_t sendLen, off_t offset, int sndbuf);
908: /*
909: * ioRecvFile() Receive file from socket, fastest (zero-copy) way
910: * @s = socket
911: * @csFile = file for receive
912: * @recvLen = receive bytes
913: * @over = overwrite file if exists with mode like 0644
914: * @rcvbuf = SO_RCVBUF value, if 0 use default
915: * return: 0 error, >0 ok, received bytes
916: */
917: size_t ioRecvFile(int s, const char *csFile, size_t recvLen, int over, int rcvbuf);
918:
1.7 misho 919:
1.14 misho 920: /* Buffered file access over memory block */
921:
922: /*
923: * io_fmemopen() File buffered stream operations over memory block
924: *
925: * @base = Base address of memory block, if =NULL Infinit length(auto-grow)
926: * @basesize = Size of memory block
927: * return: NULL error or !=NULL Opened file resource
928: */
929: FILE *io_fmemopen(void ** __restrict base, off_t basesize);
930: /*
931: * io_fmapopen() File buffered stream operations over MMAP block
932: *
933: * @csFile = Filename for MMAP, if =NULL private MMAP block
934: * @mode = File open mode
935: * @perm = If file not exists will be created with this access permissions
936: * @prot = MMAP protection
937: * @flags = MMAP mode flags
938: * @offset = Map from file offset, if csFile==NULL then this is size of MMAP private block
939: * return: NULL error or !=NULL Opened file resource
940: */
941: FILE *io_fmapopen(const char *csFile, int mode, int perm, int prot, int flags, off_t offset);
942: /*
943: * io_fd2buf() Convert open file handle to buffered file I/O
944: *
945: * @fd = File handle
946: * @mode = Permissions for new buffered file I/O
947: * return: NULL error or open buffered file
948: */
949: inline FILE *io_fd2buf(int fd, const char *mode);
950: /*
951: * io_dumbFile() Create empry or dumb file with fixed size
952: *
953: * @csFile = Filename for create
954: * @mode = File access permissions
955: * @size = File size
956: * return: -1 error or open file handle
957: */
958: int io_dumbFile(const char *csFile, int mode, off_t size);
959:
960:
1.1 misho 961: #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