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