| 1 | /* |
| 2 | * Copyright (C) 2013 David Goulet <dgoulet@efficios.com> |
| 3 | * |
| 4 | * SPDX-License-Identifier: LGPL-2.1-only |
| 5 | * |
| 6 | */ |
| 7 | |
| 8 | #define _LGPL_SOURCE |
| 9 | #include <string.h> |
| 10 | |
| 11 | #include <common/sessiond-comm/sessiond-comm.h> |
| 12 | #include <lttng/lttng-error.h> |
| 13 | #include <lttng/snapshot.h> |
| 14 | #include <lttng/snapshot-internal.h> |
| 15 | |
| 16 | #include "lttng-ctl-helper.h" |
| 17 | |
| 18 | /* |
| 19 | * Add an output object to a session identified by name. |
| 20 | * |
| 21 | * Return 0 on success or else a negative LTTNG_ERR code. |
| 22 | */ |
| 23 | int lttng_snapshot_add_output(const char *session_name, |
| 24 | struct lttng_snapshot_output *output) |
| 25 | { |
| 26 | int ret; |
| 27 | struct lttcomm_session_msg lsm; |
| 28 | struct lttcomm_lttng_output_id *reply; |
| 29 | |
| 30 | if (!session_name || !output) { |
| 31 | ret = -LTTNG_ERR_INVALID; |
| 32 | goto end; |
| 33 | } |
| 34 | |
| 35 | memset(&lsm, 0, sizeof(lsm)); |
| 36 | lsm.cmd_type = LTTNG_SNAPSHOT_ADD_OUTPUT; |
| 37 | |
| 38 | ret = lttng_strncpy(lsm.session.name, session_name, |
| 39 | sizeof(lsm.session.name)); |
| 40 | if (ret) { |
| 41 | ret = -LTTNG_ERR_INVALID; |
| 42 | goto end; |
| 43 | } |
| 44 | |
| 45 | memcpy(&lsm.u.snapshot_output.output, output, |
| 46 | sizeof(lsm.u.snapshot_output.output)); |
| 47 | |
| 48 | ret = lttng_ctl_ask_sessiond(&lsm, (void **) &reply); |
| 49 | if (ret < 0) { |
| 50 | goto end; |
| 51 | } |
| 52 | |
| 53 | output->id = reply->id; |
| 54 | free(reply); |
| 55 | ret = 0; |
| 56 | end: |
| 57 | return ret; |
| 58 | } |
| 59 | |
| 60 | /* |
| 61 | * Delete an output object to a session identified by name. |
| 62 | * |
| 63 | * Return 0 on success or else a negative LTTNG_ERR code. |
| 64 | */ |
| 65 | int lttng_snapshot_del_output(const char *session_name, |
| 66 | struct lttng_snapshot_output *output) |
| 67 | { |
| 68 | int ret; |
| 69 | struct lttcomm_session_msg lsm; |
| 70 | |
| 71 | if (!session_name || !output) { |
| 72 | ret = -LTTNG_ERR_INVALID; |
| 73 | goto end; |
| 74 | } |
| 75 | |
| 76 | memset(&lsm, 0, sizeof(lsm)); |
| 77 | lsm.cmd_type = LTTNG_SNAPSHOT_DEL_OUTPUT; |
| 78 | |
| 79 | ret = lttng_strncpy(lsm.session.name, session_name, |
| 80 | sizeof(lsm.session.name)); |
| 81 | if (ret) { |
| 82 | ret = -LTTNG_ERR_INVALID; |
| 83 | goto end; |
| 84 | } |
| 85 | |
| 86 | memcpy(&lsm.u.snapshot_output.output, output, |
| 87 | sizeof(lsm.u.snapshot_output.output)); |
| 88 | |
| 89 | ret = lttng_ctl_ask_sessiond(&lsm, NULL); |
| 90 | end: |
| 91 | return ret; |
| 92 | } |
| 93 | |
| 94 | /* |
| 95 | * List all snapshot output(s) of a session identified by name. The output list |
| 96 | * object is populated and can be iterated over with the get_next call below. |
| 97 | * |
| 98 | * Return 0 on success or else a negative LTTNG_ERR code and the list pointer |
| 99 | * is untouched. |
| 100 | */ |
| 101 | int lttng_snapshot_list_output(const char *session_name, |
| 102 | struct lttng_snapshot_output_list **list) |
| 103 | { |
| 104 | int ret; |
| 105 | struct lttcomm_session_msg lsm; |
| 106 | struct lttng_snapshot_output_list *new_list = NULL; |
| 107 | |
| 108 | if (!session_name || !list) { |
| 109 | ret = -LTTNG_ERR_INVALID; |
| 110 | goto error; |
| 111 | } |
| 112 | |
| 113 | memset(&lsm, 0, sizeof(lsm)); |
| 114 | lsm.cmd_type = LTTNG_SNAPSHOT_LIST_OUTPUT; |
| 115 | |
| 116 | ret = lttng_strncpy(lsm.session.name, session_name, |
| 117 | sizeof(lsm.session.name)); |
| 118 | if (ret) { |
| 119 | ret = -LTTNG_ERR_INVALID; |
| 120 | goto error; |
| 121 | } |
| 122 | |
| 123 | new_list = zmalloc(sizeof(*new_list)); |
| 124 | if (!new_list) { |
| 125 | ret = -LTTNG_ERR_NOMEM; |
| 126 | goto error; |
| 127 | } |
| 128 | |
| 129 | ret = lttng_ctl_ask_sessiond(&lsm, (void **) &new_list->array); |
| 130 | if (ret < 0) { |
| 131 | goto free_error; |
| 132 | } |
| 133 | |
| 134 | new_list->count = ret / sizeof(struct lttng_snapshot_output); |
| 135 | *list = new_list; |
| 136 | return 0; |
| 137 | |
| 138 | free_error: |
| 139 | free(new_list); |
| 140 | error: |
| 141 | return ret; |
| 142 | } |
| 143 | |
| 144 | /* |
| 145 | * Return the next available snapshot output object in the given list. A list |
| 146 | * output command MUST have been done before. |
| 147 | * |
| 148 | * Return the next object on success or else NULL indicating the end of the |
| 149 | * list. |
| 150 | */ |
| 151 | struct lttng_snapshot_output *lttng_snapshot_output_list_get_next( |
| 152 | struct lttng_snapshot_output_list *list) |
| 153 | { |
| 154 | struct lttng_snapshot_output *output = NULL; |
| 155 | |
| 156 | if (!list) { |
| 157 | goto error; |
| 158 | } |
| 159 | |
| 160 | /* We've reached the end. */ |
| 161 | if (list->index == list->count) { |
| 162 | goto end; |
| 163 | } |
| 164 | |
| 165 | output = &list->array[list->index]; |
| 166 | list->index++; |
| 167 | |
| 168 | end: |
| 169 | error: |
| 170 | return output; |
| 171 | } |
| 172 | |
| 173 | /* |
| 174 | * Free an output list object. |
| 175 | */ |
| 176 | void lttng_snapshot_output_list_destroy(struct lttng_snapshot_output_list *list) |
| 177 | { |
| 178 | if (!list) { |
| 179 | return; |
| 180 | } |
| 181 | |
| 182 | free(list->array); |
| 183 | free(list); |
| 184 | } |
| 185 | |
| 186 | /* |
| 187 | * Snapshot a trace for the given session. |
| 188 | * |
| 189 | * The output object can be NULL but an add output MUST be done prior to this |
| 190 | * call. If it's not NULL, it will be used to snapshot a trace. |
| 191 | * |
| 192 | * The wait parameter is ignored for now. The snapshot record command will |
| 193 | * ALWAYS wait for the snapshot to complete before returning meaning the |
| 194 | * snapshot has been written on disk or streamed over the network to a relayd. |
| 195 | * |
| 196 | * Return 0 on success or else a negative LTTNG_ERR value. |
| 197 | */ |
| 198 | int lttng_snapshot_record(const char *session_name, |
| 199 | struct lttng_snapshot_output *output, int wait) |
| 200 | { |
| 201 | int ret; |
| 202 | struct lttcomm_session_msg lsm; |
| 203 | |
| 204 | if (!session_name) { |
| 205 | ret = -LTTNG_ERR_INVALID; |
| 206 | goto end; |
| 207 | } |
| 208 | |
| 209 | memset(&lsm, 0, sizeof(lsm)); |
| 210 | lsm.cmd_type = LTTNG_SNAPSHOT_RECORD; |
| 211 | |
| 212 | ret = lttng_strncpy(lsm.session.name, session_name, |
| 213 | sizeof(lsm.session.name)); |
| 214 | if (ret) { |
| 215 | ret = -LTTNG_ERR_INVALID; |
| 216 | goto end; |
| 217 | } |
| 218 | |
| 219 | /* |
| 220 | * Not having an output object will use the default one of the session that |
| 221 | * would need to be set by a call to add output prior to calling snapshot |
| 222 | * record. |
| 223 | */ |
| 224 | if (output) { |
| 225 | memcpy(&lsm.u.snapshot_record.output, output, |
| 226 | sizeof(lsm.u.snapshot_record.output)); |
| 227 | } |
| 228 | |
| 229 | /* The wait param is ignored. */ |
| 230 | ret = lttng_ctl_ask_sessiond(&lsm, NULL); |
| 231 | end: |
| 232 | return ret; |
| 233 | } |
| 234 | |
| 235 | /* |
| 236 | * Return an newly allocated snapshot output object or NULL on error. |
| 237 | */ |
| 238 | struct lttng_snapshot_output *lttng_snapshot_output_create(void) |
| 239 | { |
| 240 | struct lttng_snapshot_output *output; |
| 241 | |
| 242 | output = zmalloc(sizeof(struct lttng_snapshot_output)); |
| 243 | if (!output) { |
| 244 | goto error; |
| 245 | } |
| 246 | |
| 247 | output->max_size = (uint64_t) -1ULL; |
| 248 | |
| 249 | error: |
| 250 | return output; |
| 251 | } |
| 252 | |
| 253 | /* |
| 254 | * Free a given snapshot output object. |
| 255 | */ |
| 256 | void lttng_snapshot_output_destroy(struct lttng_snapshot_output *obj) |
| 257 | { |
| 258 | if (obj) { |
| 259 | free(obj); |
| 260 | } |
| 261 | } |
| 262 | |
| 263 | /* |
| 264 | * Getter family functions of snapshot output. |
| 265 | */ |
| 266 | |
| 267 | uint32_t lttng_snapshot_output_get_id(const struct lttng_snapshot_output *output) |
| 268 | { |
| 269 | return output->id; |
| 270 | } |
| 271 | |
| 272 | const char *lttng_snapshot_output_get_name( |
| 273 | const struct lttng_snapshot_output *output) |
| 274 | { |
| 275 | return output->name; |
| 276 | } |
| 277 | |
| 278 | const char *lttng_snapshot_output_get_data_url(const struct lttng_snapshot_output *output) |
| 279 | { |
| 280 | return output->data_url; |
| 281 | } |
| 282 | |
| 283 | const char *lttng_snapshot_output_get_ctrl_url(const struct lttng_snapshot_output *output) |
| 284 | { |
| 285 | return output->ctrl_url; |
| 286 | } |
| 287 | |
| 288 | uint64_t lttng_snapshot_output_get_maxsize( |
| 289 | const struct lttng_snapshot_output *output) |
| 290 | { |
| 291 | return output->max_size; |
| 292 | } |
| 293 | |
| 294 | /* |
| 295 | * Setter family functions for snapshot output. |
| 296 | */ |
| 297 | |
| 298 | int lttng_snapshot_output_set_id(uint32_t id, |
| 299 | struct lttng_snapshot_output *output) |
| 300 | { |
| 301 | if (!output || id == 0) { |
| 302 | return -LTTNG_ERR_INVALID; |
| 303 | } |
| 304 | |
| 305 | output->id = id; |
| 306 | return 0; |
| 307 | } |
| 308 | |
| 309 | int lttng_snapshot_output_set_size(uint64_t size, |
| 310 | struct lttng_snapshot_output *output) |
| 311 | { |
| 312 | if (!output) { |
| 313 | return -LTTNG_ERR_INVALID; |
| 314 | } |
| 315 | |
| 316 | output->max_size = size; |
| 317 | return 0; |
| 318 | } |
| 319 | |
| 320 | int lttng_snapshot_output_set_name(const char *name, |
| 321 | struct lttng_snapshot_output *output) |
| 322 | { |
| 323 | int ret; |
| 324 | |
| 325 | if (!output || !name) { |
| 326 | ret = -LTTNG_ERR_INVALID; |
| 327 | goto end; |
| 328 | } |
| 329 | |
| 330 | ret = lttng_strncpy(output->name, name, sizeof(output->name)); |
| 331 | if (ret) { |
| 332 | ret = -LTTNG_ERR_INVALID; |
| 333 | goto end; |
| 334 | } |
| 335 | |
| 336 | end: |
| 337 | return ret; |
| 338 | } |
| 339 | |
| 340 | int lttng_snapshot_output_set_ctrl_url(const char *url, |
| 341 | struct lttng_snapshot_output *output) |
| 342 | { |
| 343 | int ret; |
| 344 | |
| 345 | if (!output || !url) { |
| 346 | ret = -LTTNG_ERR_INVALID; |
| 347 | goto end; |
| 348 | } |
| 349 | |
| 350 | ret = lttng_strncpy(output->ctrl_url, url, sizeof(output->ctrl_url)); |
| 351 | if (ret) { |
| 352 | ret = -LTTNG_ERR_INVALID; |
| 353 | goto end; |
| 354 | } |
| 355 | |
| 356 | end: |
| 357 | return ret; |
| 358 | } |
| 359 | |
| 360 | int lttng_snapshot_output_set_data_url(const char *url, |
| 361 | struct lttng_snapshot_output *output) |
| 362 | { |
| 363 | int ret; |
| 364 | |
| 365 | if (!output || !url) { |
| 366 | ret = -LTTNG_ERR_INVALID; |
| 367 | goto end; |
| 368 | } |
| 369 | |
| 370 | ret = lttng_strncpy(output->data_url, url, sizeof(output->data_url)); |
| 371 | if (ret) { |
| 372 | ret = -LTTNG_ERR_INVALID; |
| 373 | goto end; |
| 374 | } |
| 375 | |
| 376 | end: |
| 377 | return ret; |
| 378 | } |
| 379 | |
| 380 | int lttng_snapshot_output_set_local_path(const char *path, |
| 381 | struct lttng_snapshot_output *output) |
| 382 | { |
| 383 | int ret; |
| 384 | struct lttng_uri *uris = NULL; |
| 385 | ssize_t num_uris; |
| 386 | |
| 387 | if (!path || !output) { |
| 388 | ret = -LTTNG_ERR_INVALID; |
| 389 | goto end; |
| 390 | } |
| 391 | |
| 392 | num_uris = uri_parse_str_urls(path, NULL, &uris); |
| 393 | if (num_uris != 1) { |
| 394 | ret = -LTTNG_ERR_INVALID; |
| 395 | goto end; |
| 396 | } |
| 397 | |
| 398 | if (uris[0].dtype != LTTNG_DST_PATH) { |
| 399 | ret = -LTTNG_ERR_INVALID; |
| 400 | goto end; |
| 401 | } |
| 402 | |
| 403 | ret = lttng_strncpy(output->ctrl_url, path, sizeof(output->ctrl_url)); |
| 404 | if (ret != 0) { |
| 405 | ret = -LTTNG_ERR_INVALID; |
| 406 | goto end; |
| 407 | } |
| 408 | |
| 409 | end: |
| 410 | free(uris); |
| 411 | return ret; |
| 412 | } |
| 413 | |
| 414 | int lttng_snapshot_output_set_network_url(const char *url, |
| 415 | struct lttng_snapshot_output *output) |
| 416 | { |
| 417 | int ret; |
| 418 | struct lttng_uri *uris = NULL; |
| 419 | ssize_t num_uris; |
| 420 | |
| 421 | if (!url || !output) { |
| 422 | ret = -LTTNG_ERR_INVALID; |
| 423 | goto end; |
| 424 | } |
| 425 | |
| 426 | num_uris = uri_parse_str_urls(url, NULL, &uris); |
| 427 | if (num_uris != 2) { |
| 428 | ret = -LTTNG_ERR_INVALID; |
| 429 | goto end; |
| 430 | } |
| 431 | |
| 432 | if (uris[0].dtype != LTTNG_DST_IPV4 && |
| 433 | uris[0].dtype != LTTNG_DST_IPV6) { |
| 434 | ret = -LTTNG_ERR_INVALID; |
| 435 | goto end; |
| 436 | } |
| 437 | |
| 438 | if (uris[1].dtype != LTTNG_DST_IPV4 && |
| 439 | uris[1].dtype != LTTNG_DST_IPV6) { |
| 440 | ret = -LTTNG_ERR_INVALID; |
| 441 | goto end; |
| 442 | } |
| 443 | |
| 444 | ret = lttng_strncpy(output->ctrl_url, url, sizeof(output->ctrl_url)); |
| 445 | if (ret != 0) { |
| 446 | ret = -LTTNG_ERR_INVALID; |
| 447 | goto end; |
| 448 | } |
| 449 | |
| 450 | end: |
| 451 | free(uris); |
| 452 | return ret; |
| 453 | } |
| 454 | |
| 455 | int lttng_snapshot_output_set_network_urls( |
| 456 | const char *ctrl_url, const char *data_url, |
| 457 | struct lttng_snapshot_output *output) |
| 458 | { |
| 459 | int ret; |
| 460 | struct lttng_uri *uris = NULL; |
| 461 | ssize_t num_uris; |
| 462 | |
| 463 | if (!ctrl_url || !data_url || !output) { |
| 464 | ret = -LTTNG_ERR_INVALID; |
| 465 | goto end; |
| 466 | } |
| 467 | |
| 468 | num_uris = uri_parse_str_urls(ctrl_url, data_url, &uris); |
| 469 | if (num_uris != 2) { |
| 470 | ret = -LTTNG_ERR_INVALID; |
| 471 | goto end; |
| 472 | } |
| 473 | |
| 474 | if (uris[0].dtype != LTTNG_DST_IPV4 && |
| 475 | uris[0].dtype != LTTNG_DST_IPV6) { |
| 476 | ret = -LTTNG_ERR_INVALID; |
| 477 | goto end; |
| 478 | } |
| 479 | |
| 480 | if (uris[1].dtype != LTTNG_DST_IPV4 && |
| 481 | uris[1].dtype != LTTNG_DST_IPV6) { |
| 482 | ret = -LTTNG_ERR_INVALID; |
| 483 | goto end; |
| 484 | } |
| 485 | |
| 486 | ret = lttng_strncpy(output->ctrl_url, ctrl_url, sizeof(output->ctrl_url)); |
| 487 | if (ret != 0) { |
| 488 | ret = -LTTNG_ERR_INVALID; |
| 489 | goto end; |
| 490 | } |
| 491 | |
| 492 | ret = lttng_strncpy(output->data_url, data_url, sizeof(output->data_url)); |
| 493 | if (ret != 0) { |
| 494 | ret = -LTTNG_ERR_INVALID; |
| 495 | goto end; |
| 496 | } |
| 497 | |
| 498 | end: |
| 499 | free(uris); |
| 500 | return ret; |
| 501 | } |