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