[lttng-ust.git] / include / ust-comm.h

#ifndef _LTTNG_UST_COMM_H
#define _LTTNG_UST_COMM_H

/*
 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
 *                      Julien Desfossez <julien.desfossez@polymtl.ca>
 *                      Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; only
 * version 2.1 of the License.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

/*
 * This header is meant for liblttng and libust internal use ONLY.
 * These declarations should NOT be considered stable API.
 */

#include <limits.h>
#include <unistd.h>
#include <lttng/ust-abi.h>
#include <lttng/ust-error.h>
#include <lttng/ust-compiler.h>
#include <lttng/ust-ctl.h>
#include <config.h>

/*
 * Default timeout the application waits for the sessiond to send its
 * "register done" command. Can be overridden with the environment
 * variable "LTTNG_UST_REGISTER_TIMEOUT". Note that if the sessiond is not
 * found, the application proceeds directly without any delay.
 */
#define LTTNG_UST_DEFAULT_CONSTRUCTOR_TIMEOUT_MS	3000

#define LTTNG_DEFAULT_RUNDIR				LTTNG_SYSTEM_RUNDIR
#define LTTNG_DEFAULT_HOME_RUNDIR			".lttng"

/* Queue size of listen(2) */
#define LTTNG_UST_COMM_MAX_LISTEN			10
#define LTTNG_UST_COMM_REG_MSG_PADDING			64

struct lttng_event_field;
struct lttng_ctx_field;
struct lttng_enum_entry;
struct lttng_integer_type;
struct lttng_session;

struct ustctl_reg_msg {
	uint32_t magic;
	uint32_t major;
	uint32_t minor;
	uint32_t pid;
	uint32_t ppid;
	uint32_t uid;
	uint32_t gid;
	uint32_t bits_per_long;
	uint32_t uint8_t_alignment;
	uint32_t uint16_t_alignment;
	uint32_t uint32_t_alignment;
	uint32_t uint64_t_alignment;
	uint32_t long_alignment;
	uint32_t socket_type;			/* enum ustctl_socket_type */
	char name[LTTNG_UST_ABI_PROCNAME_LEN];	/* process name */
	char padding[LTTNG_UST_COMM_REG_MSG_PADDING];
} LTTNG_PACKED;

/*
 * Data structure for the commands sent from sessiond to UST.
 */
#define USTCOMM_MSG_PADDING1		32
#define USTCOMM_MSG_PADDING2		32
struct ustcomm_ust_msg {
	uint32_t handle;
	uint32_t cmd;
	char padding[USTCOMM_MSG_PADDING1];
	union {
		struct lttng_ust_channel channel;
		struct lttng_ust_stream stream;
		struct lttng_ust_event event;
		struct lttng_ust_context context;
		struct lttng_ust_tracer_version version;
		struct lttng_ust_tracepoint_iter tracepoint;
		struct {
			uint32_t data_size;	/* following filter data */
			uint32_t reloc_offset;
			uint64_t seqnum;
		} LTTNG_PACKED filter;
		struct {
			uint32_t count;	/* how many names follow */
		} LTTNG_PACKED exclusion;
		char padding[USTCOMM_MSG_PADDING2];
	} u;
} LTTNG_PACKED;

/*
 * Data structure for the response from UST to the session daemon.
 * cmd_type is sent back in the reply for validation.
 */
#define USTCOMM_REPLY_PADDING1		32
#define USTCOMM_REPLY_PADDING2		32
struct ustcomm_ust_reply {
	uint32_t handle;
	uint32_t cmd;
	int32_t ret_code;	/* enum ustcomm_return_code */
	uint32_t ret_val;	/* return value */
	char padding[USTCOMM_REPLY_PADDING1];
	union {
		struct {
			uint64_t memory_map_size;
		} LTTNG_PACKED channel;
		struct {
			uint64_t memory_map_size;
		} LTTNG_PACKED stream;
		struct lttng_ust_tracer_version version;
		struct lttng_ust_tracepoint_iter tracepoint;
		char padding[USTCOMM_REPLY_PADDING2];
	} u;
} LTTNG_PACKED;

