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

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

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