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.11 2012/05/16 13:17:51 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: sched_root_task_t *root; /* BLOB server scheduler */
217: intptr_t kill; /* BLOB server state: ==0 disable | !=0 enable */
218:
219: ait_val_t dir; /* BLOB states directory */
220:
221: rpc_cli_t server; /* BLOB server socket */
222: array_t *clients; /* connected blob client sockets */
223:
224: TAILQ_HEAD(, tagBLOB) blobs; /* registered blob variables list */
225: } srv_blob;
226: } rpc_srv_t;
227:
228:
229: /*
230: * (*rpc_callback_t)() - Callback type definition for RPC call in server process
231: *
232: * @arg1 = current execution RPC call function
233: * @arg2 = number of items in input array from call request
234: * @arg3 = input array with values from RPC call execution request
235: * return: -1 error or >-1 success execution
236: */
237: typedef int (*rpc_callback_t)(rpc_func_t *, int, array_t *);
238:
239:
240: // -----------------------------------------------------------------------
241:
242: /* Error support functions */
243:
244: // rpc_GetErrno() Get error code of last operation
245: inline int rpc_GetErrno();
246: // rpc_GetError() Get error text of last operation
247: inline const char *rpc_GetError();
248:
249:
250: /*
251: * rpc_chkPktSession() - Check RPC session
252: *
253: * @p = packet session
254: * @s = active session
255: * return: -1, 1, 2, 3 are errors or 0 ok
256: */
257: inline int rpc_chkPktSession(rpc_sess_t *p, rpc_sess_t *s);
258: /*
259: * rpc_addPktSession() - Prepare session into network format
260: *
261: * @p = packet session
262: * @s = host session
263: * return: -1 error or 0 ok
264: */
265: inline int rpc_addPktSession(rpc_sess_t *p, rpc_sess_t *s);
266: /*
267: * rpc_register_srvServices() - Register internal service functions
268: *
269: * @srv = RPC server instance
270: * return: -1 error or 0 ok
271: */
272: int rpc_register_srvServices(rpc_srv_t * __restrict srv);
273: /*
274: * rpc_register_blobServices() - Register internal service functions
275: *
276: * @srv = RPC server instance
277: * return: -1 error or 0 ok
278: */
279: int rpc_register_blobServices(rpc_srv_t * __restrict srv);
280:
281:
282: /* RPC Server side functions */
283:
284: /*
285: * rpc_srv_initServer() - Init & create RPC Server
286: *
287: * @regProgID = ProgramID for authentication & recognition
288: * @regProcID = ProcessID for authentication & recognition
289: * @concurentClients = Concurent clients at same time to this server
290: * @netBuf = Network buffer length, if =0 == BUFSIZ (also meaning max RPC packet)
291: * @csHost = Host name or address for bind server, if NULL any address
292: * @Port = Port for bind server, if Port == 0 default port is selected
293: * return: NULL == error or !=NULL bind and created RPC server instance
294: */
295: rpc_srv_t *rpc_srv_initServer(unsigned int regProgID, unsigned char regProcID,
296: int concurentClients, int netBuf,
297: const char *csHost, unsigned short Port);
298: /*
299: * rpc_srv_endServer() - Destroy RPC server, close all opened sockets and free resources
300: *
301: * @psrv = RPC Server instance
302: * return: none
303: */
304: void rpc_srv_endServer(rpc_srv_t ** __restrict psrv);
305: /*
306: * rpc_srv_loopServer() - Execute Main server loop and wait for clients requests
307: *
308: * @srv = RPC Server instance
309: * return: -1 error or 0 ok, infinite loop ...
310: */
311: int rpc_srv_loopServer(rpc_srv_t * __restrict srv);
312: #define rpc_srv_execServer(_srv, _sync) do { assert((_srv)); pthread_t __tid; \
313: if (!(_srv)->srv_kill) { \
314: pthread_create(&__tid, NULL, (void*(*)(void*)) \
315: rpc_srv_loopServer, (_srv)); \
316: if ((_sync)) \
317: pthread_join(__tid, (void**) (_sync)); \
318: else \
319: pthread_detach(__tid); \
320: } } while (0)
321:
322: /*
323: * rpc_srv_initBLOBServer() - Init & create BLOB Server
324: *
325: * @srv = RPC server instance
326: * @Port = Port for bind server, if Port == 0 default port is selected
327: * @diskDir = Disk place for BLOB file objects
328: * return: -1 == error or 0 bind and created BLOB server instance
329: */
330: int rpc_srv_initBLOBServer(rpc_srv_t * __restrict srv, u_short Port, const char *diskDir);
331: /*
332: * rpc_srv_endBLOBServer() - Destroy BLOB server, close all opened sockets and free resources
333: *
334: * @srv = RPC Server instance
335: * return: none
336: */
337: void rpc_srv_endBLOBServer(rpc_srv_t * __restrict srv);
338: /*
339: * rpc_srv_loopBLOB() - Execute Main BLOB server loop and wait for clients requests
340: *
341: * @srv = RPC Server instance
342: * return: -1 error or 0 ok, infinite loop ...
343: */
344: int rpc_srv_loopBLOBServer(rpc_srv_t * __restrict srv);
345: #define rpc_srv_execBLOBServer(_srv) do { assert((_srv)); pthread_t __tid; \
346: if (!(_srv)->srv_kill && !(_srv)->srv_blob.kill) { \
347: pthread_create(&__tid, NULL, (void*(*)(void*)) \
348: rpc_srv_loopBLOBServer, (_srv)); \
349: pthread_detach(__tid); \
350: } \
351: } while (0)
352:
353: /*
354: * rpc_srv_registerCall() - Register call to RPC server
355: *
356: * @srv = RPC Server instance
357: * @tag = Function tag
358: * @funcaddr = Function address
359: * @args = Number of return function arguments
360: * return: -1 error, 0 already registered tag or 1 register ok
361: */
362: int rpc_srv_registerCall(rpc_srv_t * __restrict srv, unsigned short tag,
363: void *funcaddr, unsigned short args);
364: /*
365: * rpc_srv_unregisterCall() - Unregister call from RPC server
366: *
367: * @srv = RPC Server instance
368: * @tag = Function tag
369: * return: -1 error, 0 not found call, 1 unregister ok
370: */
371: int rpc_srv_unregisterCall(rpc_srv_t * __restrict srv, unsigned short tag);
372: /*
373: * rpc_srv_getCall() - Get registered call from RPC server
374: *
375: * @srv = RPC Server instance
376: * @tag = tag for function
377: * return: NULL not found call, !=NULL return call
378: */
379: inline rpc_func_t *rpc_srv_getCall(rpc_srv_t * __restrict srv, uint16_t tag);
380: /*
381: * rpc_srv_execCall() - Execute registered call from RPC server
382: *
383: * @call = Register RPC call
384: * @rpc = IN RPC call structure
385: * @args = IN RPC calling arguments from RPC client
386: * return: -1 error, !=-1 ok
387: */
388: int rpc_srv_execCall(rpc_func_t * __restrict call, struct tagRPCCall * __restrict rpc,
389: array_t * __restrict args);
390:
391:
392: /*
393: * rpc_srv_blobCreate() - Create and map blob to memory region and return object
394: *
395: * @srv = RPC Server instance
396: * @len = BLOB length object
397: * return: NULL error or !=NULL allocated BLOB object
398: */
399: inline rpc_blob_t *rpc_srv_blobCreate(rpc_srv_t * __restrict srv, int len);
400: /*
401: * rpc_srv_blobMap() - Map blob to memory region
402: *
403: * @srv = RPC Server instance
404: * @blob = Map to this BLOB element
405: * return: -1 error or 0 ok
406: */
407: inline int rpc_srv_blobMap(rpc_srv_t * __restrict srv, rpc_blob_t * __restrict blob);
408: /*
409: * rpc_srv_blobUnmap() - Unmap blob memory region
410: *
411: * @blob = Mapped BLOB element
412: * return: none
413: */
414: inline void rpc_srv_blobUnmap(rpc_blob_t * __restrict blob);
415: /*
416: * rpc_srv_blobFree() - Free blob from disk & memory
417: *
418: * @srv = RPC Server instance
419: * @blob = Mapped BLOB element
420: * return: -1 error or 0 ok
421: */
422: inline int rpc_srv_blobFree(rpc_srv_t * __restrict srv, rpc_blob_t * __restrict blob);
423:
424: /*
425: * rpc_srv_registerBLOB() - Register new BLOB to server
426: *
427: * @srv = RPC Server instance
428: * @len = BLOB length
429: * return: NULL error or new registered BLOB
430: */
431: rpc_blob_t *rpc_srv_registerBLOB(rpc_srv_t * __restrict srv, size_t len);
432: /*
433: * rpc_srv_unregisterBLOB() - Unregister BLOB from server
434: *
435: * @srv = RPC Server instance
436: * @var = BLOB Variable for unregister
437: * return: -1 error, 0 not found call, 1 unregister ok
438: */
439: int rpc_srv_unregisterBLOB(rpc_srv_t * __restrict srv, uint32_t var);
440: /*
441: * rpc_srv_getBLOB() - Get registered BLOB
442: *
443: * @srv = RPC Server instance
444: * @var = hash for variable
445: * return: NULL not found, !=NULL return blob var
446: */
447: inline rpc_blob_t *rpc_srv_getBLOB(rpc_srv_t * __restrict srv, uint32_t var);
448:
449: /*
450: * rpc_srv_sendBLOB() - Send mapped BLOB to client
451: *
452: * @cli = Client instance
453: * @blob = Mapped BLOB element
454: * return: -1 error, 0 ok
455: */
456: int rpc_srv_sendBLOB(rpc_cli_t * __restrict cli, rpc_blob_t * __restrict blob);
457: /*
458: * rpc_srv_recvBLOB() - Receive BLOB from client
459: *
460: * @cli = Client instance
461: * @blob = Mapped BLOB element
462: * return: -1 error, 0 ok, >0 unreceived data from client, may be error?
463: */
464: int rpc_srv_recvBLOB(rpc_cli_t * __restrict cli, rpc_blob_t * __restrict blob);
465:
466: /* CLIENT part of functions */
467:
468: /*
469: * rpc_cli_sendBLOB() - Send BLOB to server
470: *
471: * @cli = Client instance
472: * @var = BLOB variable
473: * @data = BLOB data
474: * return: -1 error, 0 ok, 1 remote error
475: */
476: int rpc_cli_sendBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var, void * __restrict data);
477: /*
478: * rpc_cli_recvBLOB() - Receive BLOB from server
479: *
480: * @cli = Client instance
481: * @var = BLOB variable
482: * @data = BLOB data, must be free after use!
483: * return: -1 error, 0 ok, 1 remote error
484: */
485: int rpc_cli_recvBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var, void ** __restrict data);
486: /*
487: * rpc_cli_delBLOB() - Delete BLOB from server
488: *
489: * @cli = Client instance
490: * @var = BLOB variable
491: * return: -1 error, 0 ok, 1 remote error
492: */
493: int rpc_cli_delBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var);
494: /*
495: * rpc_cli_getBLOB() - Receive BLOB from server and Delete after that.
496: *
497: * @cli = Client instance
498: * @var = BLOB variable
499: * @data = BLOB data, must be free after use!
500: * return: -1 error, 0 ok, >0 remote error
501: */
502: inline int rpc_cli_getBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var,
503: void ** __restrict data);
504:
505:
506: /* RPC Client side functions */
507:
508: /*
509: * rpc_cli_openClient() - Connect to RPC Server
510: *
511: * @ProgID = ProgramID for RPC session request
512: * @ProcID = ProcessID for RPC session request
513: * @netBuf = Network buffer length, if =0 == BUFSIZ (also meaning max RPC packet)
514: * @family = Family socket type, AF_INET or AF_INET6
515: * @csHost = Host name or IP address for bind server
516: * @Port = Port for bind server, if Port == 0 default port is selected
517: * return: NULL == error or !=NULL connection to RPC server established
518: */
519: rpc_cli_t *rpc_cli_openClient(unsigned int ProgID, unsigned char ProcID, int netBuf,
520: unsigned short family, 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: * @tag = Function tag for execution
534: * @in_vars = IN RPC call array of rpc values
535: * @out_vars = OUT returned array of rpc values, must be free after use with rpc_cli_freeVals()
536: * return: -1 error or != -1 ok result
537: */
538: int rpc_cli_execCall(rpc_cli_t *cli, int noreply, u_short tag,
539: array_t * __restrict in_vars, array_t ** __restrict out_vars);
540:
541:
542: /*
543: * rpc_cli_openBLOBClient() - Connect to BLOB Server
544: *
545: * @rpccli = RPC Client session
546: * @Port = Port for bind server, if Port == 0 default port is selected
547: * return: NULL == error or !=NULL connection to BLOB server established
548: */
549: rpc_cli_t *rpc_cli_openBLOBClient(rpc_cli_t * __restrict rpccli, u_short Port);
550: /*
551: * rpc_cli_closeBLOBClient() - Close connection to BLOB server and free resources
552: *
553: * @cli = BLOB Client session
554: * return: none
555: */
556: void rpc_cli_closeBLOBClient(rpc_cli_t ** __restrict cli);
557:
558:
559: #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