X-Git-Url: https://sigrok.org/gitweb/?p=sigrok-test.git;a=blobdiff_plain;f=decoder%2Fruntc.c;h=90c37b64b76746ed7391b8ae20c90c0703b3310e;hp=2193309881b6ed4cc85591d159a94518db1fb1a9;hb=c83a4758759625c438791d3aa5bc4c4823649157;hpb=021922274c9a92b2f3a830956084185f0a7a4ed2 diff --git a/decoder/runtc.c b/decoder/runtc.c index 2193309..90c37b6 100644 --- a/decoder/runtc.c +++ b/decoder/runtc.c @@ -37,9 +37,10 @@ #include #endif -int debug = FALSE; -int statistics = FALSE; -char *coverage_report; +static int debug = FALSE; +static int statistics = FALSE; +static char *coverage_report; +static struct sr_context *ctx; struct channel { char *name; @@ -51,18 +52,25 @@ struct option { GVariant *value; }; -struct pd { +struct initial_pin_info { char *name; + int value; +}; + +struct pd { + const char *name; GSList *channels; GSList *options; + GSList *initial_pins; }; struct output { - char *pd; + const char *pd; + const char *pd_id; int type; - char *class; + const char *class; int class_idx; - char *outfile; + const char *outfile; int outfd; }; @@ -73,12 +81,12 @@ struct cvg { GSList *missed_lines; }; -struct cvg *get_mod_cov(PyObject *py_cov, char *module_name); -void cvg_add(struct cvg *dst, struct cvg *src); -struct cvg *cvg_new(void); -gboolean find_missed_line(struct cvg *cvg, char *linespec); +static struct cvg *get_mod_cov(PyObject *py_cov, const char *module_name); +static void cvg_add(struct cvg *dst, const struct cvg *src); +static struct cvg *cvg_new(void); +static gboolean find_missed_line(struct cvg *cvg, const char *linespec); -static void logmsg(char *prefix, FILE *out, const char *format, va_list args) +static void logmsg(const char *prefix, FILE *out, const char *format, va_list args) { if (prefix) fprintf(out, "%s", prefix); @@ -130,27 +138,31 @@ static int srd_log(void *cb_data, int loglevel, const char *format, va_list args return SRD_OK; } -static void usage(char *msg) +static void usage(const char *msg) { if (msg) fprintf(stderr, "%s\n", msg); - printf("Usage: runtc [-dPpoiOf]\n"); - printf(" -d Debug\n"); - printf(" -P \n"); - printf(" -p (optional)\n"); - printf(" -o (optional)\n"); + printf("Usage: runtc [-dPpoiOfcS]\n"); + printf(" -d (enables debug output)\n"); + printf(" -P \n"); + printf(" -p (optional)\n"); + printf(" -o (optional)\n"); + printf(" -N (optional)\n"); printf(" -i \n"); printf(" -O \n"); printf(" -f (optional)\n"); printf(" -c (optional)\n"); + printf(" -S (enables statistics)\n"); exit(msg ? 1 : 0); } -/* This is a neutered version of libsigrokdecode's py_str_as_str(). It +/* + * This is a neutered version of libsigrokdecode's py_str_as_str(). It * does no error checking, but then the only strings it processes are - * generated by Python's repr(), so are known good. */ + * generated by Python's repr(), so are known good. + */ static char *py_str_as_str(const PyObject *py_str) { PyObject *py_encstr; @@ -164,6 +176,28 @@ static char *py_str_as_str(const PyObject *py_str) return outstr; } +/* + * The following routines are callbacks for libsigrokdecode. They receive + * output from protocol decoders, optionally dropping data to only forward + * a selected decoder's or class' information. Output is written to either + * a specified file or stdout, an external process will compare captured + * output against expectations. + * + * Note that runtc(1) output emits the decoder "class" name instead of the + * instance name. So that generated output remains compatible with existing + * .output files which hold expected output of test cases. Without this + * approach, developers had to "anticipate" instance names from test.conf + * setups (and knowledge about internal implementation details of the srd + * library), and adjust .output files to reflect those names. Or specify + * instance names in each and every test.conf description (-o inst_id=ID). + * + * It's assumed that runtc(1) is used to check stacked decoders, but not + * multiple stacks in parallel and no stacks with multiple instances of + * decoders of the same type. When such configurations become desirable, + * runtc(1) needs to emit the instance name, and test configurations and + * output expectations need adjustment. + */ + static void srd_cb_py(struct srd_proto_data *pdata, void *cb_data) { struct output *op; @@ -176,7 +210,7 @@ static void srd_cb_py(struct srd_proto_data *pdata, void *cb_data) pydata = pdata->data; DBG("ptr %p", pydata); - if (strcmp(pdata->pdo->di->inst_id, op->pd)) + if (strcmp(pdata->pdo->di->inst_id, op->pd_id)) /* This is not the PD selected for output. */ return; @@ -187,11 +221,11 @@ static void srd_cb_py(struct srd_proto_data *pdata, void *cb_data) s = py_str_as_str(pyrepr); Py_DecRef(pyrepr); - /* Output format for testing is '- : \n'. */ + /* Output format for testing is '- : \n'. */ out = g_string_sized_new(128); g_string_printf(out, "%" PRIu64 "-%" PRIu64 " %s: %s\n", pdata->start_sample, pdata->end_sample, - pdata->pdo->di->inst_id, s); + pdata->pdo->di->decoder->id, s); g_free(s); if (write(op->outfd, out->str, out->len) == -1) ERR("SRD_OUTPUT_PYTHON callback write failure!"); @@ -211,7 +245,7 @@ static void srd_cb_bin(struct srd_proto_data *pdata, void *cb_data) op = cb_data; pdb = pdata->data; - if (strcmp(pdata->pdo->di->inst_id, op->pd)) + if (strcmp(pdata->pdo->di->inst_id, op->pd_id)) /* This is not the PD selected for output. */ return; @@ -225,7 +259,7 @@ static void srd_cb_bin(struct srd_proto_data *pdata, void *cb_data) out = g_string_sized_new(128); g_string_printf(out, "%" PRIu64 "-%" PRIu64 " %s:", pdata->start_sample, pdata->end_sample, - pdata->pdo->di->inst_id); + pdata->pdo->di->decoder->id); for (i = 0; i < pdb->size; i++) { g_string_append_printf(out, " %.2x", pdb->data[i]); } @@ -237,6 +271,7 @@ static void srd_cb_bin(struct srd_proto_data *pdata, void *cb_data) static void srd_cb_ann(struct srd_proto_data *pdata, void *cb_data) { + struct srd_decoder_inst *di; struct srd_decoder *dec; struct srd_proto_data_annotation *pda; struct output *op; @@ -244,11 +279,17 @@ static void srd_cb_ann(struct srd_proto_data *pdata, void *cb_data) int i; char **dec_ann; - DBG("Annotation output from %s", pdata->pdo->di->inst_id); + /* + * Only inspect received annotations when they originate from + * the selected protocol decoder, and an optionally specified + * annotation class matches the received data. + */ op = cb_data; pda = pdata->data; - dec = pdata->pdo->di->decoder; - if (strcmp(pdata->pdo->di->inst_id, op->pd)) + di = pdata->pdo->di; + dec = di->decoder; + DBG("Annotation output from %s", di->inst_id); + if (strcmp(di->inst_id, op->pd_id)) /* This is not the PD selected for output. */ return; @@ -259,11 +300,17 @@ static void srd_cb_ann(struct srd_proto_data *pdata, void *cb_data) */ return; + /* + * Print the annotation information in textual representation + * to the specified output file. Prefix the annotation strings + * with the start and end sample number, the decoder name, and + * the annotation name. + */ dec_ann = g_slist_nth_data(dec->annotations, pda->ann_class); line = g_string_sized_new(256); g_string_printf(line, "%" PRIu64 "-%" PRIu64 " %s: %s:", pdata->start_sample, pdata->end_sample, - pdata->pdo->di->inst_id, dec_ann[0]); + dec->id, dec_ann[0]); for (i = 0; pda->ann_text[i]; i++) g_string_append_printf(line, " \"%s\"", pda->ann_text[i]); g_string_append(line, "\n"); @@ -276,12 +323,12 @@ static void srd_cb_ann(struct srd_proto_data *pdata, void *cb_data) static void sr_cb(const struct sr_dev_inst *sdi, const struct sr_datafeed_packet *packet, void *cb_data) { + static int samplecnt = 0; const struct sr_datafeed_logic *logic; struct srd_session *sess; GVariant *gvar; uint64_t samplerate; int num_samples; - static int samplecnt = 0; struct sr_dev_driver *driver; sess = cb_data; @@ -314,8 +361,8 @@ static void sr_cb(const struct sr_dev_inst *sdi, DBG("Received SR_DF_LOGIC (%"PRIu64" bytes, unitsize = %d).", logic->length, logic->unitsize); srd_session_send(sess, samplecnt, samplecnt + num_samples, - logic->data, logic->length); - samplecnt += logic->length / logic->unitsize; + logic->data, logic->length, logic->unitsize); + samplecnt += num_samples; break; case SR_DF_END: DBG("Received SR_DF_END"); @@ -324,7 +371,7 @@ static void sr_cb(const struct sr_dev_inst *sdi, } -static int run_testcase(char *infile, GSList *pdlist, struct output *op) +static int run_testcase(const char *infile, GSList *pdlist, struct output *op) { struct srd_session *sess; struct srd_decoder *dec; @@ -335,37 +382,35 @@ static int run_testcase(char *infile, GSList *pdlist, struct output *op) struct option *option; GVariant *gvar; GHashTable *channels, *opts; - GSList *pdl, *l, *devices; + GSList *pdl, *l, *l2, *devices; int idx, i; int max_channel; char **decoder_class; struct sr_session *sr_sess; gboolean is_number; const char *s; - struct sr_dev_inst *sdi; - uint64_t unitsize; - struct sr_dev_driver *driver; + GArray *initial_pins; + struct initial_pin_info *initial_pin; if (op->outfile) { if ((op->outfd = open(op->outfile, O_CREAT|O_WRONLY, 0600)) == -1) { ERR("Unable to open %s for writing: %s", op->outfile, - strerror(errno)); + g_strerror(errno)); return FALSE; } } - if (sr_session_load(infile, &sr_sess) != SR_OK) + if (sr_session_load(ctx, infile, &sr_sess) != SR_OK){ + ERR("sr_session_load() failed"); return FALSE; + } sr_session_dev_list(sr_sess, &devices); - sdi = devices->data; - driver = sr_dev_inst_driver_get(sdi); - sr_config_get(driver, sdi, NULL, SR_CONF_CAPTURE_UNITSIZE, &gvar); - unitsize = g_variant_get_uint64(gvar); - g_variant_unref(gvar); - if (srd_session_new(&sess) != SRD_OK) + if (srd_session_new(&sess) != SRD_OK) { + ERR("srd_session_new() failed"); return FALSE; + } sr_session_datafeed_callback_add(sr_sess, sr_cb, sess); switch (op->type) { case SRD_OUTPUT_ANN: @@ -378,6 +423,7 @@ static int run_testcase(char *infile, GSList *pdlist, struct output *op) cb = srd_cb_py; break; default: + ERR("Invalid op->type"); return FALSE; } srd_pd_output_callback_add(sess, op->type, cb, op); @@ -386,8 +432,10 @@ static int run_testcase(char *infile, GSList *pdlist, struct output *op) pd = NULL; for (pdl = pdlist; pdl; pdl = pdl->next) { pd = pdl->data; - if (srd_decoder_load(pd->name) != SRD_OK) + if (srd_decoder_load(pd->name) != SRD_OK) { + ERR("srd_decoder_load() failed"); return FALSE; + } /* Instantiate decoder and pass in options. */ opts = g_hash_table_new_full(g_str_hash, g_str_equal, NULL, @@ -411,10 +459,23 @@ static int run_testcase(char *infile, GSList *pdlist, struct output *op) g_hash_table_insert(opts, option->key, option->value); } } - if (!(di = srd_inst_new(sess, pd->name, opts))) + if (!(di = srd_inst_new(sess, pd->name, opts))) { + ERR("srd_inst_new() failed"); return FALSE; + } g_hash_table_destroy(opts); + /* + * Get (a reference to) the decoder instance's ID if we + * are about to receive PD output from it. We need to + * filter output that carries the decoder instance's name. + */ + if (strcmp(pd->name, op->pd) == 0) { + op->pd_id = di->inst_id; + DBG("Decoder of type \"%s\" has instance ID \"%s\".", + op->pd, op->pd_id); + } + /* Map channels. */ if (pd->channels) { channels = g_hash_table_new_full(g_str_hash, g_str_equal, NULL, @@ -429,13 +490,41 @@ static int run_testcase(char *infile, GSList *pdlist, struct output *op) g_hash_table_insert(channels, channel->name, gvar); } - if (srd_inst_channel_set_all(di, channels, unitsize) != SRD_OK) + if (srd_inst_channel_set_all(di, channels) != SRD_OK) { + ERR("srd_inst_channel_set_all() failed"); return FALSE; + } g_hash_table_destroy(channels); } - /* If this is not the first decoder in the list, stack it - * on top of the previous one. */ + /* Set initial pins. */ + if (pd->initial_pins) { + initial_pins = g_array_sized_new(FALSE, TRUE, sizeof(uint8_t), + di->dec_num_channels); + g_array_set_size(initial_pins, di->dec_num_channels); + memset(initial_pins->data, SRD_INITIAL_PIN_SAME_AS_SAMPLE0, + di->dec_num_channels); + + for (l = pd->channels, idx = 0; l; l = l->next, idx++) { + channel = l->data; + for (l2 = pd->initial_pins; l2; l2 = l2->next) { + initial_pin = l2->data; + if (!strcmp(initial_pin->name, channel->name)) + initial_pins->data[idx] = initial_pin->value; + } + } + + if (srd_inst_initial_pins_set_all(di, initial_pins) != SRD_OK) { + ERR("srd_inst_initial_pins_set_all() failed"); + return FALSE; + } + g_array_free(initial_pins, TRUE); + } + + /* + * If this is not the first decoder in the list, stack it + * on top of the previous one. + */ if (prev_di) { if (srd_inst_stack(sess, prev_di, di) != SRD_OK) { ERR("Failed to stack decoder instances."); @@ -444,33 +533,43 @@ static int run_testcase(char *infile, GSList *pdlist, struct output *op) } prev_di = di; } + /* + * Bail out if we haven't created an instance of the selected + * decoder type of which we shall grab output data from. + */ + if (!op->pd_id) { + ERR("No / invalid decoder"); + return FALSE; + } - /* Resolve top decoder's class index, so we can match. */ + /* Resolve selected decoder's class index, so we can match. */ dec = srd_decoder_get_by_id(pd->name); if (op->class) { if (op->type == SRD_OUTPUT_ANN) l = dec->annotations; else if (op->type == SRD_OUTPUT_BINARY) l = dec->binary; - else + else { /* Only annotations and binary can have a class. */ + ERR("Invalid decoder class"); return FALSE; + } idx = 0; while (l) { decoder_class = l->data; if (!strcmp(decoder_class[0], op->class)) { op->class_idx = idx; break; - } else - idx++; + } + idx++; l = l->next; } if (op->class_idx == -1) { ERR("Output class '%s' not found in decoder %s.", op->class, pd->name); return FALSE; - } else - DBG("Class %s index is %d", op->class, op->class_idx); + } + DBG("Class %s index is %d", op->class, op->class_idx); } sr_session_start(sr_sess); @@ -523,7 +622,7 @@ static PyObject *start_coverage(GSList *pdlist) return py_cov; } -struct cvg *get_mod_cov(PyObject *py_cov, char *module_name) +static struct cvg *get_mod_cov(PyObject *py_cov, const char *module_name) { PyObject *py_mod, *py_pathlist, *py_path, *py_func, *py_pd; PyObject *py_result, *py_missed, *py_item; @@ -540,7 +639,7 @@ struct cvg *get_mod_cov(PyObject *py_cov, char *module_name) py_pathlist = PyObject_GetAttrString(py_mod, "__path__"); for (i = 0; i < PyList_Size(py_pathlist); i++) { py_path = PyList_GetItem(py_pathlist, i); - PyUnicode_FSConverter(PyList_GetItem(py_pathlist, i), &py_path); + PyUnicode_FSConverter(PyList_GetItem(py_pathlist, i), &py_path); path = PyBytes_AS_STRING(py_path); if (!(d = opendir(path))) { ERR("Invalid module path '%s'", path); @@ -591,7 +690,7 @@ struct cvg *get_mod_cov(PyObject *py_cov, char *module_name) return cvg_mod; } -struct cvg *cvg_new(void) +static struct cvg *cvg_new(void) { struct cvg *cvg; @@ -600,7 +699,7 @@ struct cvg *cvg_new(void) return cvg; } -gboolean find_missed_line(struct cvg *cvg, char *linespec) +static gboolean find_missed_line(struct cvg *cvg, const char *linespec) { GSList *l; @@ -611,7 +710,7 @@ gboolean find_missed_line(struct cvg *cvg, char *linespec) return FALSE; } -void cvg_add(struct cvg *dst, struct cvg *src) +static void cvg_add(struct cvg *dst, const struct cvg *src) { GSList *l; char *linespec; @@ -709,7 +808,6 @@ static int report_coverage(PyObject *py_cov, GSList *pdlist) int main(int argc, char **argv) { - struct sr_context *ctx; PyObject *coverage; GSList *pdlist; struct pd *pd; @@ -718,9 +816,11 @@ int main(int argc, char **argv) struct output *op; int ret, c; char *opt_infile, **kv, **opstr; + struct initial_pin_info *initial_pin; op = malloc(sizeof(struct output)); op->pd = NULL; + op->pd_id = NULL; op->type = -1; op->class = NULL; op->class_idx = -1; @@ -730,7 +830,7 @@ int main(int argc, char **argv) opt_infile = NULL; pd = NULL; coverage = NULL; - while ((c = getopt(argc, argv, "dP:p:o:i:O:f:c:S")) != -1) { + while ((c = getopt(argc, argv, "dP:p:o:N:i:O:f:c:S")) != -1) { switch (c) { case 'd': debug = TRUE; @@ -738,11 +838,12 @@ int main(int argc, char **argv) case 'P': pd = g_malloc(sizeof(struct pd)); pd->name = g_strdup(optarg); - pd->channels = pd->options = NULL; + pd->channels = pd->options = pd->initial_pins = NULL; pdlist = g_slist_append(pdlist, pd); break; case 'p': case 'o': + case 'N': if (g_slist_length(pdlist) == 0) { /* No previous -P. */ ERR("Syntax error at '%s'", optarg); @@ -758,16 +859,22 @@ int main(int argc, char **argv) if (c == 'p') { channel = malloc(sizeof(struct channel)); channel->name = g_strdup(kv[0]); - channel->channel = strtoul(kv[1], 0, 10); + channel->channel = strtoul(kv[1], NULL, 10); /* Apply to last PD. */ pd->channels = g_slist_append(pd->channels, channel); - } else { + } else if (c == 'o') { option = malloc(sizeof(struct option)); option->key = g_strdup(kv[0]); option->value = g_variant_new_string(kv[1]); - g_variant_ref_sink(option->value); + g_variant_ref_sink(option->value); /* Apply to last PD. */ pd->options = g_slist_append(pd->options, option); + } else { + initial_pin = malloc(sizeof(struct initial_pin_info)); + initial_pin->name = g_strdup(kv[0]); + initial_pin->value = strtoul(kv[1], NULL, 10); + /* Apply to last PD. */ + pd->initial_pins = g_slist_append(pd->initial_pins, initial_pin); } break; case 'i':