struct ustcomm_notify_hdr {
	uint32_t notify_cmd;
} LTTNG_PACKED;

#define USTCOMM_NOTIFY_EVENT_MSG_PADDING	32
struct ustcomm_notify_event_msg {
	uint32_t session_objd;
	uint32_t channel_objd;
	char event_name[LTTNG_UST_SYM_NAME_LEN];
	int32_t loglevel;
	uint32_t signature_len;
	uint32_t fields_len;
	uint32_t model_emf_uri_len;
	char padding[USTCOMM_NOTIFY_EVENT_MSG_PADDING];
	/* followed by signature, fields, and model_emf_uri */
} LTTNG_PACKED;

#define USTCOMM_NOTIFY_EVENT_REPLY_PADDING	32
struct ustcomm_notify_event_reply {
	int32_t ret_code;	/* 0: ok, negative: error code */
	uint32_t event_id;
	char padding[USTCOMM_NOTIFY_EVENT_REPLY_PADDING];
} LTTNG_PACKED;

#define USTCOMM_NOTIFY_ENUM_MSG_PADDING		32
struct ustcomm_notify_enum_msg {
	uint32_t session_objd;
	char enum_name[LTTNG_UST_SYM_NAME_LEN];
	uint32_t entries_len;
	char padding[USTCOMM_NOTIFY_ENUM_MSG_PADDING];
	/* followed by enum entries */
} LTTNG_PACKED;

#define USTCOMM_NOTIFY_EVENT_REPLY_PADDING	32
struct ustcomm_notify_enum_reply {
	int32_t ret_code;	/* 0: ok, negative: error code */
	uint64_t enum_id;
	char padding[USTCOMM_NOTIFY_EVENT_REPLY_PADDING];
} LTTNG_PACKED;

#define USTCOMM_NOTIFY_CHANNEL_MSG_PADDING	32
struct ustcomm_notify_channel_msg {
	uint32_t session_objd;
	uint32_t channel_objd;
	uint32_t ctx_fields_len;
	char padding[USTCOMM_NOTIFY_CHANNEL_MSG_PADDING];
	/* followed by context fields */
} LTTNG_PACKED;

#define USTCOMM_NOTIFY_CHANNEL_REPLY_PADDING	32
struct ustcomm_notify_channel_reply {
	int32_t ret_code;	/* 0: ok, negative: error code */
	uint32_t chan_id;
	uint32_t header_type;	/* enum ustctl_channel_header */
	char padding[USTCOMM_NOTIFY_CHANNEL_REPLY_PADDING];
} LTTNG_PACKED;

/*
 * LTTNG_UST_TRACEPOINT_FIELD_LIST reply is followed by a
 * struct lttng_ust_field_iter field.
 */

extern int ustcomm_create_unix_sock(const char *pathname);
extern int ustcomm_connect_unix_sock(const char *pathname);
extern int ustcomm_accept_unix_sock(int sock);
extern int ustcomm_listen_unix_sock(int sock);
extern int ustcomm_close_unix_sock(int sock);

extern ssize_t ustcomm_recv_unix_sock(int sock, void *buf, size_t len);
extern ssize_t ustcomm_send_unix_sock(int sock, const void *buf, size_t len);
extern ssize_t ustcomm_send_fds_unix_sock(int sock, int *fds, size_t nb_fd);
extern ssize_t ustcomm_recv_fds_unix_sock(int sock, int *fds, size_t nb_fd);

extern const char *ustcomm_get_readable_code(int code);
extern int ustcomm_send_app_msg(int sock, struct ustcomm_ust_msg *lum);
extern int ustcomm_recv_app_reply(int sock, struct ustcomm_ust_reply *lur,
		uint32_t expected_handle, uint32_t expected_cmd);
extern int ustcomm_send_app_cmd(int sock,
		struct ustcomm_ust_msg *lum,
		struct ustcomm_ust_reply *lur);
int ustcomm_recv_fd(int sock);

ssize_t ustcomm_recv_channel_from_sessiond(int sock,
		void **chan_data, uint64_t len, int *wakeup_fd);
