E2Manager/e2pdus/x2_reset_known_causes.go

   1 /*
   2  *   Copyright (c) 2019 AT&T Intellectual Property.
   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 /*
  18  * This source code is part of the near-RT RIC (RAN Intelligent Controller)
  19  * platform project (RICP).
  20  */
  21
  22 package e2pdus
  23
  24 // #cgo CFLAGS: -I../3rdparty/asn1codec/inc/  -I../3rdparty/asn1codec/e2ap_engine/
  25 // #cgo LDFLAGS: -L ../3rdparty/asn1codec/lib/ -L../3rdparty/asn1codec/e2ap_engine/ -le2ap_codec -lasncodec
  26 // #include <x2reset_request_wrapper.h>
  27 import "C"
  28 import (
  29         "fmt"
  30         "strings"
  31         "unsafe"
  32 )
  33
  34 const (
  35         MaxAsn1PackedBufferSize       = 4096
  36         MaxAsn1CodecMessageBufferSize = 4096
  37         MaxAsn1CodecAllocationBufferSize = 4096 // TODO: remove later
  38 )
  39
  40 // Used as default by the x2_reset_request
  41 const (
  42         OmInterventionCause = "misc:om-intervention"
  43 )
  44
  45 type cause struct {
  46         causeGroup uint32
  47         cause      int
  48 }
  49
  50 var knownCauses = map[string]cause{
  51         "misc:control-processing-overload":                {causeGroup: C.Cause_PR_misc, cause: C.CauseMisc_control_processing_overload},
  52         "misc:hardware-failure":                           {causeGroup: C.Cause_PR_misc, cause: C.CauseMisc_hardware_failure},
  53         OmInterventionCause:                               {causeGroup: C.Cause_PR_misc, cause: C.CauseMisc_om_intervention},
  54         "misc:not-enough-user-plane-processing-resources": {causeGroup: C.Cause_PR_misc, cause: C.CauseMisc_not_enough_user_plane_processing_resources},
  55         "misc:unspecified":                                {causeGroup: C.Cause_PR_misc, cause: C.CauseMisc_unspecified},
  56
  57         "protocol:transfer-syntax-error":                             {causeGroup: C.Cause_PR_protocol, cause: C.CauseProtocol_transfer_syntax_error},
  58         "protocol:abstract-syntax-error-reject":                      {causeGroup: C.Cause_PR_protocol, cause: C.CauseProtocol_abstract_syntax_error_reject},
  59         "protocol:abstract-syntax-error-ignore-and-notify":           {causeGroup: C.Cause_PR_protocol, cause: C.CauseProtocol_abstract_syntax_error_ignore_and_notify},
  60         "protocol:message-not-compatible-with-receiver-state":        {causeGroup: C.Cause_PR_protocol, cause: C.CauseProtocol_message_not_compatible_with_receiver_state},
  61         "protocol:semantic-error":                                    {causeGroup: C.Cause_PR_protocol, cause: C.CauseProtocol_semantic_error},
  62         "protocol:unspecified":                                       {causeGroup: C.Cause_PR_protocol, cause: C.CauseProtocol_unspecified},
  63         "protocol:abstract-syntax-error-falsely-constructed-message": {causeGroup: C.Cause_PR_protocol, cause: C.CauseProtocol_abstract_syntax_error_falsely_constructed_message},
  64
  65         "transport:transport-resource-unavailable": {causeGroup: C.Cause_PR_transport, cause: C.CauseTransport_transport_resource_unavailable},
  66         "transport:unspecified":                    {causeGroup: C.Cause_PR_transport, cause: C.CauseTransport_unspecified},
  67
  68         "radioNetwork:handover-desirable-for-radio-reasons":                            {causeGroup: C.Cause_PR_radioNetwork, cause: C.CauseRadioNetwork_handover_desirable_for_radio_reasons},
  69         "radioNetwork:time-critical-handover":                                          {causeGroup: C.Cause_PR_radioNetwork, cause: C.CauseRadioNetwork_time_critical_handover},
  70         "radioNetwork:resource-optimisation-handover":                                  {causeGroup: C.Cause_PR_radioNetwork, cause: C.CauseRadioNetwork_resource_optimisation_handover},
  71         "radioNetwork:reduce-load-in-serving-cell":                                     {causeGroup: C.Cause_PR_radioNetwork, cause: C.CauseRadioNetwork_reduce_load_in_serving_cell},
  72         "radioNetwork:partial-handover":                                                {causeGroup: C.Cause_PR_radioNetwork, cause: C.CauseRadioNetwork_partial_handover},
  73         "radioNetwork:unknown-new-enb-ue-x2ap-id":                                      {causeGroup: C.Cause_PR_radioNetwork, cause: C.CauseRadioNetwork_unknown_new_eNB_UE_X2AP_ID},
  74         "radioNetwork:unknown-old-enb-ue-x2ap-id":                                      {causeGroup: C.Cause_PR_radioNetwork, cause: C.CauseRadioNetwork_unknown_old_eNB_UE_X2AP_ID},
  75         "radioNetwork:unknown-pair-of-ue-x2ap-id":                                      {causeGroup: C.Cause_PR_radioNetwork, cause: C.CauseRadioNetwork_unknown_pair_of_UE_X2AP_ID},
  76         "radioNetwork:ho-target-not-allowed":                                           {causeGroup: C.Cause_PR_radioNetwork, cause: C.CauseRadioNetwork_ho_target_not_allowed},
  77         "radioNetwork:tx2relocoverall-expiry":                                          {causeGroup: C.Cause_PR_radioNetwork, cause: C.CauseRadioNetwork_tx2relocoverall_expiry},
  78         "radioNetwork:trelocprep-expiry":                                               {causeGroup: C.Cause_PR_radioNetwork, cause: C.CauseRadioNetwork_trelocprep_expiry},
  79         "radioNetwork:cell-not-available":                                              {causeGroup: C.Cause_PR_radioNetwork, cause: C.CauseRadioNetwork_cell_not_available},
  80         "radioNetwork:no-radio-resources-available-in-target-cell":                     {causeGroup: C.Cause_PR_radioNetwork, cause: C.CauseRadioNetwork_no_radio_resources_available_in_target_cell},
  81         "radioNetwork:invalid-mme-groupid":                                             {causeGroup: C.Cause_PR_radioNetwork, cause: C.CauseRadioNetwork_invalid_MME_GroupID},
  82         "radioNetwork:unknown-mme-code":                                                {causeGroup: C.Cause_PR_radioNetwork, cause: C.CauseRadioNetwork_unknown_MME_Code},
  83         "radioNetwork:encryption-and-or-integrity-protection-algorithms-not-supported": {causeGroup: C.Cause_PR_radioNetwork, cause: C.CauseRadioNetwork_encryption_and_or_integrity_protection_algorithms_not_supported},
  84         "radioNetwork:reportcharacteristicsempty":                                      {causeGroup: C.Cause_PR_radioNetwork, cause: C.CauseRadioNetwork_reportCharacteristicsEmpty},
  85         "radioNetwork:noreportperiodicity":                                             {causeGroup: C.Cause_PR_radioNetwork, cause: C.CauseRadioNetwork_noReportPeriodicity},
  86         "radioNetwork:existingMeasurementID":                                           {causeGroup: C.Cause_PR_radioNetwork, cause: C.CauseRadioNetwork_existingMeasurementID},
  87         "radioNetwork:unknown-enb-measurement-id":                                      {causeGroup: C.Cause_PR_radioNetwork, cause: C.CauseRadioNetwork_unknown_eNB_Measurement_ID},
  88         "radioNetwork:measurement-temporarily-not-available":                           {causeGroup: C.Cause_PR_radioNetwork, cause: C.CauseRadioNetwork_measurement_temporarily_not_available},
  89         "radioNetwork:unspecified":                                                     {causeGroup: C.Cause_PR_radioNetwork, cause: C.CauseRadioNetwork_unspecified},
  90         "radioNetwork:load-balancing":                                                  {causeGroup: C.Cause_PR_radioNetwork, cause: C.CauseRadioNetwork_load_balancing},
  91         "radioNetwork:handover-optimisation":                                           {causeGroup: C.Cause_PR_radioNetwork, cause: C.CauseRadioNetwork_handover_optimisation},
  92         "radioNetwork:value-out-of-allowed-range":                                      {causeGroup: C.Cause_PR_radioNetwork, cause: C.CauseRadioNetwork_value_out_of_allowed_range},
  93         "radioNetwork:multiple-E-RAB-ID-instances":                                     {causeGroup: C.Cause_PR_radioNetwork, cause: C.CauseRadioNetwork_multiple_E_RAB_ID_instances},
  94         "radioNetwork:switch-off-ongoing":                                              {causeGroup: C.Cause_PR_radioNetwork, cause: C.CauseRadioNetwork_switch_off_ongoing},
  95         "radioNetwork:not-supported-qci-value":                                         {causeGroup: C.Cause_PR_radioNetwork, cause: C.CauseRadioNetwork_not_supported_QCI_value},
  96         "radioNetwork:measurement-not-supported-for-the-object":                        {causeGroup: C.Cause_PR_radioNetwork, cause: C.CauseRadioNetwork_measurement_not_supported_for_the_object},
  97         "radioNetwork:tdcoverall-expiry":                                               {causeGroup: C.Cause_PR_radioNetwork, cause: C.CauseRadioNetwork_tDCoverall_expiry},
  98         "radioNetwork:tdcprep-expiry":                                                  {causeGroup: C.Cause_PR_radioNetwork, cause: C.CauseRadioNetwork_tDCprep_expiry},
  99         "radioNetwork:action-desirable-for-radio-reasons":                              {causeGroup: C.Cause_PR_radioNetwork, cause: C.CauseRadioNetwork_action_desirable_for_radio_reasons},
 100         "radioNetwork:reduce-load":                                                     {causeGroup: C.Cause_PR_radioNetwork, cause: C.CauseRadioNetwork_reduce_load},
 101         "radioNetwork:resource-optimisation":                                           {causeGroup: C.Cause_PR_radioNetwork, cause: C.CauseRadioNetwork_resource_optimisation},
 102         "radioNetwork:time-critical-action":                                            {causeGroup: C.Cause_PR_radioNetwork, cause: C.CauseRadioNetwork_time_critical_action},
 103         "radioNetwork:target-not-allowed":                                              {causeGroup: C.Cause_PR_radioNetwork, cause: C.CauseRadioNetwork_target_not_allowed},
 104         "radioNetwork:no-radio-resources-available":                                    {causeGroup: C.Cause_PR_radioNetwork, cause: C.CauseRadioNetwork_no_radio_resources_available},
 105         "radioNetwork:invalid-qos-combination":                                         {causeGroup: C.Cause_PR_radioNetwork, cause: C.CauseRadioNetwork_invalid_QoS_combination},
 106         "radioNetwork:encryption-algorithms-not-aupported":                             {causeGroup: C.Cause_PR_radioNetwork, cause: C.CauseRadioNetwork_encryption_algorithms_not_aupported},
 107         "radioNetwork:procedure-cancelled":                                             {causeGroup: C.Cause_PR_radioNetwork, cause: C.CauseRadioNetwork_procedure_cancelled},
 108         "radioNetwork:rrm-purpose":                                                     {causeGroup: C.Cause_PR_radioNetwork, cause: C.CauseRadioNetwork_rRM_purpose},
 109         "radioNetwork:improve-user-bit-rate":                                           {causeGroup: C.Cause_PR_radioNetwork, cause: C.CauseRadioNetwork_improve_user_bit_rate},
 110         "radioNetwork:user-inactivity":                                                 {causeGroup: C.Cause_PR_radioNetwork, cause: C.CauseRadioNetwork_user_inactivity},
 111         "radioNetwork:radio-connection-with-ue-lost":                                   {causeGroup: C.Cause_PR_radioNetwork, cause: C.CauseRadioNetwork_radio_connection_with_UE_lost},
 112         "radioNetwork:failure-in-the-radio-interface-procedure":                        {causeGroup: C.Cause_PR_radioNetwork, cause: C.CauseRadioNetwork_failure_in_the_radio_interface_procedure},
 113         "radioNetwork:bearer-option-not-supported":                                     {causeGroup: C.Cause_PR_radioNetwork, cause: C.CauseRadioNetwork_bearer_option_not_supported},
 114         "radioNetwork:mcg-mobility":                                                    {causeGroup: C.Cause_PR_radioNetwork, cause: C.CauseRadioNetwork_mCG_Mobility},
 115         "radioNetwork:scg-mobility":                                                    {causeGroup: C.Cause_PR_radioNetwork, cause: C.CauseRadioNetwork_sCG_Mobility},
 116         "radioNetwork:count-reaches-max-value":                                         {causeGroup: C.Cause_PR_radioNetwork, cause: C.CauseRadioNetwork_count_reaches_max_value},
 117         "radioNetwork:unknown-old-en-gnb-ue-x2ap-id":                                   {causeGroup: C.Cause_PR_radioNetwork, cause: C.CauseRadioNetwork_unknown_old_en_gNB_UE_X2AP_ID},
 118         "radioNetwork:pdcp-Overload":                                                   {causeGroup: C.Cause_PR_radioNetwork, cause: C.CauseRadioNetwork_pDCP_Overload},
 119 }
 120
 121 var knownCausesToX2ResetPDUs = map[string][]byte{}
 122
 123 func prepareX2ResetPDUs(maxAsn1PackedBufferSize int, maxAsn1CodecMessageBufferSize int) error {
 124         packedBuffer := make([]C.uchar, maxAsn1PackedBufferSize)
 125         errorBuffer := make([]C.char, maxAsn1CodecMessageBufferSize)
 126
 127         for k, cause := range knownCauses {
 128                 var payloadSize = C.ulong(maxAsn1PackedBufferSize)
 129                 if status := C.build_pack_x2reset_request(cause.causeGroup, C.int(cause.cause), &payloadSize, &packedBuffer[0], C.ulong(maxAsn1CodecMessageBufferSize), &errorBuffer[0]); !status {
 130                         return fmt.Errorf("#x2_reset_known_causes.prepareX2ResetPDUs - failed to build and pack the reset message %s ", C.GoString(&errorBuffer[0]))
 131                 }
 132                 knownCausesToX2ResetPDUs[strings.ToLower(k)] = C.GoBytes(unsafe.Pointer(&packedBuffer[0]), C.int(payloadSize))
 133         }
 134         return nil
 135 }
 136
 137 // KnownCausesToX2ResetPDU returns a packed x2 reset pdu with the specified cause (case insensitive match).
 138 func KnownCausesToX2ResetPDU(cause string) ([]byte, bool) {
 139         v, ok := knownCausesToX2ResetPDUs[strings.ToLower(cause)]
 140         return v, ok
 141 }
 142
 143 func init() {
 144         if err := prepareX2ResetPDUs(MaxAsn1PackedBufferSize, MaxAsn1CodecMessageBufferSize); err != nil {
 145                 panic(err)
 146         }
 147 }