Annotation of libaitio/inc/aitio.h, revision 1.38.10.12
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.38.10.12! misho 6: * $Id: aitio.h,v 1.38.10.11 2013/12/08 21:11:54 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.29 misho 15: Copyright 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013
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.24 misho 53: #include <syslog.h>
1.7 misho 54: #include <openssl/evp.h>
1.12 misho 55: #include <openssl/aes.h>
56: #include <sys/tty.h>
57: #include <sys/ioctl_compat.h>
1.13 misho 58: #include <sys/socket.h>
59: #include <sys/un.h>
1.24 misho 60: #include <sys/uio.h>
1.13 misho 61: #include <net/if_dl.h>
1.33 misho 62: #include <net/bpf.h>
1.13 misho 63: #include <netinet/in.h>
1.34 misho 64: #include <elwix.h>
1.37 misho 65: #include <aitsched.h>
1.7 misho 66:
67:
1.21 misho 68: #ifndef STRSIZ
1.34 misho 69: #define STRSIZ 256
1.21 misho 70: #endif
71:
1.34 misho 72: #define IO_SOCK_ROLE_CLIENT 0
73: #define IO_SOCK_ROLE_SERVER 1
74:
1.36 misho 75: #define IO_ETHER_FILTER_PROMISC 0
76: #define IO_ETHER_FILTER_NOTREAD -1
77: #define IO_ETHER_FILTER_READ 1
78: #define IO_ETHER_FILTER_WRITE 2
79:
1.34 misho 80:
1.35 misho 81: typedef struct tagCliSock sock_cli_t;
82: typedef void *(*sock_cb_t)(sock_cli_t*);
83: struct tagCliSock {
84: void *cli_parent;
85: int cli_fd;
86: int cli_pty;
87: sockaddr_t cli_addr;
88: char cli_name[64];
1.37 misho 89: char cli_cmdline[PATH_MAX];
90: pid_t cli_pid;
1.35 misho 91:
1.37 misho 92: sched_task_func_t cli_func;
1.35 misho 93:
1.37 misho 94: ait_val_t cli_buf[2];
1.35 misho 95:
96: TAILQ_ENTRY(tagCliSock) cli_node;
97: };
1.37 misho 98:
1.34 misho 99: typedef struct {
1.35 misho 100: int sock_role;
101: int sock_backq;
102: int sock_type;
103: int sock_proto;
104: int sock_fd;
1.37 misho 105: struct timespec sock_timeout;
1.35 misho 106: sockaddr_t sock_addr;
107: sockaddr_t sock_peer;
1.34 misho 108:
1.35 misho 109: ait_val_t sock_buf;
1.34 misho 110:
1.37 misho 111: volatile intptr_t sock_kill;
112: sched_root_task_t *sock_root;
113:
1.35 misho 114: pthread_mutex_t sock_mtx;
115: TAILQ_HEAD(, tagCliSock) sock_cli;
1.34 misho 116: } sock_t;
117:
1.38.10.2 misho 118: typedef struct {
119: unsigned int prog_inin; /* init progs */
120: unsigned int prog_maxn; /* max progs */
121: unsigned int prog_cnum; /* current progs */
122: char prog_name[PATH_MAX];
123:
124: pthread_mutex_t prog_mtx;
125: array_t *prog_fds;
1.38.10.7 misho 126: unsigned int *prog_used;
1.38.10.2 misho 127: } prog_t;
128:
1.15 misho 129:
1.1 misho 130: // io_GetErrno() Get error code of last operation
1.30 misho 131: int io_GetErrno();
1.1 misho 132: // io_GetError() Get error text of last operation
1.30 misho 133: const char *io_GetError();
1.1 misho 134:
135:
1.12 misho 136: /*
1.38.10.2 misho 137: * io_progInit() - Init program pool
138: *
139: * @progName = program name for execution
140: * @initNum = initial started programs
141: * @maxNum = maximum started programs
142: * return: NULL error or !=NULL allocated pool (must destroied with io_progDestroy())
143: */
144: prog_t *io_progInit(const char *progName,
145: unsigned int initNum, unsigned int maxNum);
146: /*
147: * io_progOpen() - Execute number of program(s)
148: *
149: * @prg = program pool
150: * @execNum = execute program(s) (0 max)
151: * return: 0 error, >0 executed programs and abs(<0) executed programs with logged error
152: */
153: int io_progOpen(prog_t * __restrict prg, unsigned int execNum);
154: /*
1.38.10.6 misho 155: * io_progGrow() - Execute to number of programs in pool
156: *
157: * @prg = program pool
158: * @toNum = execute to number of programs (0 max)
1.38.10.12! misho 159: * return: 0 error or nothing to do,
! 160: * >0 executed programs and abs(<0) executed programs with logged error
1.38.10.6 misho 161: */
162: int io_progGrow(prog_t * __restrict prg, unsigned int toNum);
163: /*
1.38.10.2 misho 164: * io_progVacuum() - Vacuum pool to running number of programs
165: *
166: * @prg = program pool
167: * @toNum = vacuum to number of programs (0 to init number)
168: * return: 0 error or >0 closed programs
169: */
1.38.10.6 misho 170: int io_progVacuum(prog_t * __restrict prg, unsigned int toNum);
1.38.10.2 misho 171: /*
1.38.10.9 misho 172: * io_progCloseAt() - Close program at pool of certain position
173: *
174: * @prg = program pool
175: * @idx = index at pool
176: * return: 0 error or !=0 closed program
177: */
178: int io_progCloseAt(prog_t * __restrict prg, unsigned int idx);
179: /*
1.38.10.2 misho 180: * io_progClose() - Close all programs in pool
181: *
182: * @prg = program pool
183: * @closeNum = close program(s) (0 all)
184: * return: 0 error, >0 closed programs
185: */
186: int io_progClose(prog_t * __restrict prg, unsigned int closeNum);
187: /*
188: * io_progDestroy() - Destroy entire program pool
189: *
190: * @pprg = program pool
191: * return: none
192: */
193: void io_progDestroy(prog_t ** __restrict pprg);
194:
1.38.10.5 misho 195: /*
196: * io_progCheck() - Check exit status of program pool
197: *
198: * @prg = program pool
1.38.10.10 misho 199: * @re = resurrect program
1.38.10.5 misho 200: * return: -1 error or >-1 exited programs
201: */
1.38.10.10 misho 202: int io_progCheck(prog_t * __restrict prg, int re);
1.38.10.5 misho 203:
1.38.10.7 misho 204: /*
205: * io_progAttach() - Attach to open program
206: *
207: * @prg = program pool
1.38.10.11 misho 208: * @newOne = Execute new one program after attach
1.38.10.7 misho 209: * return: NULL error or !=NULL attached program handle
210: */
1.38.10.8 misho 211: #ifdef POPEN_STREAM
1.38.10.11 misho 212: FILE *io_progAttach(prog_t * __restrict prg, int newOne);
1.38.10.8 misho 213: #else
1.38.10.11 misho 214: int io_progAttach(prog_t * __restrict prg, int newOne);
1.38.10.8 misho 215: #endif
1.38.10.7 misho 216: /*
217: * io_progDetach() - Detch from open program
218: *
219: * @prg= program pool
220: * @pfd = attached program handle
221: * return: none
222: */
1.38.10.8 misho 223: #ifdef POPEN_STREAM
1.38.10.7 misho 224: void io_progDetach(prog_t * __restrict prg, FILE *pfd);
1.38.10.8 misho 225: #else
226: void io_progDetach(prog_t * __restrict prg, int pfd);
227: #endif
1.38.10.7 misho 228:
1.38.10.2 misho 229:
230: /*
1.34 misho 231: * ioInitSocket() - Init socket and allocate resources
232: *
233: * @role = Socket role
234: * @type = Socket type
235: * @proto = Socket protocol
236: * @addr = Bind to address
237: * @port = Bind to port
238: * @buflen = Socket buffer, optional if =0 == BUFSIZ
239: * return: NULL error or !=NULL created socket
240: */
241: sock_t *ioInitSocket(int role, int type, int proto,
242: const char *addr, unsigned short port, size_t buflen);
243: /*
244: * ioCloseSocket() - Close socket and free resources
245: *
246: * @s = Socket
247: * return: none
248: */
249: void ioCloseSocket(sock_t ** __restrict s);
1.37 misho 250: #define ioKillSocket(x) (assert((x)), (x)->sock_kill = 1)
251: /*
252: * ioCloseClient() - Close client socket
253: *
254: * @c = Client socket
255: * return: 0 ok or !=0 error
256: */
257: int ioCloseClient(sock_cli_t * __restrict c);
1.34 misho 258: /*
259: * ioUpSocket() - Setup socket for use
260: *
261: * @s = Socket
262: * @arg = Server role = listen backlog queue and Client role = peer address
1.37 misho 263: * @timeout = Socket timeout in ms (default -1 infinit)
1.34 misho 264: * return: -1 error or 0 ok
265: */
1.37 misho 266: int ioUpSocket(sock_t * __restrict s, void *arg, int timeout);
1.35 misho 267: /*
1.37 misho 268: * ioUpdTimerSocket() - Update timeout of socket
269: *
270: * @c = Client socket
271: * return: none
272: */
1.38 misho 273: void ioUpdTimerSocket(sock_cli_t * __restrict c);
1.37 misho 274: /*
275: * ioLoopSocket() - Start socket scheduler
276: *
277: * @s = Socket
278: * @rcb = Read callback
279: * return: -1 error or return result from scheduler
280: */
281: int ioLoopSocket(sock_t * __restrict s, sched_task_func_t rcb);
282: /*
283: * ioBridgeProg2Socket() - Start socket scheduler and bridge program to socket
1.35 misho 284: *
285: * @s = Socket
1.37 misho 286: * @prgname = Program name
287: * return: 0 ok or !=0 error
1.35 misho 288: */
1.37 misho 289: int ioBridgeProg2Socket(sock_t * __restrict s, const char *prgname);
1.34 misho 290:
1.38.10.2 misho 291:
1.34 misho 292: /*
1.17 misho 293: * ioPromptRead() - Read data from input h[0] with prompt to output h[1]
1.16 misho 294: *
1.1 misho 295: * @h = file handles h[0] = input, h[1] = output, if NULL use stdin, stdout
296: * @csPrompt = Prompt before input, may be NULL
297: * @psData = Readed data
298: * @dataLen = Length of data
299: * return: 0 EOF; -1 error:: can`t read; >0 count of readed chars
300: */
1.37 misho 301: int ioPromptRead(int *h, const char *csPrompt,
302: char * __restrict psData, int dataLen);
1.1 misho 303: /*
1.17 misho 304: * ioPromptPassword() - Read password from input h[0] with prompt to output h[1]
1.16 misho 305: *
1.1 misho 306: * @h = file handles h[0] = input, h[1] = output, if NULL use stdin, stdout
307: * @csPrompt = Prompt before input, may be NULL
308: * @psPass = Readed password
309: * @passLen = Length of password
310: * @confirm = Confirm password, 0 - get password, !=0 Ask for confirmation
311: * return: 0 EOF; -1 error:: can`t read; >0 count of readed chars
312: */
1.37 misho 313: int ioPromptPassword(int *h, const char *csPrompt,
314: char * __restrict psPass, int passLen, int confirm);
1.1 misho 315:
1.10 misho 316:
317: /*
1.17 misho 318: * ioMkDir() - Function for racursive directory creation and validation
1.16 misho 319: *
1.5 misho 320: * @csDir = Full directory path
321: * @mode = Mode for directory creation if missing dir
322: * return: -1 error, 0 directory path exist, >0 created missing dirs
323: */
324: int ioMkDir(const char *csDir, int mode);
325:
1.6 misho 326: /*
1.17 misho 327: * ioWatchDirLoop() - Function for watching changes in directory and fire callback
1.16 misho 328: *
1.6 misho 329: * @csDir = Full directory path
330: * @callback = Callback if raise event! nOp -1 delete, 0 change/move, 1 create
331: * return: -1 error, !=-1 ok, number of total signaled events
332: */
333: int ioWatchDirLoop(const char *csDir, int (*callback)(const char *csName, int nOp));
334:
1.5 misho 335:
1.24 misho 336: #ifdef AIO_OPS
337: /*
338: * io_aiobulk() - AIO bulk R/W function
339: *
340: * @mode = Bulk wait mode
341: * @acbs = List of aiocb structures
342: * @nacb = Number of aiocb in list
343: * @sig = Event for completed operations, may be =NULL
344: * return: -1 error or 0 ok
345: */
1.30 misho 346: int io_aiobulk(int mode, struct aiocb ** __restrict acbs, int nacb,
1.24 misho 347: struct sigevent *sig);
348: #endif
349: /*
350: * io_rreadv() - Raw VFS bulk read function
351: *
352: * @fd = File handle
353: * @bufs = Read buffers
354: * @nbufs = Number of read buffers
355: * @offset = Read from position, if -1 read nbytes from current position
356: * @update = Update file handle position !0
357: * return: -1 error or !=-1 readed bytes
358: */
359: int io_rreadv(int fd, struct iovec * __restrict bufs, int nbufs, off_t offset,
360: int update);
361: /*
362: * io_rwritev() - Raw VFS bulk write function
363: *
364: * @fd = File handle
365: * @bufs = Write buffers
366: * @nbufs = Number of write buffers
367: * @offset = Write to position, if -1 write nbytes to current position
368: * @update = Update file handle position !0
369: * return: -1 error or !=-1 written bytes
370: */
371: int io_rwritev(int fd, struct iovec * __restrict bufs, int nbufs, off_t offset,
372: int update);
1.5 misho 373: /*
1.17 misho 374: * io_rread() - Raw VFS read function
1.16 misho 375: *
1.5 misho 376: * @fd = File handle
377: * @buf = Read buffer
378: * @nbytes = Read buffer size
379: * @offset = Read from position, if -1 read nbytes from current position
380: * @update = Update file handle position !0
381: * return: -1 error or !=-1 readed bytes
382: */
1.30 misho 383: int io_rread(int fd, void * __restrict buf, size_t nbytes, off_t offset,
1.24 misho 384: int update);
1.5 misho 385: /*
1.17 misho 386: * io_rwrite() - Raw VFS write function
1.16 misho 387: *
1.5 misho 388: * @fd = File handle
389: * @buf = Write buffer
390: * @nbytes = Write bytes from buffer
391: * @offset = Write at position, if -1 write nbytes from current position
392: * @update = Update file handle position !0
1.24 misho 393: * return: -1 error or !=-1 written bytes
1.5 misho 394: */
1.30 misho 395: int io_rwrite(int fd, void * __restrict buf, size_t nbytes, off_t offset,
1.24 misho 396: int update);
1.5 misho 397:
398: /* Disk I/O helper macros */
399: #define io_read(f, b, n) io_rread(f, b, n, -1, 1)
400: #define io_write(f, b, n) io_rwrite(f, b, n, -1, 1)
401:
402:
1.7 misho 403: /* Crypto framework */
404:
405: /*
1.17 misho 406: * ioCipher() - Cipher wrapper for all supported crypto algorythms
1.16 misho 407: *
1.7 misho 408: * @pInput = input buffer
409: * @inLen = input buffer len
1.29 misho 410: * @ppOutput = output allocated buffe, must be e_free after use
1.7 misho 411: * @Cipher = cipher engine, like EVP_bf_cbc() or etc...
412: * @pKey = key
413: * @pIV = IV, salt (8 bytes)
414: * @nMode = Mode 0 - decrypting or 1 - encrypting
415: * return: 0 not present data or error!; >0 number of processed and returned bytes into ppOutput
416: */
417: int ioCipher(unsigned char *pInput, int inLen, unsigned char **ppOutput, const EVP_CIPHER *Cipher,
418: unsigned char *pKey, unsigned char *pIV, int nMode);
419:
420: /*
1.17 misho 421: * io_Blowfish() - Blowfish cipher algorythm, work with ASCII hex strings
1.16 misho 422: *
1.7 misho 423: * @pInput = input buffer
424: * @inLen = input buffer len
1.29 misho 425: * @ppOutput = output allocated buffe, must be e_free after use
1.7 misho 426: * @pKey = key
427: * @pIV = IV, salt (8 bytes)
428: * @nMode = Mode 0 - decrypting or 1 - encrypting
429: * return: 0 not present data or error!; >0 number of processed and returned bytes into ppOutput
430: */
1.8 misho 431: int io_Blowfish(unsigned char *pInput, int inLen, unsigned char **ppOutput,
432: unsigned char *pKey, unsigned char *pIV, int nMode);
1.12 misho 433: /*
1.17 misho 434: * io_ctr_AES() - Encrypt/Decrypt stream cipher CTR_AES
1.16 misho 435: *
1.12 misho 436: * @pInput = Input buffer with ASCII
437: * @inLen = Input buffer data length
1.29 misho 438: * @ppOutput = Output buffer with cipher data, must be e_free after use
1.12 misho 439: * @pKey = Key
440: * @IV = IVector/Nonce/Counter, Warning: IV must be variable, because we write there!!!
441: * return: -1 error or >-1 how many cipher blocks proceeded
442: */
443: int io_ctr_AES(unsigned char *pInput, int inLen, unsigned char **ppOutput,
444: unsigned char *pKey, unsigned char IV[AES_BLOCK_SIZE]);
445:
446:
447: /*
1.17 misho 448: * ioAllocPTY() - Allocate new PTY and TTY
1.16 misho 449: *
1.12 misho 450: * @ptyfd = master fd, pty
451: * @ttyfd = slave fd, tty
452: * @name = tty device name if not null
453: * @namesiz = name length, must be above 63 bytes.
454: * @term = termios for terminal
455: * @winz = winsize for terminal
456: * return: -1 error or 0 ok
457: */
1.30 misho 458: int ioAllocPTY(int *ptyfd, int *ttyfd, char * __restrict name, int namesiz,
1.12 misho 459: struct termios * __restrict term, struct winsize * __restrict winz);
460: /*
1.17 misho 461: * ioFreePTY() - Release PTY and TTY device
1.16 misho 462: *
1.12 misho 463: * @ptyfd = master fd, pty (==-1 skip closing pty)
464: * @ttyname = tty filename
465: * return: none
466: */
1.30 misho 467: void ioFreePTY(int ptyfd, const char *ttyname);
1.12 misho 468: /*
1.17 misho 469: * ioChgWinPTY() - Change window size of PTY
1.16 misho 470: *
1.12 misho 471: * @ptyfd = master fd, pty
472: * @row = row
473: * @col = col
474: * @xpxl = x pixels
475: * @ypxl = y pixels
476: * return: -1 error or 0 ok
477: */
1.30 misho 478: int ioChgWinPTY(int ptyfd, unsigned short row, unsigned short col,
1.12 misho 479: unsigned short xpxl, unsigned short ypxl);
480: /*
1.17 misho 481: * ioSetOwnerTTY() - Set owner to TTY
1.16 misho 482: *
1.12 misho 483: * @ttyname = tty filename
484: * @UID = uid
485: * @GID = gid
486: * return: -1 error or 0 ok
487: */
488: int ioSetOwnerTTY(const char *ttyname, uid_t UID, gid_t GID);
489: /*
1.17 misho 490: * ioSetSidTTY() - Makes the process's controlling TTY and sets it to sane modes.
1.16 misho 491: *
1.12 misho 492: * @ttyfd = slave fd, tty
493: * @ttyname = tty filename
494: * return: -1 error or 0 ok
495: */
496: int ioSetSidTTY(int *ttyfd, const char *ttyname);
497: /*
1.17 misho 498: * ioSetRAWMode() - Enter into RAW mode
1.16 misho 499: *
1.12 misho 500: * @fd = tty fd
501: * @otio = saved old termios for later restore if !=NULL
502: * return: -1 error or 0 ok
503: */
1.30 misho 504: int ioSetRAWMode(int fd, struct termios *otio);
1.12 misho 505: /*
1.17 misho 506: * ioRestoreMode() - Restore termios to tty fd
1.16 misho 507: *
1.12 misho 508: * @fd = tty fd
509: * @tio = termios structure for restore
510: * return: -1 error or 0 ok
511: */
1.30 misho 512: int ioRestoreMode(int fd, struct termios tio);
1.12 misho 513: /*
1.17 misho 514: * ioForkPTY() - Fork new process with session leader and new TTY
1.16 misho 515: *
1.12 misho 516: * @ptyfd = master fd, pty
517: * @name = tty device name if not null
518: * @namesiz = name length, must be above 63 bytes.
519: * @term = termios for terminal
520: * @winz = winsize for terminal
521: * @otio = old termios structure for restore
522: * return: -1 error, 0 child process or >0 parent: pid of child
523: */
524: pid_t ioForkPTY(int *ptyfd, char * __restrict name, int namesiz, struct termios * __restrict term,
525: struct winsize * __restrict winz, struct termios * __restrict otio);
526:
527: /*
1.17 misho 528: * ioCreatePIDFile() - Create PID file
1.16 misho 529: *
1.12 misho 530: * @csName = PID filename
531: * @ifExists = !=0 if filename exists return error
532: * return: -1 error or 0 ok
533: */
1.30 misho 534: int ioCreatePIDFile(const char *csName, int ifExists);
1.7 misho 535:
1.13 misho 536: /*
1.17 misho 537: * ioSendFile() - AITNET sendfile() userland implementation, not dependant from OS
1.16 misho 538: *
1.13 misho 539: * @s = socket
540: * @csFile = file for send
541: * @sendLen = bytes to send, if 0 send all data
542: * @offset = start file offset
543: * @sndbuf = SO_SNDBUF value, if 0 use default
544: * return: 0 error, >0 ok, sended bytes
545: */
546: size_t ioSendFile(int s, const char *csFile, size_t sendLen, off_t offset, int sndbuf);
547: /*
1.17 misho 548: * ioRecvFile() - Receive file from socket, fastest (zero-copy) way
1.16 misho 549: *
1.13 misho 550: * @s = socket
551: * @csFile = file for receive
552: * @recvLen = receive bytes
553: * @over = overwrite file if exists with mode like 0644
554: * @rcvbuf = SO_RCVBUF value, if 0 use default
555: * return: 0 error, >0 ok, received bytes
556: */
557: size_t ioRecvFile(int s, const char *csFile, size_t recvLen, int over, int rcvbuf);
558:
1.31 misho 559: /*
560: * ioRealFileName() - Get real file name
561: *
562: * @fname = filename
563: * return: =NULL error or !=NULL real filename, should be free with e_free()
564: */
565: char *ioRealFileName(const char *fname);
1.7 misho 566:
1.14 misho 567: /* Buffered file access over memory block */
568:
569: /*
1.17 misho 570: * io_fmemopen() - File buffered stream operations over memory block
1.14 misho 571: *
572: * @base = Base address of memory block, if =NULL Infinit length(auto-grow)
573: * @basesize = Size of memory block
574: * return: NULL error or !=NULL Opened file resource
575: */
576: FILE *io_fmemopen(void ** __restrict base, off_t basesize);
577: /*
1.17 misho 578: * io_fmapopen() - File buffered stream operations over MMAP block
1.14 misho 579: *
580: * @csFile = Filename for MMAP, if =NULL private MMAP block
581: * @mode = File open mode
582: * @perm = If file not exists will be created with this access permissions
583: * @prot = MMAP protection
584: * @flags = MMAP mode flags
585: * @offset = Map from file offset, if csFile==NULL then this is size of MMAP private block
586: * return: NULL error or !=NULL Opened file resource
587: */
588: FILE *io_fmapopen(const char *csFile, int mode, int perm, int prot, int flags, off_t offset);
589: /*
1.17 misho 590: * io_fd2buf() - Convert open file handle to buffered file I/O
1.14 misho 591: *
592: * @fd = File handle
593: * @mode = Permissions for new buffered file I/O
594: * return: NULL error or open buffered file
595: */
1.30 misho 596: FILE *io_fd2buf(int fd, const char *mode);
1.14 misho 597: /*
1.17 misho 598: * io_dumbFile() - Create empry or dumb file with fixed size
1.14 misho 599: *
600: * @csFile = Filename for create
601: * @mode = File access permissions
602: * @size = File size
603: * return: -1 error or open file handle
604: */
605: int io_dumbFile(const char *csFile, int mode, off_t size);
606:
607:
1.32 misho 608: /*
609: * io_get1stiface() - Get first interface of host
610: *
611: * @szIface = interface string buffer
612: * @iflen = size of interface buffer
613: * return: -1 error or 0 ok
614: */
615: int io_get1stiface(char *szIface, int iflen);
616: /*
1.38.10.1 misho 617: * io_getmaciface() - Get MAC address from interface name
618: *
619: * @csIface = interface name
620: * @ea = ethernet address
621: * return: -1 error, 0 ok or 1 not found
622: */
623: int io_getmaciface(const char *csIface, ether_addr_t * __restrict ea);
624: /*
1.32 misho 625: * io_etherOpen() - Open BPF interface to device
626: *
627: * @csIface = interface name
628: * @flags = open flags
629: * @whdr = with complete headers
1.33 misho 630: * @wdlt = with data link type
1.32 misho 631: * @buflen = buffer length
632: * @zcbuf = zero copy buffer, if BPF supports it and isn't NULL
633: * return: -1 error or >-1 bpf handle
634: */
1.33 misho 635: int io_etherOpen(const char *csIface, int flags, int whdr, int wdlt,
1.32 misho 636: unsigned int *buflen, void **zcbuf);
637: /*
638: * io_etherClose() - Close BPF interface
639: *
640: * @eth = bpf handle
641: * @zcbuf = zero copy buffer, if BPF supports it and isn't NULL
642: * return: none
643: */
644: void io_etherClose(int eth, void **zcbuf);
645:
646: /*
1.36 misho 647: * io_etherFilter() - BPF filter routine
648: *
649: * @eth = bpf handle
650: * @io = filter direction
651: * (IO_ETHER_FILTER_PROMISC|IO_ETHER_FILTER_NOTREAD|IO_ETHER_FILTER_READ|IO_ETHER_FILTER_WRITE)
652: * @insn = BPF filter instruction array
653: * @insnlen = Length of BPF filter instruction array
654: * return: -1 error or 0 ok
655: */
656: int io_etherFilter(int eth, int io, struct bpf_insn * __restrict insn, size_t insnlen);
657:
658: /*
1.32 misho 659: * io_etherSend() - Send packet to bpf
660: *
661: * @eth = bpf handle
662: * @buf = buffer
663: * @buflen = buffer length
664: * return: -1 error or !=-1 written bytes
665: */
666: ssize_t io_etherSend(int eth, const void *buf, size_t buflen);
667: /*
668: * io_etherRecv() - Receive packet from bpf
669: *
670: * @eth = bpf handle
671: * @buf = buffer
672: * @buflen = buffer length
673: * @zcbuf = zero copy buffer, if BPF supports it and isn't NULL
674: * return: -1 error or !=-1 readed bytes
675: */
676: ssize_t io_etherRecv(int eth, void * __restrict buf,
677: size_t buflen, void * __restrict zcbuf);
678:
679:
1.1 misho 680: #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