Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

settings: shell: improve reading and writing string values #85786

Merged
merged 1 commit into from
Mar 22, 2025
Merged

settings: shell: improve reading and writing string values #85786

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 23 additions & 19 deletions subsys/settings/src/settings_shell.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
#include <zephyr/sys/util.h>
#include <zephyr/toolchain.h>

#include <ctype.h>
#include <stdint.h>
#include <stddef.h>

Expand Down Expand Up @@ -51,6 +52,7 @@ static int cmd_list(const struct shell *shell_ptr, size_t argc, char *argv[])

if (err) {
shell_error(shell_ptr, "Failed to load settings: %d", err);
err = -ENOEXEC;
}

return err;
Expand All @@ -74,6 +76,7 @@ static int settings_read_callback(const char *key,
void *param)
{
uint8_t buffer[SETTINGS_MAX_VAL_LEN];
ssize_t i;
ssize_t num_read_bytes = MIN(len, SETTINGS_MAX_VAL_LEN);
struct settings_read_callback_params *params = param;

Expand All @@ -100,11 +103,13 @@ static int settings_read_callback(const char *key,
shell_hexdump(params->shell_ptr, buffer, num_read_bytes);
break;
case SETTINGS_VALUE_STRING:
if (buffer[num_read_bytes - 1] != '\0') {
shell_error(params->shell_ptr, "Value is not a string");
return 0;
for (i = 0; i < num_read_bytes; i++) {
if (!isprint(buffer[i])) {
shell_error(params->shell_ptr, "Value is not a string");
return 0;
}
}
shell_print(params->shell_ptr, "%s", buffer);
shell_print(params->shell_ptr, "%.*s", (int)num_read_bytes, buffer);
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the %.*s addition

break;
}

Expand Down Expand Up @@ -138,7 +143,7 @@ static int cmd_read(const struct shell *shell_ptr, size_t argc, char *argv[])
err = settings_parse_type(argv[1], &value_type);
if (err) {
shell_error(shell_ptr, "Invalid type: %s", argv[1]);
return err;
return -EINVAL;
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

but settings_parse_type already returns -EINVAL, we should just propagate the error

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, but this makes it a bit clearer that the handler does not return any other error code than the two allowed.

}
}

Expand All @@ -152,9 +157,10 @@ static int cmd_read(const struct shell *shell_ptr, size_t argc, char *argv[])

if (err) {
shell_error(shell_ptr, "Failed to load setting: %d", err);
err = -ENOEXEC;
} else if (!params.value_found) {
err = -ENOENT;
shell_error(shell_ptr, "Setting not found");
err = -ENOEXEC;
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

By the way, also make sure the command handlers only return
-EINVAL and -ENOEXEC error codes as documented in the
handler type description.

Can you point me to this documentation ?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, https://docs.zephyrproject.org/latest/doxygen/html/group__shell__api.html#ga331e7d19b9b0755486596f5ffc598338

}

return err;
Expand All @@ -164,42 +170,39 @@ static int cmd_write(const struct shell *shell_ptr, size_t argc, char *argv[])
{
int err;
uint8_t buffer[CONFIG_SHELL_CMD_BUFF_SIZE / 2];
size_t buffer_len = 0;
const void *value;
size_t value_len = 0;
enum settings_value_types value_type = SETTINGS_VALUE_HEX;

if (argc > 3) {
err = settings_parse_type(argv[1], &value_type);
if (err) {
shell_error(shell_ptr, "Invalid type: %s", argv[1]);
return err;
return -EINVAL;
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same here

}
}

switch (value_type) {
case SETTINGS_VALUE_HEX:
buffer_len = hex2bin(argv[argc - 1], strlen(argv[argc - 1]),
buffer, sizeof(buffer));
value = buffer;
value_len = hex2bin(argv[argc - 1], strlen(argv[argc - 1]), buffer, sizeof(buffer));
break;
case SETTINGS_VALUE_STRING:
buffer_len = strlen(argv[argc - 1]) + 1;
if (buffer_len > sizeof(buffer)) {
shell_error(shell_ptr, "%s is bigger than shell's buffer", argv[argc - 1]);
return -EINVAL;
}

memcpy(buffer, argv[argc - 1], buffer_len);
value = argv[argc - 1];
value_len = strlen(argv[argc - 1]);
break;
}

if (buffer_len == 0) {
if (value_len == 0) {
shell_error(shell_ptr, "Failed to parse value");
return -EINVAL;
}

err = settings_save_one(argv[argc - 2], buffer, buffer_len);
err = settings_save_one(argv[argc - 2], value, value_len);

if (err) {
shell_error(shell_ptr, "Failed to write setting: %d", err);
err = -ENOEXEC;
}

return err;
Expand All @@ -213,6 +216,7 @@ static int cmd_delete(const struct shell *shell_ptr, size_t argc, char *argv[])

if (err) {
shell_error(shell_ptr, "Failed to delete setting: %d", err);
err = -ENOEXEC;
}

return err;
Expand Down
Loading