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