]>
Commit | Line | Data |
---|---|---|
2be182e6 BV |
1 | /* |
2 | * This file is part of the sigrok-cli project. | |
3 | * | |
4 | * Copyright (C) 2013 Bert Vermeulen <bert@biot.com> | |
5 | * | |
6 | * This program is free software: you can redistribute it and/or modify | |
7 | * it under the terms of the GNU General Public License as published by | |
8 | * the Free Software Foundation, either version 3 of the License, or | |
9 | * (at your option) any later version. | |
10 | * | |
11 | * This program is distributed in the hope that it will be useful, | |
12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
14 | * GNU General Public License for more details. | |
15 | * | |
16 | * You should have received a copy of the GNU General Public License | |
17 | * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
18 | */ | |
19 | ||
d486cbdd | 20 | #include <config.h> |
f0f54487 UH |
21 | #include <stdlib.h> |
22 | #include <string.h> | |
2be182e6 | 23 | #include <glib.h> |
662a1e27 | 24 | #include "sigrok-cli.h" |
2be182e6 BV |
25 | |
26 | #ifdef HAVE_SRD | |
27 | static GHashTable *pd_ann_visible = NULL; | |
28 | static GHashTable *pd_meta_visible = NULL; | |
29 | static GHashTable *pd_binary_visible = NULL; | |
3dfbfbc8 | 30 | static GHashTable *pd_channel_maps = NULL; |
2be182e6 | 31 | |
69110b5c GS |
32 | uint64_t pd_samplerate = 0; |
33 | ||
2be182e6 | 34 | extern struct srd_session *srd_sess; |
2be182e6 | 35 | |
1f90599f GS |
36 | static const char *keyword_assign = "assign_channels"; |
37 | static const char *assign_by_index = "auto_index"; | |
38 | static const char *assign_by_name = "auto_names"; | |
39 | ||
2be182e6 BV |
40 | static int opts_to_gvar(struct srd_decoder *dec, GHashTable *hash, |
41 | GHashTable **options) | |
42 | { | |
43 | struct srd_decoder_option *o; | |
44 | GSList *optl; | |
45 | GVariant *gvar; | |
46 | gint64 val_int; | |
4c1a29f4 | 47 | double val_dbl; |
2be182e6 BV |
48 | int ret; |
49 | char *val_str, *conv; | |
50 | ||
51 | ret = TRUE; | |
52 | *options = g_hash_table_new_full(g_str_hash, g_str_equal, g_free, | |
53 | (GDestroyNotify)g_variant_unref); | |
54 | ||
55 | for (optl = dec->options; optl; optl = optl->next) { | |
56 | o = optl->data; | |
57 | if (!(val_str = g_hash_table_lookup(hash, o->id))) | |
58 | /* Not specified. */ | |
59 | continue; | |
60 | if (g_variant_is_of_type(o->def, G_VARIANT_TYPE_STRING)) { | |
61 | gvar = g_variant_new_string(val_str); | |
62 | } else if (g_variant_is_of_type(o->def, G_VARIANT_TYPE_INT64)) { | |
b5c8f3a1 | 63 | conv = NULL; |
2be182e6 | 64 | val_int = strtoll(val_str, &conv, 0); |
b5c8f3a1 | 65 | if (!conv || conv == val_str || *conv) { |
2be182e6 BV |
66 | g_critical("Protocol decoder '%s' option '%s' " |
67 | "requires a number.", dec->name, o->id); | |
68 | ret = FALSE; | |
69 | break; | |
70 | } | |
71 | gvar = g_variant_new_int64(val_int); | |
4c1a29f4 GS |
72 | } else if (g_variant_is_of_type(o->def, G_VARIANT_TYPE_DOUBLE)) { |
73 | conv = NULL; | |
74 | val_dbl = strtod(val_str, &conv); | |
75 | if (!conv || conv == val_str || *conv) { | |
76 | g_critical("Protocol decoder '%s' option '%s' requires a float number.", | |
77 | dec->name, o->id); | |
78 | ret = FALSE; | |
79 | break; | |
80 | } | |
81 | gvar = g_variant_new_double(val_dbl); | |
2be182e6 BV |
82 | } else { |
83 | g_critical("Unsupported type for option '%s' (%s)", | |
84 | o->id, g_variant_get_type_string(o->def)); | |
85 | ret = FALSE; | |
86 | break; | |
87 | } | |
88 | g_variant_ref_sink(gvar); | |
89 | g_hash_table_insert(*options, g_strdup(o->id), gvar); | |
90 | g_hash_table_remove(hash, o->id); | |
91 | } | |
92 | ||
93 | return ret; | |
94 | } | |
95 | ||
51cf9b2c | 96 | static int move_hash_element(GHashTable *src, GHashTable *dest, const void *key) |
2be182e6 | 97 | { |
39aedc34 DE |
98 | void *orig_key, *value; |
99 | ||
100 | if (!g_hash_table_lookup_extended(src, key, &orig_key, &value)) | |
101 | /* Not specified. */ | |
102 | return FALSE; | |
103 | g_hash_table_steal(src, orig_key); | |
104 | g_hash_table_insert(dest, orig_key, value); | |
105 | ||
106 | return TRUE; | |
107 | } | |
108 | ||
3dfbfbc8 | 109 | static GHashTable *extract_channel_map(struct srd_decoder *dec, GHashTable *hash) |
39aedc34 | 110 | { |
3dfbfbc8 UH |
111 | GHashTable *channel_map; |
112 | struct srd_channel *pdch; | |
39aedc34 | 113 | GSList *l; |
2be182e6 | 114 | |
3dfbfbc8 | 115 | channel_map = g_hash_table_new_full(g_str_hash, g_str_equal, |
39aedc34 | 116 | g_free, g_free); |
2be182e6 | 117 | |
1f90599f | 118 | move_hash_element(hash, channel_map, keyword_assign); |
3dfbfbc8 UH |
119 | for (l = dec->channels; l; l = l->next) { |
120 | pdch = l->data; | |
121 | move_hash_element(hash, channel_map, pdch->id); | |
39aedc34 | 122 | } |
3dfbfbc8 UH |
123 | for (l = dec->opt_channels; l; l = l->next) { |
124 | pdch = l->data; | |
125 | move_hash_element(hash, channel_map, pdch->id); | |
2be182e6 | 126 | } |
2be182e6 | 127 | |
3dfbfbc8 | 128 | return channel_map; |
2be182e6 BV |
129 | } |
130 | ||
551f570c | 131 | static int register_pd(char *opt_pds, char *opt_pd_annotations) |
2be182e6 | 132 | { |
551f570c | 133 | int ret; |
2be182e6 | 134 | struct srd_decoder *dec; |
551f570c KP |
135 | struct srd_decoder_inst *di, *di_prior; |
136 | char **pdtokens, **pdtok, *pd_name; | |
3dfbfbc8 | 137 | GHashTable *pd_opthash, *options, *channels; |
2be182e6 | 138 | GList *leftover, *l; |
2be182e6 | 139 | |
2be182e6 BV |
140 | ret = 0; |
141 | pd_name = NULL; | |
551f570c KP |
142 | di_prior = NULL; |
143 | pd_opthash = options = channels = NULL; | |
144 | ||
26c63758 | 145 | pdtokens = g_strsplit(opt_pds, ",", 0); |
2be182e6 | 146 | for (pdtok = pdtokens; *pdtok; pdtok++) { |
cad0cba6 | 147 | if (!(pd_opthash = parse_generic_arg(*pdtok, TRUE, NULL))) { |
2be182e6 BV |
148 | g_critical("Invalid protocol decoder option '%s'.", *pdtok); |
149 | break; | |
150 | } | |
151 | ||
152 | pd_name = g_strdup(g_hash_table_lookup(pd_opthash, "sigrok_key")); | |
153 | g_hash_table_remove(pd_opthash, "sigrok_key"); | |
154 | if (srd_decoder_load(pd_name) != SRD_OK) { | |
155 | g_critical("Failed to load protocol decoder %s.", pd_name); | |
156 | ret = 1; | |
157 | break; | |
158 | } | |
3a8ceb6a BV |
159 | if (!(dec = srd_decoder_get_by_id(pd_name))) { |
160 | g_critical("Failed to get decoder %s by id.", pd_name); | |
161 | ret = 1; | |
162 | break; | |
163 | } | |
2be182e6 | 164 | |
3dfbfbc8 | 165 | /* Convert decoder option and channel values to GVariant. */ |
2be182e6 BV |
166 | if (!opts_to_gvar(dec, pd_opthash, &options)) { |
167 | ret = 1; | |
168 | break; | |
169 | } | |
3dfbfbc8 | 170 | channels = extract_channel_map(dec, pd_opthash); |
39aedc34 | 171 | |
2be182e6 BV |
172 | if (g_hash_table_size(pd_opthash) > 0) { |
173 | leftover = g_hash_table_get_keys(pd_opthash); | |
174 | for (l = leftover; l; l = l->next) | |
3dfbfbc8 | 175 | g_critical("Unknown option or channel '%s'", (char *)l->data); |
2be182e6 BV |
176 | g_list_free(leftover); |
177 | break; | |
178 | } | |
179 | ||
180 | if (!(di = srd_inst_new(srd_sess, pd_name, options))) { | |
181 | g_critical("Failed to instantiate protocol decoder %s.", pd_name); | |
182 | ret = 1; | |
183 | break; | |
184 | } | |
185 | ||
09fea207 | 186 | if (pdtok == pdtokens) { |
3dfbfbc8 UH |
187 | /* |
188 | * Save the channel setup for later, but only on the | |
189 | * first decoder (stacked decoders don't get channels). | |
190 | */ | |
3dfbfbc8 UH |
191 | g_hash_table_insert(pd_channel_maps, g_strdup(di->inst_id), channels); |
192 | channels = NULL; | |
09fea207 | 193 | } |
39aedc34 | 194 | |
f0f54487 UH |
195 | /* |
196 | * If no annotation list was specified, add them all in now. | |
2be182e6 BV |
197 | * This will be pared down later to leave only the last PD |
198 | * in the stack. | |
199 | */ | |
551f570c | 200 | if (!opt_pd_annotations) { |
10d4fc25 | 201 | g_hash_table_insert(pd_ann_visible, g_strdup(di->decoder->id), |
790b0261 | 202 | g_slist_append(NULL, GINT_TO_POINTER(-1))); |
551f570c KP |
203 | } |
204 | if (di_prior) { | |
205 | if (srd_inst_stack(srd_sess, di_prior, di) != SRD_OK) { | |
206 | g_critical("Failed to stack %s -> %s.", | |
207 | di_prior->inst_id, di->inst_id); | |
208 | ret = 1; | |
209 | break; | |
210 | } | |
211 | /* Remove annotations from prior levels. */ | |
212 | if (!opt_pd_annotations) | |
213 | g_hash_table_remove(pd_ann_visible, di_prior->inst_id); | |
214 | } | |
215 | di_prior = di; | |
c5e0e72e KP |
216 | g_free(pd_name); |
217 | g_hash_table_destroy(pd_opthash); | |
218 | g_hash_table_destroy(options); | |
219 | pd_opthash = options = NULL; | |
2be182e6 BV |
220 | } |
221 | ||
2be182e6 BV |
222 | if (pd_opthash) |
223 | g_hash_table_destroy(pd_opthash); | |
224 | if (options) | |
225 | g_hash_table_destroy(options); | |
3dfbfbc8 UH |
226 | if (channels) |
227 | g_hash_table_destroy(channels); | |
551f570c KP |
228 | |
229 | g_strfreev(pdtokens); | |
2be182e6 BV |
230 | |
231 | return ret; | |
232 | } | |
233 | ||
551f570c KP |
234 | /* |
235 | * Register all the PDs from all stacks. | |
236 | * | |
237 | * Each PD string is a single stack such as "uart:baudrate=19200,modbus". | |
238 | */ | |
239 | int register_pds(gchar **all_pds, char *opt_pd_annotations) | |
240 | { | |
241 | int ret; | |
242 | ||
243 | ret = 0; | |
244 | pd_ann_visible = g_hash_table_new_full(g_str_hash, g_str_equal, | |
245 | g_free, NULL); | |
246 | pd_channel_maps = g_hash_table_new_full(g_str_hash, | |
247 | g_str_equal, g_free, (GDestroyNotify)g_hash_table_destroy); | |
248 | ||
249 | for (int i = 0; all_pds[i]; i++) | |
250 | ret += register_pd(all_pds[i], opt_pd_annotations); | |
251 | ||
252 | return ret; | |
253 | } | |
254 | ||
3dfbfbc8 | 255 | static void map_pd_inst_channels(void *key, void *value, void *user_data) |
39aedc34 | 256 | { |
3dfbfbc8 UH |
257 | GHashTable *channel_map; |
258 | GHashTable *channel_indices; | |
259 | GSList *channel_list; | |
39aedc34 | 260 | struct srd_decoder_inst *di; |
1f90599f | 261 | struct srd_decoder *pd; |
39aedc34 | 262 | GVariant *var; |
3dfbfbc8 | 263 | void *channel_id; |
029d73fe UH |
264 | void *channel_target; |
265 | struct sr_channel *ch; | |
39aedc34 | 266 | GHashTableIter iter; |
1f90599f GS |
267 | enum assign_t { |
268 | ASSIGN_UNKNOWN, | |
269 | ASSIGN_USER_SPEC, | |
270 | ASSIGN_BY_INDEX, | |
271 | ASSIGN_BY_NAMES, | |
272 | } assign; | |
273 | const char *keyword; | |
274 | GSList *l_pd, *l_pdo, *l_ch; | |
275 | struct srd_channel *pdch; | |
39aedc34 | 276 | |
3dfbfbc8 UH |
277 | channel_map = value; |
278 | channel_list = user_data; | |
39aedc34 DE |
279 | |
280 | di = srd_inst_find_by_id(srd_sess, key); | |
281 | if (!di) { | |
282 | g_critical("Protocol decoder instance \"%s\" not found.", | |
283 | (char *)key); | |
284 | return; | |
285 | } | |
3dfbfbc8 | 286 | channel_indices = g_hash_table_new_full(g_str_hash, g_str_equal, g_free, |
39aedc34 DE |
287 | (GDestroyNotify)g_variant_unref); |
288 | ||
1f90599f GS |
289 | /* |
290 | * The typical mode of operation is to apply a user specified | |
291 | * mapping of sigrok channels to decoder inputs. Lack of mapping | |
292 | * specs will assign no signals (compatible behaviour to earlier | |
293 | * implementations). | |
294 | * | |
295 | * Alternatively we can assign sigrok logic channels to decoder | |
296 | * inputs in the strict order of channel indices, or when their | |
297 | * names match. Users need to request this automatic assignment | |
298 | * though, because this behaviour differs from earlier versions. | |
299 | * | |
300 | * Even more sophisticated heuristics of mapping sigrok channels | |
301 | * to decoder inputs are not implemented here. Later versions | |
302 | * could translate the Pulseview approach to the C language, but | |
303 | * it's better to stabilize that logic first before porting it. | |
304 | */ | |
305 | assign = ASSIGN_USER_SPEC; | |
306 | keyword = g_hash_table_lookup(channel_map, keyword_assign); | |
307 | if (g_hash_table_size(channel_map) != 1) { | |
308 | assign = ASSIGN_USER_SPEC; | |
309 | } else if (!keyword) { | |
310 | assign = ASSIGN_USER_SPEC; | |
311 | } else if (strcmp(keyword, assign_by_index) == 0) { | |
312 | assign = ASSIGN_BY_INDEX; | |
313 | } else if (strcmp(keyword, assign_by_name) == 0) { | |
314 | assign = ASSIGN_BY_NAMES; | |
315 | } else { | |
316 | g_critical("Unknown type of decoder channel assignment: %s.", | |
317 | keyword); | |
318 | return; | |
319 | } | |
320 | ||
321 | pd = di->decoder; | |
322 | if (assign == ASSIGN_BY_INDEX) { | |
323 | /* | |
324 | * Iterate the protocol decoder's list of input signals | |
325 | * (mandatory and optional, never more than the decoder's | |
326 | * total channels count). Assign sigrok logic channels | |
327 | * until either is exhausted. Use sigrok channels in the | |
328 | * very order of their declaration in the input stream. | |
329 | */ | |
330 | l_ch = channel_list; | |
331 | l_pd = pd->channels; | |
332 | while (l_ch && l_pd) { | |
333 | ch = l_ch->data; | |
334 | l_ch = l_ch->next; | |
335 | if (ch->type != SR_CHANNEL_LOGIC) | |
336 | break; | |
337 | if (ch->index >= di->dec_num_channels) | |
338 | break; | |
339 | pdch = l_pd->data; | |
340 | l_pd = l_pd->next; | |
341 | if (!l_pd) | |
342 | l_pd = pd->opt_channels; | |
343 | /* TODO Emit an INFO message. */ | |
344 | g_hash_table_insert(channel_map, | |
345 | g_strdup(pdch->id), g_strdup(ch->name)); | |
346 | } | |
347 | } else if (assign == ASSIGN_BY_NAMES) { | |
348 | /* | |
349 | * Iterate the protocol decoder's list of input signals. | |
350 | * Search for sigrok logic channels that have matching | |
351 | * names (case insensitive comparison). Not finding a | |
352 | * sigrok channel of a given name is non-fatal (could be | |
353 | * an optional channel, the decoder will check later for | |
354 | * all mandatory channels to be assigned). | |
355 | */ | |
356 | l_pd = pd->channels; | |
357 | l_pdo = pd->opt_channels; | |
358 | while (l_pd) { | |
359 | pdch = l_pd->data; | |
360 | l_pd = l_pd->next; | |
361 | if (!l_pd) { | |
362 | l_pd = l_pdo; | |
363 | l_pdo = NULL; | |
364 | } | |
365 | ch = find_channel(channel_list, pdch->id, FALSE); | |
366 | if (!ch) { | |
367 | /* TODO Emit a WARN message. */ | |
368 | /* if (l_pdo) ...; */ | |
369 | continue; | |
370 | } | |
371 | if (ch->type != SR_CHANNEL_LOGIC) { | |
372 | /* TODO Emit a WARN message. */ | |
373 | continue; | |
374 | } | |
375 | /* TODO Emit an INFO message. */ | |
376 | g_hash_table_insert(channel_map, | |
377 | g_strdup(pdch->id), g_strdup(ch->name)); | |
378 | } | |
379 | } | |
380 | ||
3dfbfbc8 UH |
381 | g_hash_table_iter_init(&iter, channel_map); |
382 | while (g_hash_table_iter_next(&iter, &channel_id, &channel_target)) { | |
1f90599f GS |
383 | if (strcmp(channel_id, keyword_assign) == 0) |
384 | continue; | |
172d2b30 WS |
385 | if (!channel_target) { |
386 | g_printerr("cli: Channel name for \"%s\" missing.\n", | |
387 | (char *)channel_id); | |
388 | continue; | |
389 | } | |
a2dbd848 | 390 | ch = find_channel(channel_list, channel_target, TRUE); |
029d73fe UH |
391 | if (!ch) { |
392 | g_printerr("cli: No channel with name \"%s\" found.\n", | |
393 | (char *)channel_target); | |
39aedc34 DE |
394 | continue; |
395 | } | |
029d73fe UH |
396 | if (!ch->enabled) |
397 | g_printerr("cli: Target channel \"%s\" not enabled.\n", | |
398 | (char *)channel_target); | |
39aedc34 | 399 | |
029d73fe | 400 | var = g_variant_new_int32(ch->index); |
39aedc34 | 401 | g_variant_ref_sink(var); |
3dfbfbc8 | 402 | g_hash_table_insert(channel_indices, g_strdup(channel_id), var); |
39aedc34 DE |
403 | } |
404 | ||
ee639fb4 | 405 | srd_inst_channel_set_all(di, channel_indices); |
c5e0e72e | 406 | g_hash_table_destroy(channel_indices); |
39aedc34 DE |
407 | } |
408 | ||
3dfbfbc8 | 409 | void map_pd_channels(struct sr_dev_inst *sdi) |
39aedc34 | 410 | { |
c6fa2b2e UH |
411 | GSList *channels; |
412 | ||
413 | channels = sr_dev_inst_channels_get(sdi); | |
414 | ||
3dfbfbc8 UH |
415 | if (pd_channel_maps) { |
416 | g_hash_table_foreach(pd_channel_maps, &map_pd_inst_channels, | |
c6fa2b2e | 417 | channels); |
3dfbfbc8 UH |
418 | g_hash_table_destroy(pd_channel_maps); |
419 | pd_channel_maps = NULL; | |
39aedc34 DE |
420 | } |
421 | } | |
422 | ||
26c63758 | 423 | int setup_pd_annotations(char *opt_pd_annotations) |
2be182e6 | 424 | { |
790b0261 | 425 | GSList *l, *l_ann; |
2be182e6 BV |
426 | struct srd_decoder *dec; |
427 | int ann_class; | |
790b0261 | 428 | char **pds, **pdtok, **keyval, **annlist, **ann, **ann_descr; |
d6ebfaa8 GS |
429 | const char *dec_id; |
430 | const char *ann_txt; | |
431 | const char *ann_id; | |
65cd80ad GS |
432 | const struct srd_decoder_annotation_row *row_desc; |
433 | char **ann_diag; | |
2be182e6 BV |
434 | |
435 | /* Set up custom list of PDs and annotations to show. */ | |
436 | pds = g_strsplit(opt_pd_annotations, ",", 0); | |
437 | for (pdtok = pds; *pdtok && **pdtok; pdtok++) { | |
438 | keyval = g_strsplit(*pdtok, "=", 0); | |
d6ebfaa8 GS |
439 | dec_id = keyval[0]; |
440 | if (!(dec = srd_decoder_get_by_id(dec_id))) { | |
441 | g_critical("Protocol decoder '%s' not found.", dec_id); | |
8f72edc3 GS |
442 | g_strfreev(keyval); |
443 | g_strfreev(pds); | |
2be182e6 BV |
444 | return 1; |
445 | } | |
446 | if (!dec->annotations) { | |
d6ebfaa8 | 447 | g_critical("Protocol decoder '%s' has no annotations.", dec_id); |
8f72edc3 GS |
448 | g_strfreev(keyval); |
449 | g_strfreev(pds); | |
2be182e6 BV |
450 | return 1; |
451 | } | |
d6ebfaa8 GS |
452 | ann_txt = (g_strv_length(keyval) == 2) ? keyval[1] : NULL; |
453 | if (ann_txt && *ann_txt) { | |
454 | annlist = g_strsplit(ann_txt, ":", 0); | |
790b0261 | 455 | for (ann = annlist; *ann && **ann; ann++) { |
d6ebfaa8 | 456 | ann_id = *ann; |
65cd80ad | 457 | g_debug("cli: Lookup decoder %s annotation %s.", dec_id, ann_id); |
4171a0a0 | 458 | /* Lookup annotation class. */ |
790b0261 BV |
459 | ann_class = 0; |
460 | for (l = dec->annotations; l; l = l->next, ann_class++) { | |
461 | ann_descr = l->data; | |
d6ebfaa8 | 462 | if (!canon_cmp(ann_descr[0], ann_id)) |
790b0261 BV |
463 | /* Found it. */ |
464 | break; | |
465 | } | |
4171a0a0 GS |
466 | if (l) { |
467 | l_ann = g_hash_table_lookup(pd_ann_visible, dec_id); | |
468 | l_ann = g_slist_append(l_ann, GINT_TO_POINTER(ann_class)); | |
469 | g_hash_table_replace(pd_ann_visible, g_strdup(dec_id), l_ann); | |
470 | g_debug("cli: Showing protocol decoder %s annotation " | |
471 | "class %d (%s).", dec_id, ann_class, ann_descr[0]); | |
472 | continue; | |
790b0261 | 473 | } |
65cd80ad GS |
474 | /* Lookup annotation row. */ |
475 | for (l = dec->annotation_rows; l; l = l->next) { | |
476 | row_desc = l->data; | |
477 | if (!canon_cmp(row_desc->id, ann_id)) | |
478 | break; | |
479 | } | |
480 | if (l) { | |
481 | g_debug("cli: Showing decoder %s annotation row %s (%s).", | |
482 | dec_id, row_desc->id, row_desc->desc); | |
483 | l_ann = g_hash_table_lookup(pd_ann_visible, dec_id); | |
484 | for (l = row_desc->ann_classes; l; l = l->next) { | |
485 | /* | |
486 | * This could just be: | |
487 | * l_ann = g_slist_append(l_ann, l->data); | |
488 | * But we are explicit for readability | |
489 | * and to access details for diagnostics. | |
490 | */ | |
491 | ann_class = GPOINTER_TO_INT(l->data); | |
492 | l_ann = g_slist_append(l_ann, GINT_TO_POINTER(ann_class)); | |
493 | ann_diag = g_slist_nth_data(dec->annotations, ann_class); | |
494 | g_debug("cli: Adding class %d/%s from row %s.", | |
495 | ann_class, ann_diag[0], row_desc->id); | |
496 | } | |
497 | g_hash_table_replace(pd_ann_visible, g_strdup(dec_id), l_ann); | |
498 | continue; | |
499 | } | |
4171a0a0 GS |
500 | /* No match found. */ |
501 | g_critical("Annotation '%s' not found " | |
502 | "for protocol decoder '%s'.", ann_id, dec_id); | |
503 | g_strfreev(keyval); | |
504 | g_strfreev(pds); | |
505 | return 1; | |
2be182e6 | 506 | } |
2be182e6 BV |
507 | } else { |
508 | /* No class specified: show all of them. */ | |
11e554c2 GS |
509 | ann_class = -1; |
510 | l_ann = g_slist_append(NULL, GINT_TO_POINTER(ann_class)); | |
511 | g_hash_table_insert(pd_ann_visible, g_strdup(dec_id), l_ann); | |
2be182e6 | 512 | g_debug("cli: Showing all annotation classes for protocol " |
d6ebfaa8 | 513 | "decoder %s.", dec_id); |
2be182e6 | 514 | } |
2be182e6 BV |
515 | g_strfreev(keyval); |
516 | } | |
517 | g_strfreev(pds); | |
518 | ||
519 | return 0; | |
520 | } | |
521 | ||
26c63758 | 522 | int setup_pd_meta(char *opt_pd_meta) |
2be182e6 BV |
523 | { |
524 | struct srd_decoder *dec; | |
525 | char **pds, **pdtok; | |
526 | ||
527 | pd_meta_visible = g_hash_table_new_full(g_str_hash, g_int_equal, | |
528 | g_free, NULL); | |
529 | pds = g_strsplit(opt_pd_meta, ",", 0); | |
530 | for (pdtok = pds; *pdtok && **pdtok; pdtok++) { | |
531 | if (!(dec = srd_decoder_get_by_id(*pdtok))) { | |
532 | g_critical("Protocol decoder '%s' not found.", *pdtok); | |
533 | return 1; | |
534 | } | |
535 | g_debug("cli: Showing protocol decoder meta output from '%s'.", *pdtok); | |
536 | g_hash_table_insert(pd_meta_visible, g_strdup(*pdtok), NULL); | |
537 | } | |
538 | g_strfreev(pds); | |
539 | ||
540 | return 0; | |
541 | } | |
542 | ||
26c63758 | 543 | int setup_pd_binary(char *opt_pd_binary) |
2be182e6 BV |
544 | { |
545 | GSList *l; | |
546 | struct srd_decoder *dec; | |
547 | int bin_class; | |
5ff52594 | 548 | char **pds, **pdtok, **keyval, **bin_name; |
2be182e6 BV |
549 | |
550 | pd_binary_visible = g_hash_table_new_full(g_str_hash, g_int_equal, | |
551 | g_free, NULL); | |
552 | pds = g_strsplit(opt_pd_binary, ",", 0); | |
553 | for (pdtok = pds; *pdtok && **pdtok; pdtok++) { | |
554 | keyval = g_strsplit(*pdtok, "=", 0); | |
555 | if (!(dec = srd_decoder_get_by_id(keyval[0]))) { | |
556 | g_critical("Protocol decoder '%s' not found.", keyval[0]); | |
557 | return 1; | |
558 | } | |
559 | if (!dec->binary) { | |
560 | g_critical("Protocol decoder '%s' has no binary output.", keyval[0]); | |
561 | return 1; | |
562 | } | |
563 | bin_class = 0; | |
564 | if (g_strv_length(keyval) == 2) { | |
565 | for (l = dec->binary; l; l = l->next, bin_class++) { | |
566 | bin_name = l->data; | |
5ff52594 | 567 | if (!strcmp(bin_name[0], keyval[1])) |
2be182e6 BV |
568 | /* Found it. */ |
569 | break; | |
570 | } | |
571 | if (!l) { | |
572 | g_critical("binary output '%s' not found " | |
573 | "for protocol decoder '%s'.", keyval[1], keyval[0]); | |
574 | return 1; | |
575 | } | |
576 | g_debug("cli: Showing protocol decoder %s binary class " | |
5ff52594 | 577 | "%d (%s).", keyval[0], bin_class, bin_name[0]); |
2be182e6 BV |
578 | } else { |
579 | /* No class specified: output all of them. */ | |
580 | bin_class = -1; | |
581 | g_debug("cli: Showing all binary classes for protocol " | |
582 | "decoder %s.", keyval[0]); | |
583 | } | |
584 | g_hash_table_insert(pd_binary_visible, g_strdup(keyval[0]), GINT_TO_POINTER(bin_class)); | |
585 | g_strfreev(keyval); | |
586 | } | |
587 | g_strfreev(pds); | |
588 | ||
589 | return 0; | |
590 | } | |
591 | ||
54614916 GS |
592 | /* |
593 | * Balance JSON object and array parentheses, and separate array items. | |
594 | * Somewhat convoluted API to re-use the routine for individual items as | |
595 | * well as the surrounding array and object, including deferred start of | |
596 | * the output and late flush (and to keep the state strictly local to the | |
597 | * routine). Some additional complexity due to JSON's inability to handle | |
598 | * a trailing comma at the last item. Code phrased such that text literals | |
118228e1 | 599 | * are kept in their order of appearance in the output (where possible). |
54614916 | 600 | */ |
118228e1 GS |
601 | static void jsontrace_open_close(gboolean is_close_req, |
602 | gboolean open_item, gboolean close_item) | |
54614916 | 603 | { |
118228e1 GS |
604 | static gboolean is_file_open; |
605 | static gboolean is_item_open; | |
54614916 | 606 | |
118228e1 GS |
607 | if (is_close_req && is_item_open) |
608 | close_item = TRUE; | |
609 | ||
610 | /* Automatic file header, and array item separation. */ | |
611 | if (open_item) { | |
612 | if (!is_file_open) | |
54614916 | 613 | printf("{\"traceEvents\": [\n"); |
118228e1 GS |
614 | if (is_item_open) { |
615 | printf("}"); | |
616 | is_item_open = FALSE; | |
54614916 | 617 | } |
118228e1 GS |
618 | if (is_file_open) { |
619 | printf(",\n"); | |
54614916 | 620 | } |
118228e1 GS |
621 | is_file_open = TRUE; |
622 | } | |
623 | ||
624 | /* Array item open/append/close. */ | |
625 | if (open_item) { | |
626 | printf("{"); | |
627 | is_item_open = TRUE; | |
54614916 | 628 | } |
118228e1 GS |
629 | if (!open_item && !close_item && !is_close_req) { |
630 | printf(", "); | |
631 | is_item_open = TRUE; | |
632 | } | |
633 | if (close_item) { | |
634 | printf("}"); | |
635 | is_item_open = FALSE; | |
636 | } | |
637 | ||
638 | /* Automatic file footer on shutdown. */ | |
639 | if (is_close_req && is_file_open) { | |
640 | printf("\n"); | |
641 | printf("]}\n"); | |
642 | } | |
643 | if (is_close_req) | |
644 | is_file_open = FALSE; | |
645 | ||
646 | /* Flush at end of lines, or end of file. */ | |
647 | if (close_item || is_close_req) | |
648 | fflush(stdout); | |
54614916 GS |
649 | } |
650 | ||
651 | /* Convert uint64 sample number to double timestamp in microseconds. */ | |
652 | static double jsontrace_ts_usec(uint64_t snum) | |
653 | { | |
654 | double ts_usec; | |
655 | ||
656 | ts_usec = snum; | |
657 | ts_usec *= 1e6; | |
658 | ts_usec /= pd_samplerate; | |
659 | return ts_usec; | |
660 | } | |
661 | ||
662 | /* Emit two Google Trace Events (JSON) for one PD annotation (ss, es). */ | |
663 | static void jsontrace_annotation(struct srd_decoder *dec, | |
664 | struct srd_proto_data_annotation *pda, struct srd_proto_data *pdata) | |
665 | { | |
666 | char *row_text; | |
667 | GSList *lrow, *lcls; | |
668 | struct srd_decoder_annotation_row *row; | |
669 | int cls; | |
670 | char **ann_descr; | |
671 | ||
672 | /* | |
673 | * Search for an annotation row for this index, or use the | |
674 | * annotation's descriptor. | |
675 | */ | |
676 | row_text = NULL; | |
677 | if (dec->annotation_rows) { | |
678 | for (lrow = dec->annotation_rows; lrow; lrow = lrow->next) { | |
679 | row = lrow->data; | |
680 | for (lcls = row->ann_classes; lcls; lcls = lcls->next) { | |
681 | cls = GPOINTER_TO_INT(lcls->data); | |
682 | if (cls == pda->ann_class) { | |
683 | row_text = row->desc; | |
684 | break; | |
685 | } | |
686 | } | |
687 | if (row_text) | |
688 | break; | |
689 | } | |
690 | } | |
691 | if (!row_text) { | |
692 | ann_descr = g_slist_nth_data(dec->annotations, pda->ann_class); | |
693 | row_text = ann_descr[0]; | |
694 | } | |
695 | ||
696 | /* | |
697 | * Emit two Google Trace Events for the start and end times. | |
698 | * Set the 'pid' (process ID) to the decoder name to group a | |
699 | * decoder's annotations. Set the 'tid' (thread ID) to the | |
700 | * annotation row's description. The 'ts' (timestamp) is in | |
701 | * microseconds. Set 'name' to the longest annotation text. | |
702 | * | |
a92fe14d GS |
703 | * BEWARE of the unfortunate JSON format limitation, which |
704 | * clutters data output calls with format helper calls. | |
118228e1 GS |
705 | * TODO Want to introduce a cJSON dependency to delegate the |
706 | * construction of output text? | |
54614916 | 707 | */ |
118228e1 | 708 | jsontrace_open_close(FALSE, TRUE, FALSE); |
118228e1 GS |
709 | printf("\"%s\": \"%s\"", "ph", "B"); |
710 | jsontrace_open_close(FALSE, FALSE, FALSE); | |
a92fe14d GS |
711 | printf("\"%s\": %lf", "ts", jsontrace_ts_usec(pdata->start_sample)); |
712 | jsontrace_open_close(FALSE, FALSE, FALSE); | |
118228e1 GS |
713 | printf("\"%s\": \"%s\"", "pid", pdata->pdo->proto_id); |
714 | jsontrace_open_close(FALSE, FALSE, FALSE); | |
715 | printf("\"%s\": \"%s\"", "tid", row_text); | |
716 | jsontrace_open_close(FALSE, FALSE, FALSE); | |
a92fe14d | 717 | printf("\"%s\": \"%s\"", "name", pda->ann_text[0]); |
118228e1 GS |
718 | |
719 | jsontrace_open_close(FALSE, TRUE, FALSE); | |
118228e1 GS |
720 | printf("\"%s\": \"%s\"", "ph", "E"); |
721 | jsontrace_open_close(FALSE, FALSE, FALSE); | |
a92fe14d GS |
722 | printf("\"%s\": %lf", "ts", jsontrace_ts_usec(pdata->end_sample)); |
723 | jsontrace_open_close(FALSE, FALSE, FALSE); | |
118228e1 GS |
724 | printf("\"%s\": \"%s\"", "pid", pdata->pdo->proto_id); |
725 | jsontrace_open_close(FALSE, FALSE, FALSE); | |
726 | printf("\"%s\": \"%s\"", "tid", row_text); | |
727 | jsontrace_open_close(FALSE, FALSE, FALSE); | |
a92fe14d | 728 | printf("\"%s\": \"%s\"", "name", pda->ann_text[0]); |
118228e1 GS |
729 | |
730 | jsontrace_open_close(FALSE, FALSE, TRUE); | |
54614916 GS |
731 | } |
732 | ||
2be182e6 BV |
733 | void show_pd_annotations(struct srd_proto_data *pdata, void *cb_data) |
734 | { | |
6fdcc67d | 735 | struct srd_decoder *dec; |
2be182e6 | 736 | struct srd_proto_data_annotation *pda; |
790b0261 BV |
737 | GSList *ann_list, *l; |
738 | int i; | |
6fdcc67d | 739 | char **ann_descr; |
241f9b13 | 740 | gboolean show_ann, show_snum, show_class, show_quotes, show_abbrev; |
e1a352d1 | 741 | const char *quote; |
2be182e6 | 742 | |
2be182e6 BV |
743 | (void)cb_data; |
744 | ||
745 | if (!pd_ann_visible) | |
746 | return; | |
747 | ||
10d4fc25 KP |
748 | if (!g_hash_table_lookup_extended(pd_ann_visible, pdata->pdo->di->decoder->id, |
749 | NULL, (void **)&ann_list)) { | |
2be182e6 BV |
750 | /* Not in the list of PDs whose annotations we're showing. */ |
751 | return; | |
10d4fc25 | 752 | } |
2be182e6 | 753 | |
6fdcc67d | 754 | dec = pdata->pdo->di->decoder; |
2be182e6 | 755 | pda = pdata->data; |
241f9b13 | 756 | show_ann = FALSE; |
790b0261 BV |
757 | for (l = ann_list; l; l = l->next) { |
758 | if (GPOINTER_TO_INT(l->data) == -1 | |
a23105b1 | 759 | || GPOINTER_TO_INT(l->data) == pda->ann_class) { |
241f9b13 | 760 | show_ann = TRUE; |
790b0261 BV |
761 | break; |
762 | } | |
763 | } | |
241f9b13 | 764 | if (!show_ann) |
2be182e6 BV |
765 | return; |
766 | ||
54614916 GS |
767 | /* Google Trace Events are rather special. Use a separate code path. */ |
768 | if (opt_pd_jsontrace) { | |
769 | jsontrace_annotation(dec, pda, pdata); | |
770 | return; | |
771 | } | |
772 | ||
241f9b13 | 773 | /* |
08e9378b GS |
774 | * Determine which fields of the annotation to display. Inspect |
775 | * user specified options as well as the verbosity of the log level: | |
241f9b13 GS |
776 | * - Optionally show the sample numbers for the annotation's span. |
777 | * - Always show the protocol decoder ID. | |
778 | * - Optionally show the annotation's class description. | |
779 | * - Always show the longest annotation text. | |
780 | * - Optionally show alternative annotation text (abbreviations | |
781 | * for different zoom levels). | |
782 | * - Optionally put quote marks around annotation text, when | |
783 | * recipients might have to deal with a set of text variants. | |
784 | */ | |
785 | show_snum = show_class = show_quotes = show_abbrev = FALSE; | |
08e9378b | 786 | if (opt_pd_samplenum || opt_loglevel > SR_LOG_WARN) { |
241f9b13 GS |
787 | show_snum = TRUE; |
788 | } | |
789 | if (opt_loglevel > SR_LOG_WARN) { | |
790 | show_quotes = TRUE; | |
791 | } | |
792 | if (opt_loglevel > SR_LOG_INFO) { | |
793 | show_class = TRUE; | |
794 | show_abbrev = TRUE; | |
795 | } | |
625606db SS |
796 | if (opt_pd_ann_class) |
797 | show_class = TRUE; | |
241f9b13 GS |
798 | |
799 | /* | |
800 | * Display the annotation's fields after the layout was | |
801 | * determined above. | |
802 | */ | |
e1a352d1 GS |
803 | if (show_snum) { |
804 | printf("%" PRIu64 "-%" PRIu64 " ", | |
805 | pdata->start_sample, pdata->end_sample); | |
806 | } | |
aa001713 | 807 | printf("%s: ", pdata->pdo->proto_id); |
e1a352d1 GS |
808 | if (show_class) { |
809 | ann_descr = g_slist_nth_data(dec->annotations, pda->ann_class); | |
810 | printf("%s: ", ann_descr[0]); | |
811 | } | |
812 | quote = show_quotes ? "\"" : ""; | |
813 | printf("%s%s%s", quote, pda->ann_text[0], quote); | |
814 | if (show_abbrev) { | |
815 | for (i = 1; pda->ann_text[i]; i++) | |
816 | printf(" %s%s%s", quote, pda->ann_text[i], quote); | |
6fdcc67d | 817 | } |
2be182e6 BV |
818 | printf("\n"); |
819 | fflush(stdout); | |
820 | } | |
821 | ||
822 | void show_pd_meta(struct srd_proto_data *pdata, void *cb_data) | |
823 | { | |
2be182e6 BV |
824 | (void)cb_data; |
825 | ||
826 | if (!g_hash_table_lookup_extended(pd_meta_visible, | |
827 | pdata->pdo->di->decoder->id, NULL, NULL)) | |
828 | /* Not in the list of PDs whose meta output we're showing. */ | |
829 | return; | |
830 | ||
08e9378b | 831 | if (opt_pd_samplenum || opt_loglevel > SR_LOG_WARN) |
2be182e6 BV |
832 | printf("%"PRIu64"-%"PRIu64" ", pdata->start_sample, pdata->end_sample); |
833 | printf("%s: ", pdata->pdo->proto_id); | |
834 | printf("%s: %s", pdata->pdo->meta_name, g_variant_print(pdata->data, FALSE)); | |
835 | printf("\n"); | |
836 | fflush(stdout); | |
837 | } | |
838 | ||
839 | void show_pd_binary(struct srd_proto_data *pdata, void *cb_data) | |
840 | { | |
841 | struct srd_proto_data_binary *pdb; | |
842 | gpointer classp; | |
4ae9434a | 843 | int classi; |
2be182e6 | 844 | |
2be182e6 BV |
845 | (void)cb_data; |
846 | ||
847 | if (!g_hash_table_lookup_extended(pd_binary_visible, | |
848 | pdata->pdo->di->decoder->id, NULL, (void **)&classp)) | |
849 | /* Not in the list of PDs whose meta output we're showing. */ | |
850 | return; | |
851 | ||
4ae9434a | 852 | classi = GPOINTER_TO_INT(classp); |
2be182e6 | 853 | pdb = pdata->data; |
4ae9434a | 854 | if (classi != -1 && classi != pdb->bin_class) |
2be182e6 BV |
855 | /* Not showing this binary class. */ |
856 | return; | |
857 | ||
858 | /* Just send the binary output to stdout, no embellishments. */ | |
859 | fwrite(pdb->data, pdb->size, 1, stdout); | |
860 | fflush(stdout); | |
861 | } | |
54614916 GS |
862 | |
863 | void show_pd_prepare(void) | |
864 | { | |
865 | if (opt_pd_jsontrace) | |
118228e1 | 866 | jsontrace_open_close(TRUE, FALSE, FALSE); |
54614916 GS |
867 | } |
868 | ||
869 | void show_pd_close(void) | |
870 | { | |
871 | if (opt_pd_jsontrace) | |
118228e1 | 872 | jsontrace_open_close(TRUE, FALSE, FALSE); |
54614916 | 873 | } |
2be182e6 | 874 | #endif |