pimd/pim_zlookup.c

   1 /*
   2   PIM for Quagga
   3   Copyright (C) 2008  Everton da Silva Marques
   4
   5   This program is free software; you can redistribute it and/or modify
   6   it under the terms of the GNU General Public License as published by
   7   the Free Software Foundation; either version 2 of the License, or
   8   (at your option) any later version.
   9
  10   This program is distributed in the hope that it will be useful, but
  11   WITHOUT ANY WARRANTY; without even the implied warranty of
  12   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13   General Public License for more details.
  14
  15   You should have received a copy of the GNU General Public License
  16   along with this program; see the file COPYING; if not, write to the
  17   Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,
  18   MA 02110-1301 USA
  19
  20 */
  21
  22 #include <zebra.h>
  23 #include "zebra/rib.h"
  24
  25 #include "log.h"
  26 #include "prefix.h"
  27 #include "zclient.h"
  28 #include "stream.h"
  29 #include "network.h"
  30 #include "thread.h"
  31 #include "prefix.h"
  32 #include "vty.h"
  33
  34 #include "pimd.h"
  35 #include "pim_iface.h"
  36 #include "pim_pim.h"
  37 #include "pim_str.h"
  38 #include "pim_oil.h"
  39 #include "pim_zlookup.h"
  40
  41 extern int zclient_debug;
  42
  43 static struct zclient *zlookup = NULL;
  44
  45 static void zclient_lookup_sched(struct zclient *zlookup, int delay);
  46
  47 /* Connect to zebra for nexthop lookup. */
  48 static int zclient_lookup_connect(struct thread *t)
  49 {
  50   struct zclient *zlookup;
  51
  52   zlookup = THREAD_ARG(t);
  53   zlookup->t_connect = NULL;
  54
  55   if (zlookup->sock >= 0) {
  56     return 0;
  57   }
  58
  59   if (zclient_socket_connect(zlookup) < 0) {
  60     ++zlookup->fail;
  61     zlog_warn("%s: failure connecting zclient socket: failures=%d",
  62               __PRETTY_FUNCTION__, zlookup->fail);
  63   }
  64   else {
  65     zlookup->fail = 0; /* reset counter on connection */
  66   }
  67
  68   zassert(!zlookup->t_connect);
  69   if (zlookup->sock < 0) {
  70     /* Since last connect failed, retry within 10 secs */
  71     zclient_lookup_sched(zlookup, 10);
  72     return -1;
  73   }
  74
  75   return 0;
  76 }
  77
  78 /* Schedule connection with delay. */
  79 static void zclient_lookup_sched(struct zclient *zlookup, int delay)
  80 {
  81   zassert(!zlookup->t_connect);
  82
  83   THREAD_TIMER_ON(master, zlookup->t_connect,
  84                   zclient_lookup_connect,
  85                   zlookup, delay);
  86
  87   zlog_notice("%s: zclient lookup connection scheduled for %d seconds",
  88               __PRETTY_FUNCTION__, delay);
  89 }
  90
  91 /* Schedule connection for now. */
  92 static void zclient_lookup_sched_now(struct zclient *zlookup)
  93 {
  94   zassert(!zlookup->t_connect);
  95
  96   zlookup->t_connect = thread_add_event(master, zclient_lookup_connect,
  97                                         zlookup, 0);
  98
  99   zlog_notice("%s: zclient lookup immediate connection scheduled",
 100               __PRETTY_FUNCTION__);
 101 }
 102
 103 /* Schedule reconnection, if needed. */
 104 static void zclient_lookup_reconnect(struct zclient *zlookup)
 105 {
 106   if (zlookup->t_connect) {
 107     return;
 108   }
 109
 110   zclient_lookup_sched_now(zlookup);
 111 }
 112
 113 static void zclient_lookup_failed(struct zclient *zlookup)
 114 {
 115   if (zlookup->sock >= 0) {
 116     if (close(zlookup->sock)) {
 117       zlog_warn("%s: closing fd=%d: errno=%d %s", __func__, zlookup->sock,
 118                 errno, safe_strerror(errno));
 119     }
 120     zlookup->sock = -1;
 121   }
 122
 123   zclient_lookup_reconnect(zlookup);
 124 }
 125
 126 void
 127 zclient_lookup_new (void)
 128 {
 129   zlookup = zclient_new (master);
 130   if (!zlookup) {
 131     zlog_err("%s: zclient_new() failure",
 132              __PRETTY_FUNCTION__);
 133     return;
 134   }
 135
 136   zlookup->sock = -1;
 137   zlookup->ibuf = stream_new(ZEBRA_MAX_PACKET_SIZ);
 138   zlookup->obuf = stream_new(ZEBRA_MAX_PACKET_SIZ);
 139   zlookup->t_connect = 0;
 140
 141   zclient_lookup_sched_now(zlookup);
 142
 143   zlog_notice("%s: zclient lookup socket initialized",
 144               __PRETTY_FUNCTION__);
 145
 146 }
 147
 148 static int zclient_read_nexthop(struct zclient *zlookup,
 149                                 struct pim_zlookup_nexthop nexthop_tab[],
 150                                 const int tab_size,
 151                                 struct in_addr addr)
 152 {
 153   int num_ifindex = 0;
 154   struct stream *s;
 155   const uint16_t MIN_LEN = 10; /* getipv4=4 getc=1 getl=4 getc=1 */
 156   uint16_t length;
 157   u_char marker;
 158   u_char version;
 159   vrf_id_t vrf_id;
 160   uint16_t command = 0;
 161   struct in_addr raddr;
 162   uint8_t distance;
 163   uint32_t metric;
 164   int nexthop_num;
 165   int i, err;
 166
 167   if (PIM_DEBUG_ZEBRA) {
 168     char addr_str[100];
 169     pim_inet4_dump("<addr?>", addr, addr_str, sizeof(addr_str));
 170     zlog_debug("%s: addr=%s",
 171                __PRETTY_FUNCTION__,
 172                addr_str);
 173   }
 174
 175   s = zlookup->ibuf;
 176
 177   while (command != ZEBRA_IPV4_NEXTHOP_LOOKUP_MRIB)
 178     {
 179       stream_reset(s);
 180       err = zclient_read_header (s, zlookup->sock, &length, &marker, &version,
 181                                  &vrf_id, &command);
 182       if (err < 0) {
 183         zlog_err("%s %s: zclient_read_header() failed",
 184                  __FILE__, __PRETTY_FUNCTION__);
 185         zclient_lookup_failed(zlookup);
 186         return -1;
 187       }
 188
 189       if (length < MIN_LEN) {
 190         zlog_err("%s %s: failure reading zclient lookup socket: len=%d < MIN_LEN=%d",
 191                  __FILE__, __PRETTY_FUNCTION__, length, MIN_LEN);
 192         zclient_lookup_failed(zlookup);
 193         return -2;
 194       }
 195     }
 196
 197   raddr.s_addr = stream_get_ipv4(s);
 198
 199   if (raddr.s_addr != addr.s_addr) {
 200     char addr_str[100];
 201     char raddr_str[100];
 202     pim_inet4_dump("<addr?>", addr, addr_str, sizeof(addr_str));
 203     pim_inet4_dump("<raddr?>", raddr, raddr_str, sizeof(raddr_str));
 204     zlog_warn("%s: address mismatch: addr=%s raddr=%s",
 205                __PRETTY_FUNCTION__,
 206                addr_str, raddr_str);
 207     /* warning only */
 208   }
 209
 210   distance = stream_getc(s);
 211   metric = stream_getl(s);
 212   nexthop_num = stream_getc(s);
 213
 214   if (nexthop_num < 1) {
 215     zlog_err("%s: socket %d bad nexthop_num=%d",
 216             __func__, zlookup->sock, nexthop_num);
 217     return -6;
 218   }
 219
 220   for (i = 0; i < nexthop_num; ++i) {
 221     enum nexthop_types_t nexthop_type;
 222     struct pim_neighbor *nbr;
 223
 224     nexthop_type = stream_getc(s);
 225     if (num_ifindex >= tab_size) {
 226       char addr_str[100];
 227       pim_inet4_dump("<addr?>", addr, addr_str, sizeof(addr_str));
 228       zlog_warn("%s %s: found too many nexthop ifindexes (%d > %d) for address %s",
 229                 __FILE__, __PRETTY_FUNCTION__,
 230                 (num_ifindex + 1), tab_size, addr_str);
 231       return num_ifindex;
 232     }
 233     switch (nexthop_type) {
 234     case NEXTHOP_TYPE_IFINDEX:
 235     case NEXTHOP_TYPE_IPV4_IFINDEX:
 236     case NEXTHOP_TYPE_IPV4:
 237       nexthop_tab[num_ifindex].nexthop_addr.family = AF_INET;
 238       if (nexthop_type == NEXTHOP_TYPE_IPV4_IFINDEX ||
 239           nexthop_type == NEXTHOP_TYPE_IPV4) {
 240         nexthop_tab[num_ifindex].nexthop_addr.u.prefix4.s_addr = stream_get_ipv4(s);
 241       }
 242       else {
 243         nexthop_tab[num_ifindex].nexthop_addr.u.prefix4.s_addr = PIM_NET_INADDR_ANY;
 244       }
 245       nexthop_tab[num_ifindex].ifindex           = stream_getl(s);
 246       nexthop_tab[num_ifindex].protocol_distance = distance;
 247       nexthop_tab[num_ifindex].route_metric      = metric;
 248       ++num_ifindex;
 249       break;
 250     case NEXTHOP_TYPE_IPV6_IFINDEX:
 251       nexthop_tab[num_ifindex].nexthop_addr.family = AF_INET6;
 252       stream_get (&nexthop_tab[num_ifindex].nexthop_addr.u.prefix6, s, 16);
 253       nexthop_tab[num_ifindex].ifindex = stream_getl (s);
 254       nbr = pim_neighbor_find_if (if_lookup_by_index_vrf (nexthop_tab[num_ifindex].ifindex, VRF_DEFAULT));
 255       if (nbr)
 256         {
 257           nexthop_tab[num_ifindex].nexthop_addr.family = AF_INET;
 258           nexthop_tab[num_ifindex].nexthop_addr.u.prefix4 = nbr->source_addr;
 259         }
 260         ++num_ifindex;
 261       break;
 262     default:
 263       /* do nothing */
 264       {
 265         char addr_str[100];
 266         pim_inet4_dump("<addr?>", addr, addr_str, sizeof(addr_str));
 267         zlog_warn("%s %s: found non-ifindex nexthop type=%d for address %s",
 268                  __FILE__, __PRETTY_FUNCTION__,
 269                   nexthop_type, addr_str);
 270       }
 271       break;
 272     }
 273   }
 274
 275   return num_ifindex;
 276 }
 277
 278 static int
 279 zclient_lookup_nexthop_once (struct pim_zlookup_nexthop nexthop_tab[],
 280                              const int tab_size,
 281                              struct in_addr addr)
 282 {
 283   struct stream *s;
 284   int ret;
 285
 286   if (PIM_DEBUG_ZEBRA) {
 287     char addr_str[100];
 288     pim_inet4_dump("<addr?>", addr, addr_str, sizeof(addr_str));
 289     zlog_debug("%s: addr=%s",
 290                __PRETTY_FUNCTION__,
 291                addr_str);
 292   }
 293
 294   /* Check socket. */
 295   if (zlookup->sock < 0) {
 296     zlog_err("%s %s: zclient lookup socket is not connected",
 297              __FILE__, __PRETTY_FUNCTION__);
 298     zclient_lookup_failed(zlookup);
 299     return -1;
 300   }
 301
 302   s = zlookup->obuf;
 303   stream_reset(s);
 304   zclient_create_header(s, ZEBRA_IPV4_NEXTHOP_LOOKUP_MRIB, VRF_DEFAULT);
 305   stream_put_in_addr(s, &addr);
 306   stream_putw_at(s, 0, stream_get_endp(s));
 307
 308   ret = writen(zlookup->sock, s->data, stream_get_endp(s));
 309   if (ret < 0) {
 310     zlog_err("%s %s: writen() failure: %d writing to zclient lookup socket",
 311              __FILE__, __PRETTY_FUNCTION__, errno);
 312     zclient_lookup_failed(zlookup);
 313     return -2;
 314   }
 315   if (ret == 0) {
 316     zlog_err("%s %s: connection closed on zclient lookup socket",
 317              __FILE__, __PRETTY_FUNCTION__);
 318     zclient_lookup_failed(zlookup);
 319     return -3;
 320   }
 321
 322   return zclient_read_nexthop(zlookup, nexthop_tab,
 323                               tab_size, addr);
 324 }
 325
 326 int
 327 zclient_lookup_nexthop (struct pim_zlookup_nexthop nexthop_tab[],
 328                         const int tab_size,
 329                         struct in_addr addr,
 330                         int max_lookup)
 331 {
 332   int lookup;
 333   uint32_t route_metric = 0xFFFFFFFF;
 334   uint8_t  protocol_distance = 0xFF;
 335
 336   qpim_nexthop_lookups++;
 337
 338   for (lookup = 0; lookup < max_lookup; ++lookup) {
 339     int num_ifindex;
 340     int first_ifindex;
 341     struct prefix nexthop_addr;
 342
 343     num_ifindex = zclient_lookup_nexthop_once(nexthop_tab,
 344                                               tab_size, addr);
 345     if (num_ifindex < 1) {
 346       if (PIM_DEBUG_ZEBRA) {
 347         char addr_str[100];
 348         pim_inet4_dump("<addr?>", addr, addr_str, sizeof(addr_str));
 349         zlog_debug("%s %s: lookup=%d/%d: could not find nexthop ifindex for address %s",
 350                    __FILE__, __PRETTY_FUNCTION__,
 351                    lookup, max_lookup, addr_str);
 352       }
 353       return -1;
 354     }
 355
 356     if (lookup < 1) {
 357       /* this is the non-recursive lookup - save original metric/distance */
 358       route_metric = nexthop_tab[0].route_metric;
 359       protocol_distance = nexthop_tab[0].protocol_distance;
 360     }
 361
 362     /*
 363      * FIXME: Non-recursive nexthop ensured only for first ifindex.
 364      * However, recursive route lookup should really be fixed in zebra daemon.
 365      * See also TODO T24.
 366      *
 367      * So Zebra for NEXTHOP_TYPE_IPV4 returns the ifindex now since
 368      * it was being stored.  This Doesn't solve all cases of
 369      * recursive lookup but for the most common types it does.
 370      */
 371     first_ifindex = nexthop_tab[0].ifindex;
 372     nexthop_addr = nexthop_tab[0].nexthop_addr;
 373     if (first_ifindex > 0) {
 374       /* found: first ifindex is non-recursive nexthop */
 375
 376       if (lookup > 0) {
 377         /* Report non-recursive success after first lookup */
 378         if (PIM_DEBUG_ZEBRA) {
 379           char addr_str[100];
 380           pim_inet4_dump("<addr?>", addr, addr_str, sizeof(addr_str));
 381           zlog_debug("%s %s: lookup=%d/%d: found non-recursive ifindex=%d for address %s dist=%d met=%d",
 382                      __FILE__, __PRETTY_FUNCTION__,
 383                      lookup, max_lookup, first_ifindex, addr_str,
 384                      nexthop_tab[0].protocol_distance,
 385                      nexthop_tab[0].route_metric);
 386         }
 387
 388         /* use last address as nexthop address */
 389         nexthop_tab[0].nexthop_addr.u.prefix4 = addr;
 390
 391         /* report original route metric/distance */
 392         nexthop_tab[0].route_metric = route_metric;
 393         nexthop_tab[0].protocol_distance = protocol_distance;
 394       }
 395
 396       return num_ifindex;
 397     }
 398
 399     if (PIM_DEBUG_ZEBRA) {
 400       char addr_str[100];
 401       char nexthop_str[100];
 402       pim_inet4_dump("<addr?>", addr, addr_str, sizeof(addr_str));
 403       pim_addr_dump("<nexthop?>", &nexthop_addr, nexthop_str, sizeof(nexthop_str));
 404       zlog_debug("%s %s: lookup=%d/%d: zebra returned recursive nexthop %s for address %s dist=%d met=%d",
 405                 __FILE__, __PRETTY_FUNCTION__,
 406                 lookup, max_lookup, nexthop_str, addr_str,
 407                 nexthop_tab[0].protocol_distance,
 408                 nexthop_tab[0].route_metric);
 409     }
 410
 411     addr = nexthop_addr.u.prefix4; /* use nexthop addr for recursive lookup */
 412
 413   } /* for (max_lookup) */
 414
 415   if (PIM_DEBUG_ZEBRA) {
 416     char addr_str[100];
 417     pim_inet4_dump("<addr?>", addr, addr_str, sizeof(addr_str));
 418     zlog_warn("%s %s: lookup=%d/%d: failure searching recursive nexthop ifindex for address %s",
 419               __FILE__, __PRETTY_FUNCTION__,
 420               lookup, max_lookup, addr_str);
 421   }
 422
 423   return -2;
 424 }
 425
 426 void
 427 pim_zlookup_show_ip_multicast (struct vty *vty)
 428 {
 429   vty_out(vty, "Zclient lookup socket: ");
 430   if (zlookup) {
 431     vty_out(vty, "%d failures=%d%s", zlookup->sock,
 432             zlookup->fail, VTY_NEWLINE);
 433   }
 434   else {
 435     vty_out(vty, "<null zclient>%s", VTY_NEWLINE);
 436   }
 437 }
 438
 439 int
 440 pim_zlookup_sg_statistics (struct channel_oil *c_oil)
 441 {
 442   struct stream *s = zlookup->obuf;
 443   uint16_t command = 0;
 444   unsigned long long lastused;
 445   struct prefix_sg sg;
 446   int count = 0;
 447   int ret;
 448   struct interface *ifp = pim_if_find_by_vif_index (c_oil->oil.mfcc_parent);
 449
 450   if (PIM_DEBUG_ZEBRA)
 451     {
 452       struct prefix_sg more;
 453
 454       more.src = c_oil->oil.mfcc_origin;
 455       more.grp = c_oil->oil.mfcc_mcastgrp;
 456       zlog_debug ("Sending Request for New Channel Oil Information(%s)", pim_str_sg_dump (&more));
 457     }
 458
 459   stream_reset (s);
 460   zclient_create_header (s, ZEBRA_IPMR_ROUTE_STATS, VRF_DEFAULT);
 461   stream_put_in_addr (s, &c_oil->oil.mfcc_origin);
 462   stream_put_in_addr (s, &c_oil->oil.mfcc_mcastgrp);
 463   stream_putl (s,  ifp->ifindex);
 464   stream_putw_at(s, 0, stream_get_endp(s));
 465
 466   count = stream_get_endp (s);
 467   ret = writen (zlookup->sock, s->data, count);
 468   if (ret <= 0)
 469     {
 470       zlog_err("%s %s: writen() failure: %d writing to zclient lookup socket",
 471                __FILE__, __PRETTY_FUNCTION__, errno);
 472       return -1;
 473     }
 474
 475   s = zlookup->ibuf;
 476
 477   while (command != ZEBRA_IPMR_ROUTE_STATS)
 478     {
 479       int err;
 480       uint16_t length = 0;
 481       vrf_id_t vrf_id;
 482       u_char marker;
 483       u_char version;
 484
 485       stream_reset (s);
 486       err = zclient_read_header (s, zlookup->sock, &length, &marker, &version,
 487                                  &vrf_id, &command);
 488       if (err < 0)
 489         {
 490           zlog_err ("%s %s: zclient_read_header() failed",
 491                  __FILE__, __PRETTY_FUNCTION__);
 492         zclient_lookup_failed(zlookup);
 493         return -1;
 494         }
 495     }
 496
 497   sg.src.s_addr = stream_get_ipv4 (s);
 498   sg.grp.s_addr = stream_get_ipv4 (s);
 499   if (sg.src.s_addr != c_oil->oil.mfcc_origin.s_addr ||
 500       sg.grp.s_addr != c_oil->oil.mfcc_mcastgrp.s_addr)
 501     {
 502        zlog_err ("%s: Received wrong %s information",
 503                  __PRETTY_FUNCTION__, pim_str_sg_dump (&sg));
 504        zclient_lookup_failed (zlookup);
 505        return -3;
 506     }
 507
 508   stream_get (&lastused, s, sizeof (lastused));
 509   ret = stream_getl (s);
 510
 511   if (PIM_DEBUG_ZEBRA)
 512     zlog_debug ("Received %lld for %s success: %d", lastused, pim_str_sg_dump (&sg), ret);
 513
 514   c_oil->cc.lastused = lastused;
 515
 516   return 0;
 517
 518 }