Annotation of libaitrpc/inc/aitrpc.h, revision 1.5.2.1
1.1 misho 1: /*************************************************************************
2: * (C) 2010 AITNET ltd - Sofia/Bulgaria - <misho@aitbg.com>
3: * by Michael Pounov <misho@openbsd-bg.org>
4: *
5: * $Author: misho $
1.5.2.1 ! misho 6: * $Id: aitrpc.h,v 1.5 2011/11/03 15:32:21 misho Exp $
1.1 misho 7: *
1.2 misho 8: **************************************************************************
9: The ELWIX and AITNET software is distributed under the following
10: terms:
11:
12: All of the documentation and software included in the ELWIX and AITNET
13: Releases is copyrighted by ELWIX - Sofia/Bulgaria <info@elwix.org>
14:
1.5.2.1 ! misho 15: Copyright 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012
1.2 misho 16: by Michael Pounov <misho@elwix.org>. All rights reserved.
17:
18: Redistribution and use in source and binary forms, with or without
19: modification, are permitted provided that the following conditions
20: are met:
21: 1. Redistributions of source code must retain the above copyright
22: notice, this list of conditions and the following disclaimer.
23: 2. Redistributions in binary form must reproduce the above copyright
24: notice, this list of conditions and the following disclaimer in the
25: documentation and/or other materials provided with the distribution.
26: 3. All advertising materials mentioning features or use of this software
27: must display the following acknowledgement:
28: This product includes software developed by Michael Pounov <misho@elwix.org>
29: ELWIX - Embedded LightWeight unIX and its contributors.
30: 4. Neither the name of AITNET nor the names of its contributors
31: may be used to endorse or promote products derived from this software
32: without specific prior written permission.
33:
34: THIS SOFTWARE IS PROVIDED BY AITNET AND CONTRIBUTORS ``AS IS'' AND
35: ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
36: IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
37: ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
38: FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
39: DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
40: OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
41: HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
42: LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
43: OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
44: SUCH DAMAGE.
45: */
1.1 misho 46: #ifndef __AITRPC_H
47: #define __AITRPC_H
48:
49:
50: #include <assert.h>
51: #include <stdlib.h>
52: #include <string.h>
1.5.2.1 ! misho 53: #include <errno.h>
1.1 misho 54: #include <sys/types.h>
55: #include <sys/param.h>
1.2 misho 56: #if !defined(__NetBSD__)
1.1 misho 57: #include <sys/limits.h>
1.2 misho 58: #endif
1.1 misho 59: #include <sys/socket.h>
1.4 misho 60: #include <aitio.h>
1.1 misho 61:
62:
1.5.2.1 ! misho 63: #define RPC_VERSION 3
1.1 misho 64: #define RPC_DEFPORT 2611
65:
66:
67: /* RPC builtin registed calls */
68:
1.2 misho 69: #define CALL_BLOBSHUTDOWN "rpcBLOBServerShutdown"
70: #define CALL_BLOBCLIENTS "rpcBLOBServerClients"
71: #define CALL_BLOBVARS "rpcBLOBServerVars"
72: #define CALL_BLOBSTATE "rpcBLOBServerState"
73:
74: #define CALL_SRVSHUTDOWN "rpcServerShutdown"
1.1 misho 75: #define CALL_SRVCLIENTS "rpcServerClients"
76: #define CALL_SRVCALLS "rpcServerCalls"
77: #define CALL_SRVSESSIONS "rpcServerSessions"
78:
79:
80: /* RPC types */
81:
82: typedef enum {
1.4 misho 83: disable, enable, running, kill, /* for blob.state */
84: ok, error, /* for blob reply */
85: get, set, unset /* for blob request */
1.2 misho 86: } cmd_type_t;
87:
1.1 misho 88:
1.4 misho 89: #define RPC_CALLBACK_CHECK_INPUT(_f) do { \
90: assert((_f)); \
91: if (!(_f)) { \
1.5.2.1 ! misho 92: rpc_SetErr(EINVAL, \
! 93: "Invalid callback parameters ..."); \
1.2 misho 94: return -1; \
95: } \
96: } while (0)
1.4 misho 97: #define RPC_CALLBACK_CHK_ARGS(_f, _n) do { \
98: RPC_CALLBACK_CHECK_INPUT((_f)); \
1.5 misho 99: if ((_f) && io_arraySize((_f)->func_vars) < _n) { \
1.5.2.1 ! misho 100: rpc_SetErr(EINVAL, \
! 101: "Not enough number of arguments!"); \
1.1 misho 102: return -1; \
103: } \
1.2 misho 104: } while (0)
1.1 misho 105:
106:
107: /* RPC session identification */
108:
109: typedef struct {
110: uint8_t sess_version;
1.5.2.1 ! misho 111: uint8_t sess_timeout;
1.1 misho 112: uint32_t sess_program;
113: uint32_t sess_process;
114: } __packed rpc_sess_t;
115:
116:
117: /* Server managment RPC functions ... */
118:
1.5.2.1 ! misho 119: /* RPC function registration element! */
1.1 misho 120: typedef struct tagRPCFunc {
121: uint16_t func_tag;
122: uint32_t func_hash;
1.5 misho 123: char func_file[MAXPATHLEN];
124: char func_name[UCHAR_MAX + 1];
1.1 misho 125:
1.4 misho 126: array_t *func_vars;
1.1 misho 127:
1.2 misho 128: void *func_parent;
1.1 misho 129: struct tagRPCFunc *func_next;
130: } rpc_func_t;
131:
132:
133: /* Network RPC packet - Client request */
134:
135: struct tagRPCCall {
136: rpc_sess_t call_session;
137: uint16_t call_tag;
138: uint32_t call_hash;
1.4 misho 139: uint16_t call_argc;
1.1 misho 140: } __packed;
141:
142: /* Network RPC packet - Server response */
143:
144: struct tagRPCRet {
145: rpc_sess_t ret_session;
146: uint16_t ret_tag;
147: uint32_t ret_hash;
148: int32_t ret_retcode;
149: int32_t ret_errno;
1.4 misho 150: uint16_t ret_argc;
1.1 misho 151: } __packed;
152:
1.2 misho 153: /* Network BLOB packet - Header */
154:
155: struct tagBLOBHdr {
156: rpc_sess_t hdr_session;
157: uint8_t hdr_cmd;
158: uint32_t hdr_var;
159: uint32_t hdr_len;
160: uint32_t hdr_ret;
161: } __packed;
162:
1.1 misho 163: /* Network RPC client & server elements */
164:
165: typedef struct {
1.5 misho 166: io_sockaddr_t cli_sa; // host info
1.3 misho 167: int cli_sock; // socket fd
1.1 misho 168: pthread_t cli_tid; // TID of thread
169:
170: void *cli_parent; // pointer to parent rpc_srv_t for server or to rpc_sess_t for client
1.4 misho 171: int cli_netbuf; // size of network buffer size
1.1 misho 172: } rpc_cli_t;
173:
1.2 misho 174:
1.5.2.1 ! misho 175: /* BLOB registration element! */
1.2 misho 176: typedef struct tagBLOB {
177: uint32_t blob_var;
178:
179: size_t blob_len; // size of allocated BLOB data
180: void *blob_data; // BLOB data
181:
182: struct tagBLOB *blob_next;
183: } rpc_blob_t;
184:
1.1 misho 185: typedef struct {
1.2 misho 186: rpc_sess_t srv_session; // RPC session registration info
1.1 misho 187: int srv_numcli; // maximum concurent client connections
1.4 misho 188: int srv_netbuf; // size of network buffer size
1.1 misho 189:
1.2 misho 190: rpc_cli_t srv_server; // RPC server socket
191: rpc_cli_t *srv_clients; // connected rpc client sockets
192:
193: rpc_func_t *srv_funcs; // registered functions list
194:
195: pthread_mutex_t srv_mtx;
1.3 misho 196: cmd_type_t srv_kill;
1.2 misho 197:
198: struct {
1.3 misho 199: cmd_type_t state; // BLOB server state: ==0 disable | !=0 enable
1.2 misho 200: char dir[UCHAR_MAX + 1];
201:
202: rpc_cli_t server; // BLOB server socket
203: rpc_cli_t *clients; // connected blob client sockets
1.1 misho 204:
1.2 misho 205: rpc_blob_t *blobs; // registered blob variables list
1.1 misho 206:
1.2 misho 207: pthread_mutex_t mtx;
208: } srv_blob;
1.1 misho 209: } rpc_srv_t;
210:
211:
1.2 misho 212: /*
213: * (*rpc_callback_t)() Callback type definition for RPC call in server process
214: * @arg1 = current execution RPC call function
215: * @arg2 = number of items in input array from call request
216: * @arg3 = input array with values from RPC call execution request
217: * return: -1 error or >-1 success execution
218: */
1.4 misho 219: typedef int (*rpc_callback_t)(rpc_func_t *, int, array_t *);
1.1 misho 220:
221:
222: // -----------------------------------------------------------------------
223:
224: /* Error support functions */
225:
1.3 misho 226: // rpc_GetErrno() Get error code of last operation
227: inline int rpc_GetErrno();
228: // rpc_GetError() Get error text of last operation
229: inline const char *rpc_GetError();
1.1 misho 230:
231:
1.5 misho 232: /*
233: * rpc_chkPktSession() Check session in RPC packet
234: * @p = packet session
235: * @s = active session
236: * return: -1 error or 0 ok
237: */
238: inline int rpc_chkPktSession(rpc_sess_t *p, rpc_sess_t *s);
239: /*
240: * rpc_addPktSession() Add session into RPC packet
241: * @p = packet session
242: * @s = active session
243: * return: -1 error or 0 ok
244: */
245: inline int rpc_addPktSession(rpc_sess_t *p, rpc_sess_t *s);
246:
247:
1.1 misho 248: /* RPC Server side functions */
249:
250: /*
251: * rpc_srv_initServer() Init & create RPC Server
252: * @regProgID = ProgramID for authentication & recognition
253: * @regProcID = ProcessID for authentication & recognition
254: * @concurentClients = Concurent clients at same time to this server
1.4 misho 255: * @netBuf = Network buffer length, if =0 == BUFSIZ (also meaning max RPC packet)
1.3 misho 256: * @family = Family type, AF_INET, AF_INET6 or AF_LOCAL
257: * @csHost = Host name or address for bind server, if NULL any address
1.1 misho 258: * @Port = Port for bind server, if Port == 0 default port is selected
259: * return: NULL == error or !=NULL bind and created RPC server instance
260: */
261: rpc_srv_t *rpc_srv_initServer(u_int regProgID, u_int regProcID, int concurentClients,
1.4 misho 262: int netBuf, u_short family, const char *csHost, u_short Port);
1.1 misho 263: /*
264: * rpc_srv_endServer() Destroy RPC server, close all opened sockets and free resources
1.5 misho 265: * @psrv = RPC Server instance
1.1 misho 266: * return: none
267: */
1.5 misho 268: void rpc_srv_endServer(rpc_srv_t ** __restrict psrv);
1.1 misho 269: /*
1.4 misho 270: * rpc_srv_loopServer() Execute Main server loop and wait for clients requests
1.1 misho 271: * @srv = RPC Server instance
272: * return: -1 error or 0 ok, infinite loop ...
273: */
1.4 misho 274: int rpc_srv_loopServer(rpc_srv_t * __restrict srv);
275: #define rpc_srv_execServer(_srv, _sync) do { assert((_srv)); pthread_t __tid; \
276: pthread_create(&__tid, NULL, (void*(*)(void*)) \
277: rpc_srv_loopServer, (_srv)); \
278: if ((_sync)) \
279: pthread_join(__tid, (void**) (_sync)); \
280: else \
281: pthread_detach(__tid); \
282: } while (0)
1.1 misho 283:
284: /*
1.2 misho 285: * rpc_srv_initBLOBServer() Init & create BLOB Server
1.3 misho 286: * @srv = RPC server instance
1.2 misho 287: * @Port = Port for bind server, if Port == 0 default port is selected
288: * @diskDir = Disk place for BLOB file objects
289: * return: -1 == error or 0 bind and created BLOB server instance
290: */
291: int rpc_srv_initBLOBServer(rpc_srv_t * __restrict srv, u_short Port, const char *diskDir);
292: /*
293: * rpc_srv_endBLOBServer() Destroy BLOB server, close all opened sockets and free resources
294: * @srv = RPC Server instance
295: * return: none
296: */
297: void rpc_srv_endBLOBServer(rpc_srv_t * __restrict srv);
298: /*
1.4 misho 299: * rpc_srv_loopBLOB() Execute Main BLOB server loop and wait for clients requests
1.2 misho 300: * @srv = RPC Server instance
301: * return: -1 error or 0 ok, infinite loop ...
302: */
1.4 misho 303: int rpc_srv_loopBLOB(rpc_srv_t * __restrict srv);
304: #define rpc_srv_execBLOBServer(_srv) do { assert((_srv)); pthread_t __tid; \
305: if ((_srv)->srv_blob.state == enable) { \
306: pthread_create(&__tid, NULL, (void*(*)(void*)) \
307: rpc_srv_loopBLOB, (_srv)); \
308: pthread_detach(__tid); \
309: (_srv)->srv_blob.state = running; \
310: } \
311: } while (0)
1.2 misho 312:
313: /*
1.1 misho 314: * rpc_srv_registerCall() Register call to RPC server
315: * @srv = RPC Server instance
316: * @csModule = Module name, if NULL self binary
317: * @csFunc = Function name
1.2 misho 318: * @args = Number of return function arguments, use for restriction case!
1.1 misho 319: * return: -1 error or 0 register ok
320: */
321: int rpc_srv_registerCall(rpc_srv_t * __restrict srv, const char *csModule, const char *csFunc,
1.4 misho 322: unsigned short args);
1.1 misho 323: /*
324: * rpc_srv_unregisterCall() Unregister call from RPC server
325: * @srv = RPC Server instance
326: * @csModule = Module name, if NULL self binary
327: * @csFunc = Function name
328: * return: -1 error, 0 not found call, 1 unregister ok
329: */
330: int rpc_srv_unregisterCall(rpc_srv_t * __restrict srv, const char *csModule, const char *csFunc);
331: /*
332: * rpc_srv_getFunc() Get registered call from RPC server by Name
333: * @srv = RPC Server instance
334: * @csModule = Module name, if NULL self binary
335: * @csFunc = Function name
336: * return: NULL not found call, !=NULL return call
337: */
338: rpc_func_t *rpc_srv_getFunc(rpc_srv_t * __restrict srv, const char *csModule, const char *csFunc);
339: /*
340: * rpc_srv_getCall() Get registered call from RPC server
341: * @srv = RPC Server instance
342: * @tag = tag for function
343: * @hash = hash for function
344: * return: NULL not found call, !=NULL return call
345: */
346: inline rpc_func_t *rpc_srv_getCall(rpc_srv_t * __restrict srv, uint16_t tag, uint32_t hash);
347: /*
348: * rpc_srv_execCall() Execute registered call from RPC server
349: * @call = Register RPC call
350: * @rpc = IN RPC call structure
1.4 misho 351: * @args = IN RPC calling arguments from RPC client
1.1 misho 352: * return: -1 error, !=-1 ok
353: */
1.2 misho 354: int rpc_srv_execCall(rpc_func_t * __restrict call, struct tagRPCCall * __restrict rpc,
1.4 misho 355: array_t * __restrict args);
1.1 misho 356:
357:
358: /*
1.3 misho 359: * rpc_srv_copyVars() Copy variables for RPC call to new variable array
1.1 misho 360: * @call = RPC function call
1.3 misho 361: * @newvars = New allocated variables array, must be free after use
1.1 misho 362: * return: -1 error, !=-1 Returned number of copied RPC variables
363: */
1.4 misho 364: inline int rpc_srv_copyVars(rpc_func_t * __restrict call, array_t ** __restrict newvars);
1.1 misho 365: /*
1.3 misho 366: * rpc_srv_getVars() Get variables array for RPC call
1.1 misho 367: * @call = RPC function call
1.3 misho 368: * @vars = Returned variables array, may be NULL
1.1 misho 369: * return: -1 error, !=-1 Number of returned variables
370: */
1.4 misho 371: inline int rpc_srv_getVars(rpc_func_t * __restrict call, array_t ** __restrict vars);
1.1 misho 372:
373:
1.2 misho 374: /*
375: * rpc_srv_blobCreate() Create map blob to memory region and return object
376: * @srv = RPC Server instance
377: * @len = BLOB length object
378: * return: NULL error or !=NULL allocated BLOB object
379: */
380: inline rpc_blob_t *rpc_srv_blobCreate(rpc_srv_t * __restrict srv, int len);
381: /*
382: * rpc_srv_blobMap() Map blob to memory region
383: * @srv = RPC Server instance
384: * @blob = Map to this BLOB element
385: * return: -1 error or 0 ok
386: */
387: inline int rpc_srv_blobMap(rpc_srv_t * __restrict srv, rpc_blob_t * __restrict blob);
388: /*
389: * rpc_srv_blobUnmap() Unmap blob memory region
390: * @blob = Mapped BLOB element
391: * return: none
392: */
393: inline void rpc_srv_blobUnmap(rpc_blob_t * __restrict blob);
394: /*
395: * rpc_srv_blobFree() Free blob from disk & memory
396: * @srv = RPC Server instance
397: * @blob = Mapped BLOB element
398: * return: -1 error or 0 ok
399: */
400: inline int rpc_srv_blobFree(rpc_srv_t * __restrict srv, rpc_blob_t * __restrict blob);
401:
402: /*
403: * rpc_srv_registerBLOB() Register new BLOB to server
404: * @srv = RPC Server instance
405: * @len = BLOB length
406: * return: NULL error or new registered BLOB
407: */
408: rpc_blob_t *rpc_srv_registerBLOB(rpc_srv_t * __restrict srv, size_t len);
409: /*
410: * rpc_srv_unregisterBLOB() Unregister BLOB from server
411: * @srv = RPC Server instance
412: * @var = BLOB Variable for unregister
413: * return: -1 error, 0 not found call, 1 unregister ok
414: */
415: int rpc_srv_unregisterBLOB(rpc_srv_t * __restrict srv, uint32_t var);
416: /*
417: * rpc_srv_getBLOB() Get registered BLOB
418: * @srv = RPC Server instance
419: * @var = hash for variable
420: * return: NULL not found, !=NULL return blob var
421: */
422: inline rpc_blob_t *rpc_srv_getBLOB(rpc_srv_t * __restrict srv, uint32_t var);
423:
424: /*
425: * rpc_srv_sendBLOB() Send mapped BLOB to client
426: * @cli = Client instance
427: * @blob = Mapped BLOB element
428: * return: -1 error, 0 ok
429: */
430: int rpc_srv_sendBLOB(rpc_cli_t * __restrict cli, rpc_blob_t * __restrict blob);
431: /*
432: * rpc_srv_recvBLOB() Receive BLOB from client
433: * @cli = Client instance
434: * @blob = Mapped BLOB element
435: * return: -1 error, 0 ok, >0 unreceived data from client, may be error?
436: */
437: int rpc_srv_recvBLOB(rpc_cli_t * __restrict cli, rpc_blob_t * __restrict blob);
438:
1.4 misho 439: /* CLIENT part of functions */
440:
1.2 misho 441: /*
442: * rpc_cli_sendBLOB() Send BLOB to server
443: * @cli = Client instance
444: * @var = BLOB variable
445: * @data = BLOB data
446: * return: -1 error, 0 ok, 1 remote error
447: */
1.4 misho 448: int rpc_cli_sendBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var, void * __restrict data);
1.2 misho 449: /*
450: * rpc_cli_recvBLOB() Receive BLOB from server
451: * @cli = Client instance
452: * @var = BLOB variable
453: * @data = BLOB data, must be free after use!
454: * return: -1 error, 0 ok, 1 remote error
455: */
1.4 misho 456: int rpc_cli_recvBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var, void ** __restrict data);
1.2 misho 457: /*
458: * rpc_cli_delBLOB() Delete BLOB from server
459: * @cli = Client instance
460: * @var = BLOB variable
461: * return: -1 error, 0 ok, 1 remote error
462: */
1.4 misho 463: int rpc_cli_delBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var);
1.2 misho 464: /*
465: * rpc_cli_getBLOB() Receive BLOB from server and Delete after that.
466: * @cli = Client instance
467: * @var = BLOB variable
468: * @data = BLOB data, must be free after use!
469: * return: -1 error, 0 ok, >0 remote error
470: */
1.4 misho 471: inline int rpc_cli_getBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var, void ** __restrict data);
1.2 misho 472:
473:
474:
1.1 misho 475: /* RPC Client side functions */
476:
477: /*
478: * rpc_cli_openClient() Connect to RPC Server
479: * @ProgID = ProgramID for RPC session request
480: * @ProcID = ProcessID for RPC session request
1.4 misho 481: * @netBuf = Network buffer length, if =0 == BUFSIZ (also meaning max RPC packet)
1.1 misho 482: * @family = Family socket type, AF_INET or AF_INET6
483: * @csHost = Host name or IP address for bind server
484: * @Port = Port for bind server, if Port == 0 default port is selected
485: * return: NULL == error or !=NULL connection to RPC server established
486: */
1.4 misho 487: rpc_cli_t *rpc_cli_openClient(u_int ProgID, u_int ProcID, int netBuf,
1.3 misho 488: u_short family, const char *csHost, u_short Port);
1.1 misho 489: /*
490: * rpc_cli_closeClient() Close connection to RPC server and free resources
491: * @cli = RPC Client session
492: * return: none
493: */
494: void rpc_cli_closeClient(rpc_cli_t * __restrict cli);
495: /*
496: * rpc_cli_execCall() Execute RPC call
497: * @cli = RPC Client session
498: * @csModule = Module name, if NULL self binary
499: * @csFunc = Function name for execute
1.3 misho 500: * @in_vars = IN RPC call array of rpc values
1.4 misho 501: * @out_vars = OUT returned array of rpc values, must be free after use with rpc_cli_freeVals()
1.1 misho 502: * return: -1 error or != -1 ok result
503: */
1.4 misho 504: int rpc_cli_execCall(rpc_cli_t *cli, const char *csModule, const char *csFunc,
505: array_t * __restrict in_vars, array_t ** __restrict out_vars);
1.1 misho 506:
507:
1.2 misho 508: /*
509: * rpc_cli_openBLOBClient() Connect to BLOB Server
510: * @rpccli = RPC Client session
511: * @Port = Port for bind server, if Port == 0 default port is selected
512: * return: NULL == error or !=NULL connection to BLOB server established
513: */
514: rpc_cli_t *rpc_cli_openBLOBClient(rpc_cli_t * __restrict rpccli, u_short Port);
515: /*
516: * rpc_cli_closeBLOBClient() Close connection to BLOB server and free resources
517: * @cli = BLOB Client session
518: * return: none
519: */
520: void rpc_cli_closeBLOBClient(rpc_cli_t * __restrict cli);
521:
522:
1.1 misho 523: #endif
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/cvsweb/back.gif){kind=icon}
Return to aitrpc.h CVS log ![[TXT]](/icons/cvsweb/text.gif){kind=icon}
![[DIR]](/icons/cvsweb/dir.gif){kind=icon}
Up to [ELWIX - Embedded LightWeight unIX -] / libaitrpc / inc