1: /*************************************************************************
2: * (C) 2010 AITNET ltd - Sofia/Bulgaria - <misho@aitbg.com>
3: * by Michael Pounov <misho@openbsd-bg.org>
4: *
5: * $Author: misho $
6: * $Id: aitrpc.h,v 1.5.2.7 2012/03/14 15:08:03 misho Exp $
7: *
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:
15: Copyright 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012
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: */
46: #ifndef __AITRPC_H
47: #define __AITRPC_H
48:
49:
50: #include <assert.h>
51: #include <stdlib.h>
52: #include <string.h>
53: #include <errno.h>
54: #include <sys/types.h>
55: #include <sys/param.h>
56: #if !defined(__NetBSD__)
57: #include <sys/limits.h>
58: #endif
59: #include <sys/socket.h>
60: #include <aitio.h>
61: #include <aitsched.h>
62:
63:
64: #define RPC_VERSION 3
65: #define RPC_DEFPORT 2611
66:
67: /* RPC call request flags */
68:
69: #define RPC_REPLY 0x0
70: #define RPC_NOREPLY 0x1
71:
72: /* RPC builtin registed calls */
73:
74: #define CALL_BLOBSHUTDOWN "rpcBLOBServerShutdown"
75: #define CALL_BLOBCLIENTS "rpcBLOBServerClients"
76: #define CALL_BLOBVARS "rpcBLOBServerVars"
77: #define CALL_BLOBSTATE "rpcBLOBServerState"
78:
79: #define CALL_SRVSHUTDOWN "rpcServerShutdown"
80: #define CALL_SRVCLIENTS "rpcServerClients"
81: #define CALL_SRVCALLS "rpcServerCalls"
82: #define CALL_SRVSESSIONS "rpcServerSessions"
83:
84:
85: /* RPC types */
86:
87: typedef enum {
88: disable, enable, running, kill, /* for blob.state */
89: ok, error, no, /* for blob reply */
90: get, set, unset /* for blob request */
91: } cmd_type_t;
92:
93:
94: #define RPC_CALLBACK_CHECK_INPUT(_f) do { \
95: assert((_f)); \
96: if (!(_f)) { \
97: rpc_SetErr(EINVAL, \
98: "Invalid callback parameters ..."); \
99: return -1; \
100: } \
101: } while (0)
102: #define RPC_CALLBACK_CHK_ARGS(_f, _n) do { \
103: RPC_CALLBACK_CHECK_INPUT((_f)); \
104: if ((_f) && io_arraySize((_f)->func_vars) < _n) { \
105: rpc_SetErr(EINVAL, \
106: "Not enough number of arguments!"); \
107: return -1; \
108: } \
109: } while (0)
110:
111:
112: /* RPC session identification */
113:
114: typedef struct {
115: uint8_t sess_version;
116: uint8_t sess_timeout;
117: uint32_t sess_program;
118: uint32_t sess_process;
119: } __packed rpc_sess_t;
120:
121:
122: /* Server managment RPC functions ... */
123:
124: /* RPC function registration element! */
125: typedef struct tagRPCFunc {
126: uint16_t func_tag;
127: uint32_t func_hash;
128: ait_val_t func_file;
129: ait_val_t func_name;
130:
131: array_t *func_vars;
132:
133: void *func_parent;
134: struct tagRPCFunc *func_next;
135: } rpc_func_t;
136:
137:
138: /* Network RPC packet - Client request */
139:
140: struct tagRPCCall {
141: rpc_sess_t call_session;
142:
143: uint16_t call_tag;
144: uint32_t call_hash;
145: uint16_t call_argc;
146:
147: union {
148: struct {
149: uint64_t flags;
150: } call_req;
151: struct {
152: int32_t ret;
153: int32_t eno;
154: } call_rep;
155: };
156:
157: uint16_t call_crc;
158: } __packed;
159:
160: /* Network BLOB packet - Header */
161:
162: struct tagBLOBHdr {
163: rpc_sess_t hdr_session;
164: uint8_t hdr_cmd;
165: uint32_t hdr_var;
166: uint32_t hdr_len;
167: uint32_t hdr_ret;
168: uint16_t hdr_crc;
169: } __packed;
170:
171: /* Network RPC client & server elements */
172:
173: typedef struct {
174: io_sockaddr_t cli_sa; // host info
175: int cli_sock; // socket fd
176: pthread_t cli_tid; // TID of thread
177:
178: void *cli_parent; // pointer to parent rpc_srv_t for server or to rpc_sess_t for client
179: int cli_netbuf; // size of network buffer size
180: } rpc_cli_t;
181:
182:
183: /* BLOB registration element! */
184: typedef struct tagBLOB {
185: uint32_t blob_var;
186:
187: size_t blob_len; // size of allocated BLOB data
188: void *blob_data; // BLOB data
189:
190: struct tagBLOB *blob_next;
191: } rpc_blob_t;
192:
193: typedef struct {
194: rpc_sess_t srv_session; // RPC session registration info
195: int srv_numcli; // maximum concurent client connections
196: int srv_netbuf; // size of network buffer size
197:
198: rpc_cli_t srv_server; // RPC server socket
199: rpc_cli_t *srv_clients; // connected rpc client sockets
200:
201: rpc_func_t *srv_funcs; // registered functions list
202:
203: pthread_mutex_t srv_mtx;
204: cmd_type_t srv_kill;
205:
206: struct {
207: cmd_type_t state; // BLOB server state: ==0 disable | !=0 enable
208: ait_val_t dir;
209:
210: rpc_cli_t server; // BLOB server socket
211: rpc_cli_t *clients; // connected blob client sockets
212:
213: rpc_blob_t *blobs; // registered blob variables list
214:
215: pthread_mutex_t mtx;
216: } srv_blob;
217: } rpc_srv_t;
218:
219:
220: /*
221: * (*rpc_callback_t)() - Callback type definition for RPC call in server process
222: *
223: * @arg1 = current execution RPC call function
224: * @arg2 = number of items in input array from call request
225: * @arg3 = input array with values from RPC call execution request
226: * return: -1 error or >-1 success execution
227: */
228: typedef int (*rpc_callback_t)(rpc_func_t *, int, array_t *);
229:
230:
231: // -----------------------------------------------------------------------
232:
233: /* Error support functions */
234:
235: // rpc_GetErrno() Get error code of last operation
236: inline int rpc_GetErrno();
237: // rpc_GetError() Get error text of last operation
238: inline const char *rpc_GetError();
239:
240:
241: /*
242: * rpc_chkPktSession() - Check session in RPC packet
243: *
244: * @p = packet session
245: * @s = active session
246: * return: -1 error or 0 ok
247: */
248: inline int rpc_chkPktSession(rpc_sess_t *p, rpc_sess_t *s);
249: /*
250: * rpc_addPktSession() - Add session into RPC packet
251: *
252: * @p = packet session
253: * @s = active session
254: * return: -1 error or 0 ok
255: */
256: inline int rpc_addPktSession(rpc_sess_t *p, rpc_sess_t *s);
257:
258:
259: /* RPC Server side functions */
260:
261: /*
262: * rpc_srv_initServer() - Init & create RPC Server
263: *
264: * @regProgID = ProgramID for authentication & recognition
265: * @regProcID = ProcessID for authentication & recognition
266: * @concurentClients = Concurent clients at same time to this server
267: * @netBuf = Network buffer length, if =0 == BUFSIZ (also meaning max RPC packet)
268: * @family = Family type, AF_INET, AF_INET6 or AF_LOCAL
269: * @csHost = Host name or address for bind server, if NULL any address
270: * @Port = Port for bind server, if Port == 0 default port is selected
271: * return: NULL == error or !=NULL bind and created RPC server instance
272: */
273: rpc_srv_t *rpc_srv_initServer(u_int regProgID, u_int regProcID, int concurentClients,
274: int netBuf, u_short family, const char *csHost, u_short Port);
275: /*
276: * rpc_srv_endServer() - Destroy RPC server, close all opened sockets and free resources
277: *
278: * @psrv = RPC Server instance
279: * return: none
280: */
281: void rpc_srv_endServer(rpc_srv_t ** __restrict psrv);
282: /*
283: * rpc_srv_loopServer() - Execute Main server loop and wait for clients requests
284: *
285: * @srv = RPC Server instance
286: * return: -1 error or 0 ok, infinite loop ...
287: */
288: int rpc_srv_loopServer(rpc_srv_t * __restrict srv);
289: #define rpc_srv_execServer(_srv, _sync) do { assert((_srv)); pthread_t __tid; \
290: pthread_create(&__tid, NULL, (void*(*)(void*)) \
291: rpc_srv_loopServer, (_srv)); \
292: if ((_sync)) \
293: pthread_join(__tid, (void**) (_sync)); \
294: else \
295: pthread_detach(__tid); \
296: } while (0)
297:
298: /*
299: * rpc_srv_initBLOBServer() - Init & create BLOB Server
300: *
301: * @srv = RPC server instance
302: * @Port = Port for bind server, if Port == 0 default port is selected
303: * @diskDir = Disk place for BLOB file objects
304: * return: -1 == error or 0 bind and created BLOB server instance
305: */
306: int rpc_srv_initBLOBServer(rpc_srv_t * __restrict srv, u_short Port, const char *diskDir);
307: /*
308: * rpc_srv_endBLOBServer() - Destroy BLOB server, close all opened sockets and free resources
309: *
310: * @srv = RPC Server instance
311: * return: none
312: */
313: void rpc_srv_endBLOBServer(rpc_srv_t * __restrict srv);
314: /*
315: * rpc_srv_loopBLOB() - Execute Main BLOB server loop and wait for clients requests
316: *
317: * @srv = RPC Server instance
318: * return: -1 error or 0 ok, infinite loop ...
319: */
320: int rpc_srv_loopBLOB(rpc_srv_t * __restrict srv);
321: #define rpc_srv_execBLOBServer(_srv) do { assert((_srv)); pthread_t __tid; \
322: if ((_srv)->srv_blob.state == enable) { \
323: pthread_create(&__tid, NULL, (void*(*)(void*)) \
324: rpc_srv_loopBLOB, (_srv)); \
325: pthread_detach(__tid); \
326: (_srv)->srv_blob.state = running; \
327: } \
328: } while (0)
329:
330: /*
331: * rpc_srv_registerCall() - Register call to RPC server
332: *
333: * @srv = RPC Server instance
334: * @csModule = Module name, if NULL self binary
335: * @csFunc = Function name
336: * @args = Number of return function arguments, use for restriction case!
337: * return: -1 error or 0 register ok
338: */
339: int rpc_srv_registerCall(rpc_srv_t * __restrict srv, const char *csModule, const char *csFunc,
340: unsigned short args);
341: /*
342: * rpc_srv_unregisterCall() - Unregister call from RPC server
343: *
344: * @srv = RPC Server instance
345: * @csModule = Module name, if NULL self binary
346: * @csFunc = Function name
347: * return: -1 error, 0 not found call, 1 unregister ok
348: */
349: int rpc_srv_unregisterCall(rpc_srv_t * __restrict srv, const char *csModule, const char *csFunc);
350: /*
351: * rpc_srv_getFunc() - Get registered call from RPC server by Name
352: *
353: * @srv = RPC Server instance
354: * @csModule = Module name, if NULL self binary
355: * @csFunc = Function name
356: * return: NULL not found call, !=NULL return call
357: */
358: rpc_func_t *rpc_srv_getFunc(rpc_srv_t * __restrict srv, const char *csModule, const char *csFunc);
359: /*
360: * rpc_srv_getCall() - Get registered call from RPC server
361: *
362: * @srv = RPC Server instance
363: * @tag = tag for function
364: * @hash = hash for function
365: * return: NULL not found call, !=NULL return call
366: */
367: inline rpc_func_t *rpc_srv_getCall(rpc_srv_t * __restrict srv, uint16_t tag, uint32_t hash);
368: /*
369: * rpc_srv_execCall() - Execute registered call from RPC server
370: *
371: * @call = Register RPC call
372: * @rpc = IN RPC call structure
373: * @args = IN RPC calling arguments from RPC client
374: * return: -1 error, !=-1 ok
375: */
376: int rpc_srv_execCall(rpc_func_t * __restrict call, struct tagRPCCall * __restrict rpc,
377: array_t * __restrict args);
378:
379:
380: /*
381: * rpc_srv_getVars() - Get variables array for RPC call
382: *
383: * @call = RPC function call
384: * @vars = Returned variables array, may be NULL
385: * return: -1 error, !=-1 Number of returned variables
386: */
387: inline int rpc_srv_getVars(rpc_func_t * __restrict call, array_t ** __restrict vars);
388:
389:
390: /*
391: * rpc_srv_blobCreate() - Create map blob to memory region and return object
392: *
393: * @srv = RPC Server instance
394: * @len = BLOB length object
395: * return: NULL error or !=NULL allocated BLOB object
396: */
397: inline rpc_blob_t *rpc_srv_blobCreate(rpc_srv_t * __restrict srv, int len);
398: /*
399: * rpc_srv_blobMap() - Map blob to memory region
400: *
401: * @srv = RPC Server instance
402: * @blob = Map to this BLOB element
403: * return: -1 error or 0 ok
404: */
405: inline int rpc_srv_blobMap(rpc_srv_t * __restrict srv, rpc_blob_t * __restrict blob);
406: /*
407: * rpc_srv_blobUnmap() - Unmap blob memory region
408: *
409: * @blob = Mapped BLOB element
410: * return: none
411: */
412: inline void rpc_srv_blobUnmap(rpc_blob_t * __restrict blob);
413: /*
414: * rpc_srv_blobFree() - Free blob from disk & memory
415: *
416: * @srv = RPC Server instance
417: * @blob = Mapped BLOB element
418: * return: -1 error or 0 ok
419: */
420: inline int rpc_srv_blobFree(rpc_srv_t * __restrict srv, rpc_blob_t * __restrict blob);
421:
422: /*
423: * rpc_srv_registerBLOB() - Register new BLOB to server
424: *
425: * @srv = RPC Server instance
426: * @len = BLOB length
427: * return: NULL error or new registered BLOB
428: */
429: rpc_blob_t *rpc_srv_registerBLOB(rpc_srv_t * __restrict srv, size_t len);
430: /*
431: * rpc_srv_unregisterBLOB() - Unregister BLOB from server
432: *
433: * @srv = RPC Server instance
434: * @var = BLOB Variable for unregister
435: * return: -1 error, 0 not found call, 1 unregister ok
436: */
437: int rpc_srv_unregisterBLOB(rpc_srv_t * __restrict srv, uint32_t var);
438: /*
439: * rpc_srv_getBLOB() - Get registered BLOB
440: *
441: * @srv = RPC Server instance
442: * @var = hash for variable
443: * return: NULL not found, !=NULL return blob var
444: */
445: inline rpc_blob_t *rpc_srv_getBLOB(rpc_srv_t * __restrict srv, uint32_t var);
446:
447: /*
448: * rpc_srv_sendBLOB() - Send mapped BLOB to client
449: *
450: * @cli = Client instance
451: * @blob = Mapped BLOB element
452: * return: -1 error, 0 ok
453: */
454: int rpc_srv_sendBLOB(rpc_cli_t * __restrict cli, rpc_blob_t * __restrict blob);
455: /*
456: * rpc_srv_recvBLOB() - Receive BLOB from client
457: *
458: * @cli = Client instance
459: * @blob = Mapped BLOB element
460: * return: -1 error, 0 ok, >0 unreceived data from client, may be error?
461: */
462: int rpc_srv_recvBLOB(rpc_cli_t * __restrict cli, rpc_blob_t * __restrict blob);
463:
464: /* CLIENT part of functions */
465:
466: /*
467: * rpc_cli_sendBLOB() - Send BLOB to server
468: *
469: * @cli = Client instance
470: * @var = BLOB variable
471: * @data = BLOB data
472: * return: -1 error, 0 ok, 1 remote error
473: */
474: int rpc_cli_sendBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var, void * __restrict data);
475: /*
476: * rpc_cli_recvBLOB() - Receive BLOB from server
477: *
478: * @cli = Client instance
479: * @var = BLOB variable
480: * @data = BLOB data, must be free after use!
481: * return: -1 error, 0 ok, 1 remote error
482: */
483: int rpc_cli_recvBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var, void ** __restrict data);
484: /*
485: * rpc_cli_delBLOB() - Delete BLOB from server
486: *
487: * @cli = Client instance
488: * @var = BLOB variable
489: * return: -1 error, 0 ok, 1 remote error
490: */
491: int rpc_cli_delBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var);
492: /*
493: * rpc_cli_getBLOB() - Receive BLOB from server and Delete after that.
494: *
495: * @cli = Client instance
496: * @var = BLOB variable
497: * @data = BLOB data, must be free after use!
498: * return: -1 error, 0 ok, >0 remote error
499: */
500: inline int rpc_cli_getBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var,
501: void ** __restrict data);
502:
503:
504: /*
505: * rpc_calcHashes() - Calculate hashes for RPC call
506: *
507: * @func = function
508: * @csModule = Module name, if NULL self binary
509: * @csFunc = Function name
510: * return: -1 error or 0 ok
511: */
512: int rpc_calcHashes(rpc_func_t * __restrict func, const char *csModule, const char *csFunc);
513:
514:
515: /* RPC Client side functions */
516:
517: /*
518: * rpc_cli_openClient() - Connect to RPC Server
519: *
520: * @ProgID = ProgramID for RPC session request
521: * @ProcID = ProcessID for RPC session request
522: * @netBuf = Network buffer length, if =0 == BUFSIZ (also meaning max RPC packet)
523: * @Timeout = RPC timeout in seconds, if =0 set default RPC timeout
524: * @family = Family socket type, AF_INET or AF_INET6
525: * @csHost = Host name or IP address for bind server
526: * @Port = Port for bind server, if Port == 0 default port is selected
527: * return: NULL == error or !=NULL connection to RPC server established
528: */
529: rpc_cli_t *rpc_cli_openClient(unsigned int ProgID, unsigned int ProcID, int netBuf,
530: unsigned char Timeout, unsigned short family,
531: const char *csHost, unsigned short Port);
532: /*
533: * rpc_cli_closeClient() - Close connection to RPC server and free resources
534: *
535: * @cli = RPC Client session
536: * return: none
537: */
538: void rpc_cli_closeClient(rpc_cli_t * __restrict cli);
539: /*
540: * rpc_cli_execCall() - Execute RPC call
541: *
542: * @cli = RPC Client session
543: * @csModule = Module name, if NULL self binary
544: * @csFunc = Function name for execute
545: * @in_vars = IN RPC call array of rpc values
546: * @out_vars = OUT returned array of rpc values, must be free after use with rpc_cli_freeVals()
547: * return: -1 error or != -1 ok result
548: */
549: int rpc_cli_execCall(rpc_cli_t *cli, const char *csModule, const char *csFunc,
550: array_t * __restrict in_vars, array_t ** __restrict out_vars);
551:
552:
553: /*
554: * rpc_cli_openBLOBClient() - Connect to BLOB Server
555: *
556: * @rpccli = RPC Client session
557: * @Port = Port for bind server, if Port == 0 default port is selected
558: * return: NULL == error or !=NULL connection to BLOB server established
559: */
560: rpc_cli_t *rpc_cli_openBLOBClient(rpc_cli_t * __restrict rpccli, u_short Port);
561: /*
562: * rpc_cli_closeBLOBClient() - Close connection to BLOB server and free resources
563: *
564: * @cli = BLOB Client session
565: * return: none
566: */
567: void rpc_cli_closeBLOBClient(rpc_cli_t * __restrict cli);
568:
569:
570: #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