aboutsummaryrefslogtreecommitdiff
path: root/stand/libsa/nvstore.c
blob: e5a804ff15e8f19fcf4d810b4b043d83ea7683c6 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
/*-
 * Copyright 2020 Toomas Soome <tsoome@me.com>
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */

/*
 * Big Theory Statement.
 *
 * nvstore is abstraction layer to implement data read/write to different
 * types of non-volatile storage.
 *
 * User interfaces:
 * Provide mapping via environment: setenv/unsetenv/putenv. Access via
 * environment functions/commands is available once nvstore has
 * attached the backend and stored textual data is mapped to environment.
 *
 * nvstore_init(): attach new backend and create the environment mapping.
 * nvstore_fini: detach backend and unmap the related environment.
 *
 * The disk based storage, such as UFS file or ZFS bootenv label area, is
 * only accessible after root file system is set. Root file system change
 * will switch the back end storage.
 */

#include <sys/cdefs.h>
__FBSDID("$FreeBSD$");

#include <stdbool.h>
#include <sys/queue.h>
#include "stand.h"
#include "nvstore.h"

nvstore_list_t stores = STAILQ_HEAD_INITIALIZER(stores);

void *
nvstore_get_store(const char *name)
{
	nvstore_t *st;

	st = NULL;

	STAILQ_FOREACH(st, &stores, nvs_next) {
		if (strcmp(name, st->nvs_name) == 0)
			break;
	}

	return (st);
}

int
nvstore_init(const char *name, nvs_callbacks_t *cb, void *data)
{
	nvstore_t *st;

	st = nvstore_get_store(name);
	if (st != NULL)
		return (EEXIST);

	if ((st = malloc(sizeof (*st))) == NULL)
		return (ENOMEM);

	if ((st->nvs_name = strdup(name)) == NULL) {
		free(st);
		return (ENOMEM);
	}

	st->nvs_data = data;
	st->nvs_cb = cb;

	STAILQ_INSERT_TAIL(&stores, st, nvs_next);
	return (0);
}

int
nvstore_fini(const char *name)
{
	nvstore_t *st;

	st = nvstore_get_store(name);
	if (st == NULL)
		return (ENOENT);

	STAILQ_REMOVE(&stores, st, nvstore, nvs_next);

	free(st->nvs_name);
	free(st->nvs_data);
	free(st);
	return (0);
}

int
nvstore_print(void *ptr)
{
	nvstore_t *st = ptr;

	return (st->nvs_cb->nvs_iterate(st->nvs_data, st->nvs_cb->nvs_print));
}

int
nvstore_get_var(void *ptr, const char *name, void **data)
{
	nvstore_t *st = ptr;

	return (st->nvs_cb->nvs_getter(st->nvs_data, name, data));
}

int
nvstore_set_var(void *ptr, int type, const char *name,
    void *data, size_t size)
{
	nvstore_t *st = ptr;

	return (st->nvs_cb->nvs_setter(st->nvs_data, type, name, data, size));
}

int
nvstore_set_var_from_string(void *ptr, const char *type, const char *name,
    const char *data)
{
	nvstore_t *st = ptr;

	return (st->nvs_cb->nvs_setter_str(st->nvs_data, type, name, data));
}

int
nvstore_unset_var(void *ptr, const char *name)
{
	nvstore_t *st = ptr;

	return (st->nvs_cb->nvs_unset(st->nvs_data, name));
}