[mirror_frr.git] / lib / sockopt.c

/* setsockopt functions
 * Copyright (C) 1999 Kunihiro Ishiguro
 *
 * This file is part of GNU Zebra.
 *
 * GNU Zebra is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation; either version 2, or (at your option) any
 * later version.
 *
 * GNU Zebra is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with GNU Zebra; see the file COPYING.  If not, write to the Free
 * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
 * 02111-1307, USA.  
 */

#include <zebra.h>
#include "log.h"

static void *
getsockopt_cmsg_data (struct msghdr *msgh, int level, int type)
{
  struct cmsghdr *cmsg;
  void *ptr = NULL;
  
  for (cmsg = CMSG_FIRSTHDR(msgh); 
       cmsg != NULL;
       cmsg = CMSG_NXTHDR(msgh, cmsg))
    if (cmsg->cmsg_level == level && cmsg->cmsg_type)
      return (ptr = CMSG_DATA(cmsg));
}

#ifdef HAVE_IPV6
/* Set IPv6 packet info to the socket. */
int
setsockopt_ipv6_pktinfo (int sock, int val)
{
  int ret;
    
#ifdef IPV6_RECVPKTINFO		/*2292bis-01*/
  ret = setsockopt(sock, IPPROTO_IPV6, IPV6_RECVPKTINFO, &val, sizeof(val));
  if (ret < 0)
    zlog_warn ("can't setsockopt IPV6_RECVPKTINFO : %s", strerror (errno));
#else	/*RFC2292*/
  ret = setsockopt(sock, IPPROTO_IPV6, IPV6_PKTINFO, &val, sizeof(val));
  if (ret < 0)
    zlog_warn ("can't setsockopt IPV6_PKTINFO : %s", strerror (errno));
#endif /* INIA_IPV6 */
  return ret;
}

/* Set multicast hops val to the socket. */
int
setsockopt_ipv6_checksum (int sock, int val)
{
  int ret;

#ifdef GNU_LINUX
  ret = setsockopt(sock, IPPROTO_RAW, IPV6_CHECKSUM, &val, sizeof(val));
#else
  ret = setsockopt(sock, IPPROTO_IPV6, IPV6_CHECKSUM, &val, sizeof(val));
#endif /* GNU_LINUX */
  if (ret < 0)
    zlog_warn ("can't setsockopt IPV6_CHECKSUM");
  return ret;
}

/* Set multicast hops val to the socket. */
int
setsockopt_ipv6_multicast_hops (int sock, int val)
{
  int ret;

  ret = setsockopt(sock, IPPROTO_IPV6, IPV6_MULTICAST_HOPS, &val, sizeof(val));
  if (ret < 0)
    zlog_warn ("can't setsockopt IPV6_MULTICAST_HOPS");
  return ret;
}

/* Set multicast hops val to the socket. */
int
setsockopt_ipv6_unicast_hops (int sock, int val)
{
  int ret;

  ret = setsockopt(sock, IPPROTO_IPV6, IPV6_UNICAST_HOPS, &val, sizeof(val));
  if (ret < 0)
    zlog_warn ("can't setsockopt IPV6_UNICAST_HOPS");
  return ret;
}

int
setsockopt_ipv6_hoplimit (int sock, int val)
{
  int ret;

#ifdef IPV6_RECVHOPLIMIT	/*2292bis-01*/
  ret = setsockopt (sock, IPPROTO_IPV6, IPV6_RECVHOPLIMIT, &val, sizeof(val));
  if (ret < 0)
    zlog_warn ("can't setsockopt IPV6_RECVHOPLIMIT");
#else	/*RFC2292*/
  ret = setsockopt (sock, IPPROTO_IPV6, IPV6_HOPLIMIT, &val, sizeof(val));
  if (ret < 0)
    zlog_warn ("can't setsockopt IPV6_HOPLIMIT");
#endif
  return ret;
}

