com.facebook.soloader

Class DirectorySoSource

java.lang.Object

com.facebook.soloader.SoSource

com.facebook.soloader.DirectorySoSource

Direct Known Subclasses:

UnpackingSoSource

public class DirectorySoSource
extends SoSource

SoSource that finds shared libraries in a given directory.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ON_LD_LIBRARY_PATH
static int	RESOLVE_DEPENDENCIES

Fields inherited from class com.facebook.soloader.SoSource

LOAD_FLAG_ALLOW_IMPLICIT_PROVISION, LOAD_FLAG_ALLOW_SOURCE_CHANGE, LOAD_FLAG_MIN_CUSTOM_FLAG, LOAD_RESULT_CORRUPTED_LIB_FILE, LOAD_RESULT_IMPLICITLY_PROVIDED, LOAD_RESULT_LOADED, LOAD_RESULT_NOT_FOUND, PREPARE_FLAG_ALLOW_ASYNC_INIT, PREPARE_FLAG_FORCE_REFRESH

Constructor Summary

Constructors

Constructor and Description
DirectorySoSource(java.io.File soDirectory, int flags) Make a new DirectorySoSource.
DirectorySoSource(java.io.File soDirectory, int flags, java.lang.String[] denyList) This method is similar to DirectorySoSource(File, int), with the following differences:

Method Summary

Modifier and Type	Method and Description
void	addToLdLibraryPath(java.util.Collection<java.lang.String> paths) Add an element to an LD_LIBRARY_PATH under construction.
java.lang.String[]	getLibraryDependencies(java.lang.String soName) Gets the dependencies of a library if it is found on this SoSource
java.lang.String	getLibraryPath(java.lang.String soName) Gets the full path of a library if it is found on this SoSource.
int	loadLibrary(java.lang.String soName, int loadFlags, StrictMode.ThreadPolicy threadPolicy) Load a shared library library into this process.
java.lang.String	toString() Return the class name of the actual instance.
java.io.File	unpackLibrary(java.lang.String soName) Ensure that a shared library exists on disk somewhere.

Methods inherited from class com.facebook.soloader.SoSource

getSoSourceAbis

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

RESOLVE_DEPENDENCIES

public static final int RESOLVE_DEPENDENCIES

See Also:

Constant Field Values

ON_LD_LIBRARY_PATH

public static final int ON_LD_LIBRARY_PATH

See Also:

Constant Field Values

Constructor Detail

DirectorySoSource

public DirectorySoSource(java.io.File soDirectory,
                         int flags)

Make a new DirectorySoSource. If flags contains RESOLVE_DEPENDENCIES, recursively load dependencies for shared objects loaded from this directory. (We shouldn't need to resolve dependencies for libraries loaded from system directories: the dynamic linker is smart enough to do it on its own there.)

DirectorySoSource

public DirectorySoSource(java.io.File soDirectory,
                         int flags,
                         java.lang.String[] denyList)

This method is similar to DirectorySoSource(File, int), with the following differences:

Parameters:

denyList - the soname list that we won't try to load from this source

Method Detail

loadLibrary

public int loadLibrary(java.lang.String soName,
                       int loadFlags,
                       StrictMode.ThreadPolicy threadPolicy)
                throws java.io.IOException

Description copied from class: SoSource

Load a shared library library into this process. This routine is independent of SoSource.loadLibrary(java.lang.String, int, StrictMode.ThreadPolicy).

Specified by:

loadLibrary in class SoSource

Parameters:

soName - Name of library to load

loadFlags - Zero or more of the LOAD_FLAG_XXX constants.

Returns:

One of the LOAD_RESULT_XXX constants.

Throws:

java.io.IOException

getLibraryPath

public java.lang.String getLibraryPath(java.lang.String soName)
                                throws java.io.IOException

Description copied from class: SoSource

Gets the full path of a library if it is found on this SoSource.

Overrides:

getLibraryPath in class SoSource

Parameters:

soName - the full file name of the library

Returns:

the full path of a library if it is found on this SoSource, null otherwise.

Throws:

java.io.IOException - if there is an error calculating soFileName's canonical path

getLibraryDependencies

public java.lang.String[] getLibraryDependencies(java.lang.String soName)
                                          throws java.io.IOException

Description copied from class: SoSource

Gets the dependencies of a library if it is found on this SoSource

Overrides:

getLibraryDependencies in class SoSource

Parameters:

soName - Name of library to inspect

Returns:

An array of library names upon which soName needs for linking

Throws:

java.io.IOException - if soName is found but there is an error reading it

unpackLibrary

public java.io.File unpackLibrary(java.lang.String soName)
                           throws java.io.IOException

Description copied from class: SoSource

Ensure that a shared library exists on disk somewhere. This routine is independent of SoSource.loadLibrary(java.lang.String, int, StrictMode.ThreadPolicy).

Specified by:

unpackLibrary in class SoSource

Parameters:

soName - Name of library to load

Returns:

File if library found; null if not.

Throws:

java.io.IOException

addToLdLibraryPath

public void addToLdLibraryPath(java.util.Collection<java.lang.String> paths)

Description copied from class: SoSource

Add an element to an LD_LIBRARY_PATH under construction.

Overrides:

addToLdLibraryPath in class SoSource

Parameters:

paths - Collection of paths to which to add

toString

public java.lang.String toString()

Description copied from class: SoSource

Return the class name of the actual instance. Useful for debugging.

Overrides:

toString in class SoSource

Returns:

the instance class name