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