Add tags from ctags to gitignore
[lttng-tools.git] / lttng / options.c
CommitLineData
826d496d
MD
1/*
2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
fac6795d
DG
3 *
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public License
6 * as published by the Free Software Foundation; either version 2
7 * of the License, or (at your option) any later version.
8 *
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.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
fac6795d
DG
17 */
18
19#include <popt.h>
20#include <stdlib.h>
21
22#include "lttng.h"
23
24/* Option variables */
894be886 25char *opt_event_list;
fac6795d 26char *opt_tracing_group;
5b8719f5 27char *opt_sessiond_path;
96243366 28char *opt_session_name;
894be886
DG
29char *opt_trace_name;
30int opt_destroy_trace;
96243366
DG
31int opt_create_session;
32int opt_destroy_session;
fac6795d
DG
33int opt_trace_kernel = 0;
34int opt_quiet = 0;
35int opt_verbose = 0;
36int opt_list_apps = 0;
5b8719f5 37int opt_no_sessiond = 0;
57167058 38int opt_list_session = 0;
1657e9bb 39int opt_list_traces = 0;
894be886 40int opt_create_trace;
ad874cce
DG
41int opt_start_trace = 0;
42int opt_stop_trace = 0;
894be886
DG
43int opt_enable_event;
44int opt_disable_event;
20fe2104 45int opt_kern_create_channel;
ad874cce 46pid_t opt_trace_pid = 0;
fac6795d
DG
47
48enum {
5461b305 49 OPT_HELP = 1,
894be886
DG
50 OPT_ENABLE_EVENT,
51 OPT_DISABLE_EVENT,
96243366 52 OPT_CREATE_SESSION,
894be886 53 OPT_CREATE_TRACE,
96243366 54 OPT_DESTROY_SESSION,
894be886
DG
55 OPT_DESTROY_TRACE,
56 OPT_START_TRACE,
57 OPT_STOP_TRACE,
fac6795d
DG
58};
59
60static struct poptOption long_options[] = {
61 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
96243366 62 {"create-session", 'c', POPT_ARG_STRING, 0, OPT_CREATE_SESSION, 0, 0},
894be886
DG
63 {"create-trace", 'C', POPT_ARG_STRING | POPT_ARGFLAG_OPTIONAL, 0, OPT_CREATE_TRACE, 0, 0},
64 {"destroy-trace", 'D', POPT_ARG_STRING | POPT_ARGFLAG_OPTIONAL, 0, OPT_DESTROY_TRACE, 0, 0},
96243366 65 {"destroy-session", 'd', POPT_ARG_STRING, 0, OPT_DESTROY_SESSION, 0, 0},
894be886
DG
66 {"disable-event", 0, POPT_ARG_STRING, 0, OPT_DISABLE_EVENT, 0, 0},
67 {"enable-event", 'e', POPT_ARG_STRING, 0, OPT_ENABLE_EVENT, 0, 0},
96243366 68 {"group", 0, POPT_ARG_STRING, &opt_tracing_group, 0, 0, 0},
df0da139 69 {"help", 'h', POPT_ARG_NONE, 0, OPT_HELP, 0, 0},
894be886 70 {"kernel", 'k', POPT_ARG_VAL, &opt_trace_kernel, 1, 0, 0},
20fe2104 71 {"kern-create-channel",0, POPT_ARG_VAL, &opt_kern_create_channel, 1, 0, 0},
df0da139
DG
72 {"list-apps", 'L', POPT_ARG_VAL, &opt_list_apps, 1, 0, 0},
73 {"list-sessions", 'l', POPT_ARG_VAL, &opt_list_session, 1, 0, 0},
1657e9bb 74 {"list-traces", 't', POPT_ARG_VAL, &opt_list_traces, 1, 0, 0},
fac6795d 75 {"no-kernel", 0, POPT_ARG_VAL, &opt_trace_kernel, 0, 0, 0},
df0da139 76 {"no-sessiond", 0, POPT_ARG_VAL, &opt_no_sessiond, 1, 0, 0},
ad874cce 77 {"pid", 'p', POPT_ARG_INT, &opt_trace_pid, 0, 0, 0},
df0da139 78 {"quiet", 'q', POPT_ARG_VAL, &opt_quiet, 1, 0, 0},
894be886 79 {"session", 's', POPT_ARG_STRING, &opt_session_name, 0, 0, 0},
df0da139 80 {"sessiond-path", 0, POPT_ARG_STRING, &opt_sessiond_path, 0, 0, 0},
894be886
DG
81 {"start", 0, POPT_ARG_STRING | POPT_ARGFLAG_OPTIONAL, 0, OPT_START_TRACE, 0, 0},
82 {"stop", 0, POPT_ARG_STRING | POPT_ARGFLAG_OPTIONAL, 0, OPT_STOP_TRACE, 0, 0},
df0da139 83 {"verbose", 'v', POPT_ARG_VAL, &opt_verbose, 1, 0, 0},
df0da139 84 {0, 0, 0, 0, 0, 0, 0}
fac6795d
DG
85};
86
87
88/*
89 * usage
90 */
91static void usage(FILE *ofp)
92{
93 fprintf(ofp, "LTTng Trace Control " VERSION"\n\n");
94 fprintf(ofp, "usage : lttng [OPTION]\n");
95 fprintf(ofp, "\n");
96 fprintf(ofp, "Options:\n");
aaf97519
DG
97 fprintf(ofp, " -v, --verbose Verbose mode\n");
98 fprintf(ofp, " -q, --quiet Quiet mode\n");
99 fprintf(ofp, " --help Show help\n");
100 fprintf(ofp, " --group NAME Unix tracing group name. (default: tracing)\n");
df0da139 101 fprintf(ofp, " --no-sessiond Don't spawn a session daemon\n");
aaf97519 102 fprintf(ofp, " --sessiond-path Session daemon full path\n");
894be886 103 fprintf(ofp, " -L, --list-apps List traceable user-space applications\n");
fac6795d 104 fprintf(ofp, "\n");
57167058 105 fprintf(ofp, "Session options:\n");
aaf97519 106 fprintf(ofp, " -c, --create-session NAME Create a new session\n");
894be886 107 fprintf(ofp, " -l, --list-sessions List all available sessions by name\n");
df0da139 108 fprintf(ofp, " -s, --session UUID Specify tracing session using UUID\n");
5e16da05 109 fprintf(ofp, " -d, --destroy-session NAME Destroy the session specified by NAME\n");
894be886 110 fprintf(ofp, " -t, --list-traces List session's traces. Use -s to specify the session\n");
57167058 111 fprintf(ofp, "\n");
fac6795d 112 fprintf(ofp, "Tracing options:\n");
894be886
DG
113 fprintf(ofp, " -p, --pid PID Specify action on user-space tracer for PID\n");
114 fprintf(ofp, " -k, --kernel Specify action on kernel tracer\n");
115 fprintf(ofp, " -e, --enable-event LIST Enable tracing event (support marker and tracepoint)\n");
116 fprintf(ofp, " --disable-event LIST Disable tracing event (support marker and tracepoint)\n");
117 fprintf(ofp, " -C, --create-trace Create a trace. Allocate and setup a trace\n");
118 fprintf(ofp, " -D, --destroy-trace [NAME] Destroy a trace. Use NAME to identify user-space trace\n");
119 fprintf(ofp, " --start [NAME] Start tracing. Use NAME to identify user-space trace\n");
120 fprintf(ofp, " --stop [NAME] Stop tracing. Use NAME to identify user-space trace\n");
121 fprintf(ofp, "\n");
122 fprintf(ofp, "Kernel tracing options:\n");
20fe2104 123 fprintf(ofp, " --kern-create-channel Create a kernel channel\n");
894be886
DG
124 fprintf(ofp, "\n");
125 fprintf(ofp, "User-space tracing options:\n");
df0da139
DG
126 fprintf(ofp, "\n");
127 fprintf(ofp, "Please see the lttng(1) man page for full documentation.\n");
5e16da05 128 fprintf(ofp, "See http://lttng.org for updates, bug reports and news.\n");
fac6795d
DG
129}
130
131/*
132 * parse_args
133 *
134 * Parse command line arguments.
135 * Return 0 if OK, else -1
136 */
137int parse_args(int argc, const char **argv)
138{
139 static poptContext pc;
140 int opt;
141
e8be5f4f
DG
142 /* If no options, fail */
143 if (argc < 2) {
144 return -1;
145 }
146
60cdef54 147 pc = poptGetContext(NULL, argc, argv, long_options, 0);
fac6795d
DG
148 poptReadDefaultConfig(pc, 0);
149
150 while ((opt = poptGetNextOpt(pc)) != -1) {
151 switch (opt) {
152 case OPT_HELP:
153 usage(stderr);
154 clean_exit(EXIT_SUCCESS);
155 break;
96243366
DG
156 case OPT_CREATE_SESSION:
157 opt_create_session = 1;
158 opt_session_name = poptGetOptArg(pc);
159 break;
160 case OPT_DESTROY_SESSION:
161 opt_destroy_session = 1;
894be886
DG
162 opt_session_name = poptGetOptArg(pc);
163 break;
164 case OPT_ENABLE_EVENT:
165 opt_enable_event = 1;
166 opt_event_list = poptGetOptArg(pc);
167 break;
168 case OPT_DESTROY_TRACE:
169 opt_destroy_trace = 1;
170 opt_trace_name = poptGetOptArg(pc);
171 break;
172 case OPT_START_TRACE:
173 opt_start_trace = 1;
174 opt_trace_name = poptGetOptArg(pc);
175 break;
176 case OPT_STOP_TRACE:
177 opt_stop_trace = 1;
178 opt_trace_name = poptGetOptArg(pc);
179 break;
180 case OPT_CREATE_TRACE:
181 opt_create_trace = 1;
182 opt_trace_name = poptGetOptArg(pc);
96243366 183 break;
fac6795d
DG
184 default:
185 usage(stderr);
186 clean_exit(EXIT_FAILURE);
187 break;
188 }
189 }
190
191 if (pc) {
192 poptFreeContext(pc);
193 }
194
195 return 0;
196}
This page took 0.032396 seconds and 4 git commands to generate.