Standardize lttng command line usage text
[lttng-tools.git] / src / bin / lttng / commands / stop.c
1 /*
2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
3 *
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.
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 *
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.
16 */
17
18 #define _GNU_SOURCE
19 #include <popt.h>
20 #include <stdio.h>
21 #include <stdlib.h>
22 #include <string.h>
23 #include <sys/stat.h>
24 #include <sys/types.h>
25 #include <unistd.h>
26
27 #include "../command.h"
28
29 #include <common/sessiond-comm/sessiond-comm.h>
30
31 static char *opt_session_name;
32
33 enum {
34 OPT_HELP = 1,
35 OPT_LIST_OPTIONS,
36 };
37
38 static struct poptOption long_options[] = {
39 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
40 {"help", 'h', POPT_ARG_NONE, 0, OPT_HELP, 0, 0},
41 {"list-options", 0, POPT_ARG_NONE, NULL, OPT_LIST_OPTIONS, NULL, NULL},
42 {0, 0, 0, 0, 0, 0, 0}
43 };
44
45 /*
46 * usage
47 */
48 static void usage(FILE *ofp)
49 {
50 fprintf(ofp, "usage: lttng stop [NAME] [OPTIONS]\n");
51 fprintf(ofp, "\n");
52 fprintf(ofp, "Where NAME is an optional session name. If not specified, lttng will\n");
53 fprintf(ofp, "get it from the configuration directory (.lttng).\n");
54 fprintf(ofp, "\n");
55 fprintf(ofp, "Options:\n");
56 fprintf(ofp, " -h, --help Show this help\n");
57 fprintf(ofp, " --list-options Simple listing of options\n");
58 fprintf(ofp, "\n");
59 }
60
61 /*
62 * Start tracing for all trace of the session.
63 */
64 static int stop_tracing(void)
65 {
66 int ret;
67 char *session_name;
68
69 if (opt_session_name == NULL) {
70 session_name = get_session_name();
71 if (session_name == NULL) {
72 ret = CMD_ERROR;
73 goto error;
74 }
75 } else {
76 session_name = opt_session_name;
77 }
78
79 ret = lttng_stop_tracing(session_name);
80 if (ret < 0) {
81 switch (-ret) {
82 case LTTCOMM_TRACE_ALREADY_STOPPED:
83 WARN("Tracing already stopped for session %s", session_name);
84 break;
85 default:
86 ERR("%s", lttng_strerror(ret));
87 break;
88 }
89 goto free_name;
90 }
91
92 ret = CMD_SUCCESS;
93
94 MSG("Tracing stopped for session %s", session_name);
95
96 free_name:
97 if (opt_session_name == NULL) {
98 free(session_name);
99 }
100
101 error:
102 return ret;
103 }
104
105 /*
106 * cmd_stop
107 *
108 * The 'stop <options>' first level command
109 */
110 int cmd_stop(int argc, const char **argv)
111 {
112 int opt, ret = CMD_SUCCESS;
113 static poptContext pc;
114
115 pc = poptGetContext(NULL, argc, argv, long_options, 0);
116 poptReadDefaultConfig(pc, 0);
117
118 while ((opt = poptGetNextOpt(pc)) != -1) {
119 switch (opt) {
120 case OPT_HELP:
121 usage(stdout);
122 goto end;
123 case OPT_LIST_OPTIONS:
124 list_cmd_options(stdout, long_options);
125 goto end;
126 default:
127 usage(stderr);
128 ret = CMD_UNDEFINED;
129 goto end;
130 }
131 }
132
133 opt_session_name = (char*) poptGetArg(pc);
134
135 ret = stop_tracing();
136
137 end:
138 poptFreeContext(pc);
139 return ret;
140 }
This page took 0.031313 seconds and 4 git commands to generate.