Class LinuxOperatingSystemJNA

java.lang.Object

oshi.software.common.AbstractOperatingSystem

oshi.software.common.os.linux.LinuxOperatingSystem

oshi.software.os.linux.LinuxOperatingSystemJNA

All Implemented Interfaces:

OperatingSystem

@ThreadSafe
public class LinuxOperatingSystemJNA
extends LinuxOperatingSystem

JNA-based Linux operating system implementation. Extends LinuxOperatingSystem, providing JNA implementations of process/thread ID queries and thread count via sysinfo.

Nested Class Summary

Nested classes/interfaces inherited from interface OperatingSystem

OperatingSystem.OSVersionInfo, OperatingSystem.ProcessFiltering, OperatingSystem.ProcessSorting

Modifier and Type	Interface	Description
static class	OperatingSystem.OSVersionInfo	A class representing the Operating System version details.
static final class	OperatingSystem.ProcessFiltering	Constants which may be used to filter Process lists in OperatingSystem.getProcesses(Predicate, Comparator, int), OperatingSystem.getChildProcesses(int, Predicate, Comparator, int), and OperatingSystem.getDescendantProcesses(int, Predicate, Comparator, int).
static final class	OperatingSystem.ProcessSorting	Constants which may be used to sort Process lists in OperatingSystem.getProcesses(Predicate, Comparator, int), OperatingSystem.getChildProcesses(int, Predicate, Comparator, int), and OperatingSystem.getDescendantProcesses(int, Predicate, Comparator, int).

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	HAS_GETTID	This static field identifies if the gettid function is in the c library.
static final boolean	HAS_SYSCALL_GETTID	This static field identifies if the syscall for gettid returns sane results.
static final boolean	HAS_UDEV	This static field identifies if the udev library can be loaded.

Fields inherited from class AbstractOperatingSystem

USE_WHO_COMMAND

Modifier and Type	Field	Description
protected static final boolean	USE_WHO_COMMAND	Whether to use the 'who' command for session queries.

Constructor Summary

Constructors

Constructor	Description
LinuxOperatingSystemJNA()

Method Summary

Modifier and Type	Method	Description
protected OSProcess	createOSProcess(int pid)	Creates an OS process for the given PID.
FileSystem	getFileSystem()	Instantiates a FileSystem object.
long	getHz()	Gets Jiffies per second, useful for converting ticks to milliseconds and vice versa.
NetworkParams	getNetworkParams()	Instantiates a NetworkParams object.
long	getPageSize()	Gets Page Size, for converting memory stats from pages to bytes
OSProcess	getProcess(int pid)	Gets information on a currently running process
int	getProcessId()	Gets the current process ID (PID).
List<OSSession>	getSessions()	Gets currently logged in users.
int	getThreadCount()	Get the number of threads currently running
int	getThreadId()	Makes a best effort to get the current thread ID (TID).
static long	hz()	Gets Jiffies per second, useful for converting ticks to milliseconds and vice versa.
static long	pageSize()	Gets Page Size, for converting memory stats from pages to bytes.

Methods inherited from class LinuxOperatingSystem

getBootTime, getCgroupInfo, getCurrentThread, getInstalledApplications, getInternetProtocolStats, getParentPidsFromProcFiles, getProcessCount, getReleaseFilename, getServices, getSystemBootTime, getSystemUptime, queryAllProcesses, queryBitness, queryChildProcesses, queryDescendantProcesses, queryFamilyVersionInfo, queryManufacturer

Modifier and Type	Method	Description
static long	getBootTime()	Gets the system boot time in seconds since the epoch.
CgroupInfo	getCgroupInfo()	Retrieves cgroup information for the current process.
OSThread	getCurrentThread()	Makes a best effort to get the current thread.
List<ApplicationInfo>	getInstalledApplications()	Retrieves a list of installed applications on the system.
InternetProtocolStats	getInternetProtocolStats()	Instantiates a InternetProtocolStats object.
protected static Map<Integer,Integer>	getParentPidsFromProcFiles(File[] pidFiles)	Gets parent PIDs from proc filesystem files.
int	getProcessCount()	Get the number of processes currently running
protected static String	getReleaseFilename()	Looks for a collection of possible distrib-release filenames
List<OSService>	getServices()	Gets the all services on the system.
long	getSystemBootTime()	Get Unix time of boot.
long	getSystemUptime()	Get the System up time (time since boot).
List<OSProcess>	queryAllProcesses()	Queries all processes on the system.
protected int	queryBitness(int jvmBitness)	Backup OS-specific query to determine bitness if previous checks fail
List<OSProcess>	queryChildProcesses(int parentPid)	Queries the children of a process.
List<OSProcess>	queryDescendantProcesses(int parentPid)	Queries the descendants of a process.
Pair<String, OperatingSystem.OSVersionInfo>	queryFamilyVersionInfo()	Queries the OS family and version info.
String	queryManufacturer()	Queries the OS manufacturer.

Methods inherited from class AbstractOperatingSystem

getBitness, getChildProcesses, getChildrenOrDescendants, getChildrenOrDescendants, getDescendantProcesses, getDesktopWindows, getFamily, getManufacturer, getProcesses, getVersionInfo, isElevated, toString

