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