blob: cd7bce12f9a6f4f5337e1a7e81a70d8306a4b134 [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
Kent Hagerman2b216042020-04-03 18:28:56 -040017package device
khenaidoob9203542018-09-17 22:56:37 -040018
19import (
20 "context"
21 "errors"
Kent Hagerman45a13e42020-04-13 12:23:50 -040022 "io"
David Bainbridged1afd662020-03-26 18:27:41 -070023 "strings"
24 "sync"
25 "time"
26
Kent Hagerman433a31a2020-05-20 19:04:48 -040027 "github.com/golang/protobuf/ptypes/empty"
sbarbari17d7e222019-11-05 10:02:29 -050028 "github.com/opencord/voltha-go/db/model"
Kent Hagerman433a31a2020-05-20 19:04:48 -040029 "github.com/opencord/voltha-go/rw_core/core/device/event"
30 "github.com/opencord/voltha-go/rw_core/utils"
serkant.uluderya2ae470f2020-01-21 11:13:09 -080031 "github.com/opencord/voltha-lib-go/v3/pkg/kafka"
32 "github.com/opencord/voltha-lib-go/v3/pkg/log"
serkant.uluderya2ae470f2020-01-21 11:13:09 -080033 "github.com/opencord/voltha-protos/v3/go/openflow_13"
34 "github.com/opencord/voltha-protos/v3/go/voltha"
khenaidoob9203542018-09-17 22:56:37 -040035 "google.golang.org/grpc/codes"
36 "google.golang.org/grpc/status"
khenaidoob9203542018-09-17 22:56:37 -040037)
38
Kent Hagerman2b216042020-04-03 18:28:56 -040039// LogicalManager represent logical device manager attributes
40type LogicalManager struct {
Kent Hagerman45a13e42020-04-13 12:23:50 -040041 *event.Manager
khenaidoo4c9e5592019-09-09 16:20:41 -040042 logicalDeviceAgents sync.Map
Kent Hagerman2b216042020-04-03 18:28:56 -040043 deviceMgr *Manager
npujar467fe752020-01-16 20:17:45 +053044 kafkaICProxy kafka.InterContainerProxy
khenaidoo4c9e5592019-09-09 16:20:41 -040045 clusterDataProxy *model.Proxy
khenaidoo442e7c72020-03-10 16:13:48 -040046 defaultTimeout time.Duration
khenaidoo4c9e5592019-09-09 16:20:41 -040047 logicalDevicesLoadingLock sync.RWMutex
48 logicalDeviceLoadingInProgress map[string][]chan int
khenaidoob9203542018-09-17 22:56:37 -040049}
50
Kent Hagerman2b216042020-04-03 18:28:56 -040051func (ldMgr *LogicalManager) addLogicalDeviceAgentToMap(agent *LogicalAgent) {
npujar1d86a522019-11-14 17:11:16 +053052 if _, exist := ldMgr.logicalDeviceAgents.Load(agent.logicalDeviceID); !exist {
53 ldMgr.logicalDeviceAgents.Store(agent.logicalDeviceID, agent)
khenaidoob9203542018-09-17 22:56:37 -040054 }
55}
56
khenaidoo8c3303d2019-02-13 14:59:39 -050057// getLogicalDeviceAgent returns the logical device agent. If the device is not in memory then the device will
58// be loaded from dB and a logical device agent created to managed it.
Kent Hagerman2b216042020-04-03 18:28:56 -040059func (ldMgr *LogicalManager) getLogicalDeviceAgent(ctx context.Context, logicalDeviceID string) *LogicalAgent {
Andrea Campanella09400bd2020-04-02 11:58:04 +020060 logger.Debugw("get-logical-device-agent", log.Fields{"logical-device-id": logicalDeviceID})
npujar1d86a522019-11-14 17:11:16 +053061 agent, ok := ldMgr.logicalDeviceAgents.Load(logicalDeviceID)
62 if ok {
Kent Hagerman2b216042020-04-03 18:28:56 -040063 lda := agent.(*LogicalAgent)
khenaidoo93d5a3d2020-01-15 12:37:05 -050064 if lda.logicalDevice == nil {
65 // This can happen when an agent for the logical device has been created but the logical device
66 // itself is not ready for action as it is waiting for switch and port capabilities from the
67 // relevant adapter. In such a case prevent any request aimed at that logical device.
Girish Kumarf56a4682020-03-20 20:07:46 +000068 logger.Debugf("Logical device %s is not ready to serve requests", logicalDeviceID)
khenaidoo93d5a3d2020-01-15 12:37:05 -050069 return nil
70 }
71 return lda
npujar1d86a522019-11-14 17:11:16 +053072 }
73 // Try to load into memory - loading will also create the logical device agent
npujar467fe752020-01-16 20:17:45 +053074 if err := ldMgr.load(ctx, logicalDeviceID); err == nil {
npujar1d86a522019-11-14 17:11:16 +053075 if agent, ok = ldMgr.logicalDeviceAgents.Load(logicalDeviceID); ok {
Kent Hagerman2b216042020-04-03 18:28:56 -040076 return agent.(*LogicalAgent)
khenaidoo8c3303d2019-02-13 14:59:39 -050077 }
khenaidoob9203542018-09-17 22:56:37 -040078 }
79 return nil
80}
81
Kent Hagerman2b216042020-04-03 18:28:56 -040082func (ldMgr *LogicalManager) deleteLogicalDeviceAgent(logicalDeviceID string) {
npujar1d86a522019-11-14 17:11:16 +053083 ldMgr.logicalDeviceAgents.Delete(logicalDeviceID)
khenaidoo92e62c52018-10-03 14:02:54 -040084}
85
khenaidoo8c3303d2019-02-13 14:59:39 -050086// GetLogicalDevice provides a cloned most up to date logical device. If device is not in memory
87// it will be fetched from the dB
Kent Hagerman45a13e42020-04-13 12:23:50 -040088func (ldMgr *LogicalManager) GetLogicalDevice(ctx context.Context, id *voltha.ID) (*voltha.LogicalDevice, error) {
Girish Kumarf56a4682020-03-20 20:07:46 +000089 logger.Debugw("getlogicalDevice", log.Fields{"logicaldeviceid": id})
Kent Hagerman45a13e42020-04-13 12:23:50 -040090 if agent := ldMgr.getLogicalDeviceAgent(ctx, id.Id); agent != nil {
khenaidoo442e7c72020-03-10 16:13:48 -040091 return agent.GetLogicalDevice(ctx)
khenaidoob9203542018-09-17 22:56:37 -040092 }
93 return nil, status.Errorf(codes.NotFound, "%s", id)
94}
95
Kent Hagerman2b216042020-04-03 18:28:56 -040096//ListLogicalDevices returns the list of all logical devices
Kent Hagerman45a13e42020-04-13 12:23:50 -040097func (ldMgr *LogicalManager) ListLogicalDevices(ctx context.Context, _ *empty.Empty) (*voltha.LogicalDevices, error) {
Girish Kumarf56a4682020-03-20 20:07:46 +000098 logger.Debug("ListAllLogicalDevices")
Kent Hagerman4f355f52020-03-30 16:01:33 -040099
100 var logicalDevices []*voltha.LogicalDevice
101 if err := ldMgr.clusterDataProxy.List(ctx, "logical_devices", &logicalDevices); err != nil {
Girish Kumarf56a4682020-03-20 20:07:46 +0000102 logger.Errorw("failed-to-list-logical-devices-from-cluster-proxy", log.Fields{"error": err})
Thomas Lee Se5a44012019-11-07 20:32:24 +0530103 return nil, err
104 }
Kent Hagerman4f355f52020-03-30 16:01:33 -0400105 return &voltha.LogicalDevices{Items: logicalDevices}, nil
khenaidoob9203542018-09-17 22:56:37 -0400106}
107
Kent Hagerman2b216042020-04-03 18:28:56 -0400108func (ldMgr *LogicalManager) createLogicalDevice(ctx context.Context, device *voltha.Device) (*string, error) {
Girish Kumarf56a4682020-03-20 20:07:46 +0000109 logger.Debugw("creating-logical-device", log.Fields{"deviceId": device.Id})
khenaidoob9203542018-09-17 22:56:37 -0400110 // Sanity check
111 if !device.Root {
khenaidoo2c6a0992019-04-29 13:46:56 -0400112 return nil, errors.New("device-not-root")
khenaidoob9203542018-09-17 22:56:37 -0400113 }
114
115 // Create a logical device agent - the logical device Id is based on the mac address of the device
116 // For now use the serial number - it may contain any combination of alphabetic characters and numbers,
117 // with length varying from eight characters to a maximum of 14 characters. Mac Address is part of oneof
118 // in the Device model. May need to be moved out.
Kent Hagerman2b216042020-04-03 18:28:56 -0400119 id := utils.CreateLogicalDeviceID()
David Bainbridged1afd662020-03-26 18:27:41 -0700120 sn := strings.Replace(device.MacAddress, ":", "", -1)
khenaidoo92e62c52018-10-03 14:02:54 -0400121 if id == "" {
David Bainbridged1afd662020-03-26 18:27:41 -0700122 logger.Errorw("mac-address-not-set", log.Fields{"deviceId": device.Id, "serial-number": sn})
khenaidoo92e62c52018-10-03 14:02:54 -0400123 return nil, errors.New("mac-address-not-set")
124 }
David Bainbridged1afd662020-03-26 18:27:41 -0700125
Girish Kumarf56a4682020-03-20 20:07:46 +0000126 logger.Debugw("logical-device-id", log.Fields{"logicaldeviceId": id})
khenaidoob9203542018-09-17 22:56:37 -0400127
David Bainbridged1afd662020-03-26 18:27:41 -0700128 agent := newLogicalDeviceAgent(id, sn, device.Id, ldMgr, ldMgr.deviceMgr, ldMgr.clusterDataProxy, ldMgr.defaultTimeout)
khenaidoob9203542018-09-17 22:56:37 -0400129 ldMgr.addLogicalDeviceAgentToMap(agent)
khenaidooad06fd72019-10-28 12:26:05 -0400130
131 // Update the root device with the logical device Id reference
npujar467fe752020-01-16 20:17:45 +0530132 if err := ldMgr.deviceMgr.setParentID(ctx, device, id); err != nil {
Girish Kumarf56a4682020-03-20 20:07:46 +0000133 logger.Errorw("failed-setting-parent-id", log.Fields{"logicalDeviceId": id, "deviceId": device.Id})
khenaidooad06fd72019-10-28 12:26:05 -0400134 return nil, err
135 }
136
npujar1d86a522019-11-14 17:11:16 +0530137 go func() {
khenaidoo442e7c72020-03-10 16:13:48 -0400138 //agent := newLogicalDeviceAgent(id, device.Id, ldMgr, ldMgr.deviceMgr, ldMgr.clusterDataProxy, ldMgr.defaultTimeout)
139 err := agent.start(context.Background(), false)
npujar1d86a522019-11-14 17:11:16 +0530140 if err != nil {
Girish Kumarf56a4682020-03-20 20:07:46 +0000141 logger.Errorw("unable-to-create-the-logical-device", log.Fields{"error": err})
khenaidoo442e7c72020-03-10 16:13:48 -0400142 ldMgr.deleteLogicalDeviceAgent(id)
npujar1d86a522019-11-14 17:11:16 +0530143 }
144 }()
khenaidoob9203542018-09-17 22:56:37 -0400145
Girish Kumarf56a4682020-03-20 20:07:46 +0000146 logger.Debug("creating-logical-device-ends")
khenaidoob9203542018-09-17 22:56:37 -0400147 return &id, nil
148}
149
khenaidoo6d62c002019-05-15 21:57:03 -0400150// stopManagingLogicalDeviceWithDeviceId stops the management of the logical device. This implies removal of any
151// reference of this logical device in cache. The device Id is passed as param because the logical device may already
152// have been removed from the model. This function returns the logical device Id if found
Kent Hagerman2b216042020-04-03 18:28:56 -0400153func (ldMgr *LogicalManager) stopManagingLogicalDeviceWithDeviceID(ctx context.Context, id string) string {
Girish Kumarf56a4682020-03-20 20:07:46 +0000154 logger.Infow("stop-managing-logical-device", log.Fields{"deviceId": id})
khenaidoo6d62c002019-05-15 21:57:03 -0400155 // Go over the list of logical device agents to find the one which has rootDeviceId as id
npujar1d86a522019-11-14 17:11:16 +0530156 var ldID = ""
Stephane Barbarieef6650d2019-07-18 12:15:09 -0400157 ldMgr.logicalDeviceAgents.Range(func(key, value interface{}) bool {
Kent Hagerman2b216042020-04-03 18:28:56 -0400158 ldAgent := value.(*LogicalAgent)
npujar1d86a522019-11-14 17:11:16 +0530159 if ldAgent.rootDeviceID == id {
Girish Kumarf56a4682020-03-20 20:07:46 +0000160 logger.Infow("stopping-logical-device-agent", log.Fields{"lDeviceId": key})
npujar467fe752020-01-16 20:17:45 +0530161 if err := ldAgent.stop(ctx); err != nil {
Girish Kumarf56a4682020-03-20 20:07:46 +0000162 logger.Errorw("failed-to-stop-LDAgent", log.Fields{"error": err})
Thomas Lee Se5a44012019-11-07 20:32:24 +0530163 return false
164 }
npujar1d86a522019-11-14 17:11:16 +0530165 ldID = key.(string)
166 ldMgr.logicalDeviceAgents.Delete(ldID)
khenaidoo6d62c002019-05-15 21:57:03 -0400167 }
Stephane Barbarieef6650d2019-07-18 12:15:09 -0400168 return true
169 })
npujar1d86a522019-11-14 17:11:16 +0530170 return ldID
khenaidoo6d62c002019-05-15 21:57:03 -0400171}
172
173//getLogicalDeviceFromModel retrieves the logical device data from the model.
Kent Hagerman2b216042020-04-03 18:28:56 -0400174func (ldMgr *LogicalManager) getLogicalDeviceFromModel(ctx context.Context, lDeviceID string) (*voltha.LogicalDevice, error) {
Kent Hagerman4f355f52020-03-30 16:01:33 -0400175 logicalDevice := &voltha.LogicalDevice{}
176 if have, err := ldMgr.clusterDataProxy.Get(ctx, "logical_devices/"+lDeviceID, logicalDevice); err != nil {
Girish Kumarf56a4682020-03-20 20:07:46 +0000177 logger.Errorw("failed-to-get-logical-devices-from-cluster-proxy", log.Fields{"error": err})
Thomas Lee Se5a44012019-11-07 20:32:24 +0530178 return nil, err
Kent Hagerman4f355f52020-03-30 16:01:33 -0400179 } else if !have {
180 return nil, status.Error(codes.NotFound, lDeviceID)
Thomas Lee Se5a44012019-11-07 20:32:24 +0530181 }
Kent Hagerman4f355f52020-03-30 16:01:33 -0400182
183 return logicalDevice, nil
khenaidoo6d62c002019-05-15 21:57:03 -0400184}
185
khenaidoo297cd252019-02-07 22:10:23 -0500186// load loads a logical device manager in memory
Kent Hagerman2b216042020-04-03 18:28:56 -0400187func (ldMgr *LogicalManager) load(ctx context.Context, lDeviceID string) error {
npujar1d86a522019-11-14 17:11:16 +0530188 if lDeviceID == "" {
khenaidoo4c9e5592019-09-09 16:20:41 -0400189 return nil
khenaidoo297cd252019-02-07 22:10:23 -0500190 }
khenaidoo4c9e5592019-09-09 16:20:41 -0400191 // Add a lock to prevent two concurrent calls from loading the same device twice
192 ldMgr.logicalDevicesLoadingLock.Lock()
npujar1d86a522019-11-14 17:11:16 +0530193 if _, exist := ldMgr.logicalDeviceLoadingInProgress[lDeviceID]; !exist {
194 if ldAgent, _ := ldMgr.logicalDeviceAgents.Load(lDeviceID); ldAgent == nil {
195 ldMgr.logicalDeviceLoadingInProgress[lDeviceID] = []chan int{make(chan int, 1)}
khenaidoo4c9e5592019-09-09 16:20:41 -0400196 ldMgr.logicalDevicesLoadingLock.Unlock()
npujar467fe752020-01-16 20:17:45 +0530197 if _, err := ldMgr.getLogicalDeviceFromModel(ctx, lDeviceID); err == nil {
Girish Kumarf56a4682020-03-20 20:07:46 +0000198 logger.Debugw("loading-logical-device", log.Fields{"lDeviceId": lDeviceID})
David Bainbridged1afd662020-03-26 18:27:41 -0700199 agent := newLogicalDeviceAgent(lDeviceID, "", "", ldMgr, ldMgr.deviceMgr, ldMgr.clusterDataProxy, ldMgr.defaultTimeout)
npujar467fe752020-01-16 20:17:45 +0530200 if err := agent.start(ctx, true); err != nil {
khenaidoo442e7c72020-03-10 16:13:48 -0400201 return err
khenaidoo4c9e5592019-09-09 16:20:41 -0400202 }
khenaidoo442e7c72020-03-10 16:13:48 -0400203 ldMgr.logicalDeviceAgents.Store(agent.logicalDeviceID, agent)
khenaidoo4c9e5592019-09-09 16:20:41 -0400204 } else {
Girish Kumarf56a4682020-03-20 20:07:46 +0000205 logger.Debugw("logicalDevice not in model", log.Fields{"lDeviceId": lDeviceID})
khenaidoo4c9e5592019-09-09 16:20:41 -0400206 }
207 // announce completion of task to any number of waiting channels
208 ldMgr.logicalDevicesLoadingLock.Lock()
npujar1d86a522019-11-14 17:11:16 +0530209 if v, ok := ldMgr.logicalDeviceLoadingInProgress[lDeviceID]; ok {
khenaidoo4c9e5592019-09-09 16:20:41 -0400210 for _, ch := range v {
211 close(ch)
212 }
npujar1d86a522019-11-14 17:11:16 +0530213 delete(ldMgr.logicalDeviceLoadingInProgress, lDeviceID)
khenaidoo4c9e5592019-09-09 16:20:41 -0400214 }
215 ldMgr.logicalDevicesLoadingLock.Unlock()
216 } else {
217 ldMgr.logicalDevicesLoadingLock.Unlock()
218 }
219 } else {
220 ch := make(chan int, 1)
npujar1d86a522019-11-14 17:11:16 +0530221 ldMgr.logicalDeviceLoadingInProgress[lDeviceID] = append(ldMgr.logicalDeviceLoadingInProgress[lDeviceID], ch)
khenaidoo4c9e5592019-09-09 16:20:41 -0400222 ldMgr.logicalDevicesLoadingLock.Unlock()
223 // Wait for the channel to be closed, implying the process loading this device is done.
224 <-ch
225 }
npujar1d86a522019-11-14 17:11:16 +0530226 if _, exist := ldMgr.logicalDeviceAgents.Load(lDeviceID); exist {
khenaidoo4c9e5592019-09-09 16:20:41 -0400227 return nil
228 }
npujar1d86a522019-11-14 17:11:16 +0530229 return status.Errorf(codes.Aborted, "Error loading logical device %s", lDeviceID)
khenaidoo297cd252019-02-07 22:10:23 -0500230}
231
Kent Hagerman2b216042020-04-03 18:28:56 -0400232func (ldMgr *LogicalManager) deleteLogicalDevice(ctx context.Context, device *voltha.Device) error {
Girish Kumarf56a4682020-03-20 20:07:46 +0000233 logger.Debugw("deleting-logical-device", log.Fields{"deviceId": device.Id})
khenaidoo92e62c52018-10-03 14:02:54 -0400234 // Sanity check
235 if !device.Root {
khenaidoo2c6a0992019-04-29 13:46:56 -0400236 return errors.New("device-not-root")
khenaidoo92e62c52018-10-03 14:02:54 -0400237 }
npujar1d86a522019-11-14 17:11:16 +0530238 logDeviceID := device.ParentId
npujar467fe752020-01-16 20:17:45 +0530239 if agent := ldMgr.getLogicalDeviceAgent(ctx, logDeviceID); agent != nil {
khenaidoo92e62c52018-10-03 14:02:54 -0400240 // Stop the logical device agent
Thomas Lee Se5a44012019-11-07 20:32:24 +0530241 if err := agent.stop(ctx); err != nil {
Girish Kumarf56a4682020-03-20 20:07:46 +0000242 logger.Errorw("failed-to-stop-agent", log.Fields{"error": err})
Thomas Lee Se5a44012019-11-07 20:32:24 +0530243 return err
244 }
khenaidoo92e62c52018-10-03 14:02:54 -0400245 //Remove the logical device agent from the Map
npujar1d86a522019-11-14 17:11:16 +0530246 ldMgr.deleteLogicalDeviceAgent(logDeviceID)
khenaidoo92e62c52018-10-03 14:02:54 -0400247 }
248
Girish Kumarf56a4682020-03-20 20:07:46 +0000249 logger.Debug("deleting-logical-device-ends")
khenaidoo92e62c52018-10-03 14:02:54 -0400250 return nil
251}
252
Kent Hagerman2b216042020-04-03 18:28:56 -0400253func (ldMgr *LogicalManager) getLogicalDeviceID(ctx context.Context, device *voltha.Device) (*string, error) {
khenaidoo92e62c52018-10-03 14:02:54 -0400254 // Device can either be a parent or a child device
255 if device.Root {
256 // Parent device. The ID of a parent device is the logical device ID
257 return &device.ParentId, nil
258 }
259 // Device is child device
260 // retrieve parent device using child device ID
npujar467fe752020-01-16 20:17:45 +0530261 if parentDevice := ldMgr.deviceMgr.getParentDevice(ctx, device); parentDevice != nil {
khenaidoo92e62c52018-10-03 14:02:54 -0400262 return &parentDevice.ParentId, nil
263 }
264 return nil, status.Errorf(codes.NotFound, "%s", device.Id)
265}
266
Kent Hagerman2b216042020-04-03 18:28:56 -0400267func (ldMgr *LogicalManager) getLogicalDeviceIDFromDeviceID(ctx context.Context, deviceID string) (*string, error) {
khenaidoo3ab34882019-05-02 21:33:30 -0400268 // Get the device
269 var device *voltha.Device
270 var err error
Kent Hagerman45a13e42020-04-13 12:23:50 -0400271 if device, err = ldMgr.deviceMgr.getDevice(ctx, deviceID); err != nil {
khenaidoo3ab34882019-05-02 21:33:30 -0400272 return nil, err
273 }
npujar467fe752020-01-16 20:17:45 +0530274 return ldMgr.getLogicalDeviceID(ctx, device)
khenaidoo3ab34882019-05-02 21:33:30 -0400275}
276
Kent Hagerman2b216042020-04-03 18:28:56 -0400277func (ldMgr *LogicalManager) getLogicalPortID(ctx context.Context, device *voltha.Device) (*voltha.LogicalPortId, error) {
khenaidoo19d7b632018-10-30 10:49:50 -0400278 // Get the logical device where this device is attached
npujar1d86a522019-11-14 17:11:16 +0530279 var lDeviceID *string
khenaidoo19d7b632018-10-30 10:49:50 -0400280 var err error
npujar467fe752020-01-16 20:17:45 +0530281 if lDeviceID, err = ldMgr.getLogicalDeviceID(ctx, device); err != nil {
khenaidoo19d7b632018-10-30 10:49:50 -0400282 return nil, err
283 }
284 var lDevice *voltha.LogicalDevice
Kent Hagerman45a13e42020-04-13 12:23:50 -0400285 if lDevice, err = ldMgr.GetLogicalDevice(ctx, &voltha.ID{Id: *lDeviceID}); err != nil {
khenaidoo19d7b632018-10-30 10:49:50 -0400286 return nil, err
287 }
288 // Go over list of ports
289 for _, port := range lDevice.Ports {
290 if port.DeviceId == device.Id {
npujar1d86a522019-11-14 17:11:16 +0530291 return &voltha.LogicalPortId{Id: *lDeviceID, PortId: port.Id}, nil
khenaidoo19d7b632018-10-30 10:49:50 -0400292 }
293 }
294 return nil, status.Errorf(codes.NotFound, "%s", device.Id)
295}
296
npujar1d86a522019-11-14 17:11:16 +0530297// ListLogicalDeviceFlows returns the flows of logical device
Kent Hagerman45a13e42020-04-13 12:23:50 -0400298func (ldMgr *LogicalManager) ListLogicalDeviceFlows(ctx context.Context, id *voltha.ID) (*openflow_13.Flows, error) {
299 logger.Debugw("ListLogicalDeviceFlows", log.Fields{"logicaldeviceid": id.Id})
Kent Hagerman433a31a2020-05-20 19:04:48 -0400300 agent := ldMgr.getLogicalDeviceAgent(ctx, id.Id)
301 if agent == nil {
302 return nil, status.Errorf(codes.NotFound, "%s", id.Id)
khenaidoodd237172019-05-27 16:37:17 -0400303 }
Kent Hagerman433a31a2020-05-20 19:04:48 -0400304
305 flows := agent.listLogicalDeviceFlows()
306 ctr, ret := 0, make([]*openflow_13.OfpFlowStats, len(flows))
307 for _, flow := range flows {
308 ret[ctr] = flow
309 ctr++
310 }
311 return &openflow_13.Flows{Items: ret}, nil
khenaidoodd237172019-05-27 16:37:17 -0400312}
313
npujar1d86a522019-11-14 17:11:16 +0530314// ListLogicalDeviceFlowGroups returns logical device flow groups
Kent Hagerman45a13e42020-04-13 12:23:50 -0400315func (ldMgr *LogicalManager) ListLogicalDeviceFlowGroups(ctx context.Context, id *voltha.ID) (*openflow_13.FlowGroups, error) {
316 logger.Debugw("ListLogicalDeviceFlowGroups", log.Fields{"logicaldeviceid": id.Id})
Kent Hagerman433a31a2020-05-20 19:04:48 -0400317 agent := ldMgr.getLogicalDeviceAgent(ctx, id.Id)
318 if agent == nil {
319 return nil, status.Errorf(codes.NotFound, "%s", id.Id)
khenaidoodd237172019-05-27 16:37:17 -0400320 }
Kent Hagerman433a31a2020-05-20 19:04:48 -0400321
322 groups := agent.listLogicalDeviceGroups()
323 ctr, ret := 0, make([]*openflow_13.OfpGroupEntry, len(groups))
324 for _, group := range groups {
325 ret[ctr] = group
326 ctr++
327 }
328 return &openflow_13.FlowGroups{Items: ret}, nil
khenaidoodd237172019-05-27 16:37:17 -0400329}
330
npujar1d86a522019-11-14 17:11:16 +0530331// ListLogicalDevicePorts returns logical device ports
Kent Hagerman45a13e42020-04-13 12:23:50 -0400332func (ldMgr *LogicalManager) ListLogicalDevicePorts(ctx context.Context, id *voltha.ID) (*voltha.LogicalPorts, error) {
333 logger.Debugw("ListLogicalDevicePorts", log.Fields{"logicaldeviceid": id.Id})
334 if agent := ldMgr.getLogicalDeviceAgent(ctx, id.Id); agent != nil {
khenaidoo442e7c72020-03-10 16:13:48 -0400335 return agent.ListLogicalDevicePorts(ctx)
khenaidoo19d7b632018-10-30 10:49:50 -0400336 }
Kent Hagerman45a13e42020-04-13 12:23:50 -0400337 return nil, status.Errorf(codes.NotFound, "%s", id.Id)
khenaidoo19d7b632018-10-30 10:49:50 -0400338}
339
Kent Hagerman45a13e42020-04-13 12:23:50 -0400340// GetLogicalDevicePort returns logical device port details
341func (ldMgr *LogicalManager) GetLogicalDevicePort(ctx context.Context, lPortID *voltha.LogicalPortId) (*voltha.LogicalPort, error) {
khenaidoo19d7b632018-10-30 10:49:50 -0400342 // Get the logical device where this device is attached
343 var err error
344 var lDevice *voltha.LogicalDevice
Kent Hagerman45a13e42020-04-13 12:23:50 -0400345 if lDevice, err = ldMgr.GetLogicalDevice(ctx, &voltha.ID{Id: lPortID.Id}); err != nil {
khenaidoo19d7b632018-10-30 10:49:50 -0400346 return nil, err
347 }
348 // Go over list of ports
349 for _, port := range lDevice.Ports {
npujar1d86a522019-11-14 17:11:16 +0530350 if port.Id == lPortID.PortId {
khenaidoo19d7b632018-10-30 10:49:50 -0400351 return port, nil
352 }
353 }
npujar1d86a522019-11-14 17:11:16 +0530354 return nil, status.Errorf(codes.NotFound, "%s-%s", lPortID.Id, lPortID.PortId)
khenaidoo19d7b632018-10-30 10:49:50 -0400355}
356
khenaidoo2c6a0992019-04-29 13:46:56 -0400357// updateLogicalPort sets up a logical port on the logical device based on the device port
358// information, if needed
Kent Hagerman2b216042020-04-03 18:28:56 -0400359func (ldMgr *LogicalManager) updateLogicalPort(ctx context.Context, device *voltha.Device, port *voltha.Port) error {
npujar467fe752020-01-16 20:17:45 +0530360 ldID, err := ldMgr.getLogicalDeviceID(ctx, device)
npujar1d86a522019-11-14 17:11:16 +0530361 if err != nil || *ldID == "" {
khenaidoo2c6a0992019-04-29 13:46:56 -0400362 // This is not an error as the logical device may not have been created at this time. In such a case,
363 // the ports will be created when the logical device is ready.
364 return nil
khenaidoo2c6a0992019-04-29 13:46:56 -0400365 }
npujar467fe752020-01-16 20:17:45 +0530366 if agent := ldMgr.getLogicalDeviceAgent(ctx, *ldID); agent != nil {
367 if err := agent.updateLogicalPort(ctx, device, port); err != nil {
npujar1d86a522019-11-14 17:11:16 +0530368 return err
khenaidoofc1314d2019-03-14 09:34:21 -0400369 }
370 }
371 return nil
372}
373
khenaidoo0a822f92019-05-08 15:15:57 -0400374// deleteLogicalPort removes the logical port associated with a device
Kent Hagerman2b216042020-04-03 18:28:56 -0400375func (ldMgr *LogicalManager) deleteLogicalPort(ctx context.Context, lPortID *voltha.LogicalPortId) error {
Girish Kumarf56a4682020-03-20 20:07:46 +0000376 logger.Debugw("deleting-logical-port", log.Fields{"LDeviceId": lPortID.Id})
khenaidoo19d7b632018-10-30 10:49:50 -0400377 // Get logical port
378 var logicalPort *voltha.LogicalPort
379 var err error
Kent Hagerman45a13e42020-04-13 12:23:50 -0400380 if logicalPort, err = ldMgr.GetLogicalDevicePort(ctx, lPortID); err != nil {
Girish Kumarf56a4682020-03-20 20:07:46 +0000381 logger.Debugw("no-logical-device-port-present", log.Fields{"logicalPortId": lPortID.PortId})
khenaidoo19d7b632018-10-30 10:49:50 -0400382 return err
383 }
khenaidoo92e62c52018-10-03 14:02:54 -0400384 // Sanity check
khenaidoo19d7b632018-10-30 10:49:50 -0400385 if logicalPort.RootPort {
khenaidoo2c6a0992019-04-29 13:46:56 -0400386 return errors.New("device-root")
khenaidoo92e62c52018-10-03 14:02:54 -0400387 }
npujar467fe752020-01-16 20:17:45 +0530388 if agent := ldMgr.getLogicalDeviceAgent(ctx, lPortID.Id); agent != nil {
389 if err := agent.deleteLogicalPort(ctx, logicalPort); err != nil {
Girish Kumarf56a4682020-03-20 20:07:46 +0000390 logger.Warnw("deleting-logicalport-failed", log.Fields{"LDeviceId": lPortID.Id, "error": err})
khenaidoo0a822f92019-05-08 15:15:57 -0400391 }
khenaidoo92e62c52018-10-03 14:02:54 -0400392 }
393
Girish Kumarf56a4682020-03-20 20:07:46 +0000394 logger.Debug("deleting-logical-port-ends")
khenaidoo92e62c52018-10-03 14:02:54 -0400395 return nil
396}
397
khenaidoo0a822f92019-05-08 15:15:57 -0400398// deleteLogicalPort removes the logical port associated with a child device
Kent Hagerman2b216042020-04-03 18:28:56 -0400399func (ldMgr *LogicalManager) deleteLogicalPorts(ctx context.Context, deviceID string) error {
Andrea Campanella09400bd2020-04-02 11:58:04 +0200400 logger.Debugw("deleting-logical-ports", log.Fields{"device-id": deviceID})
khenaidoo0a822f92019-05-08 15:15:57 -0400401 // Get logical port
npujar467fe752020-01-16 20:17:45 +0530402 ldID, err := ldMgr.getLogicalDeviceIDFromDeviceID(ctx, deviceID)
npujar1d86a522019-11-14 17:11:16 +0530403 if err != nil {
khenaidoo0a822f92019-05-08 15:15:57 -0400404 return err
npujar1d86a522019-11-14 17:11:16 +0530405 }
npujar467fe752020-01-16 20:17:45 +0530406 if agent := ldMgr.getLogicalDeviceAgent(ctx, *ldID); agent != nil {
407 if err = agent.deleteLogicalPorts(ctx, deviceID); err != nil {
Andrea Campanella09400bd2020-04-02 11:58:04 +0200408 logger.Warnw("delete-logical-ports-failed", log.Fields{"logical-device-id": *ldID})
npujar1d86a522019-11-14 17:11:16 +0530409 return err
khenaidoo0a822f92019-05-08 15:15:57 -0400410 }
411 }
Andrea Campanella09400bd2020-04-02 11:58:04 +0200412 logger.Debug("deleting-logical-ports-ends")
khenaidoo0a822f92019-05-08 15:15:57 -0400413 return nil
414}
415
Kent Hagerman2b216042020-04-03 18:28:56 -0400416func (ldMgr *LogicalManager) setupUNILogicalPorts(ctx context.Context, childDevice *voltha.Device) error {
Girish Kumarf56a4682020-03-20 20:07:46 +0000417 logger.Debugw("setupUNILogicalPorts", log.Fields{"childDeviceId": childDevice.Id, "parentDeviceId": childDevice.ParentId, "current-data": childDevice})
khenaidoob9203542018-09-17 22:56:37 -0400418 // Sanity check
419 if childDevice.Root {
420 return errors.New("Device-root")
421 }
422
423 // Get the logical device id parent device
npujar1d86a522019-11-14 17:11:16 +0530424 parentID := childDevice.ParentId
npujar467fe752020-01-16 20:17:45 +0530425 logDeviceID := ldMgr.deviceMgr.GetParentDeviceID(ctx, parentID)
khenaidoob9203542018-09-17 22:56:37 -0400426
Girish Kumarf56a4682020-03-20 20:07:46 +0000427 logger.Debugw("setupUNILogicalPorts", log.Fields{"logDeviceId": logDeviceID, "parentId": parentID})
khenaidoob9203542018-09-17 22:56:37 -0400428
npujar1d86a522019-11-14 17:11:16 +0530429 if parentID == "" || logDeviceID == "" {
khenaidoo2c6a0992019-04-29 13:46:56 -0400430 return errors.New("device-in-invalid-state")
khenaidoo5e677ae2019-02-28 17:26:29 -0500431 }
432
npujar467fe752020-01-16 20:17:45 +0530433 if agent := ldMgr.getLogicalDeviceAgent(ctx, logDeviceID); agent != nil {
khenaidoofc1314d2019-03-14 09:34:21 -0400434 if err := agent.setupUNILogicalPorts(ctx, childDevice); err != nil {
khenaidoobcf205b2019-01-25 22:21:14 -0500435 return err
436 }
khenaidoob9203542018-09-17 22:56:37 -0400437 }
khenaidoo21d51152019-02-01 13:48:37 -0500438 return nil
khenaidoob9203542018-09-17 22:56:37 -0400439}
khenaidoo19d7b632018-10-30 10:49:50 -0400440
Kent Hagerman2b216042020-04-03 18:28:56 -0400441func (ldMgr *LogicalManager) deleteAllLogicalPorts(ctx context.Context, device *voltha.Device) error {
Girish Kumarf56a4682020-03-20 20:07:46 +0000442 logger.Debugw("deleteAllLogicalPorts", log.Fields{"deviceId": device.Id})
khenaidoo0a822f92019-05-08 15:15:57 -0400443
npujar1d86a522019-11-14 17:11:16 +0530444 var ldID *string
khenaidoo0a822f92019-05-08 15:15:57 -0400445 var err error
446 //Get the logical device Id for this device
npujar467fe752020-01-16 20:17:45 +0530447 if ldID, err = ldMgr.getLogicalDeviceID(ctx, device); err != nil {
Girish Kumarf56a4682020-03-20 20:07:46 +0000448 logger.Warnw("no-logical-device-found", log.Fields{"deviceId": device.Id, "error": err})
khenaidoo0a822f92019-05-08 15:15:57 -0400449 return err
450 }
npujar467fe752020-01-16 20:17:45 +0530451 if agent := ldMgr.getLogicalDeviceAgent(ctx, *ldID); agent != nil {
Girish Gowdra408cd962020-03-11 14:31:31 -0700452 if err := agent.deleteAllLogicalPorts(ctx); err != nil {
khenaidoo0a822f92019-05-08 15:15:57 -0400453 return err
454 }
455 }
456 return nil
457}
Hardik Windlassc704def2020-02-26 18:23:19 +0000458
Kent Hagerman2b216042020-04-03 18:28:56 -0400459func (ldMgr *LogicalManager) updatePortState(ctx context.Context, deviceID string, portNo uint32, state voltha.OperStatus_Types) error {
Girish Kumarf56a4682020-03-20 20:07:46 +0000460 logger.Debugw("updatePortState", log.Fields{"deviceId": deviceID, "state": state, "portNo": portNo})
khenaidoo171b98e2019-10-31 11:48:15 -0400461
npujar1d86a522019-11-14 17:11:16 +0530462 var ldID *string
khenaidoo171b98e2019-10-31 11:48:15 -0400463 var err error
464 //Get the logical device Id for this device
npujar467fe752020-01-16 20:17:45 +0530465 if ldID, err = ldMgr.getLogicalDeviceIDFromDeviceID(ctx, deviceID); err != nil {
Girish Kumarf56a4682020-03-20 20:07:46 +0000466 logger.Warnw("no-logical-device-found", log.Fields{"deviceId": deviceID, "error": err})
khenaidoo171b98e2019-10-31 11:48:15 -0400467 return err
468 }
npujar467fe752020-01-16 20:17:45 +0530469 if agent := ldMgr.getLogicalDeviceAgent(ctx, *ldID); agent != nil {
470 if err := agent.updatePortState(ctx, deviceID, portNo, state); err != nil {
khenaidoo171b98e2019-10-31 11:48:15 -0400471 return err
472 }
473 }
474 return nil
475}
khenaidoo0a822f92019-05-08 15:15:57 -0400476
Kent Hagerman2b216042020-04-03 18:28:56 -0400477func (ldMgr *LogicalManager) updatePortsState(ctx context.Context, device *voltha.Device, state voltha.OperStatus_Types) error {
Girish Kumarf56a4682020-03-20 20:07:46 +0000478 logger.Debugw("updatePortsState", log.Fields{"deviceId": device.Id, "state": state, "current-data": device})
khenaidoo3ab34882019-05-02 21:33:30 -0400479
npujar1d86a522019-11-14 17:11:16 +0530480 var ldID *string
khenaidoo3ab34882019-05-02 21:33:30 -0400481 var err error
482 //Get the logical device Id for this device
npujar467fe752020-01-16 20:17:45 +0530483 if ldID, err = ldMgr.getLogicalDeviceID(ctx, device); err != nil {
Girish Kumarf56a4682020-03-20 20:07:46 +0000484 logger.Warnw("no-logical-device-found", log.Fields{"deviceId": device.Id, "error": err})
khenaidoo3ab34882019-05-02 21:33:30 -0400485 return err
486 }
npujar467fe752020-01-16 20:17:45 +0530487 if agent := ldMgr.getLogicalDeviceAgent(ctx, *ldID); agent != nil {
488 if err := agent.updatePortsState(ctx, device, state); err != nil {
khenaidoo3ab34882019-05-02 21:33:30 -0400489 return err
490 }
491 }
492 return nil
493}
494
Kent Hagerman45a13e42020-04-13 12:23:50 -0400495// UpdateLogicalDeviceFlowTable updates logical device flow table
496func (ldMgr *LogicalManager) UpdateLogicalDeviceFlowTable(ctx context.Context, flow *openflow_13.FlowTableUpdate) (*empty.Empty, error) {
497 logger.Debugw("UpdateLogicalDeviceFlowTable", log.Fields{"logicalDeviceId": flow.Id})
498 agent := ldMgr.getLogicalDeviceAgent(ctx, flow.Id)
499 if agent == nil {
500 return nil, status.Errorf(codes.NotFound, "%s", flow.Id)
khenaidoo19d7b632018-10-30 10:49:50 -0400501 }
Kent Hagerman45a13e42020-04-13 12:23:50 -0400502 return &empty.Empty{}, agent.updateFlowTable(ctx, flow.FlowMod)
khenaidoo19d7b632018-10-30 10:49:50 -0400503}
504
Kent Hagerman45a13e42020-04-13 12:23:50 -0400505// UpdateLogicalDeviceMeterTable - This function sends meter mod request to logical device manager and waits for response
506func (ldMgr *LogicalManager) UpdateLogicalDeviceMeterTable(ctx context.Context, meter *openflow_13.MeterModUpdate) (*empty.Empty, error) {
507 logger.Debugw("UpdateLogicalDeviceMeterTable", log.Fields{"logicalDeviceId": meter.Id})
508 agent := ldMgr.getLogicalDeviceAgent(ctx, meter.Id)
509 if agent == nil {
510 return nil, status.Errorf(codes.NotFound, "%s", meter.Id)
Manikkaraj kb1a10922019-07-29 12:10:34 -0400511 }
Kent Hagerman45a13e42020-04-13 12:23:50 -0400512 return &empty.Empty{}, agent.updateMeterTable(ctx, meter.MeterMod)
Manikkaraj kb1a10922019-07-29 12:10:34 -0400513}
514
npujar1d86a522019-11-14 17:11:16 +0530515// ListLogicalDeviceMeters returns logical device meters
Kent Hagerman45a13e42020-04-13 12:23:50 -0400516func (ldMgr *LogicalManager) ListLogicalDeviceMeters(ctx context.Context, id *voltha.ID) (*openflow_13.Meters, error) {
517 logger.Debugw("ListLogicalDeviceMeters", log.Fields{"logicalDeviceId": id.Id})
518 agent := ldMgr.getLogicalDeviceAgent(ctx, id.Id)
519 if agent == nil {
520 return nil, status.Errorf(codes.NotFound, "%s", id.Id)
Manikkaraj kb1a10922019-07-29 12:10:34 -0400521 }
Kent Hagerman433a31a2020-05-20 19:04:48 -0400522 meters := agent.listLogicalDeviceMeters()
523 ctr, ret := 0, make([]*openflow_13.OfpMeterEntry, len(meters))
524 for _, meter := range meters {
525 ret[ctr] = meter
526 ctr++
527 }
528 return &openflow_13.Meters{Items: ret}, nil
khenaidoo19d7b632018-10-30 10:49:50 -0400529}
530
Kent Hagerman45a13e42020-04-13 12:23:50 -0400531// UpdateLogicalDeviceFlowGroupTable updates logical device flow group table
532func (ldMgr *LogicalManager) UpdateLogicalDeviceFlowGroupTable(ctx context.Context, flow *openflow_13.FlowGroupTableUpdate) (*empty.Empty, error) {
533 logger.Debugw("UpdateGroupTable", log.Fields{"logicalDeviceId": flow.Id})
534 agent := ldMgr.getLogicalDeviceAgent(ctx, flow.Id)
535 if agent == nil {
536 return nil, status.Errorf(codes.NotFound, "%s", flow.Id)
khenaidoo19d7b632018-10-30 10:49:50 -0400537 }
Kent Hagerman45a13e42020-04-13 12:23:50 -0400538 return &empty.Empty{}, agent.updateGroupTable(ctx, flow.GroupMod)
khenaidoo19d7b632018-10-30 10:49:50 -0400539}
540
Kent Hagerman45a13e42020-04-13 12:23:50 -0400541// EnableLogicalDevicePort enables logical device port
542func (ldMgr *LogicalManager) EnableLogicalDevicePort(ctx context.Context, id *voltha.LogicalPortId) (*empty.Empty, error) {
543 logger.Debugw("EnableLogicalDevicePort", log.Fields{"logicalDeviceId": id})
544 agent := ldMgr.getLogicalDeviceAgent(ctx, id.Id)
545 if agent == nil {
546 return nil, status.Errorf(codes.NotFound, "%s", id.Id)
khenaidoo19d7b632018-10-30 10:49:50 -0400547 }
Kent Hagerman45a13e42020-04-13 12:23:50 -0400548 return &empty.Empty{}, agent.enableLogicalPort(ctx, id.PortId)
549}
550
551// DisableLogicalDevicePort disables logical device port
552func (ldMgr *LogicalManager) DisableLogicalDevicePort(ctx context.Context, id *voltha.LogicalPortId) (*empty.Empty, error) {
553 logger.Debugw("DisableLogicalDevicePort", log.Fields{"logicalDeviceId": id})
554 agent := ldMgr.getLogicalDeviceAgent(ctx, id.Id)
555 if agent == nil {
556 return nil, status.Errorf(codes.NotFound, "%s", id.Id)
557 }
558 return &empty.Empty{}, agent.disableLogicalPort(ctx, id.PortId)
khenaidoo19d7b632018-10-30 10:49:50 -0400559}
khenaidoofdbad6e2018-11-06 22:26:38 -0500560
Kent Hagerman2b216042020-04-03 18:28:56 -0400561func (ldMgr *LogicalManager) packetIn(ctx context.Context, logicalDeviceID string, port uint32, transactionID string, packet []byte) error {
Girish Kumarf56a4682020-03-20 20:07:46 +0000562 logger.Debugw("packetIn", log.Fields{"logicalDeviceId": logicalDeviceID, "port": port})
npujar467fe752020-01-16 20:17:45 +0530563 if agent := ldMgr.getLogicalDeviceAgent(ctx, logicalDeviceID); agent != nil {
npujar1d86a522019-11-14 17:11:16 +0530564 agent.packetIn(port, transactionID, packet)
khenaidoofdbad6e2018-11-06 22:26:38 -0500565 } else {
Girish Kumarf56a4682020-03-20 20:07:46 +0000566 logger.Error("logical-device-not-exist", log.Fields{"logicalDeviceId": logicalDeviceID})
khenaidoofdbad6e2018-11-06 22:26:38 -0500567 }
568 return nil
569}
Kent Hagerman2b216042020-04-03 18:28:56 -0400570
Kent Hagerman45a13e42020-04-13 12:23:50 -0400571// StreamPacketsOut sends packets to adapter
572func (ldMgr *LogicalManager) StreamPacketsOut(packets voltha.VolthaService_StreamPacketsOutServer) error {
573 logger.Debugw("StreamPacketsOut-request", log.Fields{"packets": packets})
574loop:
575 for {
576 select {
577 case <-packets.Context().Done():
578 logger.Infow("StreamPacketsOut-context-done", log.Fields{"packets": packets, "error": packets.Context().Err()})
579 break loop
580 default:
581 }
582
583 packet, err := packets.Recv()
584
585 if err == io.EOF {
586 logger.Debugw("Received-EOF", log.Fields{"packets": packets})
587 break loop
588 }
589
590 if err != nil {
591 logger.Errorw("Failed to receive packet out", log.Fields{"error": err})
592 continue
593 }
594
595 if agent := ldMgr.getLogicalDeviceAgent(packets.Context(), packet.Id); agent != nil {
596 agent.packetOut(packets.Context(), packet.PacketOut)
597 } else {
598 logger.Errorf("No logical device agent present", log.Fields{"logicalDeviceID": packet.Id})
599 }
Kent Hagerman2b216042020-04-03 18:28:56 -0400600 }
Kent Hagerman45a13e42020-04-13 12:23:50 -0400601
602 logger.Debugw("StreamPacketsOut-request-done", log.Fields{"packets": packets})
603 return nil
Kent Hagerman2b216042020-04-03 18:28:56 -0400604}