2 * Copyright 2020 Toomas Soome <tsoome@me.com>
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
7 * 1. Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
13 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * Big Theory Statement.
29 * nvstore is abstraction layer to implement data read/write to different
30 * types of non-volatile storage.
33 * Provide mapping via environment: setenv/unsetenv/putenv. Access via
34 * environment functions/commands is available once nvstore has
35 * attached the backend and stored textual data is mapped to environment.
37 * Provide command "nvstore" to create new data instances.
40 * nvstore_init(): attach new backend and create the environment mapping.
41 * nvstore_fini: detach backend and unmap the related environment.
43 * The disk based storage, such as UFS file or ZFS bootenv label area, is
44 * only accessible after root file system is set. Root file system change
45 * will switch the back end storage.
48 #include <sys/cdefs.h>
49 __FBSDID("$FreeBSD$");
52 #include <sys/queue.h>
53 #include <bootstrap.h>
56 typedef struct nvstore {
59 nvs_callbacks_t *nvs_cb;
60 STAILQ_ENTRY(nvstore) nvs_next;
63 typedef STAILQ_HEAD(store_list, nvstore) nvstore_list_t;
65 nvstore_list_t stores = STAILQ_HEAD_INITIALIZER(stores);
68 nvstore_get_store(const char *name)
74 STAILQ_FOREACH(st, &stores, nvs_next) {
75 if (strcmp(name, st->nvs_name) == 0)
83 nvstore_init(const char *name, nvs_callbacks_t *cb, void *data)
87 st = nvstore_get_store(name);
91 if ((st = malloc(sizeof (*st))) == NULL)
94 if ((st->nvs_name = strdup(name)) == NULL) {
102 STAILQ_INSERT_TAIL(&stores, st, nvs_next);
107 nvstore_fini(const char *name)
111 st = nvstore_get_store(name);
115 STAILQ_REMOVE(&stores, st, nvstore, nvs_next);
124 nvstore_print(void *ptr)
128 return (st->nvs_cb->nvs_iterate(st->nvs_data, st->nvs_cb->nvs_print));
132 nvstore_get_var(void *ptr, const char *name, void **data)
136 return (st->nvs_cb->nvs_getter(st->nvs_data, name, data));
140 nvstore_set_var(void *ptr, int type, const char *name,
141 void *data, size_t size)
145 return (st->nvs_cb->nvs_setter(st->nvs_data, type, name, data, size));
149 nvstore_set_var_from_string(void *ptr, const char *type, const char *name,
154 return (st->nvs_cb->nvs_setter_str(st->nvs_data, type, name, data));
158 nvstore_unset_var(void *ptr, const char *name)
162 return (st->nvs_cb->nvs_unset(st->nvs_data, name));
165 COMMAND_SET(nvstore, "nvstore", "manage non-volatile data", command_nvstore);
168 nvstore_usage(const char *me)
170 printf("Usage:\t%s -l\n", me);
171 printf("\t%s store -l\n", me);
172 printf("\t%s store [-t type] key value\n", me);
173 printf("\t%s store -g key\n", me);
174 printf("\t%s store -d key\n", me);
178 * Usage: nvstore -l # list stores
179 * nvstore store -l # list data in store
180 * nvstore store [-t type] key value
181 * nvstore store -g key # get value
182 * nvstore store -d key # delete key
185 command_nvstore(int argc, char *argv[])
188 bool list, get, delete;
190 char *me, *name, *type;
197 while ((c = getopt(argc, argv, "l")) != -1) {
213 if (STAILQ_EMPTY(&stores)) {
214 printf("No configured nvstores\n");
217 printf("List of configured nvstores:\n");
218 STAILQ_FOREACH(st, &stores, nvs_next) {
219 printf("\t%s\n", st->nvs_name);
227 if (argc == 0 || (argc != 0 && list)) {
232 st = nvstore_get_store(argv[0]);
242 get = delete = false;
244 while ((c = getopt(argc, argv, "d:g:lt:")) != -1) {
255 if (delete || list) {
282 (void) nvstore_print(st);
286 if (delete && name != NULL) {
287 (void) nvstore_unset_var(st, name);
291 if (get && name != NULL) {
294 if (nvstore_get_var(st, name, (void **)&ptr) == 0)
295 printf("%s = %s\n", name, ptr);
300 c = nvstore_set_var_from_string(st, type, argv[0], argv[1]);
302 printf("error: %s\n", strerror(c));