int ustcomm_recv_stream_from_sessiond(int sock,
		uint64_t *memory_map_size,
		int *shm_fd, int *wakeup_fd);

/*
 * Returns 0 on success, negative error value on error.
 * Returns -EPIPE or -ECONNRESET if other end has hung up.
 */
int ustcomm_send_reg_msg(int sock,
		enum ustctl_socket_type type,
		uint32_t bits_per_long,
		uint32_t uint8_t_alignment,
		uint32_t uint16_t_alignment,
		uint32_t uint32_t_alignment,
		uint32_t uint64_t_alignment,
		uint32_t long_alignment);

/*
 * Returns 0 on success, negative error value on error.
 * Returns -EPIPE or -ECONNRESET if other end has hung up.
 */
int ustcomm_register_event(int sock,
	struct lttng_session *session,
	int session_objd,		/* session descriptor */
	int channel_objd,		/* channel descriptor */
	const char *event_name,		/* event name (input) */
	int loglevel,
	const char *signature,		/* event signature (input) */
	size_t nr_fields,		/* fields */
	const struct lttng_event_field *fields,
	const char *model_emf_uri,
	uint32_t *id);			/* event id (output) */

/*
 * Returns 0 on success, negative error value on error.
 * Returns -EPIPE or -ECONNRESET if other end has hung up.
 */
int ustcomm_register_enum(int sock,
	int session_objd,		/* session descriptor */
	const char *enum_name,		/* enum name (input) */
	size_t nr_entries,		/* entries */
	const struct lttng_enum_entry *entries,
	uint64_t *id);			/* enum id (output) */

/*
 * Returns 0 on success, negative error value on error.
 * Returns -EPIPE or -ECONNRESET if other end has hung up.
 */
int ustcomm_register_channel(int sock,
	int session_objd,		/* session descriptor */
	int channel_objd,		/* channel descriptor */
	size_t nr_ctx_fields,
	const struct lttng_ctx_field *ctx_fields,
	uint32_t *chan_id,		/* channel id (output) */
	int *header_type); 		/* header type (output) */

int ustcomm_setsockopt_rcv_timeout(int sock, unsigned int msec);
int ustcomm_setsockopt_snd_timeout(int sock, unsigned int msec);

#endif	/* _LTTNG_UST_COMM_H */
Commit	Line	Data
b35d179d MD	1	#ifndef _LTTNG_UST_COMM_H
b35d179d MD	2	#define _LTTNG_UST_COMM_H
67c5b804 MD	3
	4	/*
	5	* Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
	6	* Julien Desfossez <julien.desfossez@polymtl.ca>
	7	* Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
	8	*
15f672f9 MD	9	* This library is free software; you can redistribute it and/or
	10	* modify it under the terms of the GNU Lesser General Public
	11	* License as published by the Free Software Foundation; only
	12	* version 2.1 of the License.
	13	*
	14	* This library is distributed in the hope that it will be useful,
67c5b804	15	* but WITHOUT ANY WARRANTY; without even the implied warranty of
15f672f9 MD	16	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	17	* Lesser General Public License for more details.
	18	*
	19	* You should have received a copy of the GNU Lesser General Public
	20	* License along with this library; if not, write to the Free Software
	21	* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
67c5b804 MD	22	*/
	23
	24	/*
	25	* This header is meant for liblttng and libust internal use ONLY.
	26	* These declarations should NOT be considered stable API.
	27	*/
	28
	29	#include <limits.h>
