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