blob: babbda9ec74875c6b64631515ff0920fdacf3b86 [file] [log] [blame]
Holger Hildebrandtfa074992020-03-27 15:42:06 +00001/*
2 * Copyright 2020-present Open Networking Foundation
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +000017//Package adaptercoreonu provides the utility for onu devices, flows and statistics
18package adaptercoreonu
Holger Hildebrandtfa074992020-03-27 15:42:06 +000019
20import (
21 "context"
22 "errors"
23 "fmt"
24 "sync"
25 "time"
26
Girish Gowdra50e56422021-06-01 16:46:04 -070027 conf "github.com/opencord/voltha-lib-go/v5/pkg/config"
dbainbri4d3a0dc2020-12-02 00:33:42 +000028
Holger Hildebrandt6c1fb0a2020-11-25 15:41:01 +000029 "github.com/golang/protobuf/ptypes"
Girish Gowdra50e56422021-06-01 16:46:04 -070030 "github.com/opencord/voltha-lib-go/v5/pkg/adapters/adapterif"
31 "github.com/opencord/voltha-lib-go/v5/pkg/db/kvstore"
32 "github.com/opencord/voltha-lib-go/v5/pkg/events/eventif"
33 "github.com/opencord/voltha-lib-go/v5/pkg/kafka"
34 "github.com/opencord/voltha-lib-go/v5/pkg/log"
mpagenkoc8bba412021-01-15 15:38:44 +000035 "github.com/opencord/voltha-protos/v4/go/extension"
dbainbri4d3a0dc2020-12-02 00:33:42 +000036 ic "github.com/opencord/voltha-protos/v4/go/inter_container"
37 "github.com/opencord/voltha-protos/v4/go/openflow_13"
38 oop "github.com/opencord/voltha-protos/v4/go/openolt"
39 "github.com/opencord/voltha-protos/v4/go/voltha"
Holger Hildebrandtfa074992020-03-27 15:42:06 +000040
Matteo Scandolo761f7512020-11-23 15:52:40 -080041 "github.com/opencord/voltha-openonu-adapter-go/internal/pkg/config"
Holger Hildebrandtfa074992020-03-27 15:42:06 +000042)
43
44//OpenONUAC structure holds the ONU core information
45type OpenONUAC struct {
Himani Chawla6d2ae152020-09-02 13:11:20 +053046 deviceHandlers map[string]*deviceHandler
Holger Hildebrandtf07b44a2020-11-10 13:07:54 +000047 deviceHandlersCreateChan map[string]chan bool //channels for deviceHandler create events
Holger Hildebrandt61b24d02020-11-16 13:36:40 +000048 lockDeviceHandlersMap sync.RWMutex
Holger Hildebrandtfa074992020-03-27 15:42:06 +000049 coreProxy adapterif.CoreProxy
50 adapterProxy adapterif.AdapterProxy
Himani Chawlac07fda02020-12-09 16:21:21 +053051 eventProxy eventif.EventProxy
Holger Hildebrandtfa074992020-03-27 15:42:06 +000052 kafkaICProxy kafka.InterContainerProxy
mpagenkoaf801632020-07-03 10:00:42 +000053 kvClient kvstore.Client
Matteo Scandolof1f39a72020-11-24 12:08:11 -080054 cm *conf.ConfigManager
Holger Hildebrandtfa074992020-03-27 15:42:06 +000055 config *config.AdapterFlags
56 numOnus int
Matteo Scandolo127c59d2021-01-28 11:31:18 -080057 KVStoreAddress string
Holger Hildebrandtfa074992020-03-27 15:42:06 +000058 KVStoreType string
mpagenkoaf801632020-07-03 10:00:42 +000059 KVStoreTimeout time.Duration
Holger Hildebrandt61b24d02020-11-16 13:36:40 +000060 mibTemplatesGenerated map[string]bool
61 lockMibTemplateGenerated sync.RWMutex
Holger Hildebrandtfa074992020-03-27 15:42:06 +000062 exitChannel chan int
63 HeartbeatCheckInterval time.Duration
64 HeartbeatFailReportInterval time.Duration
mpagenkodff5dda2020-08-28 11:52:01 +000065 AcceptIncrementalEvto bool
Holger Hildebrandtfa074992020-03-27 15:42:06 +000066 //GrpcTimeoutInterval time.Duration
Himani Chawlad96df182020-09-28 11:12:02 +053067 pSupportedFsms *OmciDeviceFsms
68 maxTimeoutInterAdapterComm time.Duration
Holger Hildebrandt38985dc2021-02-18 16:25:20 +000069 maxTimeoutReconciling time.Duration
mpagenkoc8bba412021-01-15 15:38:44 +000070 pDownloadManager *adapterDownloadManager
mpagenkoc26d4c02021-05-06 14:27:57 +000071 pFileManager *fileDownloadManager //let coexist 'old and new' DownloadManager as long as 'old' does not get obsolete
Girish Gowdraaf0ad632021-01-27 13:00:01 -080072 metricsEnabled bool
Holger Hildebrandte3677f12021-02-05 14:50:56 +000073 mibAuditInterval time.Duration
Girish Gowdra0b235842021-03-09 13:06:46 -080074 omciTimeout int // in seconds
Himani Chawla075f1642021-03-15 19:23:24 +053075 alarmAuditInterval time.Duration
mpagenkoc26d4c02021-05-06 14:27:57 +000076 dlToOnuTimeout4M time.Duration
Holger Hildebrandtfa074992020-03-27 15:42:06 +000077}
78
79//NewOpenONUAC returns a new instance of OpenONU_AC
80func NewOpenONUAC(ctx context.Context, kafkaICProxy kafka.InterContainerProxy,
81 coreProxy adapterif.CoreProxy, adapterProxy adapterif.AdapterProxy,
Himani Chawlac07fda02020-12-09 16:21:21 +053082 eventProxy eventif.EventProxy, kvClient kvstore.Client, cfg *config.AdapterFlags, cm *conf.ConfigManager) *OpenONUAC {
Holger Hildebrandtfa074992020-03-27 15:42:06 +000083 var openOnuAc OpenONUAC
84 openOnuAc.exitChannel = make(chan int, 1)
Himani Chawla6d2ae152020-09-02 13:11:20 +053085 openOnuAc.deviceHandlers = make(map[string]*deviceHandler)
Holger Hildebrandtf07b44a2020-11-10 13:07:54 +000086 openOnuAc.deviceHandlersCreateChan = make(map[string]chan bool)
Holger Hildebrandt61b24d02020-11-16 13:36:40 +000087 openOnuAc.lockDeviceHandlersMap = sync.RWMutex{}
Holger Hildebrandtfa074992020-03-27 15:42:06 +000088 openOnuAc.kafkaICProxy = kafkaICProxy
89 openOnuAc.config = cfg
Matteo Scandolof1f39a72020-11-24 12:08:11 -080090 openOnuAc.cm = cm
Holger Hildebrandtfa074992020-03-27 15:42:06 +000091 openOnuAc.numOnus = cfg.OnuNumber
92 openOnuAc.coreProxy = coreProxy
93 openOnuAc.adapterProxy = adapterProxy
94 openOnuAc.eventProxy = eventProxy
mpagenkoaf801632020-07-03 10:00:42 +000095 openOnuAc.kvClient = kvClient
Matteo Scandolo127c59d2021-01-28 11:31:18 -080096 openOnuAc.KVStoreAddress = cfg.KVStoreAddress
Holger Hildebrandtfa074992020-03-27 15:42:06 +000097 openOnuAc.KVStoreType = cfg.KVStoreType
mpagenkoaf801632020-07-03 10:00:42 +000098 openOnuAc.KVStoreTimeout = cfg.KVStoreTimeout
Holger Hildebrandt61b24d02020-11-16 13:36:40 +000099 openOnuAc.mibTemplatesGenerated = make(map[string]bool)
100 openOnuAc.lockMibTemplateGenerated = sync.RWMutex{}
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000101 openOnuAc.HeartbeatCheckInterval = cfg.HeartbeatCheckInterval
102 openOnuAc.HeartbeatFailReportInterval = cfg.HeartbeatFailReportInterval
mpagenkodff5dda2020-08-28 11:52:01 +0000103 openOnuAc.AcceptIncrementalEvto = cfg.AccIncrEvto
Himani Chawlad96df182020-09-28 11:12:02 +0530104 openOnuAc.maxTimeoutInterAdapterComm = cfg.MaxTimeoutInterAdapterComm
Holger Hildebrandt38985dc2021-02-18 16:25:20 +0000105 openOnuAc.maxTimeoutReconciling = cfg.MaxTimeoutReconciling
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000106 //openOnuAc.GrpcTimeoutInterval = cfg.GrpcTimeoutInterval
Girish Gowdraaf0ad632021-01-27 13:00:01 -0800107 openOnuAc.metricsEnabled = cfg.MetricsEnabled
Holger Hildebrandte3677f12021-02-05 14:50:56 +0000108 openOnuAc.mibAuditInterval = cfg.MibAuditInterval
Girish Gowdra0b235842021-03-09 13:06:46 -0800109 // since consumers of OMCI timeout value everywhere in code is in "int seconds", do this useful conversion
110 openOnuAc.omciTimeout = int(cfg.OmciTimeout.Seconds())
Himani Chawla075f1642021-03-15 19:23:24 +0530111 openOnuAc.alarmAuditInterval = cfg.AlarmAuditInterval
mpagenkoc26d4c02021-05-06 14:27:57 +0000112 openOnuAc.dlToOnuTimeout4M = cfg.DownloadToOnuTimeout4MB
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000113
114 openOnuAc.pSupportedFsms = &OmciDeviceFsms{
115 "mib-synchronizer": {
116 //mibSyncFsm, // Implements the MIB synchronization state machine
Himani Chawla6d2ae152020-09-02 13:11:20 +0530117 mibDbVolatileDictImpl, // Implements volatile ME MIB database
Himani Chawla4d908332020-08-31 12:30:20 +0530118 //true, // Advertise events on OpenOMCI event bus
Holger Hildebrandte3677f12021-02-05 14:50:56 +0000119 openOnuAc.mibAuditInterval, // Time to wait between MIB audits. 0 to disable audits.
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000120 // map[string]func() error{
121 // "mib-upload": onuDeviceEntry.MibUploadTask,
122 // "mib-template": onuDeviceEntry.MibTemplateTask,
123 // "get-mds": onuDeviceEntry.GetMdsTask,
124 // "mib-audit": onuDeviceEntry.GetMdsTask,
125 // "mib-resync": onuDeviceEntry.MibResyncTask,
126 // "mib-reconcile": onuDeviceEntry.MibReconcileTask,
127 // },
128 },
129 }
130
mpagenkoc8bba412021-01-15 15:38:44 +0000131 openOnuAc.pDownloadManager = newAdapterDownloadManager(ctx)
mpagenkoc26d4c02021-05-06 14:27:57 +0000132 openOnuAc.pFileManager = newFileDownloadManager(ctx)
133 openOnuAc.pFileManager.SetDownloadTimeout(ctx, cfg.DownloadToAdapterTimeout)
mpagenkoc8bba412021-01-15 15:38:44 +0000134
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000135 return &openOnuAc
136}
137
138//Start starts (logs) the adapter
139func (oo *OpenONUAC) Start(ctx context.Context) error {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000140 logger.Info(ctx, "starting-openonu-adapter")
mpagenkoc8bba412021-01-15 15:38:44 +0000141
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000142 return nil
143}
144
Himani Chawla6d2ae152020-09-02 13:11:20 +0530145/*
146//stop terminates the session
147func (oo *OpenONUAC) stop(ctx context.Context) error {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000148 logger.Info(ctx,"stopping-device-manager")
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000149 oo.exitChannel <- 1
dbainbri4d3a0dc2020-12-02 00:33:42 +0000150 logger.Info(ctx,"device-manager-stopped")
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000151 return nil
152}
Himani Chawla6d2ae152020-09-02 13:11:20 +0530153*/
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000154
Himani Chawla6d2ae152020-09-02 13:11:20 +0530155func (oo *OpenONUAC) addDeviceHandlerToMap(ctx context.Context, agent *deviceHandler) {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000156 oo.lockDeviceHandlersMap.Lock()
157 defer oo.lockDeviceHandlersMap.Unlock()
158 if _, exist := oo.deviceHandlers[agent.deviceID]; !exist {
159 oo.deviceHandlers[agent.deviceID] = agent
Himani Chawla6d2ae152020-09-02 13:11:20 +0530160 oo.deviceHandlers[agent.deviceID].start(ctx)
Holger Hildebrandtf07b44a2020-11-10 13:07:54 +0000161 if _, exist := oo.deviceHandlersCreateChan[agent.deviceID]; exist {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000162 logger.Debugw(ctx, "deviceHandler created - trigger processing of pending ONU_IND_REQUEST", log.Fields{"device-id": agent.deviceID})
Holger Hildebrandtf07b44a2020-11-10 13:07:54 +0000163 oo.deviceHandlersCreateChan[agent.deviceID] <- true
164 }
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000165 }
166}
167
Himani Chawla6d2ae152020-09-02 13:11:20 +0530168func (oo *OpenONUAC) deleteDeviceHandlerToMap(agent *deviceHandler) {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000169 oo.lockDeviceHandlersMap.Lock()
170 defer oo.lockDeviceHandlersMap.Unlock()
171 delete(oo.deviceHandlers, agent.deviceID)
Holger Hildebrandtf07b44a2020-11-10 13:07:54 +0000172 delete(oo.deviceHandlersCreateChan, agent.deviceID)
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000173}
174
Holger Hildebrandtf07b44a2020-11-10 13:07:54 +0000175//getDeviceHandler gets the ONU deviceHandler and may wait until it is created
dbainbri4d3a0dc2020-12-02 00:33:42 +0000176func (oo *OpenONUAC) getDeviceHandler(ctx context.Context, deviceID string, aWait bool) *deviceHandler {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000177 oo.lockDeviceHandlersMap.Lock()
Holger Hildebrandtf07b44a2020-11-10 13:07:54 +0000178 agent, ok := oo.deviceHandlers[deviceID]
179 if aWait && !ok {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000180 logger.Infow(ctx, "Race condition: deviceHandler not present - wait for creation or timeout",
Holger Hildebrandt6c1fb0a2020-11-25 15:41:01 +0000181 log.Fields{"device-id": deviceID})
Holger Hildebrandtf07b44a2020-11-10 13:07:54 +0000182 if _, exist := oo.deviceHandlersCreateChan[deviceID]; !exist {
183 oo.deviceHandlersCreateChan[deviceID] = make(chan bool, 1)
184 }
Girish Gowdra7407a4d2020-11-12 12:44:53 -0800185 deviceCreateChan := oo.deviceHandlersCreateChan[deviceID]
Holger Hildebrandtf07b44a2020-11-10 13:07:54 +0000186 //keep the read sema short to allow for subsequent write
187 oo.lockDeviceHandlersMap.Unlock()
188 // based on concurrent processing the deviceHandler creation may not yet be finished at his point
189 // so it might be needed to wait here for that event with some timeout
190 select {
191 case <-time.After(1 * time.Second): //timer may be discussed ...
dbainbri4d3a0dc2020-12-02 00:33:42 +0000192 logger.Warnw(ctx, "No valid deviceHandler created after max WaitTime", log.Fields{"device-id": deviceID})
Holger Hildebrandtf07b44a2020-11-10 13:07:54 +0000193 return nil
Girish Gowdra7407a4d2020-11-12 12:44:53 -0800194 case <-deviceCreateChan:
dbainbri4d3a0dc2020-12-02 00:33:42 +0000195 logger.Debugw(ctx, "deviceHandler is ready now - continue", log.Fields{"device-id": deviceID})
Girish Gowdra7407a4d2020-11-12 12:44:53 -0800196 oo.lockDeviceHandlersMap.RLock()
197 defer oo.lockDeviceHandlersMap.RUnlock()
Holger Hildebrandtf07b44a2020-11-10 13:07:54 +0000198 return oo.deviceHandlers[deviceID]
199 }
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000200 }
Holger Hildebrandtf07b44a2020-11-10 13:07:54 +0000201 oo.lockDeviceHandlersMap.Unlock()
202 return agent
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000203}
204
dbainbri4d3a0dc2020-12-02 00:33:42 +0000205func (oo *OpenONUAC) processInterAdapterONUIndReqMessage(ctx context.Context, msg *ic.InterAdapterMessage) error {
Holger Hildebrandt6c1fb0a2020-11-25 15:41:01 +0000206 msgBody := msg.GetBody()
207 onuIndication := &oop.OnuIndication{}
208 if err := ptypes.UnmarshalAny(msgBody, onuIndication); err != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000209 logger.Warnw(ctx, "onu-ind-request-cannot-unmarshal-msg-body", log.Fields{"error": err})
Holger Hildebrandt6c1fb0a2020-11-25 15:41:01 +0000210 return err
211 }
212 //ToDeviceId should address a DeviceHandler instance
213 targetDevice := msg.Header.ToDeviceId
214
215 onuOperstate := onuIndication.GetOperState()
216 waitForDhInstPresent := false
217 if onuOperstate == "up" {
218 //Race condition (relevant in BBSIM-environment only): Due to unsynchronized processing of olt-adapter and rw_core,
219 //ONU_IND_REQUEST msg by olt-adapter could arrive a little bit earlier than rw_core was able to announce the corresponding
220 //ONU by RPC of Adopt_device(). Therefore it could be necessary to wait with processing of ONU_IND_REQUEST until call of
221 //Adopt_device() arrived and DeviceHandler instance was created
222 waitForDhInstPresent = true
223 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000224 if handler := oo.getDeviceHandler(ctx, targetDevice, waitForDhInstPresent); handler != nil {
225 logger.Infow(ctx, "onu-ind-request", log.Fields{"device-id": targetDevice,
Holger Hildebrandt6c1fb0a2020-11-25 15:41:01 +0000226 "OnuId": onuIndication.GetOnuId(),
227 "AdminState": onuIndication.GetAdminState(), "OperState": onuOperstate,
228 "SNR": onuIndication.GetSerialNumber()})
229
230 if onuOperstate == "up" {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000231 return handler.createInterface(ctx, onuIndication)
Holger Hildebrandt6c1fb0a2020-11-25 15:41:01 +0000232 } else if (onuOperstate == "down") || (onuOperstate == "unreachable") {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000233 return handler.updateInterface(ctx, onuIndication)
Holger Hildebrandt6c1fb0a2020-11-25 15:41:01 +0000234 } else {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000235 logger.Errorw(ctx, "unknown-onu-ind-request operState", log.Fields{"OnuId": onuIndication.GetOnuId()})
Holger Hildebrandt6c1fb0a2020-11-25 15:41:01 +0000236 return fmt.Errorf("invalidOperState: %s, %s", onuOperstate, targetDevice)
237 }
238 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000239 logger.Warnw(ctx, "no handler found for received onu-ind-request", log.Fields{
Holger Hildebrandt6c1fb0a2020-11-25 15:41:01 +0000240 "msgToDeviceId": targetDevice})
241 return fmt.Errorf(fmt.Sprintf("handler-not-found-%s", targetDevice))
242}
243
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000244// Adapter interface required methods ############## begin #########
245// #################################################################
246
247// for original content compare: (needs according deviceHandler methods)
248// /voltha-openolt-adapter/adaptercore/openolt.go
249
250// Adopt_device creates a new device handler if not present already and then adopts the device
dbainbri4d3a0dc2020-12-02 00:33:42 +0000251func (oo *OpenONUAC) Adopt_device(ctx context.Context, device *voltha.Device) error {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000252 if device == nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000253 logger.Warn(ctx, "voltha-device-is-nil")
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000254 return errors.New("nil-device")
255 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000256 logger.Infow(ctx, "adopt-device", log.Fields{"device-id": device.Id})
Himani Chawla6d2ae152020-09-02 13:11:20 +0530257 var handler *deviceHandler
dbainbri4d3a0dc2020-12-02 00:33:42 +0000258 if handler = oo.getDeviceHandler(ctx, device.Id, false); handler == nil {
259 handler := newDeviceHandler(ctx, oo.coreProxy, oo.adapterProxy, oo.eventProxy, device, oo)
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000260 oo.addDeviceHandlerToMap(ctx, handler)
Himani Chawla6d2ae152020-09-02 13:11:20 +0530261 go handler.adoptOrReconcileDevice(ctx, device)
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000262 // Launch the creation of the device topic
263 // go oo.createDeviceTopic(device)
264 }
265 return nil
266}
267
268//Get_ofp_device_info returns OFP information for the given device
dbainbri4d3a0dc2020-12-02 00:33:42 +0000269func (oo *OpenONUAC) Get_ofp_device_info(ctx context.Context, device *voltha.Device) (*ic.SwitchCapability, error) {
270 logger.Errorw(ctx, "device-handler-not-set", log.Fields{"device-id": device.Id})
Andrea Campanella6515c582020-10-05 11:25:00 +0200271 return nil, fmt.Errorf("device-handler-not-set %s", device.Id)
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000272}
273
274//Get_ofp_port_info returns OFP port information for the given device
mpagenkoaf801632020-07-03 10:00:42 +0000275//200630: method removed as per [VOL-3202]: OF port info is now to be delivered within UniPort create
276// cmp changes in onu_uni_port.go::CreateVolthaPort()
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000277
278//Process_inter_adapter_message sends messages to a target device (between adapters)
dbainbri4d3a0dc2020-12-02 00:33:42 +0000279func (oo *OpenONUAC) Process_inter_adapter_message(ctx context.Context, msg *ic.InterAdapterMessage) error {
280 logger.Debugw(ctx, "Process_inter_adapter_message", log.Fields{"msgId": msg.Header.Id,
Holger Hildebrandt80129db2020-11-23 10:49:32 +0000281 "msgProxyDeviceId": msg.Header.ProxyDeviceId, "msgToDeviceId": msg.Header.ToDeviceId, "Type": msg.Header.Type})
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000282
Holger Hildebrandt6c1fb0a2020-11-25 15:41:01 +0000283 if msg.Header.Type == ic.InterAdapterMessageType_ONU_IND_REQUEST {
284 // we have to handle ONU_IND_REQUEST already here - see comments in processInterAdapterONUIndReqMessage()
dbainbri4d3a0dc2020-12-02 00:33:42 +0000285 return oo.processInterAdapterONUIndReqMessage(ctx, msg)
Holger Hildebrandt6c1fb0a2020-11-25 15:41:01 +0000286 }
Holger Hildebrandtf07b44a2020-11-10 13:07:54 +0000287 //ToDeviceId should address a DeviceHandler instance
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000288 targetDevice := msg.Header.ToDeviceId
dbainbri4d3a0dc2020-12-02 00:33:42 +0000289 if handler := oo.getDeviceHandler(ctx, targetDevice, false); handler != nil {
mpagenko1cc3cb42020-07-27 15:24:38 +0000290 /* 200724: modification towards synchronous implementation - possible errors within processing shall be
291 * in the accordingly delayed response, some timing effect might result in Techprofile processing for multiple UNI's
292 */
dbainbri4d3a0dc2020-12-02 00:33:42 +0000293 return handler.processInterAdapterMessage(ctx, msg)
mpagenko1cc3cb42020-07-27 15:24:38 +0000294 /* so far the processing has been in background with according commented error treatment restrictions:
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000295 go handler.ProcessInterAdapterMessage(msg)
296 // error treatment might be more sophisticated
297 // by now let's just accept the message on 'communication layer'
298 // message content problems have to be evaluated then in the handler
299 // and are by now not reported to the calling party (to force what reaction there?)
300 return nil
mpagenko1cc3cb42020-07-27 15:24:38 +0000301 */
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000302 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000303 logger.Warnw(ctx, "no handler found for received Inter-Proxy-message", log.Fields{
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000304 "msgToDeviceId": targetDevice})
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000305 return fmt.Errorf(fmt.Sprintf("handler-not-found-%s", targetDevice))
306}
307
Girish Gowdra50e56422021-06-01 16:46:04 -0700308//Process_tech_profile_instance_request not implemented
309func (oo *OpenONUAC) Process_tech_profile_instance_request(ctx context.Context, msg *ic.InterAdapterTechProfileInstanceRequestMessage) *ic.InterAdapterTechProfileDownloadMessage {
310 logger.Error(ctx, "unImplemented")
311 return nil
312}
313
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000314//Adapter_descriptor not implemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000315func (oo *OpenONUAC) Adapter_descriptor(ctx context.Context) error {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000316 return errors.New("unImplemented")
317}
318
319//Device_types unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000320func (oo *OpenONUAC) Device_types(ctx context.Context) (*voltha.DeviceTypes, error) {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000321 return nil, errors.New("unImplemented")
322}
323
324//Health returns unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000325func (oo *OpenONUAC) Health(ctx context.Context) (*voltha.HealthStatus, error) {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000326 return nil, errors.New("unImplemented")
327}
328
Holger Hildebrandt9ca8b132020-08-07 14:45:03 +0000329//Reconcile_device is called once when the adapter needs to re-create device - usually on core restart
dbainbri4d3a0dc2020-12-02 00:33:42 +0000330func (oo *OpenONUAC) Reconcile_device(ctx context.Context, device *voltha.Device) error {
Holger Hildebrandtf41a1602020-08-19 09:52:50 +0000331 if device == nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000332 logger.Warn(ctx, "reconcile-device-voltha-device-is-nil")
Holger Hildebrandtf41a1602020-08-19 09:52:50 +0000333 return errors.New("nil-device")
334 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000335 logger.Infow(ctx, "reconcile-device", log.Fields{"device-id": device.Id})
Himani Chawla6d2ae152020-09-02 13:11:20 +0530336 var handler *deviceHandler
dbainbri4d3a0dc2020-12-02 00:33:42 +0000337 if handler = oo.getDeviceHandler(ctx, device.Id, false); handler == nil {
338 handler := newDeviceHandler(ctx, oo.coreProxy, oo.adapterProxy, oo.eventProxy, device, oo)
Holger Hildebrandtf41a1602020-08-19 09:52:50 +0000339 oo.addDeviceHandlerToMap(ctx, handler)
340 handler.device = device
Maninderb5187552021-03-23 22:23:42 +0530341 if err := handler.coreProxy.DeviceStateUpdate(ctx, device.Id, device.ConnectStatus, voltha.OperStatus_RECONCILING); err != nil {
342 return fmt.Errorf("not able to update device state to reconciling. Err : %s", err.Error())
343 }
Holger Hildebrandtbe523842021-03-10 10:47:18 +0000344 handler.startReconciling(ctx, false)
Himani Chawla6d2ae152020-09-02 13:11:20 +0530345 go handler.adoptOrReconcileDevice(ctx, handler.device)
Holger Hildebrandtf41a1602020-08-19 09:52:50 +0000346 // reconcilement will be continued after onu-device entry is added
Holger Hildebrandt9ca8b132020-08-07 14:45:03 +0000347 } else {
Holger Hildebrandtf41a1602020-08-19 09:52:50 +0000348 return fmt.Errorf(fmt.Sprintf("device-already-reconciled-or-active-%s", device.Id))
Holger Hildebrandt9ca8b132020-08-07 14:45:03 +0000349 }
350 return nil
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000351}
352
353//Abandon_device unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000354func (oo *OpenONUAC) Abandon_device(ctx context.Context, device *voltha.Device) error {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000355 return errors.New("unImplemented")
356}
357
358//Disable_device disables the given device
dbainbri4d3a0dc2020-12-02 00:33:42 +0000359func (oo *OpenONUAC) Disable_device(ctx context.Context, device *voltha.Device) error {
360 logger.Infow(ctx, "disable-device", log.Fields{"device-id": device.Id})
361 if handler := oo.getDeviceHandler(ctx, device.Id, false); handler != nil {
362 go handler.disableDevice(ctx, device)
ozgecanetsiafce57b12020-05-25 14:39:35 +0300363 return nil
364 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000365 logger.Warnw(ctx, "no handler found for device-disable", log.Fields{"device-id": device.Id})
ozgecanetsiafce57b12020-05-25 14:39:35 +0300366 return fmt.Errorf(fmt.Sprintf("handler-not-found-%s", device.Id))
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000367}
368
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000369//Reenable_device enables the onu device after disable
dbainbri4d3a0dc2020-12-02 00:33:42 +0000370func (oo *OpenONUAC) Reenable_device(ctx context.Context, device *voltha.Device) error {
371 logger.Infow(ctx, "reenable-device", log.Fields{"device-id": device.Id})
372 if handler := oo.getDeviceHandler(ctx, device.Id, false); handler != nil {
373 go handler.reEnableDevice(ctx, device)
ozgecanetsiafce57b12020-05-25 14:39:35 +0300374 return nil
375 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000376 logger.Warnw(ctx, "no handler found for device-reenable", log.Fields{"device-id": device.Id})
ozgecanetsiafce57b12020-05-25 14:39:35 +0300377 return fmt.Errorf(fmt.Sprintf("handler-not-found-%s", device.Id))
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000378}
379
380//Reboot_device reboots the given device
dbainbri4d3a0dc2020-12-02 00:33:42 +0000381func (oo *OpenONUAC) Reboot_device(ctx context.Context, device *voltha.Device) error {
382 logger.Infow(ctx, "reboot-device", log.Fields{"device-id": device.Id})
383 if handler := oo.getDeviceHandler(ctx, device.Id, false); handler != nil {
mpagenko15ff4a52021-03-02 10:09:20 +0000384 go handler.rebootDevice(ctx, true, device) //reboot request with device checking
ozgecanetsiae11479f2020-07-06 09:44:47 +0300385 return nil
386 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000387 logger.Warnw(ctx, "no handler found for device-reboot", log.Fields{"device-id": device.Id})
Andrey Pozolotin1394a1c2021-06-01 00:54:18 +0300388 return fmt.Errorf("handler-not-found-for-device: %s", device.Id)
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000389}
390
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000391//Self_test_device unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000392func (oo *OpenONUAC) Self_test_device(ctx context.Context, device *voltha.Device) error {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000393 return errors.New("unImplemented")
394}
395
Himani Chawla6d2ae152020-09-02 13:11:20 +0530396// Delete_device deletes the given device
dbainbri4d3a0dc2020-12-02 00:33:42 +0000397func (oo *OpenONUAC) Delete_device(ctx context.Context, device *voltha.Device) error {
398 logger.Infow(ctx, "delete-device", log.Fields{"device-id": device.Id, "SerialNumber": device.SerialNumber})
399 if handler := oo.getDeviceHandler(ctx, device.Id, false); handler != nil {
Girish Gowdra0e533642021-03-02 22:02:51 -0800400 var errorsList []error
Holger Hildebrandtff05b682021-03-16 15:02:05 +0000401
402 handler.mutexDeletionInProgressFlag.Lock()
403 handler.deletionInProgress = true
404 handler.mutexDeletionInProgressFlag.Unlock()
405
Girish Gowdra0e533642021-03-02 22:02:51 -0800406 if err := handler.deleteDevicePersistencyData(ctx); err != nil {
407 errorsList = append(errorsList, err)
408 }
Girish Gowdra6afb56a2021-04-27 17:47:57 -0700409 select {
410 case handler.stopCollector <- true: // stop the metric collector routine
411 logger.Debugw(ctx, "sent stop signal to metric collector routine", log.Fields{"device-id": device.Id})
412 default:
413 logger.Warnw(ctx, "metric collector routine not waiting on stop signal", log.Fields{"device-id": device.Id})
414 }
415 select {
416 case handler.stopAlarmManager <- true: //stop the alarm manager.
417 logger.Debugw(ctx, "sent stop signal to alarm manager", log.Fields{"device-id": device.Id})
418 default:
419 logger.Warnw(ctx, "alarm manager not waiting on stop signal", log.Fields{"device-id": device.Id})
420 }
Girish Gowdra0e533642021-03-02 22:02:51 -0800421 if handler.pOnuMetricsMgr != nil {
422 if err := handler.pOnuMetricsMgr.clearAllPmData(ctx); err != nil {
423 errorsList = append(errorsList, err)
424 }
425 }
Girish Gowdra6afb56a2021-04-27 17:47:57 -0700426 select {
427 case handler.pSelfTestHdlr.stopSelfTestModule <- true:
428 logger.Debugw(ctx, "sent stop signal to self test handler module", log.Fields{"device-id": device.Id})
429 default:
430 logger.Warnw(ctx, "self test handler module not waiting on stop signal", log.Fields{"device-id": device.Id})
431 }
Holger Hildebrandtf07b44a2020-11-10 13:07:54 +0000432 //don't leave any garbage - even in error case
433 oo.deleteDeviceHandlerToMap(handler)
Girish Gowdra0e533642021-03-02 22:02:51 -0800434 if len(errorsList) > 0 {
435 logger.Errorw(ctx, "one-or-more-error-during-device-delete", log.Fields{"device-id": device.Id})
436 return fmt.Errorf("one-or-more-error-during-device-delete, errors:%v", errorsList)
437 }
438 return nil
Holger Hildebrandt9ca8b132020-08-07 14:45:03 +0000439 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000440 logger.Warnw(ctx, "no handler found for device-deletion", log.Fields{"device-id": device.Id})
mpagenko2418ab02020-11-12 12:58:06 +0000441 return fmt.Errorf(fmt.Sprintf("handler-not-found-%s", device.Id))
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000442}
443
444//Get_device_details unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000445func (oo *OpenONUAC) Get_device_details(ctx context.Context, device *voltha.Device) error {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000446 return errors.New("unImplemented")
447}
448
449//Update_flows_bulk returns
dbainbri4d3a0dc2020-12-02 00:33:42 +0000450func (oo *OpenONUAC) Update_flows_bulk(ctx context.Context, device *voltha.Device, flows *voltha.Flows, groups *voltha.FlowGroups, flowMetadata *voltha.FlowMetadata) error {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000451 return errors.New("unImplemented")
452}
453
454//Update_flows_incrementally updates (add/remove) the flows on a given device
dbainbri4d3a0dc2020-12-02 00:33:42 +0000455func (oo *OpenONUAC) Update_flows_incrementally(ctx context.Context, device *voltha.Device,
mpagenkodff5dda2020-08-28 11:52:01 +0000456 flows *openflow_13.FlowChanges, groups *openflow_13.FlowGroupChanges, flowMetadata *voltha.FlowMetadata) error {
mpagenkofc4f56e2020-11-04 17:17:49 +0000457
dbainbri4d3a0dc2020-12-02 00:33:42 +0000458 logger.Infow(ctx, "update-flows-incrementally", log.Fields{"device-id": device.Id})
mpagenkofc4f56e2020-11-04 17:17:49 +0000459 //flow config is relayed to handler even if the device might be in some 'inactive' state
460 // let the handler or related FSM's decide, what to do with the modified flow state info
461 // at least the flow-remove must be done in respect to internal data, while OMCI activity might not be needed here
mpagenkodff5dda2020-08-28 11:52:01 +0000462
463 // For now, there is no support for group changes (as in the actual Py-adapter code)
mpagenkofc4f56e2020-11-04 17:17:49 +0000464 // but processing is continued for flowUpdate possibly also set in the request
mpagenkodff5dda2020-08-28 11:52:01 +0000465 if groups.ToAdd != nil && groups.ToAdd.Items != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000466 logger.Warnw(ctx, "Update-flow-incr: group add not supported (ignored)", log.Fields{"device-id": device.Id})
mpagenkodff5dda2020-08-28 11:52:01 +0000467 }
468 if groups.ToRemove != nil && groups.ToRemove.Items != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000469 logger.Warnw(ctx, "Update-flow-incr: group remove not supported (ignored)", log.Fields{"device-id": device.Id})
mpagenkodff5dda2020-08-28 11:52:01 +0000470 }
471 if groups.ToUpdate != nil && groups.ToUpdate.Items != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000472 logger.Warnw(ctx, "Update-flow-incr: group update not supported (ignored)", log.Fields{"device-id": device.Id})
mpagenkodff5dda2020-08-28 11:52:01 +0000473 }
474
dbainbri4d3a0dc2020-12-02 00:33:42 +0000475 if handler := oo.getDeviceHandler(ctx, device.Id, false); handler != nil {
476 err := handler.FlowUpdateIncremental(ctx, flows, groups, flowMetadata)
mpagenkodff5dda2020-08-28 11:52:01 +0000477 return err
478 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000479 logger.Warnw(ctx, "no handler found for incremental flow update", log.Fields{"device-id": device.Id})
mpagenkodff5dda2020-08-28 11:52:01 +0000480 return fmt.Errorf(fmt.Sprintf("handler-not-found-%s", device.Id))
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000481}
482
483//Update_pm_config returns PmConfigs nil or error
dbainbri4d3a0dc2020-12-02 00:33:42 +0000484func (oo *OpenONUAC) Update_pm_config(ctx context.Context, device *voltha.Device, pmConfigs *voltha.PmConfigs) error {
Girish Gowdrae09a6202021-01-12 18:10:59 -0800485 logger.Infow(ctx, "update-pm-config", log.Fields{"device-id": device.Id})
486 if handler := oo.getDeviceHandler(ctx, device.Id, false); handler != nil {
Girish Gowdra5a7c4922021-01-22 18:33:41 -0800487 return handler.updatePmConfig(ctx, pmConfigs)
Girish Gowdrae09a6202021-01-12 18:10:59 -0800488 }
Girish Gowdra5a7c4922021-01-22 18:33:41 -0800489 logger.Warnw(ctx, "no handler found for update-pm-config", log.Fields{"device-id": device.Id})
490 return fmt.Errorf(fmt.Sprintf("handler-not-found-%s", device.Id))
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000491}
492
493//Receive_packet_out sends packet out to the device
dbainbri4d3a0dc2020-12-02 00:33:42 +0000494func (oo *OpenONUAC) Receive_packet_out(ctx context.Context, deviceID string, egressPortNo int, packet *openflow_13.OfpPacketOut) error {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000495 return errors.New("unImplemented")
496}
497
498//Suppress_event unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000499func (oo *OpenONUAC) Suppress_event(ctx context.Context, filter *voltha.EventFilter) error {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000500 return errors.New("unImplemented")
501}
502
503//Unsuppress_event unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000504func (oo *OpenONUAC) Unsuppress_event(ctx context.Context, filter *voltha.EventFilter) error {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000505 return errors.New("unImplemented")
506}
507
Andrea Campanella71e546a2021-02-26 11:09:33 +0100508//Download_image requests downloading some image according to indications as given in request
509//The ImageDownload needs to be called `request`due to library reflection requirements
510func (oo *OpenONUAC) Download_image(ctx context.Context, device *voltha.Device, request *voltha.ImageDownload) (*voltha.ImageDownload, error) {
mpagenko15ff4a52021-03-02 10:09:20 +0000511 if request != nil && (*request).Name != "" {
512 if !oo.pDownloadManager.imageExists(ctx, request) {
513 logger.Debugw(ctx, "start image download", log.Fields{"image-description": request})
514 // Download_image is not supposed to be blocking, anyway let's call the DownloadManager still synchronously to detect 'fast' problems
515 // the download itself is later done in background
516 err := oo.pDownloadManager.startDownload(ctx, request)
517 return request, err
518 }
519 // image already exists
520 logger.Debugw(ctx, "image already downloaded", log.Fields{"image-description": request})
521 return request, nil
mpagenkoc8bba412021-01-15 15:38:44 +0000522 }
mpagenko15ff4a52021-03-02 10:09:20 +0000523 return request, errors.New("invalid image definition")
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000524}
525
526//Get_image_download_status unimplemented
Andrea Campanella71e546a2021-02-26 11:09:33 +0100527//The ImageDownload needs to be called `request`due to library reflection requirements
dbainbri4d3a0dc2020-12-02 00:33:42 +0000528func (oo *OpenONUAC) Get_image_download_status(ctx context.Context, device *voltha.Device, request *voltha.ImageDownload) (*voltha.ImageDownload, error) {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000529 return nil, errors.New("unImplemented")
530}
531
532//Cancel_image_download unimplemented
Andrea Campanella71e546a2021-02-26 11:09:33 +0100533//The ImageDownload needs to be called `request`due to library reflection requirements
dbainbri4d3a0dc2020-12-02 00:33:42 +0000534func (oo *OpenONUAC) Cancel_image_download(ctx context.Context, device *voltha.Device, request *voltha.ImageDownload) (*voltha.ImageDownload, error) {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000535 return nil, errors.New("unImplemented")
536}
537
mpagenko38662d02021-08-11 09:45:19 +0000538//Activate_image_update requests downloading some Onu Software image to the ONU via OMCI
Andrea Campanella71e546a2021-02-26 11:09:33 +0100539// according to indications as given in request and on success activate the image on the ONU
540//The ImageDownload needs to be called `request`due to library reflection requirements
541func (oo *OpenONUAC) Activate_image_update(ctx context.Context, device *voltha.Device, request *voltha.ImageDownload) (*voltha.ImageDownload, error) {
mpagenko15ff4a52021-03-02 10:09:20 +0000542 if request != nil && (*request).Name != "" {
543 if oo.pDownloadManager.imageLocallyDownloaded(ctx, request) {
544 if handler := oo.getDeviceHandler(ctx, device.Id, false); handler != nil {
545 logger.Debugw(ctx, "image download on omci requested", log.Fields{
546 "image-description": request, "device-id": device.Id})
547 err := handler.doOnuSwUpgrade(ctx, request, oo.pDownloadManager)
548 return request, err
549 }
550 logger.Warnw(ctx, "no handler found for image activation", log.Fields{"device-id": device.Id})
551 return request, fmt.Errorf(fmt.Sprintf("handler-not-found - device-id: %s", device.Id))
mpagenko057889c2021-01-21 16:51:58 +0000552 }
mpagenko15ff4a52021-03-02 10:09:20 +0000553 logger.Debugw(ctx, "image not yet downloaded on activate request", log.Fields{"image-description": request})
554 return request, fmt.Errorf(fmt.Sprintf("image-not-yet-downloaded - device-id: %s", device.Id))
mpagenkoc8bba412021-01-15 15:38:44 +0000555 }
mpagenko15ff4a52021-03-02 10:09:20 +0000556 return request, errors.New("invalid image definition")
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000557}
558
559//Revert_image_update unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000560func (oo *OpenONUAC) Revert_image_update(ctx context.Context, device *voltha.Device, request *voltha.ImageDownload) (*voltha.ImageDownload, error) {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000561 return nil, errors.New("unImplemented")
562}
563
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000564// Enable_port to Enable PON/NNI interface - seems not to be used/required according to python code
dbainbri4d3a0dc2020-12-02 00:33:42 +0000565func (oo *OpenONUAC) Enable_port(ctx context.Context, deviceID string, port *voltha.Port) error {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000566 return errors.New("unImplemented")
567}
568
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000569// Disable_port to Disable pon/nni interface - seems not to be used/required according to python code
dbainbri4d3a0dc2020-12-02 00:33:42 +0000570func (oo *OpenONUAC) Disable_port(ctx context.Context, deviceID string, port *voltha.Port) error {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000571 return errors.New("unImplemented")
572}
573
Himani Chawla6d2ae152020-09-02 13:11:20 +0530574//Child_device_lost - unimplemented
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000575//needed for if update >= 3.1.x
Matteo Scandolo3f2bdc82021-03-18 18:18:22 -0700576func (oo *OpenONUAC) Child_device_lost(ctx context.Context, device *voltha.Device) error {
Matteo Scandolo2e6f1e32020-04-15 11:28:45 -0700577 return errors.New("unImplemented")
578}
579
Himani Chawla6d2ae152020-09-02 13:11:20 +0530580// Start_omci_test unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000581func (oo *OpenONUAC) Start_omci_test(ctx context.Context, device *voltha.Device, request *voltha.OmciTestRequest) (*voltha.TestResponse, error) {
Matteo Scandolo2e6f1e32020-04-15 11:28:45 -0700582 return nil, errors.New("unImplemented")
583}
584
Himani Chawla6d2ae152020-09-02 13:11:20 +0530585// Get_ext_value - unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000586func (oo *OpenONUAC) Get_ext_value(ctx context.Context, deviceID string, device *voltha.Device, valueparam voltha.ValueType_Type) (*voltha.ReturnValues, error) {
Matteo Scandolod132c0e2020-04-24 17:06:25 -0700587 return nil, errors.New("unImplemented")
588}
589
kesavandfdf77632021-01-26 23:40:33 -0500590//Single_get_value_request handles the core request to retrieve uni status
mpagenkoc8bba412021-01-15 15:38:44 +0000591func (oo *OpenONUAC) Single_get_value_request(ctx context.Context, request extension.SingleGetValueRequest) (*extension.SingleGetValueResponse, error) {
kesavandfdf77632021-01-26 23:40:33 -0500592 logger.Infow(ctx, "Single_get_value_request", log.Fields{"request": request})
593
594 if handler := oo.getDeviceHandler(ctx, request.TargetId, false); handler != nil {
595 switch reqType := request.GetRequest().GetRequest().(type) {
596 case *extension.GetValueRequest_UniInfo:
597 return handler.getUniPortStatus(ctx, reqType.UniInfo), nil
Girish Gowdra6afb56a2021-04-27 17:47:57 -0700598 case *extension.GetValueRequest_OnuOpticalInfo:
599 commChan := make(chan Message)
600 respChan := make(chan extension.SingleGetValueResponse)
601 // Initiate the self test request
602 if err := handler.pSelfTestHdlr.SelfTestRequestStart(ctx, request, commChan, respChan); err != nil {
603 return &extension.SingleGetValueResponse{
604 Response: &extension.GetValueResponse{
605 Status: extension.GetValueResponse_ERROR,
606 ErrReason: extension.GetValueResponse_INTERNAL_ERROR,
607 },
608 }, err
609 }
610 // The timeout handling is already implemented in omci_self_test_handler module
611 resp := <-respChan
612 return &resp, nil
Himani Chawla43f95ff2021-06-03 00:24:12 +0530613 case *extension.GetValueRequest_OnuInfo:
614 return handler.getOnuOMCICounters(ctx, reqType.OnuInfo), nil
kesavandfdf77632021-01-26 23:40:33 -0500615 default:
616 return postUniStatusErrResponse(extension.GetValueResponse_UNSUPPORTED), nil
617
618 }
619 }
620 logger.Errorw(ctx, "Single_get_value_request failed ", log.Fields{"request": request})
621 return postUniStatusErrResponse(extension.GetValueResponse_INVALID_DEVICE_ID), nil
mpagenkoc8bba412021-01-15 15:38:44 +0000622}
623
mpagenko83144272021-04-27 10:06:22 +0000624//if update >= 4.3.0
mpagenkoc26d4c02021-05-06 14:27:57 +0000625// Note: already with the implementation of the 'old' download interface problems were detected when the argument name used here is not the same
626// as defined in the adapter interface file. That sounds strange and the effects were strange as well.
627// The reason for that was never finally investigated.
628// To be on the safe side argument names are left here always as defined in iAdapter.go .
mpagenko83144272021-04-27 10:06:22 +0000629
630// Download_onu_image downloads (and optionally activates and commits) the indicated ONU image to the requested ONU(s)
631// if the image is not yet present on the adapter it has to be automatically downloaded
632func (oo *OpenONUAC) Download_onu_image(ctx context.Context, request *voltha.DeviceImageDownloadRequest) (*voltha.DeviceImageResponse, error) {
mpagenkoc26d4c02021-05-06 14:27:57 +0000633 if request != nil && len((*request).DeviceId) > 0 && (*request).Image.Version != "" {
634 loResponse := voltha.DeviceImageResponse{}
635 imageIdentifier := (*request).Image.Version
mpagenko38662d02021-08-11 09:45:19 +0000636 downloadedToAdapter := false
mpagenkoc26d4c02021-05-06 14:27:57 +0000637 firstDevice := true
638 var vendorID string
639 for _, pCommonID := range (*request).DeviceId {
mpagenko38662d02021-08-11 09:45:19 +0000640 vendorIDMatch := true
mpagenkoc26d4c02021-05-06 14:27:57 +0000641 loDeviceID := (*pCommonID).Id
mpagenko2f2f2362021-06-07 08:25:22 +0000642 loDeviceImageState := voltha.DeviceImageState{}
643 loDeviceImageState.DeviceId = loDeviceID
644 loImageState := voltha.ImageState{}
645 loDeviceImageState.ImageState = &loImageState
646 loDeviceImageState.ImageState.Version = (*request).Image.Version
mpagenko38662d02021-08-11 09:45:19 +0000647
648 onuVolthaDevice, err := oo.coreProxy.GetDevice(log.WithSpanFromContext(context.TODO(), ctx),
649 loDeviceID, loDeviceID)
650 if err != nil || onuVolthaDevice == nil {
651 logger.Warnw(ctx, "Failed to fetch Onu device for image download",
652 log.Fields{"device-id": loDeviceID, "err": err})
653 loDeviceImageState.ImageState.DownloadState = voltha.ImageState_DOWNLOAD_FAILED
654 loDeviceImageState.ImageState.Reason = voltha.ImageState_UNKNOWN_ERROR //proto restriction, better option: 'INVALID_DEVICE'
mpagenkoc26d4c02021-05-06 14:27:57 +0000655 loDeviceImageState.ImageState.ImageState = voltha.ImageState_IMAGE_UNKNOWN
mpagenkoc26d4c02021-05-06 14:27:57 +0000656 } else {
mpagenko38662d02021-08-11 09:45:19 +0000657 if firstDevice {
658 //start/verify download of the image to the adapter based on first found device only
659 // use the OnuVendor identification from first given device
660 firstDevice = false
661 vendorID = onuVolthaDevice.VendorId
662 imageIdentifier = vendorID + imageIdentifier //head on vendor ID of the ONU
663 logger.Debugw(ctx, "download request for file", log.Fields{"image-id": imageIdentifier})
664
665 if !oo.pFileManager.ImageExists(ctx, imageIdentifier) {
666 logger.Debugw(ctx, "start image download", log.Fields{"image-description": request})
667 // Download_image is not supposed to be blocking, anyway let's call the DownloadManager still synchronously to detect 'fast' problems
668 // the download itself is later done in background
669 if err := oo.pFileManager.StartDownload(ctx, imageIdentifier, (*request).Image.Url); err == nil {
670 downloadedToAdapter = true
671 }
672 //else: treat any error here as 'INVALID_URL' (even though it might as well be some issue on local FS, eg. 'INSUFFICIENT_SPACE')
673 // otherwise a more sophisticated error evaluation is needed
674 } else {
675 // image already exists
676 downloadedToAdapter = true
677 logger.Debugw(ctx, "image already downloaded", log.Fields{"image-description": imageIdentifier})
678 // note: If the image (with vendorId+name) has already been downloaded before from some other
679 // valid URL, the current URL is just ignored. If the operators want to ensure that the new URL
680 // is really used, then they first have to use the 'abort' API to remove the existing image!
681 // (abort API can be used also after some successful download to just remove the image from adapter)
682 }
683 } else {
684 //for all following devices verify the matching vendorID
685 if onuVolthaDevice.VendorId != vendorID {
686 logger.Warnw(ctx, "onu vendor id does not match image vendor id, device ignored",
687 log.Fields{"onu-vendor-id": onuVolthaDevice.VendorId, "image-vendor-id": vendorID})
688 vendorIDMatch = false
689 }
690 }
691 if downloadedToAdapter && vendorIDMatch {
692 // start the ONU download activity for each possible device
693 // assumption here is, that the concerned device was already created (automatic start after device creation not supported)
694 if handler := oo.getDeviceHandler(ctx, loDeviceID, false); handler != nil {
695 logger.Debugw(ctx, "image download on omci requested", log.Fields{
696 "image-id": imageIdentifier, "device-id": loDeviceID})
697 //onu upgrade handling called in background without immediate error evaluation here
698 // as the processing can be done for multiple ONU's and an error on one ONU should not stop processing for others
699 // state/progress/success of the request has to be verified using the Get_onu_image_status() API
700 go handler.onuSwUpgradeAfterDownload(ctx, request, oo.pFileManager, imageIdentifier)
701 loDeviceImageState.ImageState.DownloadState = voltha.ImageState_DOWNLOAD_STARTED
702 loDeviceImageState.ImageState.Reason = voltha.ImageState_NO_ERROR
703 loDeviceImageState.ImageState.ImageState = voltha.ImageState_IMAGE_UNKNOWN
704 } else {
705 //cannot start ONU download for requested device
706 logger.Warnw(ctx, "no handler found for image activation", log.Fields{"device-id": loDeviceID})
707 loDeviceImageState.ImageState.DownloadState = voltha.ImageState_DOWNLOAD_FAILED
708 loDeviceImageState.ImageState.Reason = voltha.ImageState_UNKNOWN_ERROR //proto restriction, better option: 'INVALID_DEVICE'
709 loDeviceImageState.ImageState.ImageState = voltha.ImageState_IMAGE_UNKNOWN
710 }
711 } else {
712 loDeviceImageState.ImageState.DownloadState = voltha.ImageState_DOWNLOAD_FAILED
713 if !downloadedToAdapter {
714 loDeviceImageState.ImageState.Reason = voltha.ImageState_INVALID_URL
715 } else { //only logical option is !vendorIDMatch
716 loDeviceImageState.ImageState.Reason = voltha.ImageState_VENDOR_DEVICE_MISMATCH
717 }
718 loDeviceImageState.ImageState.ImageState = voltha.ImageState_IMAGE_UNKNOWN
719 }
mpagenkoc26d4c02021-05-06 14:27:57 +0000720 }
mpagenko2f2f2362021-06-07 08:25:22 +0000721 loResponse.DeviceImageStates = append(loResponse.DeviceImageStates, &loDeviceImageState)
mpagenkoc26d4c02021-05-06 14:27:57 +0000722 }
723 pImageResp := &loResponse
724 return pImageResp, nil
725 }
726 return nil, errors.New("invalid image download parameters")
mpagenko83144272021-04-27 10:06:22 +0000727}
728
729// Get_onu_image_status delivers the adapter-related information about the download/activation/commitment
730// status for the requested image
731func (oo *OpenONUAC) Get_onu_image_status(ctx context.Context, in *voltha.DeviceImageRequest) (*voltha.DeviceImageResponse, error) {
mpagenkoaa3afe92021-05-21 16:20:58 +0000732 if in != nil && len((*in).DeviceId) > 0 && (*in).Version != "" {
733 loResponse := voltha.DeviceImageResponse{}
mpagenkoaa3afe92021-05-21 16:20:58 +0000734 imageIdentifier := (*in).Version
mpagenko38662d02021-08-11 09:45:19 +0000735 var vendorIDSet bool
mpagenkoaa3afe92021-05-21 16:20:58 +0000736 firstDevice := true
737 var vendorID string
738 for _, pCommonID := range (*in).DeviceId {
739 loDeviceID := (*pCommonID).Id
mpagenko38662d02021-08-11 09:45:19 +0000740 pDeviceImageState := &voltha.DeviceImageState{
741 DeviceId: loDeviceID,
742 }
743 vendorIDSet = false
mpagenkoaa3afe92021-05-21 16:20:58 +0000744 onuVolthaDevice, err := oo.coreProxy.GetDevice(log.WithSpanFromContext(context.TODO(), ctx),
745 loDeviceID, loDeviceID)
746 if err != nil || onuVolthaDevice == nil {
747 logger.Warnw(ctx, "Failed to fetch Onu device to get image status",
748 log.Fields{"device-id": loDeviceID, "err": err})
mpagenko38662d02021-08-11 09:45:19 +0000749 pImageState := &voltha.ImageState{
750 Version: (*in).Version,
751 DownloadState: voltha.ImageState_DOWNLOAD_UNKNOWN, //no statement about last activity possible
752 Reason: voltha.ImageState_UNKNOWN_ERROR, //something like "DEVICE_NOT_EXISTS" would be better (proto def)
753 ImageState: voltha.ImageState_IMAGE_UNKNOWN,
mpagenkoaa3afe92021-05-21 16:20:58 +0000754 }
mpagenko38662d02021-08-11 09:45:19 +0000755 pDeviceImageState.ImageState = pImageState
mpagenkoaa3afe92021-05-21 16:20:58 +0000756 } else {
mpagenko38662d02021-08-11 09:45:19 +0000757 if firstDevice {
758 //start/verify download of the image to the adapter based on first found device only
759 // use the OnuVendor identification from first given device
760 firstDevice = false
761 vendorID = onuVolthaDevice.VendorId
762 imageIdentifier = vendorID + imageIdentifier //head on vendor ID of the ONU
763 vendorIDSet = true
764 logger.Debugw(ctx, "status request for image", log.Fields{"image-id": imageIdentifier})
765 } else {
766 //for all following devices verify the matching vendorID
767 if onuVolthaDevice.VendorId != vendorID {
768 logger.Warnw(ctx, "onu vendor id does not match image vendor id, device ignored",
769 log.Fields{"onu-vendor-id": onuVolthaDevice.VendorId, "image-vendor-id": vendorID})
770 } else {
771 vendorIDSet = true
772 }
773 }
774 if !vendorIDSet {
775 pImageState := &voltha.ImageState{
776 Version: (*in).Version,
777 DownloadState: voltha.ImageState_DOWNLOAD_UNKNOWN, //can't be sure that download for this device was really tried
778 Reason: voltha.ImageState_VENDOR_DEVICE_MISMATCH,
779 ImageState: voltha.ImageState_IMAGE_UNKNOWN,
780 }
781 pDeviceImageState.ImageState = pImageState
782 } else {
783 // get the handler for the device
784 if handler := oo.getDeviceHandler(ctx, loDeviceID, false); handler != nil {
785 logger.Debugw(ctx, "image status request for", log.Fields{
786 "image-id": imageIdentifier, "device-id": loDeviceID})
787 //status request is called synchronously to collect the indications for all concerned devices
788 pDeviceImageState.ImageState = handler.requestOnuSwUpgradeState(ctx, imageIdentifier, (*in).Version)
789 } else {
790 //cannot get the handler
791 logger.Warnw(ctx, "no handler found for image status request ", log.Fields{"device-id": loDeviceID})
792 pImageState := &voltha.ImageState{
793 Version: (*in).Version,
794 DownloadState: voltha.ImageState_DOWNLOAD_UNKNOWN, //no statement about last activity possible
795 Reason: voltha.ImageState_UNKNOWN_ERROR, //something like "DEVICE_NOT_EXISTS" would be better (proto def)
796 ImageState: voltha.ImageState_IMAGE_UNKNOWN,
797 }
798 pDeviceImageState.ImageState = pImageState
799 }
800 }
mpagenkoaa3afe92021-05-21 16:20:58 +0000801 }
802 loResponse.DeviceImageStates = append(loResponse.DeviceImageStates, pDeviceImageState)
803 }
804 pImageResp := &loResponse
805 return pImageResp, nil
806 }
807 return nil, errors.New("invalid image status request parameters")
mpagenko83144272021-04-27 10:06:22 +0000808}
809
810// Abort_onu_image_upgrade stops the actual download/activation/commitment process (on next possibly step)
811func (oo *OpenONUAC) Abort_onu_image_upgrade(ctx context.Context, in *voltha.DeviceImageRequest) (*voltha.DeviceImageResponse, error) {
mpagenkoaa3afe92021-05-21 16:20:58 +0000812 if in != nil && len((*in).DeviceId) > 0 && (*in).Version != "" {
813 loResponse := voltha.DeviceImageResponse{}
814 imageIdentifier := (*in).Version
815 firstDevice := true
816 var vendorID string
817 for _, pCommonID := range (*in).DeviceId {
818 loDeviceID := (*pCommonID).Id
819 onuVolthaDevice, err := oo.coreProxy.GetDevice(log.WithSpanFromContext(context.TODO(), ctx),
820 loDeviceID, loDeviceID)
821 if err != nil || onuVolthaDevice == nil {
822 logger.Warnw(ctx, "Failed to fetch Onu device to abort its download",
823 log.Fields{"device-id": loDeviceID, "err": err})
824 continue //try the work with next deviceId
825 }
826 pDeviceImageState := &voltha.DeviceImageState{}
mpagenko2f2f2362021-06-07 08:25:22 +0000827 loImageState := voltha.ImageState{}
828 pDeviceImageState.ImageState = &loImageState
829
mpagenkoaa3afe92021-05-21 16:20:58 +0000830 if firstDevice {
831 //start/verify download of the image to the adapter based on first found device only
832 // use the OnuVendor identification from first given device
833 firstDevice = false
834 vendorID = onuVolthaDevice.VendorId
835 imageIdentifier = vendorID + imageIdentifier //head on vendor ID of the ONU
836 logger.Debugw(ctx, "abort request for file", log.Fields{"image-id": imageIdentifier})
837 } else {
838 //for all following devices verify the matching vendorID
839 if onuVolthaDevice.VendorId != vendorID {
840 logger.Warnw(ctx, "onu vendor id does not match image vendor id, device ignored",
841 log.Fields{"onu-vendor-id": onuVolthaDevice.VendorId, "image-vendor-id": vendorID})
842 continue //try the work with next deviceId
843 }
844 }
845
846 // cancel the ONU upgrade activity for each possible device
847 if handler := oo.getDeviceHandler(ctx, loDeviceID, false); handler != nil {
848 logger.Debugw(ctx, "image upgrade abort requested", log.Fields{
849 "image-id": imageIdentifier, "device-id": loDeviceID})
850 //upgrade cancel is called synchronously to collect the imageResponse indications for all concerned devices
851 handler.cancelOnuSwUpgrade(ctx, imageIdentifier, (*in).Version, pDeviceImageState)
852 } else {
mpagenko38662d02021-08-11 09:45:19 +0000853 //cannot start aborting ONU download for requested device
mpagenkoaa3afe92021-05-21 16:20:58 +0000854 logger.Warnw(ctx, "no handler found for aborting upgrade ", log.Fields{"device-id": loDeviceID})
855 pDeviceImageState.DeviceId = loDeviceID
856 pDeviceImageState.ImageState.Version = (*in).Version
mpagenkoaa3afe92021-05-21 16:20:58 +0000857 pDeviceImageState.ImageState.DownloadState = voltha.ImageState_DOWNLOAD_CANCELLED
mpagenko38662d02021-08-11 09:45:19 +0000858 pDeviceImageState.ImageState.Reason = voltha.ImageState_CANCELLED_ON_REQUEST //something better would be possible with protos modification
mpagenkoaa3afe92021-05-21 16:20:58 +0000859 pDeviceImageState.ImageState.ImageState = voltha.ImageState_IMAGE_UNKNOWN
860 }
861 loResponse.DeviceImageStates = append(loResponse.DeviceImageStates, pDeviceImageState)
862 }
863 if !firstDevice {
864 //if at least one valid device was found cancel also a possibly running download to adapter and remove the image
865 // this is to be done after the upgradeOnu cancel activities in order to not subduct the file for still running processes
866 oo.pFileManager.CancelDownload(ctx, imageIdentifier)
867 }
868 pImageResp := &loResponse
869 return pImageResp, nil
870 }
871 return nil, errors.New("invalid image upgrade abort parameters")
mpagenko83144272021-04-27 10:06:22 +0000872}
873
874// Get_onu_images retrieves the ONU SW image status information via OMCI
875func (oo *OpenONUAC) Get_onu_images(ctx context.Context, deviceID string) (*voltha.OnuImages, error) {
Holger Hildebrandtfb402a62021-05-26 14:40:49 +0000876 logger.Infow(ctx, "Get_onu_images", log.Fields{"device-id": deviceID})
877 if handler := oo.getDeviceHandler(ctx, deviceID, false); handler != nil {
Himani Chawla69992ab2021-07-08 15:13:02 +0530878 images, err := handler.getOnuImages(ctx)
879 if err == nil {
Holger Hildebrandtfb402a62021-05-26 14:40:49 +0000880 return images, nil
881 }
882 return nil, fmt.Errorf(fmt.Sprintf("%s-%s", err, deviceID))
883 }
884 logger.Warnw(ctx, "no handler found for Get_onu_images", log.Fields{"device-id": deviceID})
885 return nil, fmt.Errorf(fmt.Sprintf("handler-not-found-%s", deviceID))
mpagenko83144272021-04-27 10:06:22 +0000886}
887
888// Activate_onu_image initiates the activation of the image for the requested ONU(s)
mpagenkoc26d4c02021-05-06 14:27:57 +0000889// precondition: image downloaded and not yet activated or image refers to current inactive image
mpagenko83144272021-04-27 10:06:22 +0000890func (oo *OpenONUAC) Activate_onu_image(ctx context.Context, in *voltha.DeviceImageRequest) (*voltha.DeviceImageResponse, error) {
mpagenkoc26d4c02021-05-06 14:27:57 +0000891 if in != nil && len((*in).DeviceId) > 0 && (*in).Version != "" {
892 loResponse := voltha.DeviceImageResponse{}
893 imageIdentifier := (*in).Version
894 //let the deviceHandler find the adequate way of requesting the image activation
895 for _, pCommonID := range (*in).DeviceId {
896 loDeviceID := (*pCommonID).Id
mpagenko2f2f2362021-06-07 08:25:22 +0000897 loDeviceImageState := voltha.DeviceImageState{}
898 loDeviceImageState.DeviceId = loDeviceID
899 loImageState := voltha.ImageState{}
900 loDeviceImageState.ImageState = &loImageState
901 loDeviceImageState.ImageState.Version = imageIdentifier
mpagenkoc26d4c02021-05-06 14:27:57 +0000902 //compared to download procedure the vendorID (from device) is secondary here
903 // and only needed in case the upgrade process is based on some ongoing download process (and can be retrieved in deviceHandler if needed)
904 // start image activation activity for each possible device
905 // assumption here is, that the concerned device was already created (automatic start after device creation not supported)
906 if handler := oo.getDeviceHandler(ctx, loDeviceID, false); handler != nil {
907 logger.Debugw(ctx, "onu image activation requested", log.Fields{
908 "image-id": imageIdentifier, "device-id": loDeviceID})
909 //onu activation handling called in background without immediate error evaluation here
910 // as the processing can be done for multiple ONU's and an error on one ONU should not stop processing for others
911 // state/progress/success of the request has to be verified using the Get_onu_image_status() API
mpagenko183647c2021-06-08 15:25:04 +0000912 if pImageStates, err := handler.onuSwActivateRequest(ctx, imageIdentifier, (*in).CommitOnSuccess); err != nil {
913 loDeviceImageState.ImageState.DownloadState = voltha.ImageState_DOWNLOAD_UNKNOWN
914 loDeviceImageState.ImageState.Reason = voltha.ImageState_UNKNOWN_ERROR
915 loDeviceImageState.ImageState.ImageState = voltha.ImageState_IMAGE_ACTIVATION_ABORTED
916 } else {
917 loDeviceImageState.ImageState.DownloadState = pImageStates.DownloadState
918 loDeviceImageState.ImageState.Reason = pImageStates.Reason
919 loDeviceImageState.ImageState.ImageState = pImageStates.ImageState
920 }
mpagenkoc26d4c02021-05-06 14:27:57 +0000921 } else {
922 //cannot start SW activation for requested device
923 logger.Warnw(ctx, "no handler found for image activation", log.Fields{"device-id": loDeviceID})
mpagenko183647c2021-06-08 15:25:04 +0000924 loDeviceImageState.ImageState.DownloadState = voltha.ImageState_DOWNLOAD_UNKNOWN
mpagenkoc26d4c02021-05-06 14:27:57 +0000925 loDeviceImageState.ImageState.Reason = voltha.ImageState_UNKNOWN_ERROR
926 loDeviceImageState.ImageState.ImageState = voltha.ImageState_IMAGE_ACTIVATION_ABORTED
mpagenkoc26d4c02021-05-06 14:27:57 +0000927 }
mpagenko2f2f2362021-06-07 08:25:22 +0000928 loResponse.DeviceImageStates = append(loResponse.DeviceImageStates, &loDeviceImageState)
mpagenkoc26d4c02021-05-06 14:27:57 +0000929 }
930 pImageResp := &loResponse
931 return pImageResp, nil
932 }
933 return nil, errors.New("invalid image activation parameters")
mpagenko83144272021-04-27 10:06:22 +0000934}
935
936// Commit_onu_image enforces the commitment of the image for the requested ONU(s)
937// precondition: image activated and not yet committed
938func (oo *OpenONUAC) Commit_onu_image(ctx context.Context, in *voltha.DeviceImageRequest) (*voltha.DeviceImageResponse, error) {
mpagenkoc26d4c02021-05-06 14:27:57 +0000939 if in != nil && len((*in).DeviceId) > 0 && (*in).Version != "" {
940 loResponse := voltha.DeviceImageResponse{}
941 imageIdentifier := (*in).Version
942 //let the deviceHandler find the adequate way of requesting the image activation
943 for _, pCommonID := range (*in).DeviceId {
944 loDeviceID := (*pCommonID).Id
mpagenko2f2f2362021-06-07 08:25:22 +0000945 loDeviceImageState := voltha.DeviceImageState{}
946 loDeviceImageState.DeviceId = loDeviceID
947 loImageState := voltha.ImageState{}
948 loDeviceImageState.ImageState = &loImageState
949 loDeviceImageState.ImageState.Version = imageIdentifier
mpagenkoc26d4c02021-05-06 14:27:57 +0000950 //compared to download procedure the vendorID (from device) is secondary here
951 // and only needed in case the upgrade process is based on some ongoing download process (and can be retrieved in deviceHandler if needed)
952 // start image activation activity for each possible device
953 // assumption here is, that the concerned device was already created (automatic start after device creation not supported)
954 if handler := oo.getDeviceHandler(ctx, loDeviceID, false); handler != nil {
955 logger.Debugw(ctx, "onu image commitment requested", log.Fields{
956 "image-id": imageIdentifier, "device-id": loDeviceID})
957 //onu commitment handling called in background without immediate error evaluation here
958 // as the processing can be done for multiple ONU's and an error on one ONU should not stop processing for others
959 // state/progress/success of the request has to be verified using the Get_onu_image_status() API
mpagenko183647c2021-06-08 15:25:04 +0000960 if pImageStates, err := handler.onuSwCommitRequest(ctx, imageIdentifier); err != nil {
mpagenko38662d02021-08-11 09:45:19 +0000961 loDeviceImageState.ImageState.DownloadState = voltha.ImageState_DOWNLOAD_FAILED
962 loDeviceImageState.ImageState.Reason = voltha.ImageState_UNKNOWN_ERROR //can be multiple reasons here
mpagenko183647c2021-06-08 15:25:04 +0000963 loDeviceImageState.ImageState.ImageState = voltha.ImageState_IMAGE_COMMIT_ABORTED
964 } else {
965 loDeviceImageState.ImageState.DownloadState = pImageStates.DownloadState
966 loDeviceImageState.ImageState.Reason = pImageStates.Reason
967 loDeviceImageState.ImageState.ImageState = pImageStates.ImageState
968 }
mpagenkoc26d4c02021-05-06 14:27:57 +0000969 } else {
970 //cannot start SW commitment for requested device
971 logger.Warnw(ctx, "no handler found for image commitment", log.Fields{"device-id": loDeviceID})
mpagenko183647c2021-06-08 15:25:04 +0000972 loDeviceImageState.ImageState.DownloadState = voltha.ImageState_DOWNLOAD_UNKNOWN
mpagenkoc26d4c02021-05-06 14:27:57 +0000973 loDeviceImageState.ImageState.Reason = voltha.ImageState_UNKNOWN_ERROR
974 loDeviceImageState.ImageState.ImageState = voltha.ImageState_IMAGE_COMMIT_ABORTED
mpagenkoc26d4c02021-05-06 14:27:57 +0000975 }
mpagenko2f2f2362021-06-07 08:25:22 +0000976 loResponse.DeviceImageStates = append(loResponse.DeviceImageStates, &loDeviceImageState)
mpagenkoc26d4c02021-05-06 14:27:57 +0000977 }
978 pImageResp := &loResponse
979 return pImageResp, nil
980 }
981 return nil, errors.New("invalid image commitment parameters")
mpagenko83144272021-04-27 10:06:22 +0000982}
983
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000984// Adapter interface required methods ################ end #########
985// #################################################################