/*
 *  oFono - Open Source Telephony
 *  Copyright (C) 2024  Cruise, LLC
 *
 *  SPDX-License-Identifier: GPL-2.0-only
 */

#ifdef HAVE_CONFIG_H
#include <config.h>
#endif

#include "drivers/qmimodem/qmi.h"
#include <src/ofono.h>

#include <string.h>
#include <stdio.h>
#include <assert.h>
#include <ell/ell.h>

#include <sys/socket.h>
#include <linux/qrtr.h>

#define TEST_SERVICE_COUNT	2
#define TEST_TIMEOUT		5

/*
 * The amount of time to wait to validate that something did NOT occur. The
 * value is fairly arbitrary -- the longer it is, the longer the tests will take
 * to complete.
 */
#define ALLOWED_QRTR_TRANSFER_TIME 100 /* ms */

struct test_info {
	int service_fds[TEST_SERVICE_COUNT];
	struct qmi_qrtr_node *node;
	struct l_timeout *timeout;

	/* Data sent to our test service */
	struct sockaddr_qrtr sender;
	size_t received_len;
	void *received;

	bool lookup_callback_called		: 1;
	bool service_send_callback_called	: 1;
	bool internal_timeout_callback_called	: 1;
	bool notify_callback_called		: 1;
};

static void info_clear_received(struct test_info *info)
{
	l_free(info->received);
	info->received = NULL;
	info->received_len = 0;
}

static uint32_t unique_service_type(uint32_t index)
{
	/* Try to use a value that will not conflict with any real services. */
	return index + 10000;
}

static uint32_t unique_service_version(uint32_t index)
{
	return index + 10;
}

static uint32_t unique_service_instance(uint32_t index)
{
	return index + 20;
}

static int create_service(int i)
{
	int fd;
	struct sockaddr_qrtr addr;
	socklen_t addrlen;
	struct qrtr_ctrl_pkt packet;
	ssize_t bytes_sent;

	fd = socket(AF_QIPCRTR, SOCK_DGRAM, 0);
	if (fd == -1) {
		DBG("Could not create AF_QIPCRTR socket: %s", strerror(errno));
		return -errno;
	}

	/*
	 * The control node is configured by the system. Use getsockname to
	 * get its node.
	 */
	addrlen = sizeof(addr);
	if (getsockname(fd, (struct sockaddr *) &addr, &addrlen) == -1) {
		DBG("getsockname failed: %s", strerror(errno));
		goto error;
	}

	if (addr.sq_family != AF_QIPCRTR || addrlen != sizeof(addr)) {
		DBG("Unexpected sockaddr from getsockname. family: %d size: %d",
						addr.sq_family, addrlen);
		goto error;
	}

	/* Node and port are assigned automatically so no need to set them */
	memset(&packet, 0, sizeof(packet));
	packet.cmd = L_CPU_TO_LE32(QRTR_TYPE_NEW_SERVER);
	packet.server.service = L_CPU_TO_LE32(unique_service_type(i));
	packet.server.instance = L_CPU_TO_LE32(
					unique_service_instance(i) << 8 |
					unique_service_version(i));

	bytes_sent = sendto(fd, &packet, sizeof(packet), 0,
				(struct sockaddr *) &addr, addrlen);
	if (bytes_sent != sizeof(packet)) {
		DBG("sendto to set up the qrtr service failed: %s",
						strerror(errno));
		goto error;
	}

	return fd;

error:
	close(fd);

	return -errno;
}

static void setup_test_qrtr_services(struct test_info *info)
{
	int i;

	for (i = 0; i < TEST_SERVICE_COUNT; ++i) {
		info->service_fds[i] = create_service(i);
		assert(info->service_fds[i] >= 0);
	}
}

static void debug_log(const char *str, void *user_data)
{
	printf("%s\n", str);
}

static void test_timeout_cb(struct l_timeout *timeout, void *user_data)
{
	DBG("Test timed out!");
	assert(false);
}

static struct test_info *test_setup(void)
{
	struct test_info *info;

	l_main_init();

	info = l_new(struct test_info, 1);
	setup_test_qrtr_services(info);
	info->node = qmi_qrtr_node_new(0);
	assert(info->node);

	/* Enable ofono logging */
	qmi_qrtr_node_set_debug(info->node, debug_log, NULL);

	info->timeout = l_timeout_create(TEST_TIMEOUT, test_timeout_cb, info,
								NULL);

	return info;
}

