--- libaitrpc/inc/aitrpc.h 2010/06/23 16:23:31 1.1.1.1.2.7 +++ libaitrpc/inc/aitrpc.h 2011/08/19 09:20:46 1.2.4.7 @@ -3,9 +3,46 @@ * by Michael Pounov * * $Author: misho $ -* $Id: aitrpc.h,v 1.1.1.1.2.7 2010/06/23 16:23:31 misho Exp $ +* $Id: aitrpc.h,v 1.2.4.7 2011/08/19 09:20:46 misho Exp $ * -*************************************************************************/ +************************************************************************** +The ELWIX and AITNET software is distributed under the following +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 + by Michael Pounov . All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions +are met: +1. Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. +2. Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in the + documentation and/or other materials provided with the distribution. +3. All advertising materials mentioning features or use of this software + must display the following acknowledgement: +This product includes software developed by Michael Pounov +ELWIX - Embedded LightWeight unIX and its contributors. +4. Neither the name of AITNET nor the names of its contributors + may be used to endorse or promote products derived from this software + without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY AITNET AND CONTRIBUTORS ``AS IS'' AND +ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE +FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +SUCH DAMAGE. +*/ #ifndef __AITRPC_H #define __AITRPC_H @@ -15,7 +52,9 @@ #include #include #include +#if !defined(__NetBSD__) #include +#endif #include @@ -28,6 +67,7 @@ #define CALL_BLOBSHUTDOWN "rpcBLOBServerShutdown" #define CALL_BLOBCLIENTS "rpcBLOBServerClients" #define CALL_BLOBVARS "rpcBLOBServerVars" +#define CALL_BLOBSTATE "rpcBLOBServerState" #define CALL_SRVSHUTDOWN "rpcServerShutdown" #define CALL_SRVCLIENTS "rpcServerClients" @@ -47,8 +87,9 @@ typedef enum { } rpc_type_t; typedef enum { - disable, enable, - get, set, unset + disable, enable, kill, // for blob.state + ok, error, // for blob reply + get, set, unset // for blob request } cmd_type_t; /* RPC value */ @@ -59,7 +100,7 @@ typedef struct { union { uint8_t *buffer; int8_t *string; - void *blob; + uint32_t blob; size_t size; off_t offset; time_t datetime; @@ -107,11 +148,10 @@ typedef struct { if (val->val.string) { \ val->val_type = string; val->val_len = strlen(v) + 1; \ } } while (0) -#define RPC_SET_BLOB(vl, v, l) do { rpc_val_t *val = (vl); assert(val); val->val.blob = realloc(val->val.blob, l); \ - if (val->val.blob) { \ - val->val_type = blob; val->val_len = l; \ - memcpy(val->val.blob, v, l); \ - } } while (0) +#define RPC_SET_BLOB(vl, v, l) do { rpc_val_t *val = (vl); assert(val); val->val_type = blob; \ + val->val.blob = v; val->val_len = l; } while (0) +#define RPC_SET_BLOB2(vl, b) do { rpc_val_t *val = (vl); assert(val); assert(b); val->val_type = blob; \ + val->val.blob = b->blob_var; val->val_len = b->blob_len; } while (0) #define RPC_SET_SIZE(vl, v) do { rpc_val_t *val = (vl); assert(val); val->val_type = size; val->val.size = v; \ val->val_len = sizeof(size_t); } while (0) #define RPC_SET_OFF(vl, v) do { rpc_val_t *val = (vl); assert(val); val->val_type = offset; val->val.offset = v; \ @@ -148,23 +188,20 @@ typedef struct { free(val->val.string); \ val->val.string = NULL; \ } \ - if (val->val_type == blob && val->val.blob) { \ - free(val->val.blob); \ - val->val.blob = NULL; \ - } \ val->val_type = val->val_len = 0; \ } while (0) -#define RPC_CALLBACK_CHK_NUM_ARGS(f, n) do { \ - if (f->func_args != n) { \ - rpc_SetErr(22, "Error:: different number of arguments!\n"); \ +#define RPC_CALLBACK_CHECK_INPUT(x) do { \ + if (!x) { \ + rpc_SetErr(22, "Error:: invalid callback parameters ...\n"); \ return -1; \ } \ } while (0) -#define RPC_CALLBACK_CHECK_INPUT(s, f) do { \ - if (!s || !f) { \ - rpc_SetErr(22, "Error:: invalid callback parameters ...\n"); \ +#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"); \ return -1; \ } \ } while (0) @@ -189,8 +226,9 @@ typedef struct tagRPCFunc { int8_t func_name[UCHAR_MAX + 1]; int8_t func_args; - rpc_val_t *func_vals; + rpc_val_t *func_vars; + void *func_parent; struct tagRPCFunc *func_next; } rpc_func_t; @@ -221,15 +259,16 @@ struct tagBLOBHdr { rpc_sess_t hdr_session; uint8_t hdr_cmd; uint32_t hdr_var; - uint32_t hdr_seq; uint32_t hdr_len; + uint32_t hdr_ret; } __packed; /* Network RPC client & server elements */ typedef struct { struct sockaddr cli_sa; // host info - int cli_sock; // socket + int cli_sock; // socket fd + int cli_type; // socket type pthread_t cli_tid; // TID of thread void *cli_parent; // pointer to parent rpc_srv_t for server or to rpc_sess_t for client @@ -256,9 +295,10 @@ typedef struct { rpc_func_t *srv_funcs; // registered functions list pthread_mutex_t srv_mtx; + cmd_type_t srv_kill; struct { - int state; // BLOB server state: ==0 disable | !=0 enable + cmd_type_t state; // BLOB server state: ==0 disable | !=0 enable char dir[UCHAR_MAX + 1]; rpc_cli_t server; // BLOB server socket @@ -271,17 +311,24 @@ typedef struct { } rpc_srv_t; -typedef int (*rpc_callback_t)(void * const, rpc_func_t *, int, rpc_val_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 + * @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, rpc_val_t *); // ----------------------------------------------------------------------- /* Error support functions */ -// cli_GetErrno() Get error code of last operation -inline int cli_GetErrno(); -// cli_GetError() Get error text of last operation -inline const char *cli_GetError(); +// 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 Server side functions */ @@ -291,13 +338,14 @@ inline const char *cli_GetError(); * @regProgID = ProgramID for authentication & recognition * @regProcID = ProcessID for authentication & recognition * @concurentClients = Concurent clients at same time to this server - * @family = Family socket type, AF_INET or AF_INET6 - * @csHost = Host name or IP address for bind server, if NULL any address + * @sockType = Socket type, like SOCK_STREAM, SOCK_DGRAM or SOCK_RAW + * @family = Family type, AF_INET, AF_INET6 or AF_LOCAL + * @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); + int sockType, u_short family, const char *csHost, u_short Port); /* * rpc_srv_endServer() Destroy RPC server, close all opened sockets and free resources * @srv = RPC Server instance @@ -313,11 +361,13 @@ int rpc_srv_execServer(rpc_srv_t * __restrict srv); /* * rpc_srv_initBLOBServer() Init & create BLOB Server + * @srv = RPC server instance + * @sockType = Socket type, like SOCK_STREAM, SOCK_DGRAM or SOCK_RAW * @Port = Port for bind server, if Port == 0 default port is selected * @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, int sockType, u_short Port, const char *diskDir); /* * rpc_srv_endBLOBServer() Destroy BLOB server, close all opened sockets and free resources * @srv = RPC Server instance @@ -332,19 +382,11 @@ void rpc_srv_endBLOBServer(rpc_srv_t * __restrict srv) int rpc_srv_execBLOBServer(rpc_srv_t * __restrict srv); /* - * rpc_srv_getBLOB() Get registered BLOB - * @srv = RPC Server instance - * @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_srv_registerCall() Register call to RPC server * @srv = RPC Server instance * @csModule = Module name, if NULL self binary * @csFunc = Function name - * @args = Number of function arguments + * @args = Number of return function arguments, use for restriction case! * return: -1 error or 0 register ok */ int rpc_srv_registerCall(rpc_srv_t * __restrict srv, const char *csModule, const char *csFunc, @@ -375,52 +417,62 @@ 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 - * @data = RPC const data * @call = Register RPC call * @rpc = IN RPC call structure * @args = IN RPC call array of rpc values * return: -1 error, !=-1 ok */ -int rpc_srv_execCall(void * const data, rpc_func_t * __restrict call, - struct tagRPCCall * __restrict rpc, rpc_val_t * __restrict args); +int rpc_srv_execCall(rpc_func_t * __restrict call, struct tagRPCCall * __restrict rpc, + rpc_val_t * __restrict args); /* - * rpc_srv_declValsCall() Declare return variables for RPC call + * rpc_srv_returnVars() Init return variables for RPC call and zeroed values + (for safe handling return values, use this!) * @call = RPC function call - * @return_vals = Number of return variables - * return: -1 error, !=-1 ok + * @varnum = Number of return variables + * return: NULL error, !=NULL array with return values for RPC call with varnum items */ -inline int rpc_srv_declValsCall(rpc_func_t * __restrict call, int return_vals); +inline rpc_val_t *rpc_srv_returnVars(rpc_func_t * __restrict call, int varnum); /* - * rpc_srv_freeValsCall() Free return variables for RPC call + * rpc_srv_allocVars() Allocate array for call variables, + if already allocated memory for RPC call reallocate used space * @call = RPC function call - * return: none + * @varnum = Number of variables, if ==0 free previous allocated variables + * return: -1 error, !=-1 return varnum value */ -inline void rpc_srv_freeValsCall(rpc_func_t * __restrict call); +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_copyValsCall() Copy return variables for RPC call to new variable + * rpc_srv_zeroVars() Clean values from variables of RPC call * @call = RPC function call - * @newvals = New allocated variables array, must be free after use - * return: -1 error, !=-1 Returned number of copied RPC variables + * return: -1 error, !=-1 Returned number of cleaned RPC variables */ -inline int rpc_srv_copyValsCall(rpc_func_t * __restrict call, rpc_val_t ** __restrict newvals); +inline int rpc_srv_zeroVars(rpc_func_t * __restrict call); /* - * rpc_srv_delValsCall() Clean values from return variables of RPC call + * rpc_srv_copyVars() Copy variables for RPC call to new variable array * @call = RPC function call - * return: -1 error, !=-1 Returned number of cleaned RPC variables + * @newvars = New allocated variables array, must be free after use + * return: -1 error, !=-1 Returned number of copied RPC variables */ -inline int rpc_srv_delValsCall(rpc_func_t * __restrict call); +inline int rpc_srv_copyVars(rpc_func_t * __restrict call, rpc_val_t ** __restrict newvars); /* - * rpc_srv_getValsCall() Get return variables for RPC call + * rpc_srv_getVars() Get variables array for RPC call * @call = RPC function call - * @vals = Returned variables, may be NULL + * @vars = Returned variables array, may be NULL * return: -1 error, !=-1 Number of returned variables */ -inline int rpc_srv_getValsCall(rpc_func_t * __restrict call, rpc_val_t ** __restrict vals); +inline int rpc_srv_getVars(rpc_func_t * __restrict call, rpc_val_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 + */ +inline rpc_blob_t *rpc_srv_blobCreate(rpc_srv_t * __restrict srv, int len); +/* * rpc_srv_blobMap() Map blob to memory region * @srv = RPC Server instance * @blob = Map to this BLOB element @@ -441,20 +493,91 @@ 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 + * @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 + * @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 + * @srv = RPC Server instance + * @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_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 + * @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); + +/* + * 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, rpc_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, rpc_val_t * __restrict var, void ** 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, rpc_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, rpc_val_t * __restrict var, void ** data); + + + /* RPC Client side functions */ /* * rpc_cli_openClient() Connect to RPC Server * @ProgID = ProgramID for RPC session request * @ProcID = ProcessID for RPC session request + * @sockType = Socket type, like SOCK_STREAM, SOCK_DGRAM or SOCK_RAW * @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(u_int ProgID, u_int ProcID, int sockType, + u_short family, const char *csHost, u_short Port); /* * rpc_cli_closeClient() Close connection to RPC server and free resources * @cli = RPC Client session @@ -481,6 +604,22 @@ int rpc_cli_execCall(rpc_cli_t *cli, const char *csMod * return: none */ inline void rpc_cli_freeVals(int args, rpc_val_t *vals); + + +/* + * rpc_cli_openBLOBClient() Connect to BLOB Server + * @rpccli = RPC Client session + * @sockType = Socket type, like SOCK_STREAM, SOCK_DGRAM or SOCK_RAW + * @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, int sockType, u_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