/*
* Copyright ThinkTank Maths Limited 2007. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are
* permitted provided that the following conditions are met:
*
* - Redistributions of source code must retain the above copyright notice, this list
* of conditions and the following disclaimer.
*
* - Redistributions in binary form must reproduce the above copyright notice, this
* list of conditions and the following disclaimer listed in this license in the
* documentation and/or other materials provided with the distribution.
*
* - Neither the name of the copyright holders nor the names of its contributors may
* be used to endorse or promote products derived from this software without specific
* prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
* THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
* THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.netlib.utils;
import java.io.File;
/**
* Static helper methods for dealing with the Java Native Interface and detection of
* operating systems and architectures. The main purpose of this class is to provide a
* more portable alternative to the System.loadLibrary method (and horrible syntax of
* Bundle-NativeCode in MANIFEST files) when bundling binaries as part of a jar (either
* inside, or in a directory structure nearby).
*
* Note on usage: unfortunately it is not possible to provide a loadLibrary(String) method
* here as it needs to know the calling class, which is lost when wrapped here. To load a
* native library using this class, call the getPortableLibraryName() method to return a
* String which may then be passed to System.loadLibrary().
*
* Note: due to the nature of this class, a portable JUnit TestCase is not possible.
*
* @author Samuel Halliday
*/
public final class JNIMethods {
/**
* Enumeration of common CPU architectures.
*/
public enum ARCHType {
PPC, PPC_64, SPARC, UNKNOWN, X86, X86_64
};
/**
* Enumeration of common operating systems, independent of version or architecture.
*/
public enum OSType {
APPLE, LINUX, SUN, UNKNOWN, WINDOWS
};
/**
* Stores the CPU Architecture the JVM is currently running on.
*/
public static final ARCHType ARCH = calculateArch();
/**
* Stores the operating system the JVM is currently running on.
*/
public static final OSType OS = calculateOS();
/**
* The System.mapLibraryName method is broken in the sense that it does not give
* unique names for operating systems and architectures. In order to facilitate
* cross-platform compatibility allowing bundled binary files, this method will return
* a unique library name, dependent on the operating system and architecture. The
* return value of this method should be passed to the System.loadLibrary method
* instead of the raw library name.
*
* The resulting filename will be constructed by forcing the library name to lowercase
* and appending an extra String that is defined by the operating system (the
* architecture is only encoded if it is relevant). Some examples are for the
* parameter 'name':-
*
* - Apple (G3, G4): "name-apple-ppc"
* - Apple (G5): "name-apple-ppc_64"
* - Apple (Intel): "name-apple-x86"
* - Apple (Intel 64 Bit mode): "name-apple-x86_64"
* - Linux (i686): "name-linux-x86"
* - Linux (Intel/AMD 64): "name-linux-x86_64"
* - Linux (sparc): "name-linux-sparc"
* - Linux (PPC 32 bit): "name-linux-ppc"
* - Linux (PPC 64 bit): "name-linux-ppc_64"
* - Windows XP/Vista (i686): "name-windows-x86"
* - Windows XP/Vista (Intel/AMD 64): "name-windows-x86_64"
* - Sun Solaris (Blade): "name-sun-sparc"
* - Sun Solaris (Intel 64 bit): "name-sun-x86_64"
*
*
* @param name
* @return
* @throws IllegalArgumentException
* if the input name is zero length or contains a directory separator
* character.
*/
public static String getPortableLibraryName(String name) {
if (name == null)
throw new NullPointerException();
if ((name.length() == 0) || name.contains(File.separator) || name.
contains("/"))
throw new IllegalArgumentException(
"Directory separator should not appear in library name: " + name);
return name.toLowerCase() + getSuffix();
}
public static void main(String[] args) {
System.out.println(JNIMethods.OS + ", " + JNIMethods.ARCH + ", " +
getPortableLibraryName("NAME"));
}
private static ARCHType calculateArch() {
String osArch = System.getProperty("os.arch").toLowerCase();
assert osArch != null;
if (osArch.equals("i386"))
return ARCHType.X86;
if (osArch.startsWith("amd64") || osArch.startsWith("x86_64"))
return ARCHType.X86_64;
if (osArch.equals("ppc"))
return ARCHType.PPC;
if (osArch.startsWith("ppc"))
return ARCHType.PPC_64;
if (osArch.startsWith("sparc"))
return ARCHType.SPARC;
return ARCHType.UNKNOWN;
}
private static OSType calculateOS() {
String osName = System.getProperty("os.name").toLowerCase();
assert osName != null;
if (osName.startsWith("mac os x"))
return OSType.APPLE;
if (osName.startsWith("windows"))
return OSType.WINDOWS;
if (osName.startsWith("linux"))
return OSType.LINUX;
if (osName.startsWith("sun"))
return OSType.SUN;
return OSType.UNKNOWN;
}
private static String getSuffix() {
String prefix =
"-" + OS.toString().toLowerCase() + "-" + ARCH.toString().
toLowerCase();
return prefix;
}
}