static void test_cleanup(struct test_info *info)
{
	int i;

	l_free(info->received);
	l_timeout_remove(info->timeout);
	qmi_qrtr_node_free(info->node);

	/* The qrtr services will be destroyed automatically. */
	for (i = 0; i < TEST_SERVICE_COUNT; ++i)
		close(info->service_fds[i]);

	l_free(info);

	l_main_exit();
}

static void _l_test_cleanup_cleanup(void *p) { test_cleanup(*(void **) p); }

static void test_create_qrtr_node(const void *data)
{
	_auto_(test_cleanup) struct test_info *info = test_setup();
}

static void lookup_complete_cb(void *user_data)
{
	struct test_info *info = user_data;

	info->lookup_callback_called = true;
}

static void perform_lookup(struct test_info *info)
{
	qmi_qrtr_node_lookup(info->node, lookup_complete_cb, info, NULL);

	while (!info->lookup_callback_called)
		l_main_iterate(-1);
}

static void test_lookup(const void *data)
{
	_auto_(test_cleanup) struct test_info *info = test_setup();

	perform_lookup(info);
}

/* Callbacks could queue other callbacks so continue until there are no more. */
static void perform_all_pending_work(void)
{
	l_main_iterate(0);

	while (l_main_prepare() != -1)
		l_main_iterate(0);
}

static void test_create_services(const void *data)
{
	_auto_(test_cleanup) struct test_info *info = test_setup();
	struct qmi_service *services[3];
	uint32_t service_type;
	size_t i;

	perform_lookup(info);

	for (i = 0; i < TEST_SERVICE_COUNT; i++) {
		struct qmi_service *service;
		uint8_t version;

		service_type = unique_service_type(i);
		service = qmi_qrtr_node_get_service(info->node, service_type);
		assert(service);

		assert(qmi_service_get_version(service, &version));
		assert(version == unique_service_version(i));

		qmi_service_free(service);
	}

	/*
	 * Confirm that an unknown service cannot be created and does not
	 * call the callback.
	 */
	service_type = unique_service_type(TEST_SERVICE_COUNT);
	assert(!qmi_qrtr_node_get_service(info->node, service_type));

	/* Confirm that multiple services may be created for the same type */
	service_type = unique_service_type(0);

	for (i = 0; i < L_ARRAY_SIZE(services); i++) {
		services[i] = qmi_qrtr_node_get_service(info->node,
								service_type);
		assert(services[i]);
	}

	for (i = 0; i < L_ARRAY_SIZE(services); i++)
		qmi_service_free(services[i]);
}

static bool received_data(struct l_io *io, void *user_data)
{
	struct test_info *info = user_data;
	struct sockaddr_qrtr addr;
	unsigned char buf[2048];
	ssize_t bytes_read;
	socklen_t addr_size;

	addr_size = sizeof(addr);
	bytes_read = recvfrom(l_io_get_fd(io), buf, sizeof(buf), 0,
				(struct sockaddr *) &addr, &addr_size);

	/* Ignore control messages */
	if (addr.sq_port == QRTR_PORT_CTRL)
		return true;

	memcpy(&info->sender, &addr, sizeof(addr));

	assert(!info->received); /* Only expect one message */
	info->received_len = bytes_read;
	info->received = l_memdup(buf, bytes_read);

	return true;
}

#define TEST_TLV_TYPE		0x21	/* Its data value is 1 byte */
#define TEST_REQ_DATA_VALUE	0x89
#define TEST_RESP_DATA_VALUE	0x8A
#define TEST_IND_DATA_VALUE	0x8B

static void send_test_data_cb(struct qmi_result *result, void *user_data)
{
	struct test_info *info = user_data;

	uint8_t data;

	assert(!qmi_result_set_error(result, NULL));
	assert(qmi_result_get_uint8(result, TEST_TLV_TYPE, &data));
	assert(data == TEST_RESP_DATA_VALUE);

	info->service_send_callback_called = true;
}

/*
 * We know exactly how the qmi data should be packed so we can hard code the
 * structure layout to simplify the tests.
 */

#define TEST_REQ_MESSAGE_ID	42
#define TEST_RESP_MESSAGE_ID	43
#define TEST_IND_MESSAGE_ID	44
#define QMI_HDR_SIZE		7

enum qmi_message_type {
	QMI_MESSAGE_TYPE_REQ	= 0x00,
	QMI_MESSAGE_TYPE_RESP	= 0x02,
	QMI_MESSAGE_TYPE_IND	= 0x04,
};

