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