blob: 805944c1a97200b5e0d675f0ef6d3b986103878b [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
dbainbri4d3a0dc2020-12-02 00:33:42 +000027 conf "github.com/opencord/voltha-lib-go/v4/pkg/config"
28
Holger Hildebrandt6c1fb0a2020-11-25 15:41:01 +000029 "github.com/golang/protobuf/ptypes"
dbainbri4d3a0dc2020-12-02 00:33:42 +000030 "github.com/opencord/voltha-lib-go/v4/pkg/adapters/adapterif"
31 "github.com/opencord/voltha-lib-go/v4/pkg/db/kvstore"
Himani Chawlac07fda02020-12-09 16:21:21 +053032 "github.com/opencord/voltha-lib-go/v4/pkg/events/eventif"
dbainbri4d3a0dc2020-12-02 00:33:42 +000033 "github.com/opencord/voltha-lib-go/v4/pkg/kafka"
34 "github.com/opencord/voltha-lib-go/v4/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
308//Adapter_descriptor not implemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000309func (oo *OpenONUAC) Adapter_descriptor(ctx context.Context) error {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000310 return errors.New("unImplemented")
311}
312
313//Device_types unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000314func (oo *OpenONUAC) Device_types(ctx context.Context) (*voltha.DeviceTypes, error) {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000315 return nil, errors.New("unImplemented")
316}
317
318//Health returns unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000319func (oo *OpenONUAC) Health(ctx context.Context) (*voltha.HealthStatus, error) {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000320 return nil, errors.New("unImplemented")
321}
322
Holger Hildebrandt9ca8b132020-08-07 14:45:03 +0000323//Reconcile_device is called once when the adapter needs to re-create device - usually on core restart
dbainbri4d3a0dc2020-12-02 00:33:42 +0000324func (oo *OpenONUAC) Reconcile_device(ctx context.Context, device *voltha.Device) error {
Holger Hildebrandtf41a1602020-08-19 09:52:50 +0000325 if device == nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000326 logger.Warn(ctx, "reconcile-device-voltha-device-is-nil")
Holger Hildebrandtf41a1602020-08-19 09:52:50 +0000327 return errors.New("nil-device")
328 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000329 logger.Infow(ctx, "reconcile-device", log.Fields{"device-id": device.Id})
Himani Chawla6d2ae152020-09-02 13:11:20 +0530330 var handler *deviceHandler
dbainbri4d3a0dc2020-12-02 00:33:42 +0000331 if handler = oo.getDeviceHandler(ctx, device.Id, false); handler == nil {
332 handler := newDeviceHandler(ctx, oo.coreProxy, oo.adapterProxy, oo.eventProxy, device, oo)
Holger Hildebrandtf41a1602020-08-19 09:52:50 +0000333 oo.addDeviceHandlerToMap(ctx, handler)
334 handler.device = device
Maninderb5187552021-03-23 22:23:42 +0530335 if err := handler.coreProxy.DeviceStateUpdate(ctx, device.Id, device.ConnectStatus, voltha.OperStatus_RECONCILING); err != nil {
336 return fmt.Errorf("not able to update device state to reconciling. Err : %s", err.Error())
337 }
Holger Hildebrandtbe523842021-03-10 10:47:18 +0000338 handler.startReconciling(ctx, false)
Himani Chawla6d2ae152020-09-02 13:11:20 +0530339 go handler.adoptOrReconcileDevice(ctx, handler.device)
Holger Hildebrandtf41a1602020-08-19 09:52:50 +0000340 // reconcilement will be continued after onu-device entry is added
Holger Hildebrandt9ca8b132020-08-07 14:45:03 +0000341 } else {
Holger Hildebrandtf41a1602020-08-19 09:52:50 +0000342 return fmt.Errorf(fmt.Sprintf("device-already-reconciled-or-active-%s", device.Id))
Holger Hildebrandt9ca8b132020-08-07 14:45:03 +0000343 }
344 return nil
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000345}
346
347//Abandon_device unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000348func (oo *OpenONUAC) Abandon_device(ctx context.Context, device *voltha.Device) error {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000349 return errors.New("unImplemented")
350}
351
352//Disable_device disables the given device
dbainbri4d3a0dc2020-12-02 00:33:42 +0000353func (oo *OpenONUAC) Disable_device(ctx context.Context, device *voltha.Device) error {
354 logger.Infow(ctx, "disable-device", log.Fields{"device-id": device.Id})
355 if handler := oo.getDeviceHandler(ctx, device.Id, false); handler != nil {
356 go handler.disableDevice(ctx, device)
ozgecanetsiafce57b12020-05-25 14:39:35 +0300357 return nil
358 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000359 logger.Warnw(ctx, "no handler found for device-disable", log.Fields{"device-id": device.Id})
ozgecanetsiafce57b12020-05-25 14:39:35 +0300360 return fmt.Errorf(fmt.Sprintf("handler-not-found-%s", device.Id))
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000361}
362
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000363//Reenable_device enables the onu device after disable
dbainbri4d3a0dc2020-12-02 00:33:42 +0000364func (oo *OpenONUAC) Reenable_device(ctx context.Context, device *voltha.Device) error {
365 logger.Infow(ctx, "reenable-device", log.Fields{"device-id": device.Id})
366 if handler := oo.getDeviceHandler(ctx, device.Id, false); handler != nil {
367 go handler.reEnableDevice(ctx, device)
ozgecanetsiafce57b12020-05-25 14:39:35 +0300368 return nil
369 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000370 logger.Warnw(ctx, "no handler found for device-reenable", log.Fields{"device-id": device.Id})
ozgecanetsiafce57b12020-05-25 14:39:35 +0300371 return fmt.Errorf(fmt.Sprintf("handler-not-found-%s", device.Id))
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000372}
373
374//Reboot_device reboots the given device
dbainbri4d3a0dc2020-12-02 00:33:42 +0000375func (oo *OpenONUAC) Reboot_device(ctx context.Context, device *voltha.Device) error {
376 logger.Infow(ctx, "reboot-device", log.Fields{"device-id": device.Id})
377 if handler := oo.getDeviceHandler(ctx, device.Id, false); handler != nil {
mpagenko15ff4a52021-03-02 10:09:20 +0000378 go handler.rebootDevice(ctx, true, device) //reboot request with device checking
ozgecanetsiae11479f2020-07-06 09:44:47 +0300379 return nil
380 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000381 logger.Warnw(ctx, "no handler found for device-reboot", log.Fields{"device-id": device.Id})
ozgecanetsiae11479f2020-07-06 09:44:47 +0300382 return fmt.Errorf(fmt.Sprintf("handler-not-found-#{device.Id}"))
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000383}
384
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000385//Self_test_device unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000386func (oo *OpenONUAC) Self_test_device(ctx context.Context, device *voltha.Device) error {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000387 return errors.New("unImplemented")
388}
389
Himani Chawla6d2ae152020-09-02 13:11:20 +0530390// Delete_device deletes the given device
dbainbri4d3a0dc2020-12-02 00:33:42 +0000391func (oo *OpenONUAC) Delete_device(ctx context.Context, device *voltha.Device) error {
392 logger.Infow(ctx, "delete-device", log.Fields{"device-id": device.Id, "SerialNumber": device.SerialNumber})
393 if handler := oo.getDeviceHandler(ctx, device.Id, false); handler != nil {
Girish Gowdra0e533642021-03-02 22:02:51 -0800394 var errorsList []error
Holger Hildebrandtff05b682021-03-16 15:02:05 +0000395
396 handler.mutexDeletionInProgressFlag.Lock()
397 handler.deletionInProgress = true
398 handler.mutexDeletionInProgressFlag.Unlock()
399
Girish Gowdra0e533642021-03-02 22:02:51 -0800400 if err := handler.deleteDevicePersistencyData(ctx); err != nil {
401 errorsList = append(errorsList, err)
402 }
Girish Gowdra6afb56a2021-04-27 17:47:57 -0700403 select {
404 case handler.stopCollector <- true: // stop the metric collector routine
405 logger.Debugw(ctx, "sent stop signal to metric collector routine", log.Fields{"device-id": device.Id})
406 default:
407 logger.Warnw(ctx, "metric collector routine not waiting on stop signal", log.Fields{"device-id": device.Id})
408 }
409 select {
410 case handler.stopAlarmManager <- true: //stop the alarm manager.
411 logger.Debugw(ctx, "sent stop signal to alarm manager", log.Fields{"device-id": device.Id})
412 default:
413 logger.Warnw(ctx, "alarm manager not waiting on stop signal", log.Fields{"device-id": device.Id})
414 }
Girish Gowdra0e533642021-03-02 22:02:51 -0800415 if handler.pOnuMetricsMgr != nil {
416 if err := handler.pOnuMetricsMgr.clearAllPmData(ctx); err != nil {
417 errorsList = append(errorsList, err)
418 }
419 }
Girish Gowdra6afb56a2021-04-27 17:47:57 -0700420 select {
421 case handler.pSelfTestHdlr.stopSelfTestModule <- true:
422 logger.Debugw(ctx, "sent stop signal to self test handler module", log.Fields{"device-id": device.Id})
423 default:
424 logger.Warnw(ctx, "self test handler module not waiting on stop signal", log.Fields{"device-id": device.Id})
425 }
Holger Hildebrandtf07b44a2020-11-10 13:07:54 +0000426 //don't leave any garbage - even in error case
427 oo.deleteDeviceHandlerToMap(handler)
Girish Gowdra0e533642021-03-02 22:02:51 -0800428 if len(errorsList) > 0 {
429 logger.Errorw(ctx, "one-or-more-error-during-device-delete", log.Fields{"device-id": device.Id})
430 return fmt.Errorf("one-or-more-error-during-device-delete, errors:%v", errorsList)
431 }
432 return nil
Holger Hildebrandt9ca8b132020-08-07 14:45:03 +0000433 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000434 logger.Warnw(ctx, "no handler found for device-deletion", log.Fields{"device-id": device.Id})
mpagenko2418ab02020-11-12 12:58:06 +0000435 return fmt.Errorf(fmt.Sprintf("handler-not-found-%s", device.Id))
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000436}
437
438//Get_device_details unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000439func (oo *OpenONUAC) Get_device_details(ctx context.Context, device *voltha.Device) error {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000440 return errors.New("unImplemented")
441}
442
443//Update_flows_bulk returns
dbainbri4d3a0dc2020-12-02 00:33:42 +0000444func (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 +0000445 return errors.New("unImplemented")
446}
447
448//Update_flows_incrementally updates (add/remove) the flows on a given device
dbainbri4d3a0dc2020-12-02 00:33:42 +0000449func (oo *OpenONUAC) Update_flows_incrementally(ctx context.Context, device *voltha.Device,
mpagenkodff5dda2020-08-28 11:52:01 +0000450 flows *openflow_13.FlowChanges, groups *openflow_13.FlowGroupChanges, flowMetadata *voltha.FlowMetadata) error {
mpagenkofc4f56e2020-11-04 17:17:49 +0000451
dbainbri4d3a0dc2020-12-02 00:33:42 +0000452 logger.Infow(ctx, "update-flows-incrementally", log.Fields{"device-id": device.Id})
mpagenkofc4f56e2020-11-04 17:17:49 +0000453 //flow config is relayed to handler even if the device might be in some 'inactive' state
454 // let the handler or related FSM's decide, what to do with the modified flow state info
455 // 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 +0000456
457 // For now, there is no support for group changes (as in the actual Py-adapter code)
mpagenkofc4f56e2020-11-04 17:17:49 +0000458 // but processing is continued for flowUpdate possibly also set in the request
mpagenkodff5dda2020-08-28 11:52:01 +0000459 if groups.ToAdd != nil && groups.ToAdd.Items != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000460 logger.Warnw(ctx, "Update-flow-incr: group add not supported (ignored)", log.Fields{"device-id": device.Id})
mpagenkodff5dda2020-08-28 11:52:01 +0000461 }
462 if groups.ToRemove != nil && groups.ToRemove.Items != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000463 logger.Warnw(ctx, "Update-flow-incr: group remove not supported (ignored)", log.Fields{"device-id": device.Id})
mpagenkodff5dda2020-08-28 11:52:01 +0000464 }
465 if groups.ToUpdate != nil && groups.ToUpdate.Items != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000466 logger.Warnw(ctx, "Update-flow-incr: group update not supported (ignored)", log.Fields{"device-id": device.Id})
mpagenkodff5dda2020-08-28 11:52:01 +0000467 }
468
dbainbri4d3a0dc2020-12-02 00:33:42 +0000469 if handler := oo.getDeviceHandler(ctx, device.Id, false); handler != nil {
470 err := handler.FlowUpdateIncremental(ctx, flows, groups, flowMetadata)
mpagenkodff5dda2020-08-28 11:52:01 +0000471 return err
472 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000473 logger.Warnw(ctx, "no handler found for incremental flow update", log.Fields{"device-id": device.Id})
mpagenkodff5dda2020-08-28 11:52:01 +0000474 return fmt.Errorf(fmt.Sprintf("handler-not-found-%s", device.Id))
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000475}
476
477//Update_pm_config returns PmConfigs nil or error
dbainbri4d3a0dc2020-12-02 00:33:42 +0000478func (oo *OpenONUAC) Update_pm_config(ctx context.Context, device *voltha.Device, pmConfigs *voltha.PmConfigs) error {
Girish Gowdrae09a6202021-01-12 18:10:59 -0800479 logger.Infow(ctx, "update-pm-config", log.Fields{"device-id": device.Id})
480 if handler := oo.getDeviceHandler(ctx, device.Id, false); handler != nil {
Girish Gowdra5a7c4922021-01-22 18:33:41 -0800481 return handler.updatePmConfig(ctx, pmConfigs)
Girish Gowdrae09a6202021-01-12 18:10:59 -0800482 }
Girish Gowdra5a7c4922021-01-22 18:33:41 -0800483 logger.Warnw(ctx, "no handler found for update-pm-config", log.Fields{"device-id": device.Id})
484 return fmt.Errorf(fmt.Sprintf("handler-not-found-%s", device.Id))
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000485}
486
487//Receive_packet_out sends packet out to the device
dbainbri4d3a0dc2020-12-02 00:33:42 +0000488func (oo *OpenONUAC) Receive_packet_out(ctx context.Context, deviceID string, egressPortNo int, packet *openflow_13.OfpPacketOut) error {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000489 return errors.New("unImplemented")
490}
491
492//Suppress_event unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000493func (oo *OpenONUAC) Suppress_event(ctx context.Context, filter *voltha.EventFilter) error {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000494 return errors.New("unImplemented")
495}
496
497//Unsuppress_event unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000498func (oo *OpenONUAC) Unsuppress_event(ctx context.Context, filter *voltha.EventFilter) error {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000499 return errors.New("unImplemented")
500}
501
Andrea Campanella71e546a2021-02-26 11:09:33 +0100502//Download_image requests downloading some image according to indications as given in request
503//The ImageDownload needs to be called `request`due to library reflection requirements
504func (oo *OpenONUAC) Download_image(ctx context.Context, device *voltha.Device, request *voltha.ImageDownload) (*voltha.ImageDownload, error) {
mpagenko15ff4a52021-03-02 10:09:20 +0000505 if request != nil && (*request).Name != "" {
506 if !oo.pDownloadManager.imageExists(ctx, request) {
507 logger.Debugw(ctx, "start image download", log.Fields{"image-description": request})
508 // Download_image is not supposed to be blocking, anyway let's call the DownloadManager still synchronously to detect 'fast' problems
509 // the download itself is later done in background
510 err := oo.pDownloadManager.startDownload(ctx, request)
511 return request, err
512 }
513 // image already exists
514 logger.Debugw(ctx, "image already downloaded", log.Fields{"image-description": request})
515 return request, nil
mpagenkoc8bba412021-01-15 15:38:44 +0000516 }
mpagenko15ff4a52021-03-02 10:09:20 +0000517 return request, errors.New("invalid image definition")
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000518}
519
520//Get_image_download_status unimplemented
Andrea Campanella71e546a2021-02-26 11:09:33 +0100521//The ImageDownload needs to be called `request`due to library reflection requirements
dbainbri4d3a0dc2020-12-02 00:33:42 +0000522func (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 +0000523 return nil, errors.New("unImplemented")
524}
525
526//Cancel_image_download 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) Cancel_image_download(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
mpagenko057889c2021-01-21 16:51:58 +0000532//Activate_image_update requests downloading some Onu Software image to the INU via OMCI
Andrea Campanella71e546a2021-02-26 11:09:33 +0100533// according to indications as given in request and on success activate the image on the ONU
534//The ImageDownload needs to be called `request`due to library reflection requirements
535func (oo *OpenONUAC) Activate_image_update(ctx context.Context, device *voltha.Device, request *voltha.ImageDownload) (*voltha.ImageDownload, error) {
mpagenko15ff4a52021-03-02 10:09:20 +0000536 if request != nil && (*request).Name != "" {
537 if oo.pDownloadManager.imageLocallyDownloaded(ctx, request) {
538 if handler := oo.getDeviceHandler(ctx, device.Id, false); handler != nil {
539 logger.Debugw(ctx, "image download on omci requested", log.Fields{
540 "image-description": request, "device-id": device.Id})
541 err := handler.doOnuSwUpgrade(ctx, request, oo.pDownloadManager)
542 return request, err
543 }
544 logger.Warnw(ctx, "no handler found for image activation", log.Fields{"device-id": device.Id})
545 return request, fmt.Errorf(fmt.Sprintf("handler-not-found - device-id: %s", device.Id))
mpagenko057889c2021-01-21 16:51:58 +0000546 }
mpagenko15ff4a52021-03-02 10:09:20 +0000547 logger.Debugw(ctx, "image not yet downloaded on activate request", log.Fields{"image-description": request})
548 return request, fmt.Errorf(fmt.Sprintf("image-not-yet-downloaded - device-id: %s", device.Id))
mpagenkoc8bba412021-01-15 15:38:44 +0000549 }
mpagenko15ff4a52021-03-02 10:09:20 +0000550 return request, errors.New("invalid image definition")
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000551}
552
553//Revert_image_update unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000554func (oo *OpenONUAC) Revert_image_update(ctx context.Context, device *voltha.Device, request *voltha.ImageDownload) (*voltha.ImageDownload, error) {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000555 return nil, errors.New("unImplemented")
556}
557
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000558// Enable_port to Enable PON/NNI interface - seems not to be used/required according to python code
dbainbri4d3a0dc2020-12-02 00:33:42 +0000559func (oo *OpenONUAC) Enable_port(ctx context.Context, deviceID string, port *voltha.Port) error {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000560 return errors.New("unImplemented")
561}
562
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000563// Disable_port to Disable pon/nni interface - seems not to be used/required according to python code
dbainbri4d3a0dc2020-12-02 00:33:42 +0000564func (oo *OpenONUAC) Disable_port(ctx context.Context, deviceID string, port *voltha.Port) error {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000565 return errors.New("unImplemented")
566}
567
Himani Chawla6d2ae152020-09-02 13:11:20 +0530568//Child_device_lost - unimplemented
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000569//needed for if update >= 3.1.x
Matteo Scandolo3f2bdc82021-03-18 18:18:22 -0700570func (oo *OpenONUAC) Child_device_lost(ctx context.Context, device *voltha.Device) error {
Matteo Scandolo2e6f1e32020-04-15 11:28:45 -0700571 return errors.New("unImplemented")
572}
573
Himani Chawla6d2ae152020-09-02 13:11:20 +0530574// Start_omci_test unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000575func (oo *OpenONUAC) Start_omci_test(ctx context.Context, device *voltha.Device, request *voltha.OmciTestRequest) (*voltha.TestResponse, error) {
Matteo Scandolo2e6f1e32020-04-15 11:28:45 -0700576 return nil, errors.New("unImplemented")
577}
578
Himani Chawla6d2ae152020-09-02 13:11:20 +0530579// Get_ext_value - unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000580func (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 -0700581 return nil, errors.New("unImplemented")
582}
583
kesavandfdf77632021-01-26 23:40:33 -0500584//Single_get_value_request handles the core request to retrieve uni status
mpagenkoc8bba412021-01-15 15:38:44 +0000585func (oo *OpenONUAC) Single_get_value_request(ctx context.Context, request extension.SingleGetValueRequest) (*extension.SingleGetValueResponse, error) {
kesavandfdf77632021-01-26 23:40:33 -0500586 logger.Infow(ctx, "Single_get_value_request", log.Fields{"request": request})
587
588 if handler := oo.getDeviceHandler(ctx, request.TargetId, false); handler != nil {
589 switch reqType := request.GetRequest().GetRequest().(type) {
590 case *extension.GetValueRequest_UniInfo:
591 return handler.getUniPortStatus(ctx, reqType.UniInfo), nil
Girish Gowdra6afb56a2021-04-27 17:47:57 -0700592 case *extension.GetValueRequest_OnuOpticalInfo:
593 commChan := make(chan Message)
594 respChan := make(chan extension.SingleGetValueResponse)
595 // Initiate the self test request
596 if err := handler.pSelfTestHdlr.SelfTestRequestStart(ctx, request, commChan, respChan); err != nil {
597 return &extension.SingleGetValueResponse{
598 Response: &extension.GetValueResponse{
599 Status: extension.GetValueResponse_ERROR,
600 ErrReason: extension.GetValueResponse_INTERNAL_ERROR,
601 },
602 }, err
603 }
604 // The timeout handling is already implemented in omci_self_test_handler module
605 resp := <-respChan
606 return &resp, nil
kesavandfdf77632021-01-26 23:40:33 -0500607 default:
608 return postUniStatusErrResponse(extension.GetValueResponse_UNSUPPORTED), nil
609
610 }
611 }
612 logger.Errorw(ctx, "Single_get_value_request failed ", log.Fields{"request": request})
613 return postUniStatusErrResponse(extension.GetValueResponse_INVALID_DEVICE_ID), nil
mpagenkoc8bba412021-01-15 15:38:44 +0000614}
615
mpagenko83144272021-04-27 10:06:22 +0000616//if update >= 4.3.0
mpagenkoc26d4c02021-05-06 14:27:57 +0000617// Note: already with the implementation of the 'old' download interface problems were detected when the argument name used here is not the same
618// as defined in the adapter interface file. That sounds strange and the effects were strange as well.
619// The reason for that was never finally investigated.
620// To be on the safe side argument names are left here always as defined in iAdapter.go .
mpagenko83144272021-04-27 10:06:22 +0000621
622// Download_onu_image downloads (and optionally activates and commits) the indicated ONU image to the requested ONU(s)
623// if the image is not yet present on the adapter it has to be automatically downloaded
624func (oo *OpenONUAC) Download_onu_image(ctx context.Context, request *voltha.DeviceImageDownloadRequest) (*voltha.DeviceImageResponse, error) {
mpagenkoc26d4c02021-05-06 14:27:57 +0000625 if request != nil && len((*request).DeviceId) > 0 && (*request).Image.Version != "" {
626 loResponse := voltha.DeviceImageResponse{}
627 imageIdentifier := (*request).Image.Version
628 //inform the deviceHandler about (possibly new) requested ONU download requests
629 firstDevice := true
630 var vendorID string
631 for _, pCommonID := range (*request).DeviceId {
632 loDeviceID := (*pCommonID).Id
633 onuVolthaDevice, err := oo.coreProxy.GetDevice(log.WithSpanFromContext(context.TODO(), ctx),
634 loDeviceID, loDeviceID)
635 if err != nil || onuVolthaDevice == nil {
636 logger.Warnw(ctx, "Failed to fetch Onu device for image download",
637 log.Fields{"device-id": loDeviceID, "err": err})
638 continue //try the work with next deviceId
639 }
640 if firstDevice {
641 //start/verify download of the image to the adapter based on first found device only
642 // use the OnuVendor identification from first given device
643 firstDevice = false
644 vendorID = onuVolthaDevice.VendorId
645 imageIdentifier = vendorID + imageIdentifier //head on vendor ID of the ONU
646 logger.Debugw(ctx, "download request for file", log.Fields{"image-id": imageIdentifier})
647
648 if !oo.pFileManager.ImageExists(ctx, imageIdentifier) {
649 logger.Debugw(ctx, "start image download", log.Fields{"image-description": request})
650 // Download_image is not supposed to be blocking, anyway let's call the DownloadManager still synchronously to detect 'fast' problems
651 // the download itself is later done in background
652 if err := oo.pFileManager.StartDownload(ctx, imageIdentifier, (*request).Image.Url); err != nil {
653 return nil, err
654 }
655 }
656 // image already exists
657 logger.Debugw(ctx, "image already downloaded", log.Fields{"image-description": imageIdentifier})
658 } else {
659 //for all following devices verify the matching vendorID
660 if onuVolthaDevice.VendorId != vendorID {
661 logger.Warnw(ctx, "onu vendor id does not match image vendor id, device ignored",
662 log.Fields{"onu-vendor-id": onuVolthaDevice.VendorId, "image-vendor-id": vendorID})
663 continue //try the work with next deviceId
664 }
665 }
666 // start the ONU download activity for each possible device
667 // assumption here is, that the concerned device was already created (automatic start after device creation not supported)
668 if handler := oo.getDeviceHandler(ctx, loDeviceID, false); handler != nil {
669 logger.Debugw(ctx, "image download on omci requested", log.Fields{
670 "image-id": imageIdentifier, "device-id": loDeviceID})
671 //onu upgrade handling called in background without immediate error evaluation here
672 // as the processing can be done for multiple ONU's and an error on one ONU should not stop processing for others
673 // state/progress/success of the request has to be verified using the Get_onu_image_status() API
674 go handler.onuSwUpgradeAfterDownload(ctx, request, oo.pFileManager, imageIdentifier)
675 loDeviceImageState := voltha.DeviceImageState{}
676 loDeviceImageState.DeviceId = loDeviceID
677 loDeviceImageState.ImageState.Version = (*request).Image.Version
678 loDeviceImageState.ImageState.DownloadState = voltha.ImageState_DOWNLOAD_STARTED
679 loDeviceImageState.ImageState.Reason = voltha.ImageState_NO_ERROR
680 loDeviceImageState.ImageState.ImageState = voltha.ImageState_IMAGE_UNKNOWN
681 loResponse.DeviceImageStates = append(loResponse.DeviceImageStates, &loDeviceImageState)
682 } else {
683 //cannot start ONU download for requested device
684 logger.Warnw(ctx, "no handler found for image activation", log.Fields{"device-id": loDeviceID})
685 loDeviceImageState := voltha.DeviceImageState{}
686 loDeviceImageState.DeviceId = loDeviceID
687 loDeviceImageState.ImageState.Version = (*request).Image.Version
688 loDeviceImageState.ImageState.DownloadState = voltha.ImageState_DOWNLOAD_FAILED
689 loDeviceImageState.ImageState.Reason = voltha.ImageState_UNKNOWN_ERROR
690 loDeviceImageState.ImageState.ImageState = voltha.ImageState_IMAGE_UNKNOWN
691 loResponse.DeviceImageStates = append(loResponse.DeviceImageStates, &loDeviceImageState)
692 }
693 }
694 pImageResp := &loResponse
695 return pImageResp, nil
696 }
697 return nil, errors.New("invalid image download parameters")
mpagenko83144272021-04-27 10:06:22 +0000698}
699
700// Get_onu_image_status delivers the adapter-related information about the download/activation/commitment
701// status for the requested image
702func (oo *OpenONUAC) Get_onu_image_status(ctx context.Context, in *voltha.DeviceImageRequest) (*voltha.DeviceImageResponse, error) {
mpagenkoaa3afe92021-05-21 16:20:58 +0000703 if in != nil && len((*in).DeviceId) > 0 && (*in).Version != "" {
704 loResponse := voltha.DeviceImageResponse{}
705 pDlToAdapterImageState := &voltha.ImageState{}
706 imageIdentifier := (*in).Version
707 firstDevice := true
708 var vendorID string
709 for _, pCommonID := range (*in).DeviceId {
710 loDeviceID := (*pCommonID).Id
711 onuVolthaDevice, err := oo.coreProxy.GetDevice(log.WithSpanFromContext(context.TODO(), ctx),
712 loDeviceID, loDeviceID)
713 if err != nil || onuVolthaDevice == nil {
714 logger.Warnw(ctx, "Failed to fetch Onu device to get image status",
715 log.Fields{"device-id": loDeviceID, "err": err})
716 continue //try the work with next deviceId
717 }
718 if firstDevice {
719 //start/verify download of the image to the adapter based on first found device only
720 // use the OnuVendor identification from first given device
721 firstDevice = false
722 vendorID = onuVolthaDevice.VendorId
723 imageIdentifier = vendorID + imageIdentifier //head on vendor ID of the ONU
724 logger.Debugw(ctx, "status request for image", log.Fields{"image-id": imageIdentifier})
725 oo.pFileManager.RequestDownloadState(ctx, imageIdentifier, pDlToAdapterImageState)
726 } else {
727 //for all following devices verify the matching vendorID
728 if onuVolthaDevice.VendorId != vendorID {
729 logger.Warnw(ctx, "onu vendor id does not match image vendor id, device ignored",
730 log.Fields{"onu-vendor-id": onuVolthaDevice.VendorId, "image-vendor-id": vendorID})
731 continue //try the work with next deviceId
732 }
733 }
734 pDeviceImageState := &voltha.DeviceImageState{
735 ImageState: &voltha.ImageState{
736 DownloadState: (*pDlToAdapterImageState).DownloadState,
737 Reason: (*pDlToAdapterImageState).Reason,
738 },
739 }
740 // get the handler for the device
741 if handler := oo.getDeviceHandler(ctx, loDeviceID, false); handler != nil {
742 logger.Debugw(ctx, "image status request for", log.Fields{
743 "image-id": imageIdentifier, "device-id": loDeviceID})
744 //status request is called synchronously to collect the indications for all concerned devices
745 handler.requestOnuSwUpgradeState(ctx, imageIdentifier, (*in).Version, pDeviceImageState)
746 } else {
747 //cannot get the handler
748 logger.Warnw(ctx, "no handler found for image status request ", log.Fields{"device-id": loDeviceID})
749 pDeviceImageState.DeviceId = loDeviceID
750 pDeviceImageState.ImageState.Version = (*in).Version
751 pDeviceImageState.ImageState.DownloadState = voltha.ImageState_DOWNLOAD_FAILED
752 pDeviceImageState.ImageState.Reason = voltha.ImageState_UNKNOWN_ERROR
753 pDeviceImageState.ImageState.ImageState = voltha.ImageState_IMAGE_UNKNOWN
754 }
755 loResponse.DeviceImageStates = append(loResponse.DeviceImageStates, pDeviceImageState)
756 }
757 pImageResp := &loResponse
758 return pImageResp, nil
759 }
760 return nil, errors.New("invalid image status request parameters")
mpagenko83144272021-04-27 10:06:22 +0000761}
762
763// Abort_onu_image_upgrade stops the actual download/activation/commitment process (on next possibly step)
764func (oo *OpenONUAC) Abort_onu_image_upgrade(ctx context.Context, in *voltha.DeviceImageRequest) (*voltha.DeviceImageResponse, error) {
mpagenkoaa3afe92021-05-21 16:20:58 +0000765 if in != nil && len((*in).DeviceId) > 0 && (*in).Version != "" {
766 loResponse := voltha.DeviceImageResponse{}
767 imageIdentifier := (*in).Version
768 firstDevice := true
769 var vendorID string
770 for _, pCommonID := range (*in).DeviceId {
771 loDeviceID := (*pCommonID).Id
772 onuVolthaDevice, err := oo.coreProxy.GetDevice(log.WithSpanFromContext(context.TODO(), ctx),
773 loDeviceID, loDeviceID)
774 if err != nil || onuVolthaDevice == nil {
775 logger.Warnw(ctx, "Failed to fetch Onu device to abort its download",
776 log.Fields{"device-id": loDeviceID, "err": err})
777 continue //try the work with next deviceId
778 }
779 pDeviceImageState := &voltha.DeviceImageState{}
780 if firstDevice {
781 //start/verify download of the image to the adapter based on first found device only
782 // use the OnuVendor identification from first given device
783 firstDevice = false
784 vendorID = onuVolthaDevice.VendorId
785 imageIdentifier = vendorID + imageIdentifier //head on vendor ID of the ONU
786 logger.Debugw(ctx, "abort request for file", log.Fields{"image-id": imageIdentifier})
787 } else {
788 //for all following devices verify the matching vendorID
789 if onuVolthaDevice.VendorId != vendorID {
790 logger.Warnw(ctx, "onu vendor id does not match image vendor id, device ignored",
791 log.Fields{"onu-vendor-id": onuVolthaDevice.VendorId, "image-vendor-id": vendorID})
792 continue //try the work with next deviceId
793 }
794 }
795
796 // cancel the ONU upgrade activity for each possible device
797 if handler := oo.getDeviceHandler(ctx, loDeviceID, false); handler != nil {
798 logger.Debugw(ctx, "image upgrade abort requested", log.Fields{
799 "image-id": imageIdentifier, "device-id": loDeviceID})
800 //upgrade cancel is called synchronously to collect the imageResponse indications for all concerned devices
801 handler.cancelOnuSwUpgrade(ctx, imageIdentifier, (*in).Version, pDeviceImageState)
802 } else {
803 //cannot start ONU download for requested device
804 logger.Warnw(ctx, "no handler found for aborting upgrade ", log.Fields{"device-id": loDeviceID})
805 pDeviceImageState.DeviceId = loDeviceID
806 pDeviceImageState.ImageState.Version = (*in).Version
807 //nolint:misspell
808 pDeviceImageState.ImageState.DownloadState = voltha.ImageState_DOWNLOAD_CANCELLED
809 //nolint:misspell
810 pDeviceImageState.ImageState.Reason = voltha.ImageState_CANCELLED_ON_REQUEST
811 pDeviceImageState.ImageState.ImageState = voltha.ImageState_IMAGE_UNKNOWN
812 }
813 loResponse.DeviceImageStates = append(loResponse.DeviceImageStates, pDeviceImageState)
814 }
815 if !firstDevice {
816 //if at least one valid device was found cancel also a possibly running download to adapter and remove the image
817 // this is to be done after the upgradeOnu cancel activities in order to not subduct the file for still running processes
818 oo.pFileManager.CancelDownload(ctx, imageIdentifier)
819 }
820 pImageResp := &loResponse
821 return pImageResp, nil
822 }
823 return nil, errors.New("invalid image upgrade abort parameters")
mpagenko83144272021-04-27 10:06:22 +0000824}
825
826// Get_onu_images retrieves the ONU SW image status information via OMCI
827func (oo *OpenONUAC) Get_onu_images(ctx context.Context, deviceID string) (*voltha.OnuImages, error) {
828 return nil, errors.New("unImplemented")
829}
830
831// Activate_onu_image initiates the activation of the image for the requested ONU(s)
mpagenkoc26d4c02021-05-06 14:27:57 +0000832// precondition: image downloaded and not yet activated or image refers to current inactive image
mpagenko83144272021-04-27 10:06:22 +0000833func (oo *OpenONUAC) Activate_onu_image(ctx context.Context, in *voltha.DeviceImageRequest) (*voltha.DeviceImageResponse, error) {
mpagenkoc26d4c02021-05-06 14:27:57 +0000834 if in != nil && len((*in).DeviceId) > 0 && (*in).Version != "" {
835 loResponse := voltha.DeviceImageResponse{}
836 imageIdentifier := (*in).Version
837 //let the deviceHandler find the adequate way of requesting the image activation
838 for _, pCommonID := range (*in).DeviceId {
839 loDeviceID := (*pCommonID).Id
840 //compared to download procedure the vendorID (from device) is secondary here
841 // and only needed in case the upgrade process is based on some ongoing download process (and can be retrieved in deviceHandler if needed)
842 // start image activation activity for each possible device
843 // assumption here is, that the concerned device was already created (automatic start after device creation not supported)
844 if handler := oo.getDeviceHandler(ctx, loDeviceID, false); handler != nil {
845 logger.Debugw(ctx, "onu image activation requested", log.Fields{
846 "image-id": imageIdentifier, "device-id": loDeviceID})
847 //onu activation handling called in background without immediate error evaluation here
848 // as the processing can be done for multiple ONU's and an error on one ONU should not stop processing for others
849 // state/progress/success of the request has to be verified using the Get_onu_image_status() API
850 go handler.onuSwActivateRequest(ctx, imageIdentifier, (*in).CommitOnSuccess)
851 loDeviceImageState := voltha.DeviceImageState{}
852 loDeviceImageState.DeviceId = loDeviceID
853 loDeviceImageState.ImageState.Version = imageIdentifier
854 loDeviceImageState.ImageState.DownloadState = voltha.ImageState_DOWNLOAD_UNKNOWN
855 loDeviceImageState.ImageState.Reason = voltha.ImageState_NO_ERROR
856 loDeviceImageState.ImageState.ImageState = voltha.ImageState_IMAGE_ACTIVATING
857 loResponse.DeviceImageStates = append(loResponse.DeviceImageStates, &loDeviceImageState)
858 } else {
859 //cannot start SW activation for requested device
860 logger.Warnw(ctx, "no handler found for image activation", log.Fields{"device-id": loDeviceID})
861 loDeviceImageState := voltha.DeviceImageState{}
862 loDeviceImageState.DeviceId = loDeviceID
863 loDeviceImageState.ImageState.Version = imageIdentifier
864 loDeviceImageState.ImageState.DownloadState = voltha.ImageState_DOWNLOAD_UNKNOWN
865 loDeviceImageState.ImageState.Reason = voltha.ImageState_UNKNOWN_ERROR
866 loDeviceImageState.ImageState.ImageState = voltha.ImageState_IMAGE_ACTIVATION_ABORTED
867 loResponse.DeviceImageStates = append(loResponse.DeviceImageStates, &loDeviceImageState)
868 }
869 }
870 pImageResp := &loResponse
871 return pImageResp, nil
872 }
873 return nil, errors.New("invalid image activation parameters")
mpagenko83144272021-04-27 10:06:22 +0000874}
875
876// Commit_onu_image enforces the commitment of the image for the requested ONU(s)
877// precondition: image activated and not yet committed
878func (oo *OpenONUAC) Commit_onu_image(ctx context.Context, in *voltha.DeviceImageRequest) (*voltha.DeviceImageResponse, error) {
mpagenkoc26d4c02021-05-06 14:27:57 +0000879 if in != nil && len((*in).DeviceId) > 0 && (*in).Version != "" {
880 loResponse := voltha.DeviceImageResponse{}
881 imageIdentifier := (*in).Version
882 //let the deviceHandler find the adequate way of requesting the image activation
883 for _, pCommonID := range (*in).DeviceId {
884 loDeviceID := (*pCommonID).Id
885 //compared to download procedure the vendorID (from device) is secondary here
886 // and only needed in case the upgrade process is based on some ongoing download process (and can be retrieved in deviceHandler if needed)
887 // start image activation activity for each possible device
888 // assumption here is, that the concerned device was already created (automatic start after device creation not supported)
889 if handler := oo.getDeviceHandler(ctx, loDeviceID, false); handler != nil {
890 logger.Debugw(ctx, "onu image commitment requested", log.Fields{
891 "image-id": imageIdentifier, "device-id": loDeviceID})
892 //onu commitment handling called in background without immediate error evaluation here
893 // as the processing can be done for multiple ONU's and an error on one ONU should not stop processing for others
894 // state/progress/success of the request has to be verified using the Get_onu_image_status() API
895 go handler.onuSwCommitRequest(ctx, imageIdentifier)
896 loDeviceImageState := voltha.DeviceImageState{}
897 loDeviceImageState.DeviceId = loDeviceID
898 loDeviceImageState.ImageState.Version = imageIdentifier
899 loDeviceImageState.ImageState.DownloadState = voltha.ImageState_DOWNLOAD_UNKNOWN
900 loDeviceImageState.ImageState.Reason = voltha.ImageState_NO_ERROR
901 loDeviceImageState.ImageState.ImageState = voltha.ImageState_IMAGE_COMMITTING
902 loResponse.DeviceImageStates = append(loResponse.DeviceImageStates, &loDeviceImageState)
903 } else {
904 //cannot start SW commitment for requested device
905 logger.Warnw(ctx, "no handler found for image commitment", log.Fields{"device-id": loDeviceID})
906 loDeviceImageState := voltha.DeviceImageState{}
907 loDeviceImageState.DeviceId = loDeviceID
908 loDeviceImageState.ImageState.Version = imageIdentifier
909 loDeviceImageState.ImageState.DownloadState = voltha.ImageState_DOWNLOAD_UNKNOWN
910 loDeviceImageState.ImageState.Reason = voltha.ImageState_UNKNOWN_ERROR
911 loDeviceImageState.ImageState.ImageState = voltha.ImageState_IMAGE_COMMIT_ABORTED
912 loResponse.DeviceImageStates = append(loResponse.DeviceImageStates, &loDeviceImageState)
913 }
914 }
915 pImageResp := &loResponse
916 return pImageResp, nil
917 }
918 return nil, errors.New("invalid image commitment parameters")
mpagenko83144272021-04-27 10:06:22 +0000919}
920
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000921// Adapter interface required methods ################ end #########
922// #################################################################