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