com.gemstone.gemfire.internal.shared

Class NativeCalls

java.lang.Object

com.gemstone.gemfire.internal.shared.NativeCalls

Direct Known Subclasses:

NativeCalls.NativeCallsGeneric

public abstract class NativeCalls
extends Object

Encapsulates native C/C++ calls via JNA. To obtain an instance of implementation for a platform, use getInstance(). This class is also referenced by ODBC/.NET drivers so it should not refer to any classes other than standard JDK or those within the same package.

Since:

7.5

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NativeCalls.NativeCallsGeneric A generic fallback implementation of NativeCalls when no JNA based implementation could be initialized (e.g.
static interface	NativeCalls.RehashServerOnSIGHUP Callback invoked when an OS-level SIGHUP signal is caught after handler has been installed by daemonize(com.gemstone.gemfire.internal.shared.NativeCalls.RehashServerOnSIGHUP).

Field Summary

Fields

Modifier and Type	Field and Description
static int	CLOCKID_MONOTONIC
static int	CLOCKID_MONOTONIC_RAW
static int	CLOCKID_PROCESS_CPUTIME_ID
static int	CLOCKID_REALTIME
static int	CLOCKID_THREAD_CPUTIME_ID
protected static int	OPT_IPPROTO_TCP
static HashSet<String>	TEST_CHK_FALLOC_DIRS For testing - to keep track of files for which fallocate happened
static HashSet<String>	TEST_NO_FALLOC_DIRS
protected static int	UNSUPPORTED_OPTION

Constructor Summary

Constructors

Constructor and Description
NativeCalls()

Method Summary

Modifier and Type	Method and Description
long	clockResolution(int clock_id)
void	daemonize(NativeCalls.RehashServerOnSIGHUP callback) Perform the steps necessary to make the current JVM a proper UNIX daemon.
abstract String	getEnvironment(String name) Get the value of given environment variable.
static NativeCalls	getInstance() Get an instance of implementation of NativeCalls for the current platform.
protected static Map<String,String>	getModifiableJavaEnv()
protected static Map<String,String>	getModifiableJavaEnvWIN()
abstract OSType	getOSType() Get the OSType of current system.
protected int	getPlatformOption(TCPSocketOptions opt)
abstract int	getProcessId() Get the process ID of the current process.
long	getSessionThreadLimit()
protected int	getSocketKernelDescriptor(Socket sock, InputStream sockStream) Get the native kernel descriptor given the java Socket.
protected String	getUnsupportedSocketOptionMessage(TCPSocketOptions opt)
boolean	isNativeTimerEnabled() whether o/s supports high resolution clock or equivalent perf counter.
protected boolean	isNoProtocolOptionCode(int errno)
boolean	isOnLocalFileSystem(String path) This will return whether the path passed in as arg is part of a local file system or a remote file system.
abstract boolean	isProcessActive(int processId) Check whether a process with given ID is still running.
boolean	isTTY()
abstract boolean	killProcess(int processId) Kill the process with given process ID immediately (i.e.
boolean	loadNativeLibrary() Indicates whether to native library using JNI is supported or not.
void	lockCurrentMemory() Locks all pages mapped into the address space of the calling process.
long	nanoTime(int clock_id) This is fall back for jni based library implementation of NanoTimer which is more efficient than current impl through jna.
void	preBlow(String path, long maxSize, boolean preAllocate)
abstract void	setCurrentWorkingDirectory(String path) Set the current working directory to the given path.
abstract void	setEnvironment(String name, String value) Set the value of an environment variable.
protected Map<TCPSocketOptions,Throwable>	setGenericSocketOptions(Socket sock, InputStream sockStream, Map<TCPSocketOptions,Object> optValueMap) A generic implementation of setSocketOptions(java.net.Socket, java.io.InputStream, java.util.Map<com.gemstone.gemfire.internal.shared.TCPSocketOptions, java.lang.Object>) for POSIX like systems that requires the child classes to implement a few platform specific methods.
protected int	setPlatformSocketOption(int sockfd, int level, int optName, TCPSocketOptions opt, Integer optVal, int optSize)
abstract Map<TCPSocketOptions,Throwable>	setSocketOptions(Socket sock, InputStream sockStream, Map<TCPSocketOptions,Object> optValueMap) Set given extended socket options on a Java Socket.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CLOCKID_REALTIME

public static final int CLOCKID_REALTIME

See Also:

Constant Field Values

CLOCKID_MONOTONIC

public static final int CLOCKID_MONOTONIC

See Also:

Constant Field Values

CLOCKID_PROCESS_CPUTIME_ID

public static final int CLOCKID_PROCESS_CPUTIME_ID

See Also:

Constant Field Values

CLOCKID_THREAD_CPUTIME_ID

public static final int CLOCKID_THREAD_CPUTIME_ID

See Also:

Constant Field Values

CLOCKID_MONOTONIC_RAW

public static final int CLOCKID_MONOTONIC_RAW

See Also:

Constant Field Values

TEST_CHK_FALLOC_DIRS

public static volatile HashSet<String> TEST_CHK_FALLOC_DIRS

For testing - to keep track of files for which fallocate happened

TEST_NO_FALLOC_DIRS

public static volatile HashSet<String> TEST_NO_FALLOC_DIRS

OPT_IPPROTO_TCP

protected static final int OPT_IPPROTO_TCP

See Also:

Constant Field Values

UNSUPPORTED_OPTION

protected static final int UNSUPPORTED_OPTION

See Also:

Constant Field Values

Constructor Detail

NativeCalls

public NativeCalls()

Method Detail

getInstance

public static NativeCalls getInstance()

Get an instance of implementation of NativeCalls for the current platform.

getModifiableJavaEnv

protected static final Map<String,String> getModifiableJavaEnv()

getModifiableJavaEnvWIN

protected static final Map<String,String> getModifiableJavaEnvWIN()

getSocketKernelDescriptor

protected int getSocketKernelDescriptor(Socket sock,
                                        InputStream sockStream)
                                 throws UnsupportedOperationException

Get the native kernel descriptor given the java Socket. This is a horribly implementation dependent code checking various cases to get to the underlying kernel socket descriptor but works for the JDK's we support or intend to support directly or indirectly (e.g. GCJ for ODBC clients).

Parameters:

sock - the java socket

sockStream - the InputStream of the java socket, if available

Throws:

UnsupportedOperationException - if the kernel descriptor could not be extracted

getUnsupportedSocketOptionMessage

protected String getUnsupportedSocketOptionMessage(TCPSocketOptions opt)

getOSType

public abstract OSType getOSType()

Get the OSType of current system.

getEnvironment

public abstract String getEnvironment(String name)

Get the value of given environment variable. This is different from System.getenv(String) in that it returns the current value of the environment variable in the process rather than from a static unmodifiable map created on the first call.

Parameters:

name - the name of the environment variable to be modified

setEnvironment

public abstract void setEnvironment(String name,
                                    String value)

Set the value of an environment variable. This modifies both the value in the process, and the cached static map maintained by JVM on the first call so further calls to System.getenv(String) will also return the modified value.

Parameters:

name - the name of the environment variable to be modified

value - the new value of the environment variable; a value of null clears the existing value

setCurrentWorkingDirectory

public abstract void setCurrentWorkingDirectory(String path)

Set the current working directory to the given path.

Parameters:

path - new working directory (preferably a full absolute path)

getProcessId

public abstract int getProcessId()

Get the process ID of the current process.

isProcessActive

public abstract boolean isProcessActive(int processId)
                                 throws UnsupportedOperationException

Check whether a process with given ID is still running.

Throws:

UnsupportedOperationException - if no native API to determine the process status could be invoked

killProcess

public abstract boolean killProcess(int processId)
                             throws UnsupportedOperationException

Kill the process with given process ID immediately (i.e. without giving it a chance to cleanup properly).

Parameters:

processId - the PID of the process to be kill

Throws:

UnsupportedOperationException - if no native API to kill the process could be invoked

daemonize

public void daemonize(NativeCalls.RehashServerOnSIGHUP callback)
               throws UnsupportedOperationException,
                      IllegalStateException

Perform the steps necessary to make the current JVM a proper UNIX daemon.

Parameters:

callback - register callback to be invoked on catching a SIGHUP signal; SIGHUP signal is ignored if the callback is null

Throws:

UnsupportedOperationException - if the native calls could not be completed for some reason or are not available

IllegalStateException - for a non-UNIX platform

preBlow

public void preBlow(String path,
                    long maxSize,
                    boolean preAllocate)
             throws IOException

Throws:

IOException

isOnLocalFileSystem

public boolean isOnLocalFileSystem(String path)

This will return whether the path passed in as arg is part of a local file system or a remote file system. This method is mainly used by the DiskCapacityMonitor thread and we don't want to monitor remote fs available space as due to network problems/firewall issues the call to getUsableSpace can hang. See bug #49155. On platforms other than Linux this will return false even if it on local file system for now.

setSocketOptions

public abstract Map<TCPSocketOptions,Throwable> setSocketOptions(Socket sock,
                                                                 InputStream sockStream,
                                                                 Map<TCPSocketOptions,Object> optValueMap)
                                                          throws UnsupportedOperationException

Set given extended socket options on a Java Socket.

Returns:

the unsupported TCPSocketOptions for the current platform and the underlying exception

Throws:

SocketException - if there was an exception setting the option on the socket

UnsupportedOperationException - if the native API to set the option could not be found or invoked

See Also:

TCPSocketOptions

lockCurrentMemory

public void lockCurrentMemory()
                       throws UnsupportedOperationException

Locks all pages mapped into the address space of the calling process. This includes the pages of the code, data and stack segment, as well as shared libraries, user space kernel data, shared memory, and memory-mapped files. All mapped pages are guaranteed to be resident in RAM when the call returns successfully; the pages are guaranteed to stay in RAM until later unlocked. See mlockall in POSIX systems.

Throws:

UnsupportedOperationException

setGenericSocketOptions

protected final Map<TCPSocketOptions,Throwable> setGenericSocketOptions(Socket sock,
                                                                        InputStream sockStream,
                                                                        Map<TCPSocketOptions,Object> optValueMap)
                                                                 throws UnsupportedOperationException

A generic implementation of setSocketOptions(java.net.Socket, java.io.InputStream, java.util.Map<com.gemstone.gemfire.internal.shared.TCPSocketOptions, java.lang.Object>) for POSIX like systems that requires the child classes to implement a few platform specific methods.

Throws:

UnsupportedOperationException

getPlatformOption

protected int getPlatformOption(TCPSocketOptions opt)
                         throws UnsupportedOperationException

Throws:

UnsupportedOperationException

setPlatformSocketOption

protected int setPlatformSocketOption(int sockfd,
                                      int level,
                                      int optName,
                                      TCPSocketOptions opt,
                                      Integer optVal,
                                      int optSize)
                               throws UnsupportedOperationException,
                                      NativeErrorException

Throws:

UnsupportedOperationException

NativeErrorException

isNoProtocolOptionCode

protected boolean isNoProtocolOptionCode(int errno)
                                  throws UnsupportedOperationException

Throws:

UnsupportedOperationException

loadNativeLibrary

public boolean loadNativeLibrary()

Indicates whether to native library using JNI is supported or not.

Returns:

true if native library is shipped along with product for this platform.

isNativeTimerEnabled

public boolean isNativeTimerEnabled()

whether o/s supports high resolution clock or equivalent perf counter.

Returns:

true if implemented, otherwise false.

nanoTime

public long nanoTime(int clock_id)

This is fall back for jni based library implementation of NanoTimer which is more efficient than current impl through jna. Linux impls create temporary timespec object and marshals that for invoking native api. Shouldn't be used if to be called too many times, instead jni implementation is more desirable.

Parameters:

clock_id -

Returns:

nanosecond precision performance counter.

clockResolution

public long clockResolution(int clock_id)

isTTY

public boolean isTTY()

getSessionThreadLimit

public long getSessionThreadLimit()