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