1*22028508SToomas Soome /*
2*22028508SToomas Soome * Copyright 2020 Toomas Soome <tsoome@me.com>
3*22028508SToomas Soome *
4*22028508SToomas Soome * Redistribution and use in source and binary forms, with or without
5*22028508SToomas Soome * modification, are permitted provided that the following conditions
6*22028508SToomas Soome * are met:
7*22028508SToomas Soome * 1. Redistributions of source code must retain the above copyright
8*22028508SToomas Soome * notice, this list of conditions and the following disclaimer.
9*22028508SToomas Soome * 2. Redistributions in binary form must reproduce the above copyright
10*22028508SToomas Soome * notice, this list of conditions and the following disclaimer in the
11*22028508SToomas Soome * documentation and/or other materials provided with the distribution.
12*22028508SToomas Soome *
13*22028508SToomas Soome * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14*22028508SToomas Soome * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15*22028508SToomas Soome * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16*22028508SToomas Soome * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17*22028508SToomas Soome * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18*22028508SToomas Soome * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19*22028508SToomas Soome * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20*22028508SToomas Soome * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21*22028508SToomas Soome * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22*22028508SToomas Soome * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23*22028508SToomas Soome * SUCH DAMAGE.
24*22028508SToomas Soome */
25*22028508SToomas Soome
26*22028508SToomas Soome /*
27*22028508SToomas Soome * Big Theory Statement.
28*22028508SToomas Soome *
29*22028508SToomas Soome * nvstore is abstraction layer to implement data read/write to different
30*22028508SToomas Soome * types of non-volatile storage.
31*22028508SToomas Soome *
32*22028508SToomas Soome * User interfaces:
33*22028508SToomas Soome * Provide mapping via environment: setenv/unsetenv/putenv. Access via
34*22028508SToomas Soome * environment functions/commands is available once nvstore has
35*22028508SToomas Soome * attached the backend and stored textual data is mapped to environment.
36*22028508SToomas Soome *
37*22028508SToomas Soome * Provide command "nvstore" to create new data instances.
38*22028508SToomas Soome *
39*22028508SToomas Soome * API: TBD.
40*22028508SToomas Soome * nvstore_init(): attach new backend and create the environment mapping.
41*22028508SToomas Soome * nvstore_fini: detach backend and unmap the related environment.
42*22028508SToomas Soome *
43*22028508SToomas Soome * The disk based storage, such as UFS file or ZFS bootenv label area, is
44*22028508SToomas Soome * only accessible after root file system is set. Root file system change
45*22028508SToomas Soome * will switch the back end storage.
46*22028508SToomas Soome */
47*22028508SToomas Soome
48*22028508SToomas Soome #include <sys/cdefs.h>
49*22028508SToomas Soome
50*22028508SToomas Soome #include <stdbool.h>
51*22028508SToomas Soome #include <sys/queue.h>
52*22028508SToomas Soome #include <bootstrap.h>
53*22028508SToomas Soome #include "stand.h"
54*22028508SToomas Soome
55*22028508SToomas Soome typedef struct nvstore {
56*22028508SToomas Soome char *nvs_name;
57*22028508SToomas Soome void *nvs_data;
58*22028508SToomas Soome nvs_callbacks_t *nvs_cb;
59*22028508SToomas Soome STAILQ_ENTRY(nvstore) nvs_next;
60*22028508SToomas Soome } nvstore_t;
61*22028508SToomas Soome
62*22028508SToomas Soome typedef STAILQ_HEAD(store_list, nvstore) nvstore_list_t;
63*22028508SToomas Soome
64*22028508SToomas Soome nvstore_list_t stores = STAILQ_HEAD_INITIALIZER(stores);
65*22028508SToomas Soome
66*22028508SToomas Soome void *
nvstore_get_store(const char * name)67*22028508SToomas Soome nvstore_get_store(const char *name)
68*22028508SToomas Soome {
69*22028508SToomas Soome nvstore_t *st;
70*22028508SToomas Soome
71*22028508SToomas Soome st = NULL;
72*22028508SToomas Soome
73*22028508SToomas Soome STAILQ_FOREACH(st, &stores, nvs_next) {
74*22028508SToomas Soome if (strcmp(name, st->nvs_name) == 0)
75*22028508SToomas Soome break;
76*22028508SToomas Soome }
77*22028508SToomas Soome
78*22028508SToomas Soome return (st);
79*22028508SToomas Soome }
80*22028508SToomas Soome
81*22028508SToomas Soome int
nvstore_init(const char * name,nvs_callbacks_t * cb,void * data)82*22028508SToomas Soome nvstore_init(const char *name, nvs_callbacks_t *cb, void *data)
83*22028508SToomas Soome {
84*22028508SToomas Soome nvstore_t *st;
85*22028508SToomas Soome
86*22028508SToomas Soome st = nvstore_get_store(name);
87*22028508SToomas Soome if (st != NULL)
88*22028508SToomas Soome return (EEXIST);
89*22028508SToomas Soome
90*22028508SToomas Soome if ((st = malloc(sizeof (*st))) == NULL)
91*22028508SToomas Soome return (ENOMEM);
92*22028508SToomas Soome
93*22028508SToomas Soome if ((st->nvs_name = strdup(name)) == NULL) {
94*22028508SToomas Soome free(st);
95*22028508SToomas Soome return (ENOMEM);
96*22028508SToomas Soome }
97*22028508SToomas Soome
98*22028508SToomas Soome st->nvs_data = data;
99*22028508SToomas Soome st->nvs_cb = cb;
100*22028508SToomas Soome
101*22028508SToomas Soome STAILQ_INSERT_TAIL(&stores, st, nvs_next);
102*22028508SToomas Soome return (0);
103*22028508SToomas Soome }
104*22028508SToomas Soome
105*22028508SToomas Soome int
nvstore_fini(const char * name)106*22028508SToomas Soome nvstore_fini(const char *name)
107*22028508SToomas Soome {
108*22028508SToomas Soome nvstore_t *st;
109*22028508SToomas Soome
110*22028508SToomas Soome st = nvstore_get_store(name);
111*22028508SToomas Soome if (st == NULL)
112*22028508SToomas Soome return (ENOENT);
113*22028508SToomas Soome
114*22028508SToomas Soome STAILQ_REMOVE(&stores, st, nvstore, nvs_next);
115*22028508SToomas Soome
116*22028508SToomas Soome free(st->nvs_name);
117*22028508SToomas Soome free(st->nvs_data);
118*22028508SToomas Soome free(st);
119*22028508SToomas Soome return (0);
120*22028508SToomas Soome }
121*22028508SToomas Soome
122*22028508SToomas Soome int
nvstore_print(void * ptr)123*22028508SToomas Soome nvstore_print(void *ptr)
124*22028508SToomas Soome {
125*22028508SToomas Soome nvstore_t *st = ptr;
126*22028508SToomas Soome
127*22028508SToomas Soome return (st->nvs_cb->nvs_iterate(st->nvs_data, st->nvs_cb->nvs_print));
128*22028508SToomas Soome }
129*22028508SToomas Soome
130*22028508SToomas Soome int
nvstore_get_var(void * ptr,const char * name,void ** data)131*22028508SToomas Soome nvstore_get_var(void *ptr, const char *name, void **data)
132*22028508SToomas Soome {
133*22028508SToomas Soome nvstore_t *st = ptr;
134*22028508SToomas Soome
135*22028508SToomas Soome return (st->nvs_cb->nvs_getter(st->nvs_data, name, data));
136*22028508SToomas Soome }
137*22028508SToomas Soome
138*22028508SToomas Soome int
nvstore_set_var(void * ptr,int type,const char * name,void * data,size_t size)139*22028508SToomas Soome nvstore_set_var(void *ptr, int type, const char *name,
140*22028508SToomas Soome void *data, size_t size)
141*22028508SToomas Soome {
142*22028508SToomas Soome nvstore_t *st = ptr;
143*22028508SToomas Soome
144*22028508SToomas Soome return (st->nvs_cb->nvs_setter(st->nvs_data, type, name, data, size));
145*22028508SToomas Soome }
146*22028508SToomas Soome
147*22028508SToomas Soome int
nvstore_set_var_from_string(void * ptr,const char * type,const char * name,const char * data)148*22028508SToomas Soome nvstore_set_var_from_string(void *ptr, const char *type, const char *name,
149*22028508SToomas Soome const char *data)
150*22028508SToomas Soome {
151*22028508SToomas Soome nvstore_t *st = ptr;
152*22028508SToomas Soome
153*22028508SToomas Soome return (st->nvs_cb->nvs_setter_str(st->nvs_data, type, name, data));
154*22028508SToomas Soome }
155*22028508SToomas Soome
156*22028508SToomas Soome int
nvstore_unset_var(void * ptr,const char * name)157*22028508SToomas Soome nvstore_unset_var(void *ptr, const char *name)
158*22028508SToomas Soome {
159*22028508SToomas Soome nvstore_t *st = ptr;
160*22028508SToomas Soome
161*22028508SToomas Soome return (st->nvs_cb->nvs_unset(st->nvs_data, name));
162*22028508SToomas Soome }
163*22028508SToomas Soome
164*22028508SToomas Soome COMMAND_SET(nvstore, "nvstore", "manage non-volatile data", command_nvstore);
165*22028508SToomas Soome
166*22028508SToomas Soome static void
nvstore_usage(const char * me)167*22028508SToomas Soome nvstore_usage(const char *me)
168*22028508SToomas Soome {
169*22028508SToomas Soome printf("Usage:\t%s -l\n", me);
170*22028508SToomas Soome printf("\t%s store -l\n", me);
171*22028508SToomas Soome printf("\t%s store [-t type] key value\n", me);
172*22028508SToomas Soome printf("\t%s store -g key\n", me);
173*22028508SToomas Soome printf("\t%s store -d key\n", me);
174*22028508SToomas Soome }
175*22028508SToomas Soome
176*22028508SToomas Soome /*
177*22028508SToomas Soome * Usage: nvstore -l # list stores
178*22028508SToomas Soome * nvstore store -l # list data in store
179*22028508SToomas Soome * nvstore store [-t type] key value
180*22028508SToomas Soome * nvstore store -g key # get value
181*22028508SToomas Soome * nvstore store -d key # delete key
182*22028508SToomas Soome */
183*22028508SToomas Soome static int
command_nvstore(int argc,char * argv[])184*22028508SToomas Soome command_nvstore(int argc, char *argv[])
185*22028508SToomas Soome {
186*22028508SToomas Soome int c;
187*22028508SToomas Soome bool list, get, delete;
188*22028508SToomas Soome nvstore_t *st;
189*22028508SToomas Soome char *me, *name, *type;
190*22028508SToomas Soome
191*22028508SToomas Soome me = argv[0];
192*22028508SToomas Soome optind = 1;
193*22028508SToomas Soome optreset = 1;
194*22028508SToomas Soome
195*22028508SToomas Soome list = false;
196*22028508SToomas Soome while ((c = getopt(argc, argv, "l")) != -1) {
197*22028508SToomas Soome switch (c) {
198*22028508SToomas Soome case 'l':
199*22028508SToomas Soome list = true;
200*22028508SToomas Soome break;
201*22028508SToomas Soome case '?':
202*22028508SToomas Soome default:
203*22028508SToomas Soome return (CMD_ERROR);
204*22028508SToomas Soome }
205*22028508SToomas Soome }
206*22028508SToomas Soome
207*22028508SToomas Soome argc -= optind;
208*22028508SToomas Soome argv += optind;
209*22028508SToomas Soome
210*22028508SToomas Soome if (argc == 0) {
211*22028508SToomas Soome if (list) {
212*22028508SToomas Soome if (STAILQ_EMPTY(&stores)) {
213*22028508SToomas Soome printf("No configured nvstores\n");
214*22028508SToomas Soome return (CMD_OK);
215*22028508SToomas Soome }
216*22028508SToomas Soome printf("List of configured nvstores:\n");
217*22028508SToomas Soome STAILQ_FOREACH(st, &stores, nvs_next) {
218*22028508SToomas Soome printf("\t%s\n", st->nvs_name);
219*22028508SToomas Soome }
220*22028508SToomas Soome return (CMD_OK);
221*22028508SToomas Soome }
222*22028508SToomas Soome nvstore_usage(me);
223*22028508SToomas Soome return (CMD_ERROR);
224*22028508SToomas Soome }
225*22028508SToomas Soome
226*22028508SToomas Soome if (argc == 0 || (argc != 0 && list)) {
227*22028508SToomas Soome nvstore_usage(me);
228*22028508SToomas Soome return (CMD_ERROR);
229*22028508SToomas Soome }
230*22028508SToomas Soome
231*22028508SToomas Soome st = nvstore_get_store(argv[0]);
232*22028508SToomas Soome if (st == NULL) {
233*22028508SToomas Soome nvstore_usage(me);
234*22028508SToomas Soome return (CMD_ERROR);
235*22028508SToomas Soome }
236*22028508SToomas Soome
237*22028508SToomas Soome optind = 1;
238*22028508SToomas Soome optreset = 1;
239*22028508SToomas Soome name = NULL;
240*22028508SToomas Soome type = NULL;
241*22028508SToomas Soome get = delete = false;
242*22028508SToomas Soome
243*22028508SToomas Soome while ((c = getopt(argc, argv, "d:g:lt:")) != -1) {
244*22028508SToomas Soome switch (c) {
245*22028508SToomas Soome case 'd':
246*22028508SToomas Soome if (list || get) {
247*22028508SToomas Soome nvstore_usage(me);
248*22028508SToomas Soome return (CMD_ERROR);
249*22028508SToomas Soome }
250*22028508SToomas Soome name = optarg;
251*22028508SToomas Soome delete = true;
252*22028508SToomas Soome break;
253*22028508SToomas Soome case 'g':
254*22028508SToomas Soome if (delete || list) {
255*22028508SToomas Soome nvstore_usage(me);
256*22028508SToomas Soome return (CMD_ERROR);
257*22028508SToomas Soome }
258*22028508SToomas Soome name = optarg;
259*22028508SToomas Soome get = true;
260*22028508SToomas Soome break;
261*22028508SToomas Soome case 'l':
262*22028508SToomas Soome if (delete || get) {
263*22028508SToomas Soome nvstore_usage(me);
264*22028508SToomas Soome return (CMD_ERROR);
265*22028508SToomas Soome }
266*22028508SToomas Soome list = true;
267*22028508SToomas Soome break;
268*22028508SToomas Soome case 't':
269*22028508SToomas Soome type = optarg;
270*22028508SToomas Soome break;
271*22028508SToomas Soome case '?':
272*22028508SToomas Soome default:
273*22028508SToomas Soome return (CMD_ERROR);
274*22028508SToomas Soome }
275*22028508SToomas Soome }
276*22028508SToomas Soome
277*22028508SToomas Soome argc -= optind;
278*22028508SToomas Soome argv += optind;
279*22028508SToomas Soome
280*22028508SToomas Soome if (list) {
281*22028508SToomas Soome (void) nvstore_print(st);
282*22028508SToomas Soome return (CMD_OK);
283*22028508SToomas Soome }
284*22028508SToomas Soome
285*22028508SToomas Soome if (delete && name != NULL) {
286*22028508SToomas Soome (void) nvstore_unset_var(st, name);
287*22028508SToomas Soome return (CMD_OK);
288*22028508SToomas Soome }
289*22028508SToomas Soome
290*22028508SToomas Soome if (get && name != NULL) {
291*22028508SToomas Soome char *ptr = NULL;
292*22028508SToomas Soome
293*22028508SToomas Soome if (nvstore_get_var(st, name, (void **)&ptr) == 0)
294*22028508SToomas Soome printf("%s = %s\n", name, ptr);
295*22028508SToomas Soome return (CMD_OK);
296*22028508SToomas Soome }
297*22028508SToomas Soome
298*22028508SToomas Soome if (argc == 2) {
299*22028508SToomas Soome c = nvstore_set_var_from_string(st, type, argv[0], argv[1]);
300*22028508SToomas Soome if (c != 0) {
301*22028508SToomas Soome printf("error: %s\n", strerror(c));
302*22028508SToomas Soome return (CMD_ERROR);
303*22028508SToomas Soome }
304*22028508SToomas Soome return (CMD_OK);
305*22028508SToomas Soome }
306*22028508SToomas Soome
307*22028508SToomas Soome nvstore_usage(me);
308*22028508SToomas Soome return (CMD_OK);
309*22028508SToomas Soome }
310