From 6f72741fa2be906a850c5f2be24e98d5b6de4198 Mon Sep 17 00:00:00 2001 From: DmitriyEshenko Date: Sun, 14 Jun 2020 20:00:18 +0000 Subject: pim: T1729: Add PIM and IGMPv2/v3 support --- Makefile | 2 + interface-definitions/protocols-igmp.xml | 88 +++++++++++++ interface-definitions/protocols-multicast.xml | 95 ++++++++++++++ interface-definitions/protocols-pim.xml | 96 ++++++++++++++ op-mode-definitions/reset-ip-igmp.xml | 24 ++++ op-mode-definitions/reset-ip-multicast.xml | 24 ++++ op-mode-definitions/show-ip-igmp.xml | 48 +++++++ op-mode-definitions/show-ip-multicast.xml | 12 ++ op-mode-definitions/show-ip-pim.xml | 72 +++++++++++ src/conf_mode/protocols_igmp.py | 158 +++++++++++++++++++++++ src/conf_mode/protocols_pim.py | 178 ++++++++++++++++++++++++++ src/conf_mode/protocols_static_multicast.py | 141 ++++++++++++++++++++ 12 files changed, 938 insertions(+) create mode 100755 interface-definitions/protocols-igmp.xml create mode 100755 interface-definitions/protocols-multicast.xml create mode 100755 interface-definitions/protocols-pim.xml create mode 100755 op-mode-definitions/reset-ip-igmp.xml create mode 100755 op-mode-definitions/reset-ip-multicast.xml create mode 100755 op-mode-definitions/show-ip-igmp.xml mode change 100644 => 100755 op-mode-definitions/show-ip-multicast.xml create mode 100755 op-mode-definitions/show-ip-pim.xml create mode 100755 src/conf_mode/protocols_igmp.py create mode 100755 src/conf_mode/protocols_pim.py create mode 100755 src/conf_mode/protocols_static_multicast.py diff --git a/Makefile b/Makefile index f5941c920..5f2c50a9c 100644 --- a/Makefile +++ b/Makefile @@ -16,6 +16,7 @@ interface_definitions: rm -f $(TMPL_DIR)/system/options/node.def rm -f $(TMPL_DIR)/vpn/node.def rm -f $(TMPL_DIR)/vpn/ipsec/node.def + rm -f $(TMPL_DIR)/protocols/static/node.def .PHONY: op_mode_definitions .ONESHELL: @@ -35,6 +36,7 @@ op_mode_definitions: rm -f $(OP_TMPL_DIR)/monitor/node.def rm -f $(OP_TMPL_DIR)/generate/node.def rm -f $(OP_TMPL_DIR)/show/system/node.def + rm -f $(OP_TMPL_DIR)/reset/ip/node.def .PHONY: all all: clean interface_definitions op_mode_definitions diff --git a/interface-definitions/protocols-igmp.xml b/interface-definitions/protocols-igmp.xml new file mode 100755 index 000000000..a9b11e1a3 --- /dev/null +++ b/interface-definitions/protocols-igmp.xml @@ -0,0 +1,88 @@ + + + + + + + + Internet Group Management Protocol (IGMP) + + + + + IGMP interface + + + + + + + + IGMP join multicast group + + ipv4 + Multicast group address + + + + + + + + + Source address + + ipv4 + Source address + + + + + + + + + + + + IGMP version + + 2-3 + IGMP version + + + + + + + + + IGMP host query interval + + 1-1800 + Query interval in seconds + + + + + + + + + IGMP max query response time + + 10-250 + Query response value in deci-seconds + + + + + + + + + + + + + diff --git a/interface-definitions/protocols-multicast.xml b/interface-definitions/protocols-multicast.xml new file mode 100755 index 000000000..a06f2b287 --- /dev/null +++ b/interface-definitions/protocols-multicast.xml @@ -0,0 +1,95 @@ + + + + + + + + + + Multicast static route + + + + + Configure static unicast route into MRIB for multicast RPF lookup + + ipv4net + Network + + + + + + + + + Nexthop IPv4 address + + ipv4 + Nexthop IPv4 address + + + + + + + + + Distance value for this route + + 1-255 + Distance for this route + + + + + + + + + + + + + Multicast interface based route + + ipv4net + Network + + + + + + + + + Next-hop interface + + + + + + + + Distance value for this route + + 1-255 + Distance for this route + + + + + + + + + + + + + + + + + diff --git a/interface-definitions/protocols-pim.xml b/interface-definitions/protocols-pim.xml new file mode 100755 index 000000000..6152045a7 --- /dev/null +++ b/interface-definitions/protocols-pim.xml @@ -0,0 +1,96 @@ + + + + + + + + Protocol Independent Multicast (PIM) + 400 + + + + + PIM interface + + + + + + + + Designated Router Election Priority + + 1-4294967295 + Value of the new DR Priority + + + + + + + + + Hello Interval + + 1-180 + Hello Interval in seconds + + + + + + + + + + + Rendezvous Point + + + + + Rendezvous Point address + + ipv4 + Rendezvous Point address + + + + + + + + + Group Address range + + ipv4net + Group Address range RFC 3171 + + + + + + + + + + + + Keep alive Timer + + 31-60000 + Keep alive Timer in seconds + + + + + + + + + + + + + diff --git a/op-mode-definitions/reset-ip-igmp.xml b/op-mode-definitions/reset-ip-igmp.xml new file mode 100755 index 000000000..143553d33 --- /dev/null +++ b/op-mode-definitions/reset-ip-igmp.xml @@ -0,0 +1,24 @@ + + + + + + + + + IGMP clear commands + + + + + Reset IGMP interfaces + + /usr/bin/vtysh -c "clear ip igmp interfaces" + + + + + + + + diff --git a/op-mode-definitions/reset-ip-multicast.xml b/op-mode-definitions/reset-ip-multicast.xml new file mode 100755 index 000000000..d610add16 --- /dev/null +++ b/op-mode-definitions/reset-ip-multicast.xml @@ -0,0 +1,24 @@ + + + + + + + + + IP multicast routing table + + + + + Clear multicast routing table + + /usr/bin/vtysh -c "clear ip mroute" + + + + + + + + diff --git a/op-mode-definitions/show-ip-igmp.xml b/op-mode-definitions/show-ip-igmp.xml new file mode 100755 index 000000000..b8f2f9107 --- /dev/null +++ b/op-mode-definitions/show-ip-igmp.xml @@ -0,0 +1,48 @@ + + + + + + + + + Show IGMP (Internet Group Management Protocol) information + + + + + IGMP groups information + + /usr/bin/vtysh -c "show ip igmp groups" + + + + IGMP interfaces information + + /usr/bin/vtysh -c "show ip igmp interface" + + + + IGMP static join information + + /usr/bin/vtysh -c "show ip igmp join" + + + + IGMP sources information + + /usr/bin/vtysh -c "show ip igmp sources" + + + + IGMP statistics + + /usr/bin/vtysh -c "show ip igmp statistics" + + + + + + + + diff --git a/op-mode-definitions/show-ip-multicast.xml b/op-mode-definitions/show-ip-multicast.xml old mode 100644 new mode 100755 index 6ffe40436..5331d2e35 --- a/op-mode-definitions/show-ip-multicast.xml +++ b/op-mode-definitions/show-ip-multicast.xml @@ -21,6 +21,18 @@ if ps -C igmpproxy &>/dev/null; then ${vyos_op_scripts_dir}/show_igmpproxy.py --mfc; else echo IGMP proxy not configured; fi + + + IP multicast information + + /usr/bin/vtysh -c "show ip multicast" + + + + IP multicast routing table + + /usr/bin/vtysh -c "show ip mroute" + diff --git a/op-mode-definitions/show-ip-pim.xml b/op-mode-definitions/show-ip-pim.xml new file mode 100755 index 000000000..3f4edc779 --- /dev/null +++ b/op-mode-definitions/show-ip-pim.xml @@ -0,0 +1,72 @@ + + + + + + + + + Show PIM (Protocol Independent Multicast) information + + + + + PIM interfaces information + + /usr/bin/vtysh -c "show ip pim interface" + + + + PIM join information + + /usr/bin/vtysh -c "show ip pim join" + + + + PIM neighbor information + + /usr/bin/vtysh -c "show ip pim neighbor" + + + + PIM cached nexthop rpf information + + /usr/bin/vtysh -c "show ip pim nexthop" + + + + PIM state information + + /usr/bin/vtysh -c "show ip pim state" + + + + PIM statistics + + /usr/bin/vtysh -c "show ip pim statistics" + + + + PIM RP (Rendevous Point) information + + /usr/bin/vtysh -c "show ip pim rp-info" + + + + PIM cached source rpf information + + /usr/bin/vtysh -c "show ip pim rpf" + + + + PIM upstream information + + /usr/bin/vtysh -c "show ip pim upstream" + + + + + + + + diff --git a/src/conf_mode/protocols_igmp.py b/src/conf_mode/protocols_igmp.py new file mode 100755 index 000000000..983ca4c3a --- /dev/null +++ b/src/conf_mode/protocols_igmp.py @@ -0,0 +1,158 @@ +#!/usr/bin/env python3 +# +# Copyright (C) 2020 VyOS maintainers and contributors +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License version 2 or later as +# published by the Free Software Foundation. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + +import jinja2 +import copy +import os +import vyos.validate +from ipaddress import IPv4Address +from sys import exit + +from vyos import ConfigError +from vyos.config import Config + +config_file = r'/tmp/igmp.frr' + +config_tmpl = """ +! +{% for iface in old_ifaces -%} +interface {{ iface }} +{% for group in old_ifaces[iface].gr_join -%} +{% if old_ifaces[iface].gr_join[group] -%} +{% for source in old_ifaces[iface].gr_join[group] -%} +no ip igmp join {{ group }} {{ source }} +{% endfor -%} +{% else -%} +no ip igmp join {{ group }} +{% endif -%} +{% endfor -%} +no ip igmp +! +{% endfor -%} +{% for iface in ifaces -%} +interface {{ iface }} +{% if ifaces[iface].version -%} +ip igmp version {{ ifaces[iface].version }} +{% else -%} +{# IGMP default version 3 #} +ip igmp +{% endif -%} +{% if ifaces[iface].query_interval -%} +ip igmp query-interval {{ ifaces[iface].query_interval }} +{% endif -%} +{% if ifaces[iface].query_max_resp_time -%} +ip igmp query-max-response-time {{ ifaces[iface].query_max_resp_time }} +{% endif -%} +{% for group in ifaces[iface].gr_join -%} +{% if ifaces[iface].gr_join[group] -%} +{% for source in ifaces[iface].gr_join[group] -%} +ip igmp join {{ group }} {{ source }} +{% endfor -%} +{% else -%} +ip igmp join {{ group }} +{% endif -%} +{% endfor -%} +! +{% endfor -%} +! +""" + +def get_config(): + conf = Config() + igmp_conf = { + 'igmp_conf' : False, + 'old_ifaces' : {}, + 'ifaces' : {} + } + if not (conf.exists('protocols igmp') or conf.exists_effective('protocols igmp')): + return None + + if conf.exists('protocols igmp'): + igmp_conf['igmp_conf'] = True + + conf.set_level('protocols igmp') + + # # Get interfaces + for iface in conf.list_effective_nodes('interface'): + igmp_conf['old_ifaces'].update({ + iface : { + 'version' : conf.return_effective_value('interface {0} version'.format(iface)), + 'query_interval' : conf.return_effective_value('interface {0} query-interval'.format(iface)), + 'query_max_resp_time' : conf.return_effective_value('interface {0} query-max-response-time'.format(iface)), + 'gr_join' : {} + } + }) + for gr_join in conf.list_effective_nodes('interface {0} join'.format(iface)): + igmp_conf['old_ifaces'][iface]['gr_join'][gr_join] = conf.return_effective_values('interface {0} join {1} source'.format(iface, gr_join)) + + for iface in conf.list_nodes('interface'): + igmp_conf['ifaces'].update({ + iface : { + 'version' : conf.return_value('interface {0} version'.format(iface)), + 'query_interval' : conf.return_value('interface {0} query-interval'.format(iface)), + 'query_max_resp_time' : conf.return_value('interface {0} query-max-response-time'.format(iface)), + 'gr_join' : {} + } + }) + for gr_join in conf.list_nodes('interface {0} join'.format(iface)): + igmp_conf['ifaces'][iface]['gr_join'][gr_join] = conf.return_values('interface {0} join {1} source'.format(iface, gr_join)) + + return igmp_conf + +def verify(igmp): + if igmp is None: + return None + + if igmp['igmp_conf']: + # Check interfaces + if not igmp['ifaces']: + raise ConfigError("IGMP require defined interfaces!") + # Check, is this multicast group + for intfc in igmp['ifaces']: + for gr_addr in igmp['ifaces'][intfc]['gr_join']: + if IPv4Address(gr_addr) < IPv4Address('224.0.0.0'): + raise ConfigError(gr_addr + " not a multicast group") + +def generate(igmp): + if igmp is None: + return None + + tmpl = jinja2.Template(config_tmpl) + config_text = tmpl.render(igmp) + with open(config_file, 'w') as f: + f.write(config_text) + + return None + +def apply(igmp): + if igmp is None: + return None + + if os.path.exists(config_file): + os.system("sudo vtysh -d pimd -f " + config_file) + os.remove(config_file) + + return None + +if __name__ == '__main__': + try: + c = get_config() + verify(c) + generate(c) + apply(c) + except ConfigError as e: + print(e) + exit(1) diff --git a/src/conf_mode/protocols_pim.py b/src/conf_mode/protocols_pim.py new file mode 100755 index 000000000..ee5cc035f --- /dev/null +++ b/src/conf_mode/protocols_pim.py @@ -0,0 +1,178 @@ +#!/usr/bin/env python3 +# +# Copyright (C) 2020 VyOS maintainers and contributors +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License version 2 or later as +# published by the Free Software Foundation. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + +import jinja2 +import copy +import os +import vyos.validate +from ipaddress import IPv4Address +from sys import exit + +from vyos import ConfigError +from vyos.config import Config + +config_file = r'/tmp/pimd.frr' + +config_tmpl = """ +! +{% for rp_addr in old_pim.rp -%} +{% for group in old_pim.rp[rp_addr] -%} +no ip pim rp {{ rp_addr }} {{ group }} +{% endfor -%} +{% endfor -%} +{% if old_pim.rp_keep_alive -%} +no ip pim rp keep-alive-timer {{ old_pim.rp_keep_alive }} +{% endif -%} +{% for iface in old_pim.ifaces -%} +interface {{ iface }} +no ip pim +! +{% endfor -%} +{% for iface in pim.ifaces -%} +interface {{ iface }} +ip pim +{% if pim.ifaces[iface].dr_prio -%} +ip pim drpriority {{ pim.ifaces[iface].dr_prio }} +{% endif -%} +{% if pim.ifaces[iface].hello -%} +ip pim hello {{ pim.ifaces[iface].hello }} +{% endif -%} +! +{% endfor -%} +{% for rp_addr in pim.rp -%} +{% for group in pim.rp[rp_addr] -%} +ip pim rp {{ rp_addr }} {{ group }} +{% endfor -%} +{% endfor -%} +{% if pim.rp_keep_alive -%} +ip pim rp keep-alive-timer {{ pim.rp_keep_alive }} +{% endif -%} +! +""" + +def get_config(): + conf = Config() + pim_conf = { + 'pim_conf' : False, + 'old_pim' : { + 'ifaces' : {}, + 'rp' : {} + }, + 'pim' : { + 'ifaces' : {}, + 'rp' : {} + } + } + if not (conf.exists('protocols pim') or conf.exists_effective('protocols pim')): + return None + + if conf.exists('protocols pim'): + pim_conf['pim_conf'] = True + + conf.set_level('protocols pim') + + # Get interfaces + for iface in conf.list_effective_nodes('interface'): + pim_conf['old_pim']['ifaces'].update({ + iface : { + 'hello' : conf.return_effective_value('interface {0} hello'.format(iface)), + 'dr_prio' : conf.return_effective_value('interface {0} dr-priority'.format(iface)) + } + }) + + for iface in conf.list_nodes('interface'): + pim_conf['pim']['ifaces'].update({ + iface : { + 'hello' : conf.return_value('interface {0} hello'.format(iface)), + 'dr_prio' : conf.return_value('interface {0} dr-priority'.format(iface)), + } + }) + + conf.set_level('protocols pim rp') + + # Get RPs addresses + for rp_addr in conf.list_effective_nodes('address'): + pim_conf['old_pim']['rp'][rp_addr] = conf.return_effective_values('address {0} group'.format(rp_addr)) + + for rp_addr in conf.list_nodes('address'): + pim_conf['pim']['rp'][rp_addr] = conf.return_values('address {0} group'.format(rp_addr)) + + # Get RP keep-alive-timer + if conf.exists_effective('rp keep-alive-timer'): + pim_conf['old_pim']['rp_keep_alive'] = conf.return_effective_value('rp keep-alive-timer') + if conf.exists('rp keep-alive-timer'): + pim_conf['pim']['rp_keep_alive'] = conf.return_value('rp keep-alive-timer') + + return pim_conf + +def verify(pim): + if pim is None: + return None + + if pim['pim_conf']: + # Check interfaces + if not pim['pim']['ifaces']: + raise ConfigError("PIM require defined interfaces!") + + if not pim['pim']['rp']: + raise ConfigError("RP address required") + + # Check unique multicast groups + uniq_groups = [] + for rp_addr in pim['pim']['rp']: + if not pim['pim']['rp'][rp_addr]: + raise ConfigError("Group should be specified for RP " + rp_addr) + for group in pim['pim']['rp'][rp_addr]: + if (group in uniq_groups): + raise ConfigError("Group range " + group + " specified cannot exact match another") + + # Check, is this multicast group + gr_addr = group.split('/') + if IPv4Address(gr_addr[0]) < IPv4Address('224.0.0.0'): + raise ConfigError(group + " not a multicast group") + + uniq_groups.extend(pim['pim']['rp'][rp_addr]) + +def generate(pim): + if pim is None: + return None + + tmpl = jinja2.Template(config_tmpl) + config_text = tmpl.render(pim) + with open(config_file, 'w') as f: + f.write(config_text) + + return None + +def apply(pim): + if pim is None: + return None + + if os.path.exists(config_file): + os.system("sudo vtysh -d pimd -f " + config_file) + os.remove(config_file) + + return None + +if __name__ == '__main__': + try: + c = get_config() + verify(c) + generate(c) + apply(c) + except ConfigError as e: + print(e) + exit(1) diff --git a/src/conf_mode/protocols_static_multicast.py b/src/conf_mode/protocols_static_multicast.py new file mode 100755 index 000000000..b2522d74d --- /dev/null +++ b/src/conf_mode/protocols_static_multicast.py @@ -0,0 +1,141 @@ +#!/usr/bin/env python3 +# +# Copyright (C) 2020 VyOS maintainers and contributors +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License version 2 or later as +# published by the Free Software Foundation. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + +import jinja2 +import copy +import os +import vyos.validate +from ipaddress import IPv4Address +from sys import exit + +from vyos import ConfigError +from vyos.config import Config + +config_file = r'/tmp/static_mcast.frr' + +config_tmpl = """ +! +{% for route_gr in old_mroute -%} +{% for nh in old_mroute[route_gr] -%} +{% if old_mroute[route_gr][nh] -%} +no ip mroute {{ route_gr }} {{ nh }} {{ old_mroute[route_gr][nh] }} +{% else -%} +no ip mroute {{ route_gr }} {{ nh }} +{% endif -%} +{% endfor -%} +{% endfor -%} +{% for route_gr in mroute -%} +{% for nh in mroute[route_gr] -%} +{% if mroute[route_gr][nh] -%} +ip mroute {{ route_gr }} {{ nh }} {{ mroute[route_gr][nh] }} +{% else -%} +ip mroute {{ route_gr }} {{ nh }} +{% endif -%} +{% endfor -%} +{% endfor -%} +! +""" + +# Get configuration for static multicast route +def get_config(): + conf = Config() + mroute = { + 'old_mroute' : {}, + 'mroute' : {} + } + + base_path = "protocols static multicast" + + if not (conf.exists(base_path) or conf.exists_effective(base_path)): + return None + + conf.set_level(base_path) + + # Get multicast effective routes + for route in conf.list_effective_nodes('route'): + mroute['old_mroute'][route] = {} + for next_hop in conf.list_effective_nodes('route {0} next-hop'.format(route)): + mroute['old_mroute'][route].update({ + next_hop : conf.return_value('route {0} next-hop {1} distance'.format(route, next_hop)) + }) + + # Get multicast effective interface-routes + for route in conf.list_effective_nodes('interface-route'): + if not route in mroute['old_mroute']: + mroute['old_mroute'][route] = {} + for next_hop in conf.list_effective_nodes('interface-route {0} next-hop-interface'.format(route)): + mroute['old_mroute'][route].update({ + next_hop : conf.return_value('interface-route {0} next-hop-interface {1} distance'.format(route, next_hop)) + }) + + # Get multicast routes + for route in conf.list_nodes('route'): + mroute['mroute'][route] = {} + for next_hop in conf.list_nodes('route {0} next-hop'.format(route)): + mroute['mroute'][route].update({ + next_hop : conf.return_value('route {0} next-hop {1} distance'.format(route, next_hop)) + }) + + # Get multicast interface-routes + for route in conf.list_nodes('interface-route'): + if not route in mroute['mroute']: + mroute['mroute'][route] = {} + for next_hop in conf.list_nodes('interface-route {0} next-hop-interface'.format(route)): + mroute['mroute'][route].update({ + next_hop : conf.return_value('interface-route {0} next-hop-interface {1} distance'.format(route, next_hop)) + }) + + return mroute + +def verify(mroute): + if mroute is None: + return None + + for route in mroute['mroute']: + route_lst = route.split('/') + if IPv4Address(route_lst[0]) < IPv4Address('224.0.0.0'): + raise ConfigError(route + " not a multicast network") + +def generate(mroute): + if mroute is None: + return None + + tmpl = jinja2.Template(config_tmpl) + config_text = tmpl.render(mroute) + with open(config_file, 'w') as f: + f.write(config_text) + + return None + +def apply(mroute): + if mroute is None: + return None + + if os.path.exists(config_file): + os.system("sudo vtysh -d staticd -f " + config_file) + os.remove(config_file) + + return None + +if __name__ == '__main__': + try: + c = get_config() + verify(c) + generate(c) + apply(c) + except ConfigError as e: + print(e) + exit(1) -- cgit v1.2.3