2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
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.
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.
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.
27 #include <common/common.h>
28 #include <common/sessiond-comm/sessiond-comm.h>
35 * No ltt_session.lock is taken here because those data structure are widely
36 * spread across the lttng-tools code base so before caling functions below
37 * that can read/write a session, the caller MUST acquire the session lock
38 * using session_lock() and session_unlock().
42 * Init tracing session list.
44 * Please see session.h for more explanation and correct usage of the list.
46 static struct ltt_session_list ltt_session_list
= {
47 .head
= CDS_LIST_HEAD_INIT(ltt_session_list
.head
),
48 .lock
= PTHREAD_MUTEX_INITIALIZER
,
52 /* These characters are forbidden in a session name. Used by validate_name. */
53 static const char *forbidden_name_chars
= "/";
56 * Validate the session name for forbidden characters.
58 * Return 0 on success else -1 meaning a forbidden char. has been found.
60 static int validate_name(const char *name
)
67 tmp_name
= strdup(name
);
74 tok
= strpbrk(tmp_name
, forbidden_name_chars
);
76 DBG("Session name %s contains a forbidden character", name
);
77 /* Forbidden character has been found. */
89 * Add a ltt_session structure to the global list.
91 * The caller MUST acquire the session list lock before.
92 * Returns the unique identifier for the session.
94 static uint64_t add_session_list(struct ltt_session
*ls
)
98 cds_list_add(&ls
->list
, <t_session_list
.head
);
99 return ltt_session_list
.next_uuid
++;
103 * Delete a ltt_session structure to the global list.
105 * The caller MUST acquire the session list lock before.
107 static void del_session_list(struct ltt_session
*ls
)
111 cds_list_del(&ls
->list
);
115 * Return a pointer to the session list.
117 struct ltt_session_list
*session_get_list(void)
119 return <t_session_list
;
123 * Acquire session list lock
125 void session_lock_list(void)
127 pthread_mutex_lock(<t_session_list
.lock
);
131 * Release session list lock
133 void session_unlock_list(void)
135 pthread_mutex_unlock(<t_session_list
.lock
);
139 * Acquire session lock
141 void session_lock(struct ltt_session
*session
)
145 pthread_mutex_lock(&session
->lock
);
149 * Release session lock
151 void session_unlock(struct ltt_session
*session
)
155 pthread_mutex_unlock(&session
->lock
);
159 * Return a ltt_session structure ptr that matches name. If no session found,
160 * NULL is returned. This must be called with the session lock held using
161 * session_lock_list and session_unlock_list.
163 struct ltt_session
*session_find_by_name(const char *name
)
165 struct ltt_session
*iter
;
169 DBG2("Trying to find session by name %s", name
);
171 cds_list_for_each_entry(iter
, <t_session_list
.head
, list
) {
172 if (strncmp(iter
->name
, name
, NAME_MAX
) == 0) {
184 * Delete session from the session list and free the memory.
186 * Return -1 if no session is found. On success, return 1;
187 * Should *NOT* be called with RCU read-side lock held.
189 int session_destroy(struct ltt_session
*session
)
194 DBG("Destroying session %s", session
->name
);
195 del_session_list(session
);
196 pthread_mutex_destroy(&session
->lock
);
198 consumer_destroy_output(session
->consumer
);
199 snapshot_destroy(&session
->snapshot
);
206 * Create a brand new session and add it to the session list.
208 int session_create(char *name
, uid_t uid
, gid_t gid
)
211 struct ltt_session
*new_session
;
213 /* Allocate session data structure */
214 new_session
= zmalloc(sizeof(struct ltt_session
));
215 if (new_session
== NULL
) {
217 ret
= LTTNG_ERR_FATAL
;
221 /* Define session name */
223 if (snprintf(new_session
->name
, NAME_MAX
, "%s", name
) < 0) {
224 ret
= LTTNG_ERR_FATAL
;
228 ERR("No session name given");
229 ret
= LTTNG_ERR_FATAL
;
233 ret
= validate_name(name
);
235 ret
= LTTNG_ERR_SESSION_INVALID_CHAR
;
239 ret
= gethostname(new_session
->hostname
, sizeof(new_session
->hostname
));
241 if (errno
== ENAMETOOLONG
) {
242 new_session
->hostname
[sizeof(new_session
->hostname
) - 1] = '\0';
244 ret
= LTTNG_ERR_FATAL
;
249 /* Init kernel session */
250 new_session
->kernel_session
= NULL
;
251 new_session
->ust_session
= NULL
;
254 pthread_mutex_init(&new_session
->lock
, NULL
);
256 new_session
->uid
= uid
;
257 new_session
->gid
= gid
;
259 ret
= snapshot_init(&new_session
->snapshot
);
261 ret
= LTTNG_ERR_NOMEM
;
265 /* Add new session to the session list */
267 new_session
->id
= add_session_list(new_session
);
268 session_unlock_list();
271 * Consumer is let to NULL since the create_session_uri command will set it
272 * up and, if valid, assign it to the session.
275 DBG("Tracing session %s created with ID %" PRIu64
" by UID %d GID %d",
276 name
, new_session
->id
, new_session
->uid
, new_session
->gid
);
289 * Check if the UID or GID match the session. Root user has access to all
292 int session_access_ok(struct ltt_session
*session
, uid_t uid
, gid_t gid
)
296 if (uid
!= session
->uid
&& gid
!= session
->gid
&& uid
!= 0) {