]> sigrok.org Git - libsigrok.git/blobdiff - src/input/csv.c
input/csv: include section nits
[libsigrok.git] / src / input / csv.c
index 1d230fdcad0e2c3777f329943fc1ddc219a6de0f..93288973b685c330c17c4495fe5a8e5b3ffe6201 100644 (file)
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#include <config.h>
+#include "config.h"
+
+#include <glib.h>
 #include <stdlib.h>
 #include <string.h>
-#include <glib.h>
+
 #include <libsigrok/libsigrok.h>
 #include "libsigrok-internal.h"
 
 #define LOG_PREFIX "input/csv"
 
+#define CHUNK_SIZE     (4 * 1024 * 1024)
+
 /*
  * The CSV input module has the following options:
  *
@@ -156,14 +160,18 @@ struct context {
        /* Format sample data is stored in single column mode. */
        int format;
 
-       /* Size of the sample buffer. */
-       size_t sample_buffer_size;
+       size_t sample_unit_size;        /**!< Byte count for a single sample. */
+       uint8_t *sample_buffer;         /**!< Buffer for a single sample. */
 
-       /* Buffer to store sample data. */
-       uint8_t *sample_buffer;
+       uint8_t *datafeed_buffer;       /**!< Queue for datafeed submission. */
+       size_t datafeed_buf_size;
+       size_t datafeed_buf_fill;
 
        /* Current line number. */
        size_t line_number;
+
+       /* List of previously created sigrok channels. */
+       GSList *prev_sr_channels;
 };
 
 static void strip_comment(char *buf, const GString *prefix)
@@ -190,7 +198,7 @@ static int parse_binstr(const char *str, struct context *inc)
        }
 
        /* Clear buffer in order to set bits only. */
-       memset(inc->sample_buffer, 0, (inc->num_channels + 7) >> 3);
+       memset(inc->sample_buffer, 0, inc->sample_unit_size);
 
        i = inc->first_channel;
 
@@ -222,7 +230,7 @@ static int parse_hexstr(const char *str, struct context *inc)
        }
 
        /* Clear buffer in order to set bits only. */
-       memset(inc->sample_buffer, 0, (inc->num_channels + 7) >> 3);
+       memset(inc->sample_buffer, 0, inc->sample_unit_size);
 
        /* Calculate the position of the first hexadecimal digit. */
        i = inc->first_channel / 4;
@@ -266,7 +274,7 @@ static int parse_octstr(const char *str, struct context *inc)
        }
 
        /* Clear buffer in order to set bits only. */
-       memset(inc->sample_buffer, 0, (inc->num_channels + 7) >> 3);
+       memset(inc->sample_buffer, 0, inc->sample_unit_size);
 
        /* Calculate the position of the first octal digit. */
        i = inc->first_channel / 3;
@@ -349,7 +357,7 @@ static int parse_multi_columns(char **columns, struct context *inc)
        char *column;
 
        /* Clear buffer in order to set bits only. */
-       memset(inc->sample_buffer, 0, (inc->num_channels + 7) >> 3);
+       memset(inc->sample_buffer, 0, inc->sample_unit_size);
 
        for (i = 0; i < inc->num_channels; i++) {
                column = columns[i];
@@ -391,26 +399,47 @@ static int parse_single_column(const char *column, struct context *inc)
        return res;
 }
 
-static int send_samples(const struct sr_dev_inst *sdi, uint8_t *buffer,
-               gsize buffer_size, gsize count)
+static int flush_samples(const struct sr_input *in)
 {
+       struct context *inc;
        struct sr_datafeed_packet packet;
        struct sr_datafeed_logic logic;
-       int res;
-       gsize i;
+       int rc;
+
+       inc = in->priv;
+       if (!inc->datafeed_buf_fill)
+               return SR_OK;
 
+       memset(&packet, 0, sizeof(packet));
+       memset(&logic, 0, sizeof(logic));
        packet.type = SR_DF_LOGIC;
        packet.payload = &logic;
-       logic.unitsize = buffer_size;
-       logic.length = buffer_size;
-       logic.data = buffer;
-
-       for (i = 0; i < count; i++) {
-               res = sr_session_send(sdi, &packet);
-               if (res != SR_OK)
-                       return res;
-       }
+       logic.unitsize = inc->sample_unit_size;
+       logic.length = inc->datafeed_buf_fill;
+       logic.data = inc->datafeed_buffer;
 
+       rc = sr_session_send(in->sdi, &packet);
+       if (rc != SR_OK)
+               return rc;
+
+       inc->datafeed_buf_fill = 0;
+       return SR_OK;
+}
+
+static int queue_samples(const struct sr_input *in)
+{
+       struct context *inc;
+       int rc;
+
+       inc = in->priv;
+
+       inc->datafeed_buf_fill += inc->sample_unit_size;
+       if (inc->datafeed_buf_fill == inc->datafeed_buf_size) {
+               rc = flush_samples(in);
+               if (rc != SR_OK)
+                       return rc;
+       }
+       inc->sample_buffer = &inc->datafeed_buffer[inc->datafeed_buf_fill];
        return SR_OK;
 }
 
