Rotate command
[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>
db66e574 26#include <lttng/rotation.h>
6dc3064a
DG
27
28#include "snapshot.h"
00187dd4 29#include "trace-kernel.h"
7972aab2
DG
30
31struct ltt_ust_session;
00187dd4 32
b5541356
DG
33/*
34 * Tracing session list
35 *
36 * Statically declared in session.c and can be accessed by using
54d01ffb 37 * session_get_list() function that returns the pointer to the list.
b5541356 38 */
5b74c7b1 39struct ltt_session_list {
b5541356 40 /*
a24f7994
MD
41 * This lock protects any read/write access to the list and
42 * next_uuid. All public functions in session.c acquire this
43 * lock and release it before returning. If none of those
44 * functions are used, the lock MUST be acquired in order to
45 * iterate or/and do any actions on that list.
b5541356
DG
46 */
47 pthread_mutex_t lock;
6c9cc2ab 48
b5541356 49 /*
a24f7994
MD
50 * Session unique ID generator. The session list lock MUST be
51 * upon update and read of this counter.
b5541356 52 */
d022620a 53 uint64_t next_uuid;
6c9cc2ab
DG
54
55 /* Linked list head */
5b74c7b1
DG
56 struct cds_list_head head;
57};
58
b5541356
DG
59/*
60 * This data structure contains information needed to identify a tracing
61 * session for both LTTng and UST.
5b74c7b1
DG
62 */
63struct ltt_session {
74babd95 64 char name[NAME_MAX];
73184835 65 char hostname[HOST_NAME_MAX]; /* Local hostname. */
20fe2104 66 struct ltt_kernel_session *kernel_session;
f6a9efaa 67 struct ltt_ust_session *ust_session;
b5541356
DG
68 /*
69 * Protect any read/write on this session data structure. This lock must be
70 * acquired *before* using any public functions declared below. Use
54d01ffb 71 * session_lock() and session_unlock() for that.
b5541356
DG
72 */
73 pthread_mutex_t lock;
74 struct cds_list_head list;
d022620a 75 uint64_t id; /* session unique identifier */
6df2e2c9
MD
76 /* UID/GID of the user owning the session */
77 uid_t uid;
78 gid_t gid;
00e2e675
DG
79 /*
80 * Network session handle. A value of 0 means that there is no remote
81 * session established.
82 */
83 uint64_t net_handle;
84 /*
85 * This consumer is only set when the create_session_uri call is made.
86 * This contains the temporary information for a consumer output. Upon
87 * creation of the UST or kernel session, this consumer, if available, is
88 * copied into those sessions.
89 */
90 struct consumer_output *consumer;
a4b92340 91
8382cf6f
DG
92 /* Did at least ONE start command has been triggered?. */
93 unsigned int has_been_started:1;
94 /*
95 * Is the session active? Start trace command sets this to 1 and the stop
96 * command reset it to 0.
97 */
98 unsigned int active:1;
6dc3064a
DG
99
100 /* Snapshot representation in a session. */
101 struct snapshot snapshot;
102 /* Indicate if the session has to output the traces or not. */
103 unsigned int output_traces;
27babd3a
DG
104 /*
105 * This session is in snapshot mode. This means that every channel enabled
106 * will be set in overwrite mode and mmap. It is considered exclusively for
107 * snapshot purposes.
108 */
109 unsigned int snapshot_mode;
ecc48a90
JD
110 /*
111 * Timer set when the session is created for live reading.
112 */
d98ad589 113 unsigned int live_timer;
d7ba1388
MD
114 /*
115 * Path where to keep the shared memory files.
116 */
117 char shm_path[PATH_MAX];
23324029
JD
118 /*
119 * Node in ltt_sessions_ht_by_id.
120 */
121 struct lttng_ht_node_u64 node;
db66e574
JD
122 /* Number of session rotation for this session. */
123 uint64_t rotate_count;
124 /*
125 * Rotation is pending between the time it starts until the consumer has
126 * finished extracting the data. If the session uses a relay, data related
127 * to a rotation can still be in flight after that, see
128 * rotate_pending_relay.
129 */
130 bool rotate_pending;
5c408ad8
JD
131 /*
132 * True until the relay has finished the rotation of all the streams.
133 */
134 bool rotate_pending_relay;
db66e574
JD
135 /* Current status of a rotation. */
136 enum lttng_rotation_status rotation_status;
137 /*
138 * Number of channels waiting for a rotation.
139 * When this number reaches 0, we can handle the rename of the chunk
140 * folder and inform the client that the rotate is finished.
141 */
142 unsigned int nr_chan_rotate_pending;
143 struct {
144 /*
145 * When the rotation is in progress, the temporary path name is
146 * stored here. When the rotation is complete, the final path name
147 * is here and can be queried with the rotate_pending call.
148 */
149 char current_rotate_path[LTTNG_PATH_MAX];
150 /*
151 * The path where the consumer is currently writing after the first
152 * session rotation.
153 */
154 char active_tracing_path[LTTNG_PATH_MAX];
155 } rotation_chunk;
156 /*
157 * The timestamp of the beginning of the previous chunk. For the
158 * first chunk, this is the "lttng start" timestamp. For the
159 * subsequent ones, this copies the current_chunk_start_ts value when
160 * a new rotation starts. This value is used to set the name of a
161 * complete chunk directory, ex: "last_chunk_start_ts-now()".
162 */
163 time_t last_chunk_start_ts;
164 /*
165 * This is the timestamp when a new chunk starts. When a new rotation
166 * starts, we copy this value to last_chunk_start_ts and replace it
167 * with the current timestamp.
168 */
169 time_t current_chunk_start_ts;
5c408ad8
JD
170 /*
171 * Keep a state if this session was rotated after the last stop command.
172 * We only allow one rotation after a stop. At destroy, we also need to
173 * know if a rotation occured since the last stop to rename the current
174 * chunk.
175 */
176 bool rotated_after_last_stop;
5b74c7b1
DG
177};
178
179/* Prototypes */
dec56f6c 180int session_create(char *name, uid_t uid, gid_t gid);
271933a4 181int session_destroy(struct ltt_session *session);
6c9cc2ab 182
54d01ffb
DG
183void session_lock(struct ltt_session *session);
184void session_lock_list(void);
185void session_unlock(struct ltt_session *session);
186void session_unlock_list(void);
6c9cc2ab 187
58a1a227 188struct ltt_session *session_find_by_name(const char *name);
23324029 189struct ltt_session *session_find_by_id(uint64_t id);
54d01ffb 190struct ltt_session_list *session_get_list(void);
5b74c7b1 191
2f77fc4b
DG
192int session_access_ok(struct ltt_session *session, uid_t uid, gid_t gid);
193
5b74c7b1 194#endif /* _LTT_SESSION_H */
This page took 0.089907 seconds and 4 git commands to generate.