Implement filter bytecode interpreter and linker
[lttng-ust.git] / include / lttng / ust-ctl.h
... / ...
CommitLineData
1/*
2 * Copyright (C) 2011 - Julien Desfossez <julien.desfossez@polymtl.ca>
3 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; version 2 of the License only.
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 along
15 * with this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
17 */
18
19#ifndef _LTTNG_UST_CTL_H
20#define _LTTNG_UST_CTL_H
21
22#include <lttng/ust-abi.h>
23
24int ustctl_register_done(int sock);
25int ustctl_create_session(int sock);
26int ustctl_open_metadata(int sock, int session_handle,
27 struct lttng_ust_channel_attr *chops,
28 struct lttng_ust_object_data **metadata_data);
29int ustctl_create_channel(int sock, int session_handle,
30 struct lttng_ust_channel_attr *chops,
31 struct lttng_ust_object_data **channel_data);
32int ustctl_create_stream(int sock, struct lttng_ust_object_data *channel_data,
33 struct lttng_ust_object_data **stream_data);
34int ustctl_create_event(int sock, struct lttng_ust_event *ev,
35 struct lttng_ust_object_data *channel_data,
36 struct lttng_ust_object_data **event_data);
37int ustctl_add_context(int sock, struct lttng_ust_context *ctx,
38 struct lttng_ust_object_data *obj_data,
39 struct lttng_ust_object_data **context_data);
40int ustctl_set_filter(int sock, struct lttng_ust_filter_bytecode *bytecode,
41 struct lttng_ust_object_data *obj_data);
42
43int ustctl_enable(int sock, struct lttng_ust_object_data *object);
44int ustctl_disable(int sock, struct lttng_ust_object_data *object);
45int ustctl_start_session(int sock, int handle);
46int ustctl_stop_session(int sock, int handle);
47
48/*
49 * ustctl_tracepoint_list returns a tracepoint list handle, or negative
50 * error value.
51 */
52int ustctl_tracepoint_list(int sock);
53/*
54 * ustctl_tracepoint_list_get is used to iterate on the tp list
55 * handle. End is iteration is reached when -ENOENT is returned.
56 */
57int ustctl_tracepoint_list_get(int sock, int tp_list_handle,
58 struct lttng_ust_tracepoint_iter *iter);
59
60/*
61 * ustctl_tracepoint_field_list returns a tracepoint field list handle,
62 * or negative error value.
63 */
64int ustctl_tracepoint_field_list(int sock);
65
66/*
67 * ustctl_tracepoint_field_list_get is used to iterate on the tp field
68 * list handle. End is iteration is reached when -ENOENT is returned.
69 */
70int ustctl_tracepoint_field_list_get(int sock, int tp_field_list_handle,
71 struct lttng_ust_field_iter *iter);
72
73int ustctl_tracer_version(int sock, struct lttng_ust_tracer_version *v);
74int ustctl_wait_quiescent(int sock);
75
76int ustctl_sock_flush_buffer(int sock, struct lttng_ust_object_data *object);
77
78int ustctl_calibrate(int sock, struct lttng_ust_calibrate *calibrate);
79
80/*
81 * Map channel lttng_ust_shm_handle and add streams. Typically performed by the
82 * consumer to map the objects into its memory space.
83 */
84struct lttng_ust_shm_handle *ustctl_map_channel(struct lttng_ust_object_data *chan_data);
85int ustctl_add_stream(struct lttng_ust_shm_handle *lttng_ust_shm_handle,
86 struct lttng_ust_object_data *stream_data);
87/*
88 * Note: the lttng_ust_object_data from which the lttng_ust_shm_handle is derived can only
89 * be released after unmapping the handle.
90 */
91void ustctl_unmap_channel(struct lttng_ust_shm_handle *lttng_ust_shm_handle);
92
93/* Buffer operations */
94
95struct lttng_ust_shm_handle;
96struct lttng_ust_lib_ring_buffer;
97
98/* Open/close stream buffers for read */
99struct lttng_ust_lib_ring_buffer *ustctl_open_stream_read(struct lttng_ust_shm_handle *handle,
100 int cpu);
101void ustctl_close_stream_read(struct lttng_ust_shm_handle *handle,
102 struct lttng_ust_lib_ring_buffer *buf);
103
104/* For mmap mode, readable without "get" operation */
105int ustctl_get_mmap_len(struct lttng_ust_shm_handle *handle,
106 struct lttng_ust_lib_ring_buffer *buf,
107 unsigned long *len);
108int ustctl_get_max_subbuf_size(struct lttng_ust_shm_handle *handle,
109 struct lttng_ust_lib_ring_buffer *buf,
110 unsigned long *len);
111
112/*
113 * For mmap mode, operate on the current packet (between get/put or
114 * get_next/put_next).
115 */
116void *ustctl_get_mmap_base(struct lttng_ust_shm_handle *handle,
117 struct lttng_ust_lib_ring_buffer *buf);
118int ustctl_get_mmap_read_offset(struct lttng_ust_shm_handle *handle,
119 struct lttng_ust_lib_ring_buffer *buf, unsigned long *off);
120int ustctl_get_subbuf_size(struct lttng_ust_shm_handle *handle,
121 struct lttng_ust_lib_ring_buffer *buf, unsigned long *len);
122int ustctl_get_padded_subbuf_size(struct lttng_ust_shm_handle *handle,
123 struct lttng_ust_lib_ring_buffer *buf, unsigned long *len);
124int ustctl_get_next_subbuf(struct lttng_ust_shm_handle *handle,
125 struct lttng_ust_lib_ring_buffer *buf);
126int ustctl_put_next_subbuf(struct lttng_ust_shm_handle *handle,
127 struct lttng_ust_lib_ring_buffer *buf);
128
129/* snapshot */
130
131int ustctl_snapshot(struct lttng_ust_shm_handle *handle,
132 struct lttng_ust_lib_ring_buffer *buf);
133int ustctl_snapshot_get_consumed(struct lttng_ust_shm_handle *handle,
134 struct lttng_ust_lib_ring_buffer *buf, unsigned long *pos);
135int ustctl_snapshot_get_produced(struct lttng_ust_shm_handle *handle,
136 struct lttng_ust_lib_ring_buffer *buf, unsigned long *pos);
137int ustctl_get_subbuf(struct lttng_ust_shm_handle *handle,
138 struct lttng_ust_lib_ring_buffer *buf, unsigned long *pos);
139int ustctl_put_subbuf(struct lttng_ust_shm_handle *handle,
140 struct lttng_ust_lib_ring_buffer *buf);
141
142void ustctl_flush_buffer(struct lttng_ust_shm_handle *handle,
143 struct lttng_ust_lib_ring_buffer *buf,
144 int producer_active);
145
146/* Release object created by members of this API. */
147int ustctl_release_object(int sock, struct lttng_ust_object_data *data);
148/* Release handle returned by create session. */
149int ustctl_release_handle(int sock, int handle);
150
151#endif /* _LTTNG_UST_CTL_H */
This page took 0.023667 seconds and 4 git commands to generate.