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