--- libaitrpc/inc/aitrpc.h 2012/05/16 07:37:37 1.8.2.7 +++ libaitrpc/inc/aitrpc.h 2012/11/05 15:57:35 1.10.2.1 @@ -3,7 +3,7 @@ * by Michael Pounov * * $Author: misho $ -* $Id: aitrpc.h,v 1.8.2.7 2012/05/16 07:37:37 misho Exp $ +* $Id: aitrpc.h,v 1.10.2.1 2012/11/05 15:57:35 misho Exp $ * ************************************************************************** The ELWIX and AITNET software is distributed under the following @@ -72,52 +72,36 @@ SUCH DAMAGE. /* RPC builtin registed calls */ -#define CALL_MAX_ID 65535 +#define CALL_TAG_MAX 65535 -#define CALL_BLOBSHUTDOWN "rpcBLOBServerShutdown" -#define CALL_BLOBSHUTDOWN_ID 65530 -#define CALL_BLOBCLIENTS "rpcBLOBServerClients" -#define CALL_BLOBCLIENTS_ID 65529 -#define CALL_BLOBVARS "rpcBLOBServerVars" -#define CALL_BLOBVARS_ID 65528 -#define CALL_BLOBSTATE "rpcBLOBServerState" -#define CALL_BLOBSTATE_ID 65527 +#define CALL_SRVPING 65534 -#define CALL_SRVSHUTDOWN "rpcServerShutdown" -#define CALL_SRVSHUTDOWN_ID 65534 -#define CALL_SRVCLIENTS "rpcServerClients" -#define CALL_SRVCLIENTS_ID 65533 -#define CALL_SRVCALLS "rpcServerCalls" -#define CALL_SRVCALLS_ID 65532 -#define CALL_SRVSESSIONS "rpcServerSessions" -#define CALL_SRVSESSIONS_ID 65531 +#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 */ @@ -154,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 */ @@ -165,7 +150,7 @@ struct tagBLOBHdr { uint32_t hdr_ret; uint16_t hdr_crc; uint8_t hdr_pad; -} __packed; +} __packed; /* size == 22 bytes */ /* Network RPC client & server elements */ @@ -173,37 +158,42 @@ struct tagBLOBHdr { typedef struct tagRPCFunc { ait_val_t func_name; - array_t *func_vars; - void *func_parent; TAILQ_ENTRY(tagRPCFunc) func_node; } rpc_func_t; +#define RPC_FUNC_SERVER(x) ((rpc_srv_t*) (x)->func_parent) +/* BLOB register element */ +typedef struct tagBLOB { + uint32_t blob_var; /* BLOB id */ + + size_t blob_len; /* size of allocated BLOB data */ + void *blob_data; /* mapped BLOB data */ + + TAILQ_ENTRY(tagBLOB) blob_node; +} rpc_blob_t; + + typedef struct { int cli_id; /* slot id */ int cli_sock; /* socket fd */ 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) - -/* BLOB registration element! */ -typedef struct tagBLOB { - uint32_t blob_var; - - size_t blob_len; // size of allocated BLOB data - void *blob_data; // BLOB data - - struct tagBLOB *blob_next; -} rpc_blob_t; - 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 */ @@ -213,13 +203,16 @@ typedef struct { TAILQ_HEAD(, tagRPCFunc) srv_funcs; /* RPC functions list */ struct { - cmd_type_t state; /* BLOB server state: ==0 disable | !=0 enable */ - ait_val_t dir; /* BLOB states directory */ + 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 */ - array_t *clients; /* connected blob client sockets */ + ait_val_t dir; /* BLOB states directory */ - rpc_blob_t *blobs; /* registered blob variables list */ + 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; @@ -227,15 +220,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 */ @@ -262,6 +255,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 @@ -285,7 +285,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 @@ -299,7 +299,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 * @@ -307,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 @@ -324,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) @@ -354,11 +355,9 @@ int rpc_srv_loopBLOB(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 * @@ -376,19 +375,20 @@ 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); /* - * rpc_srv_blobCreate() - Create map blob to memory region and return object + * rpc_srv_blobCreate() - Create and map blob to memory region and return object * * @srv = RPC Server instance * @len = BLOB length object @@ -477,7 +477,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); @@ -494,7 +494,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, @@ -508,15 +508,12 @@ 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) - * @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 @@ -524,20 +521,33 @@ 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_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); /* @@ -547,14 +557,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