Create all trace directories and files with client user credentials
[lttng-tools.git] / lttng-sessiond / trace-ust.h
1 /*
2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
3 *
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public License
6 * as published by the Free Software Foundation; only version 2
7 * of the License.
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
17 */
18
19 #ifndef _LTT_TRACE_UST_H
20 #define _LTT_TRACE_UST_H
21
22 #include <config.h>
23 #include <limits.h>
24 #include <urcu.h>
25 #include <urcu/list.h>
26 #include <lttng/lttng.h>
27
28 #include "ust-ctl.h"
29
30 #include "../hashtable/rculfhash.h"
31
32 /* UST Stream list */
33 struct ltt_ust_stream_list {
34 unsigned int count;
35 struct cds_list_head head;
36 };
37
38 /* Context hash table nodes */
39 struct ltt_ust_context {
40 struct lttng_ust_context ctx;
41 struct cds_lfht_node node;
42 };
43
44 /* UST event */
45 struct ltt_ust_event {
46 unsigned int enabled;
47 struct lttng_ust_event attr;
48 struct cds_lfht *ctx;
49 struct cds_lfht_node node;
50 };
51
52 /* UST stream */
53 struct ltt_ust_stream {
54 int handle;
55 char pathname[PATH_MAX];
56 struct lttng_ust_object_data *obj;
57 /* Using a list of streams to keep order. */
58 struct cds_list_head list;
59 };
60
61 /* UST channel */
62 struct ltt_ust_channel {
63 unsigned int enabled;
64 char name[LTTNG_UST_SYM_NAME_LEN];
65 char pathname[PATH_MAX];
66 struct lttng_ust_channel attr;
67 struct cds_lfht *ctx;
68 struct cds_lfht *events;
69 struct cds_lfht_node node;
70 };
71
72 /* UST Metadata */
73 struct ltt_ust_metadata {
74 int handle;
75 struct lttng_ust_object_data *obj;
76 char pathname[PATH_MAX]; /* Trace file path name */
77 struct lttng_ust_channel attr;
78 struct lttng_ust_object_data *stream_obj;
79 };
80
81 /* UST domain global (LTTNG_DOMAIN_UST) */
82 struct ltt_ust_domain_global {
83 struct cds_lfht *channels;
84 };
85
86 /* UST domain pid (LTTNG_DOMAIN_UST_PID) */
87 struct ltt_ust_domain_pid {
88 pid_t pid;
89 struct cds_lfht *channels;
90 struct cds_lfht_node node;
91 };
92
93 /* UST domain exec name (LTTNG_DOMAIN_UST_EXEC_NAME) */
94 struct ltt_ust_domain_exec {
95 char exec_name[LTTNG_UST_SYM_NAME_LEN];
96 struct cds_lfht *channels;
97 struct cds_lfht_node node;
98 };
99
100 /* UST session */
101 struct ltt_ust_session {
102 int id; /* Unique identifier of session */
103 int start_trace;
104 char pathname[PATH_MAX];
105 struct ltt_ust_domain_global domain_global;
106 /*
107 * Those two hash tables contains data for a specific UST domain and each
108 * contains a HT of channels. See ltt_ust_domain_exec and
109 * ltt_ust_domain_pid data structures.
110 */
111 struct cds_lfht *domain_pid;
112 struct cds_lfht *domain_exec;
113 /* UID/GID of the user owning the session */
114 uid_t uid;
115 gid_t gid;
116 };
117
118 #ifdef HAVE_LIBLTTNG_UST_CTL
119
120 /*
121 * Lookup functions. NULL is returned if not found.
122 */
123 struct ltt_ust_event *trace_ust_find_event_by_name(struct cds_lfht *ht,
124 char *name);
125 struct ltt_ust_channel *trace_ust_find_channel_by_name(struct cds_lfht *ht,
126 char *name);
127
128 /*
129 * Create functions malloc() the data structure.
130 */
131 struct ltt_ust_session *trace_ust_create_session(char *path, int session_id,
132 struct lttng_domain *domain);
133 struct ltt_ust_channel *trace_ust_create_channel(struct lttng_channel *attr,
134 char *path);
135 struct ltt_ust_event *trace_ust_create_event(struct lttng_event *ev);
136 struct ltt_ust_metadata *trace_ust_create_metadata(char *path);
137 struct ltt_ust_context *trace_ust_create_context(
138 struct lttng_event_context *ctx);
139
140 /*
141 * Destroy functions free() the data structure and remove from linked list if
142 * it's applies.
143 */
144 void trace_ust_destroy_session(struct ltt_ust_session *session);
145 void trace_ust_destroy_metadata(struct ltt_ust_metadata *metadata);
146 void trace_ust_destroy_channel(struct ltt_ust_channel *channel);
147 void trace_ust_destroy_event(struct ltt_ust_event *event);
148
149 #else /* HAVE_LIBLTTNG_UST_CTL */
150
151 static inline
152 struct ltt_ust_event *trace_ust_find_event_by_name(struct cds_lfht *ht,
153 char *name)
154 {
155 return NULL;
156 }
157
158 static inline
159 struct ltt_ust_channel *trace_ust_find_channel_by_name(struct cds_lfht *ht,
160 char *name)
161 {
162 return NULL;
163 }
164
165 static inline
166 struct ltt_ust_session *trace_ust_create_session(char *path, pid_t pid,
167 struct lttng_domain *domain)
168 {
169 return NULL;
170 }
171 static inline
172 struct ltt_ust_channel *trace_ust_create_channel(struct lttng_channel *attr,
173 char *path)
174 {
175 return NULL;
176 }
177 static inline
178 struct ltt_ust_event *trace_ust_create_event(struct lttng_event *ev)
179 {
180 return NULL;
181 }
182 static inline
183 struct ltt_ust_metadata *trace_ust_create_metadata(char *path)
184 {
185 return NULL;
186 }
187
188 static inline
189 void trace_ust_destroy_session(struct ltt_ust_session *session)
190 {
191 }
192
193 static inline
194 void trace_ust_destroy_metadata(struct ltt_ust_metadata *metadata)
195 {
196 }
197
198 static inline
199 void trace_ust_destroy_channel(struct ltt_ust_channel *channel)
200 {
201 }
202
203 static inline
204 void trace_ust_destroy_event(struct ltt_ust_event *event)
205 {
206 }
207 static inline
208 struct ltt_ust_context *trace_ust_create_context(
209 struct lttng_event_context *ctx)
210 {
211 return NULL;
212 }
213
214 #endif /* HAVE_LIBLTTNG_UST_CTL */
215
216 #endif /* _LTT_TRACE_UST_H */
This page took 0.047252 seconds and 4 git commands to generate.