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