File:  [ELWIX - Embedded LightWeight unIX -] / libaitrpc / src / cli.c
Revision 1.9: download - view: text, annotated - select for diffs - revision graph
Mon May 14 08:39:05 2012 UTC (12 years, 1 month ago) by misho
Branches: MAIN
CVS tags: rpc3_3, RPC3_2, HEAD
version 3.2

/*************************************************************************
* (C) 2010 AITNET ltd - Sofia/Bulgaria - <misho@aitbg.com>
*  by Michael Pounov <misho@openbsd-bg.org>
*
* $Author: misho $
* $Id: cli.c,v 1.9 2012/05/14 08:39:05 misho Exp $
*
**************************************************************************
The ELWIX and AITNET software is distributed under the following
terms:

All of the documentation and software included in the ELWIX and AITNET
Releases is copyrighted by ELWIX - Sofia/Bulgaria <info@elwix.org>

Copyright 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012
	by Michael Pounov <misho@elwix.org>.  All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or other materials provided with the distribution.
3. All advertising materials mentioning features or use of this software
   must display the following acknowledgement:
This product includes software developed by Michael Pounov <misho@elwix.org>
ELWIX - Embedded LightWeight unIX and its contributors.
4. Neither the name of AITNET nor the names of its contributors
   may be used to endorse or promote products derived from this software
   without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY AITNET AND CONTRIBUTORS ``AS IS'' AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
*/
#include "global.h"


/*
 * rpc_cli_openBLOBClient() - Connect to BLOB Server
 *
 * @rpccli = RPC Client session
 * @Port = Port for bind server, if Port == 0 default port is selected
 * return: NULL == error or !=NULL connection to BLOB server established
 */
rpc_cli_t *
rpc_cli_openBLOBClient(rpc_cli_t * __restrict rpccli, u_short Port)
{
	rpc_cli_t *cli = NULL;
	io_sockaddr_t sa;
	int n;

	if (!rpccli || 
			(rpccli->cli_sa.sa.sa_family != AF_INET && rpccli->cli_sa.sa.sa_family != AF_INET6 && 
			 rpccli->cli_sa.sa.sa_family != AF_LOCAL)) {
		rpc_SetErr(EINVAL, "Invalid parameters can`t connect to BLOB server");
		return NULL;
	}

	cli = malloc(sizeof(rpc_cli_t));
	if (!cli) {
		LOGERR;
		return NULL;
	} else
		memcpy(cli, rpccli, sizeof(rpc_cli_t));

	memcpy(&sa, &rpccli->cli_sa, sizeof sa);
	switch (sa.sa.sa_family) {
		case AF_INET:
			sa.sin.sin_port = htons(Port ? Port : ntohs(sa.sin.sin_port) + 1);
			break;
		case AF_INET6:
			sa.sin6.sin6_port = htons(Port ? Port : ntohs(sa.sin6.sin6_port) + 1);
			break;
		case AF_LOCAL:
			strlcat(sa.sun.sun_path, ".blob", sizeof sa.sun.sun_path);
			break;
	}
	memcpy(&cli->cli_sa, &sa, sizeof sa);

	/* connect to BLOB server */
	cli->cli_sock = socket(cli->cli_sa.sa.sa_family, SOCK_STREAM, 0);
	if (cli->cli_sock == -1) {
		LOGERR;
		free(cli);
		return NULL;
	}
	n = cli->cli_netbuf;
	if (setsockopt(cli->cli_sock, SOL_SOCKET, SO_SNDBUF, &n, sizeof n) == -1) {
		LOGERR;
		close(cli->cli_sock);
		free(cli);
		return NULL;
	}
	if (setsockopt(cli->cli_sock, SOL_SOCKET, SO_RCVBUF, &n, sizeof n) == -1) {
		LOGERR;
		close(cli->cli_sock);
		free(cli);
		return NULL;
	}
	if (connect(cli->cli_sock, &cli->cli_sa.sa, cli->cli_sa.sa.sa_len) == -1) {
		LOGERR;
		close(cli->cli_sock);
		free(cli);
		return NULL;
	}

	return cli;
}

