lttng/org.eclipse.tracecompass.lttng2.control.ui/src/org/eclipse/tracecompass/internal/lttng2/control/ui/views/service/LTTngControlService.java

   1 /**********************************************************************
   2  * Copyright (c) 2012, 2015 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  *   Marc-Andre Laperle - Support for creating a live session
  14  *   Markus Schorn - Bug 448058: Use org.eclipse.remote in favor of RSE
  15  **********************************************************************/
  16 package org.eclipse.tracecompass.internal.lttng2.control.ui.views.service;
  17
  18 import static org.eclipse.tracecompass.common.core.NonNullUtils.checkNotNull;
  19 import static org.eclipse.tracecompass.common.core.NonNullUtils.nullToEmptyString;
  20
  21 import java.util.ArrayList;
  22 import java.util.Arrays;
  23 import java.util.Iterator;
  24 import java.util.List;
  25 import java.util.regex.Matcher;
  26 import java.util.regex.Pattern;
  27
  28 import org.eclipse.core.commands.ExecutionException;
  29 import org.eclipse.core.runtime.IProgressMonitor;
  30 import org.eclipse.core.runtime.NullProgressMonitor;
  31 import org.eclipse.jdt.annotation.NonNull;
  32 import org.eclipse.jdt.annotation.Nullable;
  33 import org.eclipse.tracecompass.internal.lttng2.control.core.model.IBaseEventInfo;
  34 import org.eclipse.tracecompass.internal.lttng2.control.core.model.IChannelInfo;
  35 import org.eclipse.tracecompass.internal.lttng2.control.core.model.IDomainInfo;
  36 import org.eclipse.tracecompass.internal.lttng2.control.core.model.IEventInfo;
  37 import org.eclipse.tracecompass.internal.lttng2.control.core.model.IFieldInfo;
  38 import org.eclipse.tracecompass.internal.lttng2.control.core.model.IProbeEventInfo;
  39 import org.eclipse.tracecompass.internal.lttng2.control.core.model.ISessionInfo;
  40 import org.eclipse.tracecompass.internal.lttng2.control.core.model.ISnapshotInfo;
  41 import org.eclipse.tracecompass.internal.lttng2.control.core.model.IUstProviderInfo;
  42 import org.eclipse.tracecompass.internal.lttng2.control.core.model.LogLevelType;
  43 import org.eclipse.tracecompass.internal.lttng2.control.core.model.TraceEventType;
  44 import org.eclipse.tracecompass.internal.lttng2.control.core.model.TraceLogLevel;
  45 import org.eclipse.tracecompass.internal.lttng2.control.core.model.impl.BaseEventInfo;
  46 import org.eclipse.tracecompass.internal.lttng2.control.core.model.impl.BufferType;
  47 import org.eclipse.tracecompass.internal.lttng2.control.core.model.impl.ChannelInfo;
  48 import org.eclipse.tracecompass.internal.lttng2.control.core.model.impl.DomainInfo;
  49 import org.eclipse.tracecompass.internal.lttng2.control.core.model.impl.EventInfo;
  50 import org.eclipse.tracecompass.internal.lttng2.control.core.model.impl.FieldInfo;
  51 import org.eclipse.tracecompass.internal.lttng2.control.core.model.impl.ProbeEventInfo;
  52 import org.eclipse.tracecompass.internal.lttng2.control.core.model.impl.SessionInfo;
  53 import org.eclipse.tracecompass.internal.lttng2.control.core.model.impl.SnapshotInfo;
  54 import org.eclipse.tracecompass.internal.lttng2.control.core.model.impl.UstProviderInfo;
  55 import org.eclipse.tracecompass.internal.lttng2.control.ui.views.logging.ControlCommandLogger;
  56 import org.eclipse.tracecompass.internal.lttng2.control.ui.views.messages.Messages;
  57 import org.eclipse.tracecompass.internal.lttng2.control.ui.views.preferences.ControlPreferences;
  58 import org.eclipse.tracecompass.tmf.remote.core.shell.ICommandInput;
  59 import org.eclipse.tracecompass.tmf.remote.core.shell.ICommandResult;
  60 import org.eclipse.tracecompass.tmf.remote.core.shell.ICommandShell;
  61
  62 /**
  63  * <p>
  64  * Service for sending LTTng trace control commands to remote host.
  65  * </p>
  66  *
  67  * @author Bernd Hufmann
  68  */
  69 public class LTTngControlService implements ILttngControlService {
  70
  71
  72     // ------------------------------------------------------------------------
  73     // Attributes
  74     // ------------------------------------------------------------------------
  75     /**
  76      * The command shell implementation
  77      */
  78     private final @NonNull ICommandShell fCommandShell;
  79
  80     /**
  81      * The version string.
  82      */
  83     private @NonNull LttngVersion fVersion = LttngVersion.NULL_VERSION;
  84
  85     // ------------------------------------------------------------------------
  86     // Constructors
  87     // ------------------------------------------------------------------------
  88
  89     /**
  90      * Constructor
  91      *
  92      * @param shell
  93      *            - the command shell implementation to use
  94      */
  95     public LTTngControlService(@NonNull ICommandShell shell) {
  96         fCommandShell = shell;
  97     }
  98
  99     // ------------------------------------------------------------------------
 100     // Accessors
 101     // ------------------------------------------------------------------------
 102
 103     @Override
 104     public String getVersionString() {
 105         return nullToEmptyString(fVersion.toString());
 106     }
 107
 108     @Override
 109     public LttngVersion getVersion() {
 110         return fVersion;
 111     }
 112
 113     /**
 114      * Sets the version of the LTTng 2.0 control service.
 115      *
 116      * @param version
 117      *            - a version to set
 118      */
 119     public void setVersion(@Nullable String version) {
 120         if (version != null) {
 121             fVersion = new LttngVersion(version);
 122         }
 123     }
 124
 125     /**
 126      * Sets the version of the LTTng 2.x control service.
 127      *
 128      * @param version
 129      *            - a version to set
 130      */
 131     public void setVersion(LttngVersion version) {
 132         if (version != null) {
 133             fVersion = version;
 134         }
 135     }
 136
 137     @Override
 138     public boolean isVersionSupported(String version) {
 139         LttngVersion tmp = new LttngVersion(version);
 140         return (fVersion.compareTo(tmp) >= 0) ? true : false;
 141     }
 142
 143     /**
 144      * Returns the command shell implementation.
 145      *
 146      * @return the command shell implementation
 147      */
 148     protected ICommandShell getCommandShell() {
 149         return fCommandShell;
 150     }
 151
 152     // ------------------------------------------------------------------------
 153     // Operations
 154     // ------------------------------------------------------------------------
 155
 156     @Override
 157     public List<String> getSessionNames(IProgressMonitor monitor) throws ExecutionException {
 158         ICommandInput command = createCommand(LTTngControlServiceConstants.COMMAND_LIST);
 159
 160         ICommandResult result = executeCommand(command, monitor);
 161
 162         // Output:
 163         // Available tracing sessions:
 164         // 1) mysession1 (/home/user/lttng-traces/mysession1-20120123-083928)
 165         // [inactive]
 166         // 2) mysession (/home/user/lttng-traces/mysession-20120123-083318)
 167         // [inactive]
 168         //
 169         // Use lttng list <session_name> for more details
 170
 171         ArrayList<String> retArray = new ArrayList<>();
 172         for (String line : result.getOutput()) {
 173             Matcher matcher = LTTngControlServiceConstants.SESSION_PATTERN.matcher(line);
 174             if (matcher.matches()) {
 175                 retArray.add(matcher.group(2).trim());
 176             }
 177         }
 178         return retArray;
 179     }
 180
 181     /**
 182      * Check if there is a pattern to be ignored into a sequence of string
 183      *
 184      * @param input
 185      *            an input list of Strings
 186      * @param pattern
 187      *            the pattern to search for
 188      * @return if the pattern exist in the array of string
 189      */
 190     protected boolean ignoredPattern(List<String> input, Pattern pattern) {
 191         for (String line : input) {
 192             Matcher matcher = pattern.matcher(line);
 193             if (matcher.matches()) {
 194                 return true;
 195             }
 196         }
 197         return false;
 198     }
 199
 200     @Override
 201     public ISessionInfo getSession(String sessionName, IProgressMonitor monitor) throws ExecutionException {
 202         ICommandInput command = createCommand(LTTngControlServiceConstants.COMMAND_LIST, sessionName);
 203         ICommandResult result = executeCommand(command, monitor);
 204
 205         int index = 0;
 206
 207         // Output:
 208         // Tracing session mysession2: [inactive]
 209         // Trace path: /home/eedbhu/lttng-traces/mysession2-20120123-110330
 210         ISessionInfo sessionInfo = new SessionInfo(sessionName);
 211
 212         while (index < result.getOutput().size()) {
 213             // Tracing session mysession2: [inactive]
 214             // Trace path: /home/eedbhu/lttng-traces/mysession2-20120123-110330
 215             //
 216             // === Domain: Kernel ===
 217             //
 218             String line = result.getOutput().get(index);
 219             Matcher matcher = LTTngControlServiceConstants.TRACE_SESSION_PATTERN.matcher(line);
 220             if (matcher.matches()) {
 221                 sessionInfo.setSessionState(matcher.group(2));
 222                 index++;
 223                 continue;
 224             }
 225
 226             matcher = LTTngControlServiceConstants.TRACE_SNAPSHOT_SESSION_PATTERN.matcher(line);
 227             if (matcher.matches()) {
 228                 sessionInfo.setSessionState(matcher.group(2));
 229                 // real name will be set later
 230                 ISnapshotInfo snapshotInfo = new SnapshotInfo(""); //$NON-NLS-1$
 231                 sessionInfo.setSnapshotInfo(snapshotInfo);
 232                 index++;
 233                 continue;
 234             }
 235
 236             if (!sessionInfo.isSnapshotSession()) {
 237                 matcher = LTTngControlServiceConstants.TRACE_NETWORK_PATH_PATTERN.matcher(line);
 238                 if (matcher.matches()) {
 239                     sessionInfo.setStreamedTrace(true);
 240                 }
 241
 242                 matcher = LTTngControlServiceConstants.TRACE_SESSION_PATH_PATTERN.matcher(line);
 243                 if (matcher.matches()) {
 244                     sessionInfo.setSessionPath(matcher.group(1).trim());
 245                     index++;
 246                     continue;
 247                 }
 248             }
 249
 250             matcher = LTTngControlServiceConstants.DOMAIN_KERNEL_PATTERN.matcher(line);
 251             if (matcher.matches()) {
 252                 // Create Domain
 253                 IDomainInfo domainInfo = new DomainInfo(Messages.TraceControl_KernelDomainDisplayName);
 254
 255                 // set kernel flag
 256                 domainInfo.setIsKernel(true);
 257
 258                 // in domain kernel
 259                 ArrayList<IChannelInfo> channels = new ArrayList<>();
 260                 index = parseDomain(result.getOutput(), index, channels, domainInfo);
 261
 262                 if (channels.size() > 0) {
 263                     // add domain
 264                     sessionInfo.addDomain(domainInfo);
 265
 266                     // set channels
 267                     domainInfo.setChannels(channels);
 268                 }
 269                 continue;
 270             }
 271
 272             matcher = LTTngControlServiceConstants.DOMAIN_UST_GLOBAL_PATTERN.matcher(line);
 273             if (matcher.matches()) {
 274                 IDomainInfo domainInfo = new DomainInfo(Messages.TraceControl_UstGlobalDomainDisplayName);
 275
 276                 // set kernel flag
 277                 domainInfo.setIsKernel(false);
 278
 279                 // in domain UST
 280                 ArrayList<IChannelInfo> channels = new ArrayList<>();
 281                 index = parseDomain(result.getOutput(), index, channels, domainInfo);
 282
 283                 if (channels.size() > 0) {
 284                     // add domain
 285                     sessionInfo.addDomain(domainInfo);
 286
 287                     // set channels
 288                     domainInfo.setChannels(channels);
 289                 }
 290                 continue;
 291             }
 292             matcher = LTTngControlServiceConstants.LIST_LIVE_TIMER_INTERVAL_PATTERN.matcher(line);
 293             if (matcher.matches()) {
 294                 long liveDelay = Long.parseLong(matcher.group(1));
 295                 if ((liveDelay > 0) && (liveDelay <= LTTngControlServiceConstants.MAX_LIVE_TIMER_INTERVAL)) {
 296                     sessionInfo.setLive(true);
 297                     sessionInfo.setLiveUrl(SessionInfo.DEFAULT_LIVE_NETWORK_URL);
 298                     sessionInfo.setLivePort(SessionInfo.DEFAULT_LIVE_PORT);
 299                     sessionInfo.setLiveDelay(liveDelay);
 300                 }
 301                 index++;
 302                 continue;
 303             }
 304
 305             index++;
 306         }
 307
 308         if (sessionInfo.isSnapshotSession()) {
 309             ISnapshotInfo snapshot = getSnapshotInfo(sessionName, monitor);
 310             sessionInfo.setSnapshotInfo(snapshot);
 311         }
 312
 313         return sessionInfo;
 314     }
 315
 316     @Override
 317     public ISnapshotInfo getSnapshotInfo(String sessionName, IProgressMonitor monitor) throws ExecutionException {
 318         ICommandInput command = createCommand(LTTngControlServiceConstants.COMMAND_SNAPSHOT, LTTngControlServiceConstants.COMMAND_LIST_SNAPSHOT_OUTPUT, LTTngControlServiceConstants.OPTION_SESSION, sessionName);
 319         ICommandResult result = executeCommand(command, monitor);
 320
 321         int index = 0;
 322
 323         // Output:
 324         // [1] snapshot-1: /home/user/lttng-traces/my-20130909-114431
 325         // or
 326         // [3] snapshot-3: net4://172.0.0.1/
 327         ISnapshotInfo snapshotInfo = new SnapshotInfo(""); //$NON-NLS-1$
 328
 329         while (index < result.getOutput().size()) {
 330             String line = result.getOutput().get(index);
 331             Matcher matcher = LTTngControlServiceConstants.LIST_SNAPSHOT_OUTPUT_PATTERN.matcher(line);
 332             if (matcher.matches()) {
 333                 snapshotInfo.setId(Integer.valueOf(matcher.group(1)));
 334                 snapshotInfo.setName(matcher.group(2));
 335                 snapshotInfo.setSnapshotPath(matcher.group(3));
 336
 337                 Matcher matcher2 = LTTngControlServiceConstants.SNAPSHOT_NETWORK_PATH_PATTERN.matcher(snapshotInfo.getSnapshotPath());
 338                 if (matcher2.matches()) {
 339                     snapshotInfo.setStreamedSnapshot(true);
 340                 }
 341
 342                 index++;
 343                 break;
 344             }
 345             index++;
 346         }
 347
 348         return snapshotInfo;
 349     }
 350
 351     @Override
 352     public List<IBaseEventInfo> getKernelProvider(IProgressMonitor monitor) throws ExecutionException {
 353         ICommandInput command = createCommand(LTTngControlServiceConstants.COMMAND_LIST, LTTngControlServiceConstants.OPTION_KERNEL);
 354         ICommandResult result = executeCommand(command, monitor, false);
 355
 356         List<IBaseEventInfo> events = new ArrayList<>();
 357
 358         // Ignore the following 2 cases:
 359         // Spawning a session daemon
 360         // Error: Unable to list kernel events
 361         // or:
 362         // Error: Unable to list kernel events
 363         //
 364         if (ignoredPattern(result.getErrorOutput(), LTTngControlServiceConstants.LIST_KERNEL_NO_KERNEL_PROVIDER_PATTERN)) {
 365             return events;
 366         }
 367
 368         if (isError(result)) {
 369             throw new ExecutionException(Messages.TraceControl_CommandError + " " + command.toString() + "\n" + result.toString()); //$NON-NLS-1$ //$NON-NLS-2$
 370         }
 371
 372         // Kernel events:
 373         // -------------
 374         // sched_kthread_stop (type: tracepoint)
 375         getProviderEventInfo(result.getOutput(), 0, events);
 376         return events;
 377     }
 378
 379     @Override
 380     public List<IUstProviderInfo> getUstProvider() throws ExecutionException {
 381         return getUstProvider(new NullProgressMonitor());
 382     }
 383
 384     @Override
 385     public List<IUstProviderInfo> getUstProvider(IProgressMonitor monitor) throws ExecutionException {
 386         ICommandInput command = createCommand(LTTngControlServiceConstants.COMMAND_LIST, LTTngControlServiceConstants.OPTION_UST);
 387
 388         if (isVersionSupported("2.1.0")) { //$NON-NLS-1$
 389             command.add(LTTngControlServiceConstants.OPTION_FIELDS);
 390         }
 391
 392         ICommandResult result = executeCommand(command, monitor, false);
 393         List<IUstProviderInfo> allProviders = new ArrayList<>();
 394
 395         // Workaround for versions 2.0.x which causes a segmentation fault for
 396         // this command
 397         // if LTTng Tools is compiled without UST support.
 398         if (!isVersionSupported("2.1.0") && (result.getResult() != 0)) { //$NON-NLS-1$
 399             return allProviders;
 400         }
 401
 402         // Ignore the following 2 cases:
 403         // Spawning a session daemon
 404         // Error: Unable to list UST events: Listing UST events failed
 405         // or:
 406         // Error: Unable to list UST events: Listing UST events failed
 407         //
 408         if (ignoredPattern(result.getErrorOutput(), LTTngControlServiceConstants.LIST_UST_NO_UST_PROVIDER_PATTERN)) {
 409             return allProviders;
 410         }
 411
 412         if (isError(result)) {
 413             throw new ExecutionException(Messages.TraceControl_CommandError + " " + command.toString() + "\n" + result.toString()); //$NON-NLS-1$ //$NON-NLS-2$
 414         }
 415
 416         // Note that field print-outs exists for version >= 2.1.0
 417         //
 418         // UST events:
 419         // -------------
 420         //
 421         // PID: 3635 - Name:
 422         // /home/user/git/lttng-ust/tests/hello.cxx/.libs/lt-hello
 423         // ust_tests_hello:tptest_sighandler (loglevel: TRACE_EMERG0) (type:
 424         // tracepoint)
 425         // ust_tests_hello:tptest (loglevel: TRACE_EMERG0) (type: tracepoint)
 426         // field: doublefield (float)
 427         // field: floatfield (float)
 428         // field: stringfield (string)
 429         //
 430         // PID: 6459 - Name:
 431         // /home/user/git/lttng-ust/tests/hello.cxx/.libs/lt-hello
 432         // ust_tests_hello:tptest_sighandler (loglevel: TRACE_EMERG0) (type:
 433         // tracepoint)
 434         // ust_tests_hello:tptest (loglevel: TRACE_EMERG0) (type: tracepoint)
 435         // field: doublefield (float)
 436         // field: floatfield (float)
 437         // field: stringfield (string)
 438
 439         IUstProviderInfo provider = null;
 440
 441         int index = 0;
 442         while (index < result.getOutput().size()) {
 443             String line = result.getOutput().get(index);
 444             Matcher matcher = LTTngControlServiceConstants.UST_PROVIDER_PATTERN.matcher(line);
 445             if (matcher.matches()) {
 446                 provider = new UstProviderInfo(matcher.group(2).trim());
 447                 provider.setPid(Integer.valueOf(matcher.group(1).trim()));
 448                 List<IBaseEventInfo> events = new ArrayList<>();
 449                 index = getProviderEventInfo(result.getOutput(), ++index, events);
 450                 provider.setEvents(events);
 451                 allProviders.add(provider);
 452             } else {
 453                 index++;
 454             }
 455         }
 456         return allProviders;
 457     }
 458
 459     @Override
 460     public ISessionInfo createSession(ISessionInfo sessionInfo, IProgressMonitor monitor) throws ExecutionException {
 461         if (sessionInfo.isStreamedTrace()) {
 462             return createStreamedSession(sessionInfo, monitor);
 463         }
 464
 465         ICommandInput command = prepareSessionCreationCommand(sessionInfo);
 466
 467         ICommandResult result = executeCommand(command, monitor);
 468
 469         // Session myssession2 created.
 470         // Traces will be written in
 471         // /home/user/lttng-traces/myssession2-20120209-095418
 472         List<String> output = result.getOutput();
 473
 474         // Get and session name and path
 475         String name = null;
 476         String path = null;
 477
 478         for (String line : output) {
 479             Matcher nameMatcher = LTTngControlServiceConstants.CREATE_SESSION_NAME_PATTERN.matcher(line);
 480             Matcher pathMatcher = LTTngControlServiceConstants.CREATE_SESSION_PATH_PATTERN.matcher(line);
 481             if (nameMatcher.matches()) {
 482                 name = String.valueOf(nameMatcher.group(1).trim());
 483             } else if (pathMatcher.matches()) {
 484                 path = String.valueOf(pathMatcher.group(1).trim());
 485             }
 486         }
 487
 488         // Verify session name
 489         if ((name == null) || (!"".equals(sessionInfo.getName()) && !name.equals(sessionInfo.getName()))) { //$NON-NLS-1$
 490             // Unexpected name returned
 491             throw new ExecutionException(Messages.TraceControl_CommandError + " " + command.toString() + "\n" + //$NON-NLS-1$ //$NON-NLS-2$
 492                     Messages.TraceControl_UnexpectedNameError + ": " + name); //$NON-NLS-1$
 493         }
 494
 495         sessionInfo.setName(name);
 496         // Verify session path
 497         if (!sessionInfo.isSnapshotSession() &&
 498                 ((path == null) || ((sessionInfo.getSessionPath() != null) && (!path.contains(sessionInfo.getSessionPath()))))) {
 499             // Unexpected path
 500             throw new ExecutionException(Messages.TraceControl_CommandError + " " + command.toString() + "\n" + //$NON-NLS-1$ //$NON-NLS-2$
 501                     Messages.TraceControl_UnexpectedPathError + ": " + name); //$NON-NLS-1$
 502         }
 503
 504         if (sessionInfo.isSnapshotSession()) {
 505             // Make it a snapshot session - content of snapshot info need to
 506             // set afterwards using getSession() or getSnapshotInfo()
 507             sessionInfo.setSnapshotInfo(new SnapshotInfo("")); //$NON-NLS-1$
 508         } else {
 509             sessionInfo.setSessionPath(path);
 510         }
 511
 512         return sessionInfo;
 513
 514     }
 515
 516     /**
 517      * Basic generation of command for session creation
 518      *
 519      * @param sessionInfo
 520      *            the session to create
 521      * @return the basic command for command creation
 522      */
 523     protected @NonNull ICommandInput prepareSessionCreationCommand(ISessionInfo sessionInfo) {
 524         ICommandInput command = createCommand(LTTngControlServiceConstants.COMMAND_CREATE_SESSION);
 525         if (!sessionInfo.getName().isEmpty()) {
 526             command.add(sessionInfo.getName());
 527         }
 528
 529         String newPath = sessionInfo.getSessionPath();
 530         if (newPath != null && !"".equals(newPath)) { //$NON-NLS-1$
 531             command.add(LTTngControlServiceConstants.OPTION_OUTPUT_PATH);
 532             command.add(newPath);
 533         }
 534
 535         if (sessionInfo.isSnapshotSession()) {
 536             command.add(LTTngControlServiceConstants.OPTION_SNAPSHOT);
 537         }
 538         return command;
 539     }
 540
 541     private @NonNull ISessionInfo createStreamedSession(ISessionInfo sessionInfo, IProgressMonitor monitor) throws ExecutionException {
 542
 543         ICommandInput command = prepareStreamedSessionCreationCommand(sessionInfo);
 544
 545         ICommandResult result = executeCommand(command, monitor);
 546
 547         // Verify output
 548         List<String> output = result.getOutput();
 549
 550         // Get and session name and path
 551         String name = null;
 552         String path = null;
 553
 554         for (String line : output) {
 555             Matcher nameMatcher = LTTngControlServiceConstants.CREATE_SESSION_NAME_PATTERN.matcher(line);
 556             Matcher pathMatcher = LTTngControlServiceConstants.CREATE_SESSION_PATH_PATTERN.matcher(line);
 557
 558             if (nameMatcher.matches()) {
 559                 name = String.valueOf(nameMatcher.group(1).trim());
 560             } else if (pathMatcher.matches() && (sessionInfo.getNetworkUrl() != null)) {
 561                 path = String.valueOf(pathMatcher.group(1).trim());
 562             }
 563         }
 564
 565         // Verify session name
 566         if ((name == null) || (!"".equals(sessionInfo.getName()) && !name.equals(sessionInfo.getName()))) { //$NON-NLS-1$
 567             // Unexpected name returned
 568             throw new ExecutionException(Messages.TraceControl_CommandError + " " + command.toString() + "\n" + //$NON-NLS-1$ //$NON-NLS-2$
 569                     Messages.TraceControl_UnexpectedNameError + ": " + name); //$NON-NLS-1$
 570         }
 571
 572         sessionInfo.setName(name);
 573
 574         sessionInfo.setStreamedTrace(true);
 575
 576         // Verify session path
 577         if (sessionInfo.getNetworkUrl() != null) {
 578             if (!sessionInfo.isSnapshotSession() && (path == null)) {
 579                 // Unexpected path
 580                 throw new ExecutionException(Messages.TraceControl_CommandError + " " + command.toString() + "\n" + //$NON-NLS-1$ //$NON-NLS-2$
 581                         Messages.TraceControl_UnexpectedPathError + ": " + name); //$NON-NLS-1$
 582             }
 583
 584             if (sessionInfo.isSnapshotSession()) {
 585                 sessionInfo.setStreamedTrace(false);
 586             } else {
 587                 sessionInfo.setSessionPath(path);
 588                 // Check file protocol
 589                 Matcher matcher = LTTngControlServiceConstants.TRACE_FILE_PROTOCOL_PATTERN.matcher(path);
 590                 if (matcher.matches()) {
 591                     sessionInfo.setStreamedTrace(false);
 592                 }
 593             }
 594         }
 595
 596         // When using controlUrl and dataUrl the full session path is not known
 597         // yet and will be set later on when listing the session
 598
 599         return sessionInfo;
 600     }
 601
 602     /**
 603      * Basic generation of command for streamed session creation
 604      *
 605      * @param sessionInfo
 606      *            the session to create
 607      * @return the basic command for command creation
 608      */
 609      protected @NonNull ICommandInput prepareStreamedSessionCreationCommand(ISessionInfo sessionInfo) {
 610         ICommandInput command = createCommand(LTTngControlServiceConstants.COMMAND_CREATE_SESSION);
 611         if (!sessionInfo.getName().isEmpty()) {
 612             command.add(sessionInfo.getName());
 613         }
 614
 615         if (sessionInfo.isSnapshotSession()) {
 616             command.add(LTTngControlServiceConstants.OPTION_SNAPSHOT);
 617         } else if (sessionInfo.isLive()) {
 618             command.add(LTTngControlServiceConstants.OPTION_LIVE);
 619             if (sessionInfo.getLiveDelay() != LTTngControlServiceConstants.UNUSED_VALUE) {
 620                 command.add(String.valueOf(sessionInfo.getLiveDelay()));
 621             }
 622         }
 623
 624         if (sessionInfo.getNetworkUrl() != null) {
 625             command.add(LTTngControlServiceConstants.OPTION_NETWORK_URL);
 626             command.add(sessionInfo.getNetworkUrl());
 627         } else {
 628             command.add(LTTngControlServiceConstants.OPTION_CONTROL_URL);
 629             command.add(sessionInfo.getControlUrl());
 630
 631             command.add(LTTngControlServiceConstants.OPTION_DATA_URL);
 632             command.add(sessionInfo.getDataUrl());
 633         }
 634         return command;
 635     }
 636
 637     @Override
 638     public void destroySession(String sessionName, IProgressMonitor monitor) throws ExecutionException {
 639
 640         ICommandInput command = createCommand(LTTngControlServiceConstants.COMMAND_DESTROY_SESSION, sessionName);
 641
 642         ICommandResult result = executeCommand(command, monitor, false);
 643         boolean isError = isError(result);
 644         if (isError && !ignoredPattern(result.getErrorOutput(), LTTngControlServiceConstants.SESSION_NOT_FOUND_ERROR_PATTERN)) {
 645             throw new ExecutionException(Messages.TraceControl_CommandError + " " + command.toString() + "\n" + result.toString()); //$NON-NLS-1$ //$NON-NLS-2$
 646         }
 647
 648         // Session <sessionName> destroyed
 649     }
 650
 651     @Override
 652     public void startSession(String sessionName, IProgressMonitor monitor) throws ExecutionException {
 653
 654         ICommandInput command = createCommand(LTTngControlServiceConstants.COMMAND_START_SESSION, sessionName);
 655
 656         executeCommand(command, monitor);
 657
 658         // Session <sessionName> started
 659     }
 660
 661     @Override
 662     public void stopSession(String sessionName, IProgressMonitor monitor) throws ExecutionException {
 663         ICommandInput command = createCommand(LTTngControlServiceConstants.COMMAND_STOP_SESSION, sessionName);
 664
 665         executeCommand(command, monitor);
 666
 667         // Session <sessionName> stopped
 668
 669     }
 670
 671     @Override
 672     public void enableChannels(String sessionName, List<String> channelNames, boolean isKernel, IChannelInfo info, IProgressMonitor monitor) throws ExecutionException {
 673
 674         // no channels to enable
 675         if (channelNames.isEmpty()) {
 676             return;
 677         }
 678
 679         ICommandInput command = createCommand(LTTngControlServiceConstants.COMMAND_ENABLE_CHANNEL);
 680
 681         command.add(toCsv(channelNames));
 682
 683         if (isKernel) {
 684             command.add(LTTngControlServiceConstants.OPTION_KERNEL);
 685         } else {
 686             command.add(LTTngControlServiceConstants.OPTION_UST);
 687         }
 688
 689         command.add(LTTngControlServiceConstants.OPTION_SESSION);
 690         command.add(sessionName);
 691
 692         if (info != null) {
 693             // --discard Discard event when buffers are full (default)
 694
 695             // --overwrite Flight recorder mode
 696             if (info.isOverwriteMode()) {
 697                 command.add(LTTngControlServiceConstants.OPTION_OVERWRITE);
 698             }
 699             // --subbuf-size SIZE Subbuffer size in bytes
 700             // (default: 4096, kernel default: 262144)
 701             if (info.getSubBufferSize() != LTTngControlServiceConstants.UNUSED_VALUE) {
 702                 command.add(LTTngControlServiceConstants.OPTION_SUB_BUFFER_SIZE);
 703                 command.add(String.valueOf(info.getSubBufferSize()));
 704             }
 705
 706             // --num-subbuf NUM Number of subbufers
 707             if (info.getNumberOfSubBuffers() != LTTngControlServiceConstants.UNUSED_VALUE) {
 708                 command.add(LTTngControlServiceConstants.OPTION_NUM_SUB_BUFFERS);
 709                 command.add(String.valueOf(info.getNumberOfSubBuffers()));
 710             }
 711
 712             // --switch-timer USEC Switch timer interval in usec
 713             if (info.getSwitchTimer() != LTTngControlServiceConstants.UNUSED_VALUE) {
 714                 command.add(LTTngControlServiceConstants.OPTION_SWITCH_TIMER);
 715                 command.add(String.valueOf(info.getSwitchTimer()));
 716             }
 717
 718             // --read-timer USEC Read timer interval in usec
 719             if (info.getReadTimer() != LTTngControlServiceConstants.UNUSED_VALUE) {
 720                 command.add(LTTngControlServiceConstants.OPTION_READ_TIMER);
 721                 command.add(String.valueOf(info.getReadTimer()));
 722             }
 723
 724             if (isVersionSupported("2.2.0")) { //$NON-NLS-1$
 725                 // --buffers-uid Every application sharing the same UID use the
 726                 // same buffers --buffers-pid Buffers are allocated per PID
 727                 if (!isKernel) {
 728                     if (info.getBufferType() == BufferType.BUFFER_PER_PID) {
 729                         command.add(LTTngControlServiceConstants.OPTION_PER_PID_BUFFERS);
 730
 731                     } else if (info.getBufferType() == BufferType.BUFFER_PER_UID) {
 732                         command.add(LTTngControlServiceConstants.OPTION_PER_UID_BUFFERS);
 733                     }
 734                 }
 735
 736                 // -C SIZE Maximum size of trace files in bytes
 737                 if (info.getMaxSizeTraceFiles() != LTTngControlServiceConstants.UNUSED_VALUE) {
 738                     command.add(LTTngControlServiceConstants.OPTION_MAX_SIZE_TRACE_FILES);
 739                     command.add(String.valueOf(info.getMaxSizeTraceFiles()));
 740                 }
 741
 742                 // -W NUM Maximum number of trace files
 743                 if (info.getMaxNumberTraceFiles() != LTTngControlServiceConstants.UNUSED_VALUE) {
 744                     command.add(LTTngControlServiceConstants.OPTION_MAX_TRACE_FILES);
 745                     command.add(String.valueOf(info.getMaxNumberTraceFiles()));
 746                 }
 747             }
 748         }
 749
 750         executeCommand(command, monitor);
 751
 752     }
 753
 754     @Override
 755     public void disableChannels(String sessionName, List<String> channelNames, boolean isKernel, IProgressMonitor monitor) throws ExecutionException {
 756
 757         // no channels to enable
 758         if (channelNames.isEmpty()) {
 759             return;
 760         }
 761
 762         ICommandInput command = createCommand(LTTngControlServiceConstants.COMMAND_DISABLE_CHANNEL);
 763
 764         command.add(toCsv(channelNames));
 765
 766         if (isKernel) {
 767             command.add(LTTngControlServiceConstants.OPTION_KERNEL);
 768         } else {
 769             command.add(LTTngControlServiceConstants.OPTION_UST);
 770         }
 771
 772         command.add(LTTngControlServiceConstants.OPTION_SESSION);
 773         command.add(sessionName);
 774
 775         executeCommand(command, monitor);
 776     }
 777
 778     @Override
 779     public void enableEvents(String sessionName, String channelName, List<String> eventNames, boolean isKernel, String filterExpression, IProgressMonitor monitor) throws ExecutionException {
 780
 781         ICommandInput command = createCommand(LTTngControlServiceConstants.COMMAND_ENABLE_EVENT);
 782
 783         if (eventNames == null || eventNames.isEmpty()) {
 784             command.add(LTTngControlServiceConstants.OPTION_ALL);
 785         } else {
 786             command.add(toCsv(eventNames));
 787         }
 788
 789         if (isKernel) {
 790             command.add(LTTngControlServiceConstants.OPTION_KERNEL);
 791         } else {
 792             command.add(LTTngControlServiceConstants.OPTION_UST);
 793         }
 794
 795         command.add(LTTngControlServiceConstants.OPTION_SESSION);
 796         command.add(sessionName);
 797
 798         if (channelName != null) {
 799             command.add(LTTngControlServiceConstants.OPTION_CHANNEL);
 800             command.add(channelName);
 801         }
 802
 803         command.add(LTTngControlServiceConstants.OPTION_TRACEPOINT);
 804
 805         if (filterExpression != null) {
 806             command.add(LTTngControlServiceConstants.OPTION_FILTER);
 807             command.add(filterExpression);
 808         }
 809
 810         executeCommand(command, monitor);
 811
 812     }
 813
 814     @Override
 815     public void enableSyscalls(String sessionName, String channelName, IProgressMonitor monitor) throws ExecutionException {
 816
 817         ICommandInput command = createCommand(LTTngControlServiceConstants.COMMAND_ENABLE_EVENT);
 818
 819         command.add(LTTngControlServiceConstants.OPTION_ALL);
 820         command.add(LTTngControlServiceConstants.OPTION_KERNEL);
 821
 822
 823         command.add(LTTngControlServiceConstants.OPTION_SESSION);
 824         command.add(sessionName);
 825
 826         if (channelName != null) {
 827             command.add(LTTngControlServiceConstants.OPTION_CHANNEL);
 828             command.add(channelName);
 829         }
 830
 831         command.add(LTTngControlServiceConstants.OPTION_SYSCALL);
 832
 833         executeCommand(command, monitor);
 834     }
 835
 836     @Override
 837     public void enableProbe(String sessionName, String channelName, String eventName, boolean isFunction, String probe, IProgressMonitor monitor) throws ExecutionException {
 838         ICommandInput command = createCommand(LTTngControlServiceConstants.COMMAND_ENABLE_EVENT);
 839
 840         command.add(eventName);
 841         command.add(LTTngControlServiceConstants.OPTION_KERNEL);
 842
 843         command.add(LTTngControlServiceConstants.OPTION_SESSION);
 844         command.add(sessionName);
 845
 846         if (channelName != null) {
 847             command.add(LTTngControlServiceConstants.OPTION_CHANNEL);
 848             command.add(channelName);
 849         }
 850         if (isFunction) {
 851             command.add(LTTngControlServiceConstants.OPTION_FUNCTION_PROBE);
 852         } else {
 853             command.add(LTTngControlServiceConstants.OPTION_PROBE);
 854         }
 855
 856         command.add(probe);
 857
 858         executeCommand(command, monitor);
 859     }
 860
 861     @Override
 862     public void enableLogLevel(String sessionName, String channelName, String eventName, LogLevelType logLevelType, TraceLogLevel level, String filterExpression, IProgressMonitor monitor) throws ExecutionException {
 863         ICommandInput command = createCommand(LTTngControlServiceConstants.COMMAND_ENABLE_EVENT);
 864
 865         command.add(eventName);
 866         command.add(LTTngControlServiceConstants.OPTION_UST);
 867
 868         command.add(LTTngControlServiceConstants.OPTION_SESSION);
 869         command.add(sessionName);
 870
 871         if (channelName != null) {
 872             command.add(LTTngControlServiceConstants.OPTION_CHANNEL);
 873             command.add(channelName);
 874         }
 875
 876         if (logLevelType == LogLevelType.LOGLEVEL) {
 877             command.add(LTTngControlServiceConstants.OPTION_LOGLEVEL);
 878         } else if (logLevelType == LogLevelType.LOGLEVEL_ONLY) {
 879             command.add(LTTngControlServiceConstants.OPTION_LOGLEVEL_ONLY);
 880
 881         } else {
 882             return;
 883         }
 884         command.add(level.getInName());
 885
 886         executeCommand(command, monitor);
 887     }
 888
 889     @Override
 890     public void disableEvent(String sessionName, String channelName, List<String> eventNames, boolean isKernel, IProgressMonitor monitor) throws ExecutionException {
 891         ICommandInput command = createCommand(LTTngControlServiceConstants.COMMAND_DISABLE_EVENT);
 892
 893         if (eventNames == null) {
 894             command.add(LTTngControlServiceConstants.OPTION_ALL);
 895         } else {
 896             // no events to disable
 897             if (eventNames.isEmpty()) {
 898                 return;
 899             }
 900
 901             StringBuffer eventNameParameter = new StringBuffer();
 902             for (Iterator<String> iterator = eventNames.iterator(); iterator.hasNext();) {
 903                 String event = iterator.next();
 904                 eventNameParameter.append(event);
 905                 if (iterator.hasNext()) {
 906                     eventNameParameter.append(',');
 907                 }
 908             }
 909             command.add(eventNameParameter.toString());
 910         }
 911
 912         if (isKernel) {
 913             command.add(LTTngControlServiceConstants.OPTION_KERNEL);
 914         } else {
 915             command.add(LTTngControlServiceConstants.OPTION_UST);
 916         }
 917
 918         command.add(LTTngControlServiceConstants.OPTION_SESSION);
 919         command.add(sessionName);
 920
 921         if (channelName != null) {
 922             command.add(LTTngControlServiceConstants.OPTION_CHANNEL);
 923             command.add(channelName);
 924         }
 925
 926         executeCommand(command, monitor);
 927     }
 928
 929     @Override
 930     public List<String> getContextList(IProgressMonitor monitor) throws ExecutionException {
 931
 932         ICommandInput command = createCommand(LTTngControlServiceConstants.COMMAND_ADD_CONTEXT, LTTngControlServiceConstants.OPTION_HELP);
 933
 934         ICommandResult result = executeCommand(command, monitor);
 935
 936         List<String> output = result.getOutput();
 937
 938         List<String> contexts = new ArrayList<>(0);
 939
 940         int index = 0;
 941         boolean inList = false;
 942         while (index < output.size()) {
 943             String line = output.get(index);
 944
 945             Matcher startMatcher = LTTngControlServiceConstants.ADD_CONTEXT_HELP_CONTEXTS_INTRO.matcher(line);
 946             Matcher endMatcher = LTTngControlServiceConstants.ADD_CONTEXT_HELP_CONTEXTS_END_LINE.matcher(line);
 947
 948             if (startMatcher.matches()) {
 949                 inList = true;
 950             } else if (endMatcher.matches()) {
 951                 break;
 952             } else if (inList == true) {
 953                 String[] tmp = line.split(","); //$NON-NLS-1$
 954                 for (int i = 0; i < tmp.length; i++) {
 955                     contexts.add(tmp[i].trim());
 956                 }
 957             }
 958             index++;
 959         }
 960         return contexts;
 961     }
 962
 963     @Override
 964     public void addContexts(String sessionName, String channelName, String eventName, boolean isKernel, List<String> contextNames, IProgressMonitor monitor) throws ExecutionException {
 965         ICommandInput command = createCommand(LTTngControlServiceConstants.COMMAND_ADD_CONTEXT);
 966
 967         command.add(LTTngControlServiceConstants.OPTION_SESSION);
 968         command.add(sessionName);
 969
 970         if (channelName != null) {
 971             command.add(LTTngControlServiceConstants.OPTION_CHANNEL);
 972             command.add(channelName);
 973         }
 974
 975         if (eventName != null) {
 976             command.add(LTTngControlServiceConstants.OPTION_EVENT);
 977             command.add(eventName);
 978         }
 979
 980         if (isKernel) {
 981             command.add(LTTngControlServiceConstants.OPTION_KERNEL);
 982         } else {
 983             command.add(LTTngControlServiceConstants.OPTION_UST);
 984         }
 985
 986         for (Iterator<String> iterator = contextNames.iterator(); iterator.hasNext();) {
 987             String context = iterator.next();
 988             command.add(LTTngControlServiceConstants.OPTION_CONTEXT_TYPE);
 989             command.add(context);
 990         }
 991
 992         executeCommand(command, monitor);
 993
 994     }
 995
 996     @Override
 997     public void recordSnapshot(String sessionName, IProgressMonitor monitor)
 998             throws ExecutionException {
 999         ICommandInput command = createCommand(LTTngControlServiceConstants.COMMAND_SNAPSHOT, LTTngControlServiceConstants.COMMAND_RECORD_SNAPSHOT);
1000
1001         String newSessionName = sessionName;
1002         command.add(LTTngControlServiceConstants.OPTION_SESSION);
1003         command.add(newSessionName);
1004
1005         executeCommand(command, monitor);
1006     }
1007
1008     @Override
1009     public void loadSession(String inputPath, boolean isForce, IProgressMonitor monitor)
1010             throws ExecutionException {
1011         ICommandInput command = createCommand(LTTngControlServiceConstants.COMMAND_LOAD_SESSION);
1012
1013         if (inputPath != null) {
1014             command.add(LTTngControlServiceConstants.OPTION_INPUT_PATH);
1015             command.add(inputPath);
1016         }
1017
1018         if (isForce) {
1019             command.add(LTTngControlServiceConstants.OPTION_FORCE);
1020         }
1021         executeCommand(command, monitor);
1022     }
1023
1024     @Override
1025     public void saveSession(String session, String outputPath, boolean isForce, IProgressMonitor monitor) throws ExecutionException {
1026         ICommandInput command = createCommand(LTTngControlServiceConstants.COMMAND_SAVE_SESSION);
1027
1028         if (outputPath != null) {
1029             command.add(LTTngControlServiceConstants.OPTION_OUTPUT_PATH);
1030             command.add(outputPath);
1031         }
1032
1033         if (isForce) {
1034             command.add(LTTngControlServiceConstants.OPTION_FORCE);
1035         }
1036
1037         if (session != null) {
1038             command.add(session);
1039         }
1040         executeCommand(command, monitor);
1041     }
1042
1043     @Override
1044     public void runCommands(IProgressMonitor monitor, List<String> commandLines) throws ExecutionException {
1045         for (String commandLine : commandLines) {
1046             if (monitor.isCanceled()) {
1047                 return;
1048             }
1049
1050             if (commandLine.isEmpty() || commandLine.startsWith("#")) { //$NON-NLS-1$
1051                 continue;
1052             }
1053             String[] args = commandLine.split("\\s+"); //$NON-NLS-1$
1054             ICommandInput command = fCommandShell.createCommand();
1055             command.addAll(Arrays.asList(args));
1056             ICommandResult result = executeCommand(command, monitor);
1057
1058             if (isError(result)) {
1059                 throw new ExecutionException(Messages.TraceControl_CommandError + " " + command.toString() + "\n" + result.toString()); //$NON-NLS-1$ //$NON-NLS-2$
1060             }
1061         }
1062     }
1063
1064     // ------------------------------------------------------------------------
1065     // Helper methods
1066     // ------------------------------------------------------------------------
1067
1068     /**
1069      * Checks if command result is an error result.
1070      *
1071      * @param result
1072      *            - the command result to check
1073      * @return true if error else false
1074      */
1075     protected boolean isError(ICommandResult result) {
1076         // Check return code and length of returned strings
1077
1078         if ((result.getResult()) != 0) {
1079             return true;
1080         }
1081
1082         // Look for error pattern
1083         for (String line : result.getErrorOutput()) {
1084             Matcher matcher = LTTngControlServiceConstants.ERROR_PATTERN.matcher(line);
1085             if (matcher.matches()) {
1086                 return true;
1087             }
1088         }
1089
1090         return false;
1091     }
1092
1093     /**
1094      * Creates a comma separated string from list of names
1095      * @param names
1096      *          List of name to convert
1097      * @return comma separated string
1098      */
1099     protected String toCsv(List<String> names) {
1100         StringBuilder csvString = new StringBuilder();
1101         for (Iterator<String> iterator = names.iterator(); iterator.hasNext();) {
1102             String name = iterator.next();
1103             csvString.append(name);
1104             if (iterator.hasNext()) {
1105                 csvString.append(',');
1106             }
1107         }
1108         return csvString.toString();
1109     }
1110
1111     /**
1112      * Parses the domain information.
1113      *
1114      * @param output
1115      *            a command output list
1116      * @param currentIndex
1117      *            current index in command output list
1118      * @param channels
1119      *            list for returning channel information
1120      * @param domainInfo
1121      *            The domain information
1122      * @return the new current index in command output list
1123      */
1124     protected int parseDomain(List<String> output, int currentIndex, List<IChannelInfo> channels, IDomainInfo domainInfo) {
1125         int index = currentIndex;
1126
1127         // if kernel set the buffer type to shared
1128         if (domainInfo.isKernel()) {
1129             domainInfo.setBufferType(BufferType.BUFFER_SHARED);
1130         }
1131
1132         // Channels:
1133         // -------------
1134         // - channnel1: [enabled]
1135         //
1136         // Attributes:
1137         // overwrite mode: 0
1138         // subbufers size: 262144
1139         // number of subbufers: 4
1140         // switch timer interval: 0
1141         // read timer interval: 200
1142         // output: splice()
1143
1144         while (index < output.size()) {
1145             String line = output.get(index);
1146
1147             if (isVersionSupported("2.2.0")) { //$NON-NLS-1$
1148                 Matcher bufferTypeMatcher = LTTngControlServiceConstants.BUFFER_TYPE_PATTERN.matcher(line);
1149                 if (bufferTypeMatcher.matches()) {
1150                     String bufferTypeString = getAttributeValue(line);
1151                     if (BufferType.BUFFER_PER_PID.getInName().equals(bufferTypeString)) {
1152                         domainInfo.setBufferType(BufferType.BUFFER_PER_PID);
1153                     } else if (BufferType.BUFFER_PER_UID.getInName().equals(bufferTypeString)) {
1154                         domainInfo.setBufferType(BufferType.BUFFER_PER_UID);
1155                     } else {
1156                         domainInfo.setBufferType(BufferType.BUFFER_TYPE_UNKNOWN);
1157                     }
1158                 }
1159             } else {
1160                 domainInfo.setBufferType(BufferType.BUFFER_TYPE_UNKNOWN);
1161             }
1162             Matcher outerMatcher = LTTngControlServiceConstants.CHANNELS_SECTION_PATTERN.matcher(line);
1163             Matcher noKernelChannelMatcher = LTTngControlServiceConstants.DOMAIN_NO_KERNEL_CHANNEL_PATTERN.matcher(line);
1164             Matcher noUstChannelMatcher = LTTngControlServiceConstants.DOMAIN_NO_UST_CHANNEL_PATTERN.matcher(line);
1165             if (outerMatcher.matches()) {
1166                 IChannelInfo channelInfo = null;
1167                 while (index < output.size()) {
1168                     String subLine = output.get(index);
1169
1170                     Matcher innerMatcher = LTTngControlServiceConstants.CHANNEL_PATTERN.matcher(subLine);
1171                     if (innerMatcher.matches()) {
1172                         channelInfo = new ChannelInfo(""); //$NON-NLS-1$
1173                         // get channel name
1174                         channelInfo.setName(innerMatcher.group(1));
1175
1176                         // get channel enablement
1177                         channelInfo.setState(innerMatcher.group(2));
1178
1179                         // set BufferType
1180                         channelInfo.setBufferType(domainInfo.getBufferType());
1181
1182                         // add channel
1183                         channels.add(channelInfo);
1184
1185                     } else if (LTTngControlServiceConstants.OVERWRITE_MODE_ATTRIBUTE.matcher(subLine).matches()) {
1186                         String value = getAttributeValue(subLine);
1187                         if (channelInfo != null) {
1188                             channelInfo.setOverwriteMode(!LTTngControlServiceConstants.OVERWRITE_MODE_ATTRIBUTE_FALSE.equals(value));
1189                         }
1190                     } else if (LTTngControlServiceConstants.SUBBUFFER_SIZE_ATTRIBUTE.matcher(subLine).matches()) {
1191                         if (channelInfo != null) {
1192                             channelInfo.setSubBufferSize(Long.valueOf(getAttributeValue(subLine)));
1193                         }
1194
1195                     } else if (LTTngControlServiceConstants.NUM_SUBBUFFERS_ATTRIBUTE.matcher(subLine).matches()) {
1196                         if (channelInfo != null) {
1197                             channelInfo.setNumberOfSubBuffers(Integer.valueOf(getAttributeValue(subLine)));
1198                         }
1199
1200                     } else if (LTTngControlServiceConstants.SWITCH_TIMER_ATTRIBUTE.matcher(subLine).matches()) {
1201                         if (channelInfo != null) {
1202                             channelInfo.setSwitchTimer(Long.valueOf(getAttributeValue(subLine)));
1203                         }
1204
1205                     } else if (LTTngControlServiceConstants.READ_TIMER_ATTRIBUTE.matcher(subLine).matches()) {
1206                         if (channelInfo != null) {
1207                             channelInfo.setReadTimer(Long.valueOf(getAttributeValue(subLine)));
1208                         }
1209
1210                     } else if (LTTngControlServiceConstants.OUTPUT_ATTRIBUTE.matcher(subLine).matches()) {
1211                         if (channelInfo != null) {
1212                             channelInfo.setOutputType(getAttributeValue(subLine));
1213                         }
1214
1215                     } else if (LTTngControlServiceConstants.TRACE_FILE_COUNT_ATTRIBUTE.matcher(subLine).matches()) {
1216                         if (channelInfo != null) {
1217                             channelInfo.setMaxNumberTraceFiles(Integer.valueOf(getAttributeValue(subLine)));
1218                         }
1219
1220                     } else if (LTTngControlServiceConstants.TRACE_FILE_SIZE_ATTRIBUTE.matcher(subLine).matches()) {
1221                         if (channelInfo != null) {
1222                             channelInfo.setMaxSizeTraceFiles(Long.valueOf(getAttributeValue(subLine)));
1223                         }
1224                     } else if (LTTngControlServiceConstants.EVENT_SECTION_PATTERN.matcher(subLine).matches()) {
1225                         List<IEventInfo> events = new ArrayList<>();
1226                         index = parseEvents(output, index, events);
1227                         if (channelInfo != null) {
1228                             channelInfo.setEvents(events);
1229                         }
1230                         // we want to stay at the current index to be able to
1231                         // exit the domain
1232                         continue;
1233                     } else if (LTTngControlServiceConstants.DOMAIN_KERNEL_PATTERN.matcher(subLine).matches()) {
1234                         return index;
1235
1236                     } else if (LTTngControlServiceConstants.DOMAIN_UST_GLOBAL_PATTERN.matcher(subLine).matches()) {
1237                         return index;
1238                     }
1239                     index++;
1240                 }
1241             } else if (noKernelChannelMatcher.matches() || noUstChannelMatcher.matches()) {
1242                 // domain indicates that no channels were found -> return
1243                 index++;
1244                 return index;
1245             }
1246             index++;
1247         }
1248         return index;
1249     }
1250
1251     /**
1252      * Parses the event information within a domain.
1253      *
1254      * @param output
1255      *            a command output list
1256      * @param currentIndex
1257      *            current index in command output list
1258      * @param events
1259      *            list for returning event information
1260      * @return the new current index in command output list
1261      */
1262     protected int parseEvents(List<String> output, int currentIndex, List<IEventInfo> events) {
1263         int index = currentIndex;
1264
1265         while (index < output.size()) {
1266             String line = output.get(index);
1267             if (LTTngControlServiceConstants.CHANNEL_PATTERN.matcher(line).matches()) {
1268                 // end of channel
1269                 return index;
1270             } else if (LTTngControlServiceConstants.DOMAIN_KERNEL_PATTERN.matcher(line).matches()) {
1271                 // end of domain
1272                 return index;
1273             } else if (LTTngControlServiceConstants.DOMAIN_UST_GLOBAL_PATTERN.matcher(line).matches()) {
1274                 // end of domain
1275                 return index;
1276             }
1277
1278             Matcher matcher = LTTngControlServiceConstants.EVENT_PATTERN.matcher(line);
1279             Matcher matcher2 = LTTngControlServiceConstants.WILDCARD_EVENT_PATTERN.matcher(line);
1280
1281             if (matcher.matches()) {
1282                 IEventInfo eventInfo = new EventInfo(matcher.group(1).trim());
1283                 eventInfo.setLogLevelType(matcher.group(2).trim());
1284                 eventInfo.setLogLevel(matcher.group(3).trim());
1285                 eventInfo.setEventType(matcher.group(4).trim());
1286                 eventInfo.setState(matcher.group(5));
1287                 String filter = matcher.group(6);
1288                 if (filter != null) {
1289                     // remove '[' and ']'
1290                     filter = filter.substring(1, filter.length() - 1);
1291                     eventInfo.setFilterExpression(filter);
1292                 }
1293                 events.add(eventInfo);
1294                 index++;
1295             } else if (matcher2.matches()) {
1296                 IEventInfo eventInfo = new EventInfo(matcher2.group(1).trim());
1297                 eventInfo.setLogLevel(TraceLogLevel.LEVEL_UNKNOWN);
1298                 eventInfo.setEventType(matcher2.group(2).trim());
1299                 eventInfo.setState(matcher2.group(3));
1300                 String filter = matcher2.group(4);
1301                 if (filter != null) {
1302                     // remove '[' and ']'
1303                     filter = filter.substring(1, filter.length() - 1);
1304                     eventInfo.setFilterExpression(filter);
1305                 }
1306
1307                 if ((eventInfo.getEventType() == TraceEventType.PROBE) ||
1308                         (eventInfo.getEventType() == TraceEventType.FUNCTION)) {
1309                     IProbeEventInfo probeEvent = new ProbeEventInfo(eventInfo.getName());
1310                     probeEvent.setLogLevel(eventInfo.getLogLevel());
1311                     probeEvent.setEventType(eventInfo.getEventType());
1312                     probeEvent.setState(eventInfo.getState());
1313
1314                     // Overwrite eventinfo
1315                     eventInfo = probeEvent;
1316
1317                     // myevent2 (type: probe) [enabled]
1318                     // addr: 0xc0101340
1319                     // myevent0 (type: function) [enabled]
1320                     // offset: 0x0
1321                     // symbol: init_post
1322                     index++;
1323                     while (index < output.size()) {
1324                         String probeLine = output.get(index);
1325                         // parse probe
1326                         Matcher addrMatcher = LTTngControlServiceConstants.PROBE_ADDRESS_PATTERN.matcher(probeLine);
1327                         Matcher offsetMatcher = LTTngControlServiceConstants.PROBE_OFFSET_PATTERN.matcher(probeLine);
1328                         Matcher symbolMatcher = LTTngControlServiceConstants.PROBE_SYMBOL_PATTERN.matcher(probeLine);
1329                         if (addrMatcher.matches()) {
1330                             String addr = addrMatcher.group(2).trim();
1331                             probeEvent.setAddress(addr);
1332                         } else if (offsetMatcher.matches()) {
1333                             String offset = offsetMatcher.group(2).trim();
1334                             probeEvent.setOffset(offset);
1335                         } else if (symbolMatcher.matches()) {
1336                             String symbol = symbolMatcher.group(2).trim();
1337                             probeEvent.setSymbol(symbol);
1338                         } else if ((LTTngControlServiceConstants.EVENT_PATTERN.matcher(probeLine).matches()) || (LTTngControlServiceConstants.WILDCARD_EVENT_PATTERN.matcher(probeLine).matches())) {
1339                             break;
1340                         } else if (LTTngControlServiceConstants.CHANNEL_PATTERN.matcher(probeLine).matches()) {
1341                             break;
1342                         } else if (LTTngControlServiceConstants.DOMAIN_KERNEL_PATTERN.matcher(probeLine).matches()) {
1343                             // end of domain
1344                             break;
1345                         } else if (LTTngControlServiceConstants.DOMAIN_UST_GLOBAL_PATTERN.matcher(probeLine).matches()) {
1346                             // end of domain
1347                             break;
1348                         }
1349                         index++;
1350                     }
1351                     events.add(eventInfo);
1352                 } else {
1353                     events.add(eventInfo);
1354                     index++;
1355                     continue;
1356                 }
1357             } else {
1358                 index++;
1359             }
1360         }
1361
1362         return index;
1363     }
1364
1365     /**
1366      * Parses a line with attributes: <attribute Name>: <attribute value>
1367      *
1368      * @param line
1369      *            - attribute line to parse
1370      * @return the attribute value as string
1371      */
1372     protected String getAttributeValue(String line) {
1373         String[] temp = line.split("\\: "); //$NON-NLS-1$
1374         return temp[1];
1375     }
1376
1377     /**
1378      * Parses the event information within a provider.
1379      *
1380      * @param output
1381      *            a command output list
1382      * @param currentIndex
1383      *            current index in command output list
1384      * @param events
1385      *            list for returning event information
1386      * @return the new current index in command output list
1387      */
1388     protected int getProviderEventInfo(List<String> output, int currentIndex, List<IBaseEventInfo> events) {
1389         int index = currentIndex;
1390         IBaseEventInfo eventInfo = null;
1391         while (index < output.size()) {
1392             String line = output.get(index);
1393             Matcher matcher = LTTngControlServiceConstants.PROVIDER_EVENT_PATTERN.matcher(line);
1394             if (matcher.matches()) {
1395                 // sched_kthread_stop (loglevel: TRACE_EMERG0) (type:
1396                 // tracepoint)
1397                 eventInfo = new BaseEventInfo(matcher.group(1).trim());
1398                 eventInfo.setLogLevel(matcher.group(2).trim());
1399                 eventInfo.setEventType(matcher.group(3).trim());
1400                 events.add(eventInfo);
1401                 index++;
1402             } else if (LTTngControlServiceConstants.EVENT_FIELD_PATTERN.matcher(line).matches()) {
1403                 if (eventInfo != null) {
1404                     List<IFieldInfo> fields = new ArrayList<>();
1405                     index = getFieldInfo(output, index, fields);
1406                     eventInfo.setFields(fields);
1407                 } else {
1408                     index++;
1409                 }
1410             }
1411             else if (LTTngControlServiceConstants.UST_PROVIDER_PATTERN.matcher(line).matches()) {
1412                 return index;
1413             } else {
1414                 index++;
1415             }
1416         }
1417         return index;
1418     }
1419
1420     /**
1421      * Parse a field's information.
1422      *
1423      * @param output
1424      *            A command output list
1425      * @param currentIndex
1426      *            The current index in the command output list
1427      * @param fields
1428      *            List for returning the field information
1429      * @return The new current index in the command output list
1430      */
1431     protected int getFieldInfo(List<String> output, int currentIndex, List<IFieldInfo> fields) {
1432         int index = currentIndex;
1433         IFieldInfo fieldInfo = null;
1434         while (index < output.size()) {
1435             String line = output.get(index);
1436             Matcher matcher = LTTngControlServiceConstants.EVENT_FIELD_PATTERN.matcher(line);
1437             if (matcher.matches()) {
1438                 // field: content (string)
1439                 fieldInfo = new FieldInfo(matcher.group(2).trim());
1440                 fieldInfo.setFieldType(matcher.group(3).trim());
1441                 fields.add(fieldInfo);
1442             } else if (LTTngControlServiceConstants.PROVIDER_EVENT_PATTERN.matcher(line).matches()) {
1443                 return index;
1444             } else if (LTTngControlServiceConstants.UST_PROVIDER_PATTERN.matcher(line).matches()) {
1445                 return index;
1446             }
1447             index++;
1448         }
1449         return index;
1450     }
1451
1452     /**
1453      * Creates a command input instance
1454      *
1455      * @param segments
1456      *            array of string that makes up a command line
1457      * @return {@link ICommandInput} instance
1458      */
1459     protected @NonNull ICommandInput createCommand(String... segments) {
1460         ICommandInput command = fCommandShell.createCommand();
1461         command.add(LTTngControlServiceConstants.CONTROL_COMMAND);
1462         List<@NonNull String> groupOption = getTracingGroupOption();
1463         if (!groupOption.isEmpty()) {
1464             command.addAll(groupOption);
1465         }
1466         String verboseOption = getVerboseOption();
1467         if (!verboseOption.isEmpty()) {
1468             command.add(verboseOption);
1469         }
1470         for (String string : segments) {
1471             command.add(checkNotNull(string));
1472         }
1473         return command;
1474     }
1475
1476     /**
1477      * @return the tracing group option if configured in the preferences
1478      */
1479     protected @NonNull List<@NonNull String> getTracingGroupOption() {
1480         List<@NonNull String> groupOption = new ArrayList<>();
1481         if (!ControlPreferences.getInstance().isDefaultTracingGroup() && !ControlPreferences.getInstance().getTracingGroup().equals("")) { //$NON-NLS-1$
1482             groupOption.add(LTTngControlServiceConstants.OPTION_TRACING_GROUP);
1483             groupOption.add(ControlPreferences.getInstance().getTracingGroup());
1484         }
1485         return groupOption;
1486     }
1487
1488     /**
1489      * @return the verbose option as configured in the preferences
1490      */
1491     protected String getVerboseOption() {
1492         if (ControlPreferences.getInstance().isLoggingEnabled()) {
1493             String level = ControlPreferences.getInstance().getVerboseLevel();
1494             if (ControlPreferences.TRACE_CONTROL_VERBOSE_LEVEL_VERBOSE.equals(level)) {
1495                 return LTTngControlServiceConstants.OPTION_VERBOSE;
1496             }
1497             if (ControlPreferences.TRACE_CONTROL_VERBOSE_LEVEL_V_VERBOSE.equals(level)) {
1498                 return LTTngControlServiceConstants.OPTION_VERY_VERBOSE;
1499             }
1500             if (ControlPreferences.TRACE_CONTROL_VERBOSE_LEVEL_V_V_VERBOSE.equals(level)) {
1501                 return LTTngControlServiceConstants.OPTION_VERY_VERY_VERBOSE;
1502             }
1503         }
1504         return ""; //$NON-NLS-1$
1505     }
1506
1507     /**
1508      * Method that logs the command and command result if logging is enabled as
1509      * well as forwards the command execution to the shell.
1510      *
1511      * @param command
1512      *            - the command to execute
1513      * @param monitor
1514      *            - a progress monitor
1515      * @return the command result
1516      * @throws ExecutionException
1517      *             If the command fails
1518      */
1519     protected ICommandResult executeCommand(@NonNull ICommandInput command,
1520             @Nullable IProgressMonitor monitor) throws ExecutionException {
1521         return executeCommand(command, monitor, true);
1522     }
1523
1524     /**
1525      * Method that logs the command and command result if logging is enabled as
1526      * well as forwards the command execution to the shell.
1527      *
1528      * @param command
1529      *            - the command to execute
1530      * @param monitor
1531      *            - a progress monitor
1532      * @param checkForError
1533      *            - true to verify command result, else false
1534      * @return the command result
1535      * @throws ExecutionException
1536      *             in case of error result
1537      */
1538     protected ICommandResult executeCommand(@NonNull ICommandInput command,
1539             @Nullable IProgressMonitor monitor, boolean checkForError)
1540             throws ExecutionException {
1541         if (ControlPreferences.getInstance().isLoggingEnabled()) {
1542             ControlCommandLogger.log(command.toString());
1543         }
1544
1545         ICommandResult result = fCommandShell.executeCommand(command, monitor);
1546
1547         if (ControlPreferences.getInstance().isLoggingEnabled()) {
1548             ControlCommandLogger.log(result.toString());
1549         }
1550
1551         if (checkForError && isError(result)) {
1552             throw new ExecutionException(Messages.TraceControl_CommandError
1553                     + " " + command.toString() + "\n" + result.toString()); //$NON-NLS-1$ //$NON-NLS-2$
1554         }
1555
1556         return result;
1557     }
1558
1559
1560 }