Modifier and Type	Method	Description
int	getBitness()	Gets the bitness (32 or 64) of the operating system.
List<OSProcess>	getChildProcesses(int parentPid, Predicate<OSProcess> filter, Comparator<OSProcess> sort, int limit)	Gets currently running child processes of provided parent PID, optionally filtering, sorting, and limited to the top "N".
protected static Set<Integer>	getChildrenOrDescendants(Collection<OSProcess> allProcs, int parentPid, boolean allDescendants)	Utility method for subclasses to take a full process list as input and return the children or descendants of a particular process.
protected static Set<Integer>	getChildrenOrDescendants(Map<Integer,Integer> parentPidMap, int parentPid, boolean allDescendants)	Utility method for subclasses to take a map of pid to parent as input and return the children or descendants of a particular process.
List<OSProcess>	getDescendantProcesses(int parentPid, Predicate<OSProcess> filter, Comparator<OSProcess> sort, int limit)	Gets currently running processes of provided parent PID's descendants, including their children, the children's children, etc., optionally filtering, sorting, and limited to the top "N".
List<OSDesktopWindow>	getDesktopWindows(boolean visibleOnly)	Gets windows on the operating system's GUI desktop.
String	getFamily()	Get the Operating System family.
String	getManufacturer()	Get the Operating System manufacturer.
List<OSProcess>	getProcesses(Predicate<OSProcess> filter, Comparator<OSProcess> sort, int limit)	Gets currently running processes, optionally filtering, sorting, and limited to the top "N".
OperatingSystem.OSVersionInfo	getVersionInfo()	Get Operating System version information.
boolean	isElevated()	Determine whether the current process has elevated permissions such as sudo / Administrator
String	toString()

Methods inherited from class Object

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

Methods inherited from interface OperatingSystem

getCurrentProcess, getProcesses, getProcesses

Modifier and Type	Method	Description
default OSProcess	getCurrentProcess()	Gets the current process.
default List<OSProcess>	getProcesses()	Gets currently running processes.
default List<OSProcess>	getProcesses(Collection<Integer> pids)	Gets information on a Collection of currently running processes.

Field Details

HAS_UDEV

public static final boolean HAS_UDEV

This static field identifies if the udev library can be loaded.

HAS_GETTID

public static final boolean HAS_GETTID

This static field identifies if the gettid function is in the c library.

HAS_SYSCALL_GETTID

public static final boolean HAS_SYSCALL_GETTID

This static field identifies if the syscall for gettid returns sane results.

Constructor Details

LinuxOperatingSystemJNA

public LinuxOperatingSystemJNA()

Method Details

getSessions

public List<OSSession> getSessions()

Description copied from interface: OperatingSystem

Gets currently logged in users.

On macOS, Linux, and Unix systems, the default implementation uses native code (see man getutxent) that is not thread safe. OSHI's use of this code is synchronized and may be used in a multi-threaded environment without introducing any additional conflicts. Users should note, however, that other operating system code may access the same native code.

The Who#queryWho() method produces similar output parsing the output of the Posix-standard who command, and may internally employ reentrant code on some platforms. Users may opt to use this command-line variant by default using the oshi.os.unix.whocommand configuration property.

Specified by:

getSessions in interface OperatingSystem

Overrides:

getSessions in class AbstractOperatingSystem

Returns:

A list of OSSession objects representing logged-in users

getFileSystem

public FileSystem getFileSystem()

Description copied from interface: OperatingSystem

Instantiates a FileSystem object.

Returns:

A FileSystem object.

getNetworkParams

public NetworkParams getNetworkParams()

Description copied from interface: OperatingSystem

Instantiates a NetworkParams object.

Returns:

A NetworkParams object.

getProcess

public OSProcess getProcess(int pid)

Description copied from interface: OperatingSystem

Gets information on a currently running process

Parameters:

pid - A process ID

Returns:

An OSProcess object for the specified process id if it is running; null otherwise

createOSProcess

protected OSProcess createOSProcess(int pid)

Description copied from class: LinuxOperatingSystem

Creates an OS process for the given PID.

Specified by:

createOSProcess in class LinuxOperatingSystem

Parameters:

pid - the process ID

Returns:

the OS process

getProcessId

public int getProcessId()

Description copied from interface: OperatingSystem

Gets the current process ID (PID).

Returns:

the Process ID of the current process

getThreadId

public int getThreadId()

Description copied from interface: OperatingSystem

Makes a best effort to get the current thread ID (TID). May not be useful in a multithreaded environment. The thread ID returned may have been short lived and no longer exist.

Thread IDs on macOS are not correlated with any other Operating System output.

Returns:

the Thread ID of the current thread if known, 0 otherwise.

hz

public static long hz()

Gets Jiffies per second, useful for converting ticks to milliseconds and vice versa.

Returns:

Jiffies per second.

pageSize

public static long pageSize()

Gets Page Size, for converting memory stats from pages to bytes.

Returns:

Page Size in bytes.

getHz

public long getHz()

Description copied from class: LinuxOperatingSystem

Gets Jiffies per second, useful for converting ticks to milliseconds and vice versa.

Specified by:

getHz in class LinuxOperatingSystem

Returns:

Jiffies per second.

getPageSize

public long getPageSize()

Description copied from class: LinuxOperatingSystem

Gets Page Size, for converting memory stats from pages to bytes

Specified by:

getPageSize in class LinuxOperatingSystem

Returns:

Page Size

getThreadCount

public int getThreadCount()

Description copied from interface: OperatingSystem

Get the number of threads currently running

Returns:

The number of threads running