logging: rpc: command to invalidate crash dump

Add log_rpc_invalidate_crash_dump() API and the underlying
RPC command to invalidate crash dump stored on the remote.

Signed-off-by: Damian Krolik <[email protected]>

Author: Damian-Nordic

include/logging/log_rpc.h

@@ -163,6 +163,18 @@ void log_rpc_stop_fetch_history(bool pause);
  */
 int log_rpc_get_crash_dump(size_t offset, uint8_t *buffer, size_t buffer_length);
 
+/**
+ * @brief Invalidates the crash dump saved on the remote device.
+ *
+ * This function issues an nRF RPC command to mark the crash dump saved on
+ * the remote device as invalid, so that it can no longer be retrieved by
+ * @ref log_rpc_get_crash_dump function.
+ *
+ * @returns 0           Indicates success.
+ * @returns -errno      Indicates failure.
+ */
+int log_rpc_invalidate_crash_dump(void);
+
 /**
  * @brief Generates a log message on the remote device.
  *

samples/nrf_rpc/protocols_serialization/client/src/log_rpc_shell.c

@@ -178,6 +178,20 @@ static int cmd_log_rpc_crash(const struct shell *sh, size_t argc, char *argv[])
 	return 0;
 }
 
+static int cmd_log_rpc_crash_invalidate(const struct shell *sh, size_t argc, char *argv[])
+{
+	int rc;
+
+	rc = log_rpc_invalidate_crash_dump();
+
+	if (rc) {
+		shell_error(sh, "Error: %d", rc);
+		return -ENOEXEC;
+	}
+
+	return 0;
+}
+
 static int cmd_log_rpc_echo(const struct shell *sh, size_t argc, char *argv[])
 {
 	int rc = 0;
@@ -216,6 +230,11 @@ static int cmd_log_rpc_time(const struct shell *sh, size_t argc, char *argv[])
 	return 0;
 }
 
+SHELL_STATIC_SUBCMD_SET_CREATE(crash_cmds,
+			       SHELL_CMD_ARG(invalidate, NULL, "Invalidate crash dump",
+					     cmd_log_rpc_crash_invalidate, 1, 0),
+			       SHELL_SUBCMD_SET_END);
+
 SHELL_STATIC_SUBCMD_SET_CREATE(
 	log_rpc_cmds,
 	SHELL_CMD_ARG(stream_level, NULL, "Set log streaming level <0-4>", cmd_log_rpc_stream_level,
@@ -227,7 +246,8 @@ SHELL_STATIC_SUBCMD_SET_CREATE(
 		      cmd_log_rpc_history_stop_fetch, 2, 0),
 	SHELL_CMD_ARG(history_threshold, NULL, "Get or set history usage threshold [0-100]",
 		      cmd_log_rpc_history_threshold, 1, 1),
-	SHELL_CMD_ARG(crash, NULL, "Retrieve remote device crash log", cmd_log_rpc_crash, 1, 0),
+	SHELL_CMD_ARG(crash, &crash_cmds, "Retrieve crash dump from remote", cmd_log_rpc_crash, 1,
+		      0),
 	SHELL_CMD_ARG(echo, NULL, "Generate log message on remote <0-4> <msg>", cmd_log_rpc_echo, 3,
 		      0),
 	SHELL_CMD_ARG(time, NULL, "Set current time <time_us|now>", cmd_log_rpc_time, 2, 0),

subsys/logging/log_backend_rpc.c

@@ -155,6 +155,22 @@ static void log_rpc_get_crash_dump_handler(const struct nrf_rpc_group *group,
 
 NRF_RPC_CBOR_CMD_DECODER(log_rpc_group, log_rpc_get_crash_dump_handler, LOG_RPC_CMD_GET_CRASH_DUMP,
 			 log_rpc_get_crash_dump_handler, NULL);
+
+static void log_rpc_invalidate_crash_dump_handler(const struct nrf_rpc_group *group,
+						  struct nrf_rpc_cbor_ctx *ctx, void *handler_data)
+{
+	int rc;
+
+	nrf_rpc_cbor_decoding_done(group, ctx);
+
+	rc = coredump_cmd(COREDUMP_CMD_INVALIDATE_STORED_DUMP, NULL);
+
+	nrf_rpc_rsp_send_int(group, rc);
+}
+
+NRF_RPC_CBOR_CMD_DECODER(log_rpc_group, log_rpc_invalidate_crash_dump_handler,
+			 LOG_RPC_CMD_INVALIDATE_CRASH_DUMP, log_rpc_invalidate_crash_dump_handler,
+			 NULL);
 #endif /* CONFIG_LOG_BACKEND_RPC_CRASH_LOG */
 
 static void format_message(struct log_msg *msg, uint32_t flags, log_output_func_t output_func,

subsys/logging/log_forwarder_rpc.c

@@ -203,6 +203,18 @@ int log_rpc_get_crash_dump(size_t offset, uint8_t *buffer, size_t buffer_length)
 	return log_chunk_size;
 }
 
+int log_rpc_invalidate_crash_dump(void)
+{
+	struct nrf_rpc_cbor_ctx ctx;
+	int32_t rc;
+
+	NRF_RPC_CBOR_ALLOC(&log_rpc_group, ctx, 0);
+	nrf_rpc_cbor_cmd_no_err(&log_rpc_group, LOG_RPC_CMD_INVALIDATE_CRASH_DUMP, &ctx,
+				nrf_rpc_rsp_decode_i32, &rc);
+
+	return rc;
+}
+
 void log_rpc_echo(enum log_rpc_level level, const char *message)
 {
 	struct nrf_rpc_cbor_ctx ctx;

subsys/logging/log_rpc_group.h

@@ -44,6 +44,7 @@ enum log_rpc_cmd_backend {
 	LOG_RPC_CMD_FETCH_HISTORY,
 	LOG_RPC_CMD_STOP_FETCH_HISTORY,
 	LOG_RPC_CMD_GET_CRASH_DUMP,
+	LOG_RPC_CMD_INVALIDATE_CRASH_DUMP,
 	LOG_RPC_CMD_ECHO,
 	LOG_RPC_CMD_SET_TIME,
 };