test/vpp_ip_route.py

   1 """
   2   IP Routes
   3
   4   object abstractions for representing IP routes in VPP
   5 """
   6
   7 from vpp_object import *
   8 from socket import inet_pton, inet_ntop, AF_INET, AF_INET6
   9
  10 # from vnet/vnet/mpls/mpls_types.h
  11 MPLS_IETF_MAX_LABEL = 0xfffff
  12 MPLS_LABEL_INVALID = MPLS_IETF_MAX_LABEL + 1
  13
  14
  15 class MRouteItfFlags:
  16     MFIB_ITF_FLAG_NONE = 0
  17     MFIB_ITF_FLAG_NEGATE_SIGNAL = 1
  18     MFIB_ITF_FLAG_ACCEPT = 2
  19     MFIB_ITF_FLAG_FORWARD = 4
  20     MFIB_ITF_FLAG_SIGNAL_PRESENT = 8
  21     MFIB_ITF_FLAG_INTERNAL_COPY = 16
  22
  23
  24 class MRouteEntryFlags:
  25     MFIB_ENTRY_FLAG_NONE = 0
  26     MFIB_ENTRY_FLAG_SIGNAL = 1
  27     MFIB_ENTRY_FLAG_DROP = 2
  28     MFIB_ENTRY_FLAG_CONNECTED = 4
  29     MFIB_ENTRY_FLAG_INHERIT_ACCEPT = 8
  30
  31
  32 class DpoProto:
  33     DPO_PROTO_IP4 = 0
  34     DPO_PROTO_IP6 = 1
  35     DPO_PROTO_MPLS = 2
  36     DPO_PROTO_ETHERNET = 3
  37     DPO_PROTO_BIER = 4
  38     DPO_PROTO_NSH = 5
  39
  40
  41 class MplsLspMode:
  42     PIPE = 0
  43     UNIFORM = 1
  44
  45
  46 def find_route(test, ip_addr, len, table_id=0, inet=AF_INET):
  47     if inet == AF_INET:
  48         s = 4
  49         routes = test.vapi.ip_fib_dump()
  50     else:
  51         s = 16
  52         routes = test.vapi.ip6_fib_dump()
  53
  54     route_addr = inet_pton(inet, ip_addr)
  55     for e in routes:
  56         if route_addr == e.address[:s] \
  57            and len == e.address_length \
  58            and table_id == e.table_id:
  59             return True
  60     return False
  61
  62
  63 class VppIpTable(VppObject):
  64
  65     def __init__(self,
  66                  test,
  67                  table_id,
  68                  is_ip6=0):
  69         self._test = test
  70         self.table_id = table_id
  71         self.is_ip6 = is_ip6
  72
  73     def add_vpp_config(self):
  74         self._test.vapi.ip_table_add_del(
  75             self.table_id,
  76             is_ipv6=self.is_ip6,
  77             is_add=1)
  78         self._test.registry.register(self, self._test.logger)
  79
  80     def remove_vpp_config(self):
  81         self._test.vapi.ip_table_add_del(
  82             self.table_id,
  83             is_ipv6=self.is_ip6,
  84             is_add=0)
  85
  86     def query_vpp_config(self):
  87         # find the default route
  88         return find_route(self._test,
  89                           "::" if self.is_ip6 else "0.0.0.0",
  90                           0,
  91                           self.table_id,
  92                           inet=AF_INET6 if self.is_ip6 == 1 else AF_INET)
  93
  94     def __str__(self):
  95         return self.object_id()
  96
  97     def object_id(self):
  98         return ("table-%s-%d" %
  99                 ("v6" if self.is_ip6 == 1 else "v4",
 100                  self.table_id))
 101
 102
 103 class VppMplsLabel(object):
 104     def __init__(self, value, mode=MplsLspMode.PIPE, ttl=64, exp=0):
 105         self.value = value
 106         self.mode = mode
 107         self.ttl = ttl
 108         self.exp = exp
 109
 110     def encode(self):
 111         is_uniform = 0 if self.mode is MplsLspMode.PIPE else 1
 112         return {'label': self.value,
 113                 'ttl': self.ttl,
 114                 'exp': self.exp,
 115                 'is_uniform': is_uniform}
 116
 117
 118 class VppRoutePath(object):
 119
 120     def __init__(
 121             self,
 122             nh_addr,
 123             nh_sw_if_index,
 124             nh_table_id=0,
 125             labels=[],
 126             nh_via_label=MPLS_LABEL_INVALID,
 127             rpf_id=0,
 128             is_interface_rx=0,
 129             is_resolve_host=0,
 130             is_resolve_attached=0,
 131             is_source_lookup=0,
 132             is_udp_encap=0,
 133             is_dvr=0,
 134             next_hop_id=0xffffffff,
 135             proto=DpoProto.DPO_PROTO_IP4):
 136         self.nh_itf = nh_sw_if_index
 137         self.nh_table_id = nh_table_id
 138         self.nh_via_label = nh_via_label
 139         self.nh_labels = labels
 140         self.weight = 1
 141         self.rpf_id = rpf_id
 142         self.proto = proto
 143         if self.proto is DpoProto.DPO_PROTO_IP6:
 144             self.nh_addr = inet_pton(AF_INET6, nh_addr)
 145         elif self.proto is DpoProto.DPO_PROTO_IP4:
 146             self.nh_addr = inet_pton(AF_INET, nh_addr)
 147         else:
 148             self.nh_addr = inet_pton(AF_INET6, "::")
 149         self.is_resolve_host = is_resolve_host
 150         self.is_resolve_attached = is_resolve_attached
 151         self.is_interface_rx = is_interface_rx
 152         self.is_source_lookup = is_source_lookup
 153         self.is_rpf_id = 0
 154         if rpf_id != 0:
 155             self.is_rpf_id = 1
 156             self.nh_itf = rpf_id
 157         self.is_udp_encap = is_udp_encap
 158         self.next_hop_id = next_hop_id
 159         self.is_dvr = is_dvr
 160
 161     def encode_labels(self):
 162         lstack = []
 163         for l in self.nh_labels:
 164             if type(l) == VppMplsLabel:
 165                 lstack.append(l.encode())
 166             else:
 167                 lstack.append({'label': l,
 168                                'ttl': 255})
 169         return lstack
 170
 171
 172 class VppMRoutePath(VppRoutePath):
 173
 174     def __init__(self, nh_sw_if_index, flags,
 175                  proto=DpoProto.DPO_PROTO_IP4,
 176                  bier_imp=0):
 177         super(VppMRoutePath, self).__init__(
 178             "::" if proto is DpoProto.DPO_PROTO_IP6 else "0.0.0.0",
 179             nh_sw_if_index,
 180             proto=proto)
 181         self.nh_i_flags = flags
 182         self.bier_imp = bier_imp
 183
 184
 185 class VppIpRoute(VppObject):
 186     """
 187     IP Route
 188     """
 189
 190     def __init__(self, test, dest_addr,
 191                  dest_addr_len, paths, table_id=0, is_ip6=0, is_local=0,
 192                  is_unreach=0, is_prohibit=0):
 193         self._test = test
 194         self.paths = paths
 195         self.dest_addr_len = dest_addr_len
 196         self.table_id = table_id
 197         self.is_ip6 = is_ip6
 198         self.is_local = is_local
 199         self.is_unreach = is_unreach
 200         self.is_prohibit = is_prohibit
 201         self.dest_addr_p = dest_addr
 202         if is_ip6:
 203             self.dest_addr = inet_pton(AF_INET6, dest_addr)
 204         else:
 205             self.dest_addr = inet_pton(AF_INET, dest_addr)
 206
 207     def modify(self, paths, is_local=0,
 208                is_unreach=0, is_prohibit=0):
 209         self.paths = paths
 210         self.is_local = is_local
 211         self.is_unreach = is_unreach
 212         self.is_prohibit = is_prohibit
 213
 214     def add_vpp_config(self):
 215         if self.is_local or self.is_unreach or self.is_prohibit:
 216             self._test.vapi.ip_add_del_route(
 217                 self.dest_addr,
 218                 self.dest_addr_len,
 219                 inet_pton(AF_INET6, "::"),
 220                 0xffffffff,
 221                 is_local=self.is_local,
 222                 is_unreach=self.is_unreach,
 223                 is_prohibit=self.is_prohibit,
 224                 table_id=self.table_id,
 225                 is_ipv6=self.is_ip6)
 226         else:
 227             for path in self.paths:
 228                 lstack = path.encode_labels()
 229
 230                 self._test.vapi.ip_add_del_route(
 231                     self.dest_addr,
 232                     self.dest_addr_len,
 233                     path.nh_addr,
 234                     path.nh_itf,
 235                     table_id=self.table_id,
 236                     next_hop_out_label_stack=lstack,
 237                     next_hop_n_out_labels=len(lstack),
 238                     next_hop_via_label=path.nh_via_label,
 239                     next_hop_table_id=path.nh_table_id,
 240                     next_hop_id=path.next_hop_id,
 241                     is_ipv6=self.is_ip6,
 242                     is_dvr=path.is_dvr,
 243                     is_resolve_host=path.is_resolve_host,
 244                     is_resolve_attached=path.is_resolve_attached,
 245                     is_source_lookup=path.is_source_lookup,
 246                     is_udp_encap=path.is_udp_encap,
 247                     is_multipath=1 if len(self.paths) > 1 else 0)
 248         self._test.registry.register(self, self._test.logger)
 249
 250     def remove_vpp_config(self):
 251         if self.is_local or self.is_unreach or self.is_prohibit:
 252             self._test.vapi.ip_add_del_route(
 253                 self.dest_addr,
 254                 self.dest_addr_len,
 255                 inet_pton(AF_INET6, "::"),
 256                 0xffffffff,
 257                 is_local=self.is_local,
 258                 is_unreach=self.is_unreach,
 259                 is_prohibit=self.is_prohibit,
 260                 is_add=0,
 261                 table_id=self.table_id,
 262                 is_ipv6=self.is_ip6)
 263         else:
 264             for path in self.paths:
 265                 self._test.vapi.ip_add_del_route(
 266                     self.dest_addr,
 267                     self.dest_addr_len,
 268                     path.nh_addr,
 269                     path.nh_itf,
 270                     table_id=self.table_id,
 271                     next_hop_table_id=path.nh_table_id,
 272                     next_hop_via_label=path.nh_via_label,
 273                     next_hop_id=path.next_hop_id,
 274                     is_add=0,
 275                     is_udp_encap=path.is_udp_encap,
 276                     is_ipv6=self.is_ip6,
 277                     is_dvr=path.is_dvr)
 278
 279     def query_vpp_config(self):
 280         return find_route(self._test,
 281                           self.dest_addr_p,
 282                           self.dest_addr_len,
 283                           self.table_id,
 284                           inet=AF_INET6 if self.is_ip6 == 1 else AF_INET)
 285
 286     def __str__(self):
 287         return self.object_id()
 288
 289     def object_id(self):
 290         return ("%d:%s/%d"
 291                 % (self.table_id,
 292                    self.dest_addr_p,
 293                    self.dest_addr_len))
 294
 295
 296 class VppIpMRoute(VppObject):
 297     """
 298     IP Multicast Route
 299     """
 300
 301     def __init__(self, test, src_addr, grp_addr,
 302                  grp_addr_len, e_flags, paths, table_id=0,
 303                  rpf_id=0, is_ip6=0):
 304         self._test = test
 305         self.paths = paths
 306         self.grp_addr_len = grp_addr_len
 307         self.table_id = table_id
 308         self.e_flags = e_flags
 309         self.is_ip6 = is_ip6
 310         self.rpf_id = rpf_id
 311
 312         if is_ip6:
 313             self.grp_addr = inet_pton(AF_INET6, grp_addr)
 314             self.src_addr = inet_pton(AF_INET6, src_addr)
 315         else:
 316             self.grp_addr = inet_pton(AF_INET, grp_addr)
 317             self.src_addr = inet_pton(AF_INET, src_addr)
 318
 319     def add_vpp_config(self):
 320         for path in self.paths:
 321             self._test.vapi.ip_mroute_add_del(self.src_addr,
 322                                               self.grp_addr,
 323                                               self.grp_addr_len,
 324                                               self.e_flags,
 325                                               path.proto,
 326                                               path.nh_itf,
 327                                               path.nh_i_flags,
 328                                               bier_imp=path.bier_imp,
 329                                               rpf_id=self.rpf_id,
 330                                               table_id=self.table_id,
 331                                               is_ipv6=self.is_ip6)
 332         self._test.registry.register(self, self._test.logger)
 333
 334     def remove_vpp_config(self):
 335         for path in self.paths:
 336             self._test.vapi.ip_mroute_add_del(self.src_addr,
 337                                               self.grp_addr,
 338                                               self.grp_addr_len,
 339                                               self.e_flags,
 340                                               path.proto,
 341                                               path.nh_itf,
 342                                               path.nh_i_flags,
 343                                               table_id=self.table_id,
 344                                               bier_imp=path.bier_imp,
 345                                               is_add=0,
 346                                               is_ipv6=self.is_ip6)
 347
 348     def update_entry_flags(self, flags):
 349         self.e_flags = flags
 350         self._test.vapi.ip_mroute_add_del(self.src_addr,
 351                                           self.grp_addr,
 352                                           self.grp_addr_len,
 353                                           self.e_flags,
 354                                           0,
 355                                           0xffffffff,
 356                                           0,
 357                                           table_id=self.table_id,
 358                                           is_ipv6=self.is_ip6)
 359
 360     def update_rpf_id(self, rpf_id):
 361         self.rpf_id = rpf_id
 362         self._test.vapi.ip_mroute_add_del(self.src_addr,
 363                                           self.grp_addr,
 364                                           self.grp_addr_len,
 365                                           self.e_flags,
 366                                           0,
 367                                           0xffffffff,
 368                                           0,
 369                                           rpf_id=self.rpf_id,
 370                                           table_id=self.table_id,
 371                                           is_ipv6=self.is_ip6)
 372
 373     def update_path_flags(self, itf, flags):
 374         for path in self.paths:
 375             if path.nh_itf == itf:
 376                 path.nh_i_flags = flags
 377                 break
 378         self._test.vapi.ip_mroute_add_del(self.src_addr,
 379                                           self.grp_addr,
 380                                           self.grp_addr_len,
 381                                           self.e_flags,
 382                                           path.proto,
 383                                           path.nh_itf,
 384                                           path.nh_i_flags,
 385                                           table_id=self.table_id,
 386                                           is_ipv6=self.is_ip6)
 387
 388     def query_vpp_config(self):
 389         if self.is_ip6:
 390             dump = self._test.vapi.ip6_mfib_dump()
 391         else:
 392             dump = self._test.vapi.ip_mfib_dump()
 393         for e in dump:
 394             if self.grp_addr == e.grp_address \
 395                and self.grp_addr_len == e.address_length \
 396                and self.src_addr == e.src_address \
 397                and self.table_id == e.table_id:
 398                 return True
 399         return False
 400
 401     def __str__(self):
 402         return self.object_id()
 403
 404     def object_id(self):
 405         if self.is_ip6:
 406             return ("%d:(%s,%s/%d)"
 407                     % (self.table_id,
 408                        inet_ntop(AF_INET6, self.src_addr),
 409                        inet_ntop(AF_INET6, self.grp_addr),
 410                        self.grp_addr_len))
 411         else:
 412             return ("%d:(%s,%s/%d)"
 413                     % (self.table_id,
 414                        inet_ntop(AF_INET, self.src_addr),
 415                        inet_ntop(AF_INET, self.grp_addr),
 416                        self.grp_addr_len))
 417
 418
 419 class VppMFibSignal(object):
 420     def __init__(self, test, route, interface, packet):
 421         self.route = route
 422         self.interface = interface
 423         self.packet = packet
 424         self.test = test
 425
 426     def compare(self, signal):
 427         self.test.assertEqual(self.interface, signal.sw_if_index)
 428         self.test.assertEqual(self.route.table_id, signal.table_id)
 429         self.test.assertEqual(self.route.grp_addr_len,
 430                               signal.grp_address_len)
 431         for i in range(self.route.grp_addr_len / 8):
 432             self.test.assertEqual(self.route.grp_addr[i],
 433                                   signal.grp_address[i])
 434         if (self.route.grp_addr_len > 32):
 435             for i in range(4):
 436                 self.test.assertEqual(self.route.src_addr[i],
 437                                       signal.src_address[i])
 438
 439
 440 class VppMplsIpBind(VppObject):
 441     """
 442     MPLS to IP Binding
 443     """
 444
 445     def __init__(self, test, local_label, dest_addr, dest_addr_len,
 446                  table_id=0, ip_table_id=0, is_ip6=0):
 447         self._test = test
 448         self.dest_addr_len = dest_addr_len
 449         self.dest_addr = dest_addr
 450         self.local_label = local_label
 451         self.table_id = table_id
 452         self.ip_table_id = ip_table_id
 453         self.is_ip6 = is_ip6
 454         if is_ip6:
 455             self.dest_addrn = inet_pton(AF_INET6, dest_addr)
 456         else:
 457             self.dest_addrn = inet_pton(AF_INET, dest_addr)
 458
 459     def add_vpp_config(self):
 460         self._test.vapi.mpls_ip_bind_unbind(self.local_label,
 461                                             self.dest_addrn,
 462                                             self.dest_addr_len,
 463                                             table_id=self.table_id,
 464                                             ip_table_id=self.ip_table_id,
 465                                             is_ip4=(self.is_ip6 == 0))
 466         self._test.registry.register(self, self._test.logger)
 467
 468     def remove_vpp_config(self):
 469         self._test.vapi.mpls_ip_bind_unbind(self.local_label,
 470                                             self.dest_addrn,
 471                                             self.dest_addr_len,
 472                                             table_id=self.table_id,
 473                                             ip_table_id=self.ip_table_id,
 474                                             is_bind=0,
 475                                             is_ip4=(self.is_ip6 == 0))
 476
 477     def query_vpp_config(self):
 478         dump = self._test.vapi.mpls_fib_dump()
 479         for e in dump:
 480             if self.local_label == e.label \
 481                and self.table_id == e.table_id:
 482                 return True
 483         return False
 484
 485     def __str__(self):
 486         return self.object_id()
 487
 488     def object_id(self):
 489         return ("%d:%s binds %d:%s/%d"
 490                 % (self.table_id,
 491                    self.local_label,
 492                    self.ip_table_id,
 493                    self.dest_addr,
 494                    self.dest_addr_len))
 495
 496
 497 class VppMplsTable(VppObject):
 498
 499     def __init__(self,
 500                  test,
 501                  table_id):
 502         self._test = test
 503         self.table_id = table_id
 504
 505     def add_vpp_config(self):
 506         self._test.vapi.mpls_table_add_del(
 507             self.table_id,
 508             is_add=1)
 509         self._test.registry.register(self, self._test.logger)
 510
 511     def remove_vpp_config(self):
 512         self._test.vapi.mpls_table_add_del(
 513             self.table_id,
 514             is_add=0)
 515
 516     def query_vpp_config(self):
 517         # find the default route
 518         dump = self._test.vapi.mpls_fib_dump()
 519         if len(dump):
 520             return True
 521         return False
 522
 523     def __str__(self):
 524         return self.object_id()
 525
 526     def object_id(self):
 527         return ("table-mpls-%d" % (self.table_id))
 528
 529
 530 class VppMplsRoute(VppObject):
 531     """
 532     MPLS Route/LSP
 533     """
 534
 535     def __init__(self, test, local_label, eos_bit, paths, table_id=0,
 536                  is_multicast=0):
 537         self._test = test
 538         self.paths = paths
 539         self.local_label = local_label
 540         self.eos_bit = eos_bit
 541         self.table_id = table_id
 542         self.is_multicast = is_multicast
 543
 544     def add_vpp_config(self):
 545         is_multipath = len(self.paths) > 1
 546         for path in self.paths:
 547             lstack = path.encode_labels()
 548
 549             self._test.vapi.mpls_route_add_del(
 550                 self.local_label,
 551                 self.eos_bit,
 552                 path.proto,
 553                 path.nh_addr,
 554                 path.nh_itf,
 555                 is_multicast=self.is_multicast,
 556                 is_multipath=is_multipath,
 557                 table_id=self.table_id,
 558                 is_interface_rx=path.is_interface_rx,
 559                 is_rpf_id=path.is_rpf_id,
 560                 next_hop_out_label_stack=lstack,
 561                 next_hop_n_out_labels=len(lstack),
 562                 next_hop_via_label=path.nh_via_label,
 563                 next_hop_table_id=path.nh_table_id)
 564         self._test.registry.register(self, self._test.logger)
 565
 566     def remove_vpp_config(self):
 567         for path in self.paths:
 568             self._test.vapi.mpls_route_add_del(self.local_label,
 569                                                self.eos_bit,
 570                                                path.proto,
 571                                                path.nh_addr,
 572                                                path.nh_itf,
 573                                                is_rpf_id=path.is_rpf_id,
 574                                                table_id=self.table_id,
 575                                                is_add=0)
 576
 577     def query_vpp_config(self):
 578         dump = self._test.vapi.mpls_fib_dump()
 579         for e in dump:
 580             if self.local_label == e.label \
 581                and self.eos_bit == e.eos_bit \
 582                and self.table_id == e.table_id:
 583                 return True
 584         return False
 585
 586     def __str__(self):
 587         return self.object_id()
 588
 589     def object_id(self):
 590         return ("%d:%s/%d"
 591                 % (self.table_id,
 592                    self.local_label,
 593                    20+self.eos_bit))