All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.wl4g.infra.common.natives.ClassPathNativeLibraryLoader Maven / Gradle / Ivy

Go to download

A Infra Common.

There is a newer version: 3.1.72
Show newest version
/*
 * Copyright 2017 ~ 2025 the original author or authors. James Wong 
 *
 * 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
 *
 *      http://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.wl4g.infra.common.natives;

import static java.lang.Runtime.*;
import static java.lang.String.format;
import static java.lang.System.currentTimeMillis;
import static java.lang.System.load;
import static java.util.Arrays.asList;
import static java.util.Collections.sort;
import static java.util.Collections.unmodifiableList;
import static java.util.Locale.US;
import static java.util.Objects.nonNull;
import static java.nio.file.StandardCopyOption.*;

import java.io.*;
import java.lang.reflect.Field;
import java.lang.reflect.Method;
import java.net.URL;
import java.nio.file.Files;
import java.util.ArrayList;
import java.util.Comparator;
import java.util.Iterator;
import java.util.List;
import java.util.Set;
import java.util.Vector;
import java.util.concurrent.atomic.AtomicBoolean;

import static com.wl4g.infra.common.lang.Assert2.*;
import static com.wl4g.infra.common.lang.ClassUtils2.getDefaultClassLoader;
import static com.wl4g.infra.common.log.SmartLoggerFactory.getLogger;

import com.wl4g.infra.common.log.SmartLogger;
import com.wl4g.infra.common.resource.StreamResource;
import com.wl4g.infra.common.resource.resolver.ClassPathResourcePatternResolver;

/**
 * The native class library auto-loader is based on the class path or file path,
 * jar file path, usually including x64/x86/amd64/ppc64/aarch64, etc (using JNI
 * - Java Native Interface).
 * 
 * @see http://adamheinrich.com/blog/2012/how-to-load-native-jni-library-from-jar
 * @see https://github.com/adamheinrich/native-utils
 *
 * @author James Wong 
 * @version v1.0 2019年12月3日
 * @since
 */
public class ClassPathNativeLibraryLoader extends PlatformInfo {

    final protected SmartLogger log = getLogger(getClass());

    /**
     * Loaded state flag.
     */
    final private AtomicBoolean loadedState = new AtomicBoolean(false);

    /**
     * Native library classLoader.
     */
    final private ClassLoader classLoader;

    /**
     * Current OS arch share lib folder path part(lowerCase).

     * e.g. Windows/x86, Windows/x86_64, Linux/x86, Linux/x86_64,
     */
    final private String archShareLibFolderPathLowerCase;

    /**
     * Matched load native library file resources.
     */
    final private List loadLibFiles = new ArrayList<>(8);

    public ClassPathNativeLibraryLoader() {
        this(getDefaultClassLoader());
    }

    /**
     * For example:
     * 
     * 
     * new {@link ClassPathNativeLibraryLoader}("/opencv/native/××/×.×");
     * 

     * 
     * Note: Because of the Java multiline annotation problem,
     * the "*" is replaced by "×"
     * 
     * @param classLoader,
     * @param archShareMapping
     * @param libLocationPattern
     */
    public ClassPathNativeLibraryLoader(ClassLoader classLoader) {
        notNull(classLoader, "Native library classLoader can't null.");
        this.classLoader = classLoader;
        this.archShareLibFolderPathLowerCase = getNativeLibFolderPathForCurrentOS().toLowerCase(US);
    }

    /**
     * Check current {@link ClassPathNativeLibraryLoader} loaded?
     * 
     * @return
     */
    public boolean isLoaded() {
        return loadedState.get();
    }

    /**
     * Gets generated library tmp files.
     * 
     * @return
     */
    public List getLibTmpFiles() {
        return unmodifiableList(loadLibFiles);
    }

