-
Notifications
You must be signed in to change notification settings - Fork 334
/
input.c
704 lines (634 loc) · 18.6 KB
/
input.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
/*
* This file is part of the libsigrok project.
*
* Copyright (C) 2014 Bert Vermeulen <bert@biot.com>
*
* 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 <string.h>
#include <errno.h>
#include <glib.h>
#include <glib/gstdio.h>
#include <libsigrok/libsigrok.h>
#include "libsigrok-internal.h"
/** @cond PRIVATE */
#define LOG_PREFIX "input"
/** @endcond */
/** @cond PRIVATE */
#define CHUNK_SIZE (4 * 1024 * 1024)
/** @endcond */
/**
* @file
*
* Input module handling.
*/
/**
* @defgroup grp_input Input modules
*
* Input file/data module handling.
*
* libsigrok can process acquisition data in several different ways.
* Aside from acquiring data from a hardware device, it can also take it
* from a file in various formats (binary, CSV, VCD, and so on).
*
* Like all libsigrok data handling, processing is done in a streaming
* manner: input should be supplied a chunk at a time. This way anything
* that processes data can do so in real time, without the user having
* to wait for the whole thing to be finished.
*
* Every input module is "pluggable", meaning it's handled as being separate
* from the main libsigrok, but linked in to it statically. To keep things
* modular and separate like this, functions within an input module should be
* declared static, with only the respective 'struct sr_input_module' being
* exported for use into the wider libsigrok namespace.
*
* @{
*/
/** @cond PRIVATE */
extern SR_PRIV struct sr_input_module input_chronovu_la8;
extern SR_PRIV struct sr_input_module input_csv;
extern SR_PRIV struct sr_input_module input_binary;
extern SR_PRIV struct sr_input_module input_stf;
extern SR_PRIV struct sr_input_module input_trace32_ad;
extern SR_PRIV struct sr_input_module input_vcd;
extern SR_PRIV struct sr_input_module input_wav;
extern SR_PRIV struct sr_input_module input_raw_analog;
extern SR_PRIV struct sr_input_module input_logicport;
extern SR_PRIV struct sr_input_module input_saleae;
extern SR_PRIV struct sr_input_module input_isf;
extern SR_PRIV struct sr_input_module input_null;
/** @endcond */
static const struct sr_input_module *input_module_list[] = {
&input_binary,
&input_chronovu_la8,
&input_csv,
#if defined HAVE_INPUT_STF && HAVE_INPUT_STF
&input_stf,
#endif
&input_trace32_ad,
&input_vcd,
&input_wav,
&input_raw_analog,
&input_logicport,
&input_saleae,
&input_isf,
&input_null,
NULL,
};
/**
* Returns a NULL-terminated list of all available input modules.
*
* @since 0.4.0
*/
SR_API const struct sr_input_module **sr_input_list(void)
{
return input_module_list;
}
/**
* Returns the specified input module's ID.
*
* @since 0.4.0
*/
SR_API const char *sr_input_id_get(const struct sr_input_module *imod)
{
if (!imod) {
sr_err("Invalid input module NULL!");
return NULL;
}
return imod->id;
}
/**
* Returns the specified input module's name.
*
* @since 0.4.0
*/
SR_API const char *sr_input_name_get(const struct sr_input_module *imod)
{
if (!imod) {
sr_err("Invalid input module NULL!");
return NULL;
}
return imod->name;
}
/**
* Returns the specified input module's description.
*
* @since 0.4.0
*/
SR_API const char *sr_input_description_get(const struct sr_input_module *imod)
{
if (!imod) {
sr_err("Invalid input module NULL!");
return NULL;
}
return imod->desc;
}
/**
* Returns the specified input module's file extensions typical for the file
* format, as a NULL terminated array, or returns a NULL pointer if there is
* no preferred extension.
* @note these are a suggestions only.
*
* @since 0.4.0
*/
SR_API const char *const *sr_input_extensions_get(
const struct sr_input_module *imod)
{
if (!imod) {
sr_err("Invalid input module NULL!");
return NULL;
}
return imod->exts;
}
/**
* Return the input module with the specified ID, or NULL if no module
* with that id is found.
*
* @since 0.4.0
*/
SR_API const struct sr_input_module *sr_input_find(const char *id)
{
int i;
for (i = 0; input_module_list[i]; i++) {
if (!strcmp(input_module_list[i]->id, id))
return input_module_list[i];
}
return NULL;
}
/**
* Returns a NULL-terminated array of struct sr_option, or NULL if the
* module takes no options.
*
* Each call to this function must be followed by a call to
* sr_input_options_free().
*
* @since 0.4.0
*/
SR_API const struct sr_option **sr_input_options_get(const struct sr_input_module *imod)
{
const struct sr_option *mod_opts, **opts;
int size, i;
if (!imod || !imod->options)
return NULL;
mod_opts = imod->options();
for (size = 0; mod_opts[size].id; size++)
;
opts = g_malloc((size + 1) * sizeof(struct sr_option *));
for (i = 0; i < size; i++)
opts[i] = &mod_opts[i];
opts[i] = NULL;
return opts;
}
/**
* After a call to sr_input_options_get(), this function cleans up all
* resources returned by that call.
*
* @since 0.4.0
*/
SR_API void sr_input_options_free(const struct sr_option **options)
{
int i;
if (!options)
return;
for (i = 0; options[i]; i++) {
if (options[i]->def) {
g_variant_unref(options[i]->def);
((struct sr_option *)options[i])->def = NULL;
}
if (options[i]->values) {
g_slist_free_full(options[i]->values, (GDestroyNotify)g_variant_unref);
((struct sr_option *)options[i])->values = NULL;
}
}
g_free(options);
}
/**
* Create a new input instance using the specified input module.
*
* This function is used when a client wants to use a specific input
* module to parse a stream. No effort is made to identify the format.
*
* @param imod The input module to use. Must not be NULL.
* @param options GHashTable consisting of keys corresponding with
* the module options @c id field. The values should be GVariant
* pointers with sunk references, of the same GVariantType as the option's
* default value.
*
* @since 0.4.0
*/
SR_API struct sr_input *sr_input_new(const struct sr_input_module *imod,
GHashTable *options)
{
struct sr_input *in;
const struct sr_option *mod_opts;
const GVariantType *gvt;
GHashTable *new_opts;
GHashTableIter iter;
gpointer key, value;
int i;
in = g_malloc0(sizeof(struct sr_input));
in->module = imod;
new_opts = g_hash_table_new_full(g_str_hash, g_str_equal, g_free,
(GDestroyNotify)g_variant_unref);
if (imod->options) {
mod_opts = imod->options();
for (i = 0; mod_opts[i].id; i++) {
if (options && g_hash_table_lookup_extended(options,
mod_opts[i].id, &key, &value)) {
/* Option not given: insert the default value. */
gvt = g_variant_get_type(mod_opts[i].def);
if (!g_variant_is_of_type(value, gvt)) {
sr_err("Invalid type for '%s' option.",
(char *)key);
g_free(in);
return NULL;
}
g_hash_table_insert(new_opts, g_strdup(mod_opts[i].id),
g_variant_ref(value));
} else {
/* Pass option along. */
g_hash_table_insert(new_opts, g_strdup(mod_opts[i].id),
g_variant_ref(mod_opts[i].def));
}
}
/* Make sure no invalid options were given. */
if (options) {
g_hash_table_iter_init(&iter, options);
while (g_hash_table_iter_next(&iter, &key, &value)) {
if (!g_hash_table_lookup(new_opts, key)) {
sr_err("Input module '%s' has no option '%s'",
imod->id, (char *)key);
g_hash_table_destroy(new_opts);
g_free(in);
return NULL;
}
}
}
}
if (in->module->init && in->module->init(in, new_opts) != SR_OK) {
g_free(in);
in = NULL;
} else {
in->buf = g_string_sized_new(128);
}
if (new_opts)
g_hash_table_destroy(new_opts);
return in;
}
/* Returns TRUE if all required meta items are available. */
static gboolean check_required_metadata(const uint8_t *metadata, uint8_t *avail)
{
int m, a;
uint8_t reqd;
for (m = 0; metadata[m]; m++) {
if (!(metadata[m] & SR_INPUT_META_REQUIRED))
continue;
reqd = metadata[m] & ~SR_INPUT_META_REQUIRED;
for (a = 0; avail[a]; a++) {
if (avail[a] == reqd)
break;
}
if (!avail[a])
/* Found a required meta item that isn't available. */
return FALSE;
}
return TRUE;
}
/**
* Try to find an input module that can parse the given buffer.
*
* The buffer must contain enough of the beginning of the file for
* the input modules to find a match. This is format-dependent. When
* magic strings get checked, 128 bytes normally could be enough. Note
* that some formats try to parse larger header sections, and benefit
* from seeing a larger scope.
*
* If an input module is found, an instance is created into *in.
* Otherwise, *in contains NULL. When multiple input moduless claim
* support for the format, the one with highest confidence takes
* precedence. Applications will see at most one input module spec.
*
* If an instance is created, it has the given buffer used for scanning
* already submitted to it, to be processed before more data is sent.
* This allows a frontend to submit an initial chunk of a non-seekable
* stream, such as stdin, without having to keep it around and submit
* it again later.
*
*/
SR_API int sr_input_scan_buffer(GString *buf, const struct sr_input **in)
{
const struct sr_input_module *imod, *best_imod;
GHashTable *meta;
unsigned int m, i;
unsigned int conf, best_conf;
int ret;
uint8_t mitem, avail_metadata[8];
/* No more metadata to be had from a buffer. */
avail_metadata[0] = SR_INPUT_META_HEADER;
avail_metadata[1] = 0;
*in = NULL;
best_imod = NULL;
best_conf = ~0;
for (i = 0; input_module_list[i]; i++) {
imod = input_module_list[i];
if (!imod->metadata[0]) {
/* Module has no metadata for matching so will take
* any input. No point in letting it try to match. */
continue;
}
if (!check_required_metadata(imod->metadata, avail_metadata))
/* Cannot satisfy this module's requirements. */
continue;
meta = g_hash_table_new(NULL, NULL);
for (m = 0; m < sizeof(imod->metadata); m++) {
mitem = imod->metadata[m] & ~SR_INPUT_META_REQUIRED;
if (mitem == SR_INPUT_META_HEADER)
g_hash_table_insert(meta, GINT_TO_POINTER(mitem), buf);
}
if (g_hash_table_size(meta) == 0) {
/* No metadata for this module, so nothing to match. */
g_hash_table_destroy(meta);
continue;
}
sr_spew("Trying module %s.", imod->id);
ret = imod->format_match(meta, &conf);
g_hash_table_destroy(meta);
if (ret == SR_ERR_DATA) {
/* Module recognized this buffer, but cannot handle it. */
continue;
} else if (ret == SR_ERR) {
/* Module didn't recognize this buffer. */
continue;
} else if (ret != SR_OK) {
/* Can be SR_ERR_NA. */
continue;
}
/* Found a matching module. */
sr_spew("Module %s matched, confidence %u.", imod->id, conf);
if (conf >= best_conf)
continue;
best_imod = imod;
best_conf = conf;
}
if (best_imod) {
*in = sr_input_new(best_imod, NULL);
g_string_insert_len((*in)->buf, 0, buf->str, buf->len);
return SR_OK;
}
return SR_ERR;
}
/**
* Try to find an input module that can parse the given file.
*
* If an input module is found, an instance is created into *in.
* Otherwise, *in contains NULL. When multiple input moduless claim
* support for the format, the one with highest confidence takes
* precedence. Applications will see at most one input module spec.
*
*/
SR_API int sr_input_scan_file(const char *filename, const struct sr_input **in)
{
int64_t filesize;
FILE *stream;
const struct sr_input_module *imod, *best_imod;
GHashTable *meta;
GString *header;
size_t count;
unsigned int midx, i;
unsigned int conf, best_conf;
int ret;
uint8_t avail_metadata[8];
*in = NULL;
if (!filename || !filename[0]) {
sr_err("Invalid filename.");
return SR_ERR_ARG;
}
stream = g_fopen(filename, "rb");
if (!stream) {
sr_err("Failed to open %s: %s", filename, g_strerror(errno));
return SR_ERR;
}
filesize = sr_file_get_size(stream);
if (filesize < 0) {
sr_err("Failed to get size of %s: %s",
filename, g_strerror(errno));
fclose(stream);
return SR_ERR;
}
header = g_string_sized_new(CHUNK_SIZE);
count = fread(header->str, 1, header->allocated_len - 1, stream);
if (count < 1 || ferror(stream)) {
sr_err("Failed to read %s: %s", filename, g_strerror(errno));
fclose(stream);
g_string_free(header, TRUE);
return SR_ERR;
}
fclose(stream);
g_string_set_size(header, count);
meta = g_hash_table_new(NULL, NULL);
g_hash_table_insert(meta, GINT_TO_POINTER(SR_INPUT_META_FILENAME),
(char *)filename);
g_hash_table_insert(meta, GINT_TO_POINTER(SR_INPUT_META_FILESIZE),
GSIZE_TO_POINTER(MIN(filesize, G_MAXSSIZE)));
g_hash_table_insert(meta, GINT_TO_POINTER(SR_INPUT_META_HEADER),
header);
midx = 0;
avail_metadata[midx++] = SR_INPUT_META_FILENAME;
avail_metadata[midx++] = SR_INPUT_META_FILESIZE;
avail_metadata[midx++] = SR_INPUT_META_HEADER;
avail_metadata[midx] = 0;
/* TODO: MIME type */
best_imod = NULL;
best_conf = ~0;
for (i = 0; input_module_list[i]; i++) {
imod = input_module_list[i];
if (!imod->metadata[0]) {
/* Module has no metadata for matching so will take
* any input. No point in letting it try to match. */
continue;
}
if (!check_required_metadata(imod->metadata, avail_metadata))
/* Cannot satisfy this module's requirements. */
continue;
sr_dbg("Trying module %s.", imod->id);
ret = imod->format_match(meta, &conf);
if (ret == SR_ERR) {
/* Module didn't recognize this buffer. */
continue;
} else if (ret != SR_OK) {
/* Module recognized this buffer, but cannot handle it. */
continue;
}
/* Found a matching module. */
sr_dbg("Module %s matched, confidence %u.", imod->id, conf);
if (conf >= best_conf)
continue;
best_imod = imod;
best_conf = conf;
}
g_hash_table_destroy(meta);
g_string_free(header, TRUE);
if (best_imod) {
*in = sr_input_new(best_imod, NULL);
return SR_OK;
}
return SR_ERR;
}
/**
* Return the input instance's module "class". This can be used to find out
* which input module handles a specific input file. This is especially
* useful when an application did not create the input stream by specifying
* an input module, but instead some shortcut or convenience wrapper did.
*
* @since 0.6.0
*/
SR_API const struct sr_input_module *sr_input_module_get(const struct sr_input *in)
{
if (!in)
return NULL;
return in->module;
}
/**
* Return the input instance's (virtual) device instance. This can be
* used to find out the number of channels and other information.
*
* If the device instance has not yet been fully populated by the input
* module, NULL is returned. This indicates the module needs more data
* to identify the number of channels and so on.
*
* @since 0.4.0
*/
SR_API struct sr_dev_inst *sr_input_dev_inst_get(const struct sr_input *in)
{
if (in->sdi_ready)
return in->sdi;
else
return NULL;
}
/**
* Send data to the specified input instance.
*
* When an input module instance is created with sr_input_new(), this
* function is used to feed data to the instance.
*
* As enough data gets fed into this function to completely populate
* the device instance associated with this input instance, this is
* guaranteed to return the moment it's ready. This gives the caller
* the chance to examine the device instance, attach session callbacks
* and so on.
*
* @since 0.4.0
*/
SR_API int sr_input_send(const struct sr_input *in, GString *buf)
{
size_t len;
len = buf ? buf->len : 0;
sr_spew("Sending %zu bytes to %s module.", len, in->module->id);
return in->module->receive((struct sr_input *)in, buf);
}
/**
* Signal the input module no more data will come.
*
* This will cause the module to process any data it may have buffered.
* The SR_DF_END packet will also typically be sent at this time.
*
* @since 0.4.0
*/
SR_API int sr_input_end(const struct sr_input *in)
{
sr_spew("Calling end() on %s module.", in->module->id);
return in->module->end((struct sr_input *)in);
}
/**
* Reset the input module's input handling structures.
*
* Causes the input module to reset its internal state so that we can re-send
* the input data from the beginning without having to re-create the entire
* input module.
*
* @since 0.5.0
*/
SR_API int sr_input_reset(const struct sr_input *in_ro)
{
struct sr_input *in;
int rc;
in = (struct sr_input *)in_ro; /* "un-const" */
if (!in || !in->module)
return SR_ERR_ARG;
/*
* Run the optional input module's .reset() method. This shall
* take care of the context (kept in the 'inc' variable).
*/
if (in->module->reset) {
sr_spew("Resetting %s module.", in->module->id);
rc = in->module->reset(in);
} else {
sr_spew("Tried to reset %s module but no reset handler found.",
in->module->id);
rc = SR_OK;
}
/*
* Handle input module status (kept in the 'in' variable) here
* in common logic. This agrees with how input module's receive()
* and end() routines "amend but never seed" the 'in' information.
*
* Void potentially accumulated receive() buffer content, and
* clear the sdi_ready flag. This makes sure that subsequent
* processing will scan the header again before sample data gets
* interpreted, and stale content from previous calls won't affect
* the result.
*
* This common logic does not harm when the input module implements
* .reset() and contains identical assignments. In the absence of
* an individual .reset() method, simple input modules can completely
* rely on common code and keep working across resets.
*/
if (in->buf)
g_string_truncate(in->buf, 0);
in->sdi_ready = FALSE;
return rc;
}
/**
* Free the specified input instance and all associated resources.
*
* @since 0.4.0
*/
SR_API void sr_input_free(const struct sr_input *in)
{
if (!in)
return;
/*
* Run the input module's optional .cleanup() routine. This
* takes care of the context (kept in the 'inc' variable).
*/
if (in->module->cleanup)
in->module->cleanup((struct sr_input *)in);
/*
* Common code releases the input module's state (kept in the
* 'in' variable). Release the device instance, the receive()
* buffer, the shallow 'in->priv' block which is 'inc' (after
* .cleanup() released potentially nested resources under 'inc').
*/
sr_dev_inst_free(in->sdi);
if (in->buf->len > 64) {
/* That seems more than just some sub-unitsize leftover... */
sr_warn("Found %" G_GSIZE_FORMAT
" unprocessed bytes at free time.", in->buf->len);
}
g_string_free(in->buf, TRUE);
g_free(in->priv);
g_free((gpointer)in);
}
/** @} */