Class WindowsOSProcessJNA

java.lang.Object

oshi.software.common.AbstractOSProcess

oshi.software.common.os.windows.WindowsOSProcess

oshi.software.os.windows.WindowsOSProcessJNA

All Implemented Interfaces:

OSProcess

@ThreadSafe
public class WindowsOSProcessJNA
extends WindowsOSProcess

JNA-based Windows OS process implementation.

Nested Class Summary

Nested classes/interfaces inherited from interface OSProcess

OSProcess.State

Modifier and Type	Interface	Description
static enum	OSProcess.State	Process and Thread Execution States

Field Summary

Fields inherited from class WindowsOSProcess

MAX_WINDOWS_HANDLES, USE_BATCH_COMMANDLINE, USE_PROCSTATE_SUSPENDED

Modifier and Type	Field	Description
protected static final long	MAX_WINDOWS_HANDLES	Maximum number of handles per process, accounting for 32-bit vs 64-bit Windows.
protected static final boolean	USE_BATCH_COMMANDLINE	Whether to use batch WMI queries for command line retrieval.
protected static final boolean	USE_PROCSTATE_SUSPENDED	Whether to check thread states to determine if a process is suspended.

Constructor Summary

Constructors

Constructor	Description
WindowsOSProcessJNA(int pid, WindowsOperatingSystemJNA os, Map<Integer, ProcessPerfCounterBlock> processMap, Map<Integer,WtsInfo> processWtsMap, Map<Integer, ThreadPerfCounterBlock> threadMap)

Method Summary

Modifier and Type	Method	Description
protected OSThread	createOSThread(int pid, int tid, String procName, ThreadPerfCounterBlock pcb)	Creates a platform-specific OS thread instance.
long	getAffinityMask()	Gets the process affinity mask for this process.
protected List<String>	queryArguments()	Queries the argument list for this process.
protected String	queryCommandLine()	Queries the command line for this process.
protected Triplet<String, String, Map<String,String>>	queryCwdCommandlineEnvironment()	Queries the current working directory, command line, and environment variables from process memory.
protected Pair<String,String>	queryGroupInfo()	Queries group account information for this process.
protected Map<Integer, ThreadPerfCounterBlock>	queryMatchingThreads(Set<Integer> pids)	Queries thread performance data matching the given process IDs.
protected Pair<String,String>	queryUserInfo()	Queries user account information for this process.
boolean	updateAttributes()	Attempts to update process attributes.
protected boolean	updateAttributes(ProcessPerfCounterBlock pcb, WtsInfo wts)	Updates process attributes from performance counter and WTS data, then performs native-specific updates.

Methods inherited from class WindowsOSProcess

defaultCwdCommandlineEnvironment, defaultPair, getArguments, getBitness, getBytesRead, getBytesWritten, getCommandLine, getCurrentWorkingDirectory, getCwdCmdEnv, getEnvironmentVariables, getGroup, getGroupID, getHardOpenFileLimit, getKernelTime, getMinorFaults, getName, getOpenFiles, getOs, getParentProcessID, getPath, getPriority, getPrivateResidentMemory, getResidentMemory, getSoftOpenFileLimit, getStartTime, getState, getThreadCount, getThreadDetails, getUpTime, getUser, getUserID, getUserTime, getVirtualSize, setBitness, setName, setPath, setState, setTcb

Modifier and Type	Method	Description
protected static Triplet<String, String, Map<String,String>>	defaultCwdCommandlineEnvironment()	Returns a default empty triplet for cwd, command line, and environment.
protected static Pair<String,String>	defaultPair()	Returns a default pair of unknown values.
List<String>	getArguments()	Makes a best effort attempt to get a list of the the command-line arguments of the process.
int	getBitness()	Attempts to get the bitness (32 or 64) of the process.
long	getBytesRead()	Gets the bytes read by the process.
long	getBytesWritten()	Gets the bytes written by the process.
String	getCommandLine()	Gets the process command line used to start the process, including arguments if available to be determined.
String	getCurrentWorkingDirectory()	Makes a best effort attempt to obtain the current working directory for the process.
protected Triplet<String, String, Map<String,String>>	getCwdCmdEnv()	Returns the memoized CWD/CommandLine/Environment triplet.
Map<String,String>	getEnvironmentVariables()	Makes a best effort attempt to obtain the environment variables of the process.
String	getGroup()	Gets the group under which the process is executing.
String	getGroupID()	Gets the group id under which the process is executing.
long	getHardOpenFileLimit()	Gets the hard limit for open file handles (or network connections) that belong to the given process.
long	getKernelTime()	Gets kernel/system (privileged) time used by the process.
long	getMinorFaults()	Gets the number of minor (soft) faults the process has made which have not required loading a memory page from disk.
String	getName()	Gets the name of the process, often the executable program.
long	getOpenFiles()	Gets the number of open file handles (or network connections) that belongs to the process.
protected OperatingSystem	getOs()	Returns the OperatingSystem instance associated with this process.
int	getParentProcessID()	Gets the process ID of this process's parent.
String	getPath()	Gets the full filesystem path of the executing process.
int	getPriority()	Gets the priority of this process.
long	getPrivateResidentMemory()	Returns an estimate of the portion of physical memory (RAM) uniquely attributed to this process.
long	getResidentMemory()	Returns the total amount of physical memory (RAM) currently mapped to the process's address space.
long	getSoftOpenFileLimit()	Gets the soft limit for open file handles (or network connections) of the given process.
long	getStartTime()	Gets the process start time.
OSProcess.State	getState()	Gets the process state.
int	getThreadCount()	Gets the number of threads being executed by this process.
List<OSThread>	getThreadDetails()	Retrieves the threads of the process and their details.
long	getUpTime()	Gets up time / elapsed time since the process started.
String	getUser()	Gets the user name of the process owner.
String	getUserID()	Gets the user id of the process owner.
long	getUserTime()	Gets user time used by the process.
long	getVirtualSize()	Gets the Virtual Memory Size (VSZ).
protected void	setBitness(int bitness)	Sets the process bitness.
protected void	setName(String name)	Sets the process name.
protected void	setPath(String path)	Sets the process executable path.
protected void	setState(OSProcess.State state)	Sets the process state.
protected void	setTcb(Map<Integer, ThreadPerfCounterBlock> tcb)	Sets the thread counter block map.

