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