/*************************************************************************
* (C) 2010 AITNET ltd - Sofia/Bulgaria - <misho@aitbg.com>
*  by Michael Pounov <misho@openbsd-bg.org>
*
* $Author: misho $
* $Id: cli.c,v 1.18 2013/08/23 13:53:15 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, 2013
	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;
	int n;

	if (!rpccli) {
		rpc_SetErr(EINVAL, "Invalid parameters can`t connect to BLOB server");
		return NULL;
	}

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

	memcpy(&cli->cli_sa, &rpccli->cli_sa, sizeof(sockaddr_t));
	switch (cli->cli_sa.sa.sa_family) {
		case AF_INET:
			cli->cli_sa.sin.sin_port = 
				htons(Port ? Port : ntohs(cli->cli_sa.sin.sin_port) + 1);
			break;
		case AF_INET6:
			cli->cli_sa.sin6.sin6_port = 
				htons(Port ? Port : ntohs(cli->cli_sa.sin6.sin6_port) + 1);
			break;
		case AF_LOCAL:
			strlcat(cli->cli_sa.sun.sun_path, ".blob", sizeof cli->cli_sa.sun.sun_path);
			break;
		default:
			rpc_SetErr(EINVAL, "Invalid socket type %d", cli->cli_sa.sa.sa_family);
			return NULL;
	}

	AIT_COPY_VAL(&cli->cli_buf, &rpccli->cli_buf);
	n = AIT_LEN(&cli->cli_buf);

	/* connect to BLOB server */
	cli->cli_sock = socket(cli->cli_sa.sa.sa_family, SOCK_STREAM, 0);
	if (cli->cli_sock == -1) {
		LOGERR;
		e_free(cli);
		return NULL;
	}
	if (setsockopt(cli->cli_sock, SOL_SOCKET, SO_SNDBUF, &n, sizeof n) == -1) {
		LOGERR;
		close(cli->cli_sock);
		e_free(cli);
		return NULL;
	}
	if (setsockopt(cli->cli_sock, SOL_SOCKET, SO_RCVBUF, &n, sizeof n) == -1) {
		LOGERR;
		close(cli->cli_sock);
		e_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);
		e_free(cli);
		return NULL;
	} else
		fcntl(cli->cli_sock, F_SETFL, fcntl(cli->cli_sock, F_GETFL) | O_NONBLOCK);

	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 || !*cli)
		return;

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

	AIT_FREE_VAL(&(*cli)->cli_buf);

	e_free(*cli);
	*cli = NULL;
}

/* -------------------------------------------------------------- */

/*
 * rpc_cli_openClient() - Connect to RPC Server
 *
 * @InstID = InstID for RPC session request
 * @netBuf = Network buffer length (min:512 bytes), if =0 == BUFSIZ (also meaning max RPC packet)
 * @csHost = Host name or IP address for bind server
 * @Port = Port for bind server, if Port == 0 default port is selected
 * @proto = Protocol, if == 0 choose SOCK_STREAM
 * return: NULL == error or !=NULL connection to RPC server established
 */
