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