RSM/converters/resource_status_response_unpacker.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 <resource_status_response_wrapper.h>
  24 import "C"
  25 import (
  26         "fmt"
  27         "rsm/models"
  28         "unsafe"
  29 )
  30
  31 const (
  32         maxCellineNB         = 256
  33         maxFailedMeasObjects = 32
  34 )
  35
  36 type IResourceStatusResponseConverter interface {
  37         Convert(packedBuf []byte) (*models.ResourceStatusResponse, error)
  38         UnpackX2apPduAsString(packedBuf []byte, maxMessageBufferSize int) (string, error)
  39 }
  40
  41 type ResourceStatusResponseConverter struct {
  42         X2apPduUnpacker
  43 }
  44
  45 func NewResourceStatusResponseConverter(unpacker X2apPduUnpacker) ResourceStatusResponseConverter {
  46         return ResourceStatusResponseConverter{unpacker}
  47 }
  48
  49 func buildCellId(cellId C.ECGI_t) string {
  50         plmnId := C.GoBytes(unsafe.Pointer(cellId.pLMN_Identity.buf), C.int(cellId.pLMN_Identity.size))
  51         eutranCellIdentifier := C.GoBytes(unsafe.Pointer(cellId.eUTRANcellIdentifier.buf), C.int(cellId.eUTRANcellIdentifier.size))
  52         return fmt.Sprintf("%x:%x", plmnId, eutranCellIdentifier)
  53 }
  54
  55 func convertMeasurementFailureCauses(measurementFailureCause_List *C.MeasurementFailureCause_List_t, measurementInitiationResult *models.MeasurementInitiationResult) error {
  56         var MeasurementFailureCauses []*models.MeasurementFailureCause
  57
  58         count := int(measurementFailureCause_List.list.count)
  59         if count < 1 || count > maxFailedMeasObjects {
  60                 return fmt.Errorf("invalid number of failure cause elements, %d", int(count))
  61         }
  62
  63         measurementFailureCause_ItemIEs_slice := (*[1 << 30]*C.MeasurementFailureCause_ItemIEs_t)(unsafe.Pointer(measurementFailureCause_List.list.array))[:count:count]
  64         for _, itemIE := range measurementFailureCause_ItemIEs_slice {
  65                 switch itemIE.value.present {
  66                 case C.MeasurementFailureCause_ItemIEs__value_PR_MeasurementFailureCause_Item:
  67                         item := (*C.MeasurementFailureCause_Item_t)(unsafe.Pointer(&itemIE.value.choice[0]))
  68                         measurementFailedReportCharacteristics := C.GoBytes(unsafe.Pointer(item.measurementFailedReportCharacteristics.buf), C.int(item.measurementFailedReportCharacteristics.size))
  69                         measurementFailureCause := models.MeasurementFailureCause{MeasurementFailedReportCharacteristics: measurementFailedReportCharacteristics}
  70                         MeasurementFailureCauses = append(MeasurementFailureCauses, &measurementFailureCause)
  71                         /*Cause ignored - only need to know that the request failed and, possibly, which report characteristics failed*/
  72                 }
  73                 measurementInitiationResult.MeasurementFailureCauses = MeasurementFailureCauses
  74         }
  75
  76         return nil
  77 }
  78
  79 func convertMeasurementInitiationResult(measurementInitiationResult_List *C.MeasurementInitiationResult_List_t) ([]*models.MeasurementInitiationResult, error) {
  80         var measurementInitiationResults []*models.MeasurementInitiationResult
  81
  82         count := int(measurementInitiationResult_List.list.count)
  83         if count < 1 || count > maxCellineNB {
  84                 return nil, fmt.Errorf("invalid number of measurement initiation result elements, %d", count)
  85         }
  86         measurementInitiationResult_ItemIEs_slice := (*[1 << 30]*C.MeasurementInitiationResult_ItemIEs_t)(unsafe.Pointer(measurementInitiationResult_List.list.array))[:count:count]
  87         for _, itemIE := range measurementInitiationResult_ItemIEs_slice {
  88                 switch itemIE.value.present {
  89                 case C.MeasurementInitiationResult_ItemIEs__value_PR_MeasurementInitiationResult_Item:
  90                         item := (*C.MeasurementInitiationResult_Item_t)(unsafe.Pointer(&itemIE.value.choice[0]))
  91                         measurementInitiationResult := models.MeasurementInitiationResult{CellId: buildCellId(item.cell_ID)}
  92                         if item.measurementFailureCause_List != nil {
  93                                 if err:= convertMeasurementFailureCauses(item.measurementFailureCause_List, &measurementInitiationResult); err != nil {
  94                                         return nil, err
  95                                 }
  96                         }
  97                         measurementInitiationResults = append(measurementInitiationResults, &measurementInitiationResult)
  98                 }
  99
 100         }
 101
 102         return measurementInitiationResults, nil
 103 }
 104
 105 func convertResourceStatusIEs(resourceStatusResponse *C.ResourceStatusResponse_t, response *models.ResourceStatusResponse) error {
 106         count := int(resourceStatusResponse.protocolIEs.list.count)
 107         resourceStatusResponse_IEs_slice := (*[1 << 30]*C.ResourceStatusResponse_IEs_t)(unsafe.Pointer(resourceStatusResponse.protocolIEs.list.array))[:count:count]
 108         for _, resourceStatusResponse_IEs := range resourceStatusResponse_IEs_slice {
 109                 switch resourceStatusResponse_IEs.value.present {
 110                 case C.ResourceStatusResponse_IEs__value_PR_Measurement_ID:
 111                         measurement_ID := (*C.Measurement_ID_t)(unsafe.Pointer(&resourceStatusResponse_IEs.value.choice[0]))
 112                         if resourceStatusResponse_IEs.id == C.ProtocolIE_ID_id_ENB1_Measurement_ID {
 113                                 response.ENB1_Measurement_ID = int64(*measurement_ID)
 114                         }
 115                         if resourceStatusResponse_IEs.id == C.ProtocolIE_ID_id_ENB2_Measurement_ID {
 116                                 response.ENB2_Measurement_ID = int64(*measurement_ID)
 117                         }
 118                 case C.ResourceStatusResponse_IEs__value_PR_CriticalityDiagnostics:
 119                         /*ignored*/
 120
 121                 case C.ResourceStatusResponse_IEs__value_PR_MeasurementInitiationResult_List:
 122                         measurementInitiationResults, err := convertMeasurementInitiationResult((*C.MeasurementInitiationResult_List_t)(unsafe.Pointer(&resourceStatusResponse_IEs.value.choice[0])))
 123                         if err != nil {
 124                                 return err
 125                         }
 126                         response.MeasurementInitiationResults = measurementInitiationResults
 127                 }
 128         }
 129         return nil
 130 }
 131
 132 func convertResourceStatusResponse(pdu *C.E2AP_PDU_t) (*models.ResourceStatusResponse, error) {
 133         response := models.ResourceStatusResponse{}
 134
 135         if pdu.present != C.E2AP_PDU_PR_successfulOutcome {
 136                 return &response, fmt.Errorf("unexpected PDU, %d", int(pdu.present))
 137         }
 138
 139         //dereference a union of pointers (C union is represented as a byte array with the size of the largest member)
 140         successfulOutcome := *(**C.SuccessfulOutcome_t)(unsafe.Pointer(&pdu.choice[0]))
 141         if successfulOutcome == nil || successfulOutcome.value.present != C.SuccessfulOutcome__value_PR_ResourceStatusResponse {
 142                 return &response, fmt.Errorf("unexpected PDU - not a resource status response")
 143         }
 144
 145         resourceStatusResponse := (*C.ResourceStatusResponse_t)(unsafe.Pointer(&successfulOutcome.value.choice[0]))
 146         if resourceStatusResponse.protocolIEs.list.count == 0 {
 147                 return &response, fmt.Errorf("unexpected PDU - no protocolIEs found")
 148         }
 149
 150         if err := convertResourceStatusIEs(resourceStatusResponse, &response); err != nil {
 151                 return &response, err
 152         }
 153
 154         return &response, nil
 155 }
 156
 157 // Convert pdu to public ResourceStatusResponse
 158 func (r ResourceStatusResponseConverter) Convert(packedBuf []byte) (*models.ResourceStatusResponse, error) {
 159         pdu, err := r.UnpackX2apPdu(packedBuf)
 160         if err != nil {
 161                 return nil, err
 162         }
 163
 164         defer C.delete_pdu(pdu)
 165         return convertResourceStatusResponse(pdu)
 166 }