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