]>
Commit | Line | Data |
---|---|---|
1 | /* | |
2 | * This file is part of the libsigrok project. | |
3 | * | |
4 | * Copyright (C) 2012 Petteri Aimonen <jpa@sr.mail.kapsi.fi> | |
5 | * Copyright (C) 2014 Bert Vermeulen <bert@biot.com> | |
6 | * Copyright (C) 2017-2020 Gerhard Sittig <gerhard.sittig@gmx.net> | |
7 | * | |
8 | * This program is free software: you can redistribute it and/or modify | |
9 | * it under the terms of the GNU General Public License as published by | |
10 | * the Free Software Foundation, either version 3 of the License, or | |
11 | * (at your option) any later version. | |
12 | * | |
13 | * This program is distributed in the hope that it will be useful, | |
14 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
16 | * GNU General Public License for more details. | |
17 | * | |
18 | * You should have received a copy of the GNU General Public License | |
19 | * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
20 | */ | |
21 | ||
22 | /* | |
23 | * The VCD input module has the following options. See the options[] | |
24 | * declaration near the bottom of the input module's source file. | |
25 | * | |
26 | * numchannels: Maximum number of sigrok channels to create. VCD signals | |
27 | * are detected in their order of declaration in the VCD file header, | |
28 | * and mapped to sigrok channels. | |
29 | * | |
30 | * skip: Allows to skip data at the start of the input file. This can | |
31 | * speed up operation on long captures. | |
32 | * Value < 0: Skip until first timestamp that is listed in the file. | |
33 | * (This is the default behaviour.) | |
34 | * Value = 0: Do not skip, instead generate samples beginning from | |
35 | * timestamp 0. | |
36 | * Value > 0: Start at the given timestamp. | |
37 | * | |
38 | * downsample: Divide the samplerate by the given factor. This can | |
39 | * speed up operation on long captures. | |
40 | * | |
41 | * compress: Trim idle periods which are longer than this value to span | |
42 | * only this many timescale ticks. This can speed up operation on long | |
43 | * captures (default 0, don't compress). | |
44 | * | |
45 | * Based on Verilog standard IEEE Std 1364-2001 Version C | |
46 | * | |
47 | * Supported features: | |
48 | * - $var with 'wire' and 'reg' types of scalar variables | |
49 | * - $timescale definition for samplerate | |
50 | * - multiple character variable identifiers | |
51 | * - same identifer used for multiple signals (identical values) | |
52 | * - vector variables (bit vectors) | |
53 | * - integer variables (analog signals with 0 digits, passed as single | |
54 | * precision float number) | |
55 | * - real variables (analog signals, passed on with single precision, | |
56 | * arbitrary digits value, not user adjustable) | |
57 | * - nested $scope, results in prefixed sigrok channel names | |
58 | * | |
59 | * Most important unsupported features: | |
60 | * - $dumpvars initial value declaration (is not an issue if generators | |
61 | * provide sample data for the #0 timestamp, otherwise session data | |
62 | * starts from zero values, and catches up when the signal changes its | |
63 | * state to a supported value) | |
64 | * | |
65 | * Implementor's note: This input module specifically does _not_ use | |
66 | * glib routines where they would hurt performance. Lots of memory | |
67 | * allocations increase execution time not by percents but by huge | |
68 | * factors. This motivated this module's custom code for splitting | |
69 | * words on text lines, and pooling previously allocated buffers. | |
70 | * | |
71 | * TODO (in arbitrary order) | |
72 | * - Map VCD scopes to sigrok channel groups? | |
73 | * - Does libsigrok support nested channel groups? Or is this feature | |
74 | * exclusive to Pulseview? | |
75 | * - Check VCD input to VCD output behaviour. Verify that export and | |
76 | * re-import results in identical data (well, VCD's constraints on | |
77 | * timescale values is known to result in differences). | |
78 | * - Check the minimum timestamp delta in the input data set, suggest | |
79 | * the downsample=N option to users for reduced resource consumption. | |
80 | * Popular VCD file creation utilities love to specify insanely tiny | |
81 | * timescale values in the pico or even femto seconds range. Which | |
82 | * results in huge sample counts after import, and potentially even | |
83 | * terminates the application due to resource exhaustion. This issue | |
84 | * only will vanish when common libsigrok infrastructure no longer | |
85 | * depends on constant rate streams of samples at discrete points | |
86 | * in time. The current input module implementation has code in place | |
87 | * to gather timestamp statistics, but the most appropriate condition | |
88 | * when to notify users is yet to be found. | |
89 | * - Cleanup the implementation. | |
90 | * - Consistent use of the glib API (where appropriate). | |
91 | * - More appropriate variable/function identifiers. | |
92 | * - More robust handling of multi-word input phrases and chunked | |
93 | * input buffers? This implementation assumes that e.g. b[01]+ | |
94 | * patterns are complete when they start, and the signal identifier | |
95 | * is available as well. Which may be true assuming that input data | |
96 | * comes in complete text lines. | |
97 | * - See if other input modules have learned lessons that we could | |
98 | * benefit from here as well? Pointless BOM (done), line oriented | |
99 | * processing with EOL variants and with optional last EOL, module | |
100 | * state reset and file re-read (stable channels list), buffered | |
101 | * session feed, synchronized feed for mixed signal sources, digits | |
102 | * or formats support for analog input, single vs double precision, | |
103 | * etc. | |
104 | * - Re-consider logging. Verbosity levels should be acceptable, | |
105 | * but volume is an issue. Drop duplicates, and drop messages from | |
106 | * known good code paths. | |
107 | */ | |
108 | ||
109 | #include <config.h> | |
110 | ||
111 | #include <glib.h> | |
112 | #include <libsigrok/libsigrok.h> | |
113 | #include "libsigrok-internal.h" | |
114 | #include <stdio.h> | |
115 | #include <stdlib.h> | |
116 | #include <string.h> | |
117 | ||
118 | #define LOG_PREFIX "input/vcd" | |
119 | ||
120 | #define CHUNK_SIZE (4 * 1024 * 1024) | |
121 | #define SCOPE_SEP '.' | |
122 | ||
123 | struct context { | |
124 | struct vcd_user_opt { | |
125 | size_t maxchannels; /* sigrok channels (output) */ | |
126 | uint64_t downsample; | |
127 | uint64_t compress; | |
128 | uint64_t skip_starttime; | |
129 | gboolean skip_specified; | |
130 | } options; | |
131 | gboolean use_skip; | |
132 | gboolean started; | |
133 | gboolean got_header; | |
134 | uint64_t prev_timestamp; | |
135 | uint64_t samplerate; | |
136 | size_t vcdsignals; /* VCD signals (input) */ | |
137 | GSList *ignored_signals; | |
138 | gboolean data_after_timestamp; | |
139 | gboolean ignore_end_keyword; | |
140 | gboolean skip_until_end; | |
141 | GSList *channels; | |
142 | size_t unit_size; | |
143 | size_t logic_count; | |
144 | size_t analog_count; | |
145 | uint8_t *current_logic; | |
146 | float *current_floats; | |
147 | struct { | |
148 | size_t max_bits; | |
149 | size_t unit_size; | |
150 | uint8_t *value; | |
151 | size_t sig_count; | |
152 | } conv_bits; | |
153 | GString *scope_prefix; | |
154 | struct feed_queue_logic *feed_logic; | |
155 | struct split_state { | |
156 | size_t alloced; | |
157 | char **words; | |
158 | gboolean in_use; | |
159 | } split; | |
160 | struct ts_stats { | |
161 | size_t total_ts_seen; | |
162 | uint64_t last_ts_value; | |
163 | uint64_t last_ts_delta; | |
164 | size_t min_count; | |
165 | struct { | |
166 | uint64_t delta; | |
167 | size_t count; | |
168 | } min_items[2]; | |
169 | uint32_t early_check_shift; | |
170 | size_t early_last_emitted; | |
171 | } ts_stats; | |
172 | struct vcd_prev { | |
173 | GSList *sr_channels; | |
174 | GSList *sr_groups; | |
175 | } prev; | |
176 | }; | |
177 | ||
178 | struct vcd_channel { | |
179 | char *name; | |
180 | char *identifier; | |
181 | size_t size; | |
182 | enum sr_channeltype type; | |
183 | size_t array_index; | |
184 | size_t byte_idx; | |
185 | uint8_t bit_mask; | |
186 | char *base_name; | |
187 | size_t range_lower, range_upper; | |
188 | int submit_digits; | |
189 | struct feed_queue_analog *feed_analog; | |
190 | }; | |
191 | ||
192 | static void free_channel(void *data) | |
193 | { | |
194 | struct vcd_channel *vcd_ch; | |
195 | ||
196 | vcd_ch = data; | |
197 | if (!vcd_ch) | |
198 | return; | |
199 | ||
200 | g_free(vcd_ch->name); | |
201 | g_free(vcd_ch->identifier); | |
202 | g_free(vcd_ch->base_name); | |
203 | feed_queue_analog_free(vcd_ch->feed_analog); | |
204 | ||
205 | g_free(vcd_ch); | |
206 | } | |
207 | ||
208 | /* TODO Drop the local decl when this has become a common helper. */ | |
209 | void sr_channel_group_free(struct sr_channel_group *cg); | |
210 | ||
211 | /* Wrapper for GDestroyNotify compatibility. */ | |
212 | static void cg_free(void *p) | |
213 | { | |
214 | sr_channel_group_free(p); | |
215 | } | |
216 | ||
217 | /* | |
218 | * Another timestamp delta was observed, update statistics: Update the | |
219 | * sorted list of minimum values, and increment the occurance counter. | |
220 | * Returns the position of the item's statistics slot, or returns a huge | |
221 | * invalid index when the current delta is larger than previously found | |
222 | * values. | |
223 | */ | |
224 | static size_t ts_stats_update_min(struct ts_stats *stats, uint64_t delta) | |
225 | { | |
226 | size_t idx, copy_idx; | |
227 | ||
228 | /* Advance over previously recorded values which are smaller. */ | |
229 | idx = 0; | |
230 | while (idx < stats->min_count && stats->min_items[idx].delta < delta) | |
231 | idx++; | |
232 | if (idx == ARRAY_SIZE(stats->min_items)) | |
233 | return idx; | |
234 | ||
235 | /* Found the exact value that previously was registered? */ | |
236 | if (stats->min_items[idx].delta == delta) { | |
237 | stats->min_items[idx].count++; | |
238 | return idx; | |
239 | } | |
240 | ||
241 | /* Allocate another slot, bubble up larger values as needed. */ | |
242 | if (stats->min_count < ARRAY_SIZE(stats->min_items)) | |
243 | stats->min_count++; | |
244 | for (copy_idx = stats->min_count - 1; copy_idx > idx; copy_idx--) | |
245 | stats->min_items[copy_idx] = stats->min_items[copy_idx - 1]; | |
246 | ||
247 | /* Start tracking this value in the found or freed slot. */ | |
248 | memset(&stats->min_items[idx], 0, sizeof(stats->min_items[idx])); | |
249 | stats->min_items[idx].delta = delta; | |
250 | stats->min_items[idx].count++; | |
251 | ||
252 | return idx; | |
253 | } | |
254 | ||
255 | /* | |
256 | * Intermediate check for extreme oversampling in the input data. Rate | |
257 | * limited emission of warnings to avoid noise, "late" emission of the | |
258 | * first potential message to avoid false positives, yet need to emit | |
259 | * the messages early (*way* before EOF) to raise awareness. | |
260 | * | |
261 | * TODO | |
262 | * Tune the limits, improve perception and usefulness of these checks. | |
263 | * Need to start emitting messages soon enough to be seen by users. Yet | |
264 | * avoid unnecessary messages for valid input's idle/quiet phases. Slow | |
265 | * input transitions are perfectly legal before bursty phases are seen | |
266 | * in the input data. Needs the check become an option, on by default, | |
267 | * but suppressable by users? | |
268 | */ | |
269 | static void ts_stats_check_early(struct ts_stats *stats) | |
270 | { | |
271 | static const struct { | |
272 | uint64_t delta; | |
273 | size_t count; | |
274 | } *cp, check_points[] = { | |
275 | { 100, 1000000, }, /* Still x100 after 1mio transitions. */ | |
276 | { 1000, 100000, }, /* Still x1k after 100k transitions. */ | |
277 | { 10000, 10000, }, /* Still x10k after 10k transitions. */ | |
278 | { 1000000, 2500, }, /* Still x1m after 2.5k transitions. */ | |
279 | }; | |
280 | ||
281 | size_t cp_idx; | |
282 | uint64_t seen_delta, check_delta; | |
283 | size_t seen_count; | |
284 | ||
285 | /* Get the current minimum's value and count. */ | |
286 | if (!stats->min_count) | |
287 | return; | |
288 | seen_delta = stats->min_items[0].delta; | |
289 | seen_count = stats->min_items[0].count; | |
290 | ||
291 | /* Emit at most one weak message per import. */ | |
292 | if (stats->early_last_emitted) | |
293 | return; | |
294 | ||
295 | /* Check arbitrary marks, emit rate limited warnings. */ | |
296 | (void)seen_count; | |
297 | check_delta = seen_delta >> stats->early_check_shift; | |
298 | for (cp_idx = 0; cp_idx < ARRAY_SIZE(check_points); cp_idx++) { | |
299 | cp = &check_points[cp_idx]; | |
300 | /* No other match can happen below. Done iterating. */ | |
301 | if (stats->total_ts_seen > cp->count) | |
302 | return; | |
303 | /* Advance to the next checkpoint description. */ | |
304 | if (stats->total_ts_seen != cp->count) | |
305 | continue; | |
306 | /* First occurance of that timestamp count. Check the value. */ | |
307 | sr_dbg("TS early chk: total %" PRIu64 ", min delta %zu / %zu.", | |
308 | cp->count, seen_delta, check_delta); | |
309 | if (check_delta < cp->delta) | |
310 | return; | |
311 | sr_warn("Low change rate? (weak estimate, min TS delta %" PRIu64 " after %zu timestamps)", | |
312 | seen_delta, stats->total_ts_seen); | |
313 | sr_warn("Consider using the downsample=N option, or increasing its value."); | |
314 | stats->early_last_emitted = stats->total_ts_seen; | |
315 | return; | |
316 | } | |
317 | } | |
318 | ||
319 | /* Reset the internal state of the timestamp tracker. */ | |
320 | static int ts_stats_prep(struct context *inc) | |
321 | { | |
322 | struct ts_stats *stats; | |
323 | uint64_t down_sample_value; | |
324 | uint32_t down_sample_shift; | |
325 | ||
326 | stats = &inc->ts_stats; | |
327 | memset(stats, 0, sizeof(*stats)); | |
328 | ||
329 | down_sample_value = inc->options.downsample; | |
330 | down_sample_shift = 0; | |
331 | while (down_sample_value >= 2) { | |
332 | down_sample_shift++; | |
333 | down_sample_value /= 2; | |
334 | } | |
335 | stats->early_check_shift = down_sample_shift; | |
336 | ||
337 | return SR_OK; | |
338 | } | |
339 | ||
340 | /* Inspect another timestamp that was received. */ | |
341 | static int ts_stats_check(struct ts_stats *stats, uint64_t curr_ts) | |
342 | { | |
343 | uint64_t last_ts, delta; | |
344 | ||
345 | last_ts = stats->last_ts_value; | |
346 | stats->last_ts_value = curr_ts; | |
347 | stats->total_ts_seen++; | |
348 | if (stats->total_ts_seen < 2) | |
349 | return SR_OK; | |
350 | ||
351 | delta = curr_ts - last_ts; | |
352 | stats->last_ts_delta = delta; | |
353 | (void)ts_stats_update_min(stats, delta); | |
354 | ||
355 | ts_stats_check_early(stats); | |
356 | ||
357 | return SR_OK; | |
358 | } | |
359 | ||
360 | /* Postprocess internal timestamp tracker state. */ | |
361 | static int ts_stats_post(struct context *inc, gboolean ignore_terminal) | |
362 | { | |
363 | struct ts_stats *stats; | |
364 | size_t min_idx; | |
365 | uint64_t delta, over_sample, over_sample_scaled, suggest_factor; | |
366 | enum sr_loglevel log_level; | |
367 | gboolean is_suspicious, has_downsample; | |
368 | ||
369 | stats = &inc->ts_stats; | |
370 | ||
371 | /* | |
372 | * Lookup the smallest timestamp delta which was found during | |
373 | * data import. Ignore the last delta if its timestamp was never | |
374 | * followed by data, and this was the only occurance. Absence of | |
375 | * result data is non-fatal here -- this code exclusively serves | |
376 | * to raise users' awareness of potential pitfalls, but does not | |
377 | * change behaviour of data processing. | |
378 | * | |
379 | * TODO Also filter by occurance count? To not emit warnings when | |
380 | * captured signals only change slowly by design. Only warn when | |
381 | * the sample rate and samples count product exceeds a threshold? | |
382 | * See below for the necessity (and potential) to adjust the log | |
383 | * message's severity and content. | |
384 | */ | |
385 | min_idx = 0; | |
386 | if (ignore_terminal) do { | |
387 | if (min_idx >= stats->min_count) | |
388 | break; | |
389 | delta = stats->last_ts_delta; | |
390 | if (stats->min_items[min_idx].delta != delta) | |
391 | break; | |
392 | if (stats->min_items[min_idx].count != 1) | |
393 | break; | |
394 | min_idx++; | |
395 | } while (0); | |
396 | if (min_idx >= stats->min_count) | |
397 | return SR_OK; | |
398 | ||
399 | /* | |
400 | * TODO Refine the condition whether to notify the user, and | |
401 | * which severity to use after having inspected all input data. | |
402 | * Any detail could get involved which previously was gathered | |
403 | * during data processing: total sample count, channel count | |
404 | * including their data type and bits width, the oversampling | |
405 | * factor (minimum observed "change rate"), or any combination | |
406 | * thereof. The current check is rather simple (unconditional | |
407 | * warning for ratios starting at 100, regardless of sample or | |
408 | * channel count). | |
409 | */ | |
410 | over_sample = stats->min_items[min_idx].delta; | |
411 | over_sample_scaled = over_sample / inc->options.downsample; | |
412 | sr_dbg("TS post stats: oversample unscaled %" PRIu64 ", scaled %" PRIu64, | |
413 | over_sample, over_sample_scaled); | |
414 | if (over_sample_scaled < 10) { | |
415 | sr_dbg("TS post stats: Low oversampling ratio, good."); | |
416 | return SR_OK; | |
417 | } | |
418 | ||
419 | /* | |
420 | * Avoid constructing the message from several tiny pieces by | |
421 | * design, because this would be hard on translators. Stick with | |
422 | * complete sentences instead, and accept the redundancy in the | |
423 | * user's interest. | |
424 | */ | |
425 | log_level = (over_sample_scaled > 20) ? SR_LOG_WARN : SR_LOG_INFO; | |
426 | is_suspicious = over_sample_scaled > 20; | |
427 | if (is_suspicious) { | |
428 | sr_log(log_level, LOG_PREFIX ": " | |
429 | "Suspiciously low overall change rate (total min TS delta %" PRIu64 ").", | |
430 | over_sample_scaled); | |
431 | } else { | |
432 | sr_log(log_level, LOG_PREFIX ": " | |
433 | "Low overall change rate (total min TS delta %" PRIu64 ").", | |
434 | over_sample_scaled); | |
435 | } | |
436 | has_downsample = inc->options.downsample > 1; | |
437 | suggest_factor = inc->options.downsample; | |
438 | while (over_sample_scaled >= 10) { | |
439 | suggest_factor *= 10; | |
440 | over_sample_scaled /= 10; | |
441 | } | |
442 | if (has_downsample) { | |
443 | sr_log(log_level, LOG_PREFIX ": " | |
444 | "Suggest higher downsample value, like %" PRIu64 ".", | |
445 | suggest_factor); | |
446 | } else { | |
447 | sr_log(log_level, LOG_PREFIX ": " | |
448 | "Suggest to downsample, value like %" PRIu64 ".", | |
449 | suggest_factor); | |
450 | } | |
451 | ||
452 | return SR_OK; | |
453 | } | |
454 | ||
455 | static void check_remove_bom(GString *buf) | |
456 | { | |
457 | static const char *bom_text = "\xef\xbb\xbf"; | |
458 | ||
459 | if (buf->len < strlen(bom_text)) | |
460 | return; | |
461 | if (strncmp(buf->str, bom_text, strlen(bom_text)) != 0) | |
462 | return; | |
463 | g_string_erase(buf, 0, strlen(bom_text)); | |
464 | } | |
465 | ||
466 | /* | |
467 | * Reads a single VCD section from input file and parses it to name/contents. | |
468 | * e.g. $timescale 1ps $end => "timescale" "1ps" | |
469 | */ | |
470 | static gboolean parse_section(GString *buf, char **name, char **contents) | |
471 | { | |
472 | static const char *end_text = "$end"; | |
473 | ||
474 | gboolean status; | |
475 | size_t pos, len; | |
476 | const char *grab_start, *grab_end; | |
477 | GString *sname, *scontent; | |
478 | ||
479 | /* Preset falsy return values. Gets updated below. */ | |
480 | *name = *contents = NULL; | |
481 | status = FALSE; | |
482 | ||
483 | /* Skip any initial white-space. */ | |
484 | pos = 0; | |
485 | while (pos < buf->len && g_ascii_isspace(buf->str[pos])) | |
486 | pos++; | |
487 | ||
488 | /* Section tag should start with $. */ | |
489 | if (buf->str[pos++] != '$') | |
490 | return FALSE; | |
491 | ||
492 | /* Read the section tag. */ | |
493 | grab_start = &buf->str[pos]; | |
494 | while (pos < buf->len && !g_ascii_isspace(buf->str[pos])) | |
495 | pos++; | |
496 | grab_end = &buf->str[pos]; | |
497 | sname = g_string_new_len(grab_start, grab_end - grab_start); | |
498 | ||
499 | /* Skip whitespace before content. */ | |
500 | while (pos < buf->len && g_ascii_isspace(buf->str[pos])) | |
501 | pos++; | |
502 | ||
503 | /* Read the content up to the '$end' marker. */ | |
504 | scontent = g_string_sized_new(128); | |
505 | grab_start = &buf->str[pos]; | |
506 | grab_end = g_strstr_len(grab_start, buf->len - pos, end_text); | |
507 | if (grab_end) { | |
508 | /* Advance 'pos' to after '$end' and more whitespace. */ | |
509 | pos = grab_end - buf->str; | |
510 | pos += strlen(end_text); | |
511 | while (pos < buf->len && g_ascii_isspace(buf->str[pos])) | |
512 | pos++; | |
513 | ||
514 | /* Grab the (trimmed) content text. */ | |
515 | while (grab_end > grab_start && g_ascii_isspace(grab_end[-1])) | |
516 | grab_end--; | |
517 | len = grab_end - grab_start; | |
518 | g_string_append_len(scontent, grab_start, len); | |
519 | if (sname->len) | |
520 | status = TRUE; | |
521 | ||
522 | /* Consume the input text which just was taken. */ | |
523 | g_string_erase(buf, 0, pos); | |
524 | } | |
525 | ||
526 | /* Return section name and content if a section was seen. */ | |
527 | *name = g_string_free(sname, !status); | |
528 | *contents = g_string_free(scontent, !status); | |
529 | ||
530 | return status; | |
531 | } | |
532 | ||
533 | /* | |
534 | * The glib routine which splits an input text into a list of words also | |
535 | * "provides empty strings" which application code then needs to remove. | |
536 | * And copies of the input text get allocated for all words. | |
537 | * | |
538 | * The repeated memory allocation is acceptable for small workloads like | |
539 | * parsing the header sections. But the heavy lifting for sample data is | |
540 | * done by DIY code to speedup execution. The use of glib routines would | |
541 | * severely hurt throughput. Allocated memory gets re-used while a strict | |
542 | * ping-pong pattern is assumed (each text line of input data enters and | |
543 | * leaves in a strict symmetrical manner, due to the organization of the | |
544 | * receive() routine and parse calls). | |
545 | */ | |
546 | ||
547 | /* Remove empty parts from an array returned by g_strsplit(). */ | |
548 | static void remove_empty_parts(gchar **parts) | |
549 | { | |
550 | gchar **src, **dest; | |
551 | ||
552 | src = dest = parts; | |
553 | while (*src) { | |
554 | if (!**src) { | |
555 | g_free(*src); | |
556 | } else { | |
557 | if (dest != src) | |
558 | *dest = *src; | |
559 | dest++; | |
560 | } | |
561 | src++; | |
562 | } | |
563 | *dest = NULL; | |
564 | } | |
565 | ||
566 | static char **split_text_line(struct context *inc, char *text, size_t *count) | |
567 | { | |
568 | struct split_state *state; | |
569 | size_t counted, alloced, wanted; | |
570 | char **words, *p, **new_words; | |
571 | ||
572 | state = &inc->split; | |
573 | ||
574 | if (count) | |
575 | *count = 0; | |
576 | ||
577 | if (state->in_use) { | |
578 | sr_dbg("coding error, split() called while \"in use\"."); | |
579 | return NULL; | |
580 | } | |
581 | ||
582 | /* | |
583 | * Seed allocation when invoked for the first time. Assume | |
584 | * simple logic data, start with a few words per line. Will | |
585 | * automatically adjust with subsequent use. | |
586 | */ | |
587 | if (!state->alloced) { | |
588 | alloced = 20; | |
589 | words = g_malloc(sizeof(words[0]) * alloced); | |
590 | if (!words) | |
591 | return NULL; | |
592 | state->alloced = alloced; | |
593 | state->words = words; | |
594 | } | |
595 | ||
596 | /* Start with most recently allocated word list space. */ | |
597 | alloced = state->alloced; | |
598 | words = state->words; | |
599 | counted = 0; | |
600 | ||
601 | /* As long as more input text remains ... */ | |
602 | p = text; | |
603 | while (*p) { | |
604 | /* Resize word list if needed. Just double the size. */ | |
605 | if (counted + 1 >= alloced) { | |
606 | wanted = 2 * alloced; | |
607 | new_words = g_realloc(words, sizeof(words[0]) * wanted); | |
608 | if (!new_words) { | |
609 | return NULL; | |
610 | } | |
611 | words = new_words; | |
612 | alloced = wanted; | |
613 | state->words = words; | |
614 | state->alloced = alloced; | |
615 | } | |
616 | ||
617 | /* Skip leading spaces. */ | |
618 | while (g_ascii_isspace(*p)) | |
619 | p++; | |
620 | if (!*p) | |
621 | break; | |
622 | ||
623 | /* Add found word to word list. */ | |
624 | words[counted++] = p; | |
625 | ||
626 | /* Find end of the word. Terminate loop upon EOS. */ | |
627 | while (*p && !g_ascii_isspace(*p)) | |
628 | p++; | |
629 | if (!*p) | |
630 | break; | |
631 | ||
632 | /* More text follows. Terminate the word. */ | |
633 | *p++ = '\0'; | |
634 | } | |
635 | ||
636 | /* | |
637 | * NULL terminate the word list. Provide its length so that | |
638 | * calling code need not re-iterate the list to get the count. | |
639 | */ | |
640 | words[counted] = NULL; | |
641 | if (count) | |
642 | *count = counted; | |
643 | state->in_use = TRUE; | |
644 | ||
645 | return words; | |
646 | } | |
647 | ||
648 | static void free_text_split(struct context *inc, char **words) | |
649 | { | |
650 | struct split_state *state; | |
651 | ||
652 | state = &inc->split; | |
653 | ||
654 | if (words && words != state->words) { | |
655 | sr_dbg("coding error, free() arg differs from split() result."); | |
656 | } | |
657 | ||
658 | /* "Double free" finally releases the memory. */ | |
659 | if (!state->in_use) { | |
660 | g_free(state->words); | |
661 | state->words = NULL; | |
662 | state->alloced = 0; | |
663 | } | |
664 | ||
665 | /* Mark as no longer in use. */ | |
666 | state->in_use = FALSE; | |
667 | } | |
668 | ||
669 | static gboolean have_header(GString *buf) | |
670 | { | |
671 | static const char *enddef_txt = "$enddefinitions"; | |
672 | static const char *end_txt = "$end"; | |
673 | ||
674 | char *p, *p_stop; | |
675 | ||
676 | /* Search for "end of definitions" section keyword. */ | |
677 | p = g_strstr_len(buf->str, buf->len, enddef_txt); | |
678 | if (!p) | |
679 | return FALSE; | |
680 | p += strlen(enddef_txt); | |
681 | ||
682 | /* Search for end of section (content expected to be empty). */ | |
683 | p_stop = &buf->str[buf->len]; | |
684 | p_stop -= strlen(end_txt); | |
685 | while (p < p_stop && g_ascii_isspace(*p)) | |
686 | p++; | |
687 | if (strncmp(p, end_txt, strlen(end_txt)) != 0) | |
688 | return FALSE; | |
689 | p += strlen(end_txt); | |
690 | ||
691 | return TRUE; | |
692 | } | |
693 | ||
694 | static int parse_timescale(struct context *inc, char *contents) | |
695 | { | |
696 | uint64_t p, q; | |
697 | ||
698 | /* | |
699 | * The standard allows for values 1, 10 or 100 | |
700 | * and units s, ms, us, ns, ps and fs. | |
701 | */ | |
702 | if (sr_parse_period(contents, &p, &q) != SR_OK) { | |
703 | sr_err("Parsing $timescale failed."); | |
704 | return SR_ERR_DATA; | |
705 | } | |
706 | ||
707 | inc->samplerate = q / p; | |
708 | sr_dbg("Samplerate: %" PRIu64, inc->samplerate); | |
709 | if (q % p != 0) { | |
710 | /* Does not happen unless time value is non-standard */ | |
711 | sr_warn("Inexact rounding of samplerate, %" PRIu64 " / %" PRIu64 " to %" PRIu64 " Hz.", | |
712 | q, p, inc->samplerate); | |
713 | } | |
714 | ||
715 | return SR_OK; | |
716 | } | |
717 | ||
718 | /* | |
719 | * Handle '$scope' and '$upscope' sections in the input file. Assume that | |
720 | * input signals have a "base name", which may be ambiguous within the | |
721 | * file. These names get declared within potentially nested scopes, which | |
722 | * this implementation uses to create longer but hopefully unique and | |
723 | * thus more usable sigrok channel names. | |
724 | * | |
725 | * Track the currently effective scopes in a string variable to simplify | |
726 | * the channel name creation. Start from an empty string, then append the | |
727 | * scope name and a separator when a new scope opens, and remove the last | |
728 | * scope name when a scope closes. This allows to simply prefix basenames | |
729 | * with the current scope to get a full name. | |
730 | * | |
731 | * It's an implementation detail to keep the trailing NUL here in the | |
732 | * GString member, to simplify the g_strconcat() call in the channel name | |
733 | * creation. | |
734 | * | |
735 | * TODO | |
736 | * - Check whether scope types must get supported, this implementation | |
737 | * does not distinguish between 'module' and 'begin' and what else | |
738 | * may be seen. The first word simply gets ignored. | |
739 | * - Check the allowed alphabet for scope names. This implementation | |
740 | * assumes "programming language identifier" style (alphanumeric with | |
741 | * underscores, plus brackets since we've seen them in example files). | |
742 | */ | |
743 | static int parse_scope(struct context *inc, char *contents, gboolean is_up) | |
744 | { | |
745 | char *sep_pos, *name_pos; | |
746 | char **parts; | |
747 | size_t length; | |
748 | ||
749 | /* | |
750 | * The 'upscope' case, drop one scope level (if available). Accept | |
751 | * excess 'upscope' calls, assume that a previous 'scope' section | |
752 | * was ignored because it referenced our software package's name. | |
753 | */ | |
754 | if (is_up) { | |
755 | /* | |
756 | * Check for a second right-most separator (and position | |
757 | * right behind that, which is the start of the last | |
758 | * scope component), or fallback to the start of string. | |
759 | * g_string_erase() from that positon to the end to drop | |
760 | * the last component. | |
761 | */ | |
762 | name_pos = inc->scope_prefix->str; | |
763 | do { | |
764 | sep_pos = strrchr(name_pos, SCOPE_SEP); | |
765 | if (!sep_pos) | |
766 | break; | |
767 | *sep_pos = '\0'; | |
768 | sep_pos = strrchr(name_pos, SCOPE_SEP); | |
769 | if (!sep_pos) | |
770 | break; | |
771 | name_pos = ++sep_pos; | |
772 | } while (0); | |
773 | length = name_pos - inc->scope_prefix->str; | |
774 | g_string_truncate(inc->scope_prefix, length); | |
775 | g_string_append_c(inc->scope_prefix, '\0'); | |
776 | sr_dbg("$upscope, prefix now: \"%s\"", inc->scope_prefix->str); | |
777 | return SR_OK; | |
778 | } | |
779 | ||
780 | /* | |
781 | * The 'scope' case, add another scope level. But skip our own | |
782 | * package name, assuming that this is an artificial node which | |
783 | * was emitted by libsigrok's VCD output module. | |
784 | */ | |
785 | sr_spew("$scope, got: \"%s\"", contents); | |
786 | parts = g_strsplit_set(contents, " \r\n\t", 0); | |
787 | remove_empty_parts(parts); | |
788 | length = g_strv_length(parts); | |
789 | if (length != 2) { | |
790 | sr_err("Unsupported 'scope' syntax: %s", contents); | |
791 | g_strfreev(parts); | |
792 | return SR_ERR_DATA; | |
793 | } | |
794 | name_pos = parts[1]; | |
795 | if (strcmp(name_pos, PACKAGE_NAME) == 0) { | |
796 | sr_info("Skipping scope with application's package name: %s", | |
797 | name_pos); | |
798 | *name_pos = '\0'; | |
799 | } | |
800 | if (*name_pos) { | |
801 | /* Drop NUL, append scope name and separator, and re-add NUL. */ | |
802 | g_string_truncate(inc->scope_prefix, inc->scope_prefix->len - 1); | |
803 | g_string_append_printf(inc->scope_prefix, | |
804 | "%s%c%c", name_pos, SCOPE_SEP, '\0'); | |
805 | } | |
806 | g_strfreev(parts); | |
807 | sr_dbg("$scope, prefix now: \"%s\"", inc->scope_prefix->str); | |
808 | ||
809 | return SR_OK; | |
810 | } | |
811 | ||
812 | /** | |
813 | * Parse a $var section which describes a VCD signal ("variable"). | |
814 | * | |
815 | * @param[in] inc Input module context. | |
816 | * @param[in] contents Input text, content of $var section. | |
817 | */ | |
818 | static int parse_header_var(struct context *inc, char *contents) | |
819 | { | |
820 | char **parts; | |
821 | size_t length; | |
822 | char *type, *size_txt, *id, *ref, *idx; | |
823 | gboolean is_reg, is_wire, is_real, is_int; | |
824 | enum sr_channeltype ch_type; | |
825 | size_t size, next_size; | |
826 | struct vcd_channel *vcd_ch; | |
827 | ||
828 | /* | |
829 | * Format of $var or $reg header specs: | |
830 | * $var type size identifier reference [opt-index] $end | |
831 | */ | |
832 | parts = g_strsplit_set(contents, " \r\n\t", 0); | |
833 | remove_empty_parts(parts); | |
834 | length = g_strv_length(parts); | |
835 | if (length != 4 && length != 5) { | |
836 | sr_warn("$var section should have 4 or 5 items"); | |
837 | g_strfreev(parts); | |
838 | return SR_ERR_DATA; | |
839 | } | |
840 | ||
841 | type = parts[0]; | |
842 | size_txt = parts[1]; | |
843 | id = parts[2]; | |
844 | ref = parts[3]; | |
845 | idx = parts[4]; | |
846 | if (idx && !*idx) | |
847 | idx = NULL; | |
848 | is_reg = g_strcmp0(type, "reg") == 0; | |
849 | is_wire = g_strcmp0(type, "wire") == 0; | |
850 | is_real = g_strcmp0(type, "real") == 0; | |
851 | is_int = g_strcmp0(type, "integer") == 0; | |
852 | ||
853 | if (is_reg || is_wire) { | |
854 | ch_type = SR_CHANNEL_LOGIC; | |
855 | } else if (is_real || is_int) { | |
856 | ch_type = SR_CHANNEL_ANALOG; | |
857 | } else { | |
858 | sr_info("Unsupported signal type: '%s'", type); | |
859 | g_strfreev(parts); | |
860 | return SR_ERR_DATA; | |
861 | } | |
862 | ||
863 | size = strtol(size_txt, NULL, 10); | |
864 | if (ch_type == SR_CHANNEL_ANALOG) { | |
865 | if (is_real && size != 32 && size != 64) { | |
866 | /* | |
867 | * The VCD input module does not depend on the | |
868 | * specific width of the floating point value. | |
869 | * This is just for information. Upon value | |
870 | * changes, a mere string gets converted to | |
871 | * float, so we may not care at all. | |
872 | * | |
873 | * Strictly speaking we might warn for 64bit | |
874 | * (double precision) declarations, because | |
875 | * sigrok internally uses single precision | |
876 | * (32bit) only. | |
877 | */ | |
878 | sr_info("Unexpected real width: '%s'", size_txt); | |
879 | } | |
880 | /* Simplify code paths below, by assuming size 1. */ | |
881 | size = 1; | |
882 | } | |
883 | if (!size) { | |
884 | sr_warn("Unsupported signal size: '%s'", size_txt); | |
885 | g_strfreev(parts); | |
886 | return SR_ERR_DATA; | |
887 | } | |
888 | if (inc->conv_bits.max_bits < size) | |
889 | inc->conv_bits.max_bits = size; | |
890 | next_size = inc->logic_count + inc->analog_count + size; | |
891 | if (inc->options.maxchannels && next_size > inc->options.maxchannels) { | |
892 | sr_warn("Skipping '%s%s', exceeds requested channel count %zu.", | |
893 | ref, idx ? idx : "", inc->options.maxchannels); | |
894 | inc->ignored_signals = g_slist_append(inc->ignored_signals, | |
895 | g_strdup(id)); | |
896 | g_strfreev(parts); | |
897 | return SR_OK; | |
898 | } | |
899 | ||
900 | vcd_ch = g_malloc0(sizeof(*vcd_ch)); | |
901 | vcd_ch->identifier = g_strdup(id); | |
902 | vcd_ch->name = g_strconcat(inc->scope_prefix->str, ref, idx, NULL); | |
903 | vcd_ch->size = size; | |
904 | vcd_ch->type = ch_type; | |
905 | switch (ch_type) { | |
906 | case SR_CHANNEL_LOGIC: | |
907 | vcd_ch->array_index = inc->logic_count; | |
908 | vcd_ch->byte_idx = vcd_ch->array_index / 8; | |
909 | vcd_ch->bit_mask = 1 << (vcd_ch->array_index % 8); | |
910 | inc->logic_count += size; | |
911 | break; | |
912 | case SR_CHANNEL_ANALOG: | |
913 | vcd_ch->array_index = inc->analog_count++; | |
914 | /* TODO: Use proper 'digits' value for this input module. */ | |
915 | vcd_ch->submit_digits = is_real ? 2 : 0; | |
916 | break; | |
917 | } | |
918 | inc->vcdsignals++; | |
919 | sr_spew("VCD signal %zu '%s' ID '%s' (size %zu), sr type %s, idx %zu.", | |
920 | inc->vcdsignals, vcd_ch->name, | |
921 | vcd_ch->identifier, vcd_ch->size, | |
922 | vcd_ch->type == SR_CHANNEL_ANALOG ? "A" : "L", | |
923 | vcd_ch->array_index); | |
924 | inc->channels = g_slist_append(inc->channels, vcd_ch); | |
925 | g_strfreev(parts); | |
926 | ||
927 | return SR_OK; | |
928 | } | |
929 | ||
930 | /** | |
931 | * Construct the name of the nth sigrok channel for a VCD signal. | |
932 | * | |
933 | * Uses the VCD signal name for scalar types and single-bit signals. | |
934 | * Uses "signal.idx" for multi-bit VCD signals without a range spec in | |
935 | * their declaration. Uses "signal[idx]" when a range is known and was | |
936 | * verified. | |
937 | * | |
938 | * @param[in] vcd_ch The VCD signal's description. | |
939 | * @param[in] idx The sigrok channel's index within the VCD signal's group. | |
940 | * | |
941 | * @return An allocated text buffer which callers need to release, #NULL | |
942 | * upon failure to create a sigrok channel name. | |
943 | */ | |
944 | static char *get_channel_name(struct vcd_channel *vcd_ch, size_t idx) | |
945 | { | |
946 | char *open_pos, *close_pos, *check_pos, *endptr; | |
947 | gboolean has_brackets, has_range; | |
948 | size_t upper, lower, tmp; | |
949 | char *ch_name; | |
950 | ||
951 | /* Handle simple scalar types, and single-bit logic first. */ | |
952 | if (vcd_ch->size <= 1) | |
953 | return g_strdup(vcd_ch->name); | |
954 | ||
955 | /* | |
956 | * If not done before: Search for a matching pair of brackets in | |
957 | * the right-most position at the very end of the string. Get the | |
958 | * two colon separated numbers between the brackets, which are | |
959 | * the range limits for array indices into the multi-bit signal. | |
960 | * Grab the "base name" of the VCD signal. | |
961 | * | |
962 | * Notice that arrays can get nested. Earlier path components can | |
963 | * be indexed as well, that's why we need the right-most range. | |
964 | * This implementation does not handle bit vectors of size 1 here | |
965 | * by explicit logic. The check for a [0:0] range would even fail. | |
966 | * But the case of size 1 is handled above, and "happens to" give | |
967 | * the expected result (just the VCD signal name). | |
968 | * | |
969 | * This implementation also deals with range limits in the reverse | |
970 | * order, as well as ranges which are not 0-based (like "[4:7]"). | |
971 | */ | |
972 | if (!vcd_ch->base_name) { | |
973 | has_range = TRUE; | |
974 | open_pos = strrchr(vcd_ch->name, '['); | |
975 | close_pos = strrchr(vcd_ch->name, ']'); | |
976 | if (close_pos && close_pos[1]) | |
977 | close_pos = NULL; | |
978 | has_brackets = open_pos && close_pos && close_pos > open_pos; | |
979 | if (!has_brackets) | |
980 | has_range = FALSE; | |
981 | if (has_range) { | |
982 | check_pos = &open_pos[1]; | |
983 | endptr = NULL; | |
984 | upper = strtoul(check_pos, &endptr, 10); | |
985 | if (!endptr || *endptr != ':') | |
986 | has_range = FALSE; | |
987 | } | |
988 | if (has_range) { | |
989 | check_pos = &endptr[1]; | |
990 | endptr = NULL; | |
991 | lower = strtoul(check_pos, &endptr, 10); | |
992 | if (!endptr || endptr != close_pos) | |
993 | has_range = FALSE; | |
994 | } | |
995 | if (has_range && lower > upper) { | |
996 | tmp = lower; | |
997 | lower = upper; | |
998 | upper = tmp; | |
999 | } | |
1000 | if (has_range) { | |
1001 | if (lower >= upper) | |
1002 | has_range = FALSE; | |
1003 | if (upper + 1 - lower != vcd_ch->size) | |
1004 | has_range = FALSE; | |
1005 | } | |
1006 | if (has_range) { | |
1007 | /* Temporarily patch the VCD channel's name. */ | |
1008 | *open_pos = '\0'; | |
1009 | vcd_ch->base_name = g_strdup(vcd_ch->name); | |
1010 | *open_pos = '['; | |
1011 | vcd_ch->range_lower = lower; | |
1012 | vcd_ch->range_upper = upper; | |
1013 | } | |
1014 | } | |
1015 | has_range = vcd_ch->range_lower + vcd_ch->range_upper; | |
1016 | if (has_range && idx >= vcd_ch->size) | |
1017 | has_range = FALSE; | |
1018 | if (!has_range) | |
1019 | return g_strdup_printf("%s.%zu", vcd_ch->name, idx); | |
1020 | ||
1021 | /* | |
1022 | * Create a sigrok channel name with just the bit's index in | |
1023 | * brackets. This avoids "name[7:0].3" results, instead results | |
1024 | * in "name[3]". | |
1025 | */ | |
1026 | ch_name = g_strdup_printf("%s[%zu]", | |
1027 | vcd_ch->base_name, vcd_ch->range_lower + idx); | |
1028 | return ch_name; | |
1029 | } | |
1030 | ||
1031 | /* | |
1032 | * Create (analog or logic) sigrok channels for the VCD signals. Create | |
1033 | * multiple sigrok channels for vector input since sigrok has no concept | |
1034 | * of multi-bit signals. Create a channel group for the vector's bits | |
1035 | * though to reflect that they form a unit. This is beneficial when UIs | |
1036 | * support optional "collapsed" displays of channel groups (like | |
1037 | * "parallel bus, hex output"). | |
1038 | * | |
1039 | * Defer channel creation until after completion of parsing the input | |
1040 | * file header. Make sure to create all logic channels first before the | |
1041 | * analog channels get created. This avoids issues with the mapping of | |
1042 | * channel indices to bitmap positions in the sample buffer. | |
1043 | */ | |
1044 | static void create_channels(const struct sr_input *in, | |
1045 | struct sr_dev_inst *sdi, enum sr_channeltype ch_type) | |
1046 | { | |
1047 | struct context *inc; | |
1048 | size_t ch_idx; | |
1049 | GSList *l; | |
1050 | struct vcd_channel *vcd_ch; | |
1051 | size_t size_idx; | |
1052 | char *ch_name; | |
1053 | struct sr_channel_group *cg; | |
1054 | struct sr_channel *ch; | |
1055 | ||
1056 | inc = in->priv; | |
1057 | ||
1058 | ch_idx = 0; | |
1059 | if (ch_type > SR_CHANNEL_LOGIC) | |
1060 | ch_idx += inc->logic_count; | |
1061 | if (ch_type > SR_CHANNEL_ANALOG) | |
1062 | ch_idx += inc->analog_count; | |
1063 | for (l = inc->channels; l; l = l->next) { | |
1064 | vcd_ch = l->data; | |
1065 | if (vcd_ch->type != ch_type) | |
1066 | continue; | |
1067 | cg = NULL; | |
1068 | if (vcd_ch->size != 1) { | |
1069 | cg = g_malloc0(sizeof(*cg)); | |
1070 | cg->name = g_strdup(vcd_ch->name); | |
1071 | } | |
1072 | for (size_idx = 0; size_idx < vcd_ch->size; size_idx++) { | |
1073 | ch_name = get_channel_name(vcd_ch, size_idx); | |
1074 | sr_dbg("sigrok channel idx %zu, name %s, type %s, en %d.", | |
1075 | ch_idx, ch_name, | |
1076 | ch_type == SR_CHANNEL_ANALOG ? "A" : "L", TRUE); | |
1077 | ch = sr_channel_new(sdi, ch_idx, ch_type, TRUE, ch_name); | |
1078 | g_free(ch_name); | |
1079 | ch_idx++; | |
1080 | if (cg) | |
1081 | cg->channels = g_slist_append(cg->channels, ch); | |
1082 | } | |
1083 | if (cg) | |
1084 | sdi->channel_groups = g_slist_append(sdi->channel_groups, cg); | |
1085 | } | |
1086 | } | |
1087 | ||
1088 | static void create_feeds(const struct sr_input *in) | |
1089 | { | |
1090 | struct context *inc; | |
1091 | GSList *l; | |
1092 | struct vcd_channel *vcd_ch; | |
1093 | size_t ch_idx; | |
1094 | struct sr_channel *ch; | |
1095 | ||
1096 | inc = in->priv; | |
1097 | ||
1098 | /* Create one feed for logic data. */ | |
1099 | if (inc->logic_count) { | |
1100 | inc->unit_size = (inc->logic_count + 7) / 8; | |
1101 | inc->feed_logic = feed_queue_logic_alloc(in->sdi, | |
1102 | CHUNK_SIZE / inc->unit_size, inc->unit_size); | |
1103 | } | |
1104 | ||
1105 | /* Create one feed per analog channel. */ | |
1106 | for (l = inc->channels; l; l = l->next) { | |
1107 | vcd_ch = l->data; | |
1108 | if (vcd_ch->type != SR_CHANNEL_ANALOG) | |
1109 | continue; | |
1110 | ch_idx = vcd_ch->array_index; | |
1111 | ch_idx += inc->logic_count; | |
1112 | ch = g_slist_nth_data(in->sdi->channels, ch_idx); | |
1113 | vcd_ch->feed_analog = feed_queue_analog_alloc(in->sdi, | |
1114 | CHUNK_SIZE / sizeof(float), | |
1115 | vcd_ch->submit_digits, ch); | |
1116 | } | |
1117 | } | |
1118 | ||
1119 | /* | |
1120 | * Keep track of a previously created channel list, in preparation of | |
1121 | * re-reading the input file. Gets called from reset()/cleanup() paths. | |
1122 | */ | |
1123 | static void keep_header_for_reread(const struct sr_input *in) | |
1124 | { | |
1125 | struct context *inc; | |
1126 | ||
1127 | inc = in->priv; | |
1128 | ||
1129 | g_slist_free_full(inc->prev.sr_groups, cg_free); | |
1130 | inc->prev.sr_groups = in->sdi->channel_groups; | |
1131 | in->sdi->channel_groups = NULL; | |
1132 | ||
1133 | g_slist_free_full(inc->prev.sr_channels, sr_channel_free_cb); | |
1134 | inc->prev.sr_channels = in->sdi->channels; | |
1135 | in->sdi->channels = NULL; | |
1136 | } | |
1137 | ||
1138 | /* | |
1139 | * Check whether the input file is being re-read, and refuse operation | |
1140 | * when essential parameters of the acquisition have changed in ways | |
1141 | * that are unexpected to calling applications. Gets called after the | |
1142 | * file header got parsed (again). | |
1143 | * | |
1144 | * Changing the channel list across re-imports of the same file is not | |
1145 | * supported, by design and for valid reasons, see bug #1215 for details. | |
1146 | * Users are expected to start new sessions when they change these | |
1147 | * essential parameters in the acquisition's setup. When we accept the | |
1148 | * re-read file, then make sure to keep using the previous channel list, | |
1149 | * applications may still reference them. | |
1150 | */ | |
1151 | static gboolean check_header_in_reread(const struct sr_input *in) | |
1152 | { | |
1153 | struct context *inc; | |
1154 | ||
1155 | if (!in) | |
1156 | return FALSE; | |
1157 | inc = in->priv; | |
1158 | if (!inc) | |
1159 | return FALSE; | |
1160 | if (!inc->prev.sr_channels) | |
1161 | return TRUE; | |
1162 | ||
1163 | if (sr_channel_lists_differ(inc->prev.sr_channels, in->sdi->channels)) { | |
1164 | sr_err("Channel list change not supported for file re-read."); | |
1165 | return FALSE; | |
1166 | } | |
1167 | ||
1168 | g_slist_free_full(in->sdi->channel_groups, cg_free); | |
1169 | in->sdi->channel_groups = inc->prev.sr_groups; | |
1170 | inc->prev.sr_groups = NULL; | |
1171 | ||
1172 | g_slist_free_full(in->sdi->channels, sr_channel_free_cb); | |
1173 | in->sdi->channels = inc->prev.sr_channels; | |
1174 | inc->prev.sr_channels = NULL; | |
1175 | ||
1176 | return TRUE; | |
1177 | } | |
1178 | ||
1179 | /* Parse VCD file header sections (rate and variables declarations). */ | |
1180 | static int parse_header(const struct sr_input *in, GString *buf) | |
1181 | { | |
1182 | struct context *inc; | |
1183 | gboolean status; | |
1184 | char *name, *contents; | |
1185 | size_t size; | |
1186 | int ret; | |
1187 | ||
1188 | inc = in->priv; | |
1189 | ||
1190 | /* Parse sections until complete header was seen. */ | |
1191 | status = FALSE; | |
1192 | name = contents = NULL; | |
1193 | inc->conv_bits.max_bits = 1; | |
1194 | while (parse_section(buf, &name, &contents)) { | |
1195 | sr_dbg("Section '%s', contents '%s'.", name, contents); | |
1196 | ||
1197 | if (g_strcmp0(name, "enddefinitions") == 0) { | |
1198 | status = TRUE; | |
1199 | goto done_section; | |
1200 | } | |
1201 | if (g_strcmp0(name, "timescale") == 0) { | |
1202 | if (parse_timescale(inc, contents) != SR_OK) | |
1203 | status = FALSE; | |
1204 | goto done_section; | |
1205 | } | |
1206 | if (g_strcmp0(name, "scope") == 0) { | |
1207 | if (parse_scope(inc, contents, FALSE) != SR_OK) | |
1208 | status = FALSE; | |
1209 | goto done_section; | |
1210 | } | |
1211 | if (g_strcmp0(name, "upscope") == 0) { | |
1212 | if (parse_scope(inc, NULL, TRUE) != SR_OK) | |
1213 | status = FALSE; | |
1214 | goto done_section; | |
1215 | } | |
1216 | if (g_strcmp0(name, "var") == 0) { | |
1217 | if (parse_header_var(inc, contents) != SR_OK) | |
1218 | status = FALSE; | |
1219 | goto done_section; | |
1220 | } | |
1221 | ||
1222 | done_section: | |
1223 | g_free(name); | |
1224 | name = NULL; | |
1225 | g_free(contents); | |
1226 | contents = NULL; | |
1227 | ||
1228 | if (status) | |
1229 | break; | |
1230 | } | |
1231 | g_free(name); | |
1232 | g_free(contents); | |
1233 | ||
1234 | inc->got_header = status; | |
1235 | if (!status) | |
1236 | return SR_ERR_DATA; | |
1237 | ||
1238 | /* Create sigrok channels here, late, logic before analog. */ | |
1239 | create_channels(in, in->sdi, SR_CHANNEL_LOGIC); | |
1240 | create_channels(in, in->sdi, SR_CHANNEL_ANALOG); | |
1241 | if (!check_header_in_reread(in)) | |
1242 | return SR_ERR_DATA; | |
1243 | create_feeds(in); | |
1244 | ||
1245 | /* | |
1246 | * Allocate space for text to number conversion, and buffers to | |
1247 | * hold current sample values before submission to the session | |
1248 | * feed. Allocate one buffer for all logic bits, and another for | |
1249 | * all floating point values of all analog channels. | |
1250 | * | |
1251 | * The buffers get updated when the VCD input stream communicates | |
1252 | * value changes. Upon reception of VCD timestamps, the buffer can | |
1253 | * provide the previously received values, to "fill in the gaps" | |
1254 | * in the generation of a continuous stream of samples for the | |
1255 | * sigrok session. | |
1256 | */ | |
1257 | size = (inc->conv_bits.max_bits + 7) / 8; | |
1258 | inc->conv_bits.unit_size = size; | |
1259 | inc->conv_bits.value = g_malloc0(size); | |
1260 | if (!inc->conv_bits.value) | |
1261 | return SR_ERR_MALLOC; | |
1262 | ||
1263 | size = (inc->logic_count + 7) / 8; | |
1264 | inc->unit_size = size; | |
1265 | inc->current_logic = g_malloc0(size); | |
1266 | if (inc->unit_size && !inc->current_logic) | |
1267 | return SR_ERR_MALLOC; | |
1268 | size = sizeof(inc->current_floats[0]) * inc->analog_count; | |
1269 | inc->current_floats = g_malloc0(size); | |
1270 | if (size && !inc->current_floats) | |
1271 | return SR_ERR_MALLOC; | |
1272 | for (size = 0; size < inc->analog_count; size++) | |
1273 | inc->current_floats[size] = 0.; | |
1274 | ||
1275 | ret = ts_stats_prep(inc); | |
1276 | if (ret != SR_OK) | |
1277 | return ret; | |
1278 | ||
1279 | return SR_OK; | |
1280 | } | |
1281 | ||
1282 | /* | |
1283 | * Add N copies of previously received values to the session, before | |
1284 | * subsequent value changes will update the data buffer. Locally buffer | |
1285 | * sample data to minimize the number of send() calls. | |
1286 | */ | |
1287 | static void add_samples(const struct sr_input *in, size_t count, gboolean flush) | |
1288 | { | |
1289 | struct context *inc; | |
1290 | GSList *ch_list; | |
1291 | struct vcd_channel *vcd_ch; | |
1292 | struct feed_queue_analog *q; | |
1293 | float value; | |
1294 | ||
1295 | inc = in->priv; | |
1296 | ||
1297 | if (inc->logic_count) { | |
1298 | feed_queue_logic_submit(inc->feed_logic, | |
1299 | inc->current_logic, count); | |
1300 | if (flush) | |
1301 | feed_queue_logic_flush(inc->feed_logic); | |
1302 | } | |
1303 | for (ch_list = inc->channels; ch_list; ch_list = ch_list->next) { | |
1304 | vcd_ch = ch_list->data; | |
1305 | if (vcd_ch->type != SR_CHANNEL_ANALOG) | |
1306 | continue; | |
1307 | q = vcd_ch->feed_analog; | |
1308 | if (!q) | |
1309 | continue; | |
1310 | value = inc->current_floats[vcd_ch->array_index]; | |
1311 | feed_queue_analog_submit(q, value, count); | |
1312 | if (flush) | |
1313 | feed_queue_analog_flush(q); | |
1314 | } | |
1315 | } | |
1316 | ||
1317 | static gint vcd_compare_id(gconstpointer a, gconstpointer b) | |
1318 | { | |
1319 | return strcmp((const char *)a, (const char *)b); | |
1320 | } | |
1321 | ||
1322 | static gboolean is_ignored(struct context *inc, const char *id) | |
1323 | { | |
1324 | GSList *ignored; | |
1325 | ||
1326 | ignored = g_slist_find_custom(inc->ignored_signals, id, vcd_compare_id); | |
1327 | return ignored != NULL; | |
1328 | } | |
1329 | ||
1330 | /* | |
1331 | * Get an analog channel's value from a bit pattern (VCD 'integer' type). | |
1332 | * The implementation assumes a maximum integer width (64bit), the API | |
1333 | * doesn't (beyond the return data type). The use of SR_CHANNEL_ANALOG | |
1334 | * channels may further constraint the number of significant digits | |
1335 | * (current asumption: float -> 23bit). | |
1336 | */ | |
1337 | static float get_int_val(uint8_t *in_bits_data, size_t in_bits_count) | |
1338 | { | |
1339 | uint64_t int_value; | |
1340 | size_t byte_count, byte_idx; | |
1341 | float flt_value; /* typeof(inc->current_floats[0]) */ | |
1342 | ||
1343 | /* Convert bit pattern to integer number (limited range). */ | |
1344 | int_value = 0; | |
1345 | byte_count = (in_bits_count + 7) / 8; | |
1346 | for (byte_idx = 0; byte_idx < byte_count; byte_idx++) { | |
1347 | if (byte_idx >= sizeof(int_value)) | |
1348 | break; | |
1349 | int_value |= *in_bits_data++ << (byte_idx * 8); | |
1350 | } | |
1351 | flt_value = int_value; | |
1352 | ||
1353 | return flt_value; | |
1354 | } | |
1355 | ||
1356 | /* | |
1357 | * Set a logic channel's level depending on the VCD signal's identifier | |
1358 | * and parsed value. Multi-bit VCD values will affect several sigrok | |
1359 | * channels. One VCD signal name can translate to several sigrok channels. | |
1360 | */ | |
1361 | static void process_bits(struct context *inc, char *identifier, | |
1362 | uint8_t *in_bits_data, size_t in_bits_count) | |
1363 | { | |
1364 | size_t size; | |
1365 | gboolean have_int; | |
1366 | GSList *l; | |
1367 | struct vcd_channel *vcd_ch; | |
1368 | float int_val; | |
1369 | size_t bit_idx; | |
1370 | uint8_t *in_bit_ptr, in_bit_mask; | |
1371 | uint8_t *out_bit_ptr, out_bit_mask; | |
1372 | uint8_t bit_val; | |
1373 | ||
1374 | size = 0; | |
1375 | have_int = FALSE; | |
1376 | int_val = 0; | |
1377 | for (l = inc->channels; l; l = l->next) { | |
1378 | vcd_ch = l->data; | |
1379 | if (g_strcmp0(identifier, vcd_ch->identifier) != 0) | |
1380 | continue; | |
1381 | if (vcd_ch->type == SR_CHANNEL_ANALOG) { | |
1382 | /* Special case for 'integer' VCD signal types. */ | |
1383 | size = vcd_ch->size; /* Flag for "VCD signal found". */ | |
1384 | if (!have_int) { | |
1385 | int_val = get_int_val(in_bits_data, in_bits_count); | |
1386 | have_int = TRUE; | |
1387 | } | |
1388 | inc->current_floats[vcd_ch->array_index] = int_val; | |
1389 | continue; | |
1390 | } | |
1391 | if (vcd_ch->type != SR_CHANNEL_LOGIC) | |
1392 | continue; | |
1393 | sr_spew("Processing %s data, id '%s', ch %zu sz %zu", | |
1394 | (size == 1) ? "bit" : "vector", | |
1395 | identifier, vcd_ch->array_index, vcd_ch->size); | |
1396 | ||
1397 | /* Found our (logic) channel. Setup in/out bit positions. */ | |
1398 | size = vcd_ch->size; | |
1399 | in_bit_ptr = in_bits_data; | |
1400 | in_bit_mask = 1 << 0; | |
1401 | out_bit_ptr = &inc->current_logic[vcd_ch->byte_idx]; | |
1402 | out_bit_mask = vcd_ch->bit_mask; | |
1403 | ||
1404 | /* | |
1405 | * Pass VCD input bit(s) to sigrok logic bits. Conversion | |
1406 | * must be done repeatedly because one VCD signal name | |
1407 | * can translate to several sigrok channels, and shifting | |
1408 | * a previously computed bit field to another channel's | |
1409 | * position in the buffer would be nearly as expensive, | |
1410 | * and certain would increase complexity of the code. | |
1411 | */ | |
1412 | for (bit_idx = 0; bit_idx < size; bit_idx++) { | |
1413 | /* Get the bit value from input data. */ | |
1414 | bit_val = 0; | |
1415 | if (bit_idx < in_bits_count) { | |
1416 | bit_val = *in_bit_ptr & in_bit_mask; | |
1417 | in_bit_mask <<= 1; | |
1418 | if (!in_bit_mask) { | |
1419 | in_bit_mask = 1 << 0; | |
1420 | in_bit_ptr++; | |
1421 | } | |
1422 | } | |
1423 | /* Manipulate the sample buffer data image. */ | |
1424 | if (bit_val) | |
1425 | *out_bit_ptr |= out_bit_mask; | |
1426 | else | |
1427 | *out_bit_ptr &= ~out_bit_mask; | |
1428 | /* Update output position after bitmap update. */ | |
1429 | out_bit_mask <<= 1; | |
1430 | if (!out_bit_mask) { | |
1431 | out_bit_mask = 1 << 0; | |
1432 | out_bit_ptr++; | |
1433 | } | |
1434 | } | |
1435 | } | |
1436 | if (!size && !is_ignored(inc, identifier)) | |
1437 | sr_warn("VCD signal not found for ID '%s'.", identifier); | |
1438 | } | |
1439 | ||
1440 | /* | |
1441 | * Set an analog channel's value from a floating point number. One | |
1442 | * VCD signal name can translate to several sigrok channels. | |
1443 | */ | |
1444 | static void process_real(struct context *inc, char *identifier, float real_val) | |
1445 | { | |
1446 | gboolean found; | |
1447 | GSList *l; | |
1448 | struct vcd_channel *vcd_ch; | |
1449 | ||
1450 | found = FALSE; | |
1451 | for (l = inc->channels; l; l = l->next) { | |
1452 | vcd_ch = l->data; | |
1453 | if (vcd_ch->type != SR_CHANNEL_ANALOG) | |
1454 | continue; | |
1455 | if (g_strcmp0(identifier, vcd_ch->identifier) != 0) | |
1456 | continue; | |
1457 | ||
1458 | /* Found our (analog) channel. */ | |
1459 | found = TRUE; | |
1460 | sr_spew("Processing real data, id '%s', ch %zu, val %.16g", | |
1461 | identifier, vcd_ch->array_index, real_val); | |
1462 | inc->current_floats[vcd_ch->array_index] = real_val; | |
1463 | } | |
1464 | if (!found && !is_ignored(inc, identifier)) | |
1465 | sr_warn("VCD signal not found for ID '%s'.", identifier); | |
1466 | } | |
1467 | ||
1468 | /* | |
1469 | * Converts a bit position's text character to a number value. | |
1470 | * | |
1471 | * TODO Check for complete coverage of Verilog's standard logic values | |
1472 | * (IEEE-1364). The set is said to be “01XZHUWL-”, which only a part of | |
1473 | * is handled here. What would be the complete mapping? | |
1474 | * - 0/L -> bit value 0 | |
1475 | * - 1/H -> bit value 1 | |
1476 | * - X "don't care" -> TODO | |
1477 | * - Z "high impedance" -> TODO | |
1478 | * - W "weak(?)" -> TODO | |
1479 | * - U "undefined" -> TODO | |
1480 | * - '-' "TODO" -> TODO | |
1481 | * | |
1482 | * For simplicity, this input module implementation maps "known low" | |
1483 | * values to 0, and "known high" values to 1. All other values will | |
1484 | * end up assuming "low" (return number 0), while callers might warn. | |
1485 | * It's up to users to provide compatible input data, or accept the | |
1486 | * warnings. Silently accepting unknown input data is not desirable. | |
1487 | */ | |
1488 | static uint8_t vcd_char_to_value(char bit_char, int *warn) | |
1489 | { | |
1490 | ||
1491 | bit_char = g_ascii_tolower(bit_char); | |
1492 | ||
1493 | /* Convert the "undisputed" variants. */ | |
1494 | if (bit_char == '0' || bit_char == 'l') | |
1495 | return 0; | |
1496 | if (bit_char == '1' || bit_char == 'h') | |
1497 | return 1; | |
1498 | ||
1499 | /* Convert the "uncertain" variants. */ | |
1500 | if (warn) | |
1501 | *warn = 1; | |
1502 | if (bit_char == 'x' || bit_char == 'z') | |
1503 | return 0; | |
1504 | if (bit_char == 'u') | |
1505 | return 0; | |
1506 | if (bit_char == '-') | |
1507 | return 0; | |
1508 | ||
1509 | /* Unhandled input text. */ | |
1510 | return ~0; | |
1511 | } | |
1512 | ||
1513 | /* Parse one text line of the data section. */ | |
1514 | static int parse_textline(const struct sr_input *in, char *lines) | |
1515 | { | |
1516 | struct context *inc; | |
1517 | int ret; | |
1518 | char **words; | |
1519 | size_t word_count, word_idx; | |
1520 | char *curr_word, *next_word, curr_first; | |
1521 | gboolean is_timestamp, is_section, is_real, is_multibit, is_singlebit; | |
1522 | uint64_t timestamp; | |
1523 | char *identifier, *endptr; | |
1524 | size_t count; | |
1525 | ||
1526 | inc = in->priv; | |
1527 | ||
1528 | /* | |
1529 | * Split the caller's text lines into a list of space separated | |
1530 | * words. Note that some of the branches consume the very next | |
1531 | * words as well, and assume that both adjacent words will be | |
1532 | * available when the first word is seen. This constraint applies | |
1533 | * to bit vector data, multi-bit integers and real (float) data, | |
1534 | * as well as single-bit data with whitespace before its | |
1535 | * identifier (if that's valid in VCD, we'd accept it here). | |
1536 | * The fact that callers always pass complete text lines should | |
1537 | * make this assumption acceptable. | |
1538 | */ | |
1539 | ret = SR_OK; | |
1540 | words = split_text_line(inc, lines, &word_count); | |
1541 | for (word_idx = 0; word_idx < word_count; word_idx++) { | |
1542 | /* | |
1543 | * Make the next two words available, to simpilify code | |
1544 | * paths below. The second word is optional here. | |
1545 | */ | |
1546 | curr_word = words[word_idx]; | |
1547 | if (!curr_word && !curr_word[0]) | |
1548 | continue; | |
1549 | curr_first = g_ascii_tolower(curr_word[0]); | |
1550 | next_word = words[word_idx + 1]; | |
1551 | if (next_word && !next_word[0]) | |
1552 | next_word = NULL; | |
1553 | ||
1554 | /* | |
1555 | * Optionally skip some sections that can be interleaved | |
1556 | * with data (and may or may not be supported by this | |
1557 | * input module). If the section is not skipped but the | |
1558 | * $end keyword needs to get tracked, specifically handle | |
1559 | * this case, for improved robustness (still reject files | |
1560 | * which happen to use invalid syntax). | |
1561 | */ | |
1562 | if (inc->skip_until_end) { | |
1563 | if (strcmp(curr_word, "$end") == 0) { | |
1564 | /* Done with unhandled/unknown section. */ | |
1565 | sr_dbg("done skipping until $end"); | |
1566 | inc->skip_until_end = FALSE; | |
1567 | } else { | |
1568 | sr_spew("skipping word: %s", curr_word); | |
1569 | } | |
1570 | continue; | |
1571 | } | |
1572 | if (inc->ignore_end_keyword) { | |
1573 | if (strcmp(curr_word, "$end") == 0) { | |
1574 | sr_dbg("done ignoring $end keyword"); | |
1575 | inc->ignore_end_keyword = FALSE; | |
1576 | continue; | |
1577 | } | |
1578 | } | |
1579 | ||
1580 | /* | |
1581 | * There may be $keyword sections inside the data part of | |
1582 | * the input file. Do inspect some of the sections' content | |
1583 | * but ignore their surrounding keywords. Silently skip | |
1584 | * unsupported section types (which transparently covers | |
1585 | * $comment sections). | |
1586 | */ | |
1587 | is_section = curr_first == '$' && curr_word[1]; | |
1588 | if (is_section) { | |
1589 | gboolean inspect_data; | |
1590 | ||
1591 | inspect_data = FALSE; | |
1592 | inspect_data |= g_strcmp0(curr_word, "$dumpvars") == 0; | |
1593 | inspect_data |= g_strcmp0(curr_word, "$dumpon") == 0; | |
1594 | inspect_data |= g_strcmp0(curr_word, "$dumpoff") == 0; | |
1595 | if (inspect_data) { | |
1596 | /* Ignore keywords, yet parse contents. */ | |
1597 | sr_dbg("%s section, will parse content", curr_word); | |
1598 | inc->ignore_end_keyword = TRUE; | |
1599 | } else { | |
1600 | /* Ignore section from here up to $end. */ | |
1601 | sr_dbg("%s section, will skip until $end", curr_word); | |
1602 | inc->skip_until_end = TRUE; | |
1603 | } | |
1604 | continue; | |
1605 | } | |
1606 | ||
1607 | /* | |
1608 | * Numbers prefixed by '#' are timestamps, which translate | |
1609 | * to sigrok sample numbers. Apply optional downsampling, | |
1610 | * and apply the 'skip' logic. Check the recent timestamp | |
1611 | * for plausibility. Submit the corresponding number of | |
1612 | * samples of previously accumulated data values to the | |
1613 | * session feed. | |
1614 | */ | |
1615 | is_timestamp = curr_first == '#' && g_ascii_isdigit(curr_word[1]); | |
1616 | if (is_timestamp) { | |
1617 | endptr = NULL; | |
1618 | timestamp = strtoull(&curr_word[1], &endptr, 10); | |
1619 | if (!endptr || *endptr) { | |
1620 | sr_err("Invalid timestamp: %s.", curr_word); | |
1621 | ret = SR_ERR_DATA; | |
1622 | break; | |
1623 | } | |
1624 | sr_spew("Got timestamp: %" PRIu64, timestamp); | |
1625 | ret = ts_stats_check(&inc->ts_stats, timestamp); | |
1626 | if (ret != SR_OK) | |
1627 | break; | |
1628 | if (inc->options.downsample > 1) { | |
1629 | timestamp /= inc->options.downsample; | |
1630 | sr_spew("Downsampled timestamp: %" PRIu64, timestamp); | |
1631 | } | |
1632 | ||
1633 | /* | |
1634 | * Skip < 0 => skip until first timestamp. | |
1635 | * Skip = 0 => don't skip | |
1636 | * Skip > 0 => skip until timestamp >= skip. | |
1637 | */ | |
1638 | if (inc->options.skip_specified && !inc->use_skip) { | |
1639 | sr_dbg("Seeding skip from user spec %" PRIu64, | |
1640 | inc->options.skip_starttime); | |
1641 | inc->prev_timestamp = inc->options.skip_starttime; | |
1642 | inc->use_skip = TRUE; | |
1643 | } | |
1644 | if (!inc->use_skip) { | |
1645 | sr_dbg("Seeding skip from first timestamp"); | |
1646 | inc->options.skip_starttime = timestamp; | |
1647 | inc->prev_timestamp = timestamp; | |
1648 | inc->use_skip = TRUE; | |
1649 | continue; | |
1650 | } | |
1651 | if (inc->options.skip_starttime && timestamp < inc->options.skip_starttime) { | |
1652 | sr_spew("Timestamp skipped, before user spec"); | |
1653 | inc->prev_timestamp = inc->options.skip_starttime; | |
1654 | continue; | |
1655 | } | |
1656 | if (timestamp == inc->prev_timestamp) { | |
1657 | /* | |
1658 | * Ignore repeated timestamps (e.g. sigrok | |
1659 | * outputs these). Can also happen when | |
1660 | * downsampling makes distinct input values | |
1661 | * end up at the same scaled down value. | |
1662 | * Also transparently covers the initial | |
1663 | * timestamp. | |
1664 | */ | |
1665 | sr_spew("Timestamp is identical to previous timestamp"); | |
1666 | continue; | |
1667 | } | |
1668 | if (timestamp < inc->prev_timestamp) { | |
1669 | sr_err("Invalid timestamp: %" PRIu64 " (leap backwards).", timestamp); | |
1670 | ret = SR_ERR_DATA; | |
1671 | break; | |
1672 | } | |
1673 | if (inc->options.compress) { | |
1674 | /* Compress long idle periods */ | |
1675 | count = timestamp - inc->prev_timestamp; | |
1676 | if (count > inc->options.compress) { | |
1677 | sr_dbg("Long idle period, compressing"); | |
1678 | count = timestamp - inc->options.compress; | |
1679 | inc->prev_timestamp = count; | |
1680 | } | |
1681 | } | |
1682 | ||
1683 | /* Generate samples from prev_timestamp up to timestamp - 1. */ | |
1684 | count = timestamp - inc->prev_timestamp; | |
1685 | sr_spew("Got a new timestamp, feeding %zu samples", count); | |
1686 | add_samples(in, count, FALSE); | |
1687 | inc->prev_timestamp = timestamp; | |
1688 | inc->data_after_timestamp = FALSE; | |
1689 | continue; | |
1690 | } | |
1691 | inc->data_after_timestamp = TRUE; | |
1692 | ||
1693 | /* | |
1694 | * Data values come in different formats, are associated | |
1695 | * with channel identifiers, and correspond to the period | |
1696 | * of time from the most recent timestamp to the next | |
1697 | * timestamp. | |
1698 | * | |
1699 | * Supported input data formats are: | |
1700 | * - R<value> <sep> <id> (analog channel, VCD type 'real'). | |
1701 | * - B<value> <sep> <id> (analog channel, VCD type 'integer'). | |
1702 | * - B<value> <sep> <id> (logic channels, VCD bit vectors). | |
1703 | * - <value> <id> (logic channel, VCD single-bit values). | |
1704 | * | |
1705 | * Input values can be: | |
1706 | * - Floating point numbers. | |
1707 | * - Bit strings (which covers multi-bit aka integers | |
1708 | * as well as vectors). | |
1709 | * - Single bits. | |
1710 | * | |
1711 | * Things to note: | |
1712 | * - Individual bits can be 0/1 which is supported by | |
1713 | * libsigrok, or x or z which is treated like 0 here | |
1714 | * (sigrok lacks support for ternary logic, neither is | |
1715 | * there support for the full IEEE set of values). | |
1716 | * - Single-bit values typically won't be separated from | |
1717 | * the signal identifer, multi-bit values and floats | |
1718 | * are separated (will reference the next word). This | |
1719 | * implementation silently accepts separators for | |
1720 | * single-bit values, too. | |
1721 | */ | |
1722 | is_real = curr_first == 'r' && curr_word[1]; | |
1723 | is_multibit = curr_first == 'b' && curr_word[1]; | |
1724 | is_singlebit = curr_first == '0' || curr_first == '1'; | |
1725 | is_singlebit |= curr_first == 'l' || curr_first == 'h'; | |
1726 | is_singlebit |= curr_first == 'x' || curr_first == 'z'; | |
1727 | is_singlebit |= curr_first == 'u' || curr_first == '-'; | |
1728 | if (is_real) { | |
1729 | char *real_text; | |
1730 | float real_val; | |
1731 | ||
1732 | real_text = &curr_word[1]; | |
1733 | identifier = next_word; | |
1734 | word_idx++; | |
1735 | if (!*real_text || !identifier || !*identifier) { | |
1736 | sr_err("Unexpected real format."); | |
1737 | ret = SR_ERR_DATA; | |
1738 | break; | |
1739 | } | |
1740 | sr_spew("Got real data %s for id '%s'.", | |
1741 | real_text, identifier); | |
1742 | if (sr_atof_ascii(real_text, &real_val) != SR_OK) { | |
1743 | sr_err("Cannot convert value: %s.", real_text); | |
1744 | ret = SR_ERR_DATA; | |
1745 | break; | |
1746 | } | |
1747 | process_real(inc, identifier, real_val); | |
1748 | continue; | |
1749 | } | |
1750 | if (is_multibit) { | |
1751 | char *bits_text_start; | |
1752 | size_t bit_count; | |
1753 | char *bits_text, bit_char; | |
1754 | uint8_t bit_value; | |
1755 | uint8_t *value_ptr, value_mask; | |
1756 | GString *bits_val_text; | |
1757 | ||
1758 | /* TODO | |
1759 | * Fold in single-bit code path here? To re-use | |
1760 | * the X/Z support. Current redundancy is few so | |
1761 | * there is little pressure to unify code paths. | |
1762 | * Also multi-bit handling is often different | |
1763 | * from single-bit handling, so the "unified" | |
1764 | * path would often check for special cases. So | |
1765 | * we may never unify code paths at all here. | |
1766 | */ | |
1767 | bits_text = &curr_word[1]; | |
1768 | identifier = next_word; | |
1769 | word_idx++; | |
1770 | ||
1771 | if (!*bits_text || !identifier || !*identifier) { | |
1772 | sr_err("Unexpected integer/vector format."); | |
1773 | ret = SR_ERR_DATA; | |
1774 | break; | |
1775 | } | |
1776 | sr_spew("Got integer/vector data %s for id '%s'.", | |
1777 | bits_text, identifier); | |
1778 | ||
1779 | /* | |
1780 | * Accept a bit string of arbitrary length (sort | |
1781 | * of, within the limits of the previously setup | |
1782 | * conversion buffer). The input text omits the | |
1783 | * leading zeroes, hence we convert from end to | |
1784 | * the start, to get the significant bits. There | |
1785 | * should only be errors for invalid input, or | |
1786 | * for input that is rather strange (data holds | |
1787 | * more bits than the signal's declaration in | |
1788 | * the header suggested). Silently accept data | |
1789 | * that fits in the conversion buffer, and has | |
1790 | * more significant bits than the signal's type | |
1791 | * (that'd be non-sence yet acceptable input). | |
1792 | */ | |
1793 | bits_text_start = bits_text; | |
1794 | bits_text += strlen(bits_text); | |
1795 | bit_count = bits_text - bits_text_start; | |
1796 | if (bit_count > inc->conv_bits.max_bits) { | |
1797 | sr_err("Value exceeds conversion buffer: %s", | |
1798 | bits_text_start); | |
1799 | ret = SR_ERR_DATA; | |
1800 | break; | |
1801 | } | |
1802 | memset(inc->conv_bits.value, 0, inc->conv_bits.unit_size); | |
1803 | value_ptr = &inc->conv_bits.value[0]; | |
1804 | value_mask = 1 << 0; | |
1805 | inc->conv_bits.sig_count = 0; | |
1806 | while (bits_text > bits_text_start) { | |
1807 | inc->conv_bits.sig_count++; | |
1808 | bit_char = *(--bits_text); | |
1809 | bit_value = vcd_char_to_value(bit_char, NULL); | |
1810 | if (bit_value == 0) { | |
1811 | /* EMPTY */ | |
1812 | } else if (bit_value == 1) { | |
1813 | *value_ptr |= value_mask; | |
1814 | } else { | |
1815 | inc->conv_bits.sig_count = 0; | |
1816 | break; | |
1817 | } | |
1818 | value_mask <<= 1; | |
1819 | if (!value_mask) { | |
1820 | value_ptr++; | |
1821 | value_mask = 1 << 0; | |
1822 | } | |
1823 | } | |
1824 | if (!inc->conv_bits.sig_count) { | |
1825 | sr_err("Unexpected vector format: %s", | |
1826 | bits_text_start); | |
1827 | ret = SR_ERR_DATA; | |
1828 | break; | |
1829 | } | |
1830 | if (sr_log_loglevel_get() >= SR_LOG_SPEW) { | |
1831 | bits_val_text = sr_hexdump_new(inc->conv_bits.value, | |
1832 | value_ptr - inc->conv_bits.value + 1); | |
1833 | sr_spew("Vector value: %s.", bits_val_text->str); | |
1834 | sr_hexdump_free(bits_val_text); | |
1835 | } | |
1836 | ||
1837 | process_bits(inc, identifier, | |
1838 | inc->conv_bits.value, inc->conv_bits.sig_count); | |
1839 | continue; | |
1840 | } | |
1841 | if (is_singlebit) { | |
1842 | char *bits_text, bit_char; | |
1843 | uint8_t bit_value; | |
1844 | ||
1845 | /* Get the value text, and signal identifier. */ | |
1846 | bits_text = &curr_word[0]; | |
1847 | bit_char = *bits_text; | |
1848 | if (!bit_char) { | |
1849 | sr_err("Bit value missing."); | |
1850 | ret = SR_ERR_DATA; | |
1851 | break; | |
1852 | } | |
1853 | identifier = ++bits_text; | |
1854 | if (!*identifier) { | |
1855 | identifier = next_word; | |
1856 | word_idx++; | |
1857 | } | |
1858 | if (!identifier || !*identifier) { | |
1859 | sr_err("Identifier missing."); | |
1860 | ret = SR_ERR_DATA; | |
1861 | break; | |
1862 | } | |
1863 | ||
1864 | /* Convert value text to single-bit number. */ | |
1865 | bit_value = vcd_char_to_value(bit_char, NULL); | |
1866 | if (bit_value != 0 && bit_value != 1) { | |
1867 | sr_err("Unsupported bit value '%c'.", bit_char); | |
1868 | ret = SR_ERR_DATA; | |
1869 | break; | |
1870 | } | |
1871 | inc->conv_bits.value[0] = bit_value; | |
1872 | process_bits(inc, identifier, inc->conv_bits.value, 1); | |
1873 | continue; | |
1874 | } | |
1875 | ||
1876 | /* Design choice: Consider unsupported input fatal. */ | |
1877 | sr_err("Unknown token '%s'.", curr_word); | |
1878 | ret = SR_ERR_DATA; | |
1879 | break; | |
1880 | } | |
1881 | free_text_split(inc, words); | |
1882 | ||
1883 | return ret; | |
1884 | } | |
1885 | ||
1886 | static int process_buffer(struct sr_input *in, gboolean is_eof) | |
1887 | { | |
1888 | struct context *inc; | |
1889 | uint64_t samplerate; | |
1890 | GVariant *gvar; | |
1891 | int ret; | |
1892 | char *rdptr, *endptr, *trimptr; | |
1893 | size_t rdlen; | |
1894 | ||
1895 | inc = in->priv; | |
1896 | ||
1897 | /* Send feed header and samplerate (once) before sample data. */ | |
1898 | if (!inc->started) { | |
1899 | std_session_send_df_header(in->sdi); | |
1900 | ||
1901 | samplerate = inc->samplerate / inc->options.downsample; | |
1902 | if (samplerate) { | |
1903 | gvar = g_variant_new_uint64(samplerate); | |
1904 | sr_session_send_meta(in->sdi, SR_CONF_SAMPLERATE, gvar); | |
1905 | } | |
1906 | ||
1907 | inc->started = TRUE; | |
1908 | } | |
1909 | ||
1910 | /* | |
1911 | * Workaround broken generators which output incomplete text | |
1912 | * lines. Enforce the trailing line feed. Proper input is not | |
1913 | * harmed by another empty line of input data. | |
1914 | */ | |
1915 | if (is_eof) | |
1916 | g_string_append_c(in->buf, '\n'); | |
1917 | ||
1918 | /* Find and process complete text lines in the input data. */ | |
1919 | ret = SR_OK; | |
1920 | rdptr = in->buf->str; | |
1921 | while (TRUE) { | |
1922 | rdlen = &in->buf->str[in->buf->len] - rdptr; | |
1923 | endptr = g_strstr_len(rdptr, rdlen, "\n"); | |
1924 | if (!endptr) | |
1925 | break; | |
1926 | trimptr = endptr; | |
1927 | *endptr++ = '\0'; | |
1928 | while (g_ascii_isspace(*rdptr)) | |
1929 | rdptr++; | |
1930 | while (trimptr > rdptr && g_ascii_isspace(trimptr[-1])) | |
1931 | *(--trimptr) = '\0'; | |
1932 | if (!*rdptr) { | |
1933 | rdptr = endptr; | |
1934 | continue; | |
1935 | } | |
1936 | ret = parse_textline(in, rdptr); | |
1937 | rdptr = endptr; | |
1938 | if (ret != SR_OK) | |
1939 | break; | |
1940 | } | |
1941 | rdlen = rdptr - in->buf->str; | |
1942 | g_string_erase(in->buf, 0, rdlen); | |
1943 | ||
1944 | return ret; | |
1945 | } | |
1946 | ||
1947 | static int format_match(GHashTable *metadata, unsigned int *confidence) | |
1948 | { | |
1949 | GString *buf, *tmpbuf; | |
1950 | gboolean status; | |
1951 | char *name, *contents; | |
1952 | ||
1953 | buf = g_hash_table_lookup(metadata, | |
1954 | GINT_TO_POINTER(SR_INPUT_META_HEADER)); | |
1955 | tmpbuf = g_string_new_len(buf->str, buf->len); | |
1956 | ||
1957 | /* | |
1958 | * If we can parse the first section correctly, then it is | |
1959 | * assumed that the input is in VCD format. | |
1960 | */ | |
1961 | check_remove_bom(tmpbuf); | |
1962 | status = parse_section(tmpbuf, &name, &contents); | |
1963 | g_string_free(tmpbuf, TRUE); | |
1964 | g_free(name); | |
1965 | g_free(contents); | |
1966 | ||
1967 | if (!status) | |
1968 | return SR_ERR; | |
1969 | ||
1970 | *confidence = 1; | |
1971 | return SR_OK; | |
1972 | } | |
1973 | ||
1974 | static int init(struct sr_input *in, GHashTable *options) | |
1975 | { | |
1976 | struct context *inc; | |
1977 | GVariant *data; | |
1978 | ||
1979 | inc = g_malloc0(sizeof(*inc)); | |
1980 | ||
1981 | data = g_hash_table_lookup(options, "numchannels"); | |
1982 | inc->options.maxchannels = g_variant_get_uint32(data); | |
1983 | ||
1984 | data = g_hash_table_lookup(options, "downsample"); | |
1985 | inc->options.downsample = g_variant_get_uint64(data); | |
1986 | if (inc->options.downsample < 1) | |
1987 | inc->options.downsample = 1; | |
1988 | ||
1989 | data = g_hash_table_lookup(options, "compress"); | |
1990 | inc->options.compress = g_variant_get_uint64(data); | |
1991 | inc->options.compress /= inc->options.downsample; | |
1992 | ||
1993 | data = g_hash_table_lookup(options, "skip"); | |
1994 | if (data) { | |
1995 | inc->options.skip_specified = TRUE; | |
1996 | inc->options.skip_starttime = g_variant_get_uint64(data); | |
1997 | if (inc->options.skip_starttime == ~UINT64_C(0)) { | |
1998 | inc->options.skip_specified = FALSE; | |
1999 | inc->options.skip_starttime = 0; | |
2000 | } | |
2001 | inc->options.skip_starttime /= inc->options.downsample; | |
2002 | } | |
2003 | ||
2004 | in->sdi = g_malloc0(sizeof(*in->sdi)); | |
2005 | in->priv = inc; | |
2006 | ||
2007 | inc->scope_prefix = g_string_new("\0"); | |
2008 | ||
2009 | return SR_OK; | |
2010 | } | |
2011 | ||
2012 | static int receive(struct sr_input *in, GString *buf) | |
2013 | { | |
2014 | struct context *inc; | |
2015 | int ret; | |
2016 | ||
2017 | inc = in->priv; | |
2018 | ||
2019 | /* Collect all input chunks, potential deferred processing. */ | |
2020 | g_string_append_len(in->buf, buf->str, buf->len); | |
2021 | if (!inc->got_header && in->buf->len == buf->len) | |
2022 | check_remove_bom(in->buf); | |
2023 | ||
2024 | /* Must complete reception of the VCD header first. */ | |
2025 | if (!inc->got_header) { | |
2026 | if (!have_header(in->buf)) | |
2027 | return SR_OK; | |
2028 | ret = parse_header(in, in->buf); | |
2029 | if (ret != SR_OK) | |
2030 | return ret; | |
2031 | /* sdi is ready, notify frontend. */ | |
2032 | in->sdi_ready = TRUE; | |
2033 | return SR_OK; | |
2034 | } | |
2035 | ||
2036 | /* Process sample data. */ | |
2037 | ret = process_buffer(in, FALSE); | |
2038 | ||
2039 | return ret; | |
2040 | } | |
2041 | ||
2042 | static int end(struct sr_input *in) | |
2043 | { | |
2044 | struct context *inc; | |
2045 | int ret; | |
2046 | size_t count; | |
2047 | ||
2048 | inc = in->priv; | |
2049 | ||
2050 | /* Must complete processing of previously received chunks. */ | |
2051 | if (in->sdi_ready) | |
2052 | ret = process_buffer(in, TRUE); | |
2053 | else | |
2054 | ret = SR_OK; | |
2055 | ||
2056 | /* Flush most recently queued sample data when EOF is seen. */ | |
2057 | count = inc->data_after_timestamp ? 1 : 0; | |
2058 | add_samples(in, count, TRUE); | |
2059 | ||
2060 | /* Optionally suggest downsampling after all input data was seen. */ | |
2061 | (void)ts_stats_post(inc, !inc->data_after_timestamp); | |
2062 | ||
2063 | /* Must send DF_END when DF_HEADER was sent before. */ | |
2064 | if (inc->started) | |
2065 | std_session_send_df_end(in->sdi); | |
2066 | ||
2067 | return ret; | |
2068 | } | |
2069 | ||
2070 | static void cleanup(struct sr_input *in) | |
2071 | { | |
2072 | struct context *inc; | |
2073 | ||
2074 | inc = in->priv; | |
2075 | ||
2076 | keep_header_for_reread(in); | |
2077 | ||
2078 | g_slist_free_full(inc->channels, free_channel); | |
2079 | inc->channels = NULL; | |
2080 | feed_queue_logic_free(inc->feed_logic); | |
2081 | inc->feed_logic = NULL; | |
2082 | g_free(inc->conv_bits.value); | |
2083 | inc->conv_bits.value = NULL; | |
2084 | g_free(inc->current_logic); | |
2085 | inc->current_logic = NULL; | |
2086 | g_free(inc->current_floats); | |
2087 | inc->current_floats = NULL; | |
2088 | g_string_free(inc->scope_prefix, TRUE); | |
2089 | inc->scope_prefix = NULL; | |
2090 | g_slist_free_full(inc->ignored_signals, g_free); | |
2091 | inc->ignored_signals = NULL; | |
2092 | free_text_split(inc, NULL); | |
2093 | } | |
2094 | ||
2095 | static int reset(struct sr_input *in) | |
2096 | { | |
2097 | struct context *inc; | |
2098 | struct vcd_user_opt save; | |
2099 | struct vcd_prev prev; | |
2100 | ||
2101 | inc = in->priv; | |
2102 | ||
2103 | /* Relase previously allocated resources. */ | |
2104 | cleanup(in); | |
2105 | g_string_truncate(in->buf, 0); | |
2106 | ||
2107 | /* Restore part of the context, init() won't run again. */ | |
2108 | save = inc->options; | |
2109 | prev = inc->prev; | |
2110 | memset(inc, 0, sizeof(*inc)); | |
2111 | inc->options = save; | |
2112 | inc->prev = prev; | |
2113 | inc->scope_prefix = g_string_new("\0"); | |
2114 | ||
2115 | return SR_OK; | |
2116 | } | |
2117 | ||
2118 | enum vcd_option_t { | |
2119 | OPT_NUM_CHANS, | |
2120 | OPT_DOWN_SAMPLE, | |
2121 | OPT_SKIP_COUNT, | |
2122 | OPT_COMPRESS, | |
2123 | OPT_MAX, | |
2124 | }; | |
2125 | ||
2126 | static struct sr_option options[] = { | |
2127 | [OPT_NUM_CHANS] = { | |
2128 | "numchannels", "Max number of sigrok channels", | |
2129 | "The maximum number of sigrok channels to create for VCD input signals.", | |
2130 | NULL, NULL, | |
2131 | }, | |
2132 | [OPT_DOWN_SAMPLE] = { | |
2133 | "downsample", "Downsampling factor", | |
2134 | "Downsample the input file's samplerate, i.e. divide by the specified factor.", | |
2135 | NULL, NULL, | |
2136 | }, | |
2137 | [OPT_SKIP_COUNT] = { | |
2138 | "skip", "Skip this many initial samples", | |
2139 | "Skip samples until the specified timestamp. " | |
2140 | "By default samples start at the first timestamp in the file. " | |
2141 | "Value 0 creates samples starting at timestamp 0. " | |
2142 | "Values above 0 only start processing at the given timestamp.", | |
2143 | NULL, NULL, | |
2144 | }, | |
2145 | [OPT_COMPRESS] = { | |
2146 | "compress", "Compress idle periods", | |
2147 | "Compress idle periods which are longer than the specified number of timescale ticks.", | |
2148 | NULL, NULL, | |
2149 | }, | |
2150 | [OPT_MAX] = ALL_ZERO, | |
2151 | }; | |
2152 | ||
2153 | static const struct sr_option *get_options(void) | |
2154 | { | |
2155 | if (!options[0].def) { | |
2156 | options[OPT_NUM_CHANS].def = g_variant_ref_sink(g_variant_new_uint32(0)); | |
2157 | options[OPT_DOWN_SAMPLE].def = g_variant_ref_sink(g_variant_new_uint64(1)); | |
2158 | options[OPT_SKIP_COUNT].def = g_variant_ref_sink(g_variant_new_uint64(~UINT64_C(0))); | |
2159 | options[OPT_COMPRESS].def = g_variant_ref_sink(g_variant_new_uint64(0)); | |
2160 | } | |
2161 | ||
2162 | return options; | |
2163 | } | |
2164 | ||
2165 | SR_PRIV struct sr_input_module input_vcd = { | |
2166 | .id = "vcd", | |
2167 | .name = "VCD", | |
2168 | .desc = "Value Change Dump data", | |
2169 | .exts = (const char*[]){"vcd", NULL}, | |
2170 | .metadata = { SR_INPUT_META_HEADER | SR_INPUT_META_REQUIRED }, | |
2171 | .options = get_options, | |
2172 | .format_match = format_match, | |
2173 | .init = init, | |
2174 | .receive = receive, | |
2175 | .end = end, | |
2176 | .cleanup = cleanup, | |
2177 | .reset = reset, | |
2178 | }; |