/* Set multicast loop zero to the socket. */
int
setsockopt_ipv6_multicast_loop (int sock, int val)
{
  int ret;
    
  ret = setsockopt (sock, IPPROTO_IPV6, IPV6_MULTICAST_LOOP, &val,
		    sizeof (val));
  if (ret < 0)
    zlog_warn ("can't setsockopt IPV6_MULTICAST_LOOP");
  return ret;
}

static int
getsockopt_ipv6_pktinfo_ifindex (struct msghdr *msgh)
{
  struct in6_pktinfo *pktinfo;
  
  pktinfo = getsockopt_cmsg_data (msgh, IPPROTO_IPV6, IPV6_PKTINFO);
  
  return pktinfo->ipi6_ifindex;
}
#endif /* HAVE_IPV6 */


/* Set up a multicast socket options for IPv4
   This is here so that people only have to do their OS multicast mess 
   in one place rather than all through zebra, ospfd, and ripd 
   NB: This is a hookpoint for specific OS functionality */
int
setsockopt_multicast_ipv4(int sock, 
			int optname, 
			struct in_addr if_addr,
			unsigned int mcast_addr,
			unsigned int ifindex)
{

  /* Linux 2.2.0 and up */
#if defined(GNU_LINUX) && LINUX_VERSION_CODE > 131584
  /* This is better because it uses ifindex directly */
  struct ip_mreqn mreqn;
  
  switch (optname)
    {
    case IP_MULTICAST_IF:
    case IP_ADD_MEMBERSHIP:
    case IP_DROP_MEMBERSHIP:
      memset (&mreqn, 0, sizeof(mreqn));

      if (mcast_addr)
	mreqn.imr_multiaddr.s_addr = mcast_addr;
      
      if (ifindex)
	mreqn.imr_ifindex = ifindex;
      else
	mreqn.imr_address = if_addr;
      
      return setsockopt(sock, IPPROTO_IP, optname, (void *)&mreqn, sizeof(mreqn));
      break;

    default:
      /* Can out and give an understandable error */
      errno = EINVAL;
      return -1;
      break;
    }

  /* Example defines for another OS, boilerplate off other code in this
     function, AND handle optname as per other sections for consistency !! */
  /* #elif  defined(BOGON_NIX) && EXAMPLE_VERSION_CODE > -100000 */
  /* Add your favourite OS here! */

#else /* #if OS_TYPE */ 
  /* default OS support */

  struct in_addr m;
  struct ip_mreq mreq;

  switch (optname)
    {
    case IP_MULTICAST_IF:
      m = if_addr;
      
      return setsockopt (sock, IPPROTO_IP, optname, (void *)&m, sizeof(m)); 
      break;

    case IP_ADD_MEMBERSHIP:
    case IP_DROP_MEMBERSHIP:
      memset (&mreq, 0, sizeof(mreq));
      mreq.imr_multiaddr.s_addr = mcast_addr;
      mreq.imr_interface = if_addr;
      
      return setsockopt (sock, 
			 IPPROTO_IP, 
			 optname, 
			 (void *)&mreq, 
			 sizeof(mreq));
      break;
      
    default:
      /* Can out and give an understandable error */
      errno = EINVAL;
      return -1;
      break;
    }
#endif /* #if OS_TYPE */

}

static int
setsockopt_ipv4_pktinfo (int sock, int val)
{
  int ret;

#if defined (IP_PKTINFO)
  ret = setsockopt (sock, IPPROTO_IP, IP_PKTINFO, &val, sizeof (val));
#elif defined (IP_RECVIF)
  ret = setsockopt (sock, IPPROTO_IP, IP_RECVIF, &val, sizeof (val));
#else
#warning "Neither IP_PKTINFO nor IP_RECVIF is available."
#warning "Will not be able to receive link info."
#warning "Things might be seriously broken.."
#endif

  if (ret < 0)
    zlog_warn ("Can't set IP_PKTINFO option");
  return ret;
}

