libaitio/inc/aitio.h - diff

Return to aitio.h CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / libaitio / inc

Diff for /libaitio/inc/aitio.h between versions 1.4 and 1.31

version 1.4, 2010/04/16 13:25:27	version 1.31, 2013/06/04 12:44:46
Line 1	Line 1
/*************************************************************************	/*************************************************************************
* (C) 2010 AITNET ltd - Sofia/Bulgaria - <misho@aitbg.com>	* (C) 2010 AITNET ltd - Sofia/Bulgaria - <misho@aitnet.org>
* by Michael Pounov <misho@openbsd-bg.org>	* by Michael Pounov <misho@elwix.org>
*	*
* $Author$	* $Author$
* $Id$	* $Id$
*	*
*************************************************************************/	**************************************************************************
#ifndef __AITIO_H	The ELWIX and AITNET software is distributed under the following
#define __AITIO_H	terms:

	All of the documentation and software included in the ELWIX and AITNET
	Releases is copyrighted by ELWIX - Sofia/Bulgaria <info@elwix.org>

typedef struct _tagURLItem {	Copyright 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013
int vallen;	by Michael Pounov <misho@elwix.org>. All rights reserved.
char *value;
} url_Item_t;

struct tagIOURL {	Redistribution and use in source and binary forms, with or without
unsigned char url_line[BUFSIZ];	modification, are permitted provided that the following conditions
	are met:
	1. Redistributions of source code must retain the above copyright
	notice, this list of conditions and the following disclaimer.
	2. Redistributions in binary form must reproduce the above copyright
	notice, this list of conditions and the following disclaimer in the
	documentation and/or other materials provided with the distribution.
	3. All advertising materials mentioning features or use of this software
	must display the following acknowledgement:
	This product includes software developed by Michael Pounov <misho@elwix.org>
	ELWIX - Embedded LightWeight unIX and its contributors.
	4. Neither the name of AITNET nor the names of its contributors
	may be used to endorse or promote products derived from this software
	without specific prior written permission.

url_Item_t url_tech;	THIS SOFTWARE IS PROVIDED BY AITNET AND CONTRIBUTORS ``AS IS'' AND
url_Item_t url_user;	ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
url_Item_t url_pass;	IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
url_Item_t url_host;	ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
url_Item_t url_port;	FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
url_Item_t url_path;	DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
url_Item_t url_args;	OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	SUCH DAMAGE.
	*/
	#ifndef __AITIO_H
	#define __AITIO_H

char *url_reserved;
};

struct tagIOCmd {	#define COMPAT_43TTY
const char *cmd_name;
int (cmd_func)(void , FILE , char *);
const char *cmd_doc;
const char *cmd_help;
char (cmd_comp)(const char *, int);
};

typedef struct tagIOCmd ioCommands_t;	#include <assert.h>
typedef char io_CompEntry_t(const char , int);	#include <syslog.h>
typedef char *io_Completion_t(const char , int, int);	#include <openssl/evp.h>
	#include <openssl/aes.h>
	#include <sys/tty.h>
	#include <sys/ioctl_compat.h>
	#include <sys/socket.h>
	#include <sys/un.h>
	#include <sys/uio.h>
	#include <net/if_dl.h>
	#include <netinet/in.h>


	#ifndef STRSIZ
	#define STRSIZ 256
	#endif


// io_GetErrno() Get error code of last operation	// io_GetErrno() Get error code of last operation
inline int io_GetErrno();	int io_GetErrno();
// io_GetError() Get error text of last operation	// io_GetError() Get error text of last operation
inline const char *io_GetError();	const char *io_GetError();


