subsys/settings: stream-style encoding and decoding to/from storage
This patch reworks routines used to store and read the settings data. Provide stream-style encoding and decoding to/from flash, so the the API only requires a pointer to binary data, and the settings implementation takes care of encoding/decoding to/from base64 and writing/reading to/from flash on the fly. This would eliminate the need of a separate base64 value buffer on the application-side, thereby further contributing to the stack footprint reduction. Above changes allows to remove: 256-byte value length limitation. removing enum settings_type usage so all settings data are treated now as a byte array (i.e. what's previously SETTINGS_BYTES) Introduced routine settings_val_read_cb for read and decode the settings data from storage inside h_set handler implementations. h_set settings handler now provide persistent value's context used along with read routine instead of immediately value. Signed-off-by: Andrzej Puzdrowski <andrzej.puzdrowski@nordicsemi.no>
This commit is contained in:
Andrzej Puzdrowski
Carles Cufí
parent
c012a288c3
commit
76f8b97871
11 changed files with 929 additions and 541 deletions
|
|
@ -8,6 +8,7 @@
|
|||
#ifndef ZEPHYR_INCLUDE_SETTINGS_SETTINGS_H_
|
||||
#define ZEPHYR_INCLUDE_SETTINGS_SETTINGS_H_
|
||||
|
||||
#include <sys/types.h>
|
||||
#include <misc/util.h>
|
||||
#include <misc/slist.h>
|
||||
#include <stdint.h>
|
||||
|
|
@ -34,76 +35,58 @@ extern "C" {
|
|||
|
||||
#define SETTINGS_NMGR_OP 0
|
||||
|
||||
/**
|
||||
* Type of settings value.
|
||||
*/
|
||||
enum settings_type {
|
||||
SETTINGS_NONE = 0,
|
||||
SETTINGS_INT8,
|
||||
SETTINGS_INT16,
|
||||
SETTINGS_INT32,
|
||||
SETTINGS_INT64,
|
||||
SETTINGS_STRING,
|
||||
SETTINGS_BYTES,
|
||||
SETTINGS_FLOAT,
|
||||
SETTINGS_DOUBLE,
|
||||
SETTINGS_BOOL,
|
||||
} __attribute__((__packed__));
|
||||
|
||||
/**
|
||||
* Parameter to commit handler describing where data is going to.
|
||||
*/
|
||||
enum settings_export_tgt {
|
||||
SETTINGS_EXPORT_PERSIST, /* Value is to be persisted. */
|
||||
SETTINGS_EXPORT_SHOW /* Value is to be displayed. */
|
||||
};
|
||||
|
||||
/**
|
||||
* @struct settings_handler
|
||||
* Config handlers for subtree implement a set of handler functions.
|
||||
* These are registered using a call to settings_register().
|
||||
*
|
||||
* @param settings_handler::node Linked list node info for module internal usage.
|
||||
*
|
||||
* @param settings_handler::name Name of subtree.
|
||||
*
|
||||
* @param settings_handler::h_get Get values handler of settings items
|
||||
* identified by keyword names.Parameters:
|
||||
* - argc - count of item in argv.
|
||||
* - argv - array of pointers to keyword names.
|
||||
* - val - buffer for a value.
|
||||
* - val_len_max - size of that buffer.
|
||||
*
|
||||
* @param settings_handler::h_set Set value handler of settings items
|
||||
* identified by keyword names. Parameters:
|
||||
* - argc - count of item in argv, argv - array of pointers to keyword names.
|
||||
* - val- pointer to value to be set.
|
||||
*
|
||||
* @param settings_handler::h_commit This handler gets called after settings
|
||||
* has been loaded in full. User might use it to apply setting to
|
||||
* the application.
|
||||
*
|
||||
* @param settings_handler::h_export This gets called to dump all current
|
||||
* settings items.
|
||||
* This happens when settings_save() tries to save the settings. Parameters:
|
||||
* - tgt: indicates where data is going to.
|
||||
* - Export_function: the pointer to the internal function which appends
|
||||
* a single key-value pair to persisted settings. Don't store duplicated
|
||||
* value. The name is subtree/key string, val is the string with
|
||||
* value.
|
||||
*
|
||||
* @remarks The User might limit a implementations of handler to serving only
|
||||
* one keyword at one call - what will impose limit to get/set values using full
|
||||
* subtree/key name.
|
||||
* These are registered using a call to @ref settings_register.
|
||||
*/
|
||||
struct settings_handler {
|
||||
sys_snode_t node;
|
||||
/**< Linked list node info for module internal usage. */
|
||||
|
||||
char *name;
|
||||
char *(*h_get)(int argc, char **argv, char *val, int val_len_max);
|
||||
int (*h_set)(int argc, char **argv, char *val);
|
||||
/**< Name of subtree. */
|
||||
|
||||
int (*h_get)(int argc, char **argv, char *val, int val_len_max);
|
||||
/**< Get values handler of settings items identified by keyword names.
|
||||
*
|
||||
* Parameters:
|
||||
* - argc - count of item in argv.
|
||||
* - argv - array of pointers to keyword names.
|
||||
* - val - buffer for a value.
|
||||
* - val_len_max - size of that buffer.
|
||||
*/
|
||||
|
||||
int (*h_set)(int argc, char **argv, void *value_ctx);
|
||||
/**< Set value handler of settings items identified by keyword names.
|
||||
*
|
||||
* Parameters:
|
||||
* - argc - count of item in argv, argv - array of pointers to keyword
|
||||
* names.
|
||||
* - value_ctx - pointer to the value contex which is used paramiter
|
||||
* for data extracting routine (@ref settings_val_read_cb).
|
||||
*/
|
||||
|
||||
int (*h_commit)(void);
|
||||
int (*h_export)(int (*export_func)(const char *name, char *val),
|
||||
enum settings_export_tgt tgt);
|
||||
/**< This handler gets called after settings has been loaded in full.
|
||||
* User might use it to apply setting to the application.
|
||||
*/
|
||||
|
||||
int (*h_export)(int (*export_func)(const char *name, void *val,
|
||||
size_t val_len));
|
||||
/**< This gets called to dump all current settings items.
|
||||
*
|
||||
* This happens when @ref settings_save tries to save the settings.
|
||||
* Parameters:
|
||||
* - export_func: the pointer to the internal function which appends
|
||||
* a single key-value pair to persisted settings. Don't store
|
||||
* duplicated value. The name is subtree/key string, val is the string
|
||||
* with value.
|
||||
*
|
||||
* @remarks The User might limit a implementations of handler to serving
|
||||
* only one keyword at one call - what will impose limit to get/set
|
||||
* values using full subtree/key name.
|
||||
*/
|
||||
};
|
||||
|
||||
/**
|
||||
|
|
@ -148,29 +131,33 @@ int settings_save(void);
|
|||
* changed value).
|
||||
*
|
||||
* @param name Name/key of the settings item.
|
||||
* @param var Value of the settings item.
|
||||
* @param value Pointer to the value of the settings item. This value will
|
||||
* be transferred to the @ref settings_handler::h_export handler implementation.
|
||||
* @param val_len Length of the value.
|
||||
*
|
||||
* @return 0 on success, non-zero on failure.
|
||||
*/
|
||||
int settings_save_one(const char *name, char *var);
|
||||
int settings_save_one(const char *name, void *value, size_t val_len);
|
||||
|
||||
/**
|
||||
* Set settings item identified by @p name to be value @p val_str.
|
||||
* Set settings item identified by @p name to be value @p value.
|
||||
* This finds the settings handler for this subtree and calls it's
|
||||
* set handler.
|
||||
*
|
||||
* @param name Name/key of the settings item.
|
||||
* @param val_str Value of the settings item.
|
||||
* @param value Pointer to the value of the settings item. This value will
|
||||
* be transferred to the @ref settings_handler::h_set handler implementation.
|
||||
* @param len Length of value string.
|
||||
*
|
||||
* @return 0 on success, non-zero on failure.
|
||||
*/
|
||||
int settings_set_value(char *name, char *val_str);
|
||||
int settings_set_value(char *name, void *value, size_t len);
|
||||
|
||||
/**
|
||||
* Get value of settings item identified by @p name.
|
||||
* This calls the settings handler h_get for the subtree.
|
||||
*
|
||||
* Configuration handler can copy the string to @p buf, the maximum
|
||||
* Configuration handler should copy the string to @p buf, the maximum
|
||||
* number of bytes it will copy is limited by @p buf_len.
|
||||
*
|
||||
* @param name Name/key of the settings item.
|
||||
|
|
@ -180,10 +167,9 @@ int settings_set_value(char *name, char *val_str);
|
|||
*
|
||||
* @param buf_len size of buf.
|
||||
*
|
||||
* @return value will be pointer to beginning of the buf,
|
||||
* except for string it will pointer to beginning of string source.
|
||||
* @return Positive: Length of copied dat. Negative: -ERCODE
|
||||
*/
|
||||
char *settings_get_value(char *name, char *buf, int buf_len);
|
||||
int settings_get_value(char *name, char *buf, int buf_len);
|
||||
|
||||
/**
|
||||
* Call commit for all settings handler. This should apply all
|
||||
|
|
@ -196,60 +182,20 @@ char *settings_get_value(char *name, char *buf, int buf_len);
|
|||
int settings_commit(char *name);
|
||||
|
||||
/**
|
||||
* Convenience routine for converting value passed as a string to native
|
||||
* data type.
|
||||
* Persistent data extracting routine.
|
||||
*
|
||||
* @param val_str Value of the settings item as string.
|
||||
* @param type Type of the value to convert to.
|
||||
* @param vp Pointer to variable to fill with the decoded value.
|
||||
* @param maxlen the vp buffer size.
|
||||
* This function read and decode data from non volatile storage to user buffer
|
||||
* This function should be used inside set handler in order to read the settings
|
||||
* data from backend storage.
|
||||
*
|
||||
* @return 0 on success, non-zero on failure.
|
||||
* @param[in] value_ctx Data contex provided by the <p>h_set</p> handler.
|
||||
* @param[out] buf Buffer for data read.
|
||||
* @param[in] len Length of <p>buf</p>.
|
||||
*
|
||||
* @retval Negative value on failure. 0 and positive: Length of data loaded to
|
||||
* the <p>buf</p>.
|
||||
*/
|
||||
int settings_value_from_str(char *val_str, enum settings_type type, void *vp,
|
||||
int maxlen);
|
||||
|
||||
/**
|
||||
* Convenience routine for converting byte array passed as a base64
|
||||
* encoded string.
|
||||
*
|
||||
* @param val_str Value of the settings item as string.
|
||||
* @param vp Pointer to variable to fill with the decoded value.
|
||||
* @param len Size of that variable. On return the number of bytes in the array.
|
||||
*
|
||||
* @return 0 on success, non-zero on failure.
|
||||
*/
|
||||
int settings_bytes_from_str(char *val_str, void *vp, int *len);
|
||||
|
||||
/**
|
||||
* Convenience routine for converting native data type to a string.
|
||||
*
|
||||
* @param type Type of the value to convert from.
|
||||
* @param vp Pointer to variable to convert.
|
||||
* @param buf Buffer where string value will be stored.
|
||||
* @param buf_len Size of the buffer.
|
||||
*
|
||||
* @return 0 on success, non-zero on failure.
|
||||
*/
|
||||
char *settings_str_from_value(enum settings_type type, void *vp, char *buf,
|
||||
int buf_len);
|
||||
#define SETTINGS_STR_FROM_BYTES_LEN(len) (((len) * 4 / 3) + 4)
|
||||
|
||||
/**
|
||||
* Convenience routine for converting byte array into a base64
|
||||
* encoded string.
|
||||
*
|
||||
* @param vp Pointer to variable to convert.
|
||||
* @param vp_len Number of bytes to convert.
|
||||
* @param buf Buffer where string value will be stored.
|
||||
* @param buf_len Size of the buffer.
|
||||
*
|
||||
* @return 0 on success, non-zero on failure.
|
||||
*/
|
||||
char *settings_str_from_bytes(void *vp, int vp_len, char *buf, int buf_len);
|
||||
|
||||
#define SETTINGS_VALUE_SET(str, type, val) \
|
||||
settings_value_from_str((str), (type), &(val), sizeof(val))
|
||||
int settings_val_read_cb(void *value_ctx, void *buf, size_t len);
|
||||
|
||||
/**
|
||||
* @} settings
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue