Zsolt Haraszti | 023ea7c | 2016-10-16 19:30:34 -0700 | [diff] [blame] | 1 | # |
Zsolt Haraszti | 3eb27a5 | 2017-01-03 21:56:48 -0800 | [diff] [blame] | 2 | # Copyright 2017 the original author or authors. |
Zsolt Haraszti | 023ea7c | 2016-10-16 19:30:34 -0700 | [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 | """ |
| 18 | The gRPC client layer for the OpenFlow agent |
| 19 | """ |
Zsolt Haraszti | 2bdb6b3 | 2016-11-03 16:56:17 -0700 | [diff] [blame] | 20 | from Queue import Queue, Empty |
alshabib | 06b449c | 2017-01-15 17:33:16 -0600 | [diff] [blame] | 21 | import os |
Zsolt Haraszti | cd22adc | 2016-10-25 00:13:06 -0700 | [diff] [blame] | 22 | |
Zsolt Haraszti | 2bdb6b3 | 2016-11-03 16:56:17 -0700 | [diff] [blame] | 23 | from grpc import StatusCode |
| 24 | from grpc._channel import _Rendezvous |
Zsolt Haraszti | cd22adc | 2016-10-25 00:13:06 -0700 | [diff] [blame] | 25 | from structlog import get_logger |
| 26 | from twisted.internet import reactor |
Zsolt Haraszti | 023ea7c | 2016-10-16 19:30:34 -0700 | [diff] [blame] | 27 | from twisted.internet import threads |
Zsolt Haraszti | cd22adc | 2016-10-25 00:13:06 -0700 | [diff] [blame] | 28 | from twisted.internet.defer import inlineCallbacks, returnValue, DeferredQueue |
Zsolt Haraszti | 023ea7c | 2016-10-16 19:30:34 -0700 | [diff] [blame] | 29 | |
Koray Kokten | 8592a23 | 2018-08-27 07:41:14 +0000 | [diff] [blame] | 30 | from protos.voltha_pb2 import ID, VolthaLocalServiceStub, FlowTableUpdate, MeterModUpdate, \ |
Jonathan Hart | 398e407 | 2018-05-30 16:54:00 -0700 | [diff] [blame] | 31 | FlowGroupTableUpdate, PacketOut |
| 32 | from protos.logical_device_pb2 import LogicalPortId |
Zsolt Haraszti | 7eeb2b3 | 2016-11-06 14:04:55 -0800 | [diff] [blame] | 33 | from google.protobuf import empty_pb2 |
Zsolt Haraszti | cd22adc | 2016-10-25 00:13:06 -0700 | [diff] [blame] | 34 | |
| 35 | |
Zsolt Haraszti | 023ea7c | 2016-10-16 19:30:34 -0700 | [diff] [blame] | 36 | class GrpcClient(object): |
| 37 | |
Richard Jankowski | db9a86e | 2018-09-17 13:33:29 -0400 | [diff] [blame] | 38 | def __init__(self, connection_manager, channel, grpc_timeout): |
Zsolt Haraszti | cd22adc | 2016-10-25 00:13:06 -0700 | [diff] [blame] | 39 | |
Zack Williams | 0ad0a39 | 2018-11-14 10:41:08 -0700 | [diff] [blame] | 40 | self.log = get_logger() |
| 41 | |
Zsolt Haraszti | cd22adc | 2016-10-25 00:13:06 -0700 | [diff] [blame] | 42 | self.connection_manager = connection_manager |
Zsolt Haraszti | 023ea7c | 2016-10-16 19:30:34 -0700 | [diff] [blame] | 43 | self.channel = channel |
Richard Jankowski | db9a86e | 2018-09-17 13:33:29 -0400 | [diff] [blame] | 44 | self.grpc_timeout = grpc_timeout |
Zsolt Haraszti | 6686203 | 2016-11-28 14:28:39 -0800 | [diff] [blame] | 45 | self.local_stub = VolthaLocalServiceStub(channel) |
Zsolt Haraszti | 023ea7c | 2016-10-16 19:30:34 -0700 | [diff] [blame] | 46 | |
Zsolt Haraszti | 2bdb6b3 | 2016-11-03 16:56:17 -0700 | [diff] [blame] | 47 | self.stopped = False |
| 48 | |
Zsolt Haraszti | cd22adc | 2016-10-25 00:13:06 -0700 | [diff] [blame] | 49 | self.packet_out_queue = Queue() # queue to send out PacketOut msgs |
| 50 | self.packet_in_queue = DeferredQueue() # queue to receive PacketIn |
Zsolt Haraszti | 217a12e | 2016-12-19 16:37:55 -0800 | [diff] [blame] | 51 | self.change_event_queue = DeferredQueue() # queue change events |
Zsolt Haraszti | 2bdb6b3 | 2016-11-03 16:56:17 -0700 | [diff] [blame] | 52 | |
| 53 | def start(self): |
Zack Williams | 0ad0a39 | 2018-11-14 10:41:08 -0700 | [diff] [blame] | 54 | self.log.debug('starting', grpc_timeout=self.grpc_timeout) |
Zsolt Haraszti | cd22adc | 2016-10-25 00:13:06 -0700 | [diff] [blame] | 55 | self.start_packet_out_stream() |
| 56 | self.start_packet_in_stream() |
Zsolt Haraszti | 217a12e | 2016-12-19 16:37:55 -0800 | [diff] [blame] | 57 | self.start_change_event_in_stream() |
Zsolt Haraszti | cd22adc | 2016-10-25 00:13:06 -0700 | [diff] [blame] | 58 | reactor.callLater(0, self.packet_in_forwarder_loop) |
Zsolt Haraszti | 217a12e | 2016-12-19 16:37:55 -0800 | [diff] [blame] | 59 | reactor.callLater(0, self.change_event_processing_loop) |
Zack Williams | 0ad0a39 | 2018-11-14 10:41:08 -0700 | [diff] [blame] | 60 | self.log.info('started') |
Zsolt Haraszti | 2bdb6b3 | 2016-11-03 16:56:17 -0700 | [diff] [blame] | 61 | return self |
| 62 | |
| 63 | def stop(self): |
Zack Williams | 0ad0a39 | 2018-11-14 10:41:08 -0700 | [diff] [blame] | 64 | self.log.debug('stopping') |
Zsolt Haraszti | 2bdb6b3 | 2016-11-03 16:56:17 -0700 | [diff] [blame] | 65 | self.stopped = True |
Zack Williams | 0ad0a39 | 2018-11-14 10:41:08 -0700 | [diff] [blame] | 66 | self.log.info('stopped') |
Zsolt Haraszti | cd22adc | 2016-10-25 00:13:06 -0700 | [diff] [blame] | 67 | |
| 68 | def start_packet_out_stream(self): |
| 69 | |
| 70 | def packet_generator(): |
| 71 | while 1: |
Zsolt Haraszti | 2bdb6b3 | 2016-11-03 16:56:17 -0700 | [diff] [blame] | 72 | try: |
| 73 | packet = self.packet_out_queue.get(block=True, timeout=1.0) |
| 74 | except Empty: |
| 75 | if self.stopped: |
| 76 | return |
| 77 | else: |
| 78 | yield packet |
Zsolt Haraszti | cd22adc | 2016-10-25 00:13:06 -0700 | [diff] [blame] | 79 | |
| 80 | def stream_packets_out(): |
| 81 | generator = packet_generator() |
alshabib | 06b449c | 2017-01-15 17:33:16 -0600 | [diff] [blame] | 82 | try: |
| 83 | self.local_stub.StreamPacketsOut(generator) |
| 84 | except _Rendezvous, e: |
Zack Williams | 0ad0a39 | 2018-11-14 10:41:08 -0700 | [diff] [blame] | 85 | self.log.error('grpc-exception', status=e.code()) |
alshabib | 06b449c | 2017-01-15 17:33:16 -0600 | [diff] [blame] | 86 | if e.code() == StatusCode.UNAVAILABLE: |
| 87 | os.system("kill -15 {}".format(os.getpid())) |
Zsolt Haraszti | cd22adc | 2016-10-25 00:13:06 -0700 | [diff] [blame] | 88 | |
| 89 | reactor.callInThread(stream_packets_out) |
| 90 | |
| 91 | def start_packet_in_stream(self): |
| 92 | |
| 93 | def receive_packet_in_stream(): |
Zsolt Haraszti | 6686203 | 2016-11-28 14:28:39 -0800 | [diff] [blame] | 94 | streaming_rpc_method = self.local_stub.ReceivePacketsIn |
Zsolt Haraszti | 9ed5429 | 2017-01-09 18:28:32 -0800 | [diff] [blame] | 95 | iterator = streaming_rpc_method(empty_pb2.Empty()) |
alshabib | 06b449c | 2017-01-15 17:33:16 -0600 | [diff] [blame] | 96 | try: |
| 97 | for packet_in in iterator: |
| 98 | reactor.callFromThread(self.packet_in_queue.put, |
| 99 | packet_in) |
Zack Williams | 0ad0a39 | 2018-11-14 10:41:08 -0700 | [diff] [blame] | 100 | self.log.debug('enqued-packet-in', |
alshabib | 06b449c | 2017-01-15 17:33:16 -0600 | [diff] [blame] | 101 | packet_in=packet_in, |
| 102 | queue_len=len(self.packet_in_queue.pending)) |
| 103 | except _Rendezvous, e: |
Zack Williams | 0ad0a39 | 2018-11-14 10:41:08 -0700 | [diff] [blame] | 104 | self.log.error('grpc-exception', status=e.code()) |
alshabib | 06b449c | 2017-01-15 17:33:16 -0600 | [diff] [blame] | 105 | if e.code() == StatusCode.UNAVAILABLE: |
| 106 | os.system("kill -15 {}".format(os.getpid())) |
Zsolt Haraszti | cd22adc | 2016-10-25 00:13:06 -0700 | [diff] [blame] | 107 | |
| 108 | reactor.callInThread(receive_packet_in_stream) |
| 109 | |
Zsolt Haraszti | 217a12e | 2016-12-19 16:37:55 -0800 | [diff] [blame] | 110 | def start_change_event_in_stream(self): |
| 111 | |
| 112 | def receive_change_events(): |
| 113 | streaming_rpc_method = self.local_stub.ReceiveChangeEvents |
Zsolt Haraszti | 9ed5429 | 2017-01-09 18:28:32 -0800 | [diff] [blame] | 114 | iterator = streaming_rpc_method(empty_pb2.Empty()) |
alshabib | 06b449c | 2017-01-15 17:33:16 -0600 | [diff] [blame] | 115 | try: |
| 116 | for event in iterator: |
| 117 | reactor.callFromThread(self.change_event_queue.put, event) |
Zack Williams | 0ad0a39 | 2018-11-14 10:41:08 -0700 | [diff] [blame] | 118 | self.log.debug('enqued-change-event', |
alshabib | 06b449c | 2017-01-15 17:33:16 -0600 | [diff] [blame] | 119 | change_event=event, |
| 120 | queue_len=len(self.change_event_queue.pending)) |
| 121 | except _Rendezvous, e: |
Zack Williams | 0ad0a39 | 2018-11-14 10:41:08 -0700 | [diff] [blame] | 122 | self.log.error('grpc-exception', status=e.code()) |
alshabib | 06b449c | 2017-01-15 17:33:16 -0600 | [diff] [blame] | 123 | if e.code() == StatusCode.UNAVAILABLE: |
| 124 | os.system("kill -15 {}".format(os.getpid())) |
Zsolt Haraszti | 217a12e | 2016-12-19 16:37:55 -0800 | [diff] [blame] | 125 | |
| 126 | reactor.callInThread(receive_change_events) |
| 127 | |
| 128 | @inlineCallbacks |
| 129 | def change_event_processing_loop(self): |
| 130 | while True: |
| 131 | try: |
| 132 | event = yield self.change_event_queue.get() |
| 133 | device_id = event.id |
| 134 | self.connection_manager.forward_change_event(device_id, event) |
| 135 | except Exception, e: |
Zack Williams | 0ad0a39 | 2018-11-14 10:41:08 -0700 | [diff] [blame] | 136 | self.log.exception('failed-in-packet-in-handler', e=e) |
Zsolt Haraszti | 217a12e | 2016-12-19 16:37:55 -0800 | [diff] [blame] | 137 | if self.stopped: |
| 138 | break |
| 139 | |
Zsolt Haraszti | 023ea7c | 2016-10-16 19:30:34 -0700 | [diff] [blame] | 140 | @inlineCallbacks |
Zsolt Haraszti | cd22adc | 2016-10-25 00:13:06 -0700 | [diff] [blame] | 141 | def packet_in_forwarder_loop(self): |
| 142 | while True: |
| 143 | packet_in = yield self.packet_in_queue.get() |
| 144 | device_id = packet_in.id |
| 145 | ofp_packet_in = packet_in.packet_in |
| 146 | self.connection_manager.forward_packet_in(device_id, ofp_packet_in) |
Zsolt Haraszti | 2bdb6b3 | 2016-11-03 16:56:17 -0700 | [diff] [blame] | 147 | if self.stopped: |
| 148 | break |
Zsolt Haraszti | cd22adc | 2016-10-25 00:13:06 -0700 | [diff] [blame] | 149 | |
| 150 | def send_packet_out(self, device_id, packet_out): |
| 151 | packet_out = PacketOut(id=device_id, packet_out=packet_out) |
| 152 | self.packet_out_queue.put(packet_out) |
| 153 | |
| 154 | @inlineCallbacks |
Jonathan Hart | 8d21c32 | 2018-04-17 07:42:02 -0700 | [diff] [blame] | 155 | def get_port(self, device_id, port_id): |
| 156 | req = LogicalPortId(id=device_id, port_id=port_id) |
| 157 | res = yield threads.deferToThread( |
Richard Jankowski | db9a86e | 2018-09-17 13:33:29 -0400 | [diff] [blame] | 158 | self.local_stub.GetLogicalDevicePort, req, timeout=self.grpc_timeout) |
Jonathan Hart | 8d21c32 | 2018-04-17 07:42:02 -0700 | [diff] [blame] | 159 | returnValue(res) |
| 160 | |
| 161 | @inlineCallbacks |
Zsolt Haraszti | cd22adc | 2016-10-25 00:13:06 -0700 | [diff] [blame] | 162 | def get_port_list(self, device_id): |
Zsolt Haraszti | 023ea7c | 2016-10-16 19:30:34 -0700 | [diff] [blame] | 163 | req = ID(id=device_id) |
| 164 | res = yield threads.deferToThread( |
Richard Jankowski | db9a86e | 2018-09-17 13:33:29 -0400 | [diff] [blame] | 165 | self.local_stub.ListLogicalDevicePorts, req, timeout=self.grpc_timeout) |
Zsolt Haraszti | 023ea7c | 2016-10-16 19:30:34 -0700 | [diff] [blame] | 166 | returnValue(res.items) |
| 167 | |
| 168 | @inlineCallbacks |
Jonathan Hart | 8d21c32 | 2018-04-17 07:42:02 -0700 | [diff] [blame] | 169 | def enable_port(self, device_id, port_id): |
| 170 | req = LogicalPortId( |
| 171 | id=device_id, |
| 172 | port_id=port_id |
| 173 | ) |
| 174 | res = yield threads.deferToThread( |
Richard Jankowski | db9a86e | 2018-09-17 13:33:29 -0400 | [diff] [blame] | 175 | self.local_stub.EnableLogicalDevicePort, req, timeout=self.grpc_timeout) |
Jonathan Hart | 8d21c32 | 2018-04-17 07:42:02 -0700 | [diff] [blame] | 176 | returnValue(res) |
| 177 | |
| 178 | @inlineCallbacks |
| 179 | def disable_port(self, device_id, port_id): |
| 180 | req = LogicalPortId( |
| 181 | id=device_id, |
| 182 | port_id=port_id |
| 183 | ) |
| 184 | res = yield threads.deferToThread( |
Richard Jankowski | db9a86e | 2018-09-17 13:33:29 -0400 | [diff] [blame] | 185 | self.local_stub.DisableLogicalDevicePort, req, timeout=self.grpc_timeout) |
Jonathan Hart | 8d21c32 | 2018-04-17 07:42:02 -0700 | [diff] [blame] | 186 | returnValue(res) |
| 187 | |
| 188 | @inlineCallbacks |
Zsolt Haraszti | cd22adc | 2016-10-25 00:13:06 -0700 | [diff] [blame] | 189 | def get_device_info(self, device_id): |
Zsolt Haraszti | 023ea7c | 2016-10-16 19:30:34 -0700 | [diff] [blame] | 190 | req = ID(id=device_id) |
| 191 | res = yield threads.deferToThread( |
Richard Jankowski | db9a86e | 2018-09-17 13:33:29 -0400 | [diff] [blame] | 192 | self.local_stub.GetLogicalDevice, req, timeout=self.grpc_timeout) |
Zsolt Haraszti | 023ea7c | 2016-10-16 19:30:34 -0700 | [diff] [blame] | 193 | returnValue(res) |
| 194 | |
| 195 | @inlineCallbacks |
Zsolt Haraszti | cd22adc | 2016-10-25 00:13:06 -0700 | [diff] [blame] | 196 | def update_flow_table(self, device_id, flow_mod): |
Zsolt Haraszti | 023ea7c | 2016-10-16 19:30:34 -0700 | [diff] [blame] | 197 | req = FlowTableUpdate( |
| 198 | id=device_id, |
| 199 | flow_mod=flow_mod |
| 200 | ) |
| 201 | res = yield threads.deferToThread( |
Richard Jankowski | db9a86e | 2018-09-17 13:33:29 -0400 | [diff] [blame] | 202 | self.local_stub.UpdateLogicalDeviceFlowTable, req, timeout=self.grpc_timeout) |
Zsolt Haraszti | 023ea7c | 2016-10-16 19:30:34 -0700 | [diff] [blame] | 203 | returnValue(res) |
| 204 | |
| 205 | @inlineCallbacks |
Koray Kokten | 8592a23 | 2018-08-27 07:41:14 +0000 | [diff] [blame] | 206 | def update_meter_mod_table(self, device_id, meter_mod): |
| 207 | req = MeterModUpdate( |
| 208 | id=device_id, |
| 209 | meter_mod=meter_mod |
| 210 | ) |
| 211 | res = yield threads.deferToThread( |
| 212 | self.local_stub.UpdateLogicalDeviceMeterTable, req) |
| 213 | returnValue(res) |
| 214 | |
| 215 | @inlineCallbacks |
Zsolt Haraszti | cd22adc | 2016-10-25 00:13:06 -0700 | [diff] [blame] | 216 | def update_group_table(self, device_id, group_mod): |
Zsolt Haraszti | 6686203 | 2016-11-28 14:28:39 -0800 | [diff] [blame] | 217 | req = FlowGroupTableUpdate( |
Zsolt Haraszti | 8a77438 | 2016-10-24 18:25:54 -0700 | [diff] [blame] | 218 | id=device_id, |
| 219 | group_mod=group_mod |
| 220 | ) |
| 221 | res = yield threads.deferToThread( |
Richard Jankowski | db9a86e | 2018-09-17 13:33:29 -0400 | [diff] [blame] | 222 | self.local_stub.UpdateLogicalDeviceFlowGroupTable, req, timeout=self.grpc_timeout) |
Zsolt Haraszti | 8a77438 | 2016-10-24 18:25:54 -0700 | [diff] [blame] | 223 | returnValue(res) |
| 224 | |
| 225 | @inlineCallbacks |
Zsolt Haraszti | cd22adc | 2016-10-25 00:13:06 -0700 | [diff] [blame] | 226 | def list_flows(self, device_id): |
Zsolt Haraszti | 023ea7c | 2016-10-16 19:30:34 -0700 | [diff] [blame] | 227 | req = ID(id=device_id) |
| 228 | res = yield threads.deferToThread( |
Richard Jankowski | db9a86e | 2018-09-17 13:33:29 -0400 | [diff] [blame] | 229 | self.local_stub.ListLogicalDeviceFlows, req, timeout=self.grpc_timeout) |
Zsolt Haraszti | 023ea7c | 2016-10-16 19:30:34 -0700 | [diff] [blame] | 230 | returnValue(res.items) |
Zsolt Haraszti | 8a77438 | 2016-10-24 18:25:54 -0700 | [diff] [blame] | 231 | |
| 232 | @inlineCallbacks |
Zsolt Haraszti | cd22adc | 2016-10-25 00:13:06 -0700 | [diff] [blame] | 233 | def list_groups(self, device_id): |
Zsolt Haraszti | 8a77438 | 2016-10-24 18:25:54 -0700 | [diff] [blame] | 234 | req = ID(id=device_id) |
| 235 | res = yield threads.deferToThread( |
Richard Jankowski | db9a86e | 2018-09-17 13:33:29 -0400 | [diff] [blame] | 236 | self.local_stub.ListLogicalDeviceFlowGroups, req, timeout=self.grpc_timeout) |
Zsolt Haraszti | 8a77438 | 2016-10-24 18:25:54 -0700 | [diff] [blame] | 237 | returnValue(res.items) |
Nicolas Palpacuer | fd7b8b1 | 2018-06-15 13:58:06 -0400 | [diff] [blame] | 238 | |
| 239 | @inlineCallbacks |
| 240 | def list_ports(self, device_id): |
| 241 | req = ID(id=device_id) |
| 242 | res = yield threads.deferToThread( |
Richard Jankowski | db9a86e | 2018-09-17 13:33:29 -0400 | [diff] [blame] | 243 | self.local_stub.ListLogicalDevicePorts, req, timeout=self.grpc_timeout) |
| 244 | returnValue(res.items) |
| 245 | |
| 246 | @inlineCallbacks |
| 247 | def list_logical_devices(self): |
| 248 | res = yield threads.deferToThread( |
| 249 | self.local_stub.ListLogicalDevices, empty_pb2.Empty(), timeout=self.grpc_timeout) |
| 250 | returnValue(res.items) |
| 251 | |
| 252 | @inlineCallbacks |
Nicolas Palpacuer | 75ba77f | 2018-08-27 17:26:57 -0400 | [diff] [blame] | 253 | def list_reachable_logical_devices(self): |
| 254 | res = yield threads.deferToThread( |
| 255 | self.local_stub.ListReachableLogicalDevices, empty_pb2.Empty(), |
| 256 | timeout=self.grpc_timeout) |
| 257 | returnValue(res.items) |
| 258 | |
| 259 | @inlineCallbacks |
Richard Jankowski | db9a86e | 2018-09-17 13:33:29 -0400 | [diff] [blame] | 260 | def subscribe(self, subscriber): |
| 261 | res = yield threads.deferToThread( |
| 262 | self.local_stub.Subscribe, subscriber, timeout=self.grpc_timeout) |
| 263 | returnValue(res) |
Koray Kokten | 8592a23 | 2018-08-27 07:41:14 +0000 | [diff] [blame] | 264 | |
Koray Kokten | 8592a23 | 2018-08-27 07:41:14 +0000 | [diff] [blame] | 265 | @inlineCallbacks |
| 266 | def get_meter_stats(self, device_id): |
| 267 | req = ID(id=device_id) |
| 268 | res = yield threads.deferToThread( |
| 269 | self.local_stub.GetMeterStatsOfLogicalDevice, req) |
| 270 | returnValue(res.items) |