blob: 4026ba107a4cc98e26daa4c6e6bf27e8ff7c4867 [file] [log] [blame]
khenaidoob9203542018-09-17 22:56:37 -04001/*
2 * Copyright 2018-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 */
npujar1d86a522019-11-14 17:11:16 +053016
khenaidoob9203542018-09-17 22:56:37 -040017package core
18
19import (
20 "context"
21 "errors"
npujar1d86a522019-11-14 17:11:16 +053022 "strings"
23 "sync"
24
sbarbari17d7e222019-11-05 10:02:29 -050025 "github.com/opencord/voltha-go/db/model"
serkant.uluderya2ae470f2020-01-21 11:13:09 -080026 "github.com/opencord/voltha-lib-go/v3/pkg/kafka"
27 "github.com/opencord/voltha-lib-go/v3/pkg/log"
28 "github.com/opencord/voltha-lib-go/v3/pkg/probe"
29 "github.com/opencord/voltha-protos/v3/go/openflow_13"
30 "github.com/opencord/voltha-protos/v3/go/voltha"
khenaidoob9203542018-09-17 22:56:37 -040031 "google.golang.org/grpc/codes"
32 "google.golang.org/grpc/status"
khenaidoob9203542018-09-17 22:56:37 -040033)
34
npujar1d86a522019-11-14 17:11:16 +053035// LogicalDeviceManager represent logical device manager attributes
khenaidoob9203542018-09-17 22:56:37 -040036type LogicalDeviceManager struct {
khenaidoo4c9e5592019-09-09 16:20:41 -040037 logicalDeviceAgents sync.Map
38 core *Core
39 deviceMgr *DeviceManager
40 grpcNbiHdlr *APIHandler
npujar467fe752020-01-16 20:17:45 +053041 kafkaICProxy kafka.InterContainerProxy
khenaidoo4c9e5592019-09-09 16:20:41 -040042 clusterDataProxy *model.Proxy
43 exitChannel chan int
44 defaultTimeout int64
45 logicalDevicesLoadingLock sync.RWMutex
46 logicalDeviceLoadingInProgress map[string][]chan int
khenaidoob9203542018-09-17 22:56:37 -040047}
48
npujar467fe752020-01-16 20:17:45 +053049func newLogicalDeviceManager(core *Core, deviceMgr *DeviceManager, kafkaICProxy kafka.InterContainerProxy, cdProxy *model.Proxy, timeout int64) *LogicalDeviceManager {
khenaidoob9203542018-09-17 22:56:37 -040050 var logicalDeviceMgr LogicalDeviceManager
Richard Jankowski199fd862019-03-18 14:49:51 -040051 logicalDeviceMgr.core = core
khenaidoob9203542018-09-17 22:56:37 -040052 logicalDeviceMgr.exitChannel = make(chan int, 1)
khenaidoob9203542018-09-17 22:56:37 -040053 logicalDeviceMgr.deviceMgr = deviceMgr
khenaidoo43c82122018-11-22 18:38:28 -050054 logicalDeviceMgr.kafkaICProxy = kafkaICProxy
khenaidoo9a468962018-09-19 15:33:13 -040055 logicalDeviceMgr.clusterDataProxy = cdProxy
khenaidoo2c6a0992019-04-29 13:46:56 -040056 logicalDeviceMgr.defaultTimeout = timeout
khenaidoo4c9e5592019-09-09 16:20:41 -040057 logicalDeviceMgr.logicalDevicesLoadingLock = sync.RWMutex{}
58 logicalDeviceMgr.logicalDeviceLoadingInProgress = make(map[string][]chan int)
khenaidoob9203542018-09-17 22:56:37 -040059 return &logicalDeviceMgr
60}
61
Richard Jankowskidbab94a2018-12-06 16:20:25 -050062func (ldMgr *LogicalDeviceManager) setGrpcNbiHandler(grpcNbiHandler *APIHandler) {
63 ldMgr.grpcNbiHdlr = grpcNbiHandler
64}
65
khenaidoo4d4802d2018-10-04 21:59:49 -040066func (ldMgr *LogicalDeviceManager) start(ctx context.Context) {
khenaidoob9203542018-09-17 22:56:37 -040067 log.Info("starting-logical-device-manager")
David K. Bainbridgeb4a9ab02019-09-20 15:12:16 -070068 probe.UpdateStatusFromContext(ctx, "logical-device-manager", probe.ServiceStatusRunning)
khenaidoob9203542018-09-17 22:56:37 -040069 log.Info("logical-device-manager-started")
70}
71
khenaidoo4d4802d2018-10-04 21:59:49 -040072func (ldMgr *LogicalDeviceManager) stop(ctx context.Context) {
khenaidoob9203542018-09-17 22:56:37 -040073 log.Info("stopping-logical-device-manager")
74 ldMgr.exitChannel <- 1
David K. Bainbridgeb4a9ab02019-09-20 15:12:16 -070075 probe.UpdateStatusFromContext(ctx, "logical-device-manager", probe.ServiceStatusStopped)
khenaidoob9203542018-09-17 22:56:37 -040076 log.Info("logical-device-manager-stopped")
77}
78
khenaidoo19d7b632018-10-30 10:49:50 -040079func sendAPIResponse(ctx context.Context, ch chan interface{}, result interface{}) {
80 if ctx.Err() == nil {
81 // Returned response only of the ctx has not been cancelled/timeout/etc
82 // Channel is automatically closed when a context is Done
83 ch <- result
84 log.Debugw("sendResponse", log.Fields{"result": result})
85 } else {
86 // Should the transaction be reverted back?
87 log.Debugw("sendResponse-context-error", log.Fields{"context-error": ctx.Err()})
88 }
89}
90
khenaidoob9203542018-09-17 22:56:37 -040091func (ldMgr *LogicalDeviceManager) addLogicalDeviceAgentToMap(agent *LogicalDeviceAgent) {
npujar1d86a522019-11-14 17:11:16 +053092 if _, exist := ldMgr.logicalDeviceAgents.Load(agent.logicalDeviceID); !exist {
93 ldMgr.logicalDeviceAgents.Store(agent.logicalDeviceID, agent)
khenaidoob9203542018-09-17 22:56:37 -040094 }
95}
96
khenaidoo8c3303d2019-02-13 14:59:39 -050097// getLogicalDeviceAgent returns the logical device agent. If the device is not in memory then the device will
98// be loaded from dB and a logical device agent created to managed it.
npujar467fe752020-01-16 20:17:45 +053099func (ldMgr *LogicalDeviceManager) getLogicalDeviceAgent(ctx context.Context, logicalDeviceID string) *LogicalDeviceAgent {
npujar1d86a522019-11-14 17:11:16 +0530100 agent, ok := ldMgr.logicalDeviceAgents.Load(logicalDeviceID)
101 if ok {
khenaidoo93d5a3d2020-01-15 12:37:05 -0500102 lda := agent.(*LogicalDeviceAgent)
103 if lda.logicalDevice == nil {
104 // This can happen when an agent for the logical device has been created but the logical device
105 // itself is not ready for action as it is waiting for switch and port capabilities from the
106 // relevant adapter. In such a case prevent any request aimed at that logical device.
107 log.Debugf("Logical device %s is not ready to serve requests", logicalDeviceID)
108 return nil
109 }
110 return lda
npujar1d86a522019-11-14 17:11:16 +0530111 }
112 // Try to load into memory - loading will also create the logical device agent
npujar467fe752020-01-16 20:17:45 +0530113 if err := ldMgr.load(ctx, logicalDeviceID); err == nil {
npujar1d86a522019-11-14 17:11:16 +0530114 if agent, ok = ldMgr.logicalDeviceAgents.Load(logicalDeviceID); ok {
115 return agent.(*LogicalDeviceAgent)
khenaidoo8c3303d2019-02-13 14:59:39 -0500116 }
khenaidoob9203542018-09-17 22:56:37 -0400117 }
118 return nil
119}
120
npujar1d86a522019-11-14 17:11:16 +0530121func (ldMgr *LogicalDeviceManager) deleteLogicalDeviceAgent(logicalDeviceID string) {
122 ldMgr.logicalDeviceAgents.Delete(logicalDeviceID)
khenaidoo92e62c52018-10-03 14:02:54 -0400123}
124
khenaidoo8c3303d2019-02-13 14:59:39 -0500125// GetLogicalDevice provides a cloned most up to date logical device. If device is not in memory
126// it will be fetched from the dB
npujar467fe752020-01-16 20:17:45 +0530127func (ldMgr *LogicalDeviceManager) getLogicalDevice(ctx context.Context, id string) (*voltha.LogicalDevice, error) {
khenaidoo92e62c52018-10-03 14:02:54 -0400128 log.Debugw("getlogicalDevice", log.Fields{"logicaldeviceid": id})
npujar467fe752020-01-16 20:17:45 +0530129 if agent := ldMgr.getLogicalDeviceAgent(ctx, id); agent != nil {
khenaidoo6e55d9e2019-12-12 18:26:26 -0500130 return agent.GetLogicalDevice(), nil
khenaidoob9203542018-09-17 22:56:37 -0400131 }
132 return nil, status.Errorf(codes.NotFound, "%s", id)
133}
134
khenaidoo43aa6bd2019-05-29 13:35:13 -0400135func (ldMgr *LogicalDeviceManager) listManagedLogicalDevices() (*voltha.LogicalDevices, error) {
136 log.Debug("listManagedLogicalDevices")
137 result := &voltha.LogicalDevices{}
Stephane Barbarieef6650d2019-07-18 12:15:09 -0400138 ldMgr.logicalDeviceAgents.Range(func(key, value interface{}) bool {
139 agent := value.(*LogicalDeviceAgent)
khenaidoo6e55d9e2019-12-12 18:26:26 -0500140 if ld := agent.GetLogicalDevice(); ld != nil {
khenaidoo43aa6bd2019-05-29 13:35:13 -0400141 result.Items = append(result.Items, ld)
142 }
Stephane Barbarieef6650d2019-07-18 12:15:09 -0400143 return true
144 })
145
khenaidoo43aa6bd2019-05-29 13:35:13 -0400146 return result, nil
147}
148
khenaidooba6b6c42019-08-02 09:11:56 -0400149//listLogicalDevices returns the list of all logical devices
npujar467fe752020-01-16 20:17:45 +0530150func (ldMgr *LogicalDeviceManager) listLogicalDevices(ctx context.Context) (*voltha.LogicalDevices, error) {
Stephane Barbarie1ab43272018-12-08 21:42:13 -0500151 log.Debug("ListAllLogicalDevices")
khenaidoob9203542018-09-17 22:56:37 -0400152 result := &voltha.LogicalDevices{}
npujar467fe752020-01-16 20:17:45 +0530153 logicalDevices, err := ldMgr.clusterDataProxy.List(ctx, "/logical_devices", 0, true, "")
Thomas Lee Se5a44012019-11-07 20:32:24 +0530154 if err != nil {
155 log.Errorw("failed-to-list-logical-devices-from-cluster-proxy", log.Fields{"error": err})
156 return nil, err
157 }
158 if logicalDevices != nil {
Stephane Barbarie1ab43272018-12-08 21:42:13 -0500159 for _, logicalDevice := range logicalDevices.([]interface{}) {
Stephane Barbarie1ab43272018-12-08 21:42:13 -0500160 result.Items = append(result.Items, logicalDevice.(*voltha.LogicalDevice))
khenaidoob9203542018-09-17 22:56:37 -0400161 }
162 }
163 return result, nil
164}
165
khenaidoo4d4802d2018-10-04 21:59:49 -0400166func (ldMgr *LogicalDeviceManager) createLogicalDevice(ctx context.Context, device *voltha.Device) (*string, error) {
khenaidoo92e62c52018-10-03 14:02:54 -0400167 log.Debugw("creating-logical-device", log.Fields{"deviceId": device.Id})
khenaidoob9203542018-09-17 22:56:37 -0400168 // Sanity check
169 if !device.Root {
khenaidoo2c6a0992019-04-29 13:46:56 -0400170 return nil, errors.New("device-not-root")
khenaidoob9203542018-09-17 22:56:37 -0400171 }
172
173 // Create a logical device agent - the logical device Id is based on the mac address of the device
174 // For now use the serial number - it may contain any combination of alphabetic characters and numbers,
175 // with length varying from eight characters to a maximum of 14 characters. Mac Address is part of oneof
176 // in the Device model. May need to be moved out.
177 macAddress := device.MacAddress
178 id := strings.Replace(macAddress, ":", "", -1)
khenaidoo92e62c52018-10-03 14:02:54 -0400179 if id == "" {
180 log.Errorw("mac-address-not-set", log.Fields{"deviceId": device.Id})
181 return nil, errors.New("mac-address-not-set")
182 }
183 log.Debugw("logical-device-id", log.Fields{"logicaldeviceId": id})
khenaidoob9203542018-09-17 22:56:37 -0400184
khenaidoo2c6a0992019-04-29 13:46:56 -0400185 agent := newLogicalDeviceAgent(id, device.Id, ldMgr, ldMgr.deviceMgr, ldMgr.clusterDataProxy, ldMgr.defaultTimeout)
khenaidoob9203542018-09-17 22:56:37 -0400186 ldMgr.addLogicalDeviceAgentToMap(agent)
khenaidooad06fd72019-10-28 12:26:05 -0400187
188 // Update the root device with the logical device Id reference
npujar467fe752020-01-16 20:17:45 +0530189 if err := ldMgr.deviceMgr.setParentID(ctx, device, id); err != nil {
khenaidooad06fd72019-10-28 12:26:05 -0400190 log.Errorw("failed-setting-parent-id", log.Fields{"logicalDeviceId": id, "deviceId": device.Id})
191 return nil, err
192 }
193
npujar1d86a522019-11-14 17:11:16 +0530194 go func() {
195 err := agent.start(ctx, false)
196 if err != nil {
197 log.Errorw("unable-to-create-the-logical-device", log.Fields{"error": err})
198 }
199 }()
khenaidoob9203542018-09-17 22:56:37 -0400200
khenaidoo92e62c52018-10-03 14:02:54 -0400201 log.Debug("creating-logical-device-ends")
khenaidoob9203542018-09-17 22:56:37 -0400202 return &id, nil
203}
204
khenaidoo6d62c002019-05-15 21:57:03 -0400205// stopManagingLogicalDeviceWithDeviceId stops the management of the logical device. This implies removal of any
206// reference of this logical device in cache. The device Id is passed as param because the logical device may already
207// have been removed from the model. This function returns the logical device Id if found
npujar467fe752020-01-16 20:17:45 +0530208func (ldMgr *LogicalDeviceManager) stopManagingLogicalDeviceWithDeviceID(ctx context.Context, id string) string {
khenaidoo6d62c002019-05-15 21:57:03 -0400209 log.Infow("stop-managing-logical-device", log.Fields{"deviceId": id})
210 // Go over the list of logical device agents to find the one which has rootDeviceId as id
npujar1d86a522019-11-14 17:11:16 +0530211 var ldID = ""
Stephane Barbarieef6650d2019-07-18 12:15:09 -0400212 ldMgr.logicalDeviceAgents.Range(func(key, value interface{}) bool {
213 ldAgent := value.(*LogicalDeviceAgent)
npujar1d86a522019-11-14 17:11:16 +0530214 if ldAgent.rootDeviceID == id {
Stephane Barbarieef6650d2019-07-18 12:15:09 -0400215 log.Infow("stopping-logical-device-agent", log.Fields{"lDeviceId": key})
npujar467fe752020-01-16 20:17:45 +0530216 if err := ldAgent.stop(ctx); err != nil {
Thomas Lee Se5a44012019-11-07 20:32:24 +0530217 log.Errorw("failed-to-stop-LDAgent", log.Fields{"error": err})
218 return false
219 }
npujar1d86a522019-11-14 17:11:16 +0530220 ldID = key.(string)
221 ldMgr.logicalDeviceAgents.Delete(ldID)
khenaidoo6d62c002019-05-15 21:57:03 -0400222 }
Stephane Barbarieef6650d2019-07-18 12:15:09 -0400223 return true
224 })
npujar1d86a522019-11-14 17:11:16 +0530225 return ldID
khenaidoo6d62c002019-05-15 21:57:03 -0400226}
227
228//getLogicalDeviceFromModel retrieves the logical device data from the model.
npujar467fe752020-01-16 20:17:45 +0530229func (ldMgr *LogicalDeviceManager) getLogicalDeviceFromModel(ctx context.Context, lDeviceID string) (*voltha.LogicalDevice, error) {
230 logicalDevice, err := ldMgr.clusterDataProxy.Get(ctx, "/logical_devices/"+lDeviceID, 0, false, "")
Thomas Lee Se5a44012019-11-07 20:32:24 +0530231 if err != nil {
232 log.Errorw("failed-to-get-logical-devices-from-cluster-proxy", log.Fields{"error": err})
233 return nil, err
234 }
235 if logicalDevice != nil {
khenaidoo6d62c002019-05-15 21:57:03 -0400236 if lDevice, ok := logicalDevice.(*voltha.LogicalDevice); ok {
237 return lDevice, nil
238 }
239 }
npujar1d86a522019-11-14 17:11:16 +0530240 return nil, status.Error(codes.NotFound, lDeviceID)
khenaidoo6d62c002019-05-15 21:57:03 -0400241}
242
khenaidoo297cd252019-02-07 22:10:23 -0500243// load loads a logical device manager in memory
npujar467fe752020-01-16 20:17:45 +0530244func (ldMgr *LogicalDeviceManager) load(ctx context.Context, lDeviceID string) error {
npujar1d86a522019-11-14 17:11:16 +0530245 if lDeviceID == "" {
khenaidoo4c9e5592019-09-09 16:20:41 -0400246 return nil
khenaidoo297cd252019-02-07 22:10:23 -0500247 }
khenaidoo4c9e5592019-09-09 16:20:41 -0400248 // Add a lock to prevent two concurrent calls from loading the same device twice
249 ldMgr.logicalDevicesLoadingLock.Lock()
npujar1d86a522019-11-14 17:11:16 +0530250 if _, exist := ldMgr.logicalDeviceLoadingInProgress[lDeviceID]; !exist {
251 if ldAgent, _ := ldMgr.logicalDeviceAgents.Load(lDeviceID); ldAgent == nil {
252 ldMgr.logicalDeviceLoadingInProgress[lDeviceID] = []chan int{make(chan int, 1)}
khenaidoo4c9e5592019-09-09 16:20:41 -0400253 ldMgr.logicalDevicesLoadingLock.Unlock()
npujar467fe752020-01-16 20:17:45 +0530254 if _, err := ldMgr.getLogicalDeviceFromModel(ctx, lDeviceID); err == nil {
npujar1d86a522019-11-14 17:11:16 +0530255 log.Debugw("loading-logical-device", log.Fields{"lDeviceId": lDeviceID})
256 agent := newLogicalDeviceAgent(lDeviceID, "", ldMgr, ldMgr.deviceMgr, ldMgr.clusterDataProxy, ldMgr.defaultTimeout)
npujar467fe752020-01-16 20:17:45 +0530257 if err := agent.start(ctx, true); err != nil {
258 if err := agent.stop(ctx); err != nil {
Thomas Lee Se5a44012019-11-07 20:32:24 +0530259 log.Errorw("failed-to-stop-agent", log.Fields{"error": err})
260 return err
261 }
khenaidoo4c9e5592019-09-09 16:20:41 -0400262 } else {
npujar1d86a522019-11-14 17:11:16 +0530263 ldMgr.logicalDeviceAgents.Store(agent.logicalDeviceID, agent)
khenaidoo4c9e5592019-09-09 16:20:41 -0400264 }
265 } else {
npujar1d86a522019-11-14 17:11:16 +0530266 log.Debugw("logicalDevice not in model", log.Fields{"lDeviceId": lDeviceID})
khenaidoo4c9e5592019-09-09 16:20:41 -0400267 }
268 // announce completion of task to any number of waiting channels
269 ldMgr.logicalDevicesLoadingLock.Lock()
npujar1d86a522019-11-14 17:11:16 +0530270 if v, ok := ldMgr.logicalDeviceLoadingInProgress[lDeviceID]; ok {
khenaidoo4c9e5592019-09-09 16:20:41 -0400271 for _, ch := range v {
272 close(ch)
273 }
npujar1d86a522019-11-14 17:11:16 +0530274 delete(ldMgr.logicalDeviceLoadingInProgress, lDeviceID)
khenaidoo4c9e5592019-09-09 16:20:41 -0400275 }
276 ldMgr.logicalDevicesLoadingLock.Unlock()
277 } else {
278 ldMgr.logicalDevicesLoadingLock.Unlock()
279 }
280 } else {
281 ch := make(chan int, 1)
npujar1d86a522019-11-14 17:11:16 +0530282 ldMgr.logicalDeviceLoadingInProgress[lDeviceID] = append(ldMgr.logicalDeviceLoadingInProgress[lDeviceID], ch)
khenaidoo4c9e5592019-09-09 16:20:41 -0400283 ldMgr.logicalDevicesLoadingLock.Unlock()
284 // Wait for the channel to be closed, implying the process loading this device is done.
285 <-ch
286 }
npujar1d86a522019-11-14 17:11:16 +0530287 if _, exist := ldMgr.logicalDeviceAgents.Load(lDeviceID); exist {
khenaidoo4c9e5592019-09-09 16:20:41 -0400288 return nil
289 }
npujar1d86a522019-11-14 17:11:16 +0530290 return status.Errorf(codes.Aborted, "Error loading logical device %s", lDeviceID)
khenaidoo297cd252019-02-07 22:10:23 -0500291}
292
khenaidoo4d4802d2018-10-04 21:59:49 -0400293func (ldMgr *LogicalDeviceManager) deleteLogicalDevice(ctx context.Context, device *voltha.Device) error {
khenaidoo92e62c52018-10-03 14:02:54 -0400294 log.Debugw("deleting-logical-device", log.Fields{"deviceId": device.Id})
295 // Sanity check
296 if !device.Root {
khenaidoo2c6a0992019-04-29 13:46:56 -0400297 return errors.New("device-not-root")
khenaidoo92e62c52018-10-03 14:02:54 -0400298 }
npujar1d86a522019-11-14 17:11:16 +0530299 logDeviceID := device.ParentId
npujar467fe752020-01-16 20:17:45 +0530300 if agent := ldMgr.getLogicalDeviceAgent(ctx, logDeviceID); agent != nil {
khenaidoo92e62c52018-10-03 14:02:54 -0400301 // Stop the logical device agent
Thomas Lee Se5a44012019-11-07 20:32:24 +0530302 if err := agent.stop(ctx); err != nil {
303 log.Errorw("failed-to-stop-agent", log.Fields{"error": err})
304 return err
305 }
khenaidoo92e62c52018-10-03 14:02:54 -0400306 //Remove the logical device agent from the Map
npujar1d86a522019-11-14 17:11:16 +0530307 ldMgr.deleteLogicalDeviceAgent(logDeviceID)
308 err := ldMgr.core.deviceOwnership.AbandonDevice(logDeviceID)
309 if err != nil {
310 log.Errorw("unable-to-abandon-the-device", log.Fields{"error": err})
311 }
khenaidoo92e62c52018-10-03 14:02:54 -0400312 }
313
314 log.Debug("deleting-logical-device-ends")
315 return nil
316}
317
npujar467fe752020-01-16 20:17:45 +0530318func (ldMgr *LogicalDeviceManager) getLogicalDeviceID(ctx context.Context, device *voltha.Device) (*string, error) {
khenaidoo92e62c52018-10-03 14:02:54 -0400319 // Device can either be a parent or a child device
320 if device.Root {
321 // Parent device. The ID of a parent device is the logical device ID
322 return &device.ParentId, nil
323 }
324 // Device is child device
325 // retrieve parent device using child device ID
npujar467fe752020-01-16 20:17:45 +0530326 if parentDevice := ldMgr.deviceMgr.getParentDevice(ctx, device); parentDevice != nil {
khenaidoo92e62c52018-10-03 14:02:54 -0400327 return &parentDevice.ParentId, nil
328 }
329 return nil, status.Errorf(codes.NotFound, "%s", device.Id)
330}
331
npujar467fe752020-01-16 20:17:45 +0530332func (ldMgr *LogicalDeviceManager) getLogicalDeviceIDFromDeviceID(ctx context.Context, deviceID string) (*string, error) {
khenaidoo3ab34882019-05-02 21:33:30 -0400333 // Get the device
334 var device *voltha.Device
335 var err error
npujar467fe752020-01-16 20:17:45 +0530336 if device, err = ldMgr.deviceMgr.GetDevice(ctx, deviceID); err != nil {
khenaidoo3ab34882019-05-02 21:33:30 -0400337 return nil, err
338 }
npujar467fe752020-01-16 20:17:45 +0530339 return ldMgr.getLogicalDeviceID(ctx, device)
khenaidoo3ab34882019-05-02 21:33:30 -0400340}
341
npujar467fe752020-01-16 20:17:45 +0530342func (ldMgr *LogicalDeviceManager) getLogicalPortID(ctx context.Context, device *voltha.Device) (*voltha.LogicalPortId, error) {
khenaidoo19d7b632018-10-30 10:49:50 -0400343 // Get the logical device where this device is attached
npujar1d86a522019-11-14 17:11:16 +0530344 var lDeviceID *string
khenaidoo19d7b632018-10-30 10:49:50 -0400345 var err error
npujar467fe752020-01-16 20:17:45 +0530346 if lDeviceID, err = ldMgr.getLogicalDeviceID(ctx, device); err != nil {
khenaidoo19d7b632018-10-30 10:49:50 -0400347 return nil, err
348 }
349 var lDevice *voltha.LogicalDevice
npujar467fe752020-01-16 20:17:45 +0530350 if lDevice, err = ldMgr.getLogicalDevice(ctx, *lDeviceID); err != nil {
khenaidoo19d7b632018-10-30 10:49:50 -0400351 return nil, err
352 }
353 // Go over list of ports
354 for _, port := range lDevice.Ports {
355 if port.DeviceId == device.Id {
npujar1d86a522019-11-14 17:11:16 +0530356 return &voltha.LogicalPortId{Id: *lDeviceID, PortId: port.Id}, nil
khenaidoo19d7b632018-10-30 10:49:50 -0400357 }
358 }
359 return nil, status.Errorf(codes.NotFound, "%s", device.Id)
360}
361
npujar1d86a522019-11-14 17:11:16 +0530362// ListLogicalDeviceFlows returns the flows of logical device
khenaidoodd237172019-05-27 16:37:17 -0400363func (ldMgr *LogicalDeviceManager) ListLogicalDeviceFlows(ctx context.Context, id string) (*openflow_13.Flows, error) {
364 log.Debugw("ListLogicalDeviceFlows", log.Fields{"logicaldeviceid": id})
npujar467fe752020-01-16 20:17:45 +0530365 if agent := ldMgr.getLogicalDeviceAgent(ctx, id); agent != nil {
khenaidoo6e55d9e2019-12-12 18:26:26 -0500366 return agent.ListLogicalDeviceFlows(), nil
khenaidoodd237172019-05-27 16:37:17 -0400367 }
368 return nil, status.Errorf(codes.NotFound, "%s", id)
369}
370
npujar1d86a522019-11-14 17:11:16 +0530371// ListLogicalDeviceFlowGroups returns logical device flow groups
khenaidoodd237172019-05-27 16:37:17 -0400372func (ldMgr *LogicalDeviceManager) ListLogicalDeviceFlowGroups(ctx context.Context, id string) (*openflow_13.FlowGroups, error) {
373 log.Debugw("ListLogicalDeviceFlowGroups", log.Fields{"logicaldeviceid": id})
npujar467fe752020-01-16 20:17:45 +0530374 if agent := ldMgr.getLogicalDeviceAgent(ctx, id); agent != nil {
khenaidoo6e55d9e2019-12-12 18:26:26 -0500375 return agent.ListLogicalDeviceFlowGroups(), nil
khenaidoodd237172019-05-27 16:37:17 -0400376 }
377 return nil, status.Errorf(codes.NotFound, "%s", id)
378}
379
npujar1d86a522019-11-14 17:11:16 +0530380// ListLogicalDevicePorts returns logical device ports
khenaidoo19d7b632018-10-30 10:49:50 -0400381func (ldMgr *LogicalDeviceManager) ListLogicalDevicePorts(ctx context.Context, id string) (*voltha.LogicalPorts, error) {
382 log.Debugw("ListLogicalDevicePorts", log.Fields{"logicaldeviceid": id})
npujar467fe752020-01-16 20:17:45 +0530383 if agent := ldMgr.getLogicalDeviceAgent(ctx, id); agent != nil {
khenaidoo6e55d9e2019-12-12 18:26:26 -0500384 return agent.ListLogicalDevicePorts(), nil
khenaidoo19d7b632018-10-30 10:49:50 -0400385 }
386 return nil, status.Errorf(codes.NotFound, "%s", id)
khenaidoo19d7b632018-10-30 10:49:50 -0400387}
388
npujar467fe752020-01-16 20:17:45 +0530389func (ldMgr *LogicalDeviceManager) getLogicalPort(ctx context.Context, lPortID *voltha.LogicalPortId) (*voltha.LogicalPort, error) {
khenaidoo19d7b632018-10-30 10:49:50 -0400390 // Get the logical device where this device is attached
391 var err error
392 var lDevice *voltha.LogicalDevice
npujar467fe752020-01-16 20:17:45 +0530393 if lDevice, err = ldMgr.getLogicalDevice(ctx, lPortID.Id); err != nil {
khenaidoo19d7b632018-10-30 10:49:50 -0400394 return nil, err
395 }
396 // Go over list of ports
397 for _, port := range lDevice.Ports {
npujar1d86a522019-11-14 17:11:16 +0530398 if port.Id == lPortID.PortId {
khenaidoo19d7b632018-10-30 10:49:50 -0400399 return port, nil
400 }
401 }
npujar1d86a522019-11-14 17:11:16 +0530402 return nil, status.Errorf(codes.NotFound, "%s-%s", lPortID.Id, lPortID.PortId)
khenaidoo19d7b632018-10-30 10:49:50 -0400403}
404
khenaidoo2c6a0992019-04-29 13:46:56 -0400405// updateLogicalPort sets up a logical port on the logical device based on the device port
406// information, if needed
npujar467fe752020-01-16 20:17:45 +0530407func (ldMgr *LogicalDeviceManager) updateLogicalPort(ctx context.Context, device *voltha.Device, port *voltha.Port) error {
408 ldID, err := ldMgr.getLogicalDeviceID(ctx, device)
npujar1d86a522019-11-14 17:11:16 +0530409 if err != nil || *ldID == "" {
khenaidoo2c6a0992019-04-29 13:46:56 -0400410 // This is not an error as the logical device may not have been created at this time. In such a case,
411 // the ports will be created when the logical device is ready.
412 return nil
khenaidoo2c6a0992019-04-29 13:46:56 -0400413 }
npujar467fe752020-01-16 20:17:45 +0530414 if agent := ldMgr.getLogicalDeviceAgent(ctx, *ldID); agent != nil {
415 if err := agent.updateLogicalPort(ctx, device, port); err != nil {
npujar1d86a522019-11-14 17:11:16 +0530416 return err
khenaidoofc1314d2019-03-14 09:34:21 -0400417 }
418 }
419 return nil
420}
421
khenaidoo0a822f92019-05-08 15:15:57 -0400422// deleteLogicalPort removes the logical port associated with a device
npujar1d86a522019-11-14 17:11:16 +0530423func (ldMgr *LogicalDeviceManager) deleteLogicalPort(ctx context.Context, lPortID *voltha.LogicalPortId) error {
424 log.Debugw("deleting-logical-port", log.Fields{"LDeviceId": lPortID.Id})
khenaidoo19d7b632018-10-30 10:49:50 -0400425 // Get logical port
426 var logicalPort *voltha.LogicalPort
427 var err error
npujar467fe752020-01-16 20:17:45 +0530428 if logicalPort, err = ldMgr.getLogicalPort(ctx, lPortID); err != nil {
npujar1d86a522019-11-14 17:11:16 +0530429 log.Debugw("no-logical-device-port-present", log.Fields{"logicalPortId": lPortID.PortId})
khenaidoo19d7b632018-10-30 10:49:50 -0400430 return err
431 }
khenaidoo92e62c52018-10-03 14:02:54 -0400432 // Sanity check
khenaidoo19d7b632018-10-30 10:49:50 -0400433 if logicalPort.RootPort {
khenaidoo2c6a0992019-04-29 13:46:56 -0400434 return errors.New("device-root")
khenaidoo92e62c52018-10-03 14:02:54 -0400435 }
npujar467fe752020-01-16 20:17:45 +0530436 if agent := ldMgr.getLogicalDeviceAgent(ctx, lPortID.Id); agent != nil {
437 if err := agent.deleteLogicalPort(ctx, logicalPort); err != nil {
npujar1d86a522019-11-14 17:11:16 +0530438 log.Warnw("deleting-logicalport-failed", log.Fields{"LDeviceId": lPortID.Id, "error": err})
khenaidoo0a822f92019-05-08 15:15:57 -0400439 }
khenaidoo92e62c52018-10-03 14:02:54 -0400440 }
441
442 log.Debug("deleting-logical-port-ends")
443 return nil
444}
445
khenaidoo0a822f92019-05-08 15:15:57 -0400446// deleteLogicalPort removes the logical port associated with a child device
npujar467fe752020-01-16 20:17:45 +0530447func (ldMgr *LogicalDeviceManager) deleteLogicalPorts(ctx context.Context, deviceID string) error {
npujar1d86a522019-11-14 17:11:16 +0530448 log.Debugw("deleting-logical-ports", log.Fields{"deviceId": deviceID})
khenaidoo0a822f92019-05-08 15:15:57 -0400449 // Get logical port
npujar467fe752020-01-16 20:17:45 +0530450 ldID, err := ldMgr.getLogicalDeviceIDFromDeviceID(ctx, deviceID)
npujar1d86a522019-11-14 17:11:16 +0530451 if err != nil {
khenaidoo0a822f92019-05-08 15:15:57 -0400452 return err
npujar1d86a522019-11-14 17:11:16 +0530453 }
npujar467fe752020-01-16 20:17:45 +0530454 if agent := ldMgr.getLogicalDeviceAgent(ctx, *ldID); agent != nil {
455 if err = agent.deleteLogicalPorts(ctx, deviceID); err != nil {
npujar1d86a522019-11-14 17:11:16 +0530456 log.Warnw("deleteLogicalPorts-failed", log.Fields{"ldeviceId": *ldID})
457 return err
khenaidoo0a822f92019-05-08 15:15:57 -0400458 }
459 }
460 log.Debug("deleting-logical-port-ends")
461 return nil
462}
463
khenaidoofc1314d2019-03-14 09:34:21 -0400464func (ldMgr *LogicalDeviceManager) setupUNILogicalPorts(ctx context.Context, childDevice *voltha.Device) error {
Stephane Barbarieef6650d2019-07-18 12:15:09 -0400465 log.Debugw("setupUNILogicalPorts", log.Fields{"childDeviceId": childDevice.Id, "parentDeviceId": childDevice.ParentId, "current-data": childDevice})
khenaidoob9203542018-09-17 22:56:37 -0400466 // Sanity check
467 if childDevice.Root {
468 return errors.New("Device-root")
469 }
470
471 // Get the logical device id parent device
npujar1d86a522019-11-14 17:11:16 +0530472 parentID := childDevice.ParentId
npujar467fe752020-01-16 20:17:45 +0530473 logDeviceID := ldMgr.deviceMgr.GetParentDeviceID(ctx, parentID)
khenaidoob9203542018-09-17 22:56:37 -0400474
npujar1d86a522019-11-14 17:11:16 +0530475 log.Debugw("setupUNILogicalPorts", log.Fields{"logDeviceId": logDeviceID, "parentId": parentID})
khenaidoob9203542018-09-17 22:56:37 -0400476
npujar1d86a522019-11-14 17:11:16 +0530477 if parentID == "" || logDeviceID == "" {
khenaidoo2c6a0992019-04-29 13:46:56 -0400478 return errors.New("device-in-invalid-state")
khenaidoo5e677ae2019-02-28 17:26:29 -0500479 }
480
npujar467fe752020-01-16 20:17:45 +0530481 if agent := ldMgr.getLogicalDeviceAgent(ctx, logDeviceID); agent != nil {
khenaidoofc1314d2019-03-14 09:34:21 -0400482 if err := agent.setupUNILogicalPorts(ctx, childDevice); err != nil {
khenaidoobcf205b2019-01-25 22:21:14 -0500483 return err
484 }
khenaidoob9203542018-09-17 22:56:37 -0400485 }
khenaidoo21d51152019-02-01 13:48:37 -0500486 return nil
khenaidoob9203542018-09-17 22:56:37 -0400487}
khenaidoo19d7b632018-10-30 10:49:50 -0400488
npujar467fe752020-01-16 20:17:45 +0530489func (ldMgr *LogicalDeviceManager) deleteAllLogicalPorts(ctx context.Context, device *voltha.Device) error {
khenaidoo0a822f92019-05-08 15:15:57 -0400490 log.Debugw("deleteAllLogicalPorts", log.Fields{"deviceId": device.Id})
491
npujar1d86a522019-11-14 17:11:16 +0530492 var ldID *string
khenaidoo0a822f92019-05-08 15:15:57 -0400493 var err error
494 //Get the logical device Id for this device
npujar467fe752020-01-16 20:17:45 +0530495 if ldID, err = ldMgr.getLogicalDeviceID(ctx, device); err != nil {
khenaidoo0a822f92019-05-08 15:15:57 -0400496 log.Warnw("no-logical-device-found", log.Fields{"deviceId": device.Id, "error": err})
497 return err
498 }
npujar467fe752020-01-16 20:17:45 +0530499 if agent := ldMgr.getLogicalDeviceAgent(ctx, *ldID); agent != nil {
500 if err := agent.deleteAllLogicalPorts(ctx, device); err != nil {
khenaidoo0a822f92019-05-08 15:15:57 -0400501 return err
502 }
503 }
504 return nil
505}
npujar467fe752020-01-16 20:17:45 +0530506func (ldMgr *LogicalDeviceManager) updatePortState(ctx context.Context, deviceID string, portNo uint32, state voltha.OperStatus_Types) error {
npujar1d86a522019-11-14 17:11:16 +0530507 log.Debugw("updatePortState", log.Fields{"deviceId": deviceID, "state": state, "portNo": portNo})
khenaidoo171b98e2019-10-31 11:48:15 -0400508
npujar1d86a522019-11-14 17:11:16 +0530509 var ldID *string
khenaidoo171b98e2019-10-31 11:48:15 -0400510 var err error
511 //Get the logical device Id for this device
npujar467fe752020-01-16 20:17:45 +0530512 if ldID, err = ldMgr.getLogicalDeviceIDFromDeviceID(ctx, deviceID); err != nil {
npujar1d86a522019-11-14 17:11:16 +0530513 log.Warnw("no-logical-device-found", log.Fields{"deviceId": deviceID, "error": err})
khenaidoo171b98e2019-10-31 11:48:15 -0400514 return err
515 }
npujar467fe752020-01-16 20:17:45 +0530516 if agent := ldMgr.getLogicalDeviceAgent(ctx, *ldID); agent != nil {
517 if err := agent.updatePortState(ctx, deviceID, portNo, state); err != nil {
khenaidoo171b98e2019-10-31 11:48:15 -0400518 return err
519 }
520 }
521 return nil
522}
khenaidoo0a822f92019-05-08 15:15:57 -0400523
npujar467fe752020-01-16 20:17:45 +0530524func (ldMgr *LogicalDeviceManager) updatePortsState(ctx context.Context, device *voltha.Device, state voltha.AdminState_Types) error {
Stephane Barbarieef6650d2019-07-18 12:15:09 -0400525 log.Debugw("updatePortsState", log.Fields{"deviceId": device.Id, "state": state, "current-data": device})
khenaidoo3ab34882019-05-02 21:33:30 -0400526
npujar1d86a522019-11-14 17:11:16 +0530527 var ldID *string
khenaidoo3ab34882019-05-02 21:33:30 -0400528 var err error
529 //Get the logical device Id for this device
npujar467fe752020-01-16 20:17:45 +0530530 if ldID, err = ldMgr.getLogicalDeviceID(ctx, device); err != nil {
khenaidoo3ab34882019-05-02 21:33:30 -0400531 log.Warnw("no-logical-device-found", log.Fields{"deviceId": device.Id, "error": err})
532 return err
533 }
npujar467fe752020-01-16 20:17:45 +0530534 if agent := ldMgr.getLogicalDeviceAgent(ctx, *ldID); agent != nil {
535 if err := agent.updatePortsState(ctx, device, state); err != nil {
khenaidoo3ab34882019-05-02 21:33:30 -0400536 return err
537 }
538 }
539 return nil
540}
541
khenaidoo19d7b632018-10-30 10:49:50 -0400542func (ldMgr *LogicalDeviceManager) updateFlowTable(ctx context.Context, id string, flow *openflow_13.OfpFlowMod, ch chan interface{}) {
543 log.Debugw("updateFlowTable", log.Fields{"logicalDeviceId": id})
544 var res interface{}
npujar467fe752020-01-16 20:17:45 +0530545 if agent := ldMgr.getLogicalDeviceAgent(ctx, id); agent != nil {
khenaidoo19d7b632018-10-30 10:49:50 -0400546 res = agent.updateFlowTable(ctx, flow)
547 log.Debugw("updateFlowTable-result", log.Fields{"result": res})
548 } else {
549 res = status.Errorf(codes.NotFound, "%s", id)
550 }
551 sendAPIResponse(ctx, ch, res)
552}
553
Manikkaraj kb1a10922019-07-29 12:10:34 -0400554func (ldMgr *LogicalDeviceManager) updateMeterTable(ctx context.Context, id string, meter *openflow_13.OfpMeterMod, ch chan interface{}) {
555 log.Debugw("updateMeterTable", log.Fields{"logicalDeviceId": id})
556 var res interface{}
npujar467fe752020-01-16 20:17:45 +0530557 if agent := ldMgr.getLogicalDeviceAgent(ctx, id); agent != nil {
Manikkaraj kb1a10922019-07-29 12:10:34 -0400558 res = agent.updateMeterTable(ctx, meter)
559 log.Debugw("updateMeterTable-result", log.Fields{"result": res})
560 } else {
561 res = status.Errorf(codes.NotFound, "%s", id)
562 }
563 sendAPIResponse(ctx, ch, res)
564}
565
npujar1d86a522019-11-14 17:11:16 +0530566// ListLogicalDeviceMeters returns logical device meters
Manikkaraj kb1a10922019-07-29 12:10:34 -0400567func (ldMgr *LogicalDeviceManager) ListLogicalDeviceMeters(ctx context.Context, id string) (*openflow_13.Meters, error) {
568 log.Debugw("ListLogicalDeviceMeters", log.Fields{"logicalDeviceId": id})
npujar467fe752020-01-16 20:17:45 +0530569 if agent := ldMgr.getLogicalDeviceAgent(ctx, id); agent != nil {
khenaidoo6e55d9e2019-12-12 18:26:26 -0500570 return agent.ListLogicalDeviceMeters(), nil
Manikkaraj kb1a10922019-07-29 12:10:34 -0400571 }
572 return nil, status.Errorf(codes.NotFound, "%s", id)
573}
khenaidoo19d7b632018-10-30 10:49:50 -0400574func (ldMgr *LogicalDeviceManager) updateGroupTable(ctx context.Context, id string, groupMod *openflow_13.OfpGroupMod, ch chan interface{}) {
575 log.Debugw("updateGroupTable", log.Fields{"logicalDeviceId": id})
576 var res interface{}
npujar467fe752020-01-16 20:17:45 +0530577 if agent := ldMgr.getLogicalDeviceAgent(ctx, id); agent != nil {
khenaidoo19d7b632018-10-30 10:49:50 -0400578 res = agent.updateGroupTable(ctx, groupMod)
579 log.Debugw("updateGroupTable-result", log.Fields{"result": res})
580 } else {
581 res = status.Errorf(codes.NotFound, "%s", id)
582 }
583 sendAPIResponse(ctx, ch, res)
584}
585
586func (ldMgr *LogicalDeviceManager) enableLogicalPort(ctx context.Context, id *voltha.LogicalPortId, ch chan interface{}) {
587 log.Debugw("enableLogicalPort", log.Fields{"logicalDeviceId": id})
588 var res interface{}
npujar467fe752020-01-16 20:17:45 +0530589 if agent := ldMgr.getLogicalDeviceAgent(ctx, id.Id); agent != nil {
590 res = agent.enableLogicalPort(ctx, id.PortId)
khenaidoo19d7b632018-10-30 10:49:50 -0400591 log.Debugw("enableLogicalPort-result", log.Fields{"result": res})
592 } else {
593 res = status.Errorf(codes.NotFound, "%s", id.Id)
594 }
595 sendAPIResponse(ctx, ch, res)
596}
597
598func (ldMgr *LogicalDeviceManager) disableLogicalPort(ctx context.Context, id *voltha.LogicalPortId, ch chan interface{}) {
599 log.Debugw("disableLogicalPort", log.Fields{"logicalDeviceId": id})
600 var res interface{}
npujar467fe752020-01-16 20:17:45 +0530601 if agent := ldMgr.getLogicalDeviceAgent(ctx, id.Id); agent != nil {
602 res = agent.disableLogicalPort(ctx, id.PortId)
khenaidoo19d7b632018-10-30 10:49:50 -0400603 log.Debugw("disableLogicalPort-result", log.Fields{"result": res})
604 } else {
605 res = status.Errorf(codes.NotFound, "%s", id.Id)
606 }
607 sendAPIResponse(ctx, ch, res)
608}
khenaidoofdbad6e2018-11-06 22:26:38 -0500609
npujar467fe752020-01-16 20:17:45 +0530610func (ldMgr *LogicalDeviceManager) packetIn(ctx context.Context, logicalDeviceID string, port uint32, transactionID string, packet []byte) error {
npujar1d86a522019-11-14 17:11:16 +0530611 log.Debugw("packetIn", log.Fields{"logicalDeviceId": logicalDeviceID, "port": port})
npujar467fe752020-01-16 20:17:45 +0530612 if agent := ldMgr.getLogicalDeviceAgent(ctx, logicalDeviceID); agent != nil {
npujar1d86a522019-11-14 17:11:16 +0530613 agent.packetIn(port, transactionID, packet)
khenaidoofdbad6e2018-11-06 22:26:38 -0500614 } else {
npujar1d86a522019-11-14 17:11:16 +0530615 log.Error("logical-device-not-exist", log.Fields{"logicalDeviceId": logicalDeviceID})
khenaidoofdbad6e2018-11-06 22:26:38 -0500616 }
617 return nil
618}