src/common/actions/rotate-session.cpp

   1 /*
   2  * Copyright (C) 2019 Simon Marchi <simon.marchi@efficios.com>
   3  *
   4  * SPDX-License-Identifier: LGPL-2.1-only
   5  *
   6  */
   7
   8 #include <common/error.hpp>
   9 #include <common/macros.hpp>
  10 #include <common/mi-lttng.hpp>
  11
  12 #include <lttng/action/action-internal.hpp>
  13 #include <lttng/action/rate-policy-internal.hpp>
  14 #include <lttng/action/rate-policy.h>
  15 #include <lttng/action/rotate-session-internal.hpp>
  16 #include <lttng/action/rotate-session.h>
  17
  18 #define IS_ROTATE_SESSION_ACTION(action) \
  19         (lttng_action_get_type(action) == LTTNG_ACTION_TYPE_ROTATE_SESSION)
  20
  21 namespace {
  22 struct lttng_action_rotate_session {
  23         struct lttng_action parent;
  24
  25         /* Owned by this. */
  26         char *session_name;
  27         struct lttng_rate_policy *policy;
  28 };
  29
  30 struct lttng_action_rotate_session_comm {
  31         /* Includes the trailing \0. */
  32         uint32_t session_name_len;
  33
  34         /*
  35          * Variable data:
  36          *
  37          *  - session name (null terminated)
  38          *  - policy
  39          */
  40         char data[];
  41 } LTTNG_PACKED;
  42 } /* namespace */
  43
  44 static const struct lttng_rate_policy *
  45 lttng_action_rotate_session_internal_get_rate_policy(const struct lttng_action *action);
  46
  47 static struct lttng_action_rotate_session *
  48 action_rotate_session_from_action(struct lttng_action *action)
  49 {
  50         LTTNG_ASSERT(action);
  51
  52         return lttng::utils::container_of(action, &lttng_action_rotate_session::parent);
  53 }
  54
  55 static const struct lttng_action_rotate_session *
  56 action_rotate_session_from_action_const(const struct lttng_action *action)
  57 {
  58         LTTNG_ASSERT(action);
  59
  60         return lttng::utils::container_of(action, &lttng_action_rotate_session::parent);
  61 }
  62
  63 static bool lttng_action_rotate_session_validate(struct lttng_action *action)
  64 {
  65         bool valid;
  66         struct lttng_action_rotate_session *action_rotate_session;
  67
  68         if (!action) {
  69                 valid = false;
  70                 goto end;
  71         }
  72
  73         action_rotate_session = action_rotate_session_from_action(action);
  74
  75         /* A non-empty session name is mandatory. */
  76         if (!action_rotate_session->session_name ||
  77             strlen(action_rotate_session->session_name) == 0) {
  78                 valid = false;
  79                 goto end;
  80         }
  81
  82         valid = true;
  83 end:
  84         return valid;
  85 }
  86
  87 static bool lttng_action_rotate_session_is_equal(const struct lttng_action *_a,
  88                                                  const struct lttng_action *_b)
  89 {
  90         bool is_equal = false;
  91         const struct lttng_action_rotate_session *a, *b;
  92
  93         a = action_rotate_session_from_action_const(_a);
  94         b = action_rotate_session_from_action_const(_b);
  95
  96         /* Action is not valid if this is not true. */
  97         LTTNG_ASSERT(a->session_name);
  98         LTTNG_ASSERT(b->session_name);
  99         if (strcmp(a->session_name, b->session_name) != 0) {
 100                 goto end;
 101         }
 102
 103         is_equal = lttng_rate_policy_is_equal(a->policy, b->policy);
 104 end:
 105         return is_equal;
 106 }
 107 static int lttng_action_rotate_session_serialize(struct lttng_action *action,
 108                                                  struct lttng_payload *payload)
 109 {
 110         struct lttng_action_rotate_session *action_rotate_session;
 111         struct lttng_action_rotate_session_comm comm;
 112         size_t session_name_len;
 113         int ret;
 114
 115         LTTNG_ASSERT(action);
 116         LTTNG_ASSERT(payload);
 117
 118         action_rotate_session = action_rotate_session_from_action(action);
 119
 120         LTTNG_ASSERT(action_rotate_session->session_name);
 121
 122         DBG("Serializing rotate session action: session-name: %s",
 123             action_rotate_session->session_name);
 124
 125         session_name_len = strlen(action_rotate_session->session_name) + 1;
 126         comm.session_name_len = session_name_len;
 127
 128         ret = lttng_dynamic_buffer_append(&payload->buffer, &comm, sizeof(comm));
 129         if (ret) {
 130                 ret = -1;
 131                 goto end;
 132         }
 133
 134         ret = lttng_dynamic_buffer_append(
 135                 &payload->buffer, action_rotate_session->session_name, session_name_len);
 136         if (ret) {
 137                 ret = -1;
 138                 goto end;
 139         }
 140
 141         ret = lttng_rate_policy_serialize(action_rotate_session->policy, payload);
 142         if (ret) {
 143                 ret = -1;
 144                 goto end;
 145         }
 146 end:
 147         return ret;
 148 }
 149
 150 static void lttng_action_rotate_session_destroy(struct lttng_action *action)
 151 {
 152         struct lttng_action_rotate_session *action_rotate_session;
 153
 154         if (!action) {
 155                 goto end;
 156         }
 157
 158         action_rotate_session = action_rotate_session_from_action(action);
 159
 160         lttng_rate_policy_destroy(action_rotate_session->policy);
 161         free(action_rotate_session->session_name);
 162         free(action_rotate_session);
 163
 164 end:
 165         return;
 166 }
 167
 168 ssize_t lttng_action_rotate_session_create_from_payload(struct lttng_payload_view *view,
 169                                                         struct lttng_action **p_action)
 170 {
 171         ssize_t consumed_len, ret;
 172         const struct lttng_action_rotate_session_comm *comm;
 173         const char *session_name;
 174         struct lttng_action *action;
 175         enum lttng_action_status status;
 176         struct lttng_rate_policy *policy = nullptr;
 177
 178         action = lttng_action_rotate_session_create();
 179         if (!action) {
 180                 consumed_len = -1;
 181                 goto end;
 182         }
 183
 184         comm = (typeof(comm)) view->buffer.data;
 185         session_name = (const char *) &comm->data;
 186
 187         if (!lttng_buffer_view_contains_string(
 188                     &view->buffer, session_name, comm->session_name_len)) {
 189                 consumed_len = -1;
 190                 goto end;
 191         }
 192         consumed_len = sizeof(*comm) + comm->session_name_len;
 193
 194         /* Rate policy. */
 195         {
 196                 struct lttng_payload_view policy_view =
 197                         lttng_payload_view_from_view(view, consumed_len, -1);
 198                 ret = lttng_rate_policy_create_from_payload(&policy_view, &policy);
 199                 if (ret < 0) {
 200                         consumed_len = -1;
 201                         goto end;
 202                 }
 203                 consumed_len += ret;
 204         }
 205
 206         status = lttng_action_rotate_session_set_session_name(action, session_name);
 207         if (status != LTTNG_ACTION_STATUS_OK) {
 208                 consumed_len = -1;
 209                 goto end;
 210         }
 211
 212         LTTNG_ASSERT(policy);
 213         status = lttng_action_rotate_session_set_rate_policy(action, policy);
 214         if (status != LTTNG_ACTION_STATUS_OK) {
 215                 consumed_len = -1;
 216                 goto end;
 217         }
 218
 219         *p_action = action;
 220         action = nullptr;
 221
 222 end:
 223         lttng_rate_policy_destroy(policy);
 224         lttng_action_rotate_session_destroy(action);
 225
 226         return consumed_len;
 227 }
 228
 229 static enum lttng_error_code
 230 lttng_action_rotate_session_mi_serialize(const struct lttng_action *action,
 231                                          struct mi_writer *writer)
 232 {
 233         int ret;
 234         enum lttng_error_code ret_code;
 235         enum lttng_action_status status;
 236         const char *session_name = nullptr;
 237         const struct lttng_rate_policy *policy = nullptr;
 238
 239         LTTNG_ASSERT(action);
 240         LTTNG_ASSERT(IS_ROTATE_SESSION_ACTION(action));
 241
 242         status = lttng_action_rotate_session_get_session_name(action, &session_name);
 243         LTTNG_ASSERT(status == LTTNG_ACTION_STATUS_OK);
 244         LTTNG_ASSERT(session_name != nullptr);
 245
 246         status = lttng_action_notify_get_rate_policy(action, &policy);
 247         LTTNG_ASSERT(status == LTTNG_ACTION_STATUS_OK);
 248         LTTNG_ASSERT(policy != nullptr);
 249
 250         /* Open action rotate session element. */
 251         ret = mi_lttng_writer_open_element(writer, mi_lttng_element_action_rotate_session);
 252         if (ret) {
 253                 goto mi_error;
 254         }
 255
 256         /* Session name. */
 257         ret = mi_lttng_writer_write_element_string(
 258                 writer, mi_lttng_element_session_name, session_name);
 259         if (ret) {
 260                 goto mi_error;
 261         }
 262
 263         /* Rate policy. */
 264         ret_code = lttng_rate_policy_mi_serialize(policy, writer);
 265         if (ret_code != LTTNG_OK) {
 266                 goto end;
 267         }
 268
 269         /* Close action rotate session element. */
 270         ret = mi_lttng_writer_close_element(writer);
 271         if (ret) {
 272                 goto mi_error;
 273         }
 274
 275         ret_code = LTTNG_OK;
 276         goto end;
 277
 278 mi_error:
 279         ret_code = LTTNG_ERR_MI_IO_FAIL;
 280 end:
 281         return ret_code;
 282 }
 283
 284 struct lttng_action *lttng_action_rotate_session_create(void)
 285 {
 286         struct lttng_action_rotate_session *action_rotate = nullptr;
 287         struct lttng_rate_policy *policy = nullptr;
 288         enum lttng_action_status status;
 289
 290         /* Create a every N = 1 rate policy. */
 291         policy = lttng_rate_policy_every_n_create(1);
 292         if (!policy) {
 293                 goto end;
 294         }
 295
 296         action_rotate = zmalloc<lttng_action_rotate_session>();
 297         if (!action_rotate) {
 298                 goto end;
 299         }
 300
 301         lttng_action_init(&action_rotate->parent,
 302                           LTTNG_ACTION_TYPE_ROTATE_SESSION,
 303                           lttng_action_rotate_session_validate,
 304                           lttng_action_rotate_session_serialize,
 305                           lttng_action_rotate_session_is_equal,
 306                           lttng_action_rotate_session_destroy,
 307                           lttng_action_rotate_session_internal_get_rate_policy,
 308                           lttng_action_generic_add_error_query_results,
 309                           lttng_action_rotate_session_mi_serialize);
 310
 311         status = lttng_action_rotate_session_set_rate_policy(&action_rotate->parent, policy);
 312         if (status != LTTNG_ACTION_STATUS_OK) {
 313                 lttng_action_destroy(&action_rotate->parent);
 314                 action_rotate = nullptr;
 315                 goto end;
 316         }
 317
 318 end:
 319         lttng_rate_policy_destroy(policy);
 320         return action_rotate ? &action_rotate->parent : nullptr;
 321 }
 322
 323 enum lttng_action_status lttng_action_rotate_session_set_session_name(struct lttng_action *action,
 324                                                                       const char *session_name)
 325 {
 326         struct lttng_action_rotate_session *action_rotate_session;
 327         enum lttng_action_status status;
 328
 329         if (!action || !IS_ROTATE_SESSION_ACTION(action) || !session_name ||
 330             strlen(session_name) == 0) {
 331                 status = LTTNG_ACTION_STATUS_INVALID;
 332                 goto end;
 333         }
 334
 335         action_rotate_session = action_rotate_session_from_action(action);
 336
 337         free(action_rotate_session->session_name);
 338
 339         action_rotate_session->session_name = strdup(session_name);
 340         if (!action_rotate_session->session_name) {
 341                 status = LTTNG_ACTION_STATUS_ERROR;
 342                 goto end;
 343         }
 344
 345         status = LTTNG_ACTION_STATUS_OK;
 346 end:
 347         return status;
 348 }
 349
 350 enum lttng_action_status
 351 lttng_action_rotate_session_get_session_name(const struct lttng_action *action,
 352                                              const char **session_name)
 353 {
 354         const struct lttng_action_rotate_session *action_rotate_session;
 355         enum lttng_action_status status;
 356
 357         if (!action || !IS_ROTATE_SESSION_ACTION(action) || !session_name) {
 358                 status = LTTNG_ACTION_STATUS_INVALID;
 359                 goto end;
 360         }
 361
 362         action_rotate_session = action_rotate_session_from_action_const(action);
 363
 364         *session_name = action_rotate_session->session_name;
 365
 366         status = LTTNG_ACTION_STATUS_OK;
 367 end:
 368         return status;
 369 }
 370
 371 enum lttng_action_status
 372 lttng_action_rotate_session_set_rate_policy(struct lttng_action *action,
 373                                             const struct lttng_rate_policy *policy)
 374 {
 375         enum lttng_action_status status;
 376         struct lttng_action_rotate_session *rotate_session_action;
 377         struct lttng_rate_policy *copy = nullptr;
 378
 379         if (!action || !policy || !IS_ROTATE_SESSION_ACTION(action)) {
 380                 status = LTTNG_ACTION_STATUS_INVALID;
 381                 goto end;
 382         }
 383
 384         copy = lttng_rate_policy_copy(policy);
 385         if (!copy) {
 386                 status = LTTNG_ACTION_STATUS_ERROR;
 387                 goto end;
 388         }
 389
 390         rotate_session_action = action_rotate_session_from_action(action);
 391
 392         /* Free the previous rate policy .*/
 393         lttng_rate_policy_destroy(rotate_session_action->policy);
 394
 395         /* Assign the policy. */
 396         rotate_session_action->policy = copy;
 397         status = LTTNG_ACTION_STATUS_OK;
 398         copy = nullptr;
 399
 400 end:
 401         lttng_rate_policy_destroy(copy);
 402         return status;
 403 }
 404
 405 enum lttng_action_status
 406 lttng_action_rotate_session_get_rate_policy(const struct lttng_action *action,
 407                                             const struct lttng_rate_policy **policy)
 408 {
 409         enum lttng_action_status status;
 410         const struct lttng_action_rotate_session *rotate_session_action;
 411
 412         if (!action || !policy || !IS_ROTATE_SESSION_ACTION(action)) {
 413                 status = LTTNG_ACTION_STATUS_INVALID;
 414                 goto end;
 415         }
 416
 417         rotate_session_action = action_rotate_session_from_action_const(action);
 418
 419         *policy = rotate_session_action->policy;
 420         status = LTTNG_ACTION_STATUS_OK;
 421 end:
 422         return status;
 423 }
 424
 425 static const struct lttng_rate_policy *
 426 lttng_action_rotate_session_internal_get_rate_policy(const struct lttng_action *action)
 427 {
 428         const struct lttng_action_rotate_session *_action;
 429         _action = action_rotate_session_from_action_const(action);
 430
 431         return _action->policy;
 432 }