X-Git-Url: http://git.lttng.org/?p=ust.git;a=blobdiff_plain;f=libustcomm%2Fustcomm.h;h=4706b72fbb930eaf4d22e5d1ac11702fe627171a;hp=05d90ebc0f02c2bd2634024d6824f398b098e77b;hb=HEAD;hpb=393bc3911a4d704f85d6331aca2fb4a5b57b5e8a diff --git a/libustcomm/ustcomm.h b/libustcomm/ustcomm.h index 05d90eb..4706b72 100644 --- a/libustcomm/ustcomm.h +++ b/libustcomm/ustcomm.h @@ -20,69 +20,201 @@ #include #include +#include -#include "kcompat.h" +#include #define SOCK_DIR "/tmp/ust-app-socks" -#define UST_SIGNAL SIGIO +#define USER_TMP_DIR "/tmp" +#define USER_SOCK_DIR_BASE "ust-socks-" +#define USER_SOCK_DIR USER_TMP_DIR "/" USER_SOCK_DIR_BASE -struct ustcomm_connection { - struct list_head list; +struct ustcomm_sock { + struct cds_list_head list; int fd; - /* Data that has not yet been consumed: */ - char *recv_buf; - int recv_buf_size; - int recv_buf_alloc; + int epoll_fd; }; -/* ustcomm_server must be shallow-copyable */ -struct ustcomm_server { - /* the "server" socket for serving the external requests */ - int listen_fd; - char *socketpath; +struct ustcomm_header { + int command; + long size; + int result; + int fd_included; +}; + +#define USTCOMM_BUFFER_SIZE ((1 << 12) - sizeof(struct ustcomm_header)) - struct list_head connections; +/* 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_ustd { - struct ustcomm_server server; +struct ustcomm_single_field { + char *field; + char data[USTCOMM_DATA_SIZE]; }; -struct ustcomm_app { - struct ustcomm_server server; +struct ustcomm_channel_info { + char *trace; + char *channel; + unsigned int subbuf_size; + unsigned int subbuf_num; + char data[USTCOMM_DATA_SIZE]; }; -/* ustcomm_source must be shallow-copyable */ -struct ustcomm_source { - int fd; - void *priv; +struct ustcomm_buffer_info { + char *trace; + 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_ust_marker_info { + char *trace; + char *channel; + char *ust_marker; + char data[USTCOMM_DATA_SIZE]; +}; + +struct ustcomm_pidunique { + s64 pidunique; +}; + +struct ustcomm_notify_buf_mapped { + char data[USTCOMM_DATA_SIZE]; }; -extern char *strdup_malloc(const char *s); +/* Ensure directory existence, usefull for unix sockets */ +extern int ensure_dir_exists(const char *dir, mode_t mode); + +/* Create and delete sockets */ +extern struct ustcomm_sock * ustcomm_init_sock(int fd, int epoll_fd, + struct cds_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); -//int send_message_pid(pid_t pid, const char *msg, char **reply); extern int ustcomm_request_consumer(pid_t pid, const char *channel); -extern int ustcomm_ustd_recv_message(struct ustcomm_ustd *ustd, char **msg, struct ustcomm_source *src, int timeout); -extern int ustcomm_app_recv_message(struct ustcomm_app *app, char **msg, struct ustcomm_source *src, int timeout); +/* Returns the current users socket directory, must be freed */ +extern char *ustcomm_user_sock_dir(void); -extern int ustcomm_init_app(pid_t pid, struct ustcomm_app *handle); -extern void ustcomm_fini_app(struct ustcomm_app *handle); -extern void ustcomm_free_app(struct ustcomm_app *app); +/* Get the st_m_time from proc*/ +extern time_t ustcomm_pid_st_mtime(pid_t pid); -extern int ustcomm_init_ustd(struct ustcomm_ustd *handle, const char *sock_path); +/* Check that a socket is live */ +extern int ustcomm_is_socket_live(char *sock_name, pid_t *read_pid); -extern int ustcomm_connect_app(pid_t pid, struct ustcomm_connection *conn); -extern int ustcomm_connect_path(const char *path, struct ustcomm_connection *conn, pid_t signalpid); -extern int ustcomm_send_request(struct ustcomm_connection *conn, const char *req, char **reply); -extern int ustcomm_send_reply(struct ustcomm_server *server, char *msg, struct ustcomm_source *src); -extern int ustcomm_disconnect(struct ustcomm_connection *conn); -extern int ustcomm_close_all_connections(struct ustcomm_server *server); +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); -extern int pid_is_online(pid_t); +/* 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_single_field(struct ustcomm_header *header, + struct ustcomm_single_field *sf, + const char *trace); + +extern int ustcomm_unpack_single_field(struct ustcomm_single_field *sf); + +extern int ustcomm_pack_channel_info(struct ustcomm_header *header, + struct ustcomm_channel_info *ch_inf, + const char *trace, + 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 *trace, + const char *channel, + int channel_cpu); + +extern int ustcomm_unpack_buffer_info(struct ustcomm_buffer_info *buf_inf); + +extern int ustcomm_pack_ust_marker_info(struct ustcomm_header *header, + struct ustcomm_ust_marker_info *ust_marker_inf, + const char *trace, + const char *channel, + const char *ust_marker); + +extern int ustcomm_unpack_ust_marker_info(struct ustcomm_ust_marker_info *ust_marker_inf); #endif /* USTCOMM_H */