Kent Hagerman | 45a13e4 | 2020-04-13 12:23:50 -0400 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2020-present Open Networking Foundation |
| 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 | package event |
| 18 | |
| 19 | import ( |
| 20 | "encoding/hex" |
| 21 | "github.com/golang/protobuf/ptypes/empty" |
| 22 | "github.com/opencord/voltha-lib-go/v3/pkg/log" |
| 23 | "github.com/opencord/voltha-protos/v3/go/openflow_13" |
| 24 | "github.com/opencord/voltha-protos/v3/go/voltha" |
| 25 | "sync" |
| 26 | ) |
| 27 | |
| 28 | type Manager struct { |
| 29 | packetInQueue chan openflow_13.PacketIn |
| 30 | packetInQueueDone chan bool |
| 31 | changeEventQueue chan openflow_13.ChangeEvent |
| 32 | changeEventQueueDone chan bool |
| 33 | } |
| 34 | |
| 35 | func NewManager() *Manager { |
| 36 | return &Manager{ |
| 37 | packetInQueue: make(chan openflow_13.PacketIn, 100), |
| 38 | packetInQueueDone: make(chan bool, 1), |
| 39 | changeEventQueue: make(chan openflow_13.ChangeEvent, 100), |
| 40 | changeEventQueueDone: make(chan bool, 1), |
| 41 | } |
| 42 | } |
| 43 | |
| 44 | func (q *Manager) SendPacketIn(deviceID string, transationID string, packet *openflow_13.OfpPacketIn) { |
| 45 | // TODO: Augment the OF PacketIn to include the transactionId |
| 46 | packetIn := openflow_13.PacketIn{Id: deviceID, PacketIn: packet} |
| 47 | logger.Debugw("SendPacketIn", log.Fields{"packetIn": packetIn}) |
| 48 | q.packetInQueue <- packetIn |
| 49 | } |
| 50 | |
| 51 | type callTracker struct { |
| 52 | failedPacket interface{} |
| 53 | } |
| 54 | type streamTracker struct { |
| 55 | calls map[string]*callTracker |
| 56 | sync.Mutex |
| 57 | } |
| 58 | |
| 59 | var streamingTracker = &streamTracker{calls: make(map[string]*callTracker)} |
| 60 | |
| 61 | func (q *Manager) getStreamingTracker(method string, done chan<- bool) *callTracker { |
| 62 | streamingTracker.Lock() |
| 63 | defer streamingTracker.Unlock() |
| 64 | if _, ok := streamingTracker.calls[method]; ok { |
| 65 | // bail out the other packet in thread |
| 66 | logger.Debugf("%s streaming call already running. Exiting it", method) |
| 67 | done <- true |
| 68 | logger.Debugf("Last %s exited. Continuing ...", method) |
| 69 | } else { |
| 70 | streamingTracker.calls[method] = &callTracker{failedPacket: nil} |
| 71 | } |
| 72 | return streamingTracker.calls[method] |
| 73 | } |
| 74 | |
| 75 | func (q *Manager) flushFailedPackets(tracker *callTracker) error { |
| 76 | if tracker.failedPacket != nil { |
| 77 | switch tracker.failedPacket.(type) { |
| 78 | case openflow_13.PacketIn: |
| 79 | logger.Debug("Enqueueing last failed packetIn") |
| 80 | q.packetInQueue <- tracker.failedPacket.(openflow_13.PacketIn) |
| 81 | case openflow_13.ChangeEvent: |
| 82 | logger.Debug("Enqueueing last failed changeEvent") |
| 83 | q.changeEventQueue <- tracker.failedPacket.(openflow_13.ChangeEvent) |
| 84 | } |
| 85 | } |
| 86 | return nil |
| 87 | } |
| 88 | |
| 89 | // ReceivePacketsIn receives packets from adapter |
| 90 | func (q *Manager) ReceivePacketsIn(_ *empty.Empty, packetsIn voltha.VolthaService_ReceivePacketsInServer) error { |
| 91 | var streamingTracker = q.getStreamingTracker("ReceivePacketsIn", q.packetInQueueDone) |
| 92 | logger.Debugw("ReceivePacketsIn-request", log.Fields{"packetsIn": packetsIn}) |
| 93 | |
| 94 | err := q.flushFailedPackets(streamingTracker) |
| 95 | if err != nil { |
| 96 | logger.Errorw("unable-to-flush-failed-packets", log.Fields{"error": err}) |
| 97 | } |
| 98 | |
| 99 | loop: |
| 100 | for { |
| 101 | select { |
| 102 | case packet := <-q.packetInQueue: |
| 103 | logger.Debugw("sending-packet-in", log.Fields{ |
| 104 | "packet": hex.EncodeToString(packet.PacketIn.Data), |
| 105 | }) |
| 106 | if err := packetsIn.Send(&packet); err != nil { |
| 107 | logger.Errorw("failed-to-send-packet", log.Fields{"error": err}) |
| 108 | // save the last failed packet in |
| 109 | streamingTracker.failedPacket = packet |
| 110 | } else { |
| 111 | if streamingTracker.failedPacket != nil { |
| 112 | // reset last failed packet saved to avoid flush |
| 113 | streamingTracker.failedPacket = nil |
| 114 | } |
| 115 | } |
| 116 | case <-q.packetInQueueDone: |
| 117 | logger.Debug("Another ReceivePacketsIn running. Bailing out ...") |
| 118 | break loop |
| 119 | } |
| 120 | } |
| 121 | |
| 122 | //TODO: Find an elegant way to get out of the above loop when the Core is stopped |
| 123 | return nil |
| 124 | } |
| 125 | |
| 126 | func (q *Manager) SendChangeEvent(deviceID string, portStatus *openflow_13.OfpPortStatus) { |
| 127 | // TODO: validate the type of portStatus parameter |
| 128 | //if _, ok := portStatus.(*openflow_13.OfpPortStatus); ok { |
| 129 | //} |
| 130 | event := openflow_13.ChangeEvent{Id: deviceID, Event: &openflow_13.ChangeEvent_PortStatus{PortStatus: portStatus}} |
| 131 | logger.Debugw("SendChangeEvent", log.Fields{"event": event}) |
| 132 | q.changeEventQueue <- event |
| 133 | } |
| 134 | |
| 135 | // ReceiveChangeEvents receives change in events |
| 136 | func (q *Manager) ReceiveChangeEvents(_ *empty.Empty, changeEvents voltha.VolthaService_ReceiveChangeEventsServer) error { |
| 137 | var streamingTracker = q.getStreamingTracker("ReceiveChangeEvents", q.changeEventQueueDone) |
| 138 | logger.Debugw("ReceiveChangeEvents-request", log.Fields{"changeEvents": changeEvents}) |
| 139 | |
| 140 | err := q.flushFailedPackets(streamingTracker) |
| 141 | if err != nil { |
| 142 | logger.Errorw("unable-to-flush-failed-packets", log.Fields{"error": err}) |
| 143 | } |
| 144 | |
| 145 | loop: |
| 146 | for { |
| 147 | select { |
| 148 | // Dequeue a change event |
| 149 | case event := <-q.changeEventQueue: |
| 150 | logger.Debugw("sending-change-event", log.Fields{"event": event}) |
| 151 | if err := changeEvents.Send(&event); err != nil { |
| 152 | logger.Errorw("failed-to-send-change-event", log.Fields{"error": err}) |
| 153 | // save last failed changeevent |
| 154 | streamingTracker.failedPacket = event |
| 155 | } else { |
| 156 | if streamingTracker.failedPacket != nil { |
| 157 | // reset last failed event saved on success to avoid flushing |
| 158 | streamingTracker.failedPacket = nil |
| 159 | } |
| 160 | } |
| 161 | case <-q.changeEventQueueDone: |
| 162 | logger.Debug("Another ReceiveChangeEvents already running. Bailing out ...") |
| 163 | break loop |
| 164 | } |
| 165 | } |
| 166 | |
| 167 | return nil |
| 168 | } |
| 169 | |
| 170 | func (q *Manager) GetChangeEventsQueueForTest() <-chan openflow_13.ChangeEvent { |
| 171 | return q.changeEventQueue |
| 172 | } |