Make all symbols from ':common' public to have proper IDEA highlighting and completion

Author: dmitrii-artuhov

common/src/main/org/jetbrains/lincheck/descriptors/CodeLocations.kt

@@ -19,7 +19,7 @@ import org.jetbrains.lincheck.trace.TRACE_CONTEXT
  * along with their corresponding code locations. To minimize overhead, Lincheck assigns unique IDs to all
  * code locations it analyses, and stores more detailed information necessary for trace generation in this object.
  */
-internal object CodeLocations {
+object CodeLocations {
     /**
      * Registers a new code location and returns its unique ID.
      *

common/src/main/org/jetbrains/lincheck/descriptors/MethodSignature.kt

@@ -13,5 +13,5 @@ package org.jetbrains.lincheck.descriptors
 import org.objectweb.asm.commons.Method
 
 
-internal fun Method.toMethodSignature() = MethodSignature(this.name, Types.convertAsmMethodType(this.descriptor))
-internal fun java.lang.reflect.Method.toMethodSignature() = Method.getMethod(this).toMethodSignature()
+fun Method.toMethodSignature() = MethodSignature(this.name, Types.convertAsmMethodType(this.descriptor))
+fun java.lang.reflect.Method.toMethodSignature() = Method.getMethod(this).toMethodSignature()

common/src/main/org/jetbrains/lincheck/trace/IndexedPool.kt

@@ -10,8 +10,8 @@
 
 package org.jetbrains.lincheck.trace
 
-internal class IndexedPool<T> {
-    private val items = mutableListOf<T>()
+class IndexedPool<T> {
+    private val items = mutableListOf<T?>()
     private val index = hashMapOf<T, Int>()
 
     @Synchronized

common/src/main/org/jetbrains/lincheck/trace/TraceContext.kt

@@ -17,14 +17,14 @@ import org.jetbrains.lincheck.descriptors.MethodSignature
 import org.jetbrains.lincheck.descriptors.VariableDescriptor
 import org.jetbrains.lincheck.descriptors.Types
 
-internal val TRACE_CONTEXT: TraceContext = TraceContext()
+val TRACE_CONTEXT: TraceContext = TraceContext()
 
-internal const val UNKNOWN_CODE_LOCATION_ID = -1
+const val UNKNOWN_CODE_LOCATION_ID = -1
 
 private val EMPTY_STACK_TRACE = StackTraceElement("", "", "", 0)
 
 class TraceContext {
-    private val locations = ArrayList<StackTraceElement>()
+    private val locations = ArrayList<StackTraceElement?>()
     private val classes = IndexedPool<ClassDescriptor>()
     private val methods = IndexedPool<MethodDescriptor>()
     private val fields = IndexedPool<FieldDescriptor>()

common/src/main/org/jetbrains/lincheck/util/AnalysisSections.kt

@@ -43,7 +43,7 @@ import sun.nio.ch.lincheck.ThreadDescriptor
  * Local sections: [NORMAL], [SILENT].
  * Propagating sections: [SILENT_PROPAGATING], [ATOMIC], [IGNORED].
  */
-internal enum class AnalysisSectionType {
+enum class AnalysisSectionType {
 
     /**
      * Normal section without special handling.
@@ -94,25 +94,25 @@ internal enum class AnalysisSectionType {
     IGNORED,
 }
 
-internal fun AnalysisSectionType.isCallStackPropagating() =
+fun AnalysisSectionType.isCallStackPropagating() =
     this >= AnalysisSectionType.SILENT_PROPAGATING
 
-internal fun AnalysisSectionType.isSilent() =
+fun AnalysisSectionType.isSilent() =
     this == AnalysisSectionType.SILENT         ||
     this == AnalysisSectionType.SILENT_PROPAGATING
 
 
 /**
  * Enables analysis for the current thread.
  */
-internal fun enableAnalysis() {
+fun enableAnalysis() {
     Injections.enableAnalysis()
 }
 
 /**
  * Disables analysis for the current thread.
  */
-internal fun disableAnalysis() {
+fun disableAnalysis() {
     Injections.disableAnalysis()
 }
 
@@ -122,7 +122,7 @@ internal fun disableAnalysis() {
  * Does not affect the current thread if it is untracked
  * (e.g. not registered in the Lincheck strategy).
  */
-internal fun enterIgnoredSection() {
+fun enterIgnoredSection() {
     Injections.enterIgnoredSection()
 }
 
@@ -132,7 +132,7 @@ internal fun enterIgnoredSection() {
  * Does not affect the current thread if it is untracked
  * (e.g. not registered in the Lincheck strategy).
  */
-internal fun leaveIgnoredSection() {
+fun leaveIgnoredSection() {
     Injections.leaveIgnoredSection()
 }
 
@@ -146,7 +146,7 @@ internal fun leaveIgnoredSection() {
  * @param block the code to execute within the ignored section.
  * @return result of the [block] invocation.
  */
-internal inline fun <R> runInsideIgnoredSection(block: () -> R): R {
+inline fun <R> runInsideIgnoredSection(block: () -> R): R {
     val desc = ThreadDescriptor.getCurrentThreadDescriptor() ?: return block()
     desc.enterIgnoredSection()
     try {
@@ -164,7 +164,7 @@ internal inline fun <R> runInsideIgnoredSection(block: () -> R): R {
  * @return result of [block] invocation.
  * @throws IllegalStateException if the method is called not from an ignored section.
  */
-internal inline fun <R> runOutsideIgnoredSection(block: () -> R): R {
+inline fun <R> runOutsideIgnoredSection(block: () -> R): R {
     val descriptor = ThreadDescriptor.getCurrentThreadDescriptor()
     if (
         descriptor == null ||
@@ -196,7 +196,7 @@ internal inline fun <R> runOutsideIgnoredSection(block: () -> R): R {
  *                        standard collections and concurrent collections are hidden,
  *                        concurrent collections are muted.
  */
-internal class AnalysisProfile(val analyzeStdLib: Boolean) {
+class AnalysisProfile(val analyzeStdLib: Boolean) {
 
     /**
      * Determines whether a given class and method should be transformed (instrumented) for analysis.

common/src/main/org/jetbrains/lincheck/util/Ensure.kt

@@ -10,37 +10,37 @@
 
 package org.jetbrains.lincheck.util
 
-internal fun Boolean.ensureTrue(): Boolean {
+fun Boolean.ensureTrue(): Boolean {
     // TODO: add contracts?
     check(this == true)
     return this
 }
 
-internal fun Boolean.ensureFalse(): Boolean {
+fun Boolean.ensureFalse(): Boolean {
     // TODO: add contracts?
     check(this == false)
     return this
 }
 
-internal inline fun<T> T.ensure(predicate: (T) -> Boolean): T {
+inline fun<T> T.ensure(predicate: (T) -> Boolean): T {
     // TODO: add contracts?
     check(predicate(this))
     return this
 }
 
-internal inline fun<T> T.ensure(predicate: (T) -> Boolean, lazyMessage: (T?) -> Any): T {
+inline fun<T> T.ensure(predicate: (T) -> Boolean, lazyMessage: (T?) -> Any): T {
     // TODO: add contracts?
     check(predicate(this)) { lazyMessage(this) }
     return this
 }
 
-internal fun<T> T?.ensureNull(): T? {
+fun<T> T?.ensureNull(): T? {
     // TODO: add contracts?
     check(this == null)
     return this
 }
 
-internal fun<T> T?.ensureNull(lazyMessage: (T?) -> Any): T? {
+fun<T> T?.ensureNull(lazyMessage: (T?) -> Any): T? {
     // TODO: add contracts?
     check(this == null) { lazyMessage(this) }
     return this

common/src/main/org/jetbrains/lincheck/util/JdkVersion.kt

@@ -14,21 +14,21 @@ package org.jetbrains.lincheck.util
 /**
  * Represents a set of Java Development Kit (JDK) major versions since JDK 6.
  */
-internal  enum class JdkVersion {
+enum class JdkVersion {
     JDK_6, JDK_7, JDK_8, JDK_9, JDK_10, JDK_11, JDK_12, JDK_13, JDK_14, JDK_15,
     JDK_16, JDK_17, JDK_18, JDK_19, JDK_20, JDK_21, JDK_22, JDK_23, JDK_24, JDK_25;
     override fun toString(): String {
         return "jdk${name.removePrefix("JDK_")}"
     }
 }
 
-internal val DEFAULT_TEST_JDK_VERSION = JdkVersion.JDK_17
+val DEFAULT_TEST_JDK_VERSION = JdkVersion.JDK_17
 
 /**
  * Determines the current JDK version based on the `java.specification.version` system property.
  * If the system property indicates an unsupported JDK version, an error is thrown.
  */
-internal val jdkVersion: JdkVersion = run {
+val jdkVersion: JdkVersion = run {
     val jdkVersion = System.getProperty("java.specification.version")
     // java.specification.version is "1.x" for Java prior to 8 and "x" for the newer ones
     when {
@@ -64,4 +64,4 @@ internal val jdkVersion: JdkVersion = run {
 /**
  * Indicates whether the current Java Development Kit (JDK) version is JDK 8.
  */
-internal val isJdk8 = (jdkVersion == JdkVersion.JDK_8)
+val isJdk8 = (jdkVersion == JdkVersion.JDK_8)

common/src/main/org/jetbrains/lincheck/util/Logger.kt

@@ -14,19 +14,19 @@ import java.io.*
 import java.time.LocalDateTime
 import java.time.format.DateTimeFormatter
 
-internal object Logger {
+object Logger {
     private val formatter: DateTimeFormatter = DateTimeFormatter.ofPattern("dd.MM.yyyy HH:mm:ss.SSS")
 
     private val logFile: File? = System.getProperty("lincheck.logFile")?.let { fileName ->
         File(fileName).also { runCatching { initFile(it) }.getOrNull() }
     }
 
-    private val logWriter: Writer = BufferedWriter(
+    val logWriter: Writer = BufferedWriter(
         if (logFile != null) FileWriter(logFile)
         else System.err.writer()
     )
 
-    private val logLevel: LoggingLevel = System.getProperty("lincheck.logLevel")?.uppercase()?.let {
+    val logLevel: LoggingLevel = System.getProperty("lincheck.logLevel")?.uppercase()?.let {
         runCatching { LoggingLevel.valueOf(it) }.getOrElse { DEFAULT_LOG_LEVEL }
     } ?: DEFAULT_LOG_LEVEL
 
@@ -46,13 +46,13 @@ internal object Logger {
 
     fun debug(e: Throwable) = log(LoggingLevel.DEBUG, e)
 
-    private inline fun log(logLevel: LoggingLevel, lazyMessage: () -> String) {
+    inline fun log(logLevel: LoggingLevel, lazyMessage: () -> String) {
         if (logLevel >= this.logLevel) {
             write(logLevel, lazyMessage(), logWriter)
         }
     }
 
-    private fun write(logLevel: LoggingLevel, s: String, writer: Writer) {
+    fun write(logLevel: LoggingLevel, s: String, writer: Writer) {
         try {
             writer.write("[${logLevel.name}] $s$LINE_SEPARATOR")
             writer.flush()
@@ -70,10 +70,6 @@ internal object Logger {
         }
     }
 
-    private fun getCurrentTimeStamp(): String {
-        return formatter.format(LocalDateTime.now())
-    }
-
     private fun initFile(file: File) {
         // create parent directories
         file.parentFile?.let { if (!it.exists()) it.mkdirs() }
@@ -86,7 +82,7 @@ internal object Logger {
 
 private val LINE_SEPARATOR = System.lineSeparator()
 
-@JvmField internal val DEFAULT_LOG_LEVEL = LoggingLevel.WARN
+@JvmField val DEFAULT_LOG_LEVEL = LoggingLevel.WARN
 
 enum class LoggingLevel {
     DEBUG, INFO, WARN, ERROR, OFF

common/src/main/org/jetbrains/lincheck/util/MethodDescriptor.kt

@@ -13,7 +13,7 @@ package org.jetbrains.lincheck.util
 import org.jetbrains.lincheck.descriptors.MethodDescriptor
 import org.jetbrains.lincheck.descriptors.Types
 
-internal fun MethodDescriptor.isArraysCopyOfIntrinsic(): Boolean {
+fun MethodDescriptor.isArraysCopyOfIntrinsic(): Boolean {
     return (
         className == "java.util.Arrays" &&
         methodName == "copyOf" &&
@@ -26,7 +26,7 @@ internal fun MethodDescriptor.isArraysCopyOfIntrinsic(): Boolean {
     )
 }
 
-internal fun MethodDescriptor.isArraysCopyOfRangeIntrinsic(): Boolean {
+fun MethodDescriptor.isArraysCopyOfRangeIntrinsic(): Boolean {
     return (
         className == "java.util.Arrays" &&
         methodName.contains("copyOfRange") &&
@@ -48,7 +48,7 @@ internal fun MethodDescriptor.isArraysCopyOfRangeIntrinsic(): Boolean {
 
 // TODO: java 8 does not have `@HotSpotIntrinsicCandidate`/`@IntrinsicCandidate` annotations
 //  add all tracked intrinsics here
-internal fun MethodDescriptor.isTrackedIntrinsic(): Boolean =
+fun MethodDescriptor.isTrackedIntrinsic(): Boolean =
     isArraysCopyOfIntrinsic() ||
     isArraysCopyOfRangeIntrinsic()
 

common/src/main/org/jetbrains/lincheck/util/UnsafeHolder.kt

@@ -15,7 +15,7 @@ import java.lang.reflect.Field
 import java.lang.reflect.Modifier
 import java.util.concurrent.ConcurrentHashMap
 
-internal object UnsafeHolder {
+object UnsafeHolder {
     val UNSAFE: Unsafe = try {
         val unsafeField = Unsafe::class.java.getDeclaredField("theUnsafe")
         unsafeField.isAccessible = true
@@ -25,11 +25,11 @@ internal object UnsafeHolder {
     }
 }
 
-private val fieldOffsetCache = ConcurrentHashMap<Field, Long>()
-private val fieldBaseObjectCache = ConcurrentHashMap<Field, Any>()
+val fieldOffsetCache = ConcurrentHashMap<Field, Long>()
+val fieldBaseObjectCache = ConcurrentHashMap<Field, Any>()
 
 @Suppress("DEPRECATION")
-internal inline fun <T> readFieldViaUnsafe(obj: Any?, field: Field, getter: Unsafe.(Any?, Long) -> T): T {
+inline fun <T> readFieldViaUnsafe(obj: Any?, field: Field, getter: Unsafe.(Any?, Long) -> T): T {
     if (Modifier.isStatic(field.modifiers)) {
         val base = fieldBaseObjectCache.computeIfAbsent(field) {
             UnsafeHolder.UNSAFE.staticFieldBase(it)
@@ -46,7 +46,7 @@ internal inline fun <T> readFieldViaUnsafe(obj: Any?, field: Field, getter: Unsa
     }
 }
 
-internal fun readFieldViaUnsafe(obj: Any?, field: Field): Any? {
+fun readFieldViaUnsafe(obj: Any?, field: Field): Any? {
     if (!field.type.isPrimitive) {
         return readFieldViaUnsafe(obj, field, Unsafe::getObject)
     }
@@ -67,7 +67,7 @@ internal fun readFieldViaUnsafe(obj: Any?, field: Field): Any? {
  * Reads a [field] of the owner object [obj] via Unsafe,
  * in case of failure fallbacks into reading the field via reflection.
  */
-internal fun readFieldSafely(obj: Any?, field: Field): Result<Any?> =
+fun readFieldSafely(obj: Any?, field: Field): Result<Any?> =
     // we wrap an unsafe read into `runCatching` to handle `UnsupportedOperationException`,
     // which can be thrown, for instance, when attempting to read
     // a field of a hidden or record class (starting from Java 15);
@@ -87,7 +87,7 @@ internal fun readFieldSafely(obj: Any?, field: Field): Result<Any?> =
         Logger.debug(exception)
     }
 
-internal fun readArrayElementViaUnsafe(arr: Any, index: Int): Any? {
+fun readArrayElementViaUnsafe(arr: Any, index: Int): Any? {
     val offset = getArrayElementOffsetViaUnsafe(arr, index)
     val componentType = arr::class.java.componentType
 
@@ -108,15 +108,15 @@ internal fun readArrayElementViaUnsafe(arr: Any, index: Int): Any? {
     }
 }
 
-internal fun getArrayElementOffsetViaUnsafe(arr: Any, index: Int): Long {
+fun getArrayElementOffsetViaUnsafe(arr: Any, index: Int): Long {
     val clazz = arr::class.java
     val baseOffset = UnsafeHolder.UNSAFE.arrayBaseOffset(clazz).toLong()
     val indexScale = UnsafeHolder.UNSAFE.arrayIndexScale(clazz).toLong()
     return baseOffset + index * indexScale
 }
 
 @Suppress("DEPRECATION")
-internal inline fun writeFieldViaUnsafe(obj: Any?, field: Field, value: Any?, setter: Unsafe.(Any?, Long, Any?) -> Unit) {
+inline fun writeFieldViaUnsafe(obj: Any?, field: Field, value: Any?, setter: Unsafe.(Any?, Long, Any?) -> Unit) {
     if (Modifier.isStatic(field.modifiers)) {
         val base = UnsafeHolder.UNSAFE.staticFieldBase(field)
         val offset = UnsafeHolder.UNSAFE.staticFieldOffset(field)
@@ -128,7 +128,7 @@ internal inline fun writeFieldViaUnsafe(obj: Any?, field: Field, value: Any?, se
 }
 
 @Suppress("NAME_SHADOWING")
-internal fun writeFieldViaUnsafe(obj: Any?, field: Field, value: Any?) {
+fun writeFieldViaUnsafe(obj: Any?, field: Field, value: Any?) {
     if (!field.type.isPrimitive) {
         return writeFieldViaUnsafe(obj, field, value, Unsafe::putObject)
     }
@@ -145,7 +145,7 @@ internal fun writeFieldViaUnsafe(obj: Any?, field: Field, value: Any?) {
     }
 }
 
-internal fun writeArrayElementViaUnsafe(arr: Any, index: Int, value: Any?): Any? {
+fun writeArrayElementViaUnsafe(arr: Any, index: Int, value: Any?): Any? {
     val offset = getArrayElementOffsetViaUnsafe(arr, index)
     val componentType = arr::class.java.componentType
 
@@ -167,7 +167,7 @@ internal fun writeArrayElementViaUnsafe(arr: Any, index: Int, value: Any?): Any?
 }
 
 @Suppress("DEPRECATION")
-internal fun getFieldOffsetViaUnsafe(field: Field): Long {
+fun getFieldOffsetViaUnsafe(field: Field): Long {
     return if (Modifier.isStatic(field.modifiers)) {
         UnsafeHolder.UNSAFE.staticFieldOffset(field)
     }
@@ -180,7 +180,7 @@ private val fieldNameByOffsetCache = ConcurrentHashMap<Pair<Class<*>, Long>, Str
 private val NULL_FIELD_NAME = ".+-  NULL  -+." // cannot store `null` in the cache.
 
 @Suppress("DEPRECATION")
-internal fun findFieldNameByOffsetViaUnsafe(targetType: Class<*>, offset: Long): String? =
+fun findFieldNameByOffsetViaUnsafe(targetType: Class<*>, offset: Long): String? =
     fieldNameByOffsetCache.getOrPut(targetType to offset) {
         findFieldNameByOffsetViaUnsafeImpl(targetType, offset) ?: NULL_FIELD_NAME
     }.let { if (it == NULL_FIELD_NAME) null else it }