/*	/*
* ioPromptRead() Read data from input h[0] with prompt to output h[1]	* ioPromptRead() - Read data from input h[0] with prompt to output h[1]
	*
* @h = file handles h[0] = input, h[1] = output, if NULL use stdin, stdout	* @h = file handles h[0] = input, h[1] = output, if NULL use stdin, stdout
* @csPrompt = Prompt before input, may be NULL	* @csPrompt = Prompt before input, may be NULL
* @psData = Readed data	* @psData = Readed data
Line 58 inline const char *io_GetError();	Line 84 inline const char *io_GetError();
*/	*/
int ioPromptRead(int h, const char csPrompt, char * __restrict psData, int dataLen);	int ioPromptRead(int h, const char csPrompt, char * __restrict psData, int dataLen);
/*	/*
* ioPromptPassword() Read password from input h[0] with prompt to output h[1]	* ioPromptPassword() - Read password from input h[0] with prompt to output h[1]
	*
* @h = file handles h[0] = input, h[1] = output, if NULL use stdin, stdout	* @h = file handles h[0] = input, h[1] = output, if NULL use stdin, stdout
* @csPrompt = Prompt before input, may be NULL	* @csPrompt = Prompt before input, may be NULL
* @psPass = Readed password	* @psPass = Readed password
Line 68 int ioPromptRead(int h, const char csPrompt, char *	Line 95 int ioPromptRead(int h, const char csPrompt, char *
*/	*/
int ioPromptPassword(int h, const char csPrompt, char * __restrict psPass, int passLen, int confirm);	int ioPromptPassword(int h, const char csPrompt, char * __restrict psPass, int passLen, int confirm);


/*	/*
* ioRegexVerify() Function for verify data match in regex expression	* ioMkDir() - Function for racursive directory creation and validation
* @csRegex = Regulare expression pattern	*
* @csData = Data for check and verify	* @csDir = Full directory path
* @startPos = Return start positions	* @mode = Mode for directory creation if missing dir
* @endPos = Return end positions	* return: -1 error, 0 directory path exist, >0 created missing dirs
* return: NULL not match or error; !=NULL begin of matched data
*/	*/
const char ioRegexVerify(const char csRegex, const char csData, int startPos, int *endPos);	int ioMkDir(const char *csDir, int mode);

/*	/*
* ioRegexGet() Function for get data match in regex expression	* ioWatchDirLoop() - Function for watching changes in directory and fire callback
* @csRegex = Regulare expression pattern	*
* @csData = Data from get	* @csDir = Full directory path
* @psString = Returned string if match	* @callback = Callback if raise event! nOp -1 delete, 0 change/move, 1 create
* @strLen = Length of string	* return: -1 error, !=-1 ok, number of total signaled events
* return: 0 not match; >0 count of returned chars
*/	*/
int ioRegexGet(const char csRegex, const char csData, char * __restrict psString, int strLen);	int ioWatchDirLoop(const char csDir, int (callback)(const char *csName, int nOp));
/*
* ioRegexReplace() Function for replace data match in regex expression with newdata
* @csRegex = Regulare expression pattern
* @csData = Source data
* @csNew = Data for replace
* return: NULL not match or error; !=NULL allocated new string, must be free after use!
*/
char ioRegexReplace(const char csRegex, const char csData, const char csNew);


	#ifdef AIO_OPS
/*	/*
* io_Path2File() Parse and make path/filename pair	* io_aiobulk() - AIO bulk R/W function
* @csArgs = Input argument line	*
* @psPath = Output Path, if ==NULL path not returned	* @mode = Bulk wait mode
* @pathLen = Size of path array	* @acbs = List of aiocb structures
* @psFile = Output File	* @nacb = Number of aiocb in list
* @fileLen = Size of file array	* @sig = Event for completed operations, may be =NULL
* return: 0 error format; -1 error:: can`t read; >0 ok, number of readed items	* return: -1 error or 0 ok
*/	*/
inline int io_Path2File(const char * __restrict csArgs, char * __restrict psPath, int pathLen,	int io_aiobulk(int mode, struct aiocb ** __restrict acbs, int nacb,
char * __restrict psFile, int fileLen);	struct sigevent *sig);
	#endif
