com.intellij.rt.coverage.instrumentation.filters.lines

Class KotlinCoroutinesFilter

java.lang.Object

org.jetbrains.coverage.org.objectweb.asm.MethodVisitor

com.intellij.rt.coverage.instrumentation.filters.lines.CoverageFilter

com.intellij.rt.coverage.instrumentation.filters.lines.KotlinCoroutinesFilter

public class KotlinCoroutinesFilter
extends CoverageFilter

Filter out generated Kotlin coroutines state machines. Namely, TABLESWITCH on state and 'if suspend' checks are ignored.

Coroutines call markers:

1. COROUTINE_SUSPENDED loaded
   1. It could be loaded via IntrinsicsKt.getCOROUTINE_SUSPENDED call
   2. Or it could be stored to a local variable
2. Suspend call
   1. It could be a call with Lkotlin/coroutines/Continuation; last parameter and Object return type
   2. Or it could be a default args call, then it also has default arguments call type suffix
   3. Or suspend lambda call via invoke method
3. Label access

   Label is stored as a field. It contains the information to resume the coroutine after suspension

We ignore:

1. IF_ACMPNE jump, if it happens after coroutines call and compares its result with COROUTINE_SUSPENDED
2. TABLESWITCH, if it switches on coroutine label
3. ARETURN, if it is generated on the first line
4. Generated exception throwing

States for ignoring exception:

1. new IllegalStateException
2. DUP
3. LDC exception message
4. INVOKESPECIAL exception constructor
5. ATHROW

Field Summary

Fields inherited from class com.intellij.rt.coverage.instrumentation.filters.lines.CoverageFilter

myContext

Fields inherited from class org.jetbrains.coverage.org.objectweb.asm.MethodVisitor

api, mv

Constructor Summary

Constructors

Constructor and Description
KotlinCoroutinesFilter()

Method Summary

Modifier and Type	Method and Description
boolean	isApplicable(InstrumentationData context) This filter is applicable for suspend methods of Kotlin class.
void	visitFieldInsn(int opcode, java.lang.String owner, java.lang.String name, java.lang.String descriptor)
void	visitIincInsn(int var, int increment)
void	visitInsn(int opcode)
void	visitIntInsn(int opcode, int operand)
void	visitJumpInsn(int opcode, org.jetbrains.coverage.org.objectweb.asm.Label label) Ignore 'if' if it compares with 'COROUTINE_SUSPENDED' object.
void	visitLdcInsn(java.lang.Object value)
void	visitLineNumber(int line, org.jetbrains.coverage.org.objectweb.asm.Label start)
void	visitLookupSwitchInsn(org.jetbrains.coverage.org.objectweb.asm.Label dflt, int[] keys, org.jetbrains.coverage.org.objectweb.asm.Label[] labels)
void	visitMethodInsn(int opcode, java.lang.String owner, java.lang.String name, java.lang.String descriptor, boolean isInterface)
void	visitMultiANewArrayInsn(java.lang.String descriptor, int numDimensions)
void	visitTableSwitchInsn(int min, int max, org.jetbrains.coverage.org.objectweb.asm.Label dflt, org.jetbrains.coverage.org.objectweb.asm.Label... labels) Ignore TABLESWITCH on coroutine state, which is stored in 'label' field.
void	visitTypeInsn(int opcode, java.lang.String type)
void	visitVarInsn(int opcode, int var)

Methods inherited from class com.intellij.rt.coverage.instrumentation.filters.lines.CoverageFilter

initFilter

Methods inherited from class org.jetbrains.coverage.org.objectweb.asm.MethodVisitor

getDelegate, visitAnnotableParameterCount, visitAnnotation, visitAnnotationDefault, visitAttribute, visitCode, visitEnd, visitFrame, visitInsnAnnotation, visitInvokeDynamicInsn, visitLabel, visitLocalVariable, visitLocalVariableAnnotation, visitMaxs, visitMethodInsn, visitParameter, visitParameterAnnotation, visitTryCatchAnnotation, visitTryCatchBlock, visitTypeAnnotation

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KotlinCoroutinesFilter

