|
| 1 | +/* |
| 2 | + * Copyright The OpenTelemetry Authors |
| 3 | + * SPDX-License-Identifier: Apache-2.0 |
| 4 | + */ |
| 5 | + |
| 6 | +package io.opentelemetry.javaagent.tooling; |
| 7 | + |
| 8 | +import static java.util.logging.Level.FINE; |
| 9 | +import static java.util.logging.Level.WARNING; |
| 10 | + |
| 11 | +import io.opentelemetry.javaagent.bootstrap.AgentClassLoader; |
| 12 | +import java.lang.instrument.Instrumentation; |
| 13 | +import java.util.Collection; |
| 14 | +import java.util.Collections; |
| 15 | +import java.util.HashMap; |
| 16 | +import java.util.Map; |
| 17 | +import java.util.Set; |
| 18 | +import java.util.logging.Logger; |
| 19 | +import javax.annotation.Nullable; |
| 20 | +import net.bytebuddy.description.type.PackageDescription; |
| 21 | +import net.bytebuddy.dynamic.loading.ClassInjector; |
| 22 | +import net.bytebuddy.utility.JavaModule; |
| 23 | + |
| 24 | +/** |
| 25 | + * Module opener provides ability to open JPMS modules and allows instrumentation classloader to |
| 26 | + * access module contents without requiring JVM arguments modification. <br> |
| 27 | + * Usage of this class must be guarded with an {@code net.bytebuddy.utility.JavaModule#isSupported} |
| 28 | + * check as it's compiled for Java 9+, otherwise an {@link UnsupportedClassVersionError} will be |
| 29 | + * thrown for java 8. |
| 30 | + */ |
| 31 | +public class ModuleOpener { |
| 32 | + |
| 33 | + private static final Logger logger = Logger.getLogger(ModuleOpener.class.getName()); |
| 34 | + |
| 35 | + // AgentClassLoader is in unnamed module of the bootstrap loader |
| 36 | + private static final JavaModule UNNAMED_BOOT_MODULE = JavaModule.ofType(AgentClassLoader.class); |
| 37 | + |
| 38 | + private ModuleOpener() {} |
| 39 | + |
| 40 | + /** |
| 41 | + * Opens JPMS module to a class loader unnamed module |
| 42 | + * |
| 43 | + * @param targetModule target module |
| 44 | + * @param openTo class loader to open module for, {@literal null} to use the unnamed module of |
| 45 | + * bootstrap classloader. |
| 46 | + * @param packagesToOpen packages to open |
| 47 | + */ |
| 48 | + public static void open( |
| 49 | + Instrumentation instrumentation, |
| 50 | + JavaModule targetModule, |
| 51 | + @Nullable ClassLoader openTo, |
| 52 | + Collection<String> packagesToOpen) { |
| 53 | + |
| 54 | + JavaModule openToModule = |
| 55 | + openTo != null ? JavaModule.of(openTo.getUnnamedModule()) : UNNAMED_BOOT_MODULE; |
| 56 | + Set<JavaModule> openToModuleSet = Collections.singleton(openToModule); |
| 57 | + Map<String, Set<JavaModule>> missingOpens = new HashMap<>(); |
| 58 | + for (String packageName : packagesToOpen) { |
| 59 | + if (!targetModule.isOpened(new PackageDescription.Simple(packageName), openToModule)) { |
| 60 | + missingOpens.put(packageName, openToModuleSet); |
| 61 | + logger.log( |
| 62 | + FINE, |
| 63 | + "Exposing package '{0}' in module '{1}' to module '{2}'", |
| 64 | + new Object[] {packageName, targetModule, openToModule}); |
| 65 | + } |
| 66 | + } |
| 67 | + if (missingOpens.isEmpty()) { |
| 68 | + return; |
| 69 | + } |
| 70 | + |
| 71 | + try { |
| 72 | + ClassInjector.UsingInstrumentation.redefineModule( |
| 73 | + instrumentation, |
| 74 | + targetModule, |
| 75 | + Collections.emptySet(), |
| 76 | + Collections.emptyMap(), |
| 77 | + missingOpens, |
| 78 | + Collections.emptySet(), |
| 79 | + Collections.emptyMap()); |
| 80 | + } catch (Exception e) { |
| 81 | + logger.log(WARNING, "Failed to redefine module '" + targetModule.getActualName() + "'", e); |
| 82 | + } |
| 83 | + } |
| 84 | +} |
0 commit comments