zephyr/subsys/net/lib/lwm2m/lwm2m_pull_context.c

/*
 * Copyright (c) 2017 Linaro Limited
 * Copyright (c) 2018-2019 Foundries.io
 *
 * SPDX-License-Identifier: Apache-2.0
 */

#define LOG_MODULE_NAME net_lwm2m_pull_context
#define LOG_LEVEL CONFIG_LWM2M_LOG_LEVEL

#include <zephyr/logging/log.h>
LOG_MODULE_REGISTER(LOG_MODULE_NAME);

#include <ctype.h>
#include <stdio.h>
#include <string.h>

#include <zephyr/net/http/parser.h>
#include <zephyr/net/socket.h>

#include "lwm2m_pull_context.h"
#include "lwm2m_engine.h"
#include "lwm2m_util.h"

static K_SEM_DEFINE(lwm2m_pull_sem, 1, 1);

#if defined(CONFIG_LWM2M_FIRMWARE_UPDATE_PULL_COAP_PROXY_SUPPORT)
#define COAP2COAP_PROXY_URI_PATH "coap2coap"
#define COAP2HTTP_PROXY_URI_PATH "coap2http"

static char proxy_uri[LWM2M_PACKAGE_URI_LEN];
#endif

static void do_transmit_timeout_cb(struct lwm2m_message *msg);

static struct firmware_pull_context {
	uint8_t obj_inst_id;
	char uri[LWM2M_PACKAGE_URI_LEN];
	bool is_firmware_uri;
	void (*result_cb)(uint16_t obj_inst_id, int error_code);
	lwm2m_engine_set_data_cb_t write_cb;

	struct lwm2m_ctx firmware_ctx;
	struct coap_block_context block_ctx;
} context;

static enum service_state {
	NOT_STARTED,
	IDLE,
	STOPPING,
} pull_service_state;

static void pull_service(struct k_work *work)
{
	ARG_UNUSED(work);
	switch (pull_service_state) {
	case NOT_STARTED:
		pull_service_state = IDLE;
		/* Set a long 5s time for a service that does not do anything*/
		/* Will be set to smaller, when there is time to clena up */
		lwm2m_engine_update_service_period(pull_service, 5000);
		break;
	case IDLE:
		/* Nothing to do */
		break;
	case STOPPING:
		/* Clean up the current socket context */
		lwm2m_engine_stop(&context.firmware_ctx);
		lwm2m_engine_update_service_period(pull_service, 5000);
		pull_service_state = IDLE;
		k_sem_give(&lwm2m_pull_sem);
		break;
	}
}

static int start_service(void)
{
	if (pull_service_state != NOT_STARTED) {
		return 0;
	}

	return lwm2m_engine_add_service(pull_service, 1);
}

/**
 * Close all open connections and release the context semaphore
 */
static void cleanup_context(void)
{
	pull_service_state = STOPPING;
	lwm2m_engine_update_service_period(pull_service, 1);
}

