libaitrpc/inc/aitrpc.h - diff

Return to aitrpc.h CVS log

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

Diff for /libaitrpc/inc/aitrpc.h between versions 1.12 and 1.21

version 1.12, 2012/11/19 21:50:26	version 1.21, 2013/11/22 13:41:33
Line 12 terms:	Line 12 terms:
All of the documentation and software included in the ELWIX and AITNET	All of the documentation and software included in the ELWIX and AITNET
Releases is copyrighted by ELWIX - Sofia/Bulgaria <info@elwix.org>	Releases is copyrighted by ELWIX - Sofia/Bulgaria <info@elwix.org>

Copyright 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012	Copyright 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013
by Michael Pounov <misho@elwix.org>. All rights reserved.	by Michael Pounov <misho@elwix.org>. All rights reserved.

Redistribution and use in source and binary forms, with or without	Redistribution and use in source and binary forms, with or without
Line 58 SUCH DAMAGE.	Line 58 SUCH DAMAGE.
#endif	#endif
#include <sys/socket.h>	#include <sys/socket.h>
#include <sys/queue.h>	#include <sys/queue.h>
#include <aitio.h>	#include <elwix.h>
#include <aitsched.h>	#include <aitsched.h>


#define RPC_VERSION 4	#define RPC_VERSION 7
#define RPC_DEFPORT 2611	#define RPC_DEFPORT 2611

/* RPC call request flags */	/* RPC call request flags */
Line 85 SUCH DAMAGE.	Line 85 SUCH DAMAGE.
#define CALL_BLOBCLIENTS 65528	#define CALL_BLOBCLIENTS 65528
#define CALL_BLOBVARS 65527	#define CALL_BLOBVARS 65527

	/* RPC signals */
	#define SIGFBLOB 54

/* RPC types */	/* RPC types */

typedef enum {	typedef enum {
ok, error, no, /* for blob reply */	ok, error, no, /* for blob reply */
get, set, unset /* for blob request */	get, set, unset /* for blob request */
} cmd_type_t;	} blob_cmd_type_t;


