--- libaitrpc/inc/aitrpc.h 2012/05/17 07:53:03 1.8.2.16 +++ libaitrpc/inc/aitrpc.h 2012/11/13 09:22:10 1.11 @@ -3,7 +3,7 @@ * by Michael Pounov * * $Author: misho $ -* $Id: aitrpc.h,v 1.8.2.16 2012/05/17 07:53:03 misho Exp $ +* $Id: aitrpc.h,v 1.11 2012/11/13 09:22:10 misho Exp $ * ************************************************************************** The ELWIX and AITNET software is distributed under the following @@ -74,8 +74,7 @@ SUCH DAMAGE. #define CALL_TAG_MAX 65535 -#define CALL_SRVPING 65535 -#define CALL_BLOBPING 65534 +#define CALL_SRVPING 65534 #define CALL_SRVSHUTDOWN 65533 #define CALL_SRVCLIENTS 65532 @@ -95,22 +94,14 @@ typedef enum { } 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 */ @@ -147,6 +138,7 @@ struct tagRPCCall { uint16_t call_argc; ait_val_t call_argv[0]; } __packed; /* size == 24 bytes */ +#define RPC_CHK_NOREPLY(x) ((x)->call_req.flags & RPC_NOREPLY) /* Network BLOB packet - Header */ @@ -166,15 +158,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 */ @@ -192,22 +194,29 @@ typedef struct { io_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 */ + pthread_t srv_tid; /* RPC exec pthread */ sched_root_task_t *srv_root; /* RPC server scheduler */ intptr_t srv_kill; /* Scheduler condition variable */ 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 */ sched_root_task_t *root; /* BLOB server scheduler */ intptr_t kill; /* BLOB server state: ==0 disable | !=0 enable */ @@ -224,15 +233,15 @@ typedef struct { /* * (*rpc_callback_t)() - Callback type definition for RPC call in server process * - * @arg1 = current execution RPC call function - * @arg2 = number of items in input array from call request + * @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 *, int, array_t *); +typedef int (*rpc_callback_t)(rpc_cli_t *, struct tagRPCCall *, array_t *); -// ----------------------------------------------------------------------- +/* ----------------------------------------------------------------------- */ /* Error support functions */ @@ -259,6 +268,13 @@ inline int rpc_chkPktSession(rpc_sess_t *p, rpc_sess_t */ inline int rpc_addPktSession(rpc_sess_t *p, rpc_sess_t *s); /* + * rpc_register_srvPing() - Register ping service function + * + * @srv = RPC server instance + * return: -1 error or 0 ok + */ +inline int rpc_register_srvPing(rpc_srv_t * __restrict srv); +/* * rpc_register_srvServices() - Register internal service functions * * @srv = RPC server instance @@ -282,7 +298,7 @@ int rpc_register_blobServices(rpc_srv_t * __restrict s * @regProgID = ProgramID for authentication & recognition * @regProcID = ProcessID 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 * return: NULL == error or !=NULL bind and created RPC server instance @@ -296,7 +312,7 @@ rpc_srv_t *rpc_srv_initServer(unsigned int regProgID, * @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 * @@ -304,14 +320,14 @@ void rpc_srv_endServer(rpc_srv_t ** __restrict psrv); * return: -1 error or 0 ok, infinite loop ... */ int rpc_srv_loopServer(rpc_srv_t * __restrict srv); -#define rpc_srv_execServer(_srv, _sync) do { assert((_srv)); pthread_t __tid; \ +#define rpc_srv_execServer(_srv, _sync) do { assert((_srv)); \ if (!(_srv)->srv_kill) { \ - pthread_create(&__tid, NULL, (void*(*)(void*)) \ + pthread_create(&(_srv)->srv_tid, NULL, (void*(*)(void*)) \ rpc_srv_loopServer, (_srv)); \ if ((_sync)) \ - pthread_join(__tid, (void**) (_sync)); \ + pthread_join((_srv)->srv_tid, (void**) (_sync)); \ else \ - pthread_detach(__tid); \ + pthread_detach((_srv)->srv_tid); \ } } while (0) /* @@ -322,14 +338,14 @@ int rpc_srv_loopServer(rpc_srv_t * __restrict srv); * @diskDir = Disk place for BLOB file objects * return: -1 == error or 0 bind and created BLOB server instance */ -int rpc_srv_initBLOBServer(rpc_srv_t * __restrict srv, u_short Port, const char *diskDir); +int rpc_srv_initBLOBServer(rpc_srv_t * __restrict srv, unsigned short Port, const char *diskDir); /* * rpc_srv_endBLOBServer() - Destroy BLOB server, close all opened sockets and free resources * * @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 * @@ -337,11 +353,12 @@ void rpc_srv_endBLOBServer(rpc_srv_t * __restrict srv) * return: -1 error or 0 ok, infinite loop ... */ int rpc_srv_loopBLOBServer(rpc_srv_t * __restrict srv); -#define rpc_srv_execBLOBServer(_srv) do { assert((_srv)); pthread_t __tid; \ +#define rpc_srv_execBLOBServer(_srv) do { assert((_srv)); \ if (!(_srv)->srv_kill && !(_srv)->srv_blob.kill) { \ - pthread_create(&__tid, NULL, (void*(*)(void*)) \ + pthread_create(&(_srv)->srv_blob.tid, NULL, \ + (void*(*)(void*)) \ rpc_srv_loopBLOBServer, (_srv)); \ - pthread_detach(__tid); \ + pthread_detach((_srv)->srv_blob.tid); \ } \ } while (0) @@ -351,11 +368,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 * @@ -373,15 +388,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); /* @@ -474,7 +490,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 io_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); @@ -491,7 +507,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 io_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, @@ -505,7 +521,7 @@ inline int rpc_cli_getBLOB(rpc_cli_t * __restrict cli, * * @ProgID = ProgramID for RPC session request * @ProcID = ProcessID for RPC session request - * @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 IP address for bind server * @Port = Port for bind server, if Port == 0 default port is selected * return: NULL == error or !=NULL connection to RPC server established @@ -525,12 +541,26 @@ void rpc_cli_closeClient(rpc_cli_t ** __restrict cli); * @cli = RPC Client session * @noreply = We not want RPC reply * @tag = Function tag for execution - * @in_vars = IN RPC call array of rpc values - * @out_vars = OUT returned array of rpc values, must be free after use with rpc_cli_freeVals() + * @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() * return: -1 error or != -1 ok result */ -int rpc_cli_execCall(rpc_cli_t *cli, int noreply, u_short tag, +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 + * + * @cli = connected client + * return: -1 error or !=-1 ping seq id + */ +inline int rpc_cli_ping(rpc_cli_t *cli); /* @@ -540,7 +570,7 @@ int rpc_cli_execCall(rpc_cli_t *cli, int noreply, u_sh * @Port = Port for bind server, if Port == 0 default port is selected * return: NULL == error or !=NULL connection to BLOB server established */ -rpc_cli_t *rpc_cli_openBLOBClient(rpc_cli_t * __restrict rpccli, u_short Port); +rpc_cli_t *rpc_cli_openBLOBClient(rpc_cli_t * __restrict rpccli, unsigned short Port); /* * rpc_cli_closeBLOBClient() - Close connection to BLOB server and free resources *