From: Mathieu Desnoyers Date: Thu, 20 Oct 2011 18:38:09 +0000 (-0400) Subject: Add lttng-ust-ctl.h header X-Git-Tag: v1.9.1~166 X-Git-Url: https://git.lttng.org./?a=commitdiff_plain;h=f3105c676e912bf2ec25d89e4889fb951c750b83;p=lttng-ust.git Add lttng-ust-ctl.h header Signed-off-by: Mathieu Desnoyers --- diff --git a/include/ust/lttng-ust-ctl.h b/include/ust/lttng-ust-ctl.h new file mode 100644 index 00000000..96d627c3 --- /dev/null +++ b/include/ust/lttng-ust-ctl.h @@ -0,0 +1,128 @@ +/* + * Copyright (C) 2011 - Julien Desfossez + * Mathieu Desnoyers + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License + * as published by the Free Software Foundation; only version 2 + * of the License. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + */ + +#ifndef _LTTNG_UST_CTL_H +#define _LTTNG_UST_CTL_H + +#include + +/* + * Tracer channel attributes. + */ +struct lttng_ust_channel_attr { + int overwrite; /* 1: overwrite, 0: discard */ + uint64_t subbuf_size; /* bytes */ + uint64_t num_subbuf; /* power of 2 */ + unsigned int switch_timer_interval; /* usec */ + unsigned int read_timer_interval; /* usec */ + enum lttng_ust_output output; /* splice, mmap */ +}; + +struct object_data { + int handle; + int shm_fd; + int wait_fd; + uint64_t memory_map_size; +}; + +int ustctl_create_session(int sock); +int ustctl_open_metadata(int sock, int session_handle, + struct lttng_ust_channel_attr *chops, + struct object_data **metadata_data); +int ustctl_create_channel(int sock, int session_handle, + struct lttng_ust_channel_attr *chops, + struct object_data **channel_data); +int ustctl_create_stream(int sock, struct object_data *channel_data, + struct object_data **stream_data); +int ustctl_create_event(int sock, struct lttng_ust_event *ev, + struct object_data *channel_data, + struct object_data **event_data); +int ustctl_add_context(int sock, struct lttng_ust_context *ctx, + struct object_data *channel_data, + struct object_data **context_data); + +int ustctl_enable(int sock, struct object_data *object); +int ustctl_disable(int sock, struct object_data *object); +int ustctl_start_session(int sock, struct object_data *object); +int ustctl_stop_session(int sock, struct object_data *object); + +int ustctl_tracepoint_list(int sock); /* not implemented yet */ +int ustctl_tracer_version(int sock, struct lttng_ust_tracer_version *v); +int ustctl_wait_quiescent(int sock); + +/* not implemented yet */ +struct lttng_ust_calibrate; +int ustctl_calibrate(int sock, struct lttng_ust_calibrate *calibrate); + +/* TODO: object_data send/recv between sessiond and consumer */ +/* TODO: release shm_handle */ + +/* + * Map channel shm_handle and add streams. Typically performed by the + * consumer to map the objects into its memory space. + */ +struct shm_handle *ustctl_map_channel(struct object_data *chan_data); +int ustctl_add_stream(struct shm_handle *shm_handle, + struct object_data *stream_data); + +/* Buffer operations */ + +struct shm_handle; +struct lib_ring_buffer; + +/* For mmap mode, readable without "get" operation */ +int ustctl_get_mmap_len(struct shm_handle *handle, + struct lib_ring_buffer *buf, + unsigned long *len); +int ustctl_get_max_subbuf_size(struct shm_handle *handle, + struct lib_ring_buffer *buf, + unsigned long *len); + +/* + * For mmap mode, operate on the current packet (between get/put or + * get_next/put_next). + */ +int ustctl_get_mmap_read_offset(struct shm_handle *handle, + struct lib_ring_buffer *buf, unsigned long *off); +int ustctl_get_subbuf_size(struct shm_handle *handle, + struct lib_ring_buffer *buf, unsigned long *len); +int ustctl_get_padded_subbuf_size(struct shm_handle *handle, + struct lib_ring_buffer *buf, unsigned long *len); +int ustctl_get_next_subbuf(struct shm_handle *handle, + struct lib_ring_buffer *buf); +int ustctl_put_next_subbuf(struct shm_handle *handle, + struct lib_ring_buffer *buf); + +/* snapshot */ + +int ustctl_snapshot(struct shm_handle *handle, + struct lib_ring_buffer *buf); +int ustctl_snapshot_get_consumed(struct shm_handle *handle, + struct lib_ring_buffer *buf, unsigned long *pos); +int ustctl_snapshot_get_produced(struct shm_handle *handle, + struct lib_ring_buffer *buf, unsigned long *pos); +int ustctl_get_subbuf(struct shm_handle *handle, + struct lib_ring_buffer *buf, unsigned long *pos); +int ustctl_put_subbuf(struct shm_handle *handle, + struct lib_ring_buffer *buf); + +/* Release object created by members of this API */ +void release_object(int sock, struct object_data *data); + +#endif /* _LTTNG_UST_CTL_H */