static int transfer_request(struct coap_block_context *ctx, uint8_t *token, uint8_t tkl,
			    coap_reply_t reply_cb)
{
	struct lwm2m_message *msg;
	int ret;
	char *cursor;
#if !defined(CONFIG_LWM2M_FIRMWARE_UPDATE_PULL_COAP_PROXY_SUPPORT)
	struct http_parser_url parser;
	uint16_t off, len;
	char *next_slash;
#endif

	msg = lwm2m_get_message(&context.firmware_ctx);
	if (!msg) {
		LOG_ERR("Unable to get a lwm2m message!");
		return -ENOMEM;
	}

	msg->type = COAP_TYPE_CON;
	msg->code = COAP_METHOD_GET;
	msg->mid = coap_next_id();
	msg->token = token;
	msg->tkl = tkl;
	msg->reply_cb = reply_cb;
	msg->message_timeout_cb = do_transmit_timeout_cb;

	ret = lwm2m_init_message(msg);
	if (ret < 0) {
		LOG_ERR("Error setting up lwm2m message");
		goto cleanup;
	}

#if defined(CONFIG_LWM2M_FIRMWARE_UPDATE_PULL_COAP_PROXY_SUPPORT)
	/* TODO: shift to lower case */
	if (strncmp(context.uri, "http", 4) == 0) {
		cursor = COAP2HTTP_PROXY_URI_PATH;
	} else if (strncmp(context.uri, "coap", 4) == 0) {
		cursor = COAP2COAP_PROXY_URI_PATH;
	} else {
		ret = -EPROTONOSUPPORT;
		LOG_ERR("Unsupported schema");
		goto cleanup;
	}

	ret = coap_packet_append_option(&msg->cpkt, COAP_OPTION_URI_PATH, cursor, strlen(cursor));
	if (ret < 0) {
		LOG_ERR("Error adding URI_PATH '%s'", cursor);
		goto cleanup;
	}
#else
	http_parser_url_init(&parser);
	ret = http_parser_parse_url(context.uri, strlen(context.uri), 0, &parser);
	if (ret < 0) {
		LOG_ERR("Invalid firmware url: %s", context.uri);
		ret = -ENOTSUP;
		goto cleanup;
	}

	/* if path is not available, off/len will be zero */
	off = parser.field_data[UF_PATH].off;
	len = parser.field_data[UF_PATH].len;
	cursor = context.uri + off;

	/* add path portions (separated by slashes) */
	while (len > 0 && (next_slash = strchr(cursor, '/')) != NULL) {
		if (next_slash != cursor) {
			ret = coap_packet_append_option(&msg->cpkt, COAP_OPTION_URI_PATH, cursor,
							next_slash - cursor);
			if (ret < 0) {
				LOG_ERR("Error adding URI_PATH");
				goto cleanup;
			}
		}

		/* skip slash */
		len -= (next_slash - cursor) + 1;
		cursor = next_slash + 1;
	}

	if (len > 0) {
		/* flush the rest */
		ret = coap_packet_append_option(&msg->cpkt, COAP_OPTION_URI_PATH, cursor, len);
		if (ret < 0) {
			LOG_ERR("Error adding URI_PATH");
			goto cleanup;
		}
	}
#endif

	ret = coap_append_block2_option(&msg->cpkt, ctx);
	if (ret < 0) {
		LOG_ERR("Unable to add block2 option.");
		goto cleanup;
	}

#if defined(CONFIG_LWM2M_FIRMWARE_UPDATE_PULL_COAP_PROXY_SUPPORT)
	ret = coap_packet_append_option(&msg->cpkt, COAP_OPTION_PROXY_URI, context.uri,
					strlen(context.uri));
	if (ret < 0) {
		LOG_ERR("Error adding PROXY_URI '%s'", context.uri);
		goto cleanup;
	}
#else
	/* Ask the server to provide a size estimate */
	ret = coap_append_option_int(&msg->cpkt, COAP_OPTION_SIZE2, 0);
	if (ret < 0) {
		LOG_ERR("Unable to add size2 option.");
		goto cleanup;
	}
#endif

	/* send request */
	ret = lwm2m_send_message_async(msg);
	if (ret < 0) {
		LOG_ERR("Error sending LWM2M packet (err:%d).", ret);
		goto cleanup;
	}

	return 0;

cleanup:
	lwm2m_reset_message(msg, true);
	return ret;
}

static int do_firmware_transfer_reply_cb(const struct coap_packet *response,
					 struct coap_reply *reply, const struct sockaddr *from)
{
	int ret;
	bool last_block;
	uint8_t token[8];
	uint8_t tkl;
	uint16_t payload_len, payload_offset, len;
	struct coap_packet *check_response = (struct coap_packet *)response;
	struct lwm2m_engine_res *res = NULL;
	size_t write_buflen;
	uint8_t resp_code, *write_buf;
	struct coap_block_context received_block_ctx;
	const uint8_t *payload_start;

	/* token is used to determine a valid ACK vs a separated response */
	tkl = coap_header_get_token(check_response, token);

	/* If separated response (ACK) return and wait for response */
	if (!tkl && coap_header_get_type(response) == COAP_TYPE_ACK) {
		return 0;
	} else if (coap_header_get_type(response) == COAP_TYPE_CON) {
		/* Send back ACK so the server knows we received the pkt */
		ret = lwm2m_send_empty_ack(&context.firmware_ctx,
					   coap_header_get_id(check_response));
		if (ret < 0) {
			LOG_ERR("Error transmitting ACK");
			goto error;
		}
	}

	/* Check response code from server. Expecting (2.05) */
	resp_code = coap_header_get_code(check_response);
	if (resp_code != COAP_RESPONSE_CODE_CONTENT) {
		LOG_ERR("Unexpected response from server: %d.%d",
			COAP_RESPONSE_CODE_CLASS(resp_code), COAP_RESPONSE_CODE_DETAIL(resp_code));
		ret = -ENOMSG;
		goto error;
	}

	/* save main firmware block context */
	memcpy(&received_block_ctx, &context.block_ctx, sizeof(context.block_ctx));

	ret = coap_update_from_block(check_response, &context.block_ctx);
	if (ret < 0) {
		LOG_ERR("Error from block update: %d", ret);
		ret = -EFAULT;
		goto error;
	}

	/* test for duplicate transfer */
	if (context.block_ctx.current < received_block_ctx.current) {
		LOG_WRN("Duplicate packet ignored");

		/* restore main firmware block context */
		memcpy(&context.block_ctx, &received_block_ctx, sizeof(context.block_ctx));

		/* set reply->user_data to error to avoid releasing */
		reply->user_data = (void *)COAP_REPLY_STATUS_ERROR;
		return 0;
	}

	/* Reach last block if ret equals to 0 */
	last_block = !coap_next_block(check_response, &context.block_ctx);

