public class CheckClassAdapter extends ClassVisitor
ClassVisitor
that checks that its methods are properly used. More precisely this class
adapter checks each method call individually, based only on its arguments, but does
not check the sequence of method calls. For example, the invalid sequence visitField(ACC_PUBLIC, "i", "I", null)
visitField(ACC_PUBLIC, "i", "D", null)
will
not be detected by this class adapter.
CheckClassAdapter
can be also used to verify bytecode transformations in order to
make sure that the transformed bytecode is sane. For example:
InputStream inputStream = ...; // get bytes for the source class ClassReader classReader = new ClassReader(inputStream); ClassWriter classWriter = new ClassWriter(classReader, ClassWriter.COMPUTE_MAXS); ClassVisitor classVisitor = new MyClassAdapter(new CheckClassAdapter(classWriter, true)); classReader.accept(classVisitor, 0); StringWriter stringWriter = new StringWriter(); PrintWriter printWriter = new PrintWriter(stringWriter); CheckClassAdapter.verify(new ClassReader(classWriter.toByteArray()), false, printWriter); assertTrue(stringWriter.toString().isEmpty());
The above code pass the transformed bytecode through a CheckClassAdapter
, with
data flow checks enabled. These checks are not exactly the same as the JVM verification, but
provide some basic type checking for each method instruction. If the bytecode has errors, the
output text shows the erroneous instruction number, and a dump of the failed method with
information about the type of the local variables and of the operand stack slots for each
instruction. For example (format is - insnNumber locals : stack):
org.objectweb.asm.tree.analysis.AnalyzerException: Error at instruction 71: Expected I, but found . at org.objectweb.asm.tree.analysis.Analyzer.analyze(Analyzer.java:...) at org.objectweb.asm.util.CheckClassAdapter.verify(CheckClassAdapter.java:...) ... remove()V 00000 LinkedBlockingQueue$Itr . . . . . . . . : ICONST_0 00001 LinkedBlockingQueue$Itr . . . . . . . . : I ISTORE 2 00001 LinkedBlockingQueue$Itr . I . . . . . . : ... 00071 LinkedBlockingQueue$Itr . I . . . . . . : ILOAD 1 00072 ? INVOKESPECIAL java/lang/Integer.<init> (I)V ...
The above output shows that the local variable 1, loaded by the ILOAD 1
instruction at position 00071
is not initialized, whereas the local variable 2 is
initialized and contains an int value.
Modifier and Type | Field and Description |
---|---|
private boolean |
checkDataFlow
Whether the bytecode must be checked with a BasicVerifier.
|
private static java.lang.String |
ERROR_AT |
private java.util.Map<Label,java.lang.Integer> |
labelInsnIndices
The index of the instruction designated by each visited label so far.
|
private java.lang.String |
nestMemberPackageName
The common package of all the nest members.
|
private static java.lang.String |
USAGE
The help message shown when command line arguments are incorrect.
|
private int |
version
The class version number.
|
private boolean |
visitCalled
Whether the
visit(int, int, java.lang.String, java.lang.String, java.lang.String, java.lang.String[]) method has been called. |
private boolean |
visitEndCalled
Whether the
visitEnd() method has been called. |
private boolean |
visitModuleCalled
Whether the
visitModule(java.lang.String, int, java.lang.String) method has been called. |
private boolean |
visitNestHostCalled
Whether the
visitNestHost(java.lang.String) method has been called. |
private boolean |
visitOuterClassCalled
Whether the
visitOuterClass(java.lang.String, java.lang.String, java.lang.String) method has been called. |
private boolean |
visitSourceCalled
Whether the
visitSource(java.lang.String, java.lang.String) method has been called. |
api, cv
Modifier | Constructor and Description |
---|---|
|
CheckClassAdapter(ClassVisitor classVisitor)
Constructs a new
CheckClassAdapter . |
|
CheckClassAdapter(ClassVisitor classVisitor,
boolean checkDataFlow)
Constructs a new
CheckClassAdapter . |
protected |
CheckClassAdapter(int api,
ClassVisitor classVisitor,
boolean checkDataFlow)
Constructs a new
CheckClassAdapter . |
Modifier and Type | Method and Description |
---|---|
(package private) static void |
checkAccess(int access,
int possibleAccess)
Checks that the given access flags do not contain invalid flags.
|
private static int |
checkChar(char c,
java.lang.String signature,
int pos)
Checks a single character.
|
static void |
checkClassSignature(java.lang.String signature)
Checks a class signature.
|
private static int |
checkClassTypeSignature(java.lang.String signature,
int startPos)
Checks a class type signature.
|
static void |
checkFieldSignature(java.lang.String signature)
Checks a field signature.
|
(package private) static void |
checkFullyQualifiedName(int version,
java.lang.String name,
java.lang.String source)
Checks that the given name is a fully qualified name, using dots.
|
private static int |
checkJavaTypeSignature(java.lang.String signature,
int startPos)
Checks a Java type signature.
|
static void |
checkMethodSignature(java.lang.String signature)
Checks a method signature.
|
private static int |
checkReferenceTypeSignature(java.lang.String signature,
int pos)
Checks a reference type signature.
|
private static int |
checkSignatureIdentifier(java.lang.String signature,
int startPos)
Checks an identifier.
|
private void |
checkState()
Checks that the visit method has been called and that visitEnd has not been called.
|
private static int |
checkTypeArgument(java.lang.String signature,
int startPos)
Checks a type argument in a class type signature.
|
private static int |
checkTypeArguments(java.lang.String signature,
int startPos)
Checks the type arguments in a class type signature.
|
private static int |
checkTypeParameter(java.lang.String signature,
int startPos)
Checks a type parameter of a class or method signature.
|
private static int |
checkTypeParameters(java.lang.String signature,
int startPos)
Checks the type parameters of a class or method signature.
|
(package private) static void |
checkTypeRef(int typeRef)
Checks the reference to a type in a type annotation.
|
private static int |
checkTypeVariableSignature(java.lang.String signature,
int startPos)
Checks a type variable signature.
|
private static char |
getChar(java.lang.String string,
int pos)
Returns the string character at the given index, or 0.
|
private static java.lang.String |
getUnqualifiedName(java.lang.String name) |
static void |
main(java.lang.String[] args)
Checks the given class.
|
(package private) static void |
main(java.lang.String[] args,
java.io.PrintWriter logger)
Checks the given class.
|
private static java.lang.String |
packageName(java.lang.String name)
Returns the package name of an internal name.
|
(package private) static void |
printAnalyzerResult(MethodNode method,
Analyzer<BasicValue> analyzer,
java.io.PrintWriter printWriter) |
static void |
verify(ClassReader classReader,
boolean printResults,
java.io.PrintWriter printWriter)
Checks the given class.
|
static void |
verify(ClassReader classReader,
java.lang.ClassLoader loader,
boolean printResults,
java.io.PrintWriter printWriter)
Checks the given class.
|
void |
visit(int version,
int access,
java.lang.String name,
java.lang.String signature,
java.lang.String superName,
java.lang.String[] interfaces)
Visits the header of the class.
|
AnnotationVisitor |
visitAnnotation(java.lang.String descriptor,
boolean visible)
Visits an annotation of the class.
|
void |
visitAttribute(Attribute attribute)
Visits a non standard attribute of the class.
|
void |
visitEnd()
Visits the end of the class.
|
FieldVisitor |
visitField(int access,
java.lang.String name,
java.lang.String descriptor,
java.lang.String signature,
java.lang.Object value)
Visits a field of the class.
|
void |
visitInnerClass(java.lang.String name,
java.lang.String outerName,
java.lang.String innerName,
int access)
Visits information about an inner class.
|
MethodVisitor |
visitMethod(int access,
java.lang.String name,
java.lang.String descriptor,
java.lang.String signature,
java.lang.String[] exceptions)
Visits a method of the class.
|
ModuleVisitor |
visitModule(java.lang.String name,
int access,
java.lang.String version)
Visit the module corresponding to the class.
|
void |
visitNestHost(java.lang.String nestHost)
Visits the nest host class of the class.
|
void |
visitNestMember(java.lang.String nestMember)
Visits a member of the nest.
|
void |
visitOuterClass(java.lang.String owner,
java.lang.String name,
java.lang.String descriptor)
Visits the enclosing class of the class.
|
void |
visitPermittedSubtypeExperimental(java.lang.String permittedSubtype)
Experimental, use at your own risk.
|
RecordComponentVisitor |
visitRecordComponentExperimental(int access,
java.lang.String name,
java.lang.String descriptor,
java.lang.String signature)
Visits a record component of the class.
|
void |
visitSource(java.lang.String file,
java.lang.String debug)
Visits the source of the class.
|
AnnotationVisitor |
visitTypeAnnotation(int typeRef,
TypePath typePath,
java.lang.String descriptor,
boolean visible)
Visits an annotation on a type in the class signature.
|
private static final java.lang.String USAGE
private static final java.lang.String ERROR_AT
private boolean checkDataFlow
private int version
private boolean visitCalled
visit(int, int, java.lang.String, java.lang.String, java.lang.String, java.lang.String[])
method has been called.private boolean visitModuleCalled
visitModule(java.lang.String, int, java.lang.String)
method has been called.private boolean visitSourceCalled
visitSource(java.lang.String, java.lang.String)
method has been called.private boolean visitOuterClassCalled
visitOuterClass(java.lang.String, java.lang.String, java.lang.String)
method has been called.private boolean visitNestHostCalled
visitNestHost(java.lang.String)
method has been called.private java.lang.String nestMemberPackageName
private boolean visitEndCalled
visitEnd()
method has been called.private java.util.Map<Label,java.lang.Integer> labelInsnIndices
public CheckClassAdapter(ClassVisitor classVisitor)
CheckClassAdapter
. Subclasses must not use this constructor.
Instead, they must use the CheckClassAdapter(int, ClassVisitor, boolean)
version.classVisitor
- the class visitor to which this adapter must delegate calls.public CheckClassAdapter(ClassVisitor classVisitor, boolean checkDataFlow)
CheckClassAdapter
. Subclasses must not use this constructor.
Instead, they must use the CheckClassAdapter(int, ClassVisitor, boolean)
version.classVisitor
- the class visitor to which this adapter must delegate calls.checkDataFlow
- whether to perform basic data flow checks. This option requires valid
maxLocals and maxStack values.java.lang.IllegalStateException
- If a subclass calls this constructor.protected CheckClassAdapter(int api, ClassVisitor classVisitor, boolean checkDataFlow)
CheckClassAdapter
.api
- the ASM API version implemented by this visitor. Must be one of Opcodes.ASM4
, Opcodes.ASM5
, Opcodes.ASM6
or Opcodes.ASM7
.classVisitor
- the class visitor to which this adapter must delegate calls.checkDataFlow
- true to perform basic data flow checks, or false to
not perform any data flow check (see CheckMethodAdapter
). This option requires
valid maxLocals and maxStack values.public void visit(int version, int access, java.lang.String name, java.lang.String signature, java.lang.String superName, java.lang.String[] interfaces)
ClassVisitor
visit
in class ClassVisitor
version
- the class version. The minor version is stored in the 16 most significant bits,
and the major version in the 16 least significant bits.access
- the class's access flags (see Opcodes
). This parameter also indicates if
the class is deprecated.name
- the internal name of the class (see Type.getInternalName()
).signature
- the signature of this class. May be null if the class is not a
generic one, and does not extend or implement generic classes or interfaces.superName
- the internal of name of the super class (see Type.getInternalName()
).
For interfaces, the super class is Object
. May be null, but only for the
Object
class.interfaces
- the internal names of the class's interfaces (see Type.getInternalName()
). May be null.public void visitSource(java.lang.String file, java.lang.String debug)
ClassVisitor
visitSource
in class ClassVisitor
file
- the name of the source file from which the class was compiled. May be null.debug
- additional debug information to compute the correspondence between source and
compiled elements of the class. May be null.public ModuleVisitor visitModule(java.lang.String name, int access, java.lang.String version)
ClassVisitor
visitModule
in class ClassVisitor
name
- the fully qualified name (using dots) of the module.access
- the module access flags, among ACC_OPEN
, ACC_SYNTHETIC
and ACC_MANDATED
.version
- the module version, or null.public void visitNestHost(java.lang.String nestHost)
ClassVisitor
visitNestHost
in class ClassVisitor
nestHost
- the internal name of the host class of the nest.public void visitNestMember(java.lang.String nestMember)
ClassVisitor
visitNestMember
in class ClassVisitor
nestMember
- the internal name of a nest member.public void visitPermittedSubtypeExperimental(java.lang.String permittedSubtype)
ClassVisitor
visitPermittedSubtypeExperimental
in class ClassVisitor
permittedSubtype
- the internal name of a permitted subtype.public void visitOuterClass(java.lang.String owner, java.lang.String name, java.lang.String descriptor)
ClassVisitor
visitOuterClass
in class ClassVisitor
owner
- internal name of the enclosing class of the class.name
- the name of the method that contains the class, or null if the class is
not enclosed in a method of its enclosing class.descriptor
- the descriptor of the method that contains the class, or null if
the class is not enclosed in a method of its enclosing class.public void visitInnerClass(java.lang.String name, java.lang.String outerName, java.lang.String innerName, int access)
ClassVisitor
visitInnerClass
in class ClassVisitor
name
- the internal name of an inner class (see Type.getInternalName()
).outerName
- the internal name of the class to which the inner class belongs (see Type.getInternalName()
). May be null for not member classes.innerName
- the (simple) name of the inner class inside its enclosing class. May be
null for anonymous inner classes.access
- the access flags of the inner class as originally declared in the enclosing
class.public RecordComponentVisitor visitRecordComponentExperimental(int access, java.lang.String name, java.lang.String descriptor, java.lang.String signature)
ClassVisitor
visitRecordComponentExperimental
in class ClassVisitor
access
- the record component access flags, the only possible value is Opcodes.ACC_DEPRECATED
.name
- the record component name.descriptor
- the record component descriptor (see Type
).signature
- the record component signature. May be null if the record component
type does not use generic types.public FieldVisitor visitField(int access, java.lang.String name, java.lang.String descriptor, java.lang.String signature, java.lang.Object value)
ClassVisitor
visitField
in class ClassVisitor
access
- the field's access flags (see Opcodes
). This parameter also indicates if
the field is synthetic and/or deprecated.name
- the field's name.descriptor
- the field's descriptor (see Type
).signature
- the field's signature. May be null if the field's type does not use
generic types.value
- the field's initial value. This parameter, which may be null if the
field does not have an initial value, must be an Integer
, a Float
, a Long
, a Double
or a String
(for int
, float
, long
or String
fields respectively). This parameter is only used for static
fields. Its value is ignored for non static fields, which must be initialized through
bytecode instructions in constructors or methods.public MethodVisitor visitMethod(int access, java.lang.String name, java.lang.String descriptor, java.lang.String signature, java.lang.String[] exceptions)
ClassVisitor
MethodVisitor
instance (or null) each time it is called, i.e., it should not return a previously
returned visitor.visitMethod
in class ClassVisitor
access
- the method's access flags (see Opcodes
). This parameter also indicates if
the method is synthetic and/or deprecated.name
- the method's name.descriptor
- the method's descriptor (see Type
).signature
- the method's signature. May be null if the method parameters,
return type and exceptions do not use generic types.exceptions
- the internal names of the method's exception classes (see Type.getInternalName()
). May be null.public AnnotationVisitor visitAnnotation(java.lang.String descriptor, boolean visible)
ClassVisitor
visitAnnotation
in class ClassVisitor
descriptor
- the class descriptor of the annotation class.visible
- true if the annotation is visible at runtime.public AnnotationVisitor visitTypeAnnotation(int typeRef, TypePath typePath, java.lang.String descriptor, boolean visible)
ClassVisitor
visitTypeAnnotation
in class ClassVisitor
typeRef
- a reference to the annotated type. The sort of this type reference must be
TypeReference.CLASS_TYPE_PARAMETER
, TypeReference.CLASS_TYPE_PARAMETER_BOUND
or TypeReference.CLASS_EXTENDS
. See
TypeReference
.typePath
- the path to the annotated type argument, wildcard bound, array element type, or
static inner type within 'typeRef'. May be null if the annotation targets
'typeRef' as a whole.descriptor
- the class descriptor of the annotation class.visible
- true if the annotation is visible at runtime.public void visitAttribute(Attribute attribute)
ClassVisitor
visitAttribute
in class ClassVisitor
attribute
- an attribute.public void visitEnd()
ClassVisitor
visitEnd
in class ClassVisitor
private void checkState()
static void checkAccess(int access, int possibleAccess)
access
- the access flags to be checked.possibleAccess
- the valid access flags.static void checkFullyQualifiedName(int version, java.lang.String name, java.lang.String source)
version
- the class version.name
- the name to be checked.source
- the source of 'name' (e.g 'module' for a module name).public static void checkClassSignature(java.lang.String signature)
signature
- a string containing the signature that must be checked.public static void checkMethodSignature(java.lang.String signature)
signature
- a string containing the signature that must be checked.public static void checkFieldSignature(java.lang.String signature)
signature
- a string containing the signature that must be checked.private static int checkTypeParameters(java.lang.String signature, int startPos)
signature
- a string containing the signature that must be checked.startPos
- index of first character to be checked.private static int checkTypeParameter(java.lang.String signature, int startPos)
signature
- a string containing the signature that must be checked.startPos
- index of first character to be checked.private static int checkReferenceTypeSignature(java.lang.String signature, int pos)
signature
- a string containing the signature that must be checked.pos
- index of first character to be checked.private static int checkClassTypeSignature(java.lang.String signature, int startPos)
signature
- a string containing the signature that must be checked.startPos
- index of first character to be checked.private static int checkTypeArguments(java.lang.String signature, int startPos)
signature
- a string containing the signature that must be checked.startPos
- index of first character to be checked.private static int checkTypeArgument(java.lang.String signature, int startPos)
signature
- a string containing the signature that must be checked.startPos
- index of first character to be checked.private static int checkTypeVariableSignature(java.lang.String signature, int startPos)
signature
- a string containing the signature that must be checked.startPos
- index of first character to be checked.private static int checkJavaTypeSignature(java.lang.String signature, int startPos)
signature
- a string containing the signature that must be checked.startPos
- index of first character to be checked.private static int checkSignatureIdentifier(java.lang.String signature, int startPos)
signature
- a string containing the signature that must be checked.startPos
- index of first character to be checked.private static int checkChar(char c, java.lang.String signature, int pos)
c
- a character.signature
- a string containing the signature that must be checked.pos
- index of first character to be checked.private static char getChar(java.lang.String string, int pos)
string
- a string.pos
- an index in 'string'.static void checkTypeRef(int typeRef)
typeRef
- a reference to an annotated type.private static java.lang.String packageName(java.lang.String name)
name
- an internal name.public static void main(java.lang.String[] args) throws java.io.IOException
Usage: CheckClassAdapter <binary class name or class file name>
args
- the command line arguments.java.io.IOException
- if the class cannot be found, or if an IO exception occurs.static void main(java.lang.String[] args, java.io.PrintWriter logger) throws java.io.IOException
args
- the command line arguments.logger
- where to log errors.java.io.IOException
- if the class cannot be found, or if an IO exception occurs.public static void verify(ClassReader classReader, boolean printResults, java.io.PrintWriter printWriter)
classReader
- the class to be checked.printResults
- whether to print the results of the bytecode verification.printWriter
- where the results (or the stack trace in case of error) must be printed.public static void verify(ClassReader classReader, java.lang.ClassLoader loader, boolean printResults, java.io.PrintWriter printWriter)
classReader
- the class to be checked.loader
- a ClassLoader
which will be used to load referenced classes. May be
null.printResults
- whether to print the results of the bytecode verification.printWriter
- where the results (or the stack trace in case of error) must be printed.static void printAnalyzerResult(MethodNode method, Analyzer<BasicValue> analyzer, java.io.PrintWriter printWriter)
private static java.lang.String getUnqualifiedName(java.lang.String name)