From af9fa8c5ea9925cb8fe076ae7d4e996836a6db13 Mon Sep 17 00:00:00 2001 From: Gerhard Sittig Date: Wed, 31 Aug 2022 00:40:37 +0200 Subject: [PATCH 1/9] parsers: avoid NULL dereference when option strings are empty When colon separated options are scanned (like "-P ps2: --show") then the empty list item which results from the trailing colon resulted in key/value pairs becoming NULL. Handle that situation, skip empty list elements. Reported-By: Peter Mortensen via IRC --- parsers.c | 2 ++ 1 file changed, 2 insertions(+) diff --git a/parsers.c b/parsers.c index b74d74f..59a7a91 100644 --- a/parsers.c +++ b/parsers.c @@ -364,6 +364,8 @@ GHashTable *parse_generic_arg(const char *arg, i++; } for (; elements[i]; i++) { + if (!elements[i][0]) + continue; split_key_value(elements[i], &k, &v); k = g_strdup(k); v = v ? g_strdup(v) : NULL; -- 2.30.2 From 625606db65d118c9a246057297633d4c5f0c1571 Mon Sep 17 00:00:00 2001 From: Sergey Spivak Date: Fri, 12 Aug 2022 15:53:43 +0400 Subject: [PATCH 2/9] decode: Optionally print annotation class with PD annotations Introduce the "--protocol-decoder-ann-class" command line option (no short form available), which emits annotation class names with textual output from protocol decoder annotations, regardless of a log level value. Based on commit 08e9378bf68a by Gerhard Sittig --- decode.c | 2 ++ doc/sigrok-cli.1 | 3 +++ options.c | 3 +++ sigrok-cli.h | 1 + 4 files changed, 9 insertions(+) diff --git a/decode.c b/decode.c index 4ddf34a..ac0e3e1 100644 --- a/decode.c +++ b/decode.c @@ -684,6 +684,8 @@ void show_pd_annotations(struct srd_proto_data *pdata, void *cb_data) show_class = TRUE; show_abbrev = TRUE; } + if (opt_pd_ann_class) + show_class = TRUE; /* * Display the annotation's fields after the layout was diff --git a/doc/sigrok-cli.1 b/doc/sigrok-cli.1 index b333bee..b489928 100644 --- a/doc/sigrok-cli.1 +++ b/doc/sigrok-cli.1 @@ -426,6 +426,9 @@ Not every decoder generates binary output. When given, decoder annotations will include sample numbers, too. This allows consumers to receive machine readable timing information. .TP +.BR "\-\-protocol\-decoder\-ann\-class +When given, decoder annotations will include annotation class names. +.TP .BR "\-l, \-\-loglevel " Set the libsigrok and libsigrokdecode loglevel. At the moment \fBsigrok\-cli\fP doesn't support setting the two loglevels independently. The higher the diff --git a/options.c b/options.c index 2573bd4..e47b680 100644 --- a/options.c +++ b/options.c @@ -40,6 +40,7 @@ gchar **opt_pds = NULL; gchar *opt_pd_annotations = NULL; gchar *opt_pd_meta = NULL; gchar *opt_pd_binary = NULL; +gboolean opt_pd_ann_class = FALSE; gboolean opt_pd_samplenum = FALSE; gboolean opt_pd_jsontrace = FALSE; #endif @@ -139,6 +140,8 @@ static const GOptionEntry optargs[] = { "Protocol decoder meta output to show", NULL}, {"protocol-decoder-binary", 'B', 0, G_OPTION_ARG_CALLBACK, &check_opt_pd_binary, "Protocol decoder binary output to show", NULL}, + {"protocol-decoder-ann-class", 0, 0, G_OPTION_ARG_NONE, &opt_pd_ann_class, + "Show annotation class in decoder output", NULL}, {"protocol-decoder-samplenum", 0, 0, G_OPTION_ARG_NONE, &opt_pd_samplenum, "Show sample numbers in decoder output", NULL}, {"protocol-decoder-jsontrace", 0, 0, G_OPTION_ARG_NONE, &opt_pd_jsontrace, diff --git a/sigrok-cli.h b/sigrok-cli.h index 2c0fbdc..684aed9 100644 --- a/sigrok-cli.h +++ b/sigrok-cli.h @@ -140,6 +140,7 @@ extern gchar **opt_pds; extern gchar *opt_pd_annotations; extern gchar *opt_pd_meta; extern gchar *opt_pd_binary; +extern gboolean opt_pd_ann_class; extern gboolean opt_pd_samplenum; extern gboolean opt_pd_jsontrace; #endif -- 2.30.2 From 9a7a9200195ad0c7bab387a1f953119bece40823 Mon Sep 17 00:00:00 2001 From: Gerhard Sittig Date: Wed, 14 Dec 2022 17:52:42 +0100 Subject: [PATCH 3/9] manpage: add --protocol-decoder-jsontrace command line option Support for JSON formatted decoder output was introduced in commit 54614916a903 ("decode: add support for Google Trace Event output (JSON)") in 2020-07. Update the manpage. --- doc/sigrok-cli.1 | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/doc/sigrok-cli.1 b/doc/sigrok-cli.1 index b489928..47ec579 100644 --- a/doc/sigrok-cli.1 +++ b/doc/sigrok-cli.1 @@ -429,6 +429,10 @@ This allows consumers to receive machine readable timing information. .BR "\-\-protocol\-decoder\-ann\-class When given, decoder annotations will include annotation class names. .TP +.BR "\-\-protocol\-decoder\-jsontrace +When given, decoder output uses the Google Trace Event format (JSON). +Which can be inspected in web browsers or other viewers. +.TP .BR "\-l, \-\-loglevel " Set the libsigrok and libsigrokdecode loglevel. At the moment \fBsigrok\-cli\fP doesn't support setting the two loglevels independently. The higher the -- 2.30.2 From 394fd9b7a456f16c7ac15f41b0e29081f1d951f8 Mon Sep 17 00:00:00 2001 From: Gerhard Sittig Date: Wed, 14 Dec 2022 17:57:19 +0100 Subject: [PATCH 4/9] manpage: add environment variables section (firmware, decoders path) Add the SIGROK_FIRMWARE_DIR, SIGROK_FIRMWARE_PATH, SIGROKDECODE_DIR, and SIGROKDECODE_PATH environment variables to the sigrok-cli(1) manpage. Strictly speaking these are the libraries' environment variables, when libsigrok looks up device firmware, and libsigrokdecode searches for Python scripts. But the libraries don't have individual manpages. So let's put them here for better perception, and to have them _somewhere_ and not lose this information. --- doc/sigrok-cli.1 | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/doc/sigrok-cli.1 b/doc/sigrok-cli.1 index 47ec579..9c847a7 100644 --- a/doc/sigrok-cli.1 +++ b/doc/sigrok-cli.1 @@ -588,6 +588,25 @@ To turn on internal logging on a Lascar EL-USB series device: .SH "EXIT STATUS" .B sigrok\-cli exits with 0 on success, 1 on most failures. +.SH "ENVIRONMENT" +.TP +.B SIGROK_FIRMWARE_DIR +A single path where to search for firmware images, in addition to a +builtin list of locations. +.TP +.B SIGROK_FIRMWARE_PATH +Multiple path entries where to search for firmware images, in addition +to builtin locations. +.TP +When decoder support was enabled in the application's configuration: +.TP +.B SIGROKDECODE_DIR +A single path where to search for protocol decoders, in addition to +a builtin list of locations. +.TP +.B SIGROKDECODE_PATH +Multiple path entries where to search for protocol decoders, in addition +to builtin locations. .SH "SEE ALSO" \fBpulseview\fP(1) .SH "BUGS" -- 2.30.2 From 527dd7262e49dd051ff554401f9cb21c2c9006dd Mon Sep 17 00:00:00 2001 From: fenugrec Date: Fri, 2 Dec 2022 21:52:00 -0500 Subject: [PATCH 5/9] HACKING: catch up with libsigrok docs (mem alloc, var decl) Bring the "Random notes" section closer to the libsigrok documentation. Adjust the discussion of memory allocation. Prefer variable declaration at the start of routines, and separate them from value assignments. --- HACKING | 21 +++++++++++++++------ 1 file changed, 15 insertions(+), 6 deletions(-) diff --git a/HACKING b/HACKING index c9b876b..36c6756 100644 --- a/HACKING +++ b/HACKING @@ -29,18 +29,27 @@ Contributions Random notes ------------ - - Consistently use g_try_malloc() / g_try_malloc0(). Do not use standard + - Don't do variable declarations in compound statements, only at the + beginning of a function. + + - Generally avoid assigning values to variables at declaration time, + especially so for complex and/or run-time dependent values. + + - Consistently use g_*malloc() / g_*malloc0(). Do not use standard malloc()/calloc() if it can be avoided (sometimes other libs such as libftdi can return malloc()'d memory, for example). - Always properly match allocations with the proper *free() functions. If - glib's g_try_malloc()/g_try_malloc0() was used, use g_free() to free the + glib's g_*malloc()/g_*malloc0() was used, use g_free() to free the memory. Otherwise use standard free(). Never use the wrong function! - - Never use g_malloc() or g_malloc0(). These functions do not return NULL - if not enough memory is available but rather lead to an exit() or segfault - instead. This behaviour is not acceptable. - Use g_try_malloc()/g_try_malloc0() instead and check the return value. + - We assume that "small" memory allocations (< 1MB) will always succeed. + Thus, it's fine to use g_malloc() or g_malloc0() for allocations of + simple/small structs and such (instead of using g_try_malloc()), and + there's no need to check the return value. + + Do use g_try_malloc() or g_try_malloc0() for large (>= 1MB) allocations + and check the return value. - You should never print any messages (neither to stdout nor stderr nor elsewhere) "manually" via e.g. printf() or g_log() or similar functions. -- 2.30.2 From 51cf9b2cbdb58001253e9921aff1a09acfa539e1 Mon Sep 17 00:00:00 2001 From: Gerhard Sittig Date: Fri, 7 Apr 2023 18:31:53 +0200 Subject: [PATCH 6/9] decode: add 'const' decorator in hash item move helper routine Decorate the lookup key in move_hash_element() as const. --- decode.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/decode.c b/decode.c index ac0e3e1..1a0747c 100644 --- a/decode.c +++ b/decode.c @@ -89,7 +89,7 @@ static int opts_to_gvar(struct srd_decoder *dec, GHashTable *hash, return ret; } -static int move_hash_element(GHashTable *src, GHashTable *dest, void *key) +static int move_hash_element(GHashTable *src, GHashTable *dest, const void *key) { void *orig_key, *value; -- 2.30.2 From a2dbd8488c1d18c39d55ebbf6e4c3c83db0296ba Mon Sep 17 00:00:00 2001 From: Gerhard Sittig Date: Fri, 7 Apr 2023 18:34:11 +0200 Subject: [PATCH 7/9] parsers: optional case insensitive channel name lookup Prepare the parsers.c:find_channel() routine to optionally lookup channels by case insensitive name matches. Stick with case sensitive comparison in all existing call sites. --- decode.c | 2 +- parsers.c | 16 +++++++++++----- sigrok-cli.h | 3 ++- 3 files changed, 14 insertions(+), 7 deletions(-) diff --git a/decode.c b/decode.c index 1a0747c..fe5b968 100644 --- a/decode.c +++ b/decode.c @@ -278,7 +278,7 @@ static void map_pd_inst_channels(void *key, void *value, void *user_data) (char *)channel_id); continue; } - ch = find_channel(channel_list, channel_target); + ch = find_channel(channel_list, channel_target, TRUE); if (!ch) { g_printerr("cli: No channel with name \"%s\" found.\n", (char *)channel_target); diff --git a/parsers.c b/parsers.c index 59a7a91..2aacefb 100644 --- a/parsers.c +++ b/parsers.c @@ -25,7 +25,8 @@ #include #include "sigrok-cli.h" -struct sr_channel *find_channel(GSList *channellist, const char *channelname) +struct sr_channel *find_channel(GSList *channellist, const char *channelname, + gboolean exact_case) { struct sr_channel *ch; GSList *l; @@ -33,8 +34,13 @@ struct sr_channel *find_channel(GSList *channellist, const char *channelname) ch = NULL; for (l = channellist; l; l = l->next) { ch = l->data; - if (!strcmp(ch->name, channelname)) - break; + if (exact_case) { + if (strcmp(ch->name, channelname) == 0) + break; + } else { + if (g_ascii_strcasecmp(ch->name, channelname) == 0) + break; + } } ch = l ? l->data : NULL; @@ -105,7 +111,7 @@ GSList *parse_channelstring(struct sr_dev_inst *sdi, const char *channelstring) ret = SR_ERR; break; } - ch = find_channel(channels, str); + ch = find_channel(channels, str, TRUE); if (!ch) { g_critical("unknown channel '%d'.", b); ret = SR_ERR; @@ -130,7 +136,7 @@ range_fail: break; } - ch = find_channel(channels, names[0]); + ch = find_channel(channels, names[0], TRUE); if (!ch) { g_critical("unknown channel '%s'.", names[0]); g_strfreev(names); diff --git a/sigrok-cli.h b/sigrok-cli.h index 684aed9..b33b076 100644 --- a/sigrok-cli.h +++ b/sigrok-cli.h @@ -103,7 +103,8 @@ void map_pd_channels(struct sr_dev_inst *sdi); #endif /* parsers.c */ -struct sr_channel *find_channel(GSList *channellist, const char *channelname); +struct sr_channel *find_channel(GSList *channellist, const char *channelname, + gboolean exact_case); GSList *parse_channelstring(struct sr_dev_inst *sdi, const char *channelstring); int parse_triggerstring(const struct sr_dev_inst *sdi, const char *s, struct sr_trigger **trigger); -- 2.30.2 From 1f90599fa522afb9cfb9f603e2a27f89a6cb222f Mon Sep 17 00:00:00 2001 From: Gerhard Sittig Date: Fri, 7 Apr 2023 18:48:46 +0200 Subject: [PATCH 8/9] decode: assign logic channels to PD inputs (by name or by index) Add support for the -P :assign_channels=auto_index or =auto_names keywords. Which assigns sigrok logic channels to decoder input signals, but requires explicit initiation by users. The default behaviour remains backwards compatible, exclusively assigns individual channels as mapped by user specs, assigns nothing by default. Name matching is implemented as a simple case insensitive comparison. Neither weaker name checks (optional separators) nor advanced heuristics are supported as seen in the Pulseview GUI application. Future versions could implement these once the set of transformation rules has settled. --- decode.c | 109 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 109 insertions(+) diff --git a/decode.c b/decode.c index fe5b968..12083a1 100644 --- a/decode.c +++ b/decode.c @@ -33,6 +33,10 @@ uint64_t pd_samplerate = 0; extern struct srd_session *srd_sess; +static const char *keyword_assign = "assign_channels"; +static const char *assign_by_index = "auto_index"; +static const char *assign_by_name = "auto_names"; + static int opts_to_gvar(struct srd_decoder *dec, GHashTable *hash, GHashTable **options) { @@ -111,6 +115,7 @@ static GHashTable *extract_channel_map(struct srd_decoder *dec, GHashTable *hash channel_map = g_hash_table_new_full(g_str_hash, g_str_equal, g_free, g_free); + move_hash_element(hash, channel_map, keyword_assign); for (l = dec->channels; l; l = l->next) { pdch = l->data; move_hash_element(hash, channel_map, pdch->id); @@ -253,11 +258,21 @@ static void map_pd_inst_channels(void *key, void *value, void *user_data) GHashTable *channel_indices; GSList *channel_list; struct srd_decoder_inst *di; + struct srd_decoder *pd; GVariant *var; void *channel_id; void *channel_target; struct sr_channel *ch; GHashTableIter iter; + enum assign_t { + ASSIGN_UNKNOWN, + ASSIGN_USER_SPEC, + ASSIGN_BY_INDEX, + ASSIGN_BY_NAMES, + } assign; + const char *keyword; + GSList *l_pd, *l_pdo, *l_ch; + struct srd_channel *pdch; channel_map = value; channel_list = user_data; @@ -271,8 +286,102 @@ static void map_pd_inst_channels(void *key, void *value, void *user_data) channel_indices = g_hash_table_new_full(g_str_hash, g_str_equal, g_free, (GDestroyNotify)g_variant_unref); + /* + * The typical mode of operation is to apply a user specified + * mapping of sigrok channels to decoder inputs. Lack of mapping + * specs will assign no signals (compatible behaviour to earlier + * implementations). + * + * Alternatively we can assign sigrok logic channels to decoder + * inputs in the strict order of channel indices, or when their + * names match. Users need to request this automatic assignment + * though, because this behaviour differs from earlier versions. + * + * Even more sophisticated heuristics of mapping sigrok channels + * to decoder inputs are not implemented here. Later versions + * could translate the Pulseview approach to the C language, but + * it's better to stabilize that logic first before porting it. + */ + assign = ASSIGN_USER_SPEC; + keyword = g_hash_table_lookup(channel_map, keyword_assign); + if (g_hash_table_size(channel_map) != 1) { + assign = ASSIGN_USER_SPEC; + } else if (!keyword) { + assign = ASSIGN_USER_SPEC; + } else if (strcmp(keyword, assign_by_index) == 0) { + assign = ASSIGN_BY_INDEX; + } else if (strcmp(keyword, assign_by_name) == 0) { + assign = ASSIGN_BY_NAMES; + } else { + g_critical("Unknown type of decoder channel assignment: %s.", + keyword); + return; + } + + pd = di->decoder; + if (assign == ASSIGN_BY_INDEX) { + /* + * Iterate the protocol decoder's list of input signals + * (mandatory and optional, never more than the decoder's + * total channels count). Assign sigrok logic channels + * until either is exhausted. Use sigrok channels in the + * very order of their declaration in the input stream. + */ + l_ch = channel_list; + l_pd = pd->channels; + while (l_ch && l_pd) { + ch = l_ch->data; + l_ch = l_ch->next; + if (ch->type != SR_CHANNEL_LOGIC) + break; + if (ch->index >= di->dec_num_channels) + break; + pdch = l_pd->data; + l_pd = l_pd->next; + if (!l_pd) + l_pd = pd->opt_channels; + /* TODO Emit an INFO message. */ + g_hash_table_insert(channel_map, + g_strdup(pdch->id), g_strdup(ch->name)); + } + } else if (assign == ASSIGN_BY_NAMES) { + /* + * Iterate the protocol decoder's list of input signals. + * Search for sigrok logic channels that have matching + * names (case insensitive comparison). Not finding a + * sigrok channel of a given name is non-fatal (could be + * an optional channel, the decoder will check later for + * all mandatory channels to be assigned). + */ + l_pd = pd->channels; + l_pdo = pd->opt_channels; + while (l_pd) { + pdch = l_pd->data; + l_pd = l_pd->next; + if (!l_pd) { + l_pd = l_pdo; + l_pdo = NULL; + } + ch = find_channel(channel_list, pdch->id, FALSE); + if (!ch) { + /* TODO Emit a WARN message. */ + /* if (l_pdo) ...; */ + continue; + } + if (ch->type != SR_CHANNEL_LOGIC) { + /* TODO Emit a WARN message. */ + continue; + } + /* TODO Emit an INFO message. */ + g_hash_table_insert(channel_map, + g_strdup(pdch->id), g_strdup(ch->name)); + } + } + g_hash_table_iter_init(&iter, channel_map); while (g_hash_table_iter_next(&iter, &channel_id, &channel_target)) { + if (strcmp(channel_id, keyword_assign) == 0) + continue; if (!channel_target) { g_printerr("cli: Channel name for \"%s\" missing.\n", (char *)channel_id); -- 2.30.2 From 9d9f7b82008e3b3665bda12a63a3339e9f7aabc3 Mon Sep 17 00:00:00 2001 From: Gerhard Sittig Date: Fri, 7 Apr 2023 18:54:14 +0200 Subject: [PATCH 9/9] doc: update sigrok-cli(1) for channel assignment to decoder inputs Extend the sigrok-cli manpage section which discusses the -P option. Mention the assignment of logic channels to decoder inputs by index or by name. Automatic assignment by position in the absence of user specs seems to not have been recent implementations' default behaviour. Remove that outdated or incorrect comment. --- doc/sigrok-cli.1 | 24 ++++++++++++++++++------ 1 file changed, 18 insertions(+), 6 deletions(-) diff --git a/doc/sigrok-cli.1 b/doc/sigrok-cli.1 index 9c847a7..33174cd 100644 --- a/doc/sigrok-cli.1 +++ b/doc/sigrok-cli.1 @@ -1,4 +1,4 @@ -.TH SIGROK\-CLI 1 "March 28, 2019" +.TH SIGROK\-CLI 1 "April 07, 2023" .SH "NAME" sigrok\-cli \- Command-line client for the sigrok software .SH "SYNOPSIS" @@ -311,15 +311,27 @@ In this example, .B wordsize is an option supported by the .B spi -protocol decoder. Additionally, the user tells sigrok to decode the SPI +protocol decoder. Additionally, the user requests sigrok to decode the SPI protocol using channel 1 as MISO signal for SPI, channel 5 as MOSI, channel 3 as CLK, and channel 0 as CS# signal. .sp -Notice that the +The .B sigrok\-cli -application does not support "name matching". Instead it's assumed that the -traces in the input stream match the order of the decoder's input signals, -or that users explicitly specify the input channel to decoder signal mapping. +application can automatically assign logic channels to decoder inputs +in their strict channel index order (by means of the +.B auto_index +keyword), or can automatically assign logic channels to decoder inputs +when their names match (case insensitive match, +.B auto_names +keyword). Users need to explicitly request this assignment, the default +behaviour is to not automatically assign any signals. +.sp +Example: +.sp + $ +.B "sigrok\-cli \-i " +.br +.B " \-P ieee488:assign_channels=auto_names" .br .sp When multiple decoders are specified in the same -- 2.30.2