Consumer rotate a channel
[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>
20fe2104 22#include <urcu/list.h>
d4a2a84a 23
6dc3064a
DG
24#include <common/hashtable/hashtable.h>
25
26#include "snapshot.h"
00187dd4 27#include "trace-kernel.h"
7972aab2
DG
28
29struct ltt_ust_session;
00187dd4 30
b5541356
DG
31/*
32 * Tracing session list
33 *
34 * Statically declared in session.c and can be accessed by using
54d01ffb 35 * session_get_list() function that returns the pointer to the list.
b5541356 36 */
5b74c7b1 37struct ltt_session_list {
b5541356 38 /*
a24f7994
MD
39 * This lock protects any read/write access to the list and
40 * next_uuid. All public functions in session.c acquire this
41 * lock and release it before returning. If none of those
42 * functions are used, the lock MUST be acquired in order to
43 * iterate or/and do any actions on that list.
b5541356
DG
44 */
45 pthread_mutex_t lock;
6c9cc2ab 46
b5541356 47 /*
a24f7994
MD
48 * Session unique ID generator. The session list lock MUST be
49 * upon update and read of this counter.
b5541356 50 */
d022620a 51 uint64_t next_uuid;
6c9cc2ab
DG
52
53 /* Linked list head */
5b74c7b1
DG
54 struct cds_list_head head;
55};
56
b5541356
DG
57/*
58 * This data structure contains information needed to identify a tracing
59 * session for both LTTng and UST.
5b74c7b1
DG
60 */
61struct ltt_session {
74babd95 62 char name[NAME_MAX];
73184835 63 char hostname[HOST_NAME_MAX]; /* Local hostname. */
20fe2104 64 struct ltt_kernel_session *kernel_session;
f6a9efaa 65 struct ltt_ust_session *ust_session;
b5541356
DG
66 /*
67 * Protect any read/write on this session data structure. This lock must be
68 * acquired *before* using any public functions declared below. Use
54d01ffb 69 * session_lock() and session_unlock() for that.
b5541356
DG
70 */
71 pthread_mutex_t lock;
72 struct cds_list_head list;
d022620a 73 uint64_t id; /* session unique identifier */
6df2e2c9
MD
74 /* UID/GID of the user owning the session */
75 uid_t uid;
76 gid_t gid;
00e2e675
DG
77 /*
78 * Network session handle. A value of 0 means that there is no remote
79 * session established.
80 */
81 uint64_t net_handle;
82 /*
83 * This consumer is only set when the create_session_uri call is made.
84 * This contains the temporary information for a consumer output. Upon
85 * creation of the UST or kernel session, this consumer, if available, is
86 * copied into those sessions.
87 */
88 struct consumer_output *consumer;
a4b92340 89
8382cf6f
DG
90 /* Did at least ONE start command has been triggered?. */
91 unsigned int has_been_started:1;
92 /*
93 * Is the session active? Start trace command sets this to 1 and the stop
94 * command reset it to 0.
95 */
96 unsigned int active:1;
6dc3064a
DG
97
98 /* Snapshot representation in a session. */
99 struct snapshot snapshot;
100 /* Indicate if the session has to output the traces or not. */
101 unsigned int output_traces;
27babd3a
DG
102 /*
103 * This session is in snapshot mode. This means that every channel enabled
104 * will be set in overwrite mode and mmap. It is considered exclusively for
105 * snapshot purposes.
106 */
107 unsigned int snapshot_mode;
ecc48a90
JD
108 /*
109 * Timer set when the session is created for live reading.
110 */
d98ad589 111 unsigned int live_timer;
d7ba1388
MD
112 /*
113 * Path where to keep the shared memory files.
114 */
115 char shm_path[PATH_MAX];
23324029
JD
116 /*
117 * Node in ltt_sessions_ht_by_id.
118 */
119 struct lttng_ht_node_u64 node;
5b74c7b1
DG
120};
121
122/* Prototypes */
dec56f6c 123int session_create(char *name, uid_t uid, gid_t gid);
271933a4 124int session_destroy(struct ltt_session *session);
6c9cc2ab 125
54d01ffb
DG
126void session_lock(struct ltt_session *session);
127void session_lock_list(void);
128void session_unlock(struct ltt_session *session);
129void session_unlock_list(void);
6c9cc2ab 130
58a1a227 131struct ltt_session *session_find_by_name(const char *name);
23324029 132struct ltt_session *session_find_by_id(uint64_t id);
54d01ffb 133struct ltt_session_list *session_get_list(void);
5b74c7b1 134
2f77fc4b
DG
135int session_access_ok(struct ltt_session *session, uid_t uid, gid_t gid);
136
5b74c7b1 137#endif /* _LTT_SESSION_H */
This page took 0.086243 seconds and 4 git commands to generate.