--- libaitrpc/inc/aitrpc.h 2011/08/29 23:26:56 1.3.2.1 +++ libaitrpc/inc/aitrpc.h 2012/05/15 22:47:10 1.8.2.4 @@ -3,7 +3,7 @@ * by Michael Pounov * * $Author: misho $ -* $Id: aitrpc.h,v 1.3.2.1 2011/08/29 23:26:56 misho Exp $ +* $Id: aitrpc.h,v 1.8.2.4 2012/05/15 22:47:10 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 +Copyright 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012 by Michael Pounov . All rights reserved. Redistribution and use in source and binary forms, with or without @@ -50,19 +50,26 @@ SUCH DAMAGE. #include #include #include +#include #include #include #if !defined(__NetBSD__) #include #endif #include +#include #include +#include -#define RPC_VERSION 1 +#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_BLOBSHUTDOWN "rpcBLOBServerShutdown" @@ -79,23 +86,25 @@ SUCH DAMAGE. /* RPC types */ typedef enum { - disable, enable, kill, /* for blob.state */ - ok, error, /* for blob reply */ - get, set, unset /* for blob request */ + 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)) { \ - rpc_SetErr(22, "Error:: invalid callback parameters ...\n"); \ + 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) && (_f)->func_args != _n) { \ - rpc_SetErr(22, "Error:: different number of arguments!\n"); \ + if ((_f) && io_arraySize((_f)->func_vars) < _n) { \ + rpc_SetErr(EINVAL, \ + "Not enough number of arguments!"); \ return -1; \ } \ } while (0) @@ -106,47 +115,36 @@ typedef enum { typedef struct { uint8_t sess_version; 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; - int8_t func_file[MAXPATHLEN]; - int8_t func_name[UCHAR_MAX + 1]; - - int8_t func_args; - ait_val_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_tag; - uint32_t call_hash; - uint8_t call_argc; -} __packed; -/* Network RPC packet - Server response */ + uint16_t call_seq; + uint16_t call_len; + uint16_t call_crc; -struct tagRPCRet { - rpc_sess_t ret_session; - uint16_t ret_tag; - uint32_t ret_hash; - int32_t ret_retcode; - int32_t ret_errno; - uint8_t ret_argc; -} __packed; + 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 */ + /* Network BLOB packet - Header */ struct tagBLOBHdr { @@ -155,20 +153,34 @@ struct tagBLOBHdr { uint32_t hdr_var; uint32_t hdr_len; uint32_t hdr_ret; + uint16_t hdr_crc; + uint8_t hdr_pad; } __packed; /* Network RPC client & server elements */ +/* RPC function registration element! */ +typedef struct tagRPCFunc { + ait_val_t func_name; + + array_t *func_vars; + + void *func_parent; + TAILQ_ENTRY(tagRPCFunc) func_node; +} rpc_func_t; + + typedef struct { - struct sockaddr cli_sa; // host info - int cli_sock; // socket fd - pthread_t cli_tid; // TID of thread + int cli_id; /* slot id */ + int cli_sock; /* socket fd */ + io_sockaddr_t cli_sa; /* host address */ + ait_val_t cli_buf; /* network buffer */ - void *cli_parent; // pointer to parent rpc_srv_t for server or to rpc_sess_t for client + void *cli_parent; /* pointer to parent rpc_srv_t for server or to rpc_sess_t for client */ } rpc_cli_t; -// BLOB registration element! +/* BLOB registration element! */ typedef struct tagBLOB { uint32_t blob_var; @@ -179,39 +191,38 @@ typedef struct tagBLOB { } rpc_blob_t; typedef struct { - rpc_sess_t srv_session; // RPC session registration info - int srv_numcli; // maximum concurent client connections + rpc_sess_t srv_session; /* RPC session registration info */ + int srv_netbuf; /* size of network buffer */ - rpc_cli_t srv_server; // RPC server socket - rpc_cli_t *srv_clients; // connected rpc client sockets + sched_root_task_t *srv_root; /* RPC server scheduler */ + intptr_t srv_kill; /* Scheduler condition variable */ - rpc_func_t *srv_funcs; // registered functions list + rpc_cli_t srv_server; /* RPC server socket */ + array_t *srv_clients; /* connected rpc client sockets */ - pthread_mutex_t srv_mtx; - cmd_type_t srv_kill; + TAILQ_HEAD(, tagRPCFunc) srv_funcs; /* RPC functions list */ struct { cmd_type_t state; // BLOB server state: ==0 disable | !=0 enable - char dir[UCHAR_MAX + 1]; + ait_val_t dir; rpc_cli_t server; // BLOB server socket rpc_cli_t *clients; // connected blob client sockets rpc_blob_t *blobs; // registered blob variables list - - pthread_mutex_t mtx; - } srv_blob; + } srv_blob; } rpc_srv_t; /* - * (*rpc_callback_t)() Callback type definition for RPC call in server process + * (*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 * @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, ait_val_t *); +typedef int (*rpc_callback_t)(rpc_func_t *, int, array_t *); // ----------------------------------------------------------------------- @@ -224,35 +235,73 @@ inline int rpc_GetErrno(); 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_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 Server side functions */ /* - * rpc_srv_initServer() Init & create RPC Server + * rpc_srv_initServer() - Init & create RPC Server + * * @regProgID = ProgramID for authentication & recognition * @regProcID = ProcessID for authentication & recognition * @concurentClients = Concurent clients at same time to this server - * @family = Family type, AF_INET, AF_INET6 or AF_LOCAL + * @netBuf = Network buffer length, 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, - 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 - * @srv = RPC Server instance + * 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 srv); +void rpc_srv_endServer(rpc_srv_t ** __restrict psrv); /* - * rpc_srv_execServer() Execute Main server loop and wait for clients requests + * rpc_srv_loopServer() - Execute Main server loop and wait for clients requests + * * @srv = RPC Server instance * return: -1 error or 0 ok, infinite loop ... */ -int rpc_srv_execServer(rpc_srv_t * __restrict srv); +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) /* - * rpc_srv_initBLOBServer() Init & create BLOB Server + * rpc_srv_initBLOBServer() - Init & create BLOB Server + * * @srv = RPC server instance * @Port = Port for bind server, if Port == 0 default port is selected * @diskDir = Disk place for BLOB file objects @@ -260,124 +309,93 @@ int rpc_srv_execServer(rpc_srv_t * __restrict srv); */ int rpc_srv_initBLOBServer(rpc_srv_t * __restrict srv, u_short Port, const char *diskDir); /* - * rpc_srv_endBLOBServer() Destroy BLOB server, close all opened sockets and free resources + * 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); /* - * rpc_srv_execBLOBServer() Execute Main BLOB server loop and wait for clients requests + * 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_execBLOBServer(rpc_srv_t * __restrict srv); +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; \ + } \ + } while (0) /* - * rpc_srv_registerCall() Register call to RPC server + * 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 + * @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, const char *csModule, const char *csFunc, - unsigned char args); +int rpc_srv_registerCall(rpc_srv_t * __restrict srv, unsigned short tag, + void *funcaddr, unsigned short args); /* - * rpc_srv_unregisterCall() Unregister call from RPC server + * 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 * @rpc = IN RPC call structure - * @args = IN RPC call array of rpc values + * @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, - ait_val_t * __restrict args); + array_t * __restrict args); /* - * rpc_srv_returnVars() Init return variables for RPC call and zeroed values - (for safe handling return values, use this!) - * @call = RPC function call - * @varnum = Number of return variables - * return: NULL error, !=NULL array with return values for RPC call with varnum items - */ -inline ait_val_t *rpc_srv_returnVars(rpc_func_t * __restrict call, int varnum); -/* - * rpc_srv_allocVars() Allocate array for call variables, - if already allocated memory for RPC call reallocate used space - * @call = RPC function call - * @varnum = Number of variables, if ==0 free previous allocated variables - * return: -1 error, !=-1 return varnum value - */ -inline int rpc_srv_allocVars(rpc_func_t * __restrict call, int varnum); -#define rpc_srv_freeVars(_call) (assert((_call)), rpc_srv_allocVars((_call), 0)) -/* - * rpc_srv_zeroVars() Clean values from variables of RPC call - * @call = RPC function call - * return: -1 error, !=-1 Returned number of cleaned RPC variables - */ -inline int rpc_srv_zeroVars(rpc_func_t * __restrict call); -/* - * rpc_srv_copyVars() Copy variables for RPC call to new variable array - * @call = RPC function call - * @newvars = New allocated variables array, must be free after use - * return: -1 error, !=-1 Returned number of copied RPC variables - */ -inline int rpc_srv_copyVars(rpc_func_t * __restrict call, ait_val_t ** __restrict newvars); -/* - * rpc_srv_getVars() Get variables array for RPC call - * @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, ait_val_t ** __restrict vars); - - -/* - * rpc_srv_blobCreate() Create map blob to memory region and return object + * 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 */ inline rpc_blob_t *rpc_srv_blobCreate(rpc_srv_t * __restrict srv, int len); /* - * rpc_srv_blobMap() Map blob to memory region + * rpc_srv_blobMap() - Map blob to memory region + * * @srv = RPC Server instance * @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); /* - * rpc_srv_blobUnmap() Unmap blob memory region + * rpc_srv_blobUnmap() - Unmap blob memory region + * * @blob = Mapped BLOB element * return: none */ inline void rpc_srv_blobUnmap(rpc_blob_t * __restrict blob); /* - * rpc_srv_blobFree() Free blob from disk & memory + * rpc_srv_blobFree() - Free blob from disk & memory + * * @srv = RPC Server instance * @blob = Mapped BLOB element * return: -1 error or 0 ok @@ -385,21 +403,24 @@ inline void rpc_srv_blobUnmap(rpc_blob_t * __restrict inline int rpc_srv_blobFree(rpc_srv_t * __restrict srv, rpc_blob_t * __restrict blob); /* - * rpc_srv_registerBLOB() Register new BLOB to server + * rpc_srv_registerBLOB() - Register new BLOB to server + * * @srv = RPC Server instance * @len = BLOB length * return: NULL error or new registered BLOB */ rpc_blob_t *rpc_srv_registerBLOB(rpc_srv_t * __restrict srv, size_t len); /* - * rpc_srv_unregisterBLOB() Unregister BLOB from server + * rpc_srv_unregisterBLOB() - Unregister BLOB from server + * * @srv = RPC Server instance * @var = BLOB Variable for unregister * return: -1 error, 0 not found call, 1 unregister ok */ int rpc_srv_unregisterBLOB(rpc_srv_t * __restrict srv, uint32_t var); /* - * rpc_srv_getBLOB() Get registered BLOB + * rpc_srv_getBLOB() - Get registered BLOB + * * @srv = RPC Server instance * @var = hash for variable * return: NULL not found, !=NULL return blob var @@ -407,22 +428,27 @@ int rpc_srv_unregisterBLOB(rpc_srv_t * __restrict srv, inline rpc_blob_t *rpc_srv_getBLOB(rpc_srv_t * __restrict srv, uint32_t var); /* - * rpc_srv_sendBLOB() Send mapped BLOB to client + * rpc_srv_sendBLOB() - Send mapped BLOB to client + * * @cli = Client instance * @blob = Mapped BLOB element * return: -1 error, 0 ok */ int rpc_srv_sendBLOB(rpc_cli_t * __restrict cli, rpc_blob_t * __restrict blob); /* - * rpc_srv_recvBLOB() Receive BLOB from client + * rpc_srv_recvBLOB() - Receive BLOB from client + * * @cli = Client instance * @blob = Mapped BLOB element * 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 + * rpc_cli_sendBLOB() - Send BLOB to server + * * @cli = Client instance * @var = BLOB variable * @data = BLOB data @@ -430,81 +456,84 @@ int rpc_srv_recvBLOB(rpc_cli_t * __restrict cli, rpc_b */ int rpc_cli_sendBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var, void * __restrict data); /* - * rpc_cli_recvBLOB() Receive BLOB from server + * 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 ** data); +int rpc_cli_recvBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var, void ** __restrict data); /* - * rpc_cli_delBLOB() Delete BLOB from server + * 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. + * 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 ** data); +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 + * 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) + * @Timeout = RPC timeout in seconds, if =0 set default RPC timeout * @family = Family socket type, AF_INET or AF_INET6 * @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(u_int ProgID, u_int ProcID, - u_short family, const char *csHost, u_short Port); +rpc_cli_t *rpc_cli_openClient(unsigned int ProgID, unsigned int ProcID, int netBuf, + unsigned char Timeout, unsigned short family, + const char *csHost, unsigned short Port); /* - * rpc_cli_closeClient() Close connection to RPC server and free resources + * 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 + * 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_argc = IN count of arguments * @in_vars = IN RPC call array of rpc values - * @out_argc = OUT returned count of arguments - * @out_vars = OUT returned array of rpc values, must be free after use (see rpc_cli_freeVals()) + * @out_vars = OUT returned array of rpc values, must be free after use with rpc_cli_freeVals() * return: -1 error or != -1 ok result */ -int rpc_cli_execCall(rpc_cli_t *cli, const char *csModule, const char *csFunc, int in_argc, - ait_val_t * __restrict in_vars, int *out_argc, ait_val_t ** __restrict out_vars); -/* - * rpc_cli_freeVals() Free ait_val_t array returned from RPC call - * @args = Number of arguments in array - * @vars = Value elements - * return: none - */ -inline void rpc_cli_freeVals(int args, ait_val_t * __restrict vars); +int rpc_cli_execCall(rpc_cli_t *cli, int noreply, const char *csModule, const char *csFunc, + array_t * __restrict in_vars, array_t ** __restrict out_vars); /* - * rpc_cli_openBLOBClient() Connect to BLOB Server + * 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, u_short Port); /* - * rpc_cli_closeBLOBClient() Close connection to BLOB server and free resources + * rpc_cli_closeBLOBClient() - Close connection to BLOB server and free resources + * * @cli = BLOB Client session * return: none */