]> sigrok.org Git - sigrok-cli.git/blobdiff - input.c
doc: update sigrok-cli(1) for channel assignment to decoder inputs
[sigrok-cli.git] / input.c
diff --git a/input.c b/input.c
index b81e84b47a5ab94541636dc02008aa256add3608..cce0d9ff916b9a159f0f3400d80bd5d96df263eb 100644 (file)
--- a/input.c
+++ b/input.c
@@ -17,8 +17,7 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#include "sigrok-cli.h"
-#include "config.h"
+#include <config.h>
 #include <sys/types.h>
 #include <sys/stat.h>
 #include <fcntl.h>
 #include <stdlib.h>
 #include <string.h>
 #include <glib.h>
+#include "sigrok-cli.h"
 
-#define BUFSIZE 16384
+#define CHUNK_SIZE (4 * 1024 * 1024)
 
-static void load_input_file_module(void)
+static void load_input_file_module(struct df_arg_desc *df_arg)
 {
        struct sr_session *session;
        const struct sr_input *in;
@@ -43,6 +43,8 @@ static void load_input_file_module(void)
        int fd;
        ssize_t len;
        char *mod_id;
+       gboolean is_stdin;
+       gboolean push_scan_data;
 
        if (!sr_input_list())
                g_critical("No supported input formats available.");
@@ -50,12 +52,14 @@ static void load_input_file_module(void)
        mod_id = NULL;
        mod_args = NULL;
        if (opt_input_format) {
-               mod_args = parse_generic_arg(opt_input_format, TRUE);
+               mod_args = parse_generic_arg(opt_input_format, TRUE, NULL);
                mod_id = g_hash_table_lookup(mod_args, "sigrok_key");
        }
 
+       is_stdin = strcmp(opt_input_file, "-") == 0;
+       push_scan_data = FALSE;
        fd = 0;
-       buf = g_string_sized_new(BUFSIZE);
+       buf = g_string_sized_new(CHUNK_SIZE);
        if (mod_id) {
                /* User specified an input module to use. */
                if (!(imod = sr_input_find(mod_id)))
@@ -63,20 +67,22 @@ static void load_input_file_module(void)
                g_hash_table_remove(mod_args, "sigrok_key");
                if ((options = sr_input_options_get(imod))) {
                        mod_opts = generic_arg_to_opt(options, mod_args);
-                       sr_output_options_free(options);
-               } else
+                       (void)warn_unknown_keys(options, mod_args, NULL);
+                       sr_input_options_free(options);
+               } else {
                        mod_opts = NULL;
+               }
                if (!(in = sr_input_new(imod, mod_opts)))
                        g_critical("Error: failed to initialize input module.");
                if (mod_opts)
                        g_hash_table_destroy(mod_opts);
                if (mod_args)
                        g_hash_table_destroy(mod_args);
-               if ((fd = open(opt_input_file, O_RDONLY)) == -1)
+               if (!is_stdin && (fd = open(opt_input_file, O_RDONLY)) < 0)
                        g_critical("Failed to load %s: %s.", opt_input_file,
-                                       strerror(errno));
+                                       g_strerror(errno));
        } else {
-               if (strcmp(opt_input_file, "-")) {
+               if (!is_stdin) {
                        /*
                         * An actual filename: let the input modules try to
                         * identify the file.
@@ -90,44 +96,69 @@ static void load_input_file_module(void)
                         * Taking input from a pipe: let the input modules try
                         * to identify the stream content.
                         */
-                       if (!strcmp(opt_input_file, "-")) {
+                       if (is_stdin) {
                                /* stdin */
                                fd = 0;
                        } else {
-                               if ((fd = open(opt_input_file, O_RDONLY)) == -1)
+                               fd = open(opt_input_file, O_RDONLY);
+                               if (fd == -1)
                                        g_critical("Failed to load %s: %s.", opt_input_file,
-                                                       strerror(errno));
+                                                       g_strerror(errno));
                        }
-                       if ((len = read(fd, buf->str, BUFSIZE)) < 1)
+                       if ((len = read(fd, buf->str, buf->allocated_len)) < 1)
                                g_critical("Failed to read %s: %s.", opt_input_file,
-                                               strerror(errno));
+                                               g_strerror(errno));
                        buf->len = len;
                        sr_input_scan_buffer(buf, &in);
+                       push_scan_data = TRUE;
                }
                if (!in)
                        g_critical("Error: no input module found for this file.");
        }
-       sr_session_new(&session);
-       sr_session_datafeed_callback_add(session, &datafeed_in, NULL);
+       sr_session_new(sr_ctx, &session);
+       df_arg->session = session;
+       sr_session_datafeed_callback_add(session, datafeed_in, df_arg);
 
