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