Annotation of libaitio/inc/aitio.h, revision 1.14.2.5
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.5! misho 6: * $Id: aitio.h,v 1.14.2.4 2012/03/10 15:37: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.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.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.14.2.4 misho 444: * io_Path2File() - Parse and make path/filename pair
445: *
446: * @csArgs = Input argument line
447: * @psPath = Output Path, if ==NULL path not returned
448: * @pathLen = Size of path array
449: * @psFile = Output File
450: * @fileLen = Size of file array
451: * return: 0 error format; -1 error:: can`t read; >0 ok, number of readed items
452: */
453: inline int
454: io_Path2File(const char * __restrict csArgs, char * __restrict psPath,
455: int pathLen, char * __restrict psFile, int fileLen);
456:
457: /*
1.8 misho 458: * io_arrayInit() - Create and initialize dynamic array
459: * @numItems = Number of Items
460: * return: NULL error, != NULL allocated memory for array
461: */
462: inline array_t *io_arrayInit(int numItems);
463: /*
1.10 misho 464: * io_arrayDestroy() - Free and destroy dynamic array
1.8 misho 465: * @parr = Array
466: * return: none
467: */
468: inline void io_arrayDestroy(array_t ** __restrict parr);
469: /*
1.10 misho 470: * io_arrayFree() - Free all data in dynamic array items
1.8 misho 471: * (WARNING! If assign static array dont use this!!!)
472: * @arr = Array
473: * return: none
474: */
475: inline void io_arrayFree(array_t * __restrict arr);
476: /*
1.10 misho 477: * io_arrayFrom() - Create and fill array from array with pointers
1.11 misho 478: * @pargv = Array with pointers
1.10 misho 479: * @argc = Number of Items, if 0 walk through argv and stop when reach NULL item
1.11 misho 480: * return: NULL error, != NULL allocated new array
1.10 misho 481: */
1.11 misho 482: inline array_t *io_arrayFrom(const char *** __restrict pargv, int argc);
1.10 misho 483: /*
484: * io_arrayTo() - Create and fill array with pointers from dynamic array
485: * @arr = Array
1.11 misho 486: * return: NULL error, != NULL allocated memory for array, NULL terminated
1.10 misho 487: */
488: inline char **io_arrayTo(array_t * __restrict arr);
489: /*
1.8 misho 490: * io_arrayLen() - Get last used element in dynamic array (array Length)
491: * @arr = Array
492: * return: -1 error, 0 empty or >0 position of last used element
493: */
494: inline int io_arrayLen(array_t * __restrict arr);
495: /*
1.10 misho 496: * io_arrayConcat() Concat source array to destination array
497: * @dest = Destination array
498: * @src = Source array
499: * return: -1 error; >0 new count of destination array
500: */
501: int io_arrayConcat(array_t * __restrict dest, array_t * __restrict src);
502: /*
1.12 misho 503: * io_arrayCopy() Copy source array to destination array
504: * @dest = Destination array, after use free with io_arrayDestroy()
505: * @src = Source array
506: * return: -1 error; >0 count of destination array
507: */
508: int io_arrayCopy(array_t ** __restrict dest, array_t * __restrict src);
509: /*
1.8 misho 510: * io_arrayGrow() - Grow/Shrink dynamic array, Use with care when it shrink!!!
511: * @arr = Array
512: * @newNumItems = Number of Items
1.12 misho 513: * @freeShrink = Free elements before shrink array
1.8 misho 514: * return: -1 error, 0 ok
515: */
1.12 misho 516: int io_arrayGrow(array_t * __restrict arr, int newNumItems, int freeShrink);
1.8 misho 517: /*
518: * io_arrayVacuum() - Vacuum dynamic array, empty elements will be deleted
519: * @arr = Array
520: * @fromWhere = 1 begin, 2 ALL empty elements
521: * return: -1 error, 0 ok
522: */
523: int io_arrayVacuum(array_t * __restrict arr, int fromWhere);
524:
1.12 misho 525: #define io_arraySize(_arr) ((_arr) ? (_arr)->arr_num : 0)
526: #define io_arrayZero(_arr) (assert((_arr)), memset((_arr)->arr_data, 0, \
527: io_arraySize((_arr)) * sizeof(void*)))
1.8 misho 528:
1.11 misho 529: #define io_arrayGet(_arr, _d) (assert((_arr) && (_arr)->arr_num > _d), *((_arr)->arr_data + _d))
530: #define io_array(_arr, _d, _type) (assert((_arr) && (_arr)->arr_num > _d), \
531: ((_type) *((_arr)->arr_data + _d)))
1.8 misho 532: #define io_arraySet(_arr, _d, _ptr) do { \
1.11 misho 533: assert((_arr) && (_arr)->arr_num > _d); \
534: *((_arr)->arr_data + _d) = (void*) (_ptr); \
1.8 misho 535: } while (0)
1.11 misho 536: #define io_arrayDel(_arr, _d, _fri) do { \
537: assert((_arr) && (_arr)->arr_num > _d); \
538: if (_fri) \
539: free(*((_arr)->arr_data + _d)); \
540: *((_arr)->arr_data + _d) = NULL; \
1.9 misho 541: } while (0)
1.8 misho 542:
543: /*
1.13 misho 544: * io_arrayElem() - Always GET/PUT element into dynamic array, if not enough elements grow array
545: * @arr = Array
546: * @n = Position
547: * @data = Element, if set NULL GET element at position or !=NULL PUT element at position
548: * return: -1 error or !=-1 return element at position
549: */
1.14 misho 550: inline void *io_arrayElem(array_t * __restrict arr, int n, void *data);
1.13 misho 551: /*
1.8 misho 552: * io_arrayPush() - Push element into dynamic array like stack manner, place at first empty position
553: * @arr = Array
554: * @data = Element, if set NULL return only first empty position
555: * return: -1 not found empty position, array is full!, >-1 return position of stored element into array
556: */
557: inline int io_arrayPush(array_t * __restrict arr, void **data);
558: /*
559: * io_arrayPop() - Pop element from dynamic array like stack manner, last used position
560: * @arr = Array
1.11 misho 561: * @data = Element, if set NULL return only last used position
1.8 misho 562: * @delAfter = Delete after Pop element, !=0 delete element from array after return data
563: * return: -1 not found used position, array is empty!, >-1 return element position
564: */
565: inline int io_arrayPop(array_t * __restrict arr, void ** __restrict data, int delAfter);
566:
567: /*
568: * io_argsNum() Parse and calculate number of arguments
569: * @csArgs = Input arguments line
570: * @csDelim = Delimiter(s) for separate
571: * return: 0 error format; -1 error:: can`t read; >0 ok, number of items
572: */
573: inline int io_argsNum(const char *csArgs, const char *csDelim);
574:
575: /*
576: * io_arrayMake() Parse and make array from arguments ... (input string will be modified!!!
577: * and output array must be free with io_arrayDestroy() after use!)
578: * @psArgs = Input arguments line, after execute string is modified!!!
579: * @nargs = Maximum requested count of arguments from input string psArgs, if 0 all psArgs
580: * @csDelim = Delimiter(s) for separate
581: * @parr = Output array of arguments ... (must be free with io_arrayDestroy() after use!)
582: * return: 0 error format; -1 error:: can`t read; >0 ok, number of readed items
583: */
584: int io_arrayMake(char * __restrict psArgs, int nargs, const char *csDelim,
585: array_t ** __restrict parr);
586:
587: /*
588: * io_MakeAV() Parse and make attribute/value pair
589: * @csArgs = Input argument line
590: * @csDelim = Delimiter for separate
591: * @psAttr = Output Attribute
592: * @attrLen = Size of attribute array
593: * @psValue = Output Value, if ==NULL this element not present value or not wanted for return
594: * @valLen = Size of value array
595: * return: 0 error format; -1 error:: can`t read; >0 ok, number of readed items
596: */
597: int io_MakeAV(const char * __restrict csArgs, const char *csDelim,
598: char * __restrict psAttr, int attrLen, char * __restrict psValue, int valLen);
599:
1.9 misho 600: /*
601: * io_sarrInit() - Create and initialize dynamic split-order array
602: * @numItems = Number of Items
603: * @segLen = Length of segment
604: * return: NULL error, != NULL allocated memory for array
605: */
606: inline sarr_t *io_sarrInit(int numItems, int segLen);
607: /*
608: * io_sarrDestroy() - Free all data in dynamic split-order array and Destroy array
609: * @parr = Array
610: * return: none
611: */
612: inline void io_sarrDestroy(sarr_t ** __restrict parr);
613: /*
614: * io_sarrGrow() - Grow/Shrink dynamic split-order array, Use with care when it shrink!!!
615: * @arr = Array
616: * @newNumItems = Number of Items
617: * return: -1 error, 0 ok
618: */
619: int io_sarrGrow(sarr_t * __restrict arr, int newNumItems);
620: /*
621: * io_sarrVacuum() - Vacuum dynamic split-order array, empty segments will be freed
622: * @arr = Array
623: * return: -1 error, >-1 freed segments
624: */
625: inline int io_sarrVacuum(sarr_t * __restrict arr);
1.12 misho 626: #define io_sarrSize(_arr) ((_arr) ? (_arr)->sarr_num : 0)
627: #define io_sarrSeg(_arr) (assert((_arr)), (_arr)->sarr_seg)
628: /*
629: * io_sarrCopy() Copy source split array to destination split array
630: * @dest = Destination split array, after use free with io_sarrDestroy()
631: * @src = Source split array
632: * return: -1 error; >0 count of destination split array
633: */
634: int io_sarrCopy(sarr_t ** __restrict dest, sarr_t * __restrict src);
1.9 misho 635: /*
636: * io_sarrGet() - Get element from dynamic split-order array
637: * @arr = Array
638: * @idx = Index (warning 1st element is at position 1)
639: * return: NULL not found, !=NULL element
640: */
641: inline void *io_sarrGet(sarr_t * __restrict arr, unsigned int idx);
642: /*
643: * io_sarrGet2() - Always get element from dynamic split-order array
644: * Function automatic grow array. Good use for Hash tables!
645: * @arr = Array
646: * @idx = Index (warning 1st element is at position 1)
647: * return: NULL not found, !=NULL element
648: */
649: void *io_sarrGet2(sarr_t * __restrict arr, unsigned int idx);
650: /*
651: * io_sarrSet() - Set element to dynamic split-order array
652: * @arr = Array
653: * @idx = Index (warning 1st element is at position 1)
654: * @data = Value
655: * return: NULL error or empty, !=NULL old value in element
656: */
657: inline void *io_sarrSet(sarr_t * __restrict arr, unsigned int idx, void *data);
1.11 misho 658: #define io_sarrDel(_arr, _idx) io_sarrSet((_arr), _idx, NULL)
659: #define io_sarr(_arr, _idx, _type) (_type)io_sarrGet((_arr), _idx)
660: /*
661: * io_sarr2array() - Convert from split-order array to dynamic array
662: * @sa = split array
663: * @sarrFree = after convert split array !=0 will be destroyed sarray
664: * return: NULL error or != NULL new array
665: */
666: array_t *io_sarr2array(sarr_t ** __restrict sa, int sarrFree);
667: /*
668: * io_array2sarr() - Convert from dynamic array to split-order array
669: * @a = array
670: * @segLen = Length of segment
671: * @arrFree = after convert array !=0 will be destroyed
672: * return: NULL error or != NULL new sarr
673: */
674: sarr_t *io_array2sarr(array_t ** __restrict a, int segLen, int arrFree);
1.8 misho 675:
676: /*
1.10 misho 677: * io_CopyEnv() Copy environment to new environment array;
678: * @oldenv = Environment array
679: * return: NULL error; !=NULL Allocated new environment array(must be free)
680: */
681: char **io_CopyEnv(const char **oldenv);
682: /*
683: * io_ExecArgs() Build exec arguments from other array
684: * @psProg = Program name for execute
685: * @oldarg = Arguments array
686: * return: NULL error; !=NULL Allocated execution array(must be free)
687: */
688: char **io_ExecArgs(const char *psProg, const char **oldarg);
689: /*
690: * io_FreeNullTerm() Free dynamic allocated null terminated array with strings
691: * @arr = Pointer to array for free
692: * return: none
693: */
694: inline void io_FreeNullTerm(char *** __restrict arr);
695:
696: /*
1.5 misho 697: * ioMkDir() Function for racursive directory creation and validation
698: * @csDir = Full directory path
699: * @mode = Mode for directory creation if missing dir
700: * return: -1 error, 0 directory path exist, >0 created missing dirs
701: */
702: int ioMkDir(const char *csDir, int mode);
703:
1.6 misho 704: /*
705: * ioWatchDirLoop() Function for watching changes in directory and fire callback
706: * @csDir = Full directory path
707: * @callback = Callback if raise event! nOp -1 delete, 0 change/move, 1 create
708: * return: -1 error, !=-1 ok, number of total signaled events
709: */
710: int ioWatchDirLoop(const char *csDir, int (*callback)(const char *csName, int nOp));
711:
1.5 misho 712:
713: /*
714: * io_rread() Raw VFS read function
715: * @fd = File handle
716: * @buf = Read buffer
717: * @nbytes = Read buffer size
718: * @offset = Read from position, if -1 read nbytes from current position
719: * @update = Update file handle position !0
720: * return: -1 error or !=-1 readed bytes
721: */
722: inline int io_rread(int fd, void * __restrict buf, size_t nbytes, off_t offset, int update);
723: /*
724: * io_rwrite() Raw VFS write function
725: * @fd = File handle
726: * @buf = Write buffer
727: * @nbytes = Write bytes from buffer
728: * @offset = Write at position, if -1 write nbytes from current position
729: * @update = Update file handle position !0
730: * return: -1 error or !=-1 writed bytes
731: */
732: inline int io_rwrite(int fd, void * __restrict buf, size_t nbytes, off_t offset, int update);
733:
734: /* Disk I/O helper macros */
735: #define io_read(f, b, n) io_rread(f, b, n, -1, 1)
736: #define io_write(f, b, n) io_rwrite(f, b, n, -1, 1)
737:
738:
739: /* Debug helper macros */
740: extern int io_Debug;
741:
1.14 misho 742: #define io_enableDEBUG int io_Debug
743: #define io_initDebug(x) (io_Debug = (x))
744: #define io_incDebug (io_Debug++)
745: #define io_decDebug (io_Debug--)
746:
747: /* Debug macros */
748: #define ioVERBOSE(x) if ((x) <= io_Debug)
749: #define ioTRACE(x) if ((x) <= io_Debug) \
750: syslog(LOG_DEBUG, "I'm in %s(%d)", __func__, __LINE__)
1.5 misho 751: #define ioDEBUG(x, fmt, ...) do { \
752: assert((fmt)); \
753: char str[STRSIZ] = { 0 }; \
1.11 misho 754: snprintf(str, sizeof str, (fmt), ##__VA_ARGS__); \
1.5 misho 755: if ((x) <= io_Debug) \
1.14 misho 756: syslog(LOG_DEBUG, "Debug(%d):%s(%d): %s\n", \
1.5 misho 757: (x), __func__, __LINE__, str); \
758: } while (0)
759:
1.14 misho 760: /* Logger macro */
761: #define ioLOGGER(x, fmt, ...) do { \
762: assert((fmt)); \
763: char str[STRSIZ] = { 0 }; \
764: snprintf(str, sizeof str, (fmt), ##__VA_ARGS__); \
765: syslog((x), "Logger:%s(%d): %s\n", \
766: __func__, __LINE__, str); \
767: } while (0)
768:
769: /* Error state macros */
1.5 misho 770: #define ioERROR(x, fmt, ...) do { \
771: assert((fmt)); \
772: char str[STRSIZ] = { 0 }; \
1.11 misho 773: snprintf(str, sizeof str, (fmt), ##__VA_ARGS__); \
1.14 misho 774: syslog(LOG_ERR, "Error:%s(%d): #%d - %s\n", \
1.5 misho 775: __func__, __LINE__, (x), str); \
776: } while (0)
1.14 misho 777: #define ioSYSERR(x) do { \
1.5 misho 778: if (x > 0 || errno) \
1.14 misho 779: syslog(LOG_ERR, "Error(sys):%s(%d): #%d - %s\n", \
1.5 misho 780: __func__, __LINE__, x > 0 ? x : errno, \
781: strerror(x > 0 ? x : errno)); \
782: } while (0)
1.14 misho 783: #define ioLIBERR(ait) do { \
1.5 misho 784: if (ait##_GetErrno()) \
1.14 misho 785: syslog(LOG_ERR, "Error(lib):%s(%d): #%d - %s\n", \
1.5 misho 786: __func__, __LINE__, ait##_GetErrno(), \
787: ait##_GetError()); \
788: } while (0)
1.3 misho 789:
1.1 misho 790:
1.7 misho 791: /* Crypto framework */
792:
793: /*
794: * ioCipher() Cipher wrapper for all supported crypto algorythms
795: * @pInput = input buffer
796: * @inLen = input buffer len
797: * @ppOutput = output allocated buffe, must be free after use
798: * @Cipher = cipher engine, like EVP_bf_cbc() or etc...
799: * @pKey = key
800: * @pIV = IV, salt (8 bytes)
801: * @nMode = Mode 0 - decrypting or 1 - encrypting
802: * return: 0 not present data or error!; >0 number of processed and returned bytes into ppOutput
803: */
804: int ioCipher(unsigned char *pInput, int inLen, unsigned char **ppOutput, const EVP_CIPHER *Cipher,
805: unsigned char *pKey, unsigned char *pIV, int nMode);
806:
807: /*
808: * io_Blowfish() Blowfish cipher algorythm, work with ASCII hex strings
809: * @pInput = input buffer
810: * @inLen = input buffer len
811: * @ppOutput = output allocated buffe, must be free after use
812: * @pKey = key
813: * @pIV = IV, salt (8 bytes)
814: * @nMode = Mode 0 - decrypting or 1 - encrypting
815: * return: 0 not present data or error!; >0 number of processed and returned bytes into ppOutput
816: */
1.8 misho 817: int io_Blowfish(unsigned char *pInput, int inLen, unsigned char **ppOutput,
818: unsigned char *pKey, unsigned char *pIV, int nMode);
1.12 misho 819: /*
820: * io_ctr_AES() Encrypt/Decrypt stream cipher CTR_AES
821: * @pInput = Input buffer with ASCII
822: * @inLen = Input buffer data length
823: * @ppOutput = Output buffer with cipher data, must be free after use
824: * @pKey = Key
825: * @IV = IVector/Nonce/Counter, Warning: IV must be variable, because we write there!!!
826: * return: -1 error or >-1 how many cipher blocks proceeded
827: */
828: int io_ctr_AES(unsigned char *pInput, int inLen, unsigned char **ppOutput,
829: unsigned char *pKey, unsigned char IV[AES_BLOCK_SIZE]);
830:
831:
832: /*
833: * ioAllocPTY() Allocate new PTY and TTY
834: * @ptyfd = master fd, pty
835: * @ttyfd = slave fd, tty
836: * @name = tty device name if not null
837: * @namesiz = name length, must be above 63 bytes.
838: * @term = termios for terminal
839: * @winz = winsize for terminal
840: * return: -1 error or 0 ok
841: */
842: inline int ioAllocPTY(int *ptyfd, int *ttyfd, char * __restrict name, int namesiz,
843: struct termios * __restrict term, struct winsize * __restrict winz);
844: /*
845: * ioFreePTY() Release PTY and TTY device
846: * @ptyfd = master fd, pty (==-1 skip closing pty)
847: * @ttyname = tty filename
848: * return: none
849: */
850: inline void ioFreePTY(int ptyfd, const char *ttyname);
851: /*
852: * ioChgWinPTY() Change window size of PTY
853: * @ptyfd = master fd, pty
854: * @row = row
855: * @col = col
856: * @xpxl = x pixels
857: * @ypxl = y pixels
858: * return: -1 error or 0 ok
859: */
860: inline int ioChgWinPTY(int ptyfd, unsigned short row, unsigned short col,
861: unsigned short xpxl, unsigned short ypxl);
862: /*
863: * ioSetOwnerTTY() Set owner to TTY
864: * @ttyname = tty filename
865: * @UID = uid
866: * @GID = gid
867: * return: -1 error or 0 ok
868: */
869: int ioSetOwnerTTY(const char *ttyname, uid_t UID, gid_t GID);
870: /*
871: * ioSetSidTTY() Makes the process's controlling TTY and sets it to sane modes.
872: * @ttyfd = slave fd, tty
873: * @ttyname = tty filename
874: * return: -1 error or 0 ok
875: */
876: int ioSetSidTTY(int *ttyfd, const char *ttyname);
877: /*
878: * ioSetRAWMode() Enter into RAW mode
879: * @fd = tty fd
880: * @otio = saved old termios for later restore if !=NULL
881: * return: -1 error or 0 ok
882: */
883: inline int ioSetRAWMode(int fd, struct termios *otio);
884: /*
885: * ioRestoreMode() Restore termios to tty fd
886: * @fd = tty fd
887: * @tio = termios structure for restore
888: * return: -1 error or 0 ok
889: */
890: inline int ioRestoreMode(int fd, struct termios tio);
891: /*
892: * ioForkPTY() Fork new process with session leader and new TTY
893: * @ptyfd = master fd, pty
894: * @name = tty device name if not null
895: * @namesiz = name length, must be above 63 bytes.
896: * @term = termios for terminal
897: * @winz = winsize for terminal
898: * @otio = old termios structure for restore
899: * return: -1 error, 0 child process or >0 parent: pid of child
900: */
901: pid_t ioForkPTY(int *ptyfd, char * __restrict name, int namesiz, struct termios * __restrict term,
902: struct winsize * __restrict winz, struct termios * __restrict otio);
903:
904: /*
905: * ioCreatePIDFile() Create PID file
906: * @csName = PID filename
907: * @ifExists = !=0 if filename exists return error
908: * return: -1 error or 0 ok
909: */
910: inline int ioCreatePIDFile(const char *csName, int ifExists);
1.7 misho 911:
1.13 misho 912: /*
913: * ioSendFile() AITNET sendfile() userland implementation, not dependant from OS
914: * @s = socket
915: * @csFile = file for send
916: * @sendLen = bytes to send, if 0 send all data
917: * @offset = start file offset
918: * @sndbuf = SO_SNDBUF value, if 0 use default
919: * return: 0 error, >0 ok, sended bytes
920: */
921: size_t ioSendFile(int s, const char *csFile, size_t sendLen, off_t offset, int sndbuf);
922: /*
923: * ioRecvFile() Receive file from socket, fastest (zero-copy) way
924: * @s = socket
925: * @csFile = file for receive
926: * @recvLen = receive bytes
927: * @over = overwrite file if exists with mode like 0644
928: * @rcvbuf = SO_RCVBUF value, if 0 use default
929: * return: 0 error, >0 ok, received bytes
930: */
931: size_t ioRecvFile(int s, const char *csFile, size_t recvLen, int over, int rcvbuf);
932:
1.7 misho 933:
1.14 misho 934: /* Buffered file access over memory block */
935:
936: /*
937: * io_fmemopen() File buffered stream operations over memory block
938: *
939: * @base = Base address of memory block, if =NULL Infinit length(auto-grow)
940: * @basesize = Size of memory block
941: * return: NULL error or !=NULL Opened file resource
942: */
943: FILE *io_fmemopen(void ** __restrict base, off_t basesize);
944: /*
945: * io_fmapopen() File buffered stream operations over MMAP block
946: *
947: * @csFile = Filename for MMAP, if =NULL private MMAP block
948: * @mode = File open mode
949: * @perm = If file not exists will be created with this access permissions
950: * @prot = MMAP protection
951: * @flags = MMAP mode flags
952: * @offset = Map from file offset, if csFile==NULL then this is size of MMAP private block
953: * return: NULL error or !=NULL Opened file resource
954: */
955: FILE *io_fmapopen(const char *csFile, int mode, int perm, int prot, int flags, off_t offset);
956: /*
957: * io_fd2buf() Convert open file handle to buffered file I/O
958: *
959: * @fd = File handle
960: * @mode = Permissions for new buffered file I/O
961: * return: NULL error or open buffered file
962: */
963: inline FILE *io_fd2buf(int fd, const char *mode);
964: /*
965: * io_dumbFile() Create empry or dumb file with fixed size
966: *
967: * @csFile = Filename for create
968: * @mode = File access permissions
969: * @size = File size
970: * return: -1 error or open file handle
971: */
972: int io_dumbFile(const char *csFile, int mode, off_t size);
973:
974:
1.1 misho 975: #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