pdtest: add support for input format specs in test.conf files
[sigrok-test.git] / decoder / runtc.c
1 /*
2  * This file is part of the sigrok-test 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
20 #include <config.h>
21
22 #include <Python.h>
23 #include <libsigrokdecode/libsigrokdecode.h>
24 #include <libsigrok/libsigrok.h>
25 #include <stdlib.h>
26 #include <stdio.h>
27 #include <stdarg.h>
28 #include <unistd.h>
29 #include <errno.h>
30 #include <sys/types.h>
31 #include <sys/stat.h>
32 #include <fcntl.h>
33 #include <time.h>
34 #include <sys/time.h>
35 #include <sys/resource.h>
36 #include <dirent.h>
37 #include <glib.h>
38 #ifdef __LINUX__
39 #include <sched.h>
40 #endif
41
42 static int debug = FALSE;
43 static int statistics = FALSE;
44 static char *coverage_report;
45 static struct sr_context *ctx;
46
47 struct channel {
48         char *name;
49         int channel;
50 };
51
52 struct option {
53         char *key;
54         GVariant *value;
55 };
56
57 struct initial_pin_info {
58         char *name;
59         int value;
60 };
61
62 struct pd {
63         const char *name;
64         GSList *channels;
65         GSList *options;
66         GSList *initial_pins;
67 };
68
69 struct output {
70         const char *pd;
71         const char *pd_id;
72         int type;
73         const char *class;
74         int class_idx;
75         const char *outfile;
76         int outfd;
77 };
78
79 struct cvg {
80         int num_lines;
81         int num_missed;
82         float coverage;
83         GSList *missed_lines;
84 };
85
86 static struct cvg *get_mod_cov(PyObject *py_cov, const char *module_name);
87 static void cvg_add(struct cvg *dst, const struct cvg *src);
88 static struct cvg *cvg_new(void);
89 static gboolean find_missed_line(struct cvg *cvg, const char *linespec);
90
91 static void logmsg(const char *prefix, FILE *out, const char *format, va_list args)
92 {
93         if (prefix)
94                 fprintf(out, "%s", prefix);
95         vfprintf(out, format, args);
96         fprintf(out, "\n");
97 }
98
99 static void DBG(const char *format, ...)
100 {
101         va_list args;
102
103         if (!debug)
104                 return;
105         va_start(args, format);
106         logmsg("DBG: runtc: ", stdout, format, args);
107         va_end(args);
108 }
109
110 static void ERR(const char *format, ...)
111 {
112         va_list args;
113
114         va_start(args, format);
115         logmsg("Error: ", stderr, format, args);
116         va_end(args);
117 }
118
119 static int sr_log(void *cb_data, int loglevel, const char *format, va_list args)
120 {
121         (void)cb_data;
122
123         if (loglevel == SR_LOG_ERR || loglevel == SR_LOG_WARN)
124                 logmsg("Error: sr: ", stderr, format, args);
125         else if (debug)
126                 logmsg("DBG: sr: ", stdout, format, args);
127
128         return SRD_OK;
129 }
130
131 static int srd_log(void *cb_data, int loglevel, const char *format, va_list args)
132 {
133         (void)cb_data;
134
135         if (loglevel == SRD_LOG_ERR || loglevel == SRD_LOG_WARN)
136                 logmsg("Error: srd: ", stderr, format, args);
137         else if (debug)
138                 logmsg("DBG: srd: ", stdout, format, args);
139
140         return SRD_OK;
141 }
142
143 static void usage(const char *msg)
144 {
145         if (msg)
146                 fprintf(stderr, "%s\n", msg);
147
148         printf("Usage: runtc [-dPpoiOfcS]\n");
149         printf("  -d  (enables debug output)\n");
150         printf("  -P <protocol decoder>\n");
151         printf("  -p <channelname=channelnum> (optional)\n");
152         printf("  -o <channeloption=value> (optional)\n");
153         printf("  -N <channelname=initial-pin-value> (optional)\n");
154         printf("  -i <input file>\n");
155         printf("  -O <output-pd:output-type[:output-class]>\n");
156         printf("  -f <output file> (optional)\n");
157         printf("  -c <coverage report> (optional)\n");
158         printf("  -S  (enables statistics)\n");
159         exit(msg ? 1 : 0);
160
161 }
162
163 /*
164  * This is a neutered version of libsigrokdecode's py_str_as_str(). It
165  * does no error checking, but then the only strings it processes are
166  * generated by Python's repr(), so are known good.
167  */
168 static char *py_str_as_str(const PyObject *py_str)
169 {
170         PyObject *py_encstr;
171         char *str, *outstr;
172
173         py_encstr = PyUnicode_AsEncodedString((PyObject *)py_str, "utf-8", NULL);
174         str = PyBytes_AS_STRING(py_encstr);
175         outstr = g_strdup(str);
176         Py_DecRef(py_encstr);
177
178         return outstr;
179 }
180
181 /*
182  * The following routines are callbacks for libsigrokdecode. They receive
183  * output from protocol decoders, optionally dropping data to only forward
184  * a selected decoder's or class' information. Output is written to either
185  * a specified file or stdout, an external process will compare captured
186  * output against expectations.
187  *
188  * Note that runtc(1) output emits the decoder "class" name instead of the
189  * instance name. So that generated output remains compatible with existing
190  * .output files which hold expected output of test cases. Without this
191  * approach, developers had to "anticipate" instance names from test.conf
192  * setups (and knowledge about internal implementation details of the srd
193  * library), and adjust .output files to reflect those names. Or specify
194  * instance names in each and every test.conf description (-o inst_id=ID).
195  *
196  * It's assumed that runtc(1) is used to check stacked decoders, but not
197  * multiple stacks in parallel and no stacks with multiple instances of
198  * decoders of the same type. When such configurations become desirable,
199  * runtc(1) needs to emit the instance name, and test configurations and
200  * output expectations need adjustment.
201  */
202
203 static void srd_cb_py(struct srd_proto_data *pdata, void *cb_data)
204 {
205         struct output *op;
206         PyObject *pydata, *pyrepr;
207         GString *out;
208         char *s;
209
210         DBG("Python output from %s", pdata->pdo->di->inst_id);
211         op = cb_data;
212         pydata = pdata->data;
213         DBG("ptr %p", pydata);
214
215         if (strcmp(pdata->pdo->di->inst_id, op->pd_id))
216                 /* This is not the PD selected for output. */
217                 return;
218
219         if (!(pyrepr = PyObject_Repr(pydata))) {
220                 ERR("Invalid Python object.");
221                 return;
222         }
223         s = py_str_as_str(pyrepr);
224         Py_DecRef(pyrepr);
225
226         /* Output format for testing is '<ss>-<es> <decoder-id>: <repr>\n'. */
227         out = g_string_sized_new(128);
228         g_string_printf(out, "%" PRIu64 "-%" PRIu64 " %s: %s\n",
229                         pdata->start_sample, pdata->end_sample,
230                         pdata->pdo->di->decoder->id, s);
231         g_free(s);
232         if (write(op->outfd, out->str, out->len) == -1)
233                 ERR("SRD_OUTPUT_PYTHON callback write failure!");
234         DBG("wrote '%s'", out->str);
235         g_string_free(out, TRUE);
236
237 }
238
239 static void srd_cb_bin(struct srd_proto_data *pdata, void *cb_data)
240 {
241         struct srd_proto_data_binary *pdb;
242         struct output *op;
243         GString *out;
244         unsigned int i;
245
246         DBG("Binary output from %s", pdata->pdo->di->inst_id);
247         op = cb_data;
248         pdb = pdata->data;
249
250         if (strcmp(pdata->pdo->di->inst_id, op->pd_id))
251                 /* This is not the PD selected for output. */
252                 return;
253
254         if (op->class_idx != -1 && op->class_idx != pdb->bin_class)
255                 /*
256                  * This output takes a specific binary class,
257                  * but not the one that just came in.
258                  */
259                 return;
260
261         out = g_string_sized_new(128);
262         g_string_printf(out, "%" PRIu64 "-%" PRIu64 " %s:",
263                         pdata->start_sample, pdata->end_sample,
264                         pdata->pdo->di->decoder->id);
265         for (i = 0; i < pdb->size; i++) {
266                 g_string_append_printf(out, " %.2x", pdb->data[i]);
267         }
268         g_string_append(out, "\n");
269         if (write(op->outfd, out->str, out->len) == -1)
270                 ERR("SRD_OUTPUT_BINARY callback write failure!");
271
272 }
273
274 static void srd_cb_ann(struct srd_proto_data *pdata, void *cb_data)
275 {
276         struct srd_decoder_inst *di;
277         struct srd_decoder *dec;
278         struct srd_proto_data_annotation *pda;
279         struct output *op;
280         GString *line;
281         int i;
282         char **dec_ann;
283
284         /*
285          * Only inspect received annotations when they originate from
286          * the selected protocol decoder, and an optionally specified
287          * annotation class matches the received data.
288          */
289         op = cb_data;
290         pda = pdata->data;
291         di = pdata->pdo->di;
292         dec = di->decoder;
293         DBG("Annotation output from %s", di->inst_id);
294         if (strcmp(di->inst_id, op->pd_id))
295                 /* This is not the PD selected for output. */
296                 return;
297
298         if (op->class_idx != -1 && op->class_idx != pda->ann_class)
299                 /*
300                  * This output takes a specific annotation class,
301                  * but not the one that just came in.
302                  */
303                 return;
304
305         /*
306          * Print the annotation information in textual representation
307          * to the specified output file. Prefix the annotation strings
308          * with the start and end sample number, the decoder name, and
309          * the annotation name.
310          */
311         dec_ann = g_slist_nth_data(dec->annotations, pda->ann_class);
312         line = g_string_sized_new(256);
313         g_string_printf(line, "%" PRIu64 "-%" PRIu64 " %s: %s:",
314                         pdata->start_sample, pdata->end_sample,
315                         dec->id, dec_ann[0]);
316         for (i = 0; pda->ann_text[i]; i++)
317                 g_string_append_printf(line, " \"%s\"", pda->ann_text[i]);
318         g_string_append(line, "\n");
319         if (write(op->outfd, line->str, line->len) == -1)
320                 ERR("SRD_OUTPUT_ANN callback write failure!");
321         g_string_free(line, TRUE);
322
323 }
324
325 static void sr_cb(const struct sr_dev_inst *sdi,
326                 const struct sr_datafeed_packet *packet, void *cb_data)
327 {
328         static int samplecnt = 0;
329         const struct sr_datafeed_logic *logic;
330         struct srd_session *sess;
331         GVariant *gvar;
332         uint64_t samplerate;
333         int num_samples;
334         struct sr_dev_driver *driver;
335
336         sess = cb_data;
337
338         driver = sr_dev_inst_driver_get(sdi);
339
340         switch (packet->type) {
341         case SR_DF_HEADER:
342                 DBG("Received SR_DF_HEADER");
343                 if (sr_config_get(driver, sdi, NULL, SR_CONF_SAMPLERATE,
344                                 &gvar) != SR_OK) {
345                         ERR("Getting samplerate failed");
346                         break;
347                 }
348                 samplerate = g_variant_get_uint64(gvar);
349                 g_variant_unref(gvar);
350                 if (srd_session_metadata_set(sess, SRD_CONF_SAMPLERATE,
351                                 g_variant_new_uint64(samplerate)) != SRD_OK) {
352                         ERR("Setting samplerate failed");
353                         break;
354                 }
355                 if (srd_session_start(sess) != SRD_OK) {
356                         ERR("Session start failed");
357                         break;
358                 }
359                 break;
360         case SR_DF_LOGIC:
361                 logic = packet->payload;
362                 num_samples = logic->length / logic->unitsize;
363                 DBG("Received SR_DF_LOGIC (%"PRIu64" bytes, unitsize = %d).",
364                         logic->length, logic->unitsize);
365                 srd_session_send(sess, samplecnt, samplecnt + num_samples,
366                                 logic->data, logic->length, logic->unitsize);
367                 samplecnt += num_samples;
368                 break;
369         case SR_DF_END:
370                 DBG("Received SR_DF_END");
371 #if defined HAVE_SRD_SESSION_SEND_EOF && HAVE_SRD_SESSION_SEND_EOF
372                 (void)srd_session_send_eof(sess);
373 #endif
374                 break;
375         }
376
377 }
378
379 static int run_testcase(const char *infile, GSList *pdlist, struct output *op)
380 {
381         struct srd_session *sess;
382         struct srd_decoder *dec;
383         struct srd_decoder_inst *di, *prev_di;
384         srd_pd_output_callback cb;
385         struct pd *pd;
386         struct channel *channel;
387         struct option *option;
388         GVariant *gvar;
389         GHashTable *channels, *opts;
390         GSList *pdl, *l, *l2, *devices;
391         int idx, i;
392         int max_channel;
393         char **decoder_class;
394         struct sr_session *sr_sess;
395         gboolean is_number;
396         const char *s;
397         GArray *initial_pins;
398         struct initial_pin_info *initial_pin;
399
400         if (op->outfile) {
401                 if ((op->outfd = open(op->outfile, O_CREAT|O_WRONLY, 0600)) == -1) {
402                         ERR("Unable to open %s for writing: %s", op->outfile,
403                                         g_strerror(errno));
404                         return FALSE;
405                 }
406         }
407
408         if (sr_session_load(ctx, infile, &sr_sess) != SR_OK){
409                 ERR("sr_session_load() failed");
410                 return FALSE;
411         }
412
413         sr_session_dev_list(sr_sess, &devices);
414
415         if (srd_session_new(&sess) != SRD_OK) {
416                 ERR("srd_session_new() failed");
417                 return FALSE;
418         }
419         sr_session_datafeed_callback_add(sr_sess, sr_cb, sess);
420         switch (op->type) {
421         case SRD_OUTPUT_ANN:
422                 cb = srd_cb_ann;
423                 break;
424         case SRD_OUTPUT_BINARY:
425                 cb = srd_cb_bin;
426                 break;
427         case SRD_OUTPUT_PYTHON:
428                 cb = srd_cb_py;
429                 break;
430         default:
431                 ERR("Invalid op->type");
432                 return FALSE;
433         }
434         srd_pd_output_callback_add(sess, op->type, cb, op);
435
436         prev_di = NULL;
437         pd = NULL;
438         for (pdl = pdlist; pdl; pdl = pdl->next) {
439                 pd = pdl->data;
440                 if (srd_decoder_load(pd->name) != SRD_OK) {
441                         ERR("srd_decoder_load() failed");
442                         return FALSE;
443                 }
444
445                 /* Instantiate decoder and pass in options. */
446                 opts = g_hash_table_new_full(g_str_hash, g_str_equal, NULL,
447                                 (GDestroyNotify)g_variant_unref);
448                 for (l = pd->options; l; l = l->next) {
449                         option = l->data;
450
451                         is_number = TRUE;
452                         s = g_variant_get_string(option->value, NULL);
453                         for (i = 0; i < (int)strlen(s); i++) {
454                                 if (!isdigit(s[i]))
455                                         is_number = FALSE;
456                         }
457
458                         if (is_number) {
459                                 /* Integer option value */
460                                 g_hash_table_insert(opts, option->key,
461                                   g_variant_new_int64(strtoull(s, NULL, 10)));
462                         } else {
463                                 /* String option value */
464                                 g_hash_table_insert(opts, option->key, option->value);
465                         }
466                 }
467                 if (!(di = srd_inst_new(sess, pd->name, opts))) {
468                         ERR("srd_inst_new() failed");
469                         return FALSE;
470                 }
471                 g_hash_table_destroy(opts);
472
473                 /*
474                  * Get (a reference to) the decoder instance's ID if we
475                  * are about to receive PD output from it. We need to
476                  * filter output that carries the decoder instance's name.
477                  */
478                 if (strcmp(pd->name, op->pd) == 0) {
479                         op->pd_id = di->inst_id;
480                         DBG("Decoder of type \"%s\" has instance ID \"%s\".",
481                             op->pd, op->pd_id);
482                 }
483
484                 /* Map channels. */
485                 if (pd->channels) {
486                         channels = g_hash_table_new_full(g_str_hash, g_str_equal, NULL,
487                                         (GDestroyNotify)g_variant_unref);
488                         max_channel = 0;
489                         for (l = pd->channels; l; l = l->next) {
490                                 channel = l->data;
491                                 if (channel->channel > max_channel)
492                                         max_channel = channel->channel;
493                                 gvar = g_variant_new_int32(channel->channel);
494                                 g_variant_ref_sink(gvar);
495                                 g_hash_table_insert(channels, channel->name, gvar);
496                         }
497
498                         if (srd_inst_channel_set_all(di, channels) != SRD_OK) {
499                                 ERR("srd_inst_channel_set_all() failed");
500                                 return FALSE;
501                         }
502                         g_hash_table_destroy(channels);
503                 }
504
505                 /* Set initial pins. */
506                 if (pd->initial_pins) {
507                         initial_pins = g_array_sized_new(FALSE, TRUE, sizeof(uint8_t),
508                                                 di->dec_num_channels);
509                         g_array_set_size(initial_pins, di->dec_num_channels);
510                         memset(initial_pins->data, SRD_INITIAL_PIN_SAME_AS_SAMPLE0,
511                                 di->dec_num_channels);
512
513                         for (l = pd->channels, idx = 0; l; l = l->next, idx++) {
514                                 channel = l->data;
515                                 for (l2 = pd->initial_pins; l2; l2 = l2->next) {
516                                         initial_pin = l2->data;
517                                         if (!strcmp(initial_pin->name, channel->name))
518                                                 initial_pins->data[idx] = initial_pin->value;
519                                 }
520                         }
521
522                         if (srd_inst_initial_pins_set_all(di, initial_pins) != SRD_OK) {
523                                 ERR("srd_inst_initial_pins_set_all() failed");
524                                 return FALSE;
525                         }
526                         g_array_free(initial_pins, TRUE);
527                 }
528
529                 /*
530                  * If this is not the first decoder in the list, stack it
531                  * on top of the previous one.
532                  */
533                 if (prev_di) {
534                         if (srd_inst_stack(sess, prev_di, di) != SRD_OK) {
535                                 ERR("Failed to stack decoder instances.");
536                                 return FALSE;
537                         }
538                 }
539                 prev_di = di;
540         }
541         /*
542          * Bail out if we haven't created an instance of the selected
543          * decoder type of which we shall grab output data from.
544          */
545         if (!op->pd_id) {
546                 ERR("No / invalid decoder");
547                 return FALSE;
548         }
549
550         /* Resolve selected decoder's class index, so we can match. */
551         dec = srd_decoder_get_by_id(pd->name);
552         if (op->class) {
553                 if (op->type == SRD_OUTPUT_ANN)
554                         l = dec->annotations;
555                 else if (op->type == SRD_OUTPUT_BINARY)
556                         l = dec->binary;
557                 else {
558                         /* Only annotations and binary can have a class. */
559                         ERR("Invalid decoder class");
560                         return FALSE;
561                 }
562                 idx = 0;
563                 while (l) {
564                         decoder_class = l->data;
565                         if (!strcmp(decoder_class[0], op->class)) {
566                                 op->class_idx = idx;
567                                 break;
568                         }
569                         idx++;
570                         l = l->next;
571                 }
572                 if (op->class_idx == -1) {
573                         ERR("Output class '%s' not found in decoder %s.",
574                                         op->class, pd->name);
575                         return FALSE;
576                 }
577                 DBG("Class %s index is %d", op->class, op->class_idx);
578         }
579
580         sr_session_start(sr_sess);
581         sr_session_run(sr_sess);
582         sr_session_stop(sr_sess);
583
584         srd_session_destroy(sess);
585
586         if (op->outfile)
587                 close(op->outfd);
588
589         return TRUE;
590 }
591
592 static PyObject *start_coverage(GSList *pdlist)
593 {
594         PyObject *py_mod, *py_pdlist, *py_pd, *py_func, *py_args, *py_kwargs, *py_cov;
595         GSList *l;
596         struct pd *pd;
597
598         DBG("Starting coverage.");
599
600         if (!(py_mod = PyImport_ImportModule("coverage")))
601                 return NULL;
602
603         if (!(py_pdlist = PyList_New(0)))
604                 return NULL;
605         for (l = pdlist; l; l = l->next) {
606                 pd = l->data;
607                 py_pd = PyUnicode_FromFormat("*/%s/*.py", pd->name);
608                 if (PyList_Append(py_pdlist, py_pd) < 0)
609                         return NULL;
610                 Py_DecRef(py_pd);
611         }
612         if (!(py_func = PyObject_GetAttrString(py_mod, "coverage")))
613                 return NULL;
614         if (!(py_args = PyTuple_New(0)))
615                 return NULL;
616         if (!(py_kwargs = Py_BuildValue("{sO}", "include", py_pdlist)))
617                 return NULL;
618         if (!(py_cov = PyObject_Call(py_func, py_args, py_kwargs)))
619                 return NULL;
620         if (!(PyObject_CallMethod(py_cov, "start", NULL)))
621                 return NULL;
622         Py_DecRef(py_pdlist);
623         Py_DecRef(py_args);
624         Py_DecRef(py_kwargs);
625         Py_DecRef(py_func);
626
627         return py_cov;
628 }
629
630 static struct cvg *get_mod_cov(PyObject *py_cov, const char *module_name)
631 {
632         PyObject *py_mod, *py_pathlist, *py_path, *py_func, *py_pd;
633         PyObject *py_result, *py_missed, *py_item;
634         DIR *d;
635         struct dirent *de;
636         struct cvg *cvg_mod;
637         int num_lines, num_missed, linenum, i, j;
638         char *path, *linespec;
639
640         if (!(py_mod = PyImport_ImportModule(module_name)))
641                 return NULL;
642
643         cvg_mod = NULL;
644         py_pathlist = PyObject_GetAttrString(py_mod, "__path__");
645         for (i = 0; i < PyList_Size(py_pathlist); i++) {
646                 py_path = PyList_GetItem(py_pathlist, i);
647                 PyUnicode_FSConverter(PyList_GetItem(py_pathlist, i), &py_path);
648                 path = PyBytes_AS_STRING(py_path);
649                 if (!(d = opendir(path))) {
650                         ERR("Invalid module path '%s'", path);
651                         return NULL;
652                 }
653                 while ((de = readdir(d))) {
654                         if (strncmp(de->d_name + strlen(de->d_name) - 3, ".py", 3))
655                                 continue;
656
657                         if (!(py_func = PyObject_GetAttrString(py_cov, "analysis2")))
658                                 return NULL;
659                         if (!(py_pd = PyUnicode_FromFormat("%s/%s", path, de->d_name)))
660                                 return NULL;
661                         if (!(py_result = PyObject_CallFunction(py_func, "O", py_pd)))
662                                 return NULL;
663                         Py_DecRef(py_pd);
664                         Py_DecRef(py_func);
665
666                         if (!cvg_mod)
667                                 cvg_mod = cvg_new();
668                         if (PyTuple_Size(py_result) != 5) {
669                                 ERR("Invalid result from coverage of '%s/%s'", path, de->d_name);
670                                 return NULL;
671                         }
672                         num_lines = PyList_Size(PyTuple_GetItem(py_result, 1));
673                         py_missed = PyTuple_GetItem(py_result, 3);
674                         num_missed = PyList_Size(py_missed);
675                         cvg_mod->num_lines += num_lines;
676                         cvg_mod->num_missed += num_missed;
677                         for (j = 0; j < num_missed; j++) {
678                                 py_item = PyList_GetItem(py_missed, j);
679                                 linenum = PyLong_AsLong(py_item);
680                                 linespec = g_strdup_printf("%s/%s:%d", module_name,
681                                                 de->d_name, linenum);
682                                 cvg_mod->missed_lines = g_slist_append(cvg_mod->missed_lines, linespec);
683                         }
684                         DBG("Coverage for %s/%s: %d lines, %d missed.",
685                                         module_name, de->d_name, num_lines, num_missed);
686                         Py_DecRef(py_result);
687                 }
688         }
689         if (cvg_mod->num_lines)
690                 cvg_mod->coverage = 100 - ((float)cvg_mod->num_missed / (float)cvg_mod->num_lines * 100);
691
692         Py_DecRef(py_mod);
693         Py_DecRef(py_path);
694
695         return cvg_mod;
696 }
697
698 static struct cvg *cvg_new(void)
699 {
700         struct cvg *cvg;
701
702         cvg = calloc(1, sizeof(struct cvg));
703
704         return cvg;
705 }
706
707 static gboolean find_missed_line(struct cvg *cvg, const char *linespec)
708 {
709         GSList *l;
710
711         for (l = cvg->missed_lines; l; l = l->next)
712                 if (!strcmp(l->data, linespec))
713                         return TRUE;
714
715         return FALSE;
716 }
717
718 static void cvg_add(struct cvg *dst, const struct cvg *src)
719 {
720         GSList *l;
721         char *linespec;
722
723         dst->num_lines += src->num_lines;
724         dst->num_missed += src->num_missed;
725         for (l = src->missed_lines; l; l = l->next) {
726                 linespec = l->data;
727                 if (!find_missed_line(dst, linespec))
728                         dst->missed_lines = g_slist_append(dst->missed_lines, linespec);
729         }
730
731 }
732
733 static int report_coverage(PyObject *py_cov, GSList *pdlist)
734 {
735         PyObject *py_func, *py_mod, *py_args, *py_kwargs, *py_outfile, *py_pct;
736         GSList *l, *ml;
737         struct pd *pd;
738         struct cvg *cvg_mod, *cvg_all;
739         float total_coverage;
740         int lines, missed, cnt;
741
742         DBG("Making coverage report.");
743
744         /* Get coverage for each module in the stack. */
745         lines = missed = 0;
746         cvg_all = cvg_new();
747         for (cnt = 0, l = pdlist; l; l = l->next, cnt++) {
748                 pd = l->data;
749                 if (!(cvg_mod = get_mod_cov(py_cov, pd->name)))
750                         return FALSE;
751                 printf("coverage: scope=%s coverage=%.0f%% lines=%d missed=%d "
752                                 "missed_lines=", pd->name, cvg_mod->coverage,
753                                 cvg_mod->num_lines, cvg_mod->num_missed);
754                 for (ml = cvg_mod->missed_lines; ml; ml = ml->next) {
755                         if (ml != cvg_mod->missed_lines)
756                                 printf(",");
757                         printf("%s", (char *)ml->data);
758                 }
759                 printf("\n");
760                 lines += cvg_mod->num_lines;
761                 missed += cvg_mod->num_missed;
762                 cvg_add(cvg_all, cvg_mod);
763                 DBG("Coverage for module %s: %d lines, %d missed", pd->name,
764                                 cvg_mod->num_lines, cvg_mod->num_missed);
765         }
766         lines /= cnt;
767         missed /= cnt;
768         total_coverage = 100 - ((float)missed / (float)lines * 100);
769
770         /* Machine-readable stats on stdout. */
771         printf("coverage: scope=all coverage=%.0f%% lines=%d missed=%d\n",
772                         total_coverage, cvg_all->num_lines, cvg_all->num_missed);
773
774         /* Write text report to file. */
775         /* io.open(coverage_report, "w") */
776         if (!(py_mod = PyImport_ImportModule("io")))
777                 return FALSE;
778         if (!(py_func = PyObject_GetAttrString(py_mod, "open")))
779                 return FALSE;
780         if (!(py_args = PyTuple_New(0)))
781                 return FALSE;
782         if (!(py_kwargs = Py_BuildValue("{ssss}", "file", coverage_report,
783                         "mode", "w")))
784                 return FALSE;
785         if (!(py_outfile = PyObject_Call(py_func, py_args, py_kwargs)))
786                 return FALSE;
787         Py_DecRef(py_kwargs);
788         Py_DecRef(py_func);
789
790         /* py_cov.report(file=py_outfile) */
791         if (!(py_func = PyObject_GetAttrString(py_cov, "report")))
792                 return FALSE;
793         if (!(py_kwargs = Py_BuildValue("{sO}", "file", py_outfile)))
794                 return FALSE;
795         if (!(py_pct = PyObject_Call(py_func, py_args, py_kwargs)))
796                 return FALSE;
797         Py_DecRef(py_pct);
798         Py_DecRef(py_kwargs);
799         Py_DecRef(py_func);
800
801         /* py_outfile.close() */
802         if (!(py_func = PyObject_GetAttrString(py_outfile, "close")))
803                 return FALSE;
804         if (!PyObject_Call(py_func, py_args, NULL))
805                 return FALSE;
806         Py_DecRef(py_outfile);
807         Py_DecRef(py_func);
808         Py_DecRef(py_args);
809         Py_DecRef(py_mod);
810
811         return TRUE;
812 }
813
814 int main(int argc, char **argv)
815 {
816         PyObject *coverage;
817         GSList *pdlist;
818         struct pd *pd;
819         struct channel *channel;
820         struct option *option;
821         struct output *op;
822         int ret, c;
823         char *opt_infile, **kv, **opstr;
824         struct initial_pin_info *initial_pin;
825
826         op = malloc(sizeof(struct output));
827         op->pd = NULL;
828         op->pd_id = NULL;
829         op->type = -1;
830         op->class = NULL;
831         op->class_idx = -1;
832         op->outfd = 1;
833
834         pdlist = NULL;
835         opt_infile = NULL;
836         pd = NULL;
837         coverage = NULL;
838         while ((c = getopt(argc, argv, "dP:p:o:N:i:O:f:c:S")) != -1) {
839                 switch (c) {
840                 case 'd':
841                         debug = TRUE;
842                         break;
843                 case 'P':
844                         pd = g_malloc(sizeof(struct pd));
845                         pd->name = g_strdup(optarg);
846                         pd->channels = pd->options = pd->initial_pins = NULL;
847                         pdlist = g_slist_append(pdlist, pd);
848                         break;
849                 case 'p':
850                 case 'o':
851                 case 'N':
852                         if (g_slist_length(pdlist) == 0) {
853                                 /* No previous -P. */
854                                 ERR("Syntax error at '%s'", optarg);
855                                 usage(NULL);
856                         }
857                         kv = g_strsplit(optarg, "=", 0);
858                         if (!kv[0] || (!kv[1] || kv[2])) {
859                                 /* Need x=y. */
860                                 ERR("Syntax error at '%s'", optarg);
861                                 g_strfreev(kv);
862                                 usage(NULL);
863                         }
864                         if (c == 'p') {
865                                 channel = malloc(sizeof(struct channel));
866                                 channel->name = g_strdup(kv[0]);
867                                 channel->channel = strtoul(kv[1], NULL, 10);
868                                 /* Apply to last PD. */
869                                 pd->channels = g_slist_append(pd->channels, channel);
870                         } else if (c == 'o') {
871                                 option = malloc(sizeof(struct option));
872                                 option->key = g_strdup(kv[0]);
873                                 option->value = g_variant_new_string(kv[1]);
874                                 g_variant_ref_sink(option->value);
875                                 /* Apply to last PD. */
876                                 pd->options = g_slist_append(pd->options, option);
877                         } else {
878                                 initial_pin = malloc(sizeof(struct initial_pin_info));
879                                 initial_pin->name = g_strdup(kv[0]);
880                                 initial_pin->value = strtoul(kv[1], NULL, 10);
881                                 /* Apply to last PD. */
882                                 pd->initial_pins = g_slist_append(pd->initial_pins, initial_pin);
883                         }
884                         break;
885                 case 'i':
886                         opt_infile = optarg;
887                         break;
888                 case 'O':
889                         opstr = g_strsplit(optarg, ":", 0);
890                         if (!opstr[0] || !opstr[1]) {
891                                 /* Need at least abc:def. */
892                                 ERR("Syntax error at '%s'", optarg);
893                                 g_strfreev(opstr);
894                                 usage(NULL);
895                         }
896                         op->pd = g_strdup(opstr[0]);
897                         if (!strcmp(opstr[1], "annotation"))
898                                 op->type = SRD_OUTPUT_ANN;
899                         else if (!strcmp(opstr[1], "binary"))
900                                 op->type = SRD_OUTPUT_BINARY;
901                         else if (!strcmp(opstr[1], "python"))
902                                 op->type = SRD_OUTPUT_PYTHON;
903                         else if (!strcmp(opstr[1], "exception"))
904                                 /* Doesn't matter, we just need it to bomb out. */
905                                 op->type = SRD_OUTPUT_PYTHON;
906                         else {
907                                 ERR("Unknown output type '%s'", opstr[1]);
908                                 g_strfreev(opstr);
909                                 usage(NULL);
910                         }
911                         if (opstr[2])
912                                 op->class = g_strdup(opstr[2]);
913                         g_strfreev(opstr);
914                         break;
915                 case 'f':
916                         op->outfile = g_strdup(optarg);
917                         op->outfd = -1;
918                         break;
919                 case 'c':
920                         coverage_report = optarg;
921                         break;
922                 case 'S':
923                         statistics = TRUE;
924                         break;
925                 default:
926                         usage(NULL);
927                 }
928         }
929         if (argc > optind)
930                 usage(NULL);
931         if (g_slist_length(pdlist) == 0)
932                 usage(NULL);
933         if (!opt_infile)
934                 usage(NULL);
935         if (!op->pd || op->type == -1)
936                 usage(NULL);
937
938         sr_log_callback_set(sr_log, NULL);
939         if (sr_init(&ctx) != SR_OK)
940                 return 1;
941
942         srd_log_callback_set(srd_log, NULL);
943         if (srd_init(DECODERS_DIR) != SRD_OK)
944                 return 1;
945
946         if (coverage_report) {
947                 if (!(coverage = start_coverage(pdlist))) {
948                         DBG("Failed to start coverage.");
949                         if (PyErr_Occurred()) {
950                                 PyErr_PrintEx(0);
951                                 PyErr_Clear();
952                         }
953                 }
954         }
955
956         ret = 0;
957         if (!run_testcase(opt_infile, pdlist, op))
958                 ret = 1;
959
960         if (coverage) {
961                 DBG("Stopping coverage.");
962
963                 if (!(PyObject_CallMethod(coverage, "stop", NULL)))
964                         ERR("Failed to stop coverage.");
965                 else if (!(report_coverage(coverage, pdlist)))
966                         ERR("Failed to make coverage report.");
967                 else
968                         DBG("Coverage report in %s", coverage_report);
969
970                 if (PyErr_Occurred()) {
971                         PyErr_PrintEx(0);
972                         PyErr_Clear();
973                 }
974                 Py_DecRef(coverage);
975         }
976
977         srd_exit();
978         sr_exit(ctx);
979
980         return ret;
981 }