Add snapshot command to lttng UI
[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
20fe2104 21#include <urcu/list.h>
d4a2a84a 22
00187dd4 23#include "trace-kernel.h"
7972aab2
DG
24
25struct ltt_ust_session;
00187dd4 26
b5541356
DG
27/*
28 * Tracing session list
29 *
30 * Statically declared in session.c and can be accessed by using
54d01ffb 31 * session_get_list() function that returns the pointer to the list.
b5541356 32 */
5b74c7b1 33struct ltt_session_list {
b5541356 34 /*
a24f7994
MD
35 * This lock protects any read/write access to the list and
36 * next_uuid. All public functions in session.c acquire this
37 * lock and release it before returning. If none of those
38 * functions are used, the lock MUST be acquired in order to
39 * iterate or/and do any actions on that list.
b5541356
DG
40 */
41 pthread_mutex_t lock;
6c9cc2ab 42
b5541356 43 /*
a24f7994
MD
44 * Session unique ID generator. The session list lock MUST be
45 * upon update and read of this counter.
b5541356 46 */
a24f7994 47 unsigned int next_uuid;
6c9cc2ab
DG
48
49 /* Linked list head */
5b74c7b1
DG
50 struct cds_list_head head;
51};
52
b5541356
DG
53/*
54 * This data structure contains information needed to identify a tracing
55 * session for both LTTng and UST.
5b74c7b1
DG
56 */
57struct ltt_session {
74babd95 58 char name[NAME_MAX];
20fe2104 59 struct ltt_kernel_session *kernel_session;
f6a9efaa 60 struct ltt_ust_session *ust_session;
b5541356
DG
61 /*
62 * Protect any read/write on this session data structure. This lock must be
63 * acquired *before* using any public functions declared below. Use
54d01ffb 64 * session_lock() and session_unlock() for that.
b5541356
DG
65 */
66 pthread_mutex_t lock;
67 struct cds_list_head list;
464dd62d 68 int enabled; /* enabled/started flag */
fc4705fe 69 unsigned int id; /* session unique identifier */
6df2e2c9
MD
70 /* UID/GID of the user owning the session */
71 uid_t uid;
72 gid_t gid;
00e2e675
DG
73 /*
74 * Network session handle. A value of 0 means that there is no remote
75 * session established.
76 */
77 uint64_t net_handle;
78 /*
79 * This consumer is only set when the create_session_uri call is made.
80 * This contains the temporary information for a consumer output. Upon
81 * creation of the UST or kernel session, this consumer, if available, is
82 * copied into those sessions.
83 */
84 struct consumer_output *consumer;
a4b92340 85
9b6c7ec5
DG
86 /* Did a start command occured before the kern/ust session creation? */
87 unsigned int started;
5b74c7b1
DG
88};
89
90/* Prototypes */
dec56f6c 91int session_create(char *name, uid_t uid, gid_t gid);
271933a4 92int session_destroy(struct ltt_session *session);
6c9cc2ab 93
54d01ffb
DG
94void session_lock(struct ltt_session *session);
95void session_lock_list(void);
96void session_unlock(struct ltt_session *session);
97void session_unlock_list(void);
6c9cc2ab 98
54d01ffb
DG
99struct ltt_session *session_find_by_name(char *name);
100struct ltt_session_list *session_get_list(void);
5b74c7b1 101
2f77fc4b
DG
102int session_access_ok(struct ltt_session *session, uid_t uid, gid_t gid);
103
5b74c7b1 104#endif /* _LTT_SESSION_H */
This page took 0.05473 seconds and 4 git commands to generate.