@@ -480,6 +509,44 @@ static int init(struct sr_input *in, GHashTable *options)
        return SR_OK;
 }
 
+/*
+ * Check the channel list for consistency across file re-import. See
+ * the VCD input module for more details and motivation.
+ */
+
+static void keep_header_for_reread(const struct sr_input *in)
+{
+       struct context *inc;
+
+       inc = in->priv;
+       g_slist_free_full(inc->prev_sr_channels, sr_channel_free_cb);
+       inc->prev_sr_channels = in->sdi->channels;
+       in->sdi->channels = NULL;
+}
+
+static int check_header_in_reread(const struct sr_input *in)
+{
+       struct context *inc;
+
+       if (!in)
+               return FALSE;
+       inc = in->priv;
+       if (!inc)
+               return FALSE;
+       if (!inc->prev_sr_channels)
+               return TRUE;
+
+       if (sr_channel_lists_differ(inc->prev_sr_channels, in->sdi->channels)) {
+               sr_err("Channel list change not supported for file re-read.");
+               return FALSE;
+       }
+       g_slist_free_full(in->sdi->channels, sr_channel_free_cb);
+       in->sdi->channels = inc->prev_sr_channels;
+       inc->prev_sr_channels = NULL;
+
+       return TRUE;
+}
+
 static const char *delim_set = "\r\n";
 
 static const char *get_line_termination(GString *buf)
@@ -591,13 +658,24 @@ static int initial_parse(const struct sr_input *in, GString *buf)
                sr_channel_new(in->sdi, i, SR_CHANNEL_LOGIC, TRUE, channel_name->str);
        }
        g_string_free(channel_name, TRUE);
+       if (!check_header_in_reread(in)) {
+               ret = SR_ERR_DATA;
+               goto out;
+       }
 
        /*
-        * Calculate the minimum buffer size to store the sample data of the
-        * channels.
+        * Calculate the minimum buffer size to store the set of samples
+        * of all channels (unit size). Determine a larger buffer size
+        * for datafeed submission that is a multiple of the unit size.
+        * Allocate the larger buffer, and have the "sample buffer" point
+        * to a location within that large buffer.
         */
-       inc->sample_buffer_size = (inc->num_channels + 7) >> 3;
-       inc->sample_buffer = g_malloc(inc->sample_buffer_size);
+       inc->sample_unit_size = (inc->num_channels + 7) / 8;
+       inc->datafeed_buf_size = CHUNK_SIZE;
+       inc->datafeed_buf_size *= inc->sample_unit_size;
+       inc->datafeed_buffer = g_malloc(inc->datafeed_buf_size);
+       inc->datafeed_buf_fill = 0;
+       inc->sample_buffer = &inc->datafeed_buffer[inc->datafeed_buf_fill];
 
 out:
        if (columns)
@@ -753,6 +831,7 @@ static int process_buffer(struct sr_input *in, gboolean is_eof)
                columns = parse_line(line, inc, max_columns);
                if (!columns) {
                        sr_err("Error while parsing line %zu.", inc->line_number);
+                       g_strfreev(lines);
                        return SR_ERR;
                }
                num_columns = g_strv_length(columns);
@@ -760,6 +839,7 @@ static int process_buffer(struct sr_input *in, gboolean is_eof)
                        sr_err("Column %u in line %zu is out of bounds.",
                                inc->first_column, inc->line_number);
                        g_strfreev(columns);
+                       g_strfreev(lines);
                        return SR_ERR;
                }
                /*
@@ -770,6 +850,7 @@ static int process_buffer(struct sr_input *in, gboolean is_eof)
                        sr_err("Not enough columns for desired number of channels in line %zu.",
                                inc->line_number);
                        g_strfreev(columns);
+                       g_strfreev(lines);
                        return SR_ERR;
                }
 
@@ -779,16 +860,19 @@ static int process_buffer(struct sr_input *in, gboolean is_eof)
                        ret = parse_single_column(columns[0], inc);
                if (ret != SR_OK) {
                        g_strfreev(columns);
+                       g_strfreev(lines);
                        return SR_ERR;
                }
 
                /* Send sample data to the session bus. */
