Annotation of libaitrpc/src/cli.c, revision 1.9.2.9

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.9.2.9 ! misho       6: * $Id: cli.c,v 1.9.2.8 2012/05/17 12:52:30 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.9.2.2   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: 
                     66:        cli = malloc(sizeof(rpc_cli_t));
                     67:        if (!cli) {
                     68:                LOGERR;
                     69:                return NULL;
                     70:        } else
                     71:                memcpy(cli, rpccli, sizeof(rpc_cli_t));
                     72: 
1.9.2.4   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.9.2.4   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.9.2.4   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.9.2.4   misho      84:                        strlcat(cli->cli_sa.sun.sun_path, ".blob", sizeof cli->cli_sa.sun.sun_path);
1.4       misho      85:                        break;
1.9.2.3   misho      86:                default:
1.9.2.4   misho      87:                        rpc_SetErr(EINVAL, "Invalid socket type %d", cli->cli_sa.sa.sa_family);
1.9.2.3   misho      88:                        return NULL;
1.2       misho      89:        }
                     90: 
1.9.2.6   misho      91:        AIT_COPY_VAL(&cli->cli_buf, &rpccli->cli_buf);
                     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;
                     97:                free(cli);
                     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.2       misho     103:                free(cli);
                    104:                return NULL;
                    105:        }
                    106: 
                    107:        return cli;
                    108: }
                    109: 
                    110: /*
1.7       misho     111:  * rpc_cli_closeBLOBClient() - Close connection to BLOB server and free resources
                    112:  *
1.2       misho     113:  * @cli = BLOB Client session
                    114:  * return: none
                    115:  */
                    116: void
1.9.2.4   misho     117: rpc_cli_closeBLOBClient(rpc_cli_t ** __restrict cli)
1.2       misho     118: {
1.9.2.4   misho     119:        if (!cli || !*cli)
1.2       misho     120:                return;
                    121: 
1.9.2.4   misho     122:        shutdown((*cli)->cli_sock, SHUT_RDWR);
                    123:        close((*cli)->cli_sock);
1.2       misho     124: 
1.9.2.4   misho     125:        AIT_FREE_VAL(&(*cli)->cli_buf);
                    126: 
                    127:        free(*cli);
                    128:        *cli = NULL;
1.2       misho     129: }
                    130: 
1.9.2.4   misho     131: /* -------------------------------------------------------------- */
1.2       misho     132: 
                    133: /*
1.7       misho     134:  * rpc_cli_openClient() - Connect to RPC Server
                    135:  *
1.1       misho     136:  * @ProgID = ProgramID for RPC session request
                    137:  * @ProcID = ProcessID for RPC session request
1.5       misho     138:  * @netBuf = Network buffer length, if =0 == BUFSIZ (also meaning max RPC packet)
1.1       misho     139:  * @csHost = Host name or IP address for bind server
                    140:  * @Port = Port for bind server, if Port == 0 default port is selected
                    141:  * return: NULL == error or !=NULL connection to RPC server established
                    142:  */
                    143: rpc_cli_t *
