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