/*	/*
* io_MakeAV() Parse and make attribute/value pair	* io_rreadv() - Raw VFS bulk read function
* @csArgs = Input argument line	*
* @csDelim = Delimiter for separate	* @fd = File handle
* @psAttr = Output Attribute	* @bufs = Read buffers
* @attrLen = Size of attribute array	* @nbufs = Number of read buffers
* @psValue = Output Value, if ==NULL this element not present value or not wanted for return	* @offset = Read from position, if -1 read nbytes from current position
* @valLen = Size of value array	* @update = Update file handle position !0
* return: 0 error format; -1 error:: can`t read; >0 ok, number of readed items	* return: -1 error or !=-1 readed bytes
*/	*/
inline int io_MakeAV(const char * __restrict csArgs, const char *csDelim,	int io_rreadv(int fd, struct iovec * __restrict bufs, int nbufs, off_t offset,
char * __restrict psAttr, int attrLen, char * __restrict psValue, int valLen);	int update);
/*	/*
* io_SizeArray() Parse and calculate size of array	* io_rwritev() - Raw VFS bulk write function
* @csArgs = Input arguments line	*
* @csDelim = Delimiter(s) for separate	* @fd = File handle
* return: 0 error format; -1 error:: can`t read; >0 ok, number of items	* @bufs = Write buffers
*/	* @nbufs = Number of write buffers
inline int io_SizeArray(const char csArgs, const char csDelim);	* @offset = Write to position, if -1 write nbytes to current position
	* @update = Update file handle position !0
	* return: -1 error or !=-1 written bytes
	*/
	int io_rwritev(int fd, struct iovec * __restrict bufs, int nbufs, off_t offset,
	int update);
/*	/*
* io_MakeArray() Parse and make array of arguments values ...	* io_rread() - Raw VFS read function
* (input string will be modified! and output array must be free)	*
* @psArgs = Input arguments line, after execute string is modified!!!	* @fd = File handle
* @csDelim = Delimiter(s) for separate	* @buf = Read buffer
* @args = Output array of arguments ... (must be free() after procced function!)	* @nbytes = Read buffer size
* @nargs = Maximum requested count of arguments from input string psArgs	* @offset = Read from position, if -1 read nbytes from current position
* return: 0 error format; -1 error:: can`t read; >0 ok, number of readed items	* @update = Update file handle position !0
*/	* return: -1 error or !=-1 readed bytes
inline int io_MakeArray(char * __restrict psArgs, const char *csDelim,	*/
char *** __restrict args, int nargs);	int io_rread(int fd, void * __restrict buf, size_t nbytes, off_t offset,
	int update);
	/*
	* io_rwrite() - Raw VFS write function
	*
	* @fd = File handle
	* @buf = Write buffer
	* @nbytes = Write bytes from buffer
	* @offset = Write at position, if -1 write nbytes from current position
	* @update = Update file handle position !0
	* return: -1 error or !=-1 written bytes
	*/
	int io_rwrite(int fd, void * __restrict buf, size_t nbytes, off_t offset,
	int update);

	/* Disk I/O helper macros */
	#define io_read(f, b, n) io_rread(f, b, n, -1, 1)
	#define io_write(f, b, n) io_rwrite(f, b, n, -1, 1)


	/* Crypto framework */

/*	/*
* io_UnquotStr() Remove quots from input text string	* ioCipher() - Cipher wrapper for all supported crypto algorythms
* @psLine = Text string	*
* return: 0 nothing to do; 1 successful unquoted string	* @pInput = input buffer
	* @inLen = input buffer len
	* @ppOutput = output allocated buffe, must be e_free after use
	* @Cipher = cipher engine, like EVP_bf_cbc() or etc...
	* @pKey = key
	* @pIV = IV, salt (8 bytes)
	* @nMode = Mode 0 - decrypting or 1 - encrypting
	* return: 0 not present data or error!; >0 number of processed and returned bytes into ppOutput
*/	*/
inline int io_UnquotStr(unsigned char *psLine);	int ioCipher(unsigned char pInput, int inLen, unsigned char ppOutput, const EVP_CIPHER Cipher,
	unsigned char pKey, unsigned char pIV, int nMode);

