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