khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 1 | # |
khenaidoo | 6fdf0ba | 2018-11-02 14:38:33 -0400 | [diff] [blame] | 2 | # Copyright 2018 the original author or authors. |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 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 | Agent to play gateway between CORE and an adapter. |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 19 | """ |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 20 | import structlog |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 21 | from google.protobuf.message import Message |
khenaidoo | 6fdf0ba | 2018-11-02 14:38:33 -0400 | [diff] [blame] | 22 | from twisted.internet.defer import inlineCallbacks, returnValue |
| 23 | |
| 24 | from adapters.kafka.container_proxy import ContainerProxy |
| 25 | from adapters.protos.common_pb2 import ID, ConnectStatus, OperStatus |
| 26 | from adapters.protos.core_adapter_pb2 import StrType, BoolType, IntType |
| 27 | from adapters.protos.device_pb2 import Device, Ports |
| 28 | from adapters.protos.voltha_pb2 import CoreInstance |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 29 | |
| 30 | log = structlog.get_logger() |
| 31 | |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 32 | |
khenaidoo | 6fdf0ba | 2018-11-02 14:38:33 -0400 | [diff] [blame] | 33 | class CoreProxy(ContainerProxy): |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 34 | |
| 35 | def __init__(self, kafka_proxy, core_topic, my_listening_topic): |
khenaidoo | 6fdf0ba | 2018-11-02 14:38:33 -0400 | [diff] [blame] | 36 | super(CoreProxy, self).__init__(kafka_proxy, core_topic, |
| 37 | my_listening_topic) |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 38 | |
khenaidoo | 6fdf0ba | 2018-11-02 14:38:33 -0400 | [diff] [blame] | 39 | @ContainerProxy.wrap_request(CoreInstance) |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 40 | @inlineCallbacks |
khenaidoo | 91ecfd6 | 2018-11-04 17:13:42 -0500 | [diff] [blame^] | 41 | def register(self, adapter, deviceTypes): |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 42 | log.debug("register") |
| 43 | try: |
khenaidoo | 91ecfd6 | 2018-11-04 17:13:42 -0500 | [diff] [blame^] | 44 | res = yield self.invoke(rpc="Register", |
| 45 | adapter=adapter, |
| 46 | deviceTypes=deviceTypes) |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 47 | log.info("registration-returned", res=res) |
| 48 | returnValue(res) |
| 49 | except Exception as e: |
| 50 | log.exception("registration-exception", e=e) |
| 51 | raise |
| 52 | |
khenaidoo | 6fdf0ba | 2018-11-02 14:38:33 -0400 | [diff] [blame] | 53 | @ContainerProxy.wrap_request(Device) |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 54 | @inlineCallbacks |
| 55 | def get_device(self, device_id): |
| 56 | log.debug("get-device") |
| 57 | id = ID() |
| 58 | id.id = device_id |
| 59 | res = yield self.invoke(rpc="GetDevice", device_id=id) |
| 60 | returnValue(res) |
| 61 | |
khenaidoo | 6fdf0ba | 2018-11-02 14:38:33 -0400 | [diff] [blame] | 62 | @ContainerProxy.wrap_request(Device) |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 63 | @inlineCallbacks |
| 64 | def get_child_device(self, parent_device_id, **kwargs): |
| 65 | raise NotImplementedError() |
| 66 | |
khenaidoo | 6fdf0ba | 2018-11-02 14:38:33 -0400 | [diff] [blame] | 67 | @ContainerProxy.wrap_request(Ports) |
khenaidoo | 92e62c5 | 2018-10-03 14:02:54 -0400 | [diff] [blame] | 68 | @inlineCallbacks |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 69 | def get_ports(self, device_id, port_type): |
khenaidoo | 92e62c5 | 2018-10-03 14:02:54 -0400 | [diff] [blame] | 70 | id = ID() |
| 71 | id.id = device_id |
| 72 | p_type = IntType() |
| 73 | p_type.val = port_type |
| 74 | res = yield self.invoke(rpc="GetPorts", |
| 75 | device_id=id, |
| 76 | port_type=p_type) |
| 77 | returnValue(res) |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 78 | |
| 79 | def get_child_devices(self, parent_device_id): |
| 80 | raise NotImplementedError() |
| 81 | |
| 82 | def get_child_device_with_proxy_address(self, proxy_address): |
| 83 | raise NotImplementedError() |
| 84 | |
| 85 | def _to_proto(self, **kwargs): |
| 86 | encoded = {} |
khenaidoo | 6fdf0ba | 2018-11-02 14:38:33 -0400 | [diff] [blame] | 87 | for k, v in kwargs.iteritems(): |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 88 | if isinstance(v, Message): |
| 89 | encoded[k] = v |
| 90 | elif type(v) == int: |
| 91 | i_proto = IntType() |
| 92 | i_proto.val = v |
| 93 | encoded[k] = i_proto |
| 94 | elif type(v) == str: |
| 95 | s_proto = StrType() |
| 96 | s_proto.val = v |
| 97 | encoded[k] = s_proto |
| 98 | elif type(v) == bool: |
| 99 | b_proto = BoolType() |
| 100 | b_proto.val = v |
| 101 | encoded[k] = b_proto |
| 102 | return encoded |
| 103 | |
khenaidoo | 6fdf0ba | 2018-11-02 14:38:33 -0400 | [diff] [blame] | 104 | @ContainerProxy.wrap_request(None) |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 105 | @inlineCallbacks |
| 106 | def child_device_detected(self, |
| 107 | parent_device_id, |
| 108 | parent_port_no, |
| 109 | child_device_type, |
| 110 | channel_id, |
| 111 | **kw): |
| 112 | id = ID() |
| 113 | id.id = parent_device_id |
| 114 | ppn = IntType() |
| 115 | ppn.val = parent_port_no |
| 116 | cdt = StrType() |
| 117 | cdt.val = child_device_type |
| 118 | channel = IntType() |
| 119 | channel.val = channel_id |
| 120 | |
| 121 | args = self._to_proto(**kw) |
| 122 | res = yield self.invoke(rpc="ChildDeviceDetected", |
| 123 | parent_device_id=id, |
khenaidoo | 6fdf0ba | 2018-11-02 14:38:33 -0400 | [diff] [blame] | 124 | parent_port_no=ppn, |
| 125 | child_device_type=cdt, |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 126 | channel_id=channel, |
| 127 | **args) |
| 128 | returnValue(res) |
| 129 | |
khenaidoo | 6fdf0ba | 2018-11-02 14:38:33 -0400 | [diff] [blame] | 130 | @ContainerProxy.wrap_request(None) |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 131 | @inlineCallbacks |
| 132 | def device_update(self, device): |
| 133 | log.debug("device_update") |
| 134 | res = yield self.invoke(rpc="DeviceUpdate", device=device) |
| 135 | returnValue(res) |
| 136 | |
| 137 | def child_device_removed(parent_device_id, child_device_id): |
| 138 | raise NotImplementedError() |
| 139 | |
khenaidoo | 6fdf0ba | 2018-11-02 14:38:33 -0400 | [diff] [blame] | 140 | @ContainerProxy.wrap_request(None) |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 141 | @inlineCallbacks |
| 142 | def device_state_update(self, device_id, |
khenaidoo | 6fdf0ba | 2018-11-02 14:38:33 -0400 | [diff] [blame] | 143 | oper_status=None, |
| 144 | connect_status=None): |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 145 | id = ID() |
| 146 | id.id = device_id |
| 147 | o_status = IntType() |
khenaidoo | 6fdf0ba | 2018-11-02 14:38:33 -0400 | [diff] [blame] | 148 | if oper_status or oper_status == OperStatus.UNKNOWN: |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 149 | o_status.val = oper_status |
| 150 | else: |
| 151 | o_status.val = -1 |
| 152 | c_status = IntType() |
khenaidoo | 6fdf0ba | 2018-11-02 14:38:33 -0400 | [diff] [blame] | 153 | if connect_status or connect_status == ConnectStatus.UNKNOWN: |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 154 | c_status.val = connect_status |
| 155 | else: |
| 156 | c_status.val = -1 |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 157 | |
| 158 | res = yield self.invoke(rpc="DeviceStateUpdate", |
| 159 | device_id=id, |
| 160 | oper_status=o_status, |
| 161 | connect_status=c_status) |
| 162 | returnValue(res) |
| 163 | |
khenaidoo | 6fdf0ba | 2018-11-02 14:38:33 -0400 | [diff] [blame] | 164 | @ContainerProxy.wrap_request(None) |
khenaidoo | 4d4802d | 2018-10-04 21:59:49 -0400 | [diff] [blame] | 165 | @inlineCallbacks |
| 166 | def children_state_update(self, device_id, |
khenaidoo | 6fdf0ba | 2018-11-02 14:38:33 -0400 | [diff] [blame] | 167 | oper_status=None, |
| 168 | connect_status=None): |
khenaidoo | 4d4802d | 2018-10-04 21:59:49 -0400 | [diff] [blame] | 169 | id = ID() |
| 170 | id.id = device_id |
| 171 | o_status = IntType() |
khenaidoo | 6fdf0ba | 2018-11-02 14:38:33 -0400 | [diff] [blame] | 172 | if oper_status or oper_status == OperStatus.UNKNOWN: |
khenaidoo | 4d4802d | 2018-10-04 21:59:49 -0400 | [diff] [blame] | 173 | o_status.val = oper_status |
| 174 | else: |
| 175 | o_status.val = -1 |
| 176 | c_status = IntType() |
khenaidoo | 6fdf0ba | 2018-11-02 14:38:33 -0400 | [diff] [blame] | 177 | if connect_status or connect_status == ConnectStatus.UNKNOWN: |
khenaidoo | 4d4802d | 2018-10-04 21:59:49 -0400 | [diff] [blame] | 178 | c_status.val = connect_status |
| 179 | else: |
| 180 | c_status.val = -1 |
| 181 | |
| 182 | res = yield self.invoke(rpc="ChildrenStateUpdate", |
| 183 | device_id=id, |
| 184 | oper_status=o_status, |
| 185 | connect_status=c_status) |
| 186 | returnValue(res) |
| 187 | |
khenaidoo | 6fdf0ba | 2018-11-02 14:38:33 -0400 | [diff] [blame] | 188 | @ContainerProxy.wrap_request(None) |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 189 | @inlineCallbacks |
khenaidoo | 92e62c5 | 2018-10-03 14:02:54 -0400 | [diff] [blame] | 190 | def port_state_update(self, |
| 191 | device_id, |
| 192 | port_type, |
| 193 | port_no, |
| 194 | oper_status): |
| 195 | id = ID() |
| 196 | id.id = device_id |
| 197 | pt = IntType() |
| 198 | pt.val = port_type |
| 199 | pNo = IntType() |
| 200 | pNo.val = port_no |
| 201 | o_status = IntType() |
| 202 | o_status.val = oper_status |
| 203 | |
| 204 | res = yield self.invoke(rpc="PortStateUpdate", |
| 205 | device_id=id, |
| 206 | port_type=pt, |
| 207 | port_no=pNo, |
| 208 | oper_status=o_status) |
| 209 | returnValue(res) |
| 210 | |
khenaidoo | 6fdf0ba | 2018-11-02 14:38:33 -0400 | [diff] [blame] | 211 | @ContainerProxy.wrap_request(None) |
khenaidoo | 92e62c5 | 2018-10-03 14:02:54 -0400 | [diff] [blame] | 212 | @inlineCallbacks |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 213 | def child_devices_state_update(self, parent_device_id, |
| 214 | oper_status=None, |
khenaidoo | 92e62c5 | 2018-10-03 14:02:54 -0400 | [diff] [blame] | 215 | connect_status=None): |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 216 | |
| 217 | id = ID() |
| 218 | id.id = parent_device_id |
| 219 | o_status = IntType() |
khenaidoo | 6fdf0ba | 2018-11-02 14:38:33 -0400 | [diff] [blame] | 220 | if oper_status or oper_status == OperStatus.UNKNOWN: |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 221 | o_status.val = oper_status |
| 222 | else: |
| 223 | o_status.val = -1 |
| 224 | c_status = IntType() |
khenaidoo | 6fdf0ba | 2018-11-02 14:38:33 -0400 | [diff] [blame] | 225 | if connect_status or connect_status == ConnectStatus.UNKNOWN: |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 226 | c_status.val = connect_status |
| 227 | else: |
| 228 | c_status.val = -1 |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 229 | |
| 230 | res = yield self.invoke(rpc="child_devices_state_update", |
| 231 | parent_device_id=id, |
| 232 | oper_status=o_status, |
khenaidoo | 92e62c5 | 2018-10-03 14:02:54 -0400 | [diff] [blame] | 233 | connect_status=c_status) |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 234 | returnValue(res) |
| 235 | |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 236 | def child_devices_removed(parent_device_id): |
| 237 | raise NotImplementedError() |
| 238 | |
khenaidoo | 6fdf0ba | 2018-11-02 14:38:33 -0400 | [diff] [blame] | 239 | @ContainerProxy.wrap_request(None) |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 240 | @inlineCallbacks |
| 241 | def device_pm_config_update(self, device_pm_config, init=False): |
| 242 | log.debug("device_pm_config_update") |
| 243 | b = BoolType() |
| 244 | b.val = init |
| 245 | res = yield self.invoke(rpc="DevicePMConfigUpdate", |
| 246 | device_pm_config=device_pm_config, init=b) |
| 247 | returnValue(res) |
| 248 | |
khenaidoo | 6fdf0ba | 2018-11-02 14:38:33 -0400 | [diff] [blame] | 249 | @ContainerProxy.wrap_request(None) |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 250 | @inlineCallbacks |
| 251 | def port_created(self, device_id, port): |
| 252 | log.debug("port_created") |
| 253 | proto_id = ID() |
| 254 | proto_id.id = device_id |
khenaidoo | 6fdf0ba | 2018-11-02 14:38:33 -0400 | [diff] [blame] | 255 | res = yield self.invoke(rpc="PortCreated", device_id=proto_id, |
| 256 | port=port) |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 257 | returnValue(res) |
| 258 | |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 259 | def port_removed(device_id, port): |
| 260 | raise NotImplementedError() |
| 261 | |
| 262 | def ports_enabled(device_id): |
| 263 | raise NotImplementedError() |
| 264 | |
| 265 | def ports_disabled(device_id): |
| 266 | raise NotImplementedError() |
| 267 | |
| 268 | def ports_oper_status_update(device_id, oper_status): |
| 269 | raise NotImplementedError() |
| 270 | |
| 271 | def image_download_update(img_dnld): |
| 272 | raise NotImplementedError() |
| 273 | |
| 274 | def image_download_deleted(img_dnld): |
| 275 | raise NotImplementedError() |
| 276 | |
| 277 | def packet_in(device_id, egress_port_no, packet): |
| 278 | raise NotImplementedError() |