Cleanup ust-app.c and make it more modular
[lttng-tools.git] / lttng-sessiond / lttng-ust-ctl.h
CommitLineData
2bdd86d4
MD
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
6 * modify it under the terms of the GNU General Public License
7 * as published by the Free Software Foundation; only version 2
8 * of the License.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
18 */
19
20#ifndef _LTTNG_UST_CTL_H
21#define _LTTNG_UST_CTL_H
22
9df8df5e 23#include "lttng-ust-abi.h"
2bdd86d4 24
13161846
DG
25int ustctl_register_done(int sock);
26int ustctl_create_session(int sock);
2bdd86d4
MD
27int ustctl_open_metadata(int sock, int session_handle,
28 struct lttng_ust_channel_attr *chops,
13161846 29 struct lttng_ust_object_data **metadata_data);
2bdd86d4
MD
30int ustctl_create_channel(int sock, int session_handle,
31 struct lttng_ust_channel_attr *chops,
13161846
DG
32 struct lttng_ust_object_data **channel_data);
33int ustctl_create_stream(int sock, struct lttng_ust_object_data *channel_data,
34 struct lttng_ust_object_data **stream_data);
2bdd86d4 35int ustctl_create_event(int sock, struct lttng_ust_event *ev,
13161846
DG
36 struct lttng_ust_object_data *channel_data,
37 struct lttng_ust_object_data **event_data);
2bdd86d4 38int ustctl_add_context(int sock, struct lttng_ust_context *ctx,
13161846
DG
39 struct lttng_ust_object_data *obj_data,
40 struct lttng_ust_object_data **context_data);
2bdd86d4 41
13161846
DG
42int ustctl_enable(int sock, struct lttng_ust_object_data *object);
43int ustctl_disable(int sock, struct lttng_ust_object_data *object);
44int ustctl_start_session(int sock, int handle);
45int ustctl_stop_session(int sock, int handle);
2bdd86d4 46
13161846
DG
47int ustctl_tracepoint_list(int sock); /* not implemented yet */
48int ustctl_tracer_version(int sock, struct lttng_ust_tracer_version *v);
49int ustctl_wait_quiescent(int sock);
2bdd86d4
MD
50
51/* Flush each buffers in this channel */
13161846 52int ustctl_flush_buffer(int sock, struct lttng_ust_object_data *channel_data);
2bdd86d4
MD
53
54/* not implemented yet */
55struct lttng_ust_calibrate;
13161846 56int ustctl_calibrate(int sock, struct lttng_ust_calibrate *calibrate);
2bdd86d4
MD
57
58/*
13161846 59 * Map channel lttng_ust_shm_handle and add streams. Typically performed by the
2bdd86d4
MD
60 * consumer to map the objects into its memory space.
61 */
13161846
DG
62struct lttng_ust_shm_handle *ustctl_map_channel(struct lttng_ust_object_data *chan_data);
63int ustctl_add_stream(struct lttng_ust_shm_handle *lttng_ust_shm_handle,
64 struct lttng_ust_object_data *stream_data);
2bdd86d4 65/*
13161846 66 * Note: the lttng_ust_object_data from which the lttng_ust_shm_handle is derived can only
2bdd86d4
MD
67 * be released after unmapping the handle.
68 */
13161846 69void ustctl_unmap_channel(struct lttng_ust_shm_handle *lttng_ust_shm_handle);
2bdd86d4
MD
70
71/* Buffer operations */
72
13161846
DG
73struct lttng_ust_shm_handle;
74struct lttng_ust_lib_ring_buffer;
2bdd86d4
MD
75
76/* Open/close stream buffers for read */
13161846
DG
77struct lttng_ust_lib_ring_buffer *ustctl_open_stream_read(struct lttng_ust_shm_handle *handle,
78 int cpu);
79void ustctl_close_stream_read(struct lttng_ust_shm_handle *handle,
80 struct lttng_ust_lib_ring_buffer *buf);
2bdd86d4
MD
81
82/* For mmap mode, readable without "get" operation */
13161846
DG
83int ustctl_get_mmap_len(struct lttng_ust_shm_handle *handle,
84 struct lttng_ust_lib_ring_buffer *buf,
85 unsigned long *len);
86int ustctl_get_max_subbuf_size(struct lttng_ust_shm_handle *handle,
87 struct lttng_ust_lib_ring_buffer *buf,
88 unsigned long *len);
2bdd86d4
MD
89
90/*
91 * For mmap mode, operate on the current packet (between get/put or
92 * get_next/put_next).
93 */
13161846
DG
94void *ustctl_get_mmap_base(struct lttng_ust_shm_handle *handle,
95 struct lttng_ust_lib_ring_buffer *buf);
96int ustctl_get_mmap_read_offset(struct lttng_ust_shm_handle *handle,
97 struct lttng_ust_lib_ring_buffer *buf, unsigned long *off);
98int ustctl_get_subbuf_size(struct lttng_ust_shm_handle *handle,
99 struct lttng_ust_lib_ring_buffer *buf, unsigned long *len);
100int ustctl_get_padded_subbuf_size(struct lttng_ust_shm_handle *handle,
101 struct lttng_ust_lib_ring_buffer *buf, unsigned long *len);
102int ustctl_get_next_subbuf(struct lttng_ust_shm_handle *handle,
103 struct lttng_ust_lib_ring_buffer *buf);
104int ustctl_put_next_subbuf(struct lttng_ust_shm_handle *handle,
105 struct lttng_ust_lib_ring_buffer *buf);
2bdd86d4
MD
106
107/* snapshot */
108
13161846
DG
109int ustctl_snapshot(struct lttng_ust_shm_handle *handle,
110 struct lttng_ust_lib_ring_buffer *buf);
111int ustctl_snapshot_get_consumed(struct lttng_ust_shm_handle *handle,
112 struct lttng_ust_lib_ring_buffer *buf, unsigned long *pos);
113int ustctl_snapshot_get_produced(struct lttng_ust_shm_handle *handle,
114 struct lttng_ust_lib_ring_buffer *buf, unsigned long *pos);
115int ustctl_get_subbuf(struct lttng_ust_shm_handle *handle,
116 struct lttng_ust_lib_ring_buffer *buf, unsigned long *pos);
117int ustctl_put_subbuf(struct lttng_ust_shm_handle *handle,
118 struct lttng_ust_lib_ring_buffer *buf);
2bdd86d4
MD
119
120/* Release object created by members of this API */
13161846 121void release_object(int sock, struct lttng_ust_object_data *data);
2bdd86d4
MD
122
123#endif /* _LTTNG_UST_CTL_H */
This page took 0.041062 seconds and 4 git commands to generate.