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