Implement snapshot commands in lttng-sessiond
[lttng-tools.git] / src / bin / lttng / commands / create.c
CommitLineData
f3ed775e
DG
1/*
2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
3 *
d14d33bf
AM
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License, version 2 only,
6 * as published by the Free Software Foundation.
f3ed775e
DG
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
d14d33bf
AM
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
f3ed775e
DG
16 */
17
18#define _GNU_SOURCE
a4b92340 19#include <assert.h>
f3ed775e
DG
20#include <popt.h>
21#include <stdio.h>
22#include <stdlib.h>
23#include <string.h>
24#include <sys/stat.h>
25#include <sys/types.h>
26#include <time.h>
27#include <unistd.h>
28
c399183f 29#include "../command.h"
679b4943 30#include "../utils.h"
f3ed775e 31
00e2e675 32#include <common/defaults.h>
42224349 33#include <common/sessiond-comm/sessiond-comm.h>
00e2e675 34#include <common/uri.h>
81b86775 35#include <common/utils.h>
42224349 36
f3ed775e
DG
37static char *opt_output_path;
38static char *opt_session_name;
a4b92340
DG
39static char *opt_url;
40static char *opt_ctrl_url;
41static char *opt_data_url;
42static int opt_no_consumer;
43static int opt_disable_consumer;
f3ed775e
DG
44
45enum {
46 OPT_HELP = 1,
679b4943 47 OPT_LIST_OPTIONS,
f3ed775e
DG
48};
49
50static struct poptOption long_options[] = {
51 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
679b4943
SM
52 {"help", 'h', POPT_ARG_NONE, NULL, OPT_HELP, NULL, NULL},
53 {"output", 'o', POPT_ARG_STRING, &opt_output_path, 0, NULL, NULL},
54 {"list-options", 0, POPT_ARG_NONE, NULL, OPT_LIST_OPTIONS, NULL, NULL},
23d14dff
DG
55 {"set-url", 'U', POPT_ARG_STRING, &opt_url, 0, 0, 0},
56 {"ctrl-url", 'C', POPT_ARG_STRING, &opt_ctrl_url, 0, 0, 0},
57 {"data-url", 'D', POPT_ARG_STRING, &opt_data_url, 0, 0, 0},
a4b92340
DG
58 {"no-consumer", 0, POPT_ARG_VAL, &opt_no_consumer, 1, 0, 0},
59 {"disable-consumer", 0, POPT_ARG_VAL, &opt_disable_consumer, 1, 0, 0},
f3ed775e
DG
60 {0, 0, 0, 0, 0, 0, 0}
61};
62
16de1a24
DG
63/*
64 * Please have a look at src/lib/lttng-ctl/lttng-ctl.c for more information on
65 * why this declaration exists and used ONLY in for this command.
66 */
07424f16
DG
67extern int _lttng_create_session_ext(const char *name, const char *url,
68 const char *datetime);
69
f3ed775e
DG
70/*
71 * usage
72 */
73static void usage(FILE *ofp)
74{
a4b92340 75 fprintf(ofp, "usage: lttng create [NAME] [OPTIONS] \n");
f3ed775e 76 fprintf(ofp, "\n");
a4b92340
DG
77 fprintf(ofp, "Without a given NAME, the default is 'auto-<yyyymmdd>-<hhmmss>'\n");
78 fprintf(ofp, "\n");
79 fprintf(ofp, "Options:\n");
f3ed775e 80 fprintf(ofp, " -h, --help Show this help\n");
1c8d13c8 81 fprintf(ofp, " --list-options Simple listing of options\n");
58a97671 82 fprintf(ofp, " -o, --output PATH Specify output path for traces\n");
a4b92340
DG
83 fprintf(ofp, "\n");
84 fprintf(ofp, "Extended Options:\n");
85 fprintf(ofp, "\n");
86 fprintf(ofp, "Using these options, each API call can be controlled individually.\n");
87 fprintf(ofp, "\n");
88 fprintf(ofp, " -U, --set-url=URL Set URL destination of the trace data.\n");
00e2e675 89 fprintf(ofp, " It is persistent for the session lifetime.\n");
a4b92340
DG
90 fprintf(ofp, " This will set both data and control URL.\n");
91 fprintf(ofp, " You can change it with the enable-consumer cmd\n");
92 fprintf(ofp, " -C, --ctrl-url=URL Set control path URL. (Must use -D also)\n");
93 fprintf(ofp, " -D, --data-url=URL Set data path URL. (Must use -C also)\n");
a4b92340
DG
94 fprintf(ofp, "\n");
95 fprintf(ofp, "Please refer to the man page (lttng(1)) for more information on network\n");
96 fprintf(ofp, "streaming mechanisms and explanation of the control and data port\n");
97 fprintf(ofp, "You must have a running remote lttng-relayd for network streaming\n");
98 fprintf(ofp, "\n");
99 fprintf(ofp, "URL format is has followed:\n");
100 fprintf(ofp, "\n");
101 fprintf(ofp, " proto://[HOST|IP][:PORT1[:PORT2]][/TRACE_PATH]\n");
102 fprintf(ofp, "\n");
103 fprintf(ofp, " Supported protocols are (proto):\n");
104 fprintf(ofp, " > file://...\n");
105 fprintf(ofp, " Local filesystem full path.\n");
106 fprintf(ofp, "\n");
16de1a24 107 fprintf(ofp, " > net[6]://...\n");
a4b92340
DG
108 fprintf(ofp, " This will use the default network transport layer which is\n");
109 fprintf(ofp, " TCP for both control (PORT1) and data port (PORT2).\n");
110 fprintf(ofp, " The default ports are respectively 5342 and 5343.\n");
111 fprintf(ofp, "\n");
0ab61906 112 fprintf(ofp, " > tcp[6]://...\n");
a4b92340
DG
113 fprintf(ofp, " Can only be used with -C and -D together\n");
114 fprintf(ofp, "\n");
115 fprintf(ofp, "NOTE: IPv6 address MUST be enclosed in brackets '[]' (rfc2732)\n");
116 fprintf(ofp, "\n");
117 fprintf(ofp, "Examples:\n");
118 fprintf(ofp, " # lttng create -U net://192.168.1.42\n");
119 fprintf(ofp, " Uses TCP and default ports for the given destination.\n");
120 fprintf(ofp, " # lttng create -U net6://[fe80::f66d:4ff:fe53:d220]\n");
121 fprintf(ofp, " Uses TCP, default ports and IPv6.\n");
122 fprintf(ofp, " # lttng create s1 -U net://myhost.com:3229\n");
123 fprintf(ofp, " Set the consumer to the remote HOST on port 3229 for control.\n");
f3ed775e
DG
124 fprintf(ofp, "\n");
125}
126
00e2e675 127/*
a4b92340 128 * For a session name, set the consumer URLs.
00e2e675 129 */
a4b92340
DG
130static int set_consumer_url(const char *session_name, const char *ctrl_url,
131 const char *data_url)
00e2e675 132{
a4b92340
DG
133 int ret;
134 struct lttng_handle *handle;
135 struct lttng_domain dom;
136
137 assert(session_name);
138
139 /*
140 * Set handle with the session name and the domain set to 0. This means to
141 * the session daemon that the next action applies on the tracing session
142 * rather then the domain specific session.
143 */
144 memset(&dom, 0, sizeof(dom));
145
146 handle = lttng_create_handle(session_name, &dom);
147 if (handle == NULL) {
148 ret = CMD_FATAL;
149 goto error;
150 }
00e2e675 151
a4b92340
DG
152 ret = lttng_set_consumer_url(handle, ctrl_url, data_url);
153 if (ret < 0) {
154 goto error;
00e2e675
DG
155 }
156
a4b92340
DG
157 if (ctrl_url) {
158 MSG("Control URL %s set for session %s", ctrl_url, session_name);
00e2e675
DG
159 }
160
a4b92340
DG
161 if (data_url) {
162 MSG("Data URL %s set for session %s", data_url, session_name);
163 }
164
165error:
166 lttng_destroy_handle(handle);
167 return ret;
168}
169
f3ed775e 170/*
1c8d13c8
TD
171 * Create a tracing session.
172 * If no name is specified, a default name is generated.
f3ed775e 173 *
1c8d13c8 174 * Returns one of the CMD_* result constants.
f3ed775e 175 */
a4b92340 176static int create_session(void)
f3ed775e 177{
a4b92340 178 int ret;
07424f16 179 char *session_name = NULL, *traces_path = NULL, *alloc_path = NULL;
a4b92340 180 char *alloc_url = NULL, *url = NULL, datetime[16];
487b253b 181 char session_name_date[NAME_MAX + 17], *print_str_url = NULL;
f3ed775e
DG
182 time_t rawtime;
183 struct tm *timeinfo;
184
d6175221
DG
185 /* Get date and time for automatic session name/path */
186 time(&rawtime);
187 timeinfo = localtime(&rawtime);
188 strftime(datetime, sizeof(datetime), "%Y%m%d-%H%M%S", timeinfo);
189
f3ed775e
DG
190 /* Auto session name creation */
191 if (opt_session_name == NULL) {
07424f16
DG
192 ret = snprintf(session_name_date, sizeof(session_name_date),
193 DEFAULT_SESSION_NAME "-%s", datetime);
d6175221 194 if (ret < 0) {
07424f16
DG
195 PERROR("snprintf session name");
196 goto error;
197 }
04965770 198 session_name = session_name_date;
07424f16 199 DBG("Auto session name set to %s", session_name_date);
f3ed775e 200 } else {
487b253b
DG
201 if (strlen(opt_session_name) > NAME_MAX) {
202 ERR("Session name too long. Length must be lower or equal to %d",
203 NAME_MAX);
204 ret = LTTNG_ERR_SESSION_FAIL;
205 goto error;
206 }
4b861950
DG
207 /*
208 * Check if the session name begins with "auto-" or is exactly "auto".
209 * Both are reserved for the default session name. See bug #449 to
210 * understand why we need to check both here.
211 */
212 if ((strncmp(opt_session_name, DEFAULT_SESSION_NAME "-",
213 strlen(DEFAULT_SESSION_NAME) + 1) == 0) ||
214 (strncmp(opt_session_name, DEFAULT_SESSION_NAME,
61b35a5a 215 strlen(DEFAULT_SESSION_NAME)) == 0 &&
4b861950 216 strlen(opt_session_name) == strlen(DEFAULT_SESSION_NAME))) {
61b35a5a
DG
217 ERR("%s is a reserved keyword for default session(s)",
218 DEFAULT_SESSION_NAME);
219 ret = CMD_ERROR;
220 goto error;
221 }
f3ed775e 222 session_name = opt_session_name;
07424f16
DG
223 ret = snprintf(session_name_date, sizeof(session_name_date),
224 "%s-%s", session_name, datetime);
225 if (ret < 0) {
226 PERROR("snprintf session name");
227 goto error;
228 }
f3ed775e
DG
229 }
230
785d2d0d 231 if (opt_output_path != NULL) {
81b86775 232 traces_path = utils_expand_path(opt_output_path);
00e2e675
DG
233 if (traces_path == NULL) {
234 ret = CMD_ERROR;
235 goto error;
236 }
237
a4b92340
DG
238 /* Create URL string from the local filesytem path */
239 ret = asprintf(&alloc_url, "file://%s", traces_path);
00e2e675 240 if (ret < 0) {
a4b92340 241 PERROR("asprintf url path");
00e2e675
DG
242 ret = CMD_FATAL;
243 goto error;
244 }
a4b92340
DG
245 /* URL to use in the lttng_create_session() call */
246 url = alloc_url;
40b03f52 247 print_str_url = traces_path;
a4b92340
DG
248 } else if (opt_url) { /* Handling URL (-U opt) */
249 url = opt_url;
40b03f52 250 print_str_url = url;
4f50c803 251 } else {
00e2e675 252 /* Auto output path */
feb0f3e5 253 alloc_path = utils_get_home_dir();
f3ed775e 254 if (alloc_path == NULL) {
d386b234 255 ERR("HOME path not found.\n \
00e2e675 256 Please specify an output path using -o, --output PATH");
f3ed775e
DG
257 ret = CMD_FATAL;
258 goto error;
259 }
d386b234 260 alloc_path = strdup(alloc_path);
f3ed775e 261
07424f16
DG
262 ret = asprintf(&alloc_url,
263 "file://%s/" DEFAULT_TRACE_DIR_NAME "/%s",
264 alloc_path, session_name_date);
58a97671 265 if (ret < 0) {
00e2e675
DG
266 PERROR("asprintf trace dir name");
267 ret = CMD_FATAL;
58a97671
DG
268 goto error;
269 }
00e2e675 270
a4b92340 271 url = alloc_url;
4f50c803
DG
272 if (!opt_data_url && !opt_ctrl_url) {
273 print_str_url = alloc_url + strlen("file://");
274 }
00e2e675
DG
275 }
276
4f50c803
DG
277 if ((!opt_ctrl_url && opt_data_url) || (opt_ctrl_url && !opt_data_url)) {
278 ERR("You need both control and data URL.");
279 ret = CMD_ERROR;
280 goto error;
281 }
785d2d0d 282
07424f16 283 ret = _lttng_create_session_ext(session_name, url, datetime);
f3ed775e 284 if (ret < 0) {
ae856491 285 /* Don't set ret so lttng can interpret the sessiond error. */
42224349 286 switch (-ret) {
f73fabfd 287 case LTTNG_ERR_EXIST_SESS:
42224349
DG
288 WARN("Session %s already exists", session_name);
289 break;
60e835ca 290 default:
60e835ca 291 break;
42224349 292 }
f3ed775e
DG
293 goto error;
294 }
295
0ab61906 296 if (opt_ctrl_url && opt_data_url) {
a4b92340
DG
297 /* Setting up control URI (-C or/and -D opt) */
298 ret = set_consumer_url(session_name, opt_ctrl_url, opt_data_url);
299 if (ret < 0) {
4f50c803
DG
300 /* Destroy created session because the URL are not valid. */
301 lttng_destroy_session(session_name);
a4b92340
DG
302 goto error;
303 }
4f50c803
DG
304 }
305
306 MSG("Session %s created.", session_name);
307 if (print_str_url) {
308 MSG("Traces will be written in %s", print_str_url);
a4b92340
DG
309 }
310
58a97671
DG
311 /* Init lttng session config */
312 ret = config_init(session_name);
f3ed775e 313 if (ret < 0) {
27089920 314 ret = CMD_ERROR;
f3ed775e
DG
315 goto error;
316 }
317
f3ed775e
DG
318 ret = CMD_SUCCESS;
319
320error:
0e428499
DG
321 free(alloc_url);
322 free(traces_path);
87f222b6 323 free(alloc_path);
a4b92340
DG
324
325 if (ret < 0) {
326 ERR("%s", lttng_strerror(ret));
327 }
f3ed775e
DG
328 return ret;
329}
330
331/*
74cc1d0f 332 * The 'create <options>' first level command
1c8d13c8
TD
333 *
334 * Returns one of the CMD_* result constants.
f3ed775e
DG
335 */
336int cmd_create(int argc, const char **argv)
337{
338 int opt, ret = CMD_SUCCESS;
339 static poptContext pc;
340
341 pc = poptGetContext(NULL, argc, argv, long_options, 0);
342 poptReadDefaultConfig(pc, 0);
343
344 while ((opt = poptGetNextOpt(pc)) != -1) {
345 switch (opt) {
346 case OPT_HELP:
27089920 347 usage(stdout);
f3ed775e 348 goto end;
679b4943
SM
349 case OPT_LIST_OPTIONS:
350 list_cmd_options(stdout, long_options);
679b4943 351 goto end;
f3ed775e
DG
352 default:
353 usage(stderr);
354 ret = CMD_UNDEFINED;
355 goto end;
356 }
357 }
358
785d2d0d
DG
359 if (opt_no_consumer) {
360 MSG("The option --no-consumer is obsolete.");
361 ret = CMD_WARNING;
362 goto end;
363 }
364
365 if (opt_disable_consumer) {
366 MSG("The option --disable-consumer is obsolete.");
367 ret = CMD_WARNING;
368 goto end;
369 }
370
f3ed775e
DG
371 opt_session_name = (char*) poptGetArg(pc);
372
373 ret = create_session();
374
375end:
ca1c3607 376 poptFreeContext(pc);
f3ed775e
DG
377 return ret;
378}
This page took 0.049681 seconds and 4 git commands to generate.