+       /*
+        * Implementation detail: The combination of reading from stdin
+        * and automatic file format detection may have pushed the first
+        * chunk of input data into the input module's data accumulator,
+        * _bypassing_ the .receive() callback. It is essential to call
+        * .receive() before calling .end() for files of size smaller than
+        * CHUNK_SIZE (which is a typical case). So that sdi becomes ready.
+        * Fortunately all input modules accept .receive() calls with
+        * a zero length, and inspect whatever was accumulated so far.
+        *
+        * After that optional initial push of data which was queued
+        * above during format detection, continue reading remaining
+        * chunks from the input file until EOF is seen.
+        */
        got_sdi = FALSE;
-       while(TRUE) {
+       while (TRUE) {
                g_string_truncate(buf, 0);
-               len = read(fd, buf->str, BUFSIZE);
+               if (push_scan_data)
+                       len = 0;
+               else
+                       len = read(fd, buf->str, buf->allocated_len);
                if (len < 0)
-                       g_critical("Read failed: %s", strerror(errno));
-               if (len == 0)
+                       g_critical("Read failed: %s", g_strerror(errno));
+               if (len == 0 && !push_scan_data)
                        /* End of file or stream. */
                        break;
+               push_scan_data = FALSE;
                buf->len = len;
-               if (sr_input_send(in, buf) != SR_OK)
+               if (sr_input_send(in, buf) != SR_OK) {
+                       g_critical("File import failed (read)");
                        break;
+               }
 
                sdi = sr_input_dev_inst_get(in);
-               if(!got_sdi && sdi) {
+               if (!got_sdi && sdi) {
                        /* First time we got a valid sdi. */
-                       if (select_channels(sdi) != SR_OK)
+                       if (select_channels(sdi) != SR_OK) {
+                               g_critical("File import failed (channels)");
                                return;
+                       }
                        if (sr_session_dev_add(session, sdi) != SR_OK) {
                                g_critical("Failed to use device.");
                                sr_session_destroy(session);
@@ -135,42 +166,68 @@ static void load_input_file_module(void)
                        }
                        got_sdi = TRUE;
                }
-
        }
        sr_input_end(in);
        sr_input_free(in);
        g_string_free(buf, TRUE);
+       close(fd);
 
+       df_arg->session = NULL;
        sr_session_destroy(session);
-
 }
 
-void load_input_file(void)
+void load_input_file(gboolean do_props)
 {
+       struct df_arg_desc df_arg;
        struct sr_session *session;
        struct sr_dev_inst *sdi;
        GSList *devices;
+       GMainLoop *main_loop;
        int ret;
 
-       if (strcmp(opt_input_file, "-") && sr_session_load(opt_input_file, &session) == SR_OK) {
-               /* sigrok session file */
-               ret = sr_session_dev_list(session, &devices);
-               if (ret != SR_OK || !devices->data) {
-                       g_critical("Failed to access session device.");
-                       sr_session_destroy(session);
-                       return;
-               }
-               sdi = devices->data;
-               if (select_channels(sdi) != SR_OK) {
+       memset(&df_arg, 0, sizeof(df_arg));
+       df_arg.do_props = do_props;
+
+       if (!strcmp(opt_input_file, "-")) {
+               /* Input from stdin is never a session file. */
+               load_input_file_module(&df_arg);
+       } else {
+               if ((ret = sr_session_load(sr_ctx, opt_input_file,
+                               &session)) == SR_OK) {
+                       /* sigrok session file */
+                       ret = sr_session_dev_list(session, &devices);
+                       if (ret != SR_OK || !devices || !devices->data) {
+                               g_critical("Failed to access session device.");
+                               g_slist_free(devices);
+                               sr_session_destroy(session);
+                               return;
+                       }
+                       sdi = devices->data;
+                       g_slist_free(devices);
+                       if (select_channels(sdi) != SR_OK) {
+                               sr_session_destroy(session);
+                               return;
+                       }
+                       main_loop = g_main_loop_new(NULL, FALSE);
+
+                       df_arg.session = session;
+                       sr_session_datafeed_callback_add(session,
+                               datafeed_in, &df_arg);
+                       sr_session_stopped_callback_set(session,
+                               (sr_session_stopped_callback)g_main_loop_quit,
+                               main_loop);
+                       if (sr_session_start(session) == SR_OK)
+                               g_main_loop_run(main_loop);
+
+                       g_main_loop_unref(main_loop);
+                       df_arg.session = NULL;
                        sr_session_destroy(session);
-                       return;
+               } else if (ret != SR_ERR) {
+                       /* It's a session file, but it didn't work out somehow. */
+                       g_critical("Failed to load session file.");
+               } else {
+                       /* Fall back on input modules. */
+                       load_input_file_module(&df_arg);
                }
-               sr_session_datafeed_callback_add(session, datafeed_in, NULL);
-               sr_session_start(session);
-               sr_session_run(session);
-               sr_session_stop(session);
-       } else {
-               /* fall back on input modules */
-               load_input_file_module();
        }
 }