Methods inherited from class AbstractOSProcess

getProcessCpuLoadBetweenTicks, getProcessCpuLoadCumulative, getProcessID, toString

Modifier and Type	Method	Description
double	getProcessCpuLoadBetweenTicks(OSProcess priorSnapshot)	Gets CPU usage of this process since a previous snapshot of the same process, provided as a parameter.
double	getProcessCpuLoadCumulative()	Gets cumulative CPU usage of this process.
int	getProcessID()	Gets the process ID.
String	toString()

Methods inherited from class Object

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

Methods inherited from interface OSProcess

getContextSwitches, getInvoluntaryContextSwitches, getMajorFaults, getVoluntaryContextSwitches

Modifier and Type	Method	Description
default long	getContextSwitches()	A snapshot of the context switches the process has done, equal to the sum of OSProcess.getVoluntaryContextSwitches() and OSProcess.getInvoluntaryContextSwitches() on platforms that provide the split.
default long	getInvoluntaryContextSwitches()	The number of involuntary context switches the process has made.
default long	getMajorFaults()	Gets the number of major (hard) faults the process has made which have required loading a memory page from disk.
default long	getVoluntaryContextSwitches()	The number of voluntary context switches the process has made.

Constructor Details

WindowsOSProcessJNA

public WindowsOSProcessJNA(int pid,
 WindowsOperatingSystemJNA os,
 Map<Integer, ProcessPerfCounterBlock> processMap,
 Map<Integer,WtsInfo> processWtsMap,
 Map<Integer, ThreadPerfCounterBlock> threadMap)

Method Details

getAffinityMask

public long getAffinityMask()

Description copied from interface: OSProcess

Gets the process affinity mask for this process.

On Windows systems with more than 64 processors, if the threads of the calling process are in a single processor group, returns the process affinity mask for that group (which may be zero if the specified process is running in a different group). If the calling process contains threads in multiple groups, returns zero.

Because macOS does not export interfaces that identify processors or control thread placement, explicit thread to processor binding is not supported and this method will return a bitmask of all logical processors.

If the Operating System fails to retrieve an affinity mask (e.g., the process has terminated), returns zero.

Returns:

a bit vector in which each bit represents the processors that a process is allowed to run on.

updateAttributes

public boolean updateAttributes()

Description copied from interface: OSProcess

Attempts to update process attributes. Returns false if the update fails, which will occur if the process no longer exists.

Returns:

true if the update was successful, false if the update failed. In addition, on a failed update the process state will be changed to OSProcess.State.INVALID.

updateAttributes

protected boolean updateAttributes(ProcessPerfCounterBlock pcb,
 WtsInfo wts)

Description copied from class: WindowsOSProcess

Updates process attributes from performance counter and WTS data, then performs native-specific updates. Subclasses should call super.updateAttributes(pcb, wts) and then perform native handle-based updates.

Overrides:

updateAttributes in class WindowsOSProcess

Parameters:

pcb - Performance counter block for this process, or null if unavailable

wts - WTS info for this process, or null if unavailable

Returns:

true if the process is valid after the update

createOSThread

protected OSThread createOSThread(int pid,
 int tid,
 String procName,
 ThreadPerfCounterBlock pcb)

Description copied from class: WindowsOSProcess

Creates a platform-specific OS thread instance.

Specified by:

createOSThread in class WindowsOSProcess

Parameters:

pid - the owning process ID

tid - the thread ID

procName - the process name

pcb - the thread performance counter block

Returns:

a new OSThread instance

queryMatchingThreads

protected Map<Integer, ThreadPerfCounterBlock> queryMatchingThreads(Set<Integer> pids)

Description copied from class: WindowsOSProcess

Queries thread performance data matching the given process IDs.

Specified by:

queryMatchingThreads in class WindowsOSProcess

Parameters:

pids - the set of process IDs to match

Returns:

a map of thread ID to thread performance counter block

queryCommandLine

protected String queryCommandLine()

Description copied from class: WindowsOSProcess

Queries the command line for this process.

Specified by:

queryCommandLine in class WindowsOSProcess

Returns:

the command line string

queryArguments

protected List<String> queryArguments()

Description copied from class: WindowsOSProcess

Queries the argument list for this process.

Specified by:

queryArguments in class WindowsOSProcess

Returns:

the list of arguments

queryUserInfo

protected Pair<String,String> queryUserInfo()

Description copied from class: WindowsOSProcess

Queries user account information for this process.

Specified by:

queryUserInfo in class WindowsOSProcess

Returns:

a pair of (account name, SID string)

queryGroupInfo

protected Pair<String,String> queryGroupInfo()

Description copied from class: WindowsOSProcess

Queries group account information for this process.

Specified by:

queryGroupInfo in class WindowsOSProcess

Returns:

a pair of (group name, SID string)

queryCwdCommandlineEnvironment

protected Triplet<String, String, Map<String,String>> queryCwdCommandlineEnvironment()

Description copied from class: WindowsOSProcess

Queries the current working directory, command line, and environment variables from process memory.

Specified by:

queryCwdCommandlineEnvironment in class WindowsOSProcess

Returns:

a triplet of (cwd, commandLine, environmentVariables)