blob: f670437b14cbfbd80e3443cdab95130723da547d [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
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
Holger Hildebrandtfa074992020-03-27 15:42:06 +000090 openOnuAc.KVStoreHost = cfg.KVStoreHost
91 openOnuAc.KVStorePort = cfg.KVStorePort
92 openOnuAc.KVStoreType = cfg.KVStoreType
mpagenkoaf801632020-07-03 10:00:42 +000093 openOnuAc.KVStoreTimeout = cfg.KVStoreTimeout
Holger Hildebrandt61b24d02020-11-16 13:36:40 +000094 openOnuAc.mibTemplatesGenerated = make(map[string]bool)
95 openOnuAc.lockMibTemplateGenerated = sync.RWMutex{}
Holger Hildebrandtfa074992020-03-27 15:42:06 +000096 openOnuAc.HeartbeatCheckInterval = cfg.HeartbeatCheckInterval
97 openOnuAc.HeartbeatFailReportInterval = cfg.HeartbeatFailReportInterval
mpagenkodff5dda2020-08-28 11:52:01 +000098 openOnuAc.AcceptIncrementalEvto = cfg.AccIncrEvto
Himani Chawlad96df182020-09-28 11:12:02 +053099 openOnuAc.maxTimeoutInterAdapterComm = cfg.MaxTimeoutInterAdapterComm
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000100 //openOnuAc.GrpcTimeoutInterval = cfg.GrpcTimeoutInterval
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
107 cMibAuditDelayImpl, // Time to wait between MIB audits. 0 to disable audits.
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000108 // map[string]func() error{
109 // "mib-upload": onuDeviceEntry.MibUploadTask,
110 // "mib-template": onuDeviceEntry.MibTemplateTask,
111 // "get-mds": onuDeviceEntry.GetMdsTask,
112 // "mib-audit": onuDeviceEntry.GetMdsTask,
113 // "mib-resync": onuDeviceEntry.MibResyncTask,
114 // "mib-reconcile": onuDeviceEntry.MibReconcileTask,
115 // },
116 },
117 }
118
mpagenkoc8bba412021-01-15 15:38:44 +0000119 openOnuAc.pDownloadManager = newAdapterDownloadManager(ctx)
120
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000121 return &openOnuAc
122}
123
124//Start starts (logs) the adapter
125func (oo *OpenONUAC) Start(ctx context.Context) error {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000126 logger.Info(ctx, "starting-openonu-adapter")
mpagenkoc8bba412021-01-15 15:38:44 +0000127
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000128 return nil
129}
130
Himani Chawla6d2ae152020-09-02 13:11:20 +0530131/*
132//stop terminates the session
133func (oo *OpenONUAC) stop(ctx context.Context) error {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000134 logger.Info(ctx,"stopping-device-manager")
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000135 oo.exitChannel <- 1
dbainbri4d3a0dc2020-12-02 00:33:42 +0000136 logger.Info(ctx,"device-manager-stopped")
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000137 return nil
138}
Himani Chawla6d2ae152020-09-02 13:11:20 +0530139*/
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000140
Himani Chawla6d2ae152020-09-02 13:11:20 +0530141func (oo *OpenONUAC) addDeviceHandlerToMap(ctx context.Context, agent *deviceHandler) {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000142 oo.lockDeviceHandlersMap.Lock()
143 defer oo.lockDeviceHandlersMap.Unlock()
144 if _, exist := oo.deviceHandlers[agent.deviceID]; !exist {
145 oo.deviceHandlers[agent.deviceID] = agent
Himani Chawla6d2ae152020-09-02 13:11:20 +0530146 oo.deviceHandlers[agent.deviceID].start(ctx)
Holger Hildebrandtf07b44a2020-11-10 13:07:54 +0000147 if _, exist := oo.deviceHandlersCreateChan[agent.deviceID]; exist {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000148 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 +0000149 oo.deviceHandlersCreateChan[agent.deviceID] <- true
150 }
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000151 }
152}
153
Himani Chawla6d2ae152020-09-02 13:11:20 +0530154func (oo *OpenONUAC) deleteDeviceHandlerToMap(agent *deviceHandler) {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000155 oo.lockDeviceHandlersMap.Lock()
156 defer oo.lockDeviceHandlersMap.Unlock()
157 delete(oo.deviceHandlers, agent.deviceID)
Holger Hildebrandtf07b44a2020-11-10 13:07:54 +0000158 delete(oo.deviceHandlersCreateChan, agent.deviceID)
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000159}
160
Holger Hildebrandtf07b44a2020-11-10 13:07:54 +0000161//getDeviceHandler gets the ONU deviceHandler and may wait until it is created
dbainbri4d3a0dc2020-12-02 00:33:42 +0000162func (oo *OpenONUAC) getDeviceHandler(ctx context.Context, deviceID string, aWait bool) *deviceHandler {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000163 oo.lockDeviceHandlersMap.Lock()
Holger Hildebrandtf07b44a2020-11-10 13:07:54 +0000164 agent, ok := oo.deviceHandlers[deviceID]
165 if aWait && !ok {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000166 logger.Infow(ctx, "Race condition: deviceHandler not present - wait for creation or timeout",
Holger Hildebrandt6c1fb0a2020-11-25 15:41:01 +0000167 log.Fields{"device-id": deviceID})
Holger Hildebrandtf07b44a2020-11-10 13:07:54 +0000168 if _, exist := oo.deviceHandlersCreateChan[deviceID]; !exist {
169 oo.deviceHandlersCreateChan[deviceID] = make(chan bool, 1)
170 }
Girish Gowdra7407a4d2020-11-12 12:44:53 -0800171 deviceCreateChan := oo.deviceHandlersCreateChan[deviceID]
Holger Hildebrandtf07b44a2020-11-10 13:07:54 +0000172 //keep the read sema short to allow for subsequent write
173 oo.lockDeviceHandlersMap.Unlock()
174 // based on concurrent processing the deviceHandler creation may not yet be finished at his point
175 // so it might be needed to wait here for that event with some timeout
176 select {
177 case <-time.After(1 * time.Second): //timer may be discussed ...
dbainbri4d3a0dc2020-12-02 00:33:42 +0000178 logger.Warnw(ctx, "No valid deviceHandler created after max WaitTime", log.Fields{"device-id": deviceID})
Holger Hildebrandtf07b44a2020-11-10 13:07:54 +0000179 return nil
Girish Gowdra7407a4d2020-11-12 12:44:53 -0800180 case <-deviceCreateChan:
dbainbri4d3a0dc2020-12-02 00:33:42 +0000181 logger.Debugw(ctx, "deviceHandler is ready now - continue", log.Fields{"device-id": deviceID})
Girish Gowdra7407a4d2020-11-12 12:44:53 -0800182 oo.lockDeviceHandlersMap.RLock()
183 defer oo.lockDeviceHandlersMap.RUnlock()
Holger Hildebrandtf07b44a2020-11-10 13:07:54 +0000184 return oo.deviceHandlers[deviceID]
185 }
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000186 }
Holger Hildebrandtf07b44a2020-11-10 13:07:54 +0000187 oo.lockDeviceHandlersMap.Unlock()
188 return agent
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000189}
190
dbainbri4d3a0dc2020-12-02 00:33:42 +0000191func (oo *OpenONUAC) processInterAdapterONUIndReqMessage(ctx context.Context, msg *ic.InterAdapterMessage) error {
Holger Hildebrandt6c1fb0a2020-11-25 15:41:01 +0000192 msgBody := msg.GetBody()
193 onuIndication := &oop.OnuIndication{}
194 if err := ptypes.UnmarshalAny(msgBody, onuIndication); err != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000195 logger.Warnw(ctx, "onu-ind-request-cannot-unmarshal-msg-body", log.Fields{"error": err})
Holger Hildebrandt6c1fb0a2020-11-25 15:41:01 +0000196 return err
197 }
198 //ToDeviceId should address a DeviceHandler instance
199 targetDevice := msg.Header.ToDeviceId
200
201 onuOperstate := onuIndication.GetOperState()
202 waitForDhInstPresent := false
203 if onuOperstate == "up" {
204 //Race condition (relevant in BBSIM-environment only): Due to unsynchronized processing of olt-adapter and rw_core,
205 //ONU_IND_REQUEST msg by olt-adapter could arrive a little bit earlier than rw_core was able to announce the corresponding
206 //ONU by RPC of Adopt_device(). Therefore it could be necessary to wait with processing of ONU_IND_REQUEST until call of
207 //Adopt_device() arrived and DeviceHandler instance was created
208 waitForDhInstPresent = true
209 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000210 if handler := oo.getDeviceHandler(ctx, targetDevice, waitForDhInstPresent); handler != nil {
211 logger.Infow(ctx, "onu-ind-request", log.Fields{"device-id": targetDevice,
Holger Hildebrandt6c1fb0a2020-11-25 15:41:01 +0000212 "OnuId": onuIndication.GetOnuId(),
213 "AdminState": onuIndication.GetAdminState(), "OperState": onuOperstate,
214 "SNR": onuIndication.GetSerialNumber()})
215
216 if onuOperstate == "up" {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000217 return handler.createInterface(ctx, onuIndication)
Holger Hildebrandt6c1fb0a2020-11-25 15:41:01 +0000218 } else if (onuOperstate == "down") || (onuOperstate == "unreachable") {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000219 return handler.updateInterface(ctx, onuIndication)
Holger Hildebrandt6c1fb0a2020-11-25 15:41:01 +0000220 } else {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000221 logger.Errorw(ctx, "unknown-onu-ind-request operState", log.Fields{"OnuId": onuIndication.GetOnuId()})
Holger Hildebrandt6c1fb0a2020-11-25 15:41:01 +0000222 return fmt.Errorf("invalidOperState: %s, %s", onuOperstate, targetDevice)
223 }
224 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000225 logger.Warnw(ctx, "no handler found for received onu-ind-request", log.Fields{
Holger Hildebrandt6c1fb0a2020-11-25 15:41:01 +0000226 "msgToDeviceId": targetDevice})
227 return fmt.Errorf(fmt.Sprintf("handler-not-found-%s", targetDevice))
228}
229
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000230// Adapter interface required methods ############## begin #########
231// #################################################################
232
233// for original content compare: (needs according deviceHandler methods)
234// /voltha-openolt-adapter/adaptercore/openolt.go
235
236// Adopt_device creates a new device handler if not present already and then adopts the device
dbainbri4d3a0dc2020-12-02 00:33:42 +0000237func (oo *OpenONUAC) Adopt_device(ctx context.Context, device *voltha.Device) error {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000238 if device == nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000239 logger.Warn(ctx, "voltha-device-is-nil")
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000240 return errors.New("nil-device")
241 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000242 logger.Infow(ctx, "adopt-device", log.Fields{"device-id": device.Id})
Himani Chawla6d2ae152020-09-02 13:11:20 +0530243 var handler *deviceHandler
dbainbri4d3a0dc2020-12-02 00:33:42 +0000244 if handler = oo.getDeviceHandler(ctx, device.Id, false); handler == nil {
245 handler := newDeviceHandler(ctx, oo.coreProxy, oo.adapterProxy, oo.eventProxy, device, oo)
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000246 oo.addDeviceHandlerToMap(ctx, handler)
Himani Chawla6d2ae152020-09-02 13:11:20 +0530247 go handler.adoptOrReconcileDevice(ctx, device)
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000248 // Launch the creation of the device topic
249 // go oo.createDeviceTopic(device)
250 }
251 return nil
252}
253
254//Get_ofp_device_info returns OFP information for the given device
dbainbri4d3a0dc2020-12-02 00:33:42 +0000255func (oo *OpenONUAC) Get_ofp_device_info(ctx context.Context, device *voltha.Device) (*ic.SwitchCapability, error) {
256 logger.Errorw(ctx, "device-handler-not-set", log.Fields{"device-id": device.Id})
Andrea Campanella6515c582020-10-05 11:25:00 +0200257 return nil, fmt.Errorf("device-handler-not-set %s", device.Id)
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000258}
259
260//Get_ofp_port_info returns OFP port information for the given device
mpagenkoaf801632020-07-03 10:00:42 +0000261//200630: method removed as per [VOL-3202]: OF port info is now to be delivered within UniPort create
262// cmp changes in onu_uni_port.go::CreateVolthaPort()
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000263
264//Process_inter_adapter_message sends messages to a target device (between adapters)
dbainbri4d3a0dc2020-12-02 00:33:42 +0000265func (oo *OpenONUAC) Process_inter_adapter_message(ctx context.Context, msg *ic.InterAdapterMessage) error {
266 logger.Debugw(ctx, "Process_inter_adapter_message", log.Fields{"msgId": msg.Header.Id,
Holger Hildebrandt80129db2020-11-23 10:49:32 +0000267 "msgProxyDeviceId": msg.Header.ProxyDeviceId, "msgToDeviceId": msg.Header.ToDeviceId, "Type": msg.Header.Type})
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000268
Holger Hildebrandt6c1fb0a2020-11-25 15:41:01 +0000269 if msg.Header.Type == ic.InterAdapterMessageType_ONU_IND_REQUEST {
270 // we have to handle ONU_IND_REQUEST already here - see comments in processInterAdapterONUIndReqMessage()
dbainbri4d3a0dc2020-12-02 00:33:42 +0000271 return oo.processInterAdapterONUIndReqMessage(ctx, msg)
Holger Hildebrandt6c1fb0a2020-11-25 15:41:01 +0000272 }
Holger Hildebrandtf07b44a2020-11-10 13:07:54 +0000273 //ToDeviceId should address a DeviceHandler instance
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000274 targetDevice := msg.Header.ToDeviceId
dbainbri4d3a0dc2020-12-02 00:33:42 +0000275 if handler := oo.getDeviceHandler(ctx, targetDevice, false); handler != nil {
mpagenko1cc3cb42020-07-27 15:24:38 +0000276 /* 200724: modification towards synchronous implementation - possible errors within processing shall be
277 * in the accordingly delayed response, some timing effect might result in Techprofile processing for multiple UNI's
278 */
dbainbri4d3a0dc2020-12-02 00:33:42 +0000279 return handler.processInterAdapterMessage(ctx, msg)
mpagenko1cc3cb42020-07-27 15:24:38 +0000280 /* so far the processing has been in background with according commented error treatment restrictions:
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000281 go handler.ProcessInterAdapterMessage(msg)
282 // error treatment might be more sophisticated
283 // by now let's just accept the message on 'communication layer'
284 // message content problems have to be evaluated then in the handler
285 // and are by now not reported to the calling party (to force what reaction there?)
286 return nil
mpagenko1cc3cb42020-07-27 15:24:38 +0000287 */
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000288 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000289 logger.Warnw(ctx, "no handler found for received Inter-Proxy-message", log.Fields{
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000290 "msgToDeviceId": targetDevice})
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000291 return fmt.Errorf(fmt.Sprintf("handler-not-found-%s", targetDevice))
292}
293
294//Adapter_descriptor not implemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000295func (oo *OpenONUAC) Adapter_descriptor(ctx context.Context) error {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000296 return errors.New("unImplemented")
297}
298
299//Device_types unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000300func (oo *OpenONUAC) Device_types(ctx context.Context) (*voltha.DeviceTypes, error) {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000301 return nil, errors.New("unImplemented")
302}
303
304//Health returns unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000305func (oo *OpenONUAC) Health(ctx context.Context) (*voltha.HealthStatus, error) {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000306 return nil, errors.New("unImplemented")
307}
308
Holger Hildebrandt9ca8b132020-08-07 14:45:03 +0000309//Reconcile_device is called once when the adapter needs to re-create device - usually on core restart
dbainbri4d3a0dc2020-12-02 00:33:42 +0000310func (oo *OpenONUAC) Reconcile_device(ctx context.Context, device *voltha.Device) error {
Holger Hildebrandtf41a1602020-08-19 09:52:50 +0000311 if device == nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000312 logger.Warn(ctx, "reconcile-device-voltha-device-is-nil")
Holger Hildebrandtf41a1602020-08-19 09:52:50 +0000313 return errors.New("nil-device")
314 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000315 logger.Infow(ctx, "reconcile-device", log.Fields{"device-id": device.Id})
Himani Chawla6d2ae152020-09-02 13:11:20 +0530316 var handler *deviceHandler
dbainbri4d3a0dc2020-12-02 00:33:42 +0000317 if handler = oo.getDeviceHandler(ctx, device.Id, false); handler == nil {
318 handler := newDeviceHandler(ctx, oo.coreProxy, oo.adapterProxy, oo.eventProxy, device, oo)
Holger Hildebrandtf41a1602020-08-19 09:52:50 +0000319 oo.addDeviceHandlerToMap(ctx, handler)
320 handler.device = device
321 handler.reconciling = true
Himani Chawla6d2ae152020-09-02 13:11:20 +0530322 go handler.adoptOrReconcileDevice(ctx, handler.device)
Holger Hildebrandtf41a1602020-08-19 09:52:50 +0000323 // reconcilement will be continued after onu-device entry is added
Holger Hildebrandt9ca8b132020-08-07 14:45:03 +0000324 } else {
Holger Hildebrandtf41a1602020-08-19 09:52:50 +0000325 return fmt.Errorf(fmt.Sprintf("device-already-reconciled-or-active-%s", device.Id))
Holger Hildebrandt9ca8b132020-08-07 14:45:03 +0000326 }
327 return nil
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000328}
329
330//Abandon_device unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000331func (oo *OpenONUAC) Abandon_device(ctx context.Context, device *voltha.Device) error {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000332 return errors.New("unImplemented")
333}
334
335//Disable_device disables the given device
dbainbri4d3a0dc2020-12-02 00:33:42 +0000336func (oo *OpenONUAC) Disable_device(ctx context.Context, device *voltha.Device) error {
337 logger.Infow(ctx, "disable-device", log.Fields{"device-id": device.Id})
338 if handler := oo.getDeviceHandler(ctx, device.Id, false); handler != nil {
339 go handler.disableDevice(ctx, device)
ozgecanetsiafce57b12020-05-25 14:39:35 +0300340 return nil
341 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000342 logger.Warnw(ctx, "no handler found for device-disable", log.Fields{"device-id": device.Id})
ozgecanetsiafce57b12020-05-25 14:39:35 +0300343 return fmt.Errorf(fmt.Sprintf("handler-not-found-%s", device.Id))
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000344}
345
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000346//Reenable_device enables the onu device after disable
dbainbri4d3a0dc2020-12-02 00:33:42 +0000347func (oo *OpenONUAC) Reenable_device(ctx context.Context, device *voltha.Device) error {
348 logger.Infow(ctx, "reenable-device", log.Fields{"device-id": device.Id})
349 if handler := oo.getDeviceHandler(ctx, device.Id, false); handler != nil {
350 go handler.reEnableDevice(ctx, device)
ozgecanetsiafce57b12020-05-25 14:39:35 +0300351 return nil
352 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000353 logger.Warnw(ctx, "no handler found for device-reenable", log.Fields{"device-id": device.Id})
ozgecanetsiafce57b12020-05-25 14:39:35 +0300354 return fmt.Errorf(fmt.Sprintf("handler-not-found-%s", device.Id))
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000355}
356
357//Reboot_device reboots the given device
dbainbri4d3a0dc2020-12-02 00:33:42 +0000358func (oo *OpenONUAC) Reboot_device(ctx context.Context, device *voltha.Device) error {
359 logger.Infow(ctx, "reboot-device", log.Fields{"device-id": device.Id})
360 if handler := oo.getDeviceHandler(ctx, device.Id, false); handler != nil {
361 go handler.rebootDevice(ctx, device)
ozgecanetsiae11479f2020-07-06 09:44:47 +0300362 return nil
363 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000364 logger.Warnw(ctx, "no handler found for device-reboot", log.Fields{"device-id": device.Id})
ozgecanetsiae11479f2020-07-06 09:44:47 +0300365 return fmt.Errorf(fmt.Sprintf("handler-not-found-#{device.Id}"))
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000366}
367
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000368//Self_test_device unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000369func (oo *OpenONUAC) Self_test_device(ctx context.Context, device *voltha.Device) error {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000370 return errors.New("unImplemented")
371}
372
Himani Chawla6d2ae152020-09-02 13:11:20 +0530373// Delete_device deletes the given device
dbainbri4d3a0dc2020-12-02 00:33:42 +0000374func (oo *OpenONUAC) Delete_device(ctx context.Context, device *voltha.Device) error {
375 logger.Infow(ctx, "delete-device", log.Fields{"device-id": device.Id, "SerialNumber": device.SerialNumber})
376 if handler := oo.getDeviceHandler(ctx, device.Id, false); handler != nil {
377 err := handler.deleteDevicePersistencyData(ctx)
Holger Hildebrandtf07b44a2020-11-10 13:07:54 +0000378 //don't leave any garbage - even in error case
379 oo.deleteDeviceHandlerToMap(handler)
mpagenko2418ab02020-11-12 12:58:06 +0000380 return err
Holger Hildebrandt9ca8b132020-08-07 14:45:03 +0000381 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000382 logger.Warnw(ctx, "no handler found for device-deletion", log.Fields{"device-id": device.Id})
mpagenko2418ab02020-11-12 12:58:06 +0000383 return fmt.Errorf(fmt.Sprintf("handler-not-found-%s", device.Id))
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000384}
385
386//Get_device_details unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000387func (oo *OpenONUAC) Get_device_details(ctx context.Context, device *voltha.Device) error {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000388 return errors.New("unImplemented")
389}
390
391//Update_flows_bulk returns
dbainbri4d3a0dc2020-12-02 00:33:42 +0000392func (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 +0000393 return errors.New("unImplemented")
394}
395
396//Update_flows_incrementally updates (add/remove) the flows on a given device
dbainbri4d3a0dc2020-12-02 00:33:42 +0000397func (oo *OpenONUAC) Update_flows_incrementally(ctx context.Context, device *voltha.Device,
mpagenkodff5dda2020-08-28 11:52:01 +0000398 flows *openflow_13.FlowChanges, groups *openflow_13.FlowGroupChanges, flowMetadata *voltha.FlowMetadata) error {
mpagenkofc4f56e2020-11-04 17:17:49 +0000399
dbainbri4d3a0dc2020-12-02 00:33:42 +0000400 logger.Infow(ctx, "update-flows-incrementally", log.Fields{"device-id": device.Id})
mpagenkofc4f56e2020-11-04 17:17:49 +0000401 //flow config is relayed to handler even if the device might be in some 'inactive' state
402 // let the handler or related FSM's decide, what to do with the modified flow state info
403 // 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 +0000404
405 // For now, there is no support for group changes (as in the actual Py-adapter code)
mpagenkofc4f56e2020-11-04 17:17:49 +0000406 // but processing is continued for flowUpdate possibly also set in the request
mpagenkodff5dda2020-08-28 11:52:01 +0000407 if groups.ToAdd != nil && groups.ToAdd.Items != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000408 logger.Warnw(ctx, "Update-flow-incr: group add not supported (ignored)", log.Fields{"device-id": device.Id})
mpagenkodff5dda2020-08-28 11:52:01 +0000409 }
410 if groups.ToRemove != nil && groups.ToRemove.Items != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000411 logger.Warnw(ctx, "Update-flow-incr: group remove not supported (ignored)", log.Fields{"device-id": device.Id})
mpagenkodff5dda2020-08-28 11:52:01 +0000412 }
413 if groups.ToUpdate != nil && groups.ToUpdate.Items != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000414 logger.Warnw(ctx, "Update-flow-incr: group update not supported (ignored)", log.Fields{"device-id": device.Id})
mpagenkodff5dda2020-08-28 11:52:01 +0000415 }
416
dbainbri4d3a0dc2020-12-02 00:33:42 +0000417 if handler := oo.getDeviceHandler(ctx, device.Id, false); handler != nil {
418 err := handler.FlowUpdateIncremental(ctx, flows, groups, flowMetadata)
mpagenkodff5dda2020-08-28 11:52:01 +0000419 return err
420 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000421 logger.Warnw(ctx, "no handler found for incremental flow update", log.Fields{"device-id": device.Id})
mpagenkodff5dda2020-08-28 11:52:01 +0000422 return fmt.Errorf(fmt.Sprintf("handler-not-found-%s", device.Id))
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000423}
424
425//Update_pm_config returns PmConfigs nil or error
dbainbri4d3a0dc2020-12-02 00:33:42 +0000426func (oo *OpenONUAC) Update_pm_config(ctx context.Context, device *voltha.Device, pmConfigs *voltha.PmConfigs) error {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000427 return errors.New("unImplemented")
428}
429
430//Receive_packet_out sends packet out to the device
dbainbri4d3a0dc2020-12-02 00:33:42 +0000431func (oo *OpenONUAC) Receive_packet_out(ctx context.Context, deviceID string, egressPortNo int, packet *openflow_13.OfpPacketOut) error {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000432 return errors.New("unImplemented")
433}
434
435//Suppress_event unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000436func (oo *OpenONUAC) Suppress_event(ctx context.Context, filter *voltha.EventFilter) error {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000437 return errors.New("unImplemented")
438}
439
440//Unsuppress_event unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000441func (oo *OpenONUAC) Unsuppress_event(ctx context.Context, filter *voltha.EventFilter) error {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000442 return errors.New("unImplemented")
443}
444
mpagenkoc8bba412021-01-15 15:38:44 +0000445//Download_image according to download image indications as given in apRequest
446func (oo *OpenONUAC) Download_image(ctx context.Context, device *voltha.Device, apRequest *voltha.ImageDownload) (*voltha.ImageDownload, error) {
447 if !oo.pDownloadManager.imageExists(ctx, apRequest) {
448 logger.Debugw(ctx, "start image download", log.Fields{"image-description": apRequest})
449 // Download_image is not supposed to be blocking, anyway let's call the DownloadManager still synchronously to detect 'fast' problems
450 // the download itself is later done in background
451 err := oo.pDownloadManager.startDownload(ctx, apRequest)
452 return apRequest, err
453 }
454 // image already exists
455 return apRequest, nil
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000456}
457
458//Get_image_download_status unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000459func (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 +0000460 return nil, errors.New("unImplemented")
461}
462
463//Cancel_image_download unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000464func (oo *OpenONUAC) Cancel_image_download(ctx context.Context, device *voltha.Device, request *voltha.ImageDownload) (*voltha.ImageDownload, error) {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000465 return nil, errors.New("unImplemented")
466}
467
468//Activate_image_update unimplemented
mpagenkoc8bba412021-01-15 15:38:44 +0000469func (oo *OpenONUAC) Activate_image_update(ctx context.Context, device *voltha.Device, apRequest *voltha.ImageDownload) (*voltha.ImageDownload, error) {
470 if handler := oo.getDeviceHandler(ctx, device.Id, false); handler != nil {
471 err := handler.doOnuSwUpgrade(ctx, apRequest)
472 return apRequest, err
473 }
474 logger.Warnw(ctx, "no handler found for Onu image activation", log.Fields{"device-id": device.Id})
475 return apRequest, fmt.Errorf(fmt.Sprintf("handler-not-found-%s", device.Id))
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000476}
477
478//Revert_image_update unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000479func (oo *OpenONUAC) Revert_image_update(ctx context.Context, device *voltha.Device, request *voltha.ImageDownload) (*voltha.ImageDownload, error) {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000480 return nil, errors.New("unImplemented")
481}
482
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000483// Enable_port to Enable PON/NNI interface - seems not to be used/required according to python code
dbainbri4d3a0dc2020-12-02 00:33:42 +0000484func (oo *OpenONUAC) Enable_port(ctx context.Context, deviceID string, port *voltha.Port) error {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000485 return errors.New("unImplemented")
486}
487
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000488// Disable_port to Disable pon/nni interface - seems not to be used/required according to python code
dbainbri4d3a0dc2020-12-02 00:33:42 +0000489func (oo *OpenONUAC) Disable_port(ctx context.Context, deviceID string, port *voltha.Port) error {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000490 return errors.New("unImplemented")
491}
492
Himani Chawla6d2ae152020-09-02 13:11:20 +0530493//Child_device_lost - unimplemented
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000494//needed for if update >= 3.1.x
dbainbri4d3a0dc2020-12-02 00:33:42 +0000495func (oo *OpenONUAC) Child_device_lost(ctx context.Context, deviceID string, pPortNo uint32, onuID uint32) error {
Matteo Scandolo2e6f1e32020-04-15 11:28:45 -0700496 return errors.New("unImplemented")
497}
498
Himani Chawla6d2ae152020-09-02 13:11:20 +0530499// Start_omci_test unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000500func (oo *OpenONUAC) Start_omci_test(ctx context.Context, device *voltha.Device, request *voltha.OmciTestRequest) (*voltha.TestResponse, error) {
Matteo Scandolo2e6f1e32020-04-15 11:28:45 -0700501 return nil, errors.New("unImplemented")
502}
503
Himani Chawla6d2ae152020-09-02 13:11:20 +0530504// Get_ext_value - unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000505func (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 -0700506 return nil, errors.New("unImplemented")
507}
508
mpagenkoc8bba412021-01-15 15:38:44 +0000509//Single_get_value_request as needed by voltha-lib-go update to 4.0.xx?
510func (oo *OpenONUAC) Single_get_value_request(ctx context.Context, request extension.SingleGetValueRequest) (*extension.SingleGetValueResponse, error) {
511 return nil, errors.New("unImplemented")
512}
513
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000514// Adapter interface required methods ################ end #########
515// #################################################################