Как выгрузить dll из Java-машины

private void addLibraryPath(String pathToAdd) throws ReflectiveOperationException {
    Field usrPathsField = ClassLoader.class.getDeclaredField("usr_paths");
    usrPathsField.setAccessible(true);
    String[] paths = (String[]) usrPathsField.get(null);
    String[] newPaths = Arrays.copyOf(paths, paths.length + 1);
    newPaths[newPaths.length - 1] = pathToAdd;
    usrPathsField.set(null, newPaths);
}
private Path prepareLibrary() throws IOException, ReflectiveOperationException {
    Path dir = Files.createTempDirectory("lib");
    try (InputStream input = ExampleClass.class.getResourceAsStream("custom.dll")) {
        if (input == null) {
            throw new FileNotFoundException("Can't load resource custom.dll");
        }
        Files.copy(input, dir.resolve("custom.dll"));
    }
    addLibraryPath(dir.toAbsolutePath().toString());
    return dir;
}

ClassLoader parentCl = ExampleClass.class.getClassLoader();
classLoader = new URLClassLoader(new URL[0], parentCl);
Class.forName("org.jdbc.CustomDriver", classLoader, true);
try (Connection connection = DriverManager.getConnection(dbUrl, dbProperties)) {
    if (connection.getClass().getClassLoader() != classLoader) {
        System.out.printf("Что-то пошло не так%n");
    }
    ...
}

ClassLoader cl = ExampleClass.class.getClassLoader();
URL url = UnloadableDriver.class.getResource("CustomJDBCDriver.jar");
if (url == null) {
    throw new FileNotFoundException("Can't load resource CustomJDBCDriver.jar");
}
Path dir = prepareLibrary();
try (InputStream stream = url.openStream()) {
    Path target = dir.resolve("CustromJDBCDriver.jar");
    Files.copy(stream, target);
    url = target.toUri().toURL();
}
ClassLoader classLoader = new URLClassLoader(new URL[] {url}, cl);
Class.forName("org.jdbc.CustomDriver", true, classLoader);
try (Connection connection = DriverManager.getConnection(dbUrl, dbProperties)) {
    if (connection.getClass().getClassLoader() != classLoader) {
        System.out.printf("Что-то пошло не так%n");
    } else {
        System.out.printf("Получилось, можно идти дальше%n");
    }
    ...
}

public class ExampleClass implements AutoCloseable {
    private final Path dir;
    private URLClassLoader classLoader;

    public ExampleClass() {
        ...
    }

    public void doWork() {
        ...
    }

    @Override
    public void close() {
        ...
        this.classLoader.close();
        this.classloader = null;
        System.gc(); // где-то здесь должна выгрузиться dll
        if (!delete(this.dir)) {
            scheduleRemovalToTaskschd(this.dir);
        }
    }
}

public class Main {
    public static void main(String args[]) {
        try (ExampleClass example = new ExampleClass()) {
            example.doWork();
        } catch (Throwable e) {
            e.printStackTrace();
        }
    }
}

@Override
public void close() {
    ...
    this.classLoader.close();
    this.classloader = null;
    System.gc();
    System.runFinalization(); // где-то здесь должна выгрузиться dll
    if (!delete(this.dir)) {
        scheduleRemovalToTaskschd(this.dir);
    }
}

Локальные переменные

Оказалось, что сборщик мусора не считает локальную переменную недостижимой, пока не будет завершена функция, содержащая эту переменную, даже если переменная вышла из области видимости.

if (needConnection) {
    try (Connection connection = DriverManager.connect()) {
        ...
    }
}
// Вот здесь переменна connection еще считается живой.

Поэтому для решения задачи выгрузки класслоадера необходимо перед вызовом gc выйти из всех функций, которые используют выгружаемые классы.

DriverManager

JDBC-драйверы при загрузке их класса регистрируются в классе DriverManager методом registerDriver(). Судя по всему, перед выгрузкой надо вызвать метод deregisterDriver(). Пробуем.

