blob: 9fcb4570e330c29988c748d0f3ca8f37b4972d37 [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"
32 "github.com/opencord/voltha-lib-go/v4/pkg/kafka"
33 "github.com/opencord/voltha-lib-go/v4/pkg/log"
34 ic "github.com/opencord/voltha-protos/v4/go/inter_container"
35 "github.com/opencord/voltha-protos/v4/go/openflow_13"
36 oop "github.com/opencord/voltha-protos/v4/go/openolt"
37 "github.com/opencord/voltha-protos/v4/go/voltha"
Holger Hildebrandtfa074992020-03-27 15:42:06 +000038
Matteo Scandolo761f7512020-11-23 15:52:40 -080039 "github.com/opencord/voltha-openonu-adapter-go/internal/pkg/config"
Holger Hildebrandtfa074992020-03-27 15:42:06 +000040)
41
42//OpenONUAC structure holds the ONU core information
43type OpenONUAC struct {
Himani Chawla6d2ae152020-09-02 13:11:20 +053044 deviceHandlers map[string]*deviceHandler
Holger Hildebrandtf07b44a2020-11-10 13:07:54 +000045 deviceHandlersCreateChan map[string]chan bool //channels for deviceHandler create events
Holger Hildebrandt61b24d02020-11-16 13:36:40 +000046 lockDeviceHandlersMap sync.RWMutex
Holger Hildebrandtfa074992020-03-27 15:42:06 +000047 coreProxy adapterif.CoreProxy
48 adapterProxy adapterif.AdapterProxy
49 eventProxy adapterif.EventProxy
50 kafkaICProxy kafka.InterContainerProxy
mpagenkoaf801632020-07-03 10:00:42 +000051 kvClient kvstore.Client
Matteo Scandolof1f39a72020-11-24 12:08:11 -080052 cm *conf.ConfigManager
Holger Hildebrandtfa074992020-03-27 15:42:06 +000053 config *config.AdapterFlags
54 numOnus int
55 KVStoreHost string
56 KVStorePort int
57 KVStoreType string
mpagenkoaf801632020-07-03 10:00:42 +000058 KVStoreTimeout time.Duration
Holger Hildebrandt61b24d02020-11-16 13:36:40 +000059 mibTemplatesGenerated map[string]bool
60 lockMibTemplateGenerated sync.RWMutex
Holger Hildebrandtfa074992020-03-27 15:42:06 +000061 exitChannel chan int
62 HeartbeatCheckInterval time.Duration
63 HeartbeatFailReportInterval time.Duration
mpagenkodff5dda2020-08-28 11:52:01 +000064 AcceptIncrementalEvto bool
Holger Hildebrandtfa074992020-03-27 15:42:06 +000065 //GrpcTimeoutInterval time.Duration
Himani Chawlad96df182020-09-28 11:12:02 +053066 pSupportedFsms *OmciDeviceFsms
67 maxTimeoutInterAdapterComm time.Duration
Holger Hildebrandtfa074992020-03-27 15:42:06 +000068}
69
70//NewOpenONUAC returns a new instance of OpenONU_AC
71func NewOpenONUAC(ctx context.Context, kafkaICProxy kafka.InterContainerProxy,
72 coreProxy adapterif.CoreProxy, adapterProxy adapterif.AdapterProxy,
Matteo Scandolof1f39a72020-11-24 12:08:11 -080073 eventProxy adapterif.EventProxy, kvClient kvstore.Client, cfg *config.AdapterFlags, cm *conf.ConfigManager) *OpenONUAC {
Holger Hildebrandtfa074992020-03-27 15:42:06 +000074 var openOnuAc OpenONUAC
75 openOnuAc.exitChannel = make(chan int, 1)
Himani Chawla6d2ae152020-09-02 13:11:20 +053076 openOnuAc.deviceHandlers = make(map[string]*deviceHandler)
Holger Hildebrandtf07b44a2020-11-10 13:07:54 +000077 openOnuAc.deviceHandlersCreateChan = make(map[string]chan bool)
Holger Hildebrandt61b24d02020-11-16 13:36:40 +000078 openOnuAc.lockDeviceHandlersMap = sync.RWMutex{}
Holger Hildebrandtfa074992020-03-27 15:42:06 +000079 openOnuAc.kafkaICProxy = kafkaICProxy
80 openOnuAc.config = cfg
Matteo Scandolof1f39a72020-11-24 12:08:11 -080081 openOnuAc.cm = cm
Holger Hildebrandtfa074992020-03-27 15:42:06 +000082 openOnuAc.numOnus = cfg.OnuNumber
83 openOnuAc.coreProxy = coreProxy
84 openOnuAc.adapterProxy = adapterProxy
85 openOnuAc.eventProxy = eventProxy
mpagenkoaf801632020-07-03 10:00:42 +000086 openOnuAc.kvClient = kvClient
Holger Hildebrandtfa074992020-03-27 15:42:06 +000087 openOnuAc.KVStoreHost = cfg.KVStoreHost
88 openOnuAc.KVStorePort = cfg.KVStorePort
89 openOnuAc.KVStoreType = cfg.KVStoreType
mpagenkoaf801632020-07-03 10:00:42 +000090 openOnuAc.KVStoreTimeout = cfg.KVStoreTimeout
Holger Hildebrandt61b24d02020-11-16 13:36:40 +000091 openOnuAc.mibTemplatesGenerated = make(map[string]bool)
92 openOnuAc.lockMibTemplateGenerated = sync.RWMutex{}
Holger Hildebrandtfa074992020-03-27 15:42:06 +000093 openOnuAc.HeartbeatCheckInterval = cfg.HeartbeatCheckInterval
94 openOnuAc.HeartbeatFailReportInterval = cfg.HeartbeatFailReportInterval
mpagenkodff5dda2020-08-28 11:52:01 +000095 openOnuAc.AcceptIncrementalEvto = cfg.AccIncrEvto
Himani Chawlad96df182020-09-28 11:12:02 +053096 openOnuAc.maxTimeoutInterAdapterComm = cfg.MaxTimeoutInterAdapterComm
Holger Hildebrandtfa074992020-03-27 15:42:06 +000097 //openOnuAc.GrpcTimeoutInterval = cfg.GrpcTimeoutInterval
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +000098
99 openOnuAc.pSupportedFsms = &OmciDeviceFsms{
100 "mib-synchronizer": {
101 //mibSyncFsm, // Implements the MIB synchronization state machine
Himani Chawla6d2ae152020-09-02 13:11:20 +0530102 mibDbVolatileDictImpl, // Implements volatile ME MIB database
Himani Chawla4d908332020-08-31 12:30:20 +0530103 //true, // Advertise events on OpenOMCI event bus
104 cMibAuditDelayImpl, // Time to wait between MIB audits. 0 to disable audits.
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000105 // map[string]func() error{
106 // "mib-upload": onuDeviceEntry.MibUploadTask,
107 // "mib-template": onuDeviceEntry.MibTemplateTask,
108 // "get-mds": onuDeviceEntry.GetMdsTask,
109 // "mib-audit": onuDeviceEntry.GetMdsTask,
110 // "mib-resync": onuDeviceEntry.MibResyncTask,
111 // "mib-reconcile": onuDeviceEntry.MibReconcileTask,
112 // },
113 },
114 }
115
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000116 return &openOnuAc
117}
118
119//Start starts (logs) the adapter
120func (oo *OpenONUAC) Start(ctx context.Context) error {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000121 logger.Info(ctx, "starting-openonu-adapter")
122 logger.Info(ctx, "openonu-adapter-started")
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000123 return nil
124}
125
Himani Chawla6d2ae152020-09-02 13:11:20 +0530126/*
127//stop terminates the session
128func (oo *OpenONUAC) stop(ctx context.Context) error {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000129 logger.Info(ctx,"stopping-device-manager")
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000130 oo.exitChannel <- 1
dbainbri4d3a0dc2020-12-02 00:33:42 +0000131 logger.Info(ctx,"device-manager-stopped")
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000132 return nil
133}
Himani Chawla6d2ae152020-09-02 13:11:20 +0530134*/
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000135
Himani Chawla6d2ae152020-09-02 13:11:20 +0530136func (oo *OpenONUAC) addDeviceHandlerToMap(ctx context.Context, agent *deviceHandler) {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000137 oo.lockDeviceHandlersMap.Lock()
138 defer oo.lockDeviceHandlersMap.Unlock()
139 if _, exist := oo.deviceHandlers[agent.deviceID]; !exist {
140 oo.deviceHandlers[agent.deviceID] = agent
Himani Chawla6d2ae152020-09-02 13:11:20 +0530141 oo.deviceHandlers[agent.deviceID].start(ctx)
Holger Hildebrandtf07b44a2020-11-10 13:07:54 +0000142 if _, exist := oo.deviceHandlersCreateChan[agent.deviceID]; exist {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000143 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 +0000144 oo.deviceHandlersCreateChan[agent.deviceID] <- true
145 }
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000146 }
147}
148
Himani Chawla6d2ae152020-09-02 13:11:20 +0530149func (oo *OpenONUAC) deleteDeviceHandlerToMap(agent *deviceHandler) {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000150 oo.lockDeviceHandlersMap.Lock()
151 defer oo.lockDeviceHandlersMap.Unlock()
152 delete(oo.deviceHandlers, agent.deviceID)
Holger Hildebrandtf07b44a2020-11-10 13:07:54 +0000153 delete(oo.deviceHandlersCreateChan, agent.deviceID)
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000154}
155
Holger Hildebrandtf07b44a2020-11-10 13:07:54 +0000156//getDeviceHandler gets the ONU deviceHandler and may wait until it is created
dbainbri4d3a0dc2020-12-02 00:33:42 +0000157func (oo *OpenONUAC) getDeviceHandler(ctx context.Context, deviceID string, aWait bool) *deviceHandler {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000158 oo.lockDeviceHandlersMap.Lock()
Holger Hildebrandtf07b44a2020-11-10 13:07:54 +0000159 agent, ok := oo.deviceHandlers[deviceID]
160 if aWait && !ok {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000161 logger.Infow(ctx, "Race condition: deviceHandler not present - wait for creation or timeout",
Holger Hildebrandt6c1fb0a2020-11-25 15:41:01 +0000162 log.Fields{"device-id": deviceID})
Holger Hildebrandtf07b44a2020-11-10 13:07:54 +0000163 if _, exist := oo.deviceHandlersCreateChan[deviceID]; !exist {
164 oo.deviceHandlersCreateChan[deviceID] = make(chan bool, 1)
165 }
Girish Gowdra7407a4d2020-11-12 12:44:53 -0800166 deviceCreateChan := oo.deviceHandlersCreateChan[deviceID]
Holger Hildebrandtf07b44a2020-11-10 13:07:54 +0000167 //keep the read sema short to allow for subsequent write
168 oo.lockDeviceHandlersMap.Unlock()
169 // based on concurrent processing the deviceHandler creation may not yet be finished at his point
170 // so it might be needed to wait here for that event with some timeout
171 select {
172 case <-time.After(1 * time.Second): //timer may be discussed ...
dbainbri4d3a0dc2020-12-02 00:33:42 +0000173 logger.Warnw(ctx, "No valid deviceHandler created after max WaitTime", log.Fields{"device-id": deviceID})
Holger Hildebrandtf07b44a2020-11-10 13:07:54 +0000174 return nil
Girish Gowdra7407a4d2020-11-12 12:44:53 -0800175 case <-deviceCreateChan:
dbainbri4d3a0dc2020-12-02 00:33:42 +0000176 logger.Debugw(ctx, "deviceHandler is ready now - continue", log.Fields{"device-id": deviceID})
Girish Gowdra7407a4d2020-11-12 12:44:53 -0800177 oo.lockDeviceHandlersMap.RLock()
178 defer oo.lockDeviceHandlersMap.RUnlock()
Holger Hildebrandtf07b44a2020-11-10 13:07:54 +0000179 return oo.deviceHandlers[deviceID]
180 }
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000181 }
Holger Hildebrandtf07b44a2020-11-10 13:07:54 +0000182 oo.lockDeviceHandlersMap.Unlock()
183 return agent
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000184}
185
dbainbri4d3a0dc2020-12-02 00:33:42 +0000186func (oo *OpenONUAC) processInterAdapterONUIndReqMessage(ctx context.Context, msg *ic.InterAdapterMessage) error {
Holger Hildebrandt6c1fb0a2020-11-25 15:41:01 +0000187 msgBody := msg.GetBody()
188 onuIndication := &oop.OnuIndication{}
189 if err := ptypes.UnmarshalAny(msgBody, onuIndication); err != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000190 logger.Warnw(ctx, "onu-ind-request-cannot-unmarshal-msg-body", log.Fields{"error": err})
Holger Hildebrandt6c1fb0a2020-11-25 15:41:01 +0000191 return err
192 }
193 //ToDeviceId should address a DeviceHandler instance
194 targetDevice := msg.Header.ToDeviceId
195
196 onuOperstate := onuIndication.GetOperState()
197 waitForDhInstPresent := false
198 if onuOperstate == "up" {
199 //Race condition (relevant in BBSIM-environment only): Due to unsynchronized processing of olt-adapter and rw_core,
200 //ONU_IND_REQUEST msg by olt-adapter could arrive a little bit earlier than rw_core was able to announce the corresponding
201 //ONU by RPC of Adopt_device(). Therefore it could be necessary to wait with processing of ONU_IND_REQUEST until call of
202 //Adopt_device() arrived and DeviceHandler instance was created
203 waitForDhInstPresent = true
204 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000205 if handler := oo.getDeviceHandler(ctx, targetDevice, waitForDhInstPresent); handler != nil {
206 logger.Infow(ctx, "onu-ind-request", log.Fields{"device-id": targetDevice,
Holger Hildebrandt6c1fb0a2020-11-25 15:41:01 +0000207 "OnuId": onuIndication.GetOnuId(),
208 "AdminState": onuIndication.GetAdminState(), "OperState": onuOperstate,
209 "SNR": onuIndication.GetSerialNumber()})
210
211 if onuOperstate == "up" {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000212 return handler.createInterface(ctx, onuIndication)
Holger Hildebrandt6c1fb0a2020-11-25 15:41:01 +0000213 } else if (onuOperstate == "down") || (onuOperstate == "unreachable") {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000214 return handler.updateInterface(ctx, onuIndication)
Holger Hildebrandt6c1fb0a2020-11-25 15:41:01 +0000215 } else {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000216 logger.Errorw(ctx, "unknown-onu-ind-request operState", log.Fields{"OnuId": onuIndication.GetOnuId()})
Holger Hildebrandt6c1fb0a2020-11-25 15:41:01 +0000217 return fmt.Errorf("invalidOperState: %s, %s", onuOperstate, targetDevice)
218 }
219 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000220 logger.Warnw(ctx, "no handler found for received onu-ind-request", log.Fields{
Holger Hildebrandt6c1fb0a2020-11-25 15:41:01 +0000221 "msgToDeviceId": targetDevice})
222 return fmt.Errorf(fmt.Sprintf("handler-not-found-%s", targetDevice))
223}
224
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000225// Adapter interface required methods ############## begin #########
226// #################################################################
227
228// for original content compare: (needs according deviceHandler methods)
229// /voltha-openolt-adapter/adaptercore/openolt.go
230
231// Adopt_device creates a new device handler if not present already and then adopts the device
dbainbri4d3a0dc2020-12-02 00:33:42 +0000232func (oo *OpenONUAC) Adopt_device(ctx context.Context, device *voltha.Device) error {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000233 if device == nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000234 logger.Warn(ctx, "voltha-device-is-nil")
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000235 return errors.New("nil-device")
236 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000237 logger.Infow(ctx, "adopt-device", log.Fields{"device-id": device.Id})
Himani Chawla6d2ae152020-09-02 13:11:20 +0530238 var handler *deviceHandler
dbainbri4d3a0dc2020-12-02 00:33:42 +0000239 if handler = oo.getDeviceHandler(ctx, device.Id, false); handler == nil {
240 handler := newDeviceHandler(ctx, oo.coreProxy, oo.adapterProxy, oo.eventProxy, device, oo)
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000241 oo.addDeviceHandlerToMap(ctx, handler)
Himani Chawla6d2ae152020-09-02 13:11:20 +0530242 go handler.adoptOrReconcileDevice(ctx, device)
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000243 // Launch the creation of the device topic
244 // go oo.createDeviceTopic(device)
245 }
246 return nil
247}
248
249//Get_ofp_device_info returns OFP information for the given device
dbainbri4d3a0dc2020-12-02 00:33:42 +0000250func (oo *OpenONUAC) Get_ofp_device_info(ctx context.Context, device *voltha.Device) (*ic.SwitchCapability, error) {
251 logger.Errorw(ctx, "device-handler-not-set", log.Fields{"device-id": device.Id})
Andrea Campanella6515c582020-10-05 11:25:00 +0200252 return nil, fmt.Errorf("device-handler-not-set %s", device.Id)
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000253}
254
255//Get_ofp_port_info returns OFP port information for the given device
mpagenkoaf801632020-07-03 10:00:42 +0000256//200630: method removed as per [VOL-3202]: OF port info is now to be delivered within UniPort create
257// cmp changes in onu_uni_port.go::CreateVolthaPort()
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000258
259//Process_inter_adapter_message sends messages to a target device (between adapters)
dbainbri4d3a0dc2020-12-02 00:33:42 +0000260func (oo *OpenONUAC) Process_inter_adapter_message(ctx context.Context, msg *ic.InterAdapterMessage) error {
261 logger.Debugw(ctx, "Process_inter_adapter_message", log.Fields{"msgId": msg.Header.Id,
Holger Hildebrandt80129db2020-11-23 10:49:32 +0000262 "msgProxyDeviceId": msg.Header.ProxyDeviceId, "msgToDeviceId": msg.Header.ToDeviceId, "Type": msg.Header.Type})
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000263
Holger Hildebrandt6c1fb0a2020-11-25 15:41:01 +0000264 if msg.Header.Type == ic.InterAdapterMessageType_ONU_IND_REQUEST {
265 // we have to handle ONU_IND_REQUEST already here - see comments in processInterAdapterONUIndReqMessage()
dbainbri4d3a0dc2020-12-02 00:33:42 +0000266 return oo.processInterAdapterONUIndReqMessage(ctx, msg)
Holger Hildebrandt6c1fb0a2020-11-25 15:41:01 +0000267 }
Holger Hildebrandtf07b44a2020-11-10 13:07:54 +0000268 //ToDeviceId should address a DeviceHandler instance
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000269 targetDevice := msg.Header.ToDeviceId
dbainbri4d3a0dc2020-12-02 00:33:42 +0000270 if handler := oo.getDeviceHandler(ctx, targetDevice, false); handler != nil {
mpagenko1cc3cb42020-07-27 15:24:38 +0000271 /* 200724: modification towards synchronous implementation - possible errors within processing shall be
272 * in the accordingly delayed response, some timing effect might result in Techprofile processing for multiple UNI's
273 */
dbainbri4d3a0dc2020-12-02 00:33:42 +0000274 return handler.processInterAdapterMessage(ctx, msg)
mpagenko1cc3cb42020-07-27 15:24:38 +0000275 /* so far the processing has been in background with according commented error treatment restrictions:
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000276 go handler.ProcessInterAdapterMessage(msg)
277 // error treatment might be more sophisticated
278 // by now let's just accept the message on 'communication layer'
279 // message content problems have to be evaluated then in the handler
280 // and are by now not reported to the calling party (to force what reaction there?)
281 return nil
mpagenko1cc3cb42020-07-27 15:24:38 +0000282 */
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000283 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000284 logger.Warnw(ctx, "no handler found for received Inter-Proxy-message", log.Fields{
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000285 "msgToDeviceId": targetDevice})
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000286 return fmt.Errorf(fmt.Sprintf("handler-not-found-%s", targetDevice))
287}
288
289//Adapter_descriptor not implemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000290func (oo *OpenONUAC) Adapter_descriptor(ctx context.Context) error {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000291 return errors.New("unImplemented")
292}
293
294//Device_types unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000295func (oo *OpenONUAC) Device_types(ctx context.Context) (*voltha.DeviceTypes, error) {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000296 return nil, errors.New("unImplemented")
297}
298
299//Health returns unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000300func (oo *OpenONUAC) Health(ctx context.Context) (*voltha.HealthStatus, error) {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000301 return nil, errors.New("unImplemented")
302}
303
Holger Hildebrandt9ca8b132020-08-07 14:45:03 +0000304//Reconcile_device is called once when the adapter needs to re-create device - usually on core restart
dbainbri4d3a0dc2020-12-02 00:33:42 +0000305func (oo *OpenONUAC) Reconcile_device(ctx context.Context, device *voltha.Device) error {
Holger Hildebrandtf41a1602020-08-19 09:52:50 +0000306 if device == nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000307 logger.Warn(ctx, "reconcile-device-voltha-device-is-nil")
Holger Hildebrandtf41a1602020-08-19 09:52:50 +0000308 return errors.New("nil-device")
309 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000310 logger.Infow(ctx, "reconcile-device", log.Fields{"device-id": device.Id})
Himani Chawla6d2ae152020-09-02 13:11:20 +0530311 var handler *deviceHandler
dbainbri4d3a0dc2020-12-02 00:33:42 +0000312 if handler = oo.getDeviceHandler(ctx, device.Id, false); handler == nil {
313 handler := newDeviceHandler(ctx, oo.coreProxy, oo.adapterProxy, oo.eventProxy, device, oo)
Holger Hildebrandtf41a1602020-08-19 09:52:50 +0000314 oo.addDeviceHandlerToMap(ctx, handler)
315 handler.device = device
316 handler.reconciling = true
Himani Chawla6d2ae152020-09-02 13:11:20 +0530317 go handler.adoptOrReconcileDevice(ctx, handler.device)
Holger Hildebrandtf41a1602020-08-19 09:52:50 +0000318 // reconcilement will be continued after onu-device entry is added
Holger Hildebrandt9ca8b132020-08-07 14:45:03 +0000319 } else {
Holger Hildebrandtf41a1602020-08-19 09:52:50 +0000320 return fmt.Errorf(fmt.Sprintf("device-already-reconciled-or-active-%s", device.Id))
Holger Hildebrandt9ca8b132020-08-07 14:45:03 +0000321 }
322 return nil
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000323}
324
325//Abandon_device unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000326func (oo *OpenONUAC) Abandon_device(ctx context.Context, device *voltha.Device) error {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000327 return errors.New("unImplemented")
328}
329
330//Disable_device disables the given device
dbainbri4d3a0dc2020-12-02 00:33:42 +0000331func (oo *OpenONUAC) Disable_device(ctx context.Context, device *voltha.Device) error {
332 logger.Infow(ctx, "disable-device", log.Fields{"device-id": device.Id})
333 if handler := oo.getDeviceHandler(ctx, device.Id, false); handler != nil {
334 go handler.disableDevice(ctx, device)
ozgecanetsiafce57b12020-05-25 14:39:35 +0300335 return nil
336 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000337 logger.Warnw(ctx, "no handler found for device-disable", log.Fields{"device-id": device.Id})
ozgecanetsiafce57b12020-05-25 14:39:35 +0300338 return fmt.Errorf(fmt.Sprintf("handler-not-found-%s", device.Id))
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000339}
340
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000341//Reenable_device enables the onu device after disable
dbainbri4d3a0dc2020-12-02 00:33:42 +0000342func (oo *OpenONUAC) Reenable_device(ctx context.Context, device *voltha.Device) error {
343 logger.Infow(ctx, "reenable-device", log.Fields{"device-id": device.Id})
344 if handler := oo.getDeviceHandler(ctx, device.Id, false); handler != nil {
345 go handler.reEnableDevice(ctx, device)
ozgecanetsiafce57b12020-05-25 14:39:35 +0300346 return nil
347 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000348 logger.Warnw(ctx, "no handler found for device-reenable", log.Fields{"device-id": device.Id})
ozgecanetsiafce57b12020-05-25 14:39:35 +0300349 return fmt.Errorf(fmt.Sprintf("handler-not-found-%s", device.Id))
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000350}
351
352//Reboot_device reboots the given device
dbainbri4d3a0dc2020-12-02 00:33:42 +0000353func (oo *OpenONUAC) Reboot_device(ctx context.Context, device *voltha.Device) error {
354 logger.Infow(ctx, "reboot-device", log.Fields{"device-id": device.Id})
355 if handler := oo.getDeviceHandler(ctx, device.Id, false); handler != nil {
356 go handler.rebootDevice(ctx, device)
ozgecanetsiae11479f2020-07-06 09:44:47 +0300357 return nil
358 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000359 logger.Warnw(ctx, "no handler found for device-reboot", log.Fields{"device-id": device.Id})
ozgecanetsiae11479f2020-07-06 09:44:47 +0300360 return fmt.Errorf(fmt.Sprintf("handler-not-found-#{device.Id}"))
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000361}
362
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000363//Self_test_device unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000364func (oo *OpenONUAC) Self_test_device(ctx context.Context, device *voltha.Device) error {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000365 return errors.New("unImplemented")
366}
367
Himani Chawla6d2ae152020-09-02 13:11:20 +0530368// Delete_device deletes the given device
dbainbri4d3a0dc2020-12-02 00:33:42 +0000369func (oo *OpenONUAC) Delete_device(ctx context.Context, device *voltha.Device) error {
370 logger.Infow(ctx, "delete-device", log.Fields{"device-id": device.Id, "SerialNumber": device.SerialNumber})
371 if handler := oo.getDeviceHandler(ctx, device.Id, false); handler != nil {
372 err := handler.deleteDevicePersistencyData(ctx)
Holger Hildebrandtf07b44a2020-11-10 13:07:54 +0000373 //don't leave any garbage - even in error case
374 oo.deleteDeviceHandlerToMap(handler)
mpagenko2418ab02020-11-12 12:58:06 +0000375 return err
Holger Hildebrandt9ca8b132020-08-07 14:45:03 +0000376 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000377 logger.Warnw(ctx, "no handler found for device-deletion", log.Fields{"device-id": device.Id})
mpagenko2418ab02020-11-12 12:58:06 +0000378 return fmt.Errorf(fmt.Sprintf("handler-not-found-%s", device.Id))
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000379}
380
381//Get_device_details unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000382func (oo *OpenONUAC) Get_device_details(ctx context.Context, device *voltha.Device) error {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000383 return errors.New("unImplemented")
384}
385
386//Update_flows_bulk returns
dbainbri4d3a0dc2020-12-02 00:33:42 +0000387func (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 +0000388 return errors.New("unImplemented")
389}
390
391//Update_flows_incrementally updates (add/remove) the flows on a given device
dbainbri4d3a0dc2020-12-02 00:33:42 +0000392func (oo *OpenONUAC) Update_flows_incrementally(ctx context.Context, device *voltha.Device,
mpagenkodff5dda2020-08-28 11:52:01 +0000393 flows *openflow_13.FlowChanges, groups *openflow_13.FlowGroupChanges, flowMetadata *voltha.FlowMetadata) error {
mpagenkofc4f56e2020-11-04 17:17:49 +0000394
dbainbri4d3a0dc2020-12-02 00:33:42 +0000395 logger.Infow(ctx, "update-flows-incrementally", log.Fields{"device-id": device.Id})
mpagenkofc4f56e2020-11-04 17:17:49 +0000396 //flow config is relayed to handler even if the device might be in some 'inactive' state
397 // let the handler or related FSM's decide, what to do with the modified flow state info
398 // 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 +0000399
400 // For now, there is no support for group changes (as in the actual Py-adapter code)
mpagenkofc4f56e2020-11-04 17:17:49 +0000401 // but processing is continued for flowUpdate possibly also set in the request
mpagenkodff5dda2020-08-28 11:52:01 +0000402 if groups.ToAdd != nil && groups.ToAdd.Items != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000403 logger.Warnw(ctx, "Update-flow-incr: group add not supported (ignored)", log.Fields{"device-id": device.Id})
mpagenkodff5dda2020-08-28 11:52:01 +0000404 }
405 if groups.ToRemove != nil && groups.ToRemove.Items != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000406 logger.Warnw(ctx, "Update-flow-incr: group remove not supported (ignored)", log.Fields{"device-id": device.Id})
mpagenkodff5dda2020-08-28 11:52:01 +0000407 }
408 if groups.ToUpdate != nil && groups.ToUpdate.Items != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000409 logger.Warnw(ctx, "Update-flow-incr: group update not supported (ignored)", log.Fields{"device-id": device.Id})
mpagenkodff5dda2020-08-28 11:52:01 +0000410 }
411
dbainbri4d3a0dc2020-12-02 00:33:42 +0000412 if handler := oo.getDeviceHandler(ctx, device.Id, false); handler != nil {
413 err := handler.FlowUpdateIncremental(ctx, flows, groups, flowMetadata)
mpagenkodff5dda2020-08-28 11:52:01 +0000414 return err
415 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000416 logger.Warnw(ctx, "no handler found for incremental flow update", log.Fields{"device-id": device.Id})
mpagenkodff5dda2020-08-28 11:52:01 +0000417 return fmt.Errorf(fmt.Sprintf("handler-not-found-%s", device.Id))
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000418}
419
420//Update_pm_config returns PmConfigs nil or error
dbainbri4d3a0dc2020-12-02 00:33:42 +0000421func (oo *OpenONUAC) Update_pm_config(ctx context.Context, device *voltha.Device, pmConfigs *voltha.PmConfigs) error {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000422 return errors.New("unImplemented")
423}
424
425//Receive_packet_out sends packet out to the device
dbainbri4d3a0dc2020-12-02 00:33:42 +0000426func (oo *OpenONUAC) Receive_packet_out(ctx context.Context, deviceID string, egressPortNo int, packet *openflow_13.OfpPacketOut) error {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000427 return errors.New("unImplemented")
428}
429
430//Suppress_event unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000431func (oo *OpenONUAC) Suppress_event(ctx context.Context, filter *voltha.EventFilter) error {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000432 return errors.New("unImplemented")
433}
434
435//Unsuppress_event unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000436func (oo *OpenONUAC) Unsuppress_event(ctx context.Context, filter *voltha.EventFilter) error {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000437 return errors.New("unImplemented")
438}
439
440//Download_image unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000441func (oo *OpenONUAC) Download_image(ctx context.Context, device *voltha.Device, request *voltha.ImageDownload) (*voltha.ImageDownload, error) {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000442 return nil, errors.New("unImplemented")
443}
444
445//Get_image_download_status unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000446func (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 +0000447 return nil, errors.New("unImplemented")
448}
449
450//Cancel_image_download unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000451func (oo *OpenONUAC) Cancel_image_download(ctx context.Context, device *voltha.Device, request *voltha.ImageDownload) (*voltha.ImageDownload, error) {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000452 return nil, errors.New("unImplemented")
453}
454
455//Activate_image_update unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000456func (oo *OpenONUAC) Activate_image_update(ctx context.Context, device *voltha.Device, request *voltha.ImageDownload) (*voltha.ImageDownload, error) {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000457 return nil, errors.New("unImplemented")
458}
459
460//Revert_image_update unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000461func (oo *OpenONUAC) Revert_image_update(ctx context.Context, device *voltha.Device, request *voltha.ImageDownload) (*voltha.ImageDownload, error) {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000462 return nil, errors.New("unImplemented")
463}
464
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000465// Enable_port to Enable PON/NNI interface - seems not to be used/required according to python code
dbainbri4d3a0dc2020-12-02 00:33:42 +0000466func (oo *OpenONUAC) Enable_port(ctx context.Context, deviceID string, port *voltha.Port) error {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000467 return errors.New("unImplemented")
468}
469
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000470// Disable_port to Disable pon/nni interface - seems not to be used/required according to python code
dbainbri4d3a0dc2020-12-02 00:33:42 +0000471func (oo *OpenONUAC) Disable_port(ctx context.Context, deviceID string, port *voltha.Port) error {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000472 return errors.New("unImplemented")
473}
474
Himani Chawla6d2ae152020-09-02 13:11:20 +0530475//Child_device_lost - unimplemented
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000476//needed for if update >= 3.1.x
dbainbri4d3a0dc2020-12-02 00:33:42 +0000477func (oo *OpenONUAC) Child_device_lost(ctx context.Context, deviceID string, pPortNo uint32, onuID uint32) error {
Matteo Scandolo2e6f1e32020-04-15 11:28:45 -0700478 return errors.New("unImplemented")
479}
480
Himani Chawla6d2ae152020-09-02 13:11:20 +0530481// Start_omci_test unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000482func (oo *OpenONUAC) Start_omci_test(ctx context.Context, device *voltha.Device, request *voltha.OmciTestRequest) (*voltha.TestResponse, error) {
Matteo Scandolo2e6f1e32020-04-15 11:28:45 -0700483 return nil, errors.New("unImplemented")
484}
485
Himani Chawla6d2ae152020-09-02 13:11:20 +0530486// Get_ext_value - unimplemented
dbainbri4d3a0dc2020-12-02 00:33:42 +0000487func (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 -0700488 return nil, errors.New("unImplemented")
489}
490
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000491// Adapter interface required methods ################ end #########
492// #################################################################