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