2 * This file is part of the sigrok-test project.
4 * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
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.
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.
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/>.
21 #include <libsigrokdecode/libsigrokdecode.h>
22 #include <libsigrok/libsigrok.h>
28 #include <sys/types.h>
33 #include <sys/resource.h>
40 static int debug = FALSE;
41 static int statistics = FALSE;
42 static char *coverage_report;
43 static struct sr_context *ctx;
77 static struct cvg *get_mod_cov(PyObject *py_cov, const char *module_name);
78 static void cvg_add(struct cvg *dst, const struct cvg *src);
79 static struct cvg *cvg_new(void);
80 static gboolean find_missed_line(struct cvg *cvg, const char *linespec);
82 static void logmsg(const char *prefix, FILE *out, const char *format, va_list args)
85 fprintf(out, "%s", prefix);
86 vfprintf(out, format, args);
90 static void DBG(const char *format, ...)
96 va_start(args, format);
97 logmsg("DBG: runtc: ", stdout, format, args);
101 static void ERR(const char *format, ...)
105 va_start(args, format);
106 logmsg("Error: ", stderr, format, args);
110 static int sr_log(void *cb_data, int loglevel, const char *format, va_list args)
114 if (loglevel == SR_LOG_ERR || loglevel == SR_LOG_WARN)
115 logmsg("Error: sr: ", stderr, format, args);
117 logmsg("DBG: sr: ", stdout, format, args);
122 static int srd_log(void *cb_data, int loglevel, const char *format, va_list args)
126 if (loglevel == SRD_LOG_ERR || loglevel == SRD_LOG_WARN)
127 logmsg("Error: srd: ", stderr, format, args);
129 logmsg("DBG: srd: ", stdout, format, args);
134 static void usage(const char *msg)
137 fprintf(stderr, "%s\n", msg);
139 printf("Usage: runtc [-dPpoiOfcS]\n");
140 printf(" -d (enables debug output)\n");
141 printf(" -P <protocol decoder>\n");
142 printf(" -p <channelname=channelnum> (optional)\n");
143 printf(" -o <channeloption=value> (optional)\n");
144 printf(" -i <input file>\n");
145 printf(" -O <output-pd:output-type[:output-class]>\n");
146 printf(" -f <output file> (optional)\n");
147 printf(" -c <coverage report> (optional)\n");
148 printf(" -S (enables statistics)\n");
154 * This is a neutered version of libsigrokdecode's py_str_as_str(). It
155 * does no error checking, but then the only strings it processes are
156 * generated by Python's repr(), so are known good.
158 static char *py_str_as_str(const PyObject *py_str)
163 py_encstr = PyUnicode_AsEncodedString((PyObject *)py_str, "utf-8", NULL);
164 str = PyBytes_AS_STRING(py_encstr);
165 outstr = g_strdup(str);
166 Py_DecRef(py_encstr);
171 static void srd_cb_py(struct srd_proto_data *pdata, void *cb_data)
174 PyObject *pydata, *pyrepr;
178 DBG("Python output from %s", pdata->pdo->di->decoder->id);
180 pydata = pdata->data;
181 DBG("ptr %p", pydata);
183 if (strcmp(pdata->pdo->di->decoder->id, op->pd))
184 /* This is not the PD selected for output. */
187 if (!(pyrepr = PyObject_Repr(pydata))) {
188 ERR("Invalid Python object.");
191 s = py_str_as_str(pyrepr);
194 /* Output format for testing is '<ss>-<es> <inst-id>: <repr>\n'. */
195 out = g_string_sized_new(128);
196 g_string_printf(out, "%" PRIu64 "-%" PRIu64 " %s: %s\n",
197 pdata->start_sample, pdata->end_sample,
198 pdata->pdo->di->decoder->id, s);
200 if (write(op->outfd, out->str, out->len) == -1)
201 ERR("SRD_OUTPUT_PYTHON callback write failure!");
202 DBG("wrote '%s'", out->str);
203 g_string_free(out, TRUE);
207 static void srd_cb_bin(struct srd_proto_data *pdata, void *cb_data)
209 struct srd_proto_data_binary *pdb;
214 DBG("Binary output from %s", pdata->pdo->di->decoder->id);
218 if (strcmp(pdata->pdo->di->decoder->id, op->pd))
219 /* This is not the PD selected for output. */
222 if (op->class_idx != -1 && op->class_idx != pdb->bin_class)
224 * This output takes a specific binary class,
225 * but not the one that just came in.
229 out = g_string_sized_new(128);
230 g_string_printf(out, "%" PRIu64 "-%" PRIu64 " %s:",
231 pdata->start_sample, pdata->end_sample,
232 pdata->pdo->di->decoder->id);
233 for (i = 0; i < pdb->size; i++) {
234 g_string_append_printf(out, " %.2x", pdb->data[i]);
236 g_string_append(out, "\n");
237 if (write(op->outfd, out->str, out->len) == -1)
238 ERR("SRD_OUTPUT_BINARY callback write failure!");
242 static void srd_cb_ann(struct srd_proto_data *pdata, void *cb_data)
244 struct srd_decoder *dec;
245 struct srd_proto_data_annotation *pda;
251 DBG("Annotation output from %s", pdata->pdo->di->decoder->id);
254 dec = pdata->pdo->di->decoder;
255 if (strcmp(pdata->pdo->di->decoder->id, op->pd))
256 /* This is not the PD selected for output. */
259 if (op->class_idx != -1 && op->class_idx != pda->ann_class)
261 * This output takes a specific annotation class,
262 * but not the one that just came in.
266 dec_ann = g_slist_nth_data(dec->annotations, pda->ann_class);
267 line = g_string_sized_new(256);
268 g_string_printf(line, "%" PRIu64 "-%" PRIu64 " %s: %s:",
269 pdata->start_sample, pdata->end_sample,
270 pdata->pdo->di->decoder->id, dec_ann[0]);
271 for (i = 0; pda->ann_text[i]; i++)
272 g_string_append_printf(line, " \"%s\"", pda->ann_text[i]);
273 g_string_append(line, "\n");
274 if (write(op->outfd, line->str, line->len) == -1)
275 ERR("SRD_OUTPUT_ANN callback write failure!");
276 g_string_free(line, TRUE);
280 static void sr_cb(const struct sr_dev_inst *sdi,
281 const struct sr_datafeed_packet *packet, void *cb_data)
283 static int samplecnt = 0;
284 const struct sr_datafeed_logic *logic;
285 struct srd_session *sess;
289 struct sr_dev_driver *driver;
293 driver = sr_dev_inst_driver_get(sdi);
295 switch (packet->type) {
297 DBG("Received SR_DF_HEADER");
298 if (sr_config_get(driver, sdi, NULL, SR_CONF_SAMPLERATE,
300 ERR("Getting samplerate failed");
303 samplerate = g_variant_get_uint64(gvar);
304 g_variant_unref(gvar);
305 if (srd_session_metadata_set(sess, SRD_CONF_SAMPLERATE,
306 g_variant_new_uint64(samplerate)) != SRD_OK) {
307 ERR("Setting samplerate failed");
310 if (srd_session_start(sess) != SRD_OK) {
311 ERR("Session start failed");
316 logic = packet->payload;
317 num_samples = logic->length / logic->unitsize;
318 DBG("Received SR_DF_LOGIC (%"PRIu64" bytes, unitsize = %d).",
319 logic->length, logic->unitsize);
320 srd_session_send(sess, samplecnt, samplecnt + num_samples,
321 logic->data, logic->length, logic->unitsize);
322 samplecnt += num_samples;
325 DBG("Received SR_DF_END");
331 static int run_testcase(const char *infile, GSList *pdlist, struct output *op)
333 struct srd_session *sess;
334 struct srd_decoder *dec;
335 struct srd_decoder_inst *di, *prev_di;
336 srd_pd_output_callback cb;
338 struct channel *channel;
339 struct option *option;
341 GHashTable *channels, *opts;
342 GSList *pdl, *l, *devices;
345 char **decoder_class;
346 struct sr_session *sr_sess;
351 if ((op->outfd = open(op->outfile, O_CREAT|O_WRONLY, 0600)) == -1) {
352 ERR("Unable to open %s for writing: %s", op->outfile,
358 if (sr_session_load(ctx, infile, &sr_sess) != SR_OK)
361 sr_session_dev_list(sr_sess, &devices);
363 if (srd_session_new(&sess) != SRD_OK)
365 sr_session_datafeed_callback_add(sr_sess, sr_cb, sess);
370 case SRD_OUTPUT_BINARY:
373 case SRD_OUTPUT_PYTHON:
379 srd_pd_output_callback_add(sess, op->type, cb, op);
383 for (pdl = pdlist; pdl; pdl = pdl->next) {
385 if (srd_decoder_load(pd->name) != SRD_OK)
388 /* Instantiate decoder and pass in options. */
389 opts = g_hash_table_new_full(g_str_hash, g_str_equal, NULL,
390 (GDestroyNotify)g_variant_unref);
391 for (l = pd->options; l; l = l->next) {
395 s = g_variant_get_string(option->value, NULL);
396 for (i = 0; i < (int)strlen(s); i++) {
402 /* Integer option value */
403 g_hash_table_insert(opts, option->key,
404 g_variant_new_int64(strtoull(s, NULL, 10)));
406 /* String option value */
407 g_hash_table_insert(opts, option->key, option->value);
410 if (!(di = srd_inst_new(sess, pd->name, opts)))
412 g_hash_table_destroy(opts);
416 channels = g_hash_table_new_full(g_str_hash, g_str_equal, NULL,
417 (GDestroyNotify)g_variant_unref);
419 for (l = pd->channels; l; l = l->next) {
421 if (channel->channel > max_channel)
422 max_channel = channel->channel;
423 gvar = g_variant_new_int32(channel->channel);
424 g_variant_ref_sink(gvar);
425 g_hash_table_insert(channels, channel->name, gvar);
428 if (srd_inst_channel_set_all(di, channels) != SRD_OK)
430 g_hash_table_destroy(channels);
434 * If this is not the first decoder in the list, stack it
435 * on top of the previous one.
438 if (srd_inst_stack(sess, prev_di, di) != SRD_OK) {
439 ERR("Failed to stack decoder instances.");
446 /* Resolve top decoder's class index, so we can match. */
447 dec = srd_decoder_get_by_id(pd->name);
449 if (op->type == SRD_OUTPUT_ANN)
450 l = dec->annotations;
451 else if (op->type == SRD_OUTPUT_BINARY)
454 /* Only annotations and binary can have a class. */
458 decoder_class = l->data;
459 if (!strcmp(decoder_class[0], op->class)) {
466 if (op->class_idx == -1) {
467 ERR("Output class '%s' not found in decoder %s.",
468 op->class, pd->name);
471 DBG("Class %s index is %d", op->class, op->class_idx);
474 sr_session_start(sr_sess);
475 sr_session_run(sr_sess);
476 sr_session_stop(sr_sess);
478 srd_session_destroy(sess);
486 static PyObject *start_coverage(GSList *pdlist)
488 PyObject *py_mod, *py_pdlist, *py_pd, *py_func, *py_args, *py_kwargs, *py_cov;
492 DBG("Starting coverage.");
494 if (!(py_mod = PyImport_ImportModule("coverage")))
497 if (!(py_pdlist = PyList_New(0)))
499 for (l = pdlist; l; l = l->next) {
501 py_pd = PyUnicode_FromFormat("*/%s/*.py", pd->name);
502 if (PyList_Append(py_pdlist, py_pd) < 0)
506 if (!(py_func = PyObject_GetAttrString(py_mod, "coverage")))
508 if (!(py_args = PyTuple_New(0)))
510 if (!(py_kwargs = Py_BuildValue("{sO}", "include", py_pdlist)))
512 if (!(py_cov = PyObject_Call(py_func, py_args, py_kwargs)))
514 if (!(PyObject_CallMethod(py_cov, "start", NULL)))
516 Py_DecRef(py_pdlist);
518 Py_DecRef(py_kwargs);
524 static struct cvg *get_mod_cov(PyObject *py_cov, const char *module_name)
526 PyObject *py_mod, *py_pathlist, *py_path, *py_func, *py_pd;
527 PyObject *py_result, *py_missed, *py_item;
531 int num_lines, num_missed, linenum, i, j;
532 char *path, *linespec;
534 if (!(py_mod = PyImport_ImportModule(module_name)))
538 py_pathlist = PyObject_GetAttrString(py_mod, "__path__");
539 for (i = 0; i < PyList_Size(py_pathlist); i++) {
540 py_path = PyList_GetItem(py_pathlist, i);
541 PyUnicode_FSConverter(PyList_GetItem(py_pathlist, i), &py_path);
542 path = PyBytes_AS_STRING(py_path);
543 if (!(d = opendir(path))) {
544 ERR("Invalid module path '%s'", path);
547 while ((de = readdir(d))) {
548 if (strncmp(de->d_name + strlen(de->d_name) - 3, ".py", 3))
551 if (!(py_func = PyObject_GetAttrString(py_cov, "analysis2")))
553 if (!(py_pd = PyUnicode_FromFormat("%s/%s", path, de->d_name)))
555 if (!(py_result = PyObject_CallFunction(py_func, "O", py_pd)))
562 if (PyTuple_Size(py_result) != 5) {
563 ERR("Invalid result from coverage of '%s/%s'", path, de->d_name);
566 num_lines = PyList_Size(PyTuple_GetItem(py_result, 1));
567 py_missed = PyTuple_GetItem(py_result, 3);
568 num_missed = PyList_Size(py_missed);
569 cvg_mod->num_lines += num_lines;
570 cvg_mod->num_missed += num_missed;
571 for (j = 0; j < num_missed; j++) {
572 py_item = PyList_GetItem(py_missed, j);
573 linenum = PyLong_AsLong(py_item);
574 linespec = g_strdup_printf("%s/%s:%d", module_name,
575 de->d_name, linenum);
576 cvg_mod->missed_lines = g_slist_append(cvg_mod->missed_lines, linespec);
578 DBG("Coverage for %s/%s: %d lines, %d missed.",
579 module_name, de->d_name, num_lines, num_missed);
580 Py_DecRef(py_result);
583 if (cvg_mod->num_lines)
584 cvg_mod->coverage = 100 - ((float)cvg_mod->num_missed / (float)cvg_mod->num_lines * 100);
592 static struct cvg *cvg_new(void)
596 cvg = calloc(1, sizeof(struct cvg));
601 static gboolean find_missed_line(struct cvg *cvg, const char *linespec)
605 for (l = cvg->missed_lines; l; l = l->next)
606 if (!strcmp(l->data, linespec))
612 static void cvg_add(struct cvg *dst, const struct cvg *src)
617 dst->num_lines += src->num_lines;
618 dst->num_missed += src->num_missed;
619 for (l = src->missed_lines; l; l = l->next) {
621 if (!find_missed_line(dst, linespec))
622 dst->missed_lines = g_slist_append(dst->missed_lines, linespec);
627 static int report_coverage(PyObject *py_cov, GSList *pdlist)
629 PyObject *py_func, *py_mod, *py_args, *py_kwargs, *py_outfile, *py_pct;
632 struct cvg *cvg_mod, *cvg_all;
633 float total_coverage;
634 int lines, missed, cnt;
636 DBG("Making coverage report.");
638 /* Get coverage for each module in the stack. */
641 for (cnt = 0, l = pdlist; l; l = l->next, cnt++) {
643 if (!(cvg_mod = get_mod_cov(py_cov, pd->name)))
645 printf("coverage: scope=%s coverage=%.0f%% lines=%d missed=%d "
646 "missed_lines=", pd->name, cvg_mod->coverage,
647 cvg_mod->num_lines, cvg_mod->num_missed);
648 for (ml = cvg_mod->missed_lines; ml; ml = ml->next) {
649 if (ml != cvg_mod->missed_lines)
651 printf("%s", (char *)ml->data);
654 lines += cvg_mod->num_lines;
655 missed += cvg_mod->num_missed;
656 cvg_add(cvg_all, cvg_mod);
657 DBG("Coverage for module %s: %d lines, %d missed", pd->name,
658 cvg_mod->num_lines, cvg_mod->num_missed);
662 total_coverage = 100 - ((float)missed / (float)lines * 100);
664 /* Machine-readable stats on stdout. */
665 printf("coverage: scope=all coverage=%.0f%% lines=%d missed=%d\n",
666 total_coverage, cvg_all->num_lines, cvg_all->num_missed);
668 /* Write text report to file. */
669 /* io.open(coverage_report, "w") */
670 if (!(py_mod = PyImport_ImportModule("io")))
672 if (!(py_func = PyObject_GetAttrString(py_mod, "open")))
674 if (!(py_args = PyTuple_New(0)))
676 if (!(py_kwargs = Py_BuildValue("{ssss}", "file", coverage_report,
679 if (!(py_outfile = PyObject_Call(py_func, py_args, py_kwargs)))
681 Py_DecRef(py_kwargs);
684 /* py_cov.report(file=py_outfile) */
685 if (!(py_func = PyObject_GetAttrString(py_cov, "report")))
687 if (!(py_kwargs = Py_BuildValue("{sO}", "file", py_outfile)))
689 if (!(py_pct = PyObject_Call(py_func, py_args, py_kwargs)))
692 Py_DecRef(py_kwargs);
695 /* py_outfile.close() */
696 if (!(py_func = PyObject_GetAttrString(py_outfile, "close")))
698 if (!PyObject_Call(py_func, py_args, NULL))
700 Py_DecRef(py_outfile);
708 int main(int argc, char **argv)
713 struct channel *channel;
714 struct option *option;
717 char *opt_infile, **kv, **opstr;
719 op = malloc(sizeof(struct output));
730 while ((c = getopt(argc, argv, "dP:p:o:i:O:f:c:S")) != -1) {
736 pd = g_malloc(sizeof(struct pd));
737 pd->name = g_strdup(optarg);
738 pd->channels = pd->options = NULL;
739 pdlist = g_slist_append(pdlist, pd);
743 if (g_slist_length(pdlist) == 0) {
744 /* No previous -P. */
745 ERR("Syntax error at '%s'", optarg);
748 kv = g_strsplit(optarg, "=", 0);
749 if (!kv[0] || (!kv[1] || kv[2])) {
751 ERR("Syntax error at '%s'", optarg);
756 channel = malloc(sizeof(struct channel));
757 channel->name = g_strdup(kv[0]);
758 channel->channel = strtoul(kv[1], NULL, 10);
759 /* Apply to last PD. */
760 pd->channels = g_slist_append(pd->channels, channel);
762 option = malloc(sizeof(struct option));
763 option->key = g_strdup(kv[0]);
764 option->value = g_variant_new_string(kv[1]);
765 g_variant_ref_sink(option->value);
766 /* Apply to last PD. */
767 pd->options = g_slist_append(pd->options, option);
774 opstr = g_strsplit(optarg, ":", 0);
775 if (!opstr[0] || !opstr[1]) {
776 /* Need at least abc:def. */
777 ERR("Syntax error at '%s'", optarg);
781 op->pd = g_strdup(opstr[0]);
782 if (!strcmp(opstr[1], "annotation"))
783 op->type = SRD_OUTPUT_ANN;
784 else if (!strcmp(opstr[1], "binary"))
785 op->type = SRD_OUTPUT_BINARY;
786 else if (!strcmp(opstr[1], "python"))
787 op->type = SRD_OUTPUT_PYTHON;
788 else if (!strcmp(opstr[1], "exception"))
789 /* Doesn't matter, we just need it to bomb out. */
790 op->type = SRD_OUTPUT_PYTHON;
792 ERR("Unknown output type '%s'", opstr[1]);
797 op->class = g_strdup(opstr[2]);
801 op->outfile = g_strdup(optarg);
805 coverage_report = optarg;
816 if (g_slist_length(pdlist) == 0)
820 if (!op->pd || op->type == -1)
823 sr_log_callback_set(sr_log, NULL);
824 if (sr_init(&ctx) != SR_OK)
827 srd_log_callback_set(srd_log, NULL);
828 if (srd_init(DECODERS_DIR) != SRD_OK)
831 if (coverage_report) {
832 if (!(coverage = start_coverage(pdlist))) {
833 DBG("Failed to start coverage.");
834 if (PyErr_Occurred()) {
842 if (!run_testcase(opt_infile, pdlist, op))
846 DBG("Stopping coverage.");
848 if (!(PyObject_CallMethod(coverage, "stop", NULL)))
849 ERR("Failed to stop coverage.");
850 else if (!(report_coverage(coverage, pdlist)))
851 ERR("Failed to make coverage report.");
853 DBG("Coverage report in %s", coverage_report);
855 if (PyErr_Occurred()) {