/* set appropriate pktinfo socket option 
 * on systems without PKTINFO, sets RECVIF, which only retrieves
 * interface index.
 */
int 
setsockopt_pktinfo (int af, int sock, int val)
{
  int ret = -1;
  
  switch (af)
    {
      case AF_INET:
        ret = setsockopt_ipv4_pktinfo (sock, val);
        break;
#ifdef HAVE_IPV6
      case AF_INET6:
        ret = setsockopt_ipv6_pktinfo (sock, val);
        break;
#endif
      default:
        zlog_warn ("setsockopt_pktinfo: unknown address family %d");
    }
  return ret;
}


static int
getsockopt_ipv4_pktinfo_ifindex (struct msghdr *msgh)
{
  int ifindex = 0;
#if defined (IP_PKTINFO)
  struct in_pktinfo *pktinfo;
#elif defined (IP_RECVIF)
#ifndef SUNOS_5
  /* RECVIF, but not SUNOS, so BSD */
  struct sockaddr_dl *sdl;
#endif /* SUNOS_5 */
  /* SUNOS_5 doesn't need a structure to extract ifindex */
#else /* IP_RECVIF */
  /* XXX Neither, so we are going to lose. */
#endif /* IP_PKTINFO */
  
#ifdef IP_PKTINFO
  pktinfo = 
    (struct in_pktinfo *)getsockopt_cmsg_data (msgh, IPPROTO_IP, IP_PKTINFO);
#elif defined (IP_RECVIF)
#ifndef SUNOS_5
  sdl = 
    (struct sockaddr_dl *)getsockopt_cmsg_data (msgh, IPPROTO_IP, IP_RECVIF);
  ifindex = sdl->sdl_index;
#else
  ifindex = *(uint_t *)getsockopt_cmsg_data (msgh, IPPROTO_IP, IP_RECVIF);
#endif /* SUNOS_5 */
#else
#warning "getsockopt_ipv4_pktinfo_ifindex: dont have PKTINFO or RECVIF"
  /* XXX why not -1 - this is a failure condition. */
  ifindex = 0;
#endif /* IP_PKTINFO */
 
  return ifindex;
}

/* return ifindex, 0 if none found */
int
getsockopt_pktinfo_ifindex (int af, struct msghdr *msgh)
{
  int ifindex = 0;
  
  switch (af)
    {
      case AF_INET:
        return (getsockopt_ipv4_pktinfo_ifindex (msgh));
        break;
#ifdef HAVE_IPV6
      case AF_INET6:
        return (getsockopt_ipv6_pktinfo_ifindex (msgh));
        break;
#endif
      default:
        zlog_warn ("getsockopt_pktinfo_ifindex: unknown address family %d");
        return (ifindex = 0);
    }
}
Commit	Line	Data
718e3744	1	/* setsockopt functions
	2	* Copyright (C) 1999 Kunihiro Ishiguro
	3	*
	4	* This file is part of GNU Zebra.
	5	*
	6	* GNU Zebra is free software; you can redistribute it and/or modify it
	7	* under the terms of the GNU General Public License as published by the
	8	* Free Software Foundation; either version 2, or (at your option) any
	9	* later version.
	10	*
	11	* GNU Zebra is distributed in the hope that it will be useful, but
	12	* WITHOUT ANY WARRANTY; without even the implied warranty of
	13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	14	* General Public License for more details.
	15	*
	16	* You should have received a copy of the GNU General Public License
	17	* along with GNU Zebra; see the file COPYING. If not, write to the Free
	18	* Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
	19	* 02111-1307, USA.
	20	*/
	21
	22	#include <zebra.h>
	23	#include "log.h"
	24
