Merge pull request #2 from AleksRychkov/trace_msg_change

Trace msg change

Author: AleksRychkov

README.md

@@ -171,7 +171,10 @@ frgament {
 * `exit`: Specifies a reference to a method to be injected at the end of instructed methods.
     * **Not required**
     * Variants:
-        * __static method reference__, e.g. `org.example.MethodHook.exit`
+        * __static method reference__, e.g. `org.example.MethodHook.exit`.
+* `msgPrefix`: Specifies prefix of trace message, `android.os.Trace.beginSection("${msgPrefix}clazzMethod.descriptor")`
+    * **Not required**
+    * Has effect only for `type: "trace"`
 
 #### Plugin configuration
 

examples/android-gradle-kts/methodhook/auto_trace.conf

@@ -5,4 +5,5 @@ autoTrace {
     interfaces = [ "io.github.aleksrychkov.example.AutoTrace" ]
     class = "*"
     methods = []
+    msgPrefix = "->"
 }

gradle/libs.versions.toml

@@ -8,14 +8,15 @@ typesafe = "1.4.2"
 junit = "5.7.1"
 plugin-publish = "1.2.1"
 okhttp = "4.12.0"
+methodhook = "0.3"
 
 [plugins]
 agp = { id = "com.android.application", version.ref = "agp" }
 detekt = { id = "io.gitlab.arturbosch.detekt", version.ref = "detekt" }
 kotlin = { id = "org.jetbrains.kotlin.jvm", version.ref = "kotlin" }
 kotlin-android = { id = "org.jetbrains.kotlin.android", version.ref = "kotlin" }
 plugin-publish = { id = "com.gradle.plugin-publish", version.ref = "plugin-publish" }
-methodhook = { id = "io.github.aleksrychkov.methodhook", version = "0.2" }
+methodhook = { id = "io.github.aleksrychkov.methodhook", version.ref = "methodhook" }
 
 
 [libraries]

methodhook/build.gradle.kts

@@ -10,7 +10,7 @@ plugins {
 }
 
 group = "io.github.aleksrychkov"
-version = "0.2"
+version = "0.3"
 
 java {
     sourceCompatibility = JavaVersion.VERSION_17

methodhook/src/main/kotlin/io/github/aleksrychkov/methodhook/config/Config.kt

@@ -27,6 +27,7 @@ internal data class TraceConfig(
     override val interfaces: ConfigValue<List<String>>,
     override val clazz: ConfigValue<String>,
     override val methods: ConfigValue<List<String>>,
+    val traceMsgPrefix: String? = null
 ) : Config
 
 /**

methodhook/src/main/kotlin/io/github/aleksrychkov/methodhook/config/ConfigMapper.kt

@@ -21,6 +21,7 @@ internal class ConfigMapper {
         const val PATH_ENTER = "enter"
         const val PATH_EXIT = "exit"
         const val PATH_DESCRIPTOR = "descriptor"
+        const val PATH_TRACE_PREFIX = "msgPrefix"
 
         // Supported configuration types
         const val TYPE_TRACE = "trace"
@@ -68,6 +69,7 @@ internal class ConfigMapper {
             interfaces = config.optionalListStringValue(PATH_INTERFACES),
             clazz = config.stringValue(PATH_CLASS),
             methods = config.listStringValue(PATH_METHODS),
+            traceMsgPrefix = config.stringOrNull(PATH_TRACE_PREFIX),
         )
 
     private fun mapDefault(config: TypeSafeConfig): Config =

methodhook/src/main/kotlin/io/github/aleksrychkov/methodhook/injects/InjectorFactory.kt

@@ -38,7 +38,9 @@ internal object InjectorFactory {
                         exitInjectMethod = config.exitInjectMethod,
                     )
 
-                    is TraceConfig -> TraceInjector
+                    is TraceConfig -> TraceInjector(
+                        msgPrefix = config.traceMsgPrefix,
+                    )
                 }
             }
             .toSet()

methodhook/src/main/kotlin/io/github/aleksrychkov/methodhook/injects/injectors/TraceInjector.kt

@@ -14,16 +14,24 @@ import org.objectweb.asm.commons.AdviceAdapter
  * allows tracking the execution of methods in an Android application. When a target
  * method is entered, it begins a new trace section, and when the method is exited,
  * it ends the trace section.
+ *
+ * @param msgPrefix - Prefix of trace's section name.
  */
-internal object TraceInjector : Injector {
+internal class TraceInjector(
+    private val msgPrefix: String? = null
+) : Injector {
 
-    private const val TRACE_MSG_LENGTH = 127
-    private const val TRACE_MSG_PREFIX = "=>"
+    private companion object {
+        const val TRACE_MSG_LENGTH = 127
+        const val TRACE_MSG_PREFIX = ""
+    }
 
     override fun onEnter(context: InjectorContext, mv: MethodVisitor) {
+        val prefix = msgPrefix ?: TRACE_MSG_PREFIX
         val className = context.className.substringAfterLast("/")
-        val msg = "$TRACE_MSG_PREFIX${className}.${context.methodName}${context.methodDescriptor}"
-            .takeLast(TRACE_MSG_LENGTH)
+        val method = context.methodName
+        val descriptor = context.methodDescriptor.stripPackages()
+        val msg = "${prefix}${className}.${method}${descriptor}".take(TRACE_MSG_LENGTH)
 
         mv.visitLdcInsn(msg)
         mv.visitMethodInsn(
@@ -33,7 +41,6 @@ internal object TraceInjector : Injector {
             "(Ljava/lang/String;)V",
             false,
         )
-
     }
 
     override fun onExit(
@@ -50,4 +57,10 @@ internal object TraceInjector : Injector {
             false,
         )
     }
+
+    private fun String.stripPackages(): String {
+        return this.replace(Regex("L[^;]+/"), "L")
+            .replace("(Ljava/lang/Void;)", "()")
+            .replace("()V", "()")
+    }
 }