Annotation of libaitrpc/src/cli.c, revision 1.13
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.13 ! misho 6: * $Id: cli.c,v 1.12.2.3 2012/11/19 21:28:55 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:
1.7 misho 15: Copyright 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012
1.2 misho 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: #include "global.h"
47:
48:
49: /*
1.7 misho 50: * rpc_cli_openBLOBClient() - Connect to BLOB Server
51: *
1.2 misho 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;
1.13 ! misho 60: int n;
1.4 misho 61:
1.10 misho 62: if (!rpccli) {
1.7 misho 63: rpc_SetErr(EINVAL, "Invalid parameters can`t connect to BLOB server");
1.2 misho 64: return NULL;
65: }
66:
1.11 misho 67: cli = io_malloc(sizeof(rpc_cli_t));
1.2 misho 68: if (!cli) {
69: LOGERR;
70: return NULL;
71: } else
72: memcpy(cli, rpccli, sizeof(rpc_cli_t));
73:
1.10 misho 74: memcpy(&cli->cli_sa, &rpccli->cli_sa, sizeof(io_sockaddr_t));
75: switch (cli->cli_sa.sa.sa_family) {
1.4 misho 76: case AF_INET:
1.10 misho 77: cli->cli_sa.sin.sin_port =
78: htons(Port ? Port : ntohs(cli->cli_sa.sin.sin_port) + 1);
1.4 misho 79: break;
80: case AF_INET6:
1.10 misho 81: cli->cli_sa.sin6.sin6_port =
82: htons(Port ? Port : ntohs(cli->cli_sa.sin6.sin6_port) + 1);
1.4 misho 83: break;
84: case AF_LOCAL:
1.10 misho 85: strlcat(cli->cli_sa.sun.sun_path, ".blob", sizeof cli->cli_sa.sun.sun_path);
1.4 misho 86: break;
1.10 misho 87: default:
88: rpc_SetErr(EINVAL, "Invalid socket type %d", cli->cli_sa.sa.sa_family);
89: return NULL;
1.2 misho 90: }
1.10 misho 91:
92: AIT_COPY_VAL(&cli->cli_buf, &rpccli->cli_buf);
1.13 ! misho 93: n = AIT_LEN(&cli->cli_buf);
1.2 misho 94:
1.4 misho 95: /* connect to BLOB server */
1.6 misho 96: cli->cli_sock = socket(cli->cli_sa.sa.sa_family, SOCK_STREAM, 0);
1.2 misho 97: if (cli->cli_sock == -1) {
98: LOGERR;
1.11 misho 99: io_free(cli);
1.2 misho 100: return NULL;
101: }
1.13 ! misho 102: if (setsockopt(cli->cli_sock, SOL_SOCKET, SO_SNDBUF, &n, sizeof n) == -1) {
! 103: LOGERR;
! 104: close(cli->cli_sock);
! 105: io_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: io_free(cli);
! 112: return NULL;
! 113: }
1.6 misho 114: if (connect(cli->cli_sock, &cli->cli_sa.sa, cli->cli_sa.sa.sa_len) == -1) {
1.2 misho 115: LOGERR;
1.5 misho 116: close(cli->cli_sock);
1.11 misho 117: io_free(cli);
1.2 misho 118: return NULL;
1.10 misho 119: } else
120: fcntl(cli->cli_sock, F_SETFL, fcntl(cli->cli_sock, F_GETFL) | O_NONBLOCK);
1.2 misho 121:
122: return cli;
123: }
124:
125: /*
1.7 misho 126: * rpc_cli_closeBLOBClient() - Close connection to BLOB server and free resources
127: *
1.2 misho 128: * @cli = BLOB Client session
129: * return: none
130: */
131: void
1.10 misho 132: rpc_cli_closeBLOBClient(rpc_cli_t ** __restrict cli)
1.2 misho 133: {
1.10 misho 134: if (!cli || !*cli)
1.2 misho 135: return;
136:
1.10 misho 137: shutdown((*cli)->cli_sock, SHUT_RDWR);
138: close((*cli)->cli_sock);
139:
140: AIT_FREE_VAL(&(*cli)->cli_buf);
1.2 misho 141:
1.11 misho 142: io_free(*cli);
1.10 misho 143: *cli = NULL;
1.2 misho 144: }
145:
1.10 misho 146: /* -------------------------------------------------------------- */
1.2 misho 147:
148: /*
1.7 misho 149: * rpc_cli_openClient() - Connect to RPC Server
150: *
1.1 misho 151: * @ProgID = ProgramID for RPC session request
152: * @ProcID = ProcessID for RPC session request
1.10 misho 153: * @netBuf = Network buffer length (min:512 bytes), if =0 == BUFSIZ (also meaning max RPC packet)
1.1 misho 154: * @csHost = Host name or IP address for bind server
155: * @Port = Port for bind server, if Port == 0 default port is selected
1.13 ! misho 156: * @proto = Protocol, if == 0 choose SOCK_STREAM
1.1 misho 157: * return: NULL == error or !=NULL connection to RPC server established
158: */
159: rpc_cli_t *
1.13 ! misho 160: rpc_cli_openClient(u_int ProgID, u_char ProcID, int netBuf, const char *csHost,
! 161: u_short Port, int proto)
1.1 misho 162: {
163: rpc_cli_t *cli = NULL;
1.11 misho 164: io_sockaddr_t sa = IO_SOCKADDR_INIT;
1.1 misho 165:
1.10 misho 166: if (!io_gethostbyname(csHost, Port, &sa))
1.1 misho 167: return NULL;
168: if (!Port)
169: Port = RPC_DEFPORT;
1.13 ! misho 170: if (!proto)
! 171: proto = SOCK_STREAM;
1.10 misho 172: if (netBuf < RPC_MIN_BUFSIZ)
1.5 misho 173: netBuf = BUFSIZ;
1.10 misho 174: else
1.12 misho 175: netBuf = io_align(netBuf, 2); /* align netBuf length */
1.10 misho 176:
177: #ifdef HAVE_SRANDOMDEV
178: srandomdev();
179: #else
180: time_t tim;
181:
182: srandom((time(&tim) ^ getpid()));
183: #endif
1.1 misho 184:
1.11 misho 185: cli = io_malloc(sizeof(rpc_cli_t));
1.1 misho 186: if (!cli) {
187: LOGERR;
188: return NULL;
189: } else
190: memset(cli, 0, sizeof(rpc_cli_t));
1.5 misho 191:
1.10 misho 192: /* build session */
1.11 misho 193: cli->cli_parent = io_malloc(sizeof(rpc_sess_t));
1.1 misho 194: if (!cli->cli_parent) {
195: LOGERR;
1.11 misho 196: io_free(cli);
1.1 misho 197: return NULL;
198: } else {
199: ((rpc_sess_t*) cli->cli_parent)->sess_version = RPC_VERSION;
200: ((rpc_sess_t*) cli->cli_parent)->sess_program = ProgID;
201: ((rpc_sess_t*) cli->cli_parent)->sess_process = ProcID;
202: }
203:
1.13 ! misho 204: cli->cli_id = proto;
1.6 misho 205: memcpy(&cli->cli_sa, &sa, sizeof cli->cli_sa);
1.10 misho 206: AIT_SET_BUF2(&cli->cli_buf, 0, netBuf);
1.4 misho 207:
208: /* connect to RPC server */
1.13 ! misho 209: cli->cli_sock = socket(cli->cli_sa.sa.sa_family, cli->cli_id, 0);
1.1 misho 210: if (cli->cli_sock == -1) {
211: LOGERR;
1.13 ! misho 212: goto err;
! 213: }
! 214: if (setsockopt(cli->cli_sock, SOL_SOCKET, SO_SNDBUF,
! 215: &netBuf, sizeof netBuf) == -1) {
! 216: LOGERR;
! 217: goto err;
1.5 misho 218: }
1.13 ! misho 219: if (setsockopt(cli->cli_sock, SOL_SOCKET, SO_RCVBUF,
! 220: &netBuf, sizeof netBuf) == -1) {
1.1 misho 221: LOGERR;
1.13 ! misho 222: goto err;
! 223: }
! 224: if (cli->cli_id == SOCK_STREAM)
! 225: if (connect(cli->cli_sock, &cli->cli_sa.sa, cli->cli_sa.sa.sa_len) == -1) {
! 226: LOGERR;
! 227: goto err;
! 228: }
1.1 misho 229:
1.13 ! misho 230: fcntl(cli->cli_sock, F_SETFL, fcntl(cli->cli_sock, F_GETFL) | O_NONBLOCK);
1.1 misho 231: return cli;
1.13 ! misho 232: err:
! 233: AIT_FREE_VAL(&cli->cli_buf);
! 234: if (cli->cli_sock > 2)
! 235: close(cli->cli_sock);
! 236: io_free(cli->cli_parent);
! 237: io_free(cli);
! 238: return NULL;
1.1 misho 239: }
240:
241: /*
1.7 misho 242: * rpc_cli_closeClient() - Close connection to RPC server and free resources
243: *
1.1 misho 244: * @cli = RPC Client session
245: * return: none
246: */
247: void
1.10 misho 248: rpc_cli_closeClient(rpc_cli_t ** __restrict cli)
1.1 misho 249: {
1.10 misho 250: if (!cli || !*cli)
1.1 misho 251: return;
252:
1.13 ! misho 253: if ((*cli)->cli_id == SOCK_STREAM)
! 254: shutdown((*cli)->cli_sock, SHUT_RDWR);
1.10 misho 255: close((*cli)->cli_sock);
256:
257: AIT_FREE_VAL(&(*cli)->cli_buf);
258:
259: if ((*cli)->cli_parent)
1.11 misho 260: io_free((*cli)->cli_parent);
1.1 misho 261:
1.11 misho 262: io_free(*cli);
1.10 misho 263: *cli = NULL;
1.1 misho 264: }
265:
266:
267: /*
1.7 misho 268: * rpc_cli_execCall() - Execute RPC call
269: *
1.1 misho 270: * @cli = RPC Client session
1.8 misho 271: * @noreply = We not want RPC reply
1.10 misho 272: * @tag = Function tag for execution
273: * @in_vars = IN RPC call array of rpc values, may be NULL
274: * @out_vars = OUT returned array of rpc values, if !=NULL must be free after use with io_freeVars()
1.1 misho 275: * return: -1 error or != -1 ok result
276: */
277: int
1.10 misho 278: rpc_cli_execCall(rpc_cli_t *cli, int noreply, u_short tag,
1.5 misho 279: array_t * __restrict in_vars, array_t ** __restrict out_vars)
1.1 misho 280: {
1.5 misho 281: struct tagRPCCall *rpc;
1.7 misho 282: int ret = 0, wlen = sizeof(struct tagRPCCall);
1.10 misho 283: uint16_t crc;
284: u_char *buf;
1.9 misho 285: struct pollfd pfd;
1.13 ! misho 286: io_sockaddr_t sa;
! 287: socklen_t salen;
1.1 misho 288:
1.10 misho 289: if (!cli) {
1.7 misho 290: rpc_SetErr(EINVAL, "Can`t execute call because parameter is null or invalid!");
1.1 misho 291: return -1;
1.10 misho 292: } else
293: buf = AIT_GET_BUF(&cli->cli_buf);
1.5 misho 294: if (out_vars)
295: *out_vars = NULL;
296:
1.13 ! misho 297: memset(&sa, 0, sizeof sa);
! 298:
1.4 misho 299: /* prepare RPC call */
1.5 misho 300: rpc = (struct tagRPCCall*) buf;
1.6 misho 301: rpc_addPktSession(&rpc->call_session, cli->cli_parent);
302: rpc->call_argc = htons(io_arraySize(in_vars));
1.10 misho 303: rpc->call_tag = htons(tag);
304: rpc->call_seq = htons(random() % USHRT_MAX);
1.5 misho 305:
1.8 misho 306: /* set reply */
307: rpc->call_req.flags = noreply ? RPC_NOREPLY : RPC_REPLY;
308:
1.6 misho 309: if (io_arraySize(in_vars)) {
1.5 misho 310: /* marshaling variables */
1.10 misho 311: ret = io_vars2buffer(buf + wlen, AIT_LEN(&cli->cli_buf) - wlen, in_vars);
1.5 misho 312: if (ret == -1) {
1.7 misho 313: rpc_SetErr(EBADRPC, "Failed to prepare RPC packet values");
314: return -1;
1.3 misho 315: } else
1.7 misho 316: wlen += ret;
1.1 misho 317: }
1.4 misho 318:
1.10 misho 319: /* total packet length */
1.8 misho 320: rpc->call_len = htons(wlen);
321:
1.7 misho 322: /* calculate CRC */
323: rpc->call_crc ^= rpc->call_crc;
1.8 misho 324: rpc->call_crc = htons(crcFletcher16((u_short*) buf, wlen / 2));
1.7 misho 325:
1.9 misho 326: pfd.fd = cli->cli_sock;
1.10 misho 327: pfd.events = POLLOUT;
328: if ((ret = poll(&pfd, 1, DEF_RPC_TIMEOUT * 1000)) < 1 ||
1.9 misho 329: pfd.revents & (POLLERR | POLLHUP | POLLNVAL)) {
1.4 misho 330: if (ret)
1.1 misho 331: LOGERR;
1.4 misho 332: else
1.10 misho 333: rpc_SetErr(ETIMEDOUT, "Timeout, can't send to RPC server");
1.1 misho 334: return -1;
335: }
1.10 misho 336: do {
1.13 ! misho 337: if (cli->cli_id == SOCK_STREAM)
! 338: ret = send(cli->cli_sock, buf, wlen, MSG_NOSIGNAL);
! 339: else
! 340: ret = sendto(cli->cli_sock, buf, wlen, MSG_NOSIGNAL,
! 341: &cli->cli_sa.sa, cli->cli_sa.sa.sa_len);
! 342: if (ret == -1) {
1.10 misho 343: if (errno == EAGAIN)
344: continue;
345: LOGERR;
346: return -1;
347: } else if (ret != wlen) {
348: rpc_SetErr(EPROCUNAVAIL, "RPC request, should be send %d bytes, "
349: "really sended %d bytes", wlen, ret);
350: return -1;
351: }
352: } while (0);
353:
354: if (noreply) /* we not want reply */
1.1 misho 355: return 0;
1.10 misho 356:
357: wlen = 0;
358: /* reply from RPC server */
359: pfd.events = POLLIN | POLLPRI;
360: do {
361: if ((ret = poll(&pfd, 1, DEF_RPC_TIMEOUT * 1000)) < 1 ||
362: pfd.revents & (POLLERR | POLLHUP | POLLNVAL)) {
1.13 ! misho 363: if (ret) {
1.10 misho 364: LOGERR;
1.13 ! misho 365: } else {
1.10 misho 366: if (wlen++ < 7)
367: continue;
368: else
369: rpc_SetErr(ETIMEDOUT, "Timeout, no answer from RPC server");
370: }
1.13 ! misho 371:
1.10 misho 372: return -1;
373: }
1.13 ! misho 374:
1.10 misho 375: memset(buf, 0, AIT_LEN(&cli->cli_buf));
1.13 ! misho 376: if (cli->cli_id == SOCK_STREAM)
! 377: ret = recv(cli->cli_sock, buf, AIT_LEN(&cli->cli_buf), 0);
! 378: else
! 379: ret = recvfrom(cli->cli_sock, buf, AIT_LEN(&cli->cli_buf), 0,
! 380: &sa.sa, &salen);
! 381: if (ret < 1) {
1.10 misho 382: if (ret) {
383: if (errno == EAGAIN)
384: continue;
385: else
386: LOGERR;
387: }
388: return -1;
389: }
1.13 ! misho 390:
! 391: if (cli->cli_id == SOCK_DGRAM) {
! 392: /* check for response from known address */
! 393: if (io_addrcmp(&cli->cli_sa, &sa, 42)) {
! 394: rpc_SetErr(ERPCMISMATCH, "Received RPC response from unknown address");
! 395: continue;
! 396: }
! 397: }
1.10 misho 398: } while (0);
1.7 misho 399: if (ret < sizeof(struct tagRPCCall)) {
1.10 misho 400: rpc_SetErr(ERPCMISMATCH, "Short RPC packet %d bytes", ret);
1.8 misho 401: return -1;
1.7 misho 402: }
1.8 misho 403:
404: /* calculate CRC */
405: crc = ntohs(rpc->call_crc);
406: rpc->call_crc ^= rpc->call_crc;
1.10 misho 407: if (crc != crcFletcher16((u_short*) buf, ntohs(rpc->call_len) / 2)) {
1.8 misho 408: rpc_SetErr(ERPCMISMATCH, "Bad CRC RPC packet");
409: return -1;
410: }
411:
1.3 misho 412: /* check RPC packet session info */
1.7 misho 413: if (rpc_chkPktSession(&rpc->call_session, cli->cli_parent)) {
1.10 misho 414: rpc_SetErr(ERPCMISMATCH, "Get invalid RPC session");
1.8 misho 415: return -1;
1.2 misho 416: } else
1.7 misho 417: wlen = sizeof(struct tagRPCCall);
1.10 misho 418: if (ntohs(rpc->call_tag) != tag) {
419: rpc_SetErr(ERPCMISMATCH, "Get wrong RPC reply");
1.8 misho 420: return -1;
1.6 misho 421: }
1.10 misho 422: if (ntohl(rpc->call_rep.eno) && ntohl(rpc->call_rep.ret) == -1) {
1.8 misho 423: rpc_SetErr(ntohl(rpc->call_rep.eno), "Server side: retcode=%d #%d %s",
1.7 misho 424: ntohl(rpc->call_rep.ret), ntohl(rpc->call_rep.eno),
425: strerror(ntohl(rpc->call_rep.eno)));
1.8 misho 426: return -1;
1.1 misho 427: }
1.10 misho 428: if (ntohs(rpc->call_argc) * sizeof(ait_val_t) > AIT_LEN(&cli->cli_buf) - wlen) {
1.8 misho 429: rpc_SetErr(EMSGSIZE, "Reply RPC packet is too long ...");
430: return -1;
1.5 misho 431: }
432:
433: /* RPC is OK! Go de-marshaling variables ... */
1.10 misho 434: if (out_vars && ntohs(rpc->call_argc)) {
1.12 misho 435: #ifdef CLI_RES_ZCOPY
436: *out_vars = io_buffer2vars(buf + wlen, AIT_LEN(&cli->cli_buf) - wlen,
437: ntohs(rpc->call_argc), 42);
438: #else
1.10 misho 439: *out_vars = io_buffer2vars(buf + wlen, AIT_LEN(&cli->cli_buf) - wlen,
1.7 misho 440: ntohs(rpc->call_argc), 0);
1.12 misho 441: #endif
1.4 misho 442: if (!*out_vars) {
1.10 misho 443: rpc_SetErr(io_GetErrno(), "%s", io_GetError());
1.1 misho 444: return -1;
1.5 misho 445: }
1.1 misho 446: }
447:
1.7 misho 448: ret = ntohl(rpc->call_rep.ret);
1.10 misho 449: return ret;
450: }
451:
452: /*
1.12 misho 453: * rpc_cli_freeCall() - Free resouce allocated by RPC call
454: *
455: * @out_vars = Returned array with variables from RPC call
456: * return: none
457: */
458: inline void
459: rpc_cli_freeCall(array_t ** __restrict out_vars)
460: {
461: #ifdef CLI_RES_ZCOPY
462: io_arrayDestroy(out_vars);
463: #else
464: io_freeVars(out_vars);
465: #endif
466: }
467:
468: /*
1.10 misho 469: * rpc_cli_ping() - Ping RPC server
470: *
471: * @cli = connected client
472: * return: -1 error or !=-1 ping seq id
473: */
474: inline int
475: rpc_cli_ping(rpc_cli_t *cli)
476: {
477: int ret = 0;
478: array_t *arr = NULL;
479:
480: if (!cli)
481: return -1;
482:
483: if (rpc_cli_execCall(cli, RPC_REPLY, CALL_SRVPING, NULL, &arr))
484: return -1;
485: else
486: ret = AIT_GET_U16(io_array(arr, 0, ait_val_t*));
1.12 misho 487: rpc_cli_freeCall(&arr);
1.10 misho 488:
1.5 misho 489: return ret;
1.1 misho 490: }
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>