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 # Print domain
  47 #
  48 def domain_print(i, ip4_pfx, ip6_pfx, ip6_src, eabits_len, psid_offset, psid_len):
  49     if format == "vpp":
  50         print(
  51             "map add domain ip4-pfx " + ip4_pfx + " ip6-pfx",
  52             ip6_pfx,
  53             "ip6-src " + ip6_src + " ea-bits-len",
  54             eabits_len,
  55             "psid-offset",
  56             psid_offset,
  57             "psid-len",
  58             psid_len,
  59         )
  60     if format == "confd":
  61         print(
  62             "vpp softwire softwire-instances softwire-instance",
  63             i,
  64             "br-ipv6 "
  65             + ip6_src
  66             + " ipv6-prefix "
  67             + ip6_pfx
  68             + " ipv4-prefix "
  69             + ip4_pfx
  70             + " ea-bits-len",
  71             eabits_len,
  72             "psid-offset",
  73             psid_offset,
  74             "psid-len",
  75             psid_len,
  76         )
  77     if format == "xml":
  78         print("<softwire-instance>")
  79         print("<id>", i, "</id>")
  80         print("  <br-ipv6>" + ip6_src + "</br-ipv6>")
  81         print("  <ipv6-prefix>" + ip6_pfx + "</ipv6-prefix>")
  82         print("  <ipv4-prefix>" + ip4_pfx + "</ipv4-prefix>")
  83         print("  <ea-len>", eabits_len, "</ea-len>")
  84         print("  <psid-len>", psid_len, "</psid-len>")
  85         print("  <psid-offset>", psid_offset, "</psid-offset>")
  86
  87
  88 def domain_print_end():
  89     if format == "xml":
  90         print("</softwire-instance>")
  91
  92
  93 def rule_print(i, psid, dst):
  94     if format == "vpp":
  95         print("map add rule index", i, "psid", psid, "ip6-dst", dst)
  96     if format == "confd":
  97         print("binding", psid, "ipv6-addr", dst)
  98     if format == "xml":
  99         print("  <binding>")
 100         print("    <psid>", psid, "</psid>")
 101         print("    <ipv6-addr>", dst, "</ipv6-addr>")
 102         print("  </binding>")
 103
 104
 105 #
 106 # Algorithmic mapping Shared IPv4 address
 107 #
 108 def algo(
 109     ip4_pfx_str,
 110     ip6_pfx_str,
 111     ip6_src_str,
 112     ea_bits_len,
 113     psid_offset,
 114     psid_len,
 115     ip6_src_ecmp=False,
 116 ):
 117     domain_print(
 118         0, ip4_pfx_str, ip6_pfx_str, ip6_src_str, ea_bits_len, psid_offset, psid_len
 119     )
 120     domain_print_end()
 121
 122
 123 #
 124 # 1:1 Full IPv4 address
 125 #
 126 def lw46(
 127     ip4_pfx_str,
 128     ip6_pfx_str,
 129     ip6_src_str,
 130     ea_bits_len,
 131     psid_offset,
 132     psid_len,
 133     ip6_src_ecmp=False,
 134 ):
 135     ip4_pfx = ipaddress.ip_network(ip4_pfx_str)
 136     ip6_src = ipaddress.ip_address(ip6_src_str)
 137     ip6_dst = ipaddress.ip_network(ip6_pfx_str)
 138     psid_len = 0
 139     mod = ip4_pfx.num_addresses / 1024
 140
 141     for i in range(ip4_pfx.num_addresses):
 142         domain_print(
 143             i, str(ip4_pfx[i]) + "/32", str(ip6_dst[i]) + "/128", str(ip6_src), 0, 0, 0
 144         )
 145         domain_print_end()
 146         if ip6_src_ecmp and not i % mod:
 147             ip6_src = ip6_src + 1
 148
 149
 150 #
 151 # 1:1 Shared IPv4 address, shared BR (16) VPP CLI
 152 #
 153 def lw46_shared(
 154     ip4_pfx_str,
 155     ip6_pfx_str,
 156     ip6_src_str,
 157     ea_bits_len,
 158     psid_offset,
 159     psid_len,
 160     ip6_src_ecmp=False,
 161 ):
 162     ip4_pfx = ipaddress.ip_network(ip4_pfx_str)
 163     ip6_src = ipaddress.ip_address(ip6_src_str)
 164     ip6_dst = ipaddress.ip_network(ip6_pfx_str)
 165     mod = ip4_pfx.num_addresses / 1024
 166
 167     for i in range(ip4_pfx.num_addresses):
 168         domain_print(i, str(ip4_pfx[i]) + "/32", "::/0", str(ip6_src), 0, 0, psid_len)
 169         for psid in range(0x1 << int(psid_len)):
 170             rule_print(i, psid, str(ip6_dst[(i * (0x1 << int(psid_len))) + psid]))
 171         domain_print_end()
 172         if ip6_src_ecmp and not i % mod:
 173             ip6_src = ip6_src + 1
 174
 175
 176 #
 177 # 1:1 Shared IPv4 address, shared BR
 178 #
 179 def lw46_shared_b(
 180     ip4_pfx_str,
 181     ip6_pfx_str,
 182     ip6_src_str,
 183     ea_bits_len,
 184     psid_offset,
 185     psid_len,
 186     ip6_src_ecmp=False,
 187 ):
 188     ip4_pfx = ipaddress.ip_network(ip4_pfx_str)
 189     ip6_src = ipaddress.ip_address(ip6_src_str)
 190     ip6_dst = list(ipaddress.ip_network(ip6_pfx_str).subnets(new_prefix=56))
 191     mod = ip4_pfx.num_addresses / 1024
 192
 193     for i in range(ip4_pfx.num_addresses):
 194         domain_print(i, str(ip4_pfx[i]) + "/32", "::/0", str(ip6_src), 0, 0, psid_len)
 195         for psid in range(0x1 << psid_len):
 196             enduserprefix = list(ip6_dst.pop(0).subnets(new_prefix=64))[255 - 1]
 197             rule_print(i, psid, enduserprefix[(i * (0x1 << psid_len)) + psid])
 198         domain_print_end()
 199         if ip6_src_ecmp and not i % mod:
 200             ip6_src = ip6_src + 1
 201
 202
 203 def xml_header_print():
 204     print(
 205         """
 206 <?xml version="1.0" encoding="UTF-8"?>
 207     <hello xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
 208     <capabilities>
 209     <capability>urn:ietf:params:netconf:base:1.0</capability>
 210     </capabilities>
 211     </hello>
 212 ]]>]]>
 213
 214 <?xml version="1.0" encoding="UTF-8"?>
 215     <rpc xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"  message-id="1">
 216     <edit-config>
 217     <target>
 218     <candidate/>
 219     </target>
 220     <config>
 221
 222     <vpp xmlns="http://www.cisco.com/yang/cisco-vpp">
 223  <softwire>
 224  <softwire-instances>
 225
 226     """
 227     )
 228
 229
 230 def xml_footer_print():
 231     print(
 232         """
 233 </softwire-instances>
 234 </softwire>
 235 </vpp>
 236     </config>
 237     </edit-config>
 238     </rpc>
 239
 240 ]]>]]>
 241
 242 <?xml version="1.0" encoding="UTF-8"?>
 243     <rpc xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="2">
 244     <close-session/>
 245     </rpc>
 246
 247 ]]>]]>
 248     """
 249     )
 250
 251
 252 format = args.format
 253 if format == "xml":
 254     xml_header_print()
 255 globals()[args.mapmode](
 256     args.ip4_pfx,
 257     args.ip6_pfx,
 258     args.ip6_src,
 259     args.ea_bits_len,
 260     args.psid_offset,
 261     args.psid_len,
 262 )
 263 if format == "xml":
 264     xml_footer_print()