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