1 /**********************************************************************
2 * Copyright (c) 2012, 2015 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 * Marc-Andre Laperle - Support for creating a live session
14 **********************************************************************/
15 package org
.eclipse
.tracecompass
.internal
.lttng2
.control
.ui
.views
.service
;
17 import static org
.eclipse
.tracecompass
.common
.core
.NonNullUtils
.checkNotNull
;
19 import java
.util
.regex
.Pattern
;
21 import org
.eclipse
.jdt
.annotation
.NonNullByDefault
;
25 * Constants for LTTng Control Service.
28 * @author Bernd Hufmann
31 public interface LTTngControlServiceConstants
{
33 // ------------------------------------------------------------------------
35 // ------------------------------------------------------------------------
37 * Pattern to match the LTTng toolchain version 2.x.y.
39 Pattern VERSION_2_PATTERN
= checkNotNull(Pattern
.compile("(2\\.\\d+\\.\\d+).*")); //$NON-NLS-1$
41 // ------------------------------------------------------------------------
43 // ------------------------------------------------------------------------
47 int UNUSED_VALUE
= -1;
49 * String representation of numerical true element
51 String TRUE_NUMERICAL
= "1"; //$NON-NLS-1$
53 // ------------------------------------------------------------------------
54 // LTTng Machine Interface constants
55 // ------------------------------------------------------------------------
58 * Name of the XSD to validate against the xml machine interface
61 String MI_XSD_FILENAME
= "mi_lttng.xsd"; //$NON-NLS-1$
62 // ------------------------------------------------------------------------
64 // ------------------------------------------------------------------------
66 * The lttng tools command.
68 String CONTROL_COMMAND
= "lttng"; //$NON-NLS-1$
70 * The lttng tools machine interface command.
72 String CONTROL_COMMAND_MI_OPTION
= "--mi"; //$NON-NLS-1$
74 * The lttng tools XML machine interface command.
76 String CONTROL_COMMAND_MI_XML
= "xml"; //$NON-NLS-1$
78 * Command: lttng version.
80 String COMMAND_VERSION
= "version"; //$NON-NLS-1$
82 * Command: lttng list.
84 String COMMAND_LIST
= "list"; //$NON-NLS-1$
86 * Command to create a session.
88 String COMMAND_CREATE_SESSION
= "create"; //$NON-NLS-1$
90 * Command to destroy a session.
92 String COMMAND_DESTROY_SESSION
= "destroy"; //$NON-NLS-1$
94 * Command to destroy a session.
96 String COMMAND_START_SESSION
= "start"; //$NON-NLS-1$
98 * Command to load a session.
100 String COMMAND_LOAD_SESSION
= "load"; //$NON-NLS-1$
102 * Command to destroy a session.
104 String COMMAND_STOP_SESSION
= "stop"; //$NON-NLS-1$
106 * Command to enable a channel.
108 String COMMAND_ENABLE_CHANNEL
= "enable-channel"; //$NON-NLS-1$
110 * Command to disable a channel.
112 String COMMAND_DISABLE_CHANNEL
= "disable-channel"; //$NON-NLS-1$
114 * Command to enable a event.
116 String COMMAND_ENABLE_EVENT
= "enable-event"; //$NON-NLS-1$
118 * Command to disable a event.
120 String COMMAND_DISABLE_EVENT
= "disable-event"; //$NON-NLS-1$
122 * Command to add a context to channels and/or events
124 String COMMAND_ADD_CONTEXT
= "add-context"; //$NON-NLS-1$
126 * Command to execute calibrate command to quantify LTTng overhead
128 String COMMAND_CALIBRATE
= "calibrate"; //$NON-NLS-1$
130 * Command to execute sub-command snapshot
132 String COMMAND_SNAPSHOT
= "snapshot"; //$NON-NLS-1$
134 * Command to list the snapshot outputs
136 String COMMAND_LIST_SNAPSHOT_OUTPUT
= "list-output"; //$NON-NLS-1$
138 * Command to record a snapshot
140 String COMMAND_RECORD_SNAPSHOT
= "record"; //$NON-NLS-1$
142 // ------------------------------------------------------------------------
143 // Command line options constants
144 // ------------------------------------------------------------------------
146 * Command line option to add tracing group of user.
148 String OPTION_TRACING_GROUP
= "-g"; //$NON-NLS-1$
150 * Command line option for verbose output.
152 String OPTION_VERBOSE
= "-v"; //$NON-NLS-1$
154 * Command line option for verbose output.
156 String OPTION_VERY_VERBOSE
= "-vv"; //$NON-NLS-1$
158 * Command line option for verbose output.
160 String OPTION_VERY_VERY_VERBOSE
= "-vvv"; //$NON-NLS-1$
162 * Command line option for output path.
164 String OPTION_OUTPUT_PATH
= "-o"; //$NON-NLS-1$
166 * Command line option for output path.
168 String OPTION_SNAPSHOT
= "--snapshot"; //$NON-NLS-1$
170 * Command line option for live
172 String OPTION_LIVE
= "--live"; //$NON-NLS-1$
174 * Command line option for kernel tracer.
176 String OPTION_KERNEL
= "-k"; //$NON-NLS-1$
178 * Command line option for UST tracer.
180 String OPTION_UST
= "-u"; //$NON-NLS-1$
182 * Command line option for specifying a session.
184 String OPTION_SESSION
= "-s"; //$NON-NLS-1$
186 * Command line option for specifying a channel.
188 String OPTION_CHANNEL
= "-c"; //$NON-NLS-1$
190 * Command line option for specifying a event.
192 String OPTION_EVENT
= "-e"; //$NON-NLS-1$
194 * Command line option for specifying all events.
196 String OPTION_ALL
= "-a"; //$NON-NLS-1$
198 * Command line option for specifying a context.
200 String OPTION_CONTEXT_TYPE
= "-t"; //$NON-NLS-1$
202 * Command line option for specifying tracepoint events.
204 String OPTION_TRACEPOINT
= "--tracepoint"; //$NON-NLS-1$
206 * Command line option for specifying syscall events.
208 String OPTION_SYSCALL
= "--syscall"; //$NON-NLS-1$
210 * Command line option for specifying a dynamic probe.
212 String OPTION_PROBE
= "--probe"; //$NON-NLS-1$
214 * Command line option for specifying a dynamic function entry/return probe.
216 String OPTION_FUNCTION_PROBE
= "--function"; //$NON-NLS-1$
218 * Command line option for specifying a log level range.
220 String OPTION_LOGLEVEL
= "--loglevel"; //$NON-NLS-1$
222 * Command line option for specifying a specific log level.
224 String OPTION_LOGLEVEL_ONLY
= "--loglevel-only"; //$NON-NLS-1$
226 * Optional command line option for configuring a channel's overwrite mode.
228 String OPTION_OVERWRITE
= "--overwrite"; //$NON-NLS-1$
230 * Optional command line option for configuring a channel's number of sub buffers.
232 String OPTION_NUM_SUB_BUFFERS
= "--num-subbuf"; //$NON-NLS-1$
234 * Optional command line option for configuring a channel's sub buffer size.
236 String OPTION_SUB_BUFFER_SIZE
= "--subbuf-size"; //$NON-NLS-1$
238 * Optional command line option for configuring a channel's switch timer interval.
240 String OPTION_SWITCH_TIMER
= "--switch-timer"; //$NON-NLS-1$
242 * Optional command line option for configuring a channel's read timer interval.
244 String OPTION_READ_TIMER
= "--read-timer"; //$NON-NLS-1$
246 * Command line option for printing the help of a specif command
248 String OPTION_HELP
= "-h"; //$NON-NLS-1$
250 * Command line option for listing the fields of UST tracepoints
252 String OPTION_FIELDS
= "-f"; //$NON-NLS-1$
254 * Command line option for configuring event's filter
256 String OPTION_FILTER
= "--filter"; //$NON-NLS-1$
258 * Command line option for configuring the streaming network URL (common for control and data channel).
260 String OPTION_NETWORK_URL
= "-U"; //$NON-NLS-1$
262 * Command line option for configuring the streaming control URL.
264 String OPTION_CONTROL_URL
= "-C"; //$NON-NLS-1$
266 * Command line option for configuring the streaming data URL.
268 String OPTION_DATA_URL
= "-D"; //$NON-NLS-1$
270 * Command line option for per UID buffers
272 String OPTION_PER_UID_BUFFERS
= "--buffers-uid"; //$NON-NLS-1$
274 * Command line option for per PID buffers
276 String OPTION_PER_PID_BUFFERS
= "--buffers-pid"; //$NON-NLS-1$
278 * Command line option for maximum size of trace files
280 String OPTION_MAX_SIZE_TRACE_FILES
= "-C"; //$NON-NLS-1$
282 * Command line option for maximum trace files
284 String OPTION_MAX_TRACE_FILES
= "-W"; //$NON-NLS-1$
287 * Maximum live timer interval value
289 Long MAX_LIVE_TIMER_INTERVAL
= 0xFFFFFFFEL
;
291 // ------------------------------------------------------------------------
293 // ------------------------------------------------------------------------
295 * Pattern to match the version.
297 Pattern VERSION_PATTERN
= checkNotNull(Pattern
.compile(".*lttng\\s+version\\s+.*(\\d+\\.\\d+\\.\\d+).*")); //$NON-NLS-1$
299 * Pattern to match for error output
301 Pattern ERROR_PATTERN
= checkNotNull(Pattern
.compile("\\s*Error\\:.*")); //$NON-NLS-1$
303 * Pattern to match for session information (lttng list)
305 Pattern SESSION_PATTERN
= checkNotNull(Pattern
.compile("\\s+(\\d+)\\)\\s+(.*)\\s+\\((.*)\\)\\s+\\[(active|inactive).*\\].*")); //$NON-NLS-1$
307 * Pattern to match for session information (lttng list <session>)
309 Pattern TRACE_SESSION_PATTERN
= checkNotNull(Pattern
.compile("\\s*Tracing\\s+session\\s+(.*)\\:\\s+\\[(active|inactive)\\].*")); //$NON-NLS-1$
311 * Pattern to match for snapshot session information (lttng list <session>)
313 Pattern TRACE_SNAPSHOT_SESSION_PATTERN
= checkNotNull(Pattern
.compile("\\s*Tracing\\s+session\\s+(.*)\\:\\s+\\[(active|inactive)\\s*snapshot\\].*")); //$NON-NLS-1$
315 * Pattern to match for session path information (lttng list <session>)
317 Pattern TRACE_SESSION_PATH_PATTERN
= checkNotNull(Pattern
.compile("\\s*Trace\\s+path\\:\\s+(.*)")); //$NON-NLS-1$
319 * Pattern to match session path for network tracing (lttng list <session>)
320 * Note: file for protocol is not considered as network trace since local consumer will be used.
322 Pattern TRACE_NETWORK_PATH_PATTERN
= checkNotNull(Pattern
.compile("\\s*Trace\\s+path\\:\\s+(net|net4|net6|tcp|tcp4|tcp6)\\:\\/\\/(.*)(\\:(\\d*)\\/(.*)\\[data\\:\\s+(\\d*)\\]){0,1}")); //$NON-NLS-1$
324 * Pattern to match session path for network tracing
325 * Note: file for protocol is not considered as network trace since local consumer will be used.
327 Pattern TRACE_NETWORK_PATTERN
= checkNotNull(Pattern
.compile("\\s*(net|net4|net6|tcp|tcp4|tcp6)\\:\\/\\/(.*)(\\:(\\d*)\\/(.*)\\[data\\:\\s+(\\d*)\\]){0,1}")); //$NON-NLS-1$
329 * Sub-pattern to pattern TRACE_NETWORK_PATH_PATTERN to match file protocol
331 Pattern TRACE_FILE_PROTOCOL_PATTERN
= checkNotNull(Pattern
.compile("(file)\\:\\/\\/(.*)")); //$NON-NLS-1$
333 * Pattern to match for kernel domain information (lttng list <session>)
335 Pattern DOMAIN_KERNEL_PATTERN
= checkNotNull(Pattern
.compile("=== Domain: Kernel ===")); //$NON-NLS-1$
337 * Pattern to match for ust domain information (lttng list <session>)
339 Pattern DOMAIN_UST_GLOBAL_PATTERN
= checkNotNull(Pattern
.compile("=== Domain: UST global ===")); //$NON-NLS-1$
341 * Pattern to match for matching warning about no kernel channel
343 Pattern DOMAIN_NO_KERNEL_CHANNEL_PATTERN
= checkNotNull(Pattern
.compile("\\s*Warning\\:\\s+No kernel\\s+channel.*")); //$NON-NLS-1$
345 * Pattern to match for matching warning about no UST channel
347 Pattern DOMAIN_NO_UST_CHANNEL_PATTERN
= checkNotNull(Pattern
.compile("\\s*Error\\:\\s+UST\\s+channel\\s+not\\s+found.*")); //$NON-NLS-1$
349 * Pattern to match for buffer type (lttng list <session>)
351 Pattern BUFFER_TYPE_PATTERN
= checkNotNull(Pattern
.compile("\\s*Buffer\\s+type\\:.*")); //$NON-NLS-1$
353 * Pattern to match for channels section (lttng list <session>)
355 Pattern CHANNELS_SECTION_PATTERN
= checkNotNull(Pattern
.compile("\\s*Channels\\:")); //$NON-NLS-1$
357 * Pattern to match for channel information (lttng list <session>)
359 Pattern CHANNEL_PATTERN
= checkNotNull(Pattern
.compile("\\s*-\\s+(.*)\\:\\s+\\[(enabled|disabled)\\]")); //$NON-NLS-1$
361 * Pattern to match for events section information (lttng list <session>)
363 Pattern EVENT_SECTION_PATTERN
= checkNotNull(Pattern
.compile("\\s*Events\\:")); //$NON-NLS-1$
365 * Pattern to match for event information (lttng list <session>)
367 Pattern EVENT_PATTERN
= checkNotNull(Pattern
.compile("\\s+(.*)\\s+\\(loglevel\\s*(:|<=|==)\\s+(.*)\\s+\\(\\d*\\)\\)\\s+\\(type:\\s+(.*)\\)\\s+\\[(enabled|disabled)\\]\\s*(\\[.*\\]){0,1}.*")); //$NON-NLS-1$
369 * Pattern to match a wildcarded event information (lttng list <session>)
371 Pattern WILDCARD_EVENT_PATTERN
= checkNotNull(Pattern
.compile("\\s+(.*)\\s+\\(type:\\s+(.*)\\)\\s+\\[(enabled|disabled)\\]\\s*(\\[.*\\]){0,1}.*")); //$NON-NLS-1$
373 * Pattern to match a probe address information (lttng list <session>)
375 Pattern PROBE_ADDRESS_PATTERN
= checkNotNull(Pattern
.compile("\\s+(addr)\\:\\s+(0x[0-9a-fA-F]{1,16})")); //$NON-NLS-1$
377 * Pattern to match a probe OFFSET information (lttng list <session>)
379 Pattern PROBE_OFFSET_PATTERN
= checkNotNull(Pattern
.compile("\\s+(offset)\\:\\s+(0x[0-9a-fA-F]{1,16})")); //$NON-NLS-1$
381 * Pattern to match a probe SYMBOL information (lttng list <session>)
383 Pattern PROBE_SYMBOL_PATTERN
= checkNotNull(Pattern
.compile("\\s+(symbol)\\:\\s+(.+)")); //$NON-NLS-1$
385 * Pattern to match for channel (overwite mode) information (lttng list <session>)
387 Pattern OVERWRITE_MODE_ATTRIBUTE
= checkNotNull(Pattern
.compile("\\s+overwrite\\s+mode\\:.*")); //$NON-NLS-1$
389 * Pattern to match indicating false for overwrite mode
391 String OVERWRITE_MODE_ATTRIBUTE_FALSE
= "0"; //$NON-NLS-1$
393 * Pattern to match indicating false for overwrite mode in machine interface mode
395 String OVERWRITE_MODE_ATTRIBUTE_FALSE_MI
= "DISCARD"; //$NON-NLS-1$
397 * Pattern to match for channel (sub-buffer size) information (lttng list <session>)
399 Pattern SUBBUFFER_SIZE_ATTRIBUTE
= checkNotNull(Pattern
.compile("\\s+subbufers\\s+size\\:.*")); //$NON-NLS-1$
401 * Pattern to match for channel (number of sub-buffers) information (lttng list <session>)
403 Pattern NUM_SUBBUFFERS_ATTRIBUTE
= checkNotNull(Pattern
.compile("\\s+number\\s+of\\s+subbufers\\:.*")); //$NON-NLS-1$
405 * Pattern to match for channel (switch timer) information (lttng list <session>)
407 Pattern SWITCH_TIMER_ATTRIBUTE
= checkNotNull(Pattern
.compile("\\s+switch\\s+timer\\s+interval\\:.*")); //$NON-NLS-1$
409 * Pattern to match for channel (read timer) information (lttng list <session>)
411 Pattern READ_TIMER_ATTRIBUTE
= checkNotNull(Pattern
.compile("\\s+read\\s+timer\\s+interval\\:.*")); //$NON-NLS-1$
413 * Pattern to match for channel (output type) information (lttng list <session>)
415 Pattern OUTPUT_ATTRIBUTE
= checkNotNull(Pattern
.compile("\\s+output\\:.*")); //$NON-NLS-1$
417 * Pattern to match for channel (trace file size) information (lttng list <session>)
419 Pattern TRACE_FILE_COUNT_ATTRIBUTE
= checkNotNull(Pattern
.compile("\\s+trace\\s+file\\s+count\\:.*")); //$NON-NLS-1$
421 * Pattern to match for channel (trace file size) information (lttng list <session>)
423 Pattern TRACE_FILE_SIZE_ATTRIBUTE
= checkNotNull(Pattern
.compile("\\s+trace\\s+file\\s+size\\s+\\(bytes\\)\\:.*")); //$NON-NLS-1$
425 * Pattern to match for provider information (lttng list -k/-u)
427 Pattern PROVIDER_EVENT_PATTERN
= checkNotNull(Pattern
.compile("\\s*(.*)\\s+\\(loglevel:\\s+(.*)\\s+\\(\\d*\\)\\)\\s+\\(type:\\s+(.*)\\)")); //$NON-NLS-1$
429 * Pattern to match event fields
431 Pattern EVENT_FIELD_PATTERN
= checkNotNull(Pattern
.compile("\\s*(field:)\\s+(.*)\\s+\\((.*)\\)")); //$NON-NLS-1$
433 * Pattern to match for UST provider information (lttng list -u)
435 Pattern UST_PROVIDER_PATTERN
= checkNotNull(Pattern
.compile("\\s*PID\\:\\s+(\\d+)\\s+-\\s+Name\\:\\s+(.*)")); //$NON-NLS-1$
437 * Pattern to match for session information (lttng create <session name>)
439 Pattern CREATE_SESSION_NAME_PATTERN
= checkNotNull(Pattern
.compile(".*Session\\s+(.*)\\s+created\\.")); //$NON-NLS-1$
441 * Pattern to match for session path information (lttng create <session name>)
443 Pattern CREATE_SESSION_PATH_PATTERN
= checkNotNull(Pattern
.compile("\\s*Traces\\s+will\\s+be\\s+written\\s+in\\s+(.*).*")); //$NON-NLS-1$
445 * Pattern to match for session command output for "session name not found".
447 Pattern SESSION_NOT_FOUND_ERROR_PATTERN
= checkNotNull(Pattern
.compile("\\s*Error:\\s+Session\\s+name\\s.*not\\s+found")); //$NON-NLS-1$
449 * Pattern to match introduction line of context list.
451 Pattern ADD_CONTEXT_HELP_CONTEXTS_INTRO
= checkNotNull(Pattern
.compile("\\s*TYPE can\\s+be\\s+one\\s+of\\s+the\\s+strings\\s+below.*")); //$NON-NLS-1$
453 * Pattern to match introduction line of context list.
455 Pattern ADD_CONTEXT_HELP_CONTEXTS_END_LINE
= checkNotNull(Pattern
.compile("\\s*Example.*")); //$NON-NLS-1$
457 * Pattern to match error line if no kernel tracer is available or installed.
459 Pattern LIST_KERNEL_NO_KERNEL_PROVIDER_PATTERN
= checkNotNull(Pattern
.compile("\\s*Error:\\s+Unable\\s+to\\s+list\\s+kernel\\s+events.*")); //$NON-NLS-1$;
461 * Pattern to match error line if no ust tracer is available or installed.
463 Pattern LIST_UST_NO_UST_PROVIDER_PATTERN
= checkNotNull(Pattern
.compile(".*Unable\\s*to\\s*list\\s*UST\\s*event.*")); //$NON-NLS-1$;
465 * Pattern to match for list snapshot information (lttng snapshot list-output)
467 Pattern LIST_SNAPSHOT_OUTPUT_PATTERN
= checkNotNull(Pattern
.compile("\\s+\\[(\\d+)\\]\\s+(\\S*)\\:\\s+(\\S*)(.*)")); //$NON-NLS-1$
469 * Pattern to match the live timer interval line of session list.
471 Pattern LIST_LIVE_TIMER_INTERVAL_PATTERN
= checkNotNull(Pattern
.compile("\\s*Live\\stimer\\sinterval\\s\\(usec\\):\\s(\\d+)")); //$NON-NLS-1$
473 * Pattern to match snapshot path for network tracing (lttng list <session>)
474 * Note: file for protocol is not considered as network trace since local consumer will be used.
476 Pattern SNAPSHOT_NETWORK_PATH_PATTERN
= checkNotNull(Pattern
.compile("(net|net4|net6|tcp|tcp4|tcp6)\\:\\/\\/(.*)(\\:(\\d*)\\/(.*)\\[data\\:\\s+(\\d*)\\]){0,1}")); //$NON-NLS-1$