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