-               ret = send_samples(in->sdi, inc->sample_buffer,
-                       inc->sample_buffer_size, 1);
+               ret = queue_samples(in);
                if (ret != SR_OK) {
                        sr_err("Sending samples failed.");
+                       g_strfreev(columns);
+                       g_strfreev(lines);
                        return SR_ERR;
                }
+
                g_strfreev(columns);
        }
        g_strfreev(lines);
@@ -832,6 +916,12 @@ static int end(struct sr_input *in)
                ret = process_buffer(in, TRUE);
        else
                ret = SR_OK;
+       if (ret != SR_OK)
+               return ret;
+
+       ret = flush_samples(in);
+       if (ret != SR_OK)
+               return ret;
 
        inc = in->priv;
        if (inc->started)
@@ -844,16 +934,14 @@ static void cleanup(struct sr_input *in)
 {
        struct context *inc;
 
-       inc = in->priv;
-
-       if (inc->delimiter)
-               g_string_free(inc->delimiter, TRUE);
+       keep_header_for_reread(in);
 
-       if (inc->comment)
-               g_string_free(inc->comment, TRUE);
+       inc = in->priv;
 
        g_free(inc->termination);
-       g_free(inc->sample_buffer);
+       inc->termination = NULL;
+       g_free(inc->datafeed_buffer);
+       inc->datafeed_buffer = NULL;
 }
 
 static int reset(struct sr_input *in)
@@ -868,25 +956,32 @@ static int reset(struct sr_input *in)
 }
 
 static struct sr_option options[] = {
-       { "single-column", "Single column", "Enable/specify single column", NULL, NULL },
-       { "numchannels", "Max channels", "Number of channels", NULL, NULL },
-       { "delimiter", "Delimiter", "Column delimiter", NULL, NULL },
-       { "format", "Format", "Numeric format", NULL, NULL },
-       { "comment", "Comment", "Comment prefix character", NULL, NULL },
-       { "samplerate", "Samplerate", "Samplerate used during capture", NULL, NULL },
-       { "first-channel", "First channel", "Column number of first channel", NULL, NULL },
-       { "header", "Header", "Treat first line as header with channel names", NULL, NULL },
-       { "startline", "Start line", "Line number at which to start processing samples", NULL, NULL },
+       { "single-column", "Single column", "Enable single-column mode, using the specified column (>= 1); 0: multi-col. mode", NULL, NULL },
+       { "numchannels", "Number of logic channels", "The number of (logic) channels (single-col. mode: number of bits beginning at 'first channel', LSB-first)", NULL, NULL },
+       { "delimiter", "Column delimiter", "The column delimiter (>= 1 characters)", NULL, NULL },
+       { "format", "Data format (single-col. mode)", "The numeric format of the data (single-col. mode): bin, hex, oct", NULL, NULL },
+       { "comment", "Comment character(s)", "The comment prefix character(s)", NULL, NULL },
+       { "samplerate", "Samplerate (Hz)", "The sample rate (used during capture) in Hz", NULL, NULL },
+       { "first-channel", "First channel", "The column number of the first channel (multi-col. mode); bit position for the first channel (single-col. mode)", NULL, NULL },
+       { "header", "Interpret first line as header (multi-col. mode)", "Treat the first line as header with channel names (multi-col. mode)", NULL, NULL },
+       { "startline", "Start line", "The line number at which to start processing samples (>= 1)", NULL, NULL },
        ALL_ZERO
 };
 
 static const struct sr_option *get_options(void)
 {
+       GSList *l;
+
        if (!options[0].def) {
                options[0].def = g_variant_ref_sink(g_variant_new_int32(0));
                options[1].def = g_variant_ref_sink(g_variant_new_int32(0));
                options[2].def = g_variant_ref_sink(g_variant_new_string(","));
                options[3].def = g_variant_ref_sink(g_variant_new_string("bin"));
+               l = NULL;
+               l = g_slist_append(l, g_variant_ref_sink(g_variant_new_string("bin")));
+               l = g_slist_append(l, g_variant_ref_sink(g_variant_new_string("hex")));
+               l = g_slist_append(l, g_variant_ref_sink(g_variant_new_string("oct")));
+               options[3].values = l;
                options[4].def = g_variant_ref_sink(g_variant_new_string(";"));
                options[5].def = g_variant_ref_sink(g_variant_new_uint64(0));
                options[6].def = g_variant_ref_sink(g_variant_new_int32(0));