mirrors/cdt
1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-07-01 06:05:24 +02:00
Code Issues Wiki Activity

[290991] More fixes and improvements to DsfExecutable tracing

Browse source
This commit is contained in:
John Cortell 2009-10-01 03:12:01 +00:00
parent c146f5ae4d
commit de96c0f149
2 changed files with 79 additions and 41 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

94
dsf/org.eclipse.cdt.dsf/src/org/eclipse/cdt/dsf/concurrent/DefaultDsfExecutor.java
View file

@ -23,6 +23,7 @@ import java.util.concurrent.ThreadFactory;
import java.util.concurrent.TimeUnit; import java.util.concurrent.TimeUnit;
import org.eclipse.cdt.dsf.internal.DsfPlugin; import org.eclipse.cdt.dsf.internal.DsfPlugin;
import org.eclipse.cdt.dsf.internal.LoggingUtils;
import org.eclipse.core.runtime.ILog; import org.eclipse.core.runtime.ILog;
import org.eclipse.core.runtime.IStatus; import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Platform; import org.eclipse.core.runtime.Platform;
@ -165,14 +166,41 @@ public class DefaultDsfExecutor extends ScheduledThreadPoolExecutor
TracingWrapper fSubmittedBy = null; TracingWrapper fSubmittedBy = null;
/** /**
* @param stackTrace * The names of the executor submitter methods we support, ordered by
* the stack trace to log * popularity so as to optimize the tracing logic. (For the curious,
* @param frameIgnoreCount * 'execute' is by far the most commonly called--ten times more often
* the number of items in [stackTrace] to ignore, starting at * than 'submit', in fact).
* the topmost frame (where the thread is currently
* executing--stackTrace[0])
*/ */
TracingWrapper(StackTraceElement[] stackTrace, int frameIgnoreCount) { private final String[] SUBMITTER_METHOD_NAMES = {
"execute", "submit", "schedule", "scheduleAtFixedRate", "scheduleWithFixedDelay" }; //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$ //$NON-NLS-4$ //$NON-NLS-5$
/**
*/
TracingWrapper() {
// Get the this thread's stack trace and then search for the call
// into the executor's submitter method. We'll want to ignore
// everything up to and including that call.
StackTraceElement[] stackTrace = Thread.currentThread().getStackTrace();
int frameIgnoreCount = 1;
String executorClassName = this.getClass().getEnclosingClass().getSimpleName(); // e.g., "DefaultDsfExecutor"
outer: for (StackTraceElement frame : stackTrace) {
final String framestr = frame.toString();
for (String methodName : SUBMITTER_METHOD_NAMES) {
if (framestr.contains(executorClassName + "." + methodName + "(")) { //$NON-NLS-1$ //$NON-NLS-2$
break outer; // exit both loops
}
}
frameIgnoreCount++;
}
if (frameIgnoreCount == stackTrace.length) {
// Internal error, really. We were unable to identify the
// executor's submission function. Our check above must be
// overlooking a possibility
frameIgnoreCount = 0;
}
// guard against the offset being greater than the stack trace // guard against the offset being greater than the stack trace
frameIgnoreCount = Math.min(frameIgnoreCount, stackTrace.length); frameIgnoreCount = Math.min(frameIgnoreCount, stackTrace.length);
fSubmittedAt = new StackTraceWrapper(new StackTraceElement[stackTrace.length - frameIgnoreCount]); fSubmittedAt = new StackTraceWrapper(new StackTraceElement[stackTrace.length - frameIgnoreCount]);
@ -209,12 +237,20 @@ public class DefaultDsfExecutor extends ScheduledThreadPoolExecutor
traceBuilder.append(')'); traceBuilder.append(')');
traceBuilder.append(' '); traceBuilder.append(' ');
// Append executable class name // This will be a Runnable or a Callable. Hopefully it will also
traceBuilder.append(getExecutable().getClass().getName()); // be a DsfExecutable and thus be instrumented with trace/debug
// information. In nearly every case, it will be an anonymous
// inner class.
final Object executable = getExecutable();
// Append executable class name. The anonymous inner class name
// name won't be very interesting; use the parent class instead.
Class<? extends Object> execClass = executable.getClass();
traceBuilder.append(execClass.isAnonymousClass() ? execClass.getSuperclass().getName() : execClass.getName());
// Add executable's toString(). // Add executable's toString().
traceBuilder.append("\n "); //$NON-NLS-1$ traceBuilder.append("\n "); //$NON-NLS-1$
traceBuilder.append(getExecutable().toString()); traceBuilder.append(LoggingUtils.toString(executable, false));
// Determine if the created-at and submitted-at information is // Determine if the created-at and submitted-at information is
// the same. If so, consolidate. // the same. If so, consolidate.
@ -222,8 +258,8 @@ public class DefaultDsfExecutor extends ScheduledThreadPoolExecutor
StackTraceElement[] submittedAtStack = (fSubmittedAt == null) ? null : fSubmittedAt.fStackTraceElements; StackTraceElement[] submittedAtStack = (fSubmittedAt == null) ? null : fSubmittedAt.fStackTraceElements;
int createdBySeqNum = Integer.MIN_VALUE; int createdBySeqNum = Integer.MIN_VALUE;
int submittedBySeqNum = (fSubmittedBy == null) ? Integer.MIN_VALUE : fSubmittedBy.fSequenceNumber; int submittedBySeqNum = (fSubmittedBy == null) ? Integer.MIN_VALUE : fSubmittedBy.fSequenceNumber;
if (getExecutable() instanceof DsfExecutable) { if (executable instanceof DsfExecutable) {
DsfExecutable dsfExecutable = (DsfExecutable)getExecutable(); DsfExecutable dsfExecutable = (DsfExecutable)executable;
createdAtStack = (dsfExecutable.fCreatedAt == null) ? null : dsfExecutable.fCreatedAt.fStackTraceElements; createdAtStack = (dsfExecutable.fCreatedAt == null) ? null : dsfExecutable.fCreatedAt.fStackTraceElements;
createdBySeqNum = (dsfExecutable.fCreatedBy == null) ? Integer.MIN_VALUE : dsfExecutable.fCreatedBy.fSequenceNumber; createdBySeqNum = (dsfExecutable.fCreatedBy == null) ? Integer.MIN_VALUE : dsfExecutable.fCreatedBy.fSequenceNumber;
} }
@ -304,8 +340,7 @@ public class DefaultDsfExecutor extends ScheduledThreadPoolExecutor
final Runnable fRunnable; final Runnable fRunnable;
public TracingWrapperRunnable(Runnable runnable, StackTraceElement[] stackTrace, int frameIgnoreCount) { public TracingWrapperRunnable(Runnable runnable) {
super(stackTrace, frameIgnoreCount);
if (runnable == null) throw new NullPointerException(); if (runnable == null) throw new NullPointerException();
fRunnable = runnable; fRunnable = runnable;
@ -339,11 +374,10 @@ public class DefaultDsfExecutor extends ScheduledThreadPoolExecutor
final Callable<T> fCallable; final Callable<T> fCallable;
/** /**
* @deprecated use constructor that takes stack trace and ignore count * @deprecated use constructor that takes just the Callable parameter
*/ */
@Deprecated @Deprecated
public TracingWrapperCallable(Callable<T> callable, int frameIgnoreCount) { public TracingWrapperCallable(Callable<T> callable, int frameIgnoreCount) {
super(new StackTraceElement[0], 0);
if (callable == null) throw new NullPointerException(); if (callable == null) throw new NullPointerException();
fCallable = callable; fCallable = callable;
} }
@ -351,8 +385,7 @@ public class DefaultDsfExecutor extends ScheduledThreadPoolExecutor
/** /**
* @since 2.1 * @since 2.1
*/ */
public TracingWrapperCallable(Callable<T> callable, StackTraceElement[] stackTrace, int frameIgnoreCount) { public TracingWrapperCallable(Callable<T> callable) {
super(stackTrace, frameIgnoreCount);
if (callable == null) throw new NullPointerException(); if (callable == null) throw new NullPointerException();
fCallable = callable; fCallable = callable;
} }
@ -370,20 +403,11 @@ public class DefaultDsfExecutor extends ScheduledThreadPoolExecutor
} }
} }
/**
* When recording a stack crawl to trace who has called a method in this
* class, we call {@link Thread#getStackTrace()} and ignore the top three
* frames. The two topmost frames are ones related to the
* {@link Thread#getStackTrace()} call itself, and the third is the method
* in this class that's been called.
*/
private static final int TRACE_FRAME_IGNORE_COUNT = 3;
@Override @Override
public <V> ScheduledFuture<V> schedule(Callable<V> callable, long delay, TimeUnit unit) { public <V> ScheduledFuture<V> schedule(Callable<V> callable, long delay, TimeUnit unit) {
if(DEBUG_EXECUTOR || ASSERTIONS_ENABLED) { if(DEBUG_EXECUTOR || ASSERTIONS_ENABLED) {
if ( !(callable instanceof TracingWrapper) ) { if ( !(callable instanceof TracingWrapper) ) {
callable = new TracingWrapperCallable<V>(callable, Thread.currentThread().getStackTrace(), TRACE_FRAME_IGNORE_COUNT); callable = new TracingWrapperCallable<V>(callable);
} }
} }
return super.schedule(callable, delay, unit); return super.schedule(callable, delay, unit);
@ -392,7 +416,7 @@ public class DefaultDsfExecutor extends ScheduledThreadPoolExecutor
public ScheduledFuture<?> schedule(Runnable command, long delay, TimeUnit unit) { public ScheduledFuture<?> schedule(Runnable command, long delay, TimeUnit unit) {
if(DEBUG_EXECUTOR || ASSERTIONS_ENABLED) { if(DEBUG_EXECUTOR || ASSERTIONS_ENABLED) {
if ( !(command instanceof TracingWrapper) ) { if ( !(command instanceof TracingWrapper) ) {
command = new TracingWrapperRunnable(command, Thread.currentThread().getStackTrace(), TRACE_FRAME_IGNORE_COUNT); command = new TracingWrapperRunnable(command);
} }
} }
return super.schedule(command, delay, unit); return super.schedule(command, delay, unit);
@ -401,7 +425,7 @@ public class DefaultDsfExecutor extends ScheduledThreadPoolExecutor
@Override @Override
public ScheduledFuture<?> scheduleAtFixedRate(Runnable command, long initialDelay, long period, TimeUnit unit) { public ScheduledFuture<?> scheduleAtFixedRate(Runnable command, long initialDelay, long period, TimeUnit unit) {
if(DEBUG_EXECUTOR || ASSERTIONS_ENABLED) { if(DEBUG_EXECUTOR || ASSERTIONS_ENABLED) {
command = new TracingWrapperRunnable(command, Thread.currentThread().getStackTrace(), TRACE_FRAME_IGNORE_COUNT); command = new TracingWrapperRunnable(command);
} }
return super.scheduleAtFixedRate(command, initialDelay, period, unit); return super.scheduleAtFixedRate(command, initialDelay, period, unit);
} }
@ -409,7 +433,7 @@ public class DefaultDsfExecutor extends ScheduledThreadPoolExecutor
@Override @Override
public ScheduledFuture<?> scheduleWithFixedDelay(Runnable command, long initialDelay, long delay, TimeUnit unit) { public ScheduledFuture<?> scheduleWithFixedDelay(Runnable command, long initialDelay, long delay, TimeUnit unit) {
if(DEBUG_EXECUTOR || ASSERTIONS_ENABLED) { if(DEBUG_EXECUTOR || ASSERTIONS_ENABLED) {
command = new TracingWrapperRunnable(command, Thread.currentThread().getStackTrace(), TRACE_FRAME_IGNORE_COUNT); command = new TracingWrapperRunnable(command);
} }
return super.scheduleWithFixedDelay(command, initialDelay, delay, unit); return super.scheduleWithFixedDelay(command, initialDelay, delay, unit);
} }
@ -417,7 +441,7 @@ public class DefaultDsfExecutor extends ScheduledThreadPoolExecutor
@Override @Override
public void execute(Runnable command) { public void execute(Runnable command) {
if(DEBUG_EXECUTOR || ASSERTIONS_ENABLED) { if(DEBUG_EXECUTOR || ASSERTIONS_ENABLED) {
command = new TracingWrapperRunnable(command, Thread.currentThread().getStackTrace(), TRACE_FRAME_IGNORE_COUNT); command = new TracingWrapperRunnable(command);
} }
super.execute(command); super.execute(command);
} }
@ -425,7 +449,7 @@ public class DefaultDsfExecutor extends ScheduledThreadPoolExecutor
@Override @Override
public Future<?> submit(Runnable command) { public Future<?> submit(Runnable command) {
if(DEBUG_EXECUTOR || ASSERTIONS_ENABLED) { if(DEBUG_EXECUTOR || ASSERTIONS_ENABLED) {
command = new TracingWrapperRunnable(command, Thread.currentThread().getStackTrace(), TRACE_FRAME_IGNORE_COUNT); command = new TracingWrapperRunnable(command);
} }
return super.submit(command); return super.submit(command);
} }
@ -433,7 +457,7 @@ public class DefaultDsfExecutor extends ScheduledThreadPoolExecutor
@Override @Override
public <T> Future<T> submit(Callable<T> callable) { public <T> Future<T> submit(Callable<T> callable) {
if(DEBUG_EXECUTOR || ASSERTIONS_ENABLED) { if(DEBUG_EXECUTOR || ASSERTIONS_ENABLED) {
callable = new TracingWrapperCallable<T>(callable, Thread.currentThread().getStackTrace(), TRACE_FRAME_IGNORE_COUNT); callable = new TracingWrapperCallable<T>(callable);
} }
return super.submit(callable); return super.submit(callable);
} }
@ -441,7 +465,7 @@ public class DefaultDsfExecutor extends ScheduledThreadPoolExecutor
@Override @Override
public <T> Future<T> submit(Runnable command, T result) { public <T> Future<T> submit(Runnable command, T result) {
if(DEBUG_EXECUTOR || ASSERTIONS_ENABLED) { if(DEBUG_EXECUTOR || ASSERTIONS_ENABLED) {
command = new TracingWrapperRunnable(command, Thread.currentThread().getStackTrace(), TRACE_FRAME_IGNORE_COUNT); command = new TracingWrapperRunnable(command);
} }
return super.submit(command, result); return super.submit(command, result);
} }

26
dsf/org.eclipse.cdt.dsf/src/org/eclipse/cdt/dsf/internal/LoggingUtils.java
View file

@ -20,10 +20,11 @@ package org.eclipse.cdt.dsf.internal;
* @since 2.1 * @since 2.1
*/ */
public class LoggingUtils { public class LoggingUtils {
/** /**
* Return a string that uniquely identifies a Java object reference, in the * Return a string that uniquely identifies a Java object reference, in the
* form "classname@id", where 'classname' is the simple (package * form "classname@id", where 'classname' is the simple or package qualified
* unqualified) name of the object's class, and 'id' is the hash code. * name of the object's class, and 'id' is the hash code.
* *
* Why not just use obj.toString()? That method is often overriden, and so * Why not just use obj.toString()? That method is often overriden, and so
* cannot be relied on for a representation that uniquely identifies the * cannot be relied on for a representation that uniquely identifies the
@ -31,22 +32,35 @@ public class LoggingUtils {
* *
* @param obj * @param obj
* the object reference to stringify * the object reference to stringify
* @param simpleClassName
* if true, use the class's simple name, otherwise the package
* qualified one
*
* @return the stringified representation of the object reference * @return the stringified representation of the object reference
*/ */
public static String toString(Object obj) { public static String toString(Object obj, boolean simpleClassName) {
if (obj == null) { if (obj == null) {
return "null"; //$NON-NLS-1$ return "null"; //$NON-NLS-1$
} }
String className = obj.getClass().getName(); String className = obj.getClass().getName();
int lastDot = className.lastIndexOf('.'); if (simpleClassName) {
if ((lastDot >= 0) && ((lastDot + 1) < className.length())) { int lastDot = className.lastIndexOf('.');
className = className.substring(lastDot + 1); if ((lastDot >= 0) && ((lastDot + 1) < className.length())) {
className = className.substring(lastDot + 1);
}
} }
String id = Integer.toHexString(System.identityHashCode(obj)); String id = Integer.toHexString(System.identityHashCode(obj));
return className + "@" + id; //$NON-NLS-1$ return className + "@" + id; //$NON-NLS-1$
} }
/**
* Equivalent to toString(obj, false)
*/
public static String toString(Object obj) {
return toString(obj, true);
}
/** /**
* Flatten out an array of strings into one string, in the form * Flatten out an array of strings into one string, in the form