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.
18 #ifndef _LTT_UST_APP_H
19 #define _LTT_UST_APP_H
23 #include "trace-ust.h"
25 /* lttng-ust supported version. */
26 #define LTTNG_UST_COMM_MAJOR 2 /* comm protocol major version */
27 #define UST_APP_MAJOR_VERSION 3 /* Internal UST version supported */
29 #define UST_APP_EVENT_LIST_SIZE 32
31 struct lttng_filter_bytecode
;
32 struct lttng_ust_filter_bytecode
;
34 extern int ust_consumerd64_fd
, ust_consumerd32_fd
;
36 struct ust_app_ht_key
{
38 const struct lttng_ust_filter_bytecode
*filter
;
39 enum lttng_ust_loglevel_type loglevel
;
43 * Application registration data structure.
45 struct ust_register_msg
{
52 uint32_t bits_per_long
;
57 * Global applications HT used by the session daemon. This table is indexed by
58 * PID using the pid_n node and pid value of an ust_app.
60 struct lttng_ht
*ust_app_ht
;
63 * Global applications HT used by the session daemon. This table is indexed by
64 * socket using the sock_n node and sock value of an ust_app.
66 struct lttng_ht
*ust_app_ht_by_sock
;
70 struct lttng_ust_context ctx
;
71 struct lttng_ust_object_data
*obj
;
72 struct lttng_ht_node_ulong node
;
75 struct ust_app_event
{
78 struct lttng_ust_object_data
*obj
;
79 struct lttng_ust_event attr
;
80 char name
[LTTNG_UST_SYM_NAME_LEN
];
81 struct lttng_ht_node_str node
;
82 struct lttng_ust_filter_bytecode
*filter
;
85 struct ust_app_channel
{
88 char name
[LTTNG_UST_SYM_NAME_LEN
];
89 struct lttng_ust_channel attr
;
90 struct lttng_ust_object_data
*obj
;
91 struct ltt_ust_stream_list streams
;
93 struct lttng_ht
*events
;
94 struct lttng_ht_node_str node
;
97 struct ust_app_session
{
99 /* started: has the session been in started state at any time ? */
100 int started
; /* allows detection of start vs restart. */
101 int handle
; /* used has unique identifier for app session */
102 int id
; /* session unique identifier */
103 struct ltt_ust_metadata
*metadata
;
104 struct lttng_ht
*channels
; /* Registered channels */
105 struct lttng_ht_node_ulong node
;
107 /* UID/GID of the user owning the session */
110 struct cds_list_head teardown_node
;
114 * Registered traceable applications. Libust registers to the session daemon
115 * and a linked list is kept of all running traceable app.
121 uid_t uid
; /* User ID that owns the apps */
122 gid_t gid
; /* Group ID that owns the apps */
124 int compatible
; /* If the lttng-ust tracer version does not match the
125 supported version of the session daemon, this flag is
126 set to 0 (NOT compatible) else 1. */
127 struct lttng_ust_tracer_version version
;
128 uint32_t v_major
; /* Verion major number */
129 uint32_t v_minor
; /* Verion minor number */
130 char name
[17]; /* Process name (short) */
131 struct lttng_ht
*sessions
;
132 struct lttng_ht_node_ulong pid_n
;
133 struct lttng_ht_node_ulong sock_n
;
135 * This is a list of ust app session that, once the app is going into
136 * teardown mode, in the RCU call, each node in this list is removed and
139 * Element of the list are added when an application unregisters after each
140 * ht_del of ust_app_session associated to this app. This list is NOT used
141 * when a session is destroyed.
143 struct cds_list_head teardown_head
;
146 #ifdef HAVE_LIBLTTNG_UST_CTL
148 int ust_app_register(struct ust_register_msg
*msg
, int sock
);
150 int ust_app_register_done(int sock
)
152 return ustctl_register_done(sock
);
154 void ust_app_unregister(int sock
);
155 unsigned long ust_app_list_count(void);
156 int ust_app_start_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
);
157 int ust_app_stop_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
);
158 int ust_app_start_trace_all(struct ltt_ust_session
*usess
);
159 int ust_app_stop_trace_all(struct ltt_ust_session
*usess
);
160 int ust_app_destroy_trace_all(struct ltt_ust_session
*usess
);
161 int ust_app_list_events(struct lttng_event
**events
);
162 int ust_app_list_event_fields(struct lttng_event_field
**fields
);
163 int ust_app_create_channel_glb(struct ltt_ust_session
*usess
,
164 struct ltt_ust_channel
*uchan
);
165 int ust_app_create_event_glb(struct ltt_ust_session
*usess
,
166 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
);
167 int ust_app_disable_event_pid(struct ltt_ust_session
*usess
,
168 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
,
170 int ust_app_enable_event_pid(struct ltt_ust_session
*usess
,
171 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
,
173 int ust_app_disable_channel_glb(struct ltt_ust_session
*usess
,
174 struct ltt_ust_channel
*uchan
);
175 int ust_app_enable_channel_glb(struct ltt_ust_session
*usess
,
176 struct ltt_ust_channel
*uchan
);
177 int ust_app_enable_event_glb(struct ltt_ust_session
*usess
,
178 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
);
179 int ust_app_disable_all_event_glb(struct ltt_ust_session
*usess
,
180 struct ltt_ust_channel
*uchan
);
181 int ust_app_enable_all_event_glb(struct ltt_ust_session
*usess
,
182 struct ltt_ust_channel
*uchan
);
183 int ust_app_disable_event_glb(struct ltt_ust_session
*usess
,
184 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
);
185 int ust_app_add_ctx_channel_glb(struct ltt_ust_session
*usess
,
186 struct ltt_ust_channel
*uchan
, struct ltt_ust_context
*uctx
);
187 void ust_app_global_update(struct ltt_ust_session
*usess
, int sock
);
189 void ust_app_clean_list(void);
190 void ust_app_ht_alloc(void);
191 struct lttng_ht
*ust_app_get_ht(void);
192 struct ust_app
*ust_app_find_by_pid(pid_t pid
);
193 int ust_app_validate_version(int sock
);
194 int ust_app_calibrate_glb(struct lttng_ust_calibrate
*calibrate
);
196 #else /* HAVE_LIBLTTNG_UST_CTL */
199 int ust_app_destroy_trace_all(struct ltt_ust_session
*usess
)
204 int ust_app_start_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
209 int ust_app_start_trace_all(struct ltt_ust_session
*usess
)
214 int ust_app_stop_trace_all(struct ltt_ust_session
*usess
)
219 int ust_app_list_events(struct lttng_event
**events
)
224 int ust_app_list_event_fields(struct lttng_event_field
**fields
)
229 int ust_app_register(struct ust_register_msg
*msg
, int sock
)
234 int ust_app_register_done(int sock
)
239 void ust_app_unregister(int sock
)
243 unsigned int ust_app_list_count(void)
248 void ust_app_lock_list(void)
252 void ust_app_unlock_list(void)
256 void ust_app_clean_list(void)
260 struct ust_app_list
*ust_app_get_list(void)
265 struct ust_app
*ust_app_get_by_pid(pid_t pid
)
270 struct lttng_ht
*ust_app_get_ht(void)
275 void ust_app_ht_alloc(void)
278 void ust_app_global_update(struct ltt_ust_session
*usess
, int sock
)
281 int ust_app_disable_channel_glb(struct ltt_ust_session
*usess
,
282 struct ltt_ust_channel
*uchan
)
287 int ust_app_enable_channel_glb(struct ltt_ust_session
*usess
,
288 struct ltt_ust_channel
*uchan
)
293 int ust_app_create_channel_glb(struct ltt_ust_session
*usess
,
294 struct ltt_ust_channel
*uchan
)
299 int ust_app_disable_all_event_glb(struct ltt_ust_session
*usess
,
300 struct ltt_ust_channel
*uchan
)
305 int ust_app_enable_all_event_glb(struct ltt_ust_session
*usess
,
306 struct ltt_ust_channel
*uchan
)
311 int ust_app_create_event_glb(struct ltt_ust_session
*usess
,
312 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
317 int ust_app_disable_event_glb(struct ltt_ust_session
*usess
,
318 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
323 int ust_app_enable_event_glb(struct ltt_ust_session
*usess
,
324 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
329 int ust_app_add_ctx_channel_glb(struct ltt_ust_session
*usess
,
330 struct ltt_ust_channel
*uchan
, struct ltt_ust_context
*uctx
)
335 int ust_app_enable_event_pid(struct ltt_ust_session
*usess
,
336 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
,
342 int ust_app_disable_event_pid(struct ltt_ust_session
*usess
,
343 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
,
349 int ust_app_validate_version(int sock
)
354 int ust_app_calibrate_glb(struct lttng_ust_calibrate
*calibrate
)
359 #endif /* HAVE_LIBLTTNG_UST_CTL */
361 #endif /* _LTT_UST_APP_H */