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