    /**
     * The file from JAR(CLASSPATH) is copied into system temporary directory
     * and then loaded. The temporary file is deleted after exiting. Method uses
     * String as filename because the pathname is "abstract", not
     * system-dependent.
     * 
     * @param libLocationPatterns
     *            lib Location patterns
     * @throws IOException
     *             Dynamic library read write error
     * @throws LoadNativeLibraryError
     *             The specified file was not found in the jar package.
     * @return {@link ClassPathNativeLibraryLoader}
     */
    @SuppressWarnings("unchecked")
    public final  T loadLibrarys(String... libLocationPatterns)
            throws IOException, LoadNativeLibraryError {

        // Loaded?
        if (!loadedState.compareAndSet(false, true)) {
            return (T) this;
        }

        assertLibLocationPatterns(libLocationPatterns);

        // Scanning native library resources.
        ClassPathResourcePatternResolver resolver = new ClassPathResourcePatternResolver(classLoader);
        Set resources = resolver.getResources(libLocationPatterns);
        // Sort resources url by ASCII dict.
        List rss = asList(resources.toArray(new StreamResource[] {}));
        sort(rss, ASC_COMPARATOR);

        // Matching native library by current os arch.
        for (StreamResource r : rss) {
            if (!r.exists() || r.isOpen() || !r.isReadable()) {
                log.warn("Cannot to load native library: {}", r.getURL().toString());
                continue;
            }
            if (!matchArchWithRequiresCandidate(r.getURL()) || !matchArchWithCurrentOS(r.getURL())) {
                continue;
            }

            File tmpLibFile = null; // Native library temporary file.
            try (InputStream in = r.getInputStream()) {
                tmpLibFile = new File(libNativeTmpDir, r.getFilename());
                loadLibFiles.add(tmpLibFile);

                // Copy match nativelib to temporary directory.
                Files.copy(in, tmpLibFile.toPath(), REPLACE_EXISTING);

                // Load to JVM.
                loadNativeLibrary(tmpLibFile);
                log.debug("Loaded native library: {}", r.getURL().toString());

            } catch (IOException e) {
                if (nonNull(tmpLibFile))
                    tmpLibFile.delete();
                throw e;
            } catch (NullPointerException e) {
                if (nonNull(tmpLibFile))
                    tmpLibFile.delete();
                throw new FileNotFoundException("Library file [" + r.getURL() + "] was not found.");
            }
        }

        // Any loaded library?
        if (loadLibFiles.isEmpty()) {
            throw new LoadNativeLibraryError("No match native library, there is no shared library file of current os/arch: '"
                    + OS_NAME + "/" + OS_ARCH + "' or the path does not meet the specification?"
                    + "\nRefer to os arch name transformation mapping: " + archMapping + "\nScan matching patterns: "
                    + asList(libLocationPatterns) + "\nAll was found native library resources: " + rss);
        }

        // Cleanup nativelib temporary files.
        cleanupTmpNativeLibs();

        return (T) this;
    }

    /**
     * Do load library
     * 
     * @param tmpLibFile
     */
    protected void loadNativeLibrary(File tmpLibFile) {
        load(tmpLibFile.getAbsolutePath());
    }

    /**
     * Match possible requires candidate suffixes for multiple platforms
     * 
     * @return
     */
    protected boolean matchArchWithRequiresCandidate(URL path) {
        String pathURL = path.toString().toLowerCase(US);
        for (String suffix : SUPPORTED_PLATFORM) {
            if (pathURL.endsWith(suffix)) {
                return true;
            }
        }
        return false;
    }

    /**
     * Automatically match the current os type and architecture.
     * 
     * @return
     */
    protected boolean matchArchWithCurrentOS(URL path) {
        return path.toString().toLowerCase(US).contains(archShareLibFolderPathLowerCase);
    }

    /**
     * Cleanup temporary nativelib files.
     * 
     * It has been proved that when the tmpFile.deleteOnExit() method is called,
     * the dynamic library file cannot be deleted after the system exits,
     * because the program is occupied, so if you want to unload the dynamic
     * library file when the program exits, you can only use hook (calling
     * private properties and private methods through reflection)
     */
    private void cleanupTmpNativeLibs() {
        getRuntime().addShutdownHook(new Thread() {
            @Override
            public void run() {
                for (File loadFile : loadLibFiles) {
                    try {
                        unloadNativeLibrary(loadFile);
                    } catch (Throwable th) {
                        log.warn(format("Failed to unload native library tmpfile: %", valueOf(loadFile.toString())), th);
                    }
                }
            }
        });
    }

