VILLASnode/clients/opal/models/AsyncIP_sl/socket.c

/** Helper functions for socket
 *
 *  Code example of an asynchronous program.  This program is started
 *  by the asynchronous controller and demonstrates how to send and 
 *  receive data to and from the asynchronous icons and a UDP or TCP
 *  port.
 *
 * @author Steffen Vogel <stvogel@eonerc.rwth-aachen.de>
 * @author Mathieu Dubé-Dallaire
 * @copyright 2014, Institute for Automation of Complex Power Systems, EONERC
 * @copyright 2003, OPAL-RT Technologies inc
 * @file
 */

#ifndef OPAL_IP_H
#define OPAL_IP_H

#ifndef PROGNAME
#define PROGNAME "AsyncIPUtils"
#endif
/* Modify this version line if you make changes to this file */
#define VERSION  "Opal-RT_20060524"

#include <errno.h>
#include <unistd.h>
#include <stdlib.h>
#include <fcntl.h>
#include <sys/time.h>
#include <sys/socket.h>
#include <netinet/in.h>

#define RT
#include "OpalPrint.h"
#include "AsyncApi.h"
#include "OpalGenAsyncParamCtrl.h"
#pragma pack()

#define UDP_PROTOCOL	1
#define TCP_PROTOCOL	2
#define	EOK		0

/* Globals variables */
struct sockaddr_in send_ad;	/* Send address */
struct sockaddr_in recv_ad;	/* Recveive address */
int sd = -1;			/* socket descriptor */
int proto = 1;

int InitSocket(Opal_GenAsyncParam_Ctrl IconCtrlStruct)
{
	struct ip_mreq mreq; /* Multicast group structure */
	int socket_type;
	int socket_proto;
	unsigned char TTL = 1;
	unsigned char LOOP = 0;
	int rc;

	proto = (int) IconCtrlStruct.FloatParam[0];
	OpalPrint("%s: Version        : %s\n", PROGNAME, VERSION);

	switch (proto) {
		case UDP_PROTOCOL:	/* Communication using UDP/IP protocol */
			socket_proto = IPPROTO_UDP;
			socket_type = SOCK_DGRAM;
			OpalPrint("%s: Protocol       : UDP/IP\n", PROGNAME);
		case TCP_PROTOCOL:	/* Communication using TCP/IP protocol */
			socket_proto = IPPROTO_IP;
			socket_type = SOCK_STREAM;
			OpalPrint("%s: Protocol       : TCP/IP\n", PROGNAME);
		case default:		/* Protocol is not recognized */
			OpalPrint("%s: ERROR: Protocol (%d) not supported!\n", PROGNAME, proto);
			return EINVAL;
	}

	OpalPrint("%s: Remote Address : %s\n", PROGNAME, IconCtrlStruct.StringParam[0]);
	OpalPrint("%s: Remote Port    : %d\n", PROGNAME, (int) IconCtrlStruct.FloatParam[1]);

	/* Initialize the socket */
	if ((sd = socket(AF_INET, socket_type, socket_proto)) < 0) {
		OpalPrint("%s: ERROR: Could not open socket\n", PROGNAME);
		return EIO;
	}

	/* Set the structure for the remote port and address */
	memset(&send_ad, 0, sizeof(send_ad));
	send_ad.sin_family = AF_INET;
	send_ad.sin_addr.s_addr = inet_addr(IconCtrlStruct.StringParam[0]);
	send_ad.sin_port = htons((u_short)IconCtrlStruct.FloatParam[1]);

	/* Set the structure for the local port and address */
	memset(&recv_ad, 0, sizeof(recv_ad));
	recv_ad.sin_family = AF_INET;
	recv_ad.sin_addr.s_addr = INADDR_ANY;
	recv_ad.sin_port = htons((u_short)IconCtrlStruct.FloatParam[2]);

	/* Bind local port and address to socket. */
	if (bind(sd, (struct sockaddr *) &recv_ad, sizeof(struct sockaddr_in)) == -1) {
		OpalPrint("%s: ERROR: Could not bind local port to socket\n", PROGNAME);
		return EIO;
	}
	else
		OpalPrint("%s: Local Port     : %d\n", PROGNAME, (int)IconCtrlStruct.FloatParam[2]);

	switch (proto) {
		case UDP_PROTOCOL:	/* Communication using UDP/IP protocol */
			/* If sending to a multicast address */
			if ((inet_addr(IconCtrlStruct.StringParam[0]) & inet_addr("240.0.0.0")) == inet_addr("224.0.0.0")) {
				if (setsockopt(sd, IPPROTO_IP, IP_MULTICAST_TTL, (char *) &TTL, sizeof(TTL)) == -1) {
					OpalPrint("%s: ERROR: Could not set TTL for multicast send (%d)\n", PROGNAME, errno);
					return EIO;
				}
				if (setsockopt(sd, IPPROTO_IP, IP_MULTICAST_LOOP, (char *)&LOOP, sizeof(LOOP)) == -1) {
					OpalPrint("%s: ERROR: Could not set loopback for multicast send (%d)\n", PROGNAME, errno);
					return EIO;
				}

				OpalPrint("%s: Configured socket for sending to multicast address\n", PROGNAME);
			}

			/* If receiving from a multicast group, register for it. */
			if (inet_addr(IconCtrlStruct.StringParam[1]) > 0) {
				if ((inet_addr(IconCtrlStruct.StringParam[1]) & inet_addr("240.0.0.0")) == inet_addr("224.0.0.0")) {
					mreq.imr_multiaddr.s_addr = inet_addr(IconCtrlStruct.StringParam[1]);
					mreq.imr_interface.s_addr = INADDR_ANY;

					/* Have the multicast socket join the multicast group */
					if (setsockopt(sd, IPPROTO_IP, IP_ADD_MEMBERSHIP, (char *) &mreq, sizeof(mreq)) == -1) {
						OpalPrint("%s: ERROR: Could not join multicast group (%d)\n", PROGNAME, errno);
						return EIO;
					}

					OpalPrint("%s: Added process to multicast group (%s)\n",
						PROGNAME, IconCtrlStruct.StringParam[1]);
				}
				else {
					OpalPrint("%s: WARNING: IP address for multicast group is not in multicast range. Ignored\n",
						PROGNAME);
				}
			}
		case TCP_PROTOCOL:	/* Communication using TCP/IP protocol */
			OpalPrint("%s: Calling connect()\n", PROGNAME);

			/* Connect to server to start data transmission */
			rc = connect(sd, (struct sockaddr *) &send_ad, sizeof(send_ad));
			if (rc < 0)  {
				OpalPrint("%s: ERROR: Call to connect() failed\n", PROGNAME);
				return EIO;
			}
	}

	return EOK;
}

