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