Annotation of libaitio/inc/aitio.h, revision 1.27
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.27 ! misho 6: * $Id: aitio.h,v 1.26.4.3 2012/11/19 15:23:31 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.24 misho 53: #include <syslog.h>
1.7 misho 54: #include <openssl/evp.h>
1.12 misho 55: #include <openssl/aes.h>
56: #include <sys/tty.h>
57: #include <sys/ioctl_compat.h>
1.13 misho 58: #include <sys/socket.h>
59: #include <sys/un.h>
1.24 misho 60: #include <sys/uio.h>
1.13 misho 61: #include <net/if_dl.h>
62: #include <netinet/in.h>
1.20 misho 63: #include <atree.h>
64: #include <ampool.h>
1.7 misho 65:
66:
1.21 misho 67: #ifndef STRSIZ
68: #define STRSIZ 256
69: #endif
70:
71: #ifndef be16toh
72: #define be16toh betoh16
73: #endif
74: #ifndef be32toh
75: #define be32toh betoh32
76: #endif
77: #ifndef be64toh
78: #define be64toh betoh64
79: #endif
80: #ifndef le16toh
81: #define le16toh letoh16
82: #endif
83: #ifndef le32toh
84: #define le32toh letoh32
85: #endif
86: #ifndef le64toh
87: #define le64toh letoh64
88: #endif
89:
1.20 misho 90: #define IO_SYSM 0
91: #define IO_MPOOL 1
92:
1.8 misho 93: #define VACUUM_LEFT 1
94: #define VACUUM_BETWEEN 2
95:
1.12 misho 96: /* AIT arrays */
1.8 misho 97:
1.9 misho 98: typedef void ** sarr_seg_t;
99: typedef struct _tagSplitArray {
100: int sarr_num;
101: int sarr_seg;
102: int sarr_siz;
103: sarr_seg_t *sarr_data;
104: } sarr_t;
105:
1.8 misho 106: typedef struct _tagArray {
1.17 misho 107: int arr_last;
1.8 misho 108: int arr_num;
109: void **arr_data;
110: } array_t;
111:
1.12 misho 112: /* AIT RPC variables and managment */
113:
114: typedef enum {
1.16 misho 115: empty, ptr, data, /* empty -> variable is not set; ptr -> void*; data -> data after struct */
1.14 misho 116: buffer, string, blob, /* buffer -> uint8_t*; string -> int8_t*; blob -> uint32_t blobID(+socket); */
1.12 misho 117: f32, f64, /* float -> f32; double -> f64 */
118: u8, u16, u32, u64, /* unsigned integers ... */
119: i8, i16, i32, i64, /* integers ... */
120: } ait_type_t;
121:
122: typedef struct {
123: uint8_t val_type;
1.21 misho 124: union {
125: struct {
126: uint8_t val_in:1;
127: uint8_t val_be:1;
128: uint8_t val_le:1;
129: uint8_t val_pad:5;
130: };
131: uint8_t val_opt;
132: };
1.17 misho 133: uint16_t val_key;
1.12 misho 134: uint32_t val_len;
135: union {
136: uint64_t net;
137:
1.14 misho 138: void *ptr;
1.12 misho 139: uint8_t *buffer;
140: int8_t *string;
141: uint32_t blob;
142: float f32;
143: double f64;
144: uint8_t u8;
145: uint16_t u16;
146: uint32_t u32;
147: uint64_t u64;
148: int8_t i8;
149: int16_t i16;
150: int32_t i32;
151: int64_t i64;
152: } val;
1.16 misho 153: uint8_t val_data[0];
1.21 misho 154: } __packed ait_val_t; /* sizeof 16 bytes */
1.12 misho 155:
156: #define AIT_TYPE(_vl) ((ait_type_t) (_vl)->val_type)
157: #define AIT_LEN(_vl) (_vl)->val_len
1.17 misho 158: #define AIT_KEY(_vl) (_vl)->val_key
1.14 misho 159: #define AIT_RAW(_vl) (_vl)->val.net
1.17 misho 160: #define AIT_ADDR(_vl) (_vl)->val.ptr
1.21 misho 161: #define AIT_IN(_vl) (_vl)->val_in
162: #define AIT_BE(_vl) (_vl)->val_be
163: #define AIT_LE(_vl) (_vl)->val_le
1.17 misho 164: #define AIT_BLOB_CHUNKS(_vl, _n) (AIT_LEN((_vl)) / _n + (AIT_LEN((_vl)) % _n) ? 1 : 0)
165: #define AIT_ISEMPTY(_vl) (AIT_TYPE((_vl)) == empty)
166:
1.18 misho 167: #define AIT_GET_LIKE(_vl, _type) ((_type) AIT_ADDR((_vl)))
1.17 misho 168:
169: #define AIT_GET_PTR(_vl) (assert(AIT_TYPE((_vl)) == ptr), (_vl)->val.ptr)
170: #define AIT_GET_DATA(_vl) (assert(AIT_TYPE((_vl)) == data), (_vl)->val_data)
171: #define AIT_GET_BUF(_vl) (assert(AIT_TYPE((_vl)) == buffer), (_vl)->val.buffer)
172: #define AIT_GET_STR(_vl) (assert(AIT_TYPE((_vl)) == string), (char*) (_vl)->val.string)
1.25 misho 173: #define AIT_GET_STRZ(_vl) (assert(AIT_TYPE((_vl)) == string), (_vl)->val.string ? \
174: (char*) (_vl)->val.string : "")
1.17 misho 175: #define AIT_GET_BLOB(_vl) (assert(AIT_TYPE((_vl)) == blob), (_vl)->val.blob)
176: #define AIT_GET_U8(_vl) (assert(AIT_TYPE((_vl)) == u8), (_vl)->val.u8)
177: #define AIT_GET_U16(_vl) (assert(AIT_TYPE((_vl)) == u16), (_vl)->val.u16)
178: #define AIT_GET_U32(_vl) (assert(AIT_TYPE((_vl)) == u32), (_vl)->val.u32)
179: #define AIT_GET_U64(_vl) (assert(AIT_TYPE((_vl)) == u64), (_vl)->val.u64)
180: #define AIT_GET_I8(_vl) (assert(AIT_TYPE((_vl)) == i8), (_vl)->val.i8)
181: #define AIT_GET_I16(_vl) (assert(AIT_TYPE((_vl)) == i16), (_vl)->val.i16)
182: #define AIT_GET_I32(_vl) (assert(AIT_TYPE((_vl)) == i32), (_vl)->val.i32)
183: #define AIT_GET_I64(_vl) (assert(AIT_TYPE((_vl)) == i64), (_vl)->val.i64)
184: #define AIT_GET_F32(_vl) (assert(AIT_TYPE((_vl)) == f32), (_vl)->val.f32)
185: #define AIT_GET_F64(_vl) (assert(AIT_TYPE((_vl)) == f64), (_vl)->val.f64)
1.12 misho 186:
1.23 misho 187: #define AIT_SET_DATA(_vl, _p, _len) do { ait_val_t *__val = io_realloc((_vl), (sizeof(ait_val_t) + _len)); \
1.16 misho 188: if (__val) { \
1.23 misho 189: void *__p = (_p); \
190: if (__p) \
191: memcpy(__val->val_data, __p, _len); \
1.16 misho 192: __val->val_type = data; AIT_LEN(__val) = _len; \
1.23 misho 193: (_vl) = __val; \
1.16 misho 194: } \
195: } while (0);
1.14 misho 196: #define AIT_SET_PTR(_vl, _p, _len) do { ait_val_t *__val = (_vl); assert(__val); \
1.20 misho 197: __val->val_type = ptr; __val->val.ptr = _p; \
198: AIT_LEN(__val) = _len; } while (0)
1.18 misho 199: #define AIT_RE_BUF(_vl, _len) do { ait_val_t *__val = (_vl); assert(__val); \
1.20 misho 200: void *__ptr = io_realloc(AIT_GET_BUF(__val), _len); \
1.18 misho 201: if (__ptr) { \
202: __val->val.buffer = __ptr; AIT_LEN(__val) = _len; \
203: } } while (0)
204: #define AIT_SET_BUF2(_vl, _c, _len) do { ait_val_t *__val = (_vl); assert(__val); \
1.20 misho 205: __val->val.buffer = io_malloc(_len); \
1.18 misho 206: if (__val->val.buffer) { \
207: __val->val_type = buffer; AIT_LEN(__val) = _len; \
208: memset(__val->val.buffer, _c, _len); \
209: } } while (0)
1.23 misho 210: #define AIT_SET_BUF(_vl, _v, _len) do { ait_val_t *__val = (_vl); void *__p = (_v); assert(__val); \
1.20 misho 211: __val->val.buffer = io_malloc(_len); \
1.12 misho 212: if (__val->val.buffer) { \
213: __val->val_type = buffer; AIT_LEN(__val) = _len; \
1.23 misho 214: if (__p) \
215: memcpy(__val->val.buffer, __p, _len); \
1.18 misho 216: else \
217: memset(__val->val.buffer, 0, _len); \
1.12 misho 218: } } while (0)
1.23 misho 219: #define AIT_SET_STR(_vl, _v) do { ait_val_t *__val = (_vl); const char *__s = (_v); assert(__val); \
220: __val->val_type = string; \
1.25 misho 221: if (__s) { \
1.23 misho 222: __val->val.string = (int8_t*) io_strdup(__s); \
223: AIT_LEN(__val) = strlen((const char*) \
224: __val->val.string) + 1; \
225: } else { \
226: __val->val.string = NULL; \
227: AIT_LEN(__val) = 0; \
228: } \
229: } while (0)
230: #define AIT_SET_STRSIZ(_vl, _len) do { ait_val_t *__val = (_vl); assert(__val); \
231: __val->val.string = (int8_t*) io_malloc(_len); \
1.12 misho 232: if (__val->val.string) { \
1.23 misho 233: __val->val_type = string; AIT_LEN(__val) = _len; \
234: memset(__val->val.string, 0, _len); \
235: } \
236: } while (0)
237: #define AIT_SET_STRCAT(_vl, _v) do { ait_val_t *__val = (_vl); const char *__s = (_v); int __l; \
238: assert(__val); assert(AIT_TYPE(__val) == string); \
239: if (!__s || !*__s) \
240: break; \
241: else \
242: __l = strlen(__s); \
243: if (!__val->val.string) \
244: __l++; \
245: void *__p = io_realloc(__val->val.string, AIT_LEN(__val) + __l); \
246: if (__p) { \
247: AIT_LEN(__val) += __l; \
1.26 misho 248: if (!__val->val.string) \
249: memset(__p, 0, AIT_LEN(__val)); \
1.23 misho 250: __val->val.string = __p; \
251: strlcat((char*) __val->val.string, __s, \
252: AIT_LEN(__val)); \
253: } \
254: } while (0)
255: #define AIT_SET_STRCPY(_vl, _v) do { ait_val_t *__val = (_vl); const char *__s = (_v); int __l; \
256: assert(__val); assert(AIT_TYPE(__val) == string); \
257: if (!__s || !*__s) \
258: break; \
259: else \
260: __l = strlen(__s) + 1; \
261: void *__p = io_realloc(__val->val.string, __l); \
262: if (__p) { \
263: AIT_LEN(__val) = __l; \
264: __val->val.string = __p; \
265: strlcpy((char*) __val->val.string, __s, \
266: AIT_LEN(__val)); \
1.12 misho 267: } } while (0)
1.23 misho 268: #define AIT_SET_STRLCPY(_vl, _v, _len) do { ait_val_t *__val = (_vl); const char *__s = (_v); \
269: assert(__val); assert(AIT_TYPE(__val) == string); \
270: if (!__s || !*__s) \
271: break; \
272: void *__p = io_realloc(__val->val.string, _len); \
1.14 misho 273: if (__p) { \
1.23 misho 274: AIT_LEN(__val) = _len; \
1.14 misho 275: __val->val.string = __p; \
1.23 misho 276: strlcpy((char*) __val->val.string, __s, \
1.17 misho 277: AIT_LEN(__val)); \
1.14 misho 278: } } while (0)
1.12 misho 279: #define AIT_SET_BLOB(_vl, _n, _len) do { ait_val_t *__val = (_vl); assert(__val); \
1.20 misho 280: __val->val_type = blob; __val->val.blob = _n; \
281: AIT_LEN(__val) = _len; } while (0)
1.12 misho 282: #define AIT_SET_BLOB2(_vl, _bv) do { ait_val_t *__val = (_vl); assert(__val); assert((_bv)); \
1.23 misho 283: __val->val_type = blob; AIT_LEN(__val) = \
284: (_bv)->blob_len; \
1.12 misho 285: __val->val.blob = (_bv)->blob_var; } while (0)
286: #define AIT_NEW_BLOB(_vl, _len) AIT_SET_BLOB((_vl), 0, _len)
287:
288: #define AIT_SET_U8(_vl, _n) do { ait_val_t *__val = (_vl); assert(__val); \
289: __val->val_type = u8; __val->val.u8 = _n; \
290: AIT_LEN(__val) = sizeof(uint8_t); } while (0)
291: #define AIT_SET_U16(_vl, _n) do { ait_val_t *__val = (_vl); assert(__val); \
292: __val->val_type = u16; __val->val.u16 = _n; \
293: AIT_LEN(__val) = sizeof(uint16_t); } while (0)
294: #define AIT_SET_U32(_vl, _n) do { ait_val_t *__val = (_vl); assert(__val); \
295: __val->val_type = u32; __val->val.u32 = _n; \
296: AIT_LEN(__val) = sizeof(uint32_t); } while (0)
297: #define AIT_SET_U64(_vl, _n) do { ait_val_t *__val = (_vl); assert(__val); \
298: __val->val_type = u64; __val->val.u64 = _n; \
299: AIT_LEN(__val) = sizeof(uint64_t); } while (0)
300: #define AIT_SET_I8(_vl, _n) do { ait_val_t *__val = (_vl); assert(__val); \
301: __val->val_type = i8; __val->val.i8 = _n; \
302: AIT_LEN(__val) = sizeof(int8_t); } while (0)
303: #define AIT_SET_I16(_vl, _n) do { ait_val_t *__val = (_vl); assert(__val); \
304: __val->val_type = i16; __val->val.i16 = _n; \
305: AIT_LEN(__val) = sizeof(int16_t); } while (0)
306: #define AIT_SET_I32(_vl, _n) do { ait_val_t *__val = (_vl); assert(__val); \
307: __val->val_type = i32; __val->val.i32 = _n; \
308: AIT_LEN(__val) = sizeof(int32_t); } while (0)
309: #define AIT_SET_I64(_vl, _n) do { ait_val_t *__val = (_vl); assert(__val); \
310: __val->val_type = i64; __val->val.i64 = _n; \
311: AIT_LEN(__val) = sizeof(int64_t); } while (0)
312: #define AIT_SET_F32(_vl, _n) do { ait_val_t *__val = (_vl); assert(__val); \
313: __val->val_type = f32; __val->val.f32 = _n; \
314: AIT_LEN(__val) = sizeof(float); } while (0)
315: #define AIT_SET_F64(_vl, _n) do { ait_val_t *__val = (_vl); assert(__val); \
316: __val->val_type = f64; __val->val.f64 = _n; \
317: AIT_LEN(__val) = sizeof(double); } while (0)
318:
1.24 misho 319: #define AIT_COPY_VAL(_vl, _v) do { assert((_vl)); assert((_v)); \
320: memcpy((_vl), (_v), sizeof(ait_val_t)); \
321: switch (AIT_TYPE((_vl))) { \
1.18 misho 322: case buffer: \
1.24 misho 323: AIT_SET_BUF((_vl), \
1.23 misho 324: AIT_GET_BUF((_v)), \
325: AIT_LEN((_v))); \
1.18 misho 326: break; \
327: case string: \
1.24 misho 328: AIT_SET_STR((_vl), \
1.23 misho 329: AIT_GET_STR((_v))); \
1.18 misho 330: break; \
331: default: \
332: break; \
333: } \
334: } while (0)
1.23 misho 335: #define AIT_COPY_DATA(_vl, _v) do { AIT_COPY_VAL((_vl), (_v)); \
1.18 misho 336: if (AIT_TYPE((_vl)) == data) \
1.23 misho 337: AIT_SET_DATA((_vl), AIT_GET_DATA((_v)), \
338: AIT_LEN((_v))); \
1.18 misho 339: } while (0)
340:
1.17 misho 341: #define AIT_INIT_VAL(_vl) (memset((_vl), 0, sizeof(ait_val_t)))
1.23 misho 342: #define AIT_INIT_VAL2(_vl, _t) do { \
343: AIT_INIT_VAL((_vl)); \
344: (_vl)->val_type = _t; \
345: } while (0)
1.26 misho 346: #define AIT_SET_LIKE(_vl, _t, _l, _v) (assert((_vl)), io_setlikeVar((_vl), _t, _l, _v))
1.20 misho 347: /* if attribute zeroCopy is set not execute io_free() */
1.16 misho 348: #define AIT_FREE_VAL(_vl) do { ait_val_t *__val = (_vl); assert(__val); \
349: switch (AIT_TYPE(__val)) { \
1.12 misho 350: case buffer: \
1.21 misho 351: if (!__val->val_in && \
352: __val->val.buffer) \
1.20 misho 353: io_free(__val->val.buffer); \
1.21 misho 354: __val->val.buffer = NULL; \
1.12 misho 355: break; \
356: case string: \
1.21 misho 357: if (!__val->val_in && \
358: __val->val.string) \
1.20 misho 359: io_free(__val->val.string); \
1.21 misho 360: __val->val.string = NULL; \
1.12 misho 361: break; \
362: default: \
363: break; \
364: } \
365: __val->val_type = empty; \
1.21 misho 366: __val->val_opt ^= __val->val_opt; \
1.12 misho 367: AIT_LEN(__val) = 0; \
1.21 misho 368: AIT_KEY(__val) = 0; \
1.12 misho 369: } while (0)
1.22 misho 370: #define AIT_ZERO_VAL(_vl) do { ait_val_t *__val = (_vl); assert(__val); \
371: switch (AIT_TYPE(__val)) { \
372: case buffer: \
373: case string: \
1.23 misho 374: if (__val->val.buffer) \
375: memset(__val->val.buffer, 0, \
1.22 misho 376: AIT_LEN(__val)); \
377: break; \
378: case data: \
1.23 misho 379: memset(__val->val_data, 0, AIT_LEN(__val)); \
1.22 misho 380: break; \
381: default: \
382: __val->val.net = 0LL; \
383: break; \
384: } \
385: AIT_KEY(__val) = 0; \
386: } while (0)
1.12 misho 387:
388: struct io_ether_addr {
389: u_int8_t ether_addr_octet[6];
390: };
1.13 misho 391: typedef struct io_ether_addr io_ether_addr_t;
392:
393: typedef union {
394: struct sockaddr_storage ss;
395: struct sockaddr sa;
396: struct sockaddr_un sun;
397: struct sockaddr_in sin;
398: struct sockaddr_in6 sin6;
399: struct sockaddr_dl sdl;
400: } io_sockaddr_t;
1.21 misho 401: #define IO_SOCKADDR_INIT { .ss = { 0 } }
1.12 misho 402:
1.3 misho 403:
1.26 misho 404: #define io_align(x, a) (((x) + ((a) - 1)) & ~((a) - 1))
1.15 misho 405:
406:
1.1 misho 407: // io_GetErrno() Get error code of last operation
408: inline int io_GetErrno();
409: // io_GetError() Get error text of last operation
410: inline const char *io_GetError();
411:
412:
1.20 misho 413: // io_mm_inuse() Check for memory management model
414: inline int io_mm_inuse();
415:
416: /*
417: * ioLibInit() - Init libaitio library memory management
418: *
419: * @mm = memory management (IO_SYSM or IO_MPOOL)
420: * @maxmem = memory limit
421: * return: -1 error or !=-1 used memory management model
422: */
423: inline int ioLibInit(int mm, unsigned long maxmem);
424: /*
425: * ioLibFini() - Finish libaitio library memory management
426: *
427: * return: none
428: */
429: inline void ioLibFini();
430:
431: /* memory management hooks */
432: extern void *(*io_malloc)(size_t);
433: extern void *(*io_calloc)(size_t, size_t);
434: extern void *(*io_realloc)(void*, size_t);
435: extern char *(*io_strdup)(const char*);
436: extern void (*io_free)(void*);
437:
438:
1.1 misho 439: /*
1.26 misho 440: * io_usleep() - usleep() replacement for ELWIX
441: *
442: * @usec = microseconds for sleep
443: * return: -1 interrupted by signal or 0 ok
444: */
445: inline int io_usleep(unsigned int usec);
446: /*
1.17 misho 447: * io_ether_ntoa() - Convert ethernet address to string
1.16 misho 448: *
1.12 misho 449: * @n = ethernet address structure, like struct ether_addr
450: * @a = string
451: * @len = string length
452: * return: NULL error or !=NULL string a
453: */
454: inline char *io_ether_ntoa(const struct io_ether_addr *n, char * __restrict a, int len);
455: /*
1.17 misho 456: * io_ether_aton() - Convert string to ethernet address
1.16 misho 457: *
1.12 misho 458: * @a = string
459: * @e = ethernet address structure, like struct ether_addr
460: * return: NULL error or !=NULL ethernet address structure
461: */
462: inline struct io_ether_addr *io_ether_aton(const char *a, struct io_ether_addr *e);
1.13 misho 463: /*
1.17 misho 464: * io_n2port() - Extract port from network structure
1.16 misho 465: *
1.13 misho 466: * @addr = Address
467: * return: 0 not supported family type or port number
468: */
1.27 ! misho 469: inline unsigned short io_n2port(io_sockaddr_t * __restrict addr);
1.13 misho 470: /*
1.17 misho 471: * io_n2addr() - Extract address from network structure
1.16 misho 472: *
1.13 misho 473: * @addr = Address
474: * @val = Value for store string address
475: * return: NULL error or !=NULL string address from val
476: */
477: const char *io_n2addr(io_sockaddr_t * __restrict addr, ait_val_t * __restrict val);
478: /*
1.17 misho 479: * io_gethostbyname() - Get host and port and make network structure
1.16 misho 480: *
1.13 misho 481: * @psHost = Hostname
482: * @port = Port
483: * @addr = Network address structure
484: * return: NULL error or !=NULL network structure
485: */
486: io_sockaddr_t *io_gethostbyname(const char *psHost, unsigned short port,
487: io_sockaddr_t * __restrict addr);
1.27 ! misho 488: /*
! 489: * io_addrcmp() - Compare network addresses
! 490: *
! 491: * @a = 1st address
! 492: * @b = 2nd address
! 493: * @p = compare and ports, if family is AF_INET or AF_INET6
! 494: * return: 0 is equal or !=0 is different
! 495: */
! 496: int io_addrcmp(io_sockaddr_t * __restrict a, io_sockaddr_t * __restrict b, int p);
1.12 misho 497:
498: /*
1.17 misho 499: * io_vars2buffer() - Marshaling data from array with variables to buffer
1.16 misho 500: *
1.12 misho 501: * @buf = Buffer
502: * @buflen = Size of buffer
503: * @vars = Variable array
504: * return: -1 error, 0 nothing done or >0 size of marshaled data
505: */
1.21 misho 506: inline int io_vars2buffer(unsigned char * __restrict buf, int buflen,
507: array_t * __restrict vars);
1.12 misho 508: /*
1.17 misho 509: * io_buffer2vars() - De-marshaling data from buffer to array with variables
1.16 misho 510: *
1.12 misho 511: * @buf = Buffer
512: * @buflen = Size of buffer
513: * @vnum = Number of variables into buffer
514: * @zcpy = Zero-copy for variables, if !=0 don't use io_arrayFree() for free variables and
515: *DON'T MODIFY OR DESTROY BUFFER*. =0 call io_arrayFree() before io_arrayDestroy()
516: * return: =NULL error, !=NULL allocated variable array, after use must free with io_arrayDestroy()
517: */
1.21 misho 518: inline array_t *io_buffer2vars(unsigned char * __restrict buf, int buflen, int vnum, int zcpy);
1.12 misho 519: /*
1.17 misho 520: * io_vars2map() - Marshaling data from array with variables to memory map
1.16 misho 521: *
1.12 misho 522: * @buf = Buffer
523: * @buflen = Size of buffer
524: * @vars = Variable array
525: * return: -1 error, 0 nothing done or >0 size of marshaled data
526: */
1.21 misho 527: inline int io_vars2map(unsigned char * __restrict buf, int buflen,
528: array_t * __restrict vars);
1.12 misho 529: /*
1.17 misho 530: * io_map2vars() - De-marshaling data from memory map to array with variables
1.16 misho 531: *
1.12 misho 532: * @buf = Buffer
533: * @buflen = Size of buffer
534: * @vnum = Number of variables into buffer
535: * @zcpy = Zero-copy for variables, if !=0 don't use io_arrayFree() for free variables and
536: *DON'T MODIFY OR DESTROY BUFFER*. =0 call io_arrayFree() before io_arrayDestroy()
537: * return: =NULL error, !=NULL allocated variable array, after use must free with io_arrayDestroy()
538: */
1.21 misho 539: inline array_t *io_map2vars(unsigned char * __restrict buf, int buflen, int vnum, int zcpy);
1.13 misho 540:
541: /*
1.17 misho 542: * io_allocVar() - Allocate memory for variable
1.16 misho 543: *
1.14 misho 544: * return: NULL error or new variable, after use free variable with io_freeVar()
545: */
546: inline ait_val_t *io_allocVar(void);
547: /*
1.17 misho 548: * io_freeVar() - Free allocated memory for variable
1.16 misho 549: *
1.14 misho 550: * @val = Variable
551: * return: none
552: */
1.17 misho 553: inline void io_freeVar(ait_val_t ** __restrict val);
1.14 misho 554: /*
1.23 misho 555: * io_makeVar() - Allocate memory and fill variable
556: *
557: * @type = type of variable
558: * @... = arg1 is value of variable
559: * @... = arg2 is length of variabla. Not required for numbers and strings!
560: * return: NULL error or new variable, after use free variable with io_freeVar()
561: */
562: ait_val_t *io_makeVar(ait_type_t type, ...);
563: /*
1.26 misho 564: * io_setlikeVar() - Set variable like ...
565: *
566: * @v = variable
567: * @t = type of data
568: * @l = length of data
569: * @... = data
570: * return: -1 error or 0 ok
571: */
1.27 ! misho 572: inline int io_setlikeVar(ait_val_t * __restrict v, ait_type_t t, unsigned int l, ...);
1.26 misho 573: /*
574: * io_sprintfVar() - Builtin string variable from formatted input
575: *
576: * @v = variable
577: * @fmt = format string
578: * @... = argument(s)
579: * return: -1 error or >0 copied bytes to variable
580: */
581: int io_sprintfVar(ait_val_t * __restrict v, const char *fmt, ...);
582: /*
583: * io_cmpVar() - Compare two variables
584: *
585: * @a = 1st variable
586: * @b = 2nd variable
587: * return: 0 is equal or !=0 is different
588: */
589: inline int io_cmpVar(ait_val_t * __restrict a, ait_val_t * __restrict b);
590: /*
1.25 misho 591: * io_hashVar() - Generate hash key for variable from string or value
592: *
593: * @v = variable
594: * @key = key string for hash, if =NULL hash will built from variable
595: * return: hash key
596: */
597: unsigned short io_hashVar(ait_val_t * __restrict v, const char * __restrict key);
598: /*
1.17 misho 599: * io_allocVars() - Allocate ait_val_t array
1.16 misho 600: *
1.13 misho 601: * @varnum = Number of variables
602: * return: =NULL error or !=NULL allocated array
603: */
604: inline array_t *io_allocVars(int varnum);
605: /*
1.17 misho 606: * io_clrVars() - Clear ait_val_t elements from array
1.16 misho 607: *
1.13 misho 608: * @vars = Variable array
609: * return: -1 error or size of array
610: */
611: inline int io_clrVars(array_t * __restrict vars);
612: /*
1.17 misho 613: * io_freeVars() - Free ait_val_t array
1.16 misho 614: *
1.13 misho 615: * @vars = Variable array
616: * return: none
617: */
618: inline void io_freeVars(array_t ** __restrict vars);
1.17 misho 619: /*
1.18 misho 620: * io_getVars() - Get ait_val_t element from array and if not exists allocate it
621: *
622: * @vars = Variable array
623: * @n = index of variable into array
624: * return: NULL error or !=NULL ait_val_t element
625: */
626: inline ait_val_t *io_getVars(array_t ** __restrict vars, int n);
627: /*
1.21 misho 628: * io_sortVarsByKey() - Sorting array with variables by key
629: *
630: * @vars = Variable array
631: * @order = Sort order. If =0 ascend or !=0 descend
632: * return: none
633: */
634: inline void io_sortVarsByKey(array_t * __restrict vars, int order);
635: /*
636: * io_sortVarsByVal() - Sorting array with variables by value
1.17 misho 637: *
638: * @vars = Variable array
1.21 misho 639: * @order = Sort order. If =0 ascend or !=0 descend
640: * @cmp = Custom compare function for sorting. If =NULL compare by value
1.17 misho 641: * return: none
642: */
1.21 misho 643: inline void io_sortVarsByVal(array_t * __restrict vars, int order,
1.17 misho 644: int (*cmp)(const void*, const void*));
645: /*
646: * io_findKeyVars() - Find variable by key from array
647: *
648: * @vars = Variables
649: * @key = Search key
650: * return: NULL error or not found, !=NULL valid element
651: */
1.27 ! misho 652: ait_val_t *io_findKeyVars(array_t * __restrict vars, unsigned short key);
1.25 misho 653: /*
654: * io_findKeyHash() - Find variable by hash string from array
655: *
656: * @vars = Variables
657: * @key = Search string
658: * return: NULL error or not found, !=NULL valid element
659: */
660: inline ait_val_t *io_findKeyHash(array_t * __restrict vars, const char * __restrict key);
661: /*
662: * io_hashKeyVars() - Generate hash keys for variables
663: *
664: * @vars = Variables
665: * return -1 error or 0 ok
666: */
667: inline int io_hashKeyVars(array_t * __restrict vars);
1.13 misho 668:
1.12 misho 669:
670: /*
1.17 misho 671: * ioPromptRead() - Read data from input h[0] with prompt to output h[1]
1.16 misho 672: *
1.1 misho 673: * @h = file handles h[0] = input, h[1] = output, if NULL use stdin, stdout
674: * @csPrompt = Prompt before input, may be NULL
675: * @psData = Readed data
676: * @dataLen = Length of data
677: * return: 0 EOF; -1 error:: can`t read; >0 count of readed chars
678: */
679: int ioPromptRead(int *h, const char *csPrompt, char * __restrict psData, int dataLen);
680: /*
1.17 misho 681: * ioPromptPassword() - Read password from input h[0] with prompt to output h[1]
1.16 misho 682: *
1.1 misho 683: * @h = file handles h[0] = input, h[1] = output, if NULL use stdin, stdout
684: * @csPrompt = Prompt before input, may be NULL
685: * @psPass = Readed password
686: * @passLen = Length of password
687: * @confirm = Confirm password, 0 - get password, !=0 Ask for confirmation
688: * return: 0 EOF; -1 error:: can`t read; >0 count of readed chars
689: */
690: int ioPromptPassword(int *h, const char *csPrompt, char * __restrict psPass, int passLen, int confirm);
691:
692: /*
1.17 misho 693: * ioRegexVerify() - Function for verify data match in regex expression
1.16 misho 694: *
1.1 misho 695: * @csRegex = Regulare expression pattern
696: * @csData = Data for check and verify
697: * @startPos = Return start positions
698: * @endPos = Return end positions
699: * return: NULL not match or error; !=NULL begin of matched data
700: */
701: const char *ioRegexVerify(const char *csRegex, const char *csData, int *startPos, int *endPos);
702: /*
1.17 misho 703: * ioRegexGet() - Function for get data match in regex expression
1.16 misho 704: *
1.1 misho 705: * @csRegex = Regulare expression pattern
706: * @csData = Data from get
707: * @psString = Returned string if match
708: * @strLen = Length of string
709: * return: 0 not match; >0 count of returned chars
710: */
711: int ioRegexGet(const char *csRegex, const char *csData, char * __restrict psString, int strLen);
712: /*
1.17 misho 713: * ioRegexReplace() - Function for replace data match in regex expression with newdata
1.16 misho 714: *
1.1 misho 715: * @csRegex = Regulare expression pattern
716: * @csData = Source data
717: * @csNew = Data for replace
1.20 misho 718: * return: NULL not match or error; !=NULL allocated new string, must be io_free after use!
1.1 misho 719: */
720: char *ioRegexReplace(const char *csRegex, const char *csData, const char *csNew);
721:
1.2 misho 722: /*
1.17 misho 723: * ioStrAst() - Function for evaluate string like asterisk variable "{text[:[-]#[:#]]}"
1.16 misho 724: *
1.6 misho 725: * @csString = Input string
1.20 misho 726: * return: NULL error, !=NULL Allocated new string evaluated from input string, must be io_free()
1.6 misho 727: */
1.13 misho 728: char *ioStrAst(const char *csString);
1.6 misho 729:
730: /*
1.17 misho 731: * io_UnquotStr() - Remove quots from input text string
1.16 misho 732: *
1.4 misho 733: * @psLine = Text string
734: * return: 0 nothing to do; 1 successful unquoted string
735: */
1.17 misho 736: inline int io_UnquotStr(char * __restrict psLine);
1.4 misho 737: /*
1.17 misho 738: * io_LTrimStr() - Remove left whitespaces from text string
1.16 misho 739: *
1.4 misho 740: * @psLine = Text string
741: * return: 0 nothing to do; !=0 Removed bytes
742: */
1.17 misho 743: inline int io_LTrimStr(char * __restrict psLine);
1.4 misho 744: /*
1.17 misho 745: * io_RTrimStr() - Remove right whitespaces from text string
1.16 misho 746: *
1.4 misho 747: * @psLine = Text string
748: * return: 0 nothing to do; !=0 Removed bytes
749: */
1.17 misho 750: inline int io_RTrimStr(char * __restrict psLine);
1.4 misho 751: /*
1.17 misho 752: * io_TrimStr() - Remove left and right whitespaces from text string
1.16 misho 753: *
1.4 misho 754: * @psLine = Text string
755: * return: 0 nothing to do; !=0 Removed bytes
756: */
1.17 misho 757: inline int io_TrimStr(char * __restrict psLine);
1.4 misho 758: /*
1.17 misho 759: * io_Ch2Hex() - Convert from Char string to Hex string
1.16 misho 760: *
1.4 misho 761: * @psLine = Text string
762: * @lineLen = Length of Text string
1.20 misho 763: * return: NULL nothing to do or error; !=0 Allocated new converted data without term\0 (must be io_free)
1.4 misho 764: */
1.5 misho 765: inline unsigned char *io_Ch2Hex(unsigned char *psLine, int lineLen);
1.4 misho 766: /*
1.17 misho 767: * io_Hex2Ch() - Convert from Hex string to Char string
1.16 misho 768: *
1.4 misho 769: * @psLine = Text string
770: * @lineLen = Length of Text string
1.20 misho 771: * return: NULL nothing to do or error; !=0 Allocated new converted string(must be io_free)
1.4 misho 772: */
1.5 misho 773: inline char *io_Hex2Ch(unsigned char *psLine, int lineLen);
1.4 misho 774:
775: /*
1.15 misho 776: * io_Path2File() - Parse and make path/filename pair
777: *
778: * @csArgs = Input argument line
779: * @psPath = Output Path, if ==NULL path not returned
780: * @pathLen = Size of path array
781: * @psFile = Output File
782: * @fileLen = Size of file array
783: * return: 0 error format; -1 error:: can`t read; >0 ok, number of readed items
784: */
785: inline int
786: io_Path2File(const char * __restrict csArgs, char * __restrict psPath,
787: int pathLen, char * __restrict psFile, int fileLen);
788:
789: /*
1.8 misho 790: * io_arrayInit() - Create and initialize dynamic array
1.16 misho 791: *
1.8 misho 792: * @numItems = Number of Items
793: * return: NULL error, != NULL allocated memory for array
794: */
795: inline array_t *io_arrayInit(int numItems);
796: /*
1.10 misho 797: * io_arrayDestroy() - Free and destroy dynamic array
1.16 misho 798: *
1.8 misho 799: * @parr = Array
800: * return: none
801: */
802: inline void io_arrayDestroy(array_t ** __restrict parr);
803: /*
1.10 misho 804: * io_arrayFree() - Free all data in dynamic array items
1.8 misho 805: * (WARNING! If assign static array dont use this!!!)
1.16 misho 806: *
1.8 misho 807: * @arr = Array
808: * return: none
809: */
810: inline void io_arrayFree(array_t * __restrict arr);
811: /*
1.10 misho 812: * io_arrayFrom() - Create and fill array from array with pointers
1.16 misho 813: *
1.11 misho 814: * @pargv = Array with pointers
1.10 misho 815: * @argc = Number of Items, if 0 walk through argv and stop when reach NULL item
1.11 misho 816: * return: NULL error, != NULL allocated new array
1.10 misho 817: */
1.11 misho 818: inline array_t *io_arrayFrom(const char *** __restrict pargv, int argc);
1.10 misho 819: /*
820: * io_arrayTo() - Create and fill array with pointers from dynamic array
1.16 misho 821: *
1.10 misho 822: * @arr = Array
1.11 misho 823: * return: NULL error, != NULL allocated memory for array, NULL terminated
1.10 misho 824: */
825: inline char **io_arrayTo(array_t * __restrict arr);
826: /*
1.8 misho 827: * io_arrayLen() - Get last used element in dynamic array (array Length)
1.16 misho 828: *
1.8 misho 829: * @arr = Array
1.17 misho 830: * return: -1 empty or >-1 position of last used element
1.8 misho 831: */
832: inline int io_arrayLen(array_t * __restrict arr);
833: /*
1.10 misho 834: * io_arrayConcat() Concat source array to destination array
1.16 misho 835: *
1.10 misho 836: * @dest = Destination array
837: * @src = Source array
838: * return: -1 error; >0 new count of destination array
839: */
840: int io_arrayConcat(array_t * __restrict dest, array_t * __restrict src);
841: /*
1.12 misho 842: * io_arrayCopy() Copy source array to destination array
1.16 misho 843: *
1.12 misho 844: * @dest = Destination array, after use free with io_arrayDestroy()
845: * @src = Source array
846: * return: -1 error; >0 count of destination array
847: */
848: int io_arrayCopy(array_t ** __restrict dest, array_t * __restrict src);
849: /*
1.8 misho 850: * io_arrayGrow() - Grow/Shrink dynamic array, Use with care when it shrink!!!
1.16 misho 851: *
1.8 misho 852: * @arr = Array
853: * @newNumItems = Number of Items
1.12 misho 854: * @freeShrink = Free elements before shrink array
1.8 misho 855: * return: -1 error, 0 ok
856: */
1.12 misho 857: int io_arrayGrow(array_t * __restrict arr, int newNumItems, int freeShrink);
1.8 misho 858: /*
859: * io_arrayVacuum() - Vacuum dynamic array, empty elements will be deleted
1.16 misho 860: *
1.8 misho 861: * @arr = Array
862: * @fromWhere = 1 begin, 2 ALL empty elements
863: * return: -1 error, 0 ok
864: */
865: int io_arrayVacuum(array_t * __restrict arr, int fromWhere);
866:
1.12 misho 867: #define io_arraySize(_arr) ((_arr) ? (_arr)->arr_num : 0)
1.17 misho 868: #define io_arrayLast(_arr) (io_arraySize((_arr)) ? (_arr)->arr_last : -1)
1.12 misho 869: #define io_arrayZero(_arr) (assert((_arr)), memset((_arr)->arr_data, 0, \
870: io_arraySize((_arr)) * sizeof(void*)))
1.8 misho 871:
1.17 misho 872: #define io_arrayGet2(_arr, _d) (assert((_arr) && (_arr)->arr_num > _d), ((_arr)->arr_data + _d))
1.18 misho 873: #define io_arrayGet(_arr, _d) (assert((_arr) && (_arr)->arr_num > _d), (_arr)->arr_data[_d])
1.11 misho 874: #define io_array(_arr, _d, _type) (assert((_arr) && (_arr)->arr_num > _d), \
1.18 misho 875: ((_type) (_arr)->arr_data[_d]))
1.8 misho 876: #define io_arraySet(_arr, _d, _ptr) do { \
1.11 misho 877: assert((_arr) && (_arr)->arr_num > _d); \
1.17 misho 878: if ((_arr)->arr_last < _d) \
879: (_arr)->arr_last = _d; \
1.18 misho 880: (_arr)->arr_data[_d] = (void*) (_ptr); \
1.8 misho 881: } while (0)
1.11 misho 882: #define io_arrayDel(_arr, _d, _fri) do { \
883: assert((_arr) && (_arr)->arr_num > _d); \
1.18 misho 884: if (_fri && (_arr)->arr_data[_d]) \
885: free((_arr)->arr_data[_d]); \
886: (_arr)->arr_data[_d] = NULL; \
1.17 misho 887: } while (0)
1.8 misho 888:
889: /*
1.13 misho 890: * io_arrayElem() - Always GET/PUT element into dynamic array, if not enough elements grow array
1.16 misho 891: *
1.13 misho 892: * @arr = Array
893: * @n = Position
894: * @data = Element, if set NULL GET element at position or !=NULL PUT element at position
895: * return: -1 error or !=-1 return element at position
896: */
1.14 misho 897: inline void *io_arrayElem(array_t * __restrict arr, int n, void *data);
1.13 misho 898: /*
1.8 misho 899: * io_arrayPush() - Push element into dynamic array like stack manner, place at first empty position
1.16 misho 900: *
1.8 misho 901: * @arr = Array
902: * @data = Element, if set NULL return only first empty position
1.17 misho 903: * @mayGrow = Array may to grow, if not enough room for new element
1.8 misho 904: * return: -1 not found empty position, array is full!, >-1 return position of stored element into array
905: */
1.17 misho 906: inline int io_arrayPush(array_t * __restrict arr, void **data, int mayGrow);
1.8 misho 907: /*
908: * io_arrayPop() - Pop element from dynamic array like stack manner, last used position
1.16 misho 909: *
1.8 misho 910: * @arr = Array
1.11 misho 911: * @data = Element, if set NULL return only last used position
1.8 misho 912: * @delAfter = Delete after Pop element, !=0 delete element from array after return data
913: * return: -1 not found used position, array is empty!, >-1 return element position
914: */
915: inline int io_arrayPop(array_t * __restrict arr, void ** __restrict data, int delAfter);
916:
917: /*
1.17 misho 918: * io_argsNum() - Parse and calculate number of arguments
1.16 misho 919: *
1.8 misho 920: * @csArgs = Input arguments line
921: * @csDelim = Delimiter(s) for separate
922: * return: 0 error format; -1 error:: can`t read; >0 ok, number of items
923: */
924: inline int io_argsNum(const char *csArgs, const char *csDelim);
925:
926: /*
1.17 misho 927: * io_arrayMake() - Parse and make array from arguments ... (input string will be modified!!!
1.8 misho 928: * and output array must be free with io_arrayDestroy() after use!)
1.16 misho 929: *
1.8 misho 930: * @psArgs = Input arguments line, after execute string is modified!!!
931: * @nargs = Maximum requested count of arguments from input string psArgs, if 0 all psArgs
932: * @csDelim = Delimiter(s) for separate
1.20 misho 933: * @parr = Output array of arguments ... (must be io_free with io_arrayDestroy() after use!)
1.8 misho 934: * return: 0 error format; -1 error:: can`t read; >0 ok, number of readed items
935: */
936: int io_arrayMake(char * __restrict psArgs, int nargs, const char *csDelim,
937: array_t ** __restrict parr);
938:
939: /*
1.17 misho 940: * io_MakeAV() - Parse and make attribute/value pair
1.16 misho 941: *
1.8 misho 942: * @csArgs = Input argument line
943: * @csDelim = Delimiter for separate
944: * @psAttr = Output Attribute
945: * @attrLen = Size of attribute array
946: * @psValue = Output Value, if ==NULL this element not present value or not wanted for return
947: * @valLen = Size of value array
948: * return: 0 error format; -1 error:: can`t read; >0 ok, number of readed items
949: */
950: int io_MakeAV(const char * __restrict csArgs, const char *csDelim,
951: char * __restrict psAttr, int attrLen, char * __restrict psValue, int valLen);
1.23 misho 952: /*
953: * io_MakeAV2() Parse and make attribute/value pair over input string
954: *
955: * @csArgs = Input argument line, will be modified!
956: * @csDelim = Delimiter for separate
957: * @psAttr = Output Attribute
958: * @psValue = Output Value, if ==NULL this element not present value or not wanted for return
959: * return: 0 error format; -1 error:: can`t read; >0 ok, number of readed items
960: */
961: int io_MakeAV2(char * __restrict psArgs, const char *csDelim,
962: char ** __restrict psAttr, char ** __restrict psValue);
1.8 misho 963:
1.9 misho 964: /*
965: * io_sarrInit() - Create and initialize dynamic split-order array
1.16 misho 966: *
1.9 misho 967: * @numItems = Number of Items
968: * @segLen = Length of segment
969: * return: NULL error, != NULL allocated memory for array
970: */
971: inline sarr_t *io_sarrInit(int numItems, int segLen);
972: /*
973: * io_sarrDestroy() - Free all data in dynamic split-order array and Destroy array
1.16 misho 974: *
1.9 misho 975: * @parr = Array
976: * return: none
977: */
978: inline void io_sarrDestroy(sarr_t ** __restrict parr);
979: /*
980: * io_sarrGrow() - Grow/Shrink dynamic split-order array, Use with care when it shrink!!!
1.16 misho 981: *
1.9 misho 982: * @arr = Array
983: * @newNumItems = Number of Items
984: * return: -1 error, 0 ok
985: */
986: int io_sarrGrow(sarr_t * __restrict arr, int newNumItems);
987: /*
988: * io_sarrVacuum() - Vacuum dynamic split-order array, empty segments will be freed
1.16 misho 989: *
1.9 misho 990: * @arr = Array
991: * return: -1 error, >-1 freed segments
992: */
993: inline int io_sarrVacuum(sarr_t * __restrict arr);
1.12 misho 994: #define io_sarrSize(_arr) ((_arr) ? (_arr)->sarr_num : 0)
995: #define io_sarrSeg(_arr) (assert((_arr)), (_arr)->sarr_seg)
996: /*
997: * io_sarrCopy() Copy source split array to destination split array
1.16 misho 998: *
1.12 misho 999: * @dest = Destination split array, after use free with io_sarrDestroy()
1000: * @src = Source split array
1001: * return: -1 error; >0 count of destination split array
1002: */
1003: int io_sarrCopy(sarr_t ** __restrict dest, sarr_t * __restrict src);
1.9 misho 1004: /*
1005: * io_sarrGet() - Get element from dynamic split-order array
1.16 misho 1006: *
1.9 misho 1007: * @arr = Array
1008: * @idx = Index (warning 1st element is at position 1)
1009: * return: NULL not found, !=NULL element
1010: */
1011: inline void *io_sarrGet(sarr_t * __restrict arr, unsigned int idx);
1012: /*
1013: * io_sarrGet2() - Always get element from dynamic split-order array
1014: * Function automatic grow array. Good use for Hash tables!
1.16 misho 1015: *
1.9 misho 1016: * @arr = Array
1017: * @idx = Index (warning 1st element is at position 1)
1018: * return: NULL not found, !=NULL element
1019: */
1020: void *io_sarrGet2(sarr_t * __restrict arr, unsigned int idx);
1021: /*
1022: * io_sarrSet() - Set element to dynamic split-order array
1.16 misho 1023: *
1.9 misho 1024: * @arr = Array
1025: * @idx = Index (warning 1st element is at position 1)
1026: * @data = Value
1027: * return: NULL error or empty, !=NULL old value in element
1028: */
1029: inline void *io_sarrSet(sarr_t * __restrict arr, unsigned int idx, void *data);
1.11 misho 1030: #define io_sarrDel(_arr, _idx) io_sarrSet((_arr), _idx, NULL)
1031: #define io_sarr(_arr, _idx, _type) (_type)io_sarrGet((_arr), _idx)
1032: /*
1033: * io_sarr2array() - Convert from split-order array to dynamic array
1.16 misho 1034: *
1.11 misho 1035: * @sa = split array
1036: * @sarrFree = after convert split array !=0 will be destroyed sarray
1037: * return: NULL error or != NULL new array
1038: */
1039: array_t *io_sarr2array(sarr_t ** __restrict sa, int sarrFree);
1040: /*
1041: * io_array2sarr() - Convert from dynamic array to split-order array
1.16 misho 1042: *
1.11 misho 1043: * @a = array
1044: * @segLen = Length of segment
1045: * @arrFree = after convert array !=0 will be destroyed
1046: * return: NULL error or != NULL new sarr
1047: */
1048: sarr_t *io_array2sarr(array_t ** __restrict a, int segLen, int arrFree);
1.8 misho 1049:
1050: /*
1.17 misho 1051: * io_CopyEnv() - Copy environment to new environment array;
1.16 misho 1052: *
1.10 misho 1053: * @oldenv = Environment array
1.20 misho 1054: * return: NULL error; !=NULL Allocated new environment array(must be io_free)
1.10 misho 1055: */
1056: char **io_CopyEnv(const char **oldenv);
1057: /*
1.17 misho 1058: * io_ExecArgs() - Build exec arguments from other array
1.16 misho 1059: *
1.10 misho 1060: * @psProg = Program name for execute
1061: * @oldarg = Arguments array
1.20 misho 1062: * return: NULL error; !=NULL Allocated execution array(must be io_free)
1.10 misho 1063: */
1064: char **io_ExecArgs(const char *psProg, const char **oldarg);
1065: /*
1.17 misho 1066: * io_FreeNullTerm() - Free dynamic allocated null terminated array with strings
1.16 misho 1067: *
1.10 misho 1068: * @arr = Pointer to array for free
1069: * return: none
1070: */
1071: inline void io_FreeNullTerm(char *** __restrict arr);
1072:
1073: /*
1.17 misho 1074: * ioMkDir() - Function for racursive directory creation and validation
1.16 misho 1075: *
1.5 misho 1076: * @csDir = Full directory path
1077: * @mode = Mode for directory creation if missing dir
1078: * return: -1 error, 0 directory path exist, >0 created missing dirs
1079: */
1080: int ioMkDir(const char *csDir, int mode);
1081:
1.6 misho 1082: /*
1.17 misho 1083: * ioWatchDirLoop() - Function for watching changes in directory and fire callback
1.16 misho 1084: *
1.6 misho 1085: * @csDir = Full directory path
1086: * @callback = Callback if raise event! nOp -1 delete, 0 change/move, 1 create
1087: * return: -1 error, !=-1 ok, number of total signaled events
1088: */
1089: int ioWatchDirLoop(const char *csDir, int (*callback)(const char *csName, int nOp));
1090:
1.5 misho 1091:
1.24 misho 1092: #ifdef AIO_OPS
1093: /*
1094: * io_aiobulk() - AIO bulk R/W function
1095: *
1096: * @mode = Bulk wait mode
1097: * @acbs = List of aiocb structures
1098: * @nacb = Number of aiocb in list
1099: * @sig = Event for completed operations, may be =NULL
1100: * return: -1 error or 0 ok
1101: */
1102: inline int io_aiobulk(int mode, struct aiocb ** __restrict acbs, int nacb,
1103: struct sigevent *sig);
1104: #endif
1105: /*
1106: * io_rreadv() - Raw VFS bulk read function
1107: *
1108: * @fd = File handle
1109: * @bufs = Read buffers
1110: * @nbufs = Number of read buffers
1111: * @offset = Read from position, if -1 read nbytes from current position
1112: * @update = Update file handle position !0
1113: * return: -1 error or !=-1 readed bytes
1114: */
1115: int io_rreadv(int fd, struct iovec * __restrict bufs, int nbufs, off_t offset,
1116: int update);
1117: /*
1118: * io_rwritev() - Raw VFS bulk write function
1119: *
1120: * @fd = File handle
1121: * @bufs = Write buffers
1122: * @nbufs = Number of write buffers
1123: * @offset = Write to position, if -1 write nbytes to current position
1124: * @update = Update file handle position !0
1125: * return: -1 error or !=-1 written bytes
1126: */
1127: int io_rwritev(int fd, struct iovec * __restrict bufs, int nbufs, off_t offset,
1128: int update);
1.5 misho 1129: /*
1.17 misho 1130: * io_rread() - Raw VFS read function
1.16 misho 1131: *
1.5 misho 1132: * @fd = File handle
1133: * @buf = Read buffer
1134: * @nbytes = Read buffer size
1135: * @offset = Read from position, if -1 read nbytes from current position
1136: * @update = Update file handle position !0
1137: * return: -1 error or !=-1 readed bytes
1138: */
1.24 misho 1139: inline int io_rread(int fd, void * __restrict buf, size_t nbytes, off_t offset,
1140: int update);
1.5 misho 1141: /*
1.17 misho 1142: * io_rwrite() - Raw VFS write function
1.16 misho 1143: *
1.5 misho 1144: * @fd = File handle
1145: * @buf = Write buffer
1146: * @nbytes = Write bytes from buffer
1147: * @offset = Write at position, if -1 write nbytes from current position
1148: * @update = Update file handle position !0
1.24 misho 1149: * return: -1 error or !=-1 written bytes
1.5 misho 1150: */
1.24 misho 1151: inline int io_rwrite(int fd, void * __restrict buf, size_t nbytes, off_t offset,
1152: int update);
1.5 misho 1153:
1154: /* Disk I/O helper macros */
1155: #define io_read(f, b, n) io_rread(f, b, n, -1, 1)
1156: #define io_write(f, b, n) io_rwrite(f, b, n, -1, 1)
1157:
1158:
1159: /* Debug helper macros */
1160: extern int io_Debug;
1161:
1.14 misho 1162: #define io_enableDEBUG int io_Debug
1163: #define io_initDebug(x) (io_Debug = (x))
1164: #define io_incDebug (io_Debug++)
1165: #define io_decDebug (io_Debug--)
1166:
1167: /* Debug macros */
1168: #define ioVERBOSE(x) if ((x) <= io_Debug)
1169: #define ioTRACE(x) if ((x) <= io_Debug) \
1170: syslog(LOG_DEBUG, "I'm in %s(%d)", __func__, __LINE__)
1.5 misho 1171: #define ioDEBUG(x, fmt, ...) do { \
1172: assert((fmt)); \
1173: char str[STRSIZ] = { 0 }; \
1.11 misho 1174: snprintf(str, sizeof str, (fmt), ##__VA_ARGS__); \
1.5 misho 1175: if ((x) <= io_Debug) \
1.14 misho 1176: syslog(LOG_DEBUG, "Debug(%d):%s(%d): %s\n", \
1.5 misho 1177: (x), __func__, __LINE__, str); \
1178: } while (0)
1179:
1.14 misho 1180: /* Logger macro */
1181: #define ioLOGGER(x, fmt, ...) do { \
1182: assert((fmt)); \
1183: char str[STRSIZ] = { 0 }; \
1184: snprintf(str, sizeof str, (fmt), ##__VA_ARGS__); \
1185: syslog((x), "Logger:%s(%d): %s\n", \
1186: __func__, __LINE__, str); \
1187: } while (0)
1188:
1189: /* Error state macros */
1.5 misho 1190: #define ioERROR(x, fmt, ...) do { \
1191: assert((fmt)); \
1192: char str[STRSIZ] = { 0 }; \
1.11 misho 1193: snprintf(str, sizeof str, (fmt), ##__VA_ARGS__); \
1.14 misho 1194: syslog(LOG_ERR, "Error:%s(%d): #%d - %s\n", \
1.5 misho 1195: __func__, __LINE__, (x), str); \
1196: } while (0)
1.14 misho 1197: #define ioSYSERR(x) do { \
1.5 misho 1198: if (x > 0 || errno) \
1.14 misho 1199: syslog(LOG_ERR, "Error(sys):%s(%d): #%d - %s\n", \
1.5 misho 1200: __func__, __LINE__, x > 0 ? x : errno, \
1201: strerror(x > 0 ? x : errno)); \
1202: } while (0)
1.14 misho 1203: #define ioLIBERR(ait) do { \
1.5 misho 1204: if (ait##_GetErrno()) \
1.14 misho 1205: syslog(LOG_ERR, "Error(lib):%s(%d): #%d - %s\n", \
1.5 misho 1206: __func__, __LINE__, ait##_GetErrno(), \
1207: ait##_GetError()); \
1208: } while (0)
1.3 misho 1209:
1.1 misho 1210:
1.7 misho 1211: /* Crypto framework */
1212:
1213: /*
1.17 misho 1214: * ioCipher() - Cipher wrapper for all supported crypto algorythms
1.16 misho 1215: *
1.7 misho 1216: * @pInput = input buffer
1217: * @inLen = input buffer len
1.20 misho 1218: * @ppOutput = output allocated buffe, must be io_free after use
1.7 misho 1219: * @Cipher = cipher engine, like EVP_bf_cbc() or etc...
1220: * @pKey = key
1221: * @pIV = IV, salt (8 bytes)
1222: * @nMode = Mode 0 - decrypting or 1 - encrypting
1223: * return: 0 not present data or error!; >0 number of processed and returned bytes into ppOutput
1224: */
1225: int ioCipher(unsigned char *pInput, int inLen, unsigned char **ppOutput, const EVP_CIPHER *Cipher,
1226: unsigned char *pKey, unsigned char *pIV, int nMode);
1227:
1228: /*
1.17 misho 1229: * io_Blowfish() - Blowfish cipher algorythm, work with ASCII hex strings
1.16 misho 1230: *
1.7 misho 1231: * @pInput = input buffer
1232: * @inLen = input buffer len
1.20 misho 1233: * @ppOutput = output allocated buffe, must be io_free after use
1.7 misho 1234: * @pKey = key
1235: * @pIV = IV, salt (8 bytes)
1236: * @nMode = Mode 0 - decrypting or 1 - encrypting
1237: * return: 0 not present data or error!; >0 number of processed and returned bytes into ppOutput
1238: */
1.8 misho 1239: int io_Blowfish(unsigned char *pInput, int inLen, unsigned char **ppOutput,
1240: unsigned char *pKey, unsigned char *pIV, int nMode);
1.12 misho 1241: /*
1.17 misho 1242: * io_ctr_AES() - Encrypt/Decrypt stream cipher CTR_AES
1.16 misho 1243: *
1.12 misho 1244: * @pInput = Input buffer with ASCII
1245: * @inLen = Input buffer data length
1.20 misho 1246: * @ppOutput = Output buffer with cipher data, must be io_free after use
1.12 misho 1247: * @pKey = Key
1248: * @IV = IVector/Nonce/Counter, Warning: IV must be variable, because we write there!!!
1249: * return: -1 error or >-1 how many cipher blocks proceeded
1250: */
1251: int io_ctr_AES(unsigned char *pInput, int inLen, unsigned char **ppOutput,
1252: unsigned char *pKey, unsigned char IV[AES_BLOCK_SIZE]);
1253:
1254:
1255: /*
1.17 misho 1256: * ioAllocPTY() - Allocate new PTY and TTY
1.16 misho 1257: *
1.12 misho 1258: * @ptyfd = master fd, pty
1259: * @ttyfd = slave fd, tty
1260: * @name = tty device name if not null
1261: * @namesiz = name length, must be above 63 bytes.
1262: * @term = termios for terminal
1263: * @winz = winsize for terminal
1264: * return: -1 error or 0 ok
1265: */
1266: inline int ioAllocPTY(int *ptyfd, int *ttyfd, char * __restrict name, int namesiz,
1267: struct termios * __restrict term, struct winsize * __restrict winz);
1268: /*
1.17 misho 1269: * ioFreePTY() - Release PTY and TTY device
1.16 misho 1270: *
1.12 misho 1271: * @ptyfd = master fd, pty (==-1 skip closing pty)
1272: * @ttyname = tty filename
1273: * return: none
1274: */
1275: inline void ioFreePTY(int ptyfd, const char *ttyname);
1276: /*
1.17 misho 1277: * ioChgWinPTY() - Change window size of PTY
1.16 misho 1278: *
1.12 misho 1279: * @ptyfd = master fd, pty
1280: * @row = row
1281: * @col = col
1282: * @xpxl = x pixels
1283: * @ypxl = y pixels
1284: * return: -1 error or 0 ok
1285: */
1286: inline int ioChgWinPTY(int ptyfd, unsigned short row, unsigned short col,
1287: unsigned short xpxl, unsigned short ypxl);
1288: /*
1.17 misho 1289: * ioSetOwnerTTY() - Set owner to TTY
1.16 misho 1290: *
1.12 misho 1291: * @ttyname = tty filename
1292: * @UID = uid
1293: * @GID = gid
1294: * return: -1 error or 0 ok
1295: */
1296: int ioSetOwnerTTY(const char *ttyname, uid_t UID, gid_t GID);
1297: /*
1.17 misho 1298: * ioSetSidTTY() - Makes the process's controlling TTY and sets it to sane modes.
1.16 misho 1299: *
1.12 misho 1300: * @ttyfd = slave fd, tty
1301: * @ttyname = tty filename
1302: * return: -1 error or 0 ok
1303: */
1304: int ioSetSidTTY(int *ttyfd, const char *ttyname);
1305: /*
1.17 misho 1306: * ioSetRAWMode() - Enter into RAW mode
1.16 misho 1307: *
1.12 misho 1308: * @fd = tty fd
1309: * @otio = saved old termios for later restore if !=NULL
1310: * return: -1 error or 0 ok
1311: */
1312: inline int ioSetRAWMode(int fd, struct termios *otio);
1313: /*
1.17 misho 1314: * ioRestoreMode() - Restore termios to tty fd
1.16 misho 1315: *
1.12 misho 1316: * @fd = tty fd
1317: * @tio = termios structure for restore
1318: * return: -1 error or 0 ok
1319: */
1320: inline int ioRestoreMode(int fd, struct termios tio);
1321: /*
1.17 misho 1322: * ioForkPTY() - Fork new process with session leader and new TTY
1.16 misho 1323: *
1.12 misho 1324: * @ptyfd = master fd, pty
1325: * @name = tty device name if not null
1326: * @namesiz = name length, must be above 63 bytes.
1327: * @term = termios for terminal
1328: * @winz = winsize for terminal
1329: * @otio = old termios structure for restore
1330: * return: -1 error, 0 child process or >0 parent: pid of child
1331: */
1332: pid_t ioForkPTY(int *ptyfd, char * __restrict name, int namesiz, struct termios * __restrict term,
1333: struct winsize * __restrict winz, struct termios * __restrict otio);
1334:
1335: /*
1.17 misho 1336: * ioCreatePIDFile() - Create PID file
1.16 misho 1337: *
1.12 misho 1338: * @csName = PID filename
1339: * @ifExists = !=0 if filename exists return error
1340: * return: -1 error or 0 ok
1341: */
1342: inline int ioCreatePIDFile(const char *csName, int ifExists);
1.7 misho 1343:
1.13 misho 1344: /*
1.17 misho 1345: * ioSendFile() - AITNET sendfile() userland implementation, not dependant from OS
1.16 misho 1346: *
1.13 misho 1347: * @s = socket
1348: * @csFile = file for send
1349: * @sendLen = bytes to send, if 0 send all data
1350: * @offset = start file offset
1351: * @sndbuf = SO_SNDBUF value, if 0 use default
1352: * return: 0 error, >0 ok, sended bytes
1353: */
1354: size_t ioSendFile(int s, const char *csFile, size_t sendLen, off_t offset, int sndbuf);
1355: /*
1.17 misho 1356: * ioRecvFile() - Receive file from socket, fastest (zero-copy) way
1.16 misho 1357: *
1.13 misho 1358: * @s = socket
1359: * @csFile = file for receive
1360: * @recvLen = receive bytes
1361: * @over = overwrite file if exists with mode like 0644
1362: * @rcvbuf = SO_RCVBUF value, if 0 use default
1363: * return: 0 error, >0 ok, received bytes
1364: */
1365: size_t ioRecvFile(int s, const char *csFile, size_t recvLen, int over, int rcvbuf);
1366:
1.7 misho 1367:
1.14 misho 1368: /* Buffered file access over memory block */
1369:
1370: /*
1.17 misho 1371: * io_fmemopen() - File buffered stream operations over memory block
1.14 misho 1372: *
1373: * @base = Base address of memory block, if =NULL Infinit length(auto-grow)
1374: * @basesize = Size of memory block
1375: * return: NULL error or !=NULL Opened file resource
1376: */
1377: FILE *io_fmemopen(void ** __restrict base, off_t basesize);
1378: /*
1.17 misho 1379: * io_fmapopen() - File buffered stream operations over MMAP block
1.14 misho 1380: *
1381: * @csFile = Filename for MMAP, if =NULL private MMAP block
1382: * @mode = File open mode
1383: * @perm = If file not exists will be created with this access permissions
1384: * @prot = MMAP protection
1385: * @flags = MMAP mode flags
1386: * @offset = Map from file offset, if csFile==NULL then this is size of MMAP private block
1387: * return: NULL error or !=NULL Opened file resource
1388: */
1389: FILE *io_fmapopen(const char *csFile, int mode, int perm, int prot, int flags, off_t offset);
1390: /*
1.17 misho 1391: * io_fd2buf() - Convert open file handle to buffered file I/O
1.14 misho 1392: *
1393: * @fd = File handle
1394: * @mode = Permissions for new buffered file I/O
1395: * return: NULL error or open buffered file
1396: */
1397: inline FILE *io_fd2buf(int fd, const char *mode);
1398: /*
1.17 misho 1399: * io_dumbFile() - Create empry or dumb file with fixed size
1.14 misho 1400: *
1401: * @csFile = Filename for create
1402: * @mode = File access permissions
1403: * @size = File size
1404: * return: -1 error or open file handle
1405: */
1406: int io_dumbFile(const char *csFile, int mode, off_t size);
1407:
1408:
1.1 misho 1409: #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