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