57773204	30	#include <unistd.h>
4318ae1b	31	#include <lttng/ust-abi.h>
7bc53e94	32	#include <lttng/ust-error.h>
b3f60bbf	33	#include <lttng/ust-compiler.h>
c785c634	34	#include <lttng/ust-ctl.h>
751d4e91	35	#include <config.h>
67c5b804	36
11ff9c7d	37	/*
cf12a773 MD	38	* Default timeout the application waits for the sessiond to send its
cf12a773 MD	39	* "register done" command. Can be overridden with the environment
69400ac4	40	* variable "LTTNG_UST_REGISTER_TIMEOUT". Note that if the sessiond is not
cf12a773	41	* found, the application proceeds directly without any delay.
11ff9c7d	42	*/
cf12a773	43	#define LTTNG_UST_DEFAULT_CONSTRUCTOR_TIMEOUT_MS 3000
11ff9c7d	44
751d4e91	45	#define LTTNG_DEFAULT_RUNDIR LTTNG_SYSTEM_RUNDIR
32ce8569	46	#define LTTNG_DEFAULT_HOME_RUNDIR ".lttng"
7fc90dca	47
67c5b804	48	/* Queue size of listen(2) */
32ce8569 MD	49	#define LTTNG_UST_COMM_MAX_LISTEN 10
	50	#define LTTNG_UST_COMM_REG_MSG_PADDING 64
	51
	52	struct lttng_event_field;
83e43212	53	struct lttng_ctx_field;
c785c634 MD	54	struct lttng_enum_entry;
	55	struct lttng_integer_type;
	56	struct lttng_session;
32ce8569 MD	57
	58	struct ustctl_reg_msg {
	59	uint32_t magic;
	60	uint32_t major;
	61	uint32_t minor;
	62	uint32_t pid;
	63	uint32_t ppid;
	64	uint32_t uid;
	65	uint32_t gid;
	66	uint32_t bits_per_long;
	67	uint32_t uint8_t_alignment;
	68	uint32_t uint16_t_alignment;
	69	uint32_t uint32_t_alignment;
	70	uint32_t uint64_t_alignment;
	71	uint32_t long_alignment;
	72	uint32_t socket_type; /* enum ustctl_socket_type */
	73	char name[LTTNG_UST_ABI_PROCNAME_LEN]; /* process name */
	74	char padding[LTTNG_UST_COMM_REG_MSG_PADDING];
	75	} LTTNG_PACKED;
67c5b804	76
67c5b804	77	/*
e7723462	78	* Data structure for the commands sent from sessiond to UST.
67c5b804	79	*/
32ce8569 MD	80	#define USTCOMM_MSG_PADDING1 32
32ce8569 MD	81	#define USTCOMM_MSG_PADDING2 32
57773204	82	struct ustcomm_ust_msg {
1ece9766	83	uint32_t handle;
46050b1a	84	uint32_t cmd;
32ce8569	85	char padding[USTCOMM_MSG_PADDING1];
67c5b804	86	union {
1ece9766	87	struct lttng_ust_channel channel;
381c0f1e	88	struct lttng_ust_stream stream;
1ece9766 MD	89	struct lttng_ust_event event;
1ece9766 MD	90	struct lttng_ust_context context;
57773204	91	struct lttng_ust_tracer_version version;
cbef6901	92	struct lttng_ust_tracepoint_iter tracepoint;
2d78951a	93	struct {
2734ca65 CB	94	uint32_t data_size; /* following filter data */
2734ca65 CB	95	uint32_t reloc_offset;
3f6fd224	96	uint64_t seqnum;
b3f60bbf	97	} LTTNG_PACKED filter;
75582b3a JI	98	struct {
	99	uint32_t count; /* how many names follow */
	100	} LTTNG_PACKED exclusion;
32ce8569	101	char padding[USTCOMM_MSG_PADDING2];
67c5b804	102	} u;
b3f60bbf	103	} LTTNG_PACKED;
67c5b804	104
9eb62b9c MD	105	/*
	106	* Data structure for the response from UST to the session daemon.
	107	* cmd_type is sent back in the reply for validation.
	108	*/
