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 /** The default directory for session */
54 public static final String DEFAULT_PATH
= ".lttng/sessions"; //$NON-NLS-1$
56 // ------------------------------------------------------------------------
57 // LTTng Machine Interface constants
58 // ------------------------------------------------------------------------
61 * Name of the XSD to validate against the xml machine interface
64 String MI_XSD_FILENAME
= "mi_lttng.xsd"; //$NON-NLS-1$
65 // ------------------------------------------------------------------------
67 // ------------------------------------------------------------------------
69 * The lttng tools command.
71 String CONTROL_COMMAND
= "lttng"; //$NON-NLS-1$
73 * The lttng tools machine interface command.
75 String CONTROL_COMMAND_MI_OPTION
= "--mi"; //$NON-NLS-1$
77 * The lttng tools XML machine interface command.
79 String CONTROL_COMMAND_MI_XML
= "xml"; //$NON-NLS-1$
81 * Command: lttng version.
83 String COMMAND_VERSION
= "version"; //$NON-NLS-1$
85 * Command: lttng list.
87 String COMMAND_LIST
= "list"; //$NON-NLS-1$
89 * Command to create a session.
91 String COMMAND_CREATE_SESSION
= "create"; //$NON-NLS-1$
93 * Command to destroy a session.
95 String COMMAND_DESTROY_SESSION
= "destroy"; //$NON-NLS-1$
97 * Command to destroy a session.
99 String COMMAND_START_SESSION
= "start"; //$NON-NLS-1$
101 * Command to load a session.
103 String COMMAND_LOAD_SESSION
= "load"; //$NON-NLS-1$
105 * Command to destroy a session.
107 String COMMAND_STOP_SESSION
= "stop"; //$NON-NLS-1$
109 * Command to enable a channel.
111 String COMMAND_ENABLE_CHANNEL
= "enable-channel"; //$NON-NLS-1$
113 * Command to disable a channel.
115 String COMMAND_DISABLE_CHANNEL
= "disable-channel"; //$NON-NLS-1$
117 * Command to enable a event.
119 String COMMAND_ENABLE_EVENT
= "enable-event"; //$NON-NLS-1$
121 * Command to disable a event.
123 String COMMAND_DISABLE_EVENT
= "disable-event"; //$NON-NLS-1$
125 * Command to add a context to channels and/or events
127 String COMMAND_ADD_CONTEXT
= "add-context"; //$NON-NLS-1$
129 * Command to execute calibrate command to quantify LTTng overhead
131 String COMMAND_CALIBRATE
= "calibrate"; //$NON-NLS-1$
133 * Command to execute sub-command snapshot
135 String COMMAND_SNAPSHOT
= "snapshot"; //$NON-NLS-1$
137 * Command to list the snapshot outputs
139 String COMMAND_LIST_SNAPSHOT_OUTPUT
= "list-output"; //$NON-NLS-1$
141 * Command to record a snapshot
143 String COMMAND_RECORD_SNAPSHOT
= "record"; //$NON-NLS-1$
145 // ------------------------------------------------------------------------
146 // Command line options constants
147 // ------------------------------------------------------------------------
149 * Command line option to add tracing group of user.
151 String OPTION_TRACING_GROUP
= "-g"; //$NON-NLS-1$
153 * Command line option for verbose output.
155 String OPTION_VERBOSE
= "-v"; //$NON-NLS-1$
157 * Command line option for verbose output.
159 String OPTION_VERY_VERBOSE
= "-vv"; //$NON-NLS-1$
161 * Command line option for verbose output.
163 String OPTION_VERY_VERY_VERBOSE
= "-vvv"; //$NON-NLS-1$
165 * Command line option for output path.
167 String OPTION_OUTPUT_PATH
= "-o"; //$NON-NLS-1$
169 * Command line option for output path.
171 String OPTION_SNAPSHOT
= "--snapshot"; //$NON-NLS-1$
173 * Command line option for live
175 String OPTION_LIVE
= "--live"; //$NON-NLS-1$
177 * Command line option for kernel tracer.
179 String OPTION_KERNEL
= "-k"; //$NON-NLS-1$
181 * Command line option for UST tracer.
183 String OPTION_UST
= "-u"; //$NON-NLS-1$
185 * Command line option for specifying a session.
187 String OPTION_SESSION
= "-s"; //$NON-NLS-1$
189 * Command line option for specifying a channel.
191 String OPTION_CHANNEL
= "-c"; //$NON-NLS-1$
193 * Command line option for specifying a event.
195 String OPTION_EVENT
= "-e"; //$NON-NLS-1$
197 * Command line option for specifying all events.
199 String OPTION_ALL
= "-a"; //$NON-NLS-1$
201 * Command line option for specifying a context.
203 String OPTION_CONTEXT_TYPE
= "-t"; //$NON-NLS-1$
205 * Command line option for specifying tracepoint events.
207 String OPTION_TRACEPOINT
= "--tracepoint"; //$NON-NLS-1$
209 * Command line option for specifying syscall events.
211 String OPTION_SYSCALL
= "--syscall"; //$NON-NLS-1$
213 * Command line option for specifying a dynamic probe.
215 String OPTION_PROBE
= "--probe"; //$NON-NLS-1$
217 * Command line option for specifying a dynamic function entry/return probe.
219 String OPTION_FUNCTION_PROBE
= "--function"; //$NON-NLS-1$
221 * Command line option for specifying a log level range.
223 String OPTION_LOGLEVEL
= "--loglevel"; //$NON-NLS-1$
225 * Command line option for specifying a specific log level.
227 String OPTION_LOGLEVEL_ONLY
= "--loglevel-only"; //$NON-NLS-1$
229 * Optional command line option for configuring a channel's overwrite mode.
231 String OPTION_OVERWRITE
= "--overwrite"; //$NON-NLS-1$
233 * Optional command line option for configuring a channel's number of sub buffers.
235 String OPTION_NUM_SUB_BUFFERS
= "--num-subbuf"; //$NON-NLS-1$
237 * Optional command line option for configuring a channel's sub buffer size.
239 String OPTION_SUB_BUFFER_SIZE
= "--subbuf-size"; //$NON-NLS-1$
241 * Optional command line option for configuring a channel's switch timer interval.
243 String OPTION_SWITCH_TIMER
= "--switch-timer"; //$NON-NLS-1$
245 * Optional command line option for configuring a channel's read timer interval.
247 String OPTION_READ_TIMER
= "--read-timer"; //$NON-NLS-1$
249 * Command line option for printing the help of a specif command
251 String OPTION_HELP
= "-h"; //$NON-NLS-1$
253 * Command line option for listing the fields of UST tracepoints
255 String OPTION_FIELDS
= "-f"; //$NON-NLS-1$
257 * Command line option for configuring event's filter
259 String OPTION_FILTER
= "--filter"; //$NON-NLS-1$
261 * Command line option for configuring the streaming network URL (common for control and data channel).
263 String OPTION_NETWORK_URL
= "-U"; //$NON-NLS-1$
265 * Command line option for configuring the streaming control URL.
267 String OPTION_CONTROL_URL
= "-C"; //$NON-NLS-1$
269 * Command line option for configuring the streaming data URL.
271 String OPTION_DATA_URL
= "-D"; //$NON-NLS-1$
273 * Command line option for per UID buffers
275 String OPTION_PER_UID_BUFFERS
= "--buffers-uid"; //$NON-NLS-1$
277 * Command line option for per PID buffers
279 String OPTION_PER_PID_BUFFERS
= "--buffers-pid"; //$NON-NLS-1$
281 * Command line option for maximum size of trace files
283 String OPTION_MAX_SIZE_TRACE_FILES
= "-C"; //$NON-NLS-1$
285 * Command line option for maximum trace files
287 String OPTION_MAX_TRACE_FILES
= "-W"; //$NON-NLS-1$
289 * Command line option for force overwrite
291 String OPTION_FORCE
= "-f"; //$NON-NLS-1$
293 * Command line option for specifying input path
295 String OPTION_INPUT_PATH
= "-i"; //$NON-NLS-1$
298 * Maximum live timer interval value
300 Long MAX_LIVE_TIMER_INTERVAL
= 0xFFFFFFFEL
;
302 // ------------------------------------------------------------------------
304 // ------------------------------------------------------------------------
306 * Pattern to match the version.
308 Pattern VERSION_PATTERN
= checkNotNull(Pattern
.compile(".*lttng\\s+version\\s+.*(\\d+\\.\\d+\\.\\d+).*")); //$NON-NLS-1$
310 * Pattern to match for error output
312 Pattern ERROR_PATTERN
= checkNotNull(Pattern
.compile("\\s*Error\\:.*")); //$NON-NLS-1$
314 * Pattern to match for session information (lttng list)
316 Pattern SESSION_PATTERN
= checkNotNull(Pattern
.compile("\\s+(\\d+)\\)\\s+(.*)\\s+\\((.*)\\)\\s+\\[(active|inactive).*\\].*")); //$NON-NLS-1$
318 * Pattern to match for session information (lttng list <session>)
320 Pattern TRACE_SESSION_PATTERN
= checkNotNull(Pattern
.compile("\\s*Tracing\\s+session\\s+(.*)\\:\\s+\\[(active|inactive)\\].*")); //$NON-NLS-1$
322 * Pattern to match for snapshot session information (lttng list <session>)
324 Pattern TRACE_SNAPSHOT_SESSION_PATTERN
= checkNotNull(Pattern
.compile("\\s*Tracing\\s+session\\s+(.*)\\:\\s+\\[(active|inactive)\\s*snapshot\\].*")); //$NON-NLS-1$
326 * Pattern to match for session path information (lttng list <session>)
328 Pattern TRACE_SESSION_PATH_PATTERN
= checkNotNull(Pattern
.compile("\\s*Trace\\s+path\\:\\s+(.*)")); //$NON-NLS-1$
330 * Pattern to match session path for network tracing (lttng list <session>)
331 * Note: file for protocol is not considered as network trace since local consumer will be used.
333 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$
335 * Pattern to match session path for network tracing
336 * Note: file for protocol is not considered as network trace since local consumer will be used.
338 Pattern TRACE_NETWORK_PATTERN
= checkNotNull(Pattern
.compile("\\s*(net|net4|net6|tcp|tcp4|tcp6)\\:\\/\\/(.*)(\\:(\\d*)\\/(.*)\\[data\\:\\s+(\\d*)\\]){0,1}")); //$NON-NLS-1$
340 * Sub-pattern to pattern TRACE_NETWORK_PATH_PATTERN to match file protocol
342 Pattern TRACE_FILE_PROTOCOL_PATTERN
= checkNotNull(Pattern
.compile("(file)\\:\\/\\/(.*)")); //$NON-NLS-1$
344 * Pattern to match for kernel domain information (lttng list <session>)
346 Pattern DOMAIN_KERNEL_PATTERN
= checkNotNull(Pattern
.compile("=== Domain: Kernel ===")); //$NON-NLS-1$
348 * Pattern to match for ust domain information (lttng list <session>)
350 Pattern DOMAIN_UST_GLOBAL_PATTERN
= checkNotNull(Pattern
.compile("=== Domain: UST global ===")); //$NON-NLS-1$
352 * Pattern to match for matching warning about no kernel channel
354 Pattern DOMAIN_NO_KERNEL_CHANNEL_PATTERN
= checkNotNull(Pattern
.compile("\\s*Warning\\:\\s+No kernel\\s+channel.*")); //$NON-NLS-1$
356 * Pattern to match for matching warning about no UST channel
358 Pattern DOMAIN_NO_UST_CHANNEL_PATTERN
= checkNotNull(Pattern
.compile("\\s*Error\\:\\s+UST\\s+channel\\s+not\\s+found.*")); //$NON-NLS-1$
360 * Pattern to match for buffer type (lttng list <session>)
362 Pattern BUFFER_TYPE_PATTERN
= checkNotNull(Pattern
.compile("\\s*Buffer\\s+type\\:.*")); //$NON-NLS-1$
364 * Pattern to match for channels section (lttng list <session>)
366 Pattern CHANNELS_SECTION_PATTERN
= checkNotNull(Pattern
.compile("\\s*Channels\\:")); //$NON-NLS-1$
368 * Pattern to match for channel information (lttng list <session>)
370 Pattern CHANNEL_PATTERN
= checkNotNull(Pattern
.compile("\\s*-\\s+(.*)\\:\\s+\\[(enabled|disabled)\\]")); //$NON-NLS-1$
372 * Pattern to match for events section information (lttng list <session>)
374 Pattern EVENT_SECTION_PATTERN
= checkNotNull(Pattern
.compile("\\s*Events\\:")); //$NON-NLS-1$
376 * Pattern to match for event information (lttng list <session>)
378 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$
380 * Pattern to match a wildcarded event information (lttng list <session>)
382 Pattern WILDCARD_EVENT_PATTERN
= checkNotNull(Pattern
.compile("\\s+(.*)\\s+\\(type:\\s+(.*)\\)\\s+\\[(enabled|disabled)\\]\\s*(\\[.*\\]){0,1}.*")); //$NON-NLS-1$
384 * Pattern to match a probe address information (lttng list <session>)
386 Pattern PROBE_ADDRESS_PATTERN
= checkNotNull(Pattern
.compile("\\s+(addr)\\:\\s+(0x[0-9a-fA-F]{1,16})")); //$NON-NLS-1$
388 * Pattern to match a probe OFFSET information (lttng list <session>)
390 Pattern PROBE_OFFSET_PATTERN
= checkNotNull(Pattern
.compile("\\s+(offset)\\:\\s+(0x[0-9a-fA-F]{1,16})")); //$NON-NLS-1$
392 * Pattern to match a probe SYMBOL information (lttng list <session>)
394 Pattern PROBE_SYMBOL_PATTERN
= checkNotNull(Pattern
.compile("\\s+(symbol)\\:\\s+(.+)")); //$NON-NLS-1$
396 * Pattern to match for channel (overwite mode) information (lttng list <session>)
398 Pattern OVERWRITE_MODE_ATTRIBUTE
= checkNotNull(Pattern
.compile("\\s+overwrite\\s+mode\\:.*")); //$NON-NLS-1$
400 * Pattern to match indicating false for overwrite mode
402 String OVERWRITE_MODE_ATTRIBUTE_FALSE
= "0"; //$NON-NLS-1$
404 * Pattern to match indicating false for overwrite mode in machine interface mode
406 String OVERWRITE_MODE_ATTRIBUTE_FALSE_MI
= "DISCARD"; //$NON-NLS-1$
408 * Pattern to match for channel (sub-buffer size) information (lttng list <session>)
410 Pattern SUBBUFFER_SIZE_ATTRIBUTE
= checkNotNull(Pattern
.compile("\\s+subbufers\\s+size\\:.*")); //$NON-NLS-1$
412 * Pattern to match for channel (number of sub-buffers) information (lttng list <session>)
414 Pattern NUM_SUBBUFFERS_ATTRIBUTE
= checkNotNull(Pattern
.compile("\\s+number\\s+of\\s+subbufers\\:.*")); //$NON-NLS-1$
416 * Pattern to match for channel (switch timer) information (lttng list <session>)
418 Pattern SWITCH_TIMER_ATTRIBUTE
= checkNotNull(Pattern
.compile("\\s+switch\\s+timer\\s+interval\\:.*")); //$NON-NLS-1$
420 * Pattern to match for channel (read timer) information (lttng list <session>)
422 Pattern READ_TIMER_ATTRIBUTE
= checkNotNull(Pattern
.compile("\\s+read\\s+timer\\s+interval\\:.*")); //$NON-NLS-1$
424 * Pattern to match for channel (output type) information (lttng list <session>)
426 Pattern OUTPUT_ATTRIBUTE
= checkNotNull(Pattern
.compile("\\s+output\\:.*")); //$NON-NLS-1$
428 * Pattern to match for channel (trace file size) information (lttng list <session>)
430 Pattern TRACE_FILE_COUNT_ATTRIBUTE
= checkNotNull(Pattern
.compile("\\s+trace\\s+file\\s+count\\:.*")); //$NON-NLS-1$
432 * Pattern to match for channel (trace file size) information (lttng list <session>)
434 Pattern TRACE_FILE_SIZE_ATTRIBUTE
= checkNotNull(Pattern
.compile("\\s+trace\\s+file\\s+size\\s+\\(bytes\\)\\:.*")); //$NON-NLS-1$
436 * Pattern to match for provider information (lttng list -k/-u)
438 Pattern PROVIDER_EVENT_PATTERN
= checkNotNull(Pattern
.compile("\\s*(.*)\\s+\\(loglevel:\\s+(.*)\\s+\\(\\d*\\)\\)\\s+\\(type:\\s+(.*)\\)")); //$NON-NLS-1$
440 * Pattern to match event fields
442 Pattern EVENT_FIELD_PATTERN
= checkNotNull(Pattern
.compile("\\s*(field:)\\s+(.*)\\s+\\((.*)\\)")); //$NON-NLS-1$
444 * Pattern to match for UST provider information (lttng list -u)
446 Pattern UST_PROVIDER_PATTERN
= checkNotNull(Pattern
.compile("\\s*PID\\:\\s+(\\d+)\\s+-\\s+Name\\:\\s+(.*)")); //$NON-NLS-1$
448 * Pattern to match for session information (lttng create <session name>)
450 Pattern CREATE_SESSION_NAME_PATTERN
= checkNotNull(Pattern
.compile(".*Session\\s+(.*)\\s+created\\.")); //$NON-NLS-1$
452 * Pattern to match for session path information (lttng create <session name>)
454 Pattern CREATE_SESSION_PATH_PATTERN
= checkNotNull(Pattern
.compile("\\s*Traces\\s+will\\s+be\\s+written\\s+in\\s+(.*).*")); //$NON-NLS-1$
456 * Pattern to match for session command output for "session name not found".
458 Pattern SESSION_NOT_FOUND_ERROR_PATTERN
= checkNotNull(Pattern
.compile("\\s*Error:\\s+Session\\s+name\\s.*not\\s+found")); //$NON-NLS-1$
460 * Pattern to match introduction line of context list.
462 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$
464 * Pattern to match introduction line of context list.
466 Pattern ADD_CONTEXT_HELP_CONTEXTS_END_LINE
= checkNotNull(Pattern
.compile("\\s*Example.*")); //$NON-NLS-1$
468 * Pattern to match error line if no kernel tracer is available or installed.
470 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$;
472 * Pattern to match error line if no ust tracer is available or installed.
474 Pattern LIST_UST_NO_UST_PROVIDER_PATTERN
= checkNotNull(Pattern
.compile(".*Unable\\s*to\\s*list\\s*UST\\s*event.*")); //$NON-NLS-1$;
476 * Pattern to match for list snapshot information (lttng snapshot list-output)
478 Pattern LIST_SNAPSHOT_OUTPUT_PATTERN
= checkNotNull(Pattern
.compile("\\s+\\[(\\d+)\\]\\s+(\\S*)\\:\\s+(\\S*)(.*)")); //$NON-NLS-1$
480 * Pattern to match the live timer interval line of session list.
482 Pattern LIST_LIVE_TIMER_INTERVAL_PATTERN
= checkNotNull(Pattern
.compile("\\s*Live\\stimer\\sinterval\\s\\(usec\\):\\s(\\d+)")); //$NON-NLS-1$
484 * Pattern to match snapshot path for network tracing (lttng list <session>)
485 * Note: file for protocol is not considered as network trace since local consumer will be used.
487 Pattern SNAPSHOT_NETWORK_PATH_PATTERN
= checkNotNull(Pattern
.compile("(net|net4|net6|tcp|tcp4|tcp6)\\:\\/\\/(.*)(\\:(\\d*)\\/(.*)\\[data\\:\\s+(\\d*)\\]){0,1}")); //$NON-NLS-1$