-
-
Notifications
You must be signed in to change notification settings - Fork 86
/
Copy pathFileSystemStore.h
271 lines (245 loc) · 11.9 KB
/
FileSystemStore.h
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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
/* mbed Microcontroller Library
* Copyright (c) 2018 ARM Limited
*
* SPDX-License-Identifier: Apache-2.0
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef MBED_FILE_SYSTEM_STORE_H
#define MBED_FILE_SYSTEM_STORE_H
#include "KVStore.h"
#include "FileSystem.h"
namespace mbed {
/** FileSystemStore for Secure Store.
* This class implements the KVStore interface to
* create a key value store over FileSystem.
*
* @code
* ...
* @endcode
*/
class FileSystemStore : public KVStore {
public:
/** Create FileSystemStore - A Key Value API on top of FS
*
* @param fs File system (FAT/LITTLE) on top of which FileSystemStore is adding KV API
*/
FileSystemStore(FileSystem *fs);
/** Destroy FileSystemStore instance
*
*/
virtual ~FileSystemStore() {}
/**
* @brief Initialize FileSystemStore, checking validity of
* KVStore writing folder and if it doesn't exist, creating it.
*
* @returns KVSTORE_SUCCESS Success.
* KVSTORE_ERROR_FAILED_OPERATION Underlying file system failed operation.
*/
virtual int init();
/**
* @brief Deinitialize FileSystemStore, release and free resources.
*
* @returns KVSTORE_SUCCESS Success.
*/
virtual int deinit();
/**
* @brief Reset FileSystemStore contents (clear all keys)
*
* @returns KVSTORE_SUCCESS Success.
* KVSTORE_ERROR_NOT_READY Not initialized.
* KVSTORE_ERROR_FAILED_OPERATION Underlying file system failed operation.
*/
virtual int reset();
/**
* @brief Set one FileSystemStore item, given key and value.
*
* @param[in] key Key - must not include '*' '/' '?' ':' ';' '\' '"' '|' ' ' '<' '>' '\'.
* @param[in] buffer Value data buffer.
* @param[in] size Value data size.
* @param[in] create_flags Flag mask.
*
* @returns KVSTORE_SUCCESS Success.
* KVSTORE_ERROR_NOT_READY Not initialized.
* KVSTORE_ERROR_FAILED_OPERATION Underlying file system failed operation.
* KVSTORE_ERROR_INVALID_ARGUMENT Invalid argument given in function arguments.
* KVSTORE_ERROR_INVALID_SIZE Invalid size given in function arguments.
* KVSTORE_ERROR_WRITE_PROTECTED Already stored with "write once" flag.
*/
virtual int set(const char *key, const void *buffer, size_t size, uint32_t create_flags);
/**
* @brief Get one FileSystemStore item by given key.
*
* @param[in] key Key - must not include '*' '/' '?' ':' ';' '\' '"' '|' ' ' '<' '>' '\'.
* @param[in] buffer Value data buffer.
* @param[in] buffer_size Value data buffer size.
* @param[out] actual_size Actual read size.
* @param[in] offset Offset to read from in data.
*
* @returns KVSTORE_SUCCESS Success.
* KVSTORE_ERROR_NOT_READY Not initialized.
* KVSTORE_ERROR_FAILED_OPERATION Underlying file system failed operation.
* KVSTORE_ERROR_INVALID_ARGUMENT Invalid argument given in function arguments.
* KVSTORE_ERROR_INVALID_SIZE Invalid size given in function arguments.
* KVSTORE_ERROR_INVALID_DATA_DETECTED Data is corrupted.
* KVSTORE_ERROR_ITEM_NOT_FOUND No such key.
*/
virtual int get(const char *key, void *buffer, size_t buffer_size, size_t *actual_size = NULL, size_t offset = 0);
/**
* @brief Get information of a given key. The returned info contains size and flags
*
* @param[in] key Key - must not include '*' '/' '?' ':' ';' '\' '"' '|' ' ' '<' '>' '\'.
* @param[out] info Returned information structure.
*
* @returns KVSTORE_SUCCESS Success.
* KVSTORE_ERROR_NOT_READY Not initialized.
* KVSTORE_ERROR_FAILED_OPERATION Underlying file system failed operation.
* KVSTORE_ERROR_INVALID_ARGUMENT Invalid argument given in function arguments.
* KVSTORE_ERROR_INVALID_SIZE Invalid size given in function arguments.
* KVSTORE_ERROR_INVALID_DATA_DETECTED Data is corrupted.
* KVSTORE_ERROR_ITEM_NOT_FOUND No such key.
*/
virtual int get_info(const char *key, info_t *info);
/**
* @brief Remove a FileSystemStore item by given key.
*
* @param[in] key Key - must not include '*' '/' '?' ':' ';' '\' '"' '|' ' ' '<' '>' '\'.
*
* @returns KVSTORE_SUCCESS Success.
* KVSTORE_ERROR_NOT_READY Not initialized.
* KVSTORE_ERROR_FAILED_OPERATION Underlying file system failed operation.
* KVSTORE_ERROR_INVALID_ARGUMENT Invalid argument given in function arguments.
* KVSTORE_ERROR_ITEM_NOT_FOUND No such key.
* KVSTORE_ERROR_WRITE_PROTECTED Already stored with "write once" flag.
*/
virtual int remove(const char *key);
/**
* @brief Start an incremental FileSystemStore set sequence. This operation is blocking other operations.
* Any get/set/remove/iterator operation will be blocked until set_finalize is called.
*
* @param[out] handle Returned incremental set handle.
* @param[in] key Key - must not include '*' '/' '?' ':' ';' '\' '"' '|' ' ' '<' '>' '\'.
* @param[in] final_data_size Final value data size.
* @param[in] create_flags Flag mask.
*
* @returns KVSTORE_SUCCESS Success.
* KVSTORE_ERROR_NOT_READY Not initialized.
* KVSTORE_ERROR_FAILED_OPERATION Underlying file system failed operation.
* KVSTORE_ERROR_INVALID_ARGUMENT Invalid argument given in function arguments.
* KVSTORE_ERROR_INVALID_SIZE Invalid size given in function arguments.
* KVSTORE_ERROR_WRITE_PROTECTED Already stored with "write once" flag.
*/
virtual int set_start(set_handle_t *handle, const char *key, size_t final_data_size, uint32_t create_flags);
/**
* @brief Add data to incremental FileSystemStore set sequence. This operation is blocking other operations.
* Any get/set/remove operation will be blocked until set_finalize is called.
*
* @param[in] handle Incremental set handle.
* @param[in] value_data Value data to add.
* @param[in] data_size Value data size.
*
* @returns KVSTORE_SUCCESS Success.
* KVSTORE_ERROR_NOT_READY Not initialized.
* KVSTORE_ERROR_FAILED_OPERATION Underlying file system failed operation.
* KVSTORE_ERROR_INVALID_ARGUMENT Invalid argument given in function arguments.
* KVSTORE_ERROR_INVALID_SIZE Invalid size given in function arguments.
* KVSTORE_ERROR_WRITE_PROTECTED Already stored with "write once" flag.
*/
virtual int set_add_data(set_handle_t handle, const void *value_data, size_t data_size);
/**
* @brief Finalize an incremental FileSystemStore set sequence.
*
* @param[in] handle Incremental set handle.
*
* @returns KVSTORE_SUCCESS Success.
* KVSTORE_ERROR_NOT_READY Not initialized.
* KVSTORE_ERROR_FAILED_OPERATION Underlying file system failed operation.
* KVSTORE_ERROR_INVALID_ARGUMENT Invalid argument given in function arguments.
*/
virtual int set_finalize(set_handle_t handle);
/**
* @brief Start an iteration over FileSystemStore keys.
* There are no issues with any other operations while iterator is open.
*
* @param[out] it Returned iterator handle.
* @param[in] prefix Key prefix (null for all keys).
*
* @returns KVSTORE_SUCCESS Success.
* KVSTORE_ERROR_NOT_READY Not initialized.
* KVSTORE_ERROR_INVALID_ARGUMENT Invalid argument given in function arguments.
*/
virtual int iterator_open(iterator_t *it, const char *prefix = NULL);
/**
* @brief Get next key in iteration.
* There are no issues with any other operations while iterator is open.
*
* @param[in] it Iterator handle.
* @param[in] key Buffer for returned key.
* @param[in] key_size Key buffer size.
*
* @returns KVSTORE_SUCCESS Success.
* KVSTORE_ERROR_NOT_READY Not initialized.
* KVSTORE_ERROR_INVALID_ARGUMENT Invalid argument given in function arguments.
* KVSTORE_ERROR_ITEM_NOT_FOUND No more keys found.
*/
virtual int iterator_next(iterator_t it, char *key, size_t key_size);
/**
* @brief Close iteration.
*
* @param[in] it Iterator handle.
*
* @returns KVSTORE_SUCCESS Success.
* KVSTORE_ERROR_NOT_READY Not initialized.
* KVSTORE_ERROR_INVALID_ARGUMENT Invalid argument given in function arguments.
*/
virtual int iterator_close(iterator_t it);
#if !defined(DOXYGEN_ONLY)
private:
// Key metadata
typedef struct {
uint32_t magic;
uint16_t metadata_size;
uint16_t revision;
uint32_t user_flags;
} key_metadata_t;
/**
* @brief Build Full name class member from Key, as a combination of FSST folder and key name
*
* @param[in] key_src key file name
*
* @returns 0 on success or a negative error code on failure
*/
int _build_full_path_key(const char *key_src);
/**
* @brief Verify Key file metadata validity and open it if valid
*
* @param[in] key In validated key file name.
* @param[in] key_metadata Returned key file metadata.
* @param[in] kv_file Opened KV file handle (unless file doesn't exist)
*
* @returns 0 on success or a negative error code on failure
*/
int _verify_key_file(const char *key, key_metadata_t *key_metadata, File *kv_file);
FileSystem *_fs;
PlatformMutex _mutex;
PlatformMutex _inc_data_add_mutex;
bool _is_initialized;
char *_cfg_fs_path; /* FileSystemStore path name on FileSystem */
size_t _cfg_fs_path_size; /* Size of configured FileSystemStore path name on FileSystem */
char *_full_path_key; /* Full name of Key file currently working on */
size_t _cur_inc_data_size; /* Amount of data added to Key file so far, during incremental add data */
set_handle_t _cur_inc_set_handle; /* handle of currently key file under incremental set process */
#endif
};
} //namespace mbed
#endif //MBED_FILE_SYSTEM_STORE_H