--- libaitrpc/inc/aitrpc.h 2012/05/17 14:22:24 1.8.2.19 +++ libaitrpc/inc/aitrpc.h 2013/04/02 15:32:03 1.13.2.2 @@ -3,7 +3,7 @@ * by Michael Pounov * * $Author: misho $ -* $Id: aitrpc.h,v 1.8.2.19 2012/05/17 14:22:24 misho Exp $ +* $Id: aitrpc.h,v 1.13.2.2 2013/04/02 15:32:03 misho Exp $ * ************************************************************************** The ELWIX and AITNET software is distributed under the following @@ -12,7 +12,7 @@ terms: All of the documentation and software included in the ELWIX and AITNET Releases is copyrighted by ELWIX - Sofia/Bulgaria -Copyright 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012 +Copyright 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013 by Michael Pounov . All rights reserved. Redistribution and use in source and binary forms, with or without @@ -58,11 +58,11 @@ SUCH DAMAGE. #endif #include #include -#include +#include #include -#define RPC_VERSION 4 +#define RPC_VERSION 6 #define RPC_DEFPORT 2611 /* RPC call request flags */ @@ -91,34 +91,31 @@ SUCH DAMAGE. typedef enum { ok, error, no, /* for blob reply */ get, set, unset /* for blob request */ -} cmd_type_t; +} blob_cmd_type_t; -#define RPC_CALLBACK_CHECK_INPUT(_f) do { \ - assert((_f)); \ - if (!(_f)) { \ +#define RPC_CALLBACK_CHECK_INPUT(x) do { \ + assert((x)); \ + if (!(x)) { \ rpc_SetErr(EINVAL, \ "Invalid callback parameters ..."); \ return -1; \ } \ } while (0) -#define RPC_CALLBACK_CHK_ARGS(_f, _n) do { \ - RPC_CALLBACK_CHECK_INPUT((_f)); \ - if ((_f) && io_arraySize((_f)->func_vars) < _n) { \ - rpc_SetErr(EINVAL, \ - "Not enough number of arguments!"); \ - return -1; \ - } \ - } while (0) /* RPC session identification */ typedef struct { - uint8_t sess_version; - uint32_t sess_program; - uint8_t sess_process; -} __packed rpc_sess_t; /* size == 6 bytes */ +#if BYTE_ORDER == LITTLE_ENDIAN + uint16_t sess_instance:8; + uint16_t sess_version:8; +#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 ... */ @@ -145,7 +142,8 @@ struct tagRPCCall { uint16_t call_tag; uint16_t call_argc; 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) /* Network BLOB packet - Header */ @@ -155,9 +153,8 @@ struct tagBLOBHdr { uint32_t hdr_var; uint32_t hdr_len; uint32_t hdr_ret; - uint16_t hdr_crc; uint8_t hdr_pad; -} __packed; /* size == 22 bytes */ +} __packed; /* size == 16 bytes */ /* Network RPC client & server elements */ @@ -165,15 +162,25 @@ struct tagBLOBHdr { typedef struct tagRPCFunc { ait_val_t func_name; - array_t *func_vars; - void *func_parent; - TAILQ_ENTRY(tagRPCFunc) func_node; + + SLIST_ENTRY(tagRPCFunc) func_next; + AVL_ENTRY(tagRPCFunc) func_node; } rpc_func_t; -#define RPC_FUNC_RETVARS(x) ((x)->func_vars) #define RPC_FUNC_SERVER(x) ((rpc_srv_t*) (x)->func_parent) +/* Tree root node */ +typedef struct tagRPCFuncs { + pthread_mutex_t mtx; + struct tagRPCFunc *slh_first; + struct tagRPCFunc *avlh_root; +} rpc_funcs_t; +#define RPC_FUNCS_LOCK(x) pthread_mutex_lock(&(x)->mtx) +#define RPC_FUNCS_UNLOCK(x) pthread_mutex_unlock(&(x)->mtx) +#define RPC_FUNCS_ISEMPTY(x) AVL_EMPTY((x)) + + /* BLOB register element */ typedef struct tagBLOB { uint32_t blob_var; /* BLOB id */ @@ -188,15 +195,21 @@ typedef struct tagBLOB { typedef struct { int cli_id; /* slot id */ 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 */ + array_t *cli_vars; /* function return variables */ + void *cli_parent; /* pointer to parent rpc_srv_t for server or to rpc_sess_t for client */ } rpc_cli_t; +#define RPC_RETVARS(x) ((x)->cli_vars) +#define RPC_SRV_SERVER(x) ((rpc_srv_t*) (x)->cli_parent) +#define RPC_CLI_SESSION(x) ((rpc_sess_t*) (x)->cli_parent) typedef struct { rpc_sess_t srv_session; /* RPC session registration info */ int srv_netbuf; /* size of network buffer */ + int srv_proto; /* Server protocol */ pthread_t srv_tid; /* RPC exec pthread */ sched_root_task_t *srv_root; /* RPC server scheduler */ @@ -205,7 +218,7 @@ typedef struct { rpc_cli_t srv_server; /* RPC server socket */ array_t *srv_clients; /* connected rpc client sockets */ - TAILQ_HEAD(, tagRPCFunc) srv_funcs; /* RPC functions list */ + rpc_funcs_t srv_funcs; /* RPC functions */ struct { pthread_t tid; /* BLOB exec pthread */ @@ -225,12 +238,12 @@ typedef struct { /* * (*rpc_callback_t)() - Callback type definition for RPC call in server process * - * @arg1 = current execution RPC call function + * @arg1 = RPC client * @arg2 = RPC packet header * @arg3 = input array with values from RPC call execution request * return: -1 error or >-1 success execution */ -typedef int (*rpc_callback_t)(rpc_func_t *, struct tagRPCCall *, array_t *); +typedef int (*rpc_callback_t)(rpc_cli_t *, struct tagRPCCall *, array_t *); /* ----------------------------------------------------------------------- */ @@ -287,24 +300,23 @@ int rpc_register_blobServices(rpc_srv_t * __restrict s /* * rpc_srv_initServer() - Init & create RPC Server * - * @regProgID = ProgramID for authentication & recognition - * @regProcID = ProcessID for authentication & recognition + * @InstID = Instance for authentication & recognition * @concurentClients = Concurent clients at same time to this server - * @netBuf = Network buffer length, 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 * @Port = Port for bind server, if Port == 0 default port is selected + * @proto = Protocol, if == 0 choose SOCK_STREAM * return: NULL == error or !=NULL bind and created RPC server instance */ -rpc_srv_t *rpc_srv_initServer(unsigned int regProgID, unsigned char regProcID, - int concurentClients, int netBuf, - const char *csHost, unsigned short Port); +rpc_srv_t *rpc_srv_initServer(unsigned char InstID, int concurentClients, int netBuf, + const char *csHost, unsigned short Port, int proto); /* * rpc_srv_endServer() - Destroy RPC server, close all opened sockets and free resources * * @psrv = RPC Server instance * return: none */ -void rpc_srv_endServer(rpc_srv_t ** __restrict psrv); +inline void rpc_srv_endServer(rpc_srv_t ** __restrict psrv); /* * rpc_srv_loopServer() - Execute Main server loop and wait for clients requests * @@ -337,7 +349,7 @@ int rpc_srv_initBLOBServer(rpc_srv_t * __restrict srv, * @srv = RPC Server instance * return: none */ -void rpc_srv_endBLOBServer(rpc_srv_t * __restrict srv); +inline void rpc_srv_endBLOBServer(rpc_srv_t * __restrict srv); /* * rpc_srv_loopBLOB() - Execute Main BLOB server loop and wait for clients requests * @@ -360,11 +372,9 @@ int rpc_srv_loopBLOBServer(rpc_srv_t * __restrict srv) * @srv = RPC Server instance * @tag = Function tag * @funcaddr = Function address - * @args = Number of return function arguments * return: -1 error, 0 already registered tag or 1 register ok */ -int rpc_srv_registerCall(rpc_srv_t * __restrict srv, unsigned short tag, - void *funcaddr, unsigned short args); +int rpc_srv_registerCall(rpc_srv_t * __restrict srv, unsigned short tag, void *funcaddr); /* * rpc_srv_unregisterCall() - Unregister call from RPC server * @@ -382,15 +392,16 @@ int rpc_srv_unregisterCall(rpc_srv_t * __restrict srv, */ inline 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 * - * @call = Register RPC call + * @cli = RPC client * @rpc = IN RPC call structure + * @funcname = Execute RPC function * @args = IN RPC calling arguments from RPC client * return: -1 error, !=-1 ok */ -int rpc_srv_execCall(rpc_func_t * __restrict call, struct tagRPCCall * __restrict rpc, - array_t * __restrict args); +int rpc_srv_execCall(rpc_cli_t * __restrict cli, struct tagRPCCall * __restrict rpc, + ait_val_t funcname, array_t * __restrict args); /* @@ -483,7 +494,7 @@ int rpc_cli_sendBLOB(rpc_cli_t * __restrict cli, ait_v * * @cli = Client instance * @var = BLOB variable - * @data = BLOB data, must be free after use! + * @data = BLOB data, must be e_free after use! * 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); @@ -500,7 +511,7 @@ int rpc_cli_delBLOB(rpc_cli_t * __restrict cli, ait_va * * @cli = Client instance * @var = BLOB variable - * @data = BLOB data, must be free after use! + * @data = BLOB data, must be e_free after use! * return: -1 error, 0 ok, >0 remote error */ inline int rpc_cli_getBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var, @@ -512,15 +523,15 @@ inline int rpc_cli_getBLOB(rpc_cli_t * __restrict cli, /* * rpc_cli_openClient() - Connect to RPC Server * - * @ProgID = ProgramID for RPC session request - * @ProcID = ProcessID for RPC session request - * @netBuf = Network buffer length, if =0 == BUFSIZ (also meaning max RPC packet) + * @InstID = InstID for RPC session request + * @netBuf = Network buffer length (min:512 bytes), if =0 == BUFSIZ (also meaning max RPC packet) * @csHost = Host name or IP address for bind server * @Port = Port for bind server, if Port == 0 default port is selected + * @proto = Protocol, if == 0 choose SOCK_STREAM * return: NULL == error or !=NULL connection to RPC server established */ -rpc_cli_t *rpc_cli_openClient(unsigned int ProgID, unsigned char ProcID, int netBuf, - const char *csHost, unsigned short Port); +rpc_cli_t *rpc_cli_openClient(unsigned char InstID, int netBuf, + const char *csHost, unsigned short Port, int proto); /* * rpc_cli_closeClient() - Close connection to RPC server and free resources * @@ -529,17 +540,72 @@ rpc_cli_t *rpc_cli_openClient(unsigned int ProgID, uns */ 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 * * @cli = RPC Client session * @noreply = We not want RPC reply * @tag = Function tag for execution - * @in_vars = IN RPC call array of rpc values, may be NULL - * @out_vars = OUT returned array of rpc values, if !=NULL must be free after use with io_freeVars() + * @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 ait_freeVars() * return: -1 error or != -1 ok result */ int rpc_cli_execCall(rpc_cli_t *cli, int noreply, unsigned short tag, array_t * __restrict in_vars, array_t ** __restrict out_vars); +/* + * rpc_cli_freeCall() - Free resouce allocated by RPC call + * + * @out_vars = Returned array with variables from RPC call + * return: none + */ +inline void rpc_cli_freeCall(array_t ** __restrict out_vars); /* * rpc_cli_ping() - Ping RPC server *