contrib/dhcpcd/src/ipv6nd.h

   1 /* SPDX-License-Identifier: BSD-2-Clause */
   2 /*
   3  * dhcpcd - IPv6 ND handling
   4  * Copyright (c) 2006-2019 Roy Marples <roy@marples.name>
   5  * All rights reserved
   6
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26  * SUCH DAMAGE.
  27  */
  28
  29 #ifndef IPV6ND_H
  30 #define IPV6ND_H
  31
  32 #ifdef INET6
  33
  34 #include <time.h>
  35
  36 #include "config.h"
  37 #include "dhcpcd.h"
  38 #include "ipv6.h"
  39
  40 struct ra {
  41         TAILQ_ENTRY(ra) next;
  42         struct interface *iface;
  43         struct in6_addr from;
  44         char sfrom[INET6_ADDRSTRLEN];
  45         uint8_t *data;
  46         size_t data_len;
  47         struct timespec acquired;
  48         unsigned char flags;
  49         uint32_t lifetime;
  50         uint32_t reachable;
  51         uint32_t retrans;
  52         uint32_t mtu;
  53         uint8_t hoplimit;
  54         struct ipv6_addrhead addrs;
  55         bool hasdns;
  56         bool expired;
  57         bool isreachable;
  58 };
  59
  60 TAILQ_HEAD(ra_head, ra);
  61
  62 struct rs_state {
  63         struct nd_router_solicit *rs;
  64         size_t rslen;
  65         int rsprobes;
  66         uint32_t retrans;
  67 #ifdef __sun
  68         int nd_fd;
  69 #endif
  70 };
  71
  72 #define RS_STATE(a) ((struct rs_state *)(ifp)->if_data[IF_DATA_IPV6ND])
  73 #define RS_CSTATE(a) ((const struct rs_state *)(ifp)->if_data[IF_DATA_IPV6ND])
  74 #define RS_STATE_RUNNING(a) (ipv6nd_hasra((a)) && ipv6nd_dadcompleted((a)))
  75
  76 #ifndef MAX_RTR_SOLICITATION_DELAY
  77 #define MAX_RTR_SOLICITATION_DELAY      1       /* seconds */
  78 #define MAX_UNICAST_SOLICIT             3       /* 3 transmissions */
  79 #define RTR_SOLICITATION_INTERVAL       4       /* seconds */
  80 #define MAX_RTR_SOLICITATIONS           3       /* times */
  81 #define MAX_NEIGHBOR_ADVERTISEMENT      3       /* 3 transmissions */
  82
  83 #ifndef IPV6_DEFHLIM
  84 #define IPV6_DEFHLIM                    64
  85 #endif
  86 #endif
  87
  88 /* On carrier up, expire known routers after RTR_CARRIER_EXPIRE seconds. */
  89 #define RTR_CARRIER_EXPIRE              \
  90     (MAX_RTR_SOLICITATION_DELAY +       \
  91     (MAX_RTR_SOLICITATIONS + 1) *       \
  92     RTR_SOLICITATION_INTERVAL)
  93
  94 #define MAX_REACHABLE_TIME              3600000 /* milliseconds */
  95 #define REACHABLE_TIME                  30000   /* milliseconds */
  96 #define RETRANS_TIMER                   1000    /* milliseconds */
  97 #define DELAY_FIRST_PROBE_TIME          5       /* seconds */
  98
  99 void ipv6nd_printoptions(const struct dhcpcd_ctx *,
 100     const struct dhcp_opt *, size_t);
 101 void ipv6nd_startrs(struct interface *);
 102 ssize_t ipv6nd_env(FILE *, const struct interface *);
 103 const struct ipv6_addr *ipv6nd_iffindaddr(const struct interface *ifp,
 104     const struct in6_addr *addr, unsigned int flags);
 105 struct ipv6_addr *ipv6nd_findaddr(struct dhcpcd_ctx *,
 106     const struct in6_addr *, unsigned int);
 107 ssize_t ipv6nd_free(struct interface *);
 108 void ipv6nd_expirera(void *arg);
 109 bool ipv6nd_hasralifetime(const struct interface *, bool);
 110 #define ipv6nd_hasra(i)         ipv6nd_hasralifetime((i), false)
 111 bool ipv6nd_hasradhcp(const struct interface *);
 112 void ipv6nd_handleifa(int, struct ipv6_addr *, pid_t);
 113 int ipv6nd_dadcompleted(const struct interface *);
 114 void ipv6nd_advertise(struct ipv6_addr *);
 115 void ipv6nd_startexpire(struct interface *);
 116 void ipv6nd_drop(struct interface *);
 117 void ipv6nd_neighbour(struct dhcpcd_ctx *, struct in6_addr *, bool);
 118 #endif /* INET6 */
 119
 120 #endif /* IPV6ND_H */