ch.ethz.inf.iks.jvmai.jvmdi |
Contains classes and interfaces for the implementation of
an aspect interface using JVMDI.
Coding conventions
Java files are coding using the standard Java style
recommendations.
For the native part, there are several modules:
AspectInterfaceImpl.c
CodeJoinPointImpl.c
ExceptionJoinPointImpl.c
FieldJoinPointImpl.c
FieldModificationJoinPointImpl.c
hmap.c
jmd.c
JoinPointContext.c
JoinPointLocation.c
util.c
Each module (e.g., FieldJoinPointImpl.c) contains 3 types of
functions:
- internal functions. Internal functions are always prefixed
by a consistent smallcaps prefix. The prefix for
FieldJoinPointImpl is
fjp
- external functions. External functions are used by other
modules, are visible in the header files (e.g., in
FieldJoinPointImpl.h) and are always prefixed by the
CAPITALIZED module prefix. The prefix for external functions,
for FieldJoinPointImpl is
FJP
- functions implementing JNI declarations from Java. They
follow the standard
javah naming scheme.
Some use-cases I played to verify the correctness of the implementation
- a field set event is signalized by the debuggger
- enter 'event' notification
o enter 'FIELD_MOD_EVENT' switch case
[ we obtain the AOP tag, call FillFromEvent]
enter FMJP.Fill From Event
1.enter FJP_Fill_fromEvent
a) enter CodeJoinPoint.FillFromEvent
- set AOP tag, set target to null,
- call JoinPointContext.FillfromEvent
- fill JoinPointContext.depth
- fill JoinPointContext.state (with STATE_GOT_NOTHING)
- obtain JoinPointContext.location
- call JoinPointLocation.FillFromEvent
- call JoinPointLocation.FillFromFrame
-fill JoinPointLocation.executingBci
-fill JoinPointLocation.executingMethod
b) set FieldJoinPointImpl.field
c) set FieldJoinPointImpl.value
2. set FieldModificationJoinPoinImpl.newValue
o call 'AspectInterface.doOnFieldAccessJoinPoint
- a method entry event, after being dispatched, askes for
'thisValue'
- enter CodeJoinPointImpl.getThis().
- call JoinPointContext.getThis();
- state is 'GOT_NOTHING'
- verification whether the 'executingMethod' is static (if yes, thisObject) = null
- for a non-static method, getLocalValue of the slot '0'
- getLocalValue checks all the types; if all typecheck fail, then 'getLocalObject'
- a method entry event, after being dispatched, asks for getArgs();
- enter CodeJoinPointImpl.getArgs().
- call JoinPointContext.getArgs();
- state is 'GOT_NOTHING'
- call do get localVariableInfo
- init values for argValues,argSlots,argNames
- call 'doGetLocalVariables' (to fill argSlots,argNames);
- interate over the local variable infos and call 'getLocalValue(depth)'
- a method entry event, after being dispatched, calls
'callerJoinPoint()'
- enter CodeJoinPointImpl.getEnclosingJoinPoint();
- call context.callerContext();
- create a new Context, with depth (-1);
- call 'doGetCallerLocationData(newContext.lcoation,thread,depth -1);
- call jpc_GetFrameId(depth -1 )
- call JPL_FillFromFrame(location);
- return the new context
- set the target (because this will be null by default);
- a methodentry event, after being dispatched, calls
'enclosingJoinPoint.getArgs()'
- SEE ABOVE on how the join point is created.
- call JoinPointContext.getArgs();
- state is 'GOT_NOTHING' (because the context is fresh)
- call do get localVariableInfo
- init values for argValues,argSlots,argNames
- call 'doGetLocalVariables' (to fill argSlots,argNames);
- interate over the local variable infos and call 'getLocalValue'
- an exception join point is signalled
- ai_GetExceptionThrowWatchTag is called
- HMAP_Get on 'aiGetExceptionThrowTable'
|
Java Source File Name | Type | Comment |
AbsentInformationException.java | Class | Exception class AbsentInformationException signals that
the code running in the vm does not have certain desired
code attributes (such as debugging information). |
AspectInterfaceImpl.java | Class | Interface AspectInterfaceImpl represents the aspect-interface to the jvmai-system.
It's needed for initialization of the jvmai-system, management of joinpoint-watches and
for enable or disable event-notification.
An instance of this interface can be obtained by calling the method
getAspectInterface() of a jvmai-provider (class DebuggerProvider ).
Implementation
The implementation of this aspect interface is based on the debugger interface of the JVM.
To receive notifications from the JVM, it uses the native code available in this class.
Bugs
The JVMDI is not consistent over serveral J2SDK versions.
- Startup ignores the openword/closed world assumption and the list of prefixes.
- Under JDK 1.4.*, when throwing an exception within the notificaion, exception
events are wrongly sent to the debugger
- Under JDK 1.4.*, the 'GetThreadDepth' JVMDI function (name may be wrong),
does not always work correclty.
|
CacheMap.java | Class | Simple LinkedHashMap based object cache implementation. |
CodeJoinPointImpl.java | Class | |
CodeSignatureImpl.java | Class | CodeSignatureImpl class. |
ControlFlow.java | Class | Class ControlFlow encapsulates thread local information needed
by the jvmai. |
DebuggerProvider.java | Class | |
ExceptionCatchJoinPointImpl.java | Class | |
ExceptionJoinPointImpl.java | Class | |
FieldAccessJoinPointImpl.java | Class | Class FieldAccessJoinPoint represents a joinpoint where
a field is accessed. |
FieldJoinPointImpl.java | Class | Class FieldJoinPointImpl represents a joinpoint where
a field is accessed. |
FieldModificationJoinPointImpl.java | Class | Class FieldModificationJoinPoint represents a joinpoint where
a field is read. |
FieldSignatureImpl.java | Class | FieldSignatureImpl class. |
HotSwapAdvancedClassWeaver.java | Class | |
HotSwapAdvancedClassWeaverWrapper.java | Class | Wrapper for HotSwapAdvancedClassWeaver . |
HotSwapAspectInterfaceImpl.java | Class | HotSwapAspectInterfaceImpl class. |
HotSwapClassRegister.java | Class | Analyses classes and holds a register all found field
accesses, field modifications, method calls, exception
throws and exception catches. |
HotSwapClassWeaver.java | Class | |
HotSwapClassWeaverWrapper.java | Interface | Interface for wrappers for HotSwapClassWeaver implementations. |
HotSwapConstructorJoinPointImpl.java | Class | HotSwapConstructorJoinPointImpl class. |
HotSwapFieldAccessJoinPointImpl.java | Class | Concrete implementation of a FieldAccessJoinPoint for the hotswap advice weaving. |
HotSwapFieldJoinPointImpl.java | Class | Concrete implementation of a CodeJoinPoint for the Jikes RVM. |
HotSwapFieldModificationJoinPointImpl.java | Class | Concrete implementation of a FieldModificationJoinPoint for the hotswap advice weaving. |
HotSwapFieldWeaver.java | Class | Remembers the fields where a callback should be inserted. |
HotSwapJoinPointImpl.java | Class | HotSwap Join Points are join-points that can occur within the
execution of a method. |
HotSwapMethodEntryJoinPointImpl.java | Class | Concrete implementation of a MethodEntryJoinPoint for the Jikes RVM. |
HotSwapMethodExitJoinPointImpl.java | Class | Concrete implementation of a MethodExitJoinPoint for the Jikes RVM. |
HotSwapMethodJoinPointImpl.java | Class | Super class for method entry/exit join points (method execution join points). |
HotSwapProvider.java | Class | HotSwapProvider class. |
HotSwapSignatureImpl.java | Class | HotSwapSignatureImpl class. |
HotSwapSimpleClassWeaver.java | Class | Modifies a given class to support advice execution.
Container for MethodWeavers, which does the code
manipulations. |
HotSwapSimpleClassWeaverWrapper.java | Class | Wrapper for HotSwapAdvancedClassWeaver . |
InvalidObjectException.java | Class | Exception class InvalidObjectException signals that a JVMDI function
has received a wrong argument. |
InvalidVmStateException.java | Class | Exception InvalidVmStateException signals that the stack was queried at an unappropriate moment. |
ItemManipulationException.java | Class | Exception class ItemManipulationException signals that a joinpoint
watch was set but it was already set, or, it should have been cleared
but no watch existed at the specific location. |
JNIUtil.java | Class | Class JNIUtil provides some useful methods for working with JNI. |
JoinPointContext.java | Class | Class JoinPointContext encapsulates local variable info. |
JoinPointLocation.java | Class | Class JoinPointLocation denotes a code location: a method
plus a bytecode index. |
JumpFinallyVisitor.java | Class | A visitor that adds a JSR instruction before each `return' instruction. |
MethodExecutionJoinPointImpl.java | Class | Class MethodExecutionJoinPointImpl is
simply the implementation for the MethodEntry and MethodExit
join point kinds. |
ProseVmException.java | Class | Exception class ProseVmException signals that
an interla operation of the vm failed. |
SignatureFormatException.java | Class | Exception class SignatureFormatException signals that a string containing a jni signature
is wrong formatted. |
StackFrameException.java | Class | Exception StackFrameException signals that the stack was queried at an unappropriate moment. |
ThreadStateException.java | Class | Exception class ThreadStateException signals that the state of
a thread is not int he appropriate state, a wrong priority
has been assigned to, etc.. |
UniqueIdArrayManager.java | Class | Utility for managing unique ids. |