X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=tests%2Fruntc.c;h=11ae560dbea4766c63872d09018dbf9b333a6e66;hp=78dbf5ec15ec38ebed8727d5681bb877855026af;hb=7149b578a48e90a8b34d70174f8c3ce51de1e282;hpb=fbd226c3f70f20fdf3cbfd43a671bf2bcc5d23e6 diff --git a/tests/runtc.c b/tests/runtc.c index 78dbf5e..11ae560 100644 --- a/tests/runtc.c +++ b/tests/runtc.c @@ -17,6 +17,7 @@ * along with this program. If not, see . */ +#include #include "../libsigrokdecode.h" #include #include @@ -30,29 +31,30 @@ #include #include #include +#include #include #ifdef __LINUX__ #include #endif -#include "../config.h" - +#include "config.h" int debug = FALSE; int statistics = FALSE; +char *coverage_report; -struct probe { +struct channel { char *name; - int probe; + int channel; }; struct option { char *key; - char *value; + GVariant *value; }; struct pd { char *name; - GSList *probes; + GSList *channels; GSList *options; }; @@ -65,8 +67,21 @@ struct output { int outfd; }; +struct cvg { + int num_lines; + int num_missed; + float coverage; + 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); + -void logmsg(char *prefix, FILE *out, const char *format, va_list args) +static void logmsg(char *prefix, FILE *out, const char *format, va_list args) { if (prefix) fprintf(out, "%s", prefix); @@ -74,18 +89,18 @@ void logmsg(char *prefix, FILE *out, const char *format, va_list args) fprintf(out, "\n"); } -void DBG(const char *format, ...) +static void DBG(const char *format, ...) { va_list args; if (!debug) return; va_start(args, format); - logmsg("DBG: ", stdout, format, args); + logmsg("DBG: runtc: ", stdout, format, args); va_end(args); } -void ERR(const char *format, ...) +static void ERR(const char *format, ...) { va_list args; @@ -94,36 +109,135 @@ void ERR(const char *format, ...) va_end(args); } -int srd_log(void *cb_data, int loglevel, const char *format, va_list args) +static int sr_log(void *cb_data, int loglevel, const char *format, va_list args) +{ + (void)cb_data; + + if (loglevel == SR_LOG_ERR || loglevel == SR_LOG_WARN) + logmsg("Error: sr: ", stderr, format, args); + else if (debug) + logmsg("DBG: sr: ", stdout, format, args); + + return SRD_OK; +} + +static int srd_log(void *cb_data, int loglevel, const char *format, va_list args) { (void)cb_data; if (loglevel == SRD_LOG_ERR || loglevel == SRD_LOG_WARN) logmsg("Error: srd: ", stderr, format, args); - else if (loglevel >= SRD_LOG_DBG && debug) + else if (debug) logmsg("DBG: srd: ", stdout, format, args); return SRD_OK; } -void usage(char *msg) +static void usage(char *msg) { if (msg) fprintf(stderr, "%s\n", msg); - //while((c = getopt(argc, argv, "dP:p:o:i:O:f:S")) != -1) { printf("Usage: runtc [-dPpoiOf]\n"); printf(" -d Debug\n"); printf(" -P \n"); - printf(" -p (optional)\n"); - printf(" -o (optional)\n"); + printf(" -p (optional)\n"); + printf(" -o (optional)\n"); printf(" -i \n"); printf(" -O \n"); printf(" -f (optional)\n"); + printf(" -c (optional)\n"); exit(msg ? 1 : 0); } +/* 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. */ +static char *py_str_as_str(const PyObject *py_str) +{ + PyObject *py_encstr; + char *str, *outstr; + + py_encstr = PyUnicode_AsEncodedString((PyObject *)py_str, "utf-8", NULL); + str = PyBytes_AS_STRING(py_encstr); + outstr = g_strdup(str); + Py_DecRef(py_encstr); + + return outstr; +} + +static void srd_cb_py(struct srd_proto_data *pdata, void *cb_data) +{ + struct output *op; + PyObject *pydata, *pyrepr; + GString *out; + char *s; + + DBG("Python output from %s", pdata->pdo->di->inst_id); + op = cb_data; + pydata = pdata->data; + DBG("ptr %p", pydata); + + if (strcmp(pdata->pdo->di->inst_id, op->pd)) + /* This is not the PD selected for output. */ + return; + + if (!(pyrepr = PyObject_Repr(pydata))) { + ERR("Invalid Python object."); + return; + } + s = py_str_as_str(pyrepr); + Py_DecRef(pyrepr); + + /* 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); + g_free(s); + if (write(op->outfd, out->str, out->len) == -1) + ERR("SRD_OUTPUT_PYTHON callback write failure!"); + DBG("wrote '%s'", out->str); + g_string_free(out, TRUE); + +} + +static void srd_cb_bin(struct srd_proto_data *pdata, void *cb_data) +{ + struct srd_proto_data_binary *pdb; + struct output *op; + GString *out; + unsigned int i; + + DBG("Binary output from %s", pdata->pdo->di->inst_id); + op = cb_data; + pdb = pdata->data; + + if (strcmp(pdata->pdo->di->inst_id, op->pd)) + /* This is not the PD selected for output. */ + return; + + if (op->class_idx != -1 && op->class_idx != pdb->bin_class) + /* + * This output takes a specific binary class, + * but not the one that just came in. + */ + return; + + out = g_string_sized_new(128); + g_string_printf(out, "%"PRIu64"-%"PRIu64" %s:", + pdata->start_sample, pdata->end_sample, + pdata->pdo->di->inst_id); + for (i = 0; i < pdb->size; i++) { + g_string_append_printf(out, " %.2x", pdb->data[i]); + } + g_string_append(out, "\n"); + if (write(op->outfd, out->str, out->len) == -1) + ERR("SRD_OUTPUT_BINARY callback write failure!"); + +} + static void srd_cb_ann(struct srd_proto_data *pdata, void *cb_data) { struct srd_decoder *dec; @@ -133,18 +247,19 @@ static void srd_cb_ann(struct srd_proto_data *pdata, void *cb_data) int i; char **dec_ann; - DBG("Annotation from %s", pdata->pdo->di->inst_id); + DBG("Annotation output from %s", pdata->pdo->di->inst_id); op = cb_data; pda = pdata->data; dec = pdata->pdo->di->decoder; - if (strcmp(pdata->pdo->di->inst_id, op->pd)) /* This is not the PD selected for output. */ return; if (op->class_idx != -1 && op->class_idx != pda->ann_format) - /* This output takes a specific annotation class, - * but not the one that just came in. */ + /* + * This output takes a specific annotation class, + * but not the one that just came in. + */ return; dec_ann = g_slist_nth_data(dec->annotations, pda->ann_format); @@ -156,7 +271,7 @@ static void srd_cb_ann(struct srd_proto_data *pdata, void *cb_data) g_string_append_printf(line, " \"%s\"", pda->ann_text[i]); g_string_append(line, "\n"); if (write(op->outfd, line->str, line->len) == -1) - ERR("Oops!"); + ERR("SRD_OUTPUT_ANN callback write failure!"); g_string_free(line, TRUE); } @@ -208,52 +323,22 @@ static void sr_cb(const struct sr_dev_inst *sdi, } -int get_stats(int stats[2]) -{ - FILE *f; - size_t len; - int tmp; - char *buf; - - stats[0] = stats[1] = -1; - if (!(f = fopen("/proc/self/status", "r"))) - return FALSE; - len = 128; - buf = malloc(len); - while (getline(&buf, &len, f) != -1) { - if (strcasestr(buf, "vmpeak:")) { - stats[0] = strtoul(buf + 10, NULL, 10); - } else if (strcasestr(buf, "vmsize:")) { - tmp = strtoul(buf + 10, NULL, 10); - if (tmp > stats[0]) - stats[0] = tmp; - } else if (strcasestr(buf, "vmhwm:")) { - stats[1] = strtoul(buf + 6, NULL, 10); - } else if (strcasestr(buf, "vmrss:")) { - tmp = strtoul(buf + 10, NULL, 10); - if (tmp > stats[0]) - stats[0] = tmp; - } - } - free(buf); - fclose(f); - - return TRUE; -} - static int run_testcase(char *infile, GSList *pdlist, struct output *op) { struct srd_session *sess; struct srd_decoder *dec; struct srd_decoder_inst *di, *prev_di; + srd_pd_output_callback cb; struct pd *pd; - struct probe *probe; + struct channel *channel; struct option *option; GVariant *gvar; - GHashTable *probes, *opts; - GSList *pdl, *l, *annl; + GHashTable *channels, *opts; + GSList *pdl, *l; int idx; - char **dec_ann; + int max_channel; + char **decoder_class; + struct sr_session *sr_sess; if (op->outfile) { if ((op->outfd = open(op->outfile, O_CREAT|O_WRONLY, 0600)) == -1) { @@ -263,13 +348,26 @@ static int run_testcase(char *infile, GSList *pdlist, struct output *op) } } - if (sr_session_load(infile) != SR_OK) + if (sr_session_load(infile, &sr_sess) != SR_OK) return FALSE; if (srd_session_new(&sess) != SRD_OK) return FALSE; - sr_session_datafeed_callback_add(sr_cb, sess); - srd_pd_output_callback_add(sess, SRD_OUTPUT_ANN, srd_cb_ann, op); + sr_session_datafeed_callback_add(sr_sess, sr_cb, sess); + switch (op->type) { + case SRD_OUTPUT_ANN: + cb = srd_cb_ann; + break; + case SRD_OUTPUT_BINARY: + cb = srd_cb_bin; + break; + case SRD_OUTPUT_PYTHON: + cb = srd_cb_py; + break; + default: + return FALSE; + } + srd_pd_output_callback_add(sess, op->type, cb, op); prev_di = NULL; pd = NULL; @@ -289,22 +387,25 @@ static int run_testcase(char *infile, GSList *pdlist, struct output *op) return FALSE; g_hash_table_destroy(opts); - /* Map probes. */ - if (pd->probes) { - probes = g_hash_table_new_full(g_str_hash, g_str_equal, NULL, + /* Map channels. */ + if (pd->channels) { + channels = g_hash_table_new_full(g_str_hash, g_str_equal, NULL, (GDestroyNotify)g_variant_unref); - for (l = pd->probes; l; l = l->next) { - probe = l->data; - gvar = g_variant_new_int32(probe->probe); + max_channel = 0; + for (l = pd->channels; l; l = l->next) { + channel = l->data; + if (channel->channel > max_channel) + max_channel = channel->channel; + gvar = g_variant_new_int32(channel->channel); g_variant_ref_sink(gvar); - g_hash_table_insert(probes, probe->name, gvar); + g_hash_table_insert(channels, channel->name, gvar); } - if (srd_inst_probe_set_all(di, probes) != SRD_OK) + if (srd_inst_channel_set_all(di, channels, + (max_channel + 8) / 8) != SRD_OK) return FALSE; - g_hash_table_destroy(probes); + g_hash_table_destroy(channels); } - /* If this is not the first decoder in the list, stack it * on top of the previous one. */ if (prev_di) { @@ -320,35 +421,33 @@ static int run_testcase(char *infile, GSList *pdlist, struct output *op) dec = srd_decoder_get_by_id(pd->name); if (op->class) { if (op->type == SRD_OUTPUT_ANN) - annl = dec->annotations; - /* TODO can't dereference this for binary yet + l = dec->annotations; else if (op->type == SRD_OUTPUT_BINARY) - annl = dec->binary; - */ + l = dec->binary; else - /* Only annotations and binary for now. */ + /* Only annotations and binary can have a class. */ return FALSE; idx = 0; - while(annl) { - dec_ann = annl->data; - /* TODO can't dereference this for binary yet */ - if (!strcmp(dec_ann[0], op->class)) { + while (l) { + decoder_class = l->data; + if (!strcmp(decoder_class[0], op->class)) { op->class_idx = idx; break; } else idx++; - annl = annl->next; + 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); } - sr_session_start(); - sr_session_run(); - sr_session_stop(); + sr_session_start(sr_sess); + sr_session_run(sr_sess); + sr_session_stop(sr_sess); srd_session_destroy(sess); @@ -358,15 +457,241 @@ static int run_testcase(char *infile, GSList *pdlist, struct output *op) return TRUE; } +static PyObject *start_coverage(GSList *pdlist) +{ + PyObject *py_mod, *py_pdlist, *py_pd, *py_func, *py_args, *py_kwargs, *py_cov; + GSList *l; + struct pd *pd; + + DBG("Starting coverage."); + + if (!(py_mod = PyImport_ImportModule("coverage"))) + return NULL; + + if (!(py_pdlist = PyList_New(0))) + return NULL; + for (l = pdlist; l; l = l->next) { + pd = l->data; + py_pd = PyUnicode_FromFormat("*/%s/*.py", pd->name); + if (PyList_Append(py_pdlist, py_pd) < 0) + return NULL; + Py_DecRef(py_pd); + } + if (!(py_func = PyObject_GetAttrString(py_mod, "coverage"))) + return NULL; + if (!(py_args = PyTuple_New(0))) + return NULL; + if (!(py_kwargs = Py_BuildValue("{sO}", "include", py_pdlist))) + return NULL; + if (!(py_cov = PyObject_Call(py_func, py_args, py_kwargs))) + return NULL; + if (!(PyObject_CallMethod(py_cov, "start", NULL))) + return NULL; + Py_DecRef(py_pdlist); + Py_DecRef(py_args); + Py_DecRef(py_kwargs); + Py_DecRef(py_func); + + return py_cov; +} + +struct cvg *get_mod_cov(PyObject *py_cov, char *module_name) +{ + PyObject *py_mod, *py_pathlist, *py_path, *py_func, *py_pd; + PyObject *py_result, *py_missed, *py_item; + DIR *d; + struct dirent *de; + struct cvg *cvg_mod; + int num_lines, num_missed, linenum, i, j; + char *path, *linespec; + + if (!(py_mod = PyImport_ImportModule(module_name))) + return NULL; + + cvg_mod = NULL; + 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); + path = PyBytes_AS_STRING(py_path); + if (!(d = opendir(path))) { + ERR("Invalid module path '%s'", path); + return NULL; + } + while ((de = readdir(d))) { + if (strncmp(de->d_name + strlen(de->d_name) - 3, ".py", 3)) + continue; + + if (!(py_func = PyObject_GetAttrString(py_cov, "analysis2"))) + return NULL; + if (!(py_pd = PyUnicode_FromFormat("%s/%s", path, de->d_name))) + return NULL; + if (!(py_result = PyObject_CallFunction(py_func, "O", py_pd))) + return NULL; + Py_DecRef(py_pd); + Py_DecRef(py_func); + + if (!cvg_mod) + cvg_mod = cvg_new(); + if (PyTuple_Size(py_result) != 5) { + ERR("Invalid result from coverage of '%s/%s'", path, de->d_name); + return NULL; + } + num_lines = PyList_Size(PyTuple_GetItem(py_result, 1)); + py_missed = PyTuple_GetItem(py_result, 3); + num_missed = PyList_Size(py_missed); + cvg_mod->num_lines += num_lines; + cvg_mod->num_missed += num_missed; + for (j = 0; j < num_missed; j++) { + py_item = PyList_GetItem(py_missed, j); + linenum = PyLong_AsLong(py_item); + linespec = g_strdup_printf("%s/%s:%d", module_name, + de->d_name, linenum); + cvg_mod->missed_lines = g_slist_append(cvg_mod->missed_lines, linespec); + } + DBG("Coverage for %s/%s: %d lines, %d missed.", + module_name, de->d_name, num_lines, num_missed); + Py_DecRef(py_result); + } + } + if (cvg_mod->num_lines) + cvg_mod->coverage = 100 - ((float)cvg_mod->num_missed / (float)cvg_mod->num_lines * 100); + + Py_DecRef(py_mod); + Py_DecRef(py_path); + + return cvg_mod; +} + +struct cvg *cvg_new(void) +{ + struct cvg *cvg; + + cvg = calloc(1, sizeof(struct cvg)); + + return cvg; +} + +gboolean find_missed_line(struct cvg *cvg, char *linespec) +{ + GSList *l; + + for (l = cvg->missed_lines; l; l = l->next) + if (!strcmp(l->data, linespec)) + return TRUE; + + return FALSE; +} + +void cvg_add(struct cvg *dst, struct cvg *src) +{ + GSList *l; + char *linespec; + + + dst->num_lines += src->num_lines; + dst->num_missed += src->num_missed; + for (l = src->missed_lines; l; l = l->next) { + linespec = l->data; + if (!find_missed_line(dst, linespec)) + dst->missed_lines = g_slist_append(dst->missed_lines, linespec); + } + +} + +static int report_coverage(PyObject *py_cov, GSList *pdlist) +{ + PyObject *py_func, *py_mod, *py_args, *py_kwargs, *py_outfile, *py_pct; + GSList *l, *ml; + struct pd *pd; + struct cvg *cvg_mod, *cvg_all; + float total_coverage; + int lines, missed, cnt; + + DBG("Making coverage report."); + + /* Get coverage for each module in the stack. */ + lines = missed = 0; + cvg_all = cvg_new(); + for (cnt = 0, l = pdlist; l; l = l->next, cnt++) { + pd = l->data; + if (!(cvg_mod = get_mod_cov(py_cov, pd->name))) + return FALSE; + printf("coverage: scope=%s coverage=%.0f%% lines=%d missed=%d " + "missed_lines=", pd->name, cvg_mod->coverage, + cvg_mod->num_lines, cvg_mod->num_missed); + for (ml = cvg_mod->missed_lines; ml; ml = ml->next) { + if (ml != cvg_mod->missed_lines) + printf(","); + printf("%s", (char *)ml->data); + } + printf("\n"); + lines += cvg_mod->num_lines; + missed += cvg_mod->num_missed; + cvg_add(cvg_all, cvg_mod); + DBG("Coverage for module %s: %d lines, %d missed", pd->name, + cvg_mod->num_lines, cvg_mod->num_missed); + } + lines /= cnt; + missed /= cnt; + total_coverage = 100 - ((float)missed / (float)lines * 100); + + /* Machine-readable stats on stdout. */ + printf("coverage: scope=all coverage=%.0f%% lines=%d missed=%d\n", + total_coverage, cvg_all->num_lines, cvg_all->num_missed); + + + /* Write text report to file. */ + /* io.open(coverage_report, "w") */ + if (!(py_mod = PyImport_ImportModule("io"))) + return FALSE; + if (!(py_func = PyObject_GetAttrString(py_mod, "open"))) + return FALSE; + if (!(py_args = PyTuple_New(0))) + return FALSE; + if (!(py_kwargs = Py_BuildValue("{ssss}", "file", coverage_report, + "mode", "w"))) + return FALSE; + if (!(py_outfile = PyObject_Call(py_func, py_args, py_kwargs))) + return FALSE; + Py_DecRef(py_kwargs); + Py_DecRef(py_func); + + /* py_cov.report(file=py_outfile) */ + if (!(py_func = PyObject_GetAttrString(py_cov, "report"))) + return FALSE; + if (!(py_kwargs = Py_BuildValue("{sO}", "file", py_outfile))) + return FALSE; + if (!(py_pct = PyObject_Call(py_func, py_args, py_kwargs))) + return FALSE; + Py_DecRef(py_pct); + Py_DecRef(py_kwargs); + Py_DecRef(py_func); + + /* py_outfile.close() */ + if (!(py_func = PyObject_GetAttrString(py_outfile, "close"))) + return FALSE; + if (!PyObject_Call(py_func, py_args, NULL)) + return FALSE; + Py_DecRef(py_outfile); + Py_DecRef(py_func); + Py_DecRef(py_args); + Py_DecRef(py_mod); + + return TRUE; +} + int main(int argc, char **argv) { struct sr_context *ctx; + PyObject *coverage; GSList *pdlist; struct pd *pd; - struct probe *probe; + struct channel *channel; struct option *option; struct output *op; - char c, *opt_infile, **kv, **opstr; + int ret, c; + char *opt_infile, **kv, **opstr; op = malloc(sizeof(struct output)); op->pd = NULL; @@ -378,7 +703,8 @@ int main(int argc, char **argv) pdlist = NULL; opt_infile = NULL; pd = NULL; - while((c = getopt(argc, argv, "dP:p:o:i:O:f:S")) != -1) { + coverage = NULL; + while ((c = getopt(argc, argv, "dP:p:o:i:O:f:c:S")) != -1) { switch(c) { case 'd': debug = TRUE; @@ -386,7 +712,7 @@ int main(int argc, char **argv) case 'P': pd = g_malloc(sizeof(struct pd)); pd->name = g_strdup(optarg); - pd->probes = pd->options = NULL; + pd->channels = pd->options = NULL; pdlist = g_slist_append(pdlist, pd); break; case 'p': @@ -404,15 +730,16 @@ int main(int argc, char **argv) usage(NULL); } if (c == 'p') { - probe = malloc(sizeof(struct probe)); - probe->name = g_strdup(kv[0]); - probe->probe = strtoul(kv[1], 0, 10); + channel = malloc(sizeof(struct channel)); + channel->name = g_strdup(kv[0]); + channel->channel = strtoul(kv[1], 0, 10); /* Apply to last PD. */ - pd->probes = g_slist_append(pd->probes, probe); + pd->channels = g_slist_append(pd->channels, channel); } else { option = malloc(sizeof(struct option)); option->key = g_strdup(kv[0]); - option->value = g_strdup(kv[1]); + option->value = g_variant_new_string(kv[1]); + g_variant_ref_sink(option->value); /* Apply to last PD. */ pd->options = g_slist_append(pd->options, option); } @@ -435,6 +762,9 @@ int main(int argc, char **argv) op->type = SRD_OUTPUT_BINARY; else if (!strcmp(opstr[1], "python")) op->type = SRD_OUTPUT_PYTHON; + else if (!strcmp(opstr[1], "exception")) + /* Doesn't matter, we just need it to bomb out. */ + op->type = SRD_OUTPUT_PYTHON; else { ERR("Unknown output type '%s'", opstr[1]); g_strfreev(opstr); @@ -448,6 +778,9 @@ int main(int argc, char **argv) op->outfile = g_strdup(optarg); op->outfd = -1; break; + case 'c': + coverage_report = optarg; + break; case 'S': statistics = TRUE; break; @@ -464,19 +797,47 @@ int main(int argc, char **argv) if (!op->pd || op->type == -1) usage(NULL); + sr_log_callback_set(sr_log, NULL); if (sr_init(&ctx) != SR_OK) return 1; srd_log_callback_set(srd_log, NULL); - if (srd_init(NULL) != SRD_OK) + if (srd_init(DECODERS_DIR) != SRD_OK) return 1; - run_testcase(opt_infile, pdlist, op); + if (coverage_report) { + if (!(coverage = start_coverage(pdlist))) { + DBG("Failed to start coverage."); + if (PyErr_Occurred()) { + PyErr_PrintEx(0); + PyErr_Clear(); + } + } + } + + ret = 0; + if (!run_testcase(opt_infile, pdlist, op)) + ret = 1; + + if (coverage) { + DBG("Stopping coverage."); + + if (!(PyObject_CallMethod(coverage, "stop", NULL))) + ERR("Failed to stop coverage."); + else if (!(report_coverage(coverage, pdlist))) + ERR("Failed to make coverage report."); + else + DBG("Coverage report in %s", coverage_report); + + if (PyErr_Occurred()) { + PyErr_PrintEx(0); + PyErr_Clear(); + } + Py_DecRef(coverage); + } srd_exit(); sr_exit(ctx); - return 0; + return ret; } - -