| 1 | #ifndef _LTTNG_UST_COMM_H |
| 2 | #define _LTTNG_UST_COMM_H |
| 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 | * |
| 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, |
| 15 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 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 |
| 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> |
| 30 | #include <unistd.h> |
| 31 | #include <lttng/ust-abi.h> |
| 32 | #include <lttng/ust-error.h> |
| 33 | #include <lttng/ust-compiler.h> |
| 34 | #include <config.h> |
| 35 | |
| 36 | /* |
| 37 | * Default timeout the application waits for the sessiond to send its |
| 38 | * "register done" command. Can be overridden with the environment |
| 39 | * variable "LTTNG_UST_REGISTER_TIMEOUT". Note that if the sessiond is not |
| 40 | * found, the application proceeds directly without any delay. |
| 41 | */ |
| 42 | #define LTTNG_UST_DEFAULT_CONSTRUCTOR_TIMEOUT_MS 3000 |
| 43 | |
| 44 | #define LTTNG_DEFAULT_RUNDIR LTTNG_SYSTEM_RUNDIR |
| 45 | #define LTTNG_DEFAULT_HOME_RUNDIR ".lttng" |
| 46 | |
| 47 | /* Queue size of listen(2) */ |
| 48 | #define LTTNG_UST_COMM_MAX_LISTEN 10 |
| 49 | #define LTTNG_UST_COMM_REG_MSG_PADDING 64 |
| 50 | |
| 51 | struct lttng_event_field; |
| 52 | struct lttng_ctx_field; |
| 53 | |
| 54 | struct ustctl_reg_msg { |
| 55 | uint32_t magic; |
| 56 | uint32_t major; |
| 57 | uint32_t minor; |
| 58 | uint32_t pid; |
| 59 | uint32_t ppid; |
| 60 | uint32_t uid; |
| 61 | uint32_t gid; |
| 62 | uint32_t bits_per_long; |
| 63 | uint32_t uint8_t_alignment; |
| 64 | uint32_t uint16_t_alignment; |
| 65 | uint32_t uint32_t_alignment; |
| 66 | uint32_t uint64_t_alignment; |
| 67 | uint32_t long_alignment; |
| 68 | uint32_t socket_type; /* enum ustctl_socket_type */ |
| 69 | char name[LTTNG_UST_ABI_PROCNAME_LEN]; /* process name */ |
| 70 | char padding[LTTNG_UST_COMM_REG_MSG_PADDING]; |
| 71 | } LTTNG_PACKED; |
| 72 | |
| 73 | /* |
| 74 | * Data structure for the commands sent from sessiond to UST. |
| 75 | */ |
| 76 | #define USTCOMM_MSG_PADDING1 32 |
| 77 | #define USTCOMM_MSG_PADDING2 32 |
| 78 | struct ustcomm_ust_msg { |
| 79 | uint32_t handle; |
| 80 | uint32_t cmd; |
| 81 | char padding[USTCOMM_MSG_PADDING1]; |
| 82 | union { |
| 83 | struct lttng_ust_channel channel; |
| 84 | struct lttng_ust_stream stream; |
| 85 | struct lttng_ust_event event; |
| 86 | struct lttng_ust_context context; |
| 87 | struct lttng_ust_tracer_version version; |
| 88 | struct lttng_ust_tracepoint_iter tracepoint; |
| 89 | struct { |
| 90 | uint32_t data_size; /* following filter data */ |
| 91 | uint32_t reloc_offset; |
| 92 | uint64_t seqnum; |
| 93 | } LTTNG_PACKED filter; |
| 94 | struct { |
| 95 | uint32_t count; /* how many names follow */ |
| 96 | } LTTNG_PACKED exclusion; |
| 97 | char padding[USTCOMM_MSG_PADDING2]; |
| 98 | } u; |
| 99 | } LTTNG_PACKED; |
| 100 | |
| 101 | /* |
| 102 | * Data structure for the response from UST to the session daemon. |
| 103 | * cmd_type is sent back in the reply for validation. |
| 104 | */ |
| 105 | #define USTCOMM_REPLY_PADDING1 32 |
| 106 | #define USTCOMM_REPLY_PADDING2 32 |
| 107 | struct ustcomm_ust_reply { |
| 108 | uint32_t handle; |
| 109 | uint32_t cmd; |
| 110 | int32_t ret_code; /* enum ustcomm_return_code */ |
| 111 | uint32_t ret_val; /* return value */ |
| 112 | char padding[USTCOMM_REPLY_PADDING1]; |
| 113 | union { |
| 114 | struct { |
| 115 | uint64_t memory_map_size; |
| 116 | } LTTNG_PACKED channel; |
| 117 | struct { |
| 118 | uint64_t memory_map_size; |
| 119 | } LTTNG_PACKED stream; |
| 120 | struct lttng_ust_tracer_version version; |
| 121 | struct lttng_ust_tracepoint_iter tracepoint; |
| 122 | char padding[USTCOMM_REPLY_PADDING2]; |
| 123 | } u; |
| 124 | } LTTNG_PACKED; |
| 125 | |
| 126 | struct ustcomm_notify_hdr { |
| 127 | uint32_t notify_cmd; |
| 128 | } LTTNG_PACKED; |
| 129 | |
| 130 | #define USTCOMM_NOTIFY_EVENT_MSG_PADDING 32 |
| 131 | struct ustcomm_notify_event_msg { |
| 132 | uint32_t session_objd; |
| 133 | uint32_t channel_objd; |
| 134 | char event_name[LTTNG_UST_SYM_NAME_LEN]; |
| 135 | int32_t loglevel; |
| 136 | uint32_t signature_len; |
| 137 | uint32_t fields_len; |
| 138 | uint32_t model_emf_uri_len; |
| 139 | char padding[USTCOMM_NOTIFY_EVENT_MSG_PADDING]; |
| 140 | /* followed by signature, fields, and model_emf_uri */ |
| 141 | } LTTNG_PACKED; |
| 142 | |
| 143 | #define USTCOMM_NOTIFY_EVENT_REPLY_PADDING 32 |
| 144 | struct ustcomm_notify_event_reply { |
| 145 | int32_t ret_code; /* 0: ok, negative: error code */ |
| 146 | uint32_t event_id; |
| 147 | char padding[USTCOMM_NOTIFY_EVENT_REPLY_PADDING]; |
| 148 | } LTTNG_PACKED; |
| 149 | |
| 150 | #define USTCOMM_NOTIFY_CHANNEL_MSG_PADDING 32 |
| 151 | struct ustcomm_notify_channel_msg { |
| 152 | uint32_t session_objd; |
| 153 | uint32_t channel_objd; |
| 154 | uint32_t ctx_fields_len; |
| 155 | char padding[USTCOMM_NOTIFY_CHANNEL_MSG_PADDING]; |
| 156 | /* followed by context fields */ |
| 157 | } LTTNG_PACKED; |
| 158 | |
| 159 | #define USTCOMM_NOTIFY_CHANNEL_REPLY_PADDING 32 |
| 160 | struct ustcomm_notify_channel_reply { |
| 161 | int32_t ret_code; /* 0: ok, negative: error code */ |
| 162 | uint32_t chan_id; |
| 163 | uint32_t header_type; /* enum ustctl_channel_header */ |
| 164 | char padding[USTCOMM_NOTIFY_CHANNEL_REPLY_PADDING]; |
| 165 | } LTTNG_PACKED; |
| 166 | |
| 167 | /* |
| 168 | * LTTNG_UST_TRACEPOINT_FIELD_LIST reply is followed by a |
| 169 | * struct lttng_ust_field_iter field. |
| 170 | */ |
| 171 | |
| 172 | extern int ustcomm_create_unix_sock(const char *pathname); |
| 173 | extern int ustcomm_connect_unix_sock(const char *pathname); |
| 174 | extern int ustcomm_accept_unix_sock(int sock); |
| 175 | extern int ustcomm_listen_unix_sock(int sock); |
| 176 | extern int ustcomm_close_unix_sock(int sock); |
| 177 | |
| 178 | extern ssize_t ustcomm_recv_unix_sock(int sock, void *buf, size_t len); |
| 179 | extern ssize_t ustcomm_send_unix_sock(int sock, const void *buf, size_t len); |
| 180 | extern ssize_t ustcomm_send_fds_unix_sock(int sock, int *fds, size_t nb_fd); |
| 181 | extern ssize_t ustcomm_recv_fds_unix_sock(int sock, int *fds, size_t nb_fd); |
| 182 | |
| 183 | extern const char *ustcomm_get_readable_code(int code); |
| 184 | extern int ustcomm_send_app_msg(int sock, struct ustcomm_ust_msg *lum); |
| 185 | extern int ustcomm_recv_app_reply(int sock, struct ustcomm_ust_reply *lur, |
| 186 | uint32_t expected_handle, uint32_t expected_cmd); |
| 187 | extern int ustcomm_send_app_cmd(int sock, |
| 188 | struct ustcomm_ust_msg *lum, |
| 189 | struct ustcomm_ust_reply *lur); |
| 190 | int ustcomm_recv_fd(int sock); |
| 191 | |
| 192 | ssize_t ustcomm_recv_channel_from_sessiond(int sock, |
| 193 | void **chan_data, uint64_t len, int *wakeup_fd); |
| 194 | int ustcomm_recv_stream_from_sessiond(int sock, |
| 195 | uint64_t *memory_map_size, |
| 196 | int *shm_fd, int *wakeup_fd); |
| 197 | |
| 198 | /* |
| 199 | * Returns 0 on success, negative error value on error. |
| 200 | * Returns -EPIPE or -ECONNRESET if other end has hung up. |
| 201 | */ |
| 202 | int ustcomm_send_reg_msg(int sock, |
| 203 | enum ustctl_socket_type type, |
| 204 | uint32_t bits_per_long, |
| 205 | uint32_t uint8_t_alignment, |
| 206 | uint32_t uint16_t_alignment, |
| 207 | uint32_t uint32_t_alignment, |
| 208 | uint32_t uint64_t_alignment, |
| 209 | uint32_t long_alignment); |
| 210 | |
| 211 | /* |
| 212 | * Returns 0 on success, negative error value on error. |
| 213 | * Returns -EPIPE or -ECONNRESET if other end has hung up. |
| 214 | */ |
| 215 | int ustcomm_register_event(int sock, |
| 216 | int session_objd, /* session descriptor */ |
| 217 | int channel_objd, /* channel descriptor */ |
| 218 | const char *event_name, /* event name (input) */ |
| 219 | int loglevel, |
| 220 | const char *signature, /* event signature (input) */ |
| 221 | size_t nr_fields, /* fields */ |
| 222 | const struct lttng_event_field *fields, |
| 223 | const char *model_emf_uri, |
| 224 | uint32_t *id); /* event id (output) */ |
| 225 | |
| 226 | /* |
| 227 | * Returns 0 on success, negative error value on error. |
| 228 | * Returns -EPIPE or -ECONNRESET if other end has hung up. |
| 229 | */ |
| 230 | int ustcomm_register_channel(int sock, |
| 231 | int session_objd, /* session descriptor */ |
| 232 | int channel_objd, /* channel descriptor */ |
| 233 | size_t nr_ctx_fields, |
| 234 | const struct lttng_ctx_field *ctx_fields, |
| 235 | uint32_t *chan_id, /* channel id (output) */ |
| 236 | int *header_type); /* header type (output) */ |
| 237 | |
| 238 | int ustcomm_setsockopt_rcv_timeout(int sock, unsigned int msec); |
| 239 | int ustcomm_setsockopt_snd_timeout(int sock, unsigned int msec); |
| 240 | |
| 241 | #endif /* _LTTNG_UST_COMM_H */ |