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