--- libaitrpc/inc/aitrpc.h 2011/08/29 22:37:06 1.3 +++ libaitrpc/inc/aitrpc.h 2011/11/03 14:28:48 1.4.2.6 @@ -3,7 +3,7 @@ * by Michael Pounov * * $Author: misho $ -* $Id: aitrpc.h,v 1.3 2011/08/29 22:37:06 misho Exp $ +* $Id: aitrpc.h,v 1.4.2.6 2011/11/03 14:28:48 misho Exp $ * ************************************************************************** The ELWIX and AITNET software is distributed under the following @@ -56,9 +56,10 @@ SUCH DAMAGE. #include #endif #include +#include -#define RPC_VERSION 1 +#define RPC_VERSION 2 #define RPC_DEFPORT 2611 @@ -78,130 +79,23 @@ SUCH DAMAGE. /* RPC types */ typedef enum { - empty, // empty -> variable is not set - buffer, string, blob, // buffer -> uint8_t*; string -> int8_t*; blob -> void*(+socket); - size, offset, datetime, // size -> size_t; offset -> off_t; datetime -> time_t; - real, bigreal, // real -> float; bigreal -> double; - u8, u16, u32, u64, // unsigned integers ... - i8, i16, i32, i64 // integers ... -} rpc_type_t; - -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, /* for blob reply */ + get, set, unset /* for blob request */ } cmd_type_t; -/* RPC value */ -typedef struct { - rpc_type_t val_type; - size_t val_len; - union { - uint8_t *buffer; - int8_t *string; - uint32_t blob; - size_t size; - off_t offset; - time_t datetime; - float real; - double bigreal; - uint8_t u8; - uint16_t u16; - uint32_t u32; - uint64_t u64; - int8_t i8; - int16_t i16; - int32_t i32; - int64_t i64; - } val; -} __packed rpc_val_t; - -#define RPC_TYPE_VAL(vl) ((vl)->val_type) -#define RPC_LEN_VAL(vl) ((vl)->val_len) -#define RPC_BLOB_CHUNKS(vl, n) ((vl)->val_len / (n) + ((vl)->val_len % (n)) ? 1 : 0) -#define RPC_EMPTY_VAL(vl) ((vl)->val_type == empty) - -#define RPC_GET_BUF(vl) (assert((vl)->val_type == buffer), (vl)->val.buffer) -#define RPC_GET_STR(vl) (assert((vl)->val_type == string), (vl)->val.string) -#define RPC_GET_BLOB(vl) (assert((vl)->val_type == blob), (vl)->val.blob) -#define RPC_GET_SIZE(vl) (assert((vl)->val_type == size), (vl)->val.size) -#define RPC_GET_OFF(vl) (assert((vl)->val_type == offset), (vl)->val.offset) -#define RPC_GET_TIME(vl) (assert((vl)->val_type == datetime), (vl)->val.datetime) -#define RPC_GET_REAL(vl) (assert((vl)->val_type == real), (vl)->val.real) -#define RPC_GET_BREAL(vl) (assert((vl)->val_type == bigreal), (vl)->val.bigreal) -#define RPC_GET_U8(vl) (assert((vl)->val_type == u8), (vl)->val.u8) -#define RPC_GET_U16(vl) (assert((vl)->val_type == u16), (vl)->val.u16) -#define RPC_GET_U32(vl) (assert((vl)->val_type == u32), (vl)->val.u32) -#define RPC_GET_U64(vl) (assert((vl)->val_type == u64), (vl)->val.u64) -#define RPC_GET_I8(vl) (assert((vl)->val_type == i8), (vl)->val.i8) -#define RPC_GET_I16(vl) (assert((vl)->val_type == i16), (vl)->val.i16) -#define RPC_GET_I32(vl) (assert((vl)->val_type == i32), (vl)->val.i32) -#define RPC_GET_I64(vl) (assert((vl)->val_type == i64), (vl)->val.i64) - -#define RPC_SET_BUF(vl, v, l) do { rpc_val_t *val = (vl); assert(val); val->val.buffer = malloc(l); \ - if (val->val.buffer) { \ - val->val_type = buffer; val->val_len = l; \ - memcpy(val->val.buffer, v, l); \ - } } while (0) -#define RPC_SET_STR(vl, v) do { rpc_val_t *val = (vl); assert(val); val->val.string = (int8_t*) strdup(v); \ - 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_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; \ - val->val_len = sizeof(off_t); } while (0) -#define RPC_SET_TIME(vl, v) do { rpc_val_t *val = (vl); assert(val); val->val_type = datetime; val->val.datetime = v; \ - val->val_len = sizeof(time_t); } while (0) -#define RPC_SET_REAL(vl, v) do { rpc_val_t *val = (vl); assert(val); val->val_type = real; val->val.real = v; \ - val->val_len = sizeof(float); } while (0) -#define RPC_SET_BREAL(vl, v) do { rpc_val_t *val = (vl); assert(val); val->val_type = bigreal; val->val.bigreal = v; \ - val->val_len = sizeof(double); } while (0) -#define RPC_SET_U8(vl, v) do { rpc_val_t *val = (vl); assert(val); val->val_type = u8; val->val.u8 = v; \ - val->val_len = sizeof(uint8_t); } while (0) -#define RPC_SET_U16(vl, v) do { rpc_val_t *val = (vl); assert(val); val->val_type = u16; val->val.u16 = v; \ - val->val_len = sizeof(uint16_t); } while (0) -#define RPC_SET_U32(vl, v) do { rpc_val_t *val = (vl); assert(val); val->val_type = u32; val->val.u32 = v; \ - val->val_len = sizeof(uint32_t); } while (0) -#define RPC_SET_U64(vl, v) do { rpc_val_t *val = (vl); assert(val); val->val_type = u64; val->val.u64 = v; \ - val->val_len = sizeof(uint64_t); } while (0) -#define RPC_SET_I8(vl, v) do { rpc_val_t *val = (vl); assert(val); val->val_type = i8; val->val.i8 = v; \ - val->val_len = sizeof(int8_t); } while (0) -#define RPC_SET_I16(vl, v) do { rpc_val_t *val = (vl); assert(val); val->val_type = i16; val->val.i16 = v; \ - val->val_len = sizeof(int16_t); } while (0) -#define RPC_SET_I32(vl, v) do { rpc_val_t *val = (vl); assert(val); val->val_type = i32; val->val.i32 = v; \ - val->val_len = sizeof(int32_t); } while (0) -#define RPC_SET_I64(vl, v) do { rpc_val_t *val = (vl); assert(val); val->val_type = i64; val->val.i64 = v; \ - val->val_len = sizeof(int64_t); } while (0) - -#define RPC_FREE_VAL(vl) do { rpc_val_t *val = (vl); assert(val); \ - if (val->val_type == buffer && val->val.buffer) { \ - free(val->val.buffer); \ - val->val.buffer = NULL; \ - } \ - if (val->val_type == string && val->val.string) { \ - free(val->val.string); \ - val->val.string = NULL; \ - } \ - val->val_type = val->val_len = 0; \ - } while (0) - - -#define RPC_CALLBACK_CHECK_INPUT(x) do { \ - if (!x) { \ +#define RPC_CALLBACK_CHECK_INPUT(_f) do { \ + assert((_f)); \ + if (!(_f)) { \ rpc_SetErr(22, "Error:: invalid callback parameters ...\n"); \ 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"); \ +#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"); \ return -1; \ } \ } while (0) @@ -222,11 +116,10 @@ typedef struct { typedef struct tagRPCFunc { uint16_t func_tag; uint32_t func_hash; - int8_t func_file[MAXPATHLEN]; - int8_t func_name[UCHAR_MAX + 1]; + char func_file[MAXPATHLEN]; + char func_name[UCHAR_MAX + 1]; - int8_t func_args; - rpc_val_t *func_vars; + array_t *func_vars; void *func_parent; struct tagRPCFunc *func_next; @@ -239,7 +132,7 @@ struct tagRPCCall { rpc_sess_t call_session; uint16_t call_tag; uint32_t call_hash; - uint8_t call_argc; + uint16_t call_argc; } __packed; /* Network RPC packet - Server response */ @@ -250,7 +143,7 @@ struct tagRPCRet { uint32_t ret_hash; int32_t ret_retcode; int32_t ret_errno; - uint8_t ret_argc; + uint16_t ret_argc; } __packed; /* Network BLOB packet - Header */ @@ -266,11 +159,12 @@ struct tagBLOBHdr { /* Network RPC client & server elements */ typedef struct { - struct sockaddr cli_sa; // host info + io_sockaddr_t cli_sa; // host info int cli_sock; // socket fd 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 + int cli_netbuf; // size of network buffer size } rpc_cli_t; @@ -287,6 +181,7 @@ typedef struct tagBLOB { 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_cli_t srv_server; // RPC server socket rpc_cli_t *srv_clients; // connected rpc client sockets @@ -317,7 +212,7 @@ typedef struct { * @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 *); +typedef int (*rpc_callback_t)(rpc_func_t *, int, array_t *); // ----------------------------------------------------------------------- @@ -330,6 +225,22 @@ inline int rpc_GetErrno(); inline const char *rpc_GetError(); +/* + * 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 + * @p = packet session + * @s = active session + * return: -1 error or 0 ok + */ +inline int rpc_addPktSession(rpc_sess_t *p, rpc_sess_t *s); + + /* RPC Server side functions */ /* @@ -337,25 +248,34 @@ inline const char *rpc_GetError(); * @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) * @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 netBuf, 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 + * @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 @@ -372,11 +292,19 @@ int rpc_srv_initBLOBServer(rpc_srv_t * __restrict srv, */ 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 @@ -387,7 +315,7 @@ int rpc_srv_execBLOBServer(rpc_srv_t * __restrict srv) * return: -1 error or 0 register ok */ int rpc_srv_registerCall(rpc_srv_t * __restrict srv, const char *csModule, const char *csFunc, - unsigned char args); + unsigned short args); /* * rpc_srv_unregisterCall() Unregister call from RPC server * @srv = RPC Server instance @@ -416,50 +344,46 @@ inline rpc_func_t *rpc_srv_getCall(rpc_srv_t * __restr * 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, - rpc_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!) + * rpc_srv_allocVars() Allocate array for call variables * @call = RPC function call - * @varnum = Number of return variables - * return: NULL error, !=NULL array with return values for RPC call with varnum items + * @varnum = Number of variables, if ==0 return already allocated variables number + * return: -1 error, !=-1 return varnum value */ -inline rpc_val_t *rpc_srv_returnVars(rpc_func_t * __restrict call, int varnum); +inline int rpc_srv_allocVars(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 + * rpc_srv_destroyVars() Destroy variables of array & array * @call = RPC function call - * @varnum = Number of variables, if ==0 free previous allocated variables - * return: -1 error, !=-1 return varnum value + * return: -1 error, !=-1 Returne remained variables */ -inline int rpc_srv_allocVars(rpc_func_t * __restrict call, int varnum); -#define rpc_srv_freeVars(_call) (assert((_call)), rpc_srv_allocVars((_call), 0)) +inline int rpc_srv_destroyVars(rpc_func_t * __restrict call); /* - * rpc_srv_zeroVars() Clean values from variables of RPC call + * rpc_srv_freeVars() Clean values from variables of array * @call = RPC function call - * return: -1 error, !=-1 Returned number of cleaned RPC variables + * return: -1 error, !=-1 Returned number of cleaned variables */ -inline int rpc_srv_zeroVars(rpc_func_t * __restrict call); +inline int rpc_srv_freeVars(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, rpc_val_t ** __restrict newvars); +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 */ -inline int rpc_srv_getVars(rpc_func_t * __restrict call, rpc_val_t ** __restrict vars); +inline int rpc_srv_getVars(rpc_func_t * __restrict call, array_t ** __restrict vars); /* @@ -527,6 +451,8 @@ int rpc_srv_sendBLOB(rpc_cli_t * __restrict cli, rpc_b */ 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 @@ -534,7 +460,7 @@ int rpc_srv_recvBLOB(rpc_cli_t * __restrict cli, rpc_b * @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); +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 @@ -542,14 +468,14 @@ int rpc_cli_sendBLOB(rpc_cli_t * __restrict cli, rpc_v * @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); +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, rpc_val_t * __restrict var); +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 @@ -557,7 +483,7 @@ int rpc_cli_delBLOB(rpc_cli_t * __restrict cli, rpc_va * @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); +inline int rpc_cli_getBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var, void ** __restrict data); @@ -567,12 +493,13 @@ inline int rpc_cli_getBLOB(rpc_cli_t * __restrict cli, * 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) * @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, +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 @@ -585,21 +512,12 @@ void rpc_cli_closeClient(rpc_cli_t * __restrict cli); * @cli = RPC Client session * @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, - rpc_val_t * __restrict in_vars, int *out_argc, rpc_val_t ** __restrict out_vars); -/* - * rpc_cli_freeVals() Free rpc_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, rpc_val_t *vars); +int rpc_cli_execCall(rpc_cli_t *cli, const char *csModule, const char *csFunc, + array_t * __restrict in_vars, array_t ** __restrict out_vars); /*