--- libaitrpc/inc/aitrpc.h 2012/05/19 00:29:50 1.9 +++ libaitrpc/inc/aitrpc.h 2015/07/02 22:28:14 1.28 @@ -3,7 +3,7 @@ * by Michael Pounov * * $Author: misho $ -* $Id: aitrpc.h,v 1.9 2012/05/19 00:29:50 misho Exp $ +* $Id: aitrpc.h,v 1.28 2015/07/02 22:28:14 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 - 2015 by Michael Pounov . All rights reserved. Redistribution and use in source and binary forms, with or without @@ -48,52 +48,22 @@ SUCH DAMAGE. #include -#include -#include -#include -#include -#include -#if !defined(__NetBSD__) -#include -#endif -#include +//#include +//#include +//#include +//#include +//#include +//#if !defined(__NetBSD__) +//#include +//#endif +//#include +#include #include -#include +#include +#include #include -#define RPC_VERSION 4 -#define RPC_DEFPORT 2611 - -/* RPC call request flags */ - -#define RPC_REPLY 0x0 -#define RPC_NOREPLY 0x1 - -/* RPC builtin registed calls */ - -#define CALL_TAG_MAX 65535 - -#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 { - ok, error, no, /* for blob reply */ - get, set, unset /* for blob request */ -} cmd_type_t; - - #define RPC_CALLBACK_CHECK_INPUT(x) do { \ assert((x)); \ if (!(x)) { \ @@ -104,66 +74,31 @@ typedef enum { } while (0) -/* RPC session identification */ +/* Network RPC server elements */ -typedef struct { - uint8_t sess_version; - uint32_t sess_program; - uint8_t sess_process; -} __packed rpc_sess_t; /* size == 6 bytes */ - - -/* Server managment RPC functions ... */ - -/* Network RPC packet - Client request */ - -struct tagRPCCall { - rpc_sess_t call_session; - - uint16_t call_seq; - uint16_t call_len; - uint16_t call_crc; - - union { - struct { - uint64_t flags; - } call_req; - struct { - int32_t ret; - int32_t eno; - } call_rep; - }; - - 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 */ - -struct tagBLOBHdr { - rpc_sess_t hdr_session; - uint8_t hdr_cmd; - uint32_t hdr_var; - uint32_t hdr_len; - uint32_t hdr_ret; - uint16_t hdr_crc; - uint8_t hdr_pad; -} __packed; /* size == 22 bytes */ - -/* Network RPC client & server elements */ - /* RPC function registration element! */ typedef struct tagRPCFunc { ait_val_t func_name; void *func_parent; - TAILQ_ENTRY(tagRPCFunc) func_node; + + SLIST_ENTRY(tagRPCFunc) func_next; + AVL_ENTRY(tagRPCFunc) func_node; } rpc_func_t; #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 */ @@ -176,22 +111,9 @@ typedef struct tagBLOB { 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) - -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 */ @@ -200,7 +122,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 */ @@ -227,40 +149,20 @@ typedef struct { */ typedef int (*rpc_callback_t)(rpc_cli_t *, struct tagRPCCall *, array_t *); +#define RPC_CALL_DEFINE(x) int (x)(rpc_cli_t*, struct tagRPCCall*, array_t*) +#define RPC_CALL_ARGS(arg1, arg2, arg3) rpc_cli_t* arg1, struct tagRPCCall* arg2, array_t* arg3 +#define RPC_CALL_STDARGS RPC_CALL_ARGS(cli, rpc, iv) + /* ----------------------------------------------------------------------- */ -/* Error support functions */ - -// rpc_GetErrno() Get error code of last operation -inline int rpc_GetErrno(); -// rpc_GetError() Get error text of last operation -inline const char *rpc_GetError(); - - /* - * rpc_chkPktSession() - Check RPC session - * - * @p = packet session - * @s = active session - * return: -1, 1, 2, 3 are errors or 0 ok - */ -inline int rpc_chkPktSession(rpc_sess_t *p, rpc_sess_t *s); -/* - * rpc_addPktSession() - Prepare session into network format - * - * @p = packet 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); +int rpc_register_srvPing(rpc_srv_t * __restrict srv); /* * rpc_register_srvServices() - Register internal service functions * @@ -282,24 +184,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 (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 */ -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 * @@ -307,15 +208,18 @@ inline void rpc_srv_endServer(rpc_srv_t ** __restrict * 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)); \ - 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) +#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) +#define rpc_srv_killServer(_srv) \ + (assert((_srv)), (_srv)->srv_blob.kill = 1, (_srv)->srv_kill = 1) /* * rpc_srv_initBLOBServer() - Init & create BLOB Server @@ -332,7 +236,7 @@ int rpc_srv_initBLOBServer(rpc_srv_t * __restrict srv, * @srv = RPC Server instance * 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 * @@ -340,16 +244,38 @@ inline void rpc_srv_endBLOBServer(rpc_srv_t * __restri * 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)); \ - 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) +#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) /* + * rpc_srv_initServer2() - Init & create layer2 RPC Server + * + * @InstID = Instance for authentication & recognition + * @concurentClients = Concurent clients at same time to this server + * @netBuf = Network buffer length (min:512 bytes), if =0 == BUFSIZ (also meaning max RPC packet) + * @csIface = Interface name for bind server, if NULL first interface on host + * return: NULL == error or !=NULL bind and created RPC server instance + */ +rpc_srv_t *rpc_srv_initServer2(u_char InstID, int concurentClients, int netBuf, + const char *csIface); + +/* + * rpc_srv_initServerExt() - Init & create pipe RPC Server + * + * @InstID = Instance for authentication & recognition + * @netBuf = Network buffer length (min:512 bytes), if =0 == BUFSIZ (also meaning max RPC packet) + * @fd = File descriptor + * return: NULL == error or !=NULL bind and created RPC server instance + */ +rpc_srv_t *rpc_srv_initServerExt(u_char InstID, int netBuf, int fd); + +/* * rpc_srv_registerCall() - Register call to RPC server * * @srv = RPC Server instance @@ -373,7 +299,7 @@ int rpc_srv_unregisterCall(rpc_srv_t * __restrict srv, * @tag = tag 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); +rpc_func_t *rpc_srv_getCall(rpc_srv_t * __restrict srv, uint16_t tag); /* * rpc_srv_execCall() Execute registered call from RPC server * @@ -392,9 +318,10 @@ int rpc_srv_execCall(rpc_cli_t * __restrict cli, struc * * @srv = RPC Server instance * @len = BLOB length object + * @tout = BLOB live timeout in seconds * 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 * @@ -402,14 +329,14 @@ inline rpc_blob_t *rpc_srv_blobCreate(rpc_srv_t * __re * @blob = Map to this BLOB element * 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 * * @blob = Mapped BLOB element * 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 * @@ -417,16 +344,17 @@ inline void rpc_srv_blobUnmap(rpc_blob_t * __restrict * @blob = Mapped BLOB element * 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 * * @srv = RPC Server instance * @len = BLOB length + * @tout = BLOB live timeout in seconds * 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 * @@ -442,7 +370,7 @@ int rpc_srv_unregisterBLOB(rpc_srv_t * __restrict srv, * @var = hash for variable * 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 @@ -460,104 +388,6 @@ int rpc_srv_sendBLOB(rpc_cli_t * __restrict cli, rpc_b * return: -1 error, 0 ok, >0 unreceived data from client, may be error? */ int rpc_srv_recvBLOB(rpc_cli_t * __restrict cli, rpc_blob_t * __restrict blob); - -/* CLIENT part of functions */ - -/* - * rpc_cli_sendBLOB() - Send BLOB to server - * - * @cli = Client instance - * @var = BLOB variable - * @data = BLOB data - * 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); -/* - * rpc_cli_recvBLOB() - Receive BLOB from server - * - * @cli = Client instance - * @var = BLOB variable - * @data = BLOB data, must be 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); -/* - * rpc_cli_delBLOB() - Delete BLOB from server - * - * @cli = Client instance - * @var = BLOB variable - * return: -1 error, 0 ok, 1 remote error - */ -int rpc_cli_delBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var); -/* - * rpc_cli_getBLOB() - Receive BLOB from server and Delete after that. - * - * @cli = Client instance - * @var = BLOB variable - * @data = BLOB data, must be 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, - void ** __restrict data); - - -/* RPC Client side functions */ - -/* - * rpc_cli_openClient() - Connect to RPC Server - * - * @ProgID = ProgramID 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) - * @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 char ProcID, int netBuf, - const char *csHost, unsigned short Port); -/* - * rpc_cli_closeClient() - Close connection to RPC server and free resources - * - * @cli = RPC Client session - * return: none - */ -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 - * @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, 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); - - -/* - * rpc_cli_openBLOBClient() - Connect to BLOB Server - * - * @rpccli = RPC Client session - * @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, 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); #endif