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