logging: rpc: command to get current history usage

Add log_rpc_history_usage_current() and log_rpc_get_history_usage_max()
API and the underlying RPC commands to get current history usage.

Signed-off-by: Tomasz Kobylarz <[email protected]>

Author: tomaszkob89

include/logging/log_rpc.h

@@ -90,6 +90,24 @@ void log_rpc_set_history_level(enum log_rpc_level level);
  */
 uint8_t log_rpc_get_history_usage_threshold(void);
 
+/**
+ * @brief Gets the current history usage size in bytes.
+ *
+ * This function fetches the current history usage size in bytes.
+ *
+ * @returns The current history usage size in bytes.
+ */
+size_t log_rpc_get_history_usage_current(void);
+
+/**
+ * @brief Gets the maximum history size in bytes.
+ *
+ * This function fetches the maximum history size in bytes.
+ *
+ * @returns The maximum history size in bytes.
+ */
+size_t log_rpc_get_history_usage_max(void);
+
 /**
  * @brief Sets the current history usage threshold.
  *

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

@@ -145,6 +145,22 @@ static int cmd_log_rpc_history_threshold(const struct shell *sh, size_t argc, ch
 	return 0;
 }
 
+static int cmd_log_rpc_history_usage_current(const struct shell *sh, size_t argc, char *argv[])
+{
+	size_t usage_size;
+	size_t max_size;
+	size_t usage;
+
+	usage_size = log_rpc_get_history_usage_current();
+	max_size = log_rpc_get_history_usage_max();
+	usage = (usage_size * 100 + max_size / 2) / max_size;
+	shell_print(sh,
+		    "History usage size: %zu bytes, max size: %zu bytes, usage: %zu%%",
+		    usage_size, max_size, usage);
+
+	return 0;
+}
+
 static int cmd_log_rpc_crash(const struct shell *sh, size_t argc, char *argv[])
 {
 	int rc;
@@ -246,6 +262,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(history_usage, NULL, "Get current history usage",
+		      cmd_log_rpc_history_usage_current, 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,

subsys/logging/log_backend_rpc.c

@@ -557,6 +557,29 @@ NRF_RPC_CBOR_CMD_DECODER(log_rpc_group, log_rpc_get_history_usage_threshold_hand
 			 LOG_RPC_CMD_GET_HISTORY_USAGE_THRESHOLD,
 			 log_rpc_get_history_usage_threshold_handler, NULL);
 
+static void log_rpc_get_history_usage_current_handler(const struct nrf_rpc_group *group,
+						  struct nrf_rpc_cbor_ctx *ctx,
+						  void *handler_data)
+{
+	nrf_rpc_cbor_decoding_done(group, ctx);
+	nrf_rpc_rsp_send_uint(group, (uint32_t)log_rpc_history_get_usage_size());
+}
+
+NRF_RPC_CBOR_CMD_DECODER(log_rpc_group, log_rpc_get_history_usage_current_handler,
+			 LOG_RPC_CMD_GET_HISTORY_USAGE_SIZE,
+			 log_rpc_get_history_usage_current_handler, NULL);
+
+static void log_rpc_get_history_usage_max_handler(const struct nrf_rpc_group *group,
+						 struct nrf_rpc_cbor_ctx *ctx, void *handler_data)
+{
+	nrf_rpc_cbor_decoding_done(group, ctx);
+	nrf_rpc_rsp_send_uint(group, (uint32_t)log_rpc_history_get_max_size());
+}
+
+NRF_RPC_CBOR_CMD_DECODER(log_rpc_group, log_rpc_get_history_usage_max_handler,
+			 LOG_RPC_CMD_GET_HISTORY_MAX_SIZE,
+			 log_rpc_get_history_usage_max_handler, NULL);
+
 static void log_rpc_set_history_usage_threshold_handler(const struct nrf_rpc_group *group,
 							struct nrf_rpc_cbor_ctx *ctx,
 							void *handler_data)

subsys/logging/log_backend_rpc_history.h

@@ -19,4 +19,8 @@ void log_rpc_history_free(const union log_msg_generic *msg);
 
 uint8_t log_rpc_history_get_usage(void);
 
+size_t log_rpc_history_get_usage_size(void);
+
+size_t log_rpc_history_get_max_size(void);
+
 #endif /* LOG_RPC_HISTORY_H_ */

