--- libaitrpc/inc/aitrpc.h 2012/11/13 09:21:27 1.10.2.2 +++ libaitrpc/inc/aitrpc.h 2015/01/18 00:03:01 1.25.2.3 @@ -3,7 +3,7 @@ * by Michael Pounov * * $Author: misho $ -* $Id: aitrpc.h,v 1.10.2.2 2012/11/13 09:21:27 misho Exp $ +* $Id: aitrpc.h,v 1.25.2.3 2015/01/18 00:03:01 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, 2012 +Copyright 2004 - 2015 by Michael Pounov . All rights reserved. Redistribution and use in source and binary forms, with or without @@ -58,13 +58,26 @@ SUCH DAMAGE. #endif #include #include -#include +#include #include -#define RPC_VERSION 4 +#define RPC_VERSION 7 #define RPC_DEFPORT 2611 +/* Additional ELWIX RPC supporting protocols */ +#ifndef SOCK_STREAM +#define SOCK_STREAM 1 /* stream socket */ +#endif +#ifndef SOCK_DGRAM +#define SOCK_DGRAM 2 /* datagram socket */ +#endif +#ifndef SOCK_RAW +#define SOCK_RAW 3 /* raw-protocol interface */ +#endif +#define SOCK_BPF 4 /* ethernet interface */ +#define SOCK_EXT 5 /* bi-directional pipe interface */ + /* RPC call request flags */ #define RPC_REPLY 0x0 @@ -85,13 +98,15 @@ SUCH DAMAGE. #define CALL_BLOBCLIENTS 65528 #define CALL_BLOBVARS 65527 +/* RPC signals */ +#define SIGFBLOB 54 /* RPC types */ typedef enum { ok, error, no, /* for blob reply */ get, set, unset /* for blob request */ -} cmd_type_t; +} blob_cmd_type_t; #define RPC_CALLBACK_CHECK_INPUT(x) do { \ @@ -107,10 +122,15 @@ typedef enum { /* RPC session identification */ typedef struct { - uint8_t sess_version; - uint32_t sess_program; - uint8_t sess_process; -} __packed rpc_sess_t; /* size == 6 bytes */ +#if BYTE_ORDER == LITTLE_ENDIAN + uint16_t sess_instance:8; + uint16_t sess_version:8; +#endif +#if BYTE_ORDER == BIG_ENDIAN + uint16_t sess_version:8; + uint16_t sess_instance:8; +#endif +} __packed rpc_sess_t; /* size == 2 bytes */ /* Server managment RPC functions ... */ @@ -120,8 +140,7 @@ typedef struct { struct tagRPCCall { rpc_sess_t call_session; - uint16_t call_seq; - uint16_t call_len; + uint32_t call_len; uint16_t call_crc; union { @@ -137,8 +156,9 @@ struct tagRPCCall { uint16_t call_tag; uint16_t call_argc; ait_val_t call_argv[0]; -} __packed; /* size == 24 bytes */ -#define RPC_CHK_NOREPLY(x) ((x)->call_req.flags & RPC_NOREPLY) +} __packed; /* size == 20 bytes */ +#define RPC_CHK_NOREPLY(x) (ntohl((u_long) (x)->call_req.flags) & RPC_NOREPLY) +#define RPC_SET_ERRNO(x, _v) ((x)->call_rep.eno = htonl((_v))) /* Network BLOB packet - Header */ @@ -148,9 +168,8 @@ struct tagBLOBHdr { uint32_t hdr_var; uint32_t hdr_len; uint32_t hdr_ret; - uint16_t hdr_crc; uint8_t hdr_pad; -} __packed; /* size == 22 bytes */ +} __packed; /* size == 16 bytes */ /* Network RPC client & server elements */ @@ -191,7 +210,7 @@ typedef struct tagBLOB { typedef struct { int cli_id; /* slot id */ int cli_sock; /* socket fd */ - io_sockaddr_t cli_sa; /* host address */ + sockaddr_t cli_sa; /* host address */ ait_val_t cli_buf; /* network buffer */ array_t *cli_vars; /* function return variables */ @@ -205,6 +224,7 @@ typedef struct { typedef struct { rpc_sess_t srv_session; /* RPC session registration info */ int srv_netbuf; /* size of network buffer */ + int srv_proto; /* Server protocol */ pthread_t srv_tid; /* RPC exec pthread */ sched_root_task_t *srv_root; /* RPC server scheduler */ @@ -240,25 +260,59 @@ typedef struct { */ typedef int (*rpc_callback_t)(rpc_cli_t *, struct tagRPCCall *, array_t *); +#define RPC_CALL_DEFINE(x) int (x)(rpc_cli_t*, struct tagRPCCall*, array_t*) +#define RPC_CALL_ARGS(arg1, arg2, arg3) rpc_cli_t* arg1, struct tagRPCCall* arg2, array_t* arg3 +#define RPC_CALL_STDARGS RPC_CALL_ARGS(cli, rpc, iv) + /* ----------------------------------------------------------------------- */ /* Error support functions */ // rpc_GetErrno() Get error code of last operation -inline int rpc_GetErrno(); +int rpc_GetErrno(); // rpc_GetError() Get error text of last operation -inline const char *rpc_GetError(); +const char *rpc_GetError(); +// rpc_SetErr() Set error to variables for internal use!!! +void rpc_SetErr(int eno, char *estr, ...); + /* + * rpc_Read() - RPC read operation + * + * @sock = socket + * @type = type of socket + * @flags = receive flags + * @sa = check client address, if you use udp protocol + * @buf = buffer + * @blen = buffer length + * return: -1 error, 0 EOF or or >0 readed bytes into buffer + */ +ssize_t rpc_Read(int sock, int type, int flags, sockaddr_t * __restrict sa, + unsigned char * __restrict buf, size_t blen); +/* + * rpc_Write() - RPC write operation + * + * @sock = socket + * @type = type of socket + * @flags = send flags + * @sa = send to client address, if you use udp protocol + * @buf = buffer + * @blen = buffer length + * return: -1 error, 0 EOF or >0 written bytes into buffer + */ +ssize_t rpc_Write(int sock, int type, int flags, sockaddr_t * __restrict sa, + unsigned char * __restrict buf, size_t blen); + +/* * 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); +int rpc_chkPktSession(rpc_sess_t *p, rpc_sess_t *s); /* * rpc_addPktSession() - Prepare session into network format * @@ -266,14 +320,14 @@ inline int rpc_chkPktSession(rpc_sess_t *p, rpc_sess_t * @s = host session * return: -1 error or 0 ok */ -inline int rpc_addPktSession(rpc_sess_t *p, rpc_sess_t *s); +int rpc_addPktSession(rpc_sess_t *p, rpc_sess_t *s); /* * rpc_register_srvPing() - Register ping service function * * @srv = RPC server instance * return: -1 error or 0 ok */ -inline int rpc_register_srvPing(rpc_srv_t * __restrict srv); +int rpc_register_srvPing(rpc_srv_t * __restrict srv); /* * rpc_register_srvServices() - Register internal service functions * @@ -295,24 +349,23 @@ int rpc_register_blobServices(rpc_srv_t * __restrict s /* * rpc_srv_initServer() - Init & create RPC Server * - * @regProgID = ProgramID for authentication & recognition - * @regProcID = ProcessID for authentication & recognition + * @InstID = Instance for authentication & recognition * @concurentClients = Concurent clients at same time to this server * @netBuf = Network buffer length (min:512 bytes), 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 + * @proto = Protocol, if == 0 choose SOCK_STREAM * return: NULL == error or !=NULL bind and created RPC server instance */ -rpc_srv_t *rpc_srv_initServer(unsigned int regProgID, unsigned char regProcID, - int concurentClients, int netBuf, - const char *csHost, unsigned short Port); +rpc_srv_t *rpc_srv_initServer(unsigned char InstID, int concurentClients, int netBuf, + const char *csHost, unsigned short Port, int proto); /* * rpc_srv_endServer() - Destroy RPC server, close all opened sockets and free resources * * @psrv = RPC Server instance * return: none */ -inline void rpc_srv_endServer(rpc_srv_t ** __restrict psrv); +void rpc_srv_endServer(rpc_srv_t ** __restrict psrv); /* * rpc_srv_loopServer() - Execute Main server loop and wait for clients requests * @@ -320,15 +373,18 @@ inline void rpc_srv_endServer(rpc_srv_t ** __restrict * return: -1 error or 0 ok, infinite loop ... */ int rpc_srv_loopServer(rpc_srv_t * __restrict srv); -#define rpc_srv_execServer(_srv, _sync) do { assert((_srv)); \ - if (!(_srv)->srv_kill) { \ - pthread_create(&(_srv)->srv_tid, NULL, (void*(*)(void*)) \ - rpc_srv_loopServer, (_srv)); \ - if ((_sync)) \ - pthread_join((_srv)->srv_tid, (void**) (_sync)); \ - else \ - pthread_detach((_srv)->srv_tid); \ - } } while (0) +#define rpc_srv_execServer(_srv, _sync) \ + do { assert((_srv)); \ + if (!(_srv)->srv_kill) { \ + pthread_create(&(_srv)->srv_tid, NULL, (void*(*)(void*)) \ + rpc_srv_loopServer, (_srv)); \ + if ((_sync)) \ + pthread_join((_srv)->srv_tid, (void**) (_sync)); \ + else \ + pthread_detach((_srv)->srv_tid); \ + } } while (0) +#define rpc_srv_killServer(_srv) \ + (assert((_srv)), (_srv)->srv_blob.kill = 1, (_srv)->srv_kill = 1) /* * rpc_srv_initBLOBServer() - Init & create BLOB Server @@ -345,7 +401,7 @@ int rpc_srv_initBLOBServer(rpc_srv_t * __restrict srv, * @srv = RPC Server instance * return: none */ -inline void rpc_srv_endBLOBServer(rpc_srv_t * __restrict srv); +void rpc_srv_endBLOBServer(rpc_srv_t * __restrict srv); /* * rpc_srv_loopBLOB() - Execute Main BLOB server loop and wait for clients requests * @@ -353,16 +409,38 @@ inline void rpc_srv_endBLOBServer(rpc_srv_t * __restri * return: -1 error or 0 ok, infinite loop ... */ int rpc_srv_loopBLOBServer(rpc_srv_t * __restrict srv); -#define rpc_srv_execBLOBServer(_srv) do { assert((_srv)); \ - if (!(_srv)->srv_kill && !(_srv)->srv_blob.kill) { \ - pthread_create(&(_srv)->srv_blob.tid, NULL, \ - (void*(*)(void*)) \ - rpc_srv_loopBLOBServer, (_srv)); \ - pthread_detach((_srv)->srv_blob.tid); \ - } \ - } while (0) +#define rpc_srv_execBLOBServer(_srv) \ + do { assert((_srv)); \ + if (!(_srv)->srv_kill && !(_srv)->srv_blob.kill) { \ + pthread_create(&(_srv)->srv_blob.tid, NULL, \ + (void*(*)(void*)) rpc_srv_loopBLOBServer, (_srv)); \ + pthread_detach((_srv)->srv_blob.tid); \ + } \ + } while (0) /* + * rpc_srv_initServer2() - Init & create layer2 RPC Server + * + * @InstID = Instance for authentication & recognition + * @concurentClients = Concurent clients at same time to this server + * @netBuf = Network buffer length (min:512 bytes), if =0 == BUFSIZ (also meaning max RPC packet) + * @csIface = Interface name for bind server, if NULL first interface on host + * return: NULL == error or !=NULL bind and created RPC server instance + */ +rpc_srv_t *rpc_srv_initServer2(u_char InstID, int concurentClients, int netBuf, + const char *csIface); + +/* + * rpc_srv_initServerExt() - Init & create pipe RPC Server + * + * @InstID = Instance for authentication & recognition + * @netBuf = Network buffer length (min:512 bytes), if =0 == BUFSIZ (also meaning max RPC packet) + * @fd = File descriptor + * return: NULL == error or !=NULL bind and created RPC server instance + */ +rpc_srv_t *rpc_srv_initServerExt(u_char InstID, int netBuf, int fd); + +/* * rpc_srv_registerCall() - Register call to RPC server * * @srv = RPC Server instance @@ -386,7 +464,7 @@ int rpc_srv_unregisterCall(rpc_srv_t * __restrict srv, * @tag = tag 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); +rpc_func_t *rpc_srv_getCall(rpc_srv_t * __restrict srv, uint16_t tag); /* * rpc_srv_execCall() Execute registered call from RPC server * @@ -405,9 +483,10 @@ int rpc_srv_execCall(rpc_cli_t * __restrict cli, struc * * @srv = RPC Server instance * @len = BLOB length object + * @tout = BLOB live timeout in seconds * return: NULL error or !=NULL allocated BLOB object */ -inline rpc_blob_t *rpc_srv_blobCreate(rpc_srv_t * __restrict srv, int len); +rpc_blob_t *rpc_srv_blobCreate(rpc_srv_t * __restrict srv, int len, int tout); /* * rpc_srv_blobMap() - Map blob to memory region * @@ -415,14 +494,14 @@ inline rpc_blob_t *rpc_srv_blobCreate(rpc_srv_t * __re * @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); +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); +void rpc_srv_blobUnmap(rpc_blob_t * __restrict blob); /* * rpc_srv_blobFree() - Free blob from disk & memory * @@ -430,16 +509,17 @@ inline void rpc_srv_blobUnmap(rpc_blob_t * __restrict * @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); +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 + * @tout = BLOB live timeout in seconds * return: NULL error or new registered BLOB */ -rpc_blob_t *rpc_srv_registerBLOB(rpc_srv_t * __restrict srv, size_t len); +rpc_blob_t *rpc_srv_registerBLOB(rpc_srv_t * __restrict srv, size_t len, int tout); /* * rpc_srv_unregisterBLOB() - Unregister BLOB from server * @@ -455,7 +535,7 @@ int rpc_srv_unregisterBLOB(rpc_srv_t * __restrict srv, * @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_blob_t *rpc_srv_getBLOB(rpc_srv_t * __restrict srv, uint32_t var); /* * rpc_srv_sendBLOB() - Send mapped BLOB to client @@ -482,15 +562,17 @@ int rpc_srv_recvBLOB(rpc_cli_t * __restrict cli, rpc_b * @cli = Client instance * @var = BLOB variable * @data = BLOB data + * @tout = BLOB live on server timeout in seconds, if =0 default timeout * return: -1 error, 0 ok, 1 remote error */ -int rpc_cli_sendBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var, void * __restrict data); +int rpc_cli_sendBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var, + void * __restrict data, int tout); /* * rpc_cli_recvBLOB() - Receive BLOB from server * * @cli = Client instance * @var = BLOB variable - * @data = BLOB data, must be io_free after use! + * @data = BLOB data, must be e_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 ** __restrict data); @@ -507,10 +589,10 @@ int rpc_cli_delBLOB(rpc_cli_t * __restrict cli, ait_va * * @cli = Client instance * @var = BLOB variable - * @data = BLOB data, must be io_free after use! + * @data = BLOB data, must be e_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, +int rpc_cli_getBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var, void ** __restrict data); @@ -519,16 +601,23 @@ 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 + * @InstID = InstID for RPC session request * @netBuf = Network buffer length (min:512 bytes), if =0 == BUFSIZ (also meaning max RPC packet) * @csHost = Host name or IP address for bind server * @Port = Port for bind server, if Port == 0 default port is selected + * @proto = Protocol, if == 0 choose SOCK_STREAM * return: NULL == error or !=NULL connection to RPC server established */ -rpc_cli_t *rpc_cli_openClient(unsigned int ProgID, unsigned char ProcID, int netBuf, - const char *csHost, unsigned short Port); +rpc_cli_t *rpc_cli_openClient(unsigned char InstID, int netBuf, + const char *csHost, unsigned short Port, int proto); /* + * rpc_cli_reconnectClient() - Reconnecting client to RPC server + * + * @cli = RPC Client session + * return: -1 error or 0 ok + */ +int rpc_cli_reconnectClient(rpc_cli_t * __restrict cli); +/* * rpc_cli_closeClient() - Close connection to RPC server and free resources * * @cli = RPC Client session @@ -536,14 +625,62 @@ rpc_cli_t *rpc_cli_openClient(unsigned int ProgID, uns */ void rpc_cli_closeClient(rpc_cli_t ** __restrict cli); /* + * rpc_pkt_Send() - Send RPC packet + * + * @sock = Socket + * @type = Type of socket + * @sa = Server address + * @pkt = RPC packet + * @len = Length of packet + * return: -1 error, 0 EOF or >0 sended bytes + */ +int rpc_pkt_Send(int sock, int type, sockaddr_t * __restrict sa, + ait_val_t * __restrict pkt, int len); +/* + * rpc_pkt_Receive() - Receive RPC packet + * + * @sock = Socket + * @type = Type of socket + * @sa = Server address + * @pkt = RPC packet + * return: -1 error, 0 EOF or >0 received bytes + */ +int rpc_pkt_Receive(int sock, int type, sockaddr_t * __restrict sa, + ait_val_t * __restrict pkt); +/* + * rpc_pkt_Request() - Build RPC Request packet + * + * @pkt = Packet buffer + * @sess = RPC session info + * @tag = Function tag for execution + * @vars = Function argument array of values, may be NULL + * @noreply = We not want RPC reply + * @nocrc = Without CRC calculation + * return: -1 error or != -1 prepared bytes into packet + */ +int rpc_pkt_Request(ait_val_t * __restrict pkt, rpc_sess_t * __restrict sess, + unsigned short tag, array_t * __restrict vars, int noreply, int nocrc); +/* + * rpc_pkt_Replay() - Decode RPC Replay packet + * + * @pkt = Packet buffer + * @sess = RPC session info, if =NULL don't check session + * @tag = Function tag + * @vars = Function argument array of values, may be NULL + * @nocrc = Without CRC calculation + * return: -1 error or != -1 return value from function + */ +int rpc_pkt_Replay(ait_val_t * __restrict pkt, rpc_sess_t * __restrict sess, + unsigned short tag, array_t ** __restrict vars, int nocrc); +/* * rpc_cli_execCall() - Execute RPC call * * @cli = RPC Client session * @noreply = We not want RPC reply * @tag = Function tag for execution - * @in_vars = IN RPC call array of rpc values, may be NULL - * @out_vars = OUT returned array of rpc values, if !=NULL must be free after use with io_freeVars() - * return: -1 error or != -1 ok result + * @in_vars = IN function argument array of values, may be NULL + * @out_vars = OUT returned array of rpc values, if !=NULL must be free after use with ait_freeVars() + * return: -1 error, 0 ok result or 1 closed rpc connection */ int rpc_cli_execCall(rpc_cli_t *cli, int noreply, unsigned short tag, array_t * __restrict in_vars, array_t ** __restrict out_vars); @@ -553,14 +690,14 @@ int rpc_cli_execCall(rpc_cli_t *cli, int noreply, unsi * @out_vars = Returned array with variables from RPC call * return: none */ -inline void rpc_cli_freeCall(array_t ** __restrict out_vars); +void rpc_cli_freeCall(array_t ** __restrict out_vars); /* * rpc_cli_ping() - Ping RPC server * * @cli = connected client * return: -1 error or !=-1 ping seq id */ -inline int rpc_cli_ping(rpc_cli_t *cli); +int rpc_cli_ping(rpc_cli_t *cli); /* @@ -578,6 +715,26 @@ rpc_cli_t *rpc_cli_openBLOBClient(rpc_cli_t * __restri * return: none */ void rpc_cli_closeBLOBClient(rpc_cli_t ** __restrict cli); + + +/* + * rpc_cli_openClient2() - Connect to layer2 RPC Server + * + * @InstID = InstID for RPC session request + * @netBuf = Network buffer length (min:512 bytes), if =0 == BUFSIZ (also meaning max RPC packet) + * @csIface = Interface name for bind client, if NULL first interface on host + * @csHost = Host ethernet address + * return: NULL == error or !=NULL connection to RPC server established + */ +rpc_cli_t *rpc_cli_openClient2(u_char InstID, int netBuf, + const char *csIface, const char *csHost); +/* + * rpc_cli_closeClient2() - Close layer2 connection to RPC server and free resources + * + * @cli = RPC Client session + * return: none + */ +void rpc_cli_closeClient2(rpc_cli_t ** __restrict cli); #endif