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