src/plugins/map/examples/gen-rules.py

   1 #!/usr/bin/env python3
   2
   3 # Copyright (c) 2015 Cisco and/or its affiliates.
   4 # Licensed under the Apache License, Version 2.0 (the "License");
   5 # you may not use this file except in compliance with the License.
   6 # You may obtain a copy of the License at:
   7 #
   8 #     http://www.apache.org/licenses/LICENSE-2.0
   9 #
  10 # Unless required by applicable law or agreed to in writing, software
  11 # distributed under the License is distributed on an "AS IS" BASIS,
  12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 # See the License for the specific language governing permissions and
  14 # limitations under the License.
  15
  16 import ipaddress
  17 import argparse
  18 import sys
  19
  20 # map add domain ip4-pfx <pfx> ip6-pfx ::/0 ip6-src <ip6-src> ea-bits-len 0 psid-offset 6 psid-len 6
  21 # map add rule index <0> psid <psid> ip6-dst <ip6-dst>
  22
  23 def_ip4_pfx = "192.0.2.0/24"
  24 def_ip6_pfx = "2001:db8::/32"
  25 def_ip6_src = "2001:db8::1"
  26 def_psid_offset = 6
  27 def_psid_len = 6
  28 def_ea_bits_len = 0
  29
  30 parser = argparse.ArgumentParser(description="MAP VPP configuration generator")
  31 parser.add_argument("-t", action="store", dest="mapmode")
  32 parser.add_argument("-f", action="store", dest="format", default="vpp")
  33 parser.add_argument("--ip4-prefix", action="store", dest="ip4_pfx", default=def_ip4_pfx)
  34 parser.add_argument("--ip6-prefix", action="store", dest="ip6_pfx", default=def_ip6_pfx)
  35 parser.add_argument("--ip6-src", action="store", dest="ip6_src", default=def_ip6_src)
  36 parser.add_argument("--psid-len", action="store", dest="psid_len", default=def_psid_len)
  37 parser.add_argument(
  38     "--psid-offset", action="store", dest="psid_offset", default=def_psid_offset
  39 )
  40 parser.add_argument(
  41     "--ea-bits-len", action="store", dest="ea_bits_len", default=def_ea_bits_len
  42 )
  43 args = parser.parse_args()
  44
  45
  46 #
  47 # Print domain
  48 #
  49 def domain_print(i, ip4_pfx, ip6_pfx, ip6_src, eabits_len, psid_offset, psid_len):
  50     if format == "vpp":
  51         print(
  52             "map add domain ip4-pfx " + ip4_pfx + " ip6-pfx",
  53             ip6_pfx,
  54             "ip6-src " + ip6_src + " ea-bits-len",
  55             eabits_len,
  56             "psid-offset",
  57             psid_offset,
  58             "psid-len",
  59             psid_len,
  60         )
  61     if format == "confd":
  62         print(
  63             "vpp softwire softwire-instances softwire-instance",
  64             i,
  65             "br-ipv6 "
  66             + ip6_src
  67             + " ipv6-prefix "
  68             + ip6_pfx
  69             + " ipv4-prefix "
  70             + ip4_pfx
  71             + " ea-bits-len",
  72             eabits_len,
  73             "psid-offset",
  74             psid_offset,
  75             "psid-len",
  76             psid_len,
  77         )
  78     if format == "xml":
  79         print("<softwire-instance>")
  80         print("<id>", i, "</id>")
  81         print("  <br-ipv6>" + ip6_src + "</br-ipv6>")
  82         print("  <ipv6-prefix>" + ip6_pfx + "</ipv6-prefix>")
  83         print("  <ipv4-prefix>" + ip4_pfx + "</ipv4-prefix>")
  84         print("  <ea-len>", eabits_len, "</ea-len>")
  85         print("  <psid-len>", psid_len, "</psid-len>")
  86         print("  <psid-offset>", psid_offset, "</psid-offset>")
  87
  88
  89 def domain_print_end():
  90     if format == "xml":
  91         print("</softwire-instance>")
  92
  93
  94 def rule_print(i, psid, dst):
  95     if format == "vpp":
  96         print("map add rule index", i, "psid", psid, "ip6-dst", dst)
  97     if format == "confd":
  98         print("binding", psid, "ipv6-addr", dst)
  99     if format == "xml":
 100         print("  <binding>")
 101         print("    <psid>", psid, "</psid>")
 102         print("    <ipv6-addr>", dst, "</ipv6-addr>")
 103         print("  </binding>")
 104
 105
 106 #
 107 # Algorithmic mapping Shared IPv4 address
 108 #
 109 def algo(
 110     ip4_pfx_str,
 111     ip6_pfx_str,
 112     ip6_src_str,
 113     ea_bits_len,
 114     psid_offset,
 115     psid_len,
 116     ip6_src_ecmp=False,
 117 ):
 118     domain_print(
 119         0, ip4_pfx_str, ip6_pfx_str, ip6_src_str, ea_bits_len, psid_offset, psid_len
 120     )
 121     domain_print_end()
 122
 123
 124 #
 125 # 1:1 Full IPv4 address
 126 #
 127 def lw46(
 128     ip4_pfx_str,
 129     ip6_pfx_str,
 130     ip6_src_str,
 131     ea_bits_len,
 132     psid_offset,
 133     psid_len,
 134     ip6_src_ecmp=False,
 135 ):
 136     ip4_pfx = ipaddress.ip_network(ip4_pfx_str)
 137     ip6_src = ipaddress.ip_address(ip6_src_str)
 138     ip6_dst = ipaddress.ip_network(ip6_pfx_str)
 139     psid_len = 0
 140     mod = ip4_pfx.num_addresses / 1024
 141
 142     for i in range(ip4_pfx.num_addresses):
 143         domain_print(
 144             i, str(ip4_pfx[i]) + "/32", str(ip6_dst[i]) + "/128", str(ip6_src), 0, 0, 0
 145         )
 146         domain_print_end()
 147         if ip6_src_ecmp and not i % mod:
 148             ip6_src = ip6_src + 1
 149
 150
 151 #
 152 # 1:1 Shared IPv4 address, shared BR (16) VPP CLI
 153 #
 154 def lw46_shared(
 155     ip4_pfx_str,
 156     ip6_pfx_str,
 157     ip6_src_str,
 158     ea_bits_len,
 159     psid_offset,
 160     psid_len,
 161     ip6_src_ecmp=False,
 162 ):
 163     ip4_pfx = ipaddress.ip_network(ip4_pfx_str)
 164     ip6_src = ipaddress.ip_address(ip6_src_str)
 165     ip6_dst = ipaddress.ip_network(ip6_pfx_str)
 166     mod = ip4_pfx.num_addresses / 1024
 167
 168     for i in range(ip4_pfx.num_addresses):
 169         domain_print(i, str(ip4_pfx[i]) + "/32", "::/0", str(ip6_src), 0, 0, psid_len)
 170         for psid in range(0x1 << int(psid_len)):
 171             rule_print(i, psid, str(ip6_dst[(i * (0x1 << int(psid_len))) + psid]))
 172         domain_print_end()
 173         if ip6_src_ecmp and not i % mod:
 174             ip6_src = ip6_src + 1
 175
 176
 177 #
 178 # 1:1 Shared IPv4 address, shared BR
 179 #
 180 def lw46_shared_b(
 181     ip4_pfx_str,
 182     ip6_pfx_str,
 183     ip6_src_str,
 184     ea_bits_len,
 185     psid_offset,
 186     psid_len,
 187     ip6_src_ecmp=False,
 188 ):
 189     ip4_pfx = ipaddress.ip_network(ip4_pfx_str)
 190     ip6_src = ipaddress.ip_address(ip6_src_str)
 191     ip6_dst = list(ipaddress.ip_network(ip6_pfx_str).subnets(new_prefix=56))
 192     mod = ip4_pfx.num_addresses / 1024
 193
 194     for i in range(ip4_pfx.num_addresses):
 195         domain_print(i, str(ip4_pfx[i]) + "/32", "::/0", str(ip6_src), 0, 0, psid_len)
 196         for psid in range(0x1 << psid_len):
 197             enduserprefix = list(ip6_dst.pop(0).subnets(new_prefix=64))[255 - 1]
 198             rule_print(i, psid, enduserprefix[(i * (0x1 << psid_len)) + psid])
 199         domain_print_end()
 200         if ip6_src_ecmp and not i % mod:
 201             ip6_src = ip6_src + 1
 202
 203
 204 def xml_header_print():
 205     print(
 206         """
 207 <?xml version="1.0" encoding="UTF-8"?>
 208     <hello xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
 209     <capabilities>
 210     <capability>urn:ietf:params:netconf:base:1.0</capability>
 211     </capabilities>
 212     </hello>
 213 ]]>]]>
 214
 215 <?xml version="1.0" encoding="UTF-8"?>
 216     <rpc xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"  message-id="1">
 217     <edit-config>
 218     <target>
 219     <candidate/>
 220     </target>
 221     <config>
 222
 223     <vpp xmlns="http://www.cisco.com/yang/cisco-vpp">
 224  <softwire>
 225  <softwire-instances>
 226
 227     """
 228     )
 229
 230
 231 def xml_footer_print():
 232     print(
 233         """
 234 </softwire-instances>
 235 </softwire>
 236 </vpp>
 237     </config>
 238     </edit-config>
 239     </rpc>
 240
 241 ]]>]]>
 242
 243 <?xml version="1.0" encoding="UTF-8"?>
 244     <rpc xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="2">
 245     <close-session/>
 246     </rpc>
 247
 248 ]]>]]>
 249     """
 250     )
 251
 252
 253 format = args.format
 254 if format == "xml":
 255     xml_header_print()
 256 globals()[args.mapmode](
 257     args.ip4_pfx,
 258     args.ip6_pfx,
 259     args.ip6_src,
 260     args.ea_bits_len,
 261     args.psid_offset,
 262     args.psid_len,
 263 )
 264 if format == "xml":
 265     xml_footer_print()