rpc_cli_t *
rpc_cli_openClient(u_char InstID, int netBuf, const char *csHost, u_short Port, int proto)
{
	rpc_cli_t *cli = NULL;
	sockaddr_t sa = E_SOCKADDR_INIT;

	if (!e_gethostbyname(csHost, Port, &sa))
		return NULL;
	if (!Port)
		Port = RPC_DEFPORT;
	if (!proto)
		proto = SOCK_STREAM;
	if (netBuf < RPC_MIN_BUFSIZ)
		netBuf = BUFSIZ;
	else
		netBuf = E_ALIGN(netBuf, 2);	/* align netBuf length */

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

	/* build session */
	cli->cli_parent = e_malloc(sizeof(rpc_sess_t));
	if (!cli->cli_parent) {
		LOGERR;
		e_free(cli);
		return NULL;
	} else {
		((rpc_sess_t*) cli->cli_parent)->sess_version = RPC_VERSION;
		((rpc_sess_t*) cli->cli_parent)->sess_instance = InstID;
	}

	cli->cli_id = proto;
	memcpy(&cli->cli_sa, &sa, sizeof cli->cli_sa);
	AIT_SET_BUFSIZ(&cli->cli_buf, 0, netBuf);

	/* connect to RPC server */
	cli->cli_sock = socket(cli->cli_sa.sa.sa_family, cli->cli_id, 0);
	if (cli->cli_sock == -1) {
		LOGERR;
		goto err;
	}
	if (setsockopt(cli->cli_sock, SOL_SOCKET, SO_SNDBUF, 
				&netBuf, sizeof netBuf) == -1) {
		LOGERR;
		goto err;
	}
	if (setsockopt(cli->cli_sock, SOL_SOCKET, SO_RCVBUF, 
				&netBuf, sizeof netBuf) == -1) {
		LOGERR;
		goto err;
	}
	if (cli->cli_id == SOCK_STREAM)
		if (connect(cli->cli_sock, &cli->cli_sa.sa, cli->cli_sa.sa.sa_len) == -1) {
			LOGERR;
			goto err;
		}

	fcntl(cli->cli_sock, F_SETFL, fcntl(cli->cli_sock, F_GETFL) | O_NONBLOCK);
	return cli;
err:
	AIT_FREE_VAL(&cli->cli_buf);
	if (cli->cli_sock > 2)
		close(cli->cli_sock);
	e_free(cli->cli_parent);
	e_free(cli);
	return NULL;
}

/*
 * 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 || !*cli)
		return;

	if ((*cli)->cli_id == SOCK_STREAM)
		shutdown((*cli)->cli_sock, SHUT_RDWR);
	close((*cli)->cli_sock);

	AIT_FREE_VAL(&(*cli)->cli_buf);

	if ((*cli)->cli_parent)
		e_free((*cli)->cli_parent);

	e_free(*cli);
	*cli = NULL;
}

/*
 * rpc_pkt_Send() - Send RPC packet
 *
 * @sock = Socket
 * @type = Type of socket
 * @sa = Server address
 * @pkt = RPC packet
 * @len = Length of packet
 * return: -1 error or !=-1 sended bytes
 */
int
rpc_pkt_Send(int sock, int type, sockaddr_t * __restrict sa, ait_val_t * __restrict pkt, int len)
{
	u_char *buf;

	if (!pkt) {
		rpc_SetErr(EINVAL, "Invalid argument(s)!");
		return -1;
	} else
		buf = AIT_GET_BUF(pkt);

	return rpc_Write(sock, type, MSG_NOSIGNAL, sa, buf, len);
}

/*
 * rpc_pkt_Receive() - Receive RPC packet
 *
 * @sock = Socket
 * @type = Type of socket
 * @sa = Server address
 * @pkt = RPC packet
 * return: -1 error or !=-1 sended bytes
 */
int
rpc_pkt_Receive(int sock, int type, sockaddr_t * __restrict sa, ait_val_t * __restrict pkt)
{
	int ret, estlen = 0, blen = sizeof(struct tagRPCCall);
	u_char *buf;
	struct tagRPCCall *rpc;

	if (!pkt) {
		rpc_SetErr(EINVAL, "Invalid argument(s)!");
		return -1;
	} else
		buf = AIT_GET_BUF(pkt);

	/* reply from RPC server */
	do {
		if (type == SOCK_STREAM)
			ret = rpc_Read(sock, type, !estlen ? MSG_PEEK : 0, NULL, buf, blen);
		else
			ret = rpc_Read(sock, type, 0, sa, buf, AIT_LEN(pkt));
		if (ret < 1) {
			LOGERR;
			return -1;
		}

		/* check for response from known address */
		if (type == SOCK_STREAM && !estlen) {
			/* 1st read for RPC header */
			if (ret < sizeof(struct tagRPCCall)) {
				rpc_SetErr(ERPCMISMATCH, "Short RPC packet %d bytes", ret);
				return -1;
			}

			/* calc estimated length */
			rpc = (struct tagRPCCall*) buf;
			estlen = ntohl(rpc->call_len);
			if (estlen > AIT_LEN(pkt))
				AIT_RE_BUF(pkt, estlen);
			buf = AIT_GET_BUF(pkt);
			blen = estlen;
			rpc = (struct tagRPCCall*) buf;
			continue;
		}

		/* compiler optimize loop if while(0) and stop working 'continue' on some platforms */
		break;
	} while (42);

	if (ret < sizeof(struct tagRPCCall)) {
		rpc_SetErr(ERPCMISMATCH, "Short RPC packet %d bytes", ret);
		return -1;
	}

	return ret;
}

