]> sigrok.org Git - libsigrok.git/blobdiff - output/output_text.c
fix corner cases/memory management (cli->text out)
[libsigrok.git] / output / output_text.c
index c4b9c95daa9c886e1bd36d449868489e61d8c08d..f6d9357a7902ce68d84d60076721d50276c06e9c 100644 (file)
 #include <string.h>
 #include <glib.h>
 #include <sigrok.h>
+#include "config.h"
 
-#define DEFAULT_BPL_BIN 64
-#define DEFAULT_BPL_HEX 256
+#define DEFAULT_BPL_BITS 64
+#define DEFAULT_BPL_HEX  256
 
 struct context {
-       int num_enabled_probes;
+       unsigned int num_enabled_probes;
        int samples_per_line;
-       int unitsize;
+       unsigned int unitsize;
        int line_offset;
        int linebuf_len;
        char *probelist[65];
@@ -37,34 +38,38 @@ struct context {
        int spl_cnt;
        uint8_t *linevalues;
        char *header;
+       int mark_trigger;
 };
 
-
-static void flush_linebufs(struct context *ctx, GSList *probes, char *outbuf)
+static void flush_linebufs(struct context *ctx, char *outbuf)
 {
        static int max_probename_len = 0;
        int len, i;
 
-       if(ctx->linebuf[0] == 0)
+       if (ctx->linebuf[0] == 0)
                return;
 
-       if(max_probename_len == 0) {
-               /* first time through */
-               for(i = 0; ctx->probelist[i]; i++) {
+       if (max_probename_len == 0) {
+               /* First time through... */
+               for (i = 0; ctx->probelist[i]; i++) {
                        len = strlen(ctx->probelist[i]);
-                       if(len > max_probename_len)
+                       if (len > max_probename_len)
                                max_probename_len = len;
                }
        }
 
-       for(i = 0; ctx->probelist[i]; i++) {
-               sprintf(outbuf + strlen(outbuf), "%*s:%s\n", max_probename_len, ctx->probelist[i],
-                               ctx->linebuf + i * ctx->linebuf_len);
+       for (i = 0; ctx->probelist[i]; i++) {
+               sprintf(outbuf + strlen(outbuf), "%*s:%s\n", max_probename_len,
+                       ctx->probelist[i], ctx->linebuf + i * ctx->linebuf_len);
        }
-       memset(ctx->linebuf, 0, i * ctx->linebuf_len);
 
-}
+       /* Mark trigger with a ^ character. */
+       if (ctx->mark_trigger != -1)
+               sprintf(outbuf + strlen(outbuf), "T:%*s^\n",
+                       ctx->mark_trigger + (ctx->mark_trigger / 8), "");
 
+       memset(ctx->linebuf, 0, i * ctx->linebuf_len);
+}
 
 static int init(struct output *o, int default_spl)
 {
@@ -75,55 +80,86 @@ static int init(struct output *o, int default_spl)
        int num_probes;
        char *samplerate_s;
 
-       ctx = malloc(sizeof(struct context));
+       if (!(ctx = calloc(1, sizeof(struct context))))
+               return SIGROK_ERR_MALLOC;
+
        o->internal = ctx;
        ctx->num_enabled_probes = 0;
-       for(l = o->device->probes; l; l = l->next) {
+
+       for (l = o->device->probes; l; l = l->next) {
                probe = l->data;
-               if(probe->enabled)
+               if (probe->enabled)
                        ctx->probelist[ctx->num_enabled_probes++] = probe->name;
        }
+
        ctx->probelist[ctx->num_enabled_probes] = 0;
        ctx->unitsize = (ctx->num_enabled_probes + 7) / 8;
        ctx->line_offset = 0;
        ctx->spl_cnt = 0;
-       if(o->param && o->param[0])
+       ctx->mark_trigger = -1;
+
+       if (o->param && o->param[0]) {
                ctx->samples_per_line = strtoul(o->param, NULL, 10);
-       else
+               if (ctx->samples_per_line < 1)
+                       return SIGROK_ERR;
+       } else
                ctx->samples_per_line = default_spl;
 
-       ctx->header = malloc(512);
-       num_probes = g_slist_length(o->device->probes);
-       samplerate = *((uint64_t *) o->device->plugin->get_device_info(o->device->plugin_index, DI_CUR_SAMPLERATE));
-       snprintf(ctx->header, 512, "Acquisition with %d/%d probes at ", ctx->num_enabled_probes, num_probes);
+       if (!(ctx->header = malloc(512))) {
+               free(ctx);
+               return SIGROK_ERR_MALLOC;
+       }
 
-       if ((samplerate_s = sigrok_samplerate_string(samplerate)) == NULL)
-               return -1; // FIXME
-       snprintf(ctx->header + strlen(ctx->header), 512, "%s\n", samplerate_s);
-       free(samplerate_s);
+       snprintf(ctx->header, 511, "%s\n", PACKAGE_STRING);
+       if (o->device->plugin) {
+               num_probes = g_slist_length(o->device->probes);
+               samplerate = *((uint64_t *) o->device->plugin->get_device_info(
+                               o->device->plugin_index, DI_CUR_SAMPLERATE));
+               if (!(samplerate_s = sigrok_samplerate_string(samplerate))) {
+                       free(ctx->header);
+                       free(ctx);
+                       return SIGROK_ERR;
+               }
+               snprintf(ctx->header + strlen(ctx->header),
+                        511 - strlen(ctx->header),
+                        "Acquisition with %d/%d probes at %s\n",
+                        ctx->num_enabled_probes, num_probes, samplerate_s);
+               free(samplerate_s);
+       }
 
-       ctx->linebuf_len = ctx->samples_per_line * 2;
-       ctx->linebuf = calloc(1, num_probes * ctx->linebuf_len);
-       ctx->linevalues = calloc(1, num_probes);
+       ctx->linebuf_len = ctx->samples_per_line * 2 + 4;
+       if (!(ctx->linebuf = calloc(1, num_probes * ctx->linebuf_len))) {
+               free(ctx->header);
+               free(ctx);
+               return SIGROK_ERR_MALLOC;
+       }
+       if (!(ctx->linevalues = calloc(1, num_probes))) {
+               free(ctx->header);
+               free(ctx);
+               return SIGROK_ERR_MALLOC;
+       }
 
-       return 0;
+       return SIGROK_OK;
 }
 
-
-static int event(struct output *o, int event_type, char **data_out, uint64_t *length_out)
+static int event(struct output *o, int event_type, char **data_out,
+                uint64_t *length_out)
 {
        struct context *ctx;
        int outsize;
        char *outbuf;
 
        ctx = o->internal;
-       switch(event_type) {
+       switch (event_type) {
        case DF_TRIGGER:
+               ctx->mark_trigger = ctx->spl_cnt;
                break;
        case DF_END:
-               outsize = ctx->num_enabled_probes * (ctx->samples_per_line + 20) + 512;
-               outbuf = calloc(1, outsize);
-               flush_linebufs(ctx, o->device->probes, outbuf);
+               outsize = ctx->num_enabled_probes
+                               * (ctx->samples_per_line + 20) + 512;
+               if (!(outbuf = calloc(1, outsize)))
+                       return SIGROK_ERR_MALLOC;
+               flush_linebufs(ctx, outbuf);
                *data_out = outbuf;
                *length_out = strlen(outbuf);
                free(o->internal);
@@ -134,61 +170,67 @@ static int event(struct output *o, int event_type, char **data_out, uint64_t *le
        return SIGROK_OK;
 }
 
-
-static int init_binary(struct output *o)
+static int init_bits(struct output *o)
 {
-
-       return init(o, DEFAULT_BPL_BIN);
-
+       return init(o, DEFAULT_BPL_BITS);
 }
 
-
-static int data_binary(struct output *o, char *data_in, uint64_t length_in, char **data_out, uint64_t *length_out)
+static int data_bits(struct output *o, char *data_in, uint64_t length_in,
+                    char **data_out, uint64_t *length_out)
 {
        struct context *ctx;
-       int outsize, offset, p;
+       unsigned int outsize, offset, p;
        uint64_t sample;
        char *outbuf;
 
        ctx = o->internal;
-       outsize = length_in / ctx->unitsize * ctx->num_enabled_probes * ctx->samples_per_line + 512;
-       outbuf = calloc(1, outsize+1);
-       if(ctx->header) {
-               /* the header is still in here, we must be on the first data packet */
+       outsize = length_in / ctx->unitsize * ctx->num_enabled_probes *
+                 ctx->samples_per_line + 4096;
+
+       if (!(outbuf = calloc(1, outsize + 1)))
+               return SIGROK_ERR_MALLOC;
+
+       outbuf[0] = '\0';
+       if (ctx->header) {
+               /* The header is still here, this must be the first packet. */
                strncpy(outbuf, ctx->header, outsize);
                free(ctx->header);
                ctx->header = NULL;
        }
-       else
-               outbuf[0] = 0;
 
-       if(length_in >= ctx->unitsize) {
-               for(offset = 0; offset <= length_in - ctx->unitsize; offset += ctx->unitsize) {
+       if (length_in >= ctx->unitsize) {
+               for (offset = 0; offset <= length_in - ctx->unitsize;
+                    offset += ctx->unitsize) {
                        memcpy(&sample, data_in + offset, ctx->unitsize);
-                       for(p = 0; p < ctx->num_enabled_probes; p++) {
-                               if(sample & ((uint64_t) 1 << p))
-                                       ctx->linebuf[p * ctx->linebuf_len + ctx->line_offset] = '1';
+                       for (p = 0; p < ctx->num_enabled_probes; p++) {
+                               if (sample & ((uint64_t) 1 << p))
+                                       ctx->linebuf[p * ctx->linebuf_len +
+                                                    ctx->line_offset] = '1';
                                else
-                                       ctx->linebuf[p * ctx->linebuf_len + ctx->line_offset] = '0';
+                                       ctx->linebuf[p * ctx->linebuf_len +
+                                                    ctx->line_offset] = '0';
                        }
                        ctx->line_offset++;
                        ctx->spl_cnt++;
 
-                       /* space every 8th bit */
-                       if((ctx->spl_cnt & 7) == 0) {
-                               for(p = 0; p < ctx->num_enabled_probes; p++)
-                                       ctx->linebuf[p * ctx->linebuf_len + ctx->line_offset] = ' ';
+                       /* Add a space every 8th bit. */
+                       if ((ctx->spl_cnt & 7) == 0) {
+                               for (p = 0; p < ctx->num_enabled_probes; p++)
+                                       ctx->linebuf[p * ctx->linebuf_len +
+                                                    ctx->line_offset] = ' ';
                                ctx->line_offset++;
                        }
 
-                       /* end of line */
-                       if(ctx->spl_cnt >= ctx->samples_per_line) {
-                               flush_linebufs(ctx, o->device->probes, outbuf);
+                       /* End of line. */
+                       if (ctx->spl_cnt >= ctx->samples_per_line) {
+                               flush_linebufs(ctx, outbuf);
                                ctx->line_offset = ctx->spl_cnt = 0;
+                               ctx->mark_trigger = -1;
                        }
                }
-       } else
-               g_message("short buffer (length_in=%"PRIu64")", length_in);
+       } else {
+               g_message("short buffer (length_in=%" PRIu64 ")", length_in);
+       }
 
        *data_out = outbuf;
        *length_out = strlen(outbuf);
@@ -196,55 +238,58 @@ static int data_binary(struct output *o, char *data_in, uint64_t length_in, char
        return SIGROK_OK;
 }
 
-
 static int init_hex(struct output *o)
 {
-
-       return init(o, DEFAULT_BPL_BIN);
-
+       return init(o, DEFAULT_BPL_BITS);
 }
 
-
-static int data_hex(struct output *o, char *data_in, uint64_t length_in, char **data_out, uint64_t *length_out)
+static int data_hex(struct output *o, char *data_in, uint64_t length_in,
+                   char **data_out, uint64_t *length_out)
 {
        struct context *ctx;
-       int outsize, offset, p;
+       unsigned int outsize, offset, p;
        uint64_t sample;
        char *outbuf;
 
        ctx = o->internal;
-       outsize = length_in / ctx->unitsize * ctx->num_enabled_probes * ctx->samples_per_line + 512;
-       outbuf = calloc(1, outsize+1);
-       if(ctx->header) {
-               /* the header is still in here, we must be on the first data packet */
+       outsize = length_in / ctx->unitsize * ctx->num_enabled_probes *
+                 ctx->samples_per_line + 4096;
+
+       if (!(outbuf = calloc(1, outsize + 1)))
+               return SIGROK_ERR_MALLOC;
+
+       outbuf[0] = '\0';
+       if (ctx->header) {
+               /* The header is still here, this must be the first packet. */
                strncpy(outbuf, ctx->header, outsize);
                free(ctx->header);
                ctx->header = NULL;
        }
-       else
-               outbuf[0] = 0;
 
        ctx->line_offset = 0;
-       for(offset = 0; offset <= length_in - ctx->unitsize; offset += ctx->unitsize) {
+       for (offset = 0; offset <= length_in - ctx->unitsize;
+            offset += ctx->unitsize) {
                memcpy(&sample, data_in + offset, ctx->unitsize);
-               for(p = 0; p < ctx->num_enabled_probes; p++) {
+               for (p = 0; p < ctx->num_enabled_probes; p++) {
                        ctx->linevalues[p] <<= 1;
-            if(sample & ((uint64_t) 1 << p))
-                ctx->linevalues[p] |= 1;
-            sprintf(ctx->linebuf + (p * ctx->linebuf_len) + ctx->line_offset, "%.2x", ctx->linevalues[p]);
+                       if (sample & ((uint64_t) 1 << p))
+                               ctx->linevalues[p] |= 1;
+                       sprintf(ctx->linebuf + (p * ctx->linebuf_len) +
+                               ctx->line_offset, "%.2x", ctx->linevalues[p]);
                }
                ctx->spl_cnt++;
 
-               /* space after every complete hex byte */
-               if((ctx->spl_cnt & 7) == 0) {
-                       for(p = 0; p < ctx->num_enabled_probes; p++)
-                               ctx->linebuf[p * ctx->linebuf_len + ctx->line_offset + 2] = ' ';
+               /* Add a space after every complete hex byte. */
+               if ((ctx->spl_cnt & 7) == 0) {
+                       for (p = 0; p < ctx->num_enabled_probes; p++)
+                               ctx->linebuf[p * ctx->linebuf_len +
+                                            ctx->line_offset + 2] = ' ';
                        ctx->line_offset += 3;
                }
 
-               /* end of line */
-               if(ctx->spl_cnt >= ctx->samples_per_line) {
-                       flush_linebufs(ctx, o->device->probes, outbuf);
+               /* End of line. */
+               if (ctx->spl_cnt >= ctx->samples_per_line) {
+                       flush_linebufs(ctx, outbuf);
                        ctx->line_offset = ctx->spl_cnt = 0;
                }
        }
@@ -255,22 +300,18 @@ static int data_hex(struct output *o, char *data_in, uint64_t length_in, char **
        return SIGROK_OK;
 }
 
-
-
-struct output_format output_text_binary = {
-       "bin",
-       "Text (binary)",
-       init_binary,
-       data_binary,
-       event
+struct output_format output_text_bits = {
+       "bits",
+       "Text (bits)",
+       init_bits,
+       data_bits,
+       event,
 };
 
-
 struct output_format output_text_hex = {
        "hex",
        "Text (hexadecimal)",
        init_hex,
        data_hex,
-       event
+       event,
 };
-