Shad Ansari | 2825d01 | 2018-02-22 23:57:46 +0000 | [diff] [blame] | 1 | # |
| 2 | # Copyright 2018 the original author or authors. |
| 3 | # |
| 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 | |
| 17 | """ |
| 18 | Openolt adapter. |
| 19 | """ |
| 20 | import structlog |
| 21 | from twisted.internet import reactor, defer |
| 22 | from zope.interface import implementer |
| 23 | |
| 24 | from openolt_device import OpenoltDevice |
| 25 | from voltha.adapters.interface import IAdapterInterface |
| 26 | from voltha.protos import third_party |
| 27 | from voltha.protos.adapter_pb2 import Adapter |
| 28 | from voltha.protos.adapter_pb2 import AdapterConfig |
| 29 | from voltha.protos.common_pb2 import LogLevel |
| 30 | from voltha.protos.device_pb2 import DeviceType, DeviceTypes |
| 31 | from voltha.protos.health_pb2 import HealthStatus |
| 32 | from voltha.registry import registry |
| 33 | |
| 34 | _ = third_party |
| 35 | log = structlog.get_logger() |
| 36 | |
| 37 | @implementer(IAdapterInterface) |
| 38 | class OpenoltAdapter(object): |
| 39 | name = 'openolt' |
| 40 | |
| 41 | supported_device_types = [ |
| 42 | DeviceType( |
| 43 | id=name, |
| 44 | adapter=name, |
| 45 | accepts_bulk_flow_update=True |
| 46 | ) |
| 47 | ] |
| 48 | |
| 49 | def __init__(self, adapter_agent, config): |
| 50 | self.adapter_agent = adapter_agent |
| 51 | self.config = config |
| 52 | self.descriptor = Adapter( |
| 53 | id=self.name, |
| 54 | vendor='OLT white box vendor', |
| 55 | version='0.1', |
| 56 | config=AdapterConfig(log_level=LogLevel.INFO) |
| 57 | ) |
| 58 | log.debug('openolt.__init__', adapter_agent=adapter_agent) |
| 59 | self.devices = dict() # device_id -> OpenoltDevice() |
| 60 | self.interface = registry('main').get_args().interface |
| 61 | self.logical_device_id_to_root_device_id = dict() |
Shad Ansari | 5dbc9c8 | 2018-05-10 03:29:31 +0000 | [diff] [blame] | 62 | self.num_devices = 0 |
Shad Ansari | 2825d01 | 2018-02-22 23:57:46 +0000 | [diff] [blame] | 63 | |
| 64 | def start(self): |
| 65 | log.info('started', interface=self.interface) |
| 66 | |
| 67 | def stop(self): |
| 68 | log.info('stopped', interface=self.interface) |
| 69 | |
| 70 | def adapter_descriptor(self): |
| 71 | log.debug('get descriptor', interface=self.interface) |
| 72 | return self.descriptor |
| 73 | |
| 74 | def device_types(self): |
| 75 | log.debug('get device_types', interface=self.interface, items=self.supported_device_types) |
| 76 | return DeviceTypes(items=self.supported_device_types) |
| 77 | |
| 78 | def health(self): |
| 79 | log.debug('get health', interface=self.interface) |
| 80 | raise NotImplementedError() |
| 81 | |
| 82 | def change_master_state(self, master): |
| 83 | log.debug('change_master_state', interface=self.interface, master=master) |
| 84 | raise NotImplementedError() |
| 85 | |
| 86 | def adopt_device(self, device): |
| 87 | log.info('adopt-device', device=device) |
| 88 | kwargs = { |
| 89 | 'adapter_agent': self.adapter_agent, |
Shad Ansari | 5dbc9c8 | 2018-05-10 03:29:31 +0000 | [diff] [blame] | 90 | 'device': device, |
| 91 | 'device_num': self.num_devices + 1 |
Shad Ansari | 2825d01 | 2018-02-22 23:57:46 +0000 | [diff] [blame] | 92 | } |
| 93 | try: |
| 94 | self.devices[device.id] = OpenoltDevice(**kwargs) |
| 95 | except Exception as e: |
| 96 | log.error('Failed to adopt OpenOLT device', error=e) |
| 97 | del self.devices[device.id] |
| 98 | raise |
Shad Ansari | 5dbc9c8 | 2018-05-10 03:29:31 +0000 | [diff] [blame] | 99 | else: |
| 100 | self.num_devices += 1 |
Shad Ansari | 2825d01 | 2018-02-22 23:57:46 +0000 | [diff] [blame] | 101 | |
| 102 | def reconcile_device(self, device): |
| 103 | log.info('reconcile-device', device=device) |
Nicolas Palpacuer | 253461f | 2018-06-01 12:01:45 -0400 | [diff] [blame^] | 104 | kwargs = { |
| 105 | 'adapter_agent': self.adapter_agent, |
| 106 | 'device': device, |
| 107 | 'device_num': self.num_devices + 1, |
| 108 | 'reconciliation': True |
| 109 | } |
| 110 | try: |
| 111 | reconciled_device = OpenoltDevice(**kwargs) |
| 112 | log.debug('reconciled-device-recreated', device_id=reconciled_device.device_id) |
| 113 | self.devices[device.id] = reconciled_device |
| 114 | except Exception as e: |
| 115 | log.error('Failed to reconcile OpenOLT device', error=e, exception_type=type(e).__name__) |
| 116 | del self.devices[device.id] |
| 117 | raise |
| 118 | else: |
| 119 | self.num_devices += 1 |
| 120 | # Invoke the children reconciliation which would setup the |
| 121 | # basic children data structures |
| 122 | self.adapter_agent.reconcile_child_devices(device.id) |
| 123 | return device |
Shad Ansari | 2825d01 | 2018-02-22 23:57:46 +0000 | [diff] [blame] | 124 | |
| 125 | def abandon_device(self, device): |
| 126 | log.info('abandon-device', device=device) |
| 127 | raise NotImplementedError() |
| 128 | |
| 129 | def disable_device(self, device): |
| 130 | log.info('disable-device', device=device) |
Jonathan Davis | 0f917a2 | 2018-05-30 14:39:45 -0400 | [diff] [blame] | 131 | handler = self.devices[device.id] |
| 132 | handler.disable() |
Shad Ansari | 2825d01 | 2018-02-22 23:57:46 +0000 | [diff] [blame] | 133 | |
| 134 | def reenable_device(self, device): |
| 135 | log.info('reenable-device', device=device) |
Jonathan Davis | 0f917a2 | 2018-05-30 14:39:45 -0400 | [diff] [blame] | 136 | handler = self.devices[device.id] |
| 137 | handler.reenable() |
Shad Ansari | 2825d01 | 2018-02-22 23:57:46 +0000 | [diff] [blame] | 138 | |
| 139 | def reboot_device(self, device): |
| 140 | log.info('reboot_device', device=device) |
| 141 | raise NotImplementedError() |
| 142 | |
| 143 | def download_image(self, device, request): |
| 144 | log.info('image_download', device=device, request=request) |
| 145 | raise NotImplementedError() |
| 146 | |
| 147 | def get_image_download_status(self, device, request): |
| 148 | log.info('get_image_download', device=device, request=request) |
| 149 | raise NotImplementedError() |
| 150 | |
| 151 | def cancel_image_download(self, device, request): |
| 152 | log.info('cancel_image_download', device=device) |
| 153 | raise NotImplementedError() |
| 154 | |
| 155 | def activate_image_update(self, device, request): |
| 156 | log.info('activate_image_update', device=device, request=request) |
| 157 | raise NotImplementedError() |
| 158 | |
| 159 | def revert_image_update(self, device, request): |
| 160 | log.info('revert_image_update', device=device, request=request) |
| 161 | raise NotImplementedError() |
| 162 | |
| 163 | def self_test_device(self, device): |
Nicolas Palpacuer | 65de6a4 | 2018-05-22 17:28:29 -0400 | [diff] [blame] | 164 | #from voltha.protos.voltha_pb2 import SelfTestResponse |
Shad Ansari | 2825d01 | 2018-02-22 23:57:46 +0000 | [diff] [blame] | 165 | raise NotImplementedError() |
| 166 | |
| 167 | def delete_device(self, device): |
| 168 | log.info('delete-device', device=device) |
Jonathan Davis | 0f917a2 | 2018-05-30 14:39:45 -0400 | [diff] [blame] | 169 | handler = self.devices[device.id] |
| 170 | handler.delete() |
| 171 | del self.devices[device.id] |
Shad Ansari | 2825d01 | 2018-02-22 23:57:46 +0000 | [diff] [blame] | 172 | |
| 173 | def get_device_details(self, device): |
| 174 | log.debug('get_device_details', device=device) |
| 175 | raise NotImplementedError() |
| 176 | |
| 177 | def update_flows_bulk(self, device, flows, groups): |
| 178 | log.info('bulk-flow-update', device_id=device.id, |
| 179 | flows=flows, groups=groups) |
| 180 | assert len(groups.items) == 0, "Cannot yet deal with groups" |
| 181 | handler = self.devices[device.id] |
| 182 | return handler.update_flow_table(flows.items) |
| 183 | |
| 184 | def update_flows_incrementally(self, device, flow_changes, group_changes): |
| 185 | log.debug('update_flows_incrementally', device=device, flow_changes=flow_changes, |
| 186 | group_changes=group_changes) |
| 187 | raise NotImplementedError() |
| 188 | |
| 189 | def update_pm_config(self, device, pm_configs): |
| 190 | log.debug('update_pm_config', device=device, pm_configs=pm_configs) |
| 191 | raise NotImplementedError() |
| 192 | |
| 193 | def send_proxied_message(self, proxy_address, msg): |
| 194 | log.debug('send-proxied-message', proxy_address=proxy_address, msg=msg) |
| 195 | handler = self.devices[proxy_address.device_id] |
| 196 | handler.send_proxied_message(proxy_address, msg) |
| 197 | |
| 198 | def receive_proxied_message(self, proxy_address, msg): |
| 199 | log.debug('receive_proxied_message', proxy_address=proxy_address, msg=msg) |
| 200 | raise NotImplementedError() |
| 201 | |
| 202 | def receive_packet_out(self, logical_device_id, egress_port_no, msg): |
| 203 | log.debug('packet-out', logical_device_id=logical_device_id, |
| 204 | egress_port_no=egress_port_no, msg_len=len(msg)) |
Shad Ansari | 42db734 | 2018-04-25 21:39:46 +0000 | [diff] [blame] | 205 | def ldi_to_di(ldi): |
| 206 | di = self.logical_device_id_to_root_device_id.get(ldi) |
| 207 | if di is None: |
| 208 | logical_device = self.adapter_agent.get_logical_device(ldi) |
| 209 | di = logical_device.root_device_id |
| 210 | self.logical_device_id_to_root_device_id[ldi] = di |
| 211 | return di |
| 212 | |
| 213 | device_id = ldi_to_di(logical_device_id) |
| 214 | handler = self.devices[device_id] |
| 215 | handler.packet_out(egress_port_no, msg) |
Shad Ansari | 2825d01 | 2018-02-22 23:57:46 +0000 | [diff] [blame] | 216 | |
| 217 | def receive_inter_adapter_message(self, msg): |
| 218 | log.info('rx_inter_adapter_msg') |
| 219 | raise NotImplementedError() |
| 220 | |
| 221 | def suppress_alarm(self, filter): |
| 222 | log.info('suppress_alarm', filter=filter) |
| 223 | raise NotImplementedError() |
| 224 | |
| 225 | def unsuppress_alarm(self, filter): |
| 226 | log.info('unsuppress_alarm', filter=filter) |
| 227 | raise NotImplementedError() |
| 228 | |
| 229 | # PON Mgnt APIs # |
| 230 | def create_interface(self, device, data): |
| 231 | log.debug('create-interface', data=data) |
| 232 | raise NotImplementedError() |
| 233 | |
| 234 | def update_interface(self, device, data): |
| 235 | log.debug('update-interface', data=data) |
| 236 | raise NotImplementedError() |
| 237 | |
| 238 | def remove_interface(self, device, data): |
| 239 | log.debug('remove-interface', data=data) |
| 240 | raise NotImplementedError() |
| 241 | |
| 242 | def receive_onu_detect_state(self, proxy_address, state): |
Nicolas Palpacuer | 65de6a4 | 2018-05-22 17:28:29 -0400 | [diff] [blame] | 243 | log.debug('receive-onu-detect-state', proxy_address=proxy_address, state=state) |
Shad Ansari | 2825d01 | 2018-02-22 23:57:46 +0000 | [diff] [blame] | 244 | raise NotImplementedError() |
| 245 | |
| 246 | def create_tcont(self, device, tcont_data, traffic_descriptor_data): |
| 247 | log.info('create-tcont', tcont_data=tcont_data, |
| 248 | traffic_descriptor_data=traffic_descriptor_data) |
| 249 | raise NotImplementedError() |
| 250 | |
| 251 | def update_tcont(self, device, tcont_data, traffic_descriptor_data): |
| 252 | log.info('update-tcont', tcont_data=tcont_data, |
| 253 | traffic_descriptor_data=traffic_descriptor_data) |
| 254 | raise NotImplementedError() |
| 255 | |
| 256 | def remove_tcont(self, device, tcont_data, traffic_descriptor_data): |
| 257 | log.info('remove-tcont', tcont_data=tcont_data, |
| 258 | traffic_descriptor_data=traffic_descriptor_data) |
| 259 | raise NotImplementedError() |
| 260 | |
| 261 | def create_gemport(self, device, data): |
| 262 | log.info('create-gemport', data=data) |
| 263 | raise NotImplementedError() |
| 264 | |
| 265 | def update_gemport(self, device, data): |
| 266 | log.info('update-gemport', data=data) |
| 267 | raise NotImplementedError() |
| 268 | |
| 269 | def remove_gemport(self, device, data): |
| 270 | log.info('remove-gemport', data=data) |
| 271 | raise NotImplementedError() |
| 272 | |
| 273 | def create_multicast_gemport(self, device, data): |
| 274 | log.info('create-mcast-gemport', data=data) |
| 275 | raise NotImplementedError() |
| 276 | |
| 277 | def update_multicast_gemport(self, device, data): |
| 278 | log.info('update-mcast-gemport', data=data) |
| 279 | raise NotImplementedError() |
| 280 | |
| 281 | def remove_multicast_gemport(self, device, data): |
| 282 | log.info('remove-mcast-gemport', data=data) |
| 283 | raise NotImplementedError() |
| 284 | |
| 285 | def create_multicast_distribution_set(self, device, data): |
| 286 | log.info('create-mcast-distribution-set', data=data) |
| 287 | raise NotImplementedError() |
| 288 | |
| 289 | def update_multicast_distribution_set(self, device, data): |
| 290 | log.info('update-mcast-distribution-set', data=data) |
| 291 | raise NotImplementedError() |
| 292 | |
| 293 | def remove_multicast_distribution_set(self, device, data): |
| 294 | log.info('remove-mcast-distribution-set', data=data) |
| 295 | raise NotImplementedError() |