2 * Copyright (C) 2012 - Julien Desfossez <jdesfossez@efficios.com>
3 * David Goulet <dgoulet@efficios.com>
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License, version 2 only,
7 * as published by the Free Software Foundation.
9 * This program is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14 * You should have received a copy of the GNU General Public License along
15 * with this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
19 #ifndef LTTNG_RELAYD_H
20 #define LTTNG_RELAYD_H
25 #include <urcu/wfqueue.h>
26 #include <urcu/list.h>
28 #include <common/hashtable/hashtable.h>
29 #include <common/index/ctf-index.h>
31 #include "ctf-trace.h"
35 * Queue used to enqueue relay requests
37 struct relay_cmd_queue
{
38 struct cds_wfq_queue queue
;
42 enum connection_type
{
45 RELAY_VIEWER_COMMAND
= 3,
46 RELAY_VIEWER_NOTIFICATION
= 4,
50 * When we receive a stream, it gets stored in a list (on a per connection
51 * basis) until we have all the streams of the same channel and the metadata
52 * associated with it, then it gets flagged with viewer_ready.
54 struct relay_stream_recv_handle
{
55 uint64_t id
; /* stream handle */
56 struct cds_list_head node
;
60 * Represents a stream in the relay
63 uint64_t stream_handle
;
64 uint64_t prev_seq
; /* previous data sequence number encountered */
65 struct lttng_ht_node_ulong stream_n
;
66 struct relay_session
*session
;
67 struct rcu_head rcu_node
;
69 /* FD on which to write the index data. */
71 /* FD on which to read the index data for the viewer. */
76 /* on-disk circular buffer of tracefiles */
77 uint64_t tracefile_size
;
78 uint64_t tracefile_size_current
;
79 uint64_t tracefile_count
;
80 uint64_t tracefile_count_current
;
81 /* To inform the viewer up to where it can go back in time. */
82 uint64_t oldest_tracefile_id
;
84 uint64_t total_index_received
;
85 uint64_t last_net_seq_num
;
88 * This node is added to the *control* connection hash table and the
89 * pointer is copied in here so we can access it when deleting this object.
90 * When deleting this, the ctf trace ht MUST NOT be destroyed. This happens
91 * at connection deletion.
93 struct lttng_ht_node_str ctf_trace_node
;
94 struct lttng_ht
*ctf_traces_ht
;
97 * To protect from concurrent read/update between the
98 * streaming-side and the viewer-side.
99 * This lock must be held, we reading/updating the
102 pthread_mutex_t lock
;
104 struct ctf_trace
*ctf_trace
;
106 * If the stream is inactive, this field is updated with the live beacon
107 * timestamp end, when it is active, this field == -1ULL.
109 uint64_t beacon_ts_end
;
111 * To protect the update of the close_write_flag and the checks of
112 * the tracefile_count_current.
113 * It is taken before checking whenever we need to know if the
114 * writer and reader are working in the same tracefile.
116 pthread_mutex_t viewer_stream_rotation_lock
;
118 /* Information telling us when to close the stream */
119 unsigned int close_flag
:1;
120 /* Indicate if the stream was initialized for a data pending command. */
121 unsigned int data_pending_check_done
:1;
122 unsigned int metadata_flag
:1;
124 * To detect when we start overwriting old data, it is used to
125 * update the oldest_tracefile_id.
127 unsigned int tracefile_overwrite
:1;
129 * Can this stream be used by a viewer or are we waiting for additional
132 unsigned int viewer_ready
:1;
136 * Internal structure to map a socket with the corresponding session.
137 * A hashtable indexed on the socket FD is used for the lookups.
139 struct relay_command
{
140 struct lttcomm_sock
*sock
;
141 struct relay_session
*session
;
142 struct cds_wfq_node node
;
143 struct lttng_ht_node_ulong sock_n
;
144 struct rcu_head rcu_node
;
145 enum connection_type type
;
146 /* protocol version to use for this session */
149 struct lttng_ht
*ctf_traces_ht
; /* indexed by path name */
151 struct cds_list_head recv_head
;
152 unsigned int version_check_done
:1;
155 struct relay_local_data
{
156 struct lttng_ht
*sessions_ht
;
159 extern char *opt_output_path
;
161 extern struct lttng_ht
*relay_streams_ht
;
162 extern struct lttng_ht
*viewer_streams_ht
;
163 extern struct lttng_ht
*indexes_ht
;
165 extern const char *tracing_group_name
;
167 extern int thread_quit_pipe
[2];
169 struct relay_stream
*relay_stream_find_by_id(uint64_t stream_id
);
170 void lttng_relay_notify_ready(void);
172 #endif /* LTTNG_RELAYD_H */