| # |
| # Copyright 2019 the original author or authors. |
| # |
| # Licensed under the Apache License, Version 2.0 (the "License"); |
| # you may not use this file except in compliance with the License. |
| # You may obtain a copy of the License at |
| # |
| # http://www.apache.org/licenses/LICENSE-2.0 |
| # |
| # Unless required by applicable law or agreed to in writing, software |
| # distributed under the License is distributed on an "AS IS" BASIS, |
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| # See the License for the specific language governing permissions and |
| # limitations under the License. |
| # |
| import structlog |
| import socket |
| from scapy.layers.l2 import Ether |
| import voltha.core.flow_decomposer as fd |
| from voltha.adapters.openolt.openolt_utils import OpenoltUtils |
| from voltha.protos.device_pb2 import Port, Device |
| from voltha.protos.openflow_13_pb2 import OFPPS_LIVE, OFPPF_FIBER, \ |
| OFPPS_LINK_DOWN, OFPPF_1GB_FD, OFPC_PORT_STATS, OFPC_TABLE_STATS, \ |
| OFPC_FLOW_STATS, OFPC_GROUP_STATS, ofp_port, ofp_port_stats, ofp_desc, \ |
| ofp_switch_features |
| from voltha.core.logical_device_agent import mac_str_to_tuple |
| from voltha.protos.logical_device_pb2 import LogicalPort |
| from voltha.protos.common_pb2 import OperStatus, AdminState, ConnectStatus |
| from voltha.protos.logical_device_pb2 import LogicalDevice |
| from voltha.registry import registry |
| |
| |
| class OpenOltDataModel(object): |
| |
| def __init__(self, device, adapter_agent, platform): |
| self.log = structlog.get_logger() |
| |
| self.device = device |
| self.adapter_agent = adapter_agent |
| self.platform = platform |
| self.logical_device_id = None |
| |
| self.device.root = True |
| self.device.connect_status = ConnectStatus.UNREACHABLE |
| self.device.oper_status = OperStatus.ACTIVATING |
| |
| self.adapter_agent.update_device(device) |
| |
| self.nni_intf_id = None |
| |
| self.proxy = registry('core').get_proxy('/') |
| |
| def reconcile(self): |
| assert self.logical_device_id is not None |
| self.adapter_agent.reconcile_logical_device( |
| self.logical_device_id) |
| # Update device cache |
| self.device = self.adapter_agent.get_device(self.device.id) |
| |
| def olt_create(self, device_info): |
| if self.logical_device_id is not None: |
| return |
| |
| dpid = device_info.device_id |
| serial_number = device_info.device_serial_number |
| |
| if dpid is None or dpid == '': |
| uri = self.device.host_and_port.split(":")[0] |
| try: |
| socket.inet_pton(socket.AF_INET, uri) |
| dpid = '00:00:' + OpenoltUtils.ip_hex(uri) |
| except socket.error: |
| # this is not an IP |
| dpid = OpenoltUtils.str_to_mac(uri) |
| |
| self.log.info('creating-openolt-logical-device', dp_id=dpid, |
| serial_number=serial_number) |
| |
| hw_desc = device_info.model |
| if device_info.hardware_version: |
| hw_desc += '-' + device_info.hardware_version |
| |
| # Create logical OF device |
| ld = LogicalDevice( |
| root_device_id=self.device.id, |
| switch_features=ofp_switch_features( |
| n_buffers=256, # TODO fake for now |
| n_tables=2, # TODO ditto |
| capabilities=( # TODO and ditto |
| OFPC_FLOW_STATS |
| | OFPC_TABLE_STATS |
| | OFPC_PORT_STATS |
| | OFPC_GROUP_STATS |
| ) |
| ), |
| desc=ofp_desc( |
| serial_num=serial_number |
| ) |
| ) |
| self.logical_device_id = \ |
| self.adapter_agent.create_logical_device(ld, dpid=dpid).id |
| |
| self.device.vendor = device_info.vendor |
| self.device.model = device_info.model |
| self.device.hardware_version = device_info.hardware_version |
| self.device.firmware_version = device_info.firmware_version |
| self.device.connect_status = ConnectStatus.REACHABLE |
| self.device.serial_number = serial_number |
| |
| self.adapter_agent.update_device(self.device) |
| |
| self.log.info('created-openolt-logical-device', |
| logical_device_id=self.logical_device_id) |
| |
| return self.logical_device_id |
| |
| def olt_oper_up(self): |
| self.device.parent_id = self.logical_device_id |
| self.device.connect_status = ConnectStatus.REACHABLE |
| self.device.oper_status = OperStatus.ACTIVE |
| self.adapter_agent.update_device(self.device) |
| |
| def olt_oper_down(self): |
| self.__disable_logical_device() |
| |
| def olt_delete(self): |
| ld = self.adapter_agent.get_logical_device(self.logical_device_id) |
| self.adapter_agent.delete_logical_device(ld) |
| |
| def olt_port_add_update(self, intf_id, intf_type, oper): |
| if oper == "up": |
| oper_status = OperStatus.ACTIVE |
| else: |
| oper_status = OperStatus.DISCOVERED |
| |
| if intf_type == "nni": |
| port_type = Port.ETHERNET_NNI |
| elif intf_type == "pon": |
| port_type = Port.PON_OLT |
| |
| port_no, label = self.__add_port(intf_id, port_type, oper_status) |
| |
| if intf_type == "nni": |
| self.__add_logical_port(port_no, intf_id, oper_status) |
| self.nni_intf_id = intf_id |
| |
| def olt_nni_intf_id(self): |
| if self.nni_intf_id is not None: |
| return self.nni_intf_id |
| |
| port_list = self.adapter_agent.get_ports(self.device.id, |
| Port.ETHERNET_NNI) |
| logical_port = self.adapter_agent.get_logical_port( |
| self.logical_device_id, port_list[0].label) |
| self.nni_intf_id = self.platform.intf_id_from_nni_port_num( |
| logical_port.ofp_port.port_no) |
| self.log.debug("nni-intf-d ", nni_intf_id=self.nni_intf_id) |
| return self.nni_intf_id |
| |
| def onu_create(self, intf_id, onu_id, serial_number): |
| onu_device = self.adapter_agent.get_child_device( |
| self.device.id, |
| serial_number=serial_number) |
| |
| if onu_device: |
| self.log.debug("data_model onu update", intf_id=intf_id, |
| onu_id=onu_id, serial_number=serial_number) |
| onu_device.oper_status = OperStatus.DISCOVERED |
| onu_device.connect_status = ConnectStatus.REACHABLE |
| self.adapter_agent.update_device(onu_device) |
| return |
| |
| self.log.debug("data_model onu create", intf_id=intf_id, |
| onu_id=onu_id, serial_number=serial_number) |
| |
| # NOTE - channel_id of onu is set to intf_id |
| proxy_address = Device.ProxyAddress(device_id=self.device.id, |
| channel_id=intf_id, onu_id=onu_id, |
| onu_session_id=onu_id) |
| port_no = self.platform.intf_id_to_port_no(intf_id, Port.PON_OLT) |
| vendor_id = serial_number[:4] |
| self.adapter_agent.add_onu_device( |
| parent_device_id=self.device.id, parent_port_no=port_no, |
| vendor_id=vendor_id, proxy_address=proxy_address, |
| root=False, serial_number=serial_number, |
| admin_state=AdminState.ENABLED, |
| connect_status=ConnectStatus.REACHABLE |
| ) |
| |
| def onu_delete(self, serial_number): |
| onu_device = self.adapter_agent.get_child_device( |
| self.device.id, |
| serial_number=serial_number) |
| try: |
| self.adapter_agent.delete_child_device(self.device.id, |
| onu_device.id, onu_device) |
| except Exception as e: |
| self.log.error('adapter_agent error', error=e) |
| |
| ofp_port_name = self.__get_uni_ofp_port_name(onu_device) |
| if ofp_port_name is None: |
| self.log.exception("uni-ofp-port-not-found") |
| return |
| |
| try: |
| self.__delete_logical_port(onu_device) |
| except Exception as e: |
| self.log.error('logical_port delete error', error=e) |
| try: |
| self.delete_port(onu_device.serial_number) |
| except Exception as e: |
| self.log.error('port delete error', error=e) |
| |
| def onu_id(self, serial_number): |
| onu_device = self.adapter_agent.get_child_device( |
| self.device.id, |
| serial_number=serial_number) |
| |
| if onu_device: |
| return onu_device.proxy_address.onu_id |
| else: |
| return 0 # Invalid onu id |
| |
| def onu_oper_down(self, intf_id, onu_id): |
| |
| onu_device = self.adapter_agent.get_child_device( |
| self.device.id, |
| parent_port_no=self.platform.intf_id_to_port_no(intf_id, |
| Port.PON_OLT), |
| onu_id=onu_id) |
| |
| if onu_device is None: |
| self.log.error('onu not found', intf_id=intf_id, onu_id=onu_id) |
| return |
| |
| onu_adapter_agent = \ |
| registry('adapter_loader').get_agent(onu_device.adapter) |
| if onu_adapter_agent is None: |
| self.log.error('onu_adapter_agent-could-not-be-retrieved', |
| onu_device=onu_device) |
| return |
| |
| if onu_device.connect_status != ConnectStatus.UNREACHABLE: |
| onu_device.connect_status = ConnectStatus.UNREACHABLE |
| self.adapter_agent.update_device(onu_device) |
| |
| # Move to discovered state |
| self.log.debug('onu-oper-state-is-down') |
| |
| if onu_device.oper_status != OperStatus.DISCOVERED: |
| onu_device.oper_status = OperStatus.DISCOVERED |
| self.adapter_agent.update_device(onu_device) |
| # Set port oper state to Discovered |
| self.__onu_ports_down(onu_device) |
| |
| onu_adapter_agent.update_interface(onu_device, |
| {'oper_state': 'down'}) |
| |
| def onu_oper_up(self, intf_id, onu_id): |
| |
| class _OnuIndication: |
| def __init__(self, intf_id, onu_id): |
| self.intf_id = intf_id |
| self.onu_id = onu_id |
| |
| onu_device = self.adapter_agent.get_child_device( |
| self.device.id, |
| parent_port_no=self.platform.intf_id_to_port_no(intf_id, |
| Port.PON_OLT), |
| onu_id=onu_id) |
| |
| if onu_device is None: |
| self.log.error('onu not found', intf_id=intf_id, onu_id=onu_id) |
| return |
| |
| onu_adapter_agent = \ |
| registry('adapter_loader').get_agent(onu_device.adapter) |
| if onu_adapter_agent is None: |
| self.log.error('onu_adapter_agent-could-not-be-retrieved', |
| onu_device=onu_device) |
| return |
| if onu_device.connect_status != ConnectStatus.REACHABLE: |
| onu_device.connect_status = ConnectStatus.REACHABLE |
| self.adapter_agent.update_device(onu_device) |
| |
| if onu_device.oper_status != OperStatus.DISCOVERED: |
| self.log.debug("ignore onu indication", |
| intf_id=intf_id, |
| onu_id=onu_id, |
| state=onu_device.oper_status, |
| msg_oper_state="up") |
| return |
| |
| onu_adapter_agent.create_interface(onu_device, |
| _OnuIndication(intf_id, onu_id)) |
| |
| def onu_download_tech_profile(self, intf_id, onu_id, uni_id, tp_path): |
| onu_device = self.adapter_agent.get_child_device( |
| self.device.id, |
| parent_port_no=self.platform.intf_id_to_port_no(intf_id, |
| Port.PON_OLT), |
| onu_id=onu_id) |
| msg = {'proxy_address': onu_device.proxy_address, |
| 'uni_id': uni_id, 'event': 'download_tech_profile', |
| 'event_data': tp_path} |
| |
| # Send the event message to the ONU adapter |
| self.adapter_agent.publish_inter_adapter_message( |
| onu_device.id, msg) |
| |
| def onu_omci_rx(self, intf_id, onu_id, pkt): |
| onu_device = self.adapter_agent.get_child_device( |
| self.device.id, |
| parent_port_no=self.platform.intf_id_to_port_no(intf_id, |
| Port.PON_OLT), |
| onu_id=onu_id) |
| self.adapter_agent.receive_proxied_message(onu_device.proxy_address, |
| pkt) |
| |
| def onu_send_packet_in(self, intf_type, intf_id, port_no, pkt): |
| if intf_type == "pon": |
| if not port_no: |
| raise ValueError("invalid port_no") |
| logical_port_num = port_no |
| elif intf_type == "nni": |
| logical_port_num = self.platform.intf_id_to_port_no( |
| intf_id, |
| Port.ETHERNET_NNI) |
| |
| ether_pkt = Ether(pkt) |
| |
| self.adapter_agent.send_packet_in( |
| logical_device_id=self.logical_device_id, |
| logical_port_no=logical_port_num, |
| packet=str(ether_pkt)) |
| |
| # ####################################################################### |
| # Flow decomposer utility functions |
| # |
| # Flow related functions that are used by the OpenOLT flow decomposer. |
| # These are all prefixed with _ to denote that they will likely be removed |
| # once OpenOLT adapter transitions back to using core's flow decomposer. |
| # ####################################################################### |
| |
| def _flow_extract_info(self, flow, flow_direction): |
| uni_port_no = None |
| child_device_id = None |
| if flow_direction == "upstream": |
| for field in fd.get_ofb_fields(flow): |
| if field.type == fd.IN_PORT: |
| is_uni, child_device_id = self.__is_uni_port(field.port) |
| if is_uni: |
| uni_port_no = field.port |
| elif flow_direction == "downstream": |
| for field in fd.get_ofb_fields(flow): |
| if field.type == fd.METADATA: |
| uni_port = field.table_metadata & 0xFFFFFFFF |
| is_uni, child_device_id = self.__is_uni_port(uni_port) |
| if is_uni: |
| uni_port_no = field.port |
| |
| if uni_port_no is None: |
| for action in fd.get_actions(flow): |
| if action.type == fd.OUTPUT: |
| is_uni, child_device_id = \ |
| self.__is_uni_port(action.output.port) |
| if is_uni: |
| uni_port_no = action.output.port |
| |
| if child_device_id: |
| child_device = self.adapter_agent.get_device(child_device_id) |
| pon_intf = child_device.proxy_address.channel_id |
| onu_id = child_device.proxy_address.onu_id |
| uni_id = self.platform.uni_id_from_port_num(uni_port_no) \ |
| if uni_port_no is not None else None |
| else: |
| raise ValueError |
| |
| return pon_intf, onu_id, uni_id |
| |
| def _get_ofp_port_name(self, intf_id, onu_id, uni_id): |
| parent_port_no = self.platform.intf_id_to_port_no(intf_id, |
| Port.PON_OLT) |
| child_device = self.adapter_agent.get_child_device( |
| self.device.id, parent_port_no=parent_port_no, onu_id=onu_id) |
| if child_device is None: |
| self.log.error("could-not-find-child-device", |
| parent_port_no=intf_id, onu_id=onu_id) |
| return (None, None) |
| ports = self.adapter_agent.get_ports(child_device.id, |
| Port.ETHERNET_UNI) |
| logical_port = self.adapter_agent.get_logical_port( |
| self.logical_device_id, ports[uni_id].label) |
| ofp_port_name = (logical_port.ofp_port.name, |
| logical_port.ofp_port.port_no) |
| return ofp_port_name |
| |
| # ####################################################################### |
| # Methods used by Alarm and Statistics Manager (TODO - re-visit) |
| # ####################################################################### |
| |
| def _adapter_name(self): |
| return self.adapter_agent.adapter_name |
| |
| def _device_id(self): |
| return self.device.id |
| |
| def _resolve_onu_id(self, onu_id, port_intf_id): |
| try: |
| onu_device = None |
| onu_device = self.adapter_agent.get_child_device( |
| self.device_id, |
| parent_port_no=self.platform.intf_id_to_port_no( |
| port_intf_id, Port.PON_OLT), |
| onu_id=onu_id) |
| except Exception as inner: |
| self.log.exception('resolve-onu-id', errmsg=inner.message) |
| |
| return onu_device |
| |
| def create_alarm(self, **kwargs): |
| return self.adapter_agent.create_alarm( |
| logical_device_id=self.logical_device_id, |
| **kwargs) |
| |
| def submit_alarm(self, alarm_event): |
| self.adapter_agent.submit_alarm(self.device.id, alarm_event) |
| |
| # ####################################################################### |
| # Private functions |
| # |
| # These functions are prefixed with __ to denote that they are private |
| # to openolt_data_model and should not be called directly from the adapter. |
| # ####################################################################### |
| |
| def __disable_logical_device(self): |
| oper_state = OperStatus.UNKNOWN |
| connect_state = ConnectStatus.UNREACHABLE |
| |
| onu_devices = self.adapter_agent.get_child_devices(self.device.id) |
| for onu_device in onu_devices: |
| onu_adapter_agent = \ |
| registry('adapter_loader').get_agent(onu_device.adapter) |
| onu_adapter_agent.update_interface(onu_device, |
| {'oper_state': 'down'}) |
| self.__onu_ports_down(onu_device) |
| |
| # Children devices |
| self.adapter_agent.update_child_devices_state( |
| self.device.id, oper_status=oper_state, |
| connect_status=connect_state) |
| # Device Ports |
| device_ports = self.adapter_agent.get_ports(self.device.id, |
| Port.ETHERNET_NNI) |
| logical_ports_ids = [port.label for port in device_ports] |
| device_ports += self.adapter_agent.get_ports(self.device.id, |
| Port.PON_OLT) |
| |
| for port in device_ports: |
| port.oper_status = oper_state |
| self.adapter_agent.add_port(self.device.id, port) |
| |
| # Device logical port |
| for logical_port_id in logical_ports_ids: |
| logical_port = self.adapter_agent.get_logical_port( |
| self.logical_device_id, logical_port_id) |
| logical_port.ofp_port.state = OFPPS_LINK_DOWN |
| self.adapter_agent.update_logical_port(self.logical_device_id, |
| logical_port) |
| self.device.oper_status = oper_state |
| self.device.connect_status = connect_state |
| self.adapter_agent.update_device(self.device) |
| |
| def __add_logical_port(self, port_no, intf_id, oper_state): |
| self.log.info('adding-logical-port', port_no=port_no) |
| |
| label = OpenoltUtils.port_name(port_no, Port.ETHERNET_NNI) |
| |
| cap = OFPPF_1GB_FD | OFPPF_FIBER |
| curr_speed = OFPPF_1GB_FD |
| max_speed = OFPPF_1GB_FD |
| |
| if oper_state == OperStatus.ACTIVE: |
| of_oper_state = OFPPS_LIVE |
| else: |
| of_oper_state = OFPPS_LINK_DOWN |
| |
| ofp = ofp_port( |
| port_no=port_no, |
| hw_addr=mac_str_to_tuple( |
| OpenoltUtils.make_mac_from_port_no(port_no)), |
| name=label, config=0, state=of_oper_state, curr=cap, |
| advertised=cap, peer=cap, curr_speed=curr_speed, |
| max_speed=max_speed) |
| |
| ofp_stats = ofp_port_stats(port_no=port_no) |
| |
| logical_port = LogicalPort( |
| id=label, ofp_port=ofp, device_id=self.device.id, |
| device_port_no=port_no, root_port=True, |
| ofp_port_stats=ofp_stats) |
| |
| self.adapter_agent.add_logical_port(self.logical_device_id, |
| logical_port) |
| |
| def __delete_logical_port(self, child_device): |
| logical_ports = self.proxy.get('/logical_devices/{}/ports'.format( |
| self.logical_device_id)) |
| for logical_port in logical_ports: |
| if logical_port.device_id == child_device.id: |
| self.log.debug('delete-logical-port', |
| onu_device_id=child_device.id, |
| logical_port=logical_port) |
| self.flow_mgr.clear_flows_and_scheduler_for_logical_port( |
| child_device, logical_port) |
| self.adapter_agent.delete_logical_port( |
| self.logical_device_id, logical_port) |
| return |
| |
| def __onu_ports_down(self, onu_device): |
| onu_ports = self.proxy.get('devices/{}/ports'.format(onu_device.id)) |
| for onu_port in onu_ports: |
| self.log.debug('onu-ports-down', onu_port=onu_port) |
| onu_port_id = onu_port.label |
| try: |
| onu_logical_port = self.adapter_agent.get_logical_port( |
| logical_device_id=self.logical_device_id, |
| port_id=onu_port_id) |
| onu_logical_port.ofp_port.state = OFPPS_LINK_DOWN |
| self.adapter_agent.update_logical_port( |
| logical_device_id=self.logical_device_id, |
| port=onu_logical_port) |
| self.log.debug('cascading-oper-state-to-port-and-logical-port') |
| except KeyError as e: |
| self.log.error('matching-onu-port-label-invalid', |
| onu_id=onu_device.id, olt_id=self.device.id, |
| onu_ports=onu_ports, onu_port_id=onu_port_id, |
| error=e) |
| |
| def __add_port(self, intf_id, port_type, oper_status): |
| port_no = self.platform.intf_id_to_port_no(intf_id, port_type) |
| |
| label = OpenoltUtils.port_name(port_no, port_type, intf_id) |
| |
| self.log.debug('adding-port', port_no=port_no, label=label, |
| port_type=port_type) |
| |
| port = Port(port_no=port_no, label=label, type=port_type, |
| admin_state=AdminState.ENABLED, oper_status=oper_status) |
| |
| self.adapter_agent.add_port(self.device.id, port) |
| |
| return port_no, label |
| |
| def __get_uni_ofp_port_name(self, child_device): |
| logical_ports = self.proxy.get('/logical_devices/{}/ports'.format( |
| self.logical_device_id)) |
| for logical_port in logical_ports: |
| if logical_port.device_id == child_device.id: |
| return logical_port.ofp_port.name |
| return None |
| |
| def __is_uni_port(self, port_no): |
| try: |
| port = self.adapter_agent.get_logical_port( |
| self.logical_device_id, 'uni-{}'.format(port_no)) |
| if port is not None: |
| return (not port.root_port), port.device_id |
| else: |
| return False, None |
| except Exception as e: |
| self.log.error("error-retrieving-port", e=e) |
| return False, None |