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   $QuaggaId: $Format:%an, %ai, %h$ $
  21 */
  22
  23 #include <zebra.h>
  24 #include "zebra/rib.h"
  25
  26 #include "log.h"
  27 #include "prefix.h"
  28 #include "zclient.h"
  29 #include "stream.h"
  30 #include "network.h"
  31 #include "thread.h"
  32
  33 #include "pimd.h"
  34 #include "pim_pim.h"
  35 #include "pim_str.h"
  36 #include "pim_zlookup.h"
  37
  38 extern int zclient_debug;
  39
  40 static void zclient_lookup_sched(struct zclient *zlookup, int delay);
  41
  42 /* Connect to zebra for nexthop lookup. */
  43 static int zclient_lookup_connect(struct thread *t)
  44 {
  45   struct zclient *zlookup;
  46
  47   zlookup = THREAD_ARG(t);
  48   zlookup->t_connect = NULL;
  49
  50   if (zlookup->sock >= 0) {
  51     return 0;
  52   }
  53
  54   if (zclient_socket_connect(zlookup) < 0) {
  55     ++zlookup->fail;
  56     zlog_warn("%s: failure connecting zclient socket: failures=%d",
  57               __PRETTY_FUNCTION__, zlookup->fail);
  58   }
  59   else {
  60     zlookup->fail = 0; /* reset counter on connection */
  61   }
  62
  63   zassert(!zlookup->t_connect);
  64   if (zlookup->sock < 0) {
  65     /* Since last connect failed, retry within 10 secs */
  66     zclient_lookup_sched(zlookup, 10);
  67     return -1;
  68   }
  69
  70   return 0;
  71 }
  72
  73 /* Schedule connection with delay. */
  74 static void zclient_lookup_sched(struct zclient *zlookup, int delay)
  75 {
  76   zassert(!zlookup->t_connect);
  77
  78   THREAD_TIMER_ON(master, zlookup->t_connect,
  79                   zclient_lookup_connect,
  80                   zlookup, delay);
  81
  82   zlog_notice("%s: zclient lookup connection scheduled for %d seconds",
  83               __PRETTY_FUNCTION__, delay);
  84 }
  85
  86 /* Schedule connection for now. */
  87 static void zclient_lookup_sched_now(struct zclient *zlookup)
  88 {
  89   zassert(!zlookup->t_connect);
  90
  91   zlookup->t_connect = thread_add_event(master, zclient_lookup_connect,
  92                                         zlookup, 0);
  93
  94   zlog_notice("%s: zclient lookup immediate connection scheduled",
  95               __PRETTY_FUNCTION__);
  96 }
  97
  98 /* Schedule reconnection, if needed. */
  99 static void zclient_lookup_reconnect(struct zclient *zlookup)
 100 {
 101   if (zlookup->t_connect) {
 102     return;
 103   }
 104
 105   zclient_lookup_sched_now(zlookup);
 106 }
 107
 108 static void zclient_lookup_failed(struct zclient *zlookup)
 109 {
 110   if (zlookup->sock >= 0) {
 111     if (close(zlookup->sock)) {
 112       zlog_warn("%s: closing fd=%d: errno=%d %s", __func__, zlookup->sock,
 113                 errno, safe_strerror(errno));
 114     }
 115     zlookup->sock = -1;
 116   }
 117
 118   zclient_lookup_reconnect(zlookup);
 119 }
 120
 121 struct zclient *zclient_lookup_new()
 122 {
 123   struct zclient *zlookup;
 124
 125   zlookup = zclient_new (master);
 126   if (!zlookup) {
 127     zlog_err("%s: zclient_new() failure",
 128              __PRETTY_FUNCTION__);
 129     return 0;
 130   }
 131
 132   zlookup->sock = -1;
 133   zlookup->ibuf = stream_new(ZEBRA_MAX_PACKET_SIZ);
 134   zlookup->obuf = stream_new(ZEBRA_MAX_PACKET_SIZ);
 135   zlookup->t_connect = 0;
 136
 137   zclient_lookup_sched_now(zlookup);
 138
 139   zlog_notice("%s: zclient lookup socket initialized",
 140               __PRETTY_FUNCTION__);
 141
 142   return zlookup;
 143 }
 144
 145 static int zclient_read_nexthop(struct zclient *zlookup,
 146                                 struct pim_zlookup_nexthop nexthop_tab[],
 147                                 const int tab_size,
 148                                 struct in_addr addr)
 149 {
 150   int num_ifindex = 0;
 151   struct stream *s;
 152   const uint16_t MIN_LEN = 10; /* getipv4=4 getc=1 getl=4 getc=1 */
 153   uint16_t length;
 154   u_char marker;
 155   u_char version;
 156   uint16_t vrf_id;
 157   uint16_t command;
 158   struct in_addr raddr;
 159   uint8_t distance;
 160   uint32_t metric;
 161   int nexthop_num;
 162   int i, err;
 163
 164   if (PIM_DEBUG_ZEBRA) {
 165     char addr_str[100];
 166     pim_inet4_dump("<addr?>", addr, addr_str, sizeof(addr_str));
 167     zlog_debug("%s: addr=%s",
 168                __PRETTY_FUNCTION__,
 169                addr_str);
 170   }
 171
 172   s = zlookup->ibuf;
 173   stream_reset(s);
 174
 175   err = zclient_read_header (s, zlookup->sock, &length, &marker, &version,
 176                              &vrf_id, &command);
 177   if (err < 0) {
 178     zlog_err("%s %s: zclient_read_header() failed",
 179              __FILE__, __PRETTY_FUNCTION__);
 180     zclient_lookup_failed(zlookup);
 181     return -1;
 182   }
 183
 184   if (length < MIN_LEN) {
 185     zlog_err("%s %s: failure reading zclient lookup socket: len=%d < MIN_LEN=%d",
 186              __FILE__, __PRETTY_FUNCTION__, length, MIN_LEN);
 187     zclient_lookup_failed(zlookup);
 188     return -2;
 189   }
 190
 191   if (command != ZEBRA_IPV4_NEXTHOP_LOOKUP_MRIB) {
 192     zlog_err("%s: socket %d command mismatch: %d",
 193             __func__, zlookup->sock, command);
 194     return -5;
 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   length -= MIN_LEN;
 221
 222   for (i = 0; i < nexthop_num; ++i) {
 223     enum nexthop_types_t nexthop_type;
 224
 225     if (length < 1) {
 226       zlog_err("%s: socket %d empty input expecting nexthop_type: len=%d",
 227                __func__, zlookup->sock, length);
 228       return -7;
 229     }
 230
 231     nexthop_type = stream_getc(s);
 232     --length;
 233
 234     switch (nexthop_type) {
 235     case ZEBRA_NEXTHOP_IFINDEX:
 236     case ZEBRA_NEXTHOP_IFNAME:
 237     case ZEBRA_NEXTHOP_IPV4_IFINDEX:
 238       if (num_ifindex >= tab_size) {
 239         char addr_str[100];
 240         pim_inet4_dump("<addr?>", addr, addr_str, sizeof(addr_str));
 241         zlog_warn("%s %s: found too many nexthop ifindexes (%d > %d) for address %s",
 242                  __FILE__, __PRETTY_FUNCTION__,
 243                  (num_ifindex + 1), tab_size, addr_str);
 244         return num_ifindex;
 245       }
 246       if (nexthop_type == ZEBRA_NEXTHOP_IPV4_IFINDEX) {
 247         if (length < 4) {
 248           zlog_err("%s: socket %d short input expecting nexthop IPv4-addr: len=%d",
 249                    __func__, zlookup->sock, length);
 250           return -8;
 251         }
 252         nexthop_tab[num_ifindex].nexthop_addr.s_addr = stream_get_ipv4(s);
 253         length -= 4;
 254       }
 255       else {
 256         nexthop_tab[num_ifindex].nexthop_addr.s_addr = PIM_NET_INADDR_ANY;
 257       }
 258       nexthop_tab[num_ifindex].ifindex           = stream_getl(s);
 259       nexthop_tab[num_ifindex].protocol_distance = distance;
 260       nexthop_tab[num_ifindex].route_metric      = metric;
 261       ++num_ifindex;
 262       break;
 263     case ZEBRA_NEXTHOP_IPV4:
 264       if (num_ifindex >= tab_size) {
 265         char addr_str[100];
 266         pim_inet4_dump("<addr?>", addr, addr_str, sizeof(addr_str));
 267         zlog_warn("%s %s: found too many nexthop ifindexes (%d > %d) for address %s",
 268                  __FILE__, __PRETTY_FUNCTION__,
 269                  (num_ifindex + 1), tab_size, addr_str);
 270         return num_ifindex;
 271       }
 272       nexthop_tab[num_ifindex].nexthop_addr.s_addr = stream_get_ipv4(s);
 273       length -= 4;
 274       nexthop_tab[num_ifindex].ifindex             = 0;
 275       nexthop_tab[num_ifindex].protocol_distance   = distance;
 276       nexthop_tab[num_ifindex].route_metric        = metric;
 277       if (PIM_DEBUG_ZEBRA) {
 278         char addr_str[100];
 279         char nexthop_str[100];
 280         pim_inet4_dump("<addr?>", addr, addr_str, sizeof(addr_str));
 281         pim_inet4_dump("<nexthop?>", nexthop_tab[num_ifindex].nexthop_addr, nexthop_str, sizeof(nexthop_str));
 282         zlog_debug("%s %s: zebra returned recursive nexthop %s for address %s",
 283                    __FILE__, __PRETTY_FUNCTION__,
 284                    nexthop_str, addr_str);
 285       }
 286       ++num_ifindex;
 287       break;
 288     default:
 289       /* do nothing */
 290       {
 291         char addr_str[100];
 292         pim_inet4_dump("<addr?>", addr, addr_str, sizeof(addr_str));
 293         zlog_warn("%s %s: found non-ifindex nexthop type=%d for address %s",
 294                  __FILE__, __PRETTY_FUNCTION__,
 295                   nexthop_type, addr_str);
 296       }
 297       break;
 298     }
 299   }
 300
 301   return num_ifindex;
 302 }
 303
 304 static int zclient_lookup_nexthop_once(struct zclient *zlookup,
 305                                        struct pim_zlookup_nexthop nexthop_tab[],
 306                                        const int tab_size,
 307                                        struct in_addr addr)
 308 {
 309   struct stream *s;
 310   int ret;
 311
 312   if (PIM_DEBUG_ZEBRA) {
 313     char addr_str[100];
 314     pim_inet4_dump("<addr?>", addr, addr_str, sizeof(addr_str));
 315     zlog_debug("%s: addr=%s",
 316                __PRETTY_FUNCTION__,
 317                addr_str);
 318   }
 319
 320   /* Check socket. */
 321   if (zlookup->sock < 0) {
 322     zlog_err("%s %s: zclient lookup socket is not connected",
 323              __FILE__, __PRETTY_FUNCTION__);
 324     zclient_lookup_failed(zlookup);
 325     return -1;
 326   }
 327
 328   s = zlookup->obuf;
 329   stream_reset(s);
 330   zclient_create_header(s, ZEBRA_IPV4_NEXTHOP_LOOKUP_MRIB, VRF_DEFAULT);
 331   stream_put_in_addr(s, &addr);
 332   stream_putw_at(s, 0, stream_get_endp(s));
 333
 334   ret = writen(zlookup->sock, s->data, stream_get_endp(s));
 335   if (ret < 0) {
 336     zlog_err("%s %s: writen() failure writing to zclient lookup socket",
 337              __FILE__, __PRETTY_FUNCTION__);
 338     zclient_lookup_failed(zlookup);
 339     return -2;
 340   }
 341   if (ret == 0) {
 342     zlog_err("%s %s: connection closed on zclient lookup socket",
 343              __FILE__, __PRETTY_FUNCTION__);
 344     zclient_lookup_failed(zlookup);
 345     return -3;
 346   }
 347
 348   return zclient_read_nexthop(zlookup, nexthop_tab,
 349                               tab_size, addr);
 350 }
 351
 352 int zclient_lookup_nexthop(struct zclient *zlookup,
 353                            struct pim_zlookup_nexthop nexthop_tab[],
 354                            const int tab_size,
 355                            struct in_addr addr,
 356                            int max_lookup)
 357 {
 358   int lookup;
 359   uint32_t route_metric = 0xFFFFFFFF;
 360   uint8_t  protocol_distance = 0xFF;
 361
 362   for (lookup = 0; lookup < max_lookup; ++lookup) {
 363     int num_ifindex;
 364     int first_ifindex;
 365     struct in_addr nexthop_addr;
 366
 367     num_ifindex = zclient_lookup_nexthop_once(qpim_zclient_lookup, nexthop_tab,
 368                                               PIM_NEXTHOP_IFINDEX_TAB_SIZE, addr);
 369     if ((num_ifindex < 1) && PIM_DEBUG_ZEBRA) {
 370       char addr_str[100];
 371       pim_inet4_dump("<addr?>", addr, addr_str, sizeof(addr_str));
 372       zlog_warn("%s %s: lookup=%d/%d: could not find nexthop ifindex for address %s",
 373                 __FILE__, __PRETTY_FUNCTION__,
 374                 lookup, max_lookup, addr_str);
 375       return -1;
 376     }
 377
 378     if (lookup < 1) {
 379       /* this is the non-recursive lookup - save original metric/distance */
 380       route_metric = nexthop_tab[0].route_metric;
 381       protocol_distance = nexthop_tab[0].protocol_distance;
 382     }
 383
 384     /*
 385       FIXME: Non-recursive nexthop ensured only for first ifindex.
 386       However, recursive route lookup should really be fixed in zebra daemon.
 387       See also TODO T24.
 388      */
 389     first_ifindex = nexthop_tab[0].ifindex;
 390     nexthop_addr = nexthop_tab[0].nexthop_addr;
 391     if (first_ifindex > 0) {
 392       /* found: first ifindex is non-recursive nexthop */
 393
 394       if ((lookup > 0) && PIM_DEBUG_ZEBRA) {
 395         /* Report non-recursive success after first lookup */
 396         char addr_str[100];
 397         pim_inet4_dump("<addr?>", addr, addr_str, sizeof(addr_str));
 398         zlog_debug("%s %s: lookup=%d/%d: found non-recursive ifindex=%d for address %s dist=%d met=%d",
 399                    __FILE__, __PRETTY_FUNCTION__,
 400                    lookup, max_lookup, first_ifindex, addr_str,
 401                    nexthop_tab[0].protocol_distance,
 402                    nexthop_tab[0].route_metric);
 403
 404         /* use last address as nexthop address */
 405         nexthop_tab[0].nexthop_addr = addr;
 406
 407         /* report original route metric/distance */
 408         nexthop_tab[0].route_metric = route_metric;
 409         nexthop_tab[0].protocol_distance = protocol_distance;
 410       }
 411
 412       return num_ifindex;
 413     }
 414
 415     if (PIM_DEBUG_ZEBRA) {
 416       char addr_str[100];
 417       char nexthop_str[100];
 418       pim_inet4_dump("<addr?>", addr, addr_str, sizeof(addr_str));
 419       pim_inet4_dump("<nexthop?>", nexthop_addr, nexthop_str, sizeof(nexthop_str));
 420       zlog_debug("%s %s: lookup=%d/%d: zebra returned recursive nexthop %s for address %s dist=%d met=%d",
 421                 __FILE__, __PRETTY_FUNCTION__,
 422                 lookup, max_lookup, nexthop_str, addr_str,
 423                 nexthop_tab[0].protocol_distance,
 424                 nexthop_tab[0].route_metric);
 425     }
 426
 427     addr = nexthop_addr; /* use nexthop addr for recursive lookup */
 428
 429   } /* for (max_lookup) */
 430
 431   if (PIM_DEBUG_ZEBRA) {
 432     char addr_str[100];
 433     pim_inet4_dump("<addr?>", addr, addr_str, sizeof(addr_str));
 434     zlog_warn("%s %s: lookup=%d/%d: failure searching recursive nexthop ifindex for address %s",
 435               __FILE__, __PRETTY_FUNCTION__,
 436               lookup, max_lookup, addr_str);
 437   }
 438
 439   return -2;
 440 }