--- libaitrpc/inc/aitrpc.h 2011/11/03 15:32:21 1.5 +++ libaitrpc/inc/aitrpc.h 2012/03/13 17:21:52 1.5.2.5 @@ -3,7 +3,7 @@ * by Michael Pounov * * $Author: misho $ -* $Id: aitrpc.h,v 1.5 2011/11/03 15:32:21 misho Exp $ +* $Id: aitrpc.h,v 1.5.2.5 2012/03/13 17:21:52 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,6 +50,7 @@ SUCH DAMAGE. #include #include #include +#include #include #include #if !defined(__NetBSD__) @@ -57,12 +58,17 @@ SUCH DAMAGE. #endif #include #include +#include -#define RPC_VERSION 2 +#define RPC_VERSION 3 #define RPC_DEFPORT 2611 +/* RPC call request flags */ +#define RPC_REPLY 0x0 +#define RPC_NOREPLY 0x1 + /* RPC builtin registed calls */ #define CALL_BLOBSHUTDOWN "rpcBLOBServerShutdown" @@ -88,14 +94,16 @@ typedef enum { #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) && io_arraySize((_f)->func_vars) < _n) { \ - rpc_SetErr(22, "Error:: not enough number of arguments!\n"); \ + rpc_SetErr(EINVAL, \ + "Not enough number of arguments!"); \ return -1; \ } \ } while (0) @@ -105,6 +113,7 @@ typedef enum { typedef struct { uint8_t sess_version; + uint8_t sess_timeout; uint32_t sess_program; uint32_t sess_process; } __packed rpc_sess_t; @@ -112,12 +121,12 @@ typedef struct { /* Server managment RPC functions ... */ -// RPC function registration element! +/* RPC function registration element! */ typedef struct tagRPCFunc { uint16_t func_tag; uint32_t func_hash; - char func_file[MAXPATHLEN]; - char func_name[UCHAR_MAX + 1]; + ait_val_t func_file; + ait_val_t func_name; array_t *func_vars; @@ -130,20 +139,22 @@ typedef struct tagRPCFunc { struct tagRPCCall { rpc_sess_t call_session; + uint16_t call_tag; uint32_t call_hash; uint16_t call_argc; -} __packed; -/* Network RPC packet - Server response */ + union { + struct { + uint64_t flags; + } call_req; + struct { + int32_t ret; + int32_t eno; + } call_rep; + }; -struct tagRPCRet { - rpc_sess_t ret_session; - uint16_t ret_tag; - uint32_t ret_hash; - int32_t ret_retcode; - int32_t ret_errno; - uint16_t ret_argc; + uint16_t call_crc; } __packed; /* Network BLOB packet - Header */ @@ -168,7 +179,7 @@ typedef struct { } rpc_cli_t; -// BLOB registration element! +/* BLOB registration element! */ typedef struct tagBLOB { uint32_t blob_var; @@ -179,21 +190,21 @@ typedef struct tagBLOB { } 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 + rpc_sess_t srv_session; // RPC session registration info + int srv_numcli; // maximum concurent client connections + int srv_netbuf; // size of network buffer size - rpc_cli_t srv_server; // RPC server socket - rpc_cli_t *srv_clients; // connected rpc client sockets + rpc_cli_t srv_server; // RPC server socket + rpc_cli_t *srv_clients; // connected rpc client sockets - rpc_func_t *srv_funcs; // registered functions list + rpc_func_t *srv_funcs; // registered functions list - pthread_mutex_t srv_mtx; - cmd_type_t srv_kill; + pthread_mutex_t srv_mtx; + cmd_type_t srv_kill; 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 @@ -201,12 +212,13 @@ typedef struct { 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 @@ -226,14 +238,16 @@ inline const char *rpc_GetError(); /* - * rpc_chkPktSession() Check session in RPC packet + * rpc_chkPktSession() - Check session in RPC packet + * * @p = packet session * @s = active session * return: -1 error or 0 ok */ inline int rpc_chkPktSession(rpc_sess_t *p, rpc_sess_t *s); /* - * rpc_addPktSession() Add session into RPC packet + * rpc_addPktSession() - Add session into RPC packet + * * @p = packet session * @s = active session * return: -1 error or 0 ok @@ -244,7 +258,8 @@ inline int rpc_addPktSession(rpc_sess_t *p, rpc_sess_t /* 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 @@ -257,13 +272,15 @@ inline int rpc_addPktSession(rpc_sess_t *p, rpc_sess_t 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_endServer() Destroy RPC server, close all opened sockets and free resources + * 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); /* - * rpc_srv_loopServer() 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 ... */ @@ -278,7 +295,8 @@ int rpc_srv_loopServer(rpc_srv_t * __restrict srv); } 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 @@ -286,13 +304,15 @@ int rpc_srv_loopServer(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_loopBLOB() 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 ... */ @@ -307,7 +327,8 @@ int rpc_srv_loopBLOB(rpc_srv_t * __restrict srv); } 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 @@ -317,7 +338,8 @@ int rpc_srv_loopBLOB(rpc_srv_t * __restrict srv); int rpc_srv_registerCall(rpc_srv_t * __restrict srv, const char *csModule, const char *csFunc, 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 @@ -325,7 +347,8 @@ int rpc_srv_registerCall(rpc_srv_t * __restrict srv, c */ int rpc_srv_unregisterCall(rpc_srv_t * __restrict srv, const char *csModule, const char *csFunc); /* - * rpc_srv_getFunc() Get registered call from RPC server by Name + * rpc_srv_getFunc() - Get registered call from RPC server by Name + * * @srv = RPC Server instance * @csModule = Module name, if NULL self binary * @csFunc = Function name @@ -333,7 +356,8 @@ int rpc_srv_unregisterCall(rpc_srv_t * __restrict srv, */ 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 + * rpc_srv_getCall() - Get registered call from RPC server + * * @srv = RPC Server instance * @tag = tag for function * @hash = hash for function @@ -341,7 +365,8 @@ rpc_func_t *rpc_srv_getFunc(rpc_srv_t * __restrict srv */ inline rpc_func_t *rpc_srv_getCall(rpc_srv_t * __restrict srv, uint16_t tag, uint32_t hash); /* - * 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 calling arguments from RPC client @@ -352,15 +377,9 @@ int rpc_srv_execCall(rpc_func_t * __restrict call, str /* - * rpc_srv_copyVars() Copy variables for RPC call to new variable array + * rpc_srv_getVars() - Get variables array for RPC call + * * @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, array_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 */ @@ -368,27 +387,31 @@ inline int rpc_srv_getVars(rpc_func_t * __restrict cal /* - * 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 @@ -396,21 +419,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 @@ -418,14 +444,16 @@ 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? @@ -435,7 +463,8 @@ int rpc_srv_recvBLOB(rpc_cli_t * __restrict cli, rpc_b /* 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 @@ -443,7 +472,8 @@ 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! @@ -451,14 +481,16 @@ int rpc_cli_sendBLOB(rpc_cli_t * __restrict cli, ait_v */ 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! @@ -471,7 +503,8 @@ inline int rpc_cli_getBLOB(rpc_cli_t * __restrict cli, /* 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) @@ -483,13 +516,15 @@ inline int rpc_cli_getBLOB(rpc_cli_t * __restrict cli, rpc_cli_t *rpc_cli_openClient(u_int ProgID, u_int ProcID, int netBuf, u_short family, const char *csHost, u_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 * @csModule = Module name, if NULL self binary * @csFunc = Function name for execute @@ -502,14 +537,16 @@ int rpc_cli_execCall(rpc_cli_t *cli, const char *csMod /* - * 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 */