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.22.6.1 2014/11/12 21:37:51 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 - 2014
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_reconnectClient() - Reconnecting client to RPC server
232: *
233: * @cli = RPC Client session
234: * return: -1 error or 0 ok
235: */
236: int
237: rpc_cli_reconnectClient(rpc_cli_t * __restrict cli)
238: {
239: int netBuf;
240:
241: if (!cli)
242: return -1;
243: else
244: netBuf = AIT_LEN(&cli->cli_buf);
245:
246: close(cli->cli_sock);
247:
248: cli->cli_sock = socket(cli->cli_sa.sa.sa_family, cli->cli_id, 0);
249: if (cli->cli_sock == -1) {
250: LOGERR;
251: return -1;
252: }
253: if (setsockopt(cli->cli_sock, SOL_SOCKET, SO_SNDBUF,
254: &netBuf, sizeof netBuf) == -1) {
255: LOGERR;
256: close(cli->cli_sock);
257: return -1;
258: }
259: if (setsockopt(cli->cli_sock, SOL_SOCKET, SO_RCVBUF,
260: &netBuf, sizeof netBuf) == -1) {
261: LOGERR;
262: close(cli->cli_sock);
263: return -1;
264: }
265: if (cli->cli_id == SOCK_STREAM)
266: if (connect(cli->cli_sock, &cli->cli_sa.sa, cli->cli_sa.sa.sa_len) == -1) {
267: LOGERR;
268: close(cli->cli_sock);
269: return -1;
270: }
271:
272: fcntl(cli->cli_sock, F_SETFL, fcntl(cli->cli_sock, F_GETFL) | O_NONBLOCK);
273: return 0;
274: }
275:
276: /*
277: * rpc_cli_closeClient() - Close connection to RPC server and free resources
278: *
279: * @cli = RPC Client session
280: * return: none
281: */
282: void
283: rpc_cli_closeClient(rpc_cli_t ** __restrict cli)
284: {
285: if (!cli || !*cli)
286: return;
287:
288: if ((*cli)->cli_id == SOCK_STREAM)
289: shutdown((*cli)->cli_sock, SHUT_RDWR);
290: close((*cli)->cli_sock);
291:
292: AIT_FREE_VAL(&(*cli)->cli_buf);
293:
294: if ((*cli)->cli_parent)
295: e_free((*cli)->cli_parent);
296:
297: e_free(*cli);
298: *cli = NULL;
299: }
300:
301: /*
302: * rpc_pkt_Send() - Send RPC packet
303: *
304: * @sock = Socket
305: * @type = Type of socket
306: * @sa = Server address
307: * @pkt = RPC packet
308: * @len = Length of packet
309: * return: -1 error, 0 EOF or >0 sended bytes
310: */
311: int
312: rpc_pkt_Send(int sock, int type, sockaddr_t * __restrict sa, ait_val_t * __restrict pkt, int len)
313: {
314: u_char *buf;
315:
316: if (!pkt) {
317: rpc_SetErr(EINVAL, "Invalid argument(s)!");
318: return -1;
319: } else
320: buf = AIT_GET_BUF(pkt);
321:
322: return rpc_Write(sock, type, MSG_NOSIGNAL, sa, buf, len);
323: }
324:
325: /*
326: * rpc_pkt_Receive() - Receive RPC packet
327: *
328: * @sock = Socket
329: * @type = Type of socket
330: * @sa = Server address
331: * @pkt = RPC packet
332: * return: -1 error, 0 EOF or >0 received bytes
333: */
334: int
335: rpc_pkt_Receive(int sock, int type, sockaddr_t * __restrict sa, ait_val_t * __restrict pkt)
336: {
337: int ret, estlen = 0, blen = sizeof(struct tagRPCCall);
338: u_char *buf;
339: struct tagRPCCall *rpc;
340:
341: if (!pkt) {
342: rpc_SetErr(EINVAL, "Invalid argument(s)!");
343: return -1;
344: } else {
345: buf = AIT_GET_BUF(pkt);
346: rpc = (struct tagRPCCall*) buf;
347: }
348:
349: /* reply from RPC server */
350: do {
351: if (type == SOCK_STREAM)
352: ret = rpc_Read(sock, type, !estlen ? MSG_PEEK : 0, NULL, buf, blen);
353: else
354: ret = rpc_Read(sock, type, !estlen ? MSG_PEEK : 0, sa, buf, blen);
355: if (ret < 1)
356: return ret;
357:
358: /* check for response from known address */
359: if (!estlen) {
360: /* 1st read for RPC header */
361: if (ret < sizeof(struct tagRPCCall)) {
362: rpc_SetErr(ERPCMISMATCH, "Short RPC packet %d bytes", ret);
363: return -1;
364: }
365:
366: /* calc estimated length */
367: estlen = ntohl(rpc->call_len);
368: if (estlen > AIT_LEN(pkt))
369: AIT_RE_BUF(pkt, estlen);
370: buf = AIT_GET_BUF(pkt);
371: rpc = (struct tagRPCCall*) buf;
372: blen = estlen;
373: continue;
374: }
375:
376: /* compiler optimize loop if while(0) and stop working 'continue' on some platforms */
377: break;
378: } while (42);
379:
380: if (ret < sizeof(struct tagRPCCall) || estlen != ret) {
381: rpc_SetErr(ERPCMISMATCH, "RPC packet mismatch estimate %d bytes, but received %d\n",
382: estlen, ret);
383: return -1;
384: }
385:
386: return ret;
387: }
388:
389: /*
390: * rpc_pkt_Request() - Build RPC Request packet
391: *
392: * @pkt = Packet buffer
393: * @sess = RPC session info
394: * @tag = Function tag for execution
395: * @vars = Function argument array of values, may be NULL
396: * @noreply = We not want RPC reply
397: * @nocrc = Without CRC calculation
398: * return: -1 error or != -1 prepared bytes into packet
399: */
400: int
401: rpc_pkt_Request(ait_val_t * __restrict pkt, rpc_sess_t * __restrict sess, u_short tag,
402: array_t * __restrict vars, int noreply, int nocrc)
403: {
404: struct tagRPCCall *rpc;
405: int ret = 0, estlen, len = sizeof(struct tagRPCCall);
406: u_char *buf;
407:
408: if (!pkt || !sess) {
409: rpc_SetErr(EINVAL, "Invalid argument(s)!");
410: return -1;
411: }
412:
413: /* calc estimated length */
414: estlen = ait_resideVars(vars) + len;
415: if (estlen > AIT_LEN(pkt))
416: AIT_RE_BUF(pkt, estlen);
417: buf = AIT_GET_BUF(pkt);
418:
419: /* prepare RPC call */
420: rpc = (struct tagRPCCall*) buf;
421: rpc_addPktSession(&rpc->call_session, sess);
422: rpc->call_tag = htons(tag);
423: if (!vars)
424: rpc->call_argc = 0;
425: else
426: rpc->call_argc = htons(array_Size(vars));
427:
428: /* set reply */
429: rpc->call_req.flags = (uint64_t) htonl(noreply ? RPC_NOREPLY : RPC_REPLY);
430:
431: if (array_Size(vars)) {
432: /* marshaling variables */
433: ret = ait_vars2buffer(buf + len, AIT_LEN(pkt) - len, vars);
434: if (ret == -1) {
435: rpc_SetErr(EBADRPC, "Failed to prepare RPC packet values");
436: return -1;
437: } else
438: len += ret;
439: }
440:
441: /* total packet length */
442: rpc->call_len = htonl(len);
443:
444: if (!nocrc) {
445: /* calculate CRC */
446: rpc->call_crc ^= rpc->call_crc;
447: rpc->call_crc = htons(crcFletcher16((u_short*) buf, len / 2));
448: }
449:
450: return len;
451: }
452:
453: /*
454: * rpc_pkt_Replay() - Decode RPC Replay packet
455: *
456: * @pkt = Packet buffer
457: * @sess = RPC session info, if =NULL don't check session
458: * @tag = Function tag
459: * @vars = Function argument array of values, may be NULL
460: * @nocrc = Without CRC calculation
461: * return: -1 error or != -1 return value from function
462: */
463: int
464: rpc_pkt_Replay(ait_val_t * __restrict pkt, rpc_sess_t * __restrict sess, u_short tag,
465: array_t ** __restrict vars, int nocrc)
466: {
467: struct tagRPCCall *rpc;
468: int len;
469: u_char *buf;
470: uint16_t crc;
471:
472: if (!pkt) {
473: rpc_SetErr(EINVAL, "Invalid argument(s)!");
474: return -1;
475: } else
476: buf = AIT_GET_BUF(pkt);
477:
478: rpc = (struct tagRPCCall*) buf;
479: if (!nocrc) {
480: /* calculate CRC */
481: crc = ntohs(rpc->call_crc);
482: rpc->call_crc ^= rpc->call_crc;
483: if (crc != crcFletcher16((u_short*) buf, ntohl(rpc->call_len) / 2)) {
484: rpc_SetErr(ERPCMISMATCH, "Bad CRC RPC packet");
485: return -1;
486: }
487: }
488:
489: /* check RPC packet session info */
490: if (sess && rpc_chkPktSession(&rpc->call_session, sess)) {
491: rpc_SetErr(ERPCMISMATCH, "Get invalid RPC session");
492: return -1;
493: }
494: if (ntohs(rpc->call_tag) != tag) {
495: rpc_SetErr(ERPCMISMATCH, "Get wrong RPC reply");
496: return -1;
497: }
498: if (ntohl(rpc->call_rep.eno) && ntohl(rpc->call_rep.ret) == -1) {
499: rpc_SetErr(ntohl(rpc->call_rep.eno), "Server side: retcode=%d #%d %s",
500: ntohl(rpc->call_rep.ret), ntohl(rpc->call_rep.eno),
501: strerror(ntohl(rpc->call_rep.eno)));
502: return -1;
503: }
504: len = ntohs(rpc->call_argc) * sizeof(ait_val_t);
505: if (len > AIT_LEN(pkt) - sizeof(struct tagRPCCall)) {
506: rpc_SetErr(EMSGSIZE, "Reply RPC packet not enough buffer space ...");
507: return -1;
508: }
509: if (len > ntohl(rpc->call_len) - sizeof(struct tagRPCCall)) {
510: rpc_SetErr(EMSGSIZE, "Reply RPC packet is too short ...");
511: return -1;
512: }
513:
514: /* RPC is OK! Go de-marshaling variables ... */
515: if (vars && ntohs(rpc->call_argc)) {
516: #ifdef CLI_RES_ZCOPY
517: *vars = ait_buffer2vars(buf + sizeof(struct tagRPCCall), len,
518: ntohs(rpc->call_argc), 42);
519: #else
520: *vars = ait_buffer2vars(buf + sizeof(struct tagRPCCall), len,
521: ntohs(rpc->call_argc), 0);
522: #endif
523: if (!*vars) {
524: rpc_SetErr(elwix_GetErrno(), "%s", elwix_GetError());
525: return -1;
526: }
527: }
528:
529: return ntohl(rpc->call_rep.ret);
530: }
531:
532: /*
533: * rpc_cli_execCall() - Execute RPC call
534: *
535: * @cli = RPC Client session
536: * @noreply = We not want RPC reply
537: * @tag = Function tag for execution
538: * @in_vars = IN function argument array of values, may be NULL
539: * @out_vars = OUT returned array of rpc values, if !=NULL must be free after use with ait_freeVars()
540: * return: -1 error, 0 ok result or 1 closed rpc connection
541: */
542: int
543: rpc_cli_execCall(rpc_cli_t *cli, int noreply, u_short tag,
544: array_t * __restrict in_vars, array_t ** __restrict out_vars)
545: {
546: int type = 0, wlen;
547: u_char *buf;
548:
549: if (!cli) {
550: rpc_SetErr(EINVAL, "Can`t execute call because parameter is null or invalid!");
551: return -1;
552: } else {
553: if (cli->cli_id == SOCK_STREAM)
554: type = cli->cli_id;
555: buf = AIT_GET_BUF(&cli->cli_buf);
556: }
557: if (out_vars)
558: *out_vars = NULL;
559:
560: if ((wlen = rpc_pkt_Request(&cli->cli_buf, cli->cli_parent, tag, in_vars, noreply, type)) == -1)
561: return -1;
562:
563: if ((wlen = rpc_pkt_Send(cli->cli_sock, cli->cli_id, &cli->cli_sa, &cli->cli_buf, wlen)) == -1)
564: return -1;
565: if (!wlen) /* closed rpc connection */
566: return 1;
567:
568: if (noreply) /* we not want reply */
569: return 0;
570:
571: if ((wlen = rpc_pkt_Receive(cli->cli_sock, cli->cli_id, &cli->cli_sa, &cli->cli_buf)) == -1)
572: return -1;
573: if (!wlen) /* closed rpc connection */
574: return 1;
575:
576: if ((wlen = rpc_pkt_Replay(&cli->cli_buf, cli->cli_parent, tag, out_vars, type)) == -1)
577: return -1;
578:
579: return 0;
580: }
581:
582: /*
583: * rpc_cli_freeCall() - Free resouce allocated by RPC call
584: *
585: * @out_vars = Returned array with variables from RPC call
586: * return: none
587: */
588: void
589: rpc_cli_freeCall(array_t ** __restrict out_vars)
590: {
591: #ifdef CLI_RES_ZCOPY
592: array_Destroy(out_vars);
593: #else
594: ait_freeVars(out_vars);
595: #endif
596: }
597:
598: /*
599: * rpc_cli_ping() - Ping RPC server
600: *
601: * @cli = connected client
602: * return: -1 error or !=-1 ping seq id
603: */
604: int
605: rpc_cli_ping(rpc_cli_t *cli)
606: {
607: int ret = 0;
608: array_t *arr = NULL;
609:
610: if (!cli)
611: return -1;
612:
613: if (rpc_cli_execCall(cli, RPC_REPLY, CALL_SRVPING, NULL, &arr))
614: return -1;
615: else
616: ret = AIT_GET_U16(array(arr, 0, ait_val_t*));
617: rpc_cli_freeCall(&arr);
618:
619: return ret;
620: }
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