Takahiro Suzuki | 241c10e | 2020-12-17 20:17:57 +0900 | [diff] [blame^] | 1 | /* |
| 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 | |
| 17 | //Package adaptercoreonu provides the utility for onu devices, flows and statistics |
| 18 | package adaptercoreonu |
| 19 | |
| 20 | import ( |
| 21 | "context" |
| 22 | "encoding/hex" |
| 23 | "encoding/json" |
| 24 | "errors" |
| 25 | "fmt" |
| 26 | "strconv" |
| 27 | "strings" |
| 28 | |
| 29 | "github.com/looplab/fsm" |
| 30 | |
| 31 | "time" |
| 32 | |
| 33 | "github.com/opencord/omci-lib-go" |
| 34 | me "github.com/opencord/omci-lib-go/generated" |
| 35 | "github.com/opencord/voltha-lib-go/v3/pkg/db/kvstore" |
| 36 | "github.com/opencord/voltha-lib-go/v3/pkg/log" |
| 37 | ) |
| 38 | |
| 39 | var supportedClassIds = []me.ClassID{ |
| 40 | me.CardholderClassID, // 5 |
| 41 | me.CircuitPackClassID, // 6 |
| 42 | me.SoftwareImageClassID, // 7 |
| 43 | me.PhysicalPathTerminationPointEthernetUniClassID, // 11 |
| 44 | me.OltGClassID, // 131 |
| 45 | me.OnuPowerSheddingClassID, // 133 |
| 46 | me.IpHostConfigDataClassID, // 134 |
| 47 | me.OnuGClassID, // 256 |
| 48 | me.Onu2GClassID, // 257 |
| 49 | me.TContClassID, // 262 |
| 50 | me.AniGClassID, // 263 |
| 51 | me.UniGClassID, // 264 |
| 52 | me.PriorityQueueClassID, // 277 |
| 53 | me.TrafficSchedulerClassID, // 278 |
| 54 | me.VirtualEthernetInterfacePointClassID, // 329 |
| 55 | me.EnhancedSecurityControlClassID, // 332 |
| 56 | me.OnuDynamicPowerManagementControlClassID, // 336 |
| 57 | } |
| 58 | |
| 59 | var fsmMsg TestMessageType |
| 60 | |
| 61 | func (onuDeviceEntry *OnuDeviceEntry) enterStartingState(e *fsm.Event) { |
| 62 | logger.Debugw("MibSync FSM", log.Fields{"Start processing MibSync-msgs in State": e.FSM.Current(), "device-id": onuDeviceEntry.deviceID}) |
| 63 | onuDeviceEntry.pOnuDB = newOnuDeviceDB(context.TODO(), onuDeviceEntry) |
| 64 | go onuDeviceEntry.processMibSyncMessages() |
| 65 | } |
| 66 | |
| 67 | func (onuDeviceEntry *OnuDeviceEntry) enterResettingMibState(e *fsm.Event) { |
| 68 | logger.Debugw("MibSync FSM", log.Fields{"Start MibTemplate processing in State": e.FSM.Current(), "device-id": onuDeviceEntry.deviceID}) |
| 69 | |
| 70 | logger.Debugw("MibSync FSM", log.Fields{"send mibReset in State": e.FSM.Current(), "device-id": onuDeviceEntry.deviceID}) |
| 71 | _ = onuDeviceEntry.PDevOmciCC.sendMibReset(context.TODO(), ConstDefaultOmciTimeout, true) |
| 72 | |
| 73 | } |
| 74 | |
| 75 | func (onuDeviceEntry *OnuDeviceEntry) enterGettingVendorAndSerialState(e *fsm.Event) { |
| 76 | logger.Debugw("MibSync FSM", log.Fields{"Start getting VendorId and SerialNumber in State": e.FSM.Current(), "device-id": onuDeviceEntry.deviceID}) |
| 77 | requestedAttributes := me.AttributeValueMap{"VendorId": "", "SerialNumber": 0} |
| 78 | meInstance := onuDeviceEntry.PDevOmciCC.sendGetMe(context.TODO(), me.OnuGClassID, onugMeID, requestedAttributes, ConstDefaultOmciTimeout, true) |
| 79 | onuDeviceEntry.PDevOmciCC.pLastTxMeInstance = meInstance |
| 80 | } |
| 81 | |
| 82 | func (onuDeviceEntry *OnuDeviceEntry) enterGettingEquipmentIDState(e *fsm.Event) { |
| 83 | logger.Debugw("MibSync FSM", log.Fields{"Start getting EquipmentId in State": e.FSM.Current(), "device-id": onuDeviceEntry.deviceID}) |
| 84 | requestedAttributes := me.AttributeValueMap{"EquipmentId": ""} |
| 85 | meInstance := onuDeviceEntry.PDevOmciCC.sendGetMe(context.TODO(), me.Onu2GClassID, onu2gMeID, requestedAttributes, ConstDefaultOmciTimeout, true) |
| 86 | onuDeviceEntry.PDevOmciCC.pLastTxMeInstance = meInstance |
| 87 | } |
| 88 | |
| 89 | func (onuDeviceEntry *OnuDeviceEntry) enterGettingFirstSwVersionState(e *fsm.Event) { |
| 90 | logger.Debugw("MibSync FSM", log.Fields{"Start getting IsActive and Version of first SW-image in State": e.FSM.Current(), "device-id": onuDeviceEntry.deviceID}) |
| 91 | requestedAttributes := me.AttributeValueMap{"IsActive": 0, "Version": ""} |
| 92 | meInstance := onuDeviceEntry.PDevOmciCC.sendGetMe(context.TODO(), me.SoftwareImageClassID, firstSwImageMeID, requestedAttributes, ConstDefaultOmciTimeout, true) |
| 93 | onuDeviceEntry.PDevOmciCC.pLastTxMeInstance = meInstance |
| 94 | } |
| 95 | |
| 96 | func (onuDeviceEntry *OnuDeviceEntry) enterGettingSecondSwVersionState(e *fsm.Event) { |
| 97 | logger.Debugw("MibSync FSM", log.Fields{"Start getting IsActive and Version of second SW-image in State": e.FSM.Current(), "device-id": onuDeviceEntry.deviceID}) |
| 98 | requestedAttributes := me.AttributeValueMap{"IsActive": 0, "Version": ""} |
| 99 | meInstance := onuDeviceEntry.PDevOmciCC.sendGetMe(context.TODO(), me.SoftwareImageClassID, secondSwImageMeID, requestedAttributes, ConstDefaultOmciTimeout, true) |
| 100 | onuDeviceEntry.PDevOmciCC.pLastTxMeInstance = meInstance |
| 101 | } |
| 102 | |
| 103 | func (onuDeviceEntry *OnuDeviceEntry) enterGettingMacAddressState(e *fsm.Event) { |
| 104 | logger.Debugw("MibSync FSM", log.Fields{"Start getting MacAddress in State": e.FSM.Current(), "device-id": onuDeviceEntry.deviceID}) |
| 105 | requestedAttributes := me.AttributeValueMap{"MacAddress": ""} |
| 106 | meInstance := onuDeviceEntry.PDevOmciCC.sendGetMe(context.TODO(), me.IpHostConfigDataClassID, ipHostConfigDataMeID, requestedAttributes, ConstDefaultOmciTimeout, true) |
| 107 | onuDeviceEntry.PDevOmciCC.pLastTxMeInstance = meInstance |
| 108 | } |
| 109 | |
| 110 | func (onuDeviceEntry *OnuDeviceEntry) enterGettingMibTemplate(e *fsm.Event) { |
| 111 | |
| 112 | for i := firstSwImageMeID; i <= secondSwImageMeID; i++ { |
| 113 | if onuDeviceEntry.swImages[i].isActive > 0 { |
| 114 | onuDeviceEntry.activeSwVersion = onuDeviceEntry.swImages[i].version |
| 115 | } |
| 116 | } |
| 117 | |
| 118 | meStoredFromTemplate := false |
| 119 | path := fmt.Sprintf(cSuffixMibTemplateKvStore, onuDeviceEntry.vendorID, onuDeviceEntry.equipmentID, onuDeviceEntry.activeSwVersion) |
| 120 | logger.Debugw("MibSync FSM - MibTemplate - etcd search string", log.Fields{"path": path}) |
| 121 | Value, err := onuDeviceEntry.mibTemplateKVStore.Get(context.TODO(), path) |
| 122 | if err == nil { |
| 123 | if Value != nil { |
| 124 | logger.Debugf("MibSync FSM - MibTemplate read: Key: %s, Value: %s %s", Value.Key, Value.Value) |
| 125 | |
| 126 | // swap out tokens with specific data |
| 127 | mibTmpString, _ := kvstore.ToString(Value.Value) |
| 128 | mibTmpString2 := strings.Replace(mibTmpString, "%SERIAL_NUMBER%", onuDeviceEntry.serialNumber, -1) |
| 129 | mibTmpString = strings.Replace(mibTmpString2, "%MAC_ADDRESS%", onuDeviceEntry.macAddress, -1) |
| 130 | mibTmpBytes := []byte(mibTmpString) |
| 131 | logger.Debugf("MibSync FSM - MibTemplate tokens swapped out: %s", mibTmpBytes) |
| 132 | |
| 133 | var fistLevelMap map[string]interface{} |
| 134 | if err = json.Unmarshal(mibTmpBytes, &fistLevelMap); err != nil { |
| 135 | logger.Error("MibSync FSM - Failed to unmarshal template", log.Fields{"error": err, "device-id": onuDeviceEntry.deviceID}) |
| 136 | } else { |
| 137 | for fistLevelKey, firstLevelValue := range fistLevelMap { |
| 138 | logger.Debugw("MibSync FSM - fistLevelKey", log.Fields{"fistLevelKey": fistLevelKey}) |
| 139 | if uint16ValidNumber, err := strconv.ParseUint(fistLevelKey, 10, 16); err == nil { |
| 140 | meClassID := me.ClassID(uint16ValidNumber) |
| 141 | logger.Debugw("MibSync FSM - fistLevelKey is a number in uint16-range", log.Fields{"uint16ValidNumber": uint16ValidNumber}) |
| 142 | if isSupportedClassID(meClassID) { |
| 143 | logger.Debugw("MibSync FSM - fistLevelKey is a supported classID", log.Fields{"meClassID": meClassID}) |
| 144 | secondLevelMap := firstLevelValue.(map[string]interface{}) |
| 145 | for secondLevelKey, secondLevelValue := range secondLevelMap { |
| 146 | logger.Debugw("MibSync FSM - secondLevelKey", log.Fields{"secondLevelKey": secondLevelKey}) |
| 147 | if uint16ValidNumber, err := strconv.ParseUint(secondLevelKey, 10, 16); err == nil { |
| 148 | meEntityID := uint16(uint16ValidNumber) |
| 149 | logger.Debugw("MibSync FSM - secondLevelKey is a number and a valid EntityId", log.Fields{"meEntityID": meEntityID}) |
| 150 | thirdLevelMap := secondLevelValue.(map[string]interface{}) |
| 151 | for thirdLevelKey, thirdLevelValue := range thirdLevelMap { |
| 152 | if thirdLevelKey == "Attributes" { |
| 153 | logger.Debugw("MibSync FSM - thirdLevelKey refers to attributes", log.Fields{"thirdLevelKey": thirdLevelKey}) |
| 154 | attributesMap := thirdLevelValue.(map[string]interface{}) |
| 155 | logger.Debugw("MibSync FSM - attributesMap", log.Fields{"attributesMap": attributesMap}) |
| 156 | onuDeviceEntry.pOnuDB.PutMe(meClassID, meEntityID, attributesMap) |
| 157 | meStoredFromTemplate = true |
| 158 | } |
| 159 | } |
| 160 | } |
| 161 | } |
| 162 | } |
| 163 | } |
| 164 | } |
| 165 | } |
| 166 | } else { |
| 167 | logger.Debugw("No MIB template found", log.Fields{"path": path, "device-id": onuDeviceEntry.deviceID}) |
| 168 | } |
| 169 | } else { |
| 170 | logger.Errorf("Get from kvstore operation failed for path %s", path) |
| 171 | } |
| 172 | if meStoredFromTemplate { |
| 173 | logger.Debug("MibSync FSM - valid MEs stored from template") |
| 174 | onuDeviceEntry.pOnuDB.logMeDb() |
| 175 | fsmMsg = LoadMibTemplateOk |
| 176 | } else { |
| 177 | logger.Debug("MibSync FSM - no valid MEs stored from template - perform MIB-upload!") |
| 178 | fsmMsg = LoadMibTemplateFailed |
| 179 | } |
| 180 | |
| 181 | mibSyncMsg := Message{ |
| 182 | Type: TestMsg, |
| 183 | Data: TestMessage{ |
| 184 | TestMessageVal: fsmMsg, |
| 185 | }, |
| 186 | } |
| 187 | onuDeviceEntry.pMibUploadFsm.commChan <- mibSyncMsg |
| 188 | } |
| 189 | |
| 190 | func (onuDeviceEntry *OnuDeviceEntry) enterUploadingState(e *fsm.Event) { |
| 191 | logger.Debugw("MibSync FSM", log.Fields{"send MibUpload in State": e.FSM.Current(), "device-id": onuDeviceEntry.deviceID}) |
| 192 | _ = onuDeviceEntry.PDevOmciCC.sendMibUpload(context.TODO(), ConstDefaultOmciTimeout, true) |
| 193 | } |
| 194 | |
| 195 | func (onuDeviceEntry *OnuDeviceEntry) enterInSyncState(e *fsm.Event) { |
| 196 | logger.Debugw("MibSync FSM", log.Fields{"send notification to core in State": e.FSM.Current(), "device-id": onuDeviceEntry.deviceID}) |
| 197 | onuDeviceEntry.transferSystemEvent(MibDatabaseSync) |
| 198 | } |
| 199 | |
| 200 | func (onuDeviceEntry *OnuDeviceEntry) enterExaminingMdsState(e *fsm.Event) { |
| 201 | logger.Debugw("MibSync FSM", log.Fields{"Start GetMds processing in State": e.FSM.Current(), "device-id": onuDeviceEntry.deviceID}) |
| 202 | logger.Debug("function not implemented yet") |
| 203 | } |
| 204 | |
| 205 | func (onuDeviceEntry *OnuDeviceEntry) enterResynchronizingState(e *fsm.Event) { |
| 206 | logger.Debugw("MibSync FSM", log.Fields{"Start MibResync processing in State": e.FSM.Current(), "device-id": onuDeviceEntry.deviceID}) |
| 207 | logger.Debug("function not implemented yet") |
| 208 | } |
| 209 | |
| 210 | func (onuDeviceEntry *OnuDeviceEntry) enterAuditingState(e *fsm.Event) { |
| 211 | logger.Debugw("MibSync FSM", log.Fields{"Start MibResync processing in State": e.FSM.Current(), "device-id": onuDeviceEntry.deviceID}) |
| 212 | logger.Debug("function not implemented yet") |
| 213 | } |
| 214 | |
| 215 | func (onuDeviceEntry *OnuDeviceEntry) enterOutOfSyncState(e *fsm.Event) { |
| 216 | logger.Debugw("MibSync FSM", log.Fields{"Start MibReconcile processing in State": e.FSM.Current(), "device-id": onuDeviceEntry.deviceID}) |
| 217 | logger.Debug("function not implemented yet") |
| 218 | } |
| 219 | |
| 220 | func (onuDeviceEntry *OnuDeviceEntry) processMibSyncMessages( /*ctx context.Context*/ ) { |
| 221 | logger.Debugw("MibSync Msg", log.Fields{"Start routine to process OMCI-messages for device-id": onuDeviceEntry.deviceID}) |
| 222 | loop: |
| 223 | for { |
| 224 | // case <-ctx.Done(): |
| 225 | // logger.Info("MibSync Msg", log.Fields{"Message handling canceled via context for device-id": onuDeviceEntry.deviceID}) |
| 226 | // break loop |
| 227 | message, ok := <-onuDeviceEntry.pMibUploadFsm.commChan |
| 228 | if !ok { |
| 229 | logger.Info("MibSync Msg", log.Fields{"Message couldn't be read from channel for device-id": onuDeviceEntry.deviceID}) |
| 230 | break loop |
| 231 | } |
| 232 | logger.Debugw("MibSync Msg", log.Fields{"Received message on ONU MibSyncChan for device-id": onuDeviceEntry.deviceID}) |
| 233 | |
| 234 | switch message.Type { |
| 235 | case TestMsg: |
| 236 | msg, _ := message.Data.(TestMessage) |
| 237 | onuDeviceEntry.handleTestMsg(msg) |
| 238 | case OMCI: |
| 239 | msg, _ := message.Data.(OmciMessage) |
| 240 | onuDeviceEntry.handleOmciMessage(msg) |
| 241 | default: |
| 242 | logger.Warn("MibSync Msg", log.Fields{"Unknown message type received for device-id": onuDeviceEntry.deviceID, "message.Type": message.Type}) |
| 243 | } |
| 244 | } |
| 245 | logger.Info("MibSync Msg", log.Fields{"Stopped handling of MibSyncChan for device-id": onuDeviceEntry.deviceID}) |
| 246 | _ = onuDeviceEntry.pMibUploadFsm.pFsm.Event(ulEvStop) |
| 247 | } |
| 248 | |
| 249 | func (onuDeviceEntry *OnuDeviceEntry) handleTestMsg(msg TestMessage) { |
| 250 | |
| 251 | logger.Debugw("MibSync Msg", log.Fields{"TestMessage received for device-id": onuDeviceEntry.deviceID, "msg.TestMessageVal": msg.TestMessageVal}) |
| 252 | |
| 253 | switch msg.TestMessageVal { |
| 254 | case LoadMibTemplateFailed: |
| 255 | _ = onuDeviceEntry.pMibUploadFsm.pFsm.Event(ulEvUploadMib) |
| 256 | logger.Debugw("MibSync Msg", log.Fields{"state": string(onuDeviceEntry.pMibUploadFsm.pFsm.Current())}) |
| 257 | case LoadMibTemplateOk: |
| 258 | _ = onuDeviceEntry.pMibUploadFsm.pFsm.Event(ulEvSuccess) |
| 259 | logger.Debugw("MibSync Msg", log.Fields{"state": string(onuDeviceEntry.pMibUploadFsm.pFsm.Current())}) |
| 260 | default: |
| 261 | logger.Warn("MibSync Msg", log.Fields{"Unknown message type received for device-id": onuDeviceEntry.deviceID, "msg.TestMessageVal": msg.TestMessageVal}) |
| 262 | } |
| 263 | } |
| 264 | |
| 265 | func (onuDeviceEntry *OnuDeviceEntry) handleOmciMibResetResponseMessage(msg OmciMessage) { |
| 266 | if onuDeviceEntry.pMibUploadFsm.pFsm.Is(ulStResettingMib) { |
| 267 | msgLayer := (*msg.OmciPacket).Layer(omci.LayerTypeMibResetResponse) |
| 268 | if msgLayer != nil { |
| 269 | msgObj, msgOk := msgLayer.(*omci.MibResetResponse) |
| 270 | if msgOk { |
| 271 | logger.Debugw("MibResetResponse Data", log.Fields{"data-fields": msgObj}) |
| 272 | if msgObj.Result == me.Success { |
| 273 | // trigger retrieval of VendorId and SerialNumber |
| 274 | _ = onuDeviceEntry.pMibUploadFsm.pFsm.Event(ulEvGetVendorAndSerial) |
| 275 | return |
| 276 | } |
| 277 | logger.Errorw("Omci MibResetResponse Error", log.Fields{"Error": msgObj.Result}) |
| 278 | } else { |
| 279 | logger.Error("Omci Msg layer could not be assigned") |
| 280 | } |
| 281 | } else { |
| 282 | logger.Error("Omci Msg layer could not be detected") |
| 283 | } |
| 284 | } else { |
| 285 | logger.Errorw("Omci MibResetResponse received", log.Fields{"in state ": onuDeviceEntry.pMibUploadFsm.pFsm.Current}) |
| 286 | } |
| 287 | logger.Info("MibSync Msg", log.Fields{"Stopped handling of MibSyncChan for device-id": onuDeviceEntry.deviceID}) |
| 288 | _ = onuDeviceEntry.pMibUploadFsm.pFsm.Event(ulEvStop) |
| 289 | |
| 290 | } |
| 291 | |
| 292 | func (onuDeviceEntry *OnuDeviceEntry) handleOmciMibUploadResponseMessage(msg OmciMessage) { |
| 293 | msgLayer := (*msg.OmciPacket).Layer(omci.LayerTypeMibUploadResponse) |
| 294 | if msgLayer == nil { |
| 295 | logger.Error("Omci Msg layer could not be detected") |
| 296 | return |
| 297 | } |
| 298 | msgObj, msgOk := msgLayer.(*omci.MibUploadResponse) |
| 299 | if !msgOk { |
| 300 | logger.Error("Omci Msg layer could not be assigned") |
| 301 | return |
| 302 | } |
| 303 | logger.Debugw("MibUploadResponse Data for:", log.Fields{"deviceId": onuDeviceEntry.deviceID, "data-fields": msgObj}) |
| 304 | /* to be verified / reworked !!! */ |
| 305 | onuDeviceEntry.PDevOmciCC.uploadNoOfCmds = msgObj.NumberOfCommands |
| 306 | if onuDeviceEntry.PDevOmciCC.uploadSequNo < onuDeviceEntry.PDevOmciCC.uploadNoOfCmds { |
| 307 | _ = onuDeviceEntry.PDevOmciCC.sendMibUploadNext(context.TODO(), ConstDefaultOmciTimeout, true) |
| 308 | } else { |
| 309 | logger.Error("Invalid number of commands received for:", log.Fields{"deviceId": onuDeviceEntry.deviceID, "uploadNoOfCmds": onuDeviceEntry.PDevOmciCC.uploadNoOfCmds}) |
| 310 | //TODO right action? |
| 311 | _ = onuDeviceEntry.pMibUploadFsm.pFsm.Event(ulEvTimeout) |
| 312 | } |
| 313 | } |
| 314 | |
| 315 | func (onuDeviceEntry *OnuDeviceEntry) handleOmciMibUploadNextResponseMessage(msg OmciMessage) { |
| 316 | msgLayer := (*msg.OmciPacket).Layer(omci.LayerTypeMibUploadNextResponse) |
| 317 | if msgLayer == nil { |
| 318 | logger.Error("Omci Msg layer could not be detected") |
| 319 | return |
| 320 | } |
| 321 | msgObj, msgOk := msgLayer.(*omci.MibUploadNextResponse) |
| 322 | if !msgOk { |
| 323 | logger.Error("Omci Msg layer could not be assigned") |
| 324 | return |
| 325 | } |
| 326 | if onuDeviceEntry.mibDebugLevel == "VERBOSE" { |
| 327 | logger.Debugw("MibUploadNextResponse Data for:", log.Fields{"deviceId": onuDeviceEntry.deviceID, "data-fields": msgObj}) |
| 328 | } |
| 329 | meClassID := msgObj.ReportedME.GetClassID() |
| 330 | meEntityID := msgObj.ReportedME.GetEntityID() |
| 331 | meAttributes := msgObj.ReportedME.GetAttributeValueMap() |
| 332 | |
| 333 | onuDeviceEntry.pOnuDB.PutMe(meClassID, meEntityID, meAttributes) |
| 334 | |
| 335 | if onuDeviceEntry.PDevOmciCC.uploadSequNo < onuDeviceEntry.PDevOmciCC.uploadNoOfCmds { |
| 336 | _ = onuDeviceEntry.PDevOmciCC.sendMibUploadNext(context.TODO(), ConstDefaultOmciTimeout, true) |
| 337 | } else { |
| 338 | onuDeviceEntry.pOnuDB.logMeDb() |
| 339 | err := onuDeviceEntry.createAndPersistMibTemplate() |
| 340 | if err != nil { |
| 341 | logger.Errorw("MibSync - MibTemplate - Failed to create and persist the mib template", log.Fields{"error": err, "device-id": onuDeviceEntry.deviceID}) |
| 342 | } |
| 343 | |
| 344 | _ = onuDeviceEntry.pMibUploadFsm.pFsm.Event(ulEvSuccess) |
| 345 | } |
| 346 | } |
| 347 | |
| 348 | func (onuDeviceEntry *OnuDeviceEntry) handleOmciGetResponseMessage(msg OmciMessage) { |
| 349 | msgLayer := (*msg.OmciPacket).Layer(omci.LayerTypeGetResponse) |
| 350 | if msgLayer != nil { |
| 351 | msgObj, msgOk := msgLayer.(*omci.GetResponse) |
| 352 | if msgOk { |
| 353 | logger.Debugw("MibSync FSM - GetResponse Data", log.Fields{"deviceId": onuDeviceEntry.deviceID, "data-fields": msgObj}) |
| 354 | if msgObj.Result == me.Success { |
| 355 | entityID := onuDeviceEntry.PDevOmciCC.pLastTxMeInstance.GetEntityID() |
| 356 | if msgObj.EntityClass == onuDeviceEntry.PDevOmciCC.pLastTxMeInstance.GetClassID() && msgObj.EntityInstance == entityID { |
| 357 | meAttributes := msgObj.Attributes |
| 358 | meInstance := onuDeviceEntry.PDevOmciCC.pLastTxMeInstance.GetName() |
| 359 | if onuDeviceEntry.mibDebugLevel == "VERBOSE" { |
| 360 | logger.Debugf("MibSync FSM - GetResponse Data for %s", log.Fields{"deviceId": onuDeviceEntry.deviceID, "data-fields": msgObj}, meInstance) |
| 361 | } |
| 362 | switch meInstance { |
| 363 | case "OnuG": |
| 364 | onuDeviceEntry.vendorID = fmt.Sprintf("%s", meAttributes["VendorId"]) |
| 365 | snBytes, _ := me.InterfaceToOctets(meAttributes["SerialNumber"]) |
| 366 | if onugSerialNumberLen == len(snBytes) { |
| 367 | snVendorPart := fmt.Sprintf("%s", snBytes[:4]) |
| 368 | snNumberPart := hex.EncodeToString(snBytes[4:]) |
| 369 | onuDeviceEntry.serialNumber = snVendorPart + snNumberPart |
| 370 | logger.Debugw("MibSync FSM - GetResponse Data for Onu-G - VendorId/SerialNumber", log.Fields{"deviceId": onuDeviceEntry.deviceID, |
| 371 | "onuDeviceEntry.vendorID": onuDeviceEntry.vendorID, "onuDeviceEntry.serialNumber": onuDeviceEntry.serialNumber}) |
| 372 | } else { |
| 373 | logger.Errorw("MibSync FSM - SerialNumber has wrong length", log.Fields{"deviceId": onuDeviceEntry.deviceID, "length": len(snBytes)}) |
| 374 | } |
| 375 | // trigger retrieval of EquipmentId |
| 376 | _ = onuDeviceEntry.pMibUploadFsm.pFsm.Event(ulEvGetEquipmentID) |
| 377 | return |
| 378 | case "Onu2G": |
| 379 | onuDeviceEntry.equipmentID = fmt.Sprintf("%s", meAttributes["EquipmentId"]) |
| 380 | logger.Debugw("MibSync FSM - GetResponse Data for Onu2-G - EquipmentId", log.Fields{"deviceId": onuDeviceEntry.deviceID, |
| 381 | "onuDeviceEntry.equipmentID": onuDeviceEntry.equipmentID}) |
| 382 | // trigger retrieval of 1st SW-image info |
| 383 | _ = onuDeviceEntry.pMibUploadFsm.pFsm.Event(ulEvGetFirstSwVersion) |
| 384 | return |
| 385 | case "SoftwareImage": |
| 386 | if entityID <= secondSwImageMeID { |
| 387 | onuDeviceEntry.swImages[entityID].version = fmt.Sprintf("%s", meAttributes["Version"]) |
| 388 | onuDeviceEntry.swImages[entityID].isActive = meAttributes["IsActive"].(uint8) |
| 389 | logger.Debugw("MibSync FSM - GetResponse Data for SoftwareImage - Version/IsActive", |
| 390 | log.Fields{"deviceId": onuDeviceEntry.deviceID, "entityID": entityID, |
| 391 | "version": onuDeviceEntry.swImages[entityID].version, "isActive": onuDeviceEntry.swImages[entityID].isActive}) |
| 392 | } else { |
| 393 | //TODO: error handling |
| 394 | logger.Errorw("MibSync FSM - Failed to GetResponse Data for SoftwareImage", log.Fields{"deviceId": onuDeviceEntry.deviceID}) |
| 395 | |
| 396 | } |
| 397 | if firstSwImageMeID == entityID { |
| 398 | _ = onuDeviceEntry.pMibUploadFsm.pFsm.Event(ulEvGetSecondSwVersion) |
| 399 | return |
| 400 | } else if secondSwImageMeID == entityID { |
| 401 | _ = onuDeviceEntry.pMibUploadFsm.pFsm.Event(ulEvGetMacAddress) |
| 402 | return |
| 403 | } |
| 404 | case "IpHostConfigData": |
| 405 | macBytes, _ := me.InterfaceToOctets(meAttributes["MacAddress"]) |
| 406 | if omciMacAddressLen == len(macBytes) { |
| 407 | onuDeviceEntry.macAddress = hex.EncodeToString(macBytes[:]) |
| 408 | logger.Debugw("MibSync FSM - GetResponse Data for IpHostConfigData - MacAddress", log.Fields{"deviceId": onuDeviceEntry.deviceID, |
| 409 | "onuDeviceEntry.macAddress": onuDeviceEntry.macAddress}) |
| 410 | } else { |
| 411 | logger.Errorw("MibSync FSM - MacAddress wrong length", log.Fields{"deviceId": onuDeviceEntry.deviceID, "length": len(macBytes)}) |
| 412 | } |
| 413 | // trigger retrieval of mib template |
| 414 | _ = onuDeviceEntry.pMibUploadFsm.pFsm.Event(ulEvGetMibTemplate) |
| 415 | return |
| 416 | } |
| 417 | } |
| 418 | } else { |
| 419 | logger.Errorw("Omci GetResponse Error", log.Fields{"Error": msgObj.Result}) |
| 420 | } |
| 421 | } else { |
| 422 | logger.Error("Omci Msg layer could not be assigned for GetResponse") |
| 423 | } |
| 424 | } else { |
| 425 | logger.Error("Omci Msg layer could not be detected for GetResponse") |
| 426 | } |
| 427 | logger.Info("MibSync Msg", log.Fields{"Stopped handling of MibSyncChan for device-id": onuDeviceEntry.deviceID}) |
| 428 | _ = onuDeviceEntry.pMibUploadFsm.pFsm.Event(ulEvStop) |
| 429 | } |
| 430 | |
| 431 | func (onuDeviceEntry *OnuDeviceEntry) handleOmciMessage(msg OmciMessage) { |
| 432 | if onuDeviceEntry.mibDebugLevel == "VERBOSE" { |
| 433 | logger.Debugw("MibSync Msg", log.Fields{"OmciMessage received for device-id": onuDeviceEntry.deviceID, |
| 434 | "msgType": msg.OmciMsg.MessageType}) |
| 435 | } |
| 436 | switch msg.OmciMsg.MessageType { |
| 437 | case omci.MibResetResponseType: |
| 438 | onuDeviceEntry.handleOmciMibResetResponseMessage(msg) |
| 439 | |
| 440 | case omci.MibUploadResponseType: |
| 441 | onuDeviceEntry.handleOmciMibUploadResponseMessage(msg) |
| 442 | |
| 443 | case omci.MibUploadNextResponseType: |
| 444 | onuDeviceEntry.handleOmciMibUploadNextResponseMessage(msg) |
| 445 | |
| 446 | case omci.GetResponseType: |
| 447 | onuDeviceEntry.handleOmciGetResponseMessage(msg) |
| 448 | |
| 449 | } |
| 450 | } |
| 451 | |
| 452 | func isSupportedClassID(meClassID me.ClassID) bool { |
| 453 | for _, v := range supportedClassIds { |
| 454 | if v == meClassID { |
| 455 | return true |
| 456 | } |
| 457 | } |
| 458 | return false |
| 459 | } |
| 460 | |
| 461 | func (onuDeviceEntry *OnuDeviceEntry) mibDbVolatileDict() error { |
| 462 | logger.Debug("MibVolatileDict- running from default Entry code") |
| 463 | return errors.New("not_implemented") |
| 464 | } |
| 465 | |
| 466 | // createAndPersistMibTemplate method creates a mib template for the device id when operator enables the ONU device for the first time. |
| 467 | // We are creating a placeholder for "SerialNumber" for ME Class ID 6 and 256 and "MacAddress" for ME Class ID 134 in the template |
| 468 | // and then storing the template into etcd "service/voltha/omci_mibs/templates/verdor_id/equipment_id/software_version" path. |
| 469 | func (onuDeviceEntry *OnuDeviceEntry) createAndPersistMibTemplate() error { |
| 470 | path := fmt.Sprintf(cSuffixMibTemplateKvStore, onuDeviceEntry.vendorID, onuDeviceEntry.equipmentID, onuDeviceEntry.activeSwVersion) |
| 471 | logger.Debugw("MibSync - MibTemplate - key name", log.Fields{"path": path}) |
| 472 | currentTime := time.Now() |
| 473 | |
| 474 | templateMap := make(map[string]interface{}) |
| 475 | templateMap["TemplateName"] = path |
| 476 | templateMap["TemplateCreated"] = currentTime.Format("2006-01-02 15:04:05.000000") |
| 477 | |
| 478 | firstLevelMap := onuDeviceEntry.pOnuDB.meDb |
| 479 | for firstLevelKey, firstLevelValue := range firstLevelMap { |
| 480 | logger.Debugw("MibSync - MibTemplate - firstLevelKey", log.Fields{"firstLevelKey": firstLevelKey}) |
| 481 | classID := strconv.Itoa(int(firstLevelKey)) |
| 482 | |
| 483 | secondLevelMap := make(map[string]interface{}) |
| 484 | for secondLevelKey, secondLevelValue := range firstLevelValue { |
| 485 | thirdLevelMap := make(map[string]interface{}) |
| 486 | entityID := strconv.Itoa(int(secondLevelKey)) |
| 487 | thirdLevelMap["Attributes"] = secondLevelValue |
| 488 | thirdLevelMap["InstanceId"] = entityID |
| 489 | secondLevelMap[entityID] = thirdLevelMap |
| 490 | if classID == "6" || classID == "256" { |
| 491 | forthLevelMap := map[string]interface{}(thirdLevelMap["Attributes"].(me.AttributeValueMap)) |
| 492 | delete(forthLevelMap, "SerialNumber") |
| 493 | forthLevelMap["SerialNumber"] = "%SERIAL_NUMBER%" |
| 494 | |
| 495 | } |
| 496 | if classID == "134" { |
| 497 | forthLevelMap := map[string]interface{}(thirdLevelMap["Attributes"].(me.AttributeValueMap)) |
| 498 | delete(forthLevelMap, "MacAddress") |
| 499 | forthLevelMap["MacAddress"] = "%MAC_ADDRESS%" |
| 500 | } |
| 501 | } |
| 502 | secondLevelMap["ClassId"] = classID |
| 503 | templateMap[classID] = secondLevelMap |
| 504 | } |
| 505 | mibTemplate, err := json.Marshal(&templateMap) |
| 506 | if err != nil { |
| 507 | logger.Errorw("MibSync - MibTemplate - Failed to marshal mibTemplate", log.Fields{"error": err, "device-id": onuDeviceEntry.deviceID}) |
| 508 | return err |
| 509 | } |
| 510 | err = onuDeviceEntry.mibTemplateKVStore.Put(context.TODO(), path, string(mibTemplate)) |
| 511 | if err != nil { |
| 512 | logger.Errorw("MibSync - MibTemplate - Failed to store template in etcd", log.Fields{"error": err, "device-id": onuDeviceEntry.deviceID}) |
| 513 | return err |
| 514 | } |
| 515 | logger.Debugw("MibSync - MibTemplate - Stored the template to etcd", log.Fields{"device-id": onuDeviceEntry.deviceID}) |
| 516 | return nil |
| 517 | } |
| 518 | |
| 519 | // func (onuDeviceEntry *OnuDeviceEntry) MibTemplateTask() error { |
| 520 | // return errors.New("not_implemented") |
| 521 | // } |
| 522 | // func (onuDeviceEntry *OnuDeviceEntry) MibUploadTask() error { |
| 523 | // return errors.New("not_implemented") |
| 524 | // } |
| 525 | // func (onuDeviceEntry *OnuDeviceEntry) GetMdsTask() error { |
| 526 | // return errors.New("not_implemented") |
| 527 | // } |
| 528 | // func (onuDeviceEntry *OnuDeviceEntry) MibResyncTask() error { |
| 529 | // return errors.New("not_implemented") |
| 530 | // } |
| 531 | // func (onuDeviceEntry *OnuDeviceEntry) MibReconcileTask() error { |
| 532 | // return errors.New("not_implemented") |
| 533 | // } |