src/lib/lttng-ctl/save.c

   1 /*
   2  * Copyright (C) 2013 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
   3  *
   4  * This library is free software; you can redistribute it and/or modify it
   5  * under the terms of the GNU Lesser General Public License, version 2.1 only,
   6  * as published by the Free Software Foundation.
   7  *
   8  * This library is distributed in the hope that it will be useful, but WITHOUT
   9  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  10  * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
  11  * for more details.
  12  *
  13  * You should have received a copy of the GNU Lesser General Public License
  14  * along with this library; if not, write to the Free Software Foundation,
  15  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  16  */
  17
  18 #define _LGPL_SOURCE
  19 #include <assert.h>
  20 #include <string.h>
  21
  22 #include <lttng/lttng-error.h>
  23 #include <lttng/save.h>
  24 #include <lttng/save-internal.h>
  25 #include <common/sessiond-comm/sessiond-comm.h>
  26
  27 #include "lttng-ctl-helper.h"
  28
  29 struct lttng_save_session_attr *lttng_save_session_attr_create(void)
  30 {
  31         return zmalloc(sizeof(struct lttng_save_session_attr));
  32 }
  33
  34 void lttng_save_session_attr_destroy(struct lttng_save_session_attr *output)
  35 {
  36         if (output) {
  37                 free(output);
  38         }
  39 }
  40
  41 const char *lttng_save_session_attr_get_session_name(
  42         struct lttng_save_session_attr *attr)
  43 {
  44         const char *ret = NULL;
  45
  46         if (attr && attr->session_name[0]) {
  47                 ret = attr->session_name;
  48         }
  49
  50         return ret;
  51 }
  52
  53 const char *lttng_save_session_attr_get_output_url(
  54         struct lttng_save_session_attr *attr)
  55 {
  56         const char *ret = NULL;
  57
  58         if (attr && attr->configuration_url[0]) {
  59                 ret = attr->configuration_url;
  60         }
  61
  62         return ret;
  63 }
  64
  65 int lttng_save_session_attr_get_overwrite(
  66         struct lttng_save_session_attr *attr)
  67 {
  68         return attr ? attr->overwrite : -LTTNG_ERR_INVALID;
  69 }
  70
  71 int lttng_save_session_attr_get_omit_name(
  72         struct lttng_save_session_attr *attr)
  73 {
  74         return attr ? attr->omit_name : -LTTNG_ERR_INVALID;
  75 }
  76
  77 int lttng_save_session_attr_get_omit_output(
  78         struct lttng_save_session_attr *attr)
  79 {
  80         return attr ? attr->omit_output : -LTTNG_ERR_INVALID;
  81 }
  82
  83 int lttng_save_session_attr_set_session_name(
  84         struct lttng_save_session_attr *attr, const char *session_name)
  85 {
  86         int ret = 0;
  87
  88         if (!attr) {
  89                 ret = -LTTNG_ERR_INVALID;
  90                 goto error;
  91         }
  92
  93         if (session_name) {
  94                 size_t len;
  95
  96                 len = strlen(session_name);
  97                 if (len >= LTTNG_NAME_MAX) {
  98                         ret = -LTTNG_ERR_INVALID;
  99                         goto error;
 100                 }
 101
 102                 strncpy(attr->session_name, session_name, len);
 103         } else {
 104                 attr->session_name[0] = '\0';
 105         }
 106 error:
 107         return ret;
 108 }
 109
 110 int lttng_save_session_attr_set_output_url(
 111         struct lttng_save_session_attr *attr, const char *url)
 112 {
 113         int ret = 0;
 114         size_t len;
 115         ssize_t size;
 116         struct lttng_uri *uris = NULL;
 117
 118         if (!attr) {
 119                 ret = -LTTNG_ERR_INVALID;
 120                 goto error;
 121         }
 122
 123         if (!url) {
 124                 attr->configuration_url[0] = '\0';
 125                 ret = 0;
 126                 goto end;
 127         }
 128
 129         len = strlen(url);
 130         if (len >= PATH_MAX) {
 131                 ret = -LTTNG_ERR_INVALID;
 132                 goto error;
 133         }
 134
 135         size = uri_parse_str_urls(url, NULL, &uris);
 136         if (size <= 0 || uris[0].dtype != LTTNG_DST_PATH) {
 137                 ret = -LTTNG_ERR_INVALID;
 138                 goto error;
 139         }
 140
 141         /* Copy string plus the NULL terminated byte. */
 142         lttng_ctl_copy_string(attr->configuration_url, uris[0].dst.path,
 143                         sizeof(attr->configuration_url));
 144
 145 end:
 146 error:
 147         free(uris);
 148         return ret;
 149 }
 150
 151 int lttng_save_session_attr_set_overwrite(
 152         struct lttng_save_session_attr *attr, int overwrite)
 153 {
 154         int ret = 0;
 155
 156         if (!attr) {
 157                 ret = -LTTNG_ERR_INVALID;
 158                 goto end;
 159         }
 160
 161         attr->overwrite = !!overwrite;
 162 end:
 163         return ret;
 164 }
 165
 166 int lttng_save_session_attr_set_omit_name(
 167         struct lttng_save_session_attr *attr, int omit_name)
 168 {
 169         int ret = 0;
 170
 171         if (!attr) {
 172                 ret = -LTTNG_ERR_INVALID;
 173                 goto end;
 174         }
 175
 176         attr->omit_name = !!omit_name;
 177 end:
 178         return ret;
 179 }
 180
 181 int lttng_save_session_attr_set_omit_output(
 182         struct lttng_save_session_attr *attr, int omit_output)
 183 {
 184         int ret = 0;
 185
 186         if (!attr) {
 187                 ret = -LTTNG_ERR_INVALID;
 188                 goto end;
 189         }
 190
 191         attr->omit_output = !!omit_output;
 192 end:
 193         return ret;
 194 }
 195
 196 /*
 197  * The lttng-ctl API does not expose all the information needed to save the
 198  * session configurations. Thus, we must send a save command to the session
 199  * daemon which will, in turn, save its current session configuration.
 200  */
 201 int lttng_save_session(struct lttng_save_session_attr *attr)
 202 {
 203         struct lttcomm_session_msg lsm;
 204         int ret;
 205
 206         if (!attr) {
 207                 ret = -LTTNG_ERR_INVALID;
 208                 goto end;
 209         }
 210
 211         memset(&lsm, 0, sizeof(lsm));
 212         lsm.cmd_type = LTTNG_SAVE_SESSION;
 213
 214         memcpy(&lsm.u.save_session.attr, attr,
 215                 sizeof(struct lttng_save_session_attr));
 216         ret = lttng_ctl_ask_sessiond(&lsm, NULL);
 217 end:
 218         return ret;
 219 }