| 1 | /* |
| 2 | * Copyright (C) 2011 EfficiOS Inc. |
| 3 | * Copyright (C) 2011 Mathieu Desnoyers <mathieu.desnoyers@efficios.com> |
| 4 | * Copyright (C) 2013 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
| 5 | * |
| 6 | * SPDX-License-Identifier: GPL-2.0-only |
| 7 | * |
| 8 | */ |
| 9 | |
| 10 | #include "manage-apps.hpp" |
| 11 | #include "testpoint.hpp" |
| 12 | #include "health-sessiond.hpp" |
| 13 | #include "utils.hpp" |
| 14 | #include "thread.hpp" |
| 15 | |
| 16 | namespace { |
| 17 | struct thread_notifiers { |
| 18 | struct lttng_pipe *quit_pipe; |
| 19 | int apps_cmd_pipe_read_fd; |
| 20 | }; |
| 21 | } /* namespace */ |
| 22 | |
| 23 | static void cleanup_application_management_thread(void *data) |
| 24 | { |
| 25 | struct thread_notifiers *notifiers = (thread_notifiers *) data; |
| 26 | |
| 27 | lttng_pipe_destroy(notifiers->quit_pipe); |
| 28 | free(notifiers); |
| 29 | } |
| 30 | |
| 31 | /* |
| 32 | * This thread receives application command sockets (FDs) on the |
| 33 | * apps_cmd_pipe and waits (polls) on them until they are closed |
| 34 | * or an error occurs. |
| 35 | * |
| 36 | * At that point, it flushes the data (tracing and metadata) associated |
| 37 | * with this application and tears down ust app sessions and other |
| 38 | * associated data structures through ust_app_unregister(). |
| 39 | * |
| 40 | * Note that this thread never sends commands to the applications |
| 41 | * through the command sockets; it merely listens for hang-ups |
| 42 | * and errors on those sockets and cleans-up as they occur. |
| 43 | */ |
| 44 | static void *thread_application_management(void *data) |
| 45 | { |
| 46 | int i, ret, err = -1; |
| 47 | ssize_t size_ret; |
| 48 | uint32_t nb_fd; |
| 49 | struct lttng_poll_event events; |
| 50 | struct thread_notifiers *notifiers = (thread_notifiers *) data; |
| 51 | const auto thread_quit_pipe_fd = lttng_pipe_get_readfd( |
| 52 | notifiers->quit_pipe); |
| 53 | |
| 54 | DBG("[thread] Manage application started"); |
| 55 | |
| 56 | rcu_register_thread(); |
| 57 | rcu_thread_online(); |
| 58 | |
| 59 | health_register(the_health_sessiond, HEALTH_SESSIOND_TYPE_APP_MANAGE); |
| 60 | |
| 61 | if (testpoint(sessiond_thread_manage_apps)) { |
| 62 | goto error_testpoint; |
| 63 | } |
| 64 | |
| 65 | health_code_update(); |
| 66 | |
| 67 | ret = lttng_poll_create(&events, 2, LTTNG_CLOEXEC); |
| 68 | if (ret < 0) { |
| 69 | goto error_poll_create; |
| 70 | } |
| 71 | |
| 72 | ret = lttng_poll_add(&events, notifiers->apps_cmd_pipe_read_fd, |
| 73 | LPOLLIN | LPOLLRDHUP); |
| 74 | if (ret < 0) { |
| 75 | goto error; |
| 76 | } |
| 77 | |
| 78 | ret = lttng_poll_add(&events, thread_quit_pipe_fd, LPOLLIN | LPOLLERR); |
| 79 | if (ret < 0) { |
| 80 | goto error; |
| 81 | } |
| 82 | |
| 83 | if (testpoint(sessiond_thread_manage_apps_before_loop)) { |
| 84 | goto error; |
| 85 | } |
| 86 | |
| 87 | health_code_update(); |
| 88 | |
| 89 | while (1) { |
| 90 | DBG("Apps thread polling"); |
| 91 | |
| 92 | /* Inifinite blocking call, waiting for transmission */ |
| 93 | restart: |
| 94 | health_poll_entry(); |
| 95 | ret = lttng_poll_wait(&events, -1); |
| 96 | DBG("Apps thread return from poll on %d fds", |
| 97 | LTTNG_POLL_GETNB(&events)); |
| 98 | health_poll_exit(); |
| 99 | if (ret < 0) { |
| 100 | /* |
| 101 | * Restart interrupted system call. |
| 102 | */ |
| 103 | if (errno == EINTR) { |
| 104 | goto restart; |
| 105 | } |
| 106 | goto error; |
| 107 | } |
| 108 | |
| 109 | nb_fd = ret; |
| 110 | |
| 111 | for (i = 0; i < nb_fd; i++) { |
| 112 | /* Fetch once the poll data */ |
| 113 | const auto revents = LTTNG_POLL_GETEV(&events, i); |
| 114 | const auto pollfd = LTTNG_POLL_GETFD(&events, i); |
| 115 | |
| 116 | health_code_update(); |
| 117 | |
| 118 | /* Activity on thread quit pipe, exiting. */ |
| 119 | if (pollfd == thread_quit_pipe_fd) { |
| 120 | DBG("Activity on thread quit pipe"); |
| 121 | err = 0; |
| 122 | goto exit; |
| 123 | } |
| 124 | |
| 125 | if (pollfd == notifiers->apps_cmd_pipe_read_fd) { |
| 126 | /* Inspect the apps cmd pipe */ |
| 127 | if (revents & LPOLLIN) { |
| 128 | int sock; |
| 129 | |
| 130 | /* Empty pipe */ |
| 131 | size_ret = lttng_read( |
| 132 | notifiers->apps_cmd_pipe_read_fd, |
| 133 | &sock, sizeof(sock)); |
| 134 | if (size_ret < sizeof(sock)) { |
| 135 | PERROR("read apps cmd pipe"); |
| 136 | goto error; |
| 137 | } |
| 138 | |
| 139 | health_code_update(); |
| 140 | |
| 141 | /* |
| 142 | * Since this is a command socket (write then read), |
| 143 | * we only monitor the error events of the socket. |
| 144 | */ |
| 145 | ret = lttng_poll_add(&events, sock, |
| 146 | LPOLLERR | LPOLLHUP | LPOLLRDHUP); |
| 147 | if (ret < 0) { |
| 148 | goto error; |
| 149 | } |
| 150 | |
| 151 | DBG("Apps with sock %d added to poll set", sock); |
| 152 | } else if (revents & (LPOLLERR | LPOLLHUP | LPOLLRDHUP)) { |
| 153 | ERR("Apps command pipe error"); |
| 154 | goto error; |
| 155 | } else { |
| 156 | ERR("Unknown poll events %u for sock %d", revents, pollfd); |
| 157 | goto error; |
| 158 | } |
| 159 | } else { |
| 160 | /* |
| 161 | * At this point, we know that a registered application made |
| 162 | * the event at poll_wait. |
| 163 | */ |
| 164 | if (revents & (LPOLLERR | LPOLLHUP | LPOLLRDHUP)) { |
| 165 | /* Removing from the poll set */ |
| 166 | ret = lttng_poll_del(&events, pollfd); |
| 167 | if (ret < 0) { |
| 168 | goto error; |
| 169 | } |
| 170 | |
| 171 | /* Socket closed on remote end. */ |
| 172 | ust_app_unregister(pollfd); |
| 173 | } else { |
| 174 | ERR("Unexpected poll events %u for sock %d", revents, pollfd); |
| 175 | goto error; |
| 176 | } |
| 177 | } |
| 178 | |
| 179 | health_code_update(); |
| 180 | } |
| 181 | } |
| 182 | |
| 183 | exit: |
| 184 | error: |
| 185 | lttng_poll_clean(&events); |
| 186 | error_poll_create: |
| 187 | error_testpoint: |
| 188 | |
| 189 | /* |
| 190 | * We don't clean the UST app hash table here since already registered |
| 191 | * applications can still be controlled so let them be until the session |
| 192 | * daemon dies or the applications stop. |
| 193 | */ |
| 194 | |
| 195 | if (err) { |
| 196 | health_error(); |
| 197 | ERR("Health error occurred in %s", __func__); |
| 198 | } |
| 199 | health_unregister(the_health_sessiond); |
| 200 | DBG("Application communication apps thread cleanup complete"); |
| 201 | rcu_thread_offline(); |
| 202 | rcu_unregister_thread(); |
| 203 | return NULL; |
| 204 | } |
| 205 | |
| 206 | static bool shutdown_application_management_thread(void *data) |
| 207 | { |
| 208 | struct thread_notifiers *notifiers = (thread_notifiers *) data; |
| 209 | const int write_fd = lttng_pipe_get_writefd(notifiers->quit_pipe); |
| 210 | |
| 211 | return notify_thread_pipe(write_fd) == 1; |
| 212 | } |
| 213 | |
| 214 | bool launch_application_management_thread(int apps_cmd_pipe_read_fd) |
| 215 | { |
| 216 | struct lttng_pipe *quit_pipe; |
| 217 | struct thread_notifiers *notifiers = NULL; |
| 218 | struct lttng_thread *thread; |
| 219 | |
| 220 | notifiers = zmalloc<thread_notifiers>(); |
| 221 | if (!notifiers) { |
| 222 | goto error_alloc; |
| 223 | } |
| 224 | quit_pipe = lttng_pipe_open(FD_CLOEXEC); |
| 225 | if (!quit_pipe) { |
| 226 | goto error; |
| 227 | } |
| 228 | notifiers->quit_pipe = quit_pipe; |
| 229 | notifiers->apps_cmd_pipe_read_fd = apps_cmd_pipe_read_fd; |
| 230 | |
| 231 | thread = lttng_thread_create("UST application management", |
| 232 | thread_application_management, |
| 233 | shutdown_application_management_thread, |
| 234 | cleanup_application_management_thread, |
| 235 | notifiers); |
| 236 | if (!thread) { |
| 237 | goto error; |
| 238 | } |
| 239 | |
| 240 | lttng_thread_put(thread); |
| 241 | return true; |
| 242 | error: |
| 243 | cleanup_application_management_thread(notifiers); |
| 244 | error_alloc: |
| 245 | return false; |
| 246 | } |