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