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