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
  18 package converters
  19
  20 // #cgo CFLAGS: -I../asn1codec/inc/ -I../asn1codec/e2ap_engine/
  21 // #cgo LDFLAGS: -L ../asn1codec/lib/ -L../asn1codec/e2ap_engine/ -le2ap_codec -lasncodec
  22 // #include <asn1codec_utils.h>
  23 // #include <x2setup_response_wrapper.h>
  24 import "C"
  25 import (
  26         "e2mgr/e2pdus"
  27         "e2mgr/logger"
  28         "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/entities"
  29         "unsafe"
  30 )
  31
  32 const (
  33         maxNrOfErrors = 256
  34 )
  35
  36 type X2SetupFailureResponseConverter struct {
  37         logger *logger.Logger
  38 }
  39
  40 type IX2SetupFailureResponseConverter interface {
  41         UnpackX2SetupFailureResponseAndExtract(packedBuf []byte) (*entities.SetupFailure, error)
  42 }
  43
  44 func NewX2SetupFailureResponseConverter(logger *logger.Logger) *X2SetupFailureResponseConverter {
  45         return &X2SetupFailureResponseConverter{
  46                 logger: logger,
  47         }
  48 }
  49
  50 // The following are possible values of a choice field, find which the pdu contains.
  51 func getCause(causeIE *C.Cause_t, setupFailure *entities.SetupFailure) error {
  52         switch causeIE.present {
  53         case C.Cause_PR_radioNetwork:
  54                 v := (*C.CauseRadioNetwork_t)(unsafe.Pointer(&causeIE.choice[0]))
  55                 setupFailure.CauseGroup = &entities.SetupFailure_NetworkLayerCause{NetworkLayerCause: entities.RadioNetworkLayer_Cause(1 + *v)}
  56         case C.Cause_PR_transport:
  57                 v := (*C.CauseTransport_t)(unsafe.Pointer(&causeIE.choice[0]))
  58                 setupFailure.CauseGroup = &entities.SetupFailure_TransportLayerCause{TransportLayerCause: entities.TransportLayer_Cause(1 + *v)}
  59         case C.Cause_PR_protocol:
  60                 v := (*C.CauseProtocol_t)(unsafe.Pointer(&causeIE.choice[0]))
  61                 setupFailure.CauseGroup = &entities.SetupFailure_ProtocolCause{ProtocolCause: entities.Protocol_Cause(1 + *v)}
  62         case C.Cause_PR_misc:
  63                 v := (*C.CauseMisc_t)(unsafe.Pointer(&causeIE.choice[0]))
  64                 setupFailure.CauseGroup = &entities.SetupFailure_MiscellaneousCause{MiscellaneousCause: entities.Miscellaneous_Cause(1 + *v)}
  65         }
  66         return nil
  67 }
  68
  69 func getCriticalityDiagnostics(critDiagIE *C.CriticalityDiagnostics_t) (*entities.CriticalityDiagnostics, error) {
  70         var critDiag *entities.CriticalityDiagnostics
  71
  72         if critDiagIE.procedureCode != nil {
  73                 critDiag = &entities.CriticalityDiagnostics{}
  74                 critDiag.ProcedureCode = uint32(*critDiagIE.procedureCode)
  75
  76         }
  77
  78         if critDiagIE.triggeringMessage != nil {
  79                 if critDiag == nil {
  80                         critDiag = &entities.CriticalityDiagnostics{}
  81                 }
  82                 critDiag.TriggeringMessage = entities.TriggeringMessage(1 + *critDiagIE.triggeringMessage)
  83
  84         }
  85
  86         if critDiagIE.procedureCriticality != nil {
  87                 if critDiag == nil {
  88                         critDiag = &entities.CriticalityDiagnostics{}
  89                 }
  90                 critDiag.ProcedureCriticality = entities.Criticality(1 + *critDiagIE.procedureCriticality)
  91
  92         }
  93
  94         if critDiagIE.iEsCriticalityDiagnostics != nil && critDiagIE.iEsCriticalityDiagnostics.list.count > 0 && critDiagIE.iEsCriticalityDiagnostics.list.count < maxNrOfErrors {
  95                 if critDiag == nil {
  96                         critDiag = &entities.CriticalityDiagnostics{}
  97                 }
  98                 var infoElements []*entities.InformationElementCriticalityDiagnostic
  99                 iEsCriticalityDiagnostics := (*C.CriticalityDiagnostics_IE_List_t)(critDiagIE.iEsCriticalityDiagnostics)
 100                 count:=int(iEsCriticalityDiagnostics.list.count)
 101                 iEsCriticalityDiagnostics_slice := (*[1 << 30]*C.CriticalityDiagnostics_IE_List__Member)(unsafe.Pointer(iEsCriticalityDiagnostics.list.array))[:count:count]
 102                 for _, criticalityDiagnostics_IE_List__Member := range  iEsCriticalityDiagnostics_slice {
 103                         infoElement := &entities.InformationElementCriticalityDiagnostic{IeCriticality: entities.Criticality(1 + criticalityDiagnostics_IE_List__Member.iECriticality)}
 104                         infoElement.IeId = uint32(criticalityDiagnostics_IE_List__Member.iE_ID)
 105                         infoElement.TypeOfError = entities.TypeOfError(1 + criticalityDiagnostics_IE_List__Member.typeOfError)
 106
 107                         infoElements = append(infoElements, infoElement)
 108
 109                 }
 110                 critDiag.InformationElementCriticalityDiagnostics = infoElements
 111         }
 112
 113         return critDiag, nil
 114 }
 115
 116 // Populate and return the EN-DC/X2 setup response failure structure with data from the pdu
 117 func x2SetupFailureResponseToProtobuf(pdu *C.E2AP_PDU_t) (*entities.SetupFailure, error) {
 118         setupFailure := entities.SetupFailure{}
 119
 120         if pdu.present == C.E2AP_PDU_PR_unsuccessfulOutcome {
 121                 //dereference a union of pointers (C union is represented as a byte array with the size of the largest member)
 122                 unsuccessfulOutcome := *(**C.UnsuccessfulOutcome_t)(unsafe.Pointer(&pdu.choice[0]))
 123                 if unsuccessfulOutcome != nil && unsuccessfulOutcome.value.present == C.UnsuccessfulOutcome__value_PR_X2SetupFailure {
 124                         x2SetupFailure := (*C.X2SetupFailure_t)(unsafe.Pointer(&unsuccessfulOutcome.value.choice[0]))
 125                         if x2SetupFailure != nil && x2SetupFailure.protocolIEs.list.count > 0 {
 126                                 count:=int(x2SetupFailure.protocolIEs.list.count)
 127                                 x2SetupFailure_IEs_slice := (*[1 << 30]*C.X2SetupFailure_IEs_t)(unsafe.Pointer(x2SetupFailure.protocolIEs.list.array))[:count:count]
 128                                 for _, x2SetupFailure_IE := range x2SetupFailure_IEs_slice {
 129                                         if x2SetupFailure_IE != nil {
 130                                                 switch x2SetupFailure_IE.value.present {
 131                                                 case C.X2SetupFailure_IEs__value_PR_Cause:
 132                                                         causeIE := (*C.Cause_t)(unsafe.Pointer(&x2SetupFailure_IE.value.choice[0]))
 133                                                         err := getCause(causeIE, &setupFailure)
 134                                                         if err != nil {
 135                                                                 return nil, err
 136                                                         }
 137                                                 case C.X2SetupFailure_IEs__value_PR_TimeToWait:
 138                                                         setupFailure.TimeToWait = entities.TimeToWait(1 + *((*C.TimeToWait_t)(unsafe.Pointer(&x2SetupFailure_IE.value.choice[0]))))
 139                                                 case C.X2SetupFailure_IEs__value_PR_CriticalityDiagnostics:
 140                                                         cdIE := (*C.CriticalityDiagnostics_t)(unsafe.Pointer(&x2SetupFailure_IE.value.choice[0]))
 141                                                         if cd, err := getCriticalityDiagnostics(cdIE); err == nil {
 142                                                                 setupFailure.CriticalityDiagnostics = cd
 143                                                         } else {
 144                                                                 return nil, err
 145                                                         }
 146                                                 }
 147                                         }
 148                                 }
 149                         }
 150                 }
 151         }
 152
 153         return &setupFailure, nil
 154 }
 155
 156 func (c *X2SetupFailureResponseConverter) UnpackX2SetupFailureResponseAndExtract(packedBuf []byte) (*entities.SetupFailure, error) {
 157         pdu, err := UnpackX2apPdu(c.logger, e2pdus.MaxAsn1CodecAllocationBufferSize, len(packedBuf), packedBuf, e2pdus.MaxAsn1CodecMessageBufferSize)
 158         if err != nil {
 159                 return nil, err
 160         }
 161
 162         defer C.delete_pdu(pdu)
 163
 164         return x2SetupFailureResponseToProtobuf(pdu)
 165 }