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.8 2012/05/16 07:54:49 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: /* BLOB register element */
184: typedef struct tagBLOB {
185: uint32_t blob_var; /* BLOB id */
186:
187: size_t blob_len; /* size of allocated BLOB data */
188: void *blob_data; /* mapped BLOB data */
189:
190: TAILQ_ENTRY(tagBLOB) blob_node;
191: } rpc_blob_t;
192:
193:
194: typedef struct {
195: int cli_id; /* slot id */
196: int cli_sock; /* socket fd */
197: io_sockaddr_t cli_sa; /* host address */
198: ait_val_t cli_buf; /* network buffer */
199:
200: void *cli_parent; /* pointer to parent rpc_srv_t for server or to rpc_sess_t for client */
201: } rpc_cli_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; /* BLOB states directory */
218:
219: rpc_cli_t server; /* BLOB server socket */
220: array_t *clients; /* connected blob client sockets */
221:
222: TAILQ_HEAD(, tagBLOB) 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: * rpc_register_blobServices() - Register internal service functions
273: *
274: * @srv = RPC server instance
275: * return: -1 error or 0 ok
276: */
277: int rpc_register_blobServices(rpc_srv_t * __restrict srv);
278:
279:
280: /* RPC Server side functions */
281:
282: /*
283: * rpc_srv_initServer() - Init & create RPC Server
284: *
285: * @regProgID = ProgramID for authentication & recognition
286: * @regProcID = ProcessID for authentication & recognition
287: * @concurentClients = Concurent clients at same time to this server
288: * @netBuf = Network buffer length, if =0 == BUFSIZ (also meaning max RPC packet)
289: * @csHost = Host name or address for bind server, if NULL any address
290: * @Port = Port for bind server, if Port == 0 default port is selected
291: * return: NULL == error or !=NULL bind and created RPC server instance
292: */
293: rpc_srv_t *rpc_srv_initServer(unsigned int regProgID, unsigned char regProcID,
294: int concurentClients, int netBuf,
295: const char *csHost, unsigned short Port);
296: /*
297: * rpc_srv_endServer() - Destroy RPC server, close all opened sockets and free resources
298: *
299: * @psrv = RPC Server instance
300: * return: none
301: */
302: void rpc_srv_endServer(rpc_srv_t ** __restrict psrv);
303: /*
304: * rpc_srv_loopServer() - Execute Main server loop and wait for clients requests
305: *
306: * @srv = RPC Server instance
307: * return: -1 error or 0 ok, infinite loop ...
308: */
309: int rpc_srv_loopServer(rpc_srv_t * __restrict srv);
310: #define rpc_srv_execServer(_srv, _sync) do { assert((_srv)); pthread_t __tid; \
311: pthread_create(&__tid, NULL, (void*(*)(void*)) \
312: rpc_srv_loopServer, (_srv)); \
313: if ((_sync)) \
314: pthread_join(__tid, (void**) (_sync)); \
315: else \
316: pthread_detach(__tid); \
317: } while (0)
318:
319: /*
320: * rpc_srv_initBLOBServer() - Init & create BLOB Server
321: *
322: * @srv = RPC server instance
323: * @Port = Port for bind server, if Port == 0 default port is selected
324: * @diskDir = Disk place for BLOB file objects
325: * return: -1 == error or 0 bind and created BLOB server instance
326: */
327: int rpc_srv_initBLOBServer(rpc_srv_t * __restrict srv, u_short Port, const char *diskDir);
328: /*
329: * rpc_srv_endBLOBServer() - Destroy BLOB server, close all opened sockets and free resources
330: *
331: * @srv = RPC Server instance
332: * return: none
333: */
334: void rpc_srv_endBLOBServer(rpc_srv_t * __restrict srv);
335: /*
336: * rpc_srv_loopBLOB() - Execute Main BLOB server loop and wait for clients requests
337: *
338: * @srv = RPC Server instance
339: * return: -1 error or 0 ok, infinite loop ...
340: */
341: int rpc_srv_loopBLOB(rpc_srv_t * __restrict srv);
342: #define rpc_srv_execBLOBServer(_srv) do { assert((_srv)); pthread_t __tid; \
343: if ((_srv)->srv_blob.state == enable) { \
344: pthread_create(&__tid, NULL, (void*(*)(void*)) \
345: rpc_srv_loopBLOB, (_srv)); \
346: pthread_detach(__tid); \
347: (_srv)->srv_blob.state = running; \
348: } \
349: } while (0)
350:
351: /*
352: * rpc_srv_registerCall() - Register call to RPC server
353: *
354: * @srv = RPC Server instance
355: * @tag = Function tag
356: * @funcaddr = Function address
357: * @args = Number of return function arguments
358: * return: -1 error, 0 already registered tag or 1 register ok
359: */
360: int rpc_srv_registerCall(rpc_srv_t * __restrict srv, unsigned short tag,
361: void *funcaddr, unsigned short args);
362: /*
363: * rpc_srv_unregisterCall() - Unregister call from RPC server
364: *
365: * @srv = RPC Server instance
366: * @tag = Function tag
367: * return: -1 error, 0 not found call, 1 unregister ok
368: */
369: int rpc_srv_unregisterCall(rpc_srv_t * __restrict srv, unsigned short tag);
370: /*
371: * rpc_srv_getCall() - Get registered call from RPC server
372: *
373: * @srv = RPC Server instance
374: * @tag = tag for function
375: * return: NULL not found call, !=NULL return call
376: */
377: inline rpc_func_t *rpc_srv_getCall(rpc_srv_t * __restrict srv, uint16_t tag);
378: /*
379: * rpc_srv_execCall() - Execute registered call from RPC server
380: *
381: * @call = Register RPC call
382: * @rpc = IN RPC call structure
383: * @args = IN RPC calling arguments from RPC client
384: * return: -1 error, !=-1 ok
385: */
386: int rpc_srv_execCall(rpc_func_t * __restrict call, struct tagRPCCall * __restrict rpc,
387: array_t * __restrict args);
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: /* RPC Client side functions */
505:
506: /*
507: * rpc_cli_openClient() - Connect to RPC Server
508: *
509: * @ProgID = ProgramID for RPC session request
510: * @ProcID = ProcessID for RPC session request
511: * @netBuf = Network buffer length, if =0 == BUFSIZ (also meaning max RPC packet)
512: * @Timeout = RPC timeout in seconds, if =0 set default RPC timeout
513: * @family = Family socket type, AF_INET or AF_INET6
514: * @csHost = Host name or IP address for bind server
515: * @Port = Port for bind server, if Port == 0 default port is selected
516: * return: NULL == error or !=NULL connection to RPC server established
517: */
518: rpc_cli_t *rpc_cli_openClient(unsigned int ProgID, unsigned int ProcID, int netBuf,
519: unsigned char Timeout, unsigned short family,
520: const char *csHost, unsigned short Port);
521: /*
522: * rpc_cli_closeClient() - Close connection to RPC server and free resources
523: *
524: * @cli = RPC Client session
525: * return: none
526: */
527: void rpc_cli_closeClient(rpc_cli_t * __restrict cli);
528: /*
529: * rpc_cli_execCall() - Execute RPC call
530: *
531: * @cli = RPC Client session
532: * @noreply = We not want RPC reply
533: * @csModule = Module name, if NULL self binary
534: * @csFunc = Function name for execute
535: * @in_vars = IN RPC call array of rpc values
536: * @out_vars = OUT returned array of rpc values, must be free after use with rpc_cli_freeVals()
537: * return: -1 error or != -1 ok result
538: */
539: int rpc_cli_execCall(rpc_cli_t *cli, int noreply, const char *csModule, const char *csFunc,
540: array_t * __restrict in_vars, array_t ** __restrict out_vars);
541:
542:
543: /*
544: * rpc_cli_openBLOBClient() - Connect to BLOB Server
545: *
546: * @rpccli = RPC Client session
547: * @Port = Port for bind server, if Port == 0 default port is selected
548: * return: NULL == error or !=NULL connection to BLOB server established
549: */
550: rpc_cli_t *rpc_cli_openBLOBClient(rpc_cli_t * __restrict rpccli, u_short Port);
551: /*
552: * rpc_cli_closeBLOBClient() - Close connection to BLOB server and free resources
553: *
554: * @cli = BLOB Client session
555: * return: none
556: */
557: void rpc_cli_closeBLOBClient(rpc_cli_t * __restrict cli);
558:
559:
560: #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