Test smm_variable_mm_service
Test mapping between the MM service and the RPC layer.
Signed-off-by: Imre Kis <imre.kis@arm.com>
Change-Id: I8bff5cd71d4e7adbfd790f3679498f94a2392c1f
diff --git a/components/service/smm_variable/frontend/mm_communicate/test/test_smm_variable_mm_service.cpp b/components/service/smm_variable/frontend/mm_communicate/test/test_smm_variable_mm_service.cpp
new file mode 100644
index 0000000..1973033
--- /dev/null
+++ b/components/service/smm_variable/frontend/mm_communicate/test/test_smm_variable_mm_service.cpp
@@ -0,0 +1,303 @@
+// SPDX-License-Identifier: BSD-3-Clause
+/*
+ * Copyright (c) 2021, Arm Limited and Contributors. All rights reserved.
+ */
+
+#include <CppUTest/TestHarness.h>
+#include <CppUTestExt/MockSupport.h>
+#include <string.h>
+#include <limits>
+#include "mock_assert.h"
+#include "components/rpc/common/test/mock_rpc_interface.h"
+#include "protocols/common/mm/mm_smc.h"
+#include "protocols/service/smm_variable/smm_variable_proto.h"
+#include "../smm_variable_mm_service.h"
+
+TEST_GROUP(smm_variable_mm_service)
+{
+ TEST_SETUP()
+ {
+ mock_rpc_interface_init();
+
+ memset(&service, 0x00, sizeof(service));
+ memset(&rpc_iface, 0x00, sizeof(rpc_iface));
+ memset(&rpc_req, 0x00, sizeof(rpc_req));
+ memset(&mm_req, 0x00, sizeof(mm_req));
+ }
+
+ TEST_TEARDOWN()
+ {
+ mock().checkExpectations();
+ mock().removeAllComparatorsAndCopiers();
+ mock().clear();
+ }
+
+ struct smm_variable_mm_service service = { 0 };
+ struct rpc_interface rpc_iface = { 0 };
+ struct call_req rpc_req = { 0 };
+ struct mm_service_call_req mm_req = { 0 };
+};
+
+TEST(smm_variable_mm_service, init_null_service)
+{
+ assert_environment_t env;
+
+ if (SETUP_ASSERT_ENVIRONMENT(env)) {
+ smm_variable_mm_service_init(NULL, NULL);
+ }
+}
+
+TEST(smm_variable_mm_service, init_null_iface)
+{
+ assert_environment_t env;
+
+ if (SETUP_ASSERT_ENVIRONMENT(env)) {
+ smm_variable_mm_service_init(&service, NULL);
+ }
+}
+
+TEST(smm_variable_mm_service, init)
+{
+ struct mm_service_interface *mm_service = NULL;
+
+ mm_service = smm_variable_mm_service_init(&service, &rpc_iface);
+
+ POINTERS_EQUAL(mm_service, &service.mm_service);
+ POINTERS_EQUAL(&rpc_iface, service.iface);
+ POINTERS_EQUAL(mm_service, mm_service->context);
+ CHECK(mm_service->receive != NULL);
+}
+
+TEST(smm_variable_mm_service, receive_too_small)
+{
+ struct mm_service_interface *mm_service = NULL;
+ int32_t result = 0;
+
+ mm_service = smm_variable_mm_service_init(&service, &rpc_iface);
+
+ mm_req.req_buf.data_len = SMM_VARIABLE_COMMUNICATE_HEADER_SIZE - 1;
+ result = mm_service->receive(mm_service, &mm_req);
+ LONGS_EQUAL(MM_RETURN_CODE_DENIED, result);
+}
+
+TEST(smm_variable_mm_service, receive_zero_data)
+{
+ struct mm_service_interface *mm_service = NULL;
+ uint8_t buffer[128] = { 0 };
+ SMM_VARIABLE_COMMUNICATE_HEADER *header = (SMM_VARIABLE_COMMUNICATE_HEADER *) buffer;
+ int32_t result = 0;
+
+ mm_req.req_buf.size = sizeof(buffer);
+ mm_req.req_buf.data_len = SMM_VARIABLE_COMMUNICATE_HEADER_SIZE;
+ mm_req.req_buf.data = buffer;
+
+ mm_req.resp_buf.size = sizeof(buffer);
+ mm_req.resp_buf.data_len = 0;
+ mm_req.resp_buf.data = buffer;
+
+ header->Function = 0x0123456789abcdefULL;
+ header->ReturnStatus = 0;
+
+ rpc_req.opcode = header->Function;
+ rpc_req.opstatus = 0xfedcba9876543210ULL;
+ rpc_req.req_buf.size = sizeof(buffer) - SMM_VARIABLE_COMMUNICATE_HEADER_SIZE;
+ rpc_req.req_buf.data_len = 0;
+ rpc_req.req_buf.data = buffer + SMM_VARIABLE_COMMUNICATE_HEADER_SIZE;
+ rpc_req.resp_buf.size = sizeof(buffer) - SMM_VARIABLE_COMMUNICATE_HEADER_SIZE;
+ rpc_req.resp_buf.data_len = 16;
+ rpc_req.resp_buf.data = buffer + SMM_VARIABLE_COMMUNICATE_HEADER_SIZE;
+
+ rpc_iface.receive = mock_rpc_interface_receive;
+
+ mm_service = smm_variable_mm_service_init(&service, &rpc_iface);
+
+ expect_mock_rpc_interface_receive(&rpc_iface, &rpc_req, TS_RPC_CALL_ACCEPTED);
+ result = mm_service->receive(mm_service, &mm_req);
+
+ LONGS_EQUAL(MM_RETURN_CODE_SUCCESS, result);
+ UNSIGNED_LONGLONGS_EQUAL(rpc_req.opstatus, header->ReturnStatus);
+ UNSIGNED_LONGLONGS_EQUAL(rpc_req.resp_buf.data_len + SMM_VARIABLE_COMMUNICATE_HEADER_SIZE,
+ mm_req.resp_buf.data_len);
+}
+
+TEST(smm_variable_mm_service, receive_data)
+{
+ struct mm_service_interface *mm_service = NULL;
+ uint8_t buffer[128] = { 0 };
+ SMM_VARIABLE_COMMUNICATE_HEADER *header = (SMM_VARIABLE_COMMUNICATE_HEADER *) buffer;
+ int32_t result = 0;
+
+ mm_req.req_buf.size = sizeof(buffer);
+ mm_req.req_buf.data_len = SMM_VARIABLE_COMMUNICATE_HEADER_SIZE + 32;
+ mm_req.req_buf.data = buffer;
+
+ mm_req.resp_buf.size = sizeof(buffer);
+ mm_req.resp_buf.data_len = 0;
+ mm_req.resp_buf.data = buffer;
+
+ header->Function = 0x0123456789abcdefULL;
+ header->ReturnStatus = 0;
+
+ rpc_req.opcode = header->Function;
+ rpc_req.opstatus = 0xfedcba9876543210ULL;
+ rpc_req.req_buf.size = sizeof(buffer) - SMM_VARIABLE_COMMUNICATE_HEADER_SIZE;
+ rpc_req.req_buf.data_len = 32;
+ rpc_req.req_buf.data = buffer + SMM_VARIABLE_COMMUNICATE_HEADER_SIZE;
+ rpc_req.resp_buf.size = sizeof(buffer) - SMM_VARIABLE_COMMUNICATE_HEADER_SIZE;
+ rpc_req.resp_buf.data_len = 16;
+ rpc_req.resp_buf.data = buffer + SMM_VARIABLE_COMMUNICATE_HEADER_SIZE;
+
+ rpc_iface.receive = mock_rpc_interface_receive;
+
+ mm_service = smm_variable_mm_service_init(&service, &rpc_iface);
+
+ expect_mock_rpc_interface_receive(&rpc_iface, &rpc_req, TS_RPC_CALL_ACCEPTED);
+ result = mm_service->receive(mm_service, &mm_req);
+
+ LONGS_EQUAL(MM_RETURN_CODE_SUCCESS, result);
+ UNSIGNED_LONGLONGS_EQUAL(rpc_req.opstatus, header->ReturnStatus);
+ UNSIGNED_LONGLONGS_EQUAL(rpc_req.resp_buf.data_len + SMM_VARIABLE_COMMUNICATE_HEADER_SIZE,
+ mm_req.resp_buf.data_len);
+}
+
+TEST(smm_variable_mm_service, receive_long_response)
+{
+ struct mm_service_interface *mm_service = NULL;
+ uint8_t buffer[128] = { 0 };
+ SMM_VARIABLE_COMMUNICATE_HEADER *header = (SMM_VARIABLE_COMMUNICATE_HEADER *) buffer;
+ int32_t result = 0;
+
+ mm_req.req_buf.size = sizeof(buffer);
+ mm_req.req_buf.data_len = SMM_VARIABLE_COMMUNICATE_HEADER_SIZE + 32;
+ mm_req.req_buf.data = buffer;
+
+ mm_req.resp_buf.size = sizeof(buffer);
+ mm_req.resp_buf.data_len = 0;
+ mm_req.resp_buf.data = buffer;
+
+ header->Function = 0x0123456789abcdefULL;
+ header->ReturnStatus = 0;
+
+ rpc_req.opcode = header->Function;
+ rpc_req.opstatus = 0xfedcba9876543210ULL;
+ rpc_req.req_buf.size = sizeof(buffer) - SMM_VARIABLE_COMMUNICATE_HEADER_SIZE;
+ rpc_req.req_buf.data_len = 32;
+ rpc_req.req_buf.data = buffer + SMM_VARIABLE_COMMUNICATE_HEADER_SIZE;
+ rpc_req.resp_buf.size = sizeof(buffer) - SMM_VARIABLE_COMMUNICATE_HEADER_SIZE;
+ rpc_req.resp_buf.data_len = std::numeric_limits<size_t>::max() - SMM_VARIABLE_COMMUNICATE_HEADER_SIZE + 1;
+ rpc_req.resp_buf.data = buffer + SMM_VARIABLE_COMMUNICATE_HEADER_SIZE;
+
+ rpc_iface.receive = mock_rpc_interface_receive;
+
+ mm_service = smm_variable_mm_service_init(&service, &rpc_iface);
+
+ expect_mock_rpc_interface_receive(&rpc_iface, &rpc_req, TS_RPC_CALL_ACCEPTED);
+ result = mm_service->receive(mm_service, &mm_req);
+
+ LONGS_EQUAL(MM_RETURN_CODE_NO_MEMORY, result);
+ UNSIGNED_LONGLONGS_EQUAL(rpc_req.opstatus, header->ReturnStatus);
+ UNSIGNED_LONGLONGS_EQUAL(rpc_req.resp_buf.data_len + SMM_VARIABLE_COMMUNICATE_HEADER_SIZE,
+ mm_req.resp_buf.data_len);
+}
+
+TEST(smm_variable_mm_service, receive_response_larger_than_size)
+{
+ struct mm_service_interface *mm_service = NULL;
+ uint8_t buffer[128] = { 0 };
+ SMM_VARIABLE_COMMUNICATE_HEADER *header = (SMM_VARIABLE_COMMUNICATE_HEADER *) buffer;
+ int32_t result = 0;
+
+ mm_req.req_buf.size = sizeof(buffer);
+ mm_req.req_buf.data_len = SMM_VARIABLE_COMMUNICATE_HEADER_SIZE + 32;
+ mm_req.req_buf.data = buffer;
+
+ mm_req.resp_buf.size = 15 + SMM_VARIABLE_COMMUNICATE_HEADER_SIZE;
+ mm_req.resp_buf.data_len = 0;
+ mm_req.resp_buf.data = buffer;
+
+ header->Function = 0x0123456789abcdefULL;
+ header->ReturnStatus = 0;
+
+ rpc_req.opcode = header->Function;
+ rpc_req.opstatus = 0xfedcba9876543210ULL;
+ rpc_req.req_buf.size = sizeof(buffer) - SMM_VARIABLE_COMMUNICATE_HEADER_SIZE;
+ rpc_req.req_buf.data_len = 32;
+ rpc_req.req_buf.data = buffer + SMM_VARIABLE_COMMUNICATE_HEADER_SIZE;
+ rpc_req.resp_buf.size = 15;
+ rpc_req.resp_buf.data_len = 16;
+ rpc_req.resp_buf.data = buffer + SMM_VARIABLE_COMMUNICATE_HEADER_SIZE;
+
+ rpc_iface.receive = mock_rpc_interface_receive;
+
+ mm_service = smm_variable_mm_service_init(&service, &rpc_iface);
+
+ expect_mock_rpc_interface_receive(&rpc_iface, &rpc_req, TS_RPC_CALL_ACCEPTED);
+ result = mm_service->receive(mm_service, &mm_req);
+
+ LONGS_EQUAL(MM_RETURN_CODE_NO_MEMORY, result);
+ UNSIGNED_LONGLONGS_EQUAL(rpc_req.opstatus, header->ReturnStatus);
+ UNSIGNED_LONGLONGS_EQUAL(rpc_req.resp_buf.data_len + SMM_VARIABLE_COMMUNICATE_HEADER_SIZE,
+ mm_req.resp_buf.data_len);
+}
+
+TEST(smm_variable_mm_service, receive_data_error_codes)
+{
+ struct mm_service_interface *mm_service = NULL;
+ uint8_t buffer[128] = { 0 };
+ SMM_VARIABLE_COMMUNICATE_HEADER *header = (SMM_VARIABLE_COMMUNICATE_HEADER *) buffer;
+ int32_t result = 0;
+
+ const struct {
+ rpc_status_t rpc_status;
+ int32_t mm_result;
+ } status_mapping[] = {
+ {TS_RPC_CALL_ACCEPTED, MM_RETURN_CODE_SUCCESS},
+ {TS_RPC_ERROR_EP_DOES_NOT_EXIT, MM_RETURN_CODE_NOT_SUPPORTED},
+ {TS_RPC_ERROR_INVALID_OPCODE, MM_RETURN_CODE_INVALID_PARAMETER},
+ {TS_RPC_ERROR_SERIALIZATION_NOT_SUPPORTED, MM_RETURN_CODE_INVALID_PARAMETER},
+ {TS_RPC_ERROR_INVALID_REQ_BODY, MM_RETURN_CODE_INVALID_PARAMETER},
+ {TS_RPC_ERROR_INVALID_RESP_BODY, MM_RETURN_CODE_INVALID_PARAMETER},
+ {TS_RPC_ERROR_RESOURCE_FAILURE, MM_RETURN_CODE_NOT_SUPPORTED},
+ {TS_RPC_ERROR_NOT_READY, MM_RETURN_CODE_NOT_SUPPORTED},
+ {TS_RPC_ERROR_INVALID_TRANSACTION, MM_RETURN_CODE_INVALID_PARAMETER},
+ {TS_RPC_ERROR_INTERNAL, MM_RETURN_CODE_NOT_SUPPORTED},
+ {TS_RPC_ERROR_INVALID_PARAMETER, MM_RETURN_CODE_INVALID_PARAMETER},
+ {TS_RPC_ERROR_INTERFACE_DOES_NOT_EXIST, MM_RETURN_CODE_NOT_SUPPORTED},
+ {1, MM_RETURN_CODE_NOT_SUPPORTED}
+
+ };
+
+ mm_req.req_buf.size = sizeof(buffer);
+ mm_req.req_buf.data_len = SMM_VARIABLE_COMMUNICATE_HEADER_SIZE + 32;
+ mm_req.req_buf.data = buffer;
+
+ mm_req.resp_buf.size = sizeof(buffer);
+ mm_req.resp_buf.data_len = 0;
+ mm_req.resp_buf.data = buffer;
+
+ header->Function = 0x0123456789abcdefULL;
+ header->ReturnStatus = 0;
+
+ rpc_req.opcode = header->Function;
+ rpc_req.opstatus = 0xfedcba9876543210ULL;
+ rpc_req.req_buf.size = sizeof(buffer) - SMM_VARIABLE_COMMUNICATE_HEADER_SIZE;
+ rpc_req.req_buf.data_len = 32;
+ rpc_req.req_buf.data = buffer + SMM_VARIABLE_COMMUNICATE_HEADER_SIZE;
+ rpc_req.resp_buf.size = sizeof(buffer) - SMM_VARIABLE_COMMUNICATE_HEADER_SIZE;
+ rpc_req.resp_buf.data_len = 16;
+ rpc_req.resp_buf.data = buffer + SMM_VARIABLE_COMMUNICATE_HEADER_SIZE;
+
+ rpc_iface.receive = mock_rpc_interface_receive;
+
+ mm_service = smm_variable_mm_service_init(&service, &rpc_iface);
+
+ for (size_t i = 0; i < ARRAY_SIZE(status_mapping); i++) {
+ expect_mock_rpc_interface_receive(&rpc_iface, &rpc_req, status_mapping[i].rpc_status);
+ result = mm_service->receive(mm_service, &mm_req);
+
+ LONGS_EQUAL(status_mapping[i].mm_result, result);
+ UNSIGNED_LONGLONGS_EQUAL(rpc_req.opstatus, header->ReturnStatus);
+ UNSIGNED_LONGLONGS_EQUAL(rpc_req.resp_buf.data_len + SMM_VARIABLE_COMMUNICATE_HEADER_SIZE,
+ mm_req.resp_buf.data_len);
+ }
+}
diff --git a/components/service/smm_variable/frontend/mm_communicate/tests.cmake b/components/service/smm_variable/frontend/mm_communicate/tests.cmake
new file mode 100644
index 0000000..d1f930c
--- /dev/null
+++ b/components/service/smm_variable/frontend/mm_communicate/tests.cmake
@@ -0,0 +1,25 @@
+#
+# Copyright (c) 2021, Arm Limited. All rights reserved.
+#
+# SPDX-License-Identifier: BSD-3-Clause
+#
+
+include(UnitTest)
+
+unit_test_add_suite(
+ NAME smm_variable_mm_service
+ SOURCES
+ ${CMAKE_CURRENT_LIST_DIR}/smm_variable_mm_service.c
+ ${CMAKE_CURRENT_LIST_DIR}/test/test_smm_variable_mm_service.cpp
+ ${UNIT_TEST_PROJECT_PATH}/components/rpc/common/test/mock_rpc_interface.cpp
+ ${UNIT_TEST_PROJECT_PATH}/components/messaging/ffa/libsp/test/mock_assert.cpp
+ INCLUDE_DIRECTORIES
+ ${UNIT_TEST_PROJECT_PATH}
+ ${UNIT_TEST_PROJECT_PATH}/components/rpc/mm_communicate/endpoint/sp
+ ${UNIT_TEST_PROJECT_PATH}/components/common/utils/include
+ ${UNIT_TEST_PROJECT_PATH}/components/messaging/ffa/libsp/include
+ ${UNIT_TEST_PROJECT_PATH}/components/messaging/ffa/libsp/test
+ ${UNIT_TEST_PROJECT_PATH}/components/rpc/common/interface
+ COMPILE_DEFINITIONS
+ -DARM64
+)
diff --git a/deployments/smm-gateway/linux-pc/CMakeLists.txt b/deployments/smm-gateway/linux-pc/CMakeLists.txt
index 2608121..09a1333 100644
--- a/deployments/smm-gateway/linux-pc/CMakeLists.txt
+++ b/deployments/smm-gateway/linux-pc/CMakeLists.txt
@@ -52,3 +52,4 @@
include(${TS_ROOT}/components/rpc/common/tests.cmake)
include(${TS_ROOT}/components/rpc/mm_communicate/endpoint/sp/tests.cmake)
+include(${TS_ROOT}/components/service/smm_variable/frontend/mm_communicate/tests.cmake)