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