X-Git-Url: http://git.efficios.com/?p=babeltrace.git;a=blobdiff_plain;f=src%2Fplugins%2Fctf%2Flttng-live%2Flttng-live.h;h=d0d5b153385866683bbf9c8aad8d164858192fa5;hp=7b72147f9aabc7fcc1461d3ccba3161992fee742;hb=1a25881946640f778a14e8f5491795193572d826;hpb=7c14d64103ff43ddeb43aaa04df17beb107f1f78 diff --git a/src/plugins/ctf/lttng-live/lttng-live.h b/src/plugins/ctf/lttng-live/lttng-live.h index 7b72147f..d0d5b153 100644 --- a/src/plugins/ctf/lttng-live/lttng-live.h +++ b/src/plugins/ctf/lttng-live/lttng-live.h @@ -1,42 +1,26 @@ -#ifndef BABELTRACE_PLUGIN_CTF_LTTNG_LIVE_H -#define BABELTRACE_PLUGIN_CTF_LTTNG_LIVE_H - /* - * BabelTrace - LTTng-live client Component + * SPDX-License-Identifier: MIT * * Copyright 2019 Francis Deslauriers * Copyright 2016 Jérémie Galarneau * Copyright 2016 Mathieu Desnoyers * - * Author: Jérémie Galarneau - * - * Permission is hereby granted, free of charge, to any person obtaining a copy - * of this software and associated documentation files (the "Software"), to deal - * in the Software without restriction, including without limitation the rights - * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell - * copies of the Software, and to permit persons to whom the Software is - * furnished to do so, subject to the following conditions: - * - * The above copyright notice and this permission notice shall be included in - * all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, - * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE - * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER - * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, - * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE - * SOFTWARE. + * BabelTrace - LTTng-live client Component */ +#ifndef BABELTRACE_PLUGIN_CTF_LTTNG_LIVE_H +#define BABELTRACE_PLUGIN_CTF_LTTNG_LIVE_H + #include +#include + +#include -#include "common/macros.h" #include +#include "common/macros.h" #include "../common/metadata/decoder.h" #include "../common/msg-iter/msg-iter.h" - #include "viewer-connection.h" struct lttng_live_component; @@ -77,11 +61,14 @@ struct lttng_live_stream_iterator { * Since only a single iterator per viewer connection, we have * only a single message iterator per stream. */ - struct bt_msg_iter *msg_iter; + struct ctf_msg_iter *msg_iter; uint64_t viewer_stream_id; - uint64_t ctf_stream_class_id; + struct { + bool is_set; + uint64_t value; + } ctf_stream_class_id; /* base offset in current index. */ uint64_t base_offset; @@ -94,7 +81,10 @@ struct lttng_live_stream_iterator { * Clock Snapshot value of the last message iterator inactivity message * sent downstream. */ - uint64_t last_inactivity_ts; + struct { + bool is_set; + uint64_t value; + } last_inactivity_ts; /* * Clock Snapshot value of the current message iterator inactivity @@ -108,7 +98,7 @@ struct lttng_live_stream_iterator { * The current message produced by this live stream iterator. Owned by * this. */ - bt_message *current_msg; + const bt_message *current_msg; /* Timestamp in nanoseconds of the current message (current_msg). */ int64_t current_msg_ts_ns; @@ -119,20 +109,38 @@ struct lttng_live_stream_iterator { /* Owned by this. */ GString *name; + + bool has_stream_hung_up; }; struct lttng_live_metadata { bt_logging_level log_level; bt_self_component *self_comp; - /* Weak reference. */ - struct lttng_live_trace *trace; - uint64_t stream_id; /* Weak reference. */ struct ctf_metadata_decoder *decoder; +}; - bool closed; +enum lttng_live_metadata_stream_state { + /* + * The metadata needs to be updated. This is either because we just + * created the trace and haven't asked yet, or the relay specifically + * told us that new metadata is available. + */ + LTTNG_LIVE_METADATA_STREAM_STATE_NEEDED, + /* + * The metadata was updated and the relay has not told us we need to + * update it yet. + */ + LTTNG_LIVE_METADATA_STREAM_STATE_NOT_NEEDED, + /* + * The relay has closed this metadata stream. We set this in reaction + * to a LTTNG_VIEWER_METADATA_ERR reply to a LTTNG_VIEWER_GET_METADATA + * command to the relay. If this field is set, we have received all the + * metadata that we are ever going to get for that metadata stream. + */ + LTTNG_LIVE_METADATA_STREAM_STATE_CLOSED, }; struct lttng_live_trace { @@ -159,7 +167,7 @@ struct lttng_live_trace { /* Owned by this. */ GPtrArray *stream_iterators; - bool new_metadata_needed; + enum lttng_live_metadata_stream_state metadata_stream_state; }; struct lttng_live_session { @@ -187,7 +195,6 @@ struct lttng_live_session { }; enum session_not_found_action { - SESSION_NOT_FOUND_ACTION_UNKNOWN, SESSION_NOT_FOUND_ACTION_CONTINUE, SESSION_NOT_FOUND_ACTION_FAIL, SESSION_NOT_FOUND_ACTION_END, @@ -237,6 +244,9 @@ struct lttng_live_msg_iter { /* Timestamp in nanosecond of the last message sent downstream. */ int64_t last_msg_ts_ns; + + /* True if the iterator was interrupted. */ + bool was_interrupted; }; enum lttng_live_iterator_status { @@ -258,8 +268,9 @@ enum lttng_live_iterator_status { LTTNG_LIVE_ITERATOR_STATUS_UNSUPPORTED = -4, }; -bt_component_class_init_method_status lttng_live_component_init( +bt_component_class_initialize_method_status lttng_live_component_init( bt_self_component_source *self_comp, + bt_self_component_source_configuration *config, const bt_value *params, void *init_method_data); bt_component_class_query_method_status lttng_live_query( @@ -270,49 +281,62 @@ bt_component_class_query_method_status lttng_live_query( void lttng_live_component_finalize(bt_self_component_source *component); -bt_component_class_message_iterator_next_method_status lttng_live_msg_iter_next( +bt_message_iterator_class_next_method_status lttng_live_msg_iter_next( bt_self_message_iterator *iterator, bt_message_array_const msgs, uint64_t capacity, uint64_t *count); -bt_component_class_message_iterator_init_method_status lttng_live_msg_iter_init( +bt_message_iterator_class_initialize_method_status lttng_live_msg_iter_init( bt_self_message_iterator *self_msg_it, - bt_self_component_source *self_comp, + bt_self_message_iterator_configuration *config, bt_self_component_port_output *self_port); void lttng_live_msg_iter_finalize(bt_self_message_iterator *it); -int lttng_live_create_viewer_session(struct lttng_live_msg_iter *lttng_live_msg_iter); -int lttng_live_attach_session(struct lttng_live_session *session); -int lttng_live_detach_session(struct lttng_live_session *session); -enum lttng_live_iterator_status lttng_live_get_new_streams( +enum lttng_live_viewer_status lttng_live_session_attach( + struct lttng_live_session *session, + bt_self_message_iterator *self_msg_iter); + +enum lttng_live_viewer_status lttng_live_session_detach( struct lttng_live_session *session); +enum lttng_live_iterator_status lttng_live_session_get_new_streams( + struct lttng_live_session *session, + bt_self_message_iterator *self_msg_iter); + +struct lttng_live_trace *lttng_live_session_borrow_or_create_trace_by_id( + struct lttng_live_session *session, uint64_t trace_id); + int lttng_live_add_session(struct lttng_live_msg_iter *lttng_live_msg_iter, uint64_t session_id, const char *hostname, const char *session_name); -ssize_t lttng_live_get_one_metadata_packet(struct lttng_live_trace *trace, - FILE *fp); +/* + * lttng_live_get_one_metadata_packet() asks the Relay Daemon for new metadata. + * If new metadata is received, the function writes it to the provided file + * handle and updates the reply_len output parameter. This function should be + * called in loop until _END status is received to ensure all metadata is + * written to the file. + */ +enum lttng_live_get_one_metadata_status lttng_live_get_one_metadata_packet( + struct lttng_live_trace *trace, FILE *fp, size_t *reply_len); + enum lttng_live_iterator_status lttng_live_get_next_index( struct lttng_live_msg_iter *lttng_live_msg_iter, struct lttng_live_stream_iterator *stream, struct packet_index *index); -enum bt_msg_iter_medium_status lttng_live_get_stream_bytes( +enum ctf_msg_iter_medium_status lttng_live_get_stream_bytes( struct lttng_live_msg_iter *lttng_live_msg_iter, struct lttng_live_stream_iterator *stream, uint8_t *buf, uint64_t offset, uint64_t req_len, uint64_t *recv_len); -void lttng_live_add_stream_iterator(struct lttng_live_msg_iter *lttng_live_msg_iter, - struct lttng_live_stream_iterator *stream_iter); -void lttng_live_remove_stream_iterator(struct lttng_live_msg_iter *lttng_live_msg_iter, - struct lttng_live_stream_iterator *stream_iter); - -struct lttng_live_trace *lttng_live_borrow_trace( - struct lttng_live_session *session, uint64_t trace_id); -void lttng_live_need_new_streams(struct lttng_live_msg_iter *lttng_live_msg_iter); bool lttng_live_graph_is_canceled(struct lttng_live_msg_iter *msg_iter); +BT_HIDDEN +void lttng_live_stream_iterator_set_state( + struct lttng_live_stream_iterator *stream_iter, + enum lttng_live_stream_state new_state); + #endif /* BABELTRACE_PLUGIN_CTF_LTTNG_LIVE_H */