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