Annotation of libaitio/inc/aitio.h, revision 1.25.2.2
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.25.2.2! misho 6: * $Id: aitio.h,v 1.25.2.1 2012/09/03 09:26:34 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.25.2.2! 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.25 misho 346: #define AIT_SET_LIKE(_vl, _t, _l, _v) do { assert((_vl)); \
347: AIT_INIT_VAL2((_vl), _t); \
348: AIT_LEN((_vl)) = _l; AIT_IN((_vl)) = 1; \
349: AIT_RAW((_vl)) = (uint64_t) (_v); \
350: } while (0)
1.20 misho 351: /* if attribute zeroCopy is set not execute io_free() */
1.16 misho 352: #define AIT_FREE_VAL(_vl) do { ait_val_t *__val = (_vl); assert(__val); \
353: switch (AIT_TYPE(__val)) { \
1.12 misho 354: case buffer: \
1.21 misho 355: if (!__val->val_in && \
356: __val->val.buffer) \
1.20 misho 357: io_free(__val->val.buffer); \
1.21 misho 358: __val->val.buffer = NULL; \
1.12 misho 359: break; \
360: case string: \
1.21 misho 361: if (!__val->val_in && \
362: __val->val.string) \
1.20 misho 363: io_free(__val->val.string); \
1.21 misho 364: __val->val.string = NULL; \
1.12 misho 365: break; \
366: default: \
367: break; \
368: } \
369: __val->val_type = empty; \
1.21 misho 370: __val->val_opt ^= __val->val_opt; \
1.12 misho 371: AIT_LEN(__val) = 0; \
1.21 misho 372: AIT_KEY(__val) = 0; \
1.12 misho 373: } while (0)
1.22 misho 374: #define AIT_ZERO_VAL(_vl) do { ait_val_t *__val = (_vl); assert(__val); \
375: switch (AIT_TYPE(__val)) { \
376: case buffer: \
377: case string: \
1.23 misho 378: if (__val->val.buffer) \
379: memset(__val->val.buffer, 0, \
1.22 misho 380: AIT_LEN(__val)); \
381: break; \
382: case data: \
1.23 misho 383: memset(__val->val_data, 0, AIT_LEN(__val)); \
1.22 misho 384: break; \
385: default: \
386: __val->val.net = 0LL; \
387: break; \
388: } \
389: AIT_KEY(__val) = 0; \
390: } while (0)
1.12 misho 391:
392: struct io_ether_addr {
393: u_int8_t ether_addr_octet[6];
394: };
1.13 misho 395: typedef struct io_ether_addr io_ether_addr_t;
396:
397: typedef union {
398: struct sockaddr_storage ss;
399: struct sockaddr sa;
400: struct sockaddr_un sun;
401: struct sockaddr_in sin;
402: struct sockaddr_in6 sin6;
403: struct sockaddr_dl sdl;
404: } io_sockaddr_t;
1.21 misho 405: #define IO_SOCKADDR_INIT { .ss = { 0 } }
1.12 misho 406:
1.3 misho 407:
1.15 misho 408: #define io_align(x, a) (((x) + (a)) & ~(a))
409:
410:
1.1 misho 411: // io_GetErrno() Get error code of last operation
412: inline int io_GetErrno();
413: // io_GetError() Get error text of last operation
414: inline const char *io_GetError();
415:
416:
1.20 misho 417: // io_mm_inuse() Check for memory management model
418: inline int io_mm_inuse();
419:
420: /*
421: * ioLibInit() - Init libaitio library memory management
422: *
423: * @mm = memory management (IO_SYSM or IO_MPOOL)
424: * @maxmem = memory limit
425: * return: -1 error or !=-1 used memory management model
426: */
427: inline int ioLibInit(int mm, unsigned long maxmem);
428: /*
429: * ioLibFini() - Finish libaitio library memory management
430: *
431: * return: none
432: */
433: inline void ioLibFini();
434:
435: /* memory management hooks */
436: extern void *(*io_malloc)(size_t);
437: extern void *(*io_calloc)(size_t, size_t);
438: extern void *(*io_realloc)(void*, size_t);
439: extern char *(*io_strdup)(const char*);
440: extern void (*io_free)(void*);
441:
442:
1.1 misho 443: /*
1.17 misho 444: * io_ether_ntoa() - Convert ethernet address to string
1.16 misho 445: *
1.12 misho 446: * @n = ethernet address structure, like struct ether_addr
447: * @a = string
448: * @len = string length
449: * return: NULL error or !=NULL string a
450: */
451: inline char *io_ether_ntoa(const struct io_ether_addr *n, char * __restrict a, int len);
452: /*
1.17 misho 453: * io_ether_aton() - Convert string to ethernet address
1.16 misho 454: *
1.12 misho 455: * @a = string
456: * @e = ethernet address structure, like struct ether_addr
457: * return: NULL error or !=NULL ethernet address structure
458: */
459: inline struct io_ether_addr *io_ether_aton(const char *a, struct io_ether_addr *e);
1.13 misho 460: /*
1.17 misho 461: * io_n2port() - Extract port from network structure
1.16 misho 462: *
1.13 misho 463: * @addr = Address
464: * return: 0 not supported family type or port number
465: */
466: inline u_short io_n2port(io_sockaddr_t * __restrict addr);
467: /*
1.17 misho 468: * io_n2addr() - Extract address from network structure
1.16 misho 469: *
1.13 misho 470: * @addr = Address
471: * @val = Value for store string address
472: * return: NULL error or !=NULL string address from val
473: */
474: const char *io_n2addr(io_sockaddr_t * __restrict addr, ait_val_t * __restrict val);
475: /*
1.17 misho 476: * io_gethostbyname() - Get host and port and make network structure
1.16 misho 477: *
1.13 misho 478: * @psHost = Hostname
479: * @port = Port
480: * @addr = Network address structure
481: * return: NULL error or !=NULL network structure
482: */
483: io_sockaddr_t *io_gethostbyname(const char *psHost, unsigned short port,
484: io_sockaddr_t * __restrict addr);
1.12 misho 485:
486: /*
1.17 misho 487: * io_vars2buffer() - Marshaling data from array with variables to buffer
1.16 misho 488: *
1.12 misho 489: * @buf = Buffer
490: * @buflen = Size of buffer
491: * @vars = Variable array
492: * return: -1 error, 0 nothing done or >0 size of marshaled data
493: */
1.21 misho 494: inline int io_vars2buffer(unsigned char * __restrict buf, int buflen,
495: array_t * __restrict vars);
1.12 misho 496: /*
1.17 misho 497: * io_buffer2vars() - De-marshaling data from buffer to array with variables
1.16 misho 498: *
1.12 misho 499: * @buf = Buffer
500: * @buflen = Size of buffer
501: * @vnum = Number of variables into buffer
502: * @zcpy = Zero-copy for variables, if !=0 don't use io_arrayFree() for free variables and
503: *DON'T MODIFY OR DESTROY BUFFER*. =0 call io_arrayFree() before io_arrayDestroy()
504: * return: =NULL error, !=NULL allocated variable array, after use must free with io_arrayDestroy()
505: */
1.21 misho 506: inline array_t *io_buffer2vars(unsigned char * __restrict buf, int buflen, int vnum, int zcpy);
1.12 misho 507: /*
1.17 misho 508: * io_vars2map() - Marshaling data from array with variables to memory map
1.16 misho 509: *
1.12 misho 510: * @buf = Buffer
511: * @buflen = Size of buffer
512: * @vars = Variable array
513: * return: -1 error, 0 nothing done or >0 size of marshaled data
514: */
1.21 misho 515: inline int io_vars2map(unsigned char * __restrict buf, int buflen,
516: array_t * __restrict vars);
1.12 misho 517: /*
1.17 misho 518: * io_map2vars() - De-marshaling data from memory map to array with variables
1.16 misho 519: *
1.12 misho 520: * @buf = Buffer
521: * @buflen = Size of buffer
522: * @vnum = Number of variables into buffer
523: * @zcpy = Zero-copy for variables, if !=0 don't use io_arrayFree() for free variables and
524: *DON'T MODIFY OR DESTROY BUFFER*. =0 call io_arrayFree() before io_arrayDestroy()
525: * return: =NULL error, !=NULL allocated variable array, after use must free with io_arrayDestroy()
526: */
1.21 misho 527: inline array_t *io_map2vars(unsigned char * __restrict buf, int buflen, int vnum, int zcpy);
1.13 misho 528:
529: /*
1.17 misho 530: * io_allocVar() - Allocate memory for variable
1.16 misho 531: *
1.14 misho 532: * return: NULL error or new variable, after use free variable with io_freeVar()
533: */
534: inline ait_val_t *io_allocVar(void);
535: /*
1.17 misho 536: * io_freeVar() - Free allocated memory for variable
1.16 misho 537: *
1.14 misho 538: * @val = Variable
539: * return: none
540: */
1.17 misho 541: inline void io_freeVar(ait_val_t ** __restrict val);
1.14 misho 542: /*
1.23 misho 543: * io_makeVar() - Allocate memory and fill variable
544: *
545: * @type = type of variable
546: * @... = arg1 is value of variable
547: * @... = arg2 is length of variabla. Not required for numbers and strings!
548: * return: NULL error or new variable, after use free variable with io_freeVar()
549: */
550: ait_val_t *io_makeVar(ait_type_t type, ...);
551: /*
1.25.2.1 misho 552: * io_sprintfVar() - Builtin string variable from formatted input
553: *
554: * @v = variable
555: * @fmt = format string
556: * @... = argument(s)
557: * return: -1 error or >0 copied bytes to variable
558: */
559: int io_sprintfVar(ait_val_t * __restrict v, const char *fmt, ...);
560: /*
1.25 misho 561: * io_hashVar() - Generate hash key for variable from string or value
562: *
563: * @v = variable
564: * @key = key string for hash, if =NULL hash will built from variable
565: * return: hash key
566: */
567: unsigned short io_hashVar(ait_val_t * __restrict v, const char * __restrict key);
568: /*
1.17 misho 569: * io_allocVars() - Allocate ait_val_t array
1.16 misho 570: *
1.13 misho 571: * @varnum = Number of variables
572: * return: =NULL error or !=NULL allocated array
573: */
574: inline array_t *io_allocVars(int varnum);
575: /*
1.17 misho 576: * io_clrVars() - Clear ait_val_t elements from array
1.16 misho 577: *
1.13 misho 578: * @vars = Variable array
579: * return: -1 error or size of array
580: */
581: inline int io_clrVars(array_t * __restrict vars);
582: /*
1.17 misho 583: * io_freeVars() - Free ait_val_t array
1.16 misho 584: *
1.13 misho 585: * @vars = Variable array
586: * return: none
587: */
588: inline void io_freeVars(array_t ** __restrict vars);
1.17 misho 589: /*
1.18 misho 590: * io_getVars() - Get ait_val_t element from array and if not exists allocate it
591: *
592: * @vars = Variable array
593: * @n = index of variable into array
594: * return: NULL error or !=NULL ait_val_t element
595: */
596: inline ait_val_t *io_getVars(array_t ** __restrict vars, int n);
597: /*
1.21 misho 598: * io_sortVarsByKey() - Sorting array with variables by key
599: *
600: * @vars = Variable array
601: * @order = Sort order. If =0 ascend or !=0 descend
602: * return: none
603: */
604: inline void io_sortVarsByKey(array_t * __restrict vars, int order);
605: /*
606: * io_sortVarsByVal() - Sorting array with variables by value
1.17 misho 607: *
608: * @vars = Variable array
1.21 misho 609: * @order = Sort order. If =0 ascend or !=0 descend
610: * @cmp = Custom compare function for sorting. If =NULL compare by value
1.17 misho 611: * return: none
612: */
1.21 misho 613: inline void io_sortVarsByVal(array_t * __restrict vars, int order,
1.17 misho 614: int (*cmp)(const void*, const void*));
615: /*
616: * io_findKeyVars() - Find variable by key from array
617: *
618: * @vars = Variables
619: * @key = Search key
620: * return: NULL error or not found, !=NULL valid element
621: */
622: ait_val_t *io_findKeyVars(array_t * __restrict vars, u_short key);
1.25 misho 623: /*
624: * io_findKeyHash() - Find variable by hash string from array
625: *
626: * @vars = Variables
627: * @key = Search string
628: * return: NULL error or not found, !=NULL valid element
629: */
630: inline ait_val_t *io_findKeyHash(array_t * __restrict vars, const char * __restrict key);
631: /*
632: * io_hashKeyVars() - Generate hash keys for variables
633: *
634: * @vars = Variables
635: * return -1 error or 0 ok
636: */
637: inline int io_hashKeyVars(array_t * __restrict vars);
1.13 misho 638:
1.12 misho 639:
640: /*
1.17 misho 641: * ioPromptRead() - Read data from input h[0] with prompt to output h[1]
1.16 misho 642: *
1.1 misho 643: * @h = file handles h[0] = input, h[1] = output, if NULL use stdin, stdout
644: * @csPrompt = Prompt before input, may be NULL
645: * @psData = Readed data
646: * @dataLen = Length of data
647: * return: 0 EOF; -1 error:: can`t read; >0 count of readed chars
648: */
649: int ioPromptRead(int *h, const char *csPrompt, char * __restrict psData, int dataLen);
650: /*
1.17 misho 651: * ioPromptPassword() - Read password from input h[0] with prompt to output h[1]
1.16 misho 652: *
1.1 misho 653: * @h = file handles h[0] = input, h[1] = output, if NULL use stdin, stdout
654: * @csPrompt = Prompt before input, may be NULL
655: * @psPass = Readed password
656: * @passLen = Length of password
657: * @confirm = Confirm password, 0 - get password, !=0 Ask for confirmation
658: * return: 0 EOF; -1 error:: can`t read; >0 count of readed chars
659: */
660: int ioPromptPassword(int *h, const char *csPrompt, char * __restrict psPass, int passLen, int confirm);
661:
662: /*
1.17 misho 663: * ioRegexVerify() - Function for verify data match in regex expression
1.16 misho 664: *
1.1 misho 665: * @csRegex = Regulare expression pattern
666: * @csData = Data for check and verify
667: * @startPos = Return start positions
668: * @endPos = Return end positions
669: * return: NULL not match or error; !=NULL begin of matched data
670: */
671: const char *ioRegexVerify(const char *csRegex, const char *csData, int *startPos, int *endPos);
672: /*
1.17 misho 673: * ioRegexGet() - Function for get data match in regex expression
1.16 misho 674: *
1.1 misho 675: * @csRegex = Regulare expression pattern
676: * @csData = Data from get
677: * @psString = Returned string if match
678: * @strLen = Length of string
679: * return: 0 not match; >0 count of returned chars
680: */
681: int ioRegexGet(const char *csRegex, const char *csData, char * __restrict psString, int strLen);
682: /*
1.17 misho 683: * ioRegexReplace() - Function for replace data match in regex expression with newdata
1.16 misho 684: *
1.1 misho 685: * @csRegex = Regulare expression pattern
686: * @csData = Source data
687: * @csNew = Data for replace
1.20 misho 688: * return: NULL not match or error; !=NULL allocated new string, must be io_free after use!
1.1 misho 689: */
690: char *ioRegexReplace(const char *csRegex, const char *csData, const char *csNew);
691:
1.2 misho 692: /*
1.17 misho 693: * ioStrAst() - Function for evaluate string like asterisk variable "{text[:[-]#[:#]]}"
1.16 misho 694: *
1.6 misho 695: * @csString = Input string
1.20 misho 696: * return: NULL error, !=NULL Allocated new string evaluated from input string, must be io_free()
1.6 misho 697: */
1.13 misho 698: char *ioStrAst(const char *csString);
1.6 misho 699:
700: /*
1.17 misho 701: * io_UnquotStr() - Remove quots from input text string
1.16 misho 702: *
1.4 misho 703: * @psLine = Text string
704: * return: 0 nothing to do; 1 successful unquoted string
705: */
1.17 misho 706: inline int io_UnquotStr(char * __restrict psLine);
1.4 misho 707: /*
1.17 misho 708: * io_LTrimStr() - Remove left whitespaces from text string
1.16 misho 709: *
1.4 misho 710: * @psLine = Text string
711: * return: 0 nothing to do; !=0 Removed bytes
712: */
1.17 misho 713: inline int io_LTrimStr(char * __restrict psLine);
1.4 misho 714: /*
1.17 misho 715: * io_RTrimStr() - Remove right whitespaces from text string
1.16 misho 716: *
1.4 misho 717: * @psLine = Text string
718: * return: 0 nothing to do; !=0 Removed bytes
719: */
1.17 misho 720: inline int io_RTrimStr(char * __restrict psLine);
1.4 misho 721: /*
1.17 misho 722: * io_TrimStr() - Remove left and right whitespaces from text string
1.16 misho 723: *
1.4 misho 724: * @psLine = Text string
725: * return: 0 nothing to do; !=0 Removed bytes
726: */
1.17 misho 727: inline int io_TrimStr(char * __restrict psLine);
1.4 misho 728: /*
1.17 misho 729: * io_Ch2Hex() - Convert from Char string to Hex string
1.16 misho 730: *
1.4 misho 731: * @psLine = Text string
732: * @lineLen = Length of Text string
1.20 misho 733: * return: NULL nothing to do or error; !=0 Allocated new converted data without term\0 (must be io_free)
1.4 misho 734: */
1.5 misho 735: inline unsigned char *io_Ch2Hex(unsigned char *psLine, int lineLen);
1.4 misho 736: /*
1.17 misho 737: * io_Hex2Ch() - Convert from Hex string to Char string
1.16 misho 738: *
1.4 misho 739: * @psLine = Text string
740: * @lineLen = Length of Text string
1.20 misho 741: * return: NULL nothing to do or error; !=0 Allocated new converted string(must be io_free)
1.4 misho 742: */
1.5 misho 743: inline char *io_Hex2Ch(unsigned char *psLine, int lineLen);
1.4 misho 744:
745: /*
1.15 misho 746: * io_Path2File() - Parse and make path/filename pair
747: *
748: * @csArgs = Input argument line
749: * @psPath = Output Path, if ==NULL path not returned
750: * @pathLen = Size of path array
751: * @psFile = Output File
752: * @fileLen = Size of file array
753: * return: 0 error format; -1 error:: can`t read; >0 ok, number of readed items
754: */
755: inline int
756: io_Path2File(const char * __restrict csArgs, char * __restrict psPath,
757: int pathLen, char * __restrict psFile, int fileLen);
758:
759: /*
1.8 misho 760: * io_arrayInit() - Create and initialize dynamic array
1.16 misho 761: *
1.8 misho 762: * @numItems = Number of Items
763: * return: NULL error, != NULL allocated memory for array
764: */
765: inline array_t *io_arrayInit(int numItems);
766: /*
1.10 misho 767: * io_arrayDestroy() - Free and destroy dynamic array
1.16 misho 768: *
1.8 misho 769: * @parr = Array
770: * return: none
771: */
772: inline void io_arrayDestroy(array_t ** __restrict parr);
773: /*
1.10 misho 774: * io_arrayFree() - Free all data in dynamic array items
1.8 misho 775: * (WARNING! If assign static array dont use this!!!)
1.16 misho 776: *
1.8 misho 777: * @arr = Array
778: * return: none
779: */
780: inline void io_arrayFree(array_t * __restrict arr);
781: /*
1.10 misho 782: * io_arrayFrom() - Create and fill array from array with pointers
1.16 misho 783: *
1.11 misho 784: * @pargv = Array with pointers
1.10 misho 785: * @argc = Number of Items, if 0 walk through argv and stop when reach NULL item
1.11 misho 786: * return: NULL error, != NULL allocated new array
1.10 misho 787: */
1.11 misho 788: inline array_t *io_arrayFrom(const char *** __restrict pargv, int argc);
1.10 misho 789: /*
790: * io_arrayTo() - Create and fill array with pointers from dynamic array
1.16 misho 791: *
1.10 misho 792: * @arr = Array
1.11 misho 793: * return: NULL error, != NULL allocated memory for array, NULL terminated
1.10 misho 794: */
795: inline char **io_arrayTo(array_t * __restrict arr);
796: /*
1.8 misho 797: * io_arrayLen() - Get last used element in dynamic array (array Length)
1.16 misho 798: *
1.8 misho 799: * @arr = Array
1.17 misho 800: * return: -1 empty or >-1 position of last used element
1.8 misho 801: */
802: inline int io_arrayLen(array_t * __restrict arr);
803: /*
1.10 misho 804: * io_arrayConcat() Concat source array to destination array
1.16 misho 805: *
1.10 misho 806: * @dest = Destination array
807: * @src = Source array
808: * return: -1 error; >0 new count of destination array
809: */
810: int io_arrayConcat(array_t * __restrict dest, array_t * __restrict src);
811: /*
1.12 misho 812: * io_arrayCopy() Copy source array to destination array
1.16 misho 813: *
1.12 misho 814: * @dest = Destination array, after use free with io_arrayDestroy()
815: * @src = Source array
816: * return: -1 error; >0 count of destination array
817: */
818: int io_arrayCopy(array_t ** __restrict dest, array_t * __restrict src);
819: /*
1.8 misho 820: * io_arrayGrow() - Grow/Shrink dynamic array, Use with care when it shrink!!!
1.16 misho 821: *
1.8 misho 822: * @arr = Array
823: * @newNumItems = Number of Items
1.12 misho 824: * @freeShrink = Free elements before shrink array
1.8 misho 825: * return: -1 error, 0 ok
826: */
1.12 misho 827: int io_arrayGrow(array_t * __restrict arr, int newNumItems, int freeShrink);
1.8 misho 828: /*
829: * io_arrayVacuum() - Vacuum dynamic array, empty elements will be deleted
1.16 misho 830: *
1.8 misho 831: * @arr = Array
832: * @fromWhere = 1 begin, 2 ALL empty elements
833: * return: -1 error, 0 ok
834: */
835: int io_arrayVacuum(array_t * __restrict arr, int fromWhere);
836:
1.12 misho 837: #define io_arraySize(_arr) ((_arr) ? (_arr)->arr_num : 0)
1.17 misho 838: #define io_arrayLast(_arr) (io_arraySize((_arr)) ? (_arr)->arr_last : -1)
1.12 misho 839: #define io_arrayZero(_arr) (assert((_arr)), memset((_arr)->arr_data, 0, \
840: io_arraySize((_arr)) * sizeof(void*)))
1.8 misho 841:
1.17 misho 842: #define io_arrayGet2(_arr, _d) (assert((_arr) && (_arr)->arr_num > _d), ((_arr)->arr_data + _d))
1.18 misho 843: #define io_arrayGet(_arr, _d) (assert((_arr) && (_arr)->arr_num > _d), (_arr)->arr_data[_d])
1.11 misho 844: #define io_array(_arr, _d, _type) (assert((_arr) && (_arr)->arr_num > _d), \
1.18 misho 845: ((_type) (_arr)->arr_data[_d]))
1.8 misho 846: #define io_arraySet(_arr, _d, _ptr) do { \
1.11 misho 847: assert((_arr) && (_arr)->arr_num > _d); \
1.17 misho 848: if ((_arr)->arr_last < _d) \
849: (_arr)->arr_last = _d; \
1.18 misho 850: (_arr)->arr_data[_d] = (void*) (_ptr); \
1.8 misho 851: } while (0)
1.11 misho 852: #define io_arrayDel(_arr, _d, _fri) do { \
853: assert((_arr) && (_arr)->arr_num > _d); \
1.18 misho 854: if (_fri && (_arr)->arr_data[_d]) \
855: free((_arr)->arr_data[_d]); \
856: (_arr)->arr_data[_d] = NULL; \
1.17 misho 857: } while (0)
1.8 misho 858:
859: /*
1.13 misho 860: * io_arrayElem() - Always GET/PUT element into dynamic array, if not enough elements grow array
1.16 misho 861: *
1.13 misho 862: * @arr = Array
863: * @n = Position
864: * @data = Element, if set NULL GET element at position or !=NULL PUT element at position
865: * return: -1 error or !=-1 return element at position
866: */
1.14 misho 867: inline void *io_arrayElem(array_t * __restrict arr, int n, void *data);
1.13 misho 868: /*
1.8 misho 869: * io_arrayPush() - Push element into dynamic array like stack manner, place at first empty position
1.16 misho 870: *
1.8 misho 871: * @arr = Array
872: * @data = Element, if set NULL return only first empty position
1.17 misho 873: * @mayGrow = Array may to grow, if not enough room for new element
1.8 misho 874: * return: -1 not found empty position, array is full!, >-1 return position of stored element into array
875: */
1.17 misho 876: inline int io_arrayPush(array_t * __restrict arr, void **data, int mayGrow);
1.8 misho 877: /*
878: * io_arrayPop() - Pop element from dynamic array like stack manner, last used position
1.16 misho 879: *
1.8 misho 880: * @arr = Array
1.11 misho 881: * @data = Element, if set NULL return only last used position
1.8 misho 882: * @delAfter = Delete after Pop element, !=0 delete element from array after return data
883: * return: -1 not found used position, array is empty!, >-1 return element position
884: */
885: inline int io_arrayPop(array_t * __restrict arr, void ** __restrict data, int delAfter);
886:
887: /*
1.17 misho 888: * io_argsNum() - Parse and calculate number of arguments
1.16 misho 889: *
1.8 misho 890: * @csArgs = Input arguments line
891: * @csDelim = Delimiter(s) for separate
892: * return: 0 error format; -1 error:: can`t read; >0 ok, number of items
893: */
894: inline int io_argsNum(const char *csArgs, const char *csDelim);
895:
896: /*
1.17 misho 897: * io_arrayMake() - Parse and make array from arguments ... (input string will be modified!!!
1.8 misho 898: * and output array must be free with io_arrayDestroy() after use!)
1.16 misho 899: *
1.8 misho 900: * @psArgs = Input arguments line, after execute string is modified!!!
901: * @nargs = Maximum requested count of arguments from input string psArgs, if 0 all psArgs
902: * @csDelim = Delimiter(s) for separate
1.20 misho 903: * @parr = Output array of arguments ... (must be io_free with io_arrayDestroy() after use!)
1.8 misho 904: * return: 0 error format; -1 error:: can`t read; >0 ok, number of readed items
905: */
906: int io_arrayMake(char * __restrict psArgs, int nargs, const char *csDelim,
907: array_t ** __restrict parr);
908:
909: /*
1.17 misho 910: * io_MakeAV() - Parse and make attribute/value pair
1.16 misho 911: *
1.8 misho 912: * @csArgs = Input argument line
913: * @csDelim = Delimiter for separate
914: * @psAttr = Output Attribute
915: * @attrLen = Size of attribute array
916: * @psValue = Output Value, if ==NULL this element not present value or not wanted for return
917: * @valLen = Size of value array
918: * return: 0 error format; -1 error:: can`t read; >0 ok, number of readed items
919: */
920: int io_MakeAV(const char * __restrict csArgs, const char *csDelim,
921: char * __restrict psAttr, int attrLen, char * __restrict psValue, int valLen);
1.23 misho 922: /*
923: * io_MakeAV2() Parse and make attribute/value pair over input string
924: *
925: * @csArgs = Input argument line, will be modified!
926: * @csDelim = Delimiter for separate
927: * @psAttr = Output Attribute
928: * @psValue = Output Value, if ==NULL this element not present value or not wanted for return
929: * return: 0 error format; -1 error:: can`t read; >0 ok, number of readed items
930: */
931: int io_MakeAV2(char * __restrict psArgs, const char *csDelim,
932: char ** __restrict psAttr, char ** __restrict psValue);
1.8 misho 933:
1.9 misho 934: /*
935: * io_sarrInit() - Create and initialize dynamic split-order array
1.16 misho 936: *
1.9 misho 937: * @numItems = Number of Items
938: * @segLen = Length of segment
939: * return: NULL error, != NULL allocated memory for array
940: */
941: inline sarr_t *io_sarrInit(int numItems, int segLen);
942: /*
943: * io_sarrDestroy() - Free all data in dynamic split-order array and Destroy array
1.16 misho 944: *
1.9 misho 945: * @parr = Array
946: * return: none
947: */
948: inline void io_sarrDestroy(sarr_t ** __restrict parr);
949: /*
950: * io_sarrGrow() - Grow/Shrink dynamic split-order array, Use with care when it shrink!!!
1.16 misho 951: *
1.9 misho 952: * @arr = Array
953: * @newNumItems = Number of Items
954: * return: -1 error, 0 ok
955: */
956: int io_sarrGrow(sarr_t * __restrict arr, int newNumItems);
957: /*
958: * io_sarrVacuum() - Vacuum dynamic split-order array, empty segments will be freed
1.16 misho 959: *
1.9 misho 960: * @arr = Array
961: * return: -1 error, >-1 freed segments
962: */
963: inline int io_sarrVacuum(sarr_t * __restrict arr);
1.12 misho 964: #define io_sarrSize(_arr) ((_arr) ? (_arr)->sarr_num : 0)
965: #define io_sarrSeg(_arr) (assert((_arr)), (_arr)->sarr_seg)
966: /*
967: * io_sarrCopy() Copy source split array to destination split array
1.16 misho 968: *
1.12 misho 969: * @dest = Destination split array, after use free with io_sarrDestroy()
970: * @src = Source split array
971: * return: -1 error; >0 count of destination split array
972: */
973: int io_sarrCopy(sarr_t ** __restrict dest, sarr_t * __restrict src);
1.9 misho 974: /*
975: * io_sarrGet() - Get element from dynamic split-order array
1.16 misho 976: *
1.9 misho 977: * @arr = Array
978: * @idx = Index (warning 1st element is at position 1)
979: * return: NULL not found, !=NULL element
980: */
981: inline void *io_sarrGet(sarr_t * __restrict arr, unsigned int idx);
982: /*
983: * io_sarrGet2() - Always get element from dynamic split-order array
984: * Function automatic grow array. Good use for Hash tables!
1.16 misho 985: *
1.9 misho 986: * @arr = Array
987: * @idx = Index (warning 1st element is at position 1)
988: * return: NULL not found, !=NULL element
989: */
990: void *io_sarrGet2(sarr_t * __restrict arr, unsigned int idx);
991: /*
992: * io_sarrSet() - Set element to dynamic split-order array
1.16 misho 993: *
1.9 misho 994: * @arr = Array
995: * @idx = Index (warning 1st element is at position 1)
996: * @data = Value
997: * return: NULL error or empty, !=NULL old value in element
998: */
999: inline void *io_sarrSet(sarr_t * __restrict arr, unsigned int idx, void *data);
1.11 misho 1000: #define io_sarrDel(_arr, _idx) io_sarrSet((_arr), _idx, NULL)
1001: #define io_sarr(_arr, _idx, _type) (_type)io_sarrGet((_arr), _idx)
1002: /*
1003: * io_sarr2array() - Convert from split-order array to dynamic array
1.16 misho 1004: *
1.11 misho 1005: * @sa = split array
1006: * @sarrFree = after convert split array !=0 will be destroyed sarray
1007: * return: NULL error or != NULL new array
1008: */
1009: array_t *io_sarr2array(sarr_t ** __restrict sa, int sarrFree);
1010: /*
1011: * io_array2sarr() - Convert from dynamic array to split-order array
1.16 misho 1012: *
1.11 misho 1013: * @a = array
1014: * @segLen = Length of segment
1015: * @arrFree = after convert array !=0 will be destroyed
1016: * return: NULL error or != NULL new sarr
1017: */
1018: sarr_t *io_array2sarr(array_t ** __restrict a, int segLen, int arrFree);
1.8 misho 1019:
1020: /*
1.17 misho 1021: * io_CopyEnv() - Copy environment to new environment array;
1.16 misho 1022: *
1.10 misho 1023: * @oldenv = Environment array
1.20 misho 1024: * return: NULL error; !=NULL Allocated new environment array(must be io_free)
1.10 misho 1025: */
1026: char **io_CopyEnv(const char **oldenv);
1027: /*
1.17 misho 1028: * io_ExecArgs() - Build exec arguments from other array
1.16 misho 1029: *
1.10 misho 1030: * @psProg = Program name for execute
1031: * @oldarg = Arguments array
1.20 misho 1032: * return: NULL error; !=NULL Allocated execution array(must be io_free)
1.10 misho 1033: */
1034: char **io_ExecArgs(const char *psProg, const char **oldarg);
1035: /*
1.17 misho 1036: * io_FreeNullTerm() - Free dynamic allocated null terminated array with strings
1.16 misho 1037: *
1.10 misho 1038: * @arr = Pointer to array for free
1039: * return: none
1040: */
1041: inline void io_FreeNullTerm(char *** __restrict arr);
1042:
1043: /*
1.17 misho 1044: * ioMkDir() - Function for racursive directory creation and validation
1.16 misho 1045: *
1.5 misho 1046: * @csDir = Full directory path
1047: * @mode = Mode for directory creation if missing dir
1048: * return: -1 error, 0 directory path exist, >0 created missing dirs
1049: */
1050: int ioMkDir(const char *csDir, int mode);
1051:
1.6 misho 1052: /*
1.17 misho 1053: * ioWatchDirLoop() - Function for watching changes in directory and fire callback
1.16 misho 1054: *
1.6 misho 1055: * @csDir = Full directory path
1056: * @callback = Callback if raise event! nOp -1 delete, 0 change/move, 1 create
1057: * return: -1 error, !=-1 ok, number of total signaled events
1058: */
1059: int ioWatchDirLoop(const char *csDir, int (*callback)(const char *csName, int nOp));
1060:
1.5 misho 1061:
1.24 misho 1062: #ifdef AIO_OPS
1063: /*
1064: * io_aiobulk() - AIO bulk R/W function
1065: *
1066: * @mode = Bulk wait mode
1067: * @acbs = List of aiocb structures
1068: * @nacb = Number of aiocb in list
1069: * @sig = Event for completed operations, may be =NULL
1070: * return: -1 error or 0 ok
1071: */
1072: inline int io_aiobulk(int mode, struct aiocb ** __restrict acbs, int nacb,
1073: struct sigevent *sig);
1074: #endif
1075: /*
1076: * io_rreadv() - Raw VFS bulk read function
1077: *
1078: * @fd = File handle
1079: * @bufs = Read buffers
1080: * @nbufs = Number of read buffers
1081: * @offset = Read from position, if -1 read nbytes from current position
1082: * @update = Update file handle position !0
1083: * return: -1 error or !=-1 readed bytes
1084: */
1085: int io_rreadv(int fd, struct iovec * __restrict bufs, int nbufs, off_t offset,
1086: int update);
1087: /*
1088: * io_rwritev() - Raw VFS bulk write function
1089: *
1090: * @fd = File handle
1091: * @bufs = Write buffers
1092: * @nbufs = Number of write buffers
1093: * @offset = Write to position, if -1 write nbytes to current position
1094: * @update = Update file handle position !0
1095: * return: -1 error or !=-1 written bytes
1096: */
1097: int io_rwritev(int fd, struct iovec * __restrict bufs, int nbufs, off_t offset,
1098: int update);
1.5 misho 1099: /*
1.17 misho 1100: * io_rread() - Raw VFS read function
1.16 misho 1101: *
1.5 misho 1102: * @fd = File handle
1103: * @buf = Read buffer
1104: * @nbytes = Read buffer size
1105: * @offset = Read from position, if -1 read nbytes from current position
1106: * @update = Update file handle position !0
1107: * return: -1 error or !=-1 readed bytes
1108: */
1.24 misho 1109: inline int io_rread(int fd, void * __restrict buf, size_t nbytes, off_t offset,
1110: int update);
1.5 misho 1111: /*
1.17 misho 1112: * io_rwrite() - Raw VFS write function
1.16 misho 1113: *
1.5 misho 1114: * @fd = File handle
1115: * @buf = Write buffer
1116: * @nbytes = Write bytes from buffer
1117: * @offset = Write at position, if -1 write nbytes from current position
1118: * @update = Update file handle position !0
1.24 misho 1119: * return: -1 error or !=-1 written bytes
1.5 misho 1120: */
1.24 misho 1121: inline int io_rwrite(int fd, void * __restrict buf, size_t nbytes, off_t offset,
1122: int update);
1.5 misho 1123:
1124: /* Disk I/O helper macros */
1125: #define io_read(f, b, n) io_rread(f, b, n, -1, 1)
1126: #define io_write(f, b, n) io_rwrite(f, b, n, -1, 1)
1127:
1128:
1129: /* Debug helper macros */
1130: extern int io_Debug;
1131:
1.14 misho 1132: #define io_enableDEBUG int io_Debug
1133: #define io_initDebug(x) (io_Debug = (x))
1134: #define io_incDebug (io_Debug++)
1135: #define io_decDebug (io_Debug--)
1136:
1137: /* Debug macros */
1138: #define ioVERBOSE(x) if ((x) <= io_Debug)
1139: #define ioTRACE(x) if ((x) <= io_Debug) \
1140: syslog(LOG_DEBUG, "I'm in %s(%d)", __func__, __LINE__)
1.5 misho 1141: #define ioDEBUG(x, fmt, ...) do { \
1142: assert((fmt)); \
1143: char str[STRSIZ] = { 0 }; \
1.11 misho 1144: snprintf(str, sizeof str, (fmt), ##__VA_ARGS__); \
1.5 misho 1145: if ((x) <= io_Debug) \
1.14 misho 1146: syslog(LOG_DEBUG, "Debug(%d):%s(%d): %s\n", \
1.5 misho 1147: (x), __func__, __LINE__, str); \
1148: } while (0)
1149:
1.14 misho 1150: /* Logger macro */
1151: #define ioLOGGER(x, fmt, ...) do { \
1152: assert((fmt)); \
1153: char str[STRSIZ] = { 0 }; \
1154: snprintf(str, sizeof str, (fmt), ##__VA_ARGS__); \
1155: syslog((x), "Logger:%s(%d): %s\n", \
1156: __func__, __LINE__, str); \
1157: } while (0)
1158:
1159: /* Error state macros */
1.5 misho 1160: #define ioERROR(x, fmt, ...) do { \
1161: assert((fmt)); \
1162: char str[STRSIZ] = { 0 }; \
1.11 misho 1163: snprintf(str, sizeof str, (fmt), ##__VA_ARGS__); \
1.14 misho 1164: syslog(LOG_ERR, "Error:%s(%d): #%d - %s\n", \
1.5 misho 1165: __func__, __LINE__, (x), str); \
1166: } while (0)
1.14 misho 1167: #define ioSYSERR(x) do { \
1.5 misho 1168: if (x > 0 || errno) \
1.14 misho 1169: syslog(LOG_ERR, "Error(sys):%s(%d): #%d - %s\n", \
1.5 misho 1170: __func__, __LINE__, x > 0 ? x : errno, \
1171: strerror(x > 0 ? x : errno)); \
1172: } while (0)
1.14 misho 1173: #define ioLIBERR(ait) do { \
1.5 misho 1174: if (ait##_GetErrno()) \
1.14 misho 1175: syslog(LOG_ERR, "Error(lib):%s(%d): #%d - %s\n", \
1.5 misho 1176: __func__, __LINE__, ait##_GetErrno(), \
1177: ait##_GetError()); \
1178: } while (0)
1.3 misho 1179:
1.1 misho 1180:
1.7 misho 1181: /* Crypto framework */
1182:
1183: /*
1.17 misho 1184: * ioCipher() - Cipher wrapper for all supported crypto algorythms
1.16 misho 1185: *
1.7 misho 1186: * @pInput = input buffer
1187: * @inLen = input buffer len
1.20 misho 1188: * @ppOutput = output allocated buffe, must be io_free after use
1.7 misho 1189: * @Cipher = cipher engine, like EVP_bf_cbc() or etc...
1190: * @pKey = key
1191: * @pIV = IV, salt (8 bytes)
1192: * @nMode = Mode 0 - decrypting or 1 - encrypting
1193: * return: 0 not present data or error!; >0 number of processed and returned bytes into ppOutput
1194: */
1195: int ioCipher(unsigned char *pInput, int inLen, unsigned char **ppOutput, const EVP_CIPHER *Cipher,
1196: unsigned char *pKey, unsigned char *pIV, int nMode);
1197:
1198: /*
1.17 misho 1199: * io_Blowfish() - Blowfish cipher algorythm, work with ASCII hex strings
1.16 misho 1200: *
1.7 misho 1201: * @pInput = input buffer
1202: * @inLen = input buffer len
1.20 misho 1203: * @ppOutput = output allocated buffe, must be io_free after use
1.7 misho 1204: * @pKey = key
1205: * @pIV = IV, salt (8 bytes)
1206: * @nMode = Mode 0 - decrypting or 1 - encrypting
1207: * return: 0 not present data or error!; >0 number of processed and returned bytes into ppOutput
1208: */
1.8 misho 1209: int io_Blowfish(unsigned char *pInput, int inLen, unsigned char **ppOutput,
1210: unsigned char *pKey, unsigned char *pIV, int nMode);
1.12 misho 1211: /*
1.17 misho 1212: * io_ctr_AES() - Encrypt/Decrypt stream cipher CTR_AES
1.16 misho 1213: *
1.12 misho 1214: * @pInput = Input buffer with ASCII
1215: * @inLen = Input buffer data length
1.20 misho 1216: * @ppOutput = Output buffer with cipher data, must be io_free after use
1.12 misho 1217: * @pKey = Key
1218: * @IV = IVector/Nonce/Counter, Warning: IV must be variable, because we write there!!!
1219: * return: -1 error or >-1 how many cipher blocks proceeded
1220: */
1221: int io_ctr_AES(unsigned char *pInput, int inLen, unsigned char **ppOutput,
1222: unsigned char *pKey, unsigned char IV[AES_BLOCK_SIZE]);
1223:
1224:
1225: /*
1.17 misho 1226: * ioAllocPTY() - Allocate new PTY and TTY
1.16 misho 1227: *
1.12 misho 1228: * @ptyfd = master fd, pty
1229: * @ttyfd = slave fd, tty
1230: * @name = tty device name if not null
1231: * @namesiz = name length, must be above 63 bytes.
1232: * @term = termios for terminal
1233: * @winz = winsize for terminal
1234: * return: -1 error or 0 ok
1235: */
1236: inline int ioAllocPTY(int *ptyfd, int *ttyfd, char * __restrict name, int namesiz,
1237: struct termios * __restrict term, struct winsize * __restrict winz);
1238: /*
1.17 misho 1239: * ioFreePTY() - Release PTY and TTY device
1.16 misho 1240: *
1.12 misho 1241: * @ptyfd = master fd, pty (==-1 skip closing pty)
1242: * @ttyname = tty filename
1243: * return: none
1244: */
1245: inline void ioFreePTY(int ptyfd, const char *ttyname);
1246: /*
1.17 misho 1247: * ioChgWinPTY() - Change window size of PTY
1.16 misho 1248: *
1.12 misho 1249: * @ptyfd = master fd, pty
1250: * @row = row
1251: * @col = col
1252: * @xpxl = x pixels
1253: * @ypxl = y pixels
1254: * return: -1 error or 0 ok
1255: */
1256: inline int ioChgWinPTY(int ptyfd, unsigned short row, unsigned short col,
1257: unsigned short xpxl, unsigned short ypxl);
1258: /*
1.17 misho 1259: * ioSetOwnerTTY() - Set owner to TTY
1.16 misho 1260: *
1.12 misho 1261: * @ttyname = tty filename
1262: * @UID = uid
1263: * @GID = gid
1264: * return: -1 error or 0 ok
1265: */
1266: int ioSetOwnerTTY(const char *ttyname, uid_t UID, gid_t GID);
1267: /*
1.17 misho 1268: * ioSetSidTTY() - Makes the process's controlling TTY and sets it to sane modes.
1.16 misho 1269: *
1.12 misho 1270: * @ttyfd = slave fd, tty
1271: * @ttyname = tty filename
1272: * return: -1 error or 0 ok
1273: */
1274: int ioSetSidTTY(int *ttyfd, const char *ttyname);
1275: /*
1.17 misho 1276: * ioSetRAWMode() - Enter into RAW mode
1.16 misho 1277: *
1.12 misho 1278: * @fd = tty fd
1279: * @otio = saved old termios for later restore if !=NULL
1280: * return: -1 error or 0 ok
1281: */
1282: inline int ioSetRAWMode(int fd, struct termios *otio);
1283: /*
1.17 misho 1284: * ioRestoreMode() - Restore termios to tty fd
1.16 misho 1285: *
1.12 misho 1286: * @fd = tty fd
1287: * @tio = termios structure for restore
1288: * return: -1 error or 0 ok
1289: */
1290: inline int ioRestoreMode(int fd, struct termios tio);
1291: /*
1.17 misho 1292: * ioForkPTY() - Fork new process with session leader and new TTY
1.16 misho 1293: *
1.12 misho 1294: * @ptyfd = master fd, pty
1295: * @name = tty device name if not null
1296: * @namesiz = name length, must be above 63 bytes.
1297: * @term = termios for terminal
1298: * @winz = winsize for terminal
1299: * @otio = old termios structure for restore
1300: * return: -1 error, 0 child process or >0 parent: pid of child
1301: */
1302: pid_t ioForkPTY(int *ptyfd, char * __restrict name, int namesiz, struct termios * __restrict term,
1303: struct winsize * __restrict winz, struct termios * __restrict otio);
1304:
1305: /*
1.17 misho 1306: * ioCreatePIDFile() - Create PID file
1.16 misho 1307: *
1.12 misho 1308: * @csName = PID filename
1309: * @ifExists = !=0 if filename exists return error
1310: * return: -1 error or 0 ok
1311: */
1312: inline int ioCreatePIDFile(const char *csName, int ifExists);
1.7 misho 1313:
1.13 misho 1314: /*
1.17 misho 1315: * ioSendFile() - AITNET sendfile() userland implementation, not dependant from OS
1.16 misho 1316: *
1.13 misho 1317: * @s = socket
1318: * @csFile = file for send
1319: * @sendLen = bytes to send, if 0 send all data
1320: * @offset = start file offset
1321: * @sndbuf = SO_SNDBUF value, if 0 use default
1322: * return: 0 error, >0 ok, sended bytes
1323: */
1324: size_t ioSendFile(int s, const char *csFile, size_t sendLen, off_t offset, int sndbuf);
1325: /*
1.17 misho 1326: * ioRecvFile() - Receive file from socket, fastest (zero-copy) way
1.16 misho 1327: *
1.13 misho 1328: * @s = socket
1329: * @csFile = file for receive
1330: * @recvLen = receive bytes
1331: * @over = overwrite file if exists with mode like 0644
1332: * @rcvbuf = SO_RCVBUF value, if 0 use default
1333: * return: 0 error, >0 ok, received bytes
1334: */
1335: size_t ioRecvFile(int s, const char *csFile, size_t recvLen, int over, int rcvbuf);
1336:
1.7 misho 1337:
1.14 misho 1338: /* Buffered file access over memory block */
1339:
1340: /*
1.17 misho 1341: * io_fmemopen() - File buffered stream operations over memory block
1.14 misho 1342: *
1343: * @base = Base address of memory block, if =NULL Infinit length(auto-grow)
1344: * @basesize = Size of memory block
1345: * return: NULL error or !=NULL Opened file resource
1346: */
1347: FILE *io_fmemopen(void ** __restrict base, off_t basesize);
1348: /*
1.17 misho 1349: * io_fmapopen() - File buffered stream operations over MMAP block
1.14 misho 1350: *
1351: * @csFile = Filename for MMAP, if =NULL private MMAP block
1352: * @mode = File open mode
1353: * @perm = If file not exists will be created with this access permissions
1354: * @prot = MMAP protection
1355: * @flags = MMAP mode flags
1356: * @offset = Map from file offset, if csFile==NULL then this is size of MMAP private block
1357: * return: NULL error or !=NULL Opened file resource
1358: */
1359: FILE *io_fmapopen(const char *csFile, int mode, int perm, int prot, int flags, off_t offset);
1360: /*
1.17 misho 1361: * io_fd2buf() - Convert open file handle to buffered file I/O
1.14 misho 1362: *
1363: * @fd = File handle
1364: * @mode = Permissions for new buffered file I/O
1365: * return: NULL error or open buffered file
1366: */
1367: inline FILE *io_fd2buf(int fd, const char *mode);
1368: /*
1.17 misho 1369: * io_dumbFile() - Create empry or dumb file with fixed size
1.14 misho 1370: *
1371: * @csFile = Filename for create
1372: * @mode = File access permissions
1373: * @size = File size
1374: * return: -1 error or open file handle
1375: */
1376: int io_dumbFile(const char *csFile, int mode, off_t size);
1377:
1378:
1.1 misho 1379: #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