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