Annotation of libaitio/inc/aitio.h, revision 1.36.2.4

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

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>