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