public KotlinCoroutinesFilter()

Method Detail

isApplicable

public boolean isApplicable(InstrumentationData context)

This filter is applicable for suspend methods of Kotlin class. It could be a suspend lambda, then it's name is 'invokeSuspend'. Or it could be a suspend method, then it's last parameter is a Continuation.

Specified by:

isApplicable in class CoverageFilter

visitLineNumber

public void visitLineNumber(int line,
                            org.jetbrains.coverage.org.objectweb.asm.Label start)

Overrides:

visitLineNumber in class org.jetbrains.coverage.org.objectweb.asm.MethodVisitor

visitMethodInsn

public void visitMethodInsn(int opcode,
                            java.lang.String owner,
                            java.lang.String name,
                            java.lang.String descriptor,
                            boolean isInterface)

Overrides:

visitMethodInsn in class org.jetbrains.coverage.org.objectweb.asm.MethodVisitor

visitVarInsn

public void visitVarInsn(int opcode,
                         int var)

Overrides:

visitVarInsn in class org.jetbrains.coverage.org.objectweb.asm.MethodVisitor

visitJumpInsn

public void visitJumpInsn(int opcode,
                          org.jetbrains.coverage.org.objectweb.asm.Label label)

Ignore 'if' if it compares with 'COROUTINE_SUSPENDED' object. Comparison could be with stored variable or with just returned from 'getCOROUTINE_SUSPENDED' value.

Overrides:

visitJumpInsn in class org.jetbrains.coverage.org.objectweb.asm.MethodVisitor

visitFieldInsn

public void visitFieldInsn(int opcode,
                           java.lang.String owner,
                           java.lang.String name,
                           java.lang.String descriptor)

Overrides:

visitFieldInsn in class org.jetbrains.coverage.org.objectweb.asm.MethodVisitor

visitTableSwitchInsn

public void visitTableSwitchInsn(int min,
                                 int max,
                                 org.jetbrains.coverage.org.objectweb.asm.Label dflt,
                                 org.jetbrains.coverage.org.objectweb.asm.Label... labels)

Ignore TABLESWITCH on coroutine state, which is stored in 'label' field.

Overrides:

visitTableSwitchInsn in class org.jetbrains.coverage.org.objectweb.asm.MethodVisitor

visitInsn

public void visitInsn(int opcode)

Overrides:

visitInsn in class org.jetbrains.coverage.org.objectweb.asm.MethodVisitor

visitTypeInsn

public void visitTypeInsn(int opcode,
                          java.lang.String type)

Overrides:

visitTypeInsn in class org.jetbrains.coverage.org.objectweb.asm.MethodVisitor

visitLdcInsn

public void visitLdcInsn(java.lang.Object value)

Overrides:

visitLdcInsn in class org.jetbrains.coverage.org.objectweb.asm.MethodVisitor

visitLookupSwitchInsn

public void visitLookupSwitchInsn(org.jetbrains.coverage.org.objectweb.asm.Label dflt,
                                  int[] keys,
                                  org.jetbrains.coverage.org.objectweb.asm.Label[] labels)

Overrides:

visitLookupSwitchInsn in class org.jetbrains.coverage.org.objectweb.asm.MethodVisitor

visitIincInsn

public void visitIincInsn(int var,
                          int increment)

Overrides:

visitIincInsn in class org.jetbrains.coverage.org.objectweb.asm.MethodVisitor

visitIntInsn

public void visitIntInsn(int opcode,
                         int operand)

Overrides:

visitIntInsn in class org.jetbrains.coverage.org.objectweb.asm.MethodVisitor

visitMultiANewArrayInsn

public void visitMultiANewArrayInsn(java.lang.String descriptor,
                                    int numDimensions)

Overrides:

visitMultiANewArrayInsn in class org.jetbrains.coverage.org.objectweb.asm.MethodVisitor