Commit | Line | Data |
---|---|---|
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 |
25 | int ustctl_register_done(int sock); |
26 | int ustctl_create_session(int sock); | |
2bdd86d4 MD |
27 | int 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 |
30 | int 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); |
33 | int ustctl_create_stream(int sock, struct lttng_ust_object_data *channel_data, | |
34 | struct lttng_ust_object_data **stream_data); | |
2bdd86d4 | 35 | int 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 | 38 | int 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 |
42 | int ustctl_enable(int sock, struct lttng_ust_object_data *object); |
43 | int ustctl_disable(int sock, struct lttng_ust_object_data *object); | |
44 | int ustctl_start_session(int sock, int handle); | |
45 | int ustctl_stop_session(int sock, int handle); | |
2bdd86d4 | 46 | |
8ec2d32a MD |
47 | /* |
48 | * ustctl_tracepoint_list returns a tracepoint list handle, or negative | |
49 | * error value. | |
50 | */ | |
51 | int ustctl_tracepoint_list(int sock); | |
52 | /* | |
53 | * ustctl_tracepoint_list_get is used to iterate on the tp list | |
54 | * handle. End is iteration is reached when -ENOENT is returned. | |
55 | */ | |
56 | int ustctl_tracepoint_list_get(int sock, int tp_list_handle, | |
177f8533 | 57 | struct lttng_ust_tracepoint_iter *iter); |
8ec2d32a | 58 | |
13161846 DG |
59 | int ustctl_tracer_version(int sock, struct lttng_ust_tracer_version *v); |
60 | int ustctl_wait_quiescent(int sock); | |
2bdd86d4 | 61 | |
6d3686da DG |
62 | int ustctl_sock_flush_buffer(int sock, struct lttng_ust_object_data *object); |
63 | ||
2bdd86d4 | 64 | /* not implemented yet */ |
13161846 | 65 | int ustctl_calibrate(int sock, struct lttng_ust_calibrate *calibrate); |
2bdd86d4 MD |
66 | |
67 | /* | |
13161846 | 68 | * Map channel lttng_ust_shm_handle and add streams. Typically performed by the |
2bdd86d4 MD |
69 | * consumer to map the objects into its memory space. |
70 | */ | |
13161846 DG |
71 | struct lttng_ust_shm_handle *ustctl_map_channel(struct lttng_ust_object_data *chan_data); |
72 | int ustctl_add_stream(struct lttng_ust_shm_handle *lttng_ust_shm_handle, | |
73 | struct lttng_ust_object_data *stream_data); | |
2bdd86d4 | 74 | /* |
13161846 | 75 | * Note: the lttng_ust_object_data from which the lttng_ust_shm_handle is derived can only |
2bdd86d4 MD |
76 | * be released after unmapping the handle. |
77 | */ | |
13161846 | 78 | void ustctl_unmap_channel(struct lttng_ust_shm_handle *lttng_ust_shm_handle); |
2bdd86d4 MD |
79 | |
80 | /* Buffer operations */ | |
81 | ||
13161846 DG |
82 | struct lttng_ust_shm_handle; |
83 | struct lttng_ust_lib_ring_buffer; | |
2bdd86d4 MD |
84 | |
85 | /* Open/close stream buffers for read */ | |
13161846 DG |
86 | struct lttng_ust_lib_ring_buffer *ustctl_open_stream_read(struct lttng_ust_shm_handle *handle, |
87 | int cpu); | |
88 | void ustctl_close_stream_read(struct lttng_ust_shm_handle *handle, | |
89 | struct lttng_ust_lib_ring_buffer *buf); | |
2bdd86d4 MD |
90 | |
91 | /* For mmap mode, readable without "get" operation */ | |
13161846 DG |
92 | int ustctl_get_mmap_len(struct lttng_ust_shm_handle *handle, |
93 | struct lttng_ust_lib_ring_buffer *buf, | |
94 | unsigned long *len); | |
95 | int ustctl_get_max_subbuf_size(struct lttng_ust_shm_handle *handle, | |
96 | struct lttng_ust_lib_ring_buffer *buf, | |
97 | unsigned long *len); | |
2bdd86d4 MD |
98 | |
99 | /* | |
100 | * For mmap mode, operate on the current packet (between get/put or | |
101 | * get_next/put_next). | |
102 | */ | |
13161846 DG |
103 | void *ustctl_get_mmap_base(struct lttng_ust_shm_handle *handle, |
104 | struct lttng_ust_lib_ring_buffer *buf); | |
105 | int ustctl_get_mmap_read_offset(struct lttng_ust_shm_handle *handle, | |
106 | struct lttng_ust_lib_ring_buffer *buf, unsigned long *off); | |
107 | int ustctl_get_subbuf_size(struct lttng_ust_shm_handle *handle, | |
108 | struct lttng_ust_lib_ring_buffer *buf, unsigned long *len); | |
109 | int ustctl_get_padded_subbuf_size(struct lttng_ust_shm_handle *handle, | |
110 | struct lttng_ust_lib_ring_buffer *buf, unsigned long *len); | |
111 | int ustctl_get_next_subbuf(struct lttng_ust_shm_handle *handle, | |
112 | struct lttng_ust_lib_ring_buffer *buf); | |
113 | int ustctl_put_next_subbuf(struct lttng_ust_shm_handle *handle, | |
114 | struct lttng_ust_lib_ring_buffer *buf); | |
2bdd86d4 MD |
115 | |
116 | /* snapshot */ | |
117 | ||
13161846 DG |
118 | int ustctl_snapshot(struct lttng_ust_shm_handle *handle, |
119 | struct lttng_ust_lib_ring_buffer *buf); | |
120 | int ustctl_snapshot_get_consumed(struct lttng_ust_shm_handle *handle, | |
121 | struct lttng_ust_lib_ring_buffer *buf, unsigned long *pos); | |
122 | int ustctl_snapshot_get_produced(struct lttng_ust_shm_handle *handle, | |
123 | struct lttng_ust_lib_ring_buffer *buf, unsigned long *pos); | |
124 | int ustctl_get_subbuf(struct lttng_ust_shm_handle *handle, | |
125 | struct lttng_ust_lib_ring_buffer *buf, unsigned long *pos); | |
126 | int ustctl_put_subbuf(struct lttng_ust_shm_handle *handle, | |
127 | struct lttng_ust_lib_ring_buffer *buf); | |
2bdd86d4 | 128 | |
8ec2d32a MD |
129 | void ustctl_flush_buffer(struct lttng_ust_shm_handle *handle, |
130 | struct lttng_ust_lib_ring_buffer *buf, | |
131 | int producer_active); | |
132 | ||
2bdd86d4 | 133 | /* Release object created by members of this API */ |
177f8533 | 134 | int ustctl_release_object(int sock, struct lttng_ust_object_data *data); |
c3fd7e61 DG |
135 | /* Release handle returned by create session. */ |
136 | int ustctl_release_handle(int sock, int handle); | |
2bdd86d4 MD |
137 | |
138 | #endif /* _LTTNG_UST_CTL_H */ |