/*	/*
* io_LTrimStr() Remove left whitespaces from text string	* io_Blowfish() - Blowfish cipher algorythm, work with ASCII hex strings
* @psLine = Text string	*
* return: 0 nothing to do; !=0 Removed bytes	* @pInput = input buffer
	* @inLen = input buffer len
	* @ppOutput = output allocated buffe, must be e_free after use
	* @pKey = key
	* @pIV = IV, salt (8 bytes)
	* @nMode = Mode 0 - decrypting or 1 - encrypting
	* return: 0 not present data or error!; >0 number of processed and returned bytes into ppOutput
*/	*/
inline int io_LTrimStr(unsigned char *psLine);	int io_Blowfish(unsigned char pInput, int inLen, unsigned char *ppOutput,
	unsigned char pKey, unsigned char pIV, int nMode);
/*	/*
* io_RTrimStr() Remove right whitespaces from text string	* io_ctr_AES() - Encrypt/Decrypt stream cipher CTR_AES
* @psLine = Text string	*
* return: 0 nothing to do; !=0 Removed bytes	* @pInput = Input buffer with ASCII
*/	* @inLen = Input buffer data length
inline int io_RTrimStr(unsigned char *psLine);	* @ppOutput = Output buffer with cipher data, must be e_free after use
	* @pKey = Key
	* @IV = IVector/Nonce/Counter, Warning: IV must be variable, because we write there!!!
	* return: -1 error or >-1 how many cipher blocks proceeded
	*/
	int io_ctr_AES(unsigned char pInput, int inLen, unsigned char *ppOutput,
	unsigned char *pKey, unsigned char IV[AES_BLOCK_SIZE]);


/*	/*
* io_TrimStr() Remove left and right whitespaces from text string	* ioAllocPTY() - Allocate new PTY and TTY
* @psLine = Text string	*
* return: 0 nothing to do; !=0 Removed bytes	* @ptyfd = master fd, pty
*/	* @ttyfd = slave fd, tty
inline int io_TrimStr(unsigned char *psLine);	* @name = tty device name if not null
	* @namesiz = name length, must be above 63 bytes.
	* @term = termios for terminal
	* @winz = winsize for terminal
	* return: -1 error or 0 ok
	*/
	int ioAllocPTY(int ptyfd, int ttyfd, char * __restrict name, int namesiz,
	struct termios * __restrict term, struct winsize * __restrict winz);
/*	/*
* io_Char2Hex() Convert from Char string to Hex string	* ioFreePTY() - Release PTY and TTY device
* @psLine = Text string	*
* @lineLen = Length of Text string	* @ptyfd = master fd, pty (==-1 skip closing pty)
* return: NULL nothing to do or error; !=0 Allocated new converted string(must be free)	* @ttyname = tty filename
*/	* return: none
inline char io_Char2Hex(unsigned char psLine, int lineLen);	*/
	void ioFreePTY(int ptyfd, const char *ttyname);
/*	/*
* io_Hex2Char() Convert from Hex string to Char string	* ioChgWinPTY() - Change window size of PTY
* @psLine = Text string	*
* @lineLen = Length of Text string	* @ptyfd = master fd, pty
* return: NULL nothing to do or error; !=0 Allocated new converted string(must be free)	* @row = row
*/	* @col = col
inline char io_Hex2Char(unsigned char psLine, int lineLen);	* @xpxl = x pixels
	* @ypxl = y pixels
	* return: -1 error or 0 ok
	*/
	int ioChgWinPTY(int ptyfd, unsigned short row, unsigned short col,
	unsigned short xpxl, unsigned short ypxl);