#define RPC_CALLBACK_CHECK_INPUT(x) do { \	#define RPC_CALLBACK_CHECK_INPUT(x) do { \
Line 107 typedef enum {	Line 109 typedef enum {
/* RPC session identification */	/* RPC session identification */

typedef struct {	typedef struct {
uint8_t sess_version;	#if BYTE_ORDER == LITTLE_ENDIAN
uint32_t sess_program;	uint16_t sess_instance:8;
uint8_t sess_process;	uint16_t sess_version:8;
} __packed rpc_sess_t; /* size == 6 bytes */	#endif
	#if BYTE_ORDER == BIG_ENDIAN
	uint16_t sess_version:8;
	uint16_t sess_instance:8;
	#endif
	} __packed rpc_sess_t; /* size == 2 bytes */


/* Server managment RPC functions ... */	/* Server managment RPC functions ... */
Line 120 typedef struct {	Line 127 typedef struct {
struct tagRPCCall {	struct tagRPCCall {
rpc_sess_t call_session;	rpc_sess_t call_session;

uint16_t call_seq;	uint32_t call_len;
uint16_t call_len;
uint16_t call_crc;	uint16_t call_crc;

union {	union {
Line 137 struct tagRPCCall {	Line 143 struct tagRPCCall {
uint16_t call_tag;	uint16_t call_tag;
uint16_t call_argc;	uint16_t call_argc;
ait_val_t call_argv[0];	ait_val_t call_argv[0];
} __packed; /* size == 24 bytes */	} __packed; /* size == 20 bytes */
#define RPC_CHK_NOREPLY(x) ((x)->call_req.flags & RPC_NOREPLY)	#define RPC_CHK_NOREPLY(x) (ntohl((u_long) (x)->call_req.flags) & RPC_NOREPLY)
	#define RPC_SET_ERRNO(x, _v) ((x)->call_rep.eno = htonl((_v)))

/* Network BLOB packet - Header */	/* Network BLOB packet - Header */

Line 148 struct tagBLOBHdr {	Line 155 struct tagBLOBHdr {
uint32_t hdr_var;	uint32_t hdr_var;
uint32_t hdr_len;	uint32_t hdr_len;
uint32_t hdr_ret;	uint32_t hdr_ret;
uint16_t hdr_crc;
uint8_t hdr_pad;	uint8_t hdr_pad;
} __packed; /* size == 22 bytes */	} __packed; /* size == 16 bytes */

/* Network RPC client & server elements */	/* Network RPC client & server elements */

Line 191 typedef struct tagBLOB {	Line 197 typedef struct tagBLOB {
typedef struct {	typedef struct {
int cli_id; /* slot id */	int cli_id; /* slot id */
int cli_sock; /* socket fd */	int cli_sock; /* socket fd */
io_sockaddr_t cli_sa; /* host address */	sockaddr_t cli_sa; /* host address */
ait_val_t cli_buf; /* network buffer */	ait_val_t cli_buf; /* network buffer */

array_t cli_vars; / function return variables */	array_t cli_vars; / function return variables */
Line 247 typedef int (rpc_callback_t)(rpc_cli_t , struct tagR	Line 253 typedef int (rpc_callback_t)(rpc_cli_t , struct tagR
/* Error support functions */	/* Error support functions */

// rpc_GetErrno() Get error code of last operation	// rpc_GetErrno() Get error code of last operation
inline int rpc_GetErrno();	int rpc_GetErrno();
// rpc_GetError() Get error text of last operation	// rpc_GetError() Get error text of last operation
inline const char *rpc_GetError();	const char *rpc_GetError();
	// rpc_SetErr() Set error to variables for internal use!!!
	void rpc_SetErr(int eno, char *estr, ...);



/*	/*
	* rpc_Read() - RPC read operation
	*
	* @sock = socket
	* @type = type of socket
	* @flags = receive flags
	* @sa = check client address, if you use udp protocol
	* @buf = buffer
	* @blen = buffer length
	* return: -1 error or >-1 readed bytes into buffer
	*/
	ssize_t rpc_Read(int sock, int type, int flags, sockaddr_t * __restrict sa,
	unsigned char * __restrict buf, size_t blen);
	/*
	* rpc_Write() - RPC write operation
	*
	* @sock = socket
	* @type = type of socket
	* @flags = send flags
	* @sa = send to client address, if you use udp protocol
	* @buf = buffer
	* @blen = buffer length
	* return: -1 error or >-1 written bytes into buffer
	*/
	ssize_t rpc_Write(int sock, int type, int flags, sockaddr_t * __restrict sa,
	unsigned char * __restrict buf, size_t blen);

	/*
* rpc_chkPktSession() - Check RPC session	* rpc_chkPktSession() - Check RPC session
*	*
* @p = packet session	* @p = packet session
* @s = active session	* @s = active session
* return: -1, 1, 2, 3 are errors or 0 ok	* return: -1, 1, 2, 3 are errors or 0 ok
*/	*/
inline int rpc_chkPktSession(rpc_sess_t p, rpc_sess_t s);	int rpc_chkPktSession(rpc_sess_t p, rpc_sess_t s);
/*	/*
* rpc_addPktSession() - Prepare session into network format	* rpc_addPktSession() - Prepare session into network format
*	*
Line 267 inline int rpc_chkPktSession(rpc_sess_t *p, rpc_sess_t	Line 303 inline int rpc_chkPktSession(rpc_sess_t *p, rpc_sess_t
* @s = host session	* @s = host session
* return: -1 error or 0 ok	* return: -1 error or 0 ok
*/	*/
inline int rpc_addPktSession(rpc_sess_t p, rpc_sess_t s);	int rpc_addPktSession(rpc_sess_t p, rpc_sess_t s);
/*	/*
* rpc_register_srvPing() - Register ping service function	* rpc_register_srvPing() - Register ping service function
*	*
* @srv = RPC server instance	* @srv = RPC server instance
* return: -1 error or 0 ok	* return: -1 error or 0 ok
*/	*/
inline int rpc_register_srvPing(rpc_srv_t * __restrict srv);	int rpc_register_srvPing(rpc_srv_t * __restrict srv);
/*	/*
* rpc_register_srvServices() - Register internal service functions	* rpc_register_srvServices() - Register internal service functions
*	*
Line 296 int rpc_register_blobServices(rpc_srv_t * __restrict s	Line 332 int rpc_register_blobServices(rpc_srv_t * __restrict s
/*	/*
* rpc_srv_initServer() - Init & create RPC Server	* rpc_srv_initServer() - Init & create RPC Server
*	*
* @regProgID = ProgramID for authentication & recognition	* @InstID = Instance for authentication & recognition
* @regProcID = ProcessID for authentication & recognition
* @concurentClients = Concurent clients at same time to this server	* @concurentClients = Concurent clients at same time to this server
* @netBuf = Network buffer length (min:512 bytes), if =0 == BUFSIZ (also meaning max RPC packet)	* @netBuf = Network buffer length (min:512 bytes), if =0 == BUFSIZ (also meaning max RPC packet)
* @csHost = Host name or address for bind server, if NULL any address	* @csHost = Host name or address for bind server, if NULL any address
Line 305 int rpc_register_blobServices(rpc_srv_t * __restrict s	Line 340 int rpc_register_blobServices(rpc_srv_t * __restrict s
* @proto = Protocol, if == 0 choose SOCK_STREAM	* @proto = Protocol, if == 0 choose SOCK_STREAM
* return: NULL == error or !=NULL bind and created RPC server instance	* return: NULL == error or !=NULL bind and created RPC server instance
*/	*/
rpc_srv_t *rpc_srv_initServer(unsigned int regProgID, unsigned char regProcID,	rpc_srv_t *rpc_srv_initServer(unsigned char InstID, int concurentClients, int netBuf,
int concurentClients, int netBuf,
const char *csHost, unsigned short Port, int proto);	const char *csHost, unsigned short Port, int proto);
/*	/*
* rpc_srv_endServer() - Destroy RPC server, close all opened sockets and free resources	* rpc_srv_endServer() - Destroy RPC server, close all opened sockets and free resources
Line 314 rpc_srv_t *rpc_srv_initServer(unsigned int regProgID,	Line 348 rpc_srv_t *rpc_srv_initServer(unsigned int regProgID,
* @psrv = RPC Server instance	* @psrv = RPC Server instance
* return: none	* return: none
*/	*/
inline void rpc_srv_endServer(rpc_srv_t ** __restrict psrv);	void rpc_srv_endServer(rpc_srv_t ** __restrict psrv);
/*	/*
* rpc_srv_loopServer() - Execute Main server loop and wait for clients requests	* rpc_srv_loopServer() - Execute Main server loop and wait for clients requests
*	*
Line 331 int rpc_srv_loopServer(rpc_srv_t * __restrict srv);	Line 365 int rpc_srv_loopServer(rpc_srv_t * __restrict srv);
else \	else \
pthread_detach((_srv)->srv_tid); \	pthread_detach((_srv)->srv_tid); \
} } while (0)	} } while (0)
	#define rpc_srv_killServer(_srv) (assert((_srv)), (_srv)->srv_blob.kill = 1, (_srv)->srv_kill = 1)

/*	/*
* rpc_srv_initBLOBServer() - Init & create BLOB Server	* rpc_srv_initBLOBServer() - Init & create BLOB Server
Line 347 int rpc_srv_initBLOBServer(rpc_srv_t * __restrict srv,	Line 382 int rpc_srv_initBLOBServer(rpc_srv_t * __restrict srv,
* @srv = RPC Server instance	* @srv = RPC Server instance
* return: none	* return: none
*/	*/
inline void rpc_srv_endBLOBServer(rpc_srv_t * __restrict srv);	void rpc_srv_endBLOBServer(rpc_srv_t * __restrict srv);
/*	/*
* rpc_srv_loopBLOB() - Execute Main BLOB server loop and wait for clients requests	* rpc_srv_loopBLOB() - Execute Main BLOB server loop and wait for clients requests
*	*
Line 388 int rpc_srv_unregisterCall(rpc_srv_t * __restrict srv,	Line 423 int rpc_srv_unregisterCall(rpc_srv_t * __restrict srv,
* @tag = tag for function	* @tag = tag for function
* return: NULL not found call, !=NULL return call	* return: NULL not found call, !=NULL return call
*/	*/
inline rpc_func_t rpc_srv_getCall(rpc_srv_t __restrict srv, uint16_t tag);	rpc_func_t rpc_srv_getCall(rpc_srv_t __restrict srv, uint16_t tag);
/*	/*
* rpc_srv_execCall() Execute registered call from RPC server	* rpc_srv_execCall() Execute registered call from RPC server
*	*
Line 407 int rpc_srv_execCall(rpc_cli_t * __restrict cli, struc	Line 442 int rpc_srv_execCall(rpc_cli_t * __restrict cli, struc
*	*
* @srv = RPC Server instance	* @srv = RPC Server instance
* @len = BLOB length object	* @len = BLOB length object
	* @tout = BLOB live timeout in seconds
* return: NULL error or !=NULL allocated BLOB object	* return: NULL error or !=NULL allocated BLOB object
*/	*/
inline rpc_blob_t rpc_srv_blobCreate(rpc_srv_t __restrict srv, int len);	rpc_blob_t rpc_srv_blobCreate(rpc_srv_t __restrict srv, int len, int tout);
/*	/*
* rpc_srv_blobMap() - Map blob to memory region	* rpc_srv_blobMap() - Map blob to memory region
*	*
Line 417 inline rpc_blob_t rpc_srv_blobCreate(rpc_srv_t __re	Line 453 inline rpc_blob_t rpc_srv_blobCreate(rpc_srv_t __re
* @blob = Map to this BLOB element	* @blob = Map to this BLOB element
* return: -1 error or 0 ok	* return: -1 error or 0 ok
*/	*/
inline int rpc_srv_blobMap(rpc_srv_t * __restrict srv, rpc_blob_t * __restrict blob);	int rpc_srv_blobMap(rpc_srv_t * __restrict srv, rpc_blob_t * __restrict blob);
/*	/*
* rpc_srv_blobUnmap() - Unmap blob memory region	* rpc_srv_blobUnmap() - Unmap blob memory region
*	*
* @blob = Mapped BLOB element	* @blob = Mapped BLOB element
* return: none	* return: none
*/	*/
inline void rpc_srv_blobUnmap(rpc_blob_t * __restrict blob);	void rpc_srv_blobUnmap(rpc_blob_t * __restrict blob);
/*	/*
* rpc_srv_blobFree() - Free blob from disk & memory	* rpc_srv_blobFree() - Free blob from disk & memory
*	*
Line 432 inline void rpc_srv_blobUnmap(rpc_blob_t * __restrict	Line 468 inline void rpc_srv_blobUnmap(rpc_blob_t * __restrict
* @blob = Mapped BLOB element	* @blob = Mapped BLOB element
* return: -1 error or 0 ok	* return: -1 error or 0 ok
*/	*/
inline int rpc_srv_blobFree(rpc_srv_t * __restrict srv, rpc_blob_t * __restrict blob);	int rpc_srv_blobFree(rpc_srv_t * __restrict srv, rpc_blob_t * __restrict blob);

/*	/*
* rpc_srv_registerBLOB() - Register new BLOB to server	* rpc_srv_registerBLOB() - Register new BLOB to server
*	*
* @srv = RPC Server instance	* @srv = RPC Server instance
* @len = BLOB length	* @len = BLOB length
	* @tout = BLOB live timeout in seconds
* return: NULL error or new registered BLOB	* return: NULL error or new registered BLOB
*/	*/
rpc_blob_t rpc_srv_registerBLOB(rpc_srv_t __restrict srv, size_t len);	rpc_blob_t rpc_srv_registerBLOB(rpc_srv_t __restrict srv, size_t len, int tout);
/*	/*
* rpc_srv_unregisterBLOB() - Unregister BLOB from server	* rpc_srv_unregisterBLOB() - Unregister BLOB from server
*	*
Line 457 int rpc_srv_unregisterBLOB(rpc_srv_t * __restrict srv,	Line 494 int rpc_srv_unregisterBLOB(rpc_srv_t * __restrict srv,
* @var = hash for variable	* @var = hash for variable
* return: NULL not found, !=NULL return blob var	* return: NULL not found, !=NULL return blob var
*/	*/
inline rpc_blob_t rpc_srv_getBLOB(rpc_srv_t __restrict srv, uint32_t var);	rpc_blob_t rpc_srv_getBLOB(rpc_srv_t __restrict srv, uint32_t var);

/*	/*
* rpc_srv_sendBLOB() - Send mapped BLOB to client	* rpc_srv_sendBLOB() - Send mapped BLOB to client
Line 484 int rpc_srv_recvBLOB(rpc_cli_t * __restrict cli, rpc_b	Line 521 int rpc_srv_recvBLOB(rpc_cli_t * __restrict cli, rpc_b
* @cli = Client instance	* @cli = Client instance
* @var = BLOB variable	* @var = BLOB variable
* @data = BLOB data	* @data = BLOB data
	* @tout = BLOB live on server timeout in seconds, if =0 default timeout
* return: -1 error, 0 ok, 1 remote error	* return: -1 error, 0 ok, 1 remote error
*/	*/
int rpc_cli_sendBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var, void * __restrict data);	int rpc_cli_sendBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var,
	void * __restrict data, int tout);
/*	/*
* rpc_cli_recvBLOB() - Receive BLOB from server	* rpc_cli_recvBLOB() - Receive BLOB from server
*	*
* @cli = Client instance	* @cli = Client instance
* @var = BLOB variable	* @var = BLOB variable
* @data = BLOB data, must be io_free after use!	* @data = BLOB data, must be e_free after use!
* return: -1 error, 0 ok, 1 remote error	* return: -1 error, 0 ok, 1 remote error
*/	*/
int rpc_cli_recvBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var, void ** __restrict data);	int rpc_cli_recvBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var, void ** __restrict data);
Line 509 int rpc_cli_delBLOB(rpc_cli_t * __restrict cli, ait_va	Line 548 int rpc_cli_delBLOB(rpc_cli_t * __restrict cli, ait_va
*	*
* @cli = Client instance	* @cli = Client instance
* @var = BLOB variable	* @var = BLOB variable
* @data = BLOB data, must be io_free after use!	* @data = BLOB data, must be e_free after use!
* return: -1 error, 0 ok, >0 remote error	* return: -1 error, 0 ok, >0 remote error
*/	*/
inline int rpc_cli_getBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var,	int rpc_cli_getBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var,
void ** __restrict data);	void ** __restrict data);


Line 521 inline int rpc_cli_getBLOB(rpc_cli_t * __restrict cli,	Line 560 inline int rpc_cli_getBLOB(rpc_cli_t * __restrict cli,
/*	/*
* rpc_cli_openClient() - Connect to RPC Server	* rpc_cli_openClient() - Connect to RPC Server
*	*
* @ProgID = ProgramID for RPC session request	* @InstID = InstID for RPC session request
* @ProcID = ProcessID for RPC session request
* @netBuf = Network buffer length (min:512 bytes), if =0 == BUFSIZ (also meaning max RPC packet)	* @netBuf = Network buffer length (min:512 bytes), if =0 == BUFSIZ (also meaning max RPC packet)
* @csHost = Host name or IP address for bind server	* @csHost = Host name or IP address for bind server
* @Port = Port for bind server, if Port == 0 default port is selected	* @Port = Port for bind server, if Port == 0 default port is selected
* @proto = Protocol, if == 0 choose SOCK_STREAM	* @proto = Protocol, if == 0 choose SOCK_STREAM
* return: NULL == error or !=NULL connection to RPC server established	* return: NULL == error or !=NULL connection to RPC server established
*/	*/
rpc_cli_t *rpc_cli_openClient(unsigned int ProgID, unsigned char ProcID, int netBuf,	rpc_cli_t *rpc_cli_openClient(unsigned char InstID, int netBuf,
const char *csHost, unsigned short Port, int proto);	const char *csHost, unsigned short Port, int proto);
/*	/*
* rpc_cli_closeClient() - Close connection to RPC server and free resources	* rpc_cli_closeClient() - Close connection to RPC server and free resources
Line 539 rpc_cli_t *rpc_cli_openClient(unsigned int ProgID, uns	Line 577 rpc_cli_t *rpc_cli_openClient(unsigned int ProgID, uns
*/	*/
void rpc_cli_closeClient(rpc_cli_t ** __restrict cli);	void rpc_cli_closeClient(rpc_cli_t ** __restrict cli);
/*	/*
	* rpc_pkt_Send() - Send RPC packet
	*
	* @sock = Socket
	* @type = Type of socket
	* @sa = Server address
	* @pkt = RPC packet
	* @len = Length of packet
	* return: -1 error or !=-1 sended bytes
	*/
	int rpc_pkt_Send(int sock, int type, sockaddr_t * __restrict sa,
	ait_val_t * __restrict pkt, int len);
	/*
	* rpc_pkt_Receive() - Receive RPC packet
	*
	* @sock = Socket
	* @type = Type of socket
	* @sa = Server address
	* @pkt = RPC packet
	* return: -1 error or !=-1 sended bytes
	*/
	int rpc_pkt_Receive(int sock, int type, sockaddr_t * __restrict sa,
	ait_val_t * __restrict pkt);
	/*
	* rpc_pkt_Request() - Build RPC Request packet
	*
	* @pkt = Packet buffer
	* @sess = RPC session info
	* @tag = Function tag for execution
	* @vars = Function argument array of values, may be NULL
	* @noreply = We not want RPC reply
	* @nocrc = Without CRC calculation
	* return: -1 error or != -1 prepared bytes into packet
	*/
	int rpc_pkt_Request(ait_val_t * __restrict pkt, rpc_sess_t * __restrict sess,
	unsigned short tag, array_t * __restrict vars, int noreply, int nocrc);
	/*
	* rpc_pkt_Replay() - Decode RPC Replay packet
	*
	* @pkt = Packet buffer
	* @sess = RPC session info
	* @tag = Function tag
	* @vars = Function argument array of values, may be NULL
	* @nocrc = Without CRC calculation
	* return: -1 error or != -1 return value from function
	*/
	int rpc_pkt_Replay(ait_val_t * __restrict pkt, rpc_sess_t * __restrict sess,
	unsigned short tag, array_t ** __restrict vars, int nocrc);
	/*
* rpc_cli_execCall() - Execute RPC call	* rpc_cli_execCall() - Execute RPC call
*	*
* @cli = RPC Client session	* @cli = RPC Client session
* @noreply = We not want RPC reply	* @noreply = We not want RPC reply
* @tag = Function tag for execution	* @tag = Function tag for execution
* @in_vars = IN RPC call array of rpc values, may be NULL	* @in_vars = IN function argument array of values, may be NULL
* @out_vars = OUT returned array of rpc values, if !=NULL must be free after use with io_freeVars()	* @out_vars = OUT returned array of rpc values, if !=NULL must be free after use with ait_freeVars()
* return: -1 error or != -1 ok result	* return: -1 error or != -1 ok result
*/	*/
int rpc_cli_execCall(rpc_cli_t *cli, int noreply, unsigned short tag,	int rpc_cli_execCall(rpc_cli_t *cli, int noreply, unsigned short tag,
Line 556 int rpc_cli_execCall(rpc_cli_t *cli, int noreply, unsi	Line 642 int rpc_cli_execCall(rpc_cli_t *cli, int noreply, unsi
* @out_vars = Returned array with variables from RPC call	* @out_vars = Returned array with variables from RPC call
* return: none	* return: none
*/	*/
inline void rpc_cli_freeCall(array_t ** __restrict out_vars);	void rpc_cli_freeCall(array_t ** __restrict out_vars);
/*	/*
* rpc_cli_ping() - Ping RPC server	* rpc_cli_ping() - Ping RPC server
*	*
* @cli = connected client	* @cli = connected client
* return: -1 error or !=-1 ping seq id	* return: -1 error or !=-1 ping seq id
*/	*/
inline int rpc_cli_ping(rpc_cli_t *cli);	int rpc_cli_ping(rpc_cli_t *cli);


/*	/*

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

Removed from v.1.12
changed lines
	Added in v.1.21