sys/netinet/in_rmx.c

   1 /*
   2  * Copyright 1994, 1995 Massachusetts Institute of Technology
   3  *
   4  * Permission to use, copy, modify, and distribute this software and
   5  * its documentation for any purpose and without fee is hereby
   6  * granted, provided that both the above copyright notice and this
   7  * permission notice appear in all copies, that both the above
   8  * copyright notice and this permission notice appear in all
   9  * supporting documentation, and that the name of M.I.T. not be used
  10  * in advertising or publicity pertaining to distribution of the
  11  * software without specific, written prior permission.  M.I.T. makes
  12  * no representations about the suitability of this software for any
  13  * purpose.  It is provided "as is" without express or implied
  14  * warranty.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY M.I.T. ``AS IS''.  M.I.T. DISCLAIMS
  17  * ALL EXPRESS OR IMPLIED WARRANTIES WITH REGARD TO THIS SOFTWARE,
  18  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  19  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT
  20  * SHALL M.I.T. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  21  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  22  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  23  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  25  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  26  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  *
  29  * $FreeBSD: src/sys/netinet/in_rmx.c,v 1.37.2.3 2002/08/09 14:49:23 ru Exp $
  30  * $DragonFly: src/sys/netinet/in_rmx.c,v 1.8 2005/01/01 09:20:05 hsu Exp $
  31  */
  32
  33 /*
  34  * This code does two things necessary for the enhanced TCP metrics to
  35  * function in a useful manner:
  36  *  1) It marks all non-host routes as `cloning', thus ensuring that
  37  *     every actual reference to such a route actually gets turned
  38  *     into a reference to a host route to the specific destination
  39  *     requested.
  40  *  2) When such routes lose all their references, it arranges for them
  41  *     to be deleted in some random collection of circumstances, so that
  42  *     a large quantity of stale routing data is not kept in kernel memory
  43  *     indefinitely.  See in_rtqtimo() below for the exact mechanism.
  44  */
  45
  46 #include <sys/param.h>
  47 #include <sys/systm.h>
  48 #include <sys/kernel.h>
  49 #include <sys/sysctl.h>
  50 #include <sys/socket.h>
  51 #include <sys/mbuf.h>
  52 #include <sys/syslog.h>
  53
  54 #include <net/if.h>
  55 #include <net/route.h>
  56 #include <netinet/in.h>
  57 #include <netinet/in_var.h>
  58 #include <netinet/ip_var.h>
  59
  60 #define RTPRF_EXPIRING  RTF_PROTO3      /* set on routes we manage */
  61
  62 static struct callout in_rtqtimo_ch;
  63
  64 /*
  65  * Do what we need to do when inserting a route.
  66  */
  67 static struct radix_node *
  68 in_addroute(char *key, char *mask, struct radix_node_head *head,
  69             struct radix_node *treenodes)
  70 {
  71         struct rtentry *rt = (struct rtentry *)treenodes;
  72         struct sockaddr_in *sin = (struct sockaddr_in *)rt_key(rt);
  73         struct radix_node *ret;
  74
  75         /*
  76          * For IP, all unicast non-host routes are automatically cloning.
  77          */
  78         if (IN_MULTICAST(ntohl(sin->sin_addr.s_addr)))
  79                 rt->rt_flags |= RTF_MULTICAST;
  80
  81         if (!(rt->rt_flags & (RTF_HOST | RTF_CLONING | RTF_MULTICAST)))
  82                 rt->rt_flags |= RTF_PRCLONING;
  83
  84         /*
  85          * A little bit of help for both IP output and input:
  86          *   For host routes, we make sure that RTF_BROADCAST
  87          *   is set for anything that looks like a broadcast address.
  88          *   This way, we can avoid an expensive call to in_broadcast()
  89          *   in ip_output() most of the time (because the route passed
  90          *   to ip_output() is almost always a host route).
  91          *
  92          *   We also do the same for local addresses, with the thought
  93          *   that this might one day be used to speed up ip_input().
  94          *
  95          * We also mark routes to multicast addresses as such, because
  96          * it's easy to do and might be useful (but this is much more
  97          * dubious since it's so easy to inspect the address).  (This
  98          * is done above.)
  99          */
 100         if (rt->rt_flags & RTF_HOST) {
 101                 if (in_broadcast(sin->sin_addr, rt->rt_ifp)) {
 102                         rt->rt_flags |= RTF_BROADCAST;
 103                 } else {
 104                         if (satosin(rt->rt_ifa->ifa_addr)->sin_addr.s_addr
 105                             == sin->sin_addr.s_addr)
 106                                 rt->rt_flags |= RTF_LOCAL;
 107                 }
 108         }
 109
 110         if (rt->rt_rmx.rmx_mtu != 0 && !(rt->rt_rmx.rmx_locks & RTV_MTU) &&
 111             rt->rt_ifp != NULL)
 112                 rt->rt_rmx.rmx_mtu = rt->rt_ifp->if_mtu;
 113
 114         ret = rn_addroute(key, mask, head, treenodes);
 115         if (ret == NULL && rt->rt_flags & RTF_HOST) {
 116                 struct rtentry *rt2;
 117
 118                 /*
 119                  * We are trying to add a host route, but can't.
 120                  * Find out if it is because of an
 121                  * ARP entry and delete it if so.
 122                  */
 123                 rt2 = rtlookup((struct sockaddr *)sin, 0,
 124                                 RTF_CLONING | RTF_PRCLONING);
 125                 if (rt2) {
 126                         --rt->rt_refcnt;
 127                         if (rt2->rt_flags & RTF_LLINFO &&
 128                             rt2->rt_flags & RTF_HOST &&
 129                             rt2->rt_gateway &&
 130                             rt2->rt_gateway->sa_family == AF_LINK) {
 131                                 rtrequest(RTM_DELETE, rt_key(rt2),
 132                                           rt2->rt_gateway, rt_mask(rt2),
 133                                           rt2->rt_flags, NULL);
 134                                 ret = rn_addroute(key, mask, head, treenodes);
 135                         }
 136                 }
 137         }
 138
 139         /*
 140          * If the new route created successfully, and we are forwarding,
 141          * and there is a cached route, free it.  Otherwise, we may end
 142          * up using the wrong route.
 143          */
 144         if (ret != NULL && ipforwarding && ipforward_rt.ro_rt != NULL) {
 145                 RTFREE(ipforward_rt.ro_rt);
 146                 ipforward_rt.ro_rt = NULL;
 147         }
 148
 149         return ret;
 150 }
 151
 152 /*
 153  * This code is the inverse of in_closeroute: on first reference, if we
 154  * were managing the route, stop doing so and set the expiration timer
 155  * back off again.
 156  */
 157 static struct radix_node *
 158 in_matchroute(char *key, struct radix_node_head *head)
 159 {
 160         struct radix_node *rn = rn_match(key, head);
 161         struct rtentry *rt = (struct rtentry *)rn;
 162
 163         if (rt != NULL && rt->rt_refcnt == 0) { /* this is first reference */
 164                 if (rt->rt_flags & RTPRF_EXPIRING) {
 165                         rt->rt_flags &= ~RTPRF_EXPIRING;
 166                         rt->rt_rmx.rmx_expire = 0;
 167                 }
 168         }
 169         return rn;
 170 }
 171
 172 static int rtq_reallyold = 60*60;  /* one hour is ``really old'' */
 173 SYSCTL_INT(_net_inet_ip, IPCTL_RTEXPIRE, rtexpire, CTLFLAG_RW,
 174     &rtq_reallyold , 0,
 175     "Default expiration time on cloned routes");
 176
 177 static int rtq_minreallyold = 10;  /* never automatically crank down to less */
 178 SYSCTL_INT(_net_inet_ip, IPCTL_RTMINEXPIRE, rtminexpire, CTLFLAG_RW,
 179     &rtq_minreallyold , 0,
 180     "Minimum time to attempt to hold onto cloned routes");
 181
 182 static int rtq_toomany = 128;      /* 128 cached routes is ``too many'' */
 183 SYSCTL_INT(_net_inet_ip, IPCTL_RTMAXCACHE, rtmaxcache, CTLFLAG_RW,
 184     &rtq_toomany , 0, "Upper limit on cloned routes");
 185
 186 /*
 187  * On last reference drop, mark the route as belong to us so that it can be
 188  * timed out.
 189  */
 190 static void
 191 in_closeroute(struct radix_node *rn, struct radix_node_head *head)
 192 {
 193         struct rtentry *rt = (struct rtentry *)rn;
 194
 195         if (!(rt->rt_flags & RTF_UP))
 196                 return;         /* prophylactic measures */
 197
 198         if ((rt->rt_flags & (RTF_LLINFO | RTF_HOST)) != RTF_HOST)
 199                 return;
 200
 201         if ((rt->rt_flags & (RTF_WASCLONED | RTPRF_EXPIRING)) != RTF_WASCLONED)
 202                 return;
 203
 204         /*
 205          * As requested by David Greenman:
 206          * If rtq_reallyold is 0, just delete the route without
 207          * waiting for a timeout cycle to kill it.
 208          */
 209         if (rtq_reallyold != 0) {
 210                 rt->rt_flags |= RTPRF_EXPIRING;
 211                 rt->rt_rmx.rmx_expire = time_second + rtq_reallyold;
 212         } else {
 213                 /*
 214                  * Remove route from the radix tree, but defer deallocation
 215                  * until we return to rtfree().
 216                  */
 217                 rtrequest(RTM_DELETE, rt_key(rt), rt->rt_gateway, rt_mask(rt),
 218                           rt->rt_flags, &rt);
 219         }
 220 }
 221
 222 struct rtqk_arg {
 223         struct radix_node_head *rnh;
 224         int draining;
 225         int killed;
 226         int found;
 227         int updating;
 228         time_t nextstop;
 229 };
 230
 231 /*
 232  * Get rid of old routes.  When draining, this deletes everything, even when
 233  * the timeout is not expired yet.  When updating, this makes sure that
 234  * nothing has a timeout longer than the current value of rtq_reallyold.
 235  */
 236 static int
 237 in_rtqkill(struct radix_node *rn, void *rock)
 238 {
 239         struct rtqk_arg *ap = rock;
 240         struct rtentry *rt = (struct rtentry *)rn;
 241         int err;
 242
 243         if (rt->rt_flags & RTPRF_EXPIRING) {
 244                 ap->found++;
 245                 if (ap->draining || rt->rt_rmx.rmx_expire <= time_second) {
 246                         if (rt->rt_refcnt > 0)
 247                                 panic("rtqkill route really not free");
 248
 249                         err = rtrequest(RTM_DELETE, rt_key(rt), rt->rt_gateway,
 250                                         rt_mask(rt), rt->rt_flags, NULL);
 251                         if (err) {
 252                                 log(LOG_WARNING, "in_rtqkill: error %d\n", err);
 253                         } else {
 254                                 ap->killed++;
 255                         }
 256                 } else {
 257                         if (ap->updating &&
 258                             (rt->rt_rmx.rmx_expire - time_second >
 259                              rtq_reallyold)) {
 260                                 rt->rt_rmx.rmx_expire = time_second +
 261                                     rtq_reallyold;
 262                         }
 263                         ap->nextstop = lmin(ap->nextstop,
 264                                             rt->rt_rmx.rmx_expire);
 265                 }
 266         }
 267
 268         return 0;
 269 }
 270
 271 #define RTQ_TIMEOUT     60*10   /* run no less than once every ten minutes */
 272 static int rtq_timeout = RTQ_TIMEOUT;
 273
 274 static void
 275 in_rtqtimo(void *rock)
 276 {
 277         struct radix_node_head *rnh = rock;
 278         struct rtqk_arg arg;
 279         struct timeval atv;
 280         static time_t last_adjusted_timeout = 0;
 281         int s;
 282
 283         arg.found = arg.killed = 0;
 284         arg.rnh = rnh;
 285         arg.nextstop = time_second + rtq_timeout;
 286         arg.draining = arg.updating = 0;
 287         s = splnet();
 288         rnh->rnh_walktree(rnh, in_rtqkill, &arg);
 289         splx(s);
 290
 291         /*
 292          * Attempt to be somewhat dynamic about this:
 293          * If there are ``too many'' routes sitting around taking up space,
 294          * then crank down the timeout, and see if we can't make some more
 295          * go away.  However, we make sure that we will never adjust more
 296          * than once in rtq_timeout seconds, to keep from cranking down too
 297          * hard.
 298          */
 299         if ((arg.found - arg.killed > rtq_toomany) &&
 300             (time_second - last_adjusted_timeout >= rtq_timeout) &&
 301             rtq_reallyold > rtq_minreallyold) {
 302                 rtq_reallyold = 2*rtq_reallyold / 3;
 303                 if (rtq_reallyold < rtq_minreallyold) {
 304                         rtq_reallyold = rtq_minreallyold;
 305                 }
 306
 307                 last_adjusted_timeout = time_second;
 308 #ifdef DIAGNOSTIC
 309                 log(LOG_DEBUG, "in_rtqtimo: adjusted rtq_reallyold to %d\n",
 310                     rtq_reallyold);
 311 #endif
 312                 arg.found = arg.killed = 0;
 313                 arg.updating = 1;
 314                 s = splnet();
 315                 rnh->rnh_walktree(rnh, in_rtqkill, &arg);
 316                 splx(s);
 317         }
 318
 319         atv.tv_usec = 0;
 320         atv.tv_sec = arg.nextstop - time_second;
 321         callout_reset(&in_rtqtimo_ch, tvtohz_high(&atv), in_rtqtimo, rock);
 322 }
 323
 324 void
 325 in_rtqdrain(void)
 326 {
 327         struct radix_node_head *rnh = rt_tables[AF_INET];
 328         struct rtqk_arg arg;
 329         int s;
 330
 331         arg.found = arg.killed = 0;
 332         arg.rnh = rnh;
 333         arg.nextstop = 0;
 334         arg.draining = 1;
 335         arg.updating = 0;
 336         s = splnet();
 337         rnh->rnh_walktree(rnh, in_rtqkill, &arg);
 338         splx(s);
 339 }
 340
 341 /*
 342  * Initialize our routing tree.
 343  */
 344 int
 345 in_inithead(void **head, int off)
 346 {
 347         struct radix_node_head *rnh;
 348
 349         if (!rn_inithead(head, off))
 350                 return 0;
 351
 352         if (head != (void **)&rt_tables[AF_INET]) /* BOGUS! */
 353                 return 1;       /* only do this for the real routing table */
 354
 355         rnh = *head;
 356         rnh->rnh_addaddr = in_addroute;
 357         rnh->rnh_matchaddr = in_matchroute;
 358         rnh->rnh_close = in_closeroute;
 359         callout_init(&in_rtqtimo_ch);
 360         in_rtqtimo(rnh);        /* kick off timeout first time */
 361         return 1;
 362 }
 363
 364 \f
 365 /*
 366  * This zaps old routes when the interface goes down or interface
 367  * address is deleted.  In the latter case, it deletes static routes
 368  * that point to this address.  If we don't do this, we may end up
 369  * using the old address in the future.  The ones we always want to
 370  * get rid of are things like ARP entries, since the user might down
 371  * the interface, walk over to a completely different network, and
 372  * plug back in.
 373  */
 374 struct in_ifadown_arg {
 375         struct radix_node_head *rnh;
 376         struct ifaddr *ifa;
 377         int del;
 378 };
 379
 380 static int
 381 in_ifadownkill(struct radix_node *rn, void *xap)
 382 {
 383         struct in_ifadown_arg *ap = xap;
 384         struct rtentry *rt = (struct rtentry *)rn;
 385         int err;
 386
 387         if (rt->rt_ifa == ap->ifa &&
 388             (ap->del || !(rt->rt_flags & RTF_STATIC))) {
 389                 /*
 390                  * We need to disable the automatic prune that happens
 391                  * in this case in rtrequest() because it will blow
 392                  * away the pointers that rn_walktree() needs in order
 393                  * continue our descent.  We will end up deleting all
 394                  * the routes that rtrequest() would have in any case,
 395                  * so that behavior is not needed there.
 396                  */
 397                 rt->rt_flags &= ~(RTF_CLONING | RTF_PRCLONING);
 398                 err = rtrequest(RTM_DELETE, rt_key(rt), rt->rt_gateway,
 399                                 rt_mask(rt), rt->rt_flags, NULL);
 400                 if (err) {
 401                         log(LOG_WARNING, "in_ifadownkill: error %d\n", err);
 402                 }
 403         }
 404         return 0;
 405 }
 406
 407 int
 408 in_ifadown(struct ifaddr *ifa, int delete)
 409 {
 410         struct in_ifadown_arg arg;
 411         struct radix_node_head *rnh;
 412
 413         if (ifa->ifa_addr->sa_family != AF_INET)
 414                 return 1;
 415
 416         arg.rnh = rnh = rt_tables[AF_INET];
 417         arg.ifa = ifa;
 418         arg.del = delete;
 419         rnh->rnh_walktree(rnh, in_ifadownkill, &arg);
 420         ifa->ifa_flags &= ~IFA_ROUTE;
 421         return 0;
 422 }