4f7baa0e	25	static void *
	26	getsockopt_cmsg_data (struct msghdr *msgh, int level, int type)
	27	{
	28	struct cmsghdr *cmsg;
	29	void *ptr = NULL;
	30
	31	for (cmsg = CMSG_FIRSTHDR(msgh);
	32	cmsg != NULL;
	33	cmsg = CMSG_NXTHDR(msgh, cmsg))
	34	if (cmsg->cmsg_level == level && cmsg->cmsg_type)
	35	return (ptr = CMSG_DATA(cmsg));
	36	}
	37
718e3744	38	#ifdef HAVE_IPV6
	39	/* Set IPv6 packet info to the socket. */
	40	int
	41	setsockopt_ipv6_pktinfo (int sock, int val)
	42	{
	43	int ret;
	44
	45	#ifdef IPV6_RECVPKTINFO /2292bis-01/
	46	ret = setsockopt(sock, IPPROTO_IPV6, IPV6_RECVPKTINFO, &val, sizeof(val));
	47	if (ret < 0)
	48	zlog_warn ("can't setsockopt IPV6_RECVPKTINFO : %s", strerror (errno));
	49	#else /RFC2292/
	50	ret = setsockopt(sock, IPPROTO_IPV6, IPV6_PKTINFO, &val, sizeof(val));
	51	if (ret < 0)
	52	zlog_warn ("can't setsockopt IPV6_PKTINFO : %s", strerror (errno));
	53	#endif /* INIA_IPV6 */
	54	return ret;
	55	}
	56
	57	/* Set multicast hops val to the socket. */
	58	int
	59	setsockopt_ipv6_checksum (int sock, int val)
	60	{
	61	int ret;
	62
	63	#ifdef GNU_LINUX
	64	ret = setsockopt(sock, IPPROTO_RAW, IPV6_CHECKSUM, &val, sizeof(val));
	65	#else
	66	ret = setsockopt(sock, IPPROTO_IPV6, IPV6_CHECKSUM, &val, sizeof(val));
	67	#endif /* GNU_LINUX */
	68	if (ret < 0)
	69	zlog_warn ("can't setsockopt IPV6_CHECKSUM");
	70	return ret;
	71	}
	72
	73	/* Set multicast hops val to the socket. */
	74	int
	75	setsockopt_ipv6_multicast_hops (int sock, int val)
	76	{
	77	int ret;
	78
	79	ret = setsockopt(sock, IPPROTO_IPV6, IPV6_MULTICAST_HOPS, &val, sizeof(val));
	80	if (ret < 0)
	81	zlog_warn ("can't setsockopt IPV6_MULTICAST_HOPS");
	82	return ret;
	83	}
	84
	85	/* Set multicast hops val to the socket. */
	86	int
	87	setsockopt_ipv6_unicast_hops (int sock, int val)
	88	{
	89	int ret;
	90
	91	ret = setsockopt(sock, IPPROTO_IPV6, IPV6_UNICAST_HOPS, &val, sizeof(val));
	92	if (ret < 0)
	93	zlog_warn ("can't setsockopt IPV6_UNICAST_HOPS");
	94	return ret;
	95	}
	96
	97	int
	98	setsockopt_ipv6_hoplimit (int sock, int val)
	99	{
	100	int ret;
	101
102	#ifdef IPV6_RECVHOPLIMIT /2292bis-01/
103	ret = setsockopt (sock, IPPROTO_IPV6, IPV6_RECVHOPLIMIT, &val, sizeof(val));
104	if (ret < 0)
105	zlog_warn ("can't setsockopt IPV6_RECVHOPLIMIT");
106	#else /RFC2292/
107	ret = setsockopt (sock, IPPROTO_IPV6, IPV6_HOPLIMIT, &val, sizeof(val));
108	if (ret < 0)
109	zlog_warn ("can't setsockopt IPV6_HOPLIMIT");
110	#endif
111	return ret;
112	}
113
114	/* Set multicast loop zero to the socket. */
115	int
116	setsockopt_ipv6_multicast_loop (int sock, int val)
117	{
118	int ret;
119
120	ret = setsockopt (sock, IPPROTO_IPV6, IPV6_MULTICAST_LOOP, &val,
121	sizeof (val));
122	if (ret < 0)
123	zlog_warn ("can't setsockopt IPV6_MULTICAST_LOOP");
124	return ret;
125	}
126
4f7baa0e	127	static int
	128	getsockopt_ipv6_pktinfo_ifindex (struct msghdr *msgh)
	129	{
	130	struct in6_pktinfo *pktinfo;
	131
	132	pktinfo = getsockopt_cmsg_data (msgh, IPPROTO_IPV6, IPV6_PKTINFO);
	133
	134	return pktinfo->ipi6_ifindex;
	135	}
