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
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
|
/*
* Copyright (C) 2020 Linux Studio Plugins Project <https://lsp-plug.in/>
* (C) 2020 Vladimir Sadovnikov <sadko4u@gmail.com>
*
* This file is part of lsp-plugin-fw
* Created on: 24 нояб. 2020 г.
*
* lsp-plugin-fw is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* any later version.
*
* lsp-plugin-fw is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with lsp-plugin-fw. If not, see <https://www.gnu.org/licenses/>.
*/
#ifndef LSP_PLUG_IN_PLUG_FW_CORE_KVTSTORAGE_H_
#define LSP_PLUG_IN_PLUG_FW_CORE_KVTSTORAGE_H_
#include <lsp-plug.in/plug-fw/version.h>
#include <lsp-plug.in/common/status.h>
#include <lsp-plug.in/lltl/parray.h>
#include <lsp-plug.in/lltl/darray.h>
namespace lsp
{
namespace core
{
enum kvt_param_type_t
{
KVT_ANY, // Any type
KVT_INT32,
KVT_UINT32,
KVT_INT64,
KVT_UINT64,
KVT_FLOAT32, // 32-bit floating-point value
KVT_FLOAT64, // 64-bit floating-point value
KVT_STRING, // UTF-8 string
KVT_BLOB // Binary data
};
enum kvt_flags_t
{
KVT_RX = 1 << 0, // Transfer from UI to DSP
KVT_TX = 1 << 1, // Transfer from DSP to UI
KVT_KEEP = 1 << 2, // Keep the previous value of parameter if it exists
KVT_DELEGATE = 1 << 3, // Delegate the control over parameter's data to the storage
KVT_PRIVATE = 1 << 4, // Private option (do not transfer)
KVT_TRANSIENT = 1 << 5, // Transient option (do not serialize)
// Special constants to not to be confused with KVT_RX and KVT_TX abbreviations
KVT_TO_UI = KVT_TX,
KVT_TO_DSP = KVT_RX
};
typedef struct kvt_blob_t
{
const char *ctype; // Content type
const void *data; // Pointer to data
size_t size; // Size of blob
} kvt_blob_t;
typedef struct kvt_param_t
{
kvt_param_type_t type;
union
{
int32_t i32;
uint32_t u32;
int64_t i64;
uint64_t u64;
float f32;
double f64;
const char *str;
kvt_blob_t blob;
};
} kvt_param_t;
class KVTStorage;
class KVTListener
{
public:
explicit KVTListener();
virtual ~KVTListener();
public:
/**
* Listener has been bound to the storage
* @param storage storage
*/
virtual void attached(KVTStorage *storage);
/**
* Listener has been unbound from the storage
* @param storage storage
*/
virtual void detached(KVTStorage *storage);
/**
* Triggers event when parameter has been created
* @param storage KVT storage that triggered the event
* @param id the full unique identifier of parameter
* @param param parameter
* @param pending pending flags (KVT_TX or KVT_RX)
*/
virtual void created(KVTStorage *storage, const char *id, const kvt_param_t *param, size_t pending);
/**
* Triggers event when parameter has been rejected (the put() method
* tried to replace the existing parameter)
* @param storage KVT storage that triggered the event
* @param id the full unique identifier of parameter
* @param rej the rejected parameter
* @param curr current value parameter
* @param pending pending flags (KVT_TX or KVT_RX)
*/
virtual void rejected(KVTStorage *storage, const char *id, const kvt_param_t *rej, const kvt_param_t *curr, size_t pending);
/**
* Triggers event when parameter has been changed
* @param storage KVT storage that triggered the event
* @param id the full unique identifier of parameter
* @param oval old value of parameter
* @param nval new value of parameter
* @param pending pending flags (KVT_TX or KVT_RX)
*/
virtual void changed(KVTStorage *storage, const char *id, const kvt_param_t *oval, const kvt_param_t *nval, size_t pending);
/**
* Triggers event when parameter has been removed
* @param storage KVT storage that triggered the event
* @param id the full unique identifier of parameter
* @param param the value of removed parameter
* @param pending pending flags (KVT_TX or KVT_RX)
*/
virtual void removed(KVTStorage *storage, const char *id, const kvt_param_t *param, size_t pending);
/**
* The parameter has been accessed for reading
* @param storage KVT storage that triggered the event
* @param id parameter identifier
* @param param parameter
* @param pending pending flags (KVT_TX or KVT_RX)
*/
virtual void access(KVTStorage *storage, const char *id, const kvt_param_t *param, size_t pending);
/**
* The parameter has been committed (it's modification flag has been reset)
* @param storage KVT storage that triggered the event
* @param id parameter identifier
* @param pending pending flags (KVT_TX or KVT_RX)
* @param param parameter parameter value
*/
virtual void commit(KVTStorage *storage, const char *id, const kvt_param_t *param, size_t pending);
/**
* The parameter has been accessed for reading/removal
* @param storage KVT storage that triggered the event
* @param id parameter identifier
* @param param parameter
*/
virtual void missed(KVTStorage *storage, const char *id);
};
class KVTIterator;
/**
* Key-value tree storage
*/
class KVTStorage
{
private:
KVTStorage & operator = (const KVTStorage &);
friend class KVTIterator;
enum iterator_mode_t
{
IT_INVALID,
IT_TX_PENDING,
IT_RX_PENDING,
IT_ALL,
IT_BRANCH,
IT_RECURSIVE,
IT_EOF
};
protected:
struct kvt_node_t;
typedef struct kvt_link_t {
kvt_link_t *prev;
kvt_link_t *next;
kvt_node_t *node;
} kvt_link_t;
typedef struct kvt_gcparam_t : public kvt_param_t {
size_t flags;
kvt_gcparam_t *next;
} kvt_gcparam_t;
typedef struct kvt_node_t
{
char *id; // Unique node identifier
size_t idlen; // Length of the ID string
kvt_node_t *parent; // Parent node
ssize_t refs; // Number of references
kvt_gcparam_t *param; // Currently used parameter
size_t pending; // Transmission flags
kvt_link_t gc; // Link to the removed list
kvt_link_t rx; // Link to the Rx modified list
kvt_link_t tx; // Link to the Tx modified list
kvt_node_t **children; // Children
size_t nchildren; // Number of children
size_t capacity; // Capacity in children
} kvt_node_t;
protected:
lltl::parray<KVTListener> vListeners;
kvt_link_t sValid;
kvt_link_t sTx;
kvt_link_t sRx;
kvt_link_t sGarbage;
char cSeparator;
kvt_gcparam_t *pTrash;
KVTIterator *pIterators;
kvt_node_t sRoot;
size_t nValues;
size_t nNodes;
size_t nTxPending;
size_t nRxPending;
protected:
inline void notify_created(const char *id, const kvt_param_t *param, size_t pending);
inline void notify_rejected(const char *id, const kvt_param_t *rej, const kvt_param_t *curr, size_t pending);
inline void notify_changed(const char *id, const kvt_param_t *oval, const kvt_param_t *nval, size_t flags);
inline void notify_removed(const char *id, const kvt_param_t *param, size_t pending);
inline void notify_access(const char *id, const kvt_param_t *param, size_t pending);
inline void notify_commit(const char *id, const kvt_param_t *param, size_t pending);
inline void notify_missed(const char *id);
protected:
inline static void link_list(kvt_link_t *root, kvt_link_t *item);
inline static void unlink_list(kvt_link_t *item);
size_t set_pending_state(kvt_node_t *node, size_t flags);
kvt_node_t *reference_up(kvt_node_t *node);
kvt_node_t *reference_down(kvt_node_t *node);
char *build_path(char **path, size_t *capacity, const kvt_node_t *node);
void destroy_parameter(kvt_gcparam_t *p);
status_t commit_parameter(const char *path, kvt_node_t *node, const kvt_param_t *value, size_t flags);
kvt_gcparam_t *copy_parameter(const kvt_param_t *src, size_t flags);
inline void init_node(kvt_node_t *node, const char *name, size_t len);
kvt_node_t *allocate_node(const char *name, size_t len);
kvt_node_t *create_node(kvt_node_t *base, const char *name, size_t len);
void destroy_node(kvt_node_t *node);
kvt_node_t *get_node(kvt_node_t *base, const char *name, size_t len);
status_t walk_node(kvt_node_t **out, const char *name);
status_t do_remove_node(const char *name, kvt_node_t *node, const kvt_param_t **value, kvt_param_type_t type);
status_t do_touch(const char *name, kvt_node_t *node, size_t flags);
status_t do_commit(const char *name, kvt_node_t *node, size_t flags);
status_t do_remove_branch(const char *name, kvt_node_t *node);
static inline bool validate_type(size_t type) { return (type >= KVT_INT32) && (type <= KVT_BLOB); }
public:
explicit KVTStorage(char separator = '/');
~KVTStorage();
void destroy();
status_t clear();
public:
/**
* Bind listener to the storage
* @param listener listener to bind
* @return status of operation
*/
status_t bind(KVTListener *listener);
/**
* Unbind listener from storage
* @param listener listener to unbind
* @return status of operation
*/
status_t unbind(KVTListener *listener);
/**
* Check that listener is bound
* @param listener listener to check
* @return status of operation
*/
status_t is_bound(KVTListener *listener);
/**
* Unbind all listeners
* @return status of operation
*/
status_t unbind_all();
public:
inline size_t nodes() const { return nNodes; }
inline size_t values() const { return nValues; }
inline size_t tx_pending() const { return nTxPending; }
inline size_t rx_pending() const { return nRxPending; }
size_t listeners() const;
public:
/**
* Put parameter to the storage
* @param name parameter name
* @param value parameter value
* @param flags operation flags @see kvt_flags_t
* @return status of operation:
* STATUS_OK if parameter has been stored
* STATUS_ALREADY_EXISTS if parameter has been rejected (only if KVT_KEEP is set)
* other error otherwise
*/
status_t put(const char *name, const kvt_param_t *value, size_t flags = 0);
status_t put(const char *name, uint32_t value, size_t flags = 0);
status_t put(const char *name, int32_t value, size_t flags = 0);
status_t put(const char *name, uint64_t value, size_t flags = 0);
status_t put(const char *name, int64_t value, size_t flags = 0);
status_t put(const char *name, float value, size_t flags = 0);
status_t put(const char *name, double value, size_t flags = 0);
status_t put(const char *name, const char *value, size_t flags = 0);
status_t put(const char *name, const kvt_blob_t *value, size_t flags = 0);
status_t put(const char *name, size_t size, const char *type, const void *value, size_t flags = 0);
/**
* Fetch parameter from the storage
* @param name parameter name
* @param value pointer to store the pointer to the parameter
* @param cast cast the value to the type if possible
* @return status of operation:
* STATUS_OK if parameter has been successfully read
* STATUS_NOT_FOUND if parameter has been not found
* STATUS_BAD_TYPE if parameter has incompatible type
*/
status_t get(const char *name, const kvt_param_t **value, kvt_param_type_t type = KVT_ANY);
status_t get(const char *name, uint32_t *value);
status_t get(const char *name, int32_t *value);
status_t get(const char *name, uint64_t *value);
status_t get(const char *name, int64_t *value);
status_t get(const char *name, float *value);
status_t get(const char *name, double *value);
status_t get(const char *name, const char **value);
status_t get(const char *name, const kvt_blob_t **value);
status_t get_dfl(const char *name, uint32_t *value, uint32_t dfl);
status_t get_dfl(const char *name, int32_t *value, int32_t dfl);
status_t get_dfl(const char *name, uint64_t *value, uint64_t dfl);
status_t get_dfl(const char *name, int64_t *value, int64_t dfl);
status_t get_dfl(const char *name, float *value, float dfl);
status_t get_dfl(const char *name, double *value, double dfl);
status_t get_dfl(const char *name, const char **value, const char *dfl);
/**
* Check that parameter of specified type exists
* @param name parameter name
* @param type parameter type (optional)
* @return true if parameter with such type exists
*/
bool exists(const char *name, kvt_param_type_t type = KVT_ANY);
/**
* Remove parameter from storage
* @param name parameter name
* @param value pointer to store the parameter's value
* @param type value type
* @return status of operation:
* STATUS_OK if parameter has been removed
* STATUS_NOT_FOUND if parameter has been not found
*/
status_t remove(const char *name, const kvt_param_t **value = NULL, kvt_param_type_t type = KVT_ANY);
status_t remove(const char *name, uint32_t *value);
status_t remove(const char *name, int32_t *value);
status_t remove(const char *name, uint64_t *value);
status_t remove(const char *name, int64_t *value);
status_t remove(const char *name, float *value);
status_t remove(const char *name, double *value);
status_t remove(const char *name, const char **value);
status_t remove(const char *name, const kvt_blob_t **value);
/**
* Set the state of node
* @param name node name
* @param modified modification flag (KVT_TX and KVT_RX)
* @return status of operation
* STATUS_OK if parameter has been removed
* STATUS_NOT_FOUND if parameter has been not found
*/
status_t touch(const char *name, size_t flags);
status_t commit(const char *name, size_t flags);
status_t touch_all(size_t flags);
status_t commit_all(size_t flags);
/**
* Remove the full parameter branch from storage
* @param name parameter name
* @return status of operation:
* STATUS_OK if parameter has been removed
* STATUS_NOT_FOUND if parameter has been not found
*/
status_t remove_branch(const char *name);
/**
* Perform garbage collection. Any of previously returned pointers to strings and
* blobs can become invalid
* @return status of operation
*/
status_t gc();
public:
/**
* Enumerate the pending for transfer elements.
* The returned iterator will be automatically garbage-collected on gc() call.
*
* @return element iterator
*/
KVTIterator *enum_tx_pending();
/**
* Enumerate the pending for receive elements.
* The returned iterator will be automatically garbage-collected on gc() call.
*
* @return element iterator
*/
KVTIterator *enum_rx_pending();
/**
* Enumerate the whole contents of storage.
* The returned iterator will be automatically garbage-collected on gc() call.
*
* @return element iterator
*/
KVTIterator *enum_all();
/**
* Enumerate the whole KVT tree branch
* The returned iterator will be automatically garbage-collected on gc() call.
*
* @param name branch name
* @param recursive enumerate sub-elements of the KVT tree branch
* @return element iterator
*/
KVTIterator *enum_branch(const char *name, bool recursive = false);
};
class KVTIterator
{
protected:
typedef struct kvt_path_t
{
KVTStorage::kvt_node_t *node;
size_t index;
} kvt_path_t;
protected:
KVTStorage::kvt_node_t sFake;
KVTStorage::iterator_mode_t enMode;
KVTStorage::kvt_node_t *pCurr;
KVTStorage::kvt_node_t *pNext;
size_t nIndex;
lltl::darray<kvt_path_t> vPath;
mutable char *pPath;
mutable char *pData;
mutable size_t nDataCap;
KVTStorage *pStorage;
KVTIterator *pGcNext;
friend class KVTStorage;
protected:
KVTIterator & operator = (const KVTIterator &);
explicit KVTIterator(KVTStorage *storage, KVTStorage::kvt_node_t *node, KVTStorage::iterator_mode_t mode);
virtual ~KVTIterator();
public:
/**
* Iterate to the next entry
* @return STATUS_OK if the next entry is present, STATUS_NOT_FOUND if no record found
*/
status_t next();
bool valid() const;
bool tx_pending() const;
bool rx_pending() const;
size_t pending() const;
size_t flags() const;
inline bool is_transient() const { return flags() & KVT_TRANSIENT; }
inline bool is_private() const { return flags() & KVT_PRIVATE; }
public:
bool exists(kvt_param_type_t type = KVT_ANY) const;
status_t get(const kvt_param_t **value, kvt_param_type_t type = KVT_ANY);
status_t get(uint32_t *value);
status_t get(int32_t *value);
status_t get(uint64_t *value);
status_t get(int64_t *value);
status_t get(float *value);
status_t get(double *value);
status_t get(const char **value);
status_t get(const kvt_blob_t **value);
status_t put(const kvt_param_t *value, size_t flags = 0);
status_t put(uint32_t value, size_t flags = 0);
status_t put(int32_t value, size_t flags = 0);
status_t put(uint64_t value, size_t flags = 0);
status_t put(int64_t value, size_t flags = 0);
status_t put(float value, size_t flags = 0);
status_t put(double value, size_t flags = 0);
status_t put(const char *value, size_t flags = 0);
status_t put(const kvt_blob_t *value, size_t flags = 0);
status_t put(size_t size, const char *type, const void *value, size_t flags = 0);
status_t remove(const kvt_param_t **value = NULL, kvt_param_type_t type = KVT_ANY);
status_t remove(uint32_t *value);
status_t remove(int32_t *value);
status_t remove(uint64_t *value);
status_t remove(int64_t *value);
status_t remove(float *value);
status_t remove(double *value);
status_t remove(const char **value);
status_t remove(const kvt_blob_t **value);
status_t touch(size_t flags);
status_t commit(size_t flags);
status_t remove_branch();
const char *name() const;
const char *id() const;
};
#ifdef LSP_DEBUG
void kvt_dump_parameter(const char *fmt, const kvt_param_t *param...);
#else
inline void kvt_dump_parameter(const char *fmt, const kvt_param_t *param...) {}
#endif
}
}
#endif /* LSP_PLUG_IN_PLUG_FW_CORE_KVTSTORAGE_H_ */
|