struct qmi_test_service_request {
	uint8_t  type;
	uint16_t transaction;
	uint16_t message;
	uint16_t length;	/* Message size without header */
	uint8_t  data_type;
	uint16_t data_length;
	uint8_t  data_value;
} __attribute__ ((packed));

struct qmi_test_service_response {
	uint8_t  type;
	uint16_t transaction;
	uint16_t message;
	uint16_t length;	/* Message size without header */
	uint8_t  error_type;
	uint16_t error_length;
	uint16_t error_result;
	uint16_t error_error;
	uint8_t  data_type;
	uint16_t data_length;
	uint8_t  data_value;
} __attribute__ ((packed));

static void send_request_via_qmi(struct test_info *info,
						struct qmi_service *service)
{
	struct qmi_param *param;

	param = qmi_param_new();
	qmi_param_append_uint8(param, TEST_TLV_TYPE, TEST_REQ_DATA_VALUE);
	assert(qmi_service_send(service, TEST_REQ_MESSAGE_ID, param,
					send_test_data_cb, info, NULL));

	while (!info->received)
		l_main_iterate(-1);
}

static void send_message_to_client(struct sockaddr_qrtr *dest, struct l_io *io,
					uint8_t type, uint16_t transaction,
					uint16_t message, uint8_t data_value)
{
	struct qmi_test_service_response response;

	/*
	 * Now echo it back to the qrtr client. The qmi_service send callback
	 * will validate that the client processed this response correctly.
	 */
	memset(&response, 0, sizeof(response));
	response.type = type;
	response.transaction = transaction;
	response.message = L_CPU_TO_LE16(message);
	response.length = L_CPU_TO_LE16(sizeof(response) - QMI_HDR_SIZE);
	response.error_type = 2;
	response.error_length = L_CPU_TO_LE16(4);
	response.data_type = TEST_TLV_TYPE;
	response.data_length = 1;
	response.data_value = data_value;

	sendto(l_io_get_fd(io), &response, sizeof(response), 0,
					(struct sockaddr *) dest,
					sizeof(*dest));
}

static void send_response_to_client(struct test_info *info, struct l_io *io)
{
	const struct qmi_test_service_request *request;

	/* First validate that the qrtr code sent the qmi request properly. */
	assert(info->received_len == sizeof(*request));
	request = info->received;
	assert(request->type == 0x00);
	assert(request->message == L_CPU_TO_LE16(TEST_REQ_MESSAGE_ID));
	assert(request->length == L_CPU_TO_LE16(
					sizeof(*request) - QMI_HDR_SIZE));
	assert(request->data_type == TEST_TLV_TYPE);
	assert(request->data_length == L_CPU_TO_LE16(1));
	assert(request->data_value == TEST_REQ_DATA_VALUE);

	/*
	 * Now respond to the qrtr client. The qmi_service send callback
	 * will validate that the client processed this response correctly.
	 */
	send_message_to_client(&info->sender, io, QMI_MESSAGE_TYPE_RESP,
					request->transaction,
					TEST_RESP_MESSAGE_ID,
					TEST_RESP_DATA_VALUE);

	while (!info->service_send_callback_called)
		l_main_iterate(-1);
}

static struct qmi_service *service_common_setup(struct test_info *info,
								bool dedicated)
{
	uint32_t service_type;
	struct qmi_service *service;

	perform_lookup(info);

	service_type = unique_service_type(0); /* Use the first service */

	if (dedicated)
		service = qmi_qrtr_node_get_dedicated_service(info->node,
								service_type);
	else
		service = qmi_qrtr_node_get_service(info->node, service_type);

	assert(service);

	return service;
}

static struct l_io *setup_io(int fd, void *user_data)
{
	struct l_io *io = l_io_new(fd);

	assert(io);
	l_io_set_read_handler(io, received_data, user_data, NULL);
	return io;
}

/*
 * Initiates a send of the TLV data payload to the test service. The test
 * service will respond with the same data payload.
 */
static void test_send_data(const void *data)
{
	_auto_(test_cleanup) struct test_info *info = test_setup();
	struct l_io *io = setup_io(info->service_fds[0], info);
	struct qmi_service *service = service_common_setup(info, false);

	send_request_via_qmi(info, service);
	send_response_to_client(info, io);

	l_io_destroy(io);
	qmi_service_free(service);
}

static void notify_cb(struct qmi_result *result, void *user_data)
{
	struct test_info *info = user_data;
	uint8_t data;

	assert(!qmi_result_set_error(result, NULL));
	assert(qmi_result_get_uint8(result, TEST_TLV_TYPE, &data));
	assert(data == TEST_IND_DATA_VALUE);

	info->notify_callback_called = true;
}

