Rename ust app function for better semantic
[lttng-tools.git] / lttng-sessiond / ust-app.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_UST_APP_H
20 #define _LTT_UST_APP_H
21
22 #include <stdint.h>
23 #include <urcu/list.h>
24
25 #include "trace-ust.h"
26
27 #define UST_APP_EVENT_LIST_SIZE 32
28
29 extern int ust_consumerd64_fd, ust_consumerd32_fd;
30
31 /*
32 * Application registration data structure.
33 */
34 struct ust_register_msg {
35 uint32_t major;
36 uint32_t minor;
37 pid_t pid;
38 pid_t ppid;
39 uid_t uid;
40 gid_t gid;
41 uint32_t bits_per_long;
42 char name[16];
43 };
44
45 /*
46 * Global applications HT used by the session daemon.
47 */
48 struct cds_lfht *ust_app_ht;
49
50 struct cds_lfht *ust_app_sock_key_map;
51
52 struct ust_app_key {
53 pid_t pid;
54 int sock;
55 struct cds_lfht_node node;
56 };
57
58 struct ust_app_event {
59 int enabled;
60 int handle;
61 struct lttng_ust_object_data *obj;
62 struct lttng_ust_event attr;
63 char name[LTTNG_UST_SYM_NAME_LEN];
64 struct cds_lfht *ctx;
65 struct cds_lfht_node node;
66 };
67
68 struct ust_app_channel {
69 int enabled;
70 int handle;
71 char name[LTTNG_UST_SYM_NAME_LEN];
72 struct lttng_ust_channel attr;
73 struct lttng_ust_object_data *obj;
74 struct ltt_ust_stream_list streams;
75 struct cds_lfht *ctx;
76 struct cds_lfht *events;
77 struct cds_lfht_node node;
78 };
79
80 struct ust_app_session {
81 int enabled;
82 /* started: has the session been in started state at any time ? */
83 int started; /* allows detection of start vs restart. */
84 int handle; /* Used has unique identifier */
85 unsigned int uid;
86 struct ltt_ust_metadata *metadata;
87 struct cds_lfht *channels; /* Registered channels */
88 struct cds_lfht_node node;
89 char path[PATH_MAX];
90 };
91
92 /*
93 * Registered traceable applications. Libust registers to the session daemon
94 * and a linked list is kept of all running traceable app.
95 */
96 struct ust_app {
97 pid_t ppid;
98 uid_t uid; /* User ID that owns the apps */
99 gid_t gid; /* Group ID that owns the apps */
100 int bits_per_long;
101 uint32_t v_major; /* Verion major number */
102 uint32_t v_minor; /* Verion minor number */
103 char name[17]; /* Process name (short) */
104 struct cds_lfht *sessions;
105 struct cds_lfht_node node;
106 struct ust_app_key key;
107 };
108
109 #ifdef HAVE_LIBLTTNG_UST_CTL
110
111 int ust_app_register(struct ust_register_msg *msg, int sock);
112 void ust_app_unregister(int sock);
113 unsigned long ust_app_list_count(void);
114 int ust_app_start_trace(struct ltt_ust_session *usess, struct ust_app *app);
115 int ust_app_stop_trace(struct ltt_ust_session *usess, struct ust_app *app);
116 int ust_app_start_trace_all(struct ltt_ust_session *usess);
117 int ust_app_stop_trace_all(struct ltt_ust_session *usess);
118 int ust_app_destroy_trace(struct ltt_ust_session *usess, struct ust_app *app);
119 int ust_app_destroy_trace_all(struct ltt_ust_session *usess);
120 int ust_app_list_events(struct lttng_event **events);
121 int ust_app_create_channel_glb(struct ltt_ust_session *usess,
122 struct ltt_ust_channel *uchan);
123 int ust_app_create_event_glb(struct ltt_ust_session *usess,
124 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
125 int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
126 struct ltt_ust_channel *uchan);
127 int ust_app_enable_channel_glb(struct ltt_ust_session *usess,
128 struct ltt_ust_channel *uchan);
129 int ust_app_enable_event_glb(struct ltt_ust_session *usess,
130 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
131 int ust_app_disable_all_event_glb(struct ltt_ust_session *usess,
132 struct ltt_ust_channel *uchan);
133 int ust_app_enable_all_event_glb(struct ltt_ust_session *usess,
134 struct ltt_ust_channel *uchan);
135 int ust_app_disable_event_glb(struct ltt_ust_session *usess,
136 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
137 void ust_app_global_update(struct ltt_ust_session *usess, int sock);
138
139 void ust_app_clean_list(void);
140 void ust_app_ht_alloc(void);
141 struct cds_lfht *ust_app_get_ht(void);
142 struct ust_app *ust_app_find_by_pid(pid_t pid);
143
144 #else /* HAVE_LIBLTTNG_UST_CTL */
145
146 static inline
147 int ust_app_destroy_trace_all(struct ltt_ust_session *usess)
148 {
149 return 0;
150 }
151 static inline
152 int ust_app_start_trace(struct ltt_ust_session *usess, struct ust_app *app)
153 {
154 return 0;
155 }
156 static inline
157 int ust_app_start_trace_all(struct ltt_ust_session *usess)
158 {
159 return 0;
160 }
161 static inline
162 int ust_app_stop_trace_all(struct ltt_ust_session *usess)
163 {
164 return 0;
165 }
166 static inline
167 int ust_app_list_events(struct lttng_event **events)
168 {
169 return 0;
170 }
171 static inline
172 int ust_app_register(struct ust_register_msg *msg, int sock)
173 {
174 return -ENOSYS;
175 }
176 static inline
177 void ust_app_unregister(int sock)
178 {
179 }
180 static inline
181 unsigned int ust_app_list_count(void)
182 {
183 return 0;
184 }
185 static inline
186 void ust_app_lock_list(void)
187 {
188 }
189 static inline
190 void ust_app_unlock_list(void)
191 {
192 }
193 static inline
194 void ust_app_clean_list(void)
195 {
196 }
197 static inline
198 struct ust_app_list *ust_app_get_list(void)
199 {
200 return NULL;
201 }
202 static inline
203 struct ust_app *ust_app_get_by_pid(pid_t pid)
204 {
205 return NULL;
206 }
207 static inline
208 struct cds_lfht *ust_app_get_ht(void)
209 {
210 return NULL;
211 }
212 static inline
213 void ust_app_ht_alloc(void)
214 {}
215 static inline
216 void ust_app_global_update(struct ltt_ust_session *usess, int sock)
217 {}
218 static inline
219 int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
220 struct ltt_ust_channel *uchan)
221 {
222 return 0;
223 }
224 static inline
225 int ust_app_enable_channel_glb(struct ltt_ust_session *usess,
226 struct ltt_ust_channel *uchan)
227 {
228 return 0;
229 }
230 static inline
231 int ust_app_create_channel_glb(struct ltt_ust_session *usess,
232 struct ltt_ust_channel *uchan)
233 {
234 return 0;
235 }
236 static inline
237 int ust_app_disable_all_event_glb(struct ltt_ust_session *usess,
238 struct ltt_ust_channel *uchan)
239 {
240 return 0;
241 }
242 static inline
243 int ust_app_enable_all_event_glb(struct ltt_ust_session *usess,
244 struct ltt_ust_channel *uchan)
245 {
246 return 0;
247 }
248 static inline
249 int ust_app_create_event_glb(struct ltt_ust_session *usess,
250 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
251 {
252 return 0;
253 }
254 static inline
255 int ust_app_disable_event_glb(struct ltt_ust_session *usess,
256 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
257 {
258 return 0;
259 }
260 static inline
261 int ust_app_enable_event_glb(struct ltt_ust_session *usess,
262 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
263 {
264 return 0;
265 }
266
267 #endif /* HAVE_LIBLTTNG_UST_CTL */
268
269 #endif /* _LTT_UST_APP_H */
This page took 0.038161 seconds and 6 git commands to generate.