718e3744	136	#endif /* HAVE_IPV6 */
	137
	138
	139	/* Set up a multicast socket options for IPv4
	140	This is here so that people only have to do their OS multicast mess
	141	in one place rather than all through zebra, ospfd, and ripd
	142	NB: This is a hookpoint for specific OS functionality */
	143	int
	144	setsockopt_multicast_ipv4(int sock,
	145	int optname,
	146	struct in_addr if_addr,
	147	unsigned int mcast_addr,
	148	unsigned int ifindex)
	149	{
	150
	151	/* Linux 2.2.0 and up */
	152	#if defined(GNU_LINUX) && LINUX_VERSION_CODE > 131584
	153	/* This is better because it uses ifindex directly */
	154	struct ip_mreqn mreqn;
	155
	156	switch (optname)
	157	{
	158	case IP_MULTICAST_IF:
	159	case IP_ADD_MEMBERSHIP:
	160	case IP_DROP_MEMBERSHIP:
	161	memset (&mreqn, 0, sizeof(mreqn));
	162
	163	if (mcast_addr)
	164	mreqn.imr_multiaddr.s_addr = mcast_addr;
	165
	166	if (ifindex)
	167	mreqn.imr_ifindex = ifindex;
	168	else
	169	mreqn.imr_address = if_addr;
	170
	171	return setsockopt(sock, IPPROTO_IP, optname, (void *)&mreqn, sizeof(mreqn));
	172	break;
	173
	174	default:
	175	/* Can out and give an understandable error */
	176	errno = EINVAL;
	177	return -1;
	178	break;
	179	}
	180
	181	/* Example defines for another OS, boilerplate off other code in this
	182	function, AND handle optname as per other sections for consistency !! */
	183	/* #elif defined(BOGON_NIX) && EXAMPLE_VERSION_CODE > -100000 */
	184	/* Add your favourite OS here! */
	185
	186	#else /* #if OS_TYPE */
	187	/* default OS support */
	188
	189	struct in_addr m;
	190	struct ip_mreq mreq;
	191
	192	switch (optname)
	193	{
	194	case IP_MULTICAST_IF:
	195	m = if_addr;
	196
	197	return setsockopt (sock, IPPROTO_IP, optname, (void *)&m, sizeof(m));
	198	break;
	199
200	case IP_ADD_MEMBERSHIP:
201	case IP_DROP_MEMBERSHIP:
202	memset (&mreq, 0, sizeof(mreq));
203	mreq.imr_multiaddr.s_addr = mcast_addr;
204	mreq.imr_interface = if_addr;
205
206	return setsockopt (sock,
207	IPPROTO_IP,
208	optname,
209	(void *)&mreq,
210	sizeof(mreq));
211	break;
212
213	default:
214	/* Can out and give an understandable error */
215	errno = EINVAL;
216	return -1;
217	break;
218	}
219	#endif /* #if OS_TYPE */
220
221	}
4f7baa0e	222
	223	static int
	224	setsockopt_ipv4_pktinfo (int sock, int val)
	225	{
	226	int ret;
	227
	228	#if defined (IP_PKTINFO)
	229	ret = setsockopt (sock, IPPROTO_IP, IP_PKTINFO, &val, sizeof (val));
	230	#elif defined (IP_RECVIF)
	231	ret = setsockopt (sock, IPPROTO_IP, IP_RECVIF, &val, sizeof (val));
	232	#else
	233	#warning "Neither IP_PKTINFO nor IP_RECVIF is available."
	234	#warning "Will not be able to receive link info."
	235	#warning "Things might be seriously broken.."
	236	#endif
	237
	238	if (ret < 0)
	239	zlog_warn ("Can't set IP_PKTINFO option");
	240	return ret;
	241	}
	242
	243	/* set appropriate pktinfo socket option
	244	* on systems without PKTINFO, sets RECVIF, which only retrieves
	245	* interface index.
	246	*/
	247	int
	248	setsockopt_pktinfo (int af, int sock, int val)
	249	{
	250	int ret = -1;
	251
	252	switch (af)
	253	{
	254	case AF_INET:
	255	ret = setsockopt_ipv4_pktinfo (sock, val);
	256	break;
	257	#ifdef HAVE_IPV6
	258	case AF_INET6:
	259	ret = setsockopt_ipv6_pktinfo (sock, val);
	260	break;
	261	#endif
	262	default:
	263	zlog_warn ("setsockopt_pktinfo: unknown address family %d");
	264	}
	265	return ret;
	266	}
	267
	268
	269	static int
	270	getsockopt_ipv4_pktinfo_ifindex (struct msghdr *msgh)
	271	{
	272	int ifindex = 0;
	273	#if defined (IP_PKTINFO)
	274	struct in_pktinfo *pktinfo;
33f92320	275	#elif defined (IP_RECVIF)
4f7baa0e	276	#ifndef SUNOS_5
33f92320	277	/* RECVIF, but not SUNOS, so BSD */
4f7baa0e	278	struct sockaddr_dl *sdl;
4f7baa0e	279	#endif /* SUNOS_5 */
33f92320	280	/* SUNOS_5 doesn't need a structure to extract ifindex */
4f7baa0e	281	#else /* IP_RECVIF */
33f92320	282	/* XXX Neither, so we are going to lose. */
4f7baa0e	283	#endif /* IP_PKTINFO */
	284
	285	#ifdef IP_PKTINFO
	286	pktinfo =
	287	(struct in_pktinfo *)getsockopt_cmsg_data (msgh, IPPROTO_IP, IP_PKTINFO);
	288	#elif defined (IP_RECVIF)
33f92320	289	#ifndef SUNOS_5
33f92320	290	sdl =
4f7baa0e	291	(struct sockaddr_dl *)getsockopt_cmsg_data (msgh, IPPROTO_IP, IP_RECVIF);
33f92320	292	ifindex = sdl->sdl_index;
	293	#else
	294	ifindex = (uint_t )getsockopt_cmsg_data (msgh, IPPROTO_IP, IP_RECVIF);
4f7baa0e	295	#endif /* SUNOS_5 */
	296	#else
	297	#warning "getsockopt_ipv4_pktinfo_ifindex: dont have PKTINFO or RECVIF"
33f92320	298	/* XXX why not -1 - this is a failure condition. */
33f92320	299	ifindex = 0;
4f7baa0e	300	#endif /* IP_PKTINFO */
	301
	302	return ifindex;
	303	}
	304
	305	/* return ifindex, 0 if none found */
	306	int
	307	getsockopt_pktinfo_ifindex (int af, struct msghdr *msgh)
	308	{
	309	int ifindex = 0;
	310
	311	switch (af)
	312	{
	313	case AF_INET:
	314	return (getsockopt_ipv4_pktinfo_ifindex (msgh));
	315	break;
	316	#ifdef HAVE_IPV6
	317	case AF_INET6:
	318	return (getsockopt_ipv6_pktinfo_ifindex (msgh));
	319	break;
	320	#endif
	321	default:
	322	zlog_warn ("getsockopt_pktinfo_ifindex: unknown address family %d");
	323	return (ifindex = 0);
	324	}
	325	}
	326