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