2 * Copyright (C) 2013 Julien Desfossez <jdesfossez@efficios.com>
3 * Copyright (C) 2013 David Goulet <dgoulet@efficios.com>
4 * Copyright (C) 2015 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
6 * SPDX-License-Identifier: GPL-2.0-only
11 #include <common/common.h>
12 #include <urcu/rculist.h>
14 #include "lttng-relayd.h"
15 #include "ctf-trace.h"
17 #include "viewer-session.h"
18 #include "viewer-stream.h"
21 struct relay_viewer_session
*viewer_session_create(void)
23 struct relay_viewer_session
*vsession
;
25 vsession
= zmalloc(sizeof(*vsession
));
29 CDS_INIT_LIST_HEAD(&vsession
->session_list
);
34 int viewer_session_set_trace_chunk_copy(struct relay_viewer_session
*vsession
,
35 struct lttng_trace_chunk
*relay_session_trace_chunk
)
38 struct lttng_trace_chunk
*viewer_chunk
;
40 lttng_trace_chunk_put(vsession
->current_trace_chunk
);
41 vsession
->current_trace_chunk
= NULL
;
43 DBG("Copying relay session's current trace chunk to the viewer session");
44 if (!relay_session_trace_chunk
) {
48 viewer_chunk
= lttng_trace_chunk_copy(relay_session_trace_chunk
);
50 ERR("Failed to create a viewer trace chunk from the relay session's current chunk");
55 vsession
->current_trace_chunk
= viewer_chunk
;
60 /* The existence of session must be guaranteed by the caller. */
61 enum lttng_viewer_attach_return_code
viewer_session_attach(
62 struct relay_viewer_session
*vsession
,
63 struct relay_session
*session
)
65 enum lttng_viewer_attach_return_code viewer_attach_status
=
66 LTTNG_VIEWER_ATTACH_OK
;
68 ASSERT_LOCKED(session
->lock
);
70 /* Will not fail, as per the ownership guarantee. */
71 if (!session_get(session
)) {
72 viewer_attach_status
= LTTNG_VIEWER_ATTACH_UNK
;
75 if (session
->viewer_attached
) {
76 viewer_attach_status
= LTTNG_VIEWER_ATTACH_ALREADY
;
80 assert(!vsession
->current_trace_chunk
);
81 session
->viewer_attached
= true;
83 ret
= viewer_session_set_trace_chunk_copy(vsession
,
84 session
->current_trace_chunk
);
87 * The live protocol does not define a generic error
88 * value for the "attach" command. The "unknown"
89 * status is used so that the viewer may handle this
90 * failure as if the session didn't exist anymore.
92 DBG("Failed to create a viewer trace chunk from the current trace chunk of session \"%s\", returning LTTNG_VIEWER_ATTACH_UNK",
93 session
->session_name
);
94 viewer_attach_status
= LTTNG_VIEWER_ATTACH_UNK
;
98 if (viewer_attach_status
== LTTNG_VIEWER_ATTACH_OK
) {
99 pthread_mutex_lock(&vsession
->session_list_lock
);
100 /* Ownership is transfered to the list. */
101 cds_list_add_rcu(&session
->viewer_session_node
,
102 &vsession
->session_list
);
103 pthread_mutex_unlock(&vsession
->session_list_lock
);
105 /* Put our local ref. */
106 session_put(session
);
109 return viewer_attach_status
;
112 /* The existence of session must be guaranteed by the caller. */
113 static int viewer_session_detach(struct relay_viewer_session
*vsession
,
114 struct relay_session
*session
)
118 pthread_mutex_lock(&session
->lock
);
119 if (!session
->viewer_attached
) {
122 session
->viewer_attached
= false;
126 pthread_mutex_lock(&vsession
->session_list_lock
);
127 cds_list_del_rcu(&session
->viewer_session_node
);
128 pthread_mutex_unlock(&vsession
->session_list_lock
);
129 /* Release reference held by the list. */
130 session_put(session
);
132 /* Safe since we know the session exists. */
133 pthread_mutex_unlock(&session
->lock
);
137 void viewer_session_destroy(struct relay_viewer_session
*vsession
)
139 lttng_trace_chunk_put(vsession
->current_trace_chunk
);
144 * Release ownership of all the streams of one session and detach the viewer.
146 void viewer_session_close_one_session(struct relay_viewer_session
*vsession
,
147 struct relay_session
*session
)
149 struct lttng_ht_iter iter
;
150 struct relay_viewer_stream
*vstream
;
153 * TODO: improvement: create more efficient list of
154 * vstream per session.
156 cds_lfht_for_each_entry(viewer_streams_ht
->ht
, &iter
.iter
,
157 vstream
, stream_n
.node
) {
158 if (!viewer_stream_get(vstream
)) {
161 if (vstream
->stream
->trace
->session
!= session
) {
162 viewer_stream_put(vstream
);
165 /* Put local reference. */
166 viewer_stream_put(vstream
);
168 * We have reached one of the viewer stream's lifetime
169 * end condition. This "put" will cause the proper
170 * teardown of the viewer stream.
172 viewer_stream_put(vstream
);
174 lttng_trace_chunk_put(vsession
->current_trace_chunk
);
175 vsession
->current_trace_chunk
= NULL
;
176 viewer_session_detach(vsession
, session
);
179 void viewer_session_close(struct relay_viewer_session
*vsession
)
181 struct relay_session
*session
;
184 cds_list_for_each_entry_rcu(session
,
185 &vsession
->session_list
, viewer_session_node
) {
186 viewer_session_close_one_session(vsession
, session
);
192 * Check if a connection is attached to a session.
193 * Return 1 if attached, 0 if not attached, a negative value on error.
195 int viewer_session_is_attached(struct relay_viewer_session
*vsession
,
196 struct relay_session
*session
)
198 struct relay_session
*iter
;
201 pthread_mutex_lock(&session
->lock
);
205 if (!session
->viewer_attached
) {
209 cds_list_for_each_entry_rcu(iter
,
210 &vsession
->session_list
,
211 viewer_session_node
) {
212 if (session
== iter
) {
220 pthread_mutex_unlock(&session
->lock
);