/*
 * rpc_cli_closeBLOBClient() - Close connection to BLOB server and free resources
 *
 * @cli = BLOB Client session
 * return: none
 */
void
rpc_cli_closeBLOBClient(rpc_cli_t * __restrict cli)
{
	if (!cli) {
		rpc_SetErr(EINVAL, "Can`t close connection because parameter is null!");
		return;
	}

	shutdown(cli->cli_sock, SHUT_RDWR);
	close(cli->cli_sock);

	free(cli);
	cli = NULL;
}

// --------------------------------------------------------------

/*
 * rpc_cli_openClient() - Connect to RPC Server
 *
 * @ProgID = ProgramID for RPC session request
 * @ProcID = ProcessID for RPC session request
 * @netBuf = Network buffer length, if =0 == BUFSIZ (also meaning max RPC packet)
 * @Timeout = RPC timeout in seconds, if =0 set default RPC timeout
 * @family = Family socket type, AF_INET or AF_INET6
 * @csHost = Host name or IP address for bind server
 * @Port = Port for bind server, if Port == 0 default port is selected
 * return: NULL == error or !=NULL connection to RPC server established
 */
rpc_cli_t *
rpc_cli_openClient(u_int ProgID, u_int ProcID, int netBuf, u_char Timeout, 
		u_short family, const char *csHost, u_short Port)
{
	rpc_cli_t *cli = NULL;
	struct hostent *host = NULL;
	io_sockaddr_t sa;
	int n;

	if (!csHost || (family != AF_INET && family != AF_INET6 && family != AF_LOCAL)) {
		rpc_SetErr(EINVAL, "Invalid parameters can`t connect to RPC server ...");
		return NULL;
	}
	if (!Port)
		Port = RPC_DEFPORT;
	if (!netBuf)
		netBuf = BUFSIZ;
	if (!Timeout)
		Timeout = DEF_RPC_TIMEOUT;
	if (csHost && family != AF_LOCAL) {
		host = gethostbyname2(csHost, family);
		if (!host) {
			rpc_SetErr(h_errno, "%s", hstrerror(h_errno));
			return NULL;
		}
	}
	memset(&sa, 0, sizeof sa);
	sa.sa.sa_family = family;
	switch (family) {
		case AF_INET:
			sa.sin.sin_len = sizeof(struct sockaddr_in);
			sa.sin.sin_port = htons(Port);
			if (csHost)
				memcpy(&sa.sin.sin_addr, host->h_addr, host->h_length);
			break;
		case AF_INET6:
			sa.sin6.sin6_len = sizeof(struct sockaddr_in6);
			sa.sin6.sin6_port = htons(Port);
			if (csHost)
				memcpy(&sa.sin6.sin6_addr, host->h_addr, host->h_length);
			break;
		case AF_LOCAL:
			sa.sun.sun_len = sizeof(struct sockaddr_un);
			if (csHost)
				strlcpy(sa.sun.sun_path, csHost, sizeof sa.sun.sun_path);
			break;
		default:
			rpc_SetErr(EINVAL, "Invalid parameters can`t connect to RPC server ...");
			return NULL;
	}

	cli = malloc(sizeof(rpc_cli_t));
	if (!cli) {
		LOGERR;
		return NULL;
	} else
		memset(cli, 0, sizeof(rpc_cli_t));

	cli->cli_netbuf = netBuf;
	cli->cli_parent = malloc(sizeof(rpc_sess_t));
	if (!cli->cli_parent) {
		LOGERR;
		free(cli);
		return NULL;
	} else {
		((rpc_sess_t*) cli->cli_parent)->sess_version = RPC_VERSION;
		((rpc_sess_t*) cli->cli_parent)->sess_timeout = Timeout;
		((rpc_sess_t*) cli->cli_parent)->sess_program = ProgID;
		((rpc_sess_t*) cli->cli_parent)->sess_process = ProcID;
	}

	memcpy(&cli->cli_sa, &sa, sizeof cli->cli_sa);

	/* connect to RPC server */
	cli->cli_sock = socket(family, SOCK_STREAM, 0);
	if (cli->cli_sock == -1) {
		LOGERR;
		free(cli->cli_parent);
		free(cli);
		return NULL;
	}
	n = cli->cli_netbuf;
	if (setsockopt(cli->cli_sock, SOL_SOCKET, SO_SNDBUF, &n, sizeof n) == -1) {
		LOGERR;
		close(cli->cli_sock);
		free(cli->cli_parent);
		free(cli);
		return NULL;
	}
	if (setsockopt(cli->cli_sock, SOL_SOCKET, SO_RCVBUF, &n, sizeof n) == -1) {
		LOGERR;
		close(cli->cli_sock);
		free(cli->cli_parent);
		free(cli);
		return NULL;
	}
	if (connect(cli->cli_sock, &cli->cli_sa.sa, cli->cli_sa.sa.sa_len) == -1) {
		LOGERR;
		close(cli->cli_sock);
		free(cli->cli_parent);
		free(cli);
		return NULL;
	}

	return cli;
}

