--- libaitrpc/inc/aitrpc.h 2012/05/14 08:39:05 1.8 +++ libaitrpc/inc/aitrpc.h 2012/05/19 00:29:50 1.9 @@ -3,7 +3,7 @@ * by Michael Pounov * * $Author: misho $ -* $Id: aitrpc.h,v 1.8 2012/05/14 08:39:05 misho Exp $ +* $Id: aitrpc.h,v 1.9 2012/05/19 00:29:50 misho Exp $ * ************************************************************************** The ELWIX and AITNET software is distributed under the following @@ -57,11 +57,12 @@ SUCH DAMAGE. #include #endif #include +#include #include #include -#define RPC_VERSION 3 +#define RPC_VERSION 4 #define RPC_DEFPORT 2611 /* RPC call request flags */ @@ -71,81 +72,58 @@ SUCH DAMAGE. /* RPC builtin registed calls */ -#define CALL_BLOBSHUTDOWN "rpcBLOBServerShutdown" -#define CALL_BLOBCLIENTS "rpcBLOBServerClients" -#define CALL_BLOBVARS "rpcBLOBServerVars" -#define CALL_BLOBSTATE "rpcBLOBServerState" +#define CALL_TAG_MAX 65535 -#define CALL_SRVSHUTDOWN "rpcServerShutdown" -#define CALL_SRVCLIENTS "rpcServerClients" -#define CALL_SRVCALLS "rpcServerCalls" -#define CALL_SRVSESSIONS "rpcServerSessions" +#define CALL_SRVPING 65534 +#define CALL_SRVSHUTDOWN 65533 +#define CALL_SRVCLIENTS 65532 +#define CALL_SRVCALLS 65531 +#define CALL_SRVSESSIONS 65530 +#define CALL_BLOBSHUTDOWN 65529 +#define CALL_BLOBCLIENTS 65528 +#define CALL_BLOBVARS 65527 + + /* RPC types */ typedef enum { - disable, enable, running, kill, /* for blob.state */ ok, error, no, /* for blob reply */ get, set, unset /* for blob request */ } 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; - uint8_t sess_timeout; uint32_t sess_program; - uint32_t sess_process; -} __packed rpc_sess_t; + uint8_t sess_process; +} __packed rpc_sess_t; /* size == 6 bytes */ /* Server managment RPC functions ... */ -/* RPC function registration element! */ -typedef struct tagRPCFunc { - uint16_t func_tag; - uint32_t func_hash; - ait_val_t func_file; - ait_val_t func_name; - - array_t *func_vars; - - void *func_parent; - struct tagRPCFunc *func_next; -} rpc_func_t; - - /* Network RPC packet - Client request */ struct tagRPCCall { rpc_sess_t call_session; + uint16_t call_seq; uint16_t call_len; + uint16_t call_crc; - uint16_t call_tag; - uint32_t call_hash; - uint16_t call_argc; - union { struct { uint64_t flags; @@ -156,8 +134,11 @@ struct tagRPCCall { } call_rep; }; - uint16_t call_crc; -} __packed; + uint16_t call_tag; + 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 */ @@ -169,68 +150,85 @@ struct tagBLOBHdr { uint32_t hdr_ret; uint16_t hdr_crc; uint8_t hdr_pad; -} __packed; +} __packed; /* size == 22 bytes */ /* Network RPC client & server elements */ -typedef struct { - io_sockaddr_t cli_sa; // host info - int cli_sock; // socket fd - pthread_t cli_tid; // TID of thread +/* RPC function registration element! */ +typedef struct tagRPCFunc { + ait_val_t func_name; - cmd_type_t cli_kill; + void *func_parent; + TAILQ_ENTRY(tagRPCFunc) func_node; +} rpc_func_t; +#define RPC_FUNC_SERVER(x) ((rpc_srv_t*) (x)->func_parent) - void *cli_parent; // pointer to parent rpc_srv_t for server or to rpc_sess_t for client - int cli_netbuf; // size of network buffer size -} rpc_cli_t; - -/* BLOB registration element! */ +/* BLOB register element */ typedef struct tagBLOB { - uint32_t blob_var; + uint32_t blob_var; /* BLOB id */ - size_t blob_len; // size of allocated BLOB data - void *blob_data; // BLOB data + size_t blob_len; /* size of allocated BLOB data */ + void *blob_data; /* mapped BLOB data */ - struct tagBLOB *blob_next; + TAILQ_ENTRY(tagBLOB) blob_node; } rpc_blob_t; + typedef struct { - rpc_sess_t srv_session; // RPC session registration info - int srv_numcli; // maximum concurent client connections - int srv_netbuf; // size of network buffer size + int cli_id; /* slot id */ + int cli_sock; /* socket fd */ + io_sockaddr_t cli_sa; /* host address */ + ait_val_t cli_buf; /* network buffer */ - rpc_cli_t srv_server; // RPC server socket - rpc_cli_t *srv_clients; // connected rpc client sockets + array_t *cli_vars; /* function return variables */ - rpc_func_t *srv_funcs; // registered functions list + 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) - cmd_type_t srv_kill; +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 */ + struct { - cmd_type_t state; // BLOB server state: ==0 disable | !=0 enable - ait_val_t dir; + pthread_t tid; /* BLOB exec pthread */ + sched_root_task_t *root; /* BLOB server scheduler */ + intptr_t kill; /* BLOB server state: ==0 disable | !=0 enable */ - rpc_cli_t server; // BLOB server socket - rpc_cli_t *clients; // connected blob client sockets + ait_val_t dir; /* BLOB states directory */ - rpc_blob_t *blobs; // registered blob variables list - } srv_blob; + rpc_cli_t server; /* BLOB server socket */ + array_t *clients; /* connected blob client sockets */ + + TAILQ_HEAD(, tagBLOB) blobs; /* registered blob variables list */ + } srv_blob; } rpc_srv_t; /* * (*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 */ @@ -241,21 +239,42 @@ inline const char *rpc_GetError(); /* - * rpc_chkPktSession() - Check session in RPC packet + * rpc_chkPktSession() - Check RPC session * * @p = packet session * @s = active session - * return: -1 error 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); /* - * rpc_addPktSession() - Add session into RPC packet + * rpc_addPktSession() - Prepare session into network format * * @p = packet session - * @s = active session + * @s = host session * return: -1 error or 0 ok */ 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 + * return: -1 error or 0 ok + */ +int rpc_register_srvServices(rpc_srv_t * __restrict srv); +/* + * rpc_register_blobServices() - Register internal service functions + * + * @srv = RPC server instance + * return: -1 error or 0 ok + */ +int rpc_register_blobServices(rpc_srv_t * __restrict srv); /* RPC Server side functions */ @@ -266,21 +285,21 @@ inline int rpc_addPktSession(rpc_sess_t *p, rpc_sess_t * @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) - * @family = Family type, AF_INET, AF_INET6 or AF_LOCAL + * @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 */ -rpc_srv_t *rpc_srv_initServer(u_int regProgID, u_int regProcID, int concurentClients, - int netBuf, u_short family, const char *csHost, u_short Port); +rpc_srv_t *rpc_srv_initServer(unsigned int regProgID, unsigned char regProcID, + int concurentClients, int netBuf, + const char *csHost, unsigned short Port); /* * 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 * @@ -288,14 +307,15 @@ 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; \ - pthread_create(&__tid, NULL, (void*(*)(void*)) \ - rpc_srv_loopServer, (_srv)); \ - if ((_sync)) \ - pthread_join(__tid, (void**) (_sync)); \ - else \ - pthread_detach(__tid); \ - } while (0) +#define rpc_srv_execServer(_srv, _sync) do { assert((_srv)); \ + if (!(_srv)->srv_kill) { \ + pthread_create(&(_srv)->srv_tid, NULL, (void*(*)(void*)) \ + rpc_srv_loopServer, (_srv)); \ + if ((_sync)) \ + pthread_join((_srv)->srv_tid, (void**) (_sync)); \ + else \ + pthread_detach((_srv)->srv_tid); \ + } } while (0) /* * rpc_srv_initBLOBServer() - Init & create BLOB Server @@ -305,27 +325,27 @@ 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 * * @srv = RPC Server instance * return: -1 error or 0 ok, infinite loop ... */ -int rpc_srv_loopBLOB(rpc_srv_t * __restrict srv); -#define rpc_srv_execBLOBServer(_srv) do { assert((_srv)); pthread_t __tid; \ - if ((_srv)->srv_blob.state == enable) { \ - pthread_create(&__tid, NULL, (void*(*)(void*)) \ - rpc_srv_loopBLOB, (_srv)); \ - pthread_detach(__tid); \ - (_srv)->srv_blob.state = running; \ +int rpc_srv_loopBLOBServer(rpc_srv_t * __restrict srv); +#define rpc_srv_execBLOBServer(_srv) do { assert((_srv)); \ + if (!(_srv)->srv_kill && !(_srv)->srv_blob.kill) { \ + pthread_create(&(_srv)->srv_blob.tid, NULL, \ + (void*(*)(void*)) \ + rpc_srv_loopBLOBServer, (_srv)); \ + pthread_detach((_srv)->srv_blob.tid); \ } \ } while (0) @@ -333,65 +353,43 @@ int rpc_srv_loopBLOB(rpc_srv_t * __restrict srv); * rpc_srv_registerCall() - Register call to RPC server * * @srv = RPC Server instance - * @csModule = Module name, if NULL self binary - * @csFunc = Function name - * @args = Number of return function arguments, use for restriction case! - * return: -1 error or 0 register ok + * @tag = Function tag + * @funcaddr = Function address + * return: -1 error, 0 already registered tag or 1 register ok */ -int rpc_srv_registerCall(rpc_srv_t * __restrict srv, const char *csModule, const char *csFunc, - 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 * * @srv = RPC Server instance - * @csModule = Module name, if NULL self binary - * @csFunc = Function name + * @tag = Function tag * return: -1 error, 0 not found call, 1 unregister ok */ -int rpc_srv_unregisterCall(rpc_srv_t * __restrict srv, const char *csModule, const char *csFunc); +int rpc_srv_unregisterCall(rpc_srv_t * __restrict srv, unsigned short tag); /* - * rpc_srv_getFunc() - Get registered call from RPC server by Name + * rpc_srv_getCall() - Get registered call from RPC server * * @srv = RPC Server instance - * @csModule = Module name, if NULL self binary - * @csFunc = Function name - * return: NULL not found call, !=NULL return call - */ -rpc_func_t *rpc_srv_getFunc(rpc_srv_t * __restrict srv, const char *csModule, const char *csFunc); -/* - * rpc_srv_getCall() - Get registered call from RPC server - * - * @srv = RPC Server instance * @tag = tag for function - * @hash = hash for function * return: NULL not found call, !=NULL return call */ -inline rpc_func_t *rpc_srv_getCall(rpc_srv_t * __restrict srv, uint16_t tag, uint32_t hash); +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); /* - * rpc_srv_getVars() - Get variables array for RPC call + * rpc_srv_blobCreate() - Create and map blob to memory region and return object * - * @call = RPC function call - * @vars = Returned variables array, may be NULL - * return: -1 error, !=-1 Number of returned variables - */ -inline int rpc_srv_getVars(rpc_func_t * __restrict call, array_t ** __restrict vars); - - -/* - * rpc_srv_blobCreate() - Create map blob to memory region and return object - * * @srv = RPC Server instance * @len = BLOB length object * return: NULL error or !=NULL allocated BLOB object @@ -503,17 +501,6 @@ inline int rpc_cli_getBLOB(rpc_cli_t * __restrict cli, void ** __restrict data); -/* - * rpc_calcHashes() - Calculate hashes for RPC call - * - * @func = function - * @csModule = Module name, if NULL self binary - * @csFunc = Function name - * return: -1 error or 0 ok - */ -int rpc_calcHashes(rpc_func_t * __restrict func, const char *csModule, const char *csFunc); - - /* RPC Client side functions */ /* @@ -521,15 +508,12 @@ int rpc_calcHashes(rpc_func_t * __restrict func, const * * @ProgID = ProgramID for RPC session request * @ProcID = ProcessID for RPC session request - * @netBuf = Network buffer length, if =0 == BUFSIZ (also meaning max RPC packet) - * @Timeout = RPC timeout in seconds, if =0 set default RPC timeout - * @family = Family socket type, AF_INET or AF_INET6 + * @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 */ -rpc_cli_t *rpc_cli_openClient(unsigned int ProgID, unsigned int ProcID, int netBuf, - unsigned char Timeout, unsigned short family, +rpc_cli_t *rpc_cli_openClient(unsigned int ProgID, unsigned char ProcID, int netBuf, const char *csHost, unsigned short Port); /* * rpc_cli_closeClient() - Close connection to RPC server and free resources @@ -537,20 +521,26 @@ rpc_cli_t *rpc_cli_openClient(unsigned int ProgID, uns * @cli = RPC Client session * return: none */ -void rpc_cli_closeClient(rpc_cli_t * __restrict cli); +void rpc_cli_closeClient(rpc_cli_t ** __restrict cli); /* * rpc_cli_execCall() - Execute RPC call * * @cli = RPC Client session * @noreply = We not want RPC reply - * @csModule = Module name, if NULL self binary - * @csFunc = Function name for execute - * @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() + * @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() * return: -1 error or != -1 ok result */ -int rpc_cli_execCall(rpc_cli_t *cli, int noreply, const char *csModule, const char *csFunc, +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_ping() - Ping RPC server + * + * @cli = connected client + * return: -1 error or !=-1 ping seq id + */ +inline int rpc_cli_ping(rpc_cli_t *cli); /* @@ -560,14 +550,14 @@ int rpc_cli_execCall(rpc_cli_t *cli, int noreply, cons * @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 * * @cli = BLOB Client session * return: none */ -void rpc_cli_closeBLOBClient(rpc_cli_t * __restrict cli); +void rpc_cli_closeBLOBClient(rpc_cli_t ** __restrict cli); #endif