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