diff --git a/nfapi/open-nFAPI/fapi/inc/nr_fapi_p5.h b/nfapi/open-nFAPI/fapi/inc/nr_fapi_p5.h index f3d9fec52a3aa484b7b1aad97961d260c2d4e669..747c91d8d96b5e10401f806d55a974128efb2de0 100644 --- a/nfapi/open-nFAPI/fapi/inc/nr_fapi_p5.h +++ b/nfapi/open-nFAPI/fapi/inc/nr_fapi_p5.h @@ -40,4 +40,6 @@ uint8_t pack_nr_param_response(void *msg, uint8_t **ppWritePackedMsg, uint8_t *e uint8_t unpack_nr_param_response(uint8_t **ppReadPackedMsg, uint8_t *end, void *msg, nfapi_p4_p5_codec_config_t *config); uint8_t pack_nr_config_request(void *msg, uint8_t **ppWritePackedMsg, uint8_t *end, nfapi_p4_p5_codec_config_t *config); uint8_t unpack_nr_config_request(uint8_t **ppReadPackedMsg, uint8_t *end, void *msg, nfapi_p4_p5_codec_config_t *config); +uint8_t pack_nr_config_response(void *msg, uint8_t **ppWritePackedMsg, uint8_t *end, nfapi_p4_p5_codec_config_t *config); +uint8_t unpack_nr_config_response(uint8_t **ppReadPackedMsg, uint8_t *end, void *msg, nfapi_p4_p5_codec_config_t *config); #endif // OPENAIRINTERFACE_NR_FAPI_P5_H diff --git a/nfapi/open-nFAPI/fapi/src/nr_fapi_p5.c b/nfapi/open-nFAPI/fapi/src/nr_fapi_p5.c index 72502be3bac4d8264b9c89625bd7babbf9941b73..d1bea031110a8633c4aa3e62d2ec888b32fea053 100644 --- a/nfapi/open-nFAPI/fapi/src/nr_fapi_p5.c +++ b/nfapi/open-nFAPI/fapi/src/nr_fapi_p5.c @@ -1566,3 +1566,69 @@ uint8_t unpack_nr_config_request(uint8_t **ppReadPackedMsg, uint8_t *end, void * printf("[PNF] vnf p7 %s:%d\n", inet_ntoa(vnf_p7_sockaddr.sin_addr), pNfapiMsg->nfapi_config.p7_vnf_port.value); return 1; } + +uint8_t pack_nr_config_response(void *msg, uint8_t **ppWritePackedMsg, uint8_t *end, nfapi_p4_p5_codec_config_t *config) +{ + nfapi_nr_config_response_scf_t *pNfapiMsg = (nfapi_nr_config_response_scf_t *)msg; + uint8_t retval = push8(pNfapiMsg->error_code, ppWritePackedMsg, end); + retval &= push8(pNfapiMsg->num_invalid_tlvs, ppWritePackedMsg, end); + retval &= push8(pNfapiMsg->num_invalid_tlvs_configured_in_idle, ppWritePackedMsg, end); + retval &= push8(pNfapiMsg->num_invalid_tlvs_configured_in_running, ppWritePackedMsg, end); + retval &= push8(pNfapiMsg->num_missing_tlvs, ppWritePackedMsg, end); + + // pack lists + for (int i = 0; i < pNfapiMsg->num_invalid_tlvs; ++i) { + nfapi_nr_generic_tlv_scf_t *element = &(pNfapiMsg->invalid_tlvs_list[i]); + pack_nr_generic_tlv(element->tl.tag, element, ppWritePackedMsg, end); + } + for (int i = 0; i < pNfapiMsg->num_invalid_tlvs_configured_in_idle; ++i) { + nfapi_nr_generic_tlv_scf_t *element = &(pNfapiMsg->invalid_tlvs_configured_in_idle_list[i]); + pack_nr_generic_tlv(element->tl.tag, element, ppWritePackedMsg, end); + } + for (int i = 0; i < pNfapiMsg->num_invalid_tlvs_configured_in_running; ++i) { + nfapi_nr_generic_tlv_scf_t *element = &(pNfapiMsg->invalid_tlvs_configured_in_running_list[i]); + pack_nr_generic_tlv(element->tl.tag, element, ppWritePackedMsg, end); + } + for (int i = 0; i < pNfapiMsg->num_missing_tlvs; ++i) { + nfapi_nr_generic_tlv_scf_t *element = &(pNfapiMsg->missing_tlvs_list[i]); + pack_nr_generic_tlv(element->tl.tag, element, ppWritePackedMsg, end); + } + + retval &= pack_vendor_extension_tlv(pNfapiMsg->vendor_extension, ppWritePackedMsg, end, config); + return retval; +} + +uint8_t unpack_nr_config_response(uint8_t **ppReadPackedMsg, uint8_t *end, void *msg, nfapi_p4_p5_codec_config_t *config) +{ + nfapi_nr_config_response_scf_t *nfapi_resp = (nfapi_nr_config_response_scf_t *)msg; + uint8_t retval = pull8(ppReadPackedMsg, &nfapi_resp->error_code, end) + && pull8(ppReadPackedMsg, &nfapi_resp->num_invalid_tlvs, end) + && pull8(ppReadPackedMsg, &nfapi_resp->num_invalid_tlvs_configured_in_idle, end) + && pull8(ppReadPackedMsg, &nfapi_resp->num_invalid_tlvs_configured_in_running, end) + && pull8(ppReadPackedMsg, &nfapi_resp->num_missing_tlvs, end); + // First unpack the invalid_tlvs_list + // allocate the memory + nfapi_resp->invalid_tlvs_list = + (nfapi_nr_generic_tlv_scf_t *)malloc(nfapi_resp->num_invalid_tlvs * sizeof(nfapi_nr_generic_tlv_scf_t)); + nfapi_resp->invalid_tlvs_configured_in_idle_list = + (nfapi_nr_generic_tlv_scf_t *)malloc(nfapi_resp->num_invalid_tlvs_configured_in_idle * sizeof(nfapi_nr_generic_tlv_scf_t)); + nfapi_resp->invalid_tlvs_configured_in_running_list = + (nfapi_nr_generic_tlv_scf_t *)malloc(nfapi_resp->num_invalid_tlvs_configured_in_running * sizeof(nfapi_nr_generic_tlv_scf_t)); + nfapi_resp->missing_tlvs_list = + (nfapi_nr_generic_tlv_scf_t *)malloc(nfapi_resp->num_missing_tlvs * sizeof(nfapi_nr_generic_tlv_scf_t)); + + // unpack the TLV lists + unpack_nr_generic_tlv_list(nfapi_resp->invalid_tlvs_list, nfapi_resp->num_invalid_tlvs, ppReadPackedMsg, end); + unpack_nr_generic_tlv_list(nfapi_resp->invalid_tlvs_configured_in_idle_list, + nfapi_resp->num_invalid_tlvs_configured_in_idle, + ppReadPackedMsg, + end); + unpack_nr_generic_tlv_list(nfapi_resp->invalid_tlvs_configured_in_running_list, + nfapi_resp->num_invalid_tlvs_configured_in_running, + ppReadPackedMsg, + end); + unpack_nr_generic_tlv_list(nfapi_resp->missing_tlvs_list, nfapi_resp->num_missing_tlvs, ppReadPackedMsg, end); + // TODO: Process and use the invalid TLVs fields + retval &= unpack_nr_tlv_list(NULL, 0, ppReadPackedMsg, end, config, &(nfapi_resp->vendor_extension)); + return retval; +} diff --git a/nfapi/open-nFAPI/nfapi/public_inc/nfapi_interface.h b/nfapi/open-nFAPI/nfapi/public_inc/nfapi_interface.h index 3e5be8d2fd70c9a1b2638a7fd80b6ab63a0a7319..78f9fdca01af75d9c90bd194a150522d748c9482 100644 --- a/nfapi/open-nFAPI/nfapi/public_inc/nfapi_interface.h +++ b/nfapi/open-nFAPI/nfapi/public_inc/nfapi_interface.h @@ -4121,10 +4121,6 @@ int pack_nr_srs_beamforming_report(void *pMessageBuf, void *pPackedBuf, uint32_t */ int unpack_nr_srs_beamforming_report(void *pMessageBuf, uint32_t messageBufLen, void *pUnpackedBuf, uint32_t unpackedBufLen); -uint8_t pack_nr_config_response(void *msg, uint8_t **ppWritePackedMsg, uint8_t *end, nfapi_p4_p5_codec_config_t *config); - -uint8_t unpack_nr_config_response(uint8_t **ppReadPackedMsg, uint8_t *end, void *msg, nfapi_p4_p5_codec_config_t *config); - uint8_t pack_nr_start_request(void *msg, uint8_t **ppWritePackedMsg, uint8_t *end, nfapi_p4_p5_codec_config_t *config); uint8_t unpack_nr_start_request(uint8_t **ppReadPackedMsg, uint8_t *end, void *msg, nfapi_p4_p5_codec_config_t *config); diff --git a/nfapi/open-nFAPI/nfapi/src/nfapi_p5.c b/nfapi/open-nFAPI/nfapi/src/nfapi_p5.c index c31820ec226e33ccd6e701aeb0fd0fe0372f1e68..9519f5e1cea9866a75590e39bf40a41daeb60fd1 100644 --- a/nfapi/open-nFAPI/nfapi/src/nfapi_p5.c +++ b/nfapi/open-nFAPI/nfapi/src/nfapi_p5.c @@ -1146,37 +1146,6 @@ static uint8_t pack_config_request(void *msg, uint8_t **ppWritePackedMsg, uint8_ &pack_uint8_tlv_value)); } -uint8_t pack_nr_config_response(void *msg, uint8_t **ppWritePackedMsg, uint8_t *end, nfapi_p4_p5_codec_config_t *config) -{ - nfapi_nr_config_response_scf_t *pNfapiMsg = (nfapi_nr_config_response_scf_t *)msg; - uint8_t retval = push8(pNfapiMsg->error_code, ppWritePackedMsg, end); - retval &= push8(pNfapiMsg->num_invalid_tlvs, ppWritePackedMsg, end); - retval &= push8(pNfapiMsg->num_invalid_tlvs_configured_in_idle, ppWritePackedMsg, end); - retval &= push8(pNfapiMsg->num_invalid_tlvs_configured_in_running, ppWritePackedMsg, end); - retval &= push8(pNfapiMsg->num_missing_tlvs, ppWritePackedMsg, end); - - // pack lists - for (int i = 0; i < pNfapiMsg->num_invalid_tlvs; ++i) { - nfapi_nr_generic_tlv_scf_t *element = &(pNfapiMsg->invalid_tlvs_list[i]); - pack_nr_generic_tlv(element->tl.tag, element, ppWritePackedMsg, end); - } - for (int i = 0; i < pNfapiMsg->num_invalid_tlvs_configured_in_idle; ++i) { - nfapi_nr_generic_tlv_scf_t *element = &(pNfapiMsg->invalid_tlvs_configured_in_idle_list[i]); - pack_nr_generic_tlv(element->tl.tag, element, ppWritePackedMsg, end); - } - for (int i = 0; i < pNfapiMsg->num_invalid_tlvs_configured_in_running; ++i) { - nfapi_nr_generic_tlv_scf_t *element = &(pNfapiMsg->invalid_tlvs_configured_in_running_list[i]); - pack_nr_generic_tlv(element->tl.tag, element, ppWritePackedMsg, end); - } - for (int i = 0; i < pNfapiMsg->num_missing_tlvs; ++i) { - nfapi_nr_generic_tlv_scf_t *element = &(pNfapiMsg->missing_tlvs_list[i]); - pack_nr_generic_tlv(element->tl.tag, element, ppWritePackedMsg, end); - } - - retval &= pack_vendor_extension_tlv(pNfapiMsg->vendor_extension, ppWritePackedMsg, end, config); - return retval; -} - static uint8_t pack_config_response(void *msg, uint8_t **ppWritePackedMsg, uint8_t *end, nfapi_p4_p5_codec_config_t *config) { nfapi_config_response_t *pNfapiMsg = (nfapi_config_response_t *)msg; return ( push32(pNfapiMsg->error_code, ppWritePackedMsg, end) && @@ -2126,44 +2095,11 @@ static uint8_t unpack_config_request(uint8_t **ppReadPackedMsg, uint8_t *end, vo &pNfapiMsg->vendor_extension)); } -static uint8_t unpack_config_response(uint8_t **ppReadPackedMsg, uint8_t *end, void *msg, nfapi_p4_p5_codec_config_t *config) { - nfapi_config_response_t *pNfapiMsg = (nfapi_config_response_t *)msg; - return ( pull32(ppReadPackedMsg, &pNfapiMsg->error_code, end) && - unpack_tlv_list(NULL, 0, ppReadPackedMsg, end, config, &(pNfapiMsg->vendor_extension))); -} - -uint8_t unpack_nr_config_response(uint8_t **ppReadPackedMsg, uint8_t *end, void *msg, nfapi_p4_p5_codec_config_t *config) +static uint8_t unpack_config_response(uint8_t **ppReadPackedMsg, uint8_t *end, void *msg, nfapi_p4_p5_codec_config_t *config) { - nfapi_nr_config_response_scf_t *nfapi_resp = (nfapi_nr_config_response_scf_t *)msg; - uint8_t retval = pull8(ppReadPackedMsg, &nfapi_resp->error_code, end) - && pull8(ppReadPackedMsg, &nfapi_resp->num_invalid_tlvs, end) - && pull8(ppReadPackedMsg, &nfapi_resp->num_invalid_tlvs_configured_in_idle, end) - && pull8(ppReadPackedMsg, &nfapi_resp->num_invalid_tlvs_configured_in_running, end) - && pull8(ppReadPackedMsg, &nfapi_resp->num_missing_tlvs, end); - // First unpack the invalid_tlvs_list - // allocate the memory - nfapi_resp->invalid_tlvs_list = - (nfapi_nr_generic_tlv_scf_t *)malloc(nfapi_resp->num_invalid_tlvs * sizeof(nfapi_nr_generic_tlv_scf_t)); - nfapi_resp->invalid_tlvs_configured_in_idle_list = - (nfapi_nr_generic_tlv_scf_t *)malloc(nfapi_resp->num_invalid_tlvs_configured_in_idle * sizeof(nfapi_nr_generic_tlv_scf_t)); - nfapi_resp->invalid_tlvs_configured_in_running_list = - (nfapi_nr_generic_tlv_scf_t *)malloc(nfapi_resp->num_invalid_tlvs_configured_in_running * sizeof(nfapi_nr_generic_tlv_scf_t)); - nfapi_resp->missing_tlvs_list = - (nfapi_nr_generic_tlv_scf_t *)malloc(nfapi_resp->num_missing_tlvs * sizeof(nfapi_nr_generic_tlv_scf_t)); - - // unpack the TLV lists - unpack_nr_generic_tlv_list(nfapi_resp->invalid_tlvs_list, nfapi_resp->num_invalid_tlvs, ppReadPackedMsg, end); - unpack_nr_generic_tlv_list(nfapi_resp->invalid_tlvs_configured_in_idle_list, - nfapi_resp->num_invalid_tlvs_configured_in_idle, - ppReadPackedMsg, - end); - unpack_nr_generic_tlv_list(nfapi_resp->invalid_tlvs_configured_in_running_list, - nfapi_resp->num_invalid_tlvs_configured_in_running, - ppReadPackedMsg, - end); - unpack_nr_generic_tlv_list(nfapi_resp->missing_tlvs_list, nfapi_resp->num_missing_tlvs, ppReadPackedMsg, end); - retval &= unpack_nr_tlv_list(NULL, 0, ppReadPackedMsg, end, config, &(nfapi_resp->vendor_extension)); - return retval; + nfapi_config_response_t *pNfapiMsg = (nfapi_config_response_t *)msg; + return (pull32(ppReadPackedMsg, &pNfapiMsg->error_code, end) + && unpack_tlv_list(NULL, 0, ppReadPackedMsg, end, config, &(pNfapiMsg->vendor_extension))); } uint8_t unpack_nr_start_request(uint8_t **ppReadPackedMsg, uint8_t *end, void *msg, nfapi_p4_p5_codec_config_t *config) diff --git a/nfapi/tests/p5/CMakeLists.txt b/nfapi/tests/p5/CMakeLists.txt index d9e209ea4466910a63c31e616719677b31fdf5ee..105f87ac92128ba860a9acc0823aa65ebfc80efa 100644 --- a/nfapi/tests/p5/CMakeLists.txt +++ b/nfapi/tests/p5/CMakeLists.txt @@ -1,5 +1,5 @@ set(Test_Labels fapi p5) -set(_fapi_p5_messages "param_request;param_response;config_request") +set(_fapi_p5_messages "param_request;param_response;config_request;config_response") foreach (fapi_p5_message IN LISTS _fapi_p5_messages) add_executable(nr_fapi_${fapi_p5_message}_test nr_fapi_${fapi_p5_message}_test.c) diff --git a/nfapi/tests/p5/nr_fapi_config_response_test.c b/nfapi/tests/p5/nr_fapi_config_response_test.c new file mode 100644 index 0000000000000000000000000000000000000000..ae97b93c2ce9cada3be15e3c73ca76f2b848c3c7 --- /dev/null +++ b/nfapi/tests/p5/nr_fapi_config_response_test.c @@ -0,0 +1,144 @@ +/* + * Licensed to the OpenAirInterface (OAI) Software Alliance under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The OpenAirInterface Software Alliance licenses this file to You under + * the OAI Public License, Version 1.1 (the "License"); you may not use this file + * except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.openairinterface.org/?page_id=698 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + *------------------------------------------------------------------------------- + * For more information about the OpenAirInterface (OAI) Software Alliance: + * contact@openairinterface.org + */ +/*! \file nfapi/tests/p5/nr_fapi_config_response_test.c + * \brief Defines a unitary test for the FAPI CONFIG.response message ( 0x03 ) + * The test consists of filling a message with randomized data, filling each lists as well with random TLVs + * After the message is created, is is packed into a byte buffer + * After packing, the header is unpacked to mimic SCTP PEEK and the values unpacked checked against the original message + * After the header is checked, the whole message is unpacked. + * The test ends by checking all of the unpacked message contents against the original message + * \author Ruben S. Silva + * \date 2024 + * \version 0.1 + * \company OpenAirInterface Software Alliance + * \email: contact@openairinterface.org, rsilva@allbesmart.pt + * \note + * \warning + */ +#include "nfapi/tests/nr_fapi_test.h" +#include "nr_fapi_p5_utils.h" + +void fill_config_response_tlv_list(nfapi_nr_generic_tlv_scf_t *list, uint8_t size) +{ + uint8_t const TLVtypes[] = {UINT_8, UINT_16, UINT_32, ARRAY_UINT_16}; + for (int i = 0; i < size; ++i) { + nfapi_nr_generic_tlv_scf_t *element = &(list[i]); + element->tl.tag = rand16_range(NFAPI_NR_CONFIG_DL_BANDWIDTH_TAG, NFAPI_NR_CONFIG_RSSI_MEASUREMENT_TAG); + element->tl.length = TLVtypes[rand8_range(0, sizeof(TLVtypes) - 1)]; + switch (element->tl.length) { + case UINT_8: + element->value.u8 = rand8(); + break; + case UINT_16: + element->value.u16 = rand16(); + break; + case UINT_32: + element->value.u32 = rand32(); + break; + case ARRAY_UINT_16: + for (int j = 0; j < 5; ++j) { + element->value.array_u16[j] = rand16(); + } + break; + default: + break; + } + } +} + +void fill_config_response_tlv(nfapi_nr_config_response_scf_t *nfapi_resp) +{ + nfapi_resp->error_code = rand8(); + nfapi_resp->num_invalid_tlvs = rand8(); + nfapi_resp->num_invalid_tlvs_configured_in_idle = rand8(); + nfapi_resp->num_invalid_tlvs_configured_in_running = rand8(); + nfapi_resp->num_missing_tlvs = rand8(); + // Lists + nfapi_resp->invalid_tlvs_list = + (nfapi_nr_generic_tlv_scf_t *)malloc(nfapi_resp->num_invalid_tlvs * sizeof(nfapi_nr_generic_tlv_scf_t)); + nfapi_resp->invalid_tlvs_configured_in_idle_list = + (nfapi_nr_generic_tlv_scf_t *)malloc(nfapi_resp->num_invalid_tlvs_configured_in_idle * sizeof(nfapi_nr_generic_tlv_scf_t)); + nfapi_resp->invalid_tlvs_configured_in_running_list = + (nfapi_nr_generic_tlv_scf_t *)malloc(nfapi_resp->num_invalid_tlvs_configured_in_running * sizeof(nfapi_nr_generic_tlv_scf_t)); + nfapi_resp->missing_tlvs_list = + (nfapi_nr_generic_tlv_scf_t *)malloc(nfapi_resp->num_missing_tlvs * sizeof(nfapi_nr_generic_tlv_scf_t)); + + fill_config_response_tlv_list(nfapi_resp->invalid_tlvs_list, nfapi_resp->num_invalid_tlvs); + fill_config_response_tlv_list(nfapi_resp->invalid_tlvs_configured_in_idle_list, nfapi_resp->num_invalid_tlvs_configured_in_idle); + fill_config_response_tlv_list(nfapi_resp->invalid_tlvs_configured_in_running_list, + nfapi_resp->num_invalid_tlvs_configured_in_running); + fill_config_response_tlv_list(nfapi_resp->missing_tlvs_list, nfapi_resp->num_missing_tlvs); +} + +void test_pack_unpack(nfapi_nr_config_response_scf_t *req) +{ + uint8_t msg_buf[65535]; + uint16_t msg_len = sizeof(*req); + // first test the packing procedure + int pack_result = fapi_nr_p5_message_pack(req, msg_len, msg_buf, sizeof(msg_buf), NULL); + DevAssert(pack_result >= 0 + NFAPI_HEADER_LENGTH); + // update req message_length value with value calculated in message_pack procedure + req->header.message_length = pack_result - NFAPI_HEADER_LENGTH; + // test the unpacking of the header + // copy first NFAPI_HEADER_LENGTH bytes into a new buffer, to simulate SCTP PEEK + fapi_message_header_t header; + uint32_t header_buffer_size = NFAPI_HEADER_LENGTH; + uint8_t header_buffer[header_buffer_size]; + for (int idx = 0; idx < header_buffer_size; idx++) { + header_buffer[idx] = msg_buf[idx]; + } + uint8_t *pReadPackedMessage = header_buffer; + int unpack_header_result = fapi_nr_p5_message_header_unpack(&pReadPackedMessage, NFAPI_HEADER_LENGTH, &header, sizeof(header), 0); + DevAssert(unpack_header_result >= 0); + DevAssert(header.message_id == req->header.message_id); + DevAssert(header.message_length == req->header.message_length); + // test the unpacking and compare with initial message + nfapi_nr_config_response_scf_t unpacked_req = {0}; + int unpack_result = + fapi_nr_p5_message_unpack(msg_buf, header.message_length + NFAPI_HEADER_LENGTH, &unpacked_req, sizeof(unpacked_req), 0); + DevAssert(unpack_result >= 0); + DevAssert(eq_config_response(&unpacked_req, req)); + free_config_response(&unpacked_req); +} + +void test_copy(const nfapi_nr_config_response_scf_t *msg) +{ + // Test copy function + nfapi_nr_config_response_scf_t copy = {0}; + copy_config_response(msg, ©); + DevAssert(eq_config_response(msg, ©)); + free_config_response(©); +} + +int main(int n, char *v[]) +{ + fapi_test_init(); + + nfapi_nr_config_response_scf_t req = {.header.message_id = NFAPI_NR_PHY_MSG_TYPE_CONFIG_RESPONSE}; + // Fill Config response TVLs + fill_config_response_tlv(&req); + // Perform tests + test_pack_unpack(&req); + test_copy(&req); + // All tests successful! + free_config_response(&req); + return 0; +}