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

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