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