Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -165,6 +165,7 @@ dependencies {
implementation("org.ow2.asm:asm:8.0.1")
implementation("org.ow2.asm:asm-util:8.0.1")
implementation("org.ow2.asm:asm-commons:8.0.1")
implementation("io.github.classgraph:classgraph:4.8.138")

testImplementation("junit:junit:4.12")
testImplementation("com.google.truth:truth:1.0.1")
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ sealed class CachedValueTracerCommand {
/** Remove all cached value stats, and clear filters. */
object Reset: CachedValueTracerCommand()

object Scan: CachedValueTracerCommand()

/** Filter cached values by class name. */
data class Filter(val pattern: String?): CachedValueTracerCommand()

Expand All @@ -50,6 +52,7 @@ fun parseCachedValueTracerCommand(text: String): CachedValueTracerCommand? {
"filter" -> parseFilterCommand(tokens.advance())
"clear-filters" -> CachedValueTracerCommand.ClearFilters
"group-by" -> parseGroupByCommand(tokens.advance())
"scan" -> CachedValueTracerCommand.Scan
else -> null
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ class CachedValueTracerCompletionProvider : TextCompletionProvider {
}

val elements = when (tokenIndex) {
0 -> listOf("clear", "reset", "filter", "clear-filters", "group-by")
0 -> listOf("clear", "reset", "filter", "clear-filters", "group-by", "scan")
1 -> when (command) {
is CachedValueTracerCommand.GroupBy -> listOf("class", "stack-trace")
else -> emptyList()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,10 @@ class CachedValueTracerController(
updateUi()
}
}
is CachedValueTracerCommand.Scan -> {
eventConsumer.clear()
updateUi()
}
else -> {
LOG.warn("Unknown command: $text")
}
Expand Down
296 changes: 296 additions & 0 deletions src/main/java/com/google/idea/perf/tracer/ClassRegistry.kt
Original file line number Diff line number Diff line change
@@ -0,0 +1,296 @@
/*
* Copyright 2022 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.idea.perf.tracer


import com.google.idea.perf.AgentLoader
import com.intellij.openapi.diagnostic.Logger
import com.intellij.openapi.progress.ProgressManager
import io.github.classgraph.ClassGraph
import io.github.classgraph.MethodInfo
import org.objectweb.asm.Type
import java.lang.reflect.Modifier

object ClassRegistry {
private var classpathClasses: List<ClassInfo> = emptyList()

private fun allLoadedClasses(): List<Class<Any>> {
val classes = AgentLoader.instrumentation?.allLoadedClasses ?: emptyArray()

return classes.filter {
with(it.name) {
!startsWith("java.lang.invoke") &&
!startsWith("com.sun.proxy") &&
!startsWith("jdk.internal.reflect")
}
}
}

fun allClasses(): List<ClassInfo> {
//full classpath if available
if (classpathClasses.isNotEmpty()) return classpathClasses

return allLoadedClasses().mapNotNull { ClassInfo.tryCreate(it) }

}

fun scanClassPath() {
val t0 = System.currentTimeMillis()
ClassGraph()
.enableClassInfo()
.rejectPackages("java.lang.invoke", "com.sun.proxy", "jdk.internal.reflect")
.ignoreClassVisibility()
.scan(1)
.use { scanResult ->
classpathClasses = scanResult.allClasses.mapNotNull { ClassInfo.tryCreate(it) }
}
val scanTime = System.currentTimeMillis() - t0
val logger = Logger.getInstance(ClassRegistry::class.java)
logger.info("Classpath scanned in $scanTime ms")

if (logger.isDebugEnabled) {
val alreadyLoaded = allLoadedClasses().map { it.name }.toSet()
val notLoadedSample = classpathClasses
.filter { !alreadyLoaded.contains(it.name) }
.take(10)
Logger.getInstance(ClassRegistry::class.java)
.debug("Not yet loaded classes sample $notLoadedSample")
}
}

fun affectedClasses(traceRequests: Collection<TraceRequest>): List<ClassInfo> {
if (traceRequests.isEmpty()) return emptyList()

if (classpathClasses.isEmpty()) {
return affectedLoadedClasses(traceRequests).mapNotNull { ClassInfo.tryCreate(it) }
}

// full classpath scanning is slow.
// match classes first, then load full details for that classes and check methods

val candidates = allClasses()
.filter { classInfo ->
traceRequests.any { it.matcher.mightMatchMethodInClass(classInfo.name) }
}
.map { it.name }
.toTypedArray()

ProgressManager.checkCanceled()

ClassGraph()
.acceptClasses(*candidates)
.enableMethodInfo()
.ignoreClassVisibility()
.ignoreFieldVisibility()
.scan(1).use { scanResult ->
val result: MutableList<ClassInfo> = mutableListOf()
for (clazz in scanResult.allClasses) {
ProgressManager.checkCanceled()
val classDetails = ClassMethods.create(clazz) ?: continue
val matches = traceRequests.any {
it.matcher.matchesMethodInClass(classDetails)
}
val details = ClassInfo.tryCreate(clazz)
if (matches && details != null) {
result.add(details)
}
}
return result
}
}


// This may be slow if there are many trace requests or if they use broad glob patterns.
fun affectedLoadedClasses(traceRequests: Collection<TraceRequest>): List<Class<*>> {
if (traceRequests.isEmpty()) return emptyList()
val result: MutableList<Class<*>> = mutableListOf()

for (clazz in allLoadedClasses()) {
val classDetails = ClassMethods.tryCreate(clazz) ?: continue
val matches = traceRequests.any {
it.matcher.matchesMethodInClass(classDetails)
}
if (matches) {
result.add(clazz)
}
}
return result
}


fun classDetails(classname: String): ClassMethods? {
val loadedClassDetails = loadedClassDetails(classname)
if (loadedClassDetails != null) {
return loadedClassDetails
}

ClassGraph().acceptClasses(classname)
.enableClassInfo()
.enableMethodInfo()
.ignoreClassVisibility()
.ignoreFieldVisibility()
.scan(1)
.use { scanResult ->
val classInfo = scanResult.getClassInfo(classname) ?: return null
return ClassMethods.create(classInfo)
}
}

private fun loadedClassDetails(classname: String): ClassMethods? {
val clazz = allLoadedClasses().firstOrNull { it.name == classname } ?: return null
return ClassMethods.tryCreate(clazz)
}
}


class Method internal constructor(
private val classGraphMethod: MethodInfo?,
private val javaMethod: java.lang.reflect.Method?,
) {

val name: String
get() = javaMethod?.name ?: classGraphMethod?.name ?: ""

val descriptor: String
get() {
if (javaMethod != null) {
return Type.getMethodDescriptor(javaMethod)
}
if (classGraphMethod != null) {
return classGraphMethod.typeDescriptorStr
}
return ""
}

override fun toString(): String {
return name
}
}

class ClassMethods internal constructor(
val name: String,
val declaredMethods: List<Method>,
val declaredConstructors: List<String>,
) {

override fun toString(): String {
return name
}


companion object {
fun create(c: io.github.classgraph.ClassInfo): ClassMethods? {
try {
return ClassMethods(
name = c.name,
declaredMethods = c.declaredMethodInfo.map { Method(it, null) },
declaredConstructors = c.declaredConstructorInfo.map { it.typeDescriptorStr },
)
} catch (e: Throwable) {
Logger.getInstance(ClassRegistry::class.java)
.warn("Error reading method info for $c", e)
return null
}
}

fun tryCreate(c: Class<*>): ClassMethods? {
try {
return ClassMethods(
name = c.name,
declaredMethods = c.declaredMethods.map { Method(null, it) },
declaredConstructors = c.declaredConstructors.map {
Type.getConstructorDescriptor(it)
},
)
} catch (e: Throwable) {
Logger.getInstance(ClassRegistry::class.java)
.warn("Error reading method info for $c", e)
return null
}
}
}
}

class ClassInfo private constructor(
val name: String,
val simpleName: String,
val packageName: String,
val isArray: Boolean,
val isAnonymousClass: Boolean,
val isLocalClass: Boolean,
val isSynthetic: Boolean,
val isInterface: Boolean,
val isAbstract: Boolean,
val isEnum: Boolean,
val isAnnotation: Boolean,
val isThrowable: Boolean,
) {


companion object {
fun tryCreate(c: Class<*>): ClassInfo? {
try {
return ClassInfo(
name = c.name,
simpleName = c.simpleName,
packageName = c.packageName,
isArray = c.isArray,
isAnonymousClass = c.isAnonymousClass,
isLocalClass = c.isLocalClass,
isSynthetic = c.isSynthetic,
isInterface = c.isInterface,
isAbstract = Modifier.isAbstract(c.modifiers),
isEnum = c.isEnum,
isAnnotation = c.isAnnotation,
isThrowable = Throwable::class.java.isAssignableFrom(c),
)
} catch (e: Throwable) {
Logger.getInstance(ClassRegistry::class.java)
.warn("Error reading class info for $c", e)
return null
}
}

fun tryCreate(c: io.github.classgraph.ClassInfo): ClassInfo? {
try {
return ClassInfo(
name = c.name,
simpleName = c.simpleName,
packageName = c.packageName,
isArray = c.isArrayClass,
isAnonymousClass = c.isAnonymousInnerClass,
isLocalClass = false,
isSynthetic = c.isSynthetic,
isInterface = c.isInterface,
isAbstract = Modifier.isAbstract(c.modifiers),
isEnum = c.isEnum,
isAnnotation = c.isAnnotation,
isThrowable = c.extendsSuperclass(kotlin.Throwable::class.java) || c.extendsSuperclass(
java.lang.Throwable::class.java
),
)
} catch (e: Throwable) {
Logger.getInstance(ClassRegistry::class.java)
.warn("Error reading class info for $c", e)
return null
}
}
}

override fun toString(): String {
return name
}
}
6 changes: 6 additions & 0 deletions src/main/java/com/google/idea/perf/tracer/TracerCommand.kt
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,9 @@ sealed class TracerCommand {
/** Zero out all tracepoint data and reset the call tree. */
object Reset: TracerCommand()

/** Scan classpath. */
object Scan: TracerCommand()

/** Trace or untrace a set of methods. */
data class Trace(
val enable: Boolean,
Expand Down Expand Up @@ -91,6 +94,7 @@ fun parseMethodTracerCommand(text: String): TracerCommand {
return when (tokens.first()) {
ClearKeyword -> TracerCommand.Clear
ResetKeyword -> TracerCommand.Reset
ScanKeyword -> TracerCommand.Scan
TraceKeyword -> parseTraceCommand(tokens.advance(), true)
UntraceKeyword -> parseTraceCommand(tokens.advance(), false)
else -> TracerCommand.Unknown
Expand Down Expand Up @@ -176,6 +180,7 @@ private object EndOfLine: Token()
private object ClearKeyword: Token()
private object ResetKeyword: Token()
private object TraceKeyword: Token()
private object ScanKeyword: Token()
private object UntraceKeyword: Token()
private object AllKeyword: Token()
private object CountKeyword: Token()
Expand Down Expand Up @@ -213,6 +218,7 @@ private fun tokenize(text: CharSequence): List<Token> {
"clear" -> tokens.add(ClearKeyword)
"reset" -> tokens.add(ResetKeyword)
"trace" -> tokens.add(TraceKeyword)
"scan" -> tokens.add(ScanKeyword)
"untrace" -> tokens.add(UntraceKeyword)
"all" -> tokens.add(AllKeyword)
"count" -> tokens.add(CountKeyword)
Expand Down
Loading