1.9.2.5   misho     144: rpc_cli_openClient(u_int ProgID, u_char ProcID, int netBuf, const char *csHost, u_short Port)
1.1       misho     145: {
                    146:        rpc_cli_t *cli = NULL;
1.6       misho     147:        io_sockaddr_t sa;
1.1       misho     148: 
1.9.2.1   misho     149:        if (!io_gethostbyname(csHost, Port, &sa))
1.1       misho     150:                return NULL;
                    151:        if (!Port)
                    152:                Port = RPC_DEFPORT;
1.5       misho     153:        if (!netBuf)
                    154:                netBuf = BUFSIZ;
1.9.2.4   misho     155: 
                    156: #ifdef HAVE_SRANDOMDEV
                    157:        srandomdev();
                    158: #else
                    159:        time_t tim;
                    160: 
                    161:        srandom((time(&tim) ^ getpid()));
                    162: #endif
1.1       misho     163: 
                    164:        cli = malloc(sizeof(rpc_cli_t));
                    165:        if (!cli) {
                    166:                LOGERR;
                    167:                return NULL;
                    168:        } else
                    169:                memset(cli, 0, sizeof(rpc_cli_t));
1.5       misho     170: 
1.9.2.4   misho     171:        /* build session */
1.1       misho     172:        cli->cli_parent = malloc(sizeof(rpc_sess_t));
                    173:        if (!cli->cli_parent) {
                    174:                LOGERR;
                    175:                free(cli);
                    176:                return NULL;
                    177:        } else {
                    178:                ((rpc_sess_t*) cli->cli_parent)->sess_version = RPC_VERSION;
                    179:                ((rpc_sess_t*) cli->cli_parent)->sess_program = ProgID;
                    180:                ((rpc_sess_t*) cli->cli_parent)->sess_process = ProcID;
                    181:        }
                    182: 
1.6       misho     183:        memcpy(&cli->cli_sa, &sa, sizeof cli->cli_sa);
1.9.2.4   misho     184:        AIT_SET_BUF2(&cli->cli_buf, 0, netBuf);
1.4       misho     185: 
                    186:        /* connect to RPC server */
1.9.2.1   misho     187:        cli->cli_sock = socket(cli->cli_sa.sa.sa_family, SOCK_STREAM, 0);
1.1       misho     188:        if (cli->cli_sock == -1) {
                    189:                LOGERR;
1.9.2.4   misho     190:                AIT_FREE_VAL(&cli->cli_buf);
1.5       misho     191:                free(cli->cli_parent);
                    192:                free(cli);
                    193:                return NULL;
                    194:        }
1.6       misho     195:        if (connect(cli->cli_sock, &cli->cli_sa.sa, cli->cli_sa.sa.sa_len) == -1) {
1.1       misho     196:                LOGERR;
1.9.2.4   misho     197:                AIT_FREE_VAL(&cli->cli_buf);
1.5       misho     198:                close(cli->cli_sock);
1.1       misho     199:                free(cli->cli_parent);
                    200:                free(cli);
                    201:                return NULL;
                    202:        }
                    203: 
                    204:        return cli;
                    205: }
                    206: 
                    207: /*
1.7       misho     208:  * rpc_cli_closeClient() - Close connection to RPC server and free resources
                    209:  *
1.1       misho     210:  * @cli = RPC Client session
                    211:  * return: none
                    212:  */
                    213: void
1.9.2.4   misho     214: rpc_cli_closeClient(rpc_cli_t ** __restrict cli)
1.1       misho     215: {
1.9.2.4   misho     216:        if (!cli || !*cli)
1.1       misho     217:                return;
                    218: 
1.9.2.4   misho     219:        shutdown((*cli)->cli_sock, SHUT_RDWR);
                    220:        close((*cli)->cli_sock);
1.1       misho     221: 
1.9.2.4   misho     222:        AIT_FREE_VAL(&(*cli)->cli_buf);
                    223: 
                    224:        if ((*cli)->cli_parent)
                    225:                free((*cli)->cli_parent);
                    226: 
                    227:        free(*cli);
                    228:        *cli = NULL;
1.1       misho     229: }
                    230: 
                    231: 
                    232: /*
1.7       misho     233:  * rpc_cli_execCall() - Execute RPC call
                    234:  *
1.1       misho     235:  * @cli = RPC Client session
1.8       misho     236:  * @noreply = We not want RPC reply
1.9.2.4   misho     237:  * @tag = Function tag for execution
1.9.2.9 ! misho     238:  * @in_vars = IN RPC call array of rpc values, may be NULL
        !           239:  * @out_vars = OUT returned array of rpc values, if !=NULL must be free after use with io_freeVars()
1.1       misho     240:  * return: -1 error or != -1 ok result
                    241:  */
                    242: int
