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: cli.c,v 1.19.6.2 2013/11/15 09:18:38 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, 2013
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: #include "global.h"
47:
48:
49: /*
50: * rpc_cli_openBLOBClient() - Connect to BLOB Server
51: *
52: * @rpccli = RPC Client session
53: * @Port = Port for bind server, if Port == 0 default port is selected
54: * return: NULL == error or !=NULL connection to BLOB server established
55: */
56: rpc_cli_t *
57: rpc_cli_openBLOBClient(rpc_cli_t * __restrict rpccli, u_short Port)
58: {
59: rpc_cli_t *cli = NULL;
60: int n;
61:
62: if (!rpccli) {
63: rpc_SetErr(EINVAL, "Invalid parameters can`t connect to BLOB server");
64: return NULL;
65: }
66:
67: cli = e_malloc(sizeof(rpc_cli_t));
68: if (!cli) {
69: LOGERR;
70: return NULL;
71: } else
72: memcpy(cli, rpccli, sizeof(rpc_cli_t));
73:
74: memcpy(&cli->cli_sa, &rpccli->cli_sa, sizeof(sockaddr_t));
75: switch (cli->cli_sa.sa.sa_family) {
76: case AF_INET:
77: cli->cli_sa.sin.sin_port =
78: htons(Port ? Port : ntohs(cli->cli_sa.sin.sin_port) + 1);
79: break;
80: case AF_INET6:
81: cli->cli_sa.sin6.sin6_port =
82: htons(Port ? Port : ntohs(cli->cli_sa.sin6.sin6_port) + 1);
83: break;
84: case AF_LOCAL:
85: strlcat(cli->cli_sa.sun.sun_path, ".blob", sizeof cli->cli_sa.sun.sun_path);
86: break;
87: default:
88: rpc_SetErr(EINVAL, "Invalid socket type %d", cli->cli_sa.sa.sa_family);
89: return NULL;
90: }
91:
92: AIT_COPY_VAL(&cli->cli_buf, &rpccli->cli_buf);
93: n = AIT_LEN(&cli->cli_buf);
94:
95: /* connect to BLOB server */
96: cli->cli_sock = socket(cli->cli_sa.sa.sa_family, SOCK_STREAM, 0);
97: if (cli->cli_sock == -1) {
98: LOGERR;
99: e_free(cli);
100: return NULL;
101: }
102: if (setsockopt(cli->cli_sock, SOL_SOCKET, SO_SNDBUF, &n, sizeof n) == -1) {
103: LOGERR;
104: close(cli->cli_sock);
105: e_free(cli);
106: return NULL;
107: }
108: if (setsockopt(cli->cli_sock, SOL_SOCKET, SO_RCVBUF, &n, sizeof n) == -1) {
109: LOGERR;
110: close(cli->cli_sock);
111: e_free(cli);
112: return NULL;
113: }
114: if (connect(cli->cli_sock, &cli->cli_sa.sa, cli->cli_sa.sa.sa_len) == -1) {
115: LOGERR;
116: close(cli->cli_sock);
117: e_free(cli);
118: return NULL;
119: } else
120: fcntl(cli->cli_sock, F_SETFL, fcntl(cli->cli_sock, F_GETFL) | O_NONBLOCK);
121:
122: return cli;
123: }
124:
125: /*
126: * rpc_cli_closeBLOBClient() - Close connection to BLOB server and free resources
127: *
128: * @cli = BLOB Client session
129: * return: none
130: */
131: void
132: rpc_cli_closeBLOBClient(rpc_cli_t ** __restrict cli)
133: {
134: if (!cli || !*cli)
135: return;
136:
137: shutdown((*cli)->cli_sock, SHUT_RDWR);
138: close((*cli)->cli_sock);
139:
140: AIT_FREE_VAL(&(*cli)->cli_buf);
141:
142: e_free(*cli);
143: *cli = NULL;
144: }
145:
146: /* -------------------------------------------------------------- */
147:
148: /*
149: * rpc_cli_openClient() - Connect to RPC Server
150: *
151: * @InstID = InstID for RPC session request
152: * @netBuf = Network buffer length (min:512 bytes), if =0 == BUFSIZ (also meaning max RPC packet)
153: * @csHost = Host name or IP address for bind server
154: * @Port = Port for bind server, if Port == 0 default port is selected
155: * @proto = Protocol, if == 0 choose SOCK_STREAM
156: * return: NULL == error or !=NULL connection to RPC server established
157: */
158: rpc_cli_t *
159: rpc_cli_openClient(u_char InstID, int netBuf, const char *csHost, u_short Port, int proto)
160: {
161: rpc_cli_t *cli = NULL;
162: sockaddr_t sa = E_SOCKADDR_INIT;
163:
164: if (!e_gethostbyname(csHost, Port, &sa))
165: return NULL;
166: if (!Port)
167: Port = RPC_DEFPORT;
168: if (!proto)
169: proto = SOCK_STREAM;
170: if (netBuf < RPC_MIN_BUFSIZ)
171: netBuf = BUFSIZ;
172: else
173: netBuf = E_ALIGN(netBuf, 2); /* align netBuf length */
174:
175: cli = e_malloc(sizeof(rpc_cli_t));
176: if (!cli) {
177: LOGERR;
178: return NULL;
179: } else
180: memset(cli, 0, sizeof(rpc_cli_t));
181:
182: /* build session */
183: cli->cli_parent = e_malloc(sizeof(rpc_sess_t));
184: if (!cli->cli_parent) {
185: LOGERR;
186: e_free(cli);
187: return NULL;
188: } else {
189: ((rpc_sess_t*) cli->cli_parent)->sess_version = RPC_VERSION;
190: ((rpc_sess_t*) cli->cli_parent)->sess_instance = InstID;
191: }
192:
193: cli->cli_id = proto;
194: memcpy(&cli->cli_sa, &sa, sizeof cli->cli_sa);
195: AIT_SET_BUFSIZ(&cli->cli_buf, 0, netBuf);
196:
197: /* connect to RPC server */
198: cli->cli_sock = socket(cli->cli_sa.sa.sa_family, cli->cli_id, 0);
199: if (cli->cli_sock == -1) {
200: LOGERR;
201: goto err;
202: }
203: if (setsockopt(cli->cli_sock, SOL_SOCKET, SO_SNDBUF,
204: &netBuf, sizeof netBuf) == -1) {
205: LOGERR;
206: goto err;
207: }
208: if (setsockopt(cli->cli_sock, SOL_SOCKET, SO_RCVBUF,
209: &netBuf, sizeof netBuf) == -1) {
210: LOGERR;
211: goto err;
212: }
213: if (cli->cli_id == SOCK_STREAM)
214: if (connect(cli->cli_sock, &cli->cli_sa.sa, cli->cli_sa.sa.sa_len) == -1) {
215: LOGERR;
216: goto err;
217: }
218:
219: fcntl(cli->cli_sock, F_SETFL, fcntl(cli->cli_sock, F_GETFL) | O_NONBLOCK);
220: return cli;
221: err:
222: AIT_FREE_VAL(&cli->cli_buf);
223: if (cli->cli_sock > 2)
224: close(cli->cli_sock);
225: e_free(cli->cli_parent);
226: e_free(cli);
227: return NULL;
228: }
229:
230: /*
231: * rpc_cli_closeClient() - Close connection to RPC server and free resources
232: *
233: * @cli = RPC Client session
234: * return: none
235: */
236: void
237: rpc_cli_closeClient(rpc_cli_t ** __restrict cli)
238: {
239: if (!cli || !*cli)
240: return;
241:
242: if ((*cli)->cli_id == SOCK_STREAM)
243: shutdown((*cli)->cli_sock, SHUT_RDWR);
244: close((*cli)->cli_sock);
245:
246: AIT_FREE_VAL(&(*cli)->cli_buf);
247:
248: if ((*cli)->cli_parent)
249: e_free((*cli)->cli_parent);
250:
251: e_free(*cli);
252: *cli = NULL;
253: }
254:
255: /*
256: * rpc_pkt_Send() - Send RPC packet
257: *
258: * @sock = Socket
259: * @type = Type of socket
260: * @sa = Server address
261: * @pkt = RPC packet
262: * @len = Length of packet
263: * return: -1 error or !=-1 sended bytes
264: */
265: int
266: rpc_pkt_Send(int sock, int type, sockaddr_t * __restrict sa, ait_val_t * __restrict pkt, int len)
267: {
268: u_char *buf;
269:
270: if (!pkt) {
271: rpc_SetErr(EINVAL, "Invalid argument(s)!");
272: return -1;
273: } else
274: buf = AIT_GET_BUF(pkt);
275:
276: return rpc_Write(sock, type, MSG_NOSIGNAL, sa, buf, len);
277: }
278:
279: /*
280: * rpc_pkt_Receive() - Receive RPC packet
281: *
282: * @sock = Socket
283: * @type = Type of socket
284: * @sa = Server address
285: * @pkt = RPC packet
286: * return: -1 error or !=-1 sended bytes
287: */
288: int
289: rpc_pkt_Receive(int sock, int type, sockaddr_t * __restrict sa, ait_val_t * __restrict pkt)
290: {
291: int ret, estlen = 0, blen = sizeof(struct tagRPCCall);
292: u_char *buf;
293: struct tagRPCCall *rpc;
294:
295: if (!pkt) {
296: rpc_SetErr(EINVAL, "Invalid argument(s)!");
297: return -1;
298: } else
299: buf = AIT_GET_BUF(pkt);
300:
301: /* reply from RPC server */
302: do {
303: if (type == SOCK_STREAM)
304: ret = rpc_Read(sock, type, !estlen ? MSG_PEEK : 0, NULL, buf, blen);
305: else
306: ret = rpc_Read(sock, type, !estlen ? MSG_PEEK : 0, sa, buf, blen);
307: if (ret < 1)
308: return -1;
309:
310: /* check for response from known address */
311: if (!estlen) {
312: /* 1st read for RPC header */
313: if (ret < sizeof(struct tagRPCCall)) {
314: rpc_SetErr(ERPCMISMATCH, "Short RPC packet %d bytes", ret);
315: return -1;
316: }
317:
318: /* calc estimated length */
319: rpc = (struct tagRPCCall*) buf;
320: estlen = ntohl(rpc->call_len);
321: if (estlen > AIT_LEN(pkt))
322: AIT_RE_BUF(pkt, estlen);
323: buf = AIT_GET_BUF(pkt);
324: blen = estlen;
325: rpc = (struct tagRPCCall*) buf;
326: continue;
327: }
328:
329: /* compiler optimize loop if while(0) and stop working 'continue' on some platforms */
330: break;
331: } while (42);
332:
333: if (ret < sizeof(struct tagRPCCall) || estlen != ret) {
334: rpc_SetErr(ERPCMISMATCH, "RPC packet mismatch estimate %d bytes, but received %d\n",
335: estlen, ret);
336: return -1;
337: }
338:
339: return ret;
340: }
341:
342: /*
343: * rpc_pkt_Request() - Build RPC Request packet
344: *
345: * @pkt = Packet buffer
346: * @sess = RPC session info
347: * @tag = Function tag for execution
348: * @vars = Function argument array of values, may be NULL
349: * @noreply = We not want RPC reply
350: * @nocrc = Without CRC calculation
351: * return: -1 error or != -1 prepared bytes into packet
352: */
353: int
354: rpc_pkt_Request(ait_val_t * __restrict pkt, rpc_sess_t * __restrict sess, u_short tag,
355: array_t * __restrict vars, int noreply, int nocrc)
356: {
357: struct tagRPCCall *rpc;
358: int ret = 0, estlen, len = sizeof(struct tagRPCCall);
359: u_char *buf;
360:
361: if (!pkt || !sess) {
362: rpc_SetErr(EINVAL, "Invalid argument(s)!");
363: return -1;
364: }
365:
366: /* calc estimated length */
367: estlen = ait_resideVars(vars) + len;
368: if (estlen > AIT_LEN(pkt))
369: AIT_RE_BUF(pkt, estlen);
370: buf = AIT_GET_BUF(pkt);
371:
372: /* prepare RPC call */
373: rpc = (struct tagRPCCall*) buf;
374: rpc_addPktSession(&rpc->call_session, sess);
375: rpc->call_tag = htons(tag);
376: if (!vars)
377: rpc->call_argc = 0;
378: else
379: rpc->call_argc = htons(array_Size(vars));
380:
381: /* set reply */
382: rpc->call_req.flags = (uint64_t) htonl(noreply ? RPC_NOREPLY : RPC_REPLY);
383:
384: if (array_Size(vars)) {
385: /* marshaling variables */
386: ret = ait_vars2buffer(buf + len, AIT_LEN(pkt) - len, vars);
387: if (ret == -1) {
388: rpc_SetErr(EBADRPC, "Failed to prepare RPC packet values");
389: return -1;
390: } else
391: len += ret;
392: }
393:
394: /* total packet length */
395: rpc->call_len = htonl(len);
396:
397: if (!nocrc) {
398: /* calculate CRC */
399: rpc->call_crc ^= rpc->call_crc;
400: rpc->call_crc = htons(crcFletcher16((u_short*) buf, len / 2));
401: }
402:
403: return len;
404: }
405:
406: /*
407: * rpc_pkt_Replay() - Decode RPC Replay packet
408: *
409: * @pkt = Packet buffer
410: * @sess = RPC session info
411: * @tag = Function tag
412: * @vars = Function argument array of values, may be NULL
413: * @nocrc = Without CRC calculation
414: * return: -1 error or != -1 return value from function
415: */
416: int
417: rpc_pkt_Replay(ait_val_t * __restrict pkt, rpc_sess_t * __restrict sess, u_short tag,
418: array_t ** __restrict vars, int nocrc)
419: {
420: struct tagRPCCall *rpc;
421: int len;
422: u_char *buf;
423: uint16_t crc;
424:
425: if (!pkt || !sess) {
426: rpc_SetErr(EINVAL, "Invalid argument(s)!");
427: return -1;
428: } else
429: buf = AIT_GET_BUF(pkt);
430:
431: rpc = (struct tagRPCCall*) buf;
432: if (!nocrc) {
433: /* calculate CRC */
434: crc = ntohs(rpc->call_crc);
435: rpc->call_crc ^= rpc->call_crc;
436: if (crc != crcFletcher16((u_short*) buf, ntohl(rpc->call_len) / 2)) {
437: rpc_SetErr(ERPCMISMATCH, "Bad CRC RPC packet");
438: return -1;
439: }
440: }
441:
442: /* check RPC packet session info */
443: if (rpc_chkPktSession(&rpc->call_session, sess)) {
444: rpc_SetErr(ERPCMISMATCH, "Get invalid RPC session");
445: return -1;
446: }
447: if (ntohs(rpc->call_tag) != tag) {
448: rpc_SetErr(ERPCMISMATCH, "Get wrong RPC reply");
449: return -1;
450: }
451: if (ntohl(rpc->call_rep.eno) && ntohl(rpc->call_rep.ret) == -1) {
452: rpc_SetErr(ntohl(rpc->call_rep.eno), "Server side: retcode=%d #%d %s",
453: ntohl(rpc->call_rep.ret), ntohl(rpc->call_rep.eno),
454: strerror(ntohl(rpc->call_rep.eno)));
455: return -1;
456: }
457: len = ntohs(rpc->call_argc) * sizeof(ait_val_t);
458: if (len > AIT_LEN(pkt) - sizeof(struct tagRPCCall)) {
459: rpc_SetErr(EMSGSIZE, "Reply RPC packet not enough buffer space ...");
460: return -1;
461: }
462: if (len > ntohl(rpc->call_len) - sizeof(struct tagRPCCall)) {
463: rpc_SetErr(EMSGSIZE, "Reply RPC packet is too short ...");
464: return -1;
465: }
466:
467: /* RPC is OK! Go de-marshaling variables ... */
468: if (vars && ntohs(rpc->call_argc)) {
469: #ifdef CLI_RES_ZCOPY
470: *vars = ait_buffer2vars(buf + sizeof(struct tagRPCCall), len,
471: ntohs(rpc->call_argc), 42);
472: #else
473: *vars = ait_buffer2vars(buf + sizeof(struct tagRPCCall), len,
474: ntohs(rpc->call_argc), 0);
475: #endif
476: if (!*vars) {
477: rpc_SetErr(elwix_GetErrno(), "%s", elwix_GetError());
478: return -1;
479: }
480: }
481:
482: return ntohl(rpc->call_rep.ret);
483: }
484:
485: /*
486: * rpc_cli_execCall() - Execute RPC call
487: *
488: * @cli = RPC Client session
489: * @noreply = We not want RPC reply
490: * @tag = Function tag for execution
491: * @in_vars = IN function argument array of values, may be NULL
492: * @out_vars = OUT returned array of rpc values, if !=NULL must be free after use with ait_freeVars()
493: * return: -1 error or != -1 ok result
494: */
495: int
496: rpc_cli_execCall(rpc_cli_t *cli, int noreply, u_short tag,
497: array_t * __restrict in_vars, array_t ** __restrict out_vars)
498: {
499: int type = 0, wlen;
500: u_char *buf;
501:
502: if (!cli) {
503: rpc_SetErr(EINVAL, "Can`t execute call because parameter is null or invalid!");
504: return -1;
505: } else {
506: if (cli->cli_id == SOCK_STREAM)
507: type = cli->cli_id;
508: buf = AIT_GET_BUF(&cli->cli_buf);
509: }
510: if (out_vars)
511: *out_vars = NULL;
512:
513: if ((wlen = rpc_pkt_Request(&cli->cli_buf, cli->cli_parent, tag, in_vars, noreply, type)) == -1)
514: return -1;
515:
516: if (rpc_pkt_Send(cli->cli_sock, cli->cli_id, &cli->cli_sa, &cli->cli_buf, wlen) == -1)
517: return -1;
518:
519: if (noreply) /* we not want reply */
520: return 0;
521:
522: if (rpc_pkt_Receive(cli->cli_sock, cli->cli_id, &cli->cli_sa, &cli->cli_buf) == -1)
523: return -1;
524:
525: if ((wlen = rpc_pkt_Replay(&cli->cli_buf, cli->cli_parent, tag, out_vars, type)) == -1)
526: return -1;
527:
528: return 0;
529: }
530:
531: /*
532: * rpc_cli_freeCall() - Free resouce allocated by RPC call
533: *
534: * @out_vars = Returned array with variables from RPC call
535: * return: none
536: */
537: void
538: rpc_cli_freeCall(array_t ** __restrict out_vars)
539: {
540: #ifdef CLI_RES_ZCOPY
541: array_Destroy(out_vars);
542: #else
543: ait_freeVars(out_vars);
544: #endif
545: }
546:
547: /*
548: * rpc_cli_ping() - Ping RPC server
549: *
550: * @cli = connected client
551: * return: -1 error or !=-1 ping seq id
552: */
553: int
554: rpc_cli_ping(rpc_cli_t *cli)
555: {
556: int ret = 0;
557: array_t *arr = NULL;
558:
559: if (!cli)
560: return -1;
561:
562: if (rpc_cli_execCall(cli, RPC_REPLY, CALL_SRVPING, NULL, &arr))
563: return -1;
564: else
565: ret = AIT_GET_U16(array(arr, 0, ait_val_t*));
566: rpc_cli_freeCall(&arr);
567:
568: return ret;
569: }
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/cvsweb/back.gif){kind=icon}
Return to cli.c CVS log ![[TXT]](/icons/cvsweb/text.gif){kind=icon}
![[DIR]](/icons/cvsweb/dir.gif){kind=icon}
Up to [ELWIX - Embedded LightWeight unIX -] / libaitrpc / src