| 1 | /* |
| 2 | * Copyright (C) 2012 - David Goulet <dgoulet@efficios.com> |
| 3 | * |
| 4 | * This program is free software; you can redistribute it and/or modify it |
| 5 | * under the terms of the GNU General Public License, version 2 only, as |
| 6 | * published by the Free Software Foundation. |
| 7 | * |
| 8 | * This program is distributed in the hope that it will be useful, but WITHOUT |
| 9 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| 10 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for |
| 11 | * more details. |
| 12 | * |
| 13 | * You should have received a copy of the GNU General Public License along with |
| 14 | * this program; if not, write to the Free Software Foundation, Inc., 51 |
| 15 | * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. |
| 16 | */ |
| 17 | |
| 18 | #ifndef _CONSUMER_H |
| 19 | #define _CONSUMER_H |
| 20 | |
| 21 | #include <common/consumer.h> |
| 22 | #include <common/hashtable/hashtable.h> |
| 23 | #include <lttng/lttng.h> |
| 24 | |
| 25 | #include "health.h" |
| 26 | |
| 27 | enum consumer_dst_type { |
| 28 | CONSUMER_DST_LOCAL, |
| 29 | CONSUMER_DST_NET, |
| 30 | }; |
| 31 | |
| 32 | struct consumer_socket { |
| 33 | /* File descriptor */ |
| 34 | int fd; |
| 35 | /* |
| 36 | * To use this socket (send/recv), this lock MUST be acquired. |
| 37 | */ |
| 38 | pthread_mutex_t *lock; |
| 39 | |
| 40 | /* |
| 41 | * Indicates if the socket was registered by a third part |
| 42 | * (REGISTER_CONSUMER) or is the spawn consumer of the session daemon. |
| 43 | * During the destroy phase of a consumer output, we close the socket if |
| 44 | * this flag is set to 1 since we don't need the fd anymore. |
| 45 | */ |
| 46 | unsigned int registered; |
| 47 | |
| 48 | /* Flag if network sockets were sent to the consumer. */ |
| 49 | unsigned int control_sock_sent; |
| 50 | unsigned int data_sock_sent; |
| 51 | |
| 52 | struct lttng_ht_node_ulong node; |
| 53 | }; |
| 54 | |
| 55 | struct consumer_data { |
| 56 | enum lttng_consumer_type type; |
| 57 | |
| 58 | pthread_t thread; /* Worker thread interacting with the consumer */ |
| 59 | |
| 60 | /* Conditions used by the consumer thread to indicate readiness. */ |
| 61 | pthread_cond_t cond; |
| 62 | pthread_condattr_t condattr; |
| 63 | pthread_mutex_t cond_mutex; |
| 64 | |
| 65 | /* |
| 66 | * This is a flag condition indicating that the consumer thread is ready |
| 67 | * and connected to the lttng-consumerd daemon. This flag MUST only be |
| 68 | * updated by locking the condition mutex above or before spawning a |
| 69 | * consumer thread. |
| 70 | * |
| 71 | * A value of 0 means that the thread is NOT ready. A value of 1 means that |
| 72 | * the thread consumer did connect successfully to the lttng-consumerd |
| 73 | * daemon. A negative value indicates that there is been an error and the |
| 74 | * thread has likely quit. |
| 75 | */ |
| 76 | int consumer_thread_is_ready; |
| 77 | |
| 78 | /* Mutex to control consumerd pid assignation */ |
| 79 | pthread_mutex_t pid_mutex; |
| 80 | pid_t pid; |
| 81 | |
| 82 | int err_sock; |
| 83 | int cmd_sock; |
| 84 | |
| 85 | /* consumer error and command Unix socket path */ |
| 86 | char err_unix_sock_path[PATH_MAX]; |
| 87 | char cmd_unix_sock_path[PATH_MAX]; |
| 88 | |
| 89 | /* communication lock */ |
| 90 | pthread_mutex_t lock; |
| 91 | }; |
| 92 | |
| 93 | /* |
| 94 | * Network URIs |
| 95 | */ |
| 96 | struct consumer_net { |
| 97 | /* |
| 98 | * Indicate if URI type is set. Those flags should only be set when the |
| 99 | * created URI is done AND valid. |
| 100 | */ |
| 101 | int control_isset; |
| 102 | int data_isset; |
| 103 | |
| 104 | /* |
| 105 | * The following two URIs MUST have the same destination address for |
| 106 | * network streaming to work. Network hop are not yet supported. |
| 107 | */ |
| 108 | |
| 109 | /* Control path for network streaming. */ |
| 110 | struct lttng_uri control; |
| 111 | |
| 112 | /* Data path for network streaming. */ |
| 113 | struct lttng_uri data; |
| 114 | }; |
| 115 | |
| 116 | /* |
| 117 | * Consumer output object describing where and how to send data. |
| 118 | */ |
| 119 | struct consumer_output { |
| 120 | /* If the consumer is enabled meaning that should be used */ |
| 121 | unsigned int enabled; |
| 122 | enum consumer_dst_type type; |
| 123 | |
| 124 | /* |
| 125 | * The net_seq_index is the index of the network stream on the consumer |
| 126 | * side. It tells the consumer which streams goes to which relayd with this |
| 127 | * index. The relayd sockets are index with it on the consumer side. |
| 128 | */ |
| 129 | uint64_t net_seq_index; |
| 130 | |
| 131 | /* |
| 132 | * Subdirectory path name used for both local and network consumer. |
| 133 | */ |
| 134 | char subdir[PATH_MAX]; |
| 135 | |
| 136 | /* |
| 137 | * Hashtable of consumer_socket index by the file descriptor value. For |
| 138 | * multiarch consumer support, we can have more than one consumer (ex: 32 |
| 139 | * and 64 bit). |
| 140 | */ |
| 141 | struct lttng_ht *socks; |
| 142 | |
| 143 | union { |
| 144 | char trace_path[PATH_MAX]; |
| 145 | struct consumer_net net; |
| 146 | } dst; |
| 147 | }; |
| 148 | |
| 149 | struct consumer_socket *consumer_find_socket(int key, |
| 150 | struct consumer_output *consumer); |
| 151 | struct consumer_socket *consumer_allocate_socket(int fd); |
| 152 | void consumer_add_socket(struct consumer_socket *sock, |
| 153 | struct consumer_output *consumer); |
| 154 | void consumer_del_socket(struct consumer_socket *sock, |
| 155 | struct consumer_output *consumer); |
| 156 | void consumer_destroy_socket(struct consumer_socket *sock); |
| 157 | |
| 158 | struct consumer_output *consumer_create_output(enum consumer_dst_type type); |
| 159 | struct consumer_output *consumer_copy_output(struct consumer_output *obj); |
| 160 | void consumer_destroy_output(struct consumer_output *obj); |
| 161 | int consumer_set_network_uri(struct consumer_output *obj, |
| 162 | struct lttng_uri *uri); |
| 163 | int consumer_send_fds(struct consumer_socket *sock, int *fds, size_t nb_fd); |
| 164 | int consumer_send_msg(struct consumer_socket *sock, |
| 165 | struct lttcomm_consumer_msg *msg); |
| 166 | int consumer_send_stream(struct consumer_socket *sock, |
| 167 | struct consumer_output *dst, struct lttcomm_consumer_msg *msg, |
| 168 | int *fds, size_t nb_fd); |
| 169 | int consumer_send_channel(struct consumer_socket *sock, |
| 170 | struct lttcomm_consumer_msg *msg); |
| 171 | int consumer_send_relayd_socket(struct consumer_socket *consumer_sock, |
| 172 | struct lttcomm_sock *sock, struct consumer_output *consumer, |
| 173 | enum lttng_stream_type type, uint64_t session_id); |
| 174 | int consumer_send_destroy_relayd(struct consumer_socket *sock, |
| 175 | struct consumer_output *consumer); |
| 176 | int consumer_recv_status_reply(struct consumer_socket *sock); |
| 177 | int consumer_recv_status_channel(struct consumer_socket *sock, |
| 178 | uint64_t *key, unsigned int *stream_count); |
| 179 | void consumer_output_send_destroy_relayd(struct consumer_output *consumer); |
| 180 | int consumer_create_socket(struct consumer_data *data, |
| 181 | struct consumer_output *output); |
| 182 | int consumer_set_subdir(struct consumer_output *consumer, |
| 183 | const char *session_name); |
| 184 | |
| 185 | void consumer_init_ask_channel_comm_msg(struct lttcomm_consumer_msg *msg, |
| 186 | uint64_t subbuf_size, |
| 187 | uint64_t num_subbuf, |
| 188 | int overwrite, |
| 189 | unsigned int switch_timer_interval, |
| 190 | unsigned int read_timer_interval, |
| 191 | int output, |
| 192 | int type, |
| 193 | uint64_t session_id, |
| 194 | const char *pathname, |
| 195 | const char *name, |
| 196 | uid_t uid, |
| 197 | gid_t gid, |
| 198 | uint64_t relayd_id, |
| 199 | uint64_t key, |
| 200 | unsigned char *uuid); |
| 201 | void consumer_init_stream_comm_msg(struct lttcomm_consumer_msg *msg, |
| 202 | enum lttng_consumer_command cmd, |
| 203 | uint64_t channel_key, |
| 204 | uint64_t stream_key, |
| 205 | int cpu); |
| 206 | void consumer_init_channel_comm_msg(struct lttcomm_consumer_msg *msg, |
| 207 | enum lttng_consumer_command cmd, |
| 208 | uint64_t channel_key, |
| 209 | uint64_t session_id, |
| 210 | const char *pathname, |
| 211 | uid_t uid, |
| 212 | gid_t gid, |
| 213 | uint64_t relayd_id, |
| 214 | const char *name, |
| 215 | unsigned int nb_init_streams, |
| 216 | enum lttng_event_output output, |
| 217 | int type); |
| 218 | int consumer_is_data_pending(uint64_t session_id, |
| 219 | struct consumer_output *consumer); |
| 220 | |
| 221 | #endif /* _CONSUMER_H */ |