2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
3 * Copyright (C) 2015 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License, version 2 only,
7 * as published by the Free Software Foundation.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License along
15 * with this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
27 #include <sys/types.h>
31 #include <urcu/list.h>
33 #include <common/mi-lttng.h>
35 #include "../command.h"
42 static char *opt_session_name
;
43 static int opt_kernel
;
44 static int opt_userspace
;
46 static char *opt_pid_string
;
56 static struct poptOption long_options
[] = {
57 /* { longName, shortName, argInfo, argPtr, value, descrip, argDesc, } */
58 { "help", 'h', POPT_ARG_NONE
, 0, OPT_HELP
, 0, 0, },
59 { "session", 's', POPT_ARG_STRING
, &opt_session_name
, OPT_SESSION
, 0, 0, },
60 { "kernel", 'k', POPT_ARG_VAL
, &opt_kernel
, 1, 0, 0, },
61 { "userspace", 'u', POPT_ARG_VAL
, &opt_userspace
, 1, 0, 0, },
62 { "pid", 'p', POPT_ARG_STRING
| POPT_ARGFLAG_OPTIONAL
, &opt_pid_string
, OPT_PID
, 0, 0, },
63 { "all", 'a', POPT_ARG_VAL
, &opt_all
, 1, 0, 0, },
64 { "list-options", 0, POPT_ARG_NONE
, NULL
, OPT_LIST_OPTIONS
, 0, 0, },
65 { 0, 0, 0, 0, 0, 0, 0, },
71 static void usage(FILE *ofp
, const char *cmd_str
)
73 fprintf(ofp
, "usage: lttng %s [-k|-u] [OPTIONS]\n", cmd_str
);
75 fprintf(ofp
, "If no session is given (-s), the context is added to\n");
76 fprintf(ofp
, "the current sesssion. Exactly one domain (-k or -u)\n");
77 fprintf(ofp
, "must be specified.\n");
79 fprintf(ofp
, "Options:\n");
80 fprintf(ofp
, " -h, --help Show this help.\n");
81 fprintf(ofp
, " --list-options Simple listing of options.\n");
82 fprintf(ofp
, " -s, --session NAME Apply to session name.\n");
83 fprintf(ofp
, " -k, --kernel Apply to the kernel tracer.\n");
84 fprintf(ofp
, " -u, --userspace Apply to the user-space tracer.\n");
85 fprintf(ofp
, " -p, --pid [PID] Process ID tracker. Leave PID empty when used with --all.\n");
86 fprintf(ofp
, " -a, --all All PIDs (use with --pid).\n");
91 int parse_pid_string(const char *_pid_string
,
92 int all
, int **_pid_list
, int *nr_pids
)
94 const char *one_pid_str
;
96 int retval
= CMD_SUCCESS
;
99 char *pid_string
= NULL
;
102 if (all
&& _pid_string
) {
103 ERR("An empty PID string is expected with --all");
107 if (!all
&& !_pid_string
) {
108 ERR("Please specify --all with an empty PID string");
113 pid_list
= zmalloc(sizeof(*_pid_list
));
115 ERR("Out of memory");
119 /* Empty PID string means all PIDs */
125 pid_string
= strdup(_pid_string
);
127 ERR("Out of memory");
133 one_pid_str
= strtok_r(pid_string
, ",", &iter
);
134 while (one_pid_str
!= NULL
) {
138 v
= strtoul(one_pid_str
, &endptr
, 10);
139 if ((v
== 0 && errno
== EINVAL
)
140 || (v
== ULONG_MAX
&& errno
== ERANGE
)
141 || (*one_pid_str
!= '\0' && *endptr
!= '\0')){
142 ERR("Error parsing PID %s", one_pid_str
);
147 if ((long) v
> INT_MAX
|| (int) v
< 0) {
148 ERR("Invalid PID value %ld", (long) v
);
155 one_pid_str
= strtok_r(NULL
, ",", &iter
);
159 /* Identity of delimiter has been lost in first pass. */
160 pid_string
= strdup(_pid_string
);
162 ERR("Out of memory");
168 pid_list
= zmalloc(count
* sizeof(*pid_list
));
170 ERR("Out of memory");
177 one_pid_str
= strtok_r(pid_string
, ",", &iter
);
178 while (one_pid_str
!= NULL
) {
181 v
= strtoul(one_pid_str
, NULL
, 10);
182 pid_list
[count
++] = (int) v
;
185 one_pid_str
= strtok_r(NULL
, ",", &iter
);
190 *_pid_list
= pid_list
;
191 goto end
; /* SUCCESS */
202 enum cmd_error_code
track_untrack_pid(enum cmd_type cmd_type
, const char *cmd_str
,
203 const char *session_name
, const char *pid_string
,
204 int all
, struct mi_writer
*writer
)
206 int ret
, success
= 1 , i
;
207 enum cmd_error_code retval
= CMD_SUCCESS
;
208 int *pid_list
= NULL
;
210 struct lttng_domain dom
;
211 struct lttng_handle
*handle
= NULL
;
212 int (*cmd_func
)(struct lttng_handle
*handle
, int pid
);
216 cmd_func
= lttng_track_pid
;
219 cmd_func
= lttng_untrack_pid
;
222 ERR("Unknown command");
227 memset(&dom
, 0, sizeof(dom
));
229 dom
.type
= LTTNG_DOMAIN_KERNEL
;
230 } else if (opt_userspace
) {
231 dom
.type
= LTTNG_DOMAIN_UST
;
233 /* Checked by the caller. */
237 ret
= parse_pid_string(pid_string
, all
, &pid_list
, &nr_pids
);
238 if (ret
!= CMD_SUCCESS
) {
239 ERR("Error parsing PID string");
240 usage(stderr
, cmd_str
);
245 handle
= lttng_create_handle(session_name
, &dom
);
246 if (handle
== NULL
) {
252 /* Open process element */
253 ret
= mi_lttng_targets_open(writer
);
260 for (i
= 0; i
< nr_pids
; i
++) {
261 DBG("%s PID %d", cmd_str
, pid_list
[i
]);
262 ret
= cmd_func(handle
, pid_list
[i
]);
265 case LTTNG_ERR_PID_TRACKED
:
266 WARN("PID %i already tracked in session %s",
267 pid_list
[i
], session_name
);
269 retval
= CMD_SUCCESS
;
271 case LTTNG_ERR_PID_NOT_TRACKED
:
272 WARN("PID %i not tracked in session %s",
273 pid_list
[i
], session_name
);
275 retval
= CMD_SUCCESS
;
278 ERR("%s", lttng_strerror(ret
));
284 MSG("PID %i %sed in session %s",
285 pid_list
[i
], cmd_str
, session_name
);
291 ret
= mi_lttng_pid_target(writer
, pid_list
[i
], 1);
297 ret
= mi_lttng_writer_write_element_bool(writer
,
298 mi_lttng_element_success
, success
);
304 ret
= mi_lttng_writer_close_element(writer
);
313 /* Close targets element */
314 ret
= mi_lttng_writer_close_element(writer
);
323 lttng_destroy_handle(handle
);
330 const char *get_mi_element_command(enum cmd_type cmd_type
)
334 return mi_lttng_element_command_track
;
336 return mi_lttng_element_command_untrack
;
343 * Add/remove tracker to/from session.
346 int cmd_track_untrack(enum cmd_type cmd_type
, const char *cmd_str
,
347 int argc
, const char **argv
)
350 enum cmd_error_code command_ret
= CMD_SUCCESS
;
352 static poptContext pc
;
353 char *session_name
= NULL
;
354 struct mi_writer
*writer
= NULL
;
357 usage(stderr
, cmd_str
);
358 command_ret
= CMD_ERROR
;
362 pc
= poptGetContext(NULL
, argc
, argv
, long_options
, 0);
363 poptReadDefaultConfig(pc
, 0);
365 while ((opt
= poptGetNextOpt(pc
)) != -1) {
368 usage(stdout
, cmd_str
);
370 case OPT_LIST_OPTIONS
:
371 list_cmd_options(stdout
, long_options
);
378 usage(stderr
, cmd_str
);
379 command_ret
= CMD_UNDEFINED
;
384 ret
= print_missing_or_multiple_domains(opt_kernel
+ opt_userspace
);
390 if (!opt_session_name
) {
391 session_name
= get_session_name();
392 if (session_name
== NULL
) {
393 command_ret
= CMD_ERROR
;
397 session_name
= opt_session_name
;
400 /* Currently only PID tracker is supported */
402 ERR("Please specify at least one tracker with its expected arguments");
403 usage(stderr
, cmd_str
);
404 command_ret
= CMD_ERROR
;
410 writer
= mi_lttng_writer_create(fileno(stdout
), lttng_opt_mi
);
412 command_ret
= CMD_ERROR
;
418 /* Open command element */
419 ret
= mi_lttng_writer_command_open(writer
,
420 get_mi_element_command(cmd_type
));
422 command_ret
= CMD_ERROR
;
426 /* Open output element */
427 ret
= mi_lttng_writer_open_element(writer
,
428 mi_lttng_element_command_output
);
430 command_ret
= CMD_ERROR
;
435 command_ret
= track_untrack_pid(cmd_type
,
436 cmd_str
, session_name
, opt_pid_string
,
438 if (command_ret
!= CMD_SUCCESS
) {
444 /* Close output element */
445 ret
= mi_lttng_writer_close_element(writer
);
447 command_ret
= CMD_ERROR
;
452 ret
= mi_lttng_writer_write_element_bool(writer
,
453 mi_lttng_element_command_success
, success
);
455 command_ret
= CMD_ERROR
;
459 /* Command element close */
460 ret
= mi_lttng_writer_command_close(writer
);
462 command_ret
= CMD_ERROR
;
468 if (!opt_session_name
) {
473 if (writer
&& mi_lttng_writer_destroy(writer
)) {
474 /* Preserve original error code */
475 command_ret
= CMD_ERROR
;
479 return (int) command_ret
;
482 int cmd_track(int argc
, const char **argv
)
484 return cmd_track_untrack(CMD_TRACK
, "track", argc
, argv
);
487 int cmd_untrack(int argc
, const char **argv
)
489 return cmd_track_untrack(CMD_UNTRACK
, "untrack", argc
, argv
);