forked from sigrokproject/libsigrokdecode
-
Notifications
You must be signed in to change notification settings - Fork 1
/
instance.c
1346 lines (1162 loc) · 36.6 KB
/
instance.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 the libsigrokdecode project.
*
* Copyright (C) 2010 Uwe Hermann <[email protected]>
* Copyright (C) 2012 Bert Vermeulen <[email protected]>
*
* This program 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 3 of the License, or
* (at your option) any later version.
*
* This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
*/
#include <config.h>
#include "libsigrokdecode-internal.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
#include "libsigrokdecode.h"
#include <glib.h>
#include <inttypes.h>
#include <stdlib.h>
#include <stdint.h>
/** @cond PRIVATE */
extern SRD_PRIV GSList *sessions;
/** @endcond */
/**
* @file
*
* Decoder instance handling.
*/
/**
* @defgroup grp_instances Decoder instances
*
* Decoder instance handling.
*
* @{
*/
static void oldpins_array_seed(struct srd_decoder_inst *di)
{
size_t count;
GArray *arr;
if (!di)
return;
if (di->old_pins_array)
return;
count = di->dec_num_channels;
arr = g_array_sized_new(FALSE, TRUE, sizeof(uint8_t), count);
g_array_set_size(arr, count);
if (arr->data)
memset(arr->data, SRD_INITIAL_PIN_SAME_AS_SAMPLE0, count);
di->old_pins_array = arr;
}
static void oldpins_array_free(struct srd_decoder_inst *di)
{
if (!di)
return;
if (!di->old_pins_array)
return;
srd_dbg("%s: Releasing initial pin state.", di->inst_id);
g_array_free(di->old_pins_array, TRUE);
di->old_pins_array = NULL;
}
/**
* Set one or more options in a decoder instance.
*
* Handled options are removed from the hash.
*
* @param di Decoder instance.
* @param options A GHashTable of options to set.
*
* @return SRD_OK upon success, a (negative) error code otherwise.
*
* @since 0.1.0
*/
SRD_API int srd_inst_option_set(struct srd_decoder_inst *di,
GHashTable *options)
{
struct srd_decoder_option *sdo;
PyObject *py_di_options, *py_optval;
GVariant *value;
GSList *l;
double val_double;
gint64 val_int;
int ret;
const char *val_str;
PyGILState_STATE gstate;
if (!di) {
srd_err("Invalid decoder instance.");
return SRD_ERR_ARG;
}
if (!options) {
srd_err("Invalid options GHashTable.");
return SRD_ERR_ARG;
}
gstate = PyGILState_Ensure();
if (!PyObject_HasAttrString(di->decoder->py_dec, "options")) {
/* Decoder has no options. */
PyGILState_Release(gstate);
if (g_hash_table_size(options) == 0) {
/* No options provided. */
return SRD_OK;
} else {
srd_err("Protocol decoder has no options.");
return SRD_ERR_ARG;
}
return SRD_OK;
}
ret = SRD_ERR_PYTHON;
py_optval = NULL;
/*
* The 'options' tuple is a class variable, but we need to
* change it. Changing it directly will affect the entire class,
* so we need to create a new object for it, and populate that
* instead.
*/
if (!(py_di_options = PyObject_GetAttrString(di->py_inst, "options")))
goto err_out;
Py_DECREF(py_di_options);
py_di_options = PyDict_New();
PyObject_SetAttrString(di->py_inst, "options", py_di_options);
Py_DECREF(py_di_options);
for (l = di->decoder->options; l; l = l->next) {
sdo = l->data;
if ((value = g_hash_table_lookup(options, sdo->id))) {
/* A value was supplied for this option. */
if (!g_variant_type_equal(g_variant_get_type(value),
g_variant_get_type(sdo->def))) {
srd_err("Option '%s' should have the same type "
"as the default value.", sdo->id);
goto err_out;
}
} else {
/* Use default for this option. */
value = sdo->def;
}
if (g_variant_is_of_type(value, G_VARIANT_TYPE_STRING)) {
val_str = g_variant_get_string(value, NULL);
if (!(py_optval = PyUnicode_FromString(val_str))) {
/* Some UTF-8 encoding error. */
PyErr_Clear();
srd_err("Option '%s' requires a UTF-8 string value.", sdo->id);
goto err_out;
}
} else if (g_variant_is_of_type(value, G_VARIANT_TYPE_INT64)) {
val_int = g_variant_get_int64(value);
if (!(py_optval = PyLong_FromLongLong(val_int))) {
/* ValueError Exception */
PyErr_Clear();
srd_err("Option '%s' has invalid integer value.", sdo->id);
goto err_out;
}
} else if (g_variant_is_of_type(value, G_VARIANT_TYPE_DOUBLE)) {
val_double = g_variant_get_double(value);
if (!(py_optval = PyFloat_FromDouble(val_double))) {
/* ValueError Exception */
PyErr_Clear();
srd_err("Option '%s' has invalid float value.",
sdo->id);
goto err_out;
}
}
if (PyDict_SetItemString(py_di_options, sdo->id, py_optval) == -1) {
Py_XDECREF(py_optval);
goto err_out;
}
/* Not harmful even if we used the default. */
g_hash_table_remove(options, sdo->id);
Py_XDECREF(py_optval);
}
if (g_hash_table_size(options) != 0)
srd_warn("Unknown options specified for '%s'", di->inst_id);
ret = SRD_OK;
err_out:
if (PyErr_Occurred()) {
srd_exception_catch("Stray exception in srd_inst_option_set()");
ret = SRD_ERR_PYTHON;
}
PyGILState_Release(gstate);
return ret;
}
/* Helper GComparefunc for g_slist_find_custom() in srd_inst_channel_set_all(). */
static gint compare_channel_id(const struct srd_channel *pdch,
const char *channel_id)
{
return strcmp(pdch->id, channel_id);
}
/**
* Set all channels in a decoder instance.
*
* This function sets _all_ channels for the specified decoder instance, i.e.,
* it overwrites any channels that were already defined (if any).
*
* @param di Decoder instance.
* @param new_channels A GHashTable of channels to set. Key is channel name,
* value is the channel number. Samples passed to this
* instance will be arranged in this order.
*
* @return SRD_OK upon success, a (negative) error code otherwise.
*
* @since 0.4.0
*/
SRD_API int srd_inst_channel_set_all(struct srd_decoder_inst *di,
GHashTable *new_channels)
{
GVariant *channel_val;
GList *l;
GSList *sl;
struct srd_channel *pdch;
int *new_channelmap, new_channelnum, num_required_channels, i;
char *channel_id;
srd_dbg("Setting channels for instance %s with list of %d channels.",
di->inst_id, g_hash_table_size(new_channels));
if (g_hash_table_size(new_channels) == 0)
/* No channels provided. */
return SRD_OK;
if (di->dec_num_channels == 0) {
/* Decoder has no channels. */
srd_err("Protocol decoder %s has no channels to define.",
di->decoder->name);
return SRD_ERR_ARG;
}
new_channelmap = g_malloc0(sizeof(int) * di->dec_num_channels);
/*
* For now, map all indexes to channel -1 (can be overridden later).
* This -1 is interpreted as an unspecified channel later.
*/
for (i = 0; i < di->dec_num_channels; i++)
new_channelmap[i] = -1;
for (l = g_hash_table_get_keys(new_channels); l; l = l->next) {
channel_id = l->data;
channel_val = g_hash_table_lookup(new_channels, channel_id);
if (!g_variant_is_of_type(channel_val, G_VARIANT_TYPE_INT32)) {
/* Channel name was specified without a value. */
srd_err("No channel number was specified for %s.",
channel_id);
g_free(new_channelmap);
return SRD_ERR_ARG;
}
new_channelnum = g_variant_get_int32(channel_val);
if (!(sl = g_slist_find_custom(di->decoder->channels, channel_id,
(GCompareFunc)compare_channel_id))) {
/* Fall back on optional channels. */
if (!(sl = g_slist_find_custom(di->decoder->opt_channels,
channel_id, (GCompareFunc)compare_channel_id))) {
srd_err("Protocol decoder %s has no channel "
"'%s'.", di->decoder->name, channel_id);
g_free(new_channelmap);
return SRD_ERR_ARG;
}
}
pdch = sl->data;
new_channelmap[pdch->order] = new_channelnum;
srd_dbg("Setting channel mapping: %s (PD ch idx %d) = input data ch idx %d.",
pdch->id, pdch->order, new_channelnum);
}
srd_dbg("Final channel map:");
num_required_channels = g_slist_length(di->decoder->channels);
for (i = 0; i < di->dec_num_channels; i++) {
GSList *ll = g_slist_nth(di->decoder->channels, i);
if (!ll)
ll = g_slist_nth(di->decoder->opt_channels,
i - num_required_channels);
pdch = ll->data;
srd_dbg(" - PD ch idx %d (%s) = input data ch idx %d (%s)", i,
pdch->id, new_channelmap[i],
(i < num_required_channels) ? "required" : "optional");
}
/* Report an error if not all required channels were specified. */
for (i = 0; i < num_required_channels; i++) {
if (new_channelmap[i] != -1)
continue;
pdch = g_slist_nth(di->decoder->channels, i)->data;
srd_err("Required channel '%s' (index %d) was not specified.",
pdch->id, i);
g_free(new_channelmap);
return SRD_ERR;
}
g_free(di->dec_channelmap);
di->dec_channelmap = new_channelmap;
return SRD_OK;
}
/**
* Create a new protocol decoder instance.
*
* @param sess The session holding the protocol decoder instance.
* Must not be NULL.
* @param decoder_id Decoder 'id' field.
* @param options GHashtable of options which override the defaults set in
* the decoder class. May be NULL.
*
* @return Pointer to a newly allocated struct srd_decoder_inst, or
* NULL in case of failure.
*
* @since 0.3.0
*/
SRD_API struct srd_decoder_inst *srd_inst_new(struct srd_session *sess,
const char *decoder_id, GHashTable *options)
{
int i;
struct srd_decoder *dec;
struct srd_decoder_inst *di;
char *inst_id;
PyGILState_STATE gstate;
i = 1;
if (!sess)
return NULL;
if (!(dec = srd_decoder_get_by_id(decoder_id))) {
srd_err("Protocol decoder %s not found.", decoder_id);
return NULL;
}
di = g_malloc0(sizeof(struct srd_decoder_inst));
di->decoder = dec;
di->sess = sess;
if (options) {
inst_id = g_hash_table_lookup(options, "id");
if (inst_id)
di->inst_id = g_strdup(inst_id);
g_hash_table_remove(options, "id");
}
/* Create a unique instance ID (as none was provided). */
if (!di->inst_id) {
di->inst_id = g_strdup_printf("%s-%d", decoder_id, i++);
while (srd_inst_find_by_id(sess, di->inst_id)) {
g_free(di->inst_id);
di->inst_id = g_strdup_printf("%s-%d", decoder_id, i++);
}
}
/*
* Prepare a default channel map, where samples come in the
* order in which the decoder class defined them.
*/
di->dec_num_channels = g_slist_length(di->decoder->channels) +
g_slist_length(di->decoder->opt_channels);
if (di->dec_num_channels) {
di->dec_channelmap =
g_malloc(sizeof(int) * di->dec_num_channels);
for (i = 0; i < di->dec_num_channels; i++)
di->dec_channelmap[i] = i;
/*
* Will be used to prepare a sample at every iteration
* of the instance's decode() method.
*/
di->channel_samples = g_malloc(di->dec_num_channels);
}
/* Default to the initial pins being the same as in sample 0. */
oldpins_array_seed(di);
gstate = PyGILState_Ensure();
/* Create a new instance of this decoder class. */
if (!(di->py_inst = PyObject_CallObject(dec->py_dec, NULL))) {
if (PyErr_Occurred())
srd_exception_catch("Failed to create %s instance",
decoder_id);
PyGILState_Release(gstate);
g_free(di->dec_channelmap);
g_free(di);
return NULL;
}
PyGILState_Release(gstate);
if (options && srd_inst_option_set(di, options) != SRD_OK) {
g_free(di->dec_channelmap);
g_free(di);
return NULL;
}
di->condition_list = NULL;
di->match_array = NULL;
di->abs_start_samplenum = 0;
di->abs_end_samplenum = 0;
di->inbuf = NULL;
di->inbuflen = 0;
di->abs_cur_samplenum = 0;
di->thread_handle = NULL;
di->got_new_samples = FALSE;
di->handled_all_samples = FALSE;
di->want_wait_terminate = FALSE;
di->decoder_state = SRD_OK;
/*
* Strictly speaking initialization of statically allocated
* condition and mutex variables (or variables allocated on the
* stack) is not required, but won't harm either. Explicitly
* running init() will better match subsequent clear() calls.
*/
g_cond_init(&di->got_new_samples_cond);
g_cond_init(&di->handled_all_samples_cond);
g_mutex_init(&di->data_mutex);
/* Instance takes input from a frontend by default. */
sess->di_list = g_slist_append(sess->di_list, di);
srd_dbg("Creating new %s instance %s.", decoder_id, di->inst_id);
return di;
}
static void srd_inst_join_decode_thread(struct srd_decoder_inst *di)
{
if (!di)
return;
if (!di->thread_handle)
return;
srd_dbg("%s: Joining decoder thread.", di->inst_id);
/*
* Terminate potentially running threads which still
* execute the decoder instance's decode() method.
*/
srd_dbg("%s: Raising want_term, sending got_new.", di->inst_id);
g_mutex_lock(&di->data_mutex);
di->want_wait_terminate = TRUE;
g_cond_signal(&di->got_new_samples_cond);
g_mutex_unlock(&di->data_mutex);
srd_dbg("%s: Running join().", di->inst_id);
(void)g_thread_join(di->thread_handle);
srd_dbg("%s: Call to join() done.", di->inst_id);
di->thread_handle = NULL;
/*
* Reset condition and mutex variables, such that next
* operations on them will find them in a clean state.
*/
g_cond_clear(&di->got_new_samples_cond);
g_cond_init(&di->got_new_samples_cond);
g_cond_clear(&di->handled_all_samples_cond);
g_cond_init(&di->handled_all_samples_cond);
g_mutex_clear(&di->data_mutex);
g_mutex_init(&di->data_mutex);
}
static void srd_inst_reset_state(struct srd_decoder_inst *di)
{
if (!di)
return;
srd_dbg("%s: Resetting decoder state.", di->inst_id);
/* Reset internal state of the decoder. */
condition_list_free(di);
match_array_free(di);
di->abs_start_samplenum = 0;
di->abs_end_samplenum = 0;
di->inbuf = NULL;
di->inbuflen = 0;
di->abs_cur_samplenum = 0;
oldpins_array_free(di);
di->got_new_samples = FALSE;
di->handled_all_samples = FALSE;
di->want_wait_terminate = FALSE;
di->decoder_state = SRD_OK;
/* Conditions and mutex got reset after joining the thread. */
}
/**
* Stack a decoder instance on top of another.
*
* @param sess The session holding the protocol decoder instances.
* Must not be NULL.
* @param di_bottom The instance on top of which di_top will be stacked.
* @param di_top The instance to go on top.
*
* @return SRD_OK upon success, a (negative) error code otherwise.
*
* @since 0.3.0
*/
SRD_API int srd_inst_stack(struct srd_session *sess,
struct srd_decoder_inst *di_bottom,
struct srd_decoder_inst *di_top)
{
if (!sess)
return SRD_ERR_ARG;
if (!di_bottom || !di_top) {
srd_err("Invalid from/to instance pair.");
return SRD_ERR_ARG;
}
if (g_slist_find(sess->di_list, di_top)) {
/* Remove from the unstacked list. */
sess->di_list = g_slist_remove(sess->di_list, di_top);
}
/*
* Check if there's at least one matching input/output pair
* for the stacked PDs. We warn if that's not the case, but it's
* not a hard error for the time being.
*/
gboolean at_least_one_match = FALSE;
for (GSList *out = di_bottom->decoder->outputs; out; out = out->next) {
const char *o = out->data;
for (GSList *in = di_top->decoder->inputs; in; in = in->next) {
const char *i = in->data;
if (!strcmp(o, i)) {
at_least_one_match = TRUE;
break;
}
}
}
if (!at_least_one_match)
srd_warn("No matching in-/output when stacking %s onto %s.",
di_top->inst_id, di_bottom->inst_id);
/* Stack on top of source di. */
di_bottom->next_di = g_slist_append(di_bottom->next_di, di_top);
srd_dbg("Stacking %s onto %s.", di_top->inst_id, di_bottom->inst_id);
return SRD_OK;
}
/**
* Search a decoder instance and its stack for instance ID.
*
* @param[in] inst_id ID to search for.
* @param[in] stack A decoder instance, potentially with stacked instances.
*
* @return The matching instance, or NULL.
*/
static struct srd_decoder_inst *srd_inst_find_by_id_stack(const char *inst_id,
struct srd_decoder_inst *stack)
{
const GSList *l;
struct srd_decoder_inst *tmp, *di;
if (!strcmp(stack->inst_id, inst_id))
return stack;
/* Otherwise, look recursively in our stack. */
di = NULL;
if (stack->next_di) {
for (l = stack->next_di; l; l = l->next) {
tmp = l->data;
if (!strcmp(tmp->inst_id, inst_id)) {
di = tmp;
break;
}
}
}
return di;
}
/**
* Find a decoder instance by its instance ID.
*
* This will recurse to find the instance anywhere in the stack tree of the
* given session.
*
* @param sess The session holding the protocol decoder instance.
* Must not be NULL.
* @param inst_id The instance ID to be found.
*
* @return Pointer to struct srd_decoder_inst, or NULL if not found.
*
* @since 0.3.0
*/
SRD_API struct srd_decoder_inst *srd_inst_find_by_id(struct srd_session *sess,
const char *inst_id)
{
GSList *l;
struct srd_decoder_inst *tmp, *di;
if (!sess)
return NULL;
di = NULL;
for (l = sess->di_list; l; l = l->next) {
tmp = l->data;
if ((di = srd_inst_find_by_id_stack(inst_id, tmp)) != NULL)
break;
}
return di;
}
/**
* Set the list of initial (assumed) pin values.
*
* @param di Decoder instance to use. Must not be NULL.
* @param initial_pins A GArray of uint8_t values. Must not be NULL.
*
* @since 0.5.0
*/
SRD_API int srd_inst_initial_pins_set_all(struct srd_decoder_inst *di, GArray *initial_pins)
{
int i;
GString *s;
if (!di) {
srd_err("Invalid decoder instance.");
return SRD_ERR_ARG;
}
if (!initial_pins)
return SRD_ERR_ARG;
if (initial_pins->len != (guint)di->dec_num_channels) {
srd_err("Incorrect number of channels (need %d, got %d).",
di->dec_num_channels, initial_pins->len);
return SRD_ERR_ARG;
}
/* Sanity-check initial pin state values. */
for (i = 0; i < di->dec_num_channels; i++) {
if (initial_pins->data[i] <= 2)
continue;
srd_err("Invalid initial channel %d pin state: %d.",
i, initial_pins->data[i]);
return SRD_ERR_ARG;
}
s = g_string_sized_new(100);
oldpins_array_seed(di);
for (i = 0; i < di->dec_num_channels; i++) {
di->old_pins_array->data[i] = initial_pins->data[i];
g_string_append_printf(s, "%d, ", di->old_pins_array->data[i]);
}
s = g_string_truncate(s, s->len - 2);
srd_dbg("Initial pins: %s.", s->str);
g_string_free(s, TRUE);
return SRD_OK;
}
/** @private */
SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di)
{
PyObject *py_res, *py_samplenum;
GSList *l;
struct srd_decoder_inst *next_di;
int ret;
PyGILState_STATE gstate;
srd_dbg("Calling start() of instance %s.", di->inst_id);
gstate = PyGILState_Ensure();
/* Run self.start(). */
if (!(py_res = PyObject_CallMethod(di->py_inst, "start", NULL))) {
srd_exception_catch("Protocol decoder instance %s",
di->inst_id);
PyGILState_Release(gstate);
return SRD_ERR_PYTHON;
}
Py_DECREF(py_res);
/* Set self.samplenum to 0. */
py_samplenum = PyLong_FromUnsignedLongLong(0);
PyObject_SetAttrString(di->py_inst, "samplenum", py_samplenum);
Py_DECREF(py_samplenum);
/* Set self.matched to None. */
PyObject_SetAttrString(di->py_inst, "matched", Py_None);
PyGILState_Release(gstate);
/* Start all the PDs stacked on top of this one. */
for (l = di->next_di; l; l = l->next) {
next_di = l->data;
if ((ret = srd_inst_start(next_di)) != SRD_OK)
return ret;
}
return SRD_OK;
}
/**
* Check whether the specified sample matches the specified term.
*
* In the case of SRD_TERM_SKIP, this function can modify
* term->num_samples_already_skipped.
*
* @param old_sample The value of the previous sample (0/1).
* @param sample The value of the current sample (0/1).
* @param term The term that should be checked for a match. Must not be NULL.
*
* @retval TRUE The current sample matches the specified term.
* @retval FALSE The current sample doesn't match the specified term, or an
* invalid term was provided.
*
* @private
*/
__attribute__((always_inline))
static inline gboolean sample_matches(uint8_t old_sample, uint8_t sample, struct srd_term *term)
{
/* Caller ensures term != NULL. */
switch (term->type) {
case SRD_TERM_HIGH:
if (sample == 1)
return TRUE;
break;
case SRD_TERM_LOW:
if (sample == 0)
return TRUE;
break;
case SRD_TERM_RISING_EDGE:
if (old_sample == 0 && sample == 1)
return TRUE;
break;
case SRD_TERM_FALLING_EDGE:
if (old_sample == 1 && sample == 0)
return TRUE;
break;
case SRD_TERM_EITHER_EDGE:
if ((old_sample == 1 && sample == 0) || (old_sample == 0 && sample == 1))
return TRUE;
break;
case SRD_TERM_NO_EDGE:
if ((old_sample == 0 && sample == 0) || (old_sample == 1 && sample == 1))
return TRUE;
break;
case SRD_TERM_SKIP:
if (term->num_samples_already_skipped == term->num_samples_to_skip)
return TRUE;
term->num_samples_already_skipped++;
break;
default:
srd_err("Unknown term type %d.", term->type);
break;
}
return FALSE;
}
/** @private */
SRD_PRIV void match_array_free(struct srd_decoder_inst *di)
{
if (!di || !di->match_array)
return;
g_array_free(di->match_array, TRUE);
di->match_array = NULL;
}
/** @private */
SRD_PRIV void condition_list_free(struct srd_decoder_inst *di)
{
GSList *l, *ll;
if (!di)
return;
for (l = di->condition_list; l; l = l->next) {
ll = l->data;
if (ll)
g_slist_free_full(ll, g_free);
}
g_slist_free(di->condition_list);
di->condition_list = NULL;
}
static gboolean have_non_null_conds(const struct srd_decoder_inst *di)
{
GSList *l, *cond;
if (!di)
return FALSE;
for (l = di->condition_list; l; l = l->next) {
cond = l->data;
if (cond)
return TRUE;
}
return FALSE;
}
static void update_old_pins_array(struct srd_decoder_inst *di,
const uint8_t *sample_pos)
{
uint8_t sample;
int i, byte_offset, bit_offset;
if (!di || !di->dec_channelmap || !sample_pos)
return;
oldpins_array_seed(di);
for (i = 0; i < di->dec_num_channels; i++) {
if (di->dec_channelmap[i] == -1)
continue; /* Ignore unused optional channels. */
byte_offset = di->dec_channelmap[i] / 8;
bit_offset = di->dec_channelmap[i] % 8;
sample = *(sample_pos + byte_offset) & (1 << bit_offset) ? 1 : 0;
di->old_pins_array->data[i] = sample;
}
}
static void update_old_pins_array_initial_pins(struct srd_decoder_inst *di)
{
uint8_t sample;
int i, byte_offset, bit_offset;
const uint8_t *sample_pos;
if (!di || !di->dec_channelmap)
return;
sample_pos = di->inbuf + ((di->abs_cur_samplenum - di->abs_start_samplenum) * di->data_unitsize);
oldpins_array_seed(di);
for (i = 0; i < di->dec_num_channels; i++) {
if (di->old_pins_array->data[i] != SRD_INITIAL_PIN_SAME_AS_SAMPLE0)
continue;
if (di->dec_channelmap[i] == -1)
continue; /* Ignore unused optional channels. */
byte_offset = di->dec_channelmap[i] / 8;
bit_offset = di->dec_channelmap[i] % 8;
sample = *(sample_pos + byte_offset) & (1 << bit_offset) ? 1 : 0;
di->old_pins_array->data[i] = sample;
}
}
static gboolean term_matches(const struct srd_decoder_inst *di,
struct srd_term *term, const uint8_t *sample_pos)
{
uint8_t old_sample, sample;
int byte_offset, bit_offset, ch;
/* Caller ensures di, di->dec_channelmap, term, sample_pos != NULL. */
if (term->type == SRD_TERM_SKIP)
return sample_matches(0, 0, term);
ch = term->channel;
byte_offset = di->dec_channelmap[ch] / 8;
bit_offset = di->dec_channelmap[ch] % 8;
sample = *(sample_pos + byte_offset) & (1 << bit_offset) ? 1 : 0;
old_sample = di->old_pins_array->data[ch];
return sample_matches(old_sample, sample, term);
}
static gboolean all_terms_match(const struct srd_decoder_inst *di,
const GSList *cond, const uint8_t *sample_pos)
{
const GSList *l;
struct srd_term *term;
/* Caller ensures di, cond, sample_pos != NULL. */
for (l = cond; l; l = l->next) {
term = l->data;
if (term->type == SRD_TERM_ALWAYS_FALSE)
return FALSE;
if (!term_matches(di, term, sample_pos))
return FALSE;
}
return TRUE;
}
static gboolean at_least_one_condition_matched(
const struct srd_decoder_inst *di, unsigned int num_conditions)
{
unsigned int i;
/* Caller ensures di != NULL. */
for (i = 0; i < num_conditions; i++) {
if (di->match_array->data[i])
return TRUE;
}
return FALSE;
}
static gboolean find_match(struct srd_decoder_inst *di)
{
uint64_t i, j, num_samples_to_process;
GSList *l, *cond;
const uint8_t *sample_pos;
unsigned int num_conditions;
/* Caller ensures di != NULL. */
/* Check whether the condition list is NULL/empty. */
if (!di->condition_list) {
srd_dbg("NULL/empty condition list, automatic match.");
return TRUE;
}
/* Check whether we have any non-NULL conditions. */
if (!have_non_null_conds(di)) {
srd_dbg("Only NULL conditions in list, automatic match.");
return TRUE;
}
num_samples_to_process = di->abs_end_samplenum - di->abs_cur_samplenum;
num_conditions = g_slist_length(di->condition_list);
/* di->match_array is NULL here. Create a new GArray. */
di->match_array = g_array_sized_new(FALSE, TRUE, sizeof(gboolean), num_conditions);
g_array_set_size(di->match_array, num_conditions);
/* Sample 0: Set di->old_pins_array for SRD_INITIAL_PIN_SAME_AS_SAMPLE0 pins. */
if (di->abs_cur_samplenum == 0)
update_old_pins_array_initial_pins(di);
for (i = 0; i < num_samples_to_process; i++, (di->abs_cur_samplenum)++) {
sample_pos = di->inbuf + ((di->abs_cur_samplenum - di->abs_start_samplenum) * di->data_unitsize);
/* Check whether the current sample matches at least one of the conditions (logical OR). */
/* IMPORTANT: We need to check all conditions, even if there was a match already! */
for (l = di->condition_list, j = 0; l; l = l->next, j++) {
cond = l->data;
if (!cond)
continue;
/* All terms in 'cond' must match (logical AND). */
di->match_array->data[j] = all_terms_match(di, cond, sample_pos);
}
update_old_pins_array(di, sample_pos);
/* If at least one condition matched we're done. */
if (at_least_one_condition_matched(di, num_conditions))
return TRUE;
}
return FALSE;
}
/**
* Process available samples and check if they match the defined conditions.
*
* This function returns if there is an error, or when a match is found, or
* when all samples have been processed (whether a match was found or not).
* This function immediately terminates when the decoder's wait() method
* invocation shall get terminated.
*
* @param di The decoder instance to use. Must not be NULL.
* @param found_match Will be set to TRUE if at least one condition matched,
* FALSE otherwise. Must not be NULL.
*
* @retval SRD_OK No errors occured, see found_match for the result.
* @retval SRD_ERR_ARG Invalid arguments.
*
* @private
*/
SRD_PRIV int process_samples_until_condition_match(struct srd_decoder_inst *di, gboolean *found_match)
{
if (!di || !found_match)
return SRD_ERR_ARG;
*found_match = FALSE;