E2Manager/converters/x2_setup_failure_response_converter.go

   1 //
   2 // Copyright 2019 AT&T Intellectual Property
   3 // Copyright 2019 Nokia
   4 //
   5 // Licensed under the Apache License, Version 2.0 (the "License");
   6 // you may not use this file except in compliance with the License.
   7 // You may obtain a copy of the License at
   8 //
   9 //      http://www.apache.org/licenses/LICENSE-2.0
  10 //
  11 // Unless required by applicable law or agreed to in writing, software
  12 // distributed under the License is distributed on an "AS IS" BASIS,
  13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 // See the License for the specific language governing permissions and
  15 // limitations under the License.
  16
  17 //  This source code is part of the near-RT RIC (RAN Intelligent Controller)
  18 //  platform project (RICP).
  19
  20
  21 package converters
  22
  23 // #cgo CFLAGS: -I../3rdparty/asn1codec/inc/ -I../3rdparty/asn1codec/e2ap_engine/
  24 // #cgo LDFLAGS: -L ../3rdparty/asn1codec/lib/ -L../3rdparty/asn1codec/e2ap_engine/ -le2ap_codec -lasncodec
  25 // #include <asn1codec_utils.h>
  26 // #include <x2setup_response_wrapper.h>
  27 import "C"
  28 import (
  29         "e2mgr/e2pdus"
  30         "e2mgr/logger"
  31         "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/entities"
  32         "unsafe"
  33 )
  34
  35 const (
  36         maxNrOfErrors = 256
  37 )
  38
  39 type X2SetupFailureResponseConverter struct {
  40         logger *logger.Logger
  41 }
  42
  43 type IX2SetupFailureResponseConverter interface {
  44         UnpackX2SetupFailureResponseAndExtract(packedBuf []byte) (*entities.SetupFailure, error)
  45 }
  46
  47 func NewX2SetupFailureResponseConverter(logger *logger.Logger) *X2SetupFailureResponseConverter {
  48         return &X2SetupFailureResponseConverter{
  49                 logger: logger,
  50         }
  51 }
  52
  53 // The following are possible values of a choice field, find which the pdu contains.
  54 func getCause(causeIE *C.Cause_t, setupFailure *entities.SetupFailure) error {
  55         switch causeIE.present {
  56         case C.Cause_PR_radioNetwork:
  57                 v := (*C.CauseRadioNetwork_t)(unsafe.Pointer(&causeIE.choice[0]))
  58                 setupFailure.CauseGroup = &entities.SetupFailure_NetworkLayerCause{NetworkLayerCause: entities.RadioNetworkLayer_Cause(1 + *v)}
  59         case C.Cause_PR_transport:
  60                 v := (*C.CauseTransport_t)(unsafe.Pointer(&causeIE.choice[0]))
  61                 setupFailure.CauseGroup = &entities.SetupFailure_TransportLayerCause{TransportLayerCause: entities.TransportLayer_Cause(1 + *v)}
  62         case C.Cause_PR_protocol:
  63                 v := (*C.CauseProtocol_t)(unsafe.Pointer(&causeIE.choice[0]))
  64                 setupFailure.CauseGroup = &entities.SetupFailure_ProtocolCause{ProtocolCause: entities.Protocol_Cause(1 + *v)}
  65         case C.Cause_PR_misc:
  66                 v := (*C.CauseMisc_t)(unsafe.Pointer(&causeIE.choice[0]))
  67                 setupFailure.CauseGroup = &entities.SetupFailure_MiscellaneousCause{MiscellaneousCause: entities.Miscellaneous_Cause(1 + *v)}
  68         }
  69         return nil
  70 }
  71
  72 func getCriticalityDiagnostics(critDiagIE *C.CriticalityDiagnostics_t) (*entities.CriticalityDiagnostics, error) {
  73         var critDiag *entities.CriticalityDiagnostics
  74
  75         if critDiagIE.procedureCode != nil {
  76                 critDiag = &entities.CriticalityDiagnostics{}
  77                 critDiag.ProcedureCode = uint32(*critDiagIE.procedureCode)
  78
  79         }
  80
  81         if critDiagIE.triggeringMessage != nil {
  82                 if critDiag == nil {
  83                         critDiag = &entities.CriticalityDiagnostics{}
  84                 }
  85                 critDiag.TriggeringMessage = entities.TriggeringMessage(1 + *critDiagIE.triggeringMessage)
  86
  87         }
  88
  89         if critDiagIE.procedureCriticality != nil {
  90                 if critDiag == nil {
  91                         critDiag = &entities.CriticalityDiagnostics{}
  92                 }
  93                 critDiag.ProcedureCriticality = entities.Criticality(1 + *critDiagIE.procedureCriticality)
  94
  95         }
  96
  97         if critDiagIE.iEsCriticalityDiagnostics != nil && critDiagIE.iEsCriticalityDiagnostics.list.count > 0 && critDiagIE.iEsCriticalityDiagnostics.list.count < maxNrOfErrors {
  98                 if critDiag == nil {
  99                         critDiag = &entities.CriticalityDiagnostics{}
 100                 }
 101                 var infoElements []*entities.InformationElementCriticalityDiagnostic
 102                 iEsCriticalityDiagnostics := (*C.CriticalityDiagnostics_IE_List_t)(critDiagIE.iEsCriticalityDiagnostics)
 103                 count:=int(iEsCriticalityDiagnostics.list.count)
 104                 iEsCriticalityDiagnostics_slice := (*[1 << 30]*C.CriticalityDiagnostics_IE_List__Member)(unsafe.Pointer(iEsCriticalityDiagnostics.list.array))[:count:count]
 105                 for _, criticalityDiagnostics_IE_List__Member := range  iEsCriticalityDiagnostics_slice {
 106                         infoElement := &entities.InformationElementCriticalityDiagnostic{IeCriticality: entities.Criticality(1 + criticalityDiagnostics_IE_List__Member.iECriticality)}
 107                         infoElement.IeId = uint32(criticalityDiagnostics_IE_List__Member.iE_ID)
 108                         infoElement.TypeOfError = entities.TypeOfError(1 + criticalityDiagnostics_IE_List__Member.typeOfError)
 109
 110                         infoElements = append(infoElements, infoElement)
 111
 112                 }
 113                 critDiag.InformationElementCriticalityDiagnostics = infoElements
 114         }
 115
 116         return critDiag, nil
 117 }
 118
 119 // Populate and return the EN-DC/X2 setup response failure structure with data from the pdu
 120 func x2SetupFailureResponseToProtobuf(pdu *C.E2AP_PDU_t) (*entities.SetupFailure, error) {
 121         setupFailure := entities.SetupFailure{}
 122
 123         if pdu.present == C.E2AP_PDU_PR_unsuccessfulOutcome {
 124                 //dereference a union of pointers (C union is represented as a byte array with the size of the largest member)
 125                 unsuccessfulOutcome := *(**C.UnsuccessfulOutcome_t)(unsafe.Pointer(&pdu.choice[0]))
 126                 if unsuccessfulOutcome != nil && unsuccessfulOutcome.value.present == C.UnsuccessfulOutcome__value_PR_X2SetupFailure {
 127                         x2SetupFailure := (*C.X2SetupFailure_t)(unsafe.Pointer(&unsuccessfulOutcome.value.choice[0]))
 128                         if x2SetupFailure != nil && x2SetupFailure.protocolIEs.list.count > 0 {
 129                                 count:=int(x2SetupFailure.protocolIEs.list.count)
 130                                 x2SetupFailure_IEs_slice := (*[1 << 30]*C.X2SetupFailure_IEs_t)(unsafe.Pointer(x2SetupFailure.protocolIEs.list.array))[:count:count]
 131                                 for _, x2SetupFailure_IE := range x2SetupFailure_IEs_slice {
 132                                         if x2SetupFailure_IE != nil {
 133                                                 switch x2SetupFailure_IE.value.present {
 134                                                 case C.X2SetupFailure_IEs__value_PR_Cause:
 135                                                         causeIE := (*C.Cause_t)(unsafe.Pointer(&x2SetupFailure_IE.value.choice[0]))
 136                                                         err := getCause(causeIE, &setupFailure)
 137                                                         if err != nil {
 138                                                                 return nil, err
 139                                                         }
 140                                                 case C.X2SetupFailure_IEs__value_PR_TimeToWait:
 141                                                         setupFailure.TimeToWait = entities.TimeToWait(1 + *((*C.TimeToWait_t)(unsafe.Pointer(&x2SetupFailure_IE.value.choice[0]))))
 142                                                 case C.X2SetupFailure_IEs__value_PR_CriticalityDiagnostics:
 143                                                         cdIE := (*C.CriticalityDiagnostics_t)(unsafe.Pointer(&x2SetupFailure_IE.value.choice[0]))
 144                                                         if cd, err := getCriticalityDiagnostics(cdIE); err == nil {
 145                                                                 setupFailure.CriticalityDiagnostics = cd
 146                                                         } else {
 147                                                                 return nil, err
 148                                                         }
 149                                                 }
 150                                         }
 151                                 }
 152                         }
 153                 }
 154         }
 155
 156         return &setupFailure, nil
 157 }
 158
 159 func (c *X2SetupFailureResponseConverter) UnpackX2SetupFailureResponseAndExtract(packedBuf []byte) (*entities.SetupFailure, error) {
 160         pdu, err := UnpackX2apPdu(c.logger, e2pdus.MaxAsn1CodecAllocationBufferSize, len(packedBuf), packedBuf, e2pdus.MaxAsn1CodecMessageBufferSize)
 161         if err != nil {
 162                 return nil, err
 163         }
 164
 165         defer C.delete_pdu(pdu)
 166
 167         return x2SetupFailureResponseToProtobuf(pdu)
 168 }