Commit | Line | Data |
---|---|---|
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> |
db66e574 | 26 | #include <lttng/rotation.h> |
5d65beab | 27 | #include <lttng/location.h> |
698fb2ed | 28 | #include <lttng/lttng-error.h> |
6dc3064a DG |
29 | |
30 | #include "snapshot.h" | |
00187dd4 | 31 | #include "trace-kernel.h" |
dd73d57b | 32 | #include "consumer.h" |
7972aab2 DG |
33 | |
34 | struct ltt_ust_session; | |
00187dd4 | 35 | |
b5541356 DG |
36 | /* |
37 | * Tracing session list | |
38 | * | |
39 | * Statically declared in session.c and can be accessed by using | |
54d01ffb | 40 | * session_get_list() function that returns the pointer to the list. |
b5541356 | 41 | */ |
5b74c7b1 | 42 | struct ltt_session_list { |
b5541356 | 43 | /* |
a24f7994 MD |
44 | * This lock protects any read/write access to the list and |
45 | * next_uuid. All public functions in session.c acquire this | |
46 | * lock and release it before returning. If none of those | |
47 | * functions are used, the lock MUST be acquired in order to | |
48 | * iterate or/and do any actions on that list. | |
b5541356 DG |
49 | */ |
50 | pthread_mutex_t lock; | |
6af972a2 JG |
51 | /* |
52 | * This condition variable is signaled on every removal from | |
53 | * the session list. | |
54 | */ | |
55 | pthread_cond_t removal_cond; | |
6c9cc2ab | 56 | |
b5541356 | 57 | /* |
a24f7994 MD |
58 | * Session unique ID generator. The session list lock MUST be |
59 | * upon update and read of this counter. | |
b5541356 | 60 | */ |
d022620a | 61 | uint64_t next_uuid; |
6c9cc2ab DG |
62 | |
63 | /* Linked list head */ | |
5b74c7b1 DG |
64 | struct cds_list_head head; |
65 | }; | |
66 | ||
b5541356 DG |
67 | /* |
68 | * This data structure contains information needed to identify a tracing | |
69 | * session for both LTTng and UST. | |
5b74c7b1 DG |
70 | */ |
71 | struct ltt_session { | |
74babd95 | 72 | char name[NAME_MAX]; |
5feee503 | 73 | bool has_auto_generated_name; |
73184835 | 74 | char hostname[HOST_NAME_MAX]; /* Local hostname. */ |
5feee503 | 75 | time_t creation_time; |
20fe2104 | 76 | struct ltt_kernel_session *kernel_session; |
f6a9efaa | 77 | struct ltt_ust_session *ust_session; |
48a86f68 | 78 | struct urcu_ref ref; |
b5541356 DG |
79 | /* |
80 | * Protect any read/write on this session data structure. This lock must be | |
81 | * acquired *before* using any public functions declared below. Use | |
54d01ffb | 82 | * session_lock() and session_unlock() for that. |
b5541356 DG |
83 | */ |
84 | pthread_mutex_t lock; | |
85 | struct cds_list_head list; | |
d022620a | 86 | uint64_t id; /* session unique identifier */ |
56ca63c0 JG |
87 | /* Indicates if the session has been added to the session list and ht.*/ |
88 | bool published; | |
48a86f68 JG |
89 | /* Indicates if a destroy command has been applied to this session. */ |
90 | bool destroyed; | |
6df2e2c9 MD |
91 | /* UID/GID of the user owning the session */ |
92 | uid_t uid; | |
93 | gid_t gid; | |
00e2e675 DG |
94 | /* |
95 | * Network session handle. A value of 0 means that there is no remote | |
96 | * session established. | |
97 | */ | |
98 | uint64_t net_handle; | |
99 | /* | |
100 | * This consumer is only set when the create_session_uri call is made. | |
101 | * This contains the temporary information for a consumer output. Upon | |
102 | * creation of the UST or kernel session, this consumer, if available, is | |
103 | * copied into those sessions. | |
104 | */ | |
105 | struct consumer_output *consumer; | |
5feee503 JG |
106 | /* |
107 | * Indicates whether or not the user has specified an output directory | |
108 | * or if it was configured using the default configuration. | |
109 | */ | |
110 | bool has_user_specified_directory; | |
8382cf6f DG |
111 | /* Did at least ONE start command has been triggered?. */ |
112 | unsigned int has_been_started:1; | |
113 | /* | |
114 | * Is the session active? Start trace command sets this to 1 and the stop | |
115 | * command reset it to 0. | |
116 | */ | |
117 | unsigned int active:1; | |
6dc3064a DG |
118 | |
119 | /* Snapshot representation in a session. */ | |
120 | struct snapshot snapshot; | |
121 | /* Indicate if the session has to output the traces or not. */ | |
122 | unsigned int output_traces; | |
27babd3a | 123 | /* |
5268a79b JG |
124 | * This session is in snapshot mode. This means that channels enabled |
125 | * will be set in overwrite mode by default and must be in mmap | |
126 | * output mode. Note that snapshots can be taken on a session that | |
127 | * is not in "snapshot_mode". This parameter only affects channel | |
128 | * creation defaults. | |
27babd3a DG |
129 | */ |
130 | unsigned int snapshot_mode; | |
8954c04a JG |
131 | /* |
132 | * A session that has channels that don't use 'mmap' output can't be | |
133 | * used to capture snapshots. This is set to true whenever a | |
134 | * 'splice' kernel channel is enabled. | |
135 | */ | |
136 | bool has_non_mmap_channel; | |
ecc48a90 JD |
137 | /* |
138 | * Timer set when the session is created for live reading. | |
139 | */ | |
d98ad589 | 140 | unsigned int live_timer; |
d7ba1388 MD |
141 | /* |
142 | * Path where to keep the shared memory files. | |
143 | */ | |
144 | char shm_path[PATH_MAX]; | |
23324029 JD |
145 | /* |
146 | * Node in ltt_sessions_ht_by_id. | |
147 | */ | |
148 | struct lttng_ht_node_u64 node; | |
d88744a4 | 149 | /* |
82528808 JG |
150 | * Timer to check periodically if a relay and/or consumer has completed |
151 | * the last rotation. | |
d88744a4 | 152 | */ |
82528808 JG |
153 | bool rotation_pending_check_timer_enabled; |
154 | timer_t rotation_pending_check_timer; | |
259c2674 | 155 | /* Timer to periodically rotate a session. */ |
82528808 JG |
156 | bool rotation_schedule_timer_enabled; |
157 | timer_t rotation_schedule_timer; | |
66ea93b1 | 158 | /* Value for periodic rotations, 0 if disabled. */ |
259c2674 | 159 | uint64_t rotate_timer_period; |
66ea93b1 | 160 | /* Value for size-based rotations, 0 if disabled. */ |
259c2674 | 161 | uint64_t rotate_size; |
5c408ad8 JD |
162 | /* |
163 | * Keep a state if this session was rotated after the last stop command. | |
164 | * We only allow one rotation after a stop. At destroy, we also need to | |
e6a80fab | 165 | * know if a rotation occurred since the last stop to rename the current |
5c408ad8 JD |
166 | * chunk. |
167 | */ | |
168 | bool rotated_after_last_stop; | |
90936dcf JD |
169 | /* |
170 | * Condition and trigger for size-based rotations. | |
171 | */ | |
172 | struct lttng_condition *rotate_condition; | |
173 | struct lttng_trigger *rotate_trigger; | |
e5148e25 | 174 | LTTNG_OPTIONAL(uint64_t) most_recent_chunk_id; |
698fb2ed | 175 | struct lttng_trace_chunk *current_trace_chunk; |
e5148e25 JG |
176 | struct lttng_trace_chunk *chunk_being_archived; |
177 | /* Current state of a rotation. */ | |
178 | enum lttng_rotation_state rotation_state; | |
179 | char *last_archived_chunk_name; | |
180 | LTTNG_OPTIONAL(uint64_t) last_archived_chunk_id; | |
5b74c7b1 DG |
181 | }; |
182 | ||
183 | /* Prototypes */ | |
5feee503 JG |
184 | enum lttng_error_code session_create(const char *name, uid_t uid, gid_t gid, |
185 | struct ltt_session **out_session); | |
54d01ffb DG |
186 | void session_lock(struct ltt_session *session); |
187 | void session_lock_list(void); | |
71e0a100 | 188 | int session_trylock_list(void); |
54d01ffb DG |
189 | void session_unlock(struct ltt_session *session); |
190 | void session_unlock_list(void); | |
6c9cc2ab | 191 | |
48a86f68 JG |
192 | void session_destroy(struct ltt_session *session); |
193 | ||
194 | bool session_get(struct ltt_session *session); | |
195 | void session_put(struct ltt_session *session); | |
196 | ||
dd73d57b JG |
197 | enum consumer_dst_type session_get_consumer_destination_type( |
198 | const struct ltt_session *session); | |
199 | const char *session_get_net_consumer_hostname( | |
200 | const struct ltt_session *session); | |
201 | void session_get_net_consumer_ports( | |
202 | const struct ltt_session *session, | |
203 | uint16_t *control_port, uint16_t *data_port); | |
5d65beab JG |
204 | struct lttng_trace_archive_location *session_get_trace_archive_location( |
205 | struct ltt_session *session); | |
dd73d57b | 206 | |
58a1a227 | 207 | struct ltt_session *session_find_by_name(const char *name); |
23324029 | 208 | struct ltt_session *session_find_by_id(uint64_t id); |
6af972a2 | 209 | |
54d01ffb | 210 | struct ltt_session_list *session_get_list(void); |
6af972a2 | 211 | void session_list_wait_empty(void); |
5b74c7b1 | 212 | |
2f77fc4b DG |
213 | int session_access_ok(struct ltt_session *session, uid_t uid, gid_t gid); |
214 | ||
d70d3b5f JG |
215 | int session_reset_rotation_state(struct ltt_session *session, |
216 | enum lttng_rotation_state result); | |
217 | ||
e5148e25 JG |
218 | /* Create a new trace chunk object from the session's configuration. */ |
219 | struct lttng_trace_chunk *session_create_new_trace_chunk( | |
220 | struct ltt_session *session, | |
698fb2ed JG |
221 | const char *session_base_path_override, |
222 | const char *chunk_name_override); | |
e5148e25 JG |
223 | |
224 | /* | |
225 | * Set `new_trace_chunk` as the session's current trace chunk. A reference | |
226 | * to `new_trace_chunk` is acquired by the session. The chunk is created | |
227 | * on remote peers (consumer and relay daemons). | |
228 | * | |
229 | * A reference to the session's current trace chunk is returned through | |
230 | * `current_session_trace_chunk` on success. | |
231 | */ | |
698fb2ed | 232 | int session_set_trace_chunk(struct ltt_session *session, |
e5148e25 JG |
233 | struct lttng_trace_chunk *new_trace_chunk, |
234 | struct lttng_trace_chunk **current_session_trace_chunk); | |
235 | ||
236 | /* | |
237 | * Close a chunk on the remote peers of a session. Has no effect on the | |
238 | * ltt_session itself. | |
239 | */ | |
240 | int session_close_trace_chunk(const struct ltt_session *session, | |
241 | struct lttng_trace_chunk *trace_chunk); | |
698fb2ed | 242 | |
5b74c7b1 | 243 | #endif /* _LTT_SESSION_H */ |