subsys/logging/log_backend_rpc_history_fcb.c

@@ -171,3 +171,28 @@ uint8_t log_rpc_history_get_usage(void)
 	 */
 	return (fcb.f_sector_cnt - num_free_sectors) * 100 / fcb.f_sector_cnt;
 }
+
+size_t log_rpc_history_get_usage_size(void)
+{
+	int num_free_sectors;
+	size_t used_size;
+
+	k_mutex_lock(&fcb_lock, K_FOREVER);
+
+	num_free_sectors = fcb_free_sector_cnt(&fcb);
+
+	k_mutex_unlock(&fcb_lock);
+
+	/*
+	 * Calculate the used size in bytes based on the number of used sectors.
+	 * This provides sector-level granularity for the size calculation.
+	 */
+	used_size = (fcb.f_sector_cnt - num_free_sectors) * fcb_sectors[0].fs_size;
+
+	return used_size;
+}
+
+size_t log_rpc_history_get_max_size(void)
+{
+	return CONFIG_LOG_BACKEND_RPC_HISTORY_SIZE;
+}

subsys/logging/log_backend_rpc_history_ram.c

@@ -91,3 +91,18 @@ uint8_t log_rpc_history_get_usage(void)
 
 	return current_size * 100 / total_size;
 }
+
+size_t log_rpc_history_get_usage_size(void)
+{
+	size_t total_size;
+	size_t current_size;
+
+	mpsc_pbuf_get_utilization(&log_history_pbuf, &total_size, &current_size);
+
+	return current_size;
+}
+
+size_t log_rpc_history_get_max_size(void)
+{
+	return CONFIG_LOG_BACKEND_RPC_HISTORY_SIZE;
+}

subsys/logging/log_forwarder_rpc.c

@@ -256,6 +256,32 @@ uint8_t log_rpc_get_history_usage_threshold(void)
 	return threshold;
 }
 
+size_t log_rpc_get_history_usage_current(void)
+{
+	struct nrf_rpc_cbor_ctx ctx;
+	uint32_t usage_size;
+
+	NRF_RPC_CBOR_ALLOC(&log_rpc_group, ctx, 0);
+
+	nrf_rpc_cbor_cmd_no_err(&log_rpc_group, LOG_RPC_CMD_GET_HISTORY_USAGE_SIZE, &ctx,
+				nrf_rpc_rsp_decode_u32, &usage_size);
+
+	return (size_t)usage_size;
+}
+
+size_t log_rpc_get_history_usage_max(void)
+{
+	struct nrf_rpc_cbor_ctx ctx;
+	uint32_t max_size;
+
+	NRF_RPC_CBOR_ALLOC(&log_rpc_group, ctx, 0);
+
+	nrf_rpc_cbor_cmd_no_err(&log_rpc_group, LOG_RPC_CMD_GET_HISTORY_MAX_SIZE, &ctx,
+				nrf_rpc_rsp_decode_u32, &max_size);
+
+	return (size_t)max_size;
+}
+
 void log_rpc_set_history_usage_threshold(log_rpc_history_threshold_reached_handler_t handler,
 					 uint8_t threshold)
 {

subsys/logging/log_rpc_group.h

@@ -41,6 +41,8 @@ enum log_rpc_cmd_backend {
 	LOG_RPC_CMD_SET_HISTORY_LEVEL,
 	LOG_RPC_CMD_GET_HISTORY_USAGE_THRESHOLD,
 	LOG_RPC_CMD_SET_HISTORY_USAGE_THRESHOLD,
+	LOG_RPC_CMD_GET_HISTORY_USAGE_SIZE,
+	LOG_RPC_CMD_GET_HISTORY_MAX_SIZE,
 	LOG_RPC_CMD_FETCH_HISTORY,
 	LOG_RPC_CMD_STOP_FETCH_HISTORY,
 	LOG_RPC_CMD_GET_CRASH_DUMP,