    /**
     * Unload native library tmpFile.
     * 
     * @param tmpLibFile
     * @throws Exception
     * @see JVM takes up
     *      local library file reference
     */
    @SuppressWarnings("unchecked")
    private final synchronized void unloadNativeLibrary(File tmpLibFile) throws Exception {
        Field field = ClassLoader.class.getDeclaredField("nativeLibraries");
        field.setAccessible(true);
        Vector libs = (Vector) field.get(classLoader);
        Iterator it = libs.iterator();
        while (it.hasNext()) {
            Object object = it.next();
            Field[] fs = object.getClass().getDeclaredFields();
            for (int k = 0; k < fs.length; k++) {
                if (fs[k].getName().equals("name")) {
                    fs[k].setAccessible(true);
                    String libPath = fs[k].get(object).toString();
                    /**
                     * Use the canonical path, otherwise:
                     * 
                     * 
                     * C:\Users\ADMINI~1\AppData\Local\Temp\javanativelibs_Administrator\6480-1577085319527\snappyjava.dll
                     * 

                     */
                    if (new File(libPath).getCanonicalPath().equals(tmpLibFile.getCanonicalPath())) {
                        Method finalize = object.getClass().getDeclaredMethod("finalize");
                        finalize.setAccessible(true);
                        finalize.invoke(object);
                        if (!tmpLibFile.delete()) {
                            log.warn("Failed to cleanup tmp library file of: {}", tmpLibFile);
                        }
                    }
                }
            }
        }
    }

    /**
     * Assertion share native library location patterns. patterns and pattern
     * cannot be null or empty
     * 
     * @param libLocationPatterns
     */
    private void assertLibLocationPatterns(String... libLocationPatterns) {
        // Check location pattern.
        notNull(libLocationPatterns, "Native library location patterns can't null.");

        for (String pattern : libLocationPatterns) {
            notNull(pattern,
                    format("Native library location pattern can't null, libLocationPatterns: %s", asList(libLocationPatterns)));

            // Check filename deep hierarchy is okay?
            int libPathDeep = pattern.split("/").length;
            if (libPathDeep < NATIVE_LIBS_PATH_LEN_MIN) {
                throw new IllegalArgumentException(
                        "The filename has to be at least " + NATIVE_LIBS_PATH_LEN_MIN + " characters long.");
            }
        }

    }

    /**
     * Create or make a temporary folder under the system temporary folder
     * 
     * @param path
     * @return
     * @throws IOException
     */
    private final synchronized static File createlibsTmpDirectory0(String path) {
        File libsTmpDir = new File(JAVA_IO_TMPDIR, path);
        if (!libsTmpDir.exists()) {
            state(libsTmpDir.mkdirs(), "Failed to create tmp directory [" + libsTmpDir.getName() + "]");
        }
        return libsTmpDir;
    }

    /**
     * The minimum length a prefix for a file has to have according to
     * {@link File#createTempFile(String, String)}}.
     */
    final public static int NATIVE_LIBS_PATH_LEN_MIN = 3;

    /**
     * Java dynamic link native libraries temporary base directory path.
     */
    final public static File libNativeTmpDir = createlibsTmpDirectory0(
            File.separator + "javanativelibs_" + USER_NAME + File.separator + LOCAL_PROCESS_ID + "-" + currentTimeMillis());

    /**
     * {@link StreamResource} URL path ASC comparator.
     */
    final public static Comparator ASC_COMPARATOR = (r1, r2) -> {
        try {
            return r1.getURL().toString().compareTo(r2.getURL().toString());
        } catch (IOException e1) {
            throw new IllegalStateException(e1);
        }
    };

    /**
     * Match possible requires candidate suffixes for multiple platforms.
     */
    final public static List SUPPORTED_PLATFORM = asList(new String[] { ".so", ".dll", ".a", ".dylib" });

}    

    

    

            

    

            



    
    






    
© 2015 - 2024 Weber Informatics LLC | Privacy Policy