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