incubator-nuttx/net/inet/ipv6_setsockopt.c

/****************************************************************************
 * net/inet/ipv6_setsockopt.c
 *
 * SPDX-License-Identifier: Apache-2.0
 *
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.  The
 * ASF licenses this file to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance with the
 * License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
 * License for the specific language governing permissions and limitations
 * under the License.
 *
 ****************************************************************************/

/****************************************************************************
 * Included Files
 ****************************************************************************/

#include <nuttx/config.h>

#include <sys/types.h>
#include <errno.h>
#include <debug.h>

#include <netinet/in.h>

#include <nuttx/net/net.h>

#include "netdev/netdev.h"
#include "netfilter/iptables.h"
#include "mld/mld.h"
#include "inet/inet.h"
#include "socket/socket.h"
#include "udp/udp.h"

#if defined(CONFIG_NET_IPv6) && defined(CONFIG_NET_SOCKOPTS)

/****************************************************************************
 * Public Functions
 ****************************************************************************/

/****************************************************************************
 * Name: ipv6_setsockopt
 *
 * Description:
 *   ipv6_setsockopt() sets the IPv6-protocol socket option specified by the
 *   'option' argument to the value pointed to by the 'value' argument for
 *   the socket specified by the 'psock' argument.
 *
 *   See <netinet/in.h> for the a complete list of values of IPv6 protocol
 *   socket options.
 *
 * Input Parameters:
 *   psock     Socket structure of socket to operate on
 *   option    identifies the option to set
 *   value     Points to the argument value
 *   value_len The length of the argument value
 *
 * Returned Value:
 *   Returns zero (OK) on success.  On failure, it returns a negated errno
 *   value to indicate the nature of the error.  See psock_setcockopt() for
 *   the list of possible error values.
 *
 ****************************************************************************/

int ipv6_setsockopt(FAR struct socket *psock, int option,
                    FAR const void *value, socklen_t value_len)
{
  int ret;

  ninfo("option: %d\n", option);

  if (value == NULL || value_len == 0)
    {
      return -EINVAL;
    }

  net_lock();
  switch (option)
    {
#ifdef CONFIG_NET_MLD

      /* Handle MLD-related socket options */

      case IPV6_JOIN_GROUP:       /* Join a multicast group */
        ret = mld_joingroup(value);
        break;

      case IPV6_LEAVE_GROUP:      /* Quit a multicast group */
        ret = mld_leavegroup(value);
        break;

      case IPV6_MULTICAST_HOPS:   /* Multicast hop limit */
        {
          FAR struct socket_conn_s *conn = psock->s_conn;

          conn->s_ttl = (value_len >= sizeof(int)) ?
                        *(FAR int *)value : (int)*(FAR unsigned char *)value;
          ret = OK;
        }
        break;

      case IPV6_MULTICAST_IF:     /* Interface to use for outgoing multicast
                                   * packets */
#ifdef NET_UDP_HAVE_STACK
      {
        FAR struct net_driver_s *dev;
        FAR struct udp_conn_s *conn = psock->s_conn;
        int ifindex = *(FAR int *)value;

        if (ifindex > 0)
          {
            dev = netdev_findbyindex(ifindex);
            if (dev == NULL)
              {
                ret = -ENODEV;
                break;
              }

#ifdef CONFIG_NET_BINDTODEVICE
            if (conn->sconn.s_boundto &&
                ifindex != conn->sconn.s_boundto)
              {
                ret = -EINVAL;
                break;
              }
#endif
          }

        conn->mreq.imr_ifindex = ifindex;

        ret = OK;
        break;
      }
#endif /* NET_UDP_HAVE_STACK */
#endif /* CONFIG_NET_MLD */

      /* The following IPv6 socket options are defined, but not implemented */

      case IPV6_V6ONLY:           /* Restrict AF_INET6 socket to IPv6
                                   * communications only */
        nwarn("WARNING: Unimplemented IPv6 option: %d\n", option);
        ret = -ENOSYS;
        break;

      case IPV6_UNICAST_HOPS:     /* Unicast hop limit */
        {
          FAR struct socket_conn_s *conn = psock->s_conn;

          conn->s_ttl = (value_len >= sizeof(int)) ?
                        *(FAR int *)value : (int)*(FAR unsigned char *)value;
          ret = OK;
        }
        break;

#ifdef CONFIG_NET_MLD
      case IPV6_MULTICAST_LOOP:   /* Multicast packets are delivered back to
                                   * the local application */
#endif
      case IPV6_RECVPKTINFO:
      case IPV6_RECVHOPLIMIT:
        {
          FAR struct socket_conn_s *conn = psock->s_conn;
          int enable = (value_len >= sizeof(int)) ?
                       *(FAR int *)value : (int)*(FAR unsigned char *)value;

          if (enable)
            {
              _SO_SETOPT(conn->s_options, option);
            }
          else
            {
              _SO_CLROPT(conn->s_options, option);
            }

          ret = OK;
        }
        break;

      case IPV6_TCLASS:
        {
          FAR struct socket_conn_s *conn = psock->s_conn;
          int tclass = (value_len >= sizeof(int)) ?
                       *(FAR int *)value : (int)*(FAR unsigned char *)value;

          /* According to RFC3542 6.5, the interpretation of the integer
           * traffic class value is:
           *   x < -1:        return an error of EINVAL
           *   x == -1:       use kernel default
           *   0 <= x <= 255: use x
           *   x >= 256:      return an error of EINVAL
           */

          if (tclass < -1 || tclass > 0xff)
            {
              nerr("ERROR: invalid tclass:%d\n", tclass);
              ret = -EINVAL;
            }
          else
            {
              if (tclass == -1)
                {
                  /* Default value is 0 */

                  tclass = 0;
                }

              conn->s_tclass = tclass;
              ret = OK;
            }
        }
        break;

#ifdef CONFIG_NET_IPTABLES
      case IP6T_SO_SET_REPLACE:
        ret = ip6t_setsockopt(psock, option, value, value_len);
        break;
#endif

      default:
        nerr("ERROR: Unrecognized IPv6 option: %d\n", option);
        ret = -ENOPROTOOPT;
        break;
    }

  net_unlock();
  return ret;
}

#endif /* CONFIG_NET_IPv6 */