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