sessiond: implement kernel clear session
[lttng-tools.git] / src / bin / lttng-sessiond / session.h
CommitLineData
91d76f53 1/*
5b74c7b1
DG
2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
3 *
d14d33bf
AM
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License, version 2 only,
6 * as published by the Free Software Foundation.
5b74c7b1
DG
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
d14d33bf
AM
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
5b74c7b1
DG
16 */
17
18#ifndef _LTT_SESSION_H
19#define _LTT_SESSION_H
20
73184835 21#include <limits.h>
5c408ad8 22#include <stdbool.h>
20fe2104 23#include <urcu/list.h>
d4a2a84a 24
6dc3064a 25#include <common/hashtable/hashtable.h>
3e3665b8 26#include <common/dynamic-array.h>
db66e574 27#include <lttng/rotation.h>
5d65beab 28#include <lttng/location.h>
82b69413 29#include <lttng/lttng-error.h>
6dc3064a
DG
30
31#include "snapshot.h"
00187dd4 32#include "trace-kernel.h"
dd73d57b 33#include "consumer.h"
7972aab2
DG
34
35struct ltt_ust_session;
00187dd4 36
3e3665b8
JG
37typedef void (*ltt_session_destroy_notifier)(const struct ltt_session *session,
38 void *user_data);
39
b5541356
DG
40/*
41 * Tracing session list
42 *
43 * Statically declared in session.c and can be accessed by using
54d01ffb 44 * session_get_list() function that returns the pointer to the list.
b5541356 45 */
5b74c7b1 46struct ltt_session_list {
b5541356 47 /*
a24f7994
MD
48 * This lock protects any read/write access to the list and
49 * next_uuid. All public functions in session.c acquire this
50 * lock and release it before returning. If none of those
51 * functions are used, the lock MUST be acquired in order to
52 * iterate or/and do any actions on that list.
b5541356
DG
53 */
54 pthread_mutex_t lock;
99d688f2
JG
55 /*
56 * This condition variable is signaled on every removal from
57 * the session list.
58 */
59 pthread_cond_t removal_cond;
6c9cc2ab 60
b5541356 61 /*
a24f7994
MD
62 * Session unique ID generator. The session list lock MUST be
63 * upon update and read of this counter.
b5541356 64 */
d022620a 65 uint64_t next_uuid;
6c9cc2ab
DG
66
67 /* Linked list head */
5b74c7b1
DG
68 struct cds_list_head head;
69};
70
b5541356
DG
71/*
72 * This data structure contains information needed to identify a tracing
73 * session for both LTTng and UST.
5b74c7b1
DG
74 */
75struct ltt_session {
74babd95 76 char name[NAME_MAX];
b178f53e 77 bool has_auto_generated_name;
46ef2188 78 bool name_contains_creation_time;
73184835 79 char hostname[HOST_NAME_MAX]; /* Local hostname. */
ecd1a12f
MD
80 /* Path of the last closed chunk. */
81 char last_chunk_path[LTTNG_PATH_MAX];
b178f53e 82 time_t creation_time;
20fe2104 83 struct ltt_kernel_session *kernel_session;
f6a9efaa 84 struct ltt_ust_session *ust_session;
e32d7f27 85 struct urcu_ref ref;
b5541356
DG
86 /*
87 * Protect any read/write on this session data structure. This lock must be
88 * acquired *before* using any public functions declared below. Use
54d01ffb 89 * session_lock() and session_unlock() for that.
b5541356
DG
90 */
91 pthread_mutex_t lock;
92 struct cds_list_head list;
d022620a 93 uint64_t id; /* session unique identifier */
f4cc5e83
JG
94 /* Indicates if the session has been added to the session list and ht.*/
95 bool published;
e32d7f27
JG
96 /* Indicates if a destroy command has been applied to this session. */
97 bool destroyed;
6df2e2c9
MD
98 /* UID/GID of the user owning the session */
99 uid_t uid;
100 gid_t gid;
00e2e675
DG
101 /*
102 * Network session handle. A value of 0 means that there is no remote
103 * session established.
104 */
105 uint64_t net_handle;
106 /*
107 * This consumer is only set when the create_session_uri call is made.
108 * This contains the temporary information for a consumer output. Upon
109 * creation of the UST or kernel session, this consumer, if available, is
110 * copied into those sessions.
111 */
112 struct consumer_output *consumer;
b178f53e
JG
113 /*
114 * Indicates whether or not the user has specified an output directory
115 * or if it was configured using the default configuration.
116 */
117 bool has_user_specified_directory;
8382cf6f
DG
118 /* Did at least ONE start command has been triggered?. */
119 unsigned int has_been_started:1;
120 /*
121 * Is the session active? Start trace command sets this to 1 and the stop
122 * command reset it to 0.
123 */
124 unsigned int active:1;
6dc3064a
DG
125
126 /* Snapshot representation in a session. */
127 struct snapshot snapshot;
128 /* Indicate if the session has to output the traces or not. */
129 unsigned int output_traces;
27babd3a 130 /*
92fe5ca1
JG
131 * This session is in snapshot mode. This means that channels enabled
132 * will be set in overwrite mode by default and must be in mmap
133 * output mode. Note that snapshots can be taken on a session that
134 * is not in "snapshot_mode". This parameter only affects channel
135 * creation defaults.
27babd3a
DG
136 */
137 unsigned int snapshot_mode;
54213acc
JG
138 /*
139 * A session that has channels that don't use 'mmap' output can't be
140 * used to capture snapshots. This is set to true whenever a
141 * 'splice' kernel channel is enabled.
142 */
143 bool has_non_mmap_channel;
ecc48a90
JD
144 /*
145 * Timer set when the session is created for live reading.
146 */
d98ad589 147 unsigned int live_timer;
d7ba1388
MD
148 /*
149 * Path where to keep the shared memory files.
150 */
151 char shm_path[PATH_MAX];
23324029
JD
152 /*
153 * Node in ltt_sessions_ht_by_id.
154 */
155 struct lttng_ht_node_u64 node;
d88744a4 156 /*
92816cc3
JG
157 * Timer to check periodically if a relay and/or consumer has completed
158 * the last rotation.
d88744a4 159 */
92816cc3
JG
160 bool rotation_pending_check_timer_enabled;
161 timer_t rotation_pending_check_timer;
259c2674 162 /* Timer to periodically rotate a session. */
92816cc3
JG
163 bool rotation_schedule_timer_enabled;
164 timer_t rotation_schedule_timer;
66ea93b1 165 /* Value for periodic rotations, 0 if disabled. */
259c2674 166 uint64_t rotate_timer_period;
66ea93b1 167 /* Value for size-based rotations, 0 if disabled. */
259c2674 168 uint64_t rotate_size;
5c408ad8
JD
169 /*
170 * Keep a state if this session was rotated after the last stop command.
171 * We only allow one rotation after a stop. At destroy, we also need to
a9577b76 172 * know if a rotation occurred since the last stop to rename the current
5c408ad8
JD
173 * chunk.
174 */
175 bool rotated_after_last_stop;
90936dcf
JD
176 /*
177 * Condition and trigger for size-based rotations.
178 */
179 struct lttng_condition *rotate_condition;
180 struct lttng_trigger *rotate_trigger;
d2956687 181 LTTNG_OPTIONAL(uint64_t) most_recent_chunk_id;
82b69413 182 struct lttng_trace_chunk *current_trace_chunk;
d2956687
JG
183 struct lttng_trace_chunk *chunk_being_archived;
184 /* Current state of a rotation. */
185 enum lttng_rotation_state rotation_state;
7fdbed1c 186 bool quiet_rotation;
d2956687
JG
187 char *last_archived_chunk_name;
188 LTTNG_OPTIONAL(uint64_t) last_archived_chunk_id;
3e3665b8 189 struct lttng_dynamic_array destroy_notifiers;
6fa5fe7c
MD
190 /* Session base path override. Set non-null. */
191 char *base_path;
5b74c7b1
DG
192};
193
194/* Prototypes */
b178f53e 195enum lttng_error_code session_create(const char *name, uid_t uid, gid_t gid,
e3876bf0 196 struct ltt_session **out_session);
54d01ffb
DG
197void session_lock(struct ltt_session *session);
198void session_lock_list(void);
71e0a100 199int session_trylock_list(void);
54d01ffb
DG
200void session_unlock(struct ltt_session *session);
201void session_unlock_list(void);
6c9cc2ab 202
e32d7f27 203void session_destroy(struct ltt_session *session);
3e3665b8
JG
204int session_add_destroy_notifier(struct ltt_session *session,
205 ltt_session_destroy_notifier notifier, void *user_data);
e32d7f27
JG
206
207bool session_get(struct ltt_session *session);
208void session_put(struct ltt_session *session);
209
dd73d57b
JG
210enum consumer_dst_type session_get_consumer_destination_type(
211 const struct ltt_session *session);
212const char *session_get_net_consumer_hostname(
213 const struct ltt_session *session);
214void session_get_net_consumer_ports(
215 const struct ltt_session *session,
216 uint16_t *control_port, uint16_t *data_port);
5d65beab 217struct lttng_trace_archive_location *session_get_trace_archive_location(
3e3665b8 218 const struct ltt_session *session);
dd73d57b 219
58a1a227 220struct ltt_session *session_find_by_name(const char *name);
23324029 221struct ltt_session *session_find_by_id(uint64_t id);
99d688f2 222
54d01ffb 223struct ltt_session_list *session_get_list(void);
99d688f2 224void session_list_wait_empty(void);
5b74c7b1 225
2f77fc4b
DG
226int session_access_ok(struct ltt_session *session, uid_t uid, gid_t gid);
227
2961f09e
JG
228int session_reset_rotation_state(struct ltt_session *session,
229 enum lttng_rotation_state result);
230
d2956687
JG
231/* Create a new trace chunk object from the session's configuration. */
232struct lttng_trace_chunk *session_create_new_trace_chunk(
348a81dc
JG
233 const struct ltt_session *session,
234 const struct consumer_output *consumer_output_override,
82b69413
JG
235 const char *session_base_path_override,
236 const char *chunk_name_override);
d2956687
JG
237
238/*
239 * Set `new_trace_chunk` as the session's current trace chunk. A reference
240 * to `new_trace_chunk` is acquired by the session. The chunk is created
241 * on remote peers (consumer and relay daemons).
242 *
243 * A reference to the session's current trace chunk is returned through
244 * `current_session_trace_chunk` on success.
245 */
82b69413 246int session_set_trace_chunk(struct ltt_session *session,
d2956687
JG
247 struct lttng_trace_chunk *new_trace_chunk,
248 struct lttng_trace_chunk **current_session_trace_chunk);
249
250/*
251 * Close a chunk on the remote peers of a session. Has no effect on the
252 * ltt_session itself.
253 */
343defc2 254int session_close_trace_chunk(struct ltt_session *session,
bbc4768c 255 struct lttng_trace_chunk *trace_chunk,
343defc2 256 enum lttng_trace_chunk_command_type close_command,
ecd1a12f 257 char *path);
82b69413 258
e2b6b28e
JG
259bool session_output_supports_trace_chunks(const struct ltt_session *session);
260
5b74c7b1 261#endif /* _LTT_SESSION_H */
This page took 0.069448 seconds and 4 git commands to generate.