	/* Process incoming data */
	payload_start = coap_packet_get_payload(response, &payload_len);
	if (payload_len > 0) {
		payload_offset = payload_start - response->data;
		LOG_DBG("total: %zd, current: %zd", context.block_ctx.total_size,
			context.block_ctx.current);

		struct lwm2m_obj_path path;

		ret = lwm2m_string_to_path("5/0/0", &path, '/');
		if (ret < 0) {
			goto error;
		}

		/* look up firmware package resource */
		ret = lwm2m_get_resource(&path, &res);
		if (ret < 0) {
			goto error;
		}

		/* get buffer data */
		write_buf = res->res_instances->data_ptr;
		write_buflen = res->res_instances->max_data_len;

		/* check for user override to buffer */
		if (res->pre_write_cb) {
			write_buf = res->pre_write_cb(0, 0, 0, &write_buflen);
		}

		if (context.write_cb) {
			size_t offset = received_block_ctx.current;

			/* flush incoming data to write_cb */
			while (payload_len > 0) {
				len = (payload_len > write_buflen) ? write_buflen : payload_len;
				payload_len -= len;
				/* check for end of packet */
				if (buf_read(write_buf, len, CPKT_BUF_READ(response),
					     &payload_offset) < 0) {
					/* malformed packet */
					ret = -EFAULT;
					goto error;
				}

				ret = context.write_cb(context.obj_inst_id, 0, 0, write_buf, len,
						       last_block && (payload_len == 0U),
						       context.block_ctx.total_size, offset);
				offset += len;
				if (ret < 0) {
					goto error;
				}
			}
		}
	}

	if (!last_block) {
		/* More block(s) to come, setup next transfer */
		ret = transfer_request(&context.block_ctx, token, tkl,
				       do_firmware_transfer_reply_cb);
		if (ret < 0) {
			goto error;
		}
	} else {
		/* Download finished */
		context.result_cb(context.obj_inst_id, 0);
		cleanup_context();
	}

	return 0;

error:
	context.result_cb(context.obj_inst_id, ret);
	cleanup_context();
	return ret;
}

static void do_transmit_timeout_cb(struct lwm2m_message *msg)
{
	LOG_ERR("TIMEOUT - Too many retry packet attempts! "
		"Aborting firmware download.");
	context.result_cb(context.obj_inst_id, -ENOMSG);
	cleanup_context();
}

static void firmware_transfer(void)
{
	int ret;
	char *server_addr;

	ret = k_sem_take(&lwm2m_pull_sem, K_FOREVER);

#if defined(CONFIG_LWM2M_FIRMWARE_UPDATE_PULL_COAP_PROXY_SUPPORT)
	server_addr = CONFIG_LWM2M_FIRMWARE_UPDATE_PULL_COAP_PROXY_ADDR;
	if (strlen(server_addr) >= LWM2M_PACKAGE_URI_LEN) {
		LOG_ERR("Invalid Proxy URI: %s", server_addr);
		ret = -ENOTSUP;
		goto error;
	}

	/* Copy required as it gets modified when port is available */
	strcpy(proxy_uri, server_addr);
	server_addr = proxy_uri;
#else
	server_addr = context.uri;
#endif

	ret = lwm2m_parse_peerinfo(server_addr, &context.firmware_ctx, context.is_firmware_uri);
	if (ret < 0) {
		LOG_ERR("Failed to parse server URI.");
		goto error;
	}

	lwm2m_engine_context_init(&context.firmware_ctx);
	ret = lwm2m_socket_start(&context.firmware_ctx);
	if (ret < 0) {
		LOG_ERR("Cannot start a firmware-pull connection:%d", ret);
		goto error;
	}

	LOG_INF("Connecting to server %s", context.uri);

	/* reset block transfer context */
	coap_block_transfer_init(&context.block_ctx, lwm2m_default_block_size(), 0);
	ret = transfer_request(&context.block_ctx, coap_next_token(), 8,
			       do_firmware_transfer_reply_cb);
	if (ret < 0) {
		goto error;
	}

	return;

error:
	context.result_cb(context.obj_inst_id, ret);
	cleanup_context();
}

int lwm2m_pull_context_start_transfer(char *uri, struct requesting_object req, k_timeout_t timeout)
{
	int ret;

	if (!req.write_cb || !req.result_cb) {
		LOG_DBG("Context failed sanity check. Verify initialization!");
		return -EINVAL;
	}

	ret = start_service();
	if (ret) {
		LOG_ERR("Failed to start the pull-service");
		return ret;
	}

	/* Check if we are not in the middle of downloading */
	ret = k_sem_take(&lwm2m_pull_sem, K_NO_WAIT);
	if (ret) {
		context.result_cb(req.obj_inst_id, -EALREADY);
		return -EALREADY;
	}
	k_sem_give(&lwm2m_pull_sem);

	context.obj_inst_id = req.obj_inst_id;
	memcpy(context.uri, uri, LWM2M_PACKAGE_URI_LEN);
	context.is_firmware_uri = req.is_firmware_uri;
	context.result_cb = req.result_cb;
	context.write_cb = req.write_cb;

	(void)memset(&context.block_ctx, 0, sizeof(struct coap_block_context));
	context.firmware_ctx.sock_fd = -1;

	firmware_transfer();

	return 0;
}

void lwm2m_pull_context_set_sockopt_callback(lwm2m_set_sockopt_cb_t set_sockopt_cb)
{
	context.firmware_ctx.set_socketoptions = set_sockopt_cb;
}