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