/*
 * rpc_cli_closeClient() - Close connection to RPC server and free resources
 *
 * @cli = RPC Client session
 * return: none
 */
void
rpc_cli_closeClient(rpc_cli_t * __restrict cli)
{
	if (!cli) {
		rpc_SetErr(EINVAL, "Can`t close connection because parameter is null!");
		return;
	}

	shutdown(cli->cli_sock, SHUT_RDWR);
	close(cli->cli_sock);

	if (cli->cli_parent)
		free(cli->cli_parent);
	free(cli);
	cli = NULL;
}


/*
 * rpc_cli_execCall() - Execute RPC call
 *
 * @cli = RPC Client session
 * @noreply = We not want RPC reply
 * @csModule = Module name, if NULL self binary
 * @csFunc = Function name for execute
 * @in_vars = IN RPC call array of rpc values
 * @out_vars = OUT returned array of rpc values, must be free after use with rpc_cli_freeVals()
 * return: -1 error or != -1 ok result
 */
int
rpc_cli_execCall(rpc_cli_t *cli, int noreply, const char *csModule, const char *csFunc, 
		array_t * __restrict in_vars, array_t ** __restrict out_vars)
{
	u_char *buf;
	rpc_func_t func;
	struct tagRPCCall *rpc;
	int ret = 0, wlen = sizeof(struct tagRPCCall);
	uint16_t tag, crc;
	uint32_t hash;
	struct pollfd pfd;

	if (!cli || !csFunc) {
		rpc_SetErr(EINVAL, "Can`t execute call because parameter is null or invalid!");
		return -1;
	}
	if (out_vars)
		*out_vars = NULL;

	buf = malloc(cli->cli_netbuf);
	if (!buf) {
		LOGERR;
		return -1;
	} else
		memset(buf, 0, cli->cli_netbuf);

	/* calculate hashes */
	if (rpc_calcHashes(&func, csModule, csFunc) == -1)
		return -1;
	else {
		tag = htons(func.func_tag);
		hash = htonl(func.func_hash);
		AIT_FREE_VAL(&func.func_name);
		AIT_FREE_VAL(&func.func_file);
	}

	/* prepare RPC call */
	rpc = (struct tagRPCCall*) buf;
	rpc_addPktSession(&rpc->call_session, cli->cli_parent);
	rpc->call_argc = htons(io_arraySize(in_vars));
	rpc->call_tag = tag;
	rpc->call_hash = hash;

	/* set reply */
	rpc->call_req.flags = noreply ? RPC_NOREPLY : RPC_REPLY;

	if (io_arraySize(in_vars)) {
		/* marshaling variables */
		ret = io_vars2buffer(buf + wlen, cli->cli_netbuf - wlen, in_vars);
		if (ret == -1) {
			rpc_SetErr(EBADRPC, "Failed to prepare RPC packet values");
			free(buf);
			return -1;
		} else
			wlen += ret;
	}

	rpc->call_len = htons(wlen);

	/* calculate CRC */
	rpc->call_crc ^= rpc->call_crc;
	rpc->call_crc = htons(crcFletcher16((u_short*) buf, wlen / 2));

	if ((ret = send(cli->cli_sock, buf, wlen, 0)) == -1) {
		LOGERR;
		free(buf);
		return -1;
	} else if (ret != wlen) {
		rpc_SetErr(EPROCUNAVAIL, "RPC request, should be send %d bytes, "
				"really sended %d bytes", wlen, ret);
		free(buf);
		return -1;
	}

	if (noreply) {
		/* we not want reply */
		free(buf);
		return 0;
	}

	/* reply from RPC server */
	pfd.fd = cli->cli_sock;
	pfd.events = POLLIN | POLLPRI;
	if ((ret = poll(&pfd, 1, DEF_RPC_TIMEOUT * 1000)) == -1 || 
			pfd.revents & (POLLERR | POLLHUP | POLLNVAL)) {
		if (ret)
			LOGERR;
		else
			rpc_SetErr(ETIMEDOUT, "Timeout, no return from RPC server?");

		free(buf);
		return -1;
	}
	memset(buf, 0, cli->cli_netbuf);
	if ((ret = recv(cli->cli_sock, buf, cli->cli_netbuf, 0)) == -1) {
		LOGERR;
		free(buf);
		return -1;
	}
	if (!ret) {	/* receive EOF! */
		free(buf);
		return 0;
	}
	if (ret < sizeof(struct tagRPCCall)) {
		rpc_SetErr(ERPCMISMATCH, "Too short RPC packet ...");
		free(buf);
		return -1;
	}

	/* calculate CRC */
	crc = ntohs(rpc->call_crc);
	rpc->call_crc ^= rpc->call_crc;
	if (crc != crcFletcher16((u_short*) buf, ret / 2)) {
		rpc_SetErr(ERPCMISMATCH, "Bad CRC RPC packet");
		free(buf);
		return -1;
	}

	/* check RPC packet session info */
	if (rpc_chkPktSession(&rpc->call_session, cli->cli_parent)) {
		rpc_SetErr(ERPCMISMATCH, "Get invalid RPC session ...");
		free(buf);
		return -1;
	} else
		wlen = sizeof(struct tagRPCCall);
	if (rpc->call_tag != tag || rpc->call_hash != hash) {
		rpc_SetErr(ERPCMISMATCH, "Get wrong RPC reply ...");
		free(buf);
		return -1;
	}
	if (ntohl(rpc->call_rep.ret) < 0 && ntohl(rpc->call_rep.eno)) {
		rpc_SetErr(ntohl(rpc->call_rep.eno), "Server side: retcode=%d #%d %s", 
				ntohl(rpc->call_rep.ret), ntohl(rpc->call_rep.eno), 
				strerror(ntohl(rpc->call_rep.eno)));
		free(buf);
		return -1;
	}
	if (ntohs(rpc->call_argc) * sizeof(ait_val_t) > cli->cli_netbuf - wlen) {
		rpc_SetErr(EMSGSIZE, "Reply RPC packet is too long ...");
		free(buf);
		return -1;
	}

	/* RPC is OK! Go de-marshaling variables ... */
	if (ntohs(rpc->call_argc)) {
		*out_vars = io_buffer2vars(buf + wlen, cli->cli_netbuf - wlen, 
				ntohs(rpc->call_argc), 0);
		if (!*out_vars) {
			free(buf);
			return -1;
		}
	}

	ret = ntohl(rpc->call_rep.ret);
	free(buf);
	return ret;
}

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