khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 1 | /* |
| 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 | */ |
npujar | 1d86a52 | 2019-11-14 17:11:16 +0530 | [diff] [blame] | 16 | |
Kent Hagerman | 2b21604 | 2020-04-03 18:28:56 -0400 | [diff] [blame] | 17 | package device |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 18 | |
| 19 | import ( |
| 20 | "context" |
Matteo Scandolo | 360605d | 2019-11-05 18:29:17 -0800 | [diff] [blame] | 21 | "encoding/hex" |
Kent Hagerman | 4f355f5 | 2020-03-30 16:01:33 -0400 | [diff] [blame] | 22 | "errors" |
khenaidoo | 3ab3488 | 2019-05-02 21:33:30 -0400 | [diff] [blame] | 23 | "fmt" |
Mahir Gunyel | b0343bf | 2021-05-11 14:14:26 -0700 | [diff] [blame] | 24 | "reflect" |
| 25 | "sync" |
| 26 | "time" |
| 27 | |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 28 | "github.com/opencord/voltha-protos/v5/go/adapter_services" |
| 29 | "github.com/opencord/voltha-protos/v5/go/core" |
| 30 | |
Maninder | 0aabf0c | 2021-03-17 14:55:14 +0530 | [diff] [blame] | 31 | "github.com/cenkalti/backoff/v3" |
Maninder | 9a1bc0d | 2020-10-26 11:34:02 +0530 | [diff] [blame] | 32 | "github.com/gogo/protobuf/proto" |
Maninder | 9a1bc0d | 2020-10-26 11:34:02 +0530 | [diff] [blame] | 33 | "github.com/golang/protobuf/ptypes/empty" |
Maninder | 0aabf0c | 2021-03-17 14:55:14 +0530 | [diff] [blame] | 34 | "github.com/opencord/voltha-go/rw_core/config" |
Maninder | 9a1bc0d | 2020-10-26 11:34:02 +0530 | [diff] [blame] | 35 | "google.golang.org/grpc/codes" |
| 36 | "google.golang.org/grpc/status" |
Mahir Gunyel | addb66a | 2020-04-29 18:08:50 -0700 | [diff] [blame] | 37 | |
Himani Chawla | 2ba1c9c | 2020-10-07 13:19:03 +0530 | [diff] [blame] | 38 | "github.com/opencord/voltha-go/db/model" |
Kent Hagerman | 2b21604 | 2020-04-03 18:28:56 -0400 | [diff] [blame] | 39 | "github.com/opencord/voltha-go/rw_core/core/adapter" |
Mahir Gunyel | 03de0d3 | 2020-06-03 01:36:59 -0700 | [diff] [blame] | 40 | "github.com/opencord/voltha-go/rw_core/core/device/flow" |
| 41 | "github.com/opencord/voltha-go/rw_core/core/device/group" |
Kent Hagerman | 2a07b86 | 2020-06-19 15:23:07 -0400 | [diff] [blame] | 42 | "github.com/opencord/voltha-go/rw_core/core/device/port" |
Himani Chawla | 2ba1c9c | 2020-10-07 13:19:03 +0530 | [diff] [blame] | 43 | "github.com/opencord/voltha-go/rw_core/core/device/transientstate" |
Scott Baker | b671a86 | 2019-10-24 10:53:40 -0700 | [diff] [blame] | 44 | coreutils "github.com/opencord/voltha-go/rw_core/utils" |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 45 | "github.com/opencord/voltha-lib-go/v7/pkg/log" |
| 46 | "github.com/opencord/voltha-protos/v5/go/common" |
| 47 | "github.com/opencord/voltha-protos/v5/go/extension" |
| 48 | ic "github.com/opencord/voltha-protos/v5/go/inter_container" |
| 49 | ofp "github.com/opencord/voltha-protos/v5/go/openflow_13" |
| 50 | "github.com/opencord/voltha-protos/v5/go/voltha" |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 51 | ) |
| 52 | |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 53 | var errReconcileAborted = errors.New("reconcile aborted") |
| 54 | var errContextExpired = errors.New("context expired") |
| 55 | |
Kent Hagerman | 2b21604 | 2020-04-03 18:28:56 -0400 | [diff] [blame] | 56 | // Agent represents device agent attributes |
| 57 | type Agent struct { |
Maninder | 0aabf0c | 2021-03-17 14:55:14 +0530 | [diff] [blame] | 58 | deviceID string |
| 59 | parentID string |
| 60 | deviceType string |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 61 | adapterEndpoint string |
Maninder | 0aabf0c | 2021-03-17 14:55:14 +0530 | [diff] [blame] | 62 | isRootDevice bool |
Maninder | 0aabf0c | 2021-03-17 14:55:14 +0530 | [diff] [blame] | 63 | adapterMgr *adapter.Manager |
| 64 | deviceMgr *Manager |
| 65 | dbProxy *model.Proxy |
| 66 | exitChannel chan int |
| 67 | device *voltha.Device |
| 68 | requestQueue *coreutils.RequestQueue |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 69 | internalTimeout time.Duration |
| 70 | rpcTimeout time.Duration |
Maninder | 0aabf0c | 2021-03-17 14:55:14 +0530 | [diff] [blame] | 71 | startOnce sync.Once |
| 72 | stopOnce sync.Once |
| 73 | stopped bool |
| 74 | stopReconciling chan int |
| 75 | stopReconcilingMutex sync.RWMutex |
| 76 | config *config.RWCoreFlags |
Mahir Gunyel | 03de0d3 | 2020-06-03 01:36:59 -0700 | [diff] [blame] | 77 | |
khenaidoo | 7585a96 | 2021-06-10 16:15:38 -0400 | [diff] [blame] | 78 | flowCache *flow.Cache |
| 79 | groupCache *group.Cache |
Himani Chawla | 2ba1c9c | 2020-10-07 13:19:03 +0530 | [diff] [blame] | 80 | portLoader *port.Loader |
| 81 | transientStateLoader *transientstate.Loader |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 82 | } |
| 83 | |
Kent Hagerman | 2b21604 | 2020-04-03 18:28:56 -0400 | [diff] [blame] | 84 | //newAgent creates a new device agent. The device will be initialized when start() is called. |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 85 | func newAgent(device *voltha.Device, deviceMgr *Manager, dbPath *model.Path, deviceProxy *model.Proxy, internalTimeout, rpcTimeout time.Duration) *Agent { |
Kent Hagerman | 2a07b86 | 2020-06-19 15:23:07 -0400 | [diff] [blame] | 86 | deviceID := device.Id |
| 87 | if deviceID == "" { |
| 88 | deviceID = coreutils.CreateDeviceID() |
Stephane Barbarie | 1ab4327 | 2018-12-08 21:42:13 -0500 | [diff] [blame] | 89 | } |
Scott Baker | 8067860 | 2019-11-14 16:57:36 -0800 | [diff] [blame] | 90 | |
Kent Hagerman | 2a07b86 | 2020-06-19 15:23:07 -0400 | [diff] [blame] | 91 | return &Agent{ |
Himani Chawla | 2ba1c9c | 2020-10-07 13:19:03 +0530 | [diff] [blame] | 92 | deviceID: deviceID, |
Himani Chawla | 2ba1c9c | 2020-10-07 13:19:03 +0530 | [diff] [blame] | 93 | isRootDevice: device.Root, |
| 94 | parentID: device.ParentId, |
| 95 | deviceType: device.Type, |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 96 | adapterEndpoint: device.AdapterEndpoint, |
Himani Chawla | 2ba1c9c | 2020-10-07 13:19:03 +0530 | [diff] [blame] | 97 | deviceMgr: deviceMgr, |
| 98 | adapterMgr: deviceMgr.adapterMgr, |
| 99 | exitChannel: make(chan int, 1), |
| 100 | dbProxy: deviceProxy, |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 101 | internalTimeout: internalTimeout, |
| 102 | rpcTimeout: rpcTimeout, |
Himani Chawla | 2ba1c9c | 2020-10-07 13:19:03 +0530 | [diff] [blame] | 103 | device: proto.Clone(device).(*voltha.Device), |
| 104 | requestQueue: coreutils.NewRequestQueue(), |
Maninder | 0aabf0c | 2021-03-17 14:55:14 +0530 | [diff] [blame] | 105 | config: deviceMgr.config, |
khenaidoo | 7585a96 | 2021-06-10 16:15:38 -0400 | [diff] [blame] | 106 | flowCache: flow.NewCache(), |
| 107 | groupCache: group.NewCache(), |
Himani Chawla | 2ba1c9c | 2020-10-07 13:19:03 +0530 | [diff] [blame] | 108 | portLoader: port.NewLoader(dbPath.SubPath("ports").Proxy(deviceID)), |
| 109 | transientStateLoader: transientstate.NewLoader(dbPath.SubPath("core").Proxy("transientstate"), deviceID), |
Kent Hagerman | 2a07b86 | 2020-06-19 15:23:07 -0400 | [diff] [blame] | 110 | } |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 111 | } |
| 112 | |
khenaidoo | 442e7c7 | 2020-03-10 16:13:48 -0400 | [diff] [blame] | 113 | // start() saves the device to the data model and registers for callbacks on that device if deviceToCreate!=nil. |
| 114 | // Otherwise, it will load the data from the dB and setup the necessary callbacks and proxies. Returns the device that |
Scott Baker | 8067860 | 2019-11-14 16:57:36 -0800 | [diff] [blame] | 115 | // was started. |
khenaidoo | 7585a96 | 2021-06-10 16:15:38 -0400 | [diff] [blame] | 116 | func (agent *Agent) start(ctx context.Context, deviceExist bool, deviceToCreate *voltha.Device) (*voltha.Device, error) { |
khenaidoo | 442e7c7 | 2020-03-10 16:13:48 -0400 | [diff] [blame] | 117 | needToStart := false |
| 118 | if agent.startOnce.Do(func() { needToStart = true }); !needToStart { |
Kent Hagerman | cba2f30 | 2020-07-28 13:37:36 -0400 | [diff] [blame] | 119 | return agent.getDeviceReadOnly(ctx) |
khenaidoo | 442e7c7 | 2020-03-10 16:13:48 -0400 | [diff] [blame] | 120 | } |
| 121 | var startSucceeded bool |
| 122 | defer func() { |
| 123 | if !startSucceeded { |
| 124 | if err := agent.stop(ctx); err != nil { |
Rohan Agrawal | 31f2180 | 2020-06-12 05:38:46 +0000 | [diff] [blame] | 125 | logger.Errorw(ctx, "failed-to-cleanup-after-unsuccessful-start", log.Fields{"device-id": agent.deviceID, "error": err}) |
khenaidoo | 442e7c7 | 2020-03-10 16:13:48 -0400 | [diff] [blame] | 126 | } |
| 127 | } |
| 128 | }() |
khenaidoo | 7585a96 | 2021-06-10 16:15:38 -0400 | [diff] [blame] | 129 | if deviceExist { |
| 130 | device := deviceToCreate |
| 131 | if device == nil { |
| 132 | // Load from dB |
| 133 | device = &voltha.Device{} |
| 134 | have, err := agent.dbProxy.Get(ctx, agent.deviceID, device) |
| 135 | if err != nil { |
| 136 | return nil, err |
| 137 | } else if !have { |
| 138 | return nil, status.Errorf(codes.NotFound, "device-%s", agent.deviceID) |
| 139 | } |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 140 | logger.Infow(ctx, "device-loaded-from-db", log.Fields{"device-id": agent.deviceID, "adapter-endpoint": device.AdapterEndpoint, "type": device.Type}) |
Thomas Lee S | e5a4401 | 2019-11-07 20:32:24 +0530 | [diff] [blame] | 141 | } |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 142 | agent.deviceType = device.Type |
| 143 | agent.adapterEndpoint = device.AdapterEndpoint |
Kent Hagerman | 4f355f5 | 2020-03-30 16:01:33 -0400 | [diff] [blame] | 144 | agent.device = proto.Clone(device).(*voltha.Device) |
khenaidoo | 7585a96 | 2021-06-10 16:15:38 -0400 | [diff] [blame] | 145 | // load the ports from KV to cache |
Kent Hagerman | 2a07b86 | 2020-06-19 15:23:07 -0400 | [diff] [blame] | 146 | agent.portLoader.Load(ctx) |
Himani Chawla | 2ba1c9c | 2020-10-07 13:19:03 +0530 | [diff] [blame] | 147 | agent.transientStateLoader.Load(ctx) |
khenaidoo | 297cd25 | 2019-02-07 22:10:23 -0500 | [diff] [blame] | 148 | } else { |
Scott Baker | 8067860 | 2019-11-14 16:57:36 -0800 | [diff] [blame] | 149 | // Create a new device |
Maninder | 9a1bc0d | 2020-10-26 11:34:02 +0530 | [diff] [blame] | 150 | var desc string |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 151 | var err error |
Maninder | 9a1bc0d | 2020-10-26 11:34:02 +0530 | [diff] [blame] | 152 | prevState := common.AdminState_UNKNOWN |
| 153 | currState := common.AdminState_UNKNOWN |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 154 | requestStatus := &common.OperationResp{Code: common.OperationResp_OPERATION_FAILURE} |
Maninder | 9a1bc0d | 2020-10-26 11:34:02 +0530 | [diff] [blame] | 155 | |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 156 | defer func() { agent.logDeviceUpdate(ctx, &prevState, &currState, requestStatus, err, desc) }() |
Maninder | 9a1bc0d | 2020-10-26 11:34:02 +0530 | [diff] [blame] | 157 | |
Kent Hagerman | f5a6735 | 2020-04-30 15:15:26 -0400 | [diff] [blame] | 158 | // Assumption is that AdminState, FlowGroups, and Flows are uninitialized since this |
| 159 | // is a new device, so populate them here before passing the device to ldProxy.Set. |
Kent Hagerman | 2b21604 | 2020-04-03 18:28:56 -0400 | [diff] [blame] | 160 | // agent.deviceId will also have been set during newAgent(). |
khenaidoo | 7585a96 | 2021-06-10 16:15:38 -0400 | [diff] [blame] | 161 | device := (proto.Clone(deviceToCreate)).(*voltha.Device) |
npujar | 1d86a52 | 2019-11-14 17:11:16 +0530 | [diff] [blame] | 162 | device.Id = agent.deviceID |
Scott Baker | 8067860 | 2019-11-14 16:57:36 -0800 | [diff] [blame] | 163 | device.AdminState = voltha.AdminState_PREPROVISIONED |
Maninder | 9a1bc0d | 2020-10-26 11:34:02 +0530 | [diff] [blame] | 164 | currState = device.AdminState |
Scott Baker | 8067860 | 2019-11-14 16:57:36 -0800 | [diff] [blame] | 165 | if !deviceToCreate.GetRoot() && deviceToCreate.ProxyAddress != nil { |
| 166 | // Set the default vlan ID to the one specified by the parent adapter. It can be |
| 167 | // overwritten by the child adapter during a device update request |
| 168 | device.Vlan = deviceToCreate.ProxyAddress.ChannelId |
| 169 | } |
| 170 | |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 171 | // Save the device to the model |
| 172 | if err = agent.dbProxy.Set(ctx, agent.deviceID, device); err != nil { |
| 173 | err = status.Errorf(codes.Aborted, "failed-adding-device-%s: %s", agent.deviceID, err) |
| 174 | return nil, err |
khenaidoo | 297cd25 | 2019-02-07 22:10:23 -0500 | [diff] [blame] | 175 | } |
Mahir Gunyel | b0343bf | 2021-05-11 14:14:26 -0700 | [diff] [blame] | 176 | _ = agent.deviceMgr.Agent.SendDeviceStateChangeEvent(ctx, device.OperStatus, device.ConnectStatus, prevState, device, time.Now().Unix()) |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 177 | requestStatus.Code = common.OperationResp_OPERATION_SUCCESS |
khenaidoo | 442e7c7 | 2020-03-10 16:13:48 -0400 | [diff] [blame] | 178 | agent.device = device |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 179 | } |
khenaidoo | 442e7c7 | 2020-03-10 16:13:48 -0400 | [diff] [blame] | 180 | startSucceeded = true |
Rohan Agrawal | cf12f20 | 2020-08-03 04:42:01 +0000 | [diff] [blame] | 181 | log.EnrichSpan(ctx, log.Fields{"device-id": agent.deviceID}) |
Rohan Agrawal | 31f2180 | 2020-06-12 05:38:46 +0000 | [diff] [blame] | 182 | logger.Debugw(ctx, "device-agent-started", log.Fields{"device-id": agent.deviceID}) |
khenaidoo | 442e7c7 | 2020-03-10 16:13:48 -0400 | [diff] [blame] | 183 | |
Kent Hagerman | cba2f30 | 2020-07-28 13:37:36 -0400 | [diff] [blame] | 184 | return agent.getDeviceReadOnly(ctx) |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 185 | } |
| 186 | |
khenaidoo | 4d4802d | 2018-10-04 21:59:49 -0400 | [diff] [blame] | 187 | // stop stops the device agent. Not much to do for now |
Kent Hagerman | 2b21604 | 2020-04-03 18:28:56 -0400 | [diff] [blame] | 188 | func (agent *Agent) stop(ctx context.Context) error { |
khenaidoo | 442e7c7 | 2020-03-10 16:13:48 -0400 | [diff] [blame] | 189 | needToStop := false |
| 190 | if agent.stopOnce.Do(func() { needToStop = true }); !needToStop { |
| 191 | return nil |
| 192 | } |
| 193 | if err := agent.requestQueue.WaitForGreenLight(ctx); err != nil { |
| 194 | return err |
| 195 | } |
| 196 | defer agent.requestQueue.RequestComplete() |
khenaidoo | 4908535 | 2020-01-13 19:15:43 -0500 | [diff] [blame] | 197 | |
Himani Chawla | b4c2591 | 2020-11-12 17:16:38 +0530 | [diff] [blame] | 198 | logger.Infow(ctx, "stopping-device-agent", log.Fields{"device-id": agent.deviceID, "parent-id": agent.parentID}) |
Himani Chawla | 2ba1c9c | 2020-10-07 13:19:03 +0530 | [diff] [blame] | 199 | // Remove the device transient loader |
| 200 | if err := agent.deleteTransientState(ctx); err != nil { |
| 201 | return err |
| 202 | } |
khenaidoo | 0a822f9 | 2019-05-08 15:15:57 -0400 | [diff] [blame] | 203 | // Remove the device from the KV store |
Kent Hagerman | f5a6735 | 2020-04-30 15:15:26 -0400 | [diff] [blame] | 204 | if err := agent.dbProxy.Remove(ctx, agent.deviceID); err != nil { |
khenaidoo | 442e7c7 | 2020-03-10 16:13:48 -0400 | [diff] [blame] | 205 | return err |
Thomas Lee S | e5a4401 | 2019-11-07 20:32:24 +0530 | [diff] [blame] | 206 | } |
khenaidoo | 442e7c7 | 2020-03-10 16:13:48 -0400 | [diff] [blame] | 207 | |
khenaidoo | 442e7c7 | 2020-03-10 16:13:48 -0400 | [diff] [blame] | 208 | close(agent.exitChannel) |
| 209 | |
| 210 | agent.stopped = true |
| 211 | |
Rohan Agrawal | 31f2180 | 2020-06-12 05:38:46 +0000 | [diff] [blame] | 212 | logger.Infow(ctx, "device-agent-stopped", log.Fields{"device-id": agent.deviceID, "parent-id": agent.parentID}) |
khenaidoo | 442e7c7 | 2020-03-10 16:13:48 -0400 | [diff] [blame] | 213 | |
| 214 | return nil |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 215 | } |
| 216 | |
Scott Baker | 8067860 | 2019-11-14 16:57:36 -0800 | [diff] [blame] | 217 | // Load the most recent state from the KVStore for the device. |
Kent Hagerman | 2b21604 | 2020-04-03 18:28:56 -0400 | [diff] [blame] | 218 | func (agent *Agent) reconcileWithKVStore(ctx context.Context) { |
khenaidoo | 442e7c7 | 2020-03-10 16:13:48 -0400 | [diff] [blame] | 219 | if err := agent.requestQueue.WaitForGreenLight(ctx); err != nil { |
Rohan Agrawal | 31f2180 | 2020-06-12 05:38:46 +0000 | [diff] [blame] | 220 | logger.Warnw(ctx, "request-aborted", log.Fields{"device-id": agent.deviceID, "error": err}) |
khenaidoo | 442e7c7 | 2020-03-10 16:13:48 -0400 | [diff] [blame] | 221 | return |
| 222 | } |
| 223 | defer agent.requestQueue.RequestComplete() |
Rohan Agrawal | 31f2180 | 2020-06-12 05:38:46 +0000 | [diff] [blame] | 224 | logger.Debug(ctx, "reconciling-device-agent-devicetype") |
Scott Baker | 8067860 | 2019-11-14 16:57:36 -0800 | [diff] [blame] | 225 | // TODO: context timeout |
Kent Hagerman | 4f355f5 | 2020-03-30 16:01:33 -0400 | [diff] [blame] | 226 | device := &voltha.Device{} |
Kent Hagerman | f5a6735 | 2020-04-30 15:15:26 -0400 | [diff] [blame] | 227 | if have, err := agent.dbProxy.Get(ctx, agent.deviceID, device); err != nil { |
Rohan Agrawal | 31f2180 | 2020-06-12 05:38:46 +0000 | [diff] [blame] | 228 | logger.Errorw(ctx, "kv-get-failed", log.Fields{"device-id": agent.deviceID, "error": err}) |
Thomas Lee S | e5a4401 | 2019-11-07 20:32:24 +0530 | [diff] [blame] | 229 | return |
Kent Hagerman | 4f355f5 | 2020-03-30 16:01:33 -0400 | [diff] [blame] | 230 | } else if !have { |
| 231 | return // not found in kv |
Thomas Lee S | e5a4401 | 2019-11-07 20:32:24 +0530 | [diff] [blame] | 232 | } |
Kent Hagerman | 4f355f5 | 2020-03-30 16:01:33 -0400 | [diff] [blame] | 233 | |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 234 | agent.deviceType = device.Type |
Kent Hagerman | 4f355f5 | 2020-03-30 16:01:33 -0400 | [diff] [blame] | 235 | agent.device = device |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 236 | agent.adapterEndpoint = device.AdapterEndpoint |
Kent Hagerman | 2a07b86 | 2020-06-19 15:23:07 -0400 | [diff] [blame] | 237 | agent.portLoader.Load(ctx) |
Himani Chawla | 2ba1c9c | 2020-10-07 13:19:03 +0530 | [diff] [blame] | 238 | agent.transientStateLoader.Load(ctx) |
| 239 | |
Rohan Agrawal | 31f2180 | 2020-06-12 05:38:46 +0000 | [diff] [blame] | 240 | logger.Debugw(ctx, "reconciled-device-agent-devicetype", log.Fields{"device-id": agent.deviceID, "type": agent.deviceType}) |
Scott Baker | 8067860 | 2019-11-14 16:57:36 -0800 | [diff] [blame] | 241 | } |
| 242 | |
khenaidoo | 442e7c7 | 2020-03-10 16:13:48 -0400 | [diff] [blame] | 243 | // onSuccess is a common callback for scenarios where we receive a nil response following a request to an adapter |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 244 | func (agent *Agent) onSuccess(ctx context.Context, prevState, currState *common.AdminState_Types, deviceUpdateLog bool) { |
| 245 | if deviceUpdateLog { |
| 246 | requestStatus := &common.OperationResp{Code: common.OperationResp_OPERATION_SUCCESS} |
| 247 | desc := "adapter-response" |
| 248 | agent.logDeviceUpdate(ctx, prevState, currState, requestStatus, nil, desc) |
| 249 | return |
| 250 | } |
| 251 | logger.Debugw(ctx, "successful-operation", log.Fields{"device-id": agent.deviceID, "rpc": coreutils.GetRPCMetadataFromContext(ctx)}) |
khenaidoo | 442e7c7 | 2020-03-10 16:13:48 -0400 | [diff] [blame] | 252 | } |
| 253 | |
| 254 | // onFailure is a common callback for scenarios where we receive an error response following a request to an adapter |
| 255 | // and the only action required is to publish the failed result on kafka |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 256 | func (agent *Agent) onFailure(ctx context.Context, err error, prevState, currState *common.AdminState_Types, deviceUpdateLog bool) { |
| 257 | // Send an event on kafka |
| 258 | rpce := agent.deviceMgr.NewRPCEvent(ctx, agent.deviceID, err.Error(), nil) |
| 259 | go agent.deviceMgr.SendRPCEvent(ctx, "RPC_ERROR_RAISE_EVENT", rpce, |
| 260 | voltha.EventCategory_COMMUNICATION, nil, time.Now().Unix()) |
khenaidoo | 442e7c7 | 2020-03-10 16:13:48 -0400 | [diff] [blame] | 261 | |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 262 | // Log the device update event |
| 263 | if deviceUpdateLog { |
| 264 | requestStatus := &common.OperationResp{Code: common.OperationResp_OPERATION_FAILURE} |
| 265 | desc := "adapter-response" |
| 266 | agent.logDeviceUpdate(ctx, prevState, currState, requestStatus, err, desc) |
| 267 | return |
khenaidoo | 442e7c7 | 2020-03-10 16:13:48 -0400 | [diff] [blame] | 268 | } |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 269 | logger.Errorw(ctx, "failed-operation", log.Fields{"error": err, "device-id": agent.deviceID, "rpc": coreutils.GetRPCMetadataFromContext(ctx)}) |
khenaidoo | 442e7c7 | 2020-03-10 16:13:48 -0400 | [diff] [blame] | 270 | } |
| 271 | |
Himani Chawla | 2ba1c9c | 2020-10-07 13:19:03 +0530 | [diff] [blame] | 272 | // onDeleteSuccess is a common callback for scenarios where we receive a nil response following a delete request |
| 273 | // to an adapter. |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 274 | func (agent *Agent) onDeleteSuccess(ctx context.Context, prevState, currState *common.AdminState_Types) { |
Himani Chawla | 2ba1c9c | 2020-10-07 13:19:03 +0530 | [diff] [blame] | 275 | if err := agent.requestQueue.WaitForGreenLight(ctx); err != nil { |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 276 | logger.Errorw(ctx, "delete-device-failure", log.Fields{"device-id": agent.deviceID, "error": err}) |
Himani Chawla | 2ba1c9c | 2020-10-07 13:19:03 +0530 | [diff] [blame] | 277 | } |
| 278 | previousDeviceTransientState := agent.getTransientState() |
| 279 | newDevice := agent.cloneDeviceWithoutLock() |
| 280 | if err := agent.updateDeviceWithTransientStateAndReleaseLock(ctx, newDevice, |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 281 | core.DeviceTransientState_DELETING_POST_ADAPTER_RESPONSE, previousDeviceTransientState); err != nil { |
| 282 | logger.Errorw(ctx, "delete-device-failure", log.Fields{"device-id": agent.deviceID, "error": err}) |
Himani Chawla | 2ba1c9c | 2020-10-07 13:19:03 +0530 | [diff] [blame] | 283 | } |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 284 | requestStatus := &common.OperationResp{Code: common.OperationResp_OPERATION_SUCCESS} |
| 285 | desc := "adapter-response" |
| 286 | agent.logDeviceUpdate(ctx, prevState, currState, requestStatus, nil, desc) |
Himani Chawla | 2ba1c9c | 2020-10-07 13:19:03 +0530 | [diff] [blame] | 287 | } |
| 288 | |
| 289 | // onDeleteFailure is a common callback for scenarios where we receive an error response following a delete request |
| 290 | // to an adapter and the only action required is to return the error response. |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 291 | func (agent *Agent) onDeleteFailure(ctx context.Context, err error, prevState, currState *common.AdminState_Types) { |
| 292 | logger.Errorw(ctx, "rpc-failed", log.Fields{"rpc": coreutils.GetRPCMetadataFromContext(ctx), "device-id": agent.deviceID, "error": err}) |
| 293 | |
Himani Chawla | 2ba1c9c | 2020-10-07 13:19:03 +0530 | [diff] [blame] | 294 | //Only updating of transient state is required, no transition. |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 295 | if er := agent.updateTransientState(ctx, core.DeviceTransientState_DELETE_FAILED); er != nil { |
| 296 | logger.Errorw(ctx, "failed-to-update-transient-state-as-delete-failed", log.Fields{"device-id": agent.deviceID, "error": er}) |
Himani Chawla | 2ba1c9c | 2020-10-07 13:19:03 +0530 | [diff] [blame] | 297 | } |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 298 | rpce := agent.deviceMgr.NewRPCEvent(ctx, agent.deviceID, err.Error(), nil) |
| 299 | go agent.deviceMgr.SendRPCEvent(ctx, "RPC_ERROR_RAISE_EVENT", rpce, |
| 300 | voltha.EventCategory_COMMUNICATION, nil, time.Now().Unix()) |
Himani Chawla | 2ba1c9c | 2020-10-07 13:19:03 +0530 | [diff] [blame] | 301 | |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 302 | // Log the device update event |
| 303 | requestStatus := &common.OperationResp{Code: common.OperationResp_OPERATION_FAILURE} |
| 304 | desc := "adapter-response" |
| 305 | agent.logDeviceUpdate(ctx, prevState, currState, requestStatus, err, desc) |
Maninder | 9a1bc0d | 2020-10-26 11:34:02 +0530 | [diff] [blame] | 306 | } |
| 307 | |
Kent Hagerman | cba2f30 | 2020-07-28 13:37:36 -0400 | [diff] [blame] | 308 | // getDeviceReadOnly returns a device which MUST NOT be modified, but is safe to keep forever. |
| 309 | func (agent *Agent) getDeviceReadOnly(ctx context.Context) (*voltha.Device, error) { |
khenaidoo | 442e7c7 | 2020-03-10 16:13:48 -0400 | [diff] [blame] | 310 | if err := agent.requestQueue.WaitForGreenLight(ctx); err != nil { |
| 311 | return nil, err |
| 312 | } |
| 313 | defer agent.requestQueue.RequestComplete() |
Kent Hagerman | cba2f30 | 2020-07-28 13:37:36 -0400 | [diff] [blame] | 314 | return agent.device, nil |
khenaidoo | 92e62c5 | 2018-10-03 14:02:54 -0400 | [diff] [blame] | 315 | } |
| 316 | |
Kent Hagerman | cba2f30 | 2020-07-28 13:37:36 -0400 | [diff] [blame] | 317 | // getDeviceReadOnlyWithoutLock returns a device which MUST NOT be modified, but is safe to keep forever. This is very efficient. |
Kent Hagerman | f6db9f1 | 2020-07-22 17:16:19 -0400 | [diff] [blame] | 318 | // The device lock MUST be held by the caller. |
Kent Hagerman | cba2f30 | 2020-07-28 13:37:36 -0400 | [diff] [blame] | 319 | func (agent *Agent) getDeviceReadOnlyWithoutLock() *voltha.Device { |
khenaidoo | 0db4c81 | 2020-05-27 15:27:30 -0400 | [diff] [blame] | 320 | return agent.device |
khenaidoo | 92e62c5 | 2018-10-03 14:02:54 -0400 | [diff] [blame] | 321 | } |
| 322 | |
Kent Hagerman | f6db9f1 | 2020-07-22 17:16:19 -0400 | [diff] [blame] | 323 | // cloneDeviceWithoutLock returns a copy of the device which is safe to modify. |
| 324 | // The device lock MUST be held by the caller. |
| 325 | func (agent *Agent) cloneDeviceWithoutLock() *voltha.Device { |
| 326 | return proto.Clone(agent.device).(*voltha.Device) |
| 327 | } |
| 328 | |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 329 | func (agent *Agent) updateDeviceTypeAndEndpoint(ctx context.Context) error { |
| 330 | if err := agent.requestQueue.WaitForGreenLight(ctx); err != nil { |
| 331 | return err |
| 332 | } |
| 333 | changed := false |
| 334 | cloned := agent.cloneDeviceWithoutLock() |
| 335 | if cloned.Type == "" { |
| 336 | adapterType, err := agent.adapterMgr.GetAdapterType(cloned.Type) |
| 337 | if err != nil { |
| 338 | agent.requestQueue.RequestComplete() |
| 339 | return err |
| 340 | } |
| 341 | cloned.Type = adapterType |
| 342 | changed = true |
| 343 | } |
| 344 | |
| 345 | if cloned.AdapterEndpoint == "" { |
| 346 | var err error |
| 347 | if cloned.AdapterEndpoint, err = agent.adapterMgr.GetAdapterEndpoint(ctx, cloned.Id, cloned.Type); err != nil { |
| 348 | agent.requestQueue.RequestComplete() |
| 349 | return err |
| 350 | } |
| 351 | agent.adapterEndpoint = cloned.AdapterEndpoint |
| 352 | changed = true |
| 353 | } |
| 354 | |
| 355 | if changed { |
| 356 | return agent.updateDeviceAndReleaseLock(ctx, cloned) |
| 357 | } |
| 358 | agent.requestQueue.RequestComplete() |
| 359 | return nil |
| 360 | } |
| 361 | |
khenaidoo | 3ab3488 | 2019-05-02 21:33:30 -0400 | [diff] [blame] | 362 | // enableDevice activates a preprovisioned or a disable device |
Kent Hagerman | 2b21604 | 2020-04-03 18:28:56 -0400 | [diff] [blame] | 363 | func (agent *Agent) enableDevice(ctx context.Context) error { |
Maninder | 9a1bc0d | 2020-10-26 11:34:02 +0530 | [diff] [blame] | 364 | //To preserve and use oldDevice state as prev state in new device |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 365 | var err error |
Maninder | 9a1bc0d | 2020-10-26 11:34:02 +0530 | [diff] [blame] | 366 | var desc string |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 367 | var prevAdminState, currAdminState common.AdminState_Types |
| 368 | requestStatus := &common.OperationResp{Code: common.OperationResp_OPERATION_FAILURE} |
Maninder | 9a1bc0d | 2020-10-26 11:34:02 +0530 | [diff] [blame] | 369 | |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 370 | defer func() { agent.logDeviceUpdate(ctx, &prevAdminState, &currAdminState, requestStatus, err, desc) }() |
Maninder | 9a1bc0d | 2020-10-26 11:34:02 +0530 | [diff] [blame] | 371 | |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 372 | if err = agent.requestQueue.WaitForGreenLight(ctx); err != nil { |
khenaidoo | 442e7c7 | 2020-03-10 16:13:48 -0400 | [diff] [blame] | 373 | return err |
| 374 | } |
Himani Chawla | b4c2591 | 2020-11-12 17:16:38 +0530 | [diff] [blame] | 375 | logger.Debugw(ctx, "enable-device", log.Fields{"device-id": agent.deviceID}) |
khenaidoo | 21d5115 | 2019-02-01 13:48:37 -0500 | [diff] [blame] | 376 | |
Kent Hagerman | cba2f30 | 2020-07-28 13:37:36 -0400 | [diff] [blame] | 377 | oldDevice := agent.getDeviceReadOnlyWithoutLock() |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 378 | prevAdminState = oldDevice.AdminState |
Maninder | 9a1bc0d | 2020-10-26 11:34:02 +0530 | [diff] [blame] | 379 | |
Maninder | 2195ccc | 2021-06-23 20:23:01 +0530 | [diff] [blame] | 380 | if !agent.proceedWithRequest(oldDevice) { |
| 381 | agent.requestQueue.RequestComplete() |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 382 | err = status.Errorf(codes.FailedPrecondition, "cannot complete operation as device deletion is in progress or reconciling is in progress/failed: %s", agent.deviceID) |
| 383 | return err |
Maninder | 2195ccc | 2021-06-23 20:23:01 +0530 | [diff] [blame] | 384 | } |
| 385 | |
Kent Hagerman | f6db9f1 | 2020-07-22 17:16:19 -0400 | [diff] [blame] | 386 | if oldDevice.AdminState == voltha.AdminState_ENABLED { |
| 387 | logger.Warnw(ctx, "device-already-enabled", log.Fields{"device-id": agent.deviceID}) |
| 388 | agent.requestQueue.RequestComplete() |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 389 | err = status.Errorf(codes.FailedPrecondition, fmt.Sprintf("cannot-enable-an-already-enabled-device: %s", oldDevice.Id)) |
Matteo Scandolo | d525ae3 | 2020-04-02 17:27:29 -0700 | [diff] [blame] | 390 | return err |
npujar | 1d86a52 | 2019-11-14 17:11:16 +0530 | [diff] [blame] | 391 | } |
| 392 | |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 393 | // Verify whether there is a device type that supports this device type |
| 394 | _, err = agent.adapterMgr.GetAdapterType(oldDevice.Type) |
| 395 | if err != nil { |
| 396 | agent.requestQueue.RequestComplete() |
| 397 | return err |
| 398 | } |
| 399 | |
| 400 | // Update device adapter endpoint if not set. This is set once by the Core and use as is by the adapters. E.g if this is a |
| 401 | // child device then the parent adapter will use this device's adapter endpoint (set here) to communicate with it. |
Kent Hagerman | f6db9f1 | 2020-07-22 17:16:19 -0400 | [diff] [blame] | 402 | newDevice := agent.cloneDeviceWithoutLock() |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 403 | if newDevice.AdapterEndpoint == "" { |
| 404 | if newDevice.AdapterEndpoint, err = agent.adapterMgr.GetAdapterEndpoint(ctx, newDevice.Id, newDevice.Type); err != nil { |
| 405 | agent.requestQueue.RequestComplete() |
| 406 | return err |
| 407 | } |
| 408 | agent.adapterEndpoint = newDevice.AdapterEndpoint |
| 409 | } |
npujar | 1d86a52 | 2019-11-14 17:11:16 +0530 | [diff] [blame] | 410 | |
Kent Hagerman | f6db9f1 | 2020-07-22 17:16:19 -0400 | [diff] [blame] | 411 | // Update the Admin State and set the operational state to activating before sending the request to the Adapters |
| 412 | newDevice.AdminState = voltha.AdminState_ENABLED |
| 413 | newDevice.OperStatus = voltha.OperStatus_ACTIVATING |
Maninder | 9a1bc0d | 2020-10-26 11:34:02 +0530 | [diff] [blame] | 414 | |
khenaidoo | 442e7c7 | 2020-03-10 16:13:48 -0400 | [diff] [blame] | 415 | // Adopt the device if it was in pre-provision state. In all other cases, try to re-enable it. |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 416 | client, err := agent.adapterMgr.GetAdapterClient(ctx, agent.adapterEndpoint) |
khenaidoo | 442e7c7 | 2020-03-10 16:13:48 -0400 | [diff] [blame] | 417 | if err != nil { |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 418 | logger.Errorw(ctx, "grpc-client-nil", |
| 419 | log.Fields{ |
| 420 | "error": err, |
| 421 | "device-id": agent.deviceID, |
| 422 | "device-type": agent.deviceType, |
| 423 | "adapter-endpoint": newDevice.AdapterEndpoint, |
| 424 | }) |
| 425 | agent.requestQueue.RequestComplete() |
khenaidoo | 442e7c7 | 2020-03-10 16:13:48 -0400 | [diff] [blame] | 426 | return err |
| 427 | } |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 428 | subCtx, cancel := context.WithTimeout(coreutils.WithAllMetadataFromContext(ctx), agent.rpcTimeout) |
| 429 | requestStatus.Code = common.OperationResp_OPERATION_IN_PROGRESS |
| 430 | go func() { |
| 431 | defer cancel() |
| 432 | var err error |
| 433 | if oldDevice.AdminState == voltha.AdminState_PREPROVISIONED { |
| 434 | _, err = client.AdoptDevice(subCtx, newDevice) |
| 435 | } else { |
| 436 | _, err = client.ReEnableDevice(subCtx, newDevice) |
| 437 | } |
| 438 | if err == nil { |
| 439 | agent.onSuccess(subCtx, nil, nil, true) |
| 440 | } else { |
| 441 | agent.onFailure(subCtx, err, nil, nil, true) |
Himani Chawla | b4c2591 | 2020-11-12 17:16:38 +0530 | [diff] [blame] | 442 | } |
| 443 | }() |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 444 | |
| 445 | // Update device |
| 446 | if err = agent.updateDeviceAndReleaseLock(ctx, newDevice); err != nil { |
| 447 | return err |
khenaidoo | 2c6a099 | 2019-04-29 13:46:56 -0400 | [diff] [blame] | 448 | } |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 449 | currAdminState = newDevice.AdminState |
| 450 | return nil |
khenaidoo | 2c6a099 | 2019-04-29 13:46:56 -0400 | [diff] [blame] | 451 | } |
| 452 | |
A R Karthick | 5c28f55 | 2019-12-11 22:47:44 -0800 | [diff] [blame] | 453 | //addFlowsAndGroups adds the "newFlows" and "newGroups" from the existing flows/groups and sends the update to the |
| 454 | //adapters |
Kent Hagerman | 2b21604 | 2020-04-03 18:28:56 -0400 | [diff] [blame] | 455 | func (agent *Agent) addFlowsAndGroups(ctx context.Context, newFlows []*ofp.OfpFlowStats, newGroups []*ofp.OfpGroupEntry, flowMetadata *voltha.FlowMetadata) error { |
Mahir Gunyel | 03de0d3 | 2020-06-03 01:36:59 -0700 | [diff] [blame] | 456 | var flwResponse, grpResponse coreutils.Response |
| 457 | var err error |
| 458 | //if new flow list is empty then the called function returns quickly |
| 459 | if flwResponse, err = agent.addFlowsToAdapter(ctx, newFlows, flowMetadata); err != nil { |
A R Karthick | 5c28f55 | 2019-12-11 22:47:44 -0800 | [diff] [blame] | 460 | return err |
| 461 | } |
Mahir Gunyel | 03de0d3 | 2020-06-03 01:36:59 -0700 | [diff] [blame] | 462 | //if new group list is empty then the called function returns quickly |
| 463 | if grpResponse, err = agent.addGroupsToAdapter(ctx, newGroups, flowMetadata); err != nil { |
| 464 | return err |
| 465 | } |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 466 | if errs := coreutils.WaitForNilOrErrorResponses(agent.rpcTimeout, flwResponse, grpResponse); errs != nil { |
| 467 | logger.Warnw(ctx, "adapter-response", log.Fields{"device-id": agent.deviceID, "result": errs}) |
khenaidoo | 442e7c7 | 2020-03-10 16:13:48 -0400 | [diff] [blame] | 468 | return status.Errorf(codes.Aborted, "flow-failure-device-%s", agent.deviceID) |
khenaidoo | 0458db6 | 2019-06-20 08:50:36 -0400 | [diff] [blame] | 469 | } |
khenaidoo | 0458db6 | 2019-06-20 08:50:36 -0400 | [diff] [blame] | 470 | return nil |
| 471 | } |
| 472 | |
A R Karthick | 5c28f55 | 2019-12-11 22:47:44 -0800 | [diff] [blame] | 473 | //deleteFlowsAndGroups removes the "flowsToDel" and "groupsToDel" from the existing flows/groups and sends the update to the |
| 474 | //adapters |
Kent Hagerman | 2b21604 | 2020-04-03 18:28:56 -0400 | [diff] [blame] | 475 | func (agent *Agent) deleteFlowsAndGroups(ctx context.Context, flowsToDel []*ofp.OfpFlowStats, groupsToDel []*ofp.OfpGroupEntry, flowMetadata *voltha.FlowMetadata) error { |
Mahir Gunyel | 03de0d3 | 2020-06-03 01:36:59 -0700 | [diff] [blame] | 476 | var flwResponse, grpResponse coreutils.Response |
| 477 | var err error |
| 478 | if flwResponse, err = agent.deleteFlowsFromAdapter(ctx, flowsToDel, flowMetadata); err != nil { |
A R Karthick | 5c28f55 | 2019-12-11 22:47:44 -0800 | [diff] [blame] | 479 | return err |
| 480 | } |
Mahir Gunyel | 03de0d3 | 2020-06-03 01:36:59 -0700 | [diff] [blame] | 481 | if grpResponse, err = agent.deleteGroupsFromAdapter(ctx, groupsToDel, flowMetadata); err != nil { |
| 482 | return err |
| 483 | } |
| 484 | |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 485 | if res := coreutils.WaitForNilOrErrorResponses(agent.rpcTimeout, flwResponse, grpResponse); res != nil { |
khenaidoo | 0458db6 | 2019-06-20 08:50:36 -0400 | [diff] [blame] | 486 | return status.Errorf(codes.Aborted, "errors-%s", res) |
| 487 | } |
| 488 | return nil |
khenaidoo | 0458db6 | 2019-06-20 08:50:36 -0400 | [diff] [blame] | 489 | } |
| 490 | |
A R Karthick | 5c28f55 | 2019-12-11 22:47:44 -0800 | [diff] [blame] | 491 | //updateFlowsAndGroups replaces the existing flows and groups with "updatedFlows" and "updatedGroups" respectively. It |
| 492 | //also sends the updates to the adapters |
Kent Hagerman | 2b21604 | 2020-04-03 18:28:56 -0400 | [diff] [blame] | 493 | func (agent *Agent) updateFlowsAndGroups(ctx context.Context, updatedFlows []*ofp.OfpFlowStats, updatedGroups []*ofp.OfpGroupEntry, flowMetadata *voltha.FlowMetadata) error { |
Mahir Gunyel | 03de0d3 | 2020-06-03 01:36:59 -0700 | [diff] [blame] | 494 | var flwResponse, grpResponse coreutils.Response |
| 495 | var err error |
| 496 | if flwResponse, err = agent.updateFlowsToAdapter(ctx, updatedFlows, flowMetadata); err != nil { |
A R Karthick | 5c28f55 | 2019-12-11 22:47:44 -0800 | [diff] [blame] | 497 | return err |
| 498 | } |
Mahir Gunyel | 03de0d3 | 2020-06-03 01:36:59 -0700 | [diff] [blame] | 499 | if grpResponse, err = agent.updateGroupsToAdapter(ctx, updatedGroups, flowMetadata); err != nil { |
| 500 | return err |
| 501 | } |
| 502 | |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 503 | if res := coreutils.WaitForNilOrErrorResponses(agent.rpcTimeout, flwResponse, grpResponse); res != nil { |
khenaidoo | 0458db6 | 2019-06-20 08:50:36 -0400 | [diff] [blame] | 504 | return status.Errorf(codes.Aborted, "errors-%s", res) |
| 505 | } |
| 506 | return nil |
khenaidoo | 19d7b63 | 2018-10-30 10:49:50 -0400 | [diff] [blame] | 507 | } |
| 508 | |
khenaidoo | 4d4802d | 2018-10-04 21:59:49 -0400 | [diff] [blame] | 509 | //disableDevice disable a device |
Kent Hagerman | 2b21604 | 2020-04-03 18:28:56 -0400 | [diff] [blame] | 510 | func (agent *Agent) disableDevice(ctx context.Context) error { |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 511 | var err error |
Maninder | 9a1bc0d | 2020-10-26 11:34:02 +0530 | [diff] [blame] | 512 | var desc string |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 513 | var prevAdminState, currAdminState common.AdminState_Types |
| 514 | requestStatus := &common.OperationResp{Code: common.OperationResp_OPERATION_FAILURE} |
| 515 | defer func() { agent.logDeviceUpdate(ctx, &prevAdminState, &currAdminState, requestStatus, err, desc) }() |
Maninder | 9a1bc0d | 2020-10-26 11:34:02 +0530 | [diff] [blame] | 516 | |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 517 | if err = agent.requestQueue.WaitForGreenLight(ctx); err != nil { |
khenaidoo | 442e7c7 | 2020-03-10 16:13:48 -0400 | [diff] [blame] | 518 | return err |
| 519 | } |
Himani Chawla | b4c2591 | 2020-11-12 17:16:38 +0530 | [diff] [blame] | 520 | logger.Debugw(ctx, "disable-device", log.Fields{"device-id": agent.deviceID}) |
khenaidoo | 6e55d9e | 2019-12-12 18:26:26 -0500 | [diff] [blame] | 521 | |
Kent Hagerman | f6db9f1 | 2020-07-22 17:16:19 -0400 | [diff] [blame] | 522 | cloned := agent.cloneDeviceWithoutLock() |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 523 | prevAdminState = agent.device.AdminState |
khenaidoo | 6e55d9e | 2019-12-12 18:26:26 -0500 | [diff] [blame] | 524 | |
Maninder | 2195ccc | 2021-06-23 20:23:01 +0530 | [diff] [blame] | 525 | if !agent.proceedWithRequest(cloned) { |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 526 | err = status.Errorf(codes.FailedPrecondition, "cannot complete operation as device deletion is in progress or reconciling is in progress/failed: %s", agent.deviceID) |
Maninder | 2195ccc | 2021-06-23 20:23:01 +0530 | [diff] [blame] | 527 | agent.requestQueue.RequestComplete() |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 528 | return err |
Maninder | 2195ccc | 2021-06-23 20:23:01 +0530 | [diff] [blame] | 529 | } |
| 530 | |
khenaidoo | 6e55d9e | 2019-12-12 18:26:26 -0500 | [diff] [blame] | 531 | if cloned.AdminState == voltha.AdminState_DISABLED { |
Maninder | 9a1bc0d | 2020-10-26 11:34:02 +0530 | [diff] [blame] | 532 | desc = "device-already-disabled" |
Kent Hagerman | f6db9f1 | 2020-07-22 17:16:19 -0400 | [diff] [blame] | 533 | agent.requestQueue.RequestComplete() |
npujar | 1d86a52 | 2019-11-14 17:11:16 +0530 | [diff] [blame] | 534 | return nil |
| 535 | } |
Himani Chawla | 2ba1c9c | 2020-10-07 13:19:03 +0530 | [diff] [blame] | 536 | if cloned.AdminState == voltha.AdminState_PREPROVISIONED { |
Kent Hagerman | f6db9f1 | 2020-07-22 17:16:19 -0400 | [diff] [blame] | 537 | agent.requestQueue.RequestComplete() |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 538 | err = status.Errorf(codes.FailedPrecondition, "deviceId:%s, invalid-admin-state:%s", agent.deviceID, cloned.AdminState) |
| 539 | return err |
npujar | 1d86a52 | 2019-11-14 17:11:16 +0530 | [diff] [blame] | 540 | } |
Maninder | 0aabf0c | 2021-03-17 14:55:14 +0530 | [diff] [blame] | 541 | |
npujar | 1d86a52 | 2019-11-14 17:11:16 +0530 | [diff] [blame] | 542 | // Update the Admin State and operational state before sending the request out |
Kent Hagerman | f6db9f1 | 2020-07-22 17:16:19 -0400 | [diff] [blame] | 543 | cloned.AdminState = voltha.AdminState_DISABLED |
| 544 | cloned.OperStatus = voltha.OperStatus_UNKNOWN |
Maninder | 9a1bc0d | 2020-10-26 11:34:02 +0530 | [diff] [blame] | 545 | |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 546 | client, err := agent.adapterMgr.GetAdapterClient(ctx, agent.adapterEndpoint) |
khenaidoo | 442e7c7 | 2020-03-10 16:13:48 -0400 | [diff] [blame] | 547 | if err != nil { |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 548 | logger.Errorw(ctx, "grpc-client-nil", |
| 549 | log.Fields{ |
| 550 | "error": err, |
| 551 | "device-id": agent.deviceID, |
| 552 | "device-type": agent.deviceType, |
| 553 | "adapter-endpoint": cloned.AdapterEndpoint, |
| 554 | }) |
| 555 | agent.requestQueue.RequestComplete() |
npujar | 1d86a52 | 2019-11-14 17:11:16 +0530 | [diff] [blame] | 556 | return err |
khenaidoo | 0a822f9 | 2019-05-08 15:15:57 -0400 | [diff] [blame] | 557 | } |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 558 | subCtx, cancel := context.WithTimeout(coreutils.WithAllMetadataFromContext(ctx), agent.rpcTimeout) |
| 559 | requestStatus.Code = common.OperationResp_OPERATION_IN_PROGRESS |
| 560 | go func() { |
| 561 | defer cancel() |
| 562 | _, err := client.DisableDevice(subCtx, cloned) |
| 563 | if err == nil { |
| 564 | agent.onSuccess(subCtx, nil, nil, true) |
| 565 | } else { |
| 566 | agent.onFailure(subCtx, err, nil, nil, true) |
| 567 | } |
| 568 | }() |
Maninder | 9a1bc0d | 2020-10-26 11:34:02 +0530 | [diff] [blame] | 569 | |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 570 | // Update device |
| 571 | if err = agent.updateDeviceAndReleaseLock(ctx, cloned); err != nil { |
| 572 | return err |
| 573 | } |
| 574 | currAdminState = cloned.AdminState |
khenaidoo | 0a822f9 | 2019-05-08 15:15:57 -0400 | [diff] [blame] | 575 | |
khenaidoo | 92e62c5 | 2018-10-03 14:02:54 -0400 | [diff] [blame] | 576 | return nil |
| 577 | } |
| 578 | |
Kent Hagerman | 2b21604 | 2020-04-03 18:28:56 -0400 | [diff] [blame] | 579 | func (agent *Agent) rebootDevice(ctx context.Context) error { |
Maninder | 9a1bc0d | 2020-10-26 11:34:02 +0530 | [diff] [blame] | 580 | var desc string |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 581 | var err error |
| 582 | requestStatus := &common.OperationResp{Code: common.OperationResp_OPERATION_FAILURE} |
| 583 | defer func() { agent.logDeviceUpdate(ctx, nil, nil, requestStatus, err, desc) }() |
Maninder | 9a1bc0d | 2020-10-26 11:34:02 +0530 | [diff] [blame] | 584 | |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 585 | if err = agent.requestQueue.WaitForGreenLight(ctx); err != nil { |
Maninder | 9a1bc0d | 2020-10-26 11:34:02 +0530 | [diff] [blame] | 586 | desc = err.Error() |
npujar | 1d86a52 | 2019-11-14 17:11:16 +0530 | [diff] [blame] | 587 | return err |
khenaidoo | 4d4802d | 2018-10-04 21:59:49 -0400 | [diff] [blame] | 588 | } |
khenaidoo | 442e7c7 | 2020-03-10 16:13:48 -0400 | [diff] [blame] | 589 | defer agent.requestQueue.RequestComplete() |
Himani Chawla | b4c2591 | 2020-11-12 17:16:38 +0530 | [diff] [blame] | 590 | logger.Debugw(ctx, "reboot-device", log.Fields{"device-id": agent.deviceID}) |
khenaidoo | 442e7c7 | 2020-03-10 16:13:48 -0400 | [diff] [blame] | 591 | |
Kent Hagerman | cba2f30 | 2020-07-28 13:37:36 -0400 | [diff] [blame] | 592 | device := agent.getDeviceReadOnlyWithoutLock() |
Maninder | 2195ccc | 2021-06-23 20:23:01 +0530 | [diff] [blame] | 593 | |
| 594 | if !agent.proceedWithRequest(device) { |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 595 | err = status.Errorf(codes.FailedPrecondition, "cannot complete operation as device deletion is in progress or reconciling is in progress/failed:%s", agent.deviceID) |
khenaidoo | 442e7c7 | 2020-03-10 16:13:48 -0400 | [diff] [blame] | 596 | return err |
| 597 | } |
Maninder | 9a1bc0d | 2020-10-26 11:34:02 +0530 | [diff] [blame] | 598 | |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 599 | client, err := agent.adapterMgr.GetAdapterClient(ctx, agent.adapterEndpoint) |
| 600 | if err != nil { |
| 601 | logger.Errorw(ctx, "grpc-client-nil", |
| 602 | log.Fields{ |
| 603 | "error": err, |
| 604 | "device-id": agent.deviceID, |
| 605 | "device-type": agent.deviceType, |
| 606 | "adapter-endpoint": device.AdapterEndpoint, |
| 607 | }) |
| 608 | return err |
| 609 | } |
| 610 | subCtx, cancel := context.WithTimeout(coreutils.WithAllMetadataFromContext(ctx), agent.rpcTimeout) |
| 611 | requestStatus.Code = common.OperationResp_OPERATION_IN_PROGRESS |
| 612 | go func() { |
| 613 | defer cancel() |
| 614 | _, err := client.RebootDevice(subCtx, device) |
| 615 | if err == nil { |
| 616 | agent.onSuccess(subCtx, nil, nil, true) |
| 617 | } else { |
| 618 | agent.onFailure(subCtx, err, nil, nil, true) |
| 619 | } |
| 620 | }() |
khenaidoo | 4d4802d | 2018-10-04 21:59:49 -0400 | [diff] [blame] | 621 | return nil |
| 622 | } |
| 623 | |
Himani Chawla | 2ba1c9c | 2020-10-07 13:19:03 +0530 | [diff] [blame] | 624 | func (agent *Agent) deleteDeviceForce(ctx context.Context) error { |
Himani Chawla | b4c2591 | 2020-11-12 17:16:38 +0530 | [diff] [blame] | 625 | logger.Debugw(ctx, "delete-device-force", log.Fields{"device-id": agent.deviceID}) |
Maninder | 9a1bc0d | 2020-10-26 11:34:02 +0530 | [diff] [blame] | 626 | |
| 627 | var desc string |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 628 | var err error |
| 629 | requestStatus := &common.OperationResp{Code: common.OperationResp_OPERATION_FAILURE} |
| 630 | defer func() { agent.logDeviceUpdate(ctx, nil, nil, requestStatus, err, desc) }() |
Maninder | 9a1bc0d | 2020-10-26 11:34:02 +0530 | [diff] [blame] | 631 | |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 632 | if err = agent.requestQueue.WaitForGreenLight(ctx); err != nil { |
Himani Chawla | 2ba1c9c | 2020-10-07 13:19:03 +0530 | [diff] [blame] | 633 | return err |
| 634 | } |
| 635 | // Get the device Transient state, return err if it is DELETING |
| 636 | previousDeviceTransientState := agent.getTransientState() |
Himani Chawla | 2ba1c9c | 2020-10-07 13:19:03 +0530 | [diff] [blame] | 637 | device := agent.cloneDeviceWithoutLock() |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 638 | if !agent.isForceDeletingAllowed(previousDeviceTransientState, device) { |
| 639 | agent.requestQueue.RequestComplete() |
| 640 | err = status.Error(codes.FailedPrecondition, fmt.Sprintf("deviceId:%s, force deletion is in progress", agent.deviceID)) |
Himani Chawla | 2ba1c9c | 2020-10-07 13:19:03 +0530 | [diff] [blame] | 641 | return err |
| 642 | } |
Himani Chawla | b4c2591 | 2020-11-12 17:16:38 +0530 | [diff] [blame] | 643 | |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 644 | previousAdminState := device.AdminState |
| 645 | if previousAdminState != common.AdminState_PREPROVISIONED { |
| 646 | var client adapter_services.AdapterServiceClient |
| 647 | client, err = agent.adapterMgr.GetAdapterClient(ctx, agent.adapterEndpoint) |
Himani Chawla | 2ba1c9c | 2020-10-07 13:19:03 +0530 | [diff] [blame] | 648 | if err != nil { |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 649 | logger.Errorw(ctx, "grpc-client-nil", |
| 650 | log.Fields{ |
| 651 | "error": err, |
| 652 | "device-id": agent.deviceID, |
| 653 | "device-type": agent.deviceType, |
| 654 | "adapter-endpoint": device.AdapterEndpoint, |
| 655 | }) |
| 656 | agent.requestQueue.RequestComplete() |
Himani Chawla | 2ba1c9c | 2020-10-07 13:19:03 +0530 | [diff] [blame] | 657 | return err |
| 658 | } |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 659 | subCtx, cancel := context.WithTimeout(coreutils.WithAllMetadataFromContext(ctx), agent.rpcTimeout) |
| 660 | requestStatus.Code = common.OperationResp_OPERATION_IN_PROGRESS |
| 661 | go func() { |
| 662 | defer cancel() |
| 663 | _, err := client.DeleteDevice(subCtx, device) |
| 664 | if err == nil { |
| 665 | agent.onSuccess(subCtx, nil, nil, true) |
| 666 | } else { |
| 667 | agent.onFailure(subCtx, err, nil, nil, true) |
| 668 | } |
| 669 | }() |
| 670 | } |
| 671 | |
| 672 | // Update device |
| 673 | if err = agent.updateDeviceWithTransientStateAndReleaseLock(ctx, device, |
| 674 | core.DeviceTransientState_FORCE_DELETING, previousDeviceTransientState); err != nil { |
| 675 | return err |
Himani Chawla | 2ba1c9c | 2020-10-07 13:19:03 +0530 | [diff] [blame] | 676 | } |
| 677 | return nil |
| 678 | } |
| 679 | |
Kent Hagerman | 2b21604 | 2020-04-03 18:28:56 -0400 | [diff] [blame] | 680 | func (agent *Agent) deleteDevice(ctx context.Context) error { |
Himani Chawla | b4c2591 | 2020-11-12 17:16:38 +0530 | [diff] [blame] | 681 | logger.Debugw(ctx, "delete-device", log.Fields{"device-id": agent.deviceID}) |
Maninder | 9a1bc0d | 2020-10-26 11:34:02 +0530 | [diff] [blame] | 682 | |
| 683 | var desc string |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 684 | var err error |
| 685 | requestStatus := &common.OperationResp{Code: common.OperationResp_OPERATION_FAILURE} |
| 686 | defer func() { agent.logDeviceUpdate(ctx, nil, nil, requestStatus, err, desc) }() |
Maninder | 9a1bc0d | 2020-10-26 11:34:02 +0530 | [diff] [blame] | 687 | |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 688 | if err = agent.requestQueue.WaitForGreenLight(ctx); err != nil { |
Maninder | 9a1bc0d | 2020-10-26 11:34:02 +0530 | [diff] [blame] | 689 | desc = err.Error() |
khenaidoo | 442e7c7 | 2020-03-10 16:13:48 -0400 | [diff] [blame] | 690 | return err |
| 691 | } |
Maninder | 0aabf0c | 2021-03-17 14:55:14 +0530 | [diff] [blame] | 692 | |
Maninder | 2195ccc | 2021-06-23 20:23:01 +0530 | [diff] [blame] | 693 | device := agent.cloneDeviceWithoutLock() |
| 694 | |
| 695 | if !agent.proceedWithRequest(device) { |
Maninder | 0aabf0c | 2021-03-17 14:55:14 +0530 | [diff] [blame] | 696 | agent.requestQueue.RequestComplete() |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 697 | err = status.Errorf(codes.FailedPrecondition, "cannot complete operation as device deletion is in progress or reconciling is in progress/failed: %s", agent.deviceID) |
| 698 | return err |
Maninder | 0aabf0c | 2021-03-17 14:55:14 +0530 | [diff] [blame] | 699 | } |
| 700 | |
Himani Chawla | 2ba1c9c | 2020-10-07 13:19:03 +0530 | [diff] [blame] | 701 | // Get the device Transient state, return err if it is DELETING |
| 702 | previousDeviceTransientState := agent.getTransientState() |
khenaidoo | 6e55d9e | 2019-12-12 18:26:26 -0500 | [diff] [blame] | 703 | |
Himani Chawla | 2ba1c9c | 2020-10-07 13:19:03 +0530 | [diff] [blame] | 704 | previousAdminState := device.AdminState |
| 705 | // Change the device transient state to DELETING_FROM_ADAPTER state till the device is removed from adapters. |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 706 | currentDeviceTransientState := core.DeviceTransientState_DELETING_FROM_ADAPTER |
khenaidoo | 442e7c7 | 2020-03-10 16:13:48 -0400 | [diff] [blame] | 707 | |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 708 | if previousAdminState == common.AdminState_PREPROVISIONED { |
Himani Chawla | 2ba1c9c | 2020-10-07 13:19:03 +0530 | [diff] [blame] | 709 | // Change the state to DELETING POST ADAPTER RESPONSE directly as adapters have no info of the device. |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 710 | currentDeviceTransientState = core.DeviceTransientState_DELETING_POST_ADAPTER_RESPONSE |
Himani Chawla | 2ba1c9c | 2020-10-07 13:19:03 +0530 | [diff] [blame] | 711 | } |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 712 | // If the device was in pre-prov state (only parent device are in that state) then do not send the request to the |
| 713 | // adapter |
| 714 | if previousAdminState != common.AdminState_PREPROVISIONED { |
| 715 | var client adapter_services.AdapterServiceClient |
| 716 | client, err = agent.adapterMgr.GetAdapterClient(ctx, agent.adapterEndpoint) |
| 717 | if err != nil { |
| 718 | logger.Errorw(ctx, "grpc-client-nil", |
| 719 | log.Fields{ |
| 720 | "error": err, |
| 721 | "device-id": agent.deviceID, |
| 722 | "device-type": agent.deviceType, |
| 723 | "adapter-endpoint": device.AdapterEndpoint, |
| 724 | }) |
| 725 | agent.requestQueue.RequestComplete() |
| 726 | return err |
| 727 | } |
| 728 | subCtx, cancel := context.WithTimeout(coreutils.WithAllMetadataFromContext(ctx), agent.rpcTimeout) |
| 729 | requestStatus.Code = common.OperationResp_OPERATION_IN_PROGRESS |
| 730 | go func() { |
| 731 | defer cancel() |
| 732 | _, err := client.DeleteDevice(subCtx, device) |
| 733 | if err == nil { |
| 734 | agent.onDeleteSuccess(subCtx, nil, nil) |
| 735 | } else { |
| 736 | agent.onDeleteFailure(subCtx, err, nil, nil) |
| 737 | } |
| 738 | }() |
| 739 | } |
| 740 | |
| 741 | // Update device and release lock |
| 742 | if err = agent.updateDeviceWithTransientStateAndReleaseLock(ctx, device, |
Himani Chawla | b4c2591 | 2020-11-12 17:16:38 +0530 | [diff] [blame] | 743 | currentDeviceTransientState, previousDeviceTransientState); err != nil { |
Maninder | 9a1bc0d | 2020-10-26 11:34:02 +0530 | [diff] [blame] | 744 | desc = err.Error() |
npujar | 1d86a52 | 2019-11-14 17:11:16 +0530 | [diff] [blame] | 745 | return err |
| 746 | } |
Himani Chawla | b4c2591 | 2020-11-12 17:16:38 +0530 | [diff] [blame] | 747 | |
khenaidoo | 4d4802d | 2018-10-04 21:59:49 -0400 | [diff] [blame] | 748 | return nil |
| 749 | } |
| 750 | |
Kent Hagerman | 2b21604 | 2020-04-03 18:28:56 -0400 | [diff] [blame] | 751 | func (agent *Agent) setParentID(ctx context.Context, device *voltha.Device, parentID string) error { |
khenaidoo | 442e7c7 | 2020-03-10 16:13:48 -0400 | [diff] [blame] | 752 | if err := agent.requestQueue.WaitForGreenLight(ctx); err != nil { |
| 753 | return err |
| 754 | } |
Himani Chawla | b4c2591 | 2020-11-12 17:16:38 +0530 | [diff] [blame] | 755 | logger.Debugw(ctx, "set-parent-id", log.Fields{"device-id": device.Id, "parent-id": parentID}) |
khenaidoo | 6e55d9e | 2019-12-12 18:26:26 -0500 | [diff] [blame] | 756 | |
Kent Hagerman | f6db9f1 | 2020-07-22 17:16:19 -0400 | [diff] [blame] | 757 | cloned := agent.cloneDeviceWithoutLock() |
npujar | 1d86a52 | 2019-11-14 17:11:16 +0530 | [diff] [blame] | 758 | cloned.ParentId = parentID |
Kent Hagerman | f6db9f1 | 2020-07-22 17:16:19 -0400 | [diff] [blame] | 759 | return agent.updateDeviceAndReleaseLock(ctx, cloned) |
khenaidoo | ad06fd7 | 2019-10-28 12:26:05 -0400 | [diff] [blame] | 760 | } |
| 761 | |
khenaidoo | 442e7c7 | 2020-03-10 16:13:48 -0400 | [diff] [blame] | 762 | // getSwitchCapability retrieves the switch capability of a parent device |
Kent Hagerman | 2b21604 | 2020-04-03 18:28:56 -0400 | [diff] [blame] | 763 | func (agent *Agent) getSwitchCapability(ctx context.Context) (*ic.SwitchCapability, error) { |
Himani Chawla | b4c2591 | 2020-11-12 17:16:38 +0530 | [diff] [blame] | 764 | logger.Debugw(ctx, "get-switch-capability", log.Fields{"device-id": agent.deviceID}) |
khenaidoo | 442e7c7 | 2020-03-10 16:13:48 -0400 | [diff] [blame] | 765 | |
Kent Hagerman | cba2f30 | 2020-07-28 13:37:36 -0400 | [diff] [blame] | 766 | device, err := agent.getDeviceReadOnly(ctx) |
khenaidoo | 442e7c7 | 2020-03-10 16:13:48 -0400 | [diff] [blame] | 767 | if err != nil { |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 768 | return nil, err |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 769 | } |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 770 | |
| 771 | // Get the gRPC client |
| 772 | client, err := agent.adapterMgr.GetAdapterClient(ctx, agent.adapterEndpoint) |
khenaidoo | 442e7c7 | 2020-03-10 16:13:48 -0400 | [diff] [blame] | 773 | if err != nil { |
| 774 | return nil, err |
| 775 | } |
| 776 | |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 777 | return client.GetOfpDeviceInfo(ctx, device) |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 778 | } |
| 779 | |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 780 | func (agent *Agent) onPacketFailure(ctx context.Context, err error, packet *ofp.OfpPacketOut) { |
| 781 | logger.Errorw(ctx, "packet-out-error", log.Fields{ |
khenaidoo | 442e7c7 | 2020-03-10 16:13:48 -0400 | [diff] [blame] | 782 | "device-id": agent.deviceID, |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 783 | "error": err.Error(), |
| 784 | "packet": hex.EncodeToString(packet.Data), |
khenaidoo | 442e7c7 | 2020-03-10 16:13:48 -0400 | [diff] [blame] | 785 | }) |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 786 | rpce := agent.deviceMgr.NewRPCEvent(ctx, agent.deviceID, err.Error(), nil) |
| 787 | go agent.deviceMgr.SendRPCEvent(ctx, "RPC_ERROR_RAISE_EVENT", rpce, |
| 788 | voltha.EventCategory_COMMUNICATION, nil, time.Now().Unix()) |
khenaidoo | 442e7c7 | 2020-03-10 16:13:48 -0400 | [diff] [blame] | 789 | } |
| 790 | |
Kent Hagerman | 2b21604 | 2020-04-03 18:28:56 -0400 | [diff] [blame] | 791 | func (agent *Agent) packetOut(ctx context.Context, outPort uint32, packet *ofp.OfpPacketOut) error { |
Scott Baker | 8067860 | 2019-11-14 16:57:36 -0800 | [diff] [blame] | 792 | if agent.deviceType == "" { |
npujar | 467fe75 | 2020-01-16 20:17:45 +0530 | [diff] [blame] | 793 | agent.reconcileWithKVStore(ctx) |
Scott Baker | 8067860 | 2019-11-14 16:57:36 -0800 | [diff] [blame] | 794 | } |
khenaidoo | fdbad6e | 2018-11-06 22:26:38 -0500 | [diff] [blame] | 795 | // Send packet to adapter |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 796 | client, err := agent.adapterMgr.GetAdapterClient(ctx, agent.adapterEndpoint) |
khenaidoo | 442e7c7 | 2020-03-10 16:13:48 -0400 | [diff] [blame] | 797 | if err != nil { |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 798 | logger.Errorw(ctx, "grpc-client-nil", |
| 799 | log.Fields{ |
| 800 | "error": err, |
| 801 | "device-id": agent.deviceID, |
| 802 | "device-type": agent.deviceType, |
| 803 | }) |
| 804 | return err |
khenaidoo | fdbad6e | 2018-11-06 22:26:38 -0500 | [diff] [blame] | 805 | } |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 806 | subCtx, cancel := context.WithTimeout(coreutils.WithAllMetadataFromContext(ctx), agent.rpcTimeout) |
| 807 | go func() { |
| 808 | defer cancel() |
| 809 | _, err := client.SendPacketOut(subCtx, &ic.PacketOut{ |
| 810 | DeviceId: agent.deviceID, |
| 811 | EgressPortNo: outPort, |
| 812 | Packet: packet, |
| 813 | }) |
| 814 | if err == nil { |
| 815 | agent.onSuccess(subCtx, nil, nil, false) |
| 816 | } else { |
| 817 | agent.onPacketFailure(subCtx, err, packet) |
| 818 | } |
| 819 | }() |
khenaidoo | fdbad6e | 2018-11-06 22:26:38 -0500 | [diff] [blame] | 820 | return nil |
| 821 | } |
| 822 | |
Kent Hagerman | f6db9f1 | 2020-07-22 17:16:19 -0400 | [diff] [blame] | 823 | func (agent *Agent) updateDeviceUsingAdapterData(ctx context.Context, device *voltha.Device) error { |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 824 | var err error |
| 825 | var desc string |
| 826 | requestStatus := &common.OperationResp{Code: common.OperationResp_OPERATION_FAILURE} |
| 827 | defer func() { agent.logDeviceUpdate(ctx, nil, nil, requestStatus, err, desc) }() |
| 828 | |
| 829 | if err = agent.requestQueue.WaitForGreenLight(ctx); err != nil { |
Kent Hagerman | f6db9f1 | 2020-07-22 17:16:19 -0400 | [diff] [blame] | 830 | return err |
| 831 | } |
Himani Chawla | b4c2591 | 2020-11-12 17:16:38 +0530 | [diff] [blame] | 832 | logger.Debugw(ctx, "update-device-using-adapter-data", log.Fields{"device-id": device.Id}) |
Kent Hagerman | f6db9f1 | 2020-07-22 17:16:19 -0400 | [diff] [blame] | 833 | |
| 834 | cloned := agent.cloneDeviceWithoutLock() |
Mahir Gunyel | 8e2707d | 2019-07-25 00:36:21 -0700 | [diff] [blame] | 835 | cloned.Root = device.Root |
| 836 | cloned.Vendor = device.Vendor |
| 837 | cloned.Model = device.Model |
| 838 | cloned.SerialNumber = device.SerialNumber |
| 839 | cloned.MacAddress = device.MacAddress |
| 840 | cloned.Vlan = device.Vlan |
| 841 | cloned.Reason = device.Reason |
Andrea Campanella | 025667e | 2021-01-14 11:50:07 +0100 | [diff] [blame] | 842 | cloned.ImageDownloads = device.ImageDownloads |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 843 | cloned.OperStatus = device.OperStatus |
| 844 | cloned.ConnectStatus = device.ConnectStatus |
| 845 | if err = agent.updateDeviceAndReleaseLock(ctx, cloned); err == nil { |
| 846 | requestStatus.Code = common.OperationResp_OPERATION_SUCCESS |
| 847 | } |
| 848 | return err |
khenaidoo | 43c8212 | 2018-11-22 18:38:28 -0500 | [diff] [blame] | 849 | } |
| 850 | |
Kent Hagerman | 2b21604 | 2020-04-03 18:28:56 -0400 | [diff] [blame] | 851 | func (agent *Agent) updateDeviceStatus(ctx context.Context, operStatus voltha.OperStatus_Types, connStatus voltha.ConnectStatus_Types) error { |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 852 | var err error |
| 853 | var desc string |
| 854 | opStatus := &common.OperationResp{Code: common.OperationResp_OPERATION_FAILURE} |
| 855 | defer func() { agent.logDeviceUpdate(ctx, nil, nil, opStatus, err, desc) }() |
| 856 | |
| 857 | if err = agent.requestQueue.WaitForGreenLight(ctx); err != nil { |
khenaidoo | 442e7c7 | 2020-03-10 16:13:48 -0400 | [diff] [blame] | 858 | return err |
| 859 | } |
khenaidoo | 6e55d9e | 2019-12-12 18:26:26 -0500 | [diff] [blame] | 860 | |
Kent Hagerman | f6db9f1 | 2020-07-22 17:16:19 -0400 | [diff] [blame] | 861 | cloned := agent.cloneDeviceWithoutLock() |
npujar | 1d86a52 | 2019-11-14 17:11:16 +0530 | [diff] [blame] | 862 | // Ensure the enums passed in are valid - they will be invalid if they are not set when this function is invoked |
Kent Hagerman | f6db9f1 | 2020-07-22 17:16:19 -0400 | [diff] [blame] | 863 | if s, ok := voltha.ConnectStatus_Types_name[int32(connStatus)]; ok { |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 864 | logger.Debugw(ctx, "update-device-conn-status", log.Fields{"ok": ok, "val": s}) |
Kent Hagerman | f6db9f1 | 2020-07-22 17:16:19 -0400 | [diff] [blame] | 865 | cloned.ConnectStatus = connStatus |
npujar | 1d86a52 | 2019-11-14 17:11:16 +0530 | [diff] [blame] | 866 | } |
Kent Hagerman | f6db9f1 | 2020-07-22 17:16:19 -0400 | [diff] [blame] | 867 | if s, ok := voltha.OperStatus_Types_name[int32(operStatus)]; ok { |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 868 | logger.Debugw(ctx, "update-device-oper-status", log.Fields{"ok": ok, "val": s}) |
Kent Hagerman | f6db9f1 | 2020-07-22 17:16:19 -0400 | [diff] [blame] | 869 | cloned.OperStatus = operStatus |
npujar | 1d86a52 | 2019-11-14 17:11:16 +0530 | [diff] [blame] | 870 | } |
Himani Chawla | b4c2591 | 2020-11-12 17:16:38 +0530 | [diff] [blame] | 871 | logger.Debugw(ctx, "update-device-status", log.Fields{"device-id": cloned.Id, "oper-status": cloned.OperStatus, "connect-status": cloned.ConnectStatus}) |
npujar | 1d86a52 | 2019-11-14 17:11:16 +0530 | [diff] [blame] | 872 | // Store the device |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 873 | if err = agent.updateDeviceAndReleaseLock(ctx, cloned); err == nil { |
| 874 | opStatus.Code = common.OperationResp_OPERATION_SUCCESS |
| 875 | } |
| 876 | return err |
khenaidoo | 92e62c5 | 2018-10-03 14:02:54 -0400 | [diff] [blame] | 877 | } |
| 878 | |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 879 | // TODO: A generic device update by attribute |
Kent Hagerman | 2b21604 | 2020-04-03 18:28:56 -0400 | [diff] [blame] | 880 | func (agent *Agent) updateDeviceAttribute(ctx context.Context, name string, value interface{}) { |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 881 | if value == nil { |
| 882 | return |
| 883 | } |
khenaidoo | 6e55d9e | 2019-12-12 18:26:26 -0500 | [diff] [blame] | 884 | |
Kent Hagerman | f6db9f1 | 2020-07-22 17:16:19 -0400 | [diff] [blame] | 885 | if err := agent.requestQueue.WaitForGreenLight(ctx); err != nil { |
| 886 | logger.Warnw(ctx, "request-aborted", log.Fields{"device-id": agent.deviceID, "name": name, "error": err}) |
| 887 | return |
| 888 | } |
| 889 | |
| 890 | cloned := agent.cloneDeviceWithoutLock() |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 891 | updated := false |
khenaidoo | 6e55d9e | 2019-12-12 18:26:26 -0500 | [diff] [blame] | 892 | s := reflect.ValueOf(cloned).Elem() |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 893 | if s.Kind() == reflect.Struct { |
| 894 | // exported field |
| 895 | f := s.FieldByName(name) |
| 896 | if f.IsValid() && f.CanSet() { |
| 897 | switch f.Kind() { |
| 898 | case reflect.String: |
| 899 | f.SetString(value.(string)) |
| 900 | updated = true |
| 901 | case reflect.Uint32: |
| 902 | f.SetUint(uint64(value.(uint32))) |
| 903 | updated = true |
| 904 | case reflect.Bool: |
| 905 | f.SetBool(value.(bool)) |
| 906 | updated = true |
| 907 | } |
| 908 | } |
| 909 | } |
divyadesai | cb8b59d | 2020-08-18 09:55:47 +0000 | [diff] [blame] | 910 | logger.Debugw(ctx, "update-field-status", log.Fields{"device-id": cloned.Id, "name": name, "updated": updated}) |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 911 | // Save the data |
khenaidoo | 6e55d9e | 2019-12-12 18:26:26 -0500 | [diff] [blame] | 912 | |
Kent Hagerman | f6db9f1 | 2020-07-22 17:16:19 -0400 | [diff] [blame] | 913 | if err := agent.updateDeviceAndReleaseLock(ctx, cloned); err != nil { |
Rohan Agrawal | 31f2180 | 2020-06-12 05:38:46 +0000 | [diff] [blame] | 914 | logger.Warnw(ctx, "attribute-update-failed", log.Fields{"attribute": name, "value": value}) |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 915 | } |
khenaidoo | b920354 | 2018-09-17 22:56:37 -0400 | [diff] [blame] | 916 | } |
serkant.uluderya | 334479d | 2019-04-10 08:26:15 -0700 | [diff] [blame] | 917 | |
Kent Hagerman | 45a13e4 | 2020-04-13 12:23:50 -0400 | [diff] [blame] | 918 | func (agent *Agent) simulateAlarm(ctx context.Context, simulateReq *voltha.SimulateAlarmRequest) error { |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 919 | var err error |
| 920 | var desc string |
| 921 | requestStatus := &common.OperationResp{Code: common.OperationResp_OPERATION_FAILURE} |
| 922 | defer func() { agent.logDeviceUpdate(ctx, nil, nil, requestStatus, err, desc) }() |
| 923 | |
| 924 | if err = agent.requestQueue.WaitForGreenLight(ctx); err != nil { |
khenaidoo | 442e7c7 | 2020-03-10 16:13:48 -0400 | [diff] [blame] | 925 | return err |
| 926 | } |
| 927 | defer agent.requestQueue.RequestComplete() |
Himani Chawla | b4c2591 | 2020-11-12 17:16:38 +0530 | [diff] [blame] | 928 | logger.Debugw(ctx, "simulate-alarm", log.Fields{"device-id": agent.deviceID}) |
khenaidoo | 6e55d9e | 2019-12-12 18:26:26 -0500 | [diff] [blame] | 929 | |
Kent Hagerman | cba2f30 | 2020-07-28 13:37:36 -0400 | [diff] [blame] | 930 | device := agent.getDeviceReadOnlyWithoutLock() |
khenaidoo | 6e55d9e | 2019-12-12 18:26:26 -0500 | [diff] [blame] | 931 | |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 932 | client, err := agent.adapterMgr.GetAdapterClient(ctx, agent.adapterEndpoint) |
khenaidoo | 442e7c7 | 2020-03-10 16:13:48 -0400 | [diff] [blame] | 933 | if err != nil { |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 934 | logger.Errorw(ctx, "grpc-client-nil", |
| 935 | log.Fields{ |
| 936 | "error": err, |
| 937 | "device-id": agent.deviceID, |
| 938 | "device-type": agent.deviceType, |
| 939 | "adapter-endpoint": device.AdapterEndpoint, |
| 940 | }) |
npujar | 1d86a52 | 2019-11-14 17:11:16 +0530 | [diff] [blame] | 941 | return err |
serkant.uluderya | 334479d | 2019-04-10 08:26:15 -0700 | [diff] [blame] | 942 | } |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 943 | subCtx, cancel := context.WithTimeout(coreutils.WithAllMetadataFromContext(ctx), agent.rpcTimeout) |
| 944 | requestStatus.Code = common.OperationResp_OPERATION_IN_PROGRESS |
| 945 | go func() { |
| 946 | defer cancel() |
| 947 | _, err := client.SimulateAlarm(subCtx, &ic.SimulateAlarmMessage{Device: device, Request: simulateReq}) |
| 948 | if err == nil { |
| 949 | agent.onSuccess(subCtx, nil, nil, false) |
| 950 | } else { |
| 951 | agent.onFailure(subCtx, err, nil, nil, false) |
| 952 | } |
| 953 | }() |
serkant.uluderya | 334479d | 2019-04-10 08:26:15 -0700 | [diff] [blame] | 954 | return nil |
| 955 | } |
Mahir Gunyel | b585167 | 2019-07-24 10:46:26 +0300 | [diff] [blame] | 956 | |
Kent Hagerman | f6db9f1 | 2020-07-22 17:16:19 -0400 | [diff] [blame] | 957 | // This function updates the device in the DB, releases the device lock, and runs any state transitions. |
| 958 | // The calling function MUST hold the device lock. The caller MUST NOT modify the device after this is called. |
| 959 | func (agent *Agent) updateDeviceAndReleaseLock(ctx context.Context, device *voltha.Device) error { |
| 960 | // fail early if this agent is no longer valid |
Kent Hagerman | 4f355f5 | 2020-03-30 16:01:33 -0400 | [diff] [blame] | 961 | if agent.stopped { |
Kent Hagerman | f6db9f1 | 2020-07-22 17:16:19 -0400 | [diff] [blame] | 962 | agent.requestQueue.RequestComplete() |
Himani Chawla | 2ba1c9c | 2020-10-07 13:19:03 +0530 | [diff] [blame] | 963 | return errors.New("device-agent-stopped") |
Thomas Lee S | e5a4401 | 2019-11-07 20:32:24 +0530 | [diff] [blame] | 964 | } |
Kent Hagerman | 4f355f5 | 2020-03-30 16:01:33 -0400 | [diff] [blame] | 965 | |
Kent Hagerman | f6db9f1 | 2020-07-22 17:16:19 -0400 | [diff] [blame] | 966 | // update in db |
Kent Hagerman | f5a6735 | 2020-04-30 15:15:26 -0400 | [diff] [blame] | 967 | if err := agent.dbProxy.Set(ctx, agent.deviceID, device); err != nil { |
Kent Hagerman | f6db9f1 | 2020-07-22 17:16:19 -0400 | [diff] [blame] | 968 | agent.requestQueue.RequestComplete() |
Kent Hagerman | 4f355f5 | 2020-03-30 16:01:33 -0400 | [diff] [blame] | 969 | return status.Errorf(codes.Internal, "failed-update-device:%s: %s", agent.deviceID, err) |
Mahir Gunyel | b585167 | 2019-07-24 10:46:26 +0300 | [diff] [blame] | 970 | } |
divyadesai | cb8b59d | 2020-08-18 09:55:47 +0000 | [diff] [blame] | 971 | logger.Debugw(ctx, "updated-device-in-store", log.Fields{"device-id: ": agent.deviceID}) |
Mahir Gunyel | b585167 | 2019-07-24 10:46:26 +0300 | [diff] [blame] | 972 | |
Kent Hagerman | 6031aad | 2020-07-29 16:36:33 -0400 | [diff] [blame] | 973 | prevDevice := agent.device |
Kent Hagerman | f6db9f1 | 2020-07-22 17:16:19 -0400 | [diff] [blame] | 974 | // update the device |
khenaidoo | 0db4c81 | 2020-05-27 15:27:30 -0400 | [diff] [blame] | 975 | agent.device = device |
Mahir Gunyel | b0343bf | 2021-05-11 14:14:26 -0700 | [diff] [blame] | 976 | //If any of the states has chenged, send the change event. |
| 977 | if prevDevice.OperStatus != device.OperStatus || prevDevice.ConnectStatus != device.ConnectStatus || prevDevice.AdminState != device.AdminState { |
| 978 | _ = agent.deviceMgr.Agent.SendDeviceStateChangeEvent(ctx, prevDevice.OperStatus, prevDevice.ConnectStatus, prevDevice.AdminState, device, time.Now().Unix()) |
| 979 | } |
Maninder | 0aabf0c | 2021-03-17 14:55:14 +0530 | [diff] [blame] | 980 | deviceTransientState := agent.getTransientState() |
| 981 | |
Kent Hagerman | f6db9f1 | 2020-07-22 17:16:19 -0400 | [diff] [blame] | 982 | // release lock before processing transition |
| 983 | agent.requestQueue.RequestComplete() |
Himani Chawla | b4c2591 | 2020-11-12 17:16:38 +0530 | [diff] [blame] | 984 | subCtx := coreutils.WithSpanAndRPCMetadataFromContext(ctx) |
Kent Hagerman | f6db9f1 | 2020-07-22 17:16:19 -0400 | [diff] [blame] | 985 | |
Himani Chawla | b4c2591 | 2020-11-12 17:16:38 +0530 | [diff] [blame] | 986 | if err := agent.deviceMgr.stateTransitions.ProcessTransition(subCtx, |
Maninder | 0aabf0c | 2021-03-17 14:55:14 +0530 | [diff] [blame] | 987 | device, prevDevice, deviceTransientState, deviceTransientState); err != nil { |
Himani Chawla | b4c2591 | 2020-11-12 17:16:38 +0530 | [diff] [blame] | 988 | logger.Errorw(ctx, "failed-process-transition", log.Fields{"device-id": device.Id, "previous-admin-state": prevDevice.AdminState, "current-admin-state": device.AdminState}) |
| 989 | // Sending RPC EVENT here |
| 990 | rpce := agent.deviceMgr.NewRPCEvent(ctx, agent.deviceID, err.Error(), nil) |
Himani Chawla | 606a4f0 | 2021-03-23 19:45:58 +0530 | [diff] [blame] | 991 | agent.deviceMgr.SendRPCEvent(ctx, "RPC_ERROR_RAISE_EVENT", rpce, voltha.EventCategory_COMMUNICATION, |
| 992 | nil, time.Now().Unix()) |
Himani Chawla | b4c2591 | 2020-11-12 17:16:38 +0530 | [diff] [blame] | 993 | |
Kent Hagerman | f6db9f1 | 2020-07-22 17:16:19 -0400 | [diff] [blame] | 994 | } |
Mahir Gunyel | b585167 | 2019-07-24 10:46:26 +0300 | [diff] [blame] | 995 | return nil |
| 996 | } |
Mahir Gunyel | fdee921 | 2019-10-16 16:52:21 -0700 | [diff] [blame] | 997 | |
Himani Chawla | 2ba1c9c | 2020-10-07 13:19:03 +0530 | [diff] [blame] | 998 | // This function updates the device transient in the DB through loader, releases the device lock, and runs any state transitions. |
| 999 | // The calling function MUST hold the device lock. The caller MUST NOT modify the device after this is called. |
| 1000 | func (agent *Agent) updateDeviceWithTransientStateAndReleaseLock(ctx context.Context, device *voltha.Device, |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 1001 | transientState, prevTransientState core.DeviceTransientState_Types) error { |
Himani Chawla | 2ba1c9c | 2020-10-07 13:19:03 +0530 | [diff] [blame] | 1002 | // fail early if this agent is no longer valid |
| 1003 | if agent.stopped { |
| 1004 | agent.requestQueue.RequestComplete() |
| 1005 | return errors.New("device-agent-stopped") |
| 1006 | } |
| 1007 | //update device TransientState |
| 1008 | if err := agent.updateTransientState(ctx, transientState); err != nil { |
| 1009 | agent.requestQueue.RequestComplete() |
| 1010 | return err |
| 1011 | } |
| 1012 | // update in db |
| 1013 | if err := agent.dbProxy.Set(ctx, agent.deviceID, device); err != nil { |
| 1014 | //Reverting TransientState update |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 1015 | if errTransient := agent.updateTransientState(ctx, prevTransientState); errTransient != nil { |
| 1016 | logger.Errorw(ctx, "failed-to-revert-transient-state-update-on-error", log.Fields{"device-id": device.Id, |
| 1017 | "previous-transient-state": prevTransientState, "current-transient-state": transientState, "error": errTransient}) |
| 1018 | } |
Himani Chawla | 2ba1c9c | 2020-10-07 13:19:03 +0530 | [diff] [blame] | 1019 | agent.requestQueue.RequestComplete() |
| 1020 | return status.Errorf(codes.Internal, "failed-update-device:%s: %s", agent.deviceID, err) |
| 1021 | } |
| 1022 | |
| 1023 | logger.Debugw(ctx, "updated-device-in-store", log.Fields{"device-id: ": agent.deviceID}) |
| 1024 | |
| 1025 | prevDevice := agent.device |
| 1026 | // update the device |
| 1027 | agent.device = device |
Mahir Gunyel | b0343bf | 2021-05-11 14:14:26 -0700 | [diff] [blame] | 1028 | //If any of the states has chenged, send the change event. |
| 1029 | if prevDevice.OperStatus != device.OperStatus || prevDevice.ConnectStatus != device.ConnectStatus || prevDevice.AdminState != device.AdminState { |
| 1030 | _ = agent.deviceMgr.Agent.SendDeviceStateChangeEvent(ctx, prevDevice.OperStatus, prevDevice.ConnectStatus, prevDevice.AdminState, device, time.Now().Unix()) |
| 1031 | } |
Himani Chawla | 2ba1c9c | 2020-10-07 13:19:03 +0530 | [diff] [blame] | 1032 | |
| 1033 | // release lock before processing transition |
| 1034 | agent.requestQueue.RequestComplete() |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 1035 | go func() { |
| 1036 | subCtx := coreutils.WithSpanAndRPCMetadataFromContext(ctx) |
| 1037 | if err := agent.deviceMgr.stateTransitions.ProcessTransition(subCtx, |
| 1038 | device, prevDevice, transientState, prevTransientState); err != nil { |
| 1039 | logger.Errorw(ctx, "failed-process-transition", log.Fields{"device-id": device.Id, "previous-admin-state": prevDevice.AdminState, "current-admin-state": device.AdminState}) |
| 1040 | // Sending RPC EVENT here |
| 1041 | rpce := agent.deviceMgr.NewRPCEvent(ctx, agent.deviceID, err.Error(), nil) |
| 1042 | agent.deviceMgr.SendRPCEvent(ctx, "RPC_ERROR_RAISE_EVENT", rpce, voltha.EventCategory_COMMUNICATION, |
| 1043 | nil, time.Now().Unix()) |
| 1044 | } |
| 1045 | }() |
Himani Chawla | 2ba1c9c | 2020-10-07 13:19:03 +0530 | [diff] [blame] | 1046 | return nil |
| 1047 | } |
Kent Hagerman | 2b21604 | 2020-04-03 18:28:56 -0400 | [diff] [blame] | 1048 | func (agent *Agent) updateDeviceReason(ctx context.Context, reason string) error { |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 1049 | logger.Debugw(ctx, "update-device-reason", log.Fields{"device-id": agent.deviceID, "reason": reason}) |
| 1050 | |
| 1051 | var err error |
| 1052 | var desc string |
| 1053 | requestStatus := &common.OperationResp{Code: common.OperationResp_OPERATION_FAILURE} |
| 1054 | defer func() { agent.logDeviceUpdate(ctx, nil, nil, requestStatus, err, desc) }() |
| 1055 | |
| 1056 | if err = agent.requestQueue.WaitForGreenLight(ctx); err != nil { |
khenaidoo | 442e7c7 | 2020-03-10 16:13:48 -0400 | [diff] [blame] | 1057 | return err |
| 1058 | } |
Maninder | 9a1bc0d | 2020-10-26 11:34:02 +0530 | [diff] [blame] | 1059 | |
Kent Hagerman | f6db9f1 | 2020-07-22 17:16:19 -0400 | [diff] [blame] | 1060 | cloned := agent.cloneDeviceWithoutLock() |
npujar | 1d86a52 | 2019-11-14 17:11:16 +0530 | [diff] [blame] | 1061 | cloned.Reason = reason |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 1062 | if err = agent.updateDeviceAndReleaseLock(ctx, cloned); err == nil { |
| 1063 | requestStatus.Code = common.OperationResp_OPERATION_SUCCESS |
Maninder | 9a1bc0d | 2020-10-26 11:34:02 +0530 | [diff] [blame] | 1064 | } |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 1065 | return err |
Mahir Gunyel | fdee921 | 2019-10-16 16:52:21 -0700 | [diff] [blame] | 1066 | } |
kesavand | bc2d162 | 2020-01-21 00:42:01 -0500 | [diff] [blame] | 1067 | |
Kent Hagerman | 2b21604 | 2020-04-03 18:28:56 -0400 | [diff] [blame] | 1068 | func (agent *Agent) ChildDeviceLost(ctx context.Context, device *voltha.Device) error { |
Himani Chawla | b4c2591 | 2020-11-12 17:16:38 +0530 | [diff] [blame] | 1069 | logger.Debugw(ctx, "child-device-lost", log.Fields{"child-device-id": device.Id, "parent-device-id": agent.deviceID}) |
Chaitrashree G S | 543df3e | 2020-02-24 22:36:54 -0500 | [diff] [blame] | 1070 | |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 1071 | var err error |
| 1072 | var desc string |
| 1073 | requestStatus := &common.OperationResp{Code: common.OperationResp_OPERATION_FAILURE} |
| 1074 | defer func() { agent.logDeviceUpdate(ctx, nil, nil, requestStatus, err, desc) }() |
| 1075 | |
Kent Hagerman | 2a07b86 | 2020-06-19 15:23:07 -0400 | [diff] [blame] | 1076 | // Remove the associated peer ports on the parent device |
| 1077 | for portID := range agent.portLoader.ListIDs() { |
| 1078 | if portHandle, have := agent.portLoader.Lock(portID); have { |
| 1079 | oldPort := portHandle.GetReadOnly() |
| 1080 | updatedPeers := make([]*voltha.Port_PeerPort, 0) |
| 1081 | for _, peerPort := range oldPort.Peers { |
| 1082 | if peerPort.DeviceId != device.Id { |
| 1083 | updatedPeers = append(updatedPeers, peerPort) |
| 1084 | } |
khenaidoo | 442e7c7 | 2020-03-10 16:13:48 -0400 | [diff] [blame] | 1085 | } |
Kent Hagerman | 2a07b86 | 2020-06-19 15:23:07 -0400 | [diff] [blame] | 1086 | newPort := *oldPort |
| 1087 | newPort.Peers = updatedPeers |
| 1088 | if err := portHandle.Update(ctx, &newPort); err != nil { |
| 1089 | portHandle.Unlock() |
| 1090 | return nil |
| 1091 | } |
| 1092 | portHandle.Unlock() |
khenaidoo | 442e7c7 | 2020-03-10 16:13:48 -0400 | [diff] [blame] | 1093 | } |
Chaitrashree G S | 543df3e | 2020-02-24 22:36:54 -0500 | [diff] [blame] | 1094 | } |
| 1095 | |
khenaidoo | 442e7c7 | 2020-03-10 16:13:48 -0400 | [diff] [blame] | 1096 | //send request to adapter |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 1097 | client, err := agent.adapterMgr.GetAdapterClient(ctx, agent.adapterEndpoint) |
khenaidoo | 442e7c7 | 2020-03-10 16:13:48 -0400 | [diff] [blame] | 1098 | if err != nil { |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 1099 | logger.Errorw(ctx, "grpc-client-nil", |
| 1100 | log.Fields{ |
| 1101 | "error": err, |
| 1102 | "device-id": agent.deviceID, |
| 1103 | "device-type": agent.deviceType, |
| 1104 | "adapter-endpoint": device.AdapterEndpoint, |
| 1105 | }) |
khenaidoo | 442e7c7 | 2020-03-10 16:13:48 -0400 | [diff] [blame] | 1106 | return err |
Chaitrashree G S | 543df3e | 2020-02-24 22:36:54 -0500 | [diff] [blame] | 1107 | } |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 1108 | subCtx, cancel := context.WithTimeout(coreutils.WithAllMetadataFromContext(ctx), agent.rpcTimeout) |
| 1109 | requestStatus.Code = common.OperationResp_OPERATION_IN_PROGRESS |
| 1110 | go func() { |
| 1111 | defer cancel() |
| 1112 | _, err := client.ChildDeviceLost(subCtx, device) |
| 1113 | if err == nil { |
| 1114 | agent.onSuccess(subCtx, nil, nil, true) |
| 1115 | } else { |
| 1116 | agent.onFailure(subCtx, err, nil, nil, true) |
| 1117 | } |
| 1118 | }() |
Chaitrashree G S | 543df3e | 2020-02-24 22:36:54 -0500 | [diff] [blame] | 1119 | return nil |
Chaitrashree G S | 543df3e | 2020-02-24 22:36:54 -0500 | [diff] [blame] | 1120 | } |
onkarkundargi | 8728525 | 2020-01-27 11:34:52 +0530 | [diff] [blame] | 1121 | |
Kent Hagerman | 2b21604 | 2020-04-03 18:28:56 -0400 | [diff] [blame] | 1122 | func (agent *Agent) startOmciTest(ctx context.Context, omcitestrequest *voltha.OmciTestRequest) (*voltha.TestResponse, error) { |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 1123 | var err error |
| 1124 | var desc string |
| 1125 | requestStatus := &common.OperationResp{Code: common.OperationResp_OPERATION_FAILURE} |
| 1126 | defer func() { agent.logDeviceUpdate(ctx, nil, nil, requestStatus, err, desc) }() |
onkarkundargi | 8728525 | 2020-01-27 11:34:52 +0530 | [diff] [blame] | 1127 | |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 1128 | // OMCI test may be performed on a pre-provisioned device. If a device is in that state both its device type and endpoint |
| 1129 | // may not have been set yet. |
| 1130 | // First check if we need to update the type or endpoint |
| 1131 | cloned, err := agent.getDeviceReadOnly(ctx) |
onkarkundargi | 8728525 | 2020-01-27 11:34:52 +0530 | [diff] [blame] | 1132 | if err != nil { |
| 1133 | return nil, err |
| 1134 | } |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 1135 | if cloned.Type == "" || cloned.AdapterEndpoint == "" { |
| 1136 | if err = agent.updateDeviceTypeAndEndpoint(ctx); err != nil { |
| 1137 | return nil, err |
| 1138 | } |
| 1139 | cloned, err = agent.getDeviceReadOnly(ctx) |
| 1140 | if err != nil { |
| 1141 | return nil, err |
| 1142 | } |
onkarkundargi | 8728525 | 2020-01-27 11:34:52 +0530 | [diff] [blame] | 1143 | } |
| 1144 | |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 1145 | // Send request to the adapter |
| 1146 | client, err := agent.adapterMgr.GetAdapterClient(ctx, agent.adapterEndpoint) |
| 1147 | if err != nil { |
| 1148 | logger.Errorw(ctx, "grpc-client-nil", |
| 1149 | log.Fields{ |
| 1150 | "error": err, |
| 1151 | "device-id": agent.deviceID, |
| 1152 | "device-type": agent.deviceType, |
| 1153 | "adapter-endpoint": cloned.AdapterEndpoint, |
| 1154 | }) |
| 1155 | return nil, err |
onkarkundargi | 8728525 | 2020-01-27 11:34:52 +0530 | [diff] [blame] | 1156 | } |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 1157 | |
| 1158 | res, err := client.StartOmciTest(ctx, &ic.OMCITest{ |
| 1159 | Device: cloned, |
| 1160 | Request: omcitestrequest, |
| 1161 | }) |
| 1162 | if err == nil { |
| 1163 | requestStatus.Code = common.OperationResp_OPERATION_SUCCESS |
| 1164 | } |
| 1165 | return res, err |
onkarkundargi | 8728525 | 2020-01-27 11:34:52 +0530 | [diff] [blame] | 1166 | } |
Dinesh Belwalkar | c1129f1 | 2020-02-27 10:41:33 -0800 | [diff] [blame] | 1167 | |
| 1168 | func (agent *Agent) getExtValue(ctx context.Context, pdevice *voltha.Device, cdevice *voltha.Device, valueparam *voltha.ValueSpecifier) (*voltha.ReturnValues, error) { |
Himani Chawla | b4c2591 | 2020-11-12 17:16:38 +0530 | [diff] [blame] | 1169 | logger.Debugw(ctx, "get-ext-value", log.Fields{"device-id": agent.deviceID, "onu-id": valueparam.Id, "value-type": valueparam.Value}) |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 1170 | var err error |
| 1171 | var desc string |
| 1172 | requestStatus := &common.OperationResp{Code: common.OperationResp_OPERATION_FAILURE} |
| 1173 | defer func() { agent.logDeviceUpdate(ctx, nil, nil, requestStatus, err, desc) }() |
| 1174 | |
| 1175 | if err = agent.requestQueue.WaitForGreenLight(ctx); err != nil { |
Dinesh Belwalkar | c1129f1 | 2020-02-27 10:41:33 -0800 | [diff] [blame] | 1176 | return nil, err |
| 1177 | } |
| 1178 | |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 1179 | //send request to adapter synchronously |
| 1180 | client, err := agent.adapterMgr.GetAdapterClient(ctx, pdevice.AdapterEndpoint) |
Dinesh Belwalkar | c1129f1 | 2020-02-27 10:41:33 -0800 | [diff] [blame] | 1181 | if err != nil { |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 1182 | logger.Errorw(ctx, "grpc-client-nil", |
| 1183 | log.Fields{ |
| 1184 | "error": err, |
| 1185 | "device-id": agent.deviceID, |
| 1186 | "device-type": agent.deviceType, |
| 1187 | "adapter-endpoint": pdevice.AdapterEndpoint, |
| 1188 | }) |
| 1189 | agent.requestQueue.RequestComplete() |
Dinesh Belwalkar | c1129f1 | 2020-02-27 10:41:33 -0800 | [diff] [blame] | 1190 | return nil, err |
| 1191 | } |
| 1192 | |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 1193 | // Release lock before sending to adapter |
| 1194 | agent.requestQueue.RequestComplete() |
Dinesh Belwalkar | c1129f1 | 2020-02-27 10:41:33 -0800 | [diff] [blame] | 1195 | |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 1196 | retVal, err := client.GetExtValue(ctx, &ic.GetExtValueMessage{ |
| 1197 | ParentDevice: pdevice, |
| 1198 | ChildDevice: cdevice, |
| 1199 | ValueType: valueparam.Value, |
| 1200 | }) |
| 1201 | if err == nil { |
| 1202 | requestStatus.Code = common.OperationResp_OPERATION_SUCCESS |
Dinesh Belwalkar | c1129f1 | 2020-02-27 10:41:33 -0800 | [diff] [blame] | 1203 | } |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 1204 | return retVal, err |
Dinesh Belwalkar | c1129f1 | 2020-02-27 10:41:33 -0800 | [diff] [blame] | 1205 | } |
dpaul | 6268631 | 2020-06-23 14:17:36 +0530 | [diff] [blame] | 1206 | |
| 1207 | func (agent *Agent) setExtValue(ctx context.Context, device *voltha.Device, value *voltha.ValueSet) (*empty.Empty, error) { |
Himani Chawla | b4c2591 | 2020-11-12 17:16:38 +0530 | [diff] [blame] | 1208 | logger.Debugw(ctx, "set-ext-value", log.Fields{"device-id": value.Id}) |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 1209 | |
| 1210 | var err error |
| 1211 | var desc string |
| 1212 | requestStatus := &common.OperationResp{Code: common.OperationResp_OPERATION_FAILURE} |
| 1213 | defer func() { agent.logDeviceUpdate(ctx, nil, nil, requestStatus, err, desc) }() |
| 1214 | |
| 1215 | if err = agent.requestQueue.WaitForGreenLight(ctx); err != nil { |
dpaul | 6268631 | 2020-06-23 14:17:36 +0530 | [diff] [blame] | 1216 | return nil, err |
| 1217 | } |
| 1218 | |
| 1219 | //send request to adapter |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 1220 | //send request to adapter synchronously |
| 1221 | client, err := agent.adapterMgr.GetAdapterClient(ctx, agent.adapterEndpoint) |
dpaul | 6268631 | 2020-06-23 14:17:36 +0530 | [diff] [blame] | 1222 | if err != nil { |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 1223 | logger.Errorw(ctx, "grpc-client-nil", |
| 1224 | log.Fields{ |
| 1225 | "error": err, |
| 1226 | "device-id": agent.deviceID, |
| 1227 | "device-type": agent.deviceType, |
| 1228 | "adapter-endpoint": device.AdapterEndpoint, |
| 1229 | }) |
| 1230 | agent.requestQueue.RequestComplete() |
dpaul | 6268631 | 2020-06-23 14:17:36 +0530 | [diff] [blame] | 1231 | return nil, err |
| 1232 | } |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 1233 | // Release lock before sending request to adapter |
| 1234 | agent.requestQueue.RequestComplete() |
dpaul | 6268631 | 2020-06-23 14:17:36 +0530 | [diff] [blame] | 1235 | |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 1236 | retVal, err := client.SetExtValue(ctx, &ic.SetExtValueMessage{ |
| 1237 | Device: device, |
| 1238 | Value: value, |
| 1239 | }) |
| 1240 | if err == nil { |
| 1241 | requestStatus.Code = common.OperationResp_OPERATION_SUCCESS |
dpaul | 6268631 | 2020-06-23 14:17:36 +0530 | [diff] [blame] | 1242 | } |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 1243 | return retVal, err |
dpaul | 6268631 | 2020-06-23 14:17:36 +0530 | [diff] [blame] | 1244 | } |
Salman Siddiqui | 1cf9504 | 2020-11-19 00:42:56 +0530 | [diff] [blame] | 1245 | |
| 1246 | func (agent *Agent) getSingleValue(ctx context.Context, request *extension.SingleGetValueRequest) (*extension.SingleGetValueResponse, error) { |
Himani Chawla | b4c2591 | 2020-11-12 17:16:38 +0530 | [diff] [blame] | 1247 | logger.Debugw(ctx, "get-single-value", log.Fields{"device-id": request.TargetId}) |
Salman Siddiqui | 1cf9504 | 2020-11-19 00:42:56 +0530 | [diff] [blame] | 1248 | |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 1249 | var err error |
| 1250 | var desc string |
| 1251 | requestStatus := &common.OperationResp{Code: common.OperationResp_OPERATION_FAILURE} |
| 1252 | defer func() { agent.logDeviceUpdate(ctx, nil, nil, requestStatus, err, desc) }() |
| 1253 | |
| 1254 | if err = agent.requestQueue.WaitForGreenLight(ctx); err != nil { |
Salman Siddiqui | 1cf9504 | 2020-11-19 00:42:56 +0530 | [diff] [blame] | 1255 | return nil, err |
| 1256 | } |
| 1257 | |
| 1258 | cloned := agent.cloneDeviceWithoutLock() |
| 1259 | |
| 1260 | //send request to adapter |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 1261 | client, err := agent.adapterMgr.GetAdapterClient(ctx, agent.adapterEndpoint) |
Salman Siddiqui | 1cf9504 | 2020-11-19 00:42:56 +0530 | [diff] [blame] | 1262 | if err != nil { |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 1263 | logger.Errorw(ctx, "grpc-client-nil", |
| 1264 | log.Fields{ |
| 1265 | "error": err, |
| 1266 | "device-id": cloned.Id, |
| 1267 | "adapter-endpoint": cloned.AdapterEndpoint, |
| 1268 | }) |
| 1269 | agent.requestQueue.RequestComplete() |
Salman Siddiqui | 1cf9504 | 2020-11-19 00:42:56 +0530 | [diff] [blame] | 1270 | return nil, err |
| 1271 | } |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 1272 | // Release lock before sending request to adapter |
| 1273 | agent.requestQueue.RequestComplete() |
Salman Siddiqui | 1cf9504 | 2020-11-19 00:42:56 +0530 | [diff] [blame] | 1274 | |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 1275 | resp, err := client.GetSingleValue(ctx, request) |
| 1276 | if err == nil { |
| 1277 | requestStatus.Code = common.OperationResp_OPERATION_SUCCESS |
Salman Siddiqui | 1cf9504 | 2020-11-19 00:42:56 +0530 | [diff] [blame] | 1278 | } |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 1279 | return resp, err |
Salman Siddiqui | 1cf9504 | 2020-11-19 00:42:56 +0530 | [diff] [blame] | 1280 | } |
| 1281 | |
| 1282 | func (agent *Agent) setSingleValue(ctx context.Context, request *extension.SingleSetValueRequest) (*extension.SingleSetValueResponse, error) { |
Himani Chawla | b4c2591 | 2020-11-12 17:16:38 +0530 | [diff] [blame] | 1283 | logger.Debugw(ctx, "set-single-value", log.Fields{"device-id": request.TargetId}) |
Salman Siddiqui | 1cf9504 | 2020-11-19 00:42:56 +0530 | [diff] [blame] | 1284 | |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 1285 | var err error |
| 1286 | var desc string |
| 1287 | requestStatus := &common.OperationResp{Code: common.OperationResp_OPERATION_FAILURE} |
| 1288 | defer func() { agent.logDeviceUpdate(ctx, nil, nil, requestStatus, err, desc) }() |
| 1289 | |
Salman Siddiqui | 1cf9504 | 2020-11-19 00:42:56 +0530 | [diff] [blame] | 1290 | if err := agent.requestQueue.WaitForGreenLight(ctx); err != nil { |
| 1291 | return nil, err |
| 1292 | } |
| 1293 | |
| 1294 | cloned := agent.cloneDeviceWithoutLock() |
| 1295 | |
| 1296 | //send request to adapter |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 1297 | client, err := agent.adapterMgr.GetAdapterClient(ctx, agent.adapterEndpoint) |
Salman Siddiqui | 1cf9504 | 2020-11-19 00:42:56 +0530 | [diff] [blame] | 1298 | if err != nil { |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 1299 | logger.Errorw(ctx, "grpc-client-nil", |
| 1300 | log.Fields{ |
| 1301 | "error": err, |
| 1302 | "device-id": agent.deviceID, |
| 1303 | "device-type": agent.deviceType, |
| 1304 | "adapter-endpoint": cloned.AdapterEndpoint, |
| 1305 | }) |
| 1306 | agent.requestQueue.RequestComplete() |
Salman Siddiqui | 1cf9504 | 2020-11-19 00:42:56 +0530 | [diff] [blame] | 1307 | return nil, err |
| 1308 | } |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 1309 | // Release lock before sending request to adapter |
| 1310 | agent.requestQueue.RequestComplete() |
Salman Siddiqui | 1cf9504 | 2020-11-19 00:42:56 +0530 | [diff] [blame] | 1311 | |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 1312 | resp, err := client.SetSingleValue(ctx, request) |
| 1313 | if err == nil { |
| 1314 | requestStatus.Code = common.OperationResp_OPERATION_SUCCESS |
Salman Siddiqui | 1cf9504 | 2020-11-19 00:42:56 +0530 | [diff] [blame] | 1315 | } |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 1316 | return resp, err |
Salman Siddiqui | 1cf9504 | 2020-11-19 00:42:56 +0530 | [diff] [blame] | 1317 | } |
Maninder | 0aabf0c | 2021-03-17 14:55:14 +0530 | [diff] [blame] | 1318 | |
Maninder | 2195ccc | 2021-06-23 20:23:01 +0530 | [diff] [blame] | 1319 | func (agent *Agent) proceedWithRequest(device *voltha.Device) bool { |
| 1320 | return !agent.isDeletionInProgress() && !agent.isInReconcileState(device) |
Maninder | 0aabf0c | 2021-03-17 14:55:14 +0530 | [diff] [blame] | 1321 | } |
| 1322 | |
| 1323 | func (agent *Agent) stopReconcile() { |
| 1324 | agent.stopReconcilingMutex.Lock() |
| 1325 | if agent.stopReconciling != nil { |
| 1326 | agent.stopReconciling <- 0 |
| 1327 | } |
| 1328 | agent.stopReconcilingMutex.Unlock() |
| 1329 | } |
| 1330 | |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 1331 | // abortAllProcessing is invoked when an adapter managing this device is restarted |
| 1332 | func (agent *Agent) abortAllProcessing(ctx context.Context) error { |
| 1333 | logger.Infow(ctx, "aborting-current-running-requests", log.Fields{"device-id": agent.deviceID}) |
| 1334 | if err := agent.requestQueue.WaitForGreenLight(ctx); err != nil { |
| 1335 | return err |
| 1336 | } |
| 1337 | defer agent.requestQueue.RequestComplete() |
| 1338 | |
| 1339 | // If any reconciling is in progress just abort it. The adapter is gone. |
| 1340 | agent.stopReconcile() |
| 1341 | |
| 1342 | // Update the Core device transient state accordingly |
| 1343 | var updatedState core.DeviceTransientState_Types |
| 1344 | switch agent.getTransientState() { |
| 1345 | case core.DeviceTransientState_RECONCILE_IN_PROGRESS: |
| 1346 | updatedState = core.DeviceTransientState_NONE |
| 1347 | case core.DeviceTransientState_FORCE_DELETING: |
| 1348 | updatedState = core.DeviceTransientState_DELETE_FAILED |
| 1349 | case core.DeviceTransientState_DELETING_FROM_ADAPTER: |
| 1350 | updatedState = core.DeviceTransientState_DELETE_FAILED |
| 1351 | default: |
| 1352 | updatedState = core.DeviceTransientState_NONE |
| 1353 | } |
| 1354 | if err := agent.updateTransientState(ctx, updatedState); err != nil { |
| 1355 | logger.Errorf(ctx, "transient-state-update-failed", log.Fields{"error": err}) |
| 1356 | return err |
| 1357 | } |
| 1358 | return nil |
| 1359 | } |
| 1360 | |
| 1361 | func (agent *Agent) ReconcileDevice(ctx context.Context) { |
| 1362 | requestStatus := &common.OperationResp{Code: common.OperationResp_OPERATION_FAILURE} |
Maninder | 0aabf0c | 2021-03-17 14:55:14 +0530 | [diff] [blame] | 1363 | var desc string |
Maninder | 0aabf0c | 2021-03-17 14:55:14 +0530 | [diff] [blame] | 1364 | |
| 1365 | if err := agent.requestQueue.WaitForGreenLight(ctx); err != nil { |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 1366 | agent.logDeviceUpdate(ctx, nil, nil, requestStatus, err, desc) |
| 1367 | return |
| 1368 | } |
| 1369 | |
| 1370 | device := agent.getDeviceReadOnlyWithoutLock() |
| 1371 | if device.AdminState == voltha.AdminState_PREPROVISIONED { |
| 1372 | agent.requestQueue.RequestComplete() |
| 1373 | logger.Debugw(ctx, "device-in-preprovisioning-state-reconcile-not-needed", log.Fields{"device-id": device.Id}) |
Maninder | 0aabf0c | 2021-03-17 14:55:14 +0530 | [diff] [blame] | 1374 | return |
| 1375 | } |
| 1376 | |
Maninder | 2195ccc | 2021-06-23 20:23:01 +0530 | [diff] [blame] | 1377 | if !agent.proceedWithRequest(device) { |
Maninder | 0aabf0c | 2021-03-17 14:55:14 +0530 | [diff] [blame] | 1378 | agent.requestQueue.RequestComplete() |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 1379 | err := fmt.Errorf("cannot complete operation as device deletion/reconciling is in progress or reconcile failed for device : %s", device.Id) |
| 1380 | logger.Errorw(ctx, "reconcile-failed", log.Fields{"error": err}) |
| 1381 | agent.logDeviceUpdate(ctx, nil, nil, requestStatus, err, desc) |
Maninder | 0aabf0c | 2021-03-17 14:55:14 +0530 | [diff] [blame] | 1382 | return |
| 1383 | } |
| 1384 | |
| 1385 | //set transient state to RECONCILE IN PROGRESS |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 1386 | err := agent.updateTransientState(ctx, core.DeviceTransientState_RECONCILE_IN_PROGRESS) |
Maninder | 0aabf0c | 2021-03-17 14:55:14 +0530 | [diff] [blame] | 1387 | if err != nil { |
| 1388 | agent.requestQueue.RequestComplete() |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 1389 | logger.Errorw(ctx, "setting-transient-state-failed", log.Fields{"error": err}) |
| 1390 | agent.logDeviceUpdate(ctx, nil, nil, requestStatus, nil, desc) |
Maninder | 0aabf0c | 2021-03-17 14:55:14 +0530 | [diff] [blame] | 1391 | return |
| 1392 | } |
| 1393 | |
Maninder | 0aabf0c | 2021-03-17 14:55:14 +0530 | [diff] [blame] | 1394 | reconcilingBackoff := backoff.NewExponentialBackOff() |
| 1395 | reconcilingBackoff.InitialInterval = agent.config.BackoffRetryInitialInterval |
| 1396 | reconcilingBackoff.MaxElapsedTime = agent.config.BackoffRetryMaxElapsedTime |
| 1397 | reconcilingBackoff.MaxInterval = agent.config.BackoffRetryMaxInterval |
| 1398 | |
| 1399 | //making here to keep lifecycle of this channel within the scope of retryReconcile |
| 1400 | agent.stopReconcilingMutex.Lock() |
| 1401 | agent.stopReconciling = make(chan int) |
| 1402 | agent.stopReconcilingMutex.Unlock() |
| 1403 | |
David K. Bainbridge | 482e442 | 2021-06-30 12:23:42 -0700 | [diff] [blame] | 1404 | // defined outside the retry loop so it can be cleaned |
| 1405 | // up when the loop breaks |
| 1406 | var backoffTimer *time.Timer |
| 1407 | |
| 1408 | retry: |
Maninder | 0aabf0c | 2021-03-17 14:55:14 +0530 | [diff] [blame] | 1409 | for { |
David K. Bainbridge | 482e442 | 2021-06-30 12:23:42 -0700 | [diff] [blame] | 1410 | // If the operations state of the device is RECONCILING_FAILED then we do not |
| 1411 | // want to continue to attempt reconciliation. |
| 1412 | deviceRef := agent.getDeviceReadOnlyWithoutLock() |
| 1413 | if deviceRef.OperStatus == common.OperStatus_RECONCILING_FAILED { |
| 1414 | logger.Warnw(ctx, "reconciling-failed-halting-retries", |
| 1415 | log.Fields{"device-id": device.Id}) |
| 1416 | agent.requestQueue.RequestComplete() |
| 1417 | break retry |
| 1418 | } |
| 1419 | |
Maninder | 0aabf0c | 2021-03-17 14:55:14 +0530 | [diff] [blame] | 1420 | // Use an exponential back off to prevent getting into a tight loop |
| 1421 | duration := reconcilingBackoff.NextBackOff() |
| 1422 | //This case should never occur in default case as max elapsed time for backoff is 0(by default) , so it will never return stop |
| 1423 | if duration == backoff.Stop { |
| 1424 | // If we reach a maximum then warn and reset the backoff |
| 1425 | // timer and keep attempting. |
| 1426 | logger.Warnw(ctx, "maximum-reconciling-backoff-reached--resetting-backoff-timer", |
| 1427 | log.Fields{"max-reconciling-backoff": reconcilingBackoff.MaxElapsedTime, |
| 1428 | "device-id": device.Id}) |
| 1429 | reconcilingBackoff.Reset() |
| 1430 | duration = reconcilingBackoff.NextBackOff() |
| 1431 | } |
| 1432 | |
David K. Bainbridge | 482e442 | 2021-06-30 12:23:42 -0700 | [diff] [blame] | 1433 | backoffTimer = time.NewTimer(duration) |
Maninder | 0aabf0c | 2021-03-17 14:55:14 +0530 | [diff] [blame] | 1434 | |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 1435 | logger.Debugw(ctx, "retrying-reconciling", log.Fields{"deviceID": device.Id, "endpoint": device.AdapterEndpoint}) |
| 1436 | // Release lock before sending request to adapter |
Maninder | 0aabf0c | 2021-03-17 14:55:14 +0530 | [diff] [blame] | 1437 | agent.requestQueue.RequestComplete() |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 1438 | |
| 1439 | // Send a reconcile request to the adapter. |
| 1440 | err := agent.sendReconcileRequestToAdapter(ctx, device) |
| 1441 | if errors.Is(err, errContextExpired) || errors.Is(err, errReconcileAborted) { |
| 1442 | logger.Errorw(ctx, "reconcile-aborted", log.Fields{"error": err}) |
| 1443 | requestStatus = &common.OperationResp{Code: common.OperationResp_OperationReturnCode(common.OperStatus_FAILED)} |
| 1444 | desc = "aborted" |
| 1445 | agent.logDeviceUpdate(ctx, nil, nil, requestStatus, err, desc) |
| 1446 | break retry |
| 1447 | } |
Maninder | 0aabf0c | 2021-03-17 14:55:14 +0530 | [diff] [blame] | 1448 | if err != nil { |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 1449 | agent.logDeviceUpdate(ctx, nil, nil, requestStatus, err, desc) |
Maninder | 0aabf0c | 2021-03-17 14:55:14 +0530 | [diff] [blame] | 1450 | <-backoffTimer.C |
| 1451 | // backoffTimer expired continue |
| 1452 | // Take lock back before retrying |
| 1453 | if err := agent.requestQueue.WaitForGreenLight(ctx); err != nil { |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 1454 | agent.logDeviceUpdate(ctx, nil, nil, requestStatus, err, desc) |
David K. Bainbridge | 482e442 | 2021-06-30 12:23:42 -0700 | [diff] [blame] | 1455 | break retry |
Maninder | 0aabf0c | 2021-03-17 14:55:14 +0530 | [diff] [blame] | 1456 | } |
| 1457 | continue |
| 1458 | } |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 1459 | // Success |
| 1460 | requestStatus = &common.OperationResp{Code: common.OperationResp_OPERATION_SUCCESS} |
| 1461 | desc = "adapter-response" |
| 1462 | agent.logDeviceUpdate(ctx, nil, nil, requestStatus, err, desc) |
| 1463 | break retry |
David K. Bainbridge | 482e442 | 2021-06-30 12:23:42 -0700 | [diff] [blame] | 1464 | } |
| 1465 | |
| 1466 | // Retry loop is broken, so stop any timers and drain the channel |
| 1467 | if backoffTimer != nil && !backoffTimer.Stop() { |
| 1468 | |
| 1469 | // As per documentation and stack overflow when a timer is stopped its |
| 1470 | // channel should be drained. The issue is that Stop returns false |
| 1471 | // either if the timer has already been fired "OR" if the timer can be |
| 1472 | // stopped before being fired. This means that in some cases the |
| 1473 | // channel has already be emptied so attempting to read from it means |
| 1474 | // a blocked thread. To get around this use a select so if the |
| 1475 | // channel is already empty the default case hits and we are not |
| 1476 | // blocked. |
| 1477 | select { |
| 1478 | case <-backoffTimer.C: |
| 1479 | default: |
Maninder | 0aabf0c | 2021-03-17 14:55:14 +0530 | [diff] [blame] | 1480 | } |
| 1481 | } |
| 1482 | } |
| 1483 | |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 1484 | func (agent *Agent) sendReconcileRequestToAdapter(ctx context.Context, device *voltha.Device) error { |
| 1485 | logger.Debugw(ctx, "sending-reconcile-to-adapter", log.Fields{"device-id": device.Id, "endpoint": agent.adapterEndpoint}) |
| 1486 | client, err := agent.adapterMgr.GetAdapterClient(ctx, agent.adapterEndpoint) |
| 1487 | if err != nil { |
| 1488 | return err |
| 1489 | } |
| 1490 | adapterResponse := make(chan error) |
| 1491 | go func() { |
| 1492 | _, err := client.ReconcileDevice(ctx, device) |
| 1493 | adapterResponse <- err |
| 1494 | }() |
Maninder | 0aabf0c | 2021-03-17 14:55:14 +0530 | [diff] [blame] | 1495 | select { |
| 1496 | // wait for response |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 1497 | case err := <-adapterResponse: |
| 1498 | if err != nil { |
| 1499 | return err |
Maninder | 0aabf0c | 2021-03-17 14:55:14 +0530 | [diff] [blame] | 1500 | } |
Maninder | 0aabf0c | 2021-03-17 14:55:14 +0530 | [diff] [blame] | 1501 | //In case of success quit retrying and wait for adapter to reset operation state of device |
| 1502 | agent.stopReconcilingMutex.Lock() |
| 1503 | agent.stopReconciling = nil |
| 1504 | agent.stopReconcilingMutex.Unlock() |
| 1505 | return nil |
| 1506 | |
| 1507 | //if reconciling need to be stopped |
| 1508 | case _, ok := <-agent.stopReconciling: |
| 1509 | agent.stopReconcilingMutex.Lock() |
| 1510 | agent.stopReconciling = nil |
| 1511 | agent.stopReconcilingMutex.Unlock() |
| 1512 | if !ok { |
| 1513 | //channel-closed |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 1514 | return fmt.Errorf("reconcile channel closed:%w", errReconcileAborted) |
Maninder | 0aabf0c | 2021-03-17 14:55:14 +0530 | [diff] [blame] | 1515 | } |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 1516 | return fmt.Errorf("reconciling aborted:%w", errReconcileAborted) |
| 1517 | // Context expired |
| 1518 | case <-ctx.Done(): |
| 1519 | return fmt.Errorf("context expired:%s :%w", ctx.Err(), errContextExpired) |
Maninder | 0aabf0c | 2021-03-17 14:55:14 +0530 | [diff] [blame] | 1520 | } |
Maninder | 0aabf0c | 2021-03-17 14:55:14 +0530 | [diff] [blame] | 1521 | } |
| 1522 | |
| 1523 | func (agent *Agent) reconcilingCleanup(ctx context.Context) error { |
| 1524 | var desc string |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 1525 | var err error |
Maninder | 0aabf0c | 2021-03-17 14:55:14 +0530 | [diff] [blame] | 1526 | operStatus := &common.OperationResp{Code: common.OperationResp_OPERATION_FAILURE} |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 1527 | defer func() { agent.logDeviceUpdate(ctx, nil, nil, operStatus, err, desc) }() |
| 1528 | |
| 1529 | if err = agent.requestQueue.WaitForGreenLight(ctx); err != nil { |
| 1530 | desc = "reconcile-cleanup-failed" |
Maninder | 0aabf0c | 2021-03-17 14:55:14 +0530 | [diff] [blame] | 1531 | return err |
| 1532 | } |
| 1533 | defer agent.requestQueue.RequestComplete() |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 1534 | err = agent.updateTransientState(ctx, core.DeviceTransientState_NONE) |
Maninder | 0aabf0c | 2021-03-17 14:55:14 +0530 | [diff] [blame] | 1535 | if err != nil { |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 1536 | logger.Errorf(ctx, "transient-state-update-failed", log.Fields{"error": err}) |
Maninder | 0aabf0c | 2021-03-17 14:55:14 +0530 | [diff] [blame] | 1537 | return err |
| 1538 | } |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 1539 | operStatus.Code = common.OperationResp_OPERATION_SUCCESS |
Maninder | 0aabf0c | 2021-03-17 14:55:14 +0530 | [diff] [blame] | 1540 | return nil |
| 1541 | } |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 1542 | |
| 1543 | func (agent *Agent) isAdapterConnectionUp(ctx context.Context) bool { |
| 1544 | c, err := agent.adapterMgr.GetAdapterClient(ctx, agent.adapterEndpoint) |
| 1545 | return c != nil && err == nil |
| 1546 | } |
| 1547 | |
| 1548 | func (agent *Agent) canDeviceRequestProceed(ctx context.Context) error { |
| 1549 | if err := agent.requestQueue.WaitForGreenLight(ctx); err != nil { |
| 1550 | return err |
| 1551 | } |
| 1552 | defer agent.requestQueue.RequestComplete() |
| 1553 | if agent.proceedWithRequest(agent.device) { |
| 1554 | return nil |
| 1555 | } |
| 1556 | return fmt.Errorf("device-cannot-process-request-%s", agent.deviceID) |
| 1557 | } |