Enumeration<Driver> drivers = driverManager.getDrivers();
while (drivers.hasMoreElements()) {
    Driver driver = drivers.nextElement();
    if (driver.getClass().getClassLoader() == classLoader) {
        DriverManager.deregisterDriver(driver);
        break;
    }
}

Не работает. Heapdump не изменился. Смотрим в исходники класса DriverManager и обнаруживаем, что в методе deregisterDriver() стоит проверка на то, что вызов должен быть из класса, который принадлежит тому же класслоадеру, что и класс, вызвавший ранее registerDriver(). А registerDriver() вызван самим драйвером из статического инициализатора. Неожиданный поворот.

Получается, мы не можем напрямую разрегистрировать драйвер. Вместо этого мы должны попросить какой-нибудь класс из нового класслоадера, чтобы он сделал это от своего имени. Выход заключается в создании специального класса DriverManagerProxy, точнее даже двух, класса и интерфейса.

public interface DriverManagerProxy {
    void deregisterDriver(Driver driver) throws SQLException;
}

public class DriverManagerProxyImpl implements DriverManagerProxy {
    @Override
    public void deregisterDriver(Driver driver) throws SQLException {
        DriverManager.deregisterDriver(driver);
    }
}

Интерфейс будет находиться в основном classpath-е, а релизация будет загружена новым загрузчиком из вспомогательного jar-файла вместе с JDBC-драйвером. Теоретически без интерфейса можно было бы обойтись, но тогда для вызова функции пришлось бы применять reflection. Используется прокси следующим образом:

public class ExampleClass implements AutoCloseable {
    private final Path dir;
    private URLClassLoader classLoader;
    private DriverManagerProxy driverManager;

    public ExampleClass() {
        ...
        this.classLoader = ...;
        Class.forName("org.jdbc.CustomDriver", true, classLoader);
        Class<?> dmClass = Class.forName("ru.example.DriverManagerProxyImpl",
                                         true,
                                         classLoader);
        this.driverManager = (DriverManagerProxy) dmClass.newInstance();
    }

    public void doWork() {
        ...
    }

    @Override
    public void close() {
        ...
        Enumeration<Driver> drivers = driverManager.getDrivers();
        while (drivers.hasMoreElements()) {
            Driver driver = drivers.nextElement();
            if (driver.getClass().getClassLoader() == classLoader) {
                driverManager.deregisterDriver(driver);
                break;
            }
        }
        this.driverManager = null;
        this.classLoader.close();
        this.classloader = null;
        System.gc();
        System.runFinalization(); // где-то здесь должна выгрузиться dll
        if (!delete(this.dir)) {
            scheduleRemovalToTaskschd(this.dir);
        }
    }
}

ResourceBundle

Следующая зацепка на класслоадер, который я пытался выгрузить, обнаружилась в недрах класса ResourceBundle. К счастью, в отличие от DriverManager, ResourceBundle предоставляет специальную функцию clearCache(), которой класслоадер передается в качестве параметра.

ResourceBundle.clearCache(classLoader);

Надо заметить, что, судя по исходникам, в ResourceBundle используются слабые ссылки, которые не должны препятствовать сборке мусора. Возможно, если очистить все остальные ссылки на наши объекты, то чистить этот кэш нет необходимости.

ThreadLocals

Последнее место, где обнаружились хвосты неиспользуемого драйвера, оказалось ThreadLocals. После истории с DriverManager-ом, очистка локальных поточных переменных кажется парой пустяков. Хотя тут не удалось обойтись без reflection.

private static void cleanupThreadLocals(ClassLoader cl)
        throws ReflectiveOperationException {
    int length = 1;
    Thread threads[] = new Thread[length];
    int cnt = Thread.enumerate(threads);
    while (cnt >= length) {
        length *= 2;
        threads = new Thread[length];
        cnt = Thread.enumerate(threads);
    }
    for (int i = 0; i < cnt; i++) {
        Thread thread = threads[i];
        if (thread == null) {
            continue;
        }
        cleanupThreadLocals(thread, cl);
    }
}