1.9.2.4   misho     243: rpc_cli_execCall(rpc_cli_t *cli, int noreply, u_short tag, 
1.5       misho     244:                array_t * __restrict in_vars, array_t ** __restrict out_vars)
1.1       misho     245: {
1.5       misho     246:        struct tagRPCCall *rpc;
1.7       misho     247:        int ret = 0, wlen = sizeof(struct tagRPCCall);
1.9.2.4   misho     248:        uint16_t crc;
                    249:        u_char *buf;
1.9       misho     250:        struct pollfd pfd;
1.1       misho     251: 
1.9.2.4   misho     252:        if (!cli) {
1.7       misho     253:                rpc_SetErr(EINVAL, "Can`t execute call because parameter is null or invalid!");
1.1       misho     254:                return -1;
1.9.2.4   misho     255:        } else
                    256:                buf = AIT_GET_BUF(&cli->cli_buf);
1.5       misho     257:        if (out_vars)
                    258:                *out_vars = NULL;
                    259: 
1.4       misho     260:        /* prepare RPC call */
1.5       misho     261:        rpc = (struct tagRPCCall*) buf;
1.6       misho     262:        rpc_addPktSession(&rpc->call_session, cli->cli_parent);
                    263:        rpc->call_argc = htons(io_arraySize(in_vars));
1.9.2.4   misho     264:        rpc->call_tag = htons(tag);
1.9.2.8   misho     265:        rpc->call_seq = htons(random() % USHRT_MAX);
1.5       misho     266: 
1.8       misho     267:        /* set reply */
                    268:        rpc->call_req.flags = noreply ? RPC_NOREPLY : RPC_REPLY;
                    269: 
1.6       misho     270:        if (io_arraySize(in_vars)) {
1.5       misho     271:                /* marshaling variables */
1.9.2.4   misho     272:                ret = io_vars2buffer(buf + wlen, AIT_LEN(&cli->cli_buf) - wlen, in_vars);
1.5       misho     273:                if (ret == -1) {
1.7       misho     274:                        rpc_SetErr(EBADRPC, "Failed to prepare RPC packet values");
                    275:                        return -1;
1.3       misho     276:                } else
1.7       misho     277:                        wlen += ret;
1.1       misho     278:        }
1.4       misho     279: 
1.9.2.4   misho     280:        /* total packet length */
1.8       misho     281:        rpc->call_len = htons(wlen);
                    282: 
1.7       misho     283:        /* calculate CRC */
                    284:        rpc->call_crc ^= rpc->call_crc;
1.8       misho     285:        rpc->call_crc = htons(crcFletcher16((u_short*) buf, wlen / 2));
1.7       misho     286: 
1.9.2.4   misho     287:        if ((ret = send(cli->cli_sock, buf, wlen, MSG_NOSIGNAL)) == -1) {
1.1       misho     288:                LOGERR;
                    289:                return -1;
1.7       misho     290:        } else if (ret != wlen) {
                    291:                rpc_SetErr(EPROCUNAVAIL, "RPC request, should be send %d bytes, "
                    292:                                "really sended %d bytes", wlen, ret);
                    293:                return -1;
1.1       misho     294:        }
                    295: 
1.9.2.4   misho     296:        if (noreply)    /* we not want reply */
1.8       misho     297:                return 0;
                    298: 
1.5       misho     299:        /* reply from RPC server */
1.9       misho     300:        pfd.fd = cli->cli_sock;
                    301:        pfd.events = POLLIN | POLLPRI;
                    302:        if ((ret = poll(&pfd, 1, DEF_RPC_TIMEOUT * 1000)) == -1 || 
                    303:                        pfd.revents & (POLLERR | POLLHUP | POLLNVAL)) {
1.4       misho     304:                if (ret)
1.1       misho     305:                        LOGERR;
1.4       misho     306:                else
1.9.2.4   misho     307:                        rpc_SetErr(ETIMEDOUT, "Timeout, no answer from RPC server");
1.4       misho     308: 
1.1       misho     309:                return -1;
                    310:        }
1.9.2.4   misho     311:        memset(buf, 0, AIT_LEN(&cli->cli_buf));
                    312:        if ((ret = recv(cli->cli_sock, buf, AIT_LEN(&cli->cli_buf), 0)) < 1) {
                    313:                if (ret)
                    314:                        LOGERR;
1.8       misho     315:                return -1;
1.1       misho     316:        }
1.7       misho     317:        if (ret < sizeof(struct tagRPCCall)) {
1.9.2.4   misho     318:                rpc_SetErr(ERPCMISMATCH, "Short RPC packet");
1.8       misho     319:                return -1;
1.7       misho     320:        }
1.8       misho     321: 
                    322:        /* calculate CRC */
                    323:        crc = ntohs(rpc->call_crc);
                    324:        rpc->call_crc ^= rpc->call_crc;
                    325:        if (crc != crcFletcher16((u_short*) buf, ret / 2)) {
                    326:                rpc_SetErr(ERPCMISMATCH, "Bad CRC RPC packet");
                    327:                return -1;
                    328:        }
                    329: 
1.3       misho     330:        /* check RPC packet session info */
1.7       misho     331:        if (rpc_chkPktSession(&rpc->call_session, cli->cli_parent)) {
1.9.2.4   misho     332:                rpc_SetErr(ERPCMISMATCH, "Get invalid RPC session");
1.8       misho     333:                return -1;
1.2       misho     334:        } else
1.7       misho     335:                wlen = sizeof(struct tagRPCCall);
1.9.2.4   misho     336:        if (ntohs(rpc->call_tag) != tag) {
                    337:                rpc_SetErr(ERPCMISMATCH, "Get wrong RPC reply");
1.8       misho     338:                return -1;
1.6       misho     339:        }
1.9.2.7   misho     340:        if (ntohl(rpc->call_rep.eno) && ntohl(rpc->call_rep.ret) == -1) {
1.8       misho     341:                rpc_SetErr(ntohl(rpc->call_rep.eno), "Server side: retcode=%d #%d %s", 
1.7       misho     342:                                ntohl(rpc->call_rep.ret), ntohl(rpc->call_rep.eno), 
                    343:                                strerror(ntohl(rpc->call_rep.eno)));
1.8       misho     344:                return -1;
1.1       misho     345:        }
1.9.2.4   misho     346:        if (ntohs(rpc->call_argc) * sizeof(ait_val_t) > AIT_LEN(&cli->cli_buf) - wlen) {
1.8       misho     347:                rpc_SetErr(EMSGSIZE, "Reply RPC packet is too long ...");
                    348:                return -1;
1.5       misho     349:        }
                    350: 
                    351:        /* RPC is OK! Go de-marshaling variables ... */
1.9.2.9 ! misho     352:        if (out_vars && ntohs(rpc->call_argc)) {
1.9.2.4   misho     353:                *out_vars = io_buffer2vars(buf + wlen, AIT_LEN(&cli->cli_buf) - wlen, 
1.7       misho     354:                                ntohs(rpc->call_argc), 0);
1.4       misho     355:                if (!*out_vars) {
1.9.2.9 ! misho     356:                        rpc_SetErr(io_GetErrno(), "%s", io_GetError());
1.1       misho     357:                        return -1;
1.5       misho     358:                }
1.1       misho     359:        }
                    360: 
1.7       misho     361:        ret = ntohl(rpc->call_rep.ret);
1.5       misho     362:        return ret;
1.1       misho     363: }
1.9.2.9 ! misho     364: 
        !           365: /*
        !           366:  * rpc_cli_ping() - Ping RPC server
        !           367:  *
        !           368:  * @cli = connected client
        !           369:  * return: -1 error or !=-1 ping seq id
        !           370:  */
        !           371: inline int
        !           372: rpc_cli_ping(rpc_cli_t *cli)
        !           373: {
        !           374:        array_t *arr;
        !           375:        int ret = 0;
        !           376: 
        !           377:        if (!cli)
        !           378:                return -1;
        !           379: 
        !           380:        if (rpc_cli_execCall(cli, RPC_REPLY, CALL_SRVPING, NULL, &arr))
        !           381:                return -1;
        !           382:        else
        !           383:                ret = AIT_GET_U16(io_getVars(arr, 0));
        !           384:        io_freeVars(&arr);
        !           385: 
        !           386:        return ret;
        !           387: }

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>