J release: Release container Image
[ric-plt/e2mgr.git] / E2Manager / e2pdus / x2_setup_requests.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 <asn1codec_utils.h>
27 // #include <x2setup_request_wrapper.h>
28 import "C"
29 import (
30         "fmt"
31         "github.com/pkg/errors"
32         "unsafe"
33 )
34
35 const (
36         EnvRicId          = "RIC_ID"
37         ShortMacro_eNB_ID = 18
38         Macro_eNB_ID      = 20
39         LongMacro_eNB_ID  = 21
40         Home_eNB_ID       = 28
41 )
42
43 var PackedEndcX2setupRequest []byte
44 var PackedX2setupRequest []byte
45 var PackedEndcX2setupRequestAsString string
46 var PackedX2setupRequestAsString string
47
48 /*The Ric Id is the combination of pLMNId and ENBId*/
49 var pLMNId []byte
50 var eNBId []byte
51 var eNBIdBitqty uint
52 var ricFlag = []byte{0xbb, 0xbc, 0xcc} /*pLMNId [3]bytes*/
53
54 func preparePackedEndcX2SetupRequest(maxAsn1PackedBufferSize int, maxAsn1CodecMessageBufferSize int, pLMNId []byte, eNB_Id []byte /*18, 20, 21, 28 bits length*/, bitqty uint, ricFlag []byte) ([]byte, string, error) {
55         packedBuf := make([]byte, maxAsn1PackedBufferSize)
56         errBuf := make([]C.char, maxAsn1CodecMessageBufferSize)
57         packedBufSize := C.ulong(len(packedBuf))
58         pduAsString := ""
59
60         if !C.build_pack_endc_x2setup_request(
61                 (*C.uchar)(unsafe.Pointer(&pLMNId[0])) /*pLMN_Identity*/,
62                 (*C.uchar)(unsafe.Pointer(&eNB_Id[0])),
63                 C.uint(bitqty),
64                 (*C.uchar)(unsafe.Pointer(&ricFlag[0])) /*pLMN_Identity*/,
65                 &packedBufSize,
66                 (*C.uchar)(unsafe.Pointer(&packedBuf[0])),
67                 C.ulong(len(errBuf)),
68                 &errBuf[0]) {
69                 return nil, "", errors.New(fmt.Sprintf("packing error: %s", C.GoString(&errBuf[0])))
70         }
71
72         pdu := C.new_pdu(C.size_t(1)) //TODO: change signature
73         defer C.delete_pdu(pdu)
74         if C.per_unpack_pdu(pdu, packedBufSize, (*C.uchar)(unsafe.Pointer(&packedBuf[0])), C.size_t(len(errBuf)), &errBuf[0]) {
75                 C.asn1_pdu_printer(pdu, C.size_t(len(errBuf)), &errBuf[0])
76                 pduAsString = C.GoString(&errBuf[0])
77         }
78
79         return packedBuf[:packedBufSize], pduAsString, nil
80 }
81
82 func preparePackedX2SetupRequest(maxAsn1PackedBufferSize int, maxAsn1CodecMessageBufferSize int, pLMNId []byte, eNB_Id []byte /*18, 20, 21, 28 bits length*/, bitqty uint, ricFlag []byte) ([]byte, string, error) {
83         packedBuf := make([]byte, maxAsn1PackedBufferSize)
84         errBuf := make([]C.char, maxAsn1CodecMessageBufferSize)
85         packedBufSize := C.ulong(len(packedBuf))
86         pduAsString := ""
87
88         if !C.build_pack_x2setup_request(
89                 (*C.uchar)(unsafe.Pointer(&pLMNId[0])) /*pLMN_Identity*/,
90                 (*C.uchar)(unsafe.Pointer(&eNB_Id[0])),
91                 C.uint(bitqty),
92                 (*C.uchar)(unsafe.Pointer(&ricFlag[0])) /*pLMN_Identity*/,
93                 &packedBufSize,
94                 (*C.uchar)(unsafe.Pointer(&packedBuf[0])),
95                 C.ulong(len(errBuf)),
96                 &errBuf[0]) {
97                 return nil, "", errors.New(fmt.Sprintf("packing error: %s", C.GoString(&errBuf[0])))
98         }
99
100         pdu := C.new_pdu(C.size_t(1)) //TODO: change signature
101         defer C.delete_pdu(pdu)
102         if C.per_unpack_pdu(pdu, packedBufSize, (*C.uchar)(unsafe.Pointer(&packedBuf[0])), C.size_t(len(errBuf)), &errBuf[0]) {
103                 C.asn1_pdu_printer(pdu, C.size_t(len(errBuf)), &errBuf[0])
104                 pduAsString = C.GoString(&errBuf[0])
105         }
106         return packedBuf[:packedBufSize], pduAsString, nil
107 }
108
109 //Expected value in RIC_ID = pLMN_Identity-eNB_ID/<eNB_ID size in bits>
110 //<6 hex digits>-<6 or 8 hex digits>/<18|20|21|28>
111 //Each byte is represented by two hex digits, the value in the lowest byte of the eNB_ID must be assigned to the lowest bits
112 //For example, to get the value of ffffeab/28  the last byte must be 0x0b, not 0xb0 (-ffffea0b/28).
113 func parseRicID(ricId string) error {
114         if _, err := fmt.Sscanf(ricId, "%6x-%8x/%2d", &pLMNId, &eNBId, &eNBIdBitqty); err != nil {
115                 return fmt.Errorf("unable to extract the value of %s: %s", EnvRicId, err)
116         }
117
118         if len(pLMNId) < 3 {
119                 return fmt.Errorf("invalid value for %s, len(pLMNId:%v) != 3", EnvRicId, pLMNId)
120         }
121
122         if len(eNBId) < 3 {
123                 return fmt.Errorf("invalid value for %s, len(eNBId:%v) != 3 or 4", EnvRicId, eNBId)
124         }
125
126         if eNBIdBitqty != ShortMacro_eNB_ID && eNBIdBitqty != Macro_eNB_ID && eNBIdBitqty != LongMacro_eNB_ID && eNBIdBitqty != Home_eNB_ID {
127                 return fmt.Errorf("invalid value for %s, eNBIdBitqty: %d", EnvRicId, eNBIdBitqty)
128         }
129
130         return nil
131 }
132
133 func init() {
134         var err error
135         ricId := "bbbccc-abcd0e/20"
136         if err = parseRicID(ricId); err != nil {
137                 panic(err)
138         }
139
140         PackedEndcX2setupRequest, PackedEndcX2setupRequestAsString, err = preparePackedEndcX2SetupRequest(MaxAsn1PackedBufferSize, MaxAsn1CodecMessageBufferSize, pLMNId, eNBId, eNBIdBitqty, ricFlag)
141         if err != nil {
142                 panic(err)
143         }
144         PackedX2setupRequest, PackedX2setupRequestAsString, err = preparePackedX2SetupRequest(MaxAsn1PackedBufferSize, MaxAsn1CodecMessageBufferSize, pLMNId, eNBId, eNBIdBitqty, ricFlag)
145         if err != nil {
146                 panic(err)
147         }
148 }