static void internal_timeout_cb(struct l_timeout *timeout, void *user_data)
{
	struct test_info *info = user_data;

	info->internal_timeout_callback_called = true;
}

static void test_notifications(const void *data)
{
	_auto_(test_cleanup) struct test_info *info = test_setup();
	struct qmi_service *service = service_common_setup(info, false);
	struct l_io *io = setup_io(info->service_fds[0], info);
	struct l_timeout *receive_timeout;

	send_request_via_qmi(info, service);
	send_response_to_client(info, io);

	qmi_service_register(service, TEST_IND_MESSAGE_ID, notify_cb, info,
						NULL);
	send_message_to_client(&info->sender, io, QMI_MESSAGE_TYPE_IND, 0,
						TEST_IND_MESSAGE_ID,
						TEST_IND_DATA_VALUE);

	while (!info->notify_callback_called)
		l_main_iterate(-1);

	qmi_service_free(service);

	/* Confirm no notifications received after the service is destroyed */
	info->notify_callback_called = false;
	send_message_to_client(&info->sender, io, QMI_MESSAGE_TYPE_IND, 0,
						TEST_IND_MESSAGE_ID,
						TEST_IND_DATA_VALUE);

	receive_timeout = l_timeout_create_ms(ALLOWED_QRTR_TRANSFER_TIME,
						internal_timeout_cb, info,
						NULL);

	while (!info->internal_timeout_callback_called)
		perform_all_pending_work();

	assert(!info->notify_callback_called);

	l_timeout_remove(receive_timeout);

	l_io_destroy(io);
}

static void test_service_notification_independence(const void *data)
{
	_auto_(test_cleanup) struct test_info *info = test_setup();
	struct l_io *io;
	uint32_t service_type;
	struct qmi_service *services[2];
	size_t i;

	perform_lookup(info);

	service_type = unique_service_type(0); /* Use the first service */

	io = setup_io(info->service_fds[0], info);

	for (i = 0; i < L_ARRAY_SIZE(services); i++) {
		services[i] = qmi_qrtr_node_get_service(info->node,
								service_type);
		assert(services[i]);

		send_request_via_qmi(info, services[i]);
		send_response_to_client(info, io);

		qmi_service_register(services[i], TEST_IND_MESSAGE_ID,
						notify_cb, info, NULL);

		info_clear_received(info);
	}

	qmi_service_free(services[0]);

	send_message_to_client(&info->sender, io, QMI_MESSAGE_TYPE_IND, 0,
						TEST_IND_MESSAGE_ID,
						TEST_IND_DATA_VALUE);

	while (!info->notify_callback_called)
		l_main_iterate(-1);

	for (i = 1; i < L_ARRAY_SIZE(services); i++)
		qmi_service_free(services[i]);

	l_io_destroy(io);
}

static void test_dedicated(const void *data)
{
	_auto_(test_cleanup) struct test_info *info = test_setup();
	struct qmi_service *service = service_common_setup(info, true);
	struct l_io *io = setup_io(info->service_fds[0], info);

	send_request_via_qmi(info, service);
	send_response_to_client(info, io);

	l_io_destroy(io);
	qmi_service_free(service);
}

static void exit_if_qrtr_not_supported(void)
{
	int fd;

	fd = socket(AF_QIPCRTR, SOCK_DGRAM, 0);
	if (fd == -1) {
		printf("Could not create AF_QIPCRTR socket: %s\n",
					strerror(errno));
		printf("Skipping tests...\n");
		exit(0);
	}

	close(fd);
}

int main(int argc, char **argv)
{
	int result;

	exit_if_qrtr_not_supported();

	/* Enable all DBG logging */
	__ofono_log_init(argv[0], "*", FALSE);

	l_test_init(&argc, &argv);
	l_test_add("QRTR node creation", test_create_qrtr_node, NULL);
	l_test_add("QRTR lookup", test_lookup, NULL);
	l_test_add("QRTR services may be created", test_create_services, NULL);
	l_test_add("QRTR service sends/responses", test_send_data, NULL);
	l_test_add("QRTR notifications", test_notifications, NULL);
	l_test_add("QRTR service notifications are independent",
				test_service_notification_independence, NULL);
	l_test_add("QRTR dedicated service", test_dedicated, NULL);
	result = l_test_run();

	__ofono_log_cleanup();

	return result;
}
