Cleanup: typo fix in comment
[babeltrace.git] / plugins / ctf / fs-sink / write.c
index 45ba3bcbb4a03241182e5ef666782877d3b1a802..feee19472fe086fc7c3a90258e734b50f0ad0053 100644 (file)
@@ -53,15 +53,54 @@ void unref_stream(struct bt_ctf_stream_class *writer_stream)
        bt_put(writer_stream);
 }
 
+static
 gboolean empty_ht(gpointer key, gpointer value, gpointer user_data)
 {
        return TRUE;
 }
 
+static
+gboolean empty_streams_ht(gpointer key, gpointer value, gpointer user_data)
+{
+       struct bt_ctf_stream *writer_stream = value;
+
+       bt_ctf_stream_flush(writer_stream);
+
+       return TRUE;
+}
+
+static
+void destroy_stream_state_key(gpointer key)
+{
+       g_free((enum fs_writer_stream_state *) key);
+}
+
+static
+void check_completed_trace(gpointer key, gpointer value, gpointer user_data)
+{
+       enum fs_writer_stream_state *state = value;
+       int *trace_completed = user_data;
+
+       if (*state != FS_WRITER_COMPLETED_STREAM) {
+               *trace_completed = 0;
+       }
+}
+
 static
 void trace_is_static_listener(struct bt_ctf_trace *trace, void *data)
 {
-       *((int *) data) = 1;
+       struct fs_writer *fs_writer = data;
+       int trace_completed = 1;
+
+       fs_writer->trace_static = 1;
+
+       g_hash_table_foreach(fs_writer->stream_states,
+                       check_completed_trace, &trace_completed);
+       if (trace_completed) {
+               writer_close(fs_writer->writer_component, fs_writer);
+               g_hash_table_remove(fs_writer->writer_component->trace_map,
+                               fs_writer->trace);
+       }
 }
 
 static
@@ -122,6 +161,138 @@ end:
        return writer_stream_class;
 }
 
+static
+enum fs_writer_stream_state *insert_new_stream_state(
+               struct writer_component *writer_component,
+               struct fs_writer *fs_writer, struct bt_ctf_stream *stream)
+{
+       enum fs_writer_stream_state *v = NULL;
+
+       v = g_new0(enum fs_writer_stream_state, 1);
+       if (!v) {
+               fprintf(writer_component->err,
+                               "[error] %s in %s:%d\n", __func__,
+                               __FILE__, __LINE__);
+       }
+       *v = FS_WRITER_UNKNOWN_STREAM;
+
+       g_hash_table_insert(fs_writer->stream_states, stream, v);
+
+       return v;
+}
+
+/*
+ * Make sure the output path is valid for a single trace: either it does
+ * not exists or it is empty.
+ *
+ * Return 0 if the path is valid, -1 otherwise.
+ */
+static
+bool valid_single_trace_path(const char *path)
+{
+       int n = 0;
+       struct dirent *d;
+       DIR *dir = opendir(path);
+       int ret;
+
+       /* non-existent directory. */
+       if (!dir) {
+               ret = 0;
+               goto end;
+       }
+
+       while ((d = readdir(dir)) != NULL) {
+               if (++n > 2) {
+                       break;
+               }
+       }
+
+       ret = closedir(dir);
+       if (ret) {
+               perror("closedir");
+               goto end;
+       }
+
+       if (n <= 2) {
+               ret = 0;
+       } else {
+               ret = -1;
+       }
+
+end:
+       return ret;
+}
+
+static
+int make_trace_path(struct writer_component *writer_component,
+               struct bt_ctf_trace *trace, char *trace_path)
+{
+       int ret;
+       const char *trace_name;
+
+       if (writer_component->single_trace) {
+               trace_name = "\0";
+       } else {
+               trace_name = bt_ctf_trace_get_name(trace);
+               if (!trace_name) {
+                       trace_name = writer_component->trace_name_base->str;
+               }
+       }
+
+       /* Sanitize the trace name. */
+       if (strlen(trace_name) == 2 && !strcmp(trace_name, "..")) {
+               fprintf(writer_component->err, "[error] Trace name cannot "
+                               "be \"..\"\n");
+               goto error;
+       }
+
+       if (strstr(trace_name, "../")) {
+               fprintf(writer_component->err, "[error] Trace name cannot "
+                               "contain \"../\", received \"%s\"\n",
+                               trace_name);
+               goto error;
+
+       }
+
+       snprintf(trace_path, PATH_MAX, "%s/%s",
+                       writer_component->base_path->str,
+                       trace_name);
+       /*
+        * Append a suffix if the trace_path exists and we are not in
+        * single-trace mode.
+        */
+       if (writer_component->single_trace) {
+               if (valid_single_trace_path(trace_path) != 0) {
+                       fprintf(writer_component->err,
+                                       "[error] Invalid output directory\n");
+                       goto error;
+               }
+       } else {
+               if (g_file_test(trace_path, G_FILE_TEST_EXISTS)) {
+                       int i = 0;
+
+                       do {
+                               snprintf(trace_path, PATH_MAX, "%s/%s-%d",
+                                               writer_component->base_path->str,
+                                               trace_name, ++i);
+                       } while (g_file_test(trace_path, G_FILE_TEST_EXISTS) && i < INT_MAX);
+                       if (i == INT_MAX) {
+                               fprintf(writer_component->err, "[error] Unable to find "
+                                               "a unique trace path\n");
+                               goto error;
+                       }
+               }
+       }
+
+       ret = 0;
+       goto end;
+
+error:
+       ret = -1;
+end:
+       return ret;
+}
+
 static
 struct fs_writer *insert_new_writer(
                struct writer_component *writer_component,
@@ -129,18 +300,29 @@ struct fs_writer *insert_new_writer(
 {
        struct bt_ctf_writer *ctf_writer = NULL;
        struct bt_ctf_trace *writer_trace = NULL;
-       char trace_name[PATH_MAX];
+       char trace_path[PATH_MAX];
        enum bt_component_status ret;
-       struct fs_writer *fs_writer;
+       struct bt_ctf_stream *stream = NULL;
+       struct fs_writer *fs_writer = NULL;
+       int nr_stream, i;
 
-       /* FIXME: replace with trace name when it will work. */
-       snprintf(trace_name, PATH_MAX, "%s/%s_%03d",
-                       writer_component->base_path->str,
-                       writer_component->trace_name_base->str,
-                       writer_component->trace_id++);
-       printf_verbose("CTF-Writer creating trace in %s\n", trace_name);
+       if (writer_component->single_trace && writer_component->nr_traces > 0) {
+               fprintf(writer_component->err, "[error] Trying to process more "
+                               "than one trace but --single-trace mode "
+                               "enabled\n");
+               goto error;
+       }
+
+       ret = make_trace_path(writer_component, trace, trace_path);
+       if (ret) {
+               fprintf(writer_component->err, "[error] %s in %s:%d\n",
+                               __func__, __FILE__, __LINE__);
+               goto error;
+       }
 
-       ctf_writer = bt_ctf_writer_create(trace_name);
+       printf("ctf.fs sink creating trace in %s\n", trace_path);
+
+       ctf_writer = bt_ctf_writer_create(trace_path);
        if (!ctf_writer) {
                fprintf(writer_component->err, "[error] %s in %s:%d\n",
                                __func__, __FILE__, __LINE__);
@@ -172,37 +354,58 @@ struct fs_writer *insert_new_writer(
                goto error;
        }
        fs_writer->writer = ctf_writer;
+       fs_writer->trace = trace;
+       fs_writer->writer_trace = writer_trace;
+       fs_writer->writer_component = writer_component;
+       BT_PUT(writer_trace);
        fs_writer->stream_class_map = g_hash_table_new_full(g_direct_hash,
                        g_direct_equal, NULL, (GDestroyNotify) unref_stream_class);
        fs_writer->stream_map = g_hash_table_new_full(g_direct_hash,
                        g_direct_equal, NULL, (GDestroyNotify) unref_stream);
-       fs_writer->trace = trace;
-       fs_writer->writer_trace = writer_trace;
-       BT_PUT(writer_trace);
+       fs_writer->stream_states = g_hash_table_new_full(g_direct_hash,
+                       g_direct_equal, NULL, destroy_stream_state_key);
+
+       /* Set all the existing streams in the unknown state. */
+       nr_stream = bt_ctf_trace_get_stream_count(trace);
+       for (i = 0; i < nr_stream; i++) {
+               stream = bt_ctf_trace_get_stream_by_index(trace, i);
+               if (!stream) {
+                       fprintf(writer_component->err,
+                                       "[error] %s in %s:%d\n", __func__,
+                                       __FILE__, __LINE__);
+                       goto error;
+               }
+               insert_new_stream_state(writer_component, fs_writer, stream);
+               BT_PUT(stream);
+       }
+
+       /* Check if the trace is already static or register a listener. */
        if (bt_ctf_trace_is_static(trace)) {
                fs_writer->trace_static = 1;
                fs_writer->static_listener_id = -1;
        } else {
                ret = bt_ctf_trace_add_is_static_listener(trace,
-                               trace_is_static_listener, &fs_writer->trace_static);
+                               trace_is_static_listener, fs_writer);
                if (ret < 0) {
                        fprintf(writer_component->err,
                                        "[error] %s in %s:%d\n", __func__, __FILE__,
                                        __LINE__);
-                       g_free(fs_writer);
-                       fs_writer = NULL;
                        goto error;
                }
                fs_writer->static_listener_id = ret;
        }
 
+       writer_component->nr_traces++;
        g_hash_table_insert(writer_component->trace_map, (gpointer) trace,
                        fs_writer);
 
        goto end;
 
 error:
+       g_free(fs_writer);
+       fs_writer = NULL;
        bt_put(writer_trace);
+       bt_put(stream);
        BT_PUT(ctf_writer);
 end:
        return fs_writer;
@@ -366,7 +569,7 @@ BT_HIDDEN
 void writer_close(struct writer_component *writer_component,
                struct fs_writer *fs_writer)
 {
-       if (fs_writer->static_listener_id > 0) {
+       if (fs_writer->static_listener_id >= 0) {
                bt_ctf_trace_remove_is_static_listener(fs_writer->trace,
                                fs_writer->static_listener_id);
        }
@@ -378,8 +581,13 @@ void writer_close(struct writer_component *writer_component,
 
        /* Empty the stream HT. */
        g_hash_table_foreach_remove(fs_writer->stream_map,
-                       empty_ht, NULL);
+                       empty_streams_ht, NULL);
        g_hash_table_destroy(fs_writer->stream_map);
+
+       /* Empty the stream state HT. */
+       g_hash_table_foreach_remove(fs_writer->stream_states,
+                       empty_ht, NULL);
+       g_hash_table_destroy(fs_writer->stream_states);
 }
 
 BT_HIDDEN
@@ -391,6 +599,7 @@ enum bt_component_status writer_stream_begin(
        struct fs_writer *fs_writer;
        struct bt_ctf_stream *writer_stream = NULL;
        enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
+       enum fs_writer_stream_state *state;
 
        stream_class = bt_ctf_stream_get_class(stream);
        if (!stream_class) {
@@ -405,6 +614,25 @@ enum bt_component_status writer_stream_begin(
                                __func__, __FILE__, __LINE__);
                goto error;
        }
+
+       /* Set the stream as active */
+       state = g_hash_table_lookup(fs_writer->stream_states, stream);
+       if (!state) {
+               if (fs_writer->trace_static) {
+                       fprintf(writer_component->err, "[error] Adding a new "
+                                       "stream on a static trace\n");
+                       goto error;
+               }
+               state = insert_new_stream_state(writer_component, fs_writer,
+                               stream);
+       }
+       if (*state != FS_WRITER_UNKNOWN_STREAM) {
+               fprintf(writer_component->err, "[error] Unexpected stream "
+                               "state %d\n", *state);
+               goto error;
+       }
+       *state = FS_WRITER_ACTIVE_STREAM;
+
        writer_stream = insert_new_stream(writer_component, fs_writer,
                        stream_class, stream);
        if (!writer_stream) {
@@ -412,7 +640,6 @@ enum bt_component_status writer_stream_begin(
                                __func__, __FILE__, __LINE__);
                goto error;
        }
-       fs_writer->active_streams++;
 
        goto end;
 
@@ -432,6 +659,7 @@ enum bt_component_status writer_stream_end(
        struct fs_writer *fs_writer;
        struct bt_ctf_trace *trace = NULL;
        enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
+       enum fs_writer_stream_state *state;
 
        stream_class = bt_ctf_stream_get_class(stream);
        if (!stream_class) {
@@ -446,14 +674,27 @@ enum bt_component_status writer_stream_end(
                                __func__, __FILE__, __LINE__);
                goto error;
        }
+
+       state = g_hash_table_lookup(fs_writer->stream_states, stream);
+       if (*state != FS_WRITER_ACTIVE_STREAM) {
+               fprintf(writer_component->err, "[error] Unexpected stream "
+                               "state %d\n", *state);
+               goto error;
+       }
+       *state = FS_WRITER_COMPLETED_STREAM;
+
        g_hash_table_remove(fs_writer->stream_map, stream);
 
-       assert(fs_writer->active_streams > 0);
-       fs_writer->active_streams--;
-       if (fs_writer->active_streams == 0 && fs_writer->trace_static) {
-               writer_close(writer_component, fs_writer);
-               g_hash_table_remove(writer_component->trace_map,
-                               fs_writer->trace);
+       if (fs_writer->trace_static) {
+               int trace_completed = 1;
+
+               g_hash_table_foreach(fs_writer->stream_states,
+                               check_completed_trace, &trace_completed);
+               if (trace_completed) {
+                       writer_close(writer_component, fs_writer);
+                       g_hash_table_remove(writer_component->trace_map,
+                                       fs_writer->trace);
+               }
        }
 
        goto end;
@@ -472,7 +713,6 @@ enum bt_component_status writer_new_packet(
                struct bt_ctf_packet *packet)
 {
        struct bt_ctf_stream *stream = NULL, *writer_stream = NULL;
-       struct bt_ctf_field *writer_packet_context = NULL;
        enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
        int int_ret;
 
@@ -491,23 +731,21 @@ enum bt_component_status writer_new_packet(
        }
        BT_PUT(stream);
 
-       writer_packet_context = ctf_copy_packet_context(writer_component->err,
-                       packet, writer_stream, 1);
-       if (!writer_packet_context) {
+       int_ret = ctf_stream_copy_packet_context(
+                       writer_component->err, packet, writer_stream);
+       if (int_ret < 0) {
                fprintf(writer_component->err, "[error] %s in %s:%d\n",
                                __func__, __FILE__, __LINE__);
                goto error;
        }
 
-       int_ret = bt_ctf_stream_set_packet_context(writer_stream,
-                       writer_packet_context);
-       if (int_ret < 0) {
-               fprintf(writer_component->err, "[error] %s in %s:%d\n", __func__,
-                               __FILE__, __LINE__);
+       ret = ctf_stream_copy_packet_header(writer_component->err,
+                       packet, writer_stream);
+       if (ret != 0) {
+               fprintf(writer_component->err, "[error] %s in %s:%d\n",
+                               __func__, __FILE__, __LINE__);
                goto error;
        }
-       BT_PUT(writer_stream);
-       BT_PUT(writer_packet_context);
 
        goto end;
 
@@ -515,7 +753,6 @@ error:
        ret = BT_COMPONENT_STATUS_ERROR;
 end:
        bt_put(writer_stream);
-       bt_put(writer_packet_context);
        bt_put(stream);
        return ret;
 }
This page took 0.02829 seconds and 4 git commands to generate.