int SendPacket(char* DataSend, int datalength)
{
	int err;

	if(sd < 0)
		return -1;

	/* Send the packet */
	if (proto == TCP_PROTOCOL)
		err = send(sd, DataSend, datalength, 0);
	else
		err = sendto(sd, DataSend, datalength, 0, (struct sockaddr *)&send_ad, sizeof(send_ad));

	return err;
}

int RecvPacket(char* DataRecv, int datalength, double timeout)
{
	int len;
	struct sockaddr_in client_ad;
	socklen_t client_ad_size = sizeof(client_ad);
	fd_set sd_set;
	struct timeval tv;

	if (sd < 0)
		return -1;

	/* Set the descriptor set for the select() call */
	FD_ZERO (&sd_set);
	FD_SET  (sd, &sd_set);

	/* Set the tv structure to the correct timeout value */
	tv.tv_sec = (int) timeout;
	tv.tv_usec = (int) ((timeout - tv.tv_sec) * 1000000);

	/* Wait for a packet. We use select() to have a timeout. This is
	 * necessary when reseting the model so we don't wait indefinitely
	 * and prevent the process from exiting and freeing the port for
	 * a future instance (model load). */
	switch (select(sd+1, &sd_set, (fd_set *) 0, (fd_set *) 0, &tv)) {
		case -1: /* Error */
			return -1;
		case  0: /* We hit the timeout */
			return 0;
		default:
			if (!(FD_ISSET(sd, &sd_set))) {
				/* We received something, but it's not on "sd". Since sd is the only
				 * descriptor in the set... */
				OpalPrint("%s: RecvPacket: God, is that You trying to reach me?\n", PROGNAME);
				return -1;
			}
	}

	/* Clear the DataRecv array (in case we receive an incomplete packet) */
	memset(DataRecv, 0, datalength);

	/* Perform the reception */
	if (proto == TCP_PROTOCOL)
		len = recv(sd, DataRecv, datalength, 0);
	else
		len = recvfrom(sd, DataRecv, datalength, 0, (struct sockaddr *) &client_ad, &client_ad_size);

	return len;
}

int CloseSocket(Opal_GenAsyncParam_Ctrl IconCtrlStruct)
{
	if (sd < 0) {
		shutdown(sd, SHUT_RDWR);
		close(sd);
	}

	return 0;
}

#endif /* OPAL_IP_H */