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