khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 1 | # |
| 2 | # Copyright 2017 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 | """ |
khenaidoo | 6fdf0ba | 2018-11-02 14:38:33 -0400 | [diff] [blame] | 18 | This facade handles kafka-formatted messages from the Core, extracts the kafka |
| 19 | formatting and forwards the request to the concrete handler. |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 20 | """ |
khenaidoo | 9084792 | 2018-12-03 14:47:51 -0500 | [diff] [blame] | 21 | import structlog |
khenaidoo | 6fdf0ba | 2018-11-02 14:38:33 -0400 | [diff] [blame] | 22 | from twisted.internet.defer import inlineCallbacks |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 23 | from zope.interface import implementer |
khenaidoo | 43c8212 | 2018-11-22 18:38:28 -0500 | [diff] [blame] | 24 | from twisted.internet import reactor |
khenaidoo | ca30132 | 2019-01-09 23:06:32 -0500 | [diff] [blame] | 25 | |
khenaidoo | 9084792 | 2018-12-03 14:47:51 -0500 | [diff] [blame] | 26 | from afkak.consumer import OFFSET_LATEST, OFFSET_EARLIEST |
khenaidoo | fdbad6e | 2018-11-06 22:26:38 -0500 | [diff] [blame] | 27 | from python.adapters.interface import IAdapterInterface |
khenaidoo | 7923270 | 2018-12-04 11:00:41 -0500 | [diff] [blame] | 28 | from python.protos.inter_container_pb2 import IntType, InterAdapterMessage, StrType, Error, ErrorCode |
khenaidoo | f5a5bfa | 2019-01-23 22:20:29 -0500 | [diff] [blame] | 29 | from python.protos.device_pb2 import Device, ImageDownload |
khenaidoo | fdbad6e | 2018-11-06 22:26:38 -0500 | [diff] [blame] | 30 | from python.protos.openflow_13_pb2 import FlowChanges, FlowGroups, Flows, \ |
| 31 | FlowGroupChanges, ofp_packet_out |
khenaidoo | 43c8212 | 2018-11-22 18:38:28 -0500 | [diff] [blame] | 32 | from python.adapters.kafka.kafka_inter_container_library import IKafkaMessagingProxy, \ |
khenaidoo | ca30132 | 2019-01-09 23:06:32 -0500 | [diff] [blame] | 33 | get_messaging_proxy, KAFKA_OFFSET_LATEST, KAFKA_OFFSET_EARLIEST |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 34 | |
khenaidoo | 9084792 | 2018-12-03 14:47:51 -0500 | [diff] [blame] | 35 | log = structlog.get_logger() |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 36 | |
| 37 | class MacAddressError(BaseException): |
| 38 | def __init__(self, error): |
| 39 | self.error = error |
| 40 | |
| 41 | |
| 42 | class IDError(BaseException): |
| 43 | def __init__(self, error): |
| 44 | self.error = error |
| 45 | |
| 46 | |
| 47 | @implementer(IAdapterInterface) |
| 48 | class AdapterRequestFacade(object): |
| 49 | """ |
| 50 | Gate-keeper between CORE and device adapters. |
| 51 | |
| 52 | On one side it interacts with Core's internal model and update/dispatch |
| 53 | mechanisms. |
| 54 | |
| 55 | On the other side, it interacts with the adapters standard interface as |
| 56 | defined in |
| 57 | """ |
| 58 | |
| 59 | def __init__(self, adapter): |
| 60 | self.adapter = adapter |
| 61 | |
| 62 | @inlineCallbacks |
| 63 | def start(self): |
khenaidoo | 9084792 | 2018-12-03 14:47:51 -0500 | [diff] [blame] | 64 | log.debug('starting') |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 65 | |
| 66 | @inlineCallbacks |
| 67 | def stop(self): |
khenaidoo | 9084792 | 2018-12-03 14:47:51 -0500 | [diff] [blame] | 68 | log.debug('stopping') |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 69 | |
khenaidoo | 9084792 | 2018-12-03 14:47:51 -0500 | [diff] [blame] | 70 | @inlineCallbacks |
khenaidoo | 43c8212 | 2018-11-22 18:38:28 -0500 | [diff] [blame] | 71 | def createKafkaDeviceTopic(self, deviceId): |
khenaidoo | 9084792 | 2018-12-03 14:47:51 -0500 | [diff] [blame] | 72 | log.debug("subscribing-to-topic", device_id=deviceId) |
khenaidoo | 43c8212 | 2018-11-22 18:38:28 -0500 | [diff] [blame] | 73 | kafka_proxy = get_messaging_proxy() |
| 74 | device_topic = kafka_proxy.get_default_topic() + "_" + deviceId |
khenaidoo | 9084792 | 2018-12-03 14:47:51 -0500 | [diff] [blame] | 75 | # yield kafka_proxy.create_topic(topic=device_topic) |
khenaidoo | ca30132 | 2019-01-09 23:06:32 -0500 | [diff] [blame] | 76 | yield kafka_proxy.subscribe(topic=device_topic, group_id=device_topic, target_cls=self, offset=KAFKA_OFFSET_EARLIEST) |
khenaidoo | 9084792 | 2018-12-03 14:47:51 -0500 | [diff] [blame] | 77 | log.debug("subscribed-to-topic", topic=device_topic) |
khenaidoo | 43c8212 | 2018-11-22 18:38:28 -0500 | [diff] [blame] | 78 | |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 79 | def adopt_device(self, device): |
| 80 | d = Device() |
| 81 | if device: |
| 82 | device.Unpack(d) |
khenaidoo | 43c8212 | 2018-11-22 18:38:28 -0500 | [diff] [blame] | 83 | |
khenaidoo | 9084792 | 2018-12-03 14:47:51 -0500 | [diff] [blame] | 84 | # Start the creation of a device specific topic to handle all |
| 85 | # subsequent requests from the Core. This adapter instance will |
| 86 | # handle all requests for that device. |
| 87 | reactor.callLater(0, self.createKafkaDeviceTopic, d.id) |
| 88 | |
khenaidoo | 43c8212 | 2018-11-22 18:38:28 -0500 | [diff] [blame] | 89 | result = self.adapter.adopt_device(d) |
| 90 | # return True, self.adapter.adopt_device(d) |
| 91 | |
khenaidoo | 43c8212 | 2018-11-22 18:38:28 -0500 | [diff] [blame] | 92 | return True, result |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 93 | else: |
khenaidoo | fdbad6e | 2018-11-06 22:26:38 -0500 | [diff] [blame] | 94 | return False, Error(code=ErrorCode.INVALID_PARAMETERS, |
| 95 | reason="device-invalid") |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 96 | |
| 97 | def get_ofp_device_info(self, device): |
| 98 | d = Device() |
| 99 | if device: |
| 100 | device.Unpack(d) |
khenaidoo | 92e62c5 | 2018-10-03 14:02:54 -0400 | [diff] [blame] | 101 | return True, self.adapter.get_ofp_device_info(d) |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 102 | else: |
khenaidoo | fdbad6e | 2018-11-06 22:26:38 -0500 | [diff] [blame] | 103 | return False, Error(code=ErrorCode.INVALID_PARAMETERS, |
| 104 | reason="device-invalid") |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 105 | |
| 106 | def get_ofp_port_info(self, device, port_no): |
| 107 | d = Device() |
| 108 | if device: |
| 109 | device.Unpack(d) |
| 110 | else: |
khenaidoo | fdbad6e | 2018-11-06 22:26:38 -0500 | [diff] [blame] | 111 | return False, Error(code=ErrorCode.INVALID_PARAMETERS, |
| 112 | reason="device-invalid") |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 113 | p = IntType() |
khenaidoo | fdbad6e | 2018-11-06 22:26:38 -0500 | [diff] [blame] | 114 | if port_no: |
| 115 | port_no.Unpack(p) |
| 116 | else: |
| 117 | return False, Error(code=ErrorCode.INVALID_PARAMETERS, |
| 118 | reason="port-no-invalid") |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 119 | |
khenaidoo | 92e62c5 | 2018-10-03 14:02:54 -0400 | [diff] [blame] | 120 | return True, self.adapter.get_ofp_port_info(d, p.val) |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 121 | |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 122 | def reconcile_device(self, device): |
| 123 | return self.adapter.reconcile_device(device) |
| 124 | |
| 125 | def abandon_device(self, device): |
| 126 | return self.adapter.abandon_device(device) |
| 127 | |
| 128 | def disable_device(self, device): |
khenaidoo | 92e62c5 | 2018-10-03 14:02:54 -0400 | [diff] [blame] | 129 | d = Device() |
| 130 | if device: |
| 131 | device.Unpack(d) |
| 132 | return True, self.adapter.disable_device(d) |
| 133 | else: |
khenaidoo | fdbad6e | 2018-11-06 22:26:38 -0500 | [diff] [blame] | 134 | return False, Error(code=ErrorCode.INVALID_PARAMETERS, |
| 135 | reason="device-invalid") |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 136 | |
| 137 | def reenable_device(self, device): |
khenaidoo | 92e62c5 | 2018-10-03 14:02:54 -0400 | [diff] [blame] | 138 | d = Device() |
| 139 | if device: |
| 140 | device.Unpack(d) |
| 141 | return True, self.adapter.reenable_device(d) |
| 142 | else: |
khenaidoo | fdbad6e | 2018-11-06 22:26:38 -0500 | [diff] [blame] | 143 | return False, Error(code=ErrorCode.INVALID_PARAMETERS, |
| 144 | reason="device-invalid") |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 145 | |
| 146 | def reboot_device(self, device): |
| 147 | d = Device() |
| 148 | if device: |
| 149 | device.Unpack(d) |
| 150 | return (True, self.adapter.reboot_device(d)) |
| 151 | else: |
khenaidoo | fdbad6e | 2018-11-06 22:26:38 -0500 | [diff] [blame] | 152 | return False, Error(code=ErrorCode.INVALID_PARAMETERS, |
| 153 | reason="device-invalid") |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 154 | |
| 155 | def download_image(self, device, request): |
khenaidoo | f5a5bfa | 2019-01-23 22:20:29 -0500 | [diff] [blame] | 156 | d = Device() |
| 157 | if device: |
| 158 | device.Unpack(d) |
| 159 | else: |
| 160 | return False, Error(code=ErrorCode.INVALID_PARAMETERS, |
| 161 | reason="device-invalid") |
| 162 | img = ImageDownload() |
| 163 | if request: |
| 164 | request.Unpack(img) |
| 165 | else: |
| 166 | return False, Error(code=ErrorCode.INVALID_PARAMETERS, |
| 167 | reason="port-no-invalid") |
| 168 | |
| 169 | return True, self.adapter.download_image(device, request) |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 170 | |
| 171 | def get_image_download_status(self, device, request): |
khenaidoo | f5a5bfa | 2019-01-23 22:20:29 -0500 | [diff] [blame] | 172 | d = Device() |
| 173 | if device: |
| 174 | device.Unpack(d) |
| 175 | else: |
| 176 | return False, Error(code=ErrorCode.INVALID_PARAMETERS, |
| 177 | reason="device-invalid") |
| 178 | img = ImageDownload() |
| 179 | if request: |
| 180 | request.Unpack(img) |
| 181 | else: |
| 182 | return False, Error(code=ErrorCode.INVALID_PARAMETERS, |
| 183 | reason="port-no-invalid") |
| 184 | |
| 185 | return True, self.adapter.get_image_download_status(device, request) |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 186 | |
| 187 | def cancel_image_download(self, device, request): |
khenaidoo | f5a5bfa | 2019-01-23 22:20:29 -0500 | [diff] [blame] | 188 | d = Device() |
| 189 | if device: |
| 190 | device.Unpack(d) |
| 191 | else: |
| 192 | return False, Error(code=ErrorCode.INVALID_PARAMETERS, |
| 193 | reason="device-invalid") |
| 194 | img = ImageDownload() |
| 195 | if request: |
| 196 | request.Unpack(img) |
| 197 | else: |
| 198 | return False, Error(code=ErrorCode.INVALID_PARAMETERS, |
| 199 | reason="port-no-invalid") |
| 200 | |
| 201 | return True, self.adapter.cancel_image_download(device, request) |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 202 | |
| 203 | def activate_image_update(self, device, request): |
khenaidoo | f5a5bfa | 2019-01-23 22:20:29 -0500 | [diff] [blame] | 204 | d = Device() |
| 205 | if device: |
| 206 | device.Unpack(d) |
| 207 | else: |
| 208 | return False, Error(code=ErrorCode.INVALID_PARAMETERS, |
| 209 | reason="device-invalid") |
| 210 | img = ImageDownload() |
| 211 | if request: |
| 212 | request.Unpack(img) |
| 213 | else: |
| 214 | return False, Error(code=ErrorCode.INVALID_PARAMETERS, |
| 215 | reason="port-no-invalid") |
| 216 | |
| 217 | return True, self.adapter.activate_image_update(device, request) |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 218 | |
| 219 | def revert_image_update(self, device, request): |
khenaidoo | f5a5bfa | 2019-01-23 22:20:29 -0500 | [diff] [blame] | 220 | d = Device() |
| 221 | if device: |
| 222 | device.Unpack(d) |
| 223 | else: |
| 224 | return False, Error(code=ErrorCode.INVALID_PARAMETERS, |
| 225 | reason="device-invalid") |
| 226 | img = ImageDownload() |
| 227 | if request: |
| 228 | request.Unpack(img) |
| 229 | else: |
| 230 | return False, Error(code=ErrorCode.INVALID_PARAMETERS, |
| 231 | reason="port-no-invalid") |
| 232 | |
| 233 | return True, self.adapter.revert_image_update(device, request) |
| 234 | |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 235 | |
| 236 | def self_test(self, device): |
| 237 | return self.adapter.self_test_device(device) |
| 238 | |
| 239 | def delete_device(self, device): |
khenaidoo | 4d4802d | 2018-10-04 21:59:49 -0400 | [diff] [blame] | 240 | d = Device() |
| 241 | if device: |
| 242 | device.Unpack(d) |
khenaidoo | 43c8212 | 2018-11-22 18:38:28 -0500 | [diff] [blame] | 243 | result = self.adapter.delete_device(d) |
| 244 | # return (True, self.adapter.delete_device(d)) |
| 245 | |
| 246 | # Before we return, delete the device specific topic as we will no |
| 247 | # longer receive requests from the Core for that device |
| 248 | kafka_proxy = get_messaging_proxy() |
| 249 | device_topic = kafka_proxy.get_default_topic() + "/" + d.id |
| 250 | kafka_proxy.unsubscribe(topic=device_topic) |
| 251 | |
| 252 | return (True, result) |
khenaidoo | 4d4802d | 2018-10-04 21:59:49 -0400 | [diff] [blame] | 253 | else: |
khenaidoo | fdbad6e | 2018-11-06 22:26:38 -0500 | [diff] [blame] | 254 | return False, Error(code=ErrorCode.INVALID_PARAMETERS, |
| 255 | reason="device-invalid") |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 256 | |
| 257 | def get_device_details(self, device): |
| 258 | return self.adapter.get_device_details(device) |
| 259 | |
| 260 | def update_flows_bulk(self, device, flows, groups): |
khenaidoo | 19d7b63 | 2018-10-30 10:49:50 -0400 | [diff] [blame] | 261 | d = Device() |
| 262 | if device: |
| 263 | device.Unpack(d) |
| 264 | else: |
khenaidoo | fdbad6e | 2018-11-06 22:26:38 -0500 | [diff] [blame] | 265 | return False, Error(code=ErrorCode.INVALID_PARAMETERS, |
| 266 | reason="device-invalid") |
khenaidoo | 19d7b63 | 2018-10-30 10:49:50 -0400 | [diff] [blame] | 267 | f = Flows() |
| 268 | if flows: |
| 269 | flows.Unpack(f) |
| 270 | |
| 271 | g = FlowGroups() |
| 272 | if groups: |
| 273 | groups.Unpack(g) |
| 274 | |
| 275 | return (True, self.adapter.update_flows_bulk(d, f, g)) |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 276 | |
| 277 | def update_flows_incrementally(self, device, flow_changes, group_changes): |
khenaidoo | 19d7b63 | 2018-10-30 10:49:50 -0400 | [diff] [blame] | 278 | d = Device() |
| 279 | if device: |
| 280 | device.Unpack(d) |
| 281 | else: |
khenaidoo | fdbad6e | 2018-11-06 22:26:38 -0500 | [diff] [blame] | 282 | return False, Error(code=ErrorCode.INVALID_PARAMETERS, |
| 283 | reason="device-invalid") |
khenaidoo | 19d7b63 | 2018-10-30 10:49:50 -0400 | [diff] [blame] | 284 | f = FlowChanges() |
| 285 | if flow_changes: |
| 286 | flow_changes.Unpack(f) |
| 287 | |
| 288 | g = FlowGroupChanges() |
| 289 | if group_changes: |
| 290 | group_changes.Unpack(g) |
| 291 | |
| 292 | return (True, self.adapter.update_flows_incrementally(d, f, g)) |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 293 | |
| 294 | def suppress_alarm(self, filter): |
| 295 | return self.adapter.suppress_alarm(filter) |
| 296 | |
| 297 | def unsuppress_alarm(self, filter): |
| 298 | return self.adapter.unsuppress_alarm(filter) |
| 299 | |
khenaidoo | 6fdf0ba | 2018-11-02 14:38:33 -0400 | [diff] [blame] | 300 | def process_inter_adapter_message(self, msg): |
| 301 | m = InterAdapterMessage() |
| 302 | if msg: |
| 303 | msg.Unpack(m) |
| 304 | else: |
khenaidoo | fdbad6e | 2018-11-06 22:26:38 -0500 | [diff] [blame] | 305 | return False, Error(code=ErrorCode.INVALID_PARAMETERS, |
| 306 | reason="msg-invalid") |
khenaidoo | 6fdf0ba | 2018-11-02 14:38:33 -0400 | [diff] [blame] | 307 | |
| 308 | return (True, self.adapter.process_inter_adapter_message(m)) |
khenaidoo | fdbad6e | 2018-11-06 22:26:38 -0500 | [diff] [blame] | 309 | |
| 310 | |
| 311 | def receive_packet_out(self, deviceId, outPort, packet): |
| 312 | d_id = StrType() |
| 313 | if deviceId: |
| 314 | deviceId.Unpack(d_id) |
| 315 | else: |
| 316 | return False, Error(code=ErrorCode.INVALID_PARAMETERS, |
| 317 | reason="deviceid-invalid") |
| 318 | |
khenaidoo | 2ccd7f4 | 2019-01-24 14:32:19 -0500 | [diff] [blame^] | 319 | op = IntType() |
khenaidoo | fdbad6e | 2018-11-06 22:26:38 -0500 | [diff] [blame] | 320 | if outPort: |
| 321 | outPort.Unpack(op) |
| 322 | else: |
| 323 | return False, Error(code=ErrorCode.INVALID_PARAMETERS, |
| 324 | reason="outport-invalid") |
| 325 | |
| 326 | p = ofp_packet_out() |
| 327 | if packet: |
| 328 | packet.Unpack(p) |
| 329 | else: |
| 330 | return False, Error(code=ErrorCode.INVALID_PARAMETERS, |
| 331 | reason="packet-invalid") |
| 332 | |
| 333 | return (True, self.adapter.receive_packet_out(d_id, op, p)) |
| 334 | |