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