/*
 * rpc_pkt_Request() - Build RPC Request packet
 *
 * @pkt = Packet buffer
 * @sess = RPC session info
 * @tag = Function tag for execution
 * @vars = Function argument array of values, may be NULL
 * @noreply = We not want RPC reply
 * @nocrc = Without CRC calculation
 * return: -1 error or != -1 prepared bytes into packet
 */
int
rpc_pkt_Request(ait_val_t * __restrict pkt, rpc_sess_t * __restrict sess, u_short tag, 
		array_t * __restrict vars, int noreply, int nocrc)
{
	struct tagRPCCall *rpc;
	int ret = 0, estlen, len = sizeof(struct tagRPCCall);
	u_char *buf;

	if (!pkt || !sess) {
		rpc_SetErr(EINVAL, "Invalid argument(s)!");
		return -1;
	}

	/* calc estimated length */
	estlen = ait_resideVars(vars) + len;
	if (estlen > AIT_LEN(pkt))
		AIT_RE_BUF(pkt, estlen);
	buf = AIT_GET_BUF(pkt);

	/* prepare RPC call */
	rpc = (struct tagRPCCall*) buf;
	rpc_addPktSession(&rpc->call_session, sess);
	rpc->call_tag = htons(tag);
	if (!vars)
		rpc->call_argc = 0;
	else
		rpc->call_argc = htons(array_Size(vars));

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

	if (array_Size(vars)) {
		/* marshaling variables */
		ret = ait_vars2buffer(buf + len, AIT_LEN(pkt) - len, vars);
		if (ret == -1) {
			rpc_SetErr(EBADRPC, "Failed to prepare RPC packet values");
			return -1;
		} else
			len += ret;
	}

	/* total packet length */
	rpc->call_len = htonl(len);

	if (!nocrc) {
		/* calculate CRC */
		rpc->call_crc ^= rpc->call_crc;
		rpc->call_crc = htons(crcFletcher16((u_short*) buf, len / 2));
	}

	return len;
}

/*
 * rpc_pkt_Replay() - Decode RPC Replay packet
 *
 * @pkt = Packet buffer
 * @sess = RPC session info
 * @tag = Function tag
 * @vars = Function argument array of values, may be NULL
 * @nocrc = Without CRC calculation
 * return: -1 error or != -1 return value from function
 */
