-/*******************************************************************************\r
- * Copyright (c) 2012 Ericsson\r
- *\r
- * All rights reserved. This program and the accompanying materials are\r
- * made available under the terms of the Eclipse Public License v1.0 which\r
- * accompanies this distribution, and is available at\r
- * http://www.eclipse.org/legal/epl-v10.html\r
- *\r
- * Contributors:\r
- * Francois Chouinard - Initial API and implementation\r
- *******************************************************************************/\r
-\r
-package org.eclipse.linuxtools.internal.tmf.core;\r
-\r
-import java.io.BufferedWriter;\r
-import java.io.FileWriter;\r
-import java.io.IOException;\r
-\r
-import org.eclipse.core.runtime.Platform;\r
-import org.eclipse.linuxtools.tmf.core.component.ITmfComponent;\r
-import org.eclipse.linuxtools.tmf.core.component.ITmfDataProvider;\r
-import org.eclipse.linuxtools.tmf.core.event.ITmfEvent;\r
-import org.eclipse.linuxtools.tmf.core.request.ITmfDataRequest;\r
-import org.eclipse.linuxtools.tmf.core.signal.TmfSignal;\r
-\r
-/**\r
- * The TMF Core tracer, used to trace TMF internal components.\r
- * <p>\r
- * The tracing classes are independently controlled (i.e no implicit inclusion)\r
- * from the launch configuration's Tracing. The resulting trace is stored in a\r
- * distinct file (TmfTrace.log) in a format that can later be analyzed by TMF.\r
- * <p>\r
- * The tracing classes are:\r
- * <ul>\r
- * <li><strong>Component</strong>: TMF components life-cycle\r
- * <li><strong>Request</strong>: TMF requests life-cycle\r
- * <li><strong>Signal</strong>: TMF signals triggering and distribution\r
- * <li><strong>Event</strong>: TMF trace events\r
- * </ul>\r
- *\r
- * @version 1.0\r
- * @author Francois Chouinard\r
- */\r
-@SuppressWarnings("nls")\r
-public class TmfCoreTracer {\r
-\r
- // ------------------------------------------------------------------------\r
- // Constants\r
- // ------------------------------------------------------------------------\r
-\r
- private static final String PLUGIN_ID = Activator.PLUGIN_ID;\r
-\r
- // Tracing keys (in .options)\r
- private static final String COMPONENT_TRACE_KEY = PLUGIN_ID + "/component";\r
- private static final String REQUEST_TRACE_KEY = PLUGIN_ID + "/request";\r
- private static final String SIGNAL_TRACE_KEY = PLUGIN_ID + "/signal";\r
- private static final String EVENT_TRACE_KEY = PLUGIN_ID + "/event";\r
-\r
- private static final String TRACE_FILE_NAME = "TmfTrace.log";\r
-\r
- // ------------------------------------------------------------------------\r
- // Attributes\r
- // ------------------------------------------------------------------------\r
-\r
- // Classes tracing flags\r
- static Boolean COMPONENT_CLASS_ENABLED = Boolean.FALSE;\r
- static Boolean REQUEST_CLASS_ENABLED = Boolean.FALSE;\r
- static Boolean SIGNAL_CLASS_ENABLED = Boolean.FALSE;\r
- static Boolean EVENT_CLASS_ENABLED = Boolean.FALSE;\r
-\r
- // Trace log file\r
- private static BufferedWriter fTraceFile;\r
-\r
- // ------------------------------------------------------------------------\r
- // Start/stop tracing - controlled by the plug-in\r
- // ------------------------------------------------------------------------\r
-\r
- /**\r
- * Set the tracing flags according to the launch configuration\r
- */\r
- public static void init() {\r
-\r
- String traceKey;\r
- boolean isTracing = false;\r
-\r
- traceKey = Platform.getDebugOption(COMPONENT_TRACE_KEY);\r
- if (traceKey != null) {\r
- COMPONENT_CLASS_ENABLED = (Boolean.valueOf(traceKey)).booleanValue();\r
- isTracing |= COMPONENT_CLASS_ENABLED;\r
- }\r
-\r
- traceKey = Platform.getDebugOption(REQUEST_TRACE_KEY);\r
- if (traceKey != null) {\r
- REQUEST_CLASS_ENABLED = (Boolean.valueOf(traceKey)).booleanValue();\r
- isTracing |= REQUEST_CLASS_ENABLED;\r
- }\r
-\r
- traceKey = Platform.getDebugOption(SIGNAL_TRACE_KEY);\r
- if (traceKey != null) {\r
- SIGNAL_CLASS_ENABLED = (Boolean.valueOf(traceKey)).booleanValue();\r
- isTracing |= SIGNAL_CLASS_ENABLED;\r
- }\r
-\r
- traceKey = Platform.getDebugOption(EVENT_TRACE_KEY);\r
- if (traceKey != null) {\r
- EVENT_CLASS_ENABLED = (Boolean.valueOf(traceKey)).booleanValue();\r
- isTracing |= EVENT_CLASS_ENABLED;\r
- }\r
-\r
- // Create trace log file if any of the flags was set\r
- if (isTracing) {\r
- try {\r
- fTraceFile = new BufferedWriter(new FileWriter(TRACE_FILE_NAME));\r
- } catch (IOException e) {\r
- Activator.logError("Error opening log file " + TRACE_FILE_NAME, e);\r
- fTraceFile = null;\r
- }\r
- }\r
- }\r
-\r
- /**\r
- * Close the trace log file\r
- */\r
- public static void stop() {\r
- if (fTraceFile != null) {\r
- try {\r
- fTraceFile.close();\r
- fTraceFile = null;\r
- } catch (IOException e) {\r
- Activator.logError("Error closing log file", e);\r
- }\r
- }\r
- }\r
-\r
- // ------------------------------------------------------------------------\r
- // Predicates\r
- // ------------------------------------------------------------------------\r
-\r
- @SuppressWarnings("javadoc")\r
- public static boolean isComponentTraced() {\r
- return COMPONENT_CLASS_ENABLED;\r
- }\r
-\r
- @SuppressWarnings("javadoc")\r
- public static boolean isRequestTraced() {\r
- return REQUEST_CLASS_ENABLED;\r
- }\r
-\r
- @SuppressWarnings("javadoc")\r
- public static boolean isSignalTraced() {\r
- return SIGNAL_CLASS_ENABLED;\r
- }\r
-\r
- @SuppressWarnings("javadoc")\r
- public static boolean isEventTraced() {\r
- return EVENT_CLASS_ENABLED;\r
- }\r
-\r
- // ------------------------------------------------------------------------\r
- // Tracing methods\r
- // ------------------------------------------------------------------------\r
-\r
- /**\r
- * The central tracing method. Prepends the timestamp and the thread id\r
- * to the trace message.\r
- *\r
- * @param msg the trace message to log\r
- */\r
- public static synchronized void trace(String msg) {\r
-\r
- // Set the timestamp (ms resolution)\r
- long currentTime = System.currentTimeMillis();\r
- StringBuilder message = new StringBuilder("[");\r
- message.append(currentTime / 1000);\r
- message.append(".");\r
- message.append(String.format("%1$03d", currentTime % 1000));\r
- message.append("] ");\r
-\r
- // Set the thread id\r
- message.append("[TID=");\r
- message.append(String.format("%1$03d", Thread.currentThread().getId()));\r
- message.append("] ");\r
-\r
- // Append the trace message\r
- message.append(msg);\r
-\r
- // Write to file\r
- if (fTraceFile != null) {\r
- try {\r
- fTraceFile.write(message.toString());\r
- fTraceFile.newLine();\r
- fTraceFile.flush();\r
- } catch (IOException e) {\r
- Activator.logError("Error writing to log file", e);\r
- }\r
- }\r
- }\r
-\r
- // ------------------------------------------------------------------------\r
- // TMF Core specific trace formatters\r
- // ------------------------------------------------------------------------\r
-\r
- @SuppressWarnings("javadoc")\r
- public static void traceComponent(ITmfComponent component, String msg) {\r
- if (COMPONENT_CLASS_ENABLED) {\r
- String message = ("[CMP] Cmp=" + component.getName() + " " + msg);\r
- trace(message);\r
- }\r
- }\r
-\r
- @SuppressWarnings("javadoc")\r
- public static void traceRequest(ITmfDataRequest request, String msg) {\r
- if (REQUEST_CLASS_ENABLED) {\r
- String message = ("[REQ] Req=" + request.getRequestId() + " " + msg);\r
- trace(message);\r
- }\r
- }\r
-\r
- @SuppressWarnings("javadoc")\r
- public static void traceSignal(TmfSignal signal, String msg) {\r
- if (SIGNAL_CLASS_ENABLED) {\r
- String message = ("[SIG] Sig=" + signal.getClass().getSimpleName()\r
- + " Target=" + msg);\r
- trace(message);\r
- }\r
- }\r
-\r
- @SuppressWarnings("javadoc")\r
- public static void traceEvent(ITmfDataProvider provider, ITmfDataRequest request, ITmfEvent event) {\r
- if (EVENT_CLASS_ENABLED) {\r
- String message = ("[EVT] Provider=" + provider.toString()\r
- + ", Req=" + request.getRequestId() + ", Event=" + event.getTimestamp());\r
- trace(message);\r
- }\r
- }\r
-\r
-}\r
+/*******************************************************************************
+ * Copyright (c) 2012 Ericsson
+ *
+ * All rights reserved. This program and the accompanying materials are
+ * made available under the terms of the Eclipse Public License v1.0 which
+ * accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Francois Chouinard - Initial API and implementation
+ *******************************************************************************/
+
+package org.eclipse.linuxtools.internal.tmf.core;
+
+import java.io.BufferedWriter;
+import java.io.FileWriter;
+import java.io.IOException;
+
+import org.eclipse.core.runtime.Platform;
+import org.eclipse.linuxtools.tmf.core.component.ITmfComponent;
+import org.eclipse.linuxtools.tmf.core.component.ITmfDataProvider;
+import org.eclipse.linuxtools.tmf.core.event.ITmfEvent;
+import org.eclipse.linuxtools.tmf.core.request.ITmfDataRequest;
+import org.eclipse.linuxtools.tmf.core.signal.TmfSignal;
+
+/**
+ * The TMF Core tracer, used to trace TMF internal components.
+ * <p>
+ * The tracing classes are independently controlled (i.e no implicit inclusion)
+ * from the launch configuration's Tracing. The resulting trace is stored in a
+ * distinct file (TmfTrace.log) in a format that can later be analyzed by TMF.
+ * <p>
+ * The tracing classes are:
+ * <ul>
+ * <li><strong>Component</strong>: TMF components life-cycle
+ * <li><strong>Request</strong>: TMF requests life-cycle
+ * <li><strong>Signal</strong>: TMF signals triggering and distribution
+ * <li><strong>Event</strong>: TMF trace events
+ * </ul>
+ *
+ * @version 1.0
+ * @author Francois Chouinard
+ */
+@SuppressWarnings("nls")
+public class TmfCoreTracer {
+
+ // ------------------------------------------------------------------------
+ // Constants
+ // ------------------------------------------------------------------------
+
+ private static final String PLUGIN_ID = Activator.PLUGIN_ID;
+
+ // Tracing keys (in .options)
+ private static final String COMPONENT_TRACE_KEY = PLUGIN_ID + "/component";
+ private static final String REQUEST_TRACE_KEY = PLUGIN_ID + "/request";
+ private static final String SIGNAL_TRACE_KEY = PLUGIN_ID + "/signal";
+ private static final String EVENT_TRACE_KEY = PLUGIN_ID + "/event";
+
+ private static final String TRACE_FILE_NAME = "TmfTrace.log";
+
+ // ------------------------------------------------------------------------
+ // Attributes
+ // ------------------------------------------------------------------------
+
+ // Classes tracing flags
+ static Boolean COMPONENT_CLASS_ENABLED = Boolean.FALSE;
+ static Boolean REQUEST_CLASS_ENABLED = Boolean.FALSE;
+ static Boolean SIGNAL_CLASS_ENABLED = Boolean.FALSE;
+ static Boolean EVENT_CLASS_ENABLED = Boolean.FALSE;
+
+ // Trace log file
+ private static BufferedWriter fTraceFile;
+
+ // ------------------------------------------------------------------------
+ // Start/stop tracing - controlled by the plug-in
+ // ------------------------------------------------------------------------
+
+ /**
+ * Set the tracing flags according to the launch configuration
+ */
+ public static void init() {
+
+ String traceKey;
+ boolean isTracing = false;
+
+ traceKey = Platform.getDebugOption(COMPONENT_TRACE_KEY);
+ if (traceKey != null) {
+ COMPONENT_CLASS_ENABLED = (Boolean.valueOf(traceKey)).booleanValue();
+ isTracing |= COMPONENT_CLASS_ENABLED;
+ }
+
+ traceKey = Platform.getDebugOption(REQUEST_TRACE_KEY);
+ if (traceKey != null) {
+ REQUEST_CLASS_ENABLED = (Boolean.valueOf(traceKey)).booleanValue();
+ isTracing |= REQUEST_CLASS_ENABLED;
+ }
+
+ traceKey = Platform.getDebugOption(SIGNAL_TRACE_KEY);
+ if (traceKey != null) {
+ SIGNAL_CLASS_ENABLED = (Boolean.valueOf(traceKey)).booleanValue();
+ isTracing |= SIGNAL_CLASS_ENABLED;
+ }
+
+ traceKey = Platform.getDebugOption(EVENT_TRACE_KEY);
+ if (traceKey != null) {
+ EVENT_CLASS_ENABLED = (Boolean.valueOf(traceKey)).booleanValue();
+ isTracing |= EVENT_CLASS_ENABLED;
+ }
+
+ // Create trace log file if any of the flags was set
+ if (isTracing) {
+ try {
+ fTraceFile = new BufferedWriter(new FileWriter(TRACE_FILE_NAME));
+ } catch (IOException e) {
+ Activator.logError("Error opening log file " + TRACE_FILE_NAME, e);
+ fTraceFile = null;
+ }
+ }
+ }
+
+ /**
+ * Close the trace log file
+ */
+ public static void stop() {
+ if (fTraceFile != null) {
+ try {
+ fTraceFile.close();
+ fTraceFile = null;
+ } catch (IOException e) {
+ Activator.logError("Error closing log file", e);
+ }
+ }
+ }
+
+ // ------------------------------------------------------------------------
+ // Predicates
+ // ------------------------------------------------------------------------
+
+ @SuppressWarnings("javadoc")
+ public static boolean isComponentTraced() {
+ return COMPONENT_CLASS_ENABLED;
+ }
+
+ @SuppressWarnings("javadoc")
+ public static boolean isRequestTraced() {
+ return REQUEST_CLASS_ENABLED;
+ }
+
+ @SuppressWarnings("javadoc")
+ public static boolean isSignalTraced() {
+ return SIGNAL_CLASS_ENABLED;
+ }
+
+ @SuppressWarnings("javadoc")
+ public static boolean isEventTraced() {
+ return EVENT_CLASS_ENABLED;
+ }
+
+ // ------------------------------------------------------------------------
+ // Tracing methods
+ // ------------------------------------------------------------------------
+
+ /**
+ * The central tracing method. Prepends the timestamp and the thread id
+ * to the trace message.
+ *
+ * @param msg the trace message to log
+ */
+ public static synchronized void trace(String msg) {
+
+ // Set the timestamp (ms resolution)
+ long currentTime = System.currentTimeMillis();
+ StringBuilder message = new StringBuilder("[");
+ message.append(currentTime / 1000);
+ message.append(".");
+ message.append(String.format("%1$03d", currentTime % 1000));
+ message.append("] ");
+
+ // Set the thread id
+ message.append("[TID=");
+ message.append(String.format("%1$03d", Thread.currentThread().getId()));
+ message.append("] ");
+
+ // Append the trace message
+ message.append(msg);
+
+ // Write to file
+ if (fTraceFile != null) {
+ try {
+ fTraceFile.write(message.toString());
+ fTraceFile.newLine();
+ fTraceFile.flush();
+ } catch (IOException e) {
+ Activator.logError("Error writing to log file", e);
+ }
+ }
+ }
+
+ // ------------------------------------------------------------------------
+ // TMF Core specific trace formatters
+ // ------------------------------------------------------------------------
+
+ @SuppressWarnings("javadoc")
+ public static void traceComponent(ITmfComponent component, String msg) {
+ if (COMPONENT_CLASS_ENABLED) {
+ String message = ("[CMP] Cmp=" + component.getName() + " " + msg);
+ trace(message);
+ }
+ }
+
+ @SuppressWarnings("javadoc")
+ public static void traceRequest(ITmfDataRequest request, String msg) {
+ if (REQUEST_CLASS_ENABLED) {
+ String message = ("[REQ] Req=" + request.getRequestId() + " " + msg);
+ trace(message);
+ }
+ }
+
+ @SuppressWarnings("javadoc")
+ public static void traceSignal(TmfSignal signal, String msg) {
+ if (SIGNAL_CLASS_ENABLED) {
+ String message = ("[SIG] Sig=" + signal.getClass().getSimpleName()
+ + " Target=" + msg);
+ trace(message);
+ }
+ }
+
+ @SuppressWarnings("javadoc")
+ public static void traceEvent(ITmfDataProvider provider, ITmfDataRequest request, ITmfEvent event) {
+ if (EVENT_CLASS_ENABLED) {
+ String message = ("[EVT] Provider=" + provider.toString()
+ + ", Req=" + request.getRequestId() + ", Event=" + event.getTimestamp());
+ trace(message);
+ }
+ }
+
+}
projects / deliverable / tracecompass.git / blobdiff