private static void cleanupThreadLocals(Thread thread, ClassLoader cl)
        throws ReflectiveOperationException {
    Field threadLocalsField = Thread.class.getDeclaredField("threadLocals");
    threadLocalsField.setAccessible(true);
    Object threadLocals = threadLocalsField.get(thread);
    if (threadLocals == null) {
        return;
    }
    Class<?> threadLocalsClass = threadLocals.getClass();
    Field tableField = threadLocalsClass.getDeclaredField("table");
    tableField.setAccessible(true);
    Object table = tableField.get(threadLocals);
    Object entries[] = (Object[]) table;
    Class<?> entryClass = table.getClass().getComponentType();
    Field valueField = entryClass.getDeclaredField("value");
    valueField.setAccessible(true);
    Method expungeStaleEntry = threadLocalsClass.getDeclaredMethod("expungeStaleEntry", Integer.TYPE);
    expungeStaleEntry.setAccessible(true);
    for (int i = 0; i < entries.length; i++) {
        Object entry = entries[i];
        if (entry == null) {
            continue;
        }
        Object value = valueField.get(entry);
        if (value != null) {
            ClassLoader valueClassLoader = value.getClass().getClassLoader();
            if (valueClassLoader == cl) {
                ((java.lang.ref.Reference<?>) entry).clear();
                expungeStaleEntry.invoke(threadLocals, i);
            }
        }
    }
}

Исключения

Мы рассчитываем на то, что код очистки можно поместить в блоке finally. На входе в этот блок у нас уже должно быть все закрыто автоматически при помощи механизма try-with-resources. Однако наш класслоадер по-прежнему не будет в этом месте удален из памяти, если из блока try выброшено исключение, класс которого загружен этим класслоадером.

Чтобы удалить из памяти нежелательный exception, его надо поймать и обработать, а если нужно ошибку все-таки выбросить наверх, то скопировать exception в другой класс. Вот как это сделал я в своей программе:

try {
    ...
} catch (RuntimeException e) {
    if (e.getClass().getClassLoader() == this.getClass().getClassLoader()) {
        throw e;
    }
    RuntimeException exception = new RuntimeException(String.format("%s: %s", e.getClass(), e.getMessage()));
    exception.setStackTrace(e.getStackTrace());
    throw exception;
} catch (SQLException e) {
    if (e.getClass().getClassLoader() == this.getClass().getClassLoader()) {
        throw e;
    }
    SQLException exception = new SQLException(String.format("%s: %s", e.getClass(), e.getMessage()));
    exception.setStackTrace(e.getStackTrace());
    throw exception;
}

private static void dumpHeap() {
    try {
        Class<?> clazz = Class.forName("com.sun.management.HotSpotDiagnosticMXBean");
        MBeanServer server = ManagementFactory.getPlatformMBeanServer();
        Object hotspotMBean =
                ManagementFactory.newPlatformMXBeanProxy(
                        server, "com.sun.management:type=HotSpotDiagnostic", clazz);
        Method m = clazz.getMethod("dumpHeap", String.class, boolean.class);
        m.invoke(hotspotMBean, "nul", true);
    } catch (@SuppressWarnings("unused") RuntimeException e) {
        return;
    } catch (@SuppressWarnings("unused") ReflectiveOperationException e) {
        return;
    } catch (@SuppressWarnings("unused") IOException e) {
        return;
    }
}

public class UnloadableDriver implements Driver, AutoCloseable {
    private final Path dir; // временный каталог, подлежащий удалению
    private URLClassLoader classLoader;
    private DriverManagerProxy driverManager;
    private Driver driver;

    public UnloadableDriver() throws SQLException {
        ...
    }

    @Override
    public void close() {
        ...
    }

    ...
}

public interface JDBCService {
    Connection getConnection(String url, Properties properties) throws SQLException;
}

@Service(JDBCService.class)
public class JDBCServiceImpl implements JDBCService {
    private UnloadableDriver driver;

    @Activate
    public void activate(ComponentContext ctx) throws SQLException {
        this.driver = new UnloadableDriver();
    }

    @Deactivate
    public void deactivate() {
        this.driver.close();
        this.driver = null;
    }

    @Override
    public Connection getConnection(String url, Properties info) throws SQLException {
        return this.driver.connect(url, properties);
    }
}