int
rpc_pkt_Replay(ait_val_t * __restrict pkt, rpc_sess_t * __restrict sess, u_short tag, 
		array_t ** __restrict vars, int nocrc)
{
	struct tagRPCCall *rpc;
	int len;
	u_char *buf;
	uint16_t crc;

	if (!pkt || !sess) {
		rpc_SetErr(EINVAL, "Invalid argument(s)!");
		return -1;
	} else
		buf = AIT_GET_BUF(pkt);

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

	/* check RPC packet session info */
	if (rpc_chkPktSession(&rpc->call_session, sess)) {
		rpc_SetErr(ERPCMISMATCH, "Get invalid RPC session");
		return -1;
	}
	if (ntohs(rpc->call_tag) != tag) {
		rpc_SetErr(ERPCMISMATCH, "Get wrong RPC reply");
		return -1;
	}
	if (ntohl(rpc->call_rep.eno) && ntohl(rpc->call_rep.ret) == -1) {
		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)));
		return -1;
	}
	len = ntohs(rpc->call_argc) * sizeof(ait_val_t);
	if (len > AIT_LEN(pkt) - sizeof(struct tagRPCCall)) {
		rpc_SetErr(EMSGSIZE, "Reply RPC packet not enough buffer space ...");
		return -1;
	}
	if (len > ntohl(rpc->call_len) - sizeof(struct tagRPCCall)) {
		rpc_SetErr(EMSGSIZE, "Reply RPC packet is too short ...");
		return -1;
	}

	/* RPC is OK! Go de-marshaling variables ... */
	if (vars && ntohs(rpc->call_argc)) {
#ifdef CLI_RES_ZCOPY
		*vars = ait_buffer2vars(buf + sizeof(struct tagRPCCall), len, 
				ntohs(rpc->call_argc), 42);
#else
		*vars = ait_buffer2vars(buf + sizeof(struct tagRPCCall), len, 
				ntohs(rpc->call_argc), 0);
#endif
		if (!*vars) {
			rpc_SetErr(elwix_GetErrno(), "%s", elwix_GetError());
			return -1;
		}
	}

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

/*
 * rpc_cli_execCall() - Execute RPC call
 *
 * @cli = RPC Client session
 * @noreply = We not want RPC reply
 * @tag = Function tag for execution
 * @in_vars = IN function argument array of values, may be NULL
 * @out_vars = OUT returned array of rpc values, if !=NULL must be free after use with ait_freeVars()
 * return: -1 error or != -1 ok result
 */
int
rpc_cli_execCall(rpc_cli_t *cli, int noreply, u_short tag, 
		array_t * __restrict in_vars, array_t ** __restrict out_vars)
{
	int type = 0, wlen;
	u_char *buf;

	if (!cli) {
		rpc_SetErr(EINVAL, "Can`t execute call because parameter is null or invalid!");
		return -1;
	} else {
		if (cli->cli_id == SOCK_STREAM)
			type = cli->cli_id;
		buf = AIT_GET_BUF(&cli->cli_buf);
	}
	if (out_vars)
		*out_vars = NULL;

	if ((wlen = rpc_pkt_Request(&cli->cli_buf, cli->cli_parent, tag, in_vars, noreply, type)) == -1)
		return -1;

	if (rpc_pkt_Send(cli->cli_sock, cli->cli_id, &cli->cli_sa, &cli->cli_buf, wlen) == -1)
		return -1;

	if (noreply)	/* we not want reply */
		return 0;

	if (rpc_pkt_Receive(cli->cli_sock, cli->cli_id, &cli->cli_sa, &cli->cli_buf) == -1)
		return -1;

	if ((wlen = rpc_pkt_Replay(&cli->cli_buf, cli->cli_parent, tag, out_vars, type)) == -1)
		return -1;

	return 0;
}

/*
 * rpc_cli_freeCall() - Free resouce allocated by RPC call
 *
 * @out_vars = Returned array with variables from RPC call
 * return: none
 */
void
rpc_cli_freeCall(array_t ** __restrict out_vars)
{
#ifdef CLI_RES_ZCOPY
	array_Destroy(out_vars);
#else
	ait_freeVars(out_vars);
#endif
}

/*
 * rpc_cli_ping() - Ping RPC server
 *
 * @cli = connected client
 * return: -1 error or !=-1 ping seq id
 */
int
rpc_cli_ping(rpc_cli_t *cli)
{
	int ret = 0;
	array_t *arr = NULL;

	if (!cli)
		return -1;

	if (rpc_cli_execCall(cli, RPC_REPLY, CALL_SRVPING, NULL, &arr))
		return -1;
	else
		ret = AIT_GET_U16(array(arr, 0, ait_val_t*));
	rpc_cli_freeCall(&arr);

	return ret;
}