blob: 21d535f93859ee4b8c8665113f11e9ae532e83c1 [file] [log] [blame]
Kent Hagerman45a13e42020-04-13 12:23:50 -04001/*
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
17package event
18
19import (
Rohan Agrawal31f21802020-06-12 05:38:46 +000020 "context"
Andrea Campanella4afb2f02021-01-29 09:38:57 +010021 "encoding/binary"
Kent Hagerman45a13e42020-04-13 12:23:50 -040022 "encoding/hex"
Kent Hagermanfa9d6d42020-05-25 11:49:40 -040023 "sync"
24
Kent Hagerman45a13e42020-04-13 12:23:50 -040025 "github.com/golang/protobuf/ptypes/empty"
Maninderdfadc982020-10-28 14:04:33 +053026 "github.com/opencord/voltha-lib-go/v4/pkg/log"
27 "github.com/opencord/voltha-protos/v4/go/openflow_13"
28 "github.com/opencord/voltha-protos/v4/go/voltha"
Kent Hagerman45a13e42020-04-13 12:23:50 -040029)
30
31type Manager struct {
32 packetInQueue chan openflow_13.PacketIn
33 packetInQueueDone chan bool
34 changeEventQueue chan openflow_13.ChangeEvent
35 changeEventQueueDone chan bool
36}
37
38func NewManager() *Manager {
39 return &Manager{
40 packetInQueue: make(chan openflow_13.PacketIn, 100),
41 packetInQueueDone: make(chan bool, 1),
42 changeEventQueue: make(chan openflow_13.ChangeEvent, 100),
43 changeEventQueueDone: make(chan bool, 1),
44 }
45}
46
Rohan Agrawal31f21802020-06-12 05:38:46 +000047func (q *Manager) SendPacketIn(ctx context.Context, deviceID string, transationID string, packet *openflow_13.OfpPacketIn) {
Kent Hagerman45a13e42020-04-13 12:23:50 -040048 // TODO: Augment the OF PacketIn to include the transactionId
49 packetIn := openflow_13.PacketIn{Id: deviceID, PacketIn: packet}
Rohan Agrawal31f21802020-06-12 05:38:46 +000050 logger.Debugw(ctx, "SendPacketIn", log.Fields{"packetIn": packetIn})
Kent Hagerman45a13e42020-04-13 12:23:50 -040051 q.packetInQueue <- packetIn
52}
53
54type callTracker struct {
55 failedPacket interface{}
56}
57type streamTracker struct {
58 calls map[string]*callTracker
59 sync.Mutex
60}
61
62var streamingTracker = &streamTracker{calls: make(map[string]*callTracker)}
63
Rohan Agrawal31f21802020-06-12 05:38:46 +000064func (q *Manager) getStreamingTracker(ctx context.Context, method string, done chan<- bool) *callTracker {
Kent Hagerman45a13e42020-04-13 12:23:50 -040065 streamingTracker.Lock()
66 defer streamingTracker.Unlock()
67 if _, ok := streamingTracker.calls[method]; ok {
68 // bail out the other packet in thread
Rohan Agrawal31f21802020-06-12 05:38:46 +000069 logger.Debugf(ctx, "%s streaming call already running. Exiting it", method)
Kent Hagerman45a13e42020-04-13 12:23:50 -040070 done <- true
Rohan Agrawal31f21802020-06-12 05:38:46 +000071 logger.Debugf(ctx, "Last %s exited. Continuing ...", method)
Kent Hagerman45a13e42020-04-13 12:23:50 -040072 } else {
73 streamingTracker.calls[method] = &callTracker{failedPacket: nil}
74 }
75 return streamingTracker.calls[method]
76}
77
Rohan Agrawal31f21802020-06-12 05:38:46 +000078func (q *Manager) flushFailedPackets(ctx context.Context, tracker *callTracker) error {
Kent Hagerman45a13e42020-04-13 12:23:50 -040079 if tracker.failedPacket != nil {
80 switch tracker.failedPacket.(type) {
81 case openflow_13.PacketIn:
Rohan Agrawal31f21802020-06-12 05:38:46 +000082 logger.Debug(ctx, "Enqueueing last failed packetIn")
Kent Hagerman45a13e42020-04-13 12:23:50 -040083 q.packetInQueue <- tracker.failedPacket.(openflow_13.PacketIn)
84 case openflow_13.ChangeEvent:
Rohan Agrawal31f21802020-06-12 05:38:46 +000085 logger.Debug(ctx, "Enqueueing last failed changeEvent")
Kent Hagerman45a13e42020-04-13 12:23:50 -040086 q.changeEventQueue <- tracker.failedPacket.(openflow_13.ChangeEvent)
87 }
88 }
89 return nil
90}
91
92// ReceivePacketsIn receives packets from adapter
93func (q *Manager) ReceivePacketsIn(_ *empty.Empty, packetsIn voltha.VolthaService_ReceivePacketsInServer) error {
Rohan Agrawal31f21802020-06-12 05:38:46 +000094 ctx := context.Background()
95 var streamingTracker = q.getStreamingTracker(ctx, "ReceivePacketsIn", q.packetInQueueDone)
96 logger.Debugw(ctx, "ReceivePacketsIn-request", log.Fields{"packetsIn": packetsIn})
Kent Hagerman45a13e42020-04-13 12:23:50 -040097
Rohan Agrawal31f21802020-06-12 05:38:46 +000098 err := q.flushFailedPackets(ctx, streamingTracker)
Kent Hagerman45a13e42020-04-13 12:23:50 -040099 if err != nil {
Rohan Agrawal31f21802020-06-12 05:38:46 +0000100 logger.Errorw(ctx, "unable-to-flush-failed-packets", log.Fields{"error": err})
Kent Hagerman45a13e42020-04-13 12:23:50 -0400101 }
102
103loop:
104 for {
105 select {
106 case packet := <-q.packetInQueue:
Rohan Agrawal31f21802020-06-12 05:38:46 +0000107 logger.Debugw(ctx, "sending-packet-in", log.Fields{
Kent Hagerman45a13e42020-04-13 12:23:50 -0400108 "packet": hex.EncodeToString(packet.PacketIn.Data),
109 })
110 if err := packetsIn.Send(&packet); err != nil {
Rohan Agrawal31f21802020-06-12 05:38:46 +0000111 logger.Errorw(ctx, "failed-to-send-packet", log.Fields{"error": err})
Kent Hagerman45a13e42020-04-13 12:23:50 -0400112 // save the last failed packet in
113 streamingTracker.failedPacket = packet
114 } else {
115 if streamingTracker.failedPacket != nil {
116 // reset last failed packet saved to avoid flush
117 streamingTracker.failedPacket = nil
118 }
119 }
120 case <-q.packetInQueueDone:
Rohan Agrawal31f21802020-06-12 05:38:46 +0000121 logger.Debug(ctx, "Another ReceivePacketsIn running. Bailing out ...")
Kent Hagerman45a13e42020-04-13 12:23:50 -0400122 break loop
123 }
124 }
125
126 //TODO: Find an elegant way to get out of the above loop when the Core is stopped
127 return nil
128}
129
Rohan Agrawal31f21802020-06-12 05:38:46 +0000130func (q *Manager) SendChangeEvent(ctx context.Context, deviceID string, reason openflow_13.OfpPortReason, desc *openflow_13.OfpPort) {
131 logger.Debugw(ctx, "SendChangeEvent", log.Fields{"device-id": deviceID, "reason": reason, "desc": desc})
Kent Hagermanfa9d6d42020-05-25 11:49:40 -0400132 q.changeEventQueue <- openflow_13.ChangeEvent{
133 Id: deviceID,
134 Event: &openflow_13.ChangeEvent_PortStatus{
135 PortStatus: &openflow_13.OfpPortStatus{
136 Reason: reason,
137 Desc: desc,
138 },
139 },
140 }
Kent Hagerman45a13e42020-04-13 12:23:50 -0400141}
142
Andrea Campanella4afb2f02021-01-29 09:38:57 +0100143func (q *Manager) SendFlowChangeEvent(ctx context.Context, deviceID string, res []error, xid uint32, flowCookie uint64) {
144 logger.Debugw(ctx, "SendChangeEvent", log.Fields{"device-id": deviceID,
145 "flowId": xid, "flowCookie": flowCookie, "errors": res})
Maninderf421da62020-12-04 11:44:58 +0530146 errorType := openflow_13.OfpErrorType_OFPET_FLOW_MOD_FAILED
Andrea Campanella4afb2f02021-01-29 09:38:57 +0100147 //Manually creating the data payload for the flow error message
148 bs := make([]byte, 2)
149 //OF 1.3
150 bs[0] = byte(4)
151 //Flow Mod
152 bs[1] = byte(14)
153 //Length of the message
154 length := make([]byte, 2)
155 binary.BigEndian.PutUint16(length, 56)
156 bs = append(bs, length...)
157 emptyArr := []byte{0, 0, 0, 0}
158 bs = append(bs, emptyArr...)
159 //Cookie of the Flow
160 cookie := make([]byte, 52)
161 binary.BigEndian.PutUint64(cookie, flowCookie)
162 bs = append(bs, cookie...)
Maninderf421da62020-12-04 11:44:58 +0530163 q.changeEventQueue <- openflow_13.ChangeEvent{
164 Id: deviceID,
165 Event: &openflow_13.ChangeEvent_Error{
166 Error: &openflow_13.OfpErrorMsg{
167 Header: &openflow_13.OfpHeader{
Andrea Campanella4afb2f02021-01-29 09:38:57 +0100168 Type: openflow_13.OfpType_OFPT_FLOW_MOD,
169 Xid: xid,
Maninderf421da62020-12-04 11:44:58 +0530170 },
171 Type: uint32(errorType),
172 Code: uint32(openflow_13.OfpFlowModFailedCode_OFPFMFC_UNKNOWN),
Andrea Campanella4afb2f02021-01-29 09:38:57 +0100173 Data: bs,
Maninderf421da62020-12-04 11:44:58 +0530174 },
175 },
176 }
177}
178
Kent Hagerman45a13e42020-04-13 12:23:50 -0400179// ReceiveChangeEvents receives change in events
180func (q *Manager) ReceiveChangeEvents(_ *empty.Empty, changeEvents voltha.VolthaService_ReceiveChangeEventsServer) error {
Rohan Agrawal31f21802020-06-12 05:38:46 +0000181 ctx := context.Background()
182 var streamingTracker = q.getStreamingTracker(ctx, "ReceiveChangeEvents", q.changeEventQueueDone)
183 logger.Debugw(ctx, "ReceiveChangeEvents-request", log.Fields{"changeEvents": changeEvents})
Kent Hagerman45a13e42020-04-13 12:23:50 -0400184
Rohan Agrawal31f21802020-06-12 05:38:46 +0000185 err := q.flushFailedPackets(ctx, streamingTracker)
Kent Hagerman45a13e42020-04-13 12:23:50 -0400186 if err != nil {
Rohan Agrawal31f21802020-06-12 05:38:46 +0000187 logger.Errorw(ctx, "unable-to-flush-failed-packets", log.Fields{"error": err})
Kent Hagerman45a13e42020-04-13 12:23:50 -0400188 }
189
190loop:
191 for {
192 select {
193 // Dequeue a change event
194 case event := <-q.changeEventQueue:
Rohan Agrawal31f21802020-06-12 05:38:46 +0000195 logger.Debugw(ctx, "sending-change-event", log.Fields{"event": event})
Kent Hagerman45a13e42020-04-13 12:23:50 -0400196 if err := changeEvents.Send(&event); err != nil {
Rohan Agrawal31f21802020-06-12 05:38:46 +0000197 logger.Errorw(ctx, "failed-to-send-change-event", log.Fields{"error": err})
Kent Hagerman45a13e42020-04-13 12:23:50 -0400198 // save last failed changeevent
199 streamingTracker.failedPacket = event
200 } else {
201 if streamingTracker.failedPacket != nil {
202 // reset last failed event saved on success to avoid flushing
203 streamingTracker.failedPacket = nil
204 }
205 }
206 case <-q.changeEventQueueDone:
Rohan Agrawal31f21802020-06-12 05:38:46 +0000207 logger.Debug(ctx, "Another ReceiveChangeEvents already running. Bailing out ...")
Kent Hagerman45a13e42020-04-13 12:23:50 -0400208 break loop
209 }
210 }
211
212 return nil
213}
214
215func (q *Manager) GetChangeEventsQueueForTest() <-chan openflow_13.ChangeEvent {
216 return q.changeEventQueue
217}