/*	/*
* ioURLGet() Parse and get data from input URL	* ioSetOwnerTTY() - Set owner to TTY
* @csURL = Input URL line	*
* @url = Output parsed URL	* @ttyname = tty filename
* return: 0 error format not find tech:// and return URL like path;	* @UID = uid
-1 error:: can`t read; >0 ok, up bits for known elements	* @GID = gid
*/	* return: -1 error or 0 ok
int ioURLGet(const char csURL, struct tagIOURL url);	*/
	int ioSetOwnerTTY(const char *ttyname, uid_t UID, gid_t GID);
/*	/*
* ioURLGetValue() Get value from parsed URL	* ioSetSidTTY() - Makes the process's controlling TTY and sets it to sane modes.
* @url = Input parsed URL	*
* @csAttr = Attribute for search	* @ttyfd = slave fd, tty
* @psValue = Return value of attribute, if ==NULL only check for existence of attribute	* @ttyname = tty filename
* @valLen = Size of psValue array	* return: -1 error or 0 ok
* return: 0 error attribute not find; -1 error:: can`t read; >0 ok, find at position	*/
*/	int ioSetSidTTY(int ttyfd, const char ttyname);
int ioURLGetValue(struct tagIOURL url, const char csAttr, char * __restrict psValue, int valLen);
/*	/*
* ioURLGetFile() Get file from parsed URL	* ioSetRAWMode() - Enter into RAW mode
* @url = Input parsed URL	*
* @psValue = Return filename, if not specified file in url path, replace with /	* @fd = tty fd
* @valLen = Size of psValue array	* @otio = saved old termios for later restore if !=NULL
* return: -1 error:: can`t read; 0 ok	* return: -1 error or 0 ok
*/	*/
int ioURLGetFile(struct tagIOURL url, char __restrict psValue, int valLen);	int ioSetRAWMode(int fd, struct termios *otio);

/*	/*
* ioCLIComp() Initialize completion CLI features	* ioRestoreMode() - Restore termios to tty fd
* @cmdComplete = Completion function	*
* @cmdEntry = Compentry function	* @fd = tty fd
* return: none	* @tio = termios structure for restore
*/	* return: -1 error or 0 ok
inline void ioCLIComp(io_Completion_t cmdComplete, io_CompEntry_t cmdEntry);	*/
	int ioRestoreMode(int fd, struct termios tio);
/*	/*
* ioCLIExec() Execute CLI main loop	* ioForkPTY() - Fork new process with session leader and new TTY
* @cmdList = Commands list	*
* @out = Output handle	* @ptyfd = master fd, pty
* @csPrompt = Prompt text	* @name = tty device name if not null
* return: -1 error, 0 = exit w/^+D, 1 done.	* @namesiz = name length, must be above 63 bytes.
*/	* @term = termios for terminal
int ioCLIExec(ioCommands_t cmdList, FILE out, const char *csPrompt);	* @winz = winsize for terminal
	* @otio = old termios structure for restore
	* return: -1 error, 0 child process or >0 parent: pid of child
	*/
	pid_t ioForkPTY(int ptyfd, char __restrict name, int namesiz, struct termios * __restrict term,
	struct winsize * __restrict winz, struct termios * __restrict otio);

/*	/*
* io_Cmd_Unsupported() Builtin helper function for unsupported commands	* ioCreatePIDFile() - Create PID file
* @cmds = Commands list	*
* @out = Output handle	* @csName = PID filename
* @args = Parsed arguments array	* @ifExists = !=0 if filename exists return error
* return: -1 error, 0 = ok, 1 exit from Cli!	* return: -1 error or 0 ok
*/	*/
int io_Cmd_Unsupported(void cmds, FILE out, char ** __restrict args);	int ioCreatePIDFile(const char *csName, int ifExists);