32ce8569 MD	109	#define USTCOMM_REPLY_PADDING1 32
32ce8569 MD	110	#define USTCOMM_REPLY_PADDING2 32
57773204	111	struct ustcomm_ust_reply {
46050b1a MD	112	uint32_t handle;
46050b1a MD	113	uint32_t cmd;
7f2348b8	114	int32_t ret_code; /* enum ustcomm_return_code */
1ece9766	115	uint32_t ret_val; /* return value */
32ce8569	116	char padding[USTCOMM_REPLY_PADDING1];
9eb62b9c	117	union {
193183fb MD	118	struct {
193183fb MD	119	uint64_t memory_map_size;
b3f60bbf	120	} LTTNG_PACKED channel;
381c0f1e MD	121	struct {
381c0f1e MD	122	uint64_t memory_map_size;
b3f60bbf	123	} LTTNG_PACKED stream;
57773204	124	struct lttng_ust_tracer_version version;
cbef6901	125	struct lttng_ust_tracepoint_iter tracepoint;
32ce8569	126	char padding[USTCOMM_REPLY_PADDING2];
9eb62b9c	127	} u;
b3f60bbf	128	} LTTNG_PACKED;
9eb62b9c	129
32ce8569 MD	130	struct ustcomm_notify_hdr {
	131	uint32_t notify_cmd;
	132	} LTTNG_PACKED;
	133
	134	#define USTCOMM_NOTIFY_EVENT_MSG_PADDING 32
	135	struct ustcomm_notify_event_msg {
	136	uint32_t session_objd;
	137	uint32_t channel_objd;
	138	char event_name[LTTNG_UST_SYM_NAME_LEN];
	139	int32_t loglevel;
	140	uint32_t signature_len;
	141	uint32_t fields_len;
	142	uint32_t model_emf_uri_len;
	143	char padding[USTCOMM_NOTIFY_EVENT_MSG_PADDING];
	144	/* followed by signature, fields, and model_emf_uri */
	145	} LTTNG_PACKED;
	146
	147	#define USTCOMM_NOTIFY_EVENT_REPLY_PADDING 32
	148	struct ustcomm_notify_event_reply {
	149	int32_t ret_code; /* 0: ok, negative: error code */
	150	uint32_t event_id;
	151	char padding[USTCOMM_NOTIFY_EVENT_REPLY_PADDING];
	152	} LTTNG_PACKED;
	153
c785c634 MD	154	#define USTCOMM_NOTIFY_ENUM_MSG_PADDING 32
	155	struct ustcomm_notify_enum_msg {
	156	uint32_t session_objd;
	157	char enum_name[LTTNG_UST_SYM_NAME_LEN];
	158	uint32_t entries_len;
	159	char padding[USTCOMM_NOTIFY_ENUM_MSG_PADDING];
	160	/* followed by enum entries */
	161	} LTTNG_PACKED;
	162
	163	#define USTCOMM_NOTIFY_EVENT_REPLY_PADDING 32
	164	struct ustcomm_notify_enum_reply {
	165	int32_t ret_code; /* 0: ok, negative: error code */
	166	uint64_t enum_id;
	167	char padding[USTCOMM_NOTIFY_EVENT_REPLY_PADDING];
	168	} LTTNG_PACKED;
	169
32ce8569 MD	170	#define USTCOMM_NOTIFY_CHANNEL_MSG_PADDING 32
	171	struct ustcomm_notify_channel_msg {
	172	uint32_t session_objd;
	173	uint32_t channel_objd;
	174	uint32_t ctx_fields_len;
	175	char padding[USTCOMM_NOTIFY_CHANNEL_MSG_PADDING];
	176	/* followed by context fields */
	177	} LTTNG_PACKED;
	178
	179	#define USTCOMM_NOTIFY_CHANNEL_REPLY_PADDING 32
	180	struct ustcomm_notify_channel_reply {
	181	int32_t ret_code; /* 0: ok, negative: error code */
	182	uint32_t chan_id;
	183	uint32_t header_type; /* enum ustctl_channel_header */
	184	char padding[USTCOMM_NOTIFY_CHANNEL_REPLY_PADDING];
	185	} LTTNG_PACKED;
	186
40003310 MD	187	/*
	188	* LTTNG_UST_TRACEPOINT_FIELD_LIST reply is followed by a
	189	* struct lttng_ust_field_iter field.
	190	*/
	191
57773204 MD	192	extern int ustcomm_create_unix_sock(const char *pathname);
	193	extern int ustcomm_connect_unix_sock(const char *pathname);
	194	extern int ustcomm_accept_unix_sock(int sock);
	195	extern int ustcomm_listen_unix_sock(int sock);
	196	extern int ustcomm_close_unix_sock(int sock);
