org.eclipse.linuxtools.lttng2.ui/src/org/eclipse/linuxtools/internal/lttng2/ui/views/control/service/LTTngControlServiceConstants.java

   1 /**********************************************************************
   2  * Copyright (c) 2012, 2013 Ericsson
   3  *
   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
   8  *
   9  * Contributors:
  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;
  15
  16 import java.util.regex.Pattern;
  17
  18 /**
  19  * <p>
  20  * Constants for LTTng Control Service.
  21  * </p>
  22  *
  23  * @author Bernd Hufmann
  24  */
  25 public interface LTTngControlServiceConstants {
  26
  27     // ------------------------------------------------------------------------
  28     // Version constants
  29     // ------------------------------------------------------------------------
  30     /**
  31      * Pattern to match the LTTng toolchain version 2.x.y.
  32      */
  33     static final Pattern VERSION_2_PATTERN = Pattern.compile("(2\\.\\d+\\.\\d+).*"); //$NON-NLS-1$
  34
  35     // ------------------------------------------------------------------------
  36     // Constants
  37     // ------------------------------------------------------------------------
  38     /**
  39      * Unused value
  40      */
  41     static final int UNUSED_VALUE = -1;
  42
  43     // ------------------------------------------------------------------------
  44     // Command constants
  45     // ------------------------------------------------------------------------
  46     /**
  47      * The lttng tools command.
  48      */
  49     static final String CONTROL_COMMAND = "lttng"; //$NON-NLS-1$
  50     /**
  51      * Command: lttng version.
  52      */
  53     static final String COMMAND_VERSION = " version "; //$NON-NLS-1$
  54     /**
  55      * Command: lttng list.
  56      */
  57     static final String COMMAND_LIST = " list "; //$NON-NLS-1$
  58     /**
  59      * Command to list kernel tracer information.
  60      */
  61     static final String COMMAND_LIST_KERNEL = COMMAND_LIST + "-k"; //$NON-NLS-1$
  62     /**
  63      * Command to list user space trace information.
  64      */
  65     static final String COMMAND_LIST_UST = COMMAND_LIST + "-u";  //$NON-NLS-1$
  66     /**
  67      * Command to create a session.
  68      */
  69     static final String COMMAND_CREATE_SESSION = " create "; //$NON-NLS-1$
  70     /**
  71      * Command to destroy a session.
  72      */
  73     static final String COMMAND_DESTROY_SESSION = " destroy "; //$NON-NLS-1$
  74     /**
  75      * Command to destroy a session.
  76      */
  77     static final String COMMAND_START_SESSION = " start "; //$NON-NLS-1$
  78     /**
  79      * Command to destroy a session.
  80      */
  81     static final String COMMAND_STOP_SESSION = " stop "; //$NON-NLS-1$
  82     /**
  83      * Command to enable a channel.
  84      */
  85     static final String COMMAND_ENABLE_CHANNEL = " enable-channel "; //$NON-NLS-1$
  86     /**
  87      * Command to disable a channel.
  88      */
  89     static final String COMMAND_DISABLE_CHANNEL = " disable-channel "; //$NON-NLS-1$
  90     /**
  91      * Command to enable a event.
  92      */
  93     static final String COMMAND_ENABLE_EVENT = " enable-event "; //$NON-NLS-1$
  94     /**
  95      * Command to disable a event.
  96      */
  97     static final String COMMAND_DISABLE_EVENT = " disable-event "; //$NON-NLS-1$
  98     /**
  99      * Command to add a context to channels and/or events
 100      */
 101     static final String COMMAND_ADD_CONTEXT = " add-context "; //$NON-NLS-1$
 102     /**
 103      * Command to execute calibrate command to quantify LTTng overhead
 104      */
 105     static final String COMMAND_CALIBRATE = " calibrate "; //$NON-NLS-1$
 106
 107     // ------------------------------------------------------------------------
 108     // Command line options constants
 109     // ------------------------------------------------------------------------
 110     /**
 111      * Command line option to add tracing group of user.
 112      */
 113     static final String OPTION_TRACING_GROUP = " -g ";  //$NON-NLS-1$
 114     /**
 115      * Command line option for verbose output.
 116      */
 117     static final String OPTION_VERBOSE = " -v ";  //$NON-NLS-1$
 118     /**
 119      * Command line option for verbose output.
 120      */
 121     static final String OPTION_VERY_VERBOSE = " -vv ";  //$NON-NLS-1$
 122     /**
 123      * Command line option for verbose output.
 124      */
 125     static final String OPTION_VERY_VERY_VERBOSE = " -vvv ";  //$NON-NLS-1$
 126     /**
 127      * Command line option for output path.
 128      */
 129     static final String OPTION_OUTPUT_PATH = " -o "; //$NON-NLS-1$
 130     /**
 131      * Command line option for kernel tracer.
 132      */
 133     static final String OPTION_KERNEL = " -k "; //$NON-NLS-1$
 134     /**
 135      * Command line option for UST tracer.
 136      */
 137     static final String OPTION_UST = " -u "; //$NON-NLS-1$
 138     /**
 139      * Command line option for specifying a session.
 140      */
 141     static final String OPTION_SESSION = " -s ";  //$NON-NLS-1$
 142     /**
 143      * Command line option for specifying a channel.
 144      */
 145     static final String OPTION_CHANNEL = " -c ";  //$NON-NLS-1$
 146     /**
 147      * Command line option for specifying a event.
 148      */
 149     static final String OPTION_EVENT = " -e ";  //$NON-NLS-1$
 150     /**
 151      * Command line option for specifying all events.
 152      */
 153     static final String OPTION_ALL = " -a ";  //$NON-NLS-1$
 154     /**
 155      * Command line option for specifying a context.
 156      */
 157     static final String OPTION_CONTEXT_TYPE = " -t ";  //$NON-NLS-1$
 158     /**
 159      * Command line option for specifying tracepoint events.
 160      */
 161     static final String OPTION_TRACEPOINT = " --tracepoint ";  //$NON-NLS-1$
 162     /**
 163      * Command line option for specifying syscall events.
 164      */
 165     static final String OPTION_SYSCALL = " --syscall ";  //$NON-NLS-1$
 166     /**
 167      * Command line option for specifying a dynamic probe.
 168      */
 169     static final String OPTION_PROBE = " --probe ";  //$NON-NLS-1$
 170     /**
 171      * Command line option for specifying a dynamic function entry/return probe.
 172      */
 173     static final String OPTION_FUNCTION_PROBE = " --function ";  //$NON-NLS-1$
 174     /**
 175      * Command line option for specifying a log level range.
 176      */
 177     static final String OPTION_LOGLEVEL = " --loglevel ";  //$NON-NLS-1$
 178     /**
 179      * Command line option for specifying a specific log level.
 180      */
 181     static final String OPTION_LOGLEVEL_ONLY = " --loglevel-only ";  //$NON-NLS-1$
 182     /**
 183      * Optional command line option for configuring a channel's overwrite mode.
 184      */
 185     static final String OPTION_OVERWRITE = " --overwrite ";  //$NON-NLS-1$
 186     /**
 187      * Optional command line option for configuring a channel's number of sub buffers.
 188      */
 189     static final String OPTION_NUM_SUB_BUFFERS = " --num-subbuf ";  //$NON-NLS-1$
 190     /**
 191      * Optional command line option for configuring a channel's sub buffer size.
 192      */
 193     static final String OPTION_SUB_BUFFER_SIZE = " --subbuf-size ";  //$NON-NLS-1$
 194     /**
 195      * Optional command line option for configuring a channel's switch timer interval.
 196      */
 197     static final String OPTION_SWITCH_TIMER = " --switch-timer ";  //$NON-NLS-1$
 198     /**
 199      * Optional command line option for configuring a channel's read timer interval.
 200      */
 201     static final String OPTION_READ_TIMER = " --read-timer ";  //$NON-NLS-1$
 202     /**
 203      * Command line option for printing the help of a specif command
 204      */
 205     static final String OPTION_HELP = " -h ";  //$NON-NLS-1$
 206     /**
 207      * Command line option for listing the fields of UST tracepoints
 208      */
 209     static final String OPTION_FIELDS = " -f "; //$NON-NLS-1$
 210     /**
 211      * Command line option for configuring event's filter
 212      */
 213     static final String OPTION_FILTER = " --filter "; //$NON-NLS-1$
 214     /**
 215      * Command line option for configuring the streaming network URL (common for control and data channel).
 216      */
 217     static final String OPTION_NETWORK_URL = " -U "; //$NON-NLS-1$
 218     /**
 219      * Command line option for configuring the streaming control URL.
 220      */
 221     static final String OPTION_CONTROL_URL = " -C "; //$NON-NLS-1$
 222     /**
 223      * Command line option for configuring the streaming data URL.
 224      */
 225     static final String OPTION_DATA_URL = " -D "; //$NON-NLS-1$
 226     /**
 227      * Command line option for per UID buffers
 228      */
 229     static final String OPTION_PER_UID_BUFFERS = " --buffers-uid "; //$NON-NLS-1$
 230     /**
 231      * Command line option for maximum size of trace files
 232      */
 233     static final String OPTION_MAX_SIZE_TRACE_FILES = " -C "; //$NON-NLS-1$
 234     /**
 235      * Command line option for maximum trace files
 236      */
 237     static final String OPTION_MAX_TRACE_FILES = " -W "; //$NON-NLS-1$
 238
 239     // ------------------------------------------------------------------------
 240     // Parsing constants
 241     // ------------------------------------------------------------------------
 242     /**
 243      * Pattern to match the version.
 244      */
 245     static final Pattern VERSION_PATTERN = Pattern.compile(".*lttng\\s+version\\s+(\\d+\\.\\d+\\.\\d+).*"); //$NON-NLS-1$
 246     /**
 247      * Pattern to match for error output
 248      */
 249     static final Pattern ERROR_PATTERN = Pattern.compile("\\s*Error\\:.*"); //$NON-NLS-1$
 250     /**
 251      * Pattern to match for session information (lttng list)
 252      */
 253     static final Pattern SESSION_PATTERN = Pattern.compile("\\s+(\\d+)\\)\\s+(.*)\\s+\\((.*)\\)\\s+\\[(active|inactive)\\].*"); //$NON-NLS-1$
 254     /**
 255      * Pattern to match for session information (lttng list <session>)
 256      */
 257     static final Pattern TRACE_SESSION_PATTERN = Pattern.compile("\\s*Tracing\\s+session\\s+(.*)\\:\\s+\\[(active|inactive)\\].*"); //$NON-NLS-1$
 258     /**
 259      * Pattern to match for session path information (lttng list <session>)
 260      */
 261     static final Pattern TRACE_SESSION_PATH_PATTERN = Pattern.compile("\\s*Trace\\s+path\\:\\s+(.*)"); //$NON-NLS-1$
 262     /**
 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.
 265      */
 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$
 267     /**
 268      * Sub-pattern to pattern TRACE_NETWORK_PATH_PATTERN to match file protocol
 269      */
 270     static final Pattern TRACE_FILE_PROTOCOL_PATTERN = Pattern.compile("(file)\\:\\/\\/(.*)"); //$NON-NLS-1$
 271     /**
 272      * Pattern to match for kernel domain information (lttng list <session>)
 273      */
 274     static final Pattern DOMAIN_KERNEL_PATTERN = Pattern.compile("=== Domain: Kernel ==="); //$NON-NLS-1$
 275     /**
 276      * Pattern to match for ust domain information (lttng list <session>)
 277      */
 278     static final Pattern DOMAIN_UST_GLOBAL_PATTERN = Pattern.compile("=== Domain: UST global ==="); //$NON-NLS-1$
 279     /**
 280      * Pattern to match for matching warning about no kernel channel
 281      */
 282     static final Pattern DOMAIN_NO_KERNEL_CHANNEL_PATTERN = Pattern.compile("\\s*Warning\\:\\s+No kernel\\s+channel.*"); //$NON-NLS-1$
 283     /**
 284      * Pattern to match for matching warning about no UST channel
 285      */
 286     static final Pattern DOMAIN_NO_UST_CHANNEL_PATTERN = Pattern.compile("\\s*Error\\:\\s+UST\\s+channel\\s+not\\s+found.*"); //$NON-NLS-1$
 287     /**
 288      * Pattern to match for channels section (lttng list <session>)
 289      */
 290     static final Pattern CHANNELS_SECTION_PATTERN = Pattern.compile("\\s*Channels\\:"); //$NON-NLS-1$
 291     /**
 292      * Pattern to match for channel information (lttng list <session>)
 293      */
 294     static final Pattern CHANNEL_PATTERN = Pattern.compile("\\s*-\\s+(.*)\\:\\s+\\[(enabled|disabled)\\]"); //$NON-NLS-1$
 295     /**
 296      * Pattern to match for events section information (lttng list <session>)
 297      */
 298     static final Pattern EVENT_SECTION_PATTERN = Pattern.compile("\\s*Events\\:"); //$NON-NLS-1$
 299     /**
 300      * Pattern to match for event information (lttng list <session>)
 301      */
 302     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$
 303     /**
 304      * Pattern to match a wildcarded event information (lttng list <session>)
 305      */
 306     static final Pattern WILDCARD_EVENT_PATTERN = Pattern.compile("\\s+(.*)\\s+\\(type:\\s+(.*)\\)\\s+\\[(enabled|disabled)\\]\\s*(\\[.*\\]){0,1}.*"); //$NON-NLS-1$
 307     /**
 308      * Pattern to match a probe address information (lttng list <session>)
 309      */
 310     static final Pattern PROBE_ADDRESS_PATTERN = Pattern.compile("\\s+(addr)\\:\\s+(0x[0-9a-fA-F]{1,8})"); //$NON-NLS-1$
 311     /**
 312      * Pattern to match a probe OFFSET information (lttng list <session>)
 313      */
 314     static final Pattern PROBE_OFFSET_PATTERN = Pattern.compile("\\s+(offset)\\:\\s+(0x[0-9a-fA-F]{1,8})"); //$NON-NLS-1$
 315     /**
 316      * Pattern to match a probe SYMBOL information (lttng list <session>)
 317      */
 318     static final Pattern PROBE_SYMBOL_PATTERN = Pattern.compile("\\s+(symbol)\\:\\s+(.+)"); //$NON-NLS-1$
 319     /**
 320      * Pattern to match for channel (overwite mode) information (lttng list <session>)
 321      */
 322     static final Pattern OVERWRITE_MODE_ATTRIBUTE = Pattern.compile("\\s+overwrite\\s+mode\\:.*"); //$NON-NLS-1$
 323     /**
 324      * Pattern to match indicating false for overwrite mode
 325      */
 326     static final String OVERWRITE_MODE_ATTRIBUTE_FALSE = "0"; //$NON-NLS-1$
 327     /**
 328      * Pattern to match for channel (sub-buffer size) information (lttng list <session>)
 329      */
 330     static final Pattern SUBBUFFER_SIZE_ATTRIBUTE = Pattern.compile("\\s+subbufers\\s+size\\:.*"); //$NON-NLS-1$
 331     /**
 332      * Pattern to match for channel (number of sub-buffers) information (lttng list <session>)
 333      */
 334     static final Pattern NUM_SUBBUFFERS_ATTRIBUTE = Pattern.compile("\\s+number\\s+of\\s+subbufers\\:.*"); //$NON-NLS-1$
 335     /**
 336      * Pattern to match for channel (switch timer) information (lttng list <session>)
 337      */
 338     static final Pattern SWITCH_TIMER_ATTRIBUTE = Pattern.compile("\\s+switch\\s+timer\\s+interval\\:.*"); //$NON-NLS-1$
 339     /**
 340      * Pattern to match for channel (read timer) information (lttng list <session>)
 341      */
 342     static final Pattern READ_TIMER_ATTRIBUTE = Pattern.compile("\\s+read\\s+timer\\s+interval\\:.*"); //$NON-NLS-1$
 343     /**
 344      * Pattern to match for channel (output type) information (lttng list <session>)
 345      */
 346     static final Pattern OUTPUT_ATTRIBUTE = Pattern.compile("\\s+output\\:.*"); //$NON-NLS-1$
 347     /**
 348      * Pattern to match for provider information (lttng list -k/-u)
 349      */
 350     static final Pattern PROVIDER_EVENT_PATTERN = Pattern.compile("\\s*(.*)\\s+\\(loglevel:\\s+(.*)\\s+\\(\\d*\\)\\)\\s+\\(type:\\s+(.*)\\)"); //$NON-NLS-1$
 351     /**
 352      * Pattern to match event fields
 353      */
 354     static final Pattern EVENT_FIELD_PATTERN = Pattern.compile("\\s*(field:)\\s+(.*)\\s+\\((.*)\\)"); //$NON-NLS-1$
 355     /**
 356      * Pattern to match for UST provider information (lttng list -u)
 357      */
 358     static final Pattern UST_PROVIDER_PATTERN = Pattern.compile("\\s*PID\\:\\s+(\\d+)\\s+-\\s+Name\\:\\s+(.*)"); //$NON-NLS-1$
 359     /**
 360      * Pattern to match for session information (lttng create <session name>)
 361      */
 362     static final Pattern CREATE_SESSION_NAME_PATTERN = Pattern.compile(".*Session\\s+(.*)\\s+created\\."); //$NON-NLS-1$
 363     /**
 364      * Pattern to match for session path information (lttng create <session name>)
 365      */
 366     static final Pattern CREATE_SESSION_PATH_PATTERN = Pattern.compile("\\s*Traces\\s+will\\s+be\\s+written\\s+in\\s+(.*).*"); //$NON-NLS-1$
 367     /**
 368      * Pattern to match for session command output for "session name not found".
 369      */
 370     static final Pattern SESSION_NOT_FOUND_ERROR_PATTERN = Pattern.compile("\\s*Error:\\s+Session\\s+name\\s+not\\s+found"); //$NON-NLS-1$
 371     /**
 372      * Pattern to match introduction line of context list.
 373      */
 374     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$
 375     /**
 376      * Pattern to match introduction line of context list.
 377      */
 378     static final Pattern ADD_CONTEXT_HELP_CONTEXTS_END_LINE = Pattern.compile("\\s*Example.*"); //$NON-NLS-1$
 379     /**
 380      * Pattern to match error line if no kernel tracer is available or installed.
 381      */
 382     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$;
 383     /**
 384      * Pattern to match error line if no ust tracer is available or installed.
 385      */
 386     static final Pattern LIST_UST_NO_UST_PROVIDER_PATTERN = Pattern.compile(".*Unable\\s*to\\s*list\\s*UST\\s*event.*"); //$NON-NLS-1$;
 387 }