/*	/*
* io_Cmd_Help() Builtin helper function for Help screen	* ioSendFile() - AITNET sendfile() userland implementation, not dependant from OS
* @cmds = Commands list	*
* @out = Output handle	* @s = socket
* @args = Parsed arguments array	* @csFile = file for send
* return: -1 error, 0 = ok	* @sendLen = bytes to send, if 0 send all data
*/	* @offset = start file offset
int io_Cmd_Help(void cmds, FILE out, char ** __restrict args);	* @sndbuf = SO_SNDBUF value, if 0 use default
	* return: 0 error, >0 ok, sended bytes
	*/
	size_t ioSendFile(int s, const char *csFile, size_t sendLen, off_t offset, int sndbuf);
/*	/*
* io_Cmd_Exit() Builtin helper function for Exit from Cli	* ioRecvFile() - Receive file from socket, fastest (zero-copy) way
* @cmds = Commands list	*
* @out = Output handle	* @s = socket
* @args = Parsed arguments array	* @csFile = file for receive
* return: 1 exit from Cli!	* @recvLen = receive bytes
*/	* @over = overwrite file if exists with mode like 0644
int io_Cmd_Exit(void cmds, FILE out, char ** __restrict args);	* @rcvbuf = SO_RCVBUF value, if 0 use default
	* return: 0 error, >0 ok, received bytes
	*/
	size_t ioRecvFile(int s, const char *csFile, size_t recvLen, int over, int rcvbuf);


/*	/*
* io_Make_Comp_Commands - Declare helper function for Commands completion arguments	* ioRealFileName() - Get real file name
*/	*
#define IO_MAKE_COMP_COMMANDS(FUNC, CMDS) \	* @fname = filename
char FUNC(const char text, int state) \	* return: =NULL error or !=NULL real filename, should be free with e_free()
{ \	*/
register int i; \	char ioRealFileName(const char fname);
int len = strlen(text); \
for (i = state; CMDS[i].cmd_name; i++) { \
if (strncmp(CMDS[i].cmd_name, "---", 3) && \
!strncmp(CMDS[i].cmd_name, text, len)) \
return strdup(CMDS[i].cmd_name); \
} \
return NULL; \
}

/*	/* Buffered file access over memory block */
* io_Make_Comp_Args - Declare helper function for Arguments completion
*/
#define IO_MAKE_COMP_ARGS(FUNC, ARGS) \
char FUNC(const char text __attribute__((unused)), int state) \
{ \
while (ARGS[state]) \
return strdup(ARGS[state]); \
return NULL; \
}

/*	/*
* io_Comp_Filename() Builtin helper function for filename completion arguments	* io_fmemopen() - File buffered stream operations over memory block
* @text = Text line	*
* @state = Position state	* @base = Base address of memory block, if =NULL Infinit length(auto-grow)
* return: NULL not found filename, != NULL filename	* @basesize = Size of memory block
*/	* return: NULL error or !=NULL Opened file resource
char io_Comp_Filename(const char text, int state);	*/
	FILE io_fmemopen(void * __restrict base, off_t basesize);
	/*
	* io_fmapopen() - File buffered stream operations over MMAP block
	*
	* @csFile = Filename for MMAP, if =NULL private MMAP block
	* @mode = File open mode
	* @perm = If file not exists will be created with this access permissions
	* @prot = MMAP protection
	* @flags = MMAP mode flags
	* @offset = Map from file offset, if csFile==NULL then this is size of MMAP private block
	* return: NULL error or !=NULL Opened file resource
	*/
	FILE io_fmapopen(const char csFile, int mode, int perm, int prot, int flags, off_t offset);
	/*
	* io_fd2buf() - Convert open file handle to buffered file I/O
	*
	* @fd = File handle
	* @mode = Permissions for new buffered file I/O
	* return: NULL error or open buffered file
	*/
	FILE io_fd2buf(int fd, const char mode);
	/*
	* io_dumbFile() - Create empry or dumb file with fixed size
	*
	* @csFile = Filename for create
	* @mode = File access permissions
	* @size = File size
	* return: -1 error or open file handle
	*/
	int io_dumbFile(const char *csFile, int mode, off_t size);


#endif	#endif

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

Removed from v.1.4
changed lines
	Added in v.1.31