74d81a6c	197
57773204	198	extern ssize_t ustcomm_recv_unix_sock(int sock, void *buf, size_t len);
32ce8569	199	extern ssize_t ustcomm_send_unix_sock(int sock, const void *buf, size_t len);
74d81a6c MD	200	extern ssize_t ustcomm_send_fds_unix_sock(int sock, int *fds, size_t nb_fd);
	201	extern ssize_t ustcomm_recv_fds_unix_sock(int sock, int *fds, size_t nb_fd);
	202
57773204 MD	203	extern const char *ustcomm_get_readable_code(int code);
	204	extern int ustcomm_send_app_msg(int sock, struct ustcomm_ust_msg *lum);
	205	extern int ustcomm_recv_app_reply(int sock, struct ustcomm_ust_reply *lur,
	206	uint32_t expected_handle, uint32_t expected_cmd);
	207	extern int ustcomm_send_app_cmd(int sock,
	208	struct ustcomm_ust_msg *lum,
	209	struct ustcomm_ust_reply *lur);
	210	int ustcomm_recv_fd(int sock);
67c5b804	211
74d81a6c	212	ssize_t ustcomm_recv_channel_from_sessiond(int sock,
ff0f5728	213	void *chan_data, uint64_t len, int wakeup_fd);
74d81a6c MD	214	int ustcomm_recv_stream_from_sessiond(int sock,
	215	uint64_t *memory_map_size,
	216	int shm_fd, int wakeup_fd);
	217
32ce8569 MD	218	/*
	219	* Returns 0 on success, negative error value on error.
	220	* Returns -EPIPE or -ECONNRESET if other end has hung up.
	221	*/
	222	int ustcomm_send_reg_msg(int sock,
	223	enum ustctl_socket_type type,
	224	uint32_t bits_per_long,
	225	uint32_t uint8_t_alignment,
	226	uint32_t uint16_t_alignment,
	227	uint32_t uint32_t_alignment,
	228	uint32_t uint64_t_alignment,
	229	uint32_t long_alignment);
	230
	231	/*
	232	* Returns 0 on success, negative error value on error.
	233	* Returns -EPIPE or -ECONNRESET if other end has hung up.
	234	*/
	235	int ustcomm_register_event(int sock,
c785c634	236	struct lttng_session *session,
32ce8569 MD	237	int session_objd, /* session descriptor */
	238	int channel_objd, /* channel descriptor */
	239	const char event_name, / event name (input) */
	240	int loglevel,
	241	const char signature, / event signature (input) */
	242	size_t nr_fields, /* fields */
	243	const struct lttng_event_field *fields,
	244	const char *model_emf_uri,
	245	uint32_t id); / event id (output) */
	246
c785c634 MD	247	/*
	248	* Returns 0 on success, negative error value on error.
	249	* Returns -EPIPE or -ECONNRESET if other end has hung up.
	250	*/
	251	int ustcomm_register_enum(int sock,
	252	int session_objd, /* session descriptor */
	253	const char enum_name, / enum name (input) */
	254	size_t nr_entries, /* entries */
	255	const struct lttng_enum_entry *entries,
	256	uint64_t id); / enum id (output) */
	257
32ce8569 MD	258	/*
	259	* Returns 0 on success, negative error value on error.
	260	* Returns -EPIPE or -ECONNRESET if other end has hung up.
	261	*/
	262	int ustcomm_register_channel(int sock,
	263	int session_objd, /* session descriptor */
	264	int channel_objd, /* channel descriptor */
	265	size_t nr_ctx_fields,
83e43212	266	const struct lttng_ctx_field *ctx_fields,
32ce8569 MD	267	uint32_t chan_id, / channel id (output) */
	268	int header_type); / header type (output) */
	269
ff517991 MD	270	int ustcomm_setsockopt_rcv_timeout(int sock, unsigned int msec);
	271	int ustcomm_setsockopt_snd_timeout(int sock, unsigned int msec);
	272
b35d179d	273	#endif /* _LTTNG_UST_COMM_H */