Fix Bz#351368: Log error output to Eclipse error log.

Previously, output was only shown on stdout/stderr only if debugging
was enabled. Now output is logged to the error log regardless.

Author: jerboaa

oprofile/org.eclipse.linuxtools.oprofile.core/ChangeLog

@@ -1,3 +1,10 @@
+2011-07-06  Severin Gehwolf  <[email protected]>
+
+	* src/org/eclipse/linuxtools/oprofile/core/linux/LinuxOpcontrolProvider.java (_runOpcontrol): Provide hints
+	in error log if opcontrol errors are detected.
+	* src/org/eclipse/linuxtools/oprofile/core/OprofileCorePlugin.java (log): Added logging methods.
+	
+
 2011-06-01  Severin Gehwolf  <[email protected]>
 
 	* src/org/eclipse/linuxtools/oprofile/core/linux/LinuxOpcontrolProvider.java (_runOpcontrol): Add print

oprofile/org.eclipse.linuxtools.oprofile.core/src/org/eclipse/linuxtools/oprofile/core/OprofileCorePlugin.java

@@ -158,4 +158,26 @@ public static boolean isDebugMode() {
 				&& Platform.getDebugOption(OprofileCorePlugin.getId()
 						+ "/debug") != null; //$NON-NLS-1$
 	}
+
+	/**
+	 * Log a string message with the given severity in the error log.
+	 * 
+	 * @param severity
+	 * @param msg
+	 */
+	public static void log(int severity, String msg) {
+	      plugin.getLog().log(new Status(severity, PLUGIN_ID, Status.OK, msg, null));
+	}
+	
+	/**
+	 * Log an exception in the error log.
+	 * 
+	 * @param severity
+	 * @param msg
+	 * @param cause
+	 */
+	public static void log(int severity, String msg, Throwable cause) {
+	      plugin.getLog().log(new Status(severity, PLUGIN_ID, Status.OK, msg, cause));
+	}
+
 }

oprofile/org.eclipse.linuxtools.oprofile.core/src/org/eclipse/linuxtools/oprofile/core/linux/LinuxOpcontrolProvider.java

@@ -21,10 +21,12 @@
 import org.eclipse.core.runtime.FileLocator;
 import org.eclipse.core.runtime.Path;
 import org.eclipse.core.runtime.Platform;
+import org.eclipse.core.runtime.Status;
 import org.eclipse.linuxtools.oprofile.core.IOpcontrolProvider;
 import org.eclipse.linuxtools.oprofile.core.OpcontrolException;
 import org.eclipse.linuxtools.oprofile.core.Oprofile;
 import org.eclipse.linuxtools.oprofile.core.OprofileCorePlugin;
+import org.eclipse.linuxtools.oprofile.core.OprofileProperties;
 import org.eclipse.linuxtools.oprofile.core.daemon.OprofileDaemonEvent;
 import org.eclipse.linuxtools.oprofile.core.daemon.OprofileDaemonOptions;
 import org.eclipse.linuxtools.oprofile.core.opxml.sessions.SessionManager;
@@ -284,25 +286,42 @@ private boolean _runOpcontrol(ArrayList<String> args) throws OpcontrolException
 				stdout.close();
 				errout.close();
 
-				// give some hints which may be helpful for discovering the real
-				// reason of weird problems.
-				if (OprofileCorePlugin.isDebugMode()) {
+				int ret = p.waitFor();
+				if (ret != 0) {
+					// give some hints which may be helpful for discovering the real
+					// reason of weird problems.
+					boolean extraInfo = false;
+
 					if (!errOutput.equals("")) { //$NON-NLS-1$
-						System.err.println(OprofileCorePlugin.DEBUG_PRINT_PREFIX + errOutput);
+						extraInfo = true;
+						OprofileCorePlugin
+								.log(Status.ERROR,
+										OprofileProperties
+												.getString("opcontrol.error.log.stderr") + ": " + errOutput); //$NON-NLS-1$
 					}
 					if (!output.equals("")) { //$NON-NLS-1$
-						System.out.println(OprofileCorePlugin.DEBUG_PRINT_PREFIX + output);
+						extraInfo = true;
+						OprofileCorePlugin
+								.log(Status.ERROR, // log as error, since stderr output might be masked as stdout
+										OprofileProperties
+												.getString("opcontrol.error.log.stdout") + ": " + output); //$NON-NLS-1$
 					}
-				}
-				
-				int ret = p.waitFor();
-				if (ret != 0) {
+
 					// Red Hat BZ #694631: NMI Watchdog problem.
 					// Give better advice as to what the problem might be.
 					if (output.contains("nmi_watchdog") && output.startsWith("Error:")) { //$NON-NLS-1$ $NON-NLS-2$
-						throw new OpcontrolException(OprofileCorePlugin.createErrorStatus("opcontrolNmiWatchdog", null)); //$NON-NLS-1$
+						throw new OpcontrolException(
+								OprofileCorePlugin.createErrorStatus(
+										"opcontrolNmiWatchdog", null)); //$NON-NLS-1$
+					} else if (extraInfo) {
+						throw new OpcontrolException(
+								OprofileCorePlugin
+										.createErrorStatus(
+												"opcontrolNonZeroExitCodeExtraInfo", null)); //$NON-NLS-1$
 					} else {
-						throw new OpcontrolException(OprofileCorePlugin.createErrorStatus("opcontrolNonZeroExitCode", null)); //$NON-NLS-1$
+						throw new OpcontrolException(
+								OprofileCorePlugin.createErrorStatus(
+										"opcontrolNonZeroExitCode", null)); //$NON-NLS-1$
 					}
 				}
 

oprofile/org.eclipse.linuxtools.oprofile.core/src/org/eclipse/linuxtools/oprofile/core/oprofile.properties

@@ -17,7 +17,11 @@ oprofileInit.error.statusMessage=An error occurred initializing OProfile for use
 oprofileInit.error.dialog.title=Error initializing OProfile
 oprofileInit.error.dialog.message=FATAL: The OProfile kernel module could not be loaded.
 
+opcontrol.error.log.stderr=opcontrol process error output
+opcontrol.error.log.stdout=opcontrol process output
+
 opcontrolRun.error.statusMessage=Error during run of opcontrol
+opcontrolNonZeroExitCodeExtraInfo.error.statusMessage=Exit code of opcontrol indicates failure.\nLook for additional information in the Error Log.
 opcontrolNonZeroExitCode.error.statusMessage=Exit code of opcontrol indicates failure.\nIf this system does not have /usr/bin/consolehelper, make sure you have added\nthe following line to /etc/sudoers:\n<username> ALL=(ALL) NOPASSWD: <path to opcontrol, e.g. /usr/bin/opcontrol>
 opcontrolNmiWatchdog.error.statusMessage=Error: counter 0 not available\nnmi_watchdog using this resource?\nTry:\nopcontrol --deinit\necho 0 > /proc/sys/kernel/nmi_watchdog\nin a Terminal. Then try profiling your binary again.