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 <lttng/action/action-internal.h>
  12 #include <lttng/action/rate-policy-internal.h>
  13 #include <lttng/action/rate-policy.h>
  14 #include <lttng/action/rotate-session-internal.h>
  15 #include <lttng/action/rotate-session.h>
  16
  17 #define IS_ROTATE_SESSION_ACTION(action) \
  18         (lttng_action_get_type(action) == LTTNG_ACTION_TYPE_ROTATE_SESSION)
  19
  20 struct lttng_action_rotate_session {
  21         struct lttng_action parent;
  22
  23         /* Owned by this. */
  24         char *session_name;
  25         struct lttng_rate_policy *policy;
  26 };
  27
  28 struct lttng_action_rotate_session_comm {
  29         /* Includes the trailing \0. */
  30         uint32_t session_name_len;
  31
  32         /*
  33          * Variable data:
  34          *
  35          *  - session name (null terminated)
  36          *  - policy
  37          */
  38         char data[];
  39 } LTTNG_PACKED;
  40
  41 static const struct lttng_rate_policy *
  42 lttng_action_rotate_session_internal_get_rate_policy(
  43                 const struct lttng_action *action);
  44
  45 static struct lttng_action_rotate_session *action_rotate_session_from_action(
  46                 struct lttng_action *action)
  47 {
  48         assert(action);
  49
  50         return container_of(action, struct lttng_action_rotate_session, parent);
  51 }
  52
  53 static const struct lttng_action_rotate_session *
  54 action_rotate_session_from_action_const(const struct lttng_action *action)
  55 {
  56         assert(action);
  57
  58         return container_of(action, struct lttng_action_rotate_session, parent);
  59 }
  60
  61 static bool lttng_action_rotate_session_validate(struct lttng_action *action)
  62 {
  63         bool valid;
  64         struct lttng_action_rotate_session *action_rotate_session;
  65
  66         if (!action) {
  67                 valid = false;
  68                 goto end;
  69         }
  70
  71         action_rotate_session = action_rotate_session_from_action(action);
  72
  73         /* A non-empty session name is mandatory. */
  74         if (!action_rotate_session->session_name ||
  75                         strlen(action_rotate_session->session_name) == 0) {
  76                 valid = false;
  77                 goto end;
  78         }
  79
  80         valid = true;
  81 end:
  82         return valid;
  83 }
  84
  85 static bool lttng_action_rotate_session_is_equal(
  86                 const struct lttng_action *_a, const struct lttng_action *_b)
  87 {
  88         bool is_equal = false;
  89         const struct lttng_action_rotate_session *a, *b;
  90
  91         a = action_rotate_session_from_action_const(_a);
  92         b = action_rotate_session_from_action_const(_b);
  93
  94         /* Action is not valid if this is not true. */
  95         assert(a->session_name);
  96         assert(b->session_name);
  97         if (strcmp(a->session_name, b->session_name)) {
  98                 goto end;
  99         }
 100
 101         is_equal = lttng_rate_policy_is_equal(a->policy, b->policy);
 102 end:
 103         return is_equal;
 104 }
 105 static int lttng_action_rotate_session_serialize(
 106                 struct lttng_action *action, struct lttng_payload *payload)
 107 {
 108         struct lttng_action_rotate_session *action_rotate_session;
 109         struct lttng_action_rotate_session_comm comm;
 110         size_t session_name_len;
 111         int ret;
 112
 113         assert(action);
 114         assert(payload);
 115
 116         action_rotate_session = action_rotate_session_from_action(action);
 117
 118         assert(action_rotate_session->session_name);
 119
 120         DBG("Serializing rotate session action: session-name: %s",
 121                         action_rotate_session->session_name);
 122
 123         session_name_len = strlen(action_rotate_session->session_name) + 1;
 124         comm.session_name_len = session_name_len;
 125
 126         ret = lttng_dynamic_buffer_append(
 127                         &payload->buffer, &comm, sizeof(comm));
 128         if (ret) {
 129                 ret = -1;
 130                 goto end;
 131         }
 132
 133         ret = lttng_dynamic_buffer_append(&payload->buffer,
 134                         action_rotate_session->session_name, session_name_len);
 135         if (ret) {
 136                 ret = -1;
 137                 goto end;
 138         }
 139
 140         ret = lttng_rate_policy_serialize(
 141                         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(
 169                 struct lttng_payload_view *view,
 170                 struct lttng_action **p_action)
 171 {
 172         ssize_t consumed_len, ret;
 173         const struct lttng_action_rotate_session_comm *comm;
 174         const char *session_name;
 175         struct lttng_action *action;
 176         enum lttng_action_status status;
 177         struct lttng_rate_policy *policy = NULL;
 178
 179         action = lttng_action_rotate_session_create();
 180         if (!action) {
 181                 consumed_len = -1;
 182                 goto end;
 183         }
 184
 185         comm = (typeof(comm)) view->buffer.data;
 186         session_name = (const char *) &comm->data;
 187
 188         if (!lttng_buffer_view_contains_string(
 189                         &view->buffer, session_name, comm->session_name_len)) {
 190                 consumed_len = -1;
 191                 goto end;
 192         }
 193         consumed_len = sizeof(*comm) + comm->session_name_len;
 194
 195         /* Rate policy. */
 196         {
 197                 struct lttng_payload_view policy_view =
 198                                 lttng_payload_view_from_view(
 199                                                 view, consumed_len, -1);
 200                 ret = lttng_rate_policy_create_from_payload(
 201                                 &policy_view, &policy);
 202                 if (ret < 0) {
 203                         consumed_len = -1;
 204                         goto end;
 205                 }
 206                 consumed_len += ret;
 207         }
 208
 209         status = lttng_action_rotate_session_set_session_name(
 210                         action, session_name);
 211         if (status != LTTNG_ACTION_STATUS_OK) {
 212                 consumed_len = -1;
 213                 goto end;
 214         }
 215
 216         assert(policy);
 217         status = lttng_action_rotate_session_set_rate_policy(action, policy);
 218         if (status != LTTNG_ACTION_STATUS_OK) {
 219                 consumed_len = -1;
 220                 goto end;
 221         }
 222
 223         *p_action = action;
 224         action = NULL;
 225
 226 end:
 227         lttng_rate_policy_destroy(policy);
 228         lttng_action_rotate_session_destroy(action);
 229
 230         return consumed_len;
 231 }
 232
 233 struct lttng_action *lttng_action_rotate_session_create(void)
 234 {
 235         struct lttng_action *action = NULL;
 236         struct lttng_rate_policy *policy = NULL;
 237         enum lttng_action_status status;
 238
 239         /* Create a every N = 1 rate policy. */
 240         policy = lttng_rate_policy_every_n_create(1);
 241         if (!policy) {
 242                 goto end;
 243         }
 244
 245         action = zmalloc(sizeof(struct lttng_action_rotate_session));
 246         if (!action) {
 247                 goto end;
 248         }
 249
 250         lttng_action_init(action, LTTNG_ACTION_TYPE_ROTATE_SESSION,
 251                         lttng_action_rotate_session_validate,
 252                         lttng_action_rotate_session_serialize,
 253                         lttng_action_rotate_session_is_equal,
 254                         lttng_action_rotate_session_destroy,
 255                         lttng_action_rotate_session_internal_get_rate_policy,
 256                         lttng_action_generic_add_error_query_results);
 257
 258         status = lttng_action_rotate_session_set_rate_policy(action, policy);
 259         if (status != LTTNG_ACTION_STATUS_OK) {
 260                 free(action);
 261                 action = NULL;
 262                 goto end;
 263         }
 264
 265 end:
 266         lttng_rate_policy_destroy(policy);
 267         return action;
 268 }
 269
 270 enum lttng_action_status lttng_action_rotate_session_set_session_name(
 271                 struct lttng_action *action, const char *session_name)
 272 {
 273         struct lttng_action_rotate_session *action_rotate_session;
 274         enum lttng_action_status status;
 275
 276         if (!action || !IS_ROTATE_SESSION_ACTION(action) || !session_name ||
 277                         strlen(session_name) == 0) {
 278                 status = LTTNG_ACTION_STATUS_INVALID;
 279                 goto end;
 280         }
 281
 282         action_rotate_session = action_rotate_session_from_action(action);
 283
 284         free(action_rotate_session->session_name);
 285
 286         action_rotate_session->session_name = strdup(session_name);
 287         if (!action_rotate_session->session_name) {
 288                 status = LTTNG_ACTION_STATUS_ERROR;
 289                 goto end;
 290         }
 291
 292         status = LTTNG_ACTION_STATUS_OK;
 293 end:
 294         return status;
 295 }
 296
 297 enum lttng_action_status lttng_action_rotate_session_get_session_name(
 298                 const struct lttng_action *action, const char **session_name)
 299 {
 300         const struct lttng_action_rotate_session *action_rotate_session;
 301         enum lttng_action_status status;
 302
 303         if (!action || !IS_ROTATE_SESSION_ACTION(action) || !session_name) {
 304                 status = LTTNG_ACTION_STATUS_INVALID;
 305                 goto end;
 306         }
 307
 308         action_rotate_session = action_rotate_session_from_action_const(action);
 309
 310         *session_name = action_rotate_session->session_name;
 311
 312         status = LTTNG_ACTION_STATUS_OK;
 313 end:
 314         return status;
 315 }
 316
 317 enum lttng_action_status lttng_action_rotate_session_set_rate_policy(
 318                 struct lttng_action *action,
 319                 const struct lttng_rate_policy *policy)
 320 {
 321         enum lttng_action_status status;
 322         struct lttng_action_rotate_session *rotate_session_action;
 323         struct lttng_rate_policy *copy = NULL;
 324
 325         if (!action || !policy || !IS_ROTATE_SESSION_ACTION(action)) {
 326                 status = LTTNG_ACTION_STATUS_INVALID;
 327                 goto end;
 328         }
 329
 330         copy = lttng_rate_policy_copy(policy);
 331         if (!copy) {
 332                 status = LTTNG_ACTION_STATUS_ERROR;
 333                 goto end;
 334         }
 335
 336         rotate_session_action = action_rotate_session_from_action(action);
 337
 338         /* Free the previous rate policy .*/
 339         lttng_rate_policy_destroy(rotate_session_action->policy);
 340
 341         /* Assign the policy. */
 342         rotate_session_action->policy = copy;
 343         status = LTTNG_ACTION_STATUS_OK;
 344         copy = NULL;
 345
 346 end:
 347         lttng_rate_policy_destroy(copy);
 348         return status;
 349 }
 350
 351 enum lttng_action_status lttng_action_rotate_session_get_rate_policy(
 352                 const struct lttng_action *action,
 353                 const struct lttng_rate_policy **policy)
 354 {
 355         enum lttng_action_status status;
 356         const struct lttng_action_rotate_session *rotate_session_action;
 357
 358         if (!action || !policy || !IS_ROTATE_SESSION_ACTION(action)) {
 359                 status = LTTNG_ACTION_STATUS_INVALID;
 360                 goto end;
 361         }
 362
 363         rotate_session_action = action_rotate_session_from_action_const(action);
 364
 365         *policy = rotate_session_action->policy;
 366         status = LTTNG_ACTION_STATUS_OK;
 367 end:
 368         return status;
 369 }
 370
 371 static const struct lttng_rate_policy *
 372 lttng_action_rotate_session_internal_get_rate_policy(
 373                 const struct lttng_action *action)
 374 {
 375         const struct lttng_action_rotate_session *_action;
 376         _action = action_rotate_session_from_action_const(action);
 377
 378         return _action->policy;
 379 }