blob: 1eeac1ac9dd46be76ef6dc0c4e3bd5a9ab7febe2 [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
mpagenkoc8bba412021-01-15 15:38:44 +000069 pDownloadManager *adapterDownloadManager
Girish Gowdraaf0ad632021-01-27 13:00:01 -080070 metricsEnabled bool
Holger Hildebrandtfa074992020-03-27 15:42:06 +000071}
72
73//NewOpenONUAC returns a new instance of OpenONU_AC
74func NewOpenONUAC(ctx context.Context, kafkaICProxy kafka.InterContainerProxy,
75 coreProxy adapterif.CoreProxy, adapterProxy adapterif.AdapterProxy,
Himani Chawlac07fda02020-12-09 16:21:21 +053076 eventProxy eventif.EventProxy, kvClient kvstore.Client, cfg *config.AdapterFlags, cm *conf.ConfigManager) *OpenONUAC {
Holger Hildebrandtfa074992020-03-27 15:42:06 +000077 var openOnuAc OpenONUAC
78 openOnuAc.exitChannel = make(chan int, 1)
Himani Chawla6d2ae152020-09-02 13:11:20 +053079 openOnuAc.deviceHandlers = make(map[string]*deviceHandler)
Holger Hildebrandtf07b44a2020-11-10 13:07:54 +000080 openOnuAc.deviceHandlersCreateChan = make(map[string]chan bool)
Holger Hildebrandt61b24d02020-11-16 13:36:40 +000081 openOnuAc.lockDeviceHandlersMap = sync.RWMutex{}
Holger Hildebrandtfa074992020-03-27 15:42:06 +000082 openOnuAc.kafkaICProxy = kafkaICProxy
83 openOnuAc.config = cfg
Matteo Scandolof1f39a72020-11-24 12:08:11 -080084 openOnuAc.cm = cm
Holger Hildebrandtfa074992020-03-27 15:42:06 +000085 openOnuAc.numOnus = cfg.OnuNumber
86 openOnuAc.coreProxy = coreProxy
87 openOnuAc.adapterProxy = adapterProxy
88 openOnuAc.eventProxy = eventProxy
mpagenkoaf801632020-07-03 10:00:42 +000089 openOnuAc.kvClient = kvClient
Matteo Scandolo127c59d2021-01-28 11:31:18 -080090 openOnuAc.KVStoreAddress = cfg.KVStoreAddress
Holger Hildebrandtfa074992020-03-27 15:42:06 +000091 openOnuAc.KVStoreType = cfg.KVStoreType
mpagenkoaf801632020-07-03 10:00:42 +000092 openOnuAc.KVStoreTimeout = cfg.KVStoreTimeout
Holger Hildebrandt61b24d02020-11-16 13:36:40 +000093 openOnuAc.mibTemplatesGenerated = make(map[string]bool)
94 openOnuAc.lockMibTemplateGenerated = sync.RWMutex{}
Holger Hildebrandtfa074992020-03-27 15:42:06 +000095 openOnuAc.HeartbeatCheckInterval = cfg.HeartbeatCheckInterval
96 openOnuAc.HeartbeatFailReportInterval = cfg.HeartbeatFailReportInterval
mpagenkodff5dda2020-08-28 11:52:01 +000097 openOnuAc.AcceptIncrementalEvto = cfg.AccIncrEvto
Himani Chawlad96df182020-09-28 11:12:02 +053098 openOnuAc.maxTimeoutInterAdapterComm = cfg.MaxTimeoutInterAdapterComm
Holger Hildebrandtfa074992020-03-27 15:42:06 +000099 //openOnuAc.GrpcTimeoutInterval = cfg.GrpcTimeoutInterval
Girish Gowdraaf0ad632021-01-27 13:00:01 -0800100 openOnuAc.metricsEnabled = cfg.MetricsEnabled
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000101
102 openOnuAc.pSupportedFsms = &OmciDeviceFsms{
103 "mib-synchronizer": {
104 //mibSyncFsm, // Implements the MIB synchronization state machine
Himani Chawla6d2ae152020-09-02 13:11:20 +0530105 mibDbVolatileDictImpl, // Implements volatile ME MIB database
Himani Chawla4d908332020-08-31 12:30:20 +0530106 //true, // Advertise events on OpenOMCI event bus
Holger Hildebrandt10d98192021-01-27 15:29:31 +0000107 //TODO: audit delay should come from command parameters configured via helm charts (covered by VOL-3786)
Himani Chawla4d908332020-08-31 12:30:20 +0530108 cMibAuditDelayImpl, // Time to wait between MIB audits. 0 to disable audits.
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000109 // map[string]func() error{
110 // "mib-upload": onuDeviceEntry.MibUploadTask,
111 // "mib-template": onuDeviceEntry.MibTemplateTask,
112 // "get-mds": onuDeviceEntry.GetMdsTask,
113 // "mib-audit": onuDeviceEntry.GetMdsTask,
114 // "mib-resync": onuDeviceEntry.MibResyncTask,
115 // "mib-reconcile": onuDeviceEntry.MibReconcileTask,
116 // },
117 },
118 }
119
mpagenkoc8bba412021-01-15 15:38:44 +0000120 openOnuAc.pDownloadManager = newAdapterDownloadManager(ctx)
121
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000122 return &openOnuAc
123}
124
125//Start starts (logs) the adapter
126func (oo *OpenONUAC) Start(ctx context.Context) error {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000127 logger.Info(ctx, "starting-openonu-adapter")
mpagenkoc8bba412021-01-15 15:38:44 +0000128
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000129 return nil
130}
131
Himani Chawla6d2ae152020-09-02 13:11:20 +0530132/*
133//stop terminates the session
134func (oo *OpenONUAC) stop(ctx context.Context) error {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000135 logger.Info(ctx,"stopping-device-manager")
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000136 oo.exitChannel <- 1
dbainbri4d3a0dc2020-12-02 00:33:42 +0000137 logger.Info(ctx,"device-manager-stopped")
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000138 return nil
139}
Himani Chawla6d2ae152020-09-02 13:11:20 +0530140*/
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000141
Himani Chawla6d2ae152020-09-02 13:11:20 +0530142func (oo *OpenONUAC) addDeviceHandlerToMap(ctx context.Context, agent *deviceHandler) {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000143 oo.lockDeviceHandlersMap.Lock()
144 defer oo.lockDeviceHandlersMap.Unlock()
145 if _, exist := oo.deviceHandlers[agent.deviceID]; !exist {
146 oo.deviceHandlers[agent.deviceID] = agent
Himani Chawla6d2ae152020-09-02 13:11:20 +0530147 oo.deviceHandlers[agent.deviceID].start(ctx)
Holger Hildebrandtf07b44a2020-11-10 13:07:54 +0000148 if _, exist := oo.deviceHandlersCreateChan[agent.deviceID]; exist {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000149 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 +0000150 oo.deviceHandlersCreateChan[agent.deviceID] <- true
151 }
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000152 }
153}
154
Himani Chawla6d2ae152020-09-02 13:11:20 +0530155func (oo *OpenONUAC) deleteDeviceHandlerToMap(agent *deviceHandler) {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000156 oo.lockDeviceHandlersMap.Lock()
157 defer oo.lockDeviceHandlersMap.Unlock()
158 delete(oo.deviceHandlers, agent.deviceID)
Holger Hildebrandtf07b44a2020-11-10 13:07:54 +0000159 delete(oo.deviceHandlersCreateChan, agent.deviceID)
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000160}
161
Holger Hildebrandtf07b44a2020-11-10 13:07:54 +0000162//getDeviceHandler gets the ONU deviceHandler and may wait until it is created
dbainbri4d3a0dc2020-12-02 00:33:42 +0000163func (oo *OpenONUAC) getDeviceHandler(ctx context.Context, deviceID string, aWait bool) *deviceHandler {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000164 oo.lockDeviceHandlersMap.Lock()
Holger Hildebrandtf07b44a2020-11-10 13:07:54 +0000165 agent, ok := oo.deviceHandlers[deviceID]
166 if aWait && !ok {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000167 logger.Infow(ctx, "Race condition: deviceHandler not present - wait for creation or timeout",
Holger Hildebrandt6c1fb0a2020-11-25 15:41:01 +0000168 log.Fields{"device-id": deviceID})
Holger Hildebrandtf07b44a2020-11-10 13:07:54 +0000169 if _, exist := oo.deviceHandlersCreateChan[deviceID]; !exist {
170 oo.deviceHandlersCreateChan[deviceID] = make(chan bool, 1)
171 }
Girish Gowdra7407a4d2020-11-12 12:44:53 -0800172 deviceCreateChan := oo.deviceHandlersCreateChan[deviceID]
Holger Hildebrandtf07b44a2020-11-10 13:07:54 +0000173 //keep the read sema short to allow for subsequent write
174 oo.lockDeviceHandlersMap.Unlock()
175 // based on concurrent processing the deviceHandler creation may not yet be finished at his point
176 // so it might be needed to wait here for that event with some timeout
177 select {
178 case <-time.After(1 * time.Second): //timer may be discussed ...
dbainbri4d3a0dc2020-12-02 00:33:42 +0000179 logger.Warnw(ctx, "No valid deviceHandler created after max WaitTime", log.Fields{"device-id": deviceID})
Holger Hildebrandtf07b44a2020-11-10 13:07:54 +0000180 return nil
Girish Gowdra7407a4d2020-11-12 12:44:53 -0800181 case <-deviceCreateChan:
dbainbri4d3a0dc2020-12-02 00:33:42 +0000182 logger.Debugw(ctx, "deviceHandler is ready now - continue", log.Fields{"device-id": deviceID})
Girish Gowdra7407a4d2020-11-12 12:44:53 -0800183 oo.lockDeviceHandlersMap.RLock()
184 defer oo.lockDeviceHandlersMap.RUnlock()
Holger Hildebrandtf07b44a2020-11-10 13:07:54 +0000185 return oo.deviceHandlers[deviceID]
186 }
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000187 }
Holger Hildebrandtf07b44a2020-11-10 13:07:54 +0000188 oo.lockDeviceHandlersMap.Unlock()
189 return agent
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000190}
191
dbainbri4d3a0dc2020-12-02 00:33:42 +0000192func (oo *OpenONUAC) processInterAdapterONUIndReqMessage(ctx context.Context, msg *ic.InterAdapterMessage) error {
Holger Hildebrandt6c1fb0a2020-11-25 15:41:01 +0000193 msgBody := msg.GetBody()
194 onuIndication := &oop.OnuIndication{}
195 if err := ptypes.UnmarshalAny(msgBody, onuIndication); err != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000196 logger.Warnw(ctx, "onu-ind-request-cannot-unmarshal-msg-body", log.Fields{"error": err})
Holger Hildebrandt6c1fb0a2020-11-25 15:41:01 +0000197 return err
198 }
199 //ToDeviceId should address a DeviceHandler instance
200 targetDevice := msg.Header.ToDeviceId
201
202 onuOperstate := onuIndication.GetOperState()
203 waitForDhInstPresent := false
204 if onuOperstate == "up" {
205 //Race condition (relevant in BBSIM-environment only): Due to unsynchronized processing of olt-adapter and rw_core,
206 //ONU_IND_REQUEST msg by olt-adapter could arrive a little bit earlier than rw_core was able to announce the corresponding
207 //ONU by RPC of Adopt_device(). Therefore it could be necessary to wait with processing of ONU_IND_REQUEST until call of
208 //Adopt_device() arrived and DeviceHandler instance was created
209 waitForDhInstPresent = true
210 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000211 if handler := oo.getDeviceHandler(ctx, targetDevice, waitForDhInstPresent); handler != nil {
212 logger.Infow(ctx, "onu-ind-request", log.Fields{"device-id": targetDevice,
Holger Hildebrandt6c1fb0a2020-11-25 15:41:01 +0000213 "OnuId": onuIndication.GetOnuId(),
214 "AdminState": onuIndication.GetAdminState(), "OperState": onuOperstate,
215 "SNR": onuIndication.GetSerialNumber()})
216
217 if onuOperstate == "up" {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000218 return handler.createInterface(ctx, onuIndication)
Holger Hildebrandt6c1fb0a2020-11-25 15:41:01 +0000219 } else if (onuOperstate == "down") || (onuOperstate == "unreachable") {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000220 return handler.updateInterface(ctx, onuIndication)
Holger Hildebrandt6c1fb0a2020-11-25 15:41:01 +0000221 } else {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000222 logger.Errorw(ctx, "unknown-onu-ind-request operState", log.Fields{"OnuId": onuIndication.GetOnuId()})
Holger Hildebrandt6c1fb0a2020-11-25 15:41:01 +0000223 return fmt.Errorf("invalidOperState: %s, %s", onuOperstate, targetDevice)
224 }
225 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000226 logger.Warnw(ctx, "no handler found for received onu-ind-request", log.Fields{
Holger Hildebrandt6c1fb0a2020-11-25 15:41:01 +0000227 "msgToDeviceId": targetDevice})
228 return fmt.Errorf(fmt.Sprintf("handler-not-found-%s", targetDevice))
229}
230
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000231// Adapter interface required methods ############## begin #########
232// #################################################################
233
234// for original content compare: (needs according deviceHandler methods)
235// /voltha-openolt-adapter/adaptercore/openolt.go
236
237// Adopt_device creates a new device handler if not present already and then adopts the device
dbainbri4d3a0dc2020-12-02 00:33:42 +0000238func (oo *OpenONUAC) Adopt_device(ctx context.Context, device *voltha.Device) error {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000239 if device == nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000240 logger.Warn(ctx, "voltha-device-is-nil")
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000241 return errors.New("nil-device")
242 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000243 logger.Infow(ctx, "adopt-device", log.Fields{"device-id": device.Id})
Himani Chawla6d2ae152020-09-02 13:11:20 +0530244 var handler *deviceHandler
dbainbri4d3a0dc2020-12-02 00:33:42 +0000245 if handler = oo.getDeviceHandler(ctx, device.Id, false); handler == nil {
246 handler := newDeviceHandler(ctx, oo.coreProxy, oo.adapterProxy, oo.eventProxy, device, oo)
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000247 oo.addDeviceHandlerToMap(ctx, handler)
Himani Chawla6d2ae152020-09-02 13:11:20 +0530248 go handler.adoptOrReconcileDevice(ctx, device)
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000249 // Launch the creation of the device topic
250 // go oo.createDeviceTopic(device)
251 }
252 return nil
253}
254
255//Get_ofp_device_info returns OFP information for the given device
dbainbri4d3a0dc2020-12-02 00:33:42 +0000256func (oo *OpenONUAC) Get_ofp_device_info(ctx context.Context, device *voltha.Device) (*ic.SwitchCapability, error) {
257 logger.Errorw(ctx, "device-handler-not-set", log.Fields{"device-id": device.Id})
Andrea Campanella6515c582020-10-05 11:25:00 +0200258 return nil, fmt.Errorf("device-handler-not-set %s", device.Id)
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000259}
260
261//Get_ofp_port_info returns OFP port information for the given device
mpagenkoaf801632020-07-03 10:00:42 +0000262//200630: method removed as per [VOL-3202]: OF port info is now to be delivered within UniPort create
263// cmp changes in onu_uni_port.go::CreateVolthaPort()
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000264
265//Process_inter_adapter_message sends messages to a target device (between adapters)
dbainbri4d3a0dc2020-12-02 00:33:42 +0000266func (oo *OpenONUAC) Process_inter_adapter_message(ctx context.Context, msg *ic.InterAdapterMessage) error {
267 logger.Debugw(ctx, "Process_inter_adapter_message", log.Fields{"msgId": msg.Header.Id,
Holger Hildebrandt80129db2020-11-23 10:49:32 +0000268 "msgProxyDeviceId": msg.Header.ProxyDeviceId, "msgToDeviceId": msg.Header.ToDeviceId, "Type": msg.Header.Type})
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000269
Holger Hildebrandt6c1fb0a2020-11-25 15:41:01 +0000270 if msg.Header.Type == ic.InterAdapterMessageType_ONU_IND_REQUEST {
271 // we have to handle ONU_IND_REQUEST already here - see comments in processInterAdapterONUIndReqMessage()
dbainbri4d3a0dc2020-12-02 00:33:42 +0000272 return oo.processInterAdapterONUIndReqMessage(ctx, msg)
Holger Hildebrandt6c1fb0a2020-11-25 15:41:01 +0000273 }
Holger Hildebrandtf07b44a2020-11-10 13:07:54 +0000274 //ToDeviceId should address a DeviceHandler instance
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000275 targetDevice := msg.Header.ToDeviceId
dbainbri4d3a0dc2020-12-02 00:33:42 +0000276 if handler := oo.getDeviceHandler(ctx, targetDevice, false); handler != nil {
mpagenko1cc3cb42020-07-27 15:24:38 +0000277 /* 200724: modification towards synchronous implementation - possible errors within processing shall be
278 * in the accordingly delayed response, some timing effect might result in Techprofile processing for multiple UNI's
279 */
dbainbri4d3a0dc2020-12-02 00:33:42 +0000280 return handler.processInterAdapterMessage(ctx, msg)
mpagenko1cc3cb42020-07-27 15:24:38 +0000281 /* so far the processing has been in background with according commented error treatment restrictions:
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000282 go handler.ProcessInterAdapterMessage(msg)
283 // error treatment might be more sophisticated
284 // by now let's just accept the message on 'communication layer'
285 // message content problems have to be evaluated then in the handler
286 // and are by now not reported to the calling party (to force what reaction there?)
287 return nil
mpagenko1cc3cb42020-07-27 15:24:38 +0000288 */
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000289 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000290 logger.Warnw(ctx, "no handler found for received Inter-Proxy-message", log.Fields{
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000291 "msgToDeviceId": targetDevice})
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000292 return fmt.Errorf(fmt.Sprintf("handler-not-found-%s", targetDevice))
293}
294
295//Adapter_descriptor not implemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000296func (oo *OpenONUAC) Adapter_descriptor(ctx context.Context) error {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000297 return errors.New("unImplemented")
298}
299
300//Device_types unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000301func (oo *OpenONUAC) Device_types(ctx context.Context) (*voltha.DeviceTypes, error) {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000302 return nil, errors.New("unImplemented")
303}
304
305//Health returns unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000306func (oo *OpenONUAC) Health(ctx context.Context) (*voltha.HealthStatus, error) {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000307 return nil, errors.New("unImplemented")
308}
309
Holger Hildebrandt9ca8b132020-08-07 14:45:03 +0000310//Reconcile_device is called once when the adapter needs to re-create device - usually on core restart
dbainbri4d3a0dc2020-12-02 00:33:42 +0000311func (oo *OpenONUAC) Reconcile_device(ctx context.Context, device *voltha.Device) error {
Holger Hildebrandtf41a1602020-08-19 09:52:50 +0000312 if device == nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000313 logger.Warn(ctx, "reconcile-device-voltha-device-is-nil")
Holger Hildebrandtf41a1602020-08-19 09:52:50 +0000314 return errors.New("nil-device")
315 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000316 logger.Infow(ctx, "reconcile-device", log.Fields{"device-id": device.Id})
Himani Chawla6d2ae152020-09-02 13:11:20 +0530317 var handler *deviceHandler
dbainbri4d3a0dc2020-12-02 00:33:42 +0000318 if handler = oo.getDeviceHandler(ctx, device.Id, false); handler == nil {
319 handler := newDeviceHandler(ctx, oo.coreProxy, oo.adapterProxy, oo.eventProxy, device, oo)
Holger Hildebrandtf41a1602020-08-19 09:52:50 +0000320 oo.addDeviceHandlerToMap(ctx, handler)
321 handler.device = device
322 handler.reconciling = true
Himani Chawla6d2ae152020-09-02 13:11:20 +0530323 go handler.adoptOrReconcileDevice(ctx, handler.device)
Holger Hildebrandtf41a1602020-08-19 09:52:50 +0000324 // reconcilement will be continued after onu-device entry is added
Holger Hildebrandt9ca8b132020-08-07 14:45:03 +0000325 } else {
Holger Hildebrandtf41a1602020-08-19 09:52:50 +0000326 return fmt.Errorf(fmt.Sprintf("device-already-reconciled-or-active-%s", device.Id))
Holger Hildebrandt9ca8b132020-08-07 14:45:03 +0000327 }
328 return nil
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000329}
330
331//Abandon_device unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000332func (oo *OpenONUAC) Abandon_device(ctx context.Context, device *voltha.Device) error {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000333 return errors.New("unImplemented")
334}
335
336//Disable_device disables the given device
dbainbri4d3a0dc2020-12-02 00:33:42 +0000337func (oo *OpenONUAC) Disable_device(ctx context.Context, device *voltha.Device) error {
338 logger.Infow(ctx, "disable-device", log.Fields{"device-id": device.Id})
339 if handler := oo.getDeviceHandler(ctx, device.Id, false); handler != nil {
340 go handler.disableDevice(ctx, device)
ozgecanetsiafce57b12020-05-25 14:39:35 +0300341 return nil
342 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000343 logger.Warnw(ctx, "no handler found for device-disable", log.Fields{"device-id": device.Id})
ozgecanetsiafce57b12020-05-25 14:39:35 +0300344 return fmt.Errorf(fmt.Sprintf("handler-not-found-%s", device.Id))
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000345}
346
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000347//Reenable_device enables the onu device after disable
dbainbri4d3a0dc2020-12-02 00:33:42 +0000348func (oo *OpenONUAC) Reenable_device(ctx context.Context, device *voltha.Device) error {
349 logger.Infow(ctx, "reenable-device", log.Fields{"device-id": device.Id})
350 if handler := oo.getDeviceHandler(ctx, device.Id, false); handler != nil {
351 go handler.reEnableDevice(ctx, device)
ozgecanetsiafce57b12020-05-25 14:39:35 +0300352 return nil
353 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000354 logger.Warnw(ctx, "no handler found for device-reenable", log.Fields{"device-id": device.Id})
ozgecanetsiafce57b12020-05-25 14:39:35 +0300355 return fmt.Errorf(fmt.Sprintf("handler-not-found-%s", device.Id))
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000356}
357
358//Reboot_device reboots the given device
dbainbri4d3a0dc2020-12-02 00:33:42 +0000359func (oo *OpenONUAC) Reboot_device(ctx context.Context, device *voltha.Device) error {
360 logger.Infow(ctx, "reboot-device", log.Fields{"device-id": device.Id})
361 if handler := oo.getDeviceHandler(ctx, device.Id, false); handler != nil {
362 go handler.rebootDevice(ctx, device)
ozgecanetsiae11479f2020-07-06 09:44:47 +0300363 return nil
364 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000365 logger.Warnw(ctx, "no handler found for device-reboot", log.Fields{"device-id": device.Id})
ozgecanetsiae11479f2020-07-06 09:44:47 +0300366 return fmt.Errorf(fmt.Sprintf("handler-not-found-#{device.Id}"))
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000367}
368
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000369//Self_test_device unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000370func (oo *OpenONUAC) Self_test_device(ctx context.Context, device *voltha.Device) error {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000371 return errors.New("unImplemented")
372}
373
Himani Chawla6d2ae152020-09-02 13:11:20 +0530374// Delete_device deletes the given device
dbainbri4d3a0dc2020-12-02 00:33:42 +0000375func (oo *OpenONUAC) Delete_device(ctx context.Context, device *voltha.Device) error {
376 logger.Infow(ctx, "delete-device", log.Fields{"device-id": device.Id, "SerialNumber": device.SerialNumber})
377 if handler := oo.getDeviceHandler(ctx, device.Id, false); handler != nil {
378 err := handler.deleteDevicePersistencyData(ctx)
Holger Hildebrandtf07b44a2020-11-10 13:07:54 +0000379 //don't leave any garbage - even in error case
380 oo.deleteDeviceHandlerToMap(handler)
mpagenko2418ab02020-11-12 12:58:06 +0000381 return err
Holger Hildebrandt9ca8b132020-08-07 14:45:03 +0000382 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000383 logger.Warnw(ctx, "no handler found for device-deletion", log.Fields{"device-id": device.Id})
mpagenko2418ab02020-11-12 12:58:06 +0000384 return fmt.Errorf(fmt.Sprintf("handler-not-found-%s", device.Id))
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000385}
386
387//Get_device_details unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000388func (oo *OpenONUAC) Get_device_details(ctx context.Context, device *voltha.Device) error {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000389 return errors.New("unImplemented")
390}
391
392//Update_flows_bulk returns
dbainbri4d3a0dc2020-12-02 00:33:42 +0000393func (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 +0000394 return errors.New("unImplemented")
395}
396
397//Update_flows_incrementally updates (add/remove) the flows on a given device
dbainbri4d3a0dc2020-12-02 00:33:42 +0000398func (oo *OpenONUAC) Update_flows_incrementally(ctx context.Context, device *voltha.Device,
mpagenkodff5dda2020-08-28 11:52:01 +0000399 flows *openflow_13.FlowChanges, groups *openflow_13.FlowGroupChanges, flowMetadata *voltha.FlowMetadata) error {
mpagenkofc4f56e2020-11-04 17:17:49 +0000400
dbainbri4d3a0dc2020-12-02 00:33:42 +0000401 logger.Infow(ctx, "update-flows-incrementally", log.Fields{"device-id": device.Id})
mpagenkofc4f56e2020-11-04 17:17:49 +0000402 //flow config is relayed to handler even if the device might be in some 'inactive' state
403 // let the handler or related FSM's decide, what to do with the modified flow state info
404 // 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 +0000405
406 // For now, there is no support for group changes (as in the actual Py-adapter code)
mpagenkofc4f56e2020-11-04 17:17:49 +0000407 // but processing is continued for flowUpdate possibly also set in the request
mpagenkodff5dda2020-08-28 11:52:01 +0000408 if groups.ToAdd != nil && groups.ToAdd.Items != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000409 logger.Warnw(ctx, "Update-flow-incr: group add not supported (ignored)", log.Fields{"device-id": device.Id})
mpagenkodff5dda2020-08-28 11:52:01 +0000410 }
411 if groups.ToRemove != nil && groups.ToRemove.Items != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000412 logger.Warnw(ctx, "Update-flow-incr: group remove not supported (ignored)", log.Fields{"device-id": device.Id})
mpagenkodff5dda2020-08-28 11:52:01 +0000413 }
414 if groups.ToUpdate != nil && groups.ToUpdate.Items != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000415 logger.Warnw(ctx, "Update-flow-incr: group update not supported (ignored)", log.Fields{"device-id": device.Id})
mpagenkodff5dda2020-08-28 11:52:01 +0000416 }
417
dbainbri4d3a0dc2020-12-02 00:33:42 +0000418 if handler := oo.getDeviceHandler(ctx, device.Id, false); handler != nil {
419 err := handler.FlowUpdateIncremental(ctx, flows, groups, flowMetadata)
mpagenkodff5dda2020-08-28 11:52:01 +0000420 return err
421 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000422 logger.Warnw(ctx, "no handler found for incremental flow update", log.Fields{"device-id": device.Id})
mpagenkodff5dda2020-08-28 11:52:01 +0000423 return fmt.Errorf(fmt.Sprintf("handler-not-found-%s", device.Id))
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000424}
425
426//Update_pm_config returns PmConfigs nil or error
dbainbri4d3a0dc2020-12-02 00:33:42 +0000427func (oo *OpenONUAC) Update_pm_config(ctx context.Context, device *voltha.Device, pmConfigs *voltha.PmConfigs) error {
Girish Gowdrae09a6202021-01-12 18:10:59 -0800428 logger.Infow(ctx, "update-pm-config", log.Fields{"device-id": device.Id})
429 if handler := oo.getDeviceHandler(ctx, device.Id, false); handler != nil {
Girish Gowdra5a7c4922021-01-22 18:33:41 -0800430 return handler.updatePmConfig(ctx, pmConfigs)
Girish Gowdrae09a6202021-01-12 18:10:59 -0800431 }
Girish Gowdra5a7c4922021-01-22 18:33:41 -0800432 logger.Warnw(ctx, "no handler found for update-pm-config", log.Fields{"device-id": device.Id})
433 return fmt.Errorf(fmt.Sprintf("handler-not-found-%s", device.Id))
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000434}
435
436//Receive_packet_out sends packet out to the device
dbainbri4d3a0dc2020-12-02 00:33:42 +0000437func (oo *OpenONUAC) Receive_packet_out(ctx context.Context, deviceID string, egressPortNo int, packet *openflow_13.OfpPacketOut) error {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000438 return errors.New("unImplemented")
439}
440
441//Suppress_event unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000442func (oo *OpenONUAC) Suppress_event(ctx context.Context, filter *voltha.EventFilter) error {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000443 return errors.New("unImplemented")
444}
445
446//Unsuppress_event unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000447func (oo *OpenONUAC) Unsuppress_event(ctx context.Context, filter *voltha.EventFilter) error {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000448 return errors.New("unImplemented")
449}
450
mpagenko057889c2021-01-21 16:51:58 +0000451//Download_image requests downloading some image according to indications as given in apRequest
mpagenkoc8bba412021-01-15 15:38:44 +0000452func (oo *OpenONUAC) Download_image(ctx context.Context, device *voltha.Device, apRequest *voltha.ImageDownload) (*voltha.ImageDownload, error) {
453 if !oo.pDownloadManager.imageExists(ctx, apRequest) {
454 logger.Debugw(ctx, "start image download", log.Fields{"image-description": apRequest})
455 // Download_image is not supposed to be blocking, anyway let's call the DownloadManager still synchronously to detect 'fast' problems
456 // the download itself is later done in background
457 err := oo.pDownloadManager.startDownload(ctx, apRequest)
458 return apRequest, err
459 }
460 // image already exists
mpagenko057889c2021-01-21 16:51:58 +0000461 logger.Debugw(ctx, "image already downloaded", log.Fields{"image-description": apRequest})
mpagenkoc8bba412021-01-15 15:38:44 +0000462 return apRequest, nil
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000463}
464
465//Get_image_download_status unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000466func (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 +0000467 return nil, errors.New("unImplemented")
468}
469
470//Cancel_image_download unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000471func (oo *OpenONUAC) Cancel_image_download(ctx context.Context, device *voltha.Device, request *voltha.ImageDownload) (*voltha.ImageDownload, error) {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000472 return nil, errors.New("unImplemented")
473}
474
mpagenko057889c2021-01-21 16:51:58 +0000475//Activate_image_update requests downloading some Onu Software image to the INU via OMCI
476// according to indications as given in apRequest and on success activate the image on the ONU
mpagenkoc8bba412021-01-15 15:38:44 +0000477func (oo *OpenONUAC) Activate_image_update(ctx context.Context, device *voltha.Device, apRequest *voltha.ImageDownload) (*voltha.ImageDownload, error) {
mpagenko057889c2021-01-21 16:51:58 +0000478 if oo.pDownloadManager.imageExists(ctx, apRequest) {
479 if handler := oo.getDeviceHandler(ctx, device.Id, false); handler != nil {
480 logger.Debugw(ctx, "image download on omci requested", log.Fields{
481 "image-description": apRequest, "device-id": device.Id})
482 err := handler.doOnuSwUpgrade(ctx, apRequest)
483 return apRequest, err
484 }
485 logger.Warnw(ctx, "no handler found for image activation", log.Fields{"device-id": device.Id})
486 return apRequest, fmt.Errorf(fmt.Sprintf("handler-not-found - device-id: %s", device.Id))
mpagenkoc8bba412021-01-15 15:38:44 +0000487 }
mpagenko057889c2021-01-21 16:51:58 +0000488 logger.Debugw(ctx, "image not yet downloaded on activate request", log.Fields{"image-description": apRequest})
489 return apRequest, fmt.Errorf(fmt.Sprintf("image-not-yet-downloaded - device-id: %s", device.Id))
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000490}
491
492//Revert_image_update unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000493func (oo *OpenONUAC) Revert_image_update(ctx context.Context, device *voltha.Device, request *voltha.ImageDownload) (*voltha.ImageDownload, error) {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000494 return nil, errors.New("unImplemented")
495}
496
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000497// Enable_port to Enable PON/NNI interface - seems not to be used/required according to python code
dbainbri4d3a0dc2020-12-02 00:33:42 +0000498func (oo *OpenONUAC) Enable_port(ctx context.Context, deviceID string, port *voltha.Port) error {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000499 return errors.New("unImplemented")
500}
501
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000502// Disable_port to Disable pon/nni interface - seems not to be used/required according to python code
dbainbri4d3a0dc2020-12-02 00:33:42 +0000503func (oo *OpenONUAC) Disable_port(ctx context.Context, deviceID string, port *voltha.Port) error {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000504 return errors.New("unImplemented")
505}
506
Himani Chawla6d2ae152020-09-02 13:11:20 +0530507//Child_device_lost - unimplemented
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000508//needed for if update >= 3.1.x
dbainbri4d3a0dc2020-12-02 00:33:42 +0000509func (oo *OpenONUAC) Child_device_lost(ctx context.Context, deviceID string, pPortNo uint32, onuID uint32) error {
Matteo Scandolo2e6f1e32020-04-15 11:28:45 -0700510 return errors.New("unImplemented")
511}
512
Himani Chawla6d2ae152020-09-02 13:11:20 +0530513// Start_omci_test unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000514func (oo *OpenONUAC) Start_omci_test(ctx context.Context, device *voltha.Device, request *voltha.OmciTestRequest) (*voltha.TestResponse, error) {
Matteo Scandolo2e6f1e32020-04-15 11:28:45 -0700515 return nil, errors.New("unImplemented")
516}
517
Himani Chawla6d2ae152020-09-02 13:11:20 +0530518// Get_ext_value - unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000519func (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 -0700520 return nil, errors.New("unImplemented")
521}
522
kesavandfdf77632021-01-26 23:40:33 -0500523//Single_get_value_request handles the core request to retrieve uni status
mpagenkoc8bba412021-01-15 15:38:44 +0000524func (oo *OpenONUAC) Single_get_value_request(ctx context.Context, request extension.SingleGetValueRequest) (*extension.SingleGetValueResponse, error) {
kesavandfdf77632021-01-26 23:40:33 -0500525 logger.Infow(ctx, "Single_get_value_request", log.Fields{"request": request})
526
527 if handler := oo.getDeviceHandler(ctx, request.TargetId, false); handler != nil {
528 switch reqType := request.GetRequest().GetRequest().(type) {
529 case *extension.GetValueRequest_UniInfo:
530 return handler.getUniPortStatus(ctx, reqType.UniInfo), nil
531 default:
532 return postUniStatusErrResponse(extension.GetValueResponse_UNSUPPORTED), nil
533
534 }
535 }
536 logger.Errorw(ctx, "Single_get_value_request failed ", log.Fields{"request": request})
537 return postUniStatusErrResponse(extension.GetValueResponse_INVALID_DEVICE_ID), nil
mpagenkoc8bba412021-01-15 15:38:44 +0000538}
539
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000540// Adapter interface required methods ################ end #########
541// #################################################################