-
Notifications
You must be signed in to change notification settings - Fork 5
/
Copy pathubridge.c
4616 lines (3931 loc) · 157 KB
/
ubridge.c
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
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* This file is part of SID.
*
* Copyright (C) 2017-2020 Red Hat, Inc. All rights reserved.
*
* SID is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 2 of the License, or
* (at your option) any later version.
*
* SID 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with SID. If not, see <http://www.gnu.org/licenses/>.
*/
#include "base/common.h"
#include "base/bitmap.h"
#include "base/buffer.h"
#include "base/comms.h"
#include "base/formatter.h"
#include "base/mem.h"
#include "base/util.h"
#include "iface/usid.h"
#include "log/log.h"
#include "resource/kv-store.h"
#include "resource/module-registry.h"
#include "resource/resource.h"
#include "resource/ucmd-module.h"
#include "resource/worker-control.h"
#include <ctype.h>
#include <dirent.h>
#include <fcntl.h>
#include <libudev.h>
#include <sys/mman.h>
#include <sys/signalfd.h>
#include <sys/stat.h>
#include <sys/types.h>
#include <unistd.h>
#define UBRIDGE_NAME "ubridge"
#define CONNECTION_NAME "connection"
#define COMMAND_NAME "command"
#define INTERNAL_AGGREGATE_ID "ubridge-internal"
#define MODULES_AGGREGATE_ID "modules"
#define MODULES_BLOCK_ID "block"
#define MODULES_TYPE_ID "type"
#define UDEV_TAG_SID "sid"
#define KV_KEY_UDEV_SID_SESSION_ID "SID_SESSION_ID"
#define SID_UCMD_MOD_FN_NAME_TRIGGER_ACTION_CURRENT "sid_ucmd_trigger_action_current"
#define SID_UCMD_MOD_FN_NAME_TRIGGER_ACTION_NEXT "sid_ucmd_trigger_action_next"
#define MAIN_KV_STORE_NAME "main"
#define MAIN_WORKER_CHANNEL_ID "main"
#define KV_PAIR_C "="
#define KV_END_C ""
#define ID_NULL ""
#define KEY_NULL ID_NULL
#define KV_PREFIX_OP_ILLEGAL_C "X"
#define KV_PREFIX_OP_SET_C ""
#define KV_PREFIX_OP_PLUS_C "+"
#define KV_PREFIX_OP_MINUS_C "-"
#define KV_PREFIX_NS_UNDEFINED_C ""
#define KV_PREFIX_NS_UDEV_C "U"
#define KV_PREFIX_NS_DEVICE_C "D"
#define KV_PREFIX_NS_MODULE_C "M"
#define KV_PREFIX_NS_GLOBAL_C "G"
#define KEY_SYS_C "#"
#define KV_KEY_DEV_READY KEY_SYS_C "RDY"
#define KV_KEY_DEV_RESERVED KEY_SYS_C "RES"
#define KV_KEY_DEV_MOD KEY_SYS_C "MOD"
#define KV_KEY_DOM_LAYER "LYR"
#define KV_KEY_DOM_USER "USR"
#define KV_KEY_GEN_GROUP_MEMBERS KEY_SYS_C "GMB"
#define KV_KEY_GEN_GROUP_IN KEY_SYS_C "GIN"
#define MOD_NAME_CORE "#core"
#define OWNER_CORE MOD_NAME_CORE
#define DEFAULT_KV_FLAGS_CORE KV_PERSISTENT | KV_MOD_RESERVED | KV_MOD_PRIVATE
#define CMD_DEV_ID_FMT "%s (%d:%d)"
#define CMD_DEV_ID(ucmd_ctx) ucmd_ctx->udev_dev.name, ucmd_ctx->udev_dev.major, ucmd_ctx->udev_dev.minor
/* internal resources */
const sid_resource_type_t sid_resource_type_ubridge_connection;
const sid_resource_type_t sid_resource_type_ubridge_command;
struct sid_ucmd_mod_ctx {
sid_resource_t *kv_store_res; /* KV store main or snapshot */
sid_resource_t *modules_res; /* top-level resource for all ucmd module registries */
struct buffer * gen_buf; /* generic buffer */
};
struct umonitor {
struct udev * udev;
struct udev_monitor *mon;
};
struct ubridge {
int socket_fd;
struct sid_ucmd_mod_ctx ucmd_mod_ctx;
struct umonitor umonitor;
};
typedef enum
{
CMD_SCAN_PHASE_A_INIT = 0, /* core initializes phase "A" */
CMD_SCAN_PHASE_A_IDENT, /* module */
CMD_SCAN_PHASE_A_SCAN_PRE, /* module */
CMD_SCAN_PHASE_A_SCAN_CURRENT, /* module */
CMD_SCAN_PHASE_A_SCAN_NEXT, /* module */
CMD_SCAN_PHASE_A_SCAN_POST_CURRENT, /* module */
CMD_SCAN_PHASE_A_SCAN_POST_NEXT, /* module */
CMD_SCAN_PHASE_A_WAITING, /* core waits for confirmation */
CMD_SCAN_PHASE_A_EXIT, /* core exits phase "A" */
CMD_SCAN_PHASE_B_TRIGGER_ACTION_CURRENT,
__CMD_SCAN_PHASE_B_TRIGGER_ACTION_START = CMD_SCAN_PHASE_B_TRIGGER_ACTION_CURRENT,
CMD_SCAN_PHASE_B_TRIGGER_ACTION_NEXT,
__CMD_SCAN_PHASE_B_TRIGGER_ACTION_END = CMD_SCAN_PHASE_B_TRIGGER_ACTION_NEXT,
CMD_SCAN_PHASE_ERROR,
} cmd_scan_phase_t;
struct udevice {
udev_action_t action;
udev_devtype_t type;
const char * path;
const char * name; /* just a pointer to devpath's last element */
int major;
int minor;
uint64_t seqnum;
const char * synth_uuid;
};
struct connection {
int fd;
struct buffer *buf;
};
struct sid_ucmd_ctx {
char * dev_id; /* device identifier (major_minor) */
struct udevice udev_dev; /* udev context for currently processed device */
cmd_scan_phase_t scan_phase; /* current phase at the time of use of this context */
struct sid_ucmd_mod_ctx ucmd_mod_ctx; /* commod module context */
struct buffer * res_buf; /* result buffer */
struct usid_msg_header request_header; /* original request header (keep last, contains flexible array) */
};
struct cmd_mod_fns {
sid_ucmd_fn_t *ident;
sid_ucmd_fn_t *scan_pre;
sid_ucmd_fn_t *scan_current;
sid_ucmd_fn_t *scan_next;
sid_ucmd_fn_t *scan_post_current;
sid_ucmd_fn_t *scan_post_next;
sid_ucmd_fn_t *trigger_action_current;
sid_ucmd_fn_t *trigger_action_next;
sid_ucmd_fn_t *error;
} __attribute__((packed));
struct cmd_exec_arg {
sid_resource_t * cmd_res;
sid_resource_t * type_mod_registry_res;
sid_resource_iter_t *block_mod_iter; /* all block modules to execute */
sid_resource_t * type_mod_res_current; /* one type module for current layer to execute */
sid_resource_t * type_mod_res_next; /* one type module for next layer to execute */
};
struct cmd_reg {
const char *name;
uint32_t flags;
int (*exec)(struct cmd_exec_arg *exec_arg);
};
struct kv_value {
uint64_t seqnum;
sid_ucmd_kv_flags_t flags;
char data[]; /* contains both internal and external data */
} __attribute__((packed));
enum
{
KV_VALUE_IDX_SEQNUM,
KV_VALUE_IDX_FLAGS,
KV_VALUE_IDX_OWNER,
KV_VALUE_IDX_DATA,
_KV_VALUE_IDX_COUNT,
};
#define KV_VALUE_PREPARE_HEADER(iov, seqnum, flags, owner) \
iov[KV_VALUE_IDX_SEQNUM] = (struct iovec) {&(seqnum), sizeof(seqnum)}; \
iov[KV_VALUE_IDX_FLAGS] = (struct iovec) {&(flags), sizeof(flags)}; \
iov[KV_VALUE_IDX_OWNER] = (struct iovec) \
{ \
owner, strlen(owner) + 1 \
}
#define KV_VALUE_SEQNUM(iov) (*((uint64_t *) ((struct iovec *) iov)[KV_VALUE_IDX_SEQNUM].iov_base))
#define KV_VALUE_FLAGS(iov) (*((sid_ucmd_kv_flags_t *) ((struct iovec *) iov)[KV_VALUE_IDX_FLAGS].iov_base))
#define KV_VALUE_OWNER(iov) ((char *) ((struct iovec *) iov)[KV_VALUE_IDX_OWNER].iov_base)
#define KV_VALUE_DATA(iov) (((struct iovec *) iov)[KV_VALUE_IDX_DATA].iov_base)
struct kv_update_arg {
sid_resource_t *res;
struct buffer * gen_buf;
const char * owner; /* in */
void * custom; /* in/out */
int ret_code; /* out */
};
typedef enum
{
KV_OP_ILLEGAL, /* illegal operation */
KV_OP_SET, /* set value for kv */
KV_OP_PLUS, /* add value to vector kv */
KV_OP_MINUS, /* remove value fomr vector kv */
} kv_op_t;
typedef enum
{
DELTA_NO_FLAGS = 0x0,
DELTA_WITH_DIFF = 0x1, /* calculate difference between old and new value, update records */
DELTA_WITH_REL = 0x2, /* as DELTA_WITH_DIFF, but also update referenced relatives */
} delta_flags_t;
struct kv_delta {
kv_op_t op;
delta_flags_t flags;
struct buffer *plus;
struct buffer *minus;
struct buffer *final;
};
typedef enum
{
__KEY_PART_START = 0x0,
KEY_PART_OP = 0x0,
KEY_PART_DOM = 0x1,
KEY_PART_NS = 0x2,
KEY_PART_NS_PART = 0x3,
KEY_PART_ID = 0x4,
KEY_PART_ID_PART = 0x5,
KEY_PART_CORE = 0x6,
__KEY_PART_COUNT,
} key_part_t;
struct kv_key_spec {
kv_op_t op;
const char * dom;
sid_ucmd_kv_namespace_t ns;
const char * ns_part;
const char * id;
const char * id_part;
const char * key;
};
struct kv_rel_spec {
struct kv_delta * delta;
struct kv_key_spec *cur_key_spec;
struct kv_key_spec *rel_key_spec;
};
struct kv_key_res_def {
sid_ucmd_kv_namespace_t ns;
const char * key;
};
struct cross_bitmap_calc_arg {
struct iovec * old_value;
size_t old_size;
struct bitmap *old_bmp;
struct iovec * new_value;
size_t new_size;
struct bitmap *new_bmp;
};
/*
* Generic flags for all commands.
*/
#define CMD_KV_IMPORT_UDEV UINT32_C(0x00000001) /* imports udev environment as KV_NS_UDEV records */
#define CMD_KV_EXPORT_UDEV UINT32_C(0x00000002) /* exports KV_NS_UDEV+KV_PERSISTENT records to udev environment/db */
#define CMD_KV_EXPORT_SID UINT32_C(0x00000004) /* exports KV_NS_<!UDEV>+KV_PERSISTENT records to main sid db */
#define CMD_SESSION_ID UINT32_C(0x00000008) /* supports sessions */
#define CMD_SKIP_RESULT UINT32_C(0x00000010) /* skips sending the result buffer */
/*
* Capability flags for 'scan' command phases (phases are represented as subcommands).
*/
#define CMD_SCAN_CAP_RDY UINT32_C(0x00000001) /* can set ready state */
#define CMD_SCAN_CAP_RES UINT32_C(0x00000002) /* can set reserved state */
#define CMD_SCAN_CAP_ALL UINT32_C(0xFFFFFFFF) /* can set anything */
static struct cmd_reg _cmd_scan_phase_regs[];
static sid_ucmd_kv_flags_t kv_flags_no_persist = (DEFAULT_KV_FLAGS_CORE) & ~KV_PERSISTENT;
static sid_ucmd_kv_flags_t kv_flags_persist = DEFAULT_KV_FLAGS_CORE;
static char * core_owner = OWNER_CORE;
static int _kv_delta(const char *full_key, struct kv_store_update_spec *spec, void *arg);
static const char _key_prefix_err_msg[] = "Failed to get key prefix to store hierarchy records for device " CMD_DEV_ID_FMT ".";
udev_action_t sid_ucmd_dev_get_action(struct sid_ucmd_ctx *ucmd_ctx)
{
return ucmd_ctx->udev_dev.action;
}
int sid_ucmd_dev_get_major(struct sid_ucmd_ctx *ucmd_ctx)
{
return ucmd_ctx->udev_dev.major;
}
int sid_ucmd_dev_get_minor(struct sid_ucmd_ctx *ucmd_ctx)
{
return ucmd_ctx->udev_dev.minor;
}
const char *sid_ucmd_dev_get_name(struct sid_ucmd_ctx *ucmd_ctx)
{
return ucmd_ctx->udev_dev.name;
}
udev_devtype_t sid_ucmd_dev_get_type(struct sid_ucmd_ctx *ucmd_ctx)
{
return ucmd_ctx->udev_dev.type;
}
uint64_t sid_ucmd_dev_get_seqnum(struct sid_ucmd_ctx *ucmd_ctx)
{
return ucmd_ctx->udev_dev.seqnum;
}
const char *sid_ucmd_dev_get_synth_uuid(struct sid_ucmd_ctx *ucmd_ctx)
{
return ucmd_ctx->udev_dev.synth_uuid;
}
static const char *_do_buffer_compose_key(struct buffer *buf, struct kv_key_spec *spec, int prefix_only)
{
static const char *op_to_key_prefix_map[] = {[KV_OP_ILLEGAL] = KV_PREFIX_OP_ILLEGAL_C,
[KV_OP_SET] = KV_PREFIX_OP_SET_C,
[KV_OP_PLUS] = KV_PREFIX_OP_PLUS_C,
[KV_OP_MINUS] = KV_PREFIX_OP_MINUS_C};
static const char *ns_to_key_prefix_map[] = {[KV_NS_UNDEFINED] = KV_PREFIX_NS_UNDEFINED_C,
[KV_NS_UDEV] = KV_PREFIX_NS_UDEV_C,
[KV_NS_DEVICE] = KV_PREFIX_NS_DEVICE_C,
[KV_NS_MODULE] = KV_PREFIX_NS_MODULE_C,
[KV_NS_GLOBAL] = KV_PREFIX_NS_GLOBAL_C};
/* <op>:<dom>:<ns>:<ns_part>:<id>:<id_part>[:<key>] */
return buffer_fmt_add(buf,
NULL,
"%s" KV_STORE_KEY_JOIN /* op */
"%s" KV_STORE_KEY_JOIN /* dom */
"%s" KV_STORE_KEY_JOIN /* ns */
"%s" KV_STORE_KEY_JOIN /* ns_part */
"%s" KV_STORE_KEY_JOIN /* id */
"%s"
"%s" /* id_part */
"%s",
op_to_key_prefix_map[spec->op],
spec->dom,
ns_to_key_prefix_map[spec->ns],
spec->ns_part,
spec->id,
spec->id_part,
prefix_only ? KEY_NULL : KV_STORE_KEY_JOIN,
prefix_only ? KEY_NULL : spec->key);
}
static const char *_buffer_compose_key(struct buffer *buf, struct kv_key_spec *spec)
{
/* <op>:<dom>:<ns>:<ns_part>:<id>:<id_part>:<key> */
return _do_buffer_compose_key(buf, spec, 0);
}
static const char *_buffer_compose_key_prefix(struct buffer *buf, struct kv_key_spec *spec)
{
/* <op>:<dom>:<ns>:<ns_part><id>:<id_part> */
return _do_buffer_compose_key(buf, spec, 1);
}
static const char *_get_key_part(const char *key, key_part_t req_part, size_t *len)
{
key_part_t part;
const char *start = key, *end;
for (part = __KEY_PART_START; part < req_part; part++) {
if (!(start = strstr(start, KV_STORE_KEY_JOIN)))
return NULL;
start++;
}
if (len) {
if (req_part == __KEY_PART_COUNT - 1)
*len = strlen(start);
else {
if (!(end = strstr(start, KV_STORE_KEY_JOIN)))
return NULL;
*len = end - start;
}
}
return start;
}
static kv_op_t _get_op_from_key(const char *key)
{
const char *str;
size_t len;
/* |<>|
* <op>:<dom>:<ns>:<ns_part>:<id>:<id_part>[:<key>]
*/
if (!(str = _get_key_part(key, KEY_PART_OP, &len)) || len > 1)
return KV_OP_ILLEGAL;
if (!len)
return KV_OP_SET;
if (str[0] == KV_PREFIX_OP_PLUS_C[0])
return KV_OP_PLUS;
else if (str[0] == KV_PREFIX_OP_MINUS_C[0])
return KV_OP_MINUS;
return KV_OP_ILLEGAL;
}
static sid_ucmd_kv_namespace_t _get_ns_from_key(const char *key)
{
const char *str;
size_t len;
/* |<>|
* <op>:<dom>:<ns>:<ns_part>:<id>:<id_part>[:<key>]
*/
if (!(str = _get_key_part(key, KEY_PART_NS, &len)) || len > 1)
return KV_NS_UNDEFINED;
if (str[0] == KV_PREFIX_NS_UDEV_C[0])
return KV_NS_UDEV;
else if (str[0] == KV_PREFIX_NS_DEVICE_C[0])
return KV_NS_DEVICE;
else if (str[0] == KV_PREFIX_NS_MODULE_C[0])
return KV_NS_MODULE;
else if (str[0] == KV_PREFIX_NS_GLOBAL_C[0])
return KV_NS_GLOBAL;
else
return KV_NS_UNDEFINED;
}
static const char *_buffer_copy_ns_part_from_key(struct buffer *buf, const char *key)
{
const char *str;
size_t len;
/* |<----->|
<op>:<dom>:<ns>:<ns_part><id>:<id_part>[:<key>]
*/
if (!(str = _get_key_part(key, KEY_PART_NS_PART, &len)))
return NULL;
return buffer_fmt_add(buf, NULL, "%.*s", len, str);
}
static struct iovec *_get_value_vector(kv_store_value_flags_t flags, void *value, size_t value_size, struct iovec *iov)
{
size_t owner_size;
struct kv_value *kv_value;
if (!value)
return NULL;
if (flags & KV_STORE_VALUE_VECTOR)
return value;
kv_value = value;
owner_size = strlen(kv_value->data) + 1;
KV_VALUE_PREPARE_HEADER(iov, kv_value->seqnum, kv_value->flags, kv_value->data);
iov[KV_VALUE_IDX_DATA] = (struct iovec) {kv_value->data + owner_size, value_size - sizeof(*kv_value) - owner_size};
return iov;
}
static const char *_get_iov_str(struct buffer *buf, bool unset, struct iovec *iov, size_t iov_size)
{
size_t i;
const char *str;
if (unset)
return buffer_fmt_add(buf, NULL, "NULL");
str = buffer_add(buf, "", 0, NULL);
for (i = KV_VALUE_IDX_DATA; i < iov_size; i++) {
if (!buffer_add(buf, iov[i].iov_base, iov[i].iov_len - 1, NULL) || !buffer_add(buf, " ", 1, NULL))
goto fail;
}
buffer_add(buf, "\0", 1, NULL);
return str;
fail:
if (str)
buffer_rewind_mem(buf, str);
return NULL;
}
static int _write_kv_store_stats(struct usid_stats *stats, sid_resource_t *kv_store_res)
{
kv_store_iter_t * iter;
const char * key;
size_t size;
kv_store_value_flags_t flags;
void * value;
size_t hash_size, int_size, int_data_size, ext_size, ext_data_size;
memset(stats, 0, sizeof(*stats));
if (!(iter = kv_store_iter_create(kv_store_res))) {
log_error(ID(kv_store_res), INTERNAL_ERROR "%s: failed to create record iterator", __func__);
return -ENOMEM;
}
while ((value = kv_store_iter_next(iter, &size, &flags))) {
stats->nr_kv_pairs++;
key = kv_store_iter_current_key(iter);
kv_store_iter_current_size(iter, &int_size, &int_data_size, &ext_size, &ext_data_size);
stats->key_size += strlen(key) + 1;
stats->value_int_size += int_size;
stats->value_int_data_size += int_data_size;
stats->value_ext_size += ext_size;
stats->value_ext_data_size += ext_data_size;
}
kv_store_get_size(kv_store_res, &hash_size, &int_size);
if (stats->value_int_size != int_size)
log_error(ID(kv_store_res),
INTERNAL_ERROR "%s: kv-store size mismatch: %" PRIu64 " is not equal to %zu",
__func__,
stats->value_int_size,
int_size);
stats->meta_size = hash_size;
kv_store_iter_destroy(iter);
return 0;
}
static void _dump_kv_store(const char *str, sid_resource_t *kv_store_res)
{
kv_store_iter_t * iter;
size_t size;
kv_store_value_flags_t flags;
void * value;
struct iovec tmp_iov[KV_VALUE_IDX_DATA + 1];
struct iovec * iov;
unsigned int i = 0, j;
if (!(iter = kv_store_iter_create(kv_store_res))) {
log_error(ID(kv_store_res), INTERNAL_ERROR "%s: failed to create record iterator", __func__);
return;
}
log_print(ID(kv_store_res), "\n======= KV STORE DUMP BEGIN %s =======", str);
while ((value = kv_store_iter_next(iter, &size, &flags))) {
iov = _get_value_vector(flags, value, size, tmp_iov);
if (!strncmp(kv_store_iter_current_key(iter), "U:", 2))
continue;
log_print(ID(kv_store_res), " --- RECORD %u", i);
log_print(ID(kv_store_res), " key: %s", kv_store_iter_current_key(iter));
log_print(ID(kv_store_res),
" seqnum: %" PRIu64 " flags: %s%s%s%s owner: %s",
KV_VALUE_SEQNUM(iov),
KV_VALUE_FLAGS(iov) & KV_PERSISTENT ? "KV_PERSISTENT " : "",
KV_VALUE_FLAGS(iov) & KV_MOD_PROTECTED ? "KV_MOD_PROTECTED " : "",
KV_VALUE_FLAGS(iov) & KV_MOD_PRIVATE ? "KV_MOD_PRIVATE " : "",
KV_VALUE_FLAGS(iov) & KV_MOD_RESERVED ? "KV_MOD_RESERVED " : "",
KV_VALUE_OWNER(iov));
log_print(ID(kv_store_res),
" value: %s",
flags & KV_STORE_VALUE_VECTOR ? "vector" : (const char *) KV_VALUE_DATA(iov));
if (flags & KV_STORE_VALUE_VECTOR) {
for (j = KV_VALUE_IDX_DATA; j < size; j++)
log_print(ID(kv_store_res),
" [%u] = %s",
j - KV_VALUE_IDX_DATA,
(const char *) iov[j].iov_base);
}
log_print(ID(kv_store_res), " ");
i++;
}
log_print(ID(kv_store_res), "======= KV STORE DUMP END %s =========\n", str);
kv_store_iter_destroy(iter);
}
static void _dump_kv_store_dev_stack_in_dot(const char *str, sid_resource_t *kv_store_res)
{
static const char ID[] = "DOT";
kv_store_iter_t * iter;
void * value;
size_t value_size, elem_count, dom_len, this_dev_len, ref_dev_len;
const char * full_key, *key, *dom, *this_dev, *ref_dev;
kv_store_value_flags_t flags;
struct iovec tmp_iov[KV_VALUE_IDX_DATA + 1];
struct iovec * iov;
int i;
if (!(iter = kv_store_iter_create(kv_store_res))) {
log_error(ID(kv_store_res), INTERNAL_ERROR "%s: failed to create record iterator", __func__);
goto out;
}
log_print(ID, "digraph stack {");
while ((value = kv_store_iter_next(iter, &value_size, &flags))) {
full_key = kv_store_iter_current_key(iter);
/* we're intested in KV_NS_DEVICE records only */
if (_get_ns_from_key(full_key) != KV_NS_DEVICE)
continue;
key = _get_key_part(full_key, KEY_PART_CORE, NULL);
/*
* We need to print:
*
* '"this dev"' once
* (we're using KV_KEY_DEV_READY key for that as that is set only once for each dev)
*
* '"this dev" -> "ref_dev"' for each ref dev
* (that's the KV_KEY_GEN_GROUP_IN + KV_KEY_DOM_LAYER key)
*
*/
if (!strcmp(key, KV_KEY_DEV_READY)) {
this_dev = _get_key_part(full_key, KEY_PART_NS_PART, &this_dev_len);
log_print(ID, "\"%.*s\"", (int) this_dev_len, this_dev);
continue;
}
if (strcmp(key, KV_KEY_GEN_GROUP_IN) || (!(dom = _get_key_part(full_key, KEY_PART_DOM, &dom_len))) || !dom_len ||
strncmp(dom, KV_KEY_DOM_LAYER, dom_len))
continue;
this_dev = _get_key_part(full_key, KEY_PART_NS_PART, &this_dev_len);
iov = _get_value_vector(flags, value, value_size, tmp_iov);
if (flags & KV_STORE_VALUE_VECTOR)
elem_count = value_size;
else
elem_count = KV_VALUE_IDX_DATA + 1;
for (i = KV_VALUE_IDX_DATA; i < elem_count; i++) {
ref_dev = _get_key_part((const char *) iov[i].iov_base, KEY_PART_NS_PART, &ref_dev_len);
log_print(ID, "\"%.*s\" -> \"%.*s\"", (int) this_dev_len, this_dev, (int) ref_dev_len, ref_dev);
}
}
log_print(ID, "}");
out:
if (iter)
kv_store_iter_destroy(iter);
}
static int _kv_overwrite(const char *full_key, struct kv_store_update_spec *spec, void *arg)
{
struct kv_update_arg *update_arg = arg;
struct iovec tmp_iov_old[KV_VALUE_IDX_DATA + 1];
struct iovec tmp_iov_new[KV_VALUE_IDX_DATA + 1];
struct iovec * iov_old, *iov_new;
const char * reason;
if (!spec->old_data)
return 1;
iov_old = _get_value_vector(spec->old_flags, spec->old_data, spec->old_data_size, tmp_iov_old);
iov_new = _get_value_vector(spec->new_flags, spec->new_data, spec->new_data_size, tmp_iov_new);
if (KV_VALUE_FLAGS(iov_old) & KV_MOD_PRIVATE) {
if (strcmp(KV_VALUE_OWNER(iov_old), KV_VALUE_OWNER(iov_new))) {
reason = "private";
update_arg->ret_code = -EACCES;
goto keep_old;
}
} else if (KV_VALUE_FLAGS(iov_old) & KV_MOD_PROTECTED) {
if (strcmp(KV_VALUE_OWNER(iov_old), KV_VALUE_OWNER(iov_new))) {
reason = "protected";
update_arg->ret_code = -EPERM;
goto keep_old;
}
} else if (KV_VALUE_FLAGS(iov_old) & KV_MOD_RESERVED) {
if (strcmp(KV_VALUE_OWNER(iov_old), KV_VALUE_OWNER(iov_new))) {
reason = "reserved";
update_arg->ret_code = -EBUSY;
goto keep_old;
}
}
update_arg->ret_code = 0;
return 1;
keep_old:
log_debug(ID(update_arg->res),
"Module %s can't overwrite value with key %s which is %s and attached to %s module.",
KV_VALUE_OWNER(iov_new),
full_key,
reason,
KV_VALUE_OWNER(iov_old));
return 0;
}
static int _flags_indicate_mod_owned(sid_ucmd_kv_flags_t flags)
{
return flags & (KV_MOD_PROTECTED | KV_MOD_PRIVATE | KV_MOD_RESERVED);
}
static const char *_get_mod_name(struct module *mod)
{
return mod ? module_get_full_name(mod) : MOD_NAME_CORE;
}
static size_t _kv_value_ext_data_offset(struct kv_value *kv_value)
{
return strlen(kv_value->data) + 1;
}
int sid_ucmd_print_exported_kv_store(const char *prefix, char *ptr, size_t size, output_format_t format, struct buffer *outbuf)
{
size_t full_key_size, data_size, len;
unsigned int i, records = 0;
bool needs_comma = false;
const char * end;
kv_store_value_flags_t ext_flags;
uint64_t seqnum;
sid_ucmd_kv_flags_t flags;
struct kv_value value;
end = ptr + size;
print_start_document(format, outbuf, 0);
print_start_array("siddb", format, outbuf, 1);
while (ptr < end) {
print_start_elem(needs_comma, format, outbuf, 2);
print_uint_field("RECORD", records, format, outbuf, true, 3);
memcpy(&ext_flags, ptr, sizeof(ext_flags));
ptr += sizeof(ext_flags);
memcpy(&full_key_size, ptr, sizeof(full_key_size));
ptr += sizeof(full_key_size);
memcpy(&data_size, ptr, sizeof(data_size));
ptr += sizeof(data_size);
print_str_field("key", ptr, format, outbuf, true, 3);
ptr += full_key_size;
if (ext_flags & KV_STORE_VALUE_VECTOR) {
if (data_size < KV_VALUE_IDX_DATA) {
log_error(prefix, "Received incorrect vector of size %zu.", data_size);
return -1;
}
for (i = 0; i < data_size; i++) {
memcpy(&len, ptr, sizeof(len));
ptr += sizeof(len);
switch (i) {
case KV_VALUE_IDX_SEQNUM:
if (len != sizeof(uint64_t)) {
log_error(prefix,
"Received incorrect sequence number size %zu != %zu.",
len,
sizeof(uint64_t));
return -1;
}
memcpy(&seqnum, ptr, sizeof(seqnum));
print_uint_field("seqnum", seqnum, format, outbuf, true, 3);
break;
case KV_VALUE_IDX_FLAGS:
if (len != sizeof(sid_ucmd_kv_flags_t)) {
log_error(prefix,
"Received incorrect flags size %zu != %zu.",
len,
sizeof(sid_ucmd_kv_flags_t));
return -1;
}
memcpy(&flags, ptr, sizeof(flags));
print_start_array("flags", format, outbuf, 3);
print_bool_array_elem("KV_PERSISTENT",
flags & KV_PERSISTENT,
format,
outbuf,
true,
4);
print_bool_array_elem("KV_MOD_PROTECTED",
flags & KV_MOD_PROTECTED,
format,
outbuf,
true,
4);
print_bool_array_elem("KV_MOD_PRIVATE",
flags & KV_MOD_PRIVATE,
format,
outbuf,
true,
4);
print_bool_array_elem("KV_MOD_RESERVED",
flags & KV_MOD_RESERVED,
format,
outbuf,
false,
4);
print_end_array(true, format, outbuf, 3);
break;
case KV_VALUE_IDX_OWNER:
if (len)
print_str_field("owner", ptr, format, outbuf, true, 3);
else
print_str_field("owner", "", format, outbuf, true, 3);
break;
case KV_VALUE_IDX_DATA:
print_start_array("values", format, outbuf, 3);
/* fall through */
default:
if (len)
print_str_array_elem(ptr, format, outbuf, i + 1 < data_size, 4);
else
print_str_array_elem("", format, outbuf, i + 1 < data_size, 4);
}
ptr += len;
}
if (data_size > KV_VALUE_IDX_DATA)
print_end_array(false, format, outbuf, 3);
} else {
size_t owner_size;
char * data;
if (data_size <= sizeof(struct kv_value)) {
log_error(prefix, "Received incorrect value of size %zu.", data_size);
return -1;
}
memcpy(&value, ptr, sizeof(value));
data = ptr + sizeof(value);
print_uint_field("seqnum", value.seqnum, format, outbuf, true, 3);
print_start_array("flags", format, outbuf, 3);
print_bool_array_elem("KV_PERSISTENT", value.flags & KV_PERSISTENT, format, outbuf, true, 4);
print_bool_array_elem("KV_MOD_PROTECTED", value.flags & KV_MOD_PROTECTED, format, outbuf, true, 4);
print_bool_array_elem("KV_MOD_PRIVATE", value.flags & KV_MOD_PRIVATE, format, outbuf, true, 4);
print_bool_array_elem("KV_MOD_RESERVED", value.flags & KV_MOD_RESERVED, format, outbuf, false, 4);
print_end_array(true, format, outbuf, 3);
print_str_field("owner", data, format, outbuf, true, 3);
owner_size = strlen(data) + 1;
data += owner_size;
if (sizeof(value) + owner_size < data_size)
print_str_field("value", data, format, outbuf, true, 3);
else
print_str_field("value", "", format, outbuf, true, 3);
ptr += data_size;
}
records++;
print_end_elem(format, outbuf, 2);
needs_comma = true;
}
print_end_array(false, format, outbuf, 1);
print_end_document(format, outbuf, 0);
return 0;
}
static int _build_kv_buffer(sid_resource_t *cmd_res, struct buffer **buf, bool export_udev, bool export_sid, bool persistent_only)
{
struct sid_ucmd_ctx * ucmd_ctx = sid_resource_get_data(cmd_res);
struct kv_value * kv_value;
kv_store_iter_t * iter;
const char * key;
void * value;
bool vector;
size_t size, iov_size, key_size, data_offset;
kv_store_value_flags_t flags;
struct iovec * iov;
unsigned i;
int r = -1;
struct buffer * export_buf = NULL;
/*
* For udev namespace, we append key=value pairs to the output buffer.
*
* For other namespaces, we serialize the key-value records to export
* buffer which is backed by BUFFER_BACKEND_MEMFD/BUFFER_TYPE_LINEAR
* so we can send the FD where we want to.
*
* We only add key=value pairs to buffers which are marked with
* KV_PERSISTENT flag.
*/
if (!(iter = kv_store_iter_create(ucmd_ctx->ucmd_mod_ctx.kv_store_res))) {
// TODO: Discard udev kv-store we've already appended to the output buffer!
log_error(ID(cmd_res), "Failed to create iterator for temp key-value store.");
goto fail;
}
if (!(export_buf = buffer_create(&((struct buffer_spec) {.backend = BUFFER_BACKEND_MEMFD,
.type = BUFFER_TYPE_LINEAR,
.mode = BUFFER_MODE_SIZE_PREFIX}),
&((struct buffer_init) {.size = 0, .alloc_step = PATH_MAX, .limit = 0}),
&r))) {
log_error(ID(cmd_res), "Failed to create export buffer.");
goto fail;
}
while ((value = kv_store_iter_next(iter, &size, &flags))) {
vector = flags & KV_STORE_VALUE_VECTOR;
if (vector) {
iov = value;
iov_size = size;
kv_value = NULL;
if (persistent_only) {
if (!(KV_VALUE_FLAGS(iov) & KV_PERSISTENT))
continue;
KV_VALUE_FLAGS(iov) &= ~KV_PERSISTENT;
}
} else {
iov = NULL;
iov_size = 0;
kv_value = value;
if (persistent_only) {
if (!(kv_value->flags & KV_PERSISTENT))
continue;
kv_value->flags &= ~KV_PERSISTENT;
}
}
key = kv_store_iter_current_key(iter);
key_size = strlen(key) + 1;
// TODO: Also deal with situation if the udev namespace values are defined as vectors by chance.
if (_get_ns_from_key(key) == KV_NS_UDEV) {
if (!export_udev) {
log_debug(ID(cmd_res), "Ignoring request to export record with key %s to udev.", key);
continue;
}
if (vector) {
log_error(ID(cmd_res),
INTERNAL_ERROR "%s: Unsupported vector value for key %s in udev namespace.",
__func__,
key);
r = -ENOTSUP;
goto fail;
}
key = _get_key_part(key, KEY_PART_CORE, NULL);
if (!buffer_add(ucmd_ctx->res_buf, (void *) key, strlen(key), &r) ||
!buffer_add(ucmd_ctx->res_buf, KV_PAIR_C, 1, &r))
goto fail;
data_offset = _kv_value_ext_data_offset(kv_value);
if (!buffer_add(ucmd_ctx->res_buf,
kv_value->data + data_offset,
strlen(kv_value->data + data_offset),
&r) ||
!buffer_add(ucmd_ctx->res_buf, KV_END_C, 1, &r))
goto fail;
continue;
}
/*
* Export keys with data to main process.
*
* Serialization format fields (message size is implicitly set
* when using BUFFER_MODE_SIZE_PREFIX):
*
* 1) message size (MSG_SIGE_PREFIX_TYPE)
* 2) flags (uint32_t)
* 3) key size (size_t)
* 4) data size (size_t)
* 5) key (key_size)
* 6) data (data_size)
*
* If "data" is a vector, then "data size" denotes vector
* item count and "data" is split into these fields repeated
* for each vector item:
*