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