src/common/actions/rotate-session.c

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