blob: e933173810876e86264c81c7302a4ecb0cde87b6 [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
57 KVStoreHost string
58 KVStorePort int
59 KVStoreType string
mpagenkoaf801632020-07-03 10:00:42 +000060 KVStoreTimeout time.Duration
Holger Hildebrandt61b24d02020-11-16 13:36:40 +000061 mibTemplatesGenerated map[string]bool
62 lockMibTemplateGenerated sync.RWMutex
Holger Hildebrandtfa074992020-03-27 15:42:06 +000063 exitChannel chan int
64 HeartbeatCheckInterval time.Duration
65 HeartbeatFailReportInterval time.Duration
mpagenkodff5dda2020-08-28 11:52:01 +000066 AcceptIncrementalEvto bool
Holger Hildebrandtfa074992020-03-27 15:42:06 +000067 //GrpcTimeoutInterval time.Duration
Himani Chawlad96df182020-09-28 11:12:02 +053068 pSupportedFsms *OmciDeviceFsms
69 maxTimeoutInterAdapterComm time.Duration
mpagenkoc8bba412021-01-15 15:38:44 +000070 pDownloadManager *adapterDownloadManager
Girish Gowdraaf0ad632021-01-27 13:00:01 -080071 metricsEnabled bool
Holger Hildebrandtfa074992020-03-27 15:42:06 +000072}
73
74//NewOpenONUAC returns a new instance of OpenONU_AC
75func NewOpenONUAC(ctx context.Context, kafkaICProxy kafka.InterContainerProxy,
76 coreProxy adapterif.CoreProxy, adapterProxy adapterif.AdapterProxy,
Himani Chawlac07fda02020-12-09 16:21:21 +053077 eventProxy eventif.EventProxy, kvClient kvstore.Client, cfg *config.AdapterFlags, cm *conf.ConfigManager) *OpenONUAC {
Holger Hildebrandtfa074992020-03-27 15:42:06 +000078 var openOnuAc OpenONUAC
79 openOnuAc.exitChannel = make(chan int, 1)
Himani Chawla6d2ae152020-09-02 13:11:20 +053080 openOnuAc.deviceHandlers = make(map[string]*deviceHandler)
Holger Hildebrandtf07b44a2020-11-10 13:07:54 +000081 openOnuAc.deviceHandlersCreateChan = make(map[string]chan bool)
Holger Hildebrandt61b24d02020-11-16 13:36:40 +000082 openOnuAc.lockDeviceHandlersMap = sync.RWMutex{}
Holger Hildebrandtfa074992020-03-27 15:42:06 +000083 openOnuAc.kafkaICProxy = kafkaICProxy
84 openOnuAc.config = cfg
Matteo Scandolof1f39a72020-11-24 12:08:11 -080085 openOnuAc.cm = cm
Holger Hildebrandtfa074992020-03-27 15:42:06 +000086 openOnuAc.numOnus = cfg.OnuNumber
87 openOnuAc.coreProxy = coreProxy
88 openOnuAc.adapterProxy = adapterProxy
89 openOnuAc.eventProxy = eventProxy
mpagenkoaf801632020-07-03 10:00:42 +000090 openOnuAc.kvClient = kvClient
Holger Hildebrandtfa074992020-03-27 15:42:06 +000091 openOnuAc.KVStoreHost = cfg.KVStoreHost
92 openOnuAc.KVStorePort = cfg.KVStorePort
93 openOnuAc.KVStoreType = cfg.KVStoreType
mpagenkoaf801632020-07-03 10:00:42 +000094 openOnuAc.KVStoreTimeout = cfg.KVStoreTimeout
Holger Hildebrandt61b24d02020-11-16 13:36:40 +000095 openOnuAc.mibTemplatesGenerated = make(map[string]bool)
96 openOnuAc.lockMibTemplateGenerated = sync.RWMutex{}
Holger Hildebrandtfa074992020-03-27 15:42:06 +000097 openOnuAc.HeartbeatCheckInterval = cfg.HeartbeatCheckInterval
98 openOnuAc.HeartbeatFailReportInterval = cfg.HeartbeatFailReportInterval
mpagenkodff5dda2020-08-28 11:52:01 +000099 openOnuAc.AcceptIncrementalEvto = cfg.AccIncrEvto
Himani Chawlad96df182020-09-28 11:12:02 +0530100 openOnuAc.maxTimeoutInterAdapterComm = cfg.MaxTimeoutInterAdapterComm
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000101 //openOnuAc.GrpcTimeoutInterval = cfg.GrpcTimeoutInterval
Girish Gowdraaf0ad632021-01-27 13:00:01 -0800102 openOnuAc.metricsEnabled = cfg.MetricsEnabled
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000103
104 openOnuAc.pSupportedFsms = &OmciDeviceFsms{
105 "mib-synchronizer": {
106 //mibSyncFsm, // Implements the MIB synchronization state machine
Himani Chawla6d2ae152020-09-02 13:11:20 +0530107 mibDbVolatileDictImpl, // Implements volatile ME MIB database
Himani Chawla4d908332020-08-31 12:30:20 +0530108 //true, // Advertise events on OpenOMCI event bus
109 cMibAuditDelayImpl, // Time to wait between MIB audits. 0 to disable audits.
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000110 // map[string]func() error{
111 // "mib-upload": onuDeviceEntry.MibUploadTask,
112 // "mib-template": onuDeviceEntry.MibTemplateTask,
113 // "get-mds": onuDeviceEntry.GetMdsTask,
114 // "mib-audit": onuDeviceEntry.GetMdsTask,
115 // "mib-resync": onuDeviceEntry.MibResyncTask,
116 // "mib-reconcile": onuDeviceEntry.MibReconcileTask,
117 // },
118 },
119 }
120
mpagenkoc8bba412021-01-15 15:38:44 +0000121 openOnuAc.pDownloadManager = newAdapterDownloadManager(ctx)
122
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000123 return &openOnuAc
124}
125
126//Start starts (logs) the adapter
127func (oo *OpenONUAC) Start(ctx context.Context) error {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000128 logger.Info(ctx, "starting-openonu-adapter")
mpagenkoc8bba412021-01-15 15:38:44 +0000129
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000130 return nil
131}
132
Himani Chawla6d2ae152020-09-02 13:11:20 +0530133/*
134//stop terminates the session
135func (oo *OpenONUAC) stop(ctx context.Context) error {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000136 logger.Info(ctx,"stopping-device-manager")
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000137 oo.exitChannel <- 1
dbainbri4d3a0dc2020-12-02 00:33:42 +0000138 logger.Info(ctx,"device-manager-stopped")
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000139 return nil
140}
Himani Chawla6d2ae152020-09-02 13:11:20 +0530141*/
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000142
Himani Chawla6d2ae152020-09-02 13:11:20 +0530143func (oo *OpenONUAC) addDeviceHandlerToMap(ctx context.Context, agent *deviceHandler) {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000144 oo.lockDeviceHandlersMap.Lock()
145 defer oo.lockDeviceHandlersMap.Unlock()
146 if _, exist := oo.deviceHandlers[agent.deviceID]; !exist {
147 oo.deviceHandlers[agent.deviceID] = agent
Himani Chawla6d2ae152020-09-02 13:11:20 +0530148 oo.deviceHandlers[agent.deviceID].start(ctx)
Holger Hildebrandtf07b44a2020-11-10 13:07:54 +0000149 if _, exist := oo.deviceHandlersCreateChan[agent.deviceID]; exist {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000150 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 +0000151 oo.deviceHandlersCreateChan[agent.deviceID] <- true
152 }
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000153 }
154}
155
Himani Chawla6d2ae152020-09-02 13:11:20 +0530156func (oo *OpenONUAC) deleteDeviceHandlerToMap(agent *deviceHandler) {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000157 oo.lockDeviceHandlersMap.Lock()
158 defer oo.lockDeviceHandlersMap.Unlock()
159 delete(oo.deviceHandlers, agent.deviceID)
Holger Hildebrandtf07b44a2020-11-10 13:07:54 +0000160 delete(oo.deviceHandlersCreateChan, agent.deviceID)
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000161}
162
Holger Hildebrandtf07b44a2020-11-10 13:07:54 +0000163//getDeviceHandler gets the ONU deviceHandler and may wait until it is created
dbainbri4d3a0dc2020-12-02 00:33:42 +0000164func (oo *OpenONUAC) getDeviceHandler(ctx context.Context, deviceID string, aWait bool) *deviceHandler {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000165 oo.lockDeviceHandlersMap.Lock()
Holger Hildebrandtf07b44a2020-11-10 13:07:54 +0000166 agent, ok := oo.deviceHandlers[deviceID]
167 if aWait && !ok {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000168 logger.Infow(ctx, "Race condition: deviceHandler not present - wait for creation or timeout",
Holger Hildebrandt6c1fb0a2020-11-25 15:41:01 +0000169 log.Fields{"device-id": deviceID})
Holger Hildebrandtf07b44a2020-11-10 13:07:54 +0000170 if _, exist := oo.deviceHandlersCreateChan[deviceID]; !exist {
171 oo.deviceHandlersCreateChan[deviceID] = make(chan bool, 1)
172 }
Girish Gowdra7407a4d2020-11-12 12:44:53 -0800173 deviceCreateChan := oo.deviceHandlersCreateChan[deviceID]
Holger Hildebrandtf07b44a2020-11-10 13:07:54 +0000174 //keep the read sema short to allow for subsequent write
175 oo.lockDeviceHandlersMap.Unlock()
176 // based on concurrent processing the deviceHandler creation may not yet be finished at his point
177 // so it might be needed to wait here for that event with some timeout
178 select {
179 case <-time.After(1 * time.Second): //timer may be discussed ...
dbainbri4d3a0dc2020-12-02 00:33:42 +0000180 logger.Warnw(ctx, "No valid deviceHandler created after max WaitTime", log.Fields{"device-id": deviceID})
Holger Hildebrandtf07b44a2020-11-10 13:07:54 +0000181 return nil
Girish Gowdra7407a4d2020-11-12 12:44:53 -0800182 case <-deviceCreateChan:
dbainbri4d3a0dc2020-12-02 00:33:42 +0000183 logger.Debugw(ctx, "deviceHandler is ready now - continue", log.Fields{"device-id": deviceID})
Girish Gowdra7407a4d2020-11-12 12:44:53 -0800184 oo.lockDeviceHandlersMap.RLock()
185 defer oo.lockDeviceHandlersMap.RUnlock()
Holger Hildebrandtf07b44a2020-11-10 13:07:54 +0000186 return oo.deviceHandlers[deviceID]
187 }
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000188 }
Holger Hildebrandtf07b44a2020-11-10 13:07:54 +0000189 oo.lockDeviceHandlersMap.Unlock()
190 return agent
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000191}
192
dbainbri4d3a0dc2020-12-02 00:33:42 +0000193func (oo *OpenONUAC) processInterAdapterONUIndReqMessage(ctx context.Context, msg *ic.InterAdapterMessage) error {
Holger Hildebrandt6c1fb0a2020-11-25 15:41:01 +0000194 msgBody := msg.GetBody()
195 onuIndication := &oop.OnuIndication{}
196 if err := ptypes.UnmarshalAny(msgBody, onuIndication); err != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000197 logger.Warnw(ctx, "onu-ind-request-cannot-unmarshal-msg-body", log.Fields{"error": err})
Holger Hildebrandt6c1fb0a2020-11-25 15:41:01 +0000198 return err
199 }
200 //ToDeviceId should address a DeviceHandler instance
201 targetDevice := msg.Header.ToDeviceId
202
203 onuOperstate := onuIndication.GetOperState()
204 waitForDhInstPresent := false
205 if onuOperstate == "up" {
206 //Race condition (relevant in BBSIM-environment only): Due to unsynchronized processing of olt-adapter and rw_core,
207 //ONU_IND_REQUEST msg by olt-adapter could arrive a little bit earlier than rw_core was able to announce the corresponding
208 //ONU by RPC of Adopt_device(). Therefore it could be necessary to wait with processing of ONU_IND_REQUEST until call of
209 //Adopt_device() arrived and DeviceHandler instance was created
210 waitForDhInstPresent = true
211 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000212 if handler := oo.getDeviceHandler(ctx, targetDevice, waitForDhInstPresent); handler != nil {
213 logger.Infow(ctx, "onu-ind-request", log.Fields{"device-id": targetDevice,
Holger Hildebrandt6c1fb0a2020-11-25 15:41:01 +0000214 "OnuId": onuIndication.GetOnuId(),
215 "AdminState": onuIndication.GetAdminState(), "OperState": onuOperstate,
216 "SNR": onuIndication.GetSerialNumber()})
217
218 if onuOperstate == "up" {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000219 return handler.createInterface(ctx, onuIndication)
Holger Hildebrandt6c1fb0a2020-11-25 15:41:01 +0000220 } else if (onuOperstate == "down") || (onuOperstate == "unreachable") {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000221 return handler.updateInterface(ctx, onuIndication)
Holger Hildebrandt6c1fb0a2020-11-25 15:41:01 +0000222 } else {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000223 logger.Errorw(ctx, "unknown-onu-ind-request operState", log.Fields{"OnuId": onuIndication.GetOnuId()})
Holger Hildebrandt6c1fb0a2020-11-25 15:41:01 +0000224 return fmt.Errorf("invalidOperState: %s, %s", onuOperstate, targetDevice)
225 }
226 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000227 logger.Warnw(ctx, "no handler found for received onu-ind-request", log.Fields{
Holger Hildebrandt6c1fb0a2020-11-25 15:41:01 +0000228 "msgToDeviceId": targetDevice})
229 return fmt.Errorf(fmt.Sprintf("handler-not-found-%s", targetDevice))
230}
231
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000232// Adapter interface required methods ############## begin #########
233// #################################################################
234
235// for original content compare: (needs according deviceHandler methods)
236// /voltha-openolt-adapter/adaptercore/openolt.go
237
238// Adopt_device creates a new device handler if not present already and then adopts the device
dbainbri4d3a0dc2020-12-02 00:33:42 +0000239func (oo *OpenONUAC) Adopt_device(ctx context.Context, device *voltha.Device) error {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000240 if device == nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000241 logger.Warn(ctx, "voltha-device-is-nil")
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000242 return errors.New("nil-device")
243 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000244 logger.Infow(ctx, "adopt-device", log.Fields{"device-id": device.Id})
Himani Chawla6d2ae152020-09-02 13:11:20 +0530245 var handler *deviceHandler
dbainbri4d3a0dc2020-12-02 00:33:42 +0000246 if handler = oo.getDeviceHandler(ctx, device.Id, false); handler == nil {
247 handler := newDeviceHandler(ctx, oo.coreProxy, oo.adapterProxy, oo.eventProxy, device, oo)
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000248 oo.addDeviceHandlerToMap(ctx, handler)
Himani Chawla6d2ae152020-09-02 13:11:20 +0530249 go handler.adoptOrReconcileDevice(ctx, device)
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000250 // Launch the creation of the device topic
251 // go oo.createDeviceTopic(device)
252 }
253 return nil
254}
255
256//Get_ofp_device_info returns OFP information for the given device
dbainbri4d3a0dc2020-12-02 00:33:42 +0000257func (oo *OpenONUAC) Get_ofp_device_info(ctx context.Context, device *voltha.Device) (*ic.SwitchCapability, error) {
258 logger.Errorw(ctx, "device-handler-not-set", log.Fields{"device-id": device.Id})
Andrea Campanella6515c582020-10-05 11:25:00 +0200259 return nil, fmt.Errorf("device-handler-not-set %s", device.Id)
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000260}
261
262//Get_ofp_port_info returns OFP port information for the given device
mpagenkoaf801632020-07-03 10:00:42 +0000263//200630: method removed as per [VOL-3202]: OF port info is now to be delivered within UniPort create
264// cmp changes in onu_uni_port.go::CreateVolthaPort()
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000265
266//Process_inter_adapter_message sends messages to a target device (between adapters)
dbainbri4d3a0dc2020-12-02 00:33:42 +0000267func (oo *OpenONUAC) Process_inter_adapter_message(ctx context.Context, msg *ic.InterAdapterMessage) error {
268 logger.Debugw(ctx, "Process_inter_adapter_message", log.Fields{"msgId": msg.Header.Id,
Holger Hildebrandt80129db2020-11-23 10:49:32 +0000269 "msgProxyDeviceId": msg.Header.ProxyDeviceId, "msgToDeviceId": msg.Header.ToDeviceId, "Type": msg.Header.Type})
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000270
Holger Hildebrandt6c1fb0a2020-11-25 15:41:01 +0000271 if msg.Header.Type == ic.InterAdapterMessageType_ONU_IND_REQUEST {
272 // we have to handle ONU_IND_REQUEST already here - see comments in processInterAdapterONUIndReqMessage()
dbainbri4d3a0dc2020-12-02 00:33:42 +0000273 return oo.processInterAdapterONUIndReqMessage(ctx, msg)
Holger Hildebrandt6c1fb0a2020-11-25 15:41:01 +0000274 }
Holger Hildebrandtf07b44a2020-11-10 13:07:54 +0000275 //ToDeviceId should address a DeviceHandler instance
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000276 targetDevice := msg.Header.ToDeviceId
dbainbri4d3a0dc2020-12-02 00:33:42 +0000277 if handler := oo.getDeviceHandler(ctx, targetDevice, false); handler != nil {
mpagenko1cc3cb42020-07-27 15:24:38 +0000278 /* 200724: modification towards synchronous implementation - possible errors within processing shall be
279 * in the accordingly delayed response, some timing effect might result in Techprofile processing for multiple UNI's
280 */
dbainbri4d3a0dc2020-12-02 00:33:42 +0000281 return handler.processInterAdapterMessage(ctx, msg)
mpagenko1cc3cb42020-07-27 15:24:38 +0000282 /* so far the processing has been in background with according commented error treatment restrictions:
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000283 go handler.ProcessInterAdapterMessage(msg)
284 // error treatment might be more sophisticated
285 // by now let's just accept the message on 'communication layer'
286 // message content problems have to be evaluated then in the handler
287 // and are by now not reported to the calling party (to force what reaction there?)
288 return nil
mpagenko1cc3cb42020-07-27 15:24:38 +0000289 */
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000290 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000291 logger.Warnw(ctx, "no handler found for received Inter-Proxy-message", log.Fields{
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000292 "msgToDeviceId": targetDevice})
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000293 return fmt.Errorf(fmt.Sprintf("handler-not-found-%s", targetDevice))
294}
295
296//Adapter_descriptor not implemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000297func (oo *OpenONUAC) Adapter_descriptor(ctx context.Context) error {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000298 return errors.New("unImplemented")
299}
300
301//Device_types unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000302func (oo *OpenONUAC) Device_types(ctx context.Context) (*voltha.DeviceTypes, error) {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000303 return nil, errors.New("unImplemented")
304}
305
306//Health returns unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000307func (oo *OpenONUAC) Health(ctx context.Context) (*voltha.HealthStatus, error) {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000308 return nil, errors.New("unImplemented")
309}
310
Holger Hildebrandt9ca8b132020-08-07 14:45:03 +0000311//Reconcile_device is called once when the adapter needs to re-create device - usually on core restart
dbainbri4d3a0dc2020-12-02 00:33:42 +0000312func (oo *OpenONUAC) Reconcile_device(ctx context.Context, device *voltha.Device) error {
Holger Hildebrandtf41a1602020-08-19 09:52:50 +0000313 if device == nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000314 logger.Warn(ctx, "reconcile-device-voltha-device-is-nil")
Holger Hildebrandtf41a1602020-08-19 09:52:50 +0000315 return errors.New("nil-device")
316 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000317 logger.Infow(ctx, "reconcile-device", log.Fields{"device-id": device.Id})
Himani Chawla6d2ae152020-09-02 13:11:20 +0530318 var handler *deviceHandler
dbainbri4d3a0dc2020-12-02 00:33:42 +0000319 if handler = oo.getDeviceHandler(ctx, device.Id, false); handler == nil {
320 handler := newDeviceHandler(ctx, oo.coreProxy, oo.adapterProxy, oo.eventProxy, device, oo)
Holger Hildebrandtf41a1602020-08-19 09:52:50 +0000321 oo.addDeviceHandlerToMap(ctx, handler)
322 handler.device = device
323 handler.reconciling = true
Himani Chawla6d2ae152020-09-02 13:11:20 +0530324 go handler.adoptOrReconcileDevice(ctx, handler.device)
Holger Hildebrandtf41a1602020-08-19 09:52:50 +0000325 // reconcilement will be continued after onu-device entry is added
Holger Hildebrandt9ca8b132020-08-07 14:45:03 +0000326 } else {
Holger Hildebrandtf41a1602020-08-19 09:52:50 +0000327 return fmt.Errorf(fmt.Sprintf("device-already-reconciled-or-active-%s", device.Id))
Holger Hildebrandt9ca8b132020-08-07 14:45:03 +0000328 }
329 return nil
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000330}
331
332//Abandon_device unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000333func (oo *OpenONUAC) Abandon_device(ctx context.Context, device *voltha.Device) error {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000334 return errors.New("unImplemented")
335}
336
337//Disable_device disables the given device
dbainbri4d3a0dc2020-12-02 00:33:42 +0000338func (oo *OpenONUAC) Disable_device(ctx context.Context, device *voltha.Device) error {
339 logger.Infow(ctx, "disable-device", log.Fields{"device-id": device.Id})
340 if handler := oo.getDeviceHandler(ctx, device.Id, false); handler != nil {
341 go handler.disableDevice(ctx, device)
ozgecanetsiafce57b12020-05-25 14:39:35 +0300342 return nil
343 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000344 logger.Warnw(ctx, "no handler found for device-disable", log.Fields{"device-id": device.Id})
ozgecanetsiafce57b12020-05-25 14:39:35 +0300345 return fmt.Errorf(fmt.Sprintf("handler-not-found-%s", device.Id))
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000346}
347
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000348//Reenable_device enables the onu device after disable
dbainbri4d3a0dc2020-12-02 00:33:42 +0000349func (oo *OpenONUAC) Reenable_device(ctx context.Context, device *voltha.Device) error {
350 logger.Infow(ctx, "reenable-device", log.Fields{"device-id": device.Id})
351 if handler := oo.getDeviceHandler(ctx, device.Id, false); handler != nil {
352 go handler.reEnableDevice(ctx, device)
ozgecanetsiafce57b12020-05-25 14:39:35 +0300353 return nil
354 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000355 logger.Warnw(ctx, "no handler found for device-reenable", log.Fields{"device-id": device.Id})
ozgecanetsiafce57b12020-05-25 14:39:35 +0300356 return fmt.Errorf(fmt.Sprintf("handler-not-found-%s", device.Id))
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000357}
358
359//Reboot_device reboots the given device
dbainbri4d3a0dc2020-12-02 00:33:42 +0000360func (oo *OpenONUAC) Reboot_device(ctx context.Context, device *voltha.Device) error {
361 logger.Infow(ctx, "reboot-device", log.Fields{"device-id": device.Id})
362 if handler := oo.getDeviceHandler(ctx, device.Id, false); handler != nil {
363 go handler.rebootDevice(ctx, device)
ozgecanetsiae11479f2020-07-06 09:44:47 +0300364 return nil
365 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000366 logger.Warnw(ctx, "no handler found for device-reboot", log.Fields{"device-id": device.Id})
ozgecanetsiae11479f2020-07-06 09:44:47 +0300367 return fmt.Errorf(fmt.Sprintf("handler-not-found-#{device.Id}"))
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000368}
369
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000370//Self_test_device unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000371func (oo *OpenONUAC) Self_test_device(ctx context.Context, device *voltha.Device) error {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000372 return errors.New("unImplemented")
373}
374
Himani Chawla6d2ae152020-09-02 13:11:20 +0530375// Delete_device deletes the given device
dbainbri4d3a0dc2020-12-02 00:33:42 +0000376func (oo *OpenONUAC) Delete_device(ctx context.Context, device *voltha.Device) error {
377 logger.Infow(ctx, "delete-device", log.Fields{"device-id": device.Id, "SerialNumber": device.SerialNumber})
378 if handler := oo.getDeviceHandler(ctx, device.Id, false); handler != nil {
379 err := handler.deleteDevicePersistencyData(ctx)
Holger Hildebrandtf07b44a2020-11-10 13:07:54 +0000380 //don't leave any garbage - even in error case
381 oo.deleteDeviceHandlerToMap(handler)
mpagenko2418ab02020-11-12 12:58:06 +0000382 return err
Holger Hildebrandt9ca8b132020-08-07 14:45:03 +0000383 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000384 logger.Warnw(ctx, "no handler found for device-deletion", log.Fields{"device-id": device.Id})
mpagenko2418ab02020-11-12 12:58:06 +0000385 return fmt.Errorf(fmt.Sprintf("handler-not-found-%s", device.Id))
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000386}
387
388//Get_device_details unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000389func (oo *OpenONUAC) Get_device_details(ctx context.Context, device *voltha.Device) error {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000390 return errors.New("unImplemented")
391}
392
393//Update_flows_bulk returns
dbainbri4d3a0dc2020-12-02 00:33:42 +0000394func (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 +0000395 return errors.New("unImplemented")
396}
397
398//Update_flows_incrementally updates (add/remove) the flows on a given device
dbainbri4d3a0dc2020-12-02 00:33:42 +0000399func (oo *OpenONUAC) Update_flows_incrementally(ctx context.Context, device *voltha.Device,
mpagenkodff5dda2020-08-28 11:52:01 +0000400 flows *openflow_13.FlowChanges, groups *openflow_13.FlowGroupChanges, flowMetadata *voltha.FlowMetadata) error {
mpagenkofc4f56e2020-11-04 17:17:49 +0000401
dbainbri4d3a0dc2020-12-02 00:33:42 +0000402 logger.Infow(ctx, "update-flows-incrementally", log.Fields{"device-id": device.Id})
mpagenkofc4f56e2020-11-04 17:17:49 +0000403 //flow config is relayed to handler even if the device might be in some 'inactive' state
404 // let the handler or related FSM's decide, what to do with the modified flow state info
405 // 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 +0000406
407 // For now, there is no support for group changes (as in the actual Py-adapter code)
mpagenkofc4f56e2020-11-04 17:17:49 +0000408 // but processing is continued for flowUpdate possibly also set in the request
mpagenkodff5dda2020-08-28 11:52:01 +0000409 if groups.ToAdd != nil && groups.ToAdd.Items != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000410 logger.Warnw(ctx, "Update-flow-incr: group add not supported (ignored)", log.Fields{"device-id": device.Id})
mpagenkodff5dda2020-08-28 11:52:01 +0000411 }
412 if groups.ToRemove != nil && groups.ToRemove.Items != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000413 logger.Warnw(ctx, "Update-flow-incr: group remove not supported (ignored)", log.Fields{"device-id": device.Id})
mpagenkodff5dda2020-08-28 11:52:01 +0000414 }
415 if groups.ToUpdate != nil && groups.ToUpdate.Items != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000416 logger.Warnw(ctx, "Update-flow-incr: group update not supported (ignored)", log.Fields{"device-id": device.Id})
mpagenkodff5dda2020-08-28 11:52:01 +0000417 }
418
dbainbri4d3a0dc2020-12-02 00:33:42 +0000419 if handler := oo.getDeviceHandler(ctx, device.Id, false); handler != nil {
420 err := handler.FlowUpdateIncremental(ctx, flows, groups, flowMetadata)
mpagenkodff5dda2020-08-28 11:52:01 +0000421 return err
422 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000423 logger.Warnw(ctx, "no handler found for incremental flow update", log.Fields{"device-id": device.Id})
mpagenkodff5dda2020-08-28 11:52:01 +0000424 return fmt.Errorf(fmt.Sprintf("handler-not-found-%s", device.Id))
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000425}
426
427//Update_pm_config returns PmConfigs nil or error
dbainbri4d3a0dc2020-12-02 00:33:42 +0000428func (oo *OpenONUAC) Update_pm_config(ctx context.Context, device *voltha.Device, pmConfigs *voltha.PmConfigs) error {
Girish Gowdrae09a6202021-01-12 18:10:59 -0800429 logger.Infow(ctx, "update-pm-config", log.Fields{"device-id": device.Id})
430 if handler := oo.getDeviceHandler(ctx, device.Id, false); handler != nil {
Girish Gowdra5a7c4922021-01-22 18:33:41 -0800431 return handler.updatePmConfig(ctx, pmConfigs)
Girish Gowdrae09a6202021-01-12 18:10:59 -0800432 }
Girish Gowdra5a7c4922021-01-22 18:33:41 -0800433 logger.Warnw(ctx, "no handler found for update-pm-config", log.Fields{"device-id": device.Id})
434 return fmt.Errorf(fmt.Sprintf("handler-not-found-%s", device.Id))
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000435}
436
437//Receive_packet_out sends packet out to the device
dbainbri4d3a0dc2020-12-02 00:33:42 +0000438func (oo *OpenONUAC) Receive_packet_out(ctx context.Context, deviceID string, egressPortNo int, packet *openflow_13.OfpPacketOut) error {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000439 return errors.New("unImplemented")
440}
441
442//Suppress_event unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000443func (oo *OpenONUAC) Suppress_event(ctx context.Context, filter *voltha.EventFilter) error {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000444 return errors.New("unImplemented")
445}
446
447//Unsuppress_event unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000448func (oo *OpenONUAC) Unsuppress_event(ctx context.Context, filter *voltha.EventFilter) error {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000449 return errors.New("unImplemented")
450}
451
mpagenko057889c2021-01-21 16:51:58 +0000452//Download_image requests downloading some image according to indications as given in apRequest
mpagenkoc8bba412021-01-15 15:38:44 +0000453func (oo *OpenONUAC) Download_image(ctx context.Context, device *voltha.Device, apRequest *voltha.ImageDownload) (*voltha.ImageDownload, error) {
454 if !oo.pDownloadManager.imageExists(ctx, apRequest) {
455 logger.Debugw(ctx, "start image download", log.Fields{"image-description": apRequest})
456 // Download_image is not supposed to be blocking, anyway let's call the DownloadManager still synchronously to detect 'fast' problems
457 // the download itself is later done in background
458 err := oo.pDownloadManager.startDownload(ctx, apRequest)
459 return apRequest, err
460 }
461 // image already exists
mpagenko057889c2021-01-21 16:51:58 +0000462 logger.Debugw(ctx, "image already downloaded", log.Fields{"image-description": apRequest})
mpagenkoc8bba412021-01-15 15:38:44 +0000463 return apRequest, nil
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000464}
465
466//Get_image_download_status unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000467func (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 +0000468 return nil, errors.New("unImplemented")
469}
470
471//Cancel_image_download unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000472func (oo *OpenONUAC) Cancel_image_download(ctx context.Context, device *voltha.Device, request *voltha.ImageDownload) (*voltha.ImageDownload, error) {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000473 return nil, errors.New("unImplemented")
474}
475
mpagenko057889c2021-01-21 16:51:58 +0000476//Activate_image_update requests downloading some Onu Software image to the INU via OMCI
477// according to indications as given in apRequest and on success activate the image on the ONU
mpagenkoc8bba412021-01-15 15:38:44 +0000478func (oo *OpenONUAC) Activate_image_update(ctx context.Context, device *voltha.Device, apRequest *voltha.ImageDownload) (*voltha.ImageDownload, error) {
mpagenko057889c2021-01-21 16:51:58 +0000479 if oo.pDownloadManager.imageExists(ctx, apRequest) {
480 if handler := oo.getDeviceHandler(ctx, device.Id, false); handler != nil {
481 logger.Debugw(ctx, "image download on omci requested", log.Fields{
482 "image-description": apRequest, "device-id": device.Id})
483 err := handler.doOnuSwUpgrade(ctx, apRequest)
484 return apRequest, err
485 }
486 logger.Warnw(ctx, "no handler found for image activation", log.Fields{"device-id": device.Id})
487 return apRequest, fmt.Errorf(fmt.Sprintf("handler-not-found - device-id: %s", device.Id))
mpagenkoc8bba412021-01-15 15:38:44 +0000488 }
mpagenko057889c2021-01-21 16:51:58 +0000489 logger.Debugw(ctx, "image not yet downloaded on activate request", log.Fields{"image-description": apRequest})
490 return apRequest, fmt.Errorf(fmt.Sprintf("image-not-yet-downloaded - device-id: %s", device.Id))
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000491}
492
493//Revert_image_update unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000494func (oo *OpenONUAC) Revert_image_update(ctx context.Context, device *voltha.Device, request *voltha.ImageDownload) (*voltha.ImageDownload, error) {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000495 return nil, errors.New("unImplemented")
496}
497
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000498// Enable_port to Enable PON/NNI interface - seems not to be used/required according to python code
dbainbri4d3a0dc2020-12-02 00:33:42 +0000499func (oo *OpenONUAC) Enable_port(ctx context.Context, deviceID string, port *voltha.Port) error {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000500 return errors.New("unImplemented")
501}
502
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000503// Disable_port to Disable pon/nni interface - seems not to be used/required according to python code
dbainbri4d3a0dc2020-12-02 00:33:42 +0000504func (oo *OpenONUAC) Disable_port(ctx context.Context, deviceID string, port *voltha.Port) error {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000505 return errors.New("unImplemented")
506}
507
Himani Chawla6d2ae152020-09-02 13:11:20 +0530508//Child_device_lost - unimplemented
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000509//needed for if update >= 3.1.x
dbainbri4d3a0dc2020-12-02 00:33:42 +0000510func (oo *OpenONUAC) Child_device_lost(ctx context.Context, deviceID string, pPortNo uint32, onuID uint32) error {
Matteo Scandolo2e6f1e32020-04-15 11:28:45 -0700511 return errors.New("unImplemented")
512}
513
Himani Chawla6d2ae152020-09-02 13:11:20 +0530514// Start_omci_test unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000515func (oo *OpenONUAC) Start_omci_test(ctx context.Context, device *voltha.Device, request *voltha.OmciTestRequest) (*voltha.TestResponse, error) {
Matteo Scandolo2e6f1e32020-04-15 11:28:45 -0700516 return nil, errors.New("unImplemented")
517}
518
Himani Chawla6d2ae152020-09-02 13:11:20 +0530519// Get_ext_value - unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000520func (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 -0700521 return nil, errors.New("unImplemented")
522}
523
Girish Gowdrae09a6202021-01-12 18:10:59 -0800524// Single_get_value_request - unimplemented
mpagenkoc8bba412021-01-15 15:38:44 +0000525func (oo *OpenONUAC) Single_get_value_request(ctx context.Context, request extension.SingleGetValueRequest) (*extension.SingleGetValueResponse, error) {
526 return nil, errors.New("unImplemented")
527}
528
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000529// Adapter interface required methods ################ end #########
530// #################################################################