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