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