Add -j/--jul to lttng UI and ABI
[lttng-tools.git] / src / bin / lttng-sessiond / trace-ust.h
CommitLineData
97ee3a89
DG
1/*
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.
97ee3a89
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.
97ee3a89
DG
16 */
17
18#ifndef _LTT_TRACE_UST_H
19#define _LTT_TRACE_UST_H
20
3bd1e081 21#include <config.h>
97ee3a89
DG
22#include <limits.h>
23#include <urcu/list.h>
bec39940 24
97ee3a89 25#include <lttng/lttng.h>
10a8a223 26#include <common/hashtable/hashtable.h>
ce2a9e76 27#include <common/defaults.h>
3bd1e081 28
00e2e675 29#include "consumer.h"
48842b30 30#include "ust-ctl.h"
97ee3a89 31
18eace3b
DG
32struct ltt_ust_ht_key {
33 const char *name;
34 const struct lttng_filter_bytecode *filter;
35 enum lttng_ust_loglevel_type loglevel;
36};
37
f6a9efaa
DG
38/* Context hash table nodes */
39struct ltt_ust_context {
40 struct lttng_ust_context ctx;
bec39940 41 struct lttng_ht_node_ulong node;
31746f93 42 struct cds_list_head list;
97ee3a89
DG
43};
44
45/* UST event */
46struct ltt_ust_event {
37357452 47 unsigned int enabled;
f6a9efaa 48 struct lttng_ust_event attr;
bec39940 49 struct lttng_ht_node_str node;
53a80697 50 struct lttng_ust_filter_bytecode *filter;
2bdd86d4
MD
51};
52
97ee3a89
DG
53/* UST channel */
54struct ltt_ust_channel {
7972aab2 55 uint64_t id; /* unique id per session. */
37357452 56 unsigned int enabled;
44d3bd01 57 char name[LTTNG_UST_SYM_NAME_LEN];
ffe60014 58 struct lttng_ust_channel_attr attr;
bec39940 59 struct lttng_ht *ctx;
31746f93 60 struct cds_list_head ctx_list;
bec39940
DG
61 struct lttng_ht *events;
62 struct lttng_ht_node_str node;
1624d5b7
JD
63 uint64_t tracefile_size;
64 uint64_t tracefile_count;
97ee3a89
DG
65};
66
67/* UST Metadata */
68struct ltt_ust_metadata {
69 int handle;
13161846 70 struct lttng_ust_object_data *obj;
f6a9efaa 71 char pathname[PATH_MAX]; /* Trace file path name */
ffe60014 72 struct lttng_ust_channel_attr attr;
13161846 73 struct lttng_ust_object_data *stream_obj;
97ee3a89
DG
74};
75
f6a9efaa
DG
76/* UST domain global (LTTNG_DOMAIN_UST) */
77struct ltt_ust_domain_global {
bec39940 78 struct lttng_ht *channels;
7972aab2 79 struct cds_list_head registry_buffer_uid_list;
f6a9efaa
DG
80};
81
97ee3a89
DG
82/* UST session */
83struct ltt_ust_session {
d9bf3ca4 84 uint64_t id; /* Unique identifier of session */
36dc12cc 85 int start_trace;
f6a9efaa 86 struct ltt_ust_domain_global domain_global;
6df2e2c9
MD
87 /* UID/GID of the user owning the session */
88 uid_t uid;
89 gid_t gid;
00e2e675
DG
90 /*
91 * Two consumer_output object are needed where one is for the current
92 * output object and the second one is the temporary object used to store
93 * URI being set by the lttng_set_consumer_uri call. Once
94 * lttng_enable_consumer is called, the two pointers are swapped.
95 */
96 struct consumer_output *consumer;
97 struct consumer_output *tmp_consumer;
f3f0db50
DG
98 /* Sequence number for filters so the tracer knows the ordering. */
99 uint64_t filter_seq_num;
7972aab2
DG
100 /* This indicates which type of buffer this session is set for. */
101 enum lttng_buffer_type buffer_type;
102 /* If set to 1, the buffer_type can not be changed anymore. */
103 int buffer_type_changed;
104 /* For per UID buffer, every buffer reg object is kept of this session */
105 struct cds_list_head buffer_reg_uid_list;
106 /* Next channel ID available for a newly registered channel. */
107 uint64_t next_channel_id;
108 /* Once this value reaches UINT32_MAX, no more id can be allocated. */
109 uint64_t used_channel_id;
2bba9e53
DG
110 /* Tell or not if the session has to output the traces. */
111 unsigned int output_traces;
27babd3a 112 unsigned int snapshot_mode;
85076754 113 unsigned int has_non_default_channel;
ecc48a90 114 unsigned int live_timer_interval; /* usec */
97ee3a89
DG
115};
116
7972aab2
DG
117/*
118 * Validate that the id has reached the maximum allowed or not.
119 *
120 * Return 0 if NOT else 1.
121 */
122static inline int trace_ust_is_max_id(uint64_t id)
123{
124 return (id == UINT64_MAX) ? 1 : 0;
125}
126
127/*
128 * Return next available channel id and increment the used counter. The
129 * trace_ust_is_max_id function MUST be called before in order to validate if
130 * the maximum number of IDs have been reached. If not, it is safe to call this
131 * function.
132 *
133 * Return a unique channel ID. If max is reached, the used_channel_id counter
134 * is returned.
135 */
136static inline uint64_t trace_ust_get_next_chan_id(struct ltt_ust_session *s)
137{
138 if (trace_ust_is_max_id(s->used_channel_id)) {
139 return s->used_channel_id;
140 }
141
142 s->used_channel_id++;
143 return s->next_channel_id++;
144}
145
74d0b642 146#ifdef HAVE_LIBLTTNG_UST_CTL
3bd1e081 147
18eace3b
DG
148int trace_ust_ht_match_event(struct cds_lfht_node *node, const void *_key);
149int trace_ust_ht_match_event_by_name(struct cds_lfht_node *node,
150 const void *_key);
151
97ee3a89
DG
152/*
153 * Lookup functions. NULL is returned if not found.
154 */
18eace3b
DG
155struct ltt_ust_event *trace_ust_find_event(struct lttng_ht *ht,
156 char *name, struct lttng_filter_bytecode *filter, int loglevel);
bec39940 157struct ltt_ust_channel *trace_ust_find_channel_by_name(struct lttng_ht *ht,
f6a9efaa 158 char *name);
97ee3a89
DG
159
160/*
161 * Create functions malloc() the data structure.
162 */
d9bf3ca4 163struct ltt_ust_session *trace_ust_create_session(uint64_t session_id);
dec56f6c 164struct ltt_ust_channel *trace_ust_create_channel(struct lttng_channel *attr);
025faf73
DG
165struct ltt_ust_event *trace_ust_create_event(struct lttng_event *ev,
166 struct lttng_filter_bytecode *filter);
97ee3a89 167struct ltt_ust_metadata *trace_ust_create_metadata(char *path);
55cc08a6
DG
168struct ltt_ust_context *trace_ust_create_context(
169 struct lttng_event_context *ctx);
d5979e4a
DG
170void trace_ust_delete_channel(struct lttng_ht *ht,
171 struct ltt_ust_channel *channel);
97ee3a89
DG
172
173/*
174 * Destroy functions free() the data structure and remove from linked list if
175 * it's applies.
176 */
177void trace_ust_destroy_session(struct ltt_ust_session *session);
178void trace_ust_destroy_metadata(struct ltt_ust_metadata *metadata);
179void trace_ust_destroy_channel(struct ltt_ust_channel *channel);
180void trace_ust_destroy_event(struct ltt_ust_event *event);
181
74d0b642 182#else /* HAVE_LIBLTTNG_UST_CTL */
3bd1e081 183
37a86c61
DG
184static inline int trace_ust_ht_match_event(struct cds_lfht_node *node,
185 const void *_key)
186{
187 return 0;
188}
189static inline int trace_ust_ht_match_event_by_name(struct cds_lfht_node *node,
190 const void *_key)
191{
192 return 0;
193}
3bd1e081 194static inline
bec39940 195struct ltt_ust_channel *trace_ust_find_channel_by_name(struct lttng_ht *ht,
f6a9efaa 196 char *name)
3bd1e081
MD
197{
198 return NULL;
199}
f6a9efaa 200
3bd1e081 201static inline
dec56f6c 202struct ltt_ust_session *trace_ust_create_session(unsigned int session_id)
3bd1e081
MD
203{
204 return NULL;
205}
206static inline
dec56f6c 207struct ltt_ust_channel *trace_ust_create_channel(struct lttng_channel *attr)
3bd1e081
MD
208{
209 return NULL;
210}
211static inline
025faf73
DG
212struct ltt_ust_event *trace_ust_create_event(struct lttng_event *ev,
213 struct lttng_filter_bytecode *filter)
3bd1e081
MD
214{
215 return NULL;
216}
217static inline
218struct ltt_ust_metadata *trace_ust_create_metadata(char *path)
219{
220 return NULL;
221}
222
223static inline
224void trace_ust_destroy_session(struct ltt_ust_session *session)
225{
226}
48842b30 227
3bd1e081
MD
228static inline
229void trace_ust_destroy_metadata(struct ltt_ust_metadata *metadata)
230{
231}
48842b30 232
3bd1e081
MD
233static inline
234void trace_ust_destroy_channel(struct ltt_ust_channel *channel)
235{
236}
48842b30 237
3bd1e081
MD
238static inline
239void trace_ust_destroy_event(struct ltt_ust_event *event)
240{
241}
34378f76
DG
242static inline
243struct ltt_ust_context *trace_ust_create_context(
244 struct lttng_event_context *ctx)
245{
246 return NULL;
247}
37a86c61
DG
248static inline struct ltt_ust_event *trace_ust_find_event(struct lttng_ht *ht,
249 char *name, struct lttng_filter_bytecode *filter, int loglevel)
250{
251 return NULL;
252}
d5979e4a
DG
253static inline
254void trace_ust_delete_channel(struct lttng_ht *ht,
255 struct ltt_ust_channel *channel)
256{
257 return;
258}
3bd1e081 259
74d0b642 260#endif /* HAVE_LIBLTTNG_UST_CTL */
3bd1e081 261
97ee3a89 262#endif /* _LTT_TRACE_UST_H */
This page took 0.048497 seconds and 4 git commands to generate.