Class FreeBsdOSProcess

java.lang.Object

oshi.software.common.AbstractOSProcess

oshi.software.common.os.unix.bsd.BsdOSProcess

oshi.software.common.os.unix.freebsd.FreeBsdOSProcess

All Implemented Interfaces:

OSProcess

public abstract class FreeBsdOSProcess
extends BsdOSProcess

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

Modifier and Type	Field	Description
static final String	PS_COMMAND_ARGS
static final List<BsdPsKeyword>	PS_KEYWORDS	Ordered ps columns queried for each process.

Fields inherited from class BsdOSProcess

commandLineBackup, group, groupID, involuntaryContextSwitches, majorFaults, minorFaults, residentSetSize, user, userID, voluntaryContextSwitches

Modifier and Type	Field	Description
protected String	commandLineBackup
protected String	group
protected String	groupID
protected long	involuntaryContextSwitches
protected long	majorFaults
protected long	minorFaults
protected long	residentSetSize
protected String	user
protected String	userID
protected long	voluntaryContextSwitches

Fields inherited from class AbstractOSProcess

bytesRead, bytesWritten, kernelTime, name, parentProcessID, path, priority, startTime, state, threadCount, upTime, userTime, virtualSize

Modifier and Type	Field	Description
protected long	bytesRead
protected long	bytesWritten
protected long	kernelTime
protected String	name
protected int	parentProcessID
protected String	path
protected int	priority
protected long	startTime
protected OSProcess.State	state
protected int	threadCount
protected long	upTime
protected long	userTime
protected long	virtualSize

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FreeBsdOSProcess(int pid)

Method Summary

Modifier and Type	Method	Description
List<OSThread>	getThreadDetails()	Retrieves the threads of the process and their details.
protected String	psCommandArgs()	Returns the comma-separated ps -o column list for this platform, derived from BsdOSProcess.psKeywords().
protected List<BsdPsKeyword>	psKeywords()	Returns this platform's ordered ps column keys, used both to build the ps command and to parse its output positionally.

Methods inherited from class BsdOSProcess

getAffinityMask, getArguments, getBitness, getCommandLine, getEnvironmentVariables, getGroup, getGroupID, getInvoluntaryContextSwitches, getMajorFaults, getMinorFaults, getProcessOpenFileLimit, getResidentMemory, getStateFromOutput, getUser, getUserID, getVoluntaryContextSwitches, queryArguments, queryBitness, queryEnvironmentVariables, queryStartTimeMillis, updateAttributes, updateAttributes, updateThreadCount

Modifier and Type	Method	Description
long	getAffinityMask()	Gets the process affinity mask for this process.
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.
String	getCommandLine()	Gets the process command line used to start the process, including arguments if available to be determined.
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	getInvoluntaryContextSwitches()	The number of involuntary context switches the process has made.
long	getMajorFaults()	Gets the number of major (hard) faults the process has made which have required loading a memory page from disk.
long	getMinorFaults()	Gets the number of minor (soft) faults the process has made which have not required loading a memory page from disk.
protected static long	getProcessOpenFileLimit(long processId, int index)	Parses the soft or hard open-file limit for another process from /proc/<pid>/limits.
long	getResidentMemory()	Returns the total amount of physical memory (RAM) currently mapped to the process's address space.
protected static OSProcess.State	getStateFromOutput(char stateValue)	Maps a ps single-character state to an OSProcess.State.
String	getUser()	Gets the user name of the process owner.
String	getUserID()	Gets the user id of the process owner.
long	getVoluntaryContextSwitches()	The number of voluntary context switches the process has made.
protected abstract List<String>	queryArguments()	Queries this process's argument list.
protected abstract int	queryBitness()	Queries this process's bitness (32 or 64), or 0 if unknown.
protected abstract Map<String,String>	queryEnvironmentVariables()	Queries this process's environment variables.
protected long	queryStartTimeMillis()	Returns this process's start time in epoch milliseconds, or -1 to derive it from the ps elapsed-time column.
boolean	updateAttributes()	Attempts to update process attributes.
protected boolean	updateAttributes(Map<BsdPsKeyword, String> psMap)	Populates this process's attributes from a parsed ps row.
protected void	updateThreadCount()	Populates AbstractOSProcess.threadCount for platforms whose ps output lacks an nlwp column.

Methods inherited from class AbstractOSProcess

getBytesRead, getBytesWritten, getKernelTime, getName, getParentProcessID, getPath, getPriority, getProcessCpuLoadBetweenTicks, getProcessCpuLoadCumulative, getProcessID, getStartTime, getState, getThreadCount, getUpTime, getUserTime, getVirtualSize, toString

Modifier and Type	Method	Description
long	getBytesRead()	Gets the bytes read by the process.
long	getBytesWritten()	Gets the bytes written by the process.
long	getKernelTime()	Gets kernel/system (privileged) time used by the process.
String	getName()	Gets the name of the process, often the executable program.
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.
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.
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.
long	getUpTime()	Gets up time / elapsed time since the process started.
long	getUserTime()	Gets user time used by the process.
long	getVirtualSize()	Gets the Virtual Memory Size (VSZ).
String	toString()

Methods inherited from class Object

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

Methods inherited from interface OSProcess

getContextSwitches, getCurrentWorkingDirectory, getHardOpenFileLimit, getOpenFiles, getPrivateResidentMemory, getSoftOpenFileLimit

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.
String	getCurrentWorkingDirectory()	Makes a best effort attempt to obtain the current working directory for the process.
long	getHardOpenFileLimit()	Gets the hard limit for open file handles (or network connections) that belong to the given process.
long	getOpenFiles()	Gets the number of open file handles (or network connections) that belongs to the process.
default long	getPrivateResidentMemory()	Returns an estimate of the portion of physical memory (RAM) uniquely attributed to this process.
long	getSoftOpenFileLimit()	Gets the soft limit for open file handles (or network connections) of the given process.

Field Details

PS_KEYWORDS

public static final List<BsdPsKeyword> PS_KEYWORDS

Ordered ps columns queried for each process. Shared by the FreeBsdOSProcess subclasses (JNA/FFM) and the FreeBSD OperatingSystem classes so the column list and parsing stay in lockstep. ARGS must remain last.

PS_COMMAND_ARGS

public static final String PS_COMMAND_ARGS

Constructor Details

FreeBsdOSProcess

protected FreeBsdOSProcess(int pid)

Method Details

psKeywords

protected List<BsdPsKeyword> psKeywords()

Description copied from class: BsdOSProcess

Returns this platform's ordered ps column keys, used both to build the ps command and to parse its output positionally.

Specified by:

psKeywords in class BsdOSProcess

Returns:

the ordered column keys

psCommandArgs

protected String psCommandArgs()

Description copied from class: BsdOSProcess

Returns the comma-separated ps -o column list for this platform, derived from BsdOSProcess.psKeywords().

Specified by:

psCommandArgs in class BsdOSProcess

Returns:

the ps column argument

getThreadDetails

public List<OSThread> getThreadDetails()

Description copied from interface: OSProcess

Retrieves the threads of the process and their details.

The amount of returned information is operating-system dependent and may incur some latency.

Returns:

a list of threads