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