[ust.git] / libustcomm / ustcomm.h

/* Copyright (C) 2009  Pierre-Marc Fournier
 *
 * 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; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * 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
 */

#ifndef USTCOMM_H
#define USTCOMM_H

#include <sys/types.h>
#include <sys/un.h>
#include <urcu/list.h>

#include <ust/kcompat/kcompat.h>

#define SOCK_DIR "/tmp/ust-app-socks"

struct ustcomm_sock {
	struct list_head list;
	int fd;
	int epoll_fd;
};

struct ustcomm_header {
	int command;
	long size;
	int result;
	int fd_included;
};

#define USTCOMM_BUFFER_SIZE ((1 << 12) - sizeof(struct ustcomm_header))

/* Specify a sata size that leaves margin at the end of a buffer
 * in order to make sure that we never have more data than
 * will fit in the buffer AND that the last chars (due to a
 * pre-receive memset) will always be 0, terminating any string
 */
#define USTCOMM_DATA_SIZE (USTCOMM_BUFFER_SIZE - 20 * sizeof(void *))

enum tracectl_commands {
	ALLOC_TRACE,
	CONSUME_BUFFER,
	CREATE_TRACE,
	DESTROY_TRACE,
	DISABLE_MARKER,
	ENABLE_MARKER,
	EXIT,
	FORCE_SUBBUF_SWITCH,
	GET_BUF_SHMID_PIPE_FD,
	GET_PIDUNIQUE,
	GET_SOCK_PATH,
	GET_SUBBUFFER,
	GET_SUBBUF_NUM_SIZE,
	LIST_MARKERS,
	LIST_TRACE_EVENTS,
	LOAD_PROBE_LIB,
	NOTIFY_BUF_MAPPED,
	PRINT_MARKERS,
	PRINT_TRACE_EVENTS,
	PUT_SUBBUFFER,
	SETUP_TRACE,
	SET_SOCK_PATH,
	SET_SUBBUF_NUM,
	SET_SUBBUF_SIZE,
	START,
	START_TRACE,
	STOP_TRACE,
};

struct ustcomm_channel_info {
	char *channel;
	unsigned int subbuf_size;
	unsigned int subbuf_num;
	char data[USTCOMM_DATA_SIZE];
};

struct ustcomm_buffer_info {
	char *channel;
	int ch_cpu;
	pid_t pid;
	int buf_shmid;
	int buf_struct_shmid;
	long consumed_old;
	char data[USTCOMM_DATA_SIZE];
};

struct ustcomm_marker_info {
	char *channel;
	char *marker;
	char data[USTCOMM_DATA_SIZE];
};

struct ustcomm_sock_path {
	char *sock_path;
	char data[USTCOMM_DATA_SIZE];
};

struct ustcomm_pidunique {
	s64 pidunique;
};

struct ustcomm_notify_buf_mapped {
	char data[USTCOMM_DATA_SIZE];
};

/* Ensure directory existence, usefull for unix sockets */
extern int ensure_dir_exists(const char *dir);

/* Create and delete sockets */
extern struct ustcomm_sock * ustcomm_init_sock(int fd, int epoll_fd,
					       struct list_head *list);
extern void ustcomm_del_sock(struct ustcomm_sock *sock, int keep_in_epoll);

/* Create and delete named sockets */
extern struct ustcomm_sock * ustcomm_init_named_socket(const char *name,
						       int epoll_fd);
extern void ustcomm_del_named_sock(struct ustcomm_sock *sock,
				   int keep_socket_file);

/* Send and receive functions for file descriptors */
extern int ustcomm_send_fd(int sock, const struct ustcomm_header *header,
			   const char *data, int *fd);
extern int ustcomm_recv_fd(int sock, struct ustcomm_header *header,
			   char *data, int *fd);

/* Normal send and receive functions */
extern int ustcomm_send(int sock, const struct ustcomm_header *header,
			const char *data);
extern int ustcomm_recv(int sock, struct ustcomm_header *header,
			char *data);

/* Receive and allocate data, not to be used inside libust */
extern int ustcomm_recv_alloc(int sock,
			      struct ustcomm_header *header,
			      char **data);

/* Request function, send and receive */
extern int ustcomm_req(int sock,
		       const struct ustcomm_header *req_header,
		       const char *req_data,
		       struct ustcomm_header *res_header,
		       char *res_data);

extern int ustcomm_request_consumer(pid_t pid, const char *channel);
extern int ustcomm_connect_app(pid_t pid, int *app_fd);
extern int ustcomm_connect_path(const char *path, int *connection_fd);

extern int nth_token_is(const char *str, const char *token, int tok_no);

extern char *nth_token(const char *str, int tok_no);

/* String serialising functions, printf straight into a buffer */
#define USTCOMM_POISON_PTR (void *)0x19831018

extern char * ustcomm_print_data(char *data_field, int field_size,
				 int *offset, const char *format, ...);
extern char * ustcomm_restore_ptr(char *ptr, char *data_field,
				  int data_field_size);

#define COMPUTE_MSG_SIZE(struct_ptr, offset)				\
	(size_t) (long)(struct_ptr)->data - (long)(struct_ptr) + (offset)

/* Packing and unpacking functions, making life easier */
extern int ustcomm_pack_channel_info(struct ustcomm_header *header,
				     struct ustcomm_channel_info *ch_inf,
				     const char *channel);

extern int ustcomm_unpack_channel_info(struct ustcomm_channel_info *ch_inf);

extern int ustcomm_pack_buffer_info(struct ustcomm_header *header,
				    struct ustcomm_buffer_info *buf_inf,
				    const char *channel,
				    int channel_cpu);

extern int ustcomm_unpack_buffer_info(struct ustcomm_buffer_info *buf_inf);

extern int ustcomm_pack_marker_info(struct ustcomm_header *header,
				    struct ustcomm_marker_info *marker_inf,
				    const char *channel,
				    const char *marker);

extern int ustcomm_unpack_marker_info(struct ustcomm_marker_info *marker_inf);


extern int ustcomm_pack_sock_path(struct ustcomm_header *header,
				  struct ustcomm_sock_path *sock_path_inf,
				  const char *socket_path);

extern int ustcomm_unpack_sock_path(struct ustcomm_sock_path *sock_path_inf);

/* Packing and requesting functions */
extern int ustcomm_send_ch_req(int sock, char *channel, int command,
			       struct ustcomm_header *recv_header,
			       char *recv_data);

extern int ustcomm_send_buf_req(int sock, char *channel, int ch_cpu,
				int command,
				struct ustcomm_header *recv_header,
				char *recv_data);

#endif /* USTCOMM_H */
Commit	Line	Data
	1	/* Copyright (C) 2009 Pierre-Marc Fournier
	2	*
	3	* This library is free software; you can redistribute it and/or
	4	* modify it under the terms of the GNU Lesser General Public
	5	* License as published by the Free Software Foundation; either
	6	* version 2.1 of the License, or (at your option) any later version.
	7	*
	8	* This library is distributed in the hope that it will be useful,
	9	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	10	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	11	* Lesser General Public License for more details.
	12	*
	13	* You should have received a copy of the GNU Lesser General Public
	14	* License along with this library; if not, write to the Free Software
	15	* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
	16	*/
	17
	18	#ifndef USTCOMM_H
	19	#define USTCOMM_H
	20
	21	#include <sys/types.h>
	22	#include <sys/un.h>
	23	#include <urcu/list.h>
	24
	25	#include <ust/kcompat/kcompat.h>
	26
	27	#define SOCK_DIR "/tmp/ust-app-socks"
	28
	29	struct ustcomm_sock {
	30	struct list_head list;
	31	int fd;
	32	int epoll_fd;
	33	};
	34
	35	struct ustcomm_header {
	36	int command;
	37	long size;
	38	int result;
	39	int fd_included;
	40	};
	41
	42	#define USTCOMM_BUFFER_SIZE ((1 << 12) - sizeof(struct ustcomm_header))
	43
	44	/* Specify a sata size that leaves margin at the end of a buffer
	45	* in order to make sure that we never have more data than
	46	* will fit in the buffer AND that the last chars (due to a
	47	* pre-receive memset) will always be 0, terminating any string
	48	*/
	49	#define USTCOMM_DATA_SIZE (USTCOMM_BUFFER_SIZE - 20 * sizeof(void *))
	50
	51	enum tracectl_commands {
	52	ALLOC_TRACE,
	53	CONSUME_BUFFER,
	54	CREATE_TRACE,
	55	DESTROY_TRACE,
	56	DISABLE_MARKER,
	57	ENABLE_MARKER,
	58	EXIT,
	59	FORCE_SUBBUF_SWITCH,
	60	GET_BUF_SHMID_PIPE_FD,
	61	GET_PIDUNIQUE,
	62	GET_SOCK_PATH,
	63	GET_SUBBUFFER,
	64	GET_SUBBUF_NUM_SIZE,
	65	LIST_MARKERS,
	66	LIST_TRACE_EVENTS,
	67	LOAD_PROBE_LIB,
	68	NOTIFY_BUF_MAPPED,
	69	PRINT_MARKERS,
	70	PRINT_TRACE_EVENTS,
	71	PUT_SUBBUFFER,
	72	SETUP_TRACE,
	73	SET_SOCK_PATH,
	74	SET_SUBBUF_NUM,
	75	SET_SUBBUF_SIZE,
	76	START,
	77	START_TRACE,
	78	STOP_TRACE,
	79	};
	80
	81	struct ustcomm_channel_info {
	82	char *channel;
	83	unsigned int subbuf_size;
	84	unsigned int subbuf_num;
	85	char data[USTCOMM_DATA_SIZE];
	86	};
	87
	88	struct ustcomm_buffer_info {
	89	char *channel;
	90	int ch_cpu;
	91	pid_t pid;
	92	int buf_shmid;
	93	int buf_struct_shmid;
	94	long consumed_old;
	95	char data[USTCOMM_DATA_SIZE];
	96	};
	97
	98	struct ustcomm_marker_info {
	99	char *channel;
	100	char *marker;
	101	char data[USTCOMM_DATA_SIZE];
	102	};
	103
	104	struct ustcomm_sock_path {
	105	char *sock_path;
	106	char data[USTCOMM_DATA_SIZE];
	107	};
	108
	109	struct ustcomm_pidunique {
	110	s64 pidunique;
	111	};
	112
	113	struct ustcomm_notify_buf_mapped {
	114	char data[USTCOMM_DATA_SIZE];
	115	};
	116
	117	/* Ensure directory existence, usefull for unix sockets */
	118	extern int ensure_dir_exists(const char *dir);
	119
	120	/* Create and delete sockets */
	121	extern struct ustcomm_sock * ustcomm_init_sock(int fd, int epoll_fd,
	122	struct list_head *list);
	123	extern void ustcomm_del_sock(struct ustcomm_sock *sock, int keep_in_epoll);
	124
	125	/* Create and delete named sockets */
	126	extern struct ustcomm_sock * ustcomm_init_named_socket(const char *name,
	127	int epoll_fd);
	128	extern void ustcomm_del_named_sock(struct ustcomm_sock *sock,
	129	int keep_socket_file);
	130
	131	/* Send and receive functions for file descriptors */
	132	extern int ustcomm_send_fd(int sock, const struct ustcomm_header *header,
	133	const char data, int fd);
	134	extern int ustcomm_recv_fd(int sock, struct ustcomm_header *header,
	135	char data, int fd);
	136
	137	/* Normal send and receive functions */
	138	extern int ustcomm_send(int sock, const struct ustcomm_header *header,
	139	const char *data);
	140	extern int ustcomm_recv(int sock, struct ustcomm_header *header,
	141	char *data);
	142
	143	/* Receive and allocate data, not to be used inside libust */
	144	extern int ustcomm_recv_alloc(int sock,
	145	struct ustcomm_header *header,
	146	char **data);
	147
	148	/* Request function, send and receive */
	149	extern int ustcomm_req(int sock,
	150	const struct ustcomm_header *req_header,
	151	const char *req_data,
	152	struct ustcomm_header *res_header,
	153	char *res_data);
	154
	155	extern int ustcomm_request_consumer(pid_t pid, const char *channel);
	156	extern int ustcomm_connect_app(pid_t pid, int *app_fd);
	157	extern int ustcomm_connect_path(const char path, int connection_fd);
	158
	159	extern int nth_token_is(const char str, const char token, int tok_no);
	160
	161	extern char nth_token(const char str, int tok_no);
	162
	163	/* String serialising functions, printf straight into a buffer */
	164	#define USTCOMM_POISON_PTR (void *)0x19831018
	165
	166	extern char * ustcomm_print_data(char *data_field, int field_size,
	167	int offset, const char format, ...);
	168	extern char * ustcomm_restore_ptr(char ptr, char data_field,
	169	int data_field_size);
	170
	171	#define COMPUTE_MSG_SIZE(struct_ptr, offset) \
	172	(size_t) (long)(struct_ptr)->data - (long)(struct_ptr) + (offset)
	173
	174	/* Packing and unpacking functions, making life easier */
	175	extern int ustcomm_pack_channel_info(struct ustcomm_header *header,
	176	struct ustcomm_channel_info *ch_inf,
	177	const char *channel);
	178
	179	extern int ustcomm_unpack_channel_info(struct ustcomm_channel_info *ch_inf);
	180
	181	extern int ustcomm_pack_buffer_info(struct ustcomm_header *header,
	182	struct ustcomm_buffer_info *buf_inf,
	183	const char *channel,
	184	int channel_cpu);
	185
	186	extern int ustcomm_unpack_buffer_info(struct ustcomm_buffer_info *buf_inf);
	187
	188	extern int ustcomm_pack_marker_info(struct ustcomm_header *header,
	189	struct ustcomm_marker_info *marker_inf,
	190	const char *channel,
	191	const char *marker);
	192
	193	extern int ustcomm_unpack_marker_info(struct ustcomm_marker_info *marker_inf);
	194
	195
	196	extern int ustcomm_pack_sock_path(struct ustcomm_header *header,
	197	struct ustcomm_sock_path *sock_path_inf,
	198	const char *socket_path);
	199
	200	extern int ustcomm_unpack_sock_path(struct ustcomm_sock_path *sock_path_inf);
	201
	202	/* Packing and requesting functions */
	203	extern int ustcomm_send_ch_req(int sock, char *channel, int command,
	204	struct ustcomm_header *recv_header,
	205	char *recv_data);
	206
	207	extern int ustcomm_send_buf_req(int sock, char *channel, int ch_cpu,
	208	int command,
	209	struct ustcomm_header *recv_header,
	210	char *recv_data);
	211
	212	#endif /* USTCOMM_H */