/*************************************************************************
* (C) 2010 AITNET ltd - Sofia/Bulgaria - <misho@aitbg.com>
* by Michael Pounov <misho@openbsd-bg.org>
*
* $Author: misho $
* $Id: aitrpc.h,v 1.1.1.1.2.22 2011/03/15 15:46:58 misho Exp $
*
*************************************************************************/
#ifndef __AITRPC_H
#define __AITRPC_H
#include <assert.h>
#include <stdlib.h>
#include <string.h>
#include <sys/types.h>
#include <sys/param.h>
#include <sys/limits.h>
#include <sys/socket.h>
#define RPC_VERSION 1
#define RPC_DEFPORT 2611
/* RPC builtin registed calls */
#define CALL_BLOBSHUTDOWN "rpcBLOBServerShutdown"
#define CALL_BLOBCLIENTS "rpcBLOBServerClients"
#define CALL_BLOBVARS "rpcBLOBServerVars"
#define CALL_BLOBSTATE "rpcBLOBServerState"
#define CALL_SRVSHUTDOWN "rpcServerShutdown"
#define CALL_SRVCLIENTS "rpcServerClients"
#define CALL_SRVCALLS "rpcServerCalls"
#define CALL_SRVSESSIONS "rpcServerSessions"
/* 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, // 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) { \
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"); \
return -1; \
} \
} while (0)
/* RPC session identification */
typedef struct {
uint8_t sess_version;
uint32_t sess_program;
uint32_t sess_process;
} __packed rpc_sess_t;
/* 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;
rpc_val_t *func_vals;
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 */
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;
/* 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;
} __packed;
/* Network RPC client & server elements */
typedef struct {
struct sockaddr cli_sa; // host info
int cli_sock; // socket
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
} rpc_cli_t;
// BLOB registration element!
typedef struct tagBLOB {
uint32_t blob_var;
size_t blob_len; // size of allocated BLOB data
void *blob_data; // BLOB data
struct tagBLOB *blob_next;
} rpc_blob_t;
typedef struct {
rpc_sess_t srv_session; // RPC session registration info
int srv_numcli; // maximum concurent client connections
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
pthread_mutex_t srv_mtx;
struct {
int state; // BLOB server state: ==0 disable | !=0 enable
char dir[UCHAR_MAX + 1];
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;
} rpc_srv_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 Server side functions */
/*
* 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 socket type, AF_INET or AF_INET6
* @csHost = Host name or IP 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_endServer() Destroy RPC server, close all opened sockets and free resources
* @srv = RPC Server instance
* return: none
*/
void rpc_srv_endServer(rpc_srv_t * __restrict srv);
/*
* rpc_srv_execServer() 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);
/*
* rpc_srv_initBLOBServer() Init & create BLOB Server
* @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);
/*
* 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
* @srv = RPC Server instance
* return: -1 error or 0 ok, infinite loop ...
*/
int rpc_srv_execBLOBServer(rpc_srv_t * __restrict srv);
/*
* 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
*/
int rpc_srv_registerCall(rpc_srv_t * __restrict srv, const char *csModule, const char *csFunc,
unsigned char args);
/*
* rpc_srv_unregisterCall() Unregister call from RPC server
* @srv = RPC Server instance
* @csModule = Module name, if NULL self binary
* @csFunc = Function name
* 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);
/*
* 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
* 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);
/*
* 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
* return: -1 error, !=-1 ok
*/
int rpc_srv_execCall(rpc_func_t * __restrict call, struct tagRPCCall * __restrict rpc,
rpc_val_t * __restrict args);
/*
* rpc_srv_retValsCall() Declare 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: NULL error, !=NULL array with return values for RPC call with return_vals items
*/
inline rpc_val_t *rpc_srv_retValsCall(rpc_func_t * __restrict call, int return_vals);
/*
* rpc_srv_declValsCall() Declare return variables for RPC call,
if already allocated memory for RPC call return values
function reallocate used space with return_vals count elements
* @call = RPC function call
* @return_vals = Number of return variables
* return: -1 error, !=-1 ok
*/
inline int rpc_srv_declValsCall(rpc_func_t * __restrict call, int return_vals);
/*
* rpc_srv_freeValsCall() Free return variables for RPC call
* @call = RPC function call
* return: none
*/
inline void rpc_srv_freeValsCall(rpc_func_t * __restrict call);
/*
* rpc_srv_copyValsCall() Copy return variables for RPC call to new variable
* @call = RPC function call
* @newvals = New allocated variables array, must be free after use
* return: -1 error, !=-1 Returned number of copied RPC variables
*/
inline int rpc_srv_copyValsCall(rpc_func_t * __restrict call, rpc_val_t ** __restrict newvals);
/*
* rpc_srv_zeroValsCall() Clean values from return variables of RPC call
* @call = RPC function call
* return: -1 error, !=-1 Returned number of cleaned RPC variables
*/
inline int rpc_srv_zeroValsCall(rpc_func_t * __restrict call);
/*
* rpc_srv_getValsCall() Get return variables for RPC call
* @call = RPC function call
* @vals = Returned variables, 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);
/*
* 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
* 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
* @blob = Mapped BLOB element
* return: none
*/
inline void rpc_srv_blobUnmap(rpc_blob_t * __restrict blob);
/*
* rpc_srv_blobFree() Free blob from disk & memory
* @srv = RPC Server instance
* @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);
/*
* 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
* @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_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
* @csModule = Module name, if NULL self binary
* @csFunc = Function name for execute
* @in_argc = IN count of arguments
* @in_vals = IN RPC call array of rpc values
* @out_argc = OUT returned count of arguments
* @out_vals = OUT returned array of rpc values, must be free after use (see 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_vals, int *out_argc, rpc_val_t ** __restrict out_vals);
/*
* rpc_cli_freeVals() Free rpc_val_t array returned from RPC call
* @args = Number of arguments in array
* @vals = Value elements
* return: none
*/
inline void rpc_cli_freeVals(int args, rpc_val_t *vals);
/*
* 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
* @cli = BLOB Client session
* return: none
*/
void rpc_cli_closeBLOBClient(rpc_cli_t * __restrict cli);
#endif
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>