sys/net/route/route_ctl.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2020 Alexander V. Chernikov
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25  * SUCH DAMAGE.
  26  *
  27  * $FreeBSD$
  28  */
  29
  30 /*
  31  * This header file contains public functions and structures used for
  32  * routing table manipulations.
  33  */
  34
  35 #ifndef _NET_ROUTE_ROUTE_CTL_H_
  36 #define _NET_ROUTE_ROUTE_CTL_H_
  37
  38 struct rib_cmd_info {
  39         uint8_t                 rc_cmd;         /* RTM_ADD|RTM_DEL|RTM_CHANGE */
  40         uint8_t                 spare[3];
  41         uint32_t                rc_nh_weight;   /* new nhop weight */
  42         struct rtentry          *rc_rt;         /* Target entry */
  43         struct nhop_object      *rc_nh_old;     /* Target nhop OR mpath */
  44         struct nhop_object      *rc_nh_new;     /* Target nhop OR mpath */
  45 };
  46
  47 int rib_add_route(uint32_t fibnum, struct rt_addrinfo *info,
  48   struct rib_cmd_info *rc);
  49 int rib_del_route(uint32_t fibnum, struct rt_addrinfo *info,
  50   struct rib_cmd_info *rc);
  51 int rib_change_route(uint32_t fibnum, struct rt_addrinfo *info,
  52   struct rib_cmd_info *rc);
  53 int rib_action(uint32_t fibnum, int action, struct rt_addrinfo *info,
  54   struct rib_cmd_info *rc);
  55 int rib_handle_ifaddr_info(uint32_t fibnum, int cmd, struct rt_addrinfo *info);
  56
  57 typedef void route_notification_t(struct rib_cmd_info *rc, void *);
  58 void rib_decompose_notification(struct rib_cmd_info *rc,
  59     route_notification_t *cb, void *cbdata);
  60
  61 int rib_add_redirect(u_int fibnum, struct sockaddr *dst,
  62   struct sockaddr *gateway, struct sockaddr *author, struct ifnet *ifp,
  63   int flags, int expire_sec);
  64
  65 /* common flags for the functions below */
  66 #define RIB_FLAG_WLOCK          0x01    /* Need exclusive rnh lock */
  67 #define RIB_FLAG_LOCKED         0x02    /* Do not explicitly acquire rnh lock */
  68
  69 enum rib_walk_hook {
  70         RIB_WALK_HOOK_PRE,      /* Hook is called before iteration */
  71         RIB_WALK_HOOK_POST,     /* Hook is called after iteration */
  72 };
  73 typedef int rib_walktree_f_t(struct rtentry *, void *);
  74 typedef void rib_walk_hook_f_t(struct rib_head *rnh, enum rib_walk_hook stage,
  75     void *arg);
  76 void rib_walk(uint32_t fibnum, int af, bool wlock, rib_walktree_f_t *wa_f,
  77     void *arg);
  78 void rib_walk_ext(uint32_t fibnum, int af, bool wlock, rib_walktree_f_t *wa_f,
  79     rib_walk_hook_f_t *hook_f, void *arg);
  80 void rib_walk_ext_internal(struct rib_head *rnh, bool wlock,
  81     rib_walktree_f_t *wa_f, rib_walk_hook_f_t *hook_f, void *arg);
  82 void rib_walk_ext_locked(struct rib_head *rnh, rib_walktree_f_t *wa_f,
  83     rib_walk_hook_f_t *hook_f, void *arg);
  84 void rib_walk_from(uint32_t fibnum, int family, uint32_t flags, struct sockaddr *prefix,
  85     struct sockaddr *mask, rib_walktree_f_t *wa_f, void *arg);
  86
  87 void rib_walk_del(u_int fibnum, int family, rib_filter_f_t *filter_f,
  88     void *arg, bool report);
  89
  90 void rib_foreach_table_walk(int family, bool wlock, rib_walktree_f_t *wa_f,
  91     rib_walk_hook_f_t *hook_f, void *arg);
  92 void rib_foreach_table_walk_del(int family, rib_filter_f_t *filter_f, void *arg);
  93
  94 struct nhop_object;
  95 struct nhgrp_object;
  96 struct route_nhop_data {
  97         union {
  98                 struct nhop_object *rnd_nhop;
  99                 struct nhgrp_object *rnd_nhgrp;
 100         };
 101         uint32_t rnd_weight;
 102 };
 103
 104 const struct rtentry *rib_lookup_prefix(uint32_t fibnum, int family,
 105     const struct sockaddr *dst, const struct sockaddr *netmask,
 106     struct route_nhop_data *rnd);
 107 const struct rtentry *rib_lookup_lpm(uint32_t fibnum, int family,
 108     const struct sockaddr *dst, struct route_nhop_data *rnd);
 109
 110 /* rtentry accessors */
 111 bool rt_is_host(const struct rtentry *rt);
 112 sa_family_t rt_get_family(const struct rtentry *);
 113 struct nhop_object *rt_get_raw_nhop(const struct rtentry *rt);
 114 #ifdef INET
 115 struct in_addr;
 116 void rt_get_inet_prefix_plen(const struct rtentry *rt, struct in_addr *paddr,
 117     int *plen, uint32_t *pscopeid);
 118 void rt_get_inet_prefix_pmask(const struct rtentry *rt, struct in_addr *paddr,
 119     struct in_addr *pmask, uint32_t *pscopeid);
 120 struct rtentry *rt_get_inet_parent(uint32_t fibnum, struct in_addr addr, int plen);
 121 #endif
 122 #ifdef INET6
 123 struct in6_addr;
 124 void rt_get_inet6_prefix_plen(const struct rtentry *rt, struct in6_addr *paddr,
 125     int *plen, uint32_t *pscopeid);
 126 void rt_get_inet6_prefix_pmask(const struct rtentry *rt, struct in6_addr *paddr,
 127     struct in6_addr *pmask, uint32_t *pscopeid);
 128 struct rtentry *rt_get_inet6_parent(uint32_t fibnum, const struct in6_addr *paddr,
 129     int plen);
 130 #endif
 131
 132 /* Nexthops */
 133 uint32_t nhops_get_count(struct rib_head *rh);
 134
 135 /* Multipath */
 136 struct weightened_nhop;
 137
 138 struct weightened_nhop *nhgrp_get_nhops(struct nhgrp_object *nhg,
 139     uint32_t *pnum_nhops);
 140 uint32_t nhgrp_get_count(struct rib_head *rh);
 141
 142 /* Route subscriptions */
 143 enum rib_subscription_type {
 144         RIB_NOTIFY_IMMEDIATE,
 145         RIB_NOTIFY_DELAYED
 146 };
 147
 148 struct rib_subscription;
 149 typedef void rib_subscription_cb_t(struct rib_head *rnh, struct rib_cmd_info *rc,
 150     void *arg);
 151
 152 struct rib_subscription *rib_subscribe(uint32_t fibnum, int family,
 153     rib_subscription_cb_t *f, void *arg, enum rib_subscription_type type,
 154     bool waitok);
 155 struct rib_subscription *rib_subscribe_internal(struct rib_head *rnh,
 156     rib_subscription_cb_t *f, void *arg, enum rib_subscription_type type,
 157     bool waitok);
 158 struct rib_subscription *rib_subscribe_locked(struct rib_head *rnh,
 159     rib_subscription_cb_t *f, void *arg, enum rib_subscription_type type);
 160 void rib_unsubscribe(struct rib_subscription *rs);
 161 void rib_unsubscribe_locked(struct rib_subscription *rs);
 162
 163 #endif