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