Class AixOSProcess

    • Field Detail

      • LOG

        private static final org.slf4j.Logger LOG
      • bitness

        private java.util.function.Supplier<java.lang.Integer> bitness
      • commandLine

        private java.util.function.Supplier<java.lang.String> commandLine
      • cmdEnv

        private java.util.function.Supplier<Pair<java.util.List<java.lang.String>,​java.util.Map<java.lang.String,​java.lang.String>>> cmdEnv
      • affinityMask

        private final java.util.function.Supplier<java.lang.Long> affinityMask
      • name

        private java.lang.String name
      • path

        private java.lang.String path
      • commandLineBackup

        private java.lang.String commandLineBackup
      • user

        private java.lang.String user
      • userID

        private java.lang.String userID
      • group

        private java.lang.String group
      • groupID

        private java.lang.String groupID
      • parentProcessID

        private int parentProcessID
      • threadCount

        private int threadCount
      • priority

        private int priority
      • virtualSize

        private long virtualSize
      • residentSetSize

        private long residentSetSize
      • kernelTime

        private long kernelTime
      • userTime

        private long userTime
      • startTime

        private long startTime
      • upTime

        private long upTime
      • bytesRead

        private long bytesRead
      • bytesWritten

        private long bytesWritten
      • procCpu

        private java.util.function.Supplier<com.sun.jna.platform.unix.aix.Perfstat.perfstat_process_t[]> procCpu
    • Constructor Detail

      • AixOSProcess

        public AixOSProcess​(int pid,
                            Pair<java.lang.Long,​java.lang.Long> userSysCpuTime,
                            java.util.function.Supplier<com.sun.jna.platform.unix.aix.Perfstat.perfstat_process_t[]> procCpu,
                            AixOperatingSystem os)
    • Method Detail

      • getName

        public java.lang.String getName()
        Description copied from interface: OSProcess
        Gets the name of the process, often the executable program.
        Returns:
        the name of the process.
      • getPath

        public java.lang.String getPath()
        Description copied from interface: OSProcess
        Gets the full filesystem path of the executing process.
        Returns:
        the full path of the executing process.
      • getCommandLine

        public java.lang.String getCommandLine()
        Description copied from interface: OSProcess
        Gets the process command line used to start the process, including arguments if available to be determined. This method generally returns the same information as OSProcess.getArguments() in a more user-readable format, and is more robust to non-elevated access.

        The format of this string is platform-dependent, may be truncated, and may require the end user to parse the result. Users should generally prefer OSProcess.getArguments() which already parses the results, and use this method as a backup.

        On AIX and Solaris, the string may be truncated to 80 characters if there was insufficient permission to read the process memory.

        On Windows, attempts to retrieve the value from process memory, which requires that the process be owned by the same user as the executing process, or elevated permissions, and additionally requires the target process to have the same bitness (e.g., this will fail on a 32-bit process if queried by 64-bit and vice versa). If reading process memory fails, by default, performs a single WMI query for this process, with some latency. If this method will be frequently called for multiple processes, see the configuration file to enable a batch query mode leveraging Win32ProcessCached.getCommandLine(int, long) to improve performance, or setting that parameter via GlobalConfig.set(String, Object) before instantiating any OSProcess object.

        Returns:
        the process command line.
      • queryCommandLine

        private java.lang.String queryCommandLine()
      • getArguments

        public java.util.List<java.lang.String> getArguments()
        Description copied from interface: OSProcess
        Makes a best effort attempt to get a list of the the command-line arguments of the process. Returns the same information as OSProcess.getCommandLine() but parsed to a list. May require elevated permissions or same-user ownership.
        Returns:
        A list of Strings representing the arguments. May return an empty list if there was a failure (for example, because the process is already dead or permission was denied).
      • getEnvironmentVariables

        public java.util.Map<java.lang.String,​java.lang.String> getEnvironmentVariables()
        Description copied from interface: OSProcess
        Makes a best effort attempt to obtain the environment variables of the process. May require elevated permissions or same-user ownership.
        Returns:
        A map representing the environment variables and their values. May return an empty map if there was a failure (for example, because the process is already dead or permission was denied).
      • queryCommandlineEnvironment

        private Pair<java.util.List<java.lang.String>,​java.util.Map<java.lang.String,​java.lang.String>> queryCommandlineEnvironment()
      • getCurrentWorkingDirectory

        public java.lang.String getCurrentWorkingDirectory()
        Description copied from interface: OSProcess
        Makes a best effort attempt to obtain the current working directory for the process.
        Returns:
        the process current working directory.
      • getUser

        public java.lang.String getUser()
        Description copied from interface: OSProcess
        Gets the user name of the process owner.
        Returns:
        the user name. On Windows systems, also returns the domain prepended to the username.
      • getUserID

        public java.lang.String getUserID()
        Description copied from interface: OSProcess
        Gets the user id of the process owner.
        Returns:
        the userID. On Windows systems, returns the Security ID (SID)
      • getGroup

        public java.lang.String getGroup()
        Description copied from interface: OSProcess
        Gets the group under which the process is executing.

        On Windows systems, populating this value for processes other than the current user requires administrative privileges (and still may fail for some system processes) and can incur significant latency. When successful, returns a the default primary group with access to this process, corresponding to the SID in OSProcess.getGroupID().

        Returns:
        the group.
      • getGroupID

        public java.lang.String getGroupID()
        Description copied from interface: OSProcess
        Gets the group id under which the process is executing.

        On Windows systems, populating this value for processes other than the current user requires administrative privileges (and still may fail for some system processes) and can incur significant latency. When successful, returns the default primary group SID with access to this process, corresponding to the name in OSProcess.getGroup().

        Returns:
        the groupID.
      • getState

        public OSProcess.State getState()
        Description copied from interface: OSProcess
        Gets the process state.
        Returns:
        the execution state of the process.
      • getParentProcessID

        public int getParentProcessID()
        Description copied from interface: OSProcess
        Gets the process ID of this process's parent.
        Returns:
        the parentProcessID, if any; 0 otherwise.
      • getThreadCount

        public int getThreadCount()
        Description copied from interface: OSProcess
        Gets the number of threads being executed by this process. More information is available using OSProcess.getThreadDetails().
        Returns:
        the number of threads in this process.
      • getPriority

        public int getPriority()
        Description copied from interface: OSProcess
        Gets the priority of this process.

        For Linux and Unix, priority is a value in the range -20 to 19 (20 on some systems). The default priority is 0; lower priorities cause more favorable scheduling.

        For Windows, priority values can range from 0 (lowest priority) to 31 (highest priority).

        macOS has 128 priority levels, ranging from 0 (lowest priority) to 127 (highest priority). They are divided into several major bands: 0 through 51 are the normal levels; the default priority is 31. 52 through 79 are the highest priority regular threads; 80 through 95 are for kernel mode threads; and 96 through 127 correspond to real-time threads, which are treated differently than other threads by the scheduler.

        Returns:
        the priority of this process.
      • getVirtualSize

        public long getVirtualSize()
        Description copied from interface: OSProcess
        Gets the Virtual Memory Size (VSZ). Includes all memory that the process can access, including memory that is swapped out and memory that is from shared libraries.
        Returns:
        the Virtual Memory Size
      • getResidentSetSize

        public long getResidentSetSize()
        Description copied from interface: OSProcess
        Gets the Resident Set Size (RSS). Used to show how much memory is allocated to that process and is in RAM. It does not include memory that is swapped out. It does include memory from shared libraries as long as the pages from those libraries are actually in memory. It does include all stack and heap memory.

        On Windows, returns the Private Working Set size, which should match the "Memory" column in the Windows Task Manager.

        On Linux, returns the RSS value from /proc/[pid]/stat, which may be inaccurate because of a kernel-internal scalability optimization. If accurate values are required, read /proc/[pid]/smaps using FileUtil.getKeyValueMapFromFile(String, String).

        Returns:
        the Resident Set Size
      • getKernelTime

        public long getKernelTime()
        Description copied from interface: OSProcess
        Gets kernel/system (privileged) time used by the process.
        Returns:
        the number of milliseconds the process has executed in kernel/system mode.
      • getUserTime

        public long getUserTime()
        Description copied from interface: OSProcess
        Gets user time used by the process.
        Returns:
        the number of milliseconds the process has executed in user mode.
      • getUpTime

        public long getUpTime()
        Description copied from interface: OSProcess
        Gets up time / elapsed time since the process started.
        Returns:
        the number of milliseconds since the process started.
      • getStartTime

        public long getStartTime()
        Description copied from interface: OSProcess
        Gets the process start time.
        Returns:
        the start time of the process in number of milliseconds since January 1, 1970 UTC.
      • getBytesRead

        public long getBytesRead()
        Description copied from interface: OSProcess
        Gets the bytes read by the process.

        On Solaris, includes both bytes read and written.

        Returns:
        the number of bytes the process has read from disk.
      • getBytesWritten

        public long getBytesWritten()
        Description copied from interface: OSProcess
        Gets the bytes written by the process.

        On Solaris, all IO bytes are included read bytes so this value is 0.

        Returns:
        the number of bytes the process has written to disk.
      • getOpenFiles

        public long getOpenFiles()
        Description copied from interface: OSProcess
        Gets the number of open file handles (or network connections) that belongs to the process.

        On FreeBSD and Solaris, this value is only populated if information for a single process id is requested.

        Returns:
        open files or -1 if unknown or not supported
      • getSoftOpenFileLimit

        public long getSoftOpenFileLimit()
        Description copied from interface: OSProcess
        Gets the soft limit for open file handles (or network connections) of the given process.

        Retrieving the soft limit for processes other than the calling process is only supported on Linux, FreeBsd and Solaris.

        Returns:
        the soft open file limit for the process if available. Returns -1 if the calling process is not the same as this OSProcess instance and the underlying operating system does not support retrieving the soft limit for other processes.
      • getHardOpenFileLimit

        public long getHardOpenFileLimit()
        Description copied from interface: OSProcess
        Gets the hard limit for open file handles (or network connections) that belong to the given process.

        Retrieving the hard limit for processes other than the calling process is only supported on Linux, FreeBsd and Solaris.

        Returns:
        the hard open file limit for the process if available. Returns -1 if the calling process is not the same as this OSProcess instance and the underlying operating system does not support retrieving the hard limit for other processes.
      • getBitness

        public int getBitness()
        Description copied from interface: OSProcess
        Attempts to get the bitness (32 or 64) of the process.
        Returns:
        The bitness, if able to be determined, 0 otherwise.
      • queryBitness

        private int queryBitness()
      • 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.
      • getThreadDetails

        public java.util.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
      • 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

        private boolean updateAttributes​(Pair<java.lang.Long,​java.lang.Long> userSysCpuTime)
      • getStateFromOutput

        static OSProcess.State getStateFromOutput​(char stateValue)
        Returns Enum STATE for the state value obtained from status string of thread/process.
        Parameters:
        stateValue - state value from the status string
        Returns:
        The state