#include <babeltrace/ctf-ir/fields.h>
#include <babeltrace/ctf-writer/stream-class.h>
#include <babeltrace/ctf-writer/stream.h>
+#include <assert.h>
#include <ctfcopytrace.h>
#include "writer.h"
+static
+void unref_stream_class(struct bt_ctf_stream_class *writer_stream_class)
+{
+ bt_put(writer_stream_class);
+}
+
+static
+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)
+{
+ 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
struct bt_ctf_stream_class *insert_new_stream_class(
struct writer_component *writer_component,
- struct bt_ctf_writer *ctf_writer,
+ struct fs_writer *fs_writer,
struct bt_ctf_stream_class *stream_class)
{
struct bt_ctf_stream_class *writer_stream_class = NULL;
struct bt_ctf_trace *trace = NULL, *writer_trace = NULL;
+ struct bt_ctf_writer *ctf_writer = fs_writer->writer;
enum bt_component_status ret;
trace = bt_ctf_stream_class_get_trace(stream_class);
goto error;
}
- g_hash_table_insert(writer_component->stream_class_map,
+ ret = bt_ctf_trace_add_stream_class(writer_trace, writer_stream_class);
+ if (ret) {
+ fprintf(writer_component->err,
+ "[error] %s in %s:%d\n", __func__, __FILE__,
+ __LINE__);
+ goto error;
+ }
+
+ g_hash_table_insert(fs_writer->stream_class_map,
(gpointer) stream_class, writer_stream_class);
goto end;
}
static
-struct bt_ctf_stream *insert_new_stream(
+enum fs_writer_stream_state *insert_new_stream_state(
struct writer_component *writer_component,
- struct bt_ctf_writer *ctf_writer,
- struct bt_ctf_stream_class *stream_class,
- struct bt_ctf_stream *stream)
+ struct fs_writer *fs_writer, struct bt_ctf_stream *stream)
{
- struct bt_ctf_stream *writer_stream = NULL;
- struct bt_ctf_stream_class *writer_stream_class = NULL;
+ enum fs_writer_stream_state *v = NULL;
- writer_stream_class = g_hash_table_lookup(
- writer_component->stream_class_map,
- (gpointer) stream_class);
- if (!writer_stream_class) {
- writer_stream_class = insert_new_stream_class(
- writer_component, ctf_writer, stream_class);
- if (!writer_stream_class) {
- fprintf(writer_component->err, "[error] %s in %s:%d\n",
- __func__, __FILE__, __LINE__);
- goto error;
- }
+ v = g_new0(enum fs_writer_stream_state, 1);
+ if (!v) {
+ fprintf(writer_component->err,
+ "[error] %s in %s:%d\n", __func__,
+ __FILE__, __LINE__);
}
- bt_get(writer_stream_class);
+ *v = FS_WRITER_UNKNOWN_STREAM;
- writer_stream = bt_ctf_writer_create_stream(ctf_writer,
- writer_stream_class);
- if (!writer_stream) {
- fprintf(writer_component->err, "[error] %s in %s:%d\n",
- __func__, __FILE__, __LINE__);
- goto error;
+ 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;
}
- g_hash_table_insert(writer_component->stream_map, (gpointer) stream,
- writer_stream);
+ while ((d = readdir(dir)) != NULL) {
+ /* Ignore "." and ".." directories. */
+ if (++n > 2) {
+ break;
+ }
+ }
- goto end;
+ ret = closedir(dir);
+ if (ret) {
+ perror("closedir");
+ goto end;
+ }
+
+ if (n <= 2) {
+ ret = 0;
+ } else {
+ ret = -1;
+ }
-error:
- BT_PUT(writer_stream);
end:
- bt_put(writer_stream_class);
- return writer_stream;
+ return ret;
}
static
-struct bt_ctf_stream *lookup_stream(struct writer_component *writer_component,
- struct bt_ctf_stream *stream)
+int make_trace_path(struct writer_component *writer_component,
+ struct bt_ctf_trace *trace, char *trace_path)
{
- return (struct bt_ctf_stream *) g_hash_table_lookup(
- writer_component->stream_map,
- (gpointer) stream);
-}
+ 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;
+ }
+ }
-static
-struct bt_ctf_event_class *get_event_class(struct writer_component *writer_component,
- struct bt_ctf_stream_class *writer_stream_class,
- struct bt_ctf_event_class *event_class)
-{
- return bt_ctf_stream_class_get_event_class_by_id(writer_stream_class,
- bt_ctf_event_class_get_id(event_class));
+ /* 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;
}
-struct bt_ctf_writer *insert_new_writer(
+static
+struct fs_writer *insert_new_writer(
struct writer_component *writer_component,
struct bt_ctf_trace *trace)
{
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 bt_ctf_stream *stream = NULL;
+ struct fs_writer *fs_writer = NULL;
+ int nr_stream, i;
+
+ 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;
+ }
- /* 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);
+ 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;
+ }
+
+ printf("ctf.fs sink creating trace in %s\n", trace_path);
- ctf_writer = bt_ctf_writer_create(trace_name);
+ ctf_writer = bt_ctf_writer_create(trace_path);
if (!ctf_writer) {
fprintf(writer_component->err, "[error] %s in %s:%d\n",
__func__, __FILE__, __LINE__);
fprintf(writer_component->err, "[error] %s in %s:%d\n",
__func__, __FILE__, __LINE__);
BT_PUT(ctf_writer);
- goto end;
+ goto error;
+ }
+
+ fs_writer = g_new0(struct fs_writer, 1);
+ if (!fs_writer) {
+ fprintf(writer_component->err,
+ "[error] %s in %s:%d\n", __func__, __FILE__,
+ __LINE__);
+ 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->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);
+ if (ret < 0) {
+ fprintf(writer_component->err,
+ "[error] %s in %s:%d\n", __func__, __FILE__,
+ __LINE__);
+ goto error;
+ }
+ fs_writer->static_listener_id = ret;
+ }
+ writer_component->nr_traces++;
g_hash_table_insert(writer_component->trace_map, (gpointer) trace,
- ctf_writer);
+ 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 ctf_writer;
+ return fs_writer;
}
static
-struct bt_ctf_writer *get_writer(struct writer_component *writer_component,
+struct fs_writer *get_fs_writer(struct writer_component *writer_component,
struct bt_ctf_stream_class *stream_class)
{
struct bt_ctf_trace *trace = NULL;
- struct bt_ctf_writer *ctf_writer = NULL;
+ struct fs_writer *fs_writer;
trace = bt_ctf_stream_class_get_trace(stream_class);
if (!trace) {
- ctf_writer = NULL;
fprintf(writer_component->err, "[error] %s in %s:%d\n",
__func__, __FILE__, __LINE__);
goto error;
}
- ctf_writer = g_hash_table_lookup(writer_component->trace_map,
+ fs_writer = g_hash_table_lookup(writer_component->trace_map,
(gpointer) trace);
- if (!ctf_writer) {
- ctf_writer = insert_new_writer(writer_component, trace);
+ if (!fs_writer) {
+ fs_writer = insert_new_writer(writer_component, trace);
}
- bt_get(ctf_writer);
BT_PUT(trace);
goto end;
error:
- BT_PUT(ctf_writer);
+ fs_writer = NULL;
end:
- return ctf_writer;
+ return fs_writer;
}
static
-struct bt_ctf_stream *get_writer_stream(
+struct fs_writer *get_fs_writer_from_stream(
struct writer_component *writer_component,
- struct bt_ctf_packet *packet, struct bt_ctf_stream *stream)
+ struct bt_ctf_stream *stream)
{
struct bt_ctf_stream_class *stream_class = NULL;
- struct bt_ctf_writer *ctf_writer = NULL;
- struct bt_ctf_stream *writer_stream = NULL;
+ struct fs_writer *fs_writer;
stream_class = bt_ctf_stream_get_class(stream);
if (!stream_class) {
goto error;
}
- ctf_writer = get_writer(writer_component, stream_class);
- if (!ctf_writer) {
+ fs_writer = get_fs_writer(writer_component, stream_class);
+ goto end;
+
+error:
+ fs_writer = NULL;
+
+end:
+ bt_put(stream_class);
+ return fs_writer;
+}
+
+static
+struct bt_ctf_stream_class *lookup_stream_class(
+ struct writer_component *writer_component,
+ struct bt_ctf_stream_class *stream_class)
+{
+ struct fs_writer *fs_writer = get_fs_writer(
+ writer_component, stream_class);
+ assert(fs_writer);
+ return (struct bt_ctf_stream_class *) g_hash_table_lookup(
+ fs_writer->stream_class_map, (gpointer) stream_class);
+}
+
+static
+struct bt_ctf_stream *lookup_stream(struct writer_component *writer_component,
+ struct bt_ctf_stream *stream)
+{
+ struct fs_writer *fs_writer = get_fs_writer_from_stream(
+ writer_component, stream);
+ assert(fs_writer);
+ return (struct bt_ctf_stream *) g_hash_table_lookup(
+ fs_writer->stream_map, (gpointer) stream);
+}
+
+static
+struct bt_ctf_stream *insert_new_stream(
+ struct writer_component *writer_component,
+ struct fs_writer *fs_writer,
+ struct bt_ctf_stream_class *stream_class,
+ struct bt_ctf_stream *stream)
+{
+ struct bt_ctf_stream *writer_stream = NULL;
+ struct bt_ctf_stream_class *writer_stream_class = NULL;
+ struct bt_ctf_writer *ctf_writer = bt_get(fs_writer->writer);
+
+ writer_stream_class = lookup_stream_class(writer_component,
+ stream_class);
+ if (!writer_stream_class) {
+ writer_stream_class = insert_new_stream_class(
+ writer_component, fs_writer, stream_class);
+ if (!writer_stream_class) {
+ fprintf(writer_component->err, "[error] %s in %s:%d\n",
+ __func__, __FILE__, __LINE__);
+ goto error;
+ }
+ }
+ bt_get(writer_stream_class);
+
+ writer_stream = bt_ctf_stream_create(writer_stream_class,
+ bt_ctf_stream_get_name(stream));
+ if (!writer_stream) {
fprintf(writer_component->err, "[error] %s in %s:%d\n",
__func__, __FILE__, __LINE__);
goto error;
}
+ g_hash_table_insert(fs_writer->stream_map, (gpointer) stream,
+ writer_stream);
+
+ goto end;
+
+error:
+ BT_PUT(writer_stream);
+end:
+ bt_put(ctf_writer);
+ bt_put(writer_stream_class);
+ return writer_stream;
+}
+
+static
+struct bt_ctf_event_class *get_event_class(struct writer_component *writer_component,
+ struct bt_ctf_stream_class *writer_stream_class,
+ struct bt_ctf_event_class *event_class)
+{
+ return bt_ctf_stream_class_get_event_class_by_id(writer_stream_class,
+ bt_ctf_event_class_get_id(event_class));
+}
+
+static
+struct bt_ctf_stream *get_writer_stream(
+ struct writer_component *writer_component,
+ struct bt_ctf_packet *packet, struct bt_ctf_stream *stream)
+{
+ struct bt_ctf_stream *writer_stream = NULL;
+
writer_stream = lookup_stream(writer_component, stream);
if (!writer_stream) {
- writer_stream = insert_new_stream(writer_component, ctf_writer,
- stream_class, stream);
+ fprintf(writer_component->err, "[error] %s in %s:%d\n",
+ __func__, __FILE__, __LINE__);
+ goto error;
}
bt_get(writer_stream);
error:
BT_PUT(writer_stream);
end:
- bt_put(ctf_writer);
- bt_put(stream_class);
return writer_stream;
}
+BT_HIDDEN
+void writer_close(struct writer_component *writer_component,
+ struct fs_writer *fs_writer)
+{
+ if (fs_writer->static_listener_id >= 0) {
+ bt_ctf_trace_remove_is_static_listener(fs_writer->trace,
+ fs_writer->static_listener_id);
+ }
+
+ /* Empty the stream class HT. */
+ g_hash_table_foreach_remove(fs_writer->stream_class_map,
+ empty_ht, NULL);
+ g_hash_table_destroy(fs_writer->stream_class_map);
+
+ /* Empty the stream HT. */
+ g_hash_table_foreach_remove(fs_writer->stream_map,
+ 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
+enum bt_component_status writer_stream_begin(
+ struct writer_component *writer_component,
+ struct bt_ctf_stream *stream)
+{
+ struct bt_ctf_stream_class *stream_class = NULL;
+ 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) {
+ fprintf(writer_component->err, "[error] %s in %s:%d\n",
+ __func__, __FILE__, __LINE__);
+ goto error;
+ }
+
+ fs_writer = get_fs_writer(writer_component, stream_class);
+ if (!fs_writer) {
+ fprintf(writer_component->err, "[error] %s in %s:%d\n",
+ __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) {
+ fprintf(writer_component->err, "[error] %s in %s:%d\n",
+ __func__, __FILE__, __LINE__);
+ goto error;
+ }
+
+ goto end;
+
+error:
+ ret = BT_COMPONENT_STATUS_ERROR;
+end:
+ bt_put(stream_class);
+ return ret;
+}
+
+BT_HIDDEN
+enum bt_component_status writer_stream_end(
+ struct writer_component *writer_component,
+ struct bt_ctf_stream *stream)
+{
+ struct bt_ctf_stream_class *stream_class = NULL;
+ 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) {
+ fprintf(writer_component->err, "[error] %s in %s:%d\n",
+ __func__, __FILE__, __LINE__);
+ goto error;
+ }
+
+ fs_writer = get_fs_writer(writer_component, stream_class);
+ if (!fs_writer) {
+ fprintf(writer_component->err, "[error] %s in %s:%d\n",
+ __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);
+
+ 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;
+
+error:
+ ret = BT_COMPONENT_STATUS_ERROR;
+end:
+ BT_PUT(trace);
+ BT_PUT(stream_class);
+ return ret;
+}
+
BT_HIDDEN
enum bt_component_status writer_new_packet(
struct writer_component *writer_component,
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;
}
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;
ret = BT_COMPONENT_STATUS_ERROR;
end:
bt_put(writer_stream);
- bt_put(writer_packet_context);
bt_put(stream);
return ret;
}
goto error;
}
- writer_stream_class = g_hash_table_lookup(
- writer_component->stream_class_map,
- (gpointer) stream_class);
+ writer_stream_class = lookup_stream_class(writer_component, stream_class);
if (!writer_stream_class || !bt_get(writer_stream_class)) {
fprintf(writer_component->err, "[error] %s in %s:%d\n", __func__,
__FILE__, __LINE__);