1 /**********************************************************************
2 * Copyright (c) 2012, 2013 Ericsson
4 * All rights reserved. This program and the accompanying materials are
5 * made available under the terms of the Eclipse Public License v1.0 which
6 * accompanies this distribution, and is available at
7 * http://www.eclipse.org/legal/epl-v10.html
10 * Bernd Hufmann - Initial API and implementation
11 * Bernd Hufmann - Updated for support of LTTng Tools 2.1
12 * Simon Delisle - Updated for support of LTTng Tools 2.2
13 **********************************************************************/
14 package org
.eclipse
.linuxtools
.internal
.lttng2
.ui
.views
.control
.service
;
16 import java
.util
.regex
.Pattern
;
20 * Constants for LTTng Control Service.
23 * @author Bernd Hufmann
25 public interface LTTngControlServiceConstants
{
27 // ------------------------------------------------------------------------
29 // ------------------------------------------------------------------------
31 * Pattern to match the LTTng toolchain version 2.x.y.
33 static final Pattern VERSION_2_PATTERN
= Pattern
.compile("(2\\.\\d+\\.\\d+).*"); //$NON-NLS-1$
35 // ------------------------------------------------------------------------
37 // ------------------------------------------------------------------------
41 static final int UNUSED_VALUE
= -1;
43 // ------------------------------------------------------------------------
45 // ------------------------------------------------------------------------
47 * The lttng tools command.
49 static final String CONTROL_COMMAND
= "lttng"; //$NON-NLS-1$
51 * Command: lttng version.
53 static final String COMMAND_VERSION
= " version "; //$NON-NLS-1$
55 * Command: lttng list.
57 static final String COMMAND_LIST
= " list "; //$NON-NLS-1$
59 * Command to list kernel tracer information.
61 static final String COMMAND_LIST_KERNEL
= COMMAND_LIST
+ "-k"; //$NON-NLS-1$
63 * Command to list user space trace information.
65 static final String COMMAND_LIST_UST
= COMMAND_LIST
+ "-u"; //$NON-NLS-1$
67 * Command to create a session.
69 static final String COMMAND_CREATE_SESSION
= " create "; //$NON-NLS-1$
71 * Command to destroy a session.
73 static final String COMMAND_DESTROY_SESSION
= " destroy "; //$NON-NLS-1$
75 * Command to destroy a session.
77 static final String COMMAND_START_SESSION
= " start "; //$NON-NLS-1$
79 * Command to destroy a session.
81 static final String COMMAND_STOP_SESSION
= " stop "; //$NON-NLS-1$
83 * Command to enable a channel.
85 static final String COMMAND_ENABLE_CHANNEL
= " enable-channel "; //$NON-NLS-1$
87 * Command to disable a channel.
89 static final String COMMAND_DISABLE_CHANNEL
= " disable-channel "; //$NON-NLS-1$
91 * Command to enable a event.
93 static final String COMMAND_ENABLE_EVENT
= " enable-event "; //$NON-NLS-1$
95 * Command to disable a event.
97 static final String COMMAND_DISABLE_EVENT
= " disable-event "; //$NON-NLS-1$
99 * Command to add a context to channels and/or events
101 static final String COMMAND_ADD_CONTEXT
= " add-context "; //$NON-NLS-1$
103 * Command to execute calibrate command to quantify LTTng overhead
105 static final String COMMAND_CALIBRATE
= " calibrate "; //$NON-NLS-1$
107 // ------------------------------------------------------------------------
108 // Command line options constants
109 // ------------------------------------------------------------------------
111 * Command line option to add tracing group of user.
113 static final String OPTION_TRACING_GROUP
= " -g "; //$NON-NLS-1$
115 * Command line option for verbose output.
117 static final String OPTION_VERBOSE
= " -v "; //$NON-NLS-1$
119 * Command line option for verbose output.
121 static final String OPTION_VERY_VERBOSE
= " -vv "; //$NON-NLS-1$
123 * Command line option for verbose output.
125 static final String OPTION_VERY_VERY_VERBOSE
= " -vvv "; //$NON-NLS-1$
127 * Command line option for output path.
129 static final String OPTION_OUTPUT_PATH
= " -o "; //$NON-NLS-1$
131 * Command line option for kernel tracer.
133 static final String OPTION_KERNEL
= " -k "; //$NON-NLS-1$
135 * Command line option for UST tracer.
137 static final String OPTION_UST
= " -u "; //$NON-NLS-1$
139 * Command line option for specifying a session.
141 static final String OPTION_SESSION
= " -s "; //$NON-NLS-1$
143 * Command line option for specifying a channel.
145 static final String OPTION_CHANNEL
= " -c "; //$NON-NLS-1$
147 * Command line option for specifying a event.
149 static final String OPTION_EVENT
= " -e "; //$NON-NLS-1$
151 * Command line option for specifying all events.
153 static final String OPTION_ALL
= " -a "; //$NON-NLS-1$
155 * Command line option for specifying a context.
157 static final String OPTION_CONTEXT_TYPE
= " -t "; //$NON-NLS-1$
159 * Command line option for specifying tracepoint events.
161 static final String OPTION_TRACEPOINT
= " --tracepoint "; //$NON-NLS-1$
163 * Command line option for specifying syscall events.
165 static final String OPTION_SYSCALL
= " --syscall "; //$NON-NLS-1$
167 * Command line option for specifying a dynamic probe.
169 static final String OPTION_PROBE
= " --probe "; //$NON-NLS-1$
171 * Command line option for specifying a dynamic function entry/return probe.
173 static final String OPTION_FUNCTION_PROBE
= " --function "; //$NON-NLS-1$
175 * Command line option for specifying a log level range.
177 static final String OPTION_LOGLEVEL
= " --loglevel "; //$NON-NLS-1$
179 * Command line option for specifying a specific log level.
181 static final String OPTION_LOGLEVEL_ONLY
= " --loglevel-only "; //$NON-NLS-1$
183 * Optional command line option for configuring a channel's overwrite mode.
185 static final String OPTION_OVERWRITE
= " --overwrite "; //$NON-NLS-1$
187 * Optional command line option for configuring a channel's number of sub buffers.
189 static final String OPTION_NUM_SUB_BUFFERS
= " --num-subbuf "; //$NON-NLS-1$
191 * Optional command line option for configuring a channel's sub buffer size.
193 static final String OPTION_SUB_BUFFER_SIZE
= " --subbuf-size "; //$NON-NLS-1$
195 * Optional command line option for configuring a channel's switch timer interval.
197 static final String OPTION_SWITCH_TIMER
= " --switch-timer "; //$NON-NLS-1$
199 * Optional command line option for configuring a channel's read timer interval.
201 static final String OPTION_READ_TIMER
= " --read-timer "; //$NON-NLS-1$
203 * Command line option for printing the help of a specif command
205 static final String OPTION_HELP
= " -h "; //$NON-NLS-1$
207 * Command line option for listing the fields of UST tracepoints
209 static final String OPTION_FIELDS
= " -f "; //$NON-NLS-1$
211 * Command line option for configuring event's filter
213 static final String OPTION_FILTER
= " --filter "; //$NON-NLS-1$
215 * Command line option for configuring the streaming network URL (common for control and data channel).
217 static final String OPTION_NETWORK_URL
= " -U "; //$NON-NLS-1$
219 * Command line option for configuring the streaming control URL.
221 static final String OPTION_CONTROL_URL
= " -C "; //$NON-NLS-1$
223 * Command line option for configuring the streaming data URL.
225 static final String OPTION_DATA_URL
= " -D "; //$NON-NLS-1$
227 * Command line option for per UID buffers
229 static final String OPTION_PER_UID_BUFFERS
= " --buffers-uid "; //$NON-NLS-1$
231 * Command line option for maximum size of trace files
233 static final String OPTION_MAX_SIZE_TRACE_FILES
= " -C "; //$NON-NLS-1$
235 * Command line option for maximum trace files
237 static final String OPTION_MAX_TRACE_FILES
= " -W "; //$NON-NLS-1$
239 // ------------------------------------------------------------------------
241 // ------------------------------------------------------------------------
243 * Pattern to match the version.
245 static final Pattern VERSION_PATTERN
= Pattern
.compile(".*lttng\\s+version\\s+(\\d+\\.\\d+\\.\\d+).*"); //$NON-NLS-1$
247 * Pattern to match for error output
249 static final Pattern ERROR_PATTERN
= Pattern
.compile("\\s*Error\\:.*"); //$NON-NLS-1$
251 * Pattern to match for session information (lttng list)
253 static final Pattern SESSION_PATTERN
= Pattern
.compile("\\s+(\\d+)\\)\\s+(.*)\\s+\\((.*)\\)\\s+\\[(active|inactive)\\].*"); //$NON-NLS-1$
255 * Pattern to match for session information (lttng list <session>)
257 static final Pattern TRACE_SESSION_PATTERN
= Pattern
.compile("\\s*Tracing\\s+session\\s+(.*)\\:\\s+\\[(active|inactive)\\].*"); //$NON-NLS-1$
259 * Pattern to match for session path information (lttng list <session>)
261 static final Pattern TRACE_SESSION_PATH_PATTERN
= Pattern
.compile("\\s*Trace\\s+path\\:\\s+(.*)"); //$NON-NLS-1$
263 * Pattern to match session path for network tracing (lttng list <session>)
264 * Note: file for protocol is not considered as network trace since local consumer will be used.
266 static final Pattern TRACE_NETWORK_PATH_PATTERN
= Pattern
.compile("\\s*Trace\\s+path\\:\\s+(net|net6|tcp|tcp6)\\:\\/\\/(.*)(\\:(\\d*)\\/(.*)\\[data\\:\\s+(\\d*)\\]){0,1}"); //$NON-NLS-1$
268 * Sub-pattern to pattern TRACE_NETWORK_PATH_PATTERN to match file protocol
270 static final Pattern TRACE_FILE_PROTOCOL_PATTERN
= Pattern
.compile("(file)\\:\\/\\/(.*)"); //$NON-NLS-1$
272 * Pattern to match for kernel domain information (lttng list <session>)
274 static final Pattern DOMAIN_KERNEL_PATTERN
= Pattern
.compile("=== Domain: Kernel ==="); //$NON-NLS-1$
276 * Pattern to match for ust domain information (lttng list <session>)
278 static final Pattern DOMAIN_UST_GLOBAL_PATTERN
= Pattern
.compile("=== Domain: UST global ==="); //$NON-NLS-1$
280 * Pattern to match for matching warning about no kernel channel
282 static final Pattern DOMAIN_NO_KERNEL_CHANNEL_PATTERN
= Pattern
.compile("\\s*Warning\\:\\s+No kernel\\s+channel.*"); //$NON-NLS-1$
284 * Pattern to match for matching warning about no UST channel
286 static final Pattern DOMAIN_NO_UST_CHANNEL_PATTERN
= Pattern
.compile("\\s*Error\\:\\s+UST\\s+channel\\s+not\\s+found.*"); //$NON-NLS-1$
288 * Pattern to match for buffer type (lttng list <session>)
290 static final Pattern BUFFER_TYPE_PATTERN
= Pattern
.compile("\\s*Buffer\\s+type\\:.*"); //$NON-NLS-1$
292 * Pattern to match for channels section (lttng list <session>)
294 static final Pattern CHANNELS_SECTION_PATTERN
= Pattern
.compile("\\s*Channels\\:"); //$NON-NLS-1$
296 * Pattern to match for channel information (lttng list <session>)
298 static final Pattern CHANNEL_PATTERN
= Pattern
.compile("\\s*-\\s+(.*)\\:\\s+\\[(enabled|disabled)\\]"); //$NON-NLS-1$
300 * Pattern to match for events section information (lttng list <session>)
302 static final Pattern EVENT_SECTION_PATTERN
= Pattern
.compile("\\s*Events\\:"); //$NON-NLS-1$
304 * Pattern to match for event information (lttng list <session>)
306 static final Pattern EVENT_PATTERN
= Pattern
.compile("\\s+(.*)\\s+\\(loglevel:\\s+(.*)\\s+\\(\\d*\\)\\)\\s+\\(type:\\s+(.*)\\)\\s+\\[(enabled|disabled)\\]\\s*(\\[.*\\]){0,1}.*"); //$NON-NLS-1$
308 * Pattern to match a wildcarded event information (lttng list <session>)
310 static final Pattern WILDCARD_EVENT_PATTERN
= Pattern
.compile("\\s+(.*)\\s+\\(type:\\s+(.*)\\)\\s+\\[(enabled|disabled)\\]\\s*(\\[.*\\]){0,1}.*"); //$NON-NLS-1$
312 * Pattern to match a probe address information (lttng list <session>)
314 static final Pattern PROBE_ADDRESS_PATTERN
= Pattern
.compile("\\s+(addr)\\:\\s+(0x[0-9a-fA-F]{1,8})"); //$NON-NLS-1$
316 * Pattern to match a probe OFFSET information (lttng list <session>)
318 static final Pattern PROBE_OFFSET_PATTERN
= Pattern
.compile("\\s+(offset)\\:\\s+(0x[0-9a-fA-F]{1,8})"); //$NON-NLS-1$
320 * Pattern to match a probe SYMBOL information (lttng list <session>)
322 static final Pattern PROBE_SYMBOL_PATTERN
= Pattern
.compile("\\s+(symbol)\\:\\s+(.+)"); //$NON-NLS-1$
324 * Pattern to match for channel (overwite mode) information (lttng list <session>)
326 static final Pattern OVERWRITE_MODE_ATTRIBUTE
= Pattern
.compile("\\s+overwrite\\s+mode\\:.*"); //$NON-NLS-1$
328 * Pattern to match indicating false for overwrite mode
330 static final String OVERWRITE_MODE_ATTRIBUTE_FALSE
= "0"; //$NON-NLS-1$
332 * Pattern to match for channel (sub-buffer size) information (lttng list <session>)
334 static final Pattern SUBBUFFER_SIZE_ATTRIBUTE
= Pattern
.compile("\\s+subbufers\\s+size\\:.*"); //$NON-NLS-1$
336 * Pattern to match for channel (number of sub-buffers) information (lttng list <session>)
338 static final Pattern NUM_SUBBUFFERS_ATTRIBUTE
= Pattern
.compile("\\s+number\\s+of\\s+subbufers\\:.*"); //$NON-NLS-1$
340 * Pattern to match for channel (switch timer) information (lttng list <session>)
342 static final Pattern SWITCH_TIMER_ATTRIBUTE
= Pattern
.compile("\\s+switch\\s+timer\\s+interval\\:.*"); //$NON-NLS-1$
344 * Pattern to match for channel (read timer) information (lttng list <session>)
346 static final Pattern READ_TIMER_ATTRIBUTE
= Pattern
.compile("\\s+read\\s+timer\\s+interval\\:.*"); //$NON-NLS-1$
348 * Pattern to match for channel (output type) information (lttng list <session>)
350 static final Pattern OUTPUT_ATTRIBUTE
= Pattern
.compile("\\s+output\\:.*"); //$NON-NLS-1$
352 * Pattern to match for provider information (lttng list -k/-u)
354 static final Pattern PROVIDER_EVENT_PATTERN
= Pattern
.compile("\\s*(.*)\\s+\\(loglevel:\\s+(.*)\\s+\\(\\d*\\)\\)\\s+\\(type:\\s+(.*)\\)"); //$NON-NLS-1$
356 * Pattern to match event fields
358 static final Pattern EVENT_FIELD_PATTERN
= Pattern
.compile("\\s*(field:)\\s+(.*)\\s+\\((.*)\\)"); //$NON-NLS-1$
360 * Pattern to match for UST provider information (lttng list -u)
362 static final Pattern UST_PROVIDER_PATTERN
= Pattern
.compile("\\s*PID\\:\\s+(\\d+)\\s+-\\s+Name\\:\\s+(.*)"); //$NON-NLS-1$
364 * Pattern to match for session information (lttng create <session name>)
366 static final Pattern CREATE_SESSION_NAME_PATTERN
= Pattern
.compile(".*Session\\s+(.*)\\s+created\\."); //$NON-NLS-1$
368 * Pattern to match for session path information (lttng create <session name>)
370 static final Pattern CREATE_SESSION_PATH_PATTERN
= Pattern
.compile("\\s*Traces\\s+will\\s+be\\s+written\\s+in\\s+(.*).*"); //$NON-NLS-1$
372 * Pattern to match for session command output for "session name not found".
374 static final Pattern SESSION_NOT_FOUND_ERROR_PATTERN
= Pattern
.compile("\\s*Error:\\s+Session\\s+name\\s+not\\s+found"); //$NON-NLS-1$
376 * Pattern to match introduction line of context list.
378 static final Pattern ADD_CONTEXT_HELP_CONTEXTS_INTRO
= Pattern
.compile("\\s*TYPE can\\s+be\\s+one\\s+of\\s+the\\s+strings\\s+below.*"); //$NON-NLS-1$
380 * Pattern to match introduction line of context list.
382 static final Pattern ADD_CONTEXT_HELP_CONTEXTS_END_LINE
= Pattern
.compile("\\s*Example.*"); //$NON-NLS-1$
384 * Pattern to match error line if no kernel tracer is available or installed.
386 static final Pattern LIST_KERNEL_NO_KERNEL_PROVIDER_PATTERN
= Pattern
.compile("\\s*Error:\\s+Unable\\s+to\\s+list\\s+kernel\\s+events.*"); //$NON-NLS-1$;
388 * Pattern to match error line if no ust tracer is available or installed.
390 static final Pattern LIST_UST_NO_UST_PROVIDER_PATTERN
= Pattern
.compile(".*Unable\\s*to\\s*list\\s*UST\\s*event.*"); //$NON-NLS-1$;