 |
OpenVMS System Services Reference Manual
The JPI$_GETJPI_CONTROL_FLAGS item code includes the following flags:
| Flag |
Description |
|
JPI$M_NO_TARGET_INSWAP
|
Does not retrieve a process that has been swapped out of the balance
set. This control flag is used to avoid adding the load of swapping
processes into a system. By using this control flag and requesting
information from a process that has been swapped out, the following
occurs:
- Any data stored in the virtual address space of the process is not
accessible.
- Any data stored in the process header (PHD) might not be accessible.
- Any data stored in resident data structures, such as the process
control block (PCB) or the job information block (JIB), is accessible.
You must examine the return length of an item to verify that the
item was retrieved.
|
|
JPI$M_NO_TARGET_AST
|
Does not deliver a kernel mode AST to the target process. This control
flag is used to avoid executing a target process to retrieve
information. By using this control flag and not delivering an AST to a
target process, the following occurs:
- Any data stored in the virtual address space of the process is not
accessible.
- Any data stored in system data structures, such as the process
header (PHD), the process control block (PCB), or the job information
block (JIB), is accessible.
You must examine the return length of an item to verify that the
item was retrieved.
The use of this control flag also implies that $GETJPI does not
swap in a process, because $GETJPI would only bring a process into
memory to deliver an AST to that process.
|
|
JPI$M_IGNORE_TARGET_STATUS
|
Attempts to retrieve as much information as possible, even though the
process might be suspended or is being deleted. This control flag is
used to retrieve all possible information from a process.
|
|
JPI$M_THREAD
|
Sets the wildcard mode to return information on all of the process's
kernel threads beginning with the initial kernel thread.
|
JPI$_GPGCNT
Returns, in pages (on VAX systems) or pagelets (on Alpha systems), the
process's global page count in the working set, which is a longword
integer value.
JPI$_GRP
Returns, as a longword integer value, the group number of the process's
UIC.
JPI$_HOME_RAD
Returns the home resource affinity domain (RAD).
Note: OpenVMS support for RADs is available only on the new AlphaServer GS series systems. For more information about using RADs, refer to the OpenVMS Alpha Partitioning and Galaxy Guide.
JPI$_IMAGECOUNT
Returns, as a longword integer value, the number of images that have
been run down for the process.
JPI$_IMAGE_RIGHTS
Returns the binary content of the image rights list as an array of
quadword identifiers. Each entry consists of a longword identifier
value and longword identifier attributes, as shown in Table SYS-13.
The image rights list is a set of identifiers associated with a
protected subsystem image. When a process runs a protected subsystem,
the subsystem rights are automatically added to the process's image
rights list. These identifiers are subsequently removed during image
rundown. Allocate a buffer that is sufficient to hold the image rights
list, because $GETJPI returns only as much of the list as will fit in
the buffer.
Table SYS-13 Attributes of an Identifier
| Symbolic Name |
Description |
|
KGB$M_DYNAMIC
|
Identifier can be enabled or disabled.
|
|
+KGB$M_NOACCESS
|
Rights of the identifier are null and void.
|
|
KGB$M_RESOURCE
|
Resources can be charged to the identifier.
|
|
+KGB$M_SUBSYSTEM
|
Identifier can be used to create protected subsystems.
|
+VAX specific
JPI$_IMAGNAME
Returns, as a character string, the directory specification and the
image file name.
JPI$_IMAGPRIV
Returns a quadword mask of the privileges with which the current image
was installed. If the current image was not installed, $GETJPI returns
the value 0 in the buffer.
JPI$_INITIAL_THREAD_PID
Returns the PID of the initial thread for the target process. The PID
is a longword hexadecimal value.
JPI$_JOBPRCCNT
Returns the total number of subprocesses owned by the job, which is a
longword integer value.
JPI$_JOBTYPE
Returns the execution mode of the process at the root of the job tree,
which is a longword integer value. The symbolic name and value for each
execution mode are listed in the following table. The $JPIDEF macro
defines the symbolic names.
| Mode Name |
Value |
|
JPI$K_DETACHED
|
0
|
|
JPI$K_NETWORK
|
1
|
|
JPI$K_BATCH
|
2
|
|
JPI$K_LOCAL
|
3
|
|
JPI$K_DIALUP
|
4
|
|
JPI$K_REMOTE
|
5
|
JPI$_KT_COUNT
Returns the current count of kernel threads for the target process,
which is a longword integer value.
JPI$_LAST_LOGIN_I
Returns, as a quadword absolute time value, the date of the last
successful interactive login prior to the current session. It returns a
quadword of 0 when processes have not executed the LOGINOUT image.
JPI$_LAST_LOGIN_N
Returns, as a quadword absolute time value, the date of the last
successful noninteractive login prior to the current session. It
returns a quadword of 0 when processes have not executed the LOGINOUT
image.
JPI$_LOGIN_FAILURES
Returns the number of login failures that occurred prior to the current
session. It returns a longword of 0 when processes have not executed
the LOGINOUT image.
JPI$_LOGIN_FLAGS
Returns a longword bit mask containing information related to the login
sequence. It returns a longword of 0 when processes have not executed
the LOGINOUT image. The following bits are defined:
| Symbolic Name |
Description |
|
JPI$M_NEW_MAIL_AT_LOGIN
|
User had new mail messages waiting at login.
|
|
JPI$M_PASSWORD_CHANGED
|
User changed the primary password during login.
|
|
JPI$M_PASSWORD_EXPIRED
|
User's primary password expired during login.
|
|
JPI$M_PASSWORD_WARNING
|
System gave the user a warning at login that the account's primary
password would expire within 5 days.
|
|
JPI$M_PASSWORD2_CHANGED
|
Account's secondary password was changed during login.
|
|
JPI$M_PASSWORD2_EXPIRED
|
Account's secondary password expired during login.
|
|
JPI$M_PASSWORD2_WARNING
|
System gave the user a warning at login that the account's secondary
password would expire within 5 days.
|
JPI$_LOGINTIM
Returns the time at which the process was created, which is a standard
64-bit absolute time.
JPI$_MASTER_PID
Returns the process identification (PID) of the master process in the
job. The PID is a longword hexadecimal value.
JPI$_MAXDETACH
Returns the maximum number of detached processes allowed for the user
who owns the process specified in the call to $GETJPI. This limit is
set in the UAF record of the user. The number is returned as a word
decimal value. A value of 0 means that there is no limit on the number
of detached processes for that user name.
JPI$_MAXJOBS
Returns the maximum number of active processes allowed for the user who
owns the process specified in the call to $GETJPI. This limit is set in
the UAF record of the user. The number is returned as a word decimal
value. A value of 0 means that there is no limit on the number of
active processes for that user name.
JPI$_MEM
Returns the member number of the process's UIC, which is a longword
integer value.
JPI$_MODE
Returns the mode of the process, which is a longword integer value. The
symbolic name and value for each mode are listed in the following
table. The $JPIDEF macro defines the symbolic names.
| Mode Name |
Value |
|
JPI$K_OTHER
|
0
|
|
JPI$K_NETWORK
|
1
|
|
JPI$K_BATCH
|
2
|
|
JPI$K_INTERACTIVE
|
3
|
JPI$_MSGMASK
Returns the default message mask of the process, which is a longword
bit mask.
JPI$_MULTITHREAD
Returns the maximum kernel thread count allowed for the target process,
which is a longword integer value.
JPI$_NODENAME
Returns, as a character string, the name of the OpenVMS Cluster node on
which the process is running.
JPI$_NODE_CSID
Returns, as a longword hexadecimal integer, the cluster ID of the
OpenVMS Cluster node on which the process is running.
JPI$_NODE_VERSION
Returns, as a character string, the operating system version number of
the OpenVMS Cluster node on which the process is running.
JPI$_OWNER
Returns the process identification (PID) of the process that created
the specified process. The PID is a longword hexadecimal value.
JPI$_PAGEFLTS
Returns the total number of page faults incurred by the process. This
is a longword integer value.
JPI$_PAGFILCNT
Returns the remaining paging file quota of the process, which is a
longword integer value, measured in pages (on VAX systems) or pagelets
(on Alpha systems).
JPI$_PAGFILLOC
Returns the current paging file assignment of the process. The fourth
byte of the returned longword value is the index of the system page
file to which the process is currently assigned.
JPI$_PARSE_STYLE_IMAGE
Set by $SET_PROCESS_PROPERTIES, and can be either
PARSE_STYLE$C_TRADITIONAL or PARSE_STYLE$C_EXTENDED. The return length
is one byte.
JPI$_PARSE_STYLE_PERM
Set by $SET_PROCESS_PROPERTIES, and can be either
PARSE_STYLE$C_TRADITIONAL or PARSE_STYLE$C_EXTENDED. The return length
is one byte.
JPI$_PERMANENT_AFFINITY_MASK
On Alpha systems, returns the permanent explicit affinity mask for the
associated kernel thread.
JPI$_PERMANENT_USERCAP_MASK
On Alpha systems, returns the permanent user capability mask for the
associated kernel thread.
JPI$_PGFLQUOTA
Returns the paging file quota (maximum virtual page count) of the
process, which is a longword integer value, measured in pages (on VAX
systems) or pagelets (on Alpha systems).
JPI$_PHDFLAGS
Returns the process header flags as a longword bit vector.
JPI$_PID
Returns the process identification (PID) of the process. The PID is a
longword hexadecimal value.
JPI$_P0_FIRST_FREE_VA_64
On Alpha systems, this item code returns the 64-bit virtual address of
the first free page at the end of the program region (P0 space) of the
process.
Because this number is a quadword, the buffer length field in the item
descriptor should specify 8 (bytes).
JPI$_P1_FIRST_FREE_VA_64
On Alpha systems, this item code returns the 64-bit virtual address of
the first free page at the end of the control region (P1 space) of the
process.
Because this number is a quadword, the buffer length field in the item
descriptor should specify 8 (bytes).
JPI$_P2_FIRST_FREE_VA_64
On Alpha systems, this item code returns the 64-bit virtual address of
the first free page at the end of P2 space of the process.
Because this number is a quadword, the buffer length field in the item
descriptor should specify 8 (bytes).
JPI$_PPGCNT
Returns the number of pages (on VAX systems) or pagelets (on Alpha
systems) the process has in the working set. This is a longword integer
value.
JPI$_PRCCNT
Returns, as a longword integer value, the number of subprocesses
created by the process. The number returned by JPI$_PRCCNT does not
include any subprocesses created by subprocesses of the process named
in the procnam argument.
JPI$_PRCLM
Returns the subprocess quota of the process, which is a longword
integer value.
JPI$_PRCNAM
Returns, as a character string, the name of the process. Because the
process name can include up to 15 characters, the buffer length field
of the item descriptor should specify at least 15 bytes.
JPI$_PRI
Returns the current priority of the process, which is a longword
integer value.
JPI$_PRIB
Returns the base priority of the process, which is a longword integer
value.
JPI$_PROCESS_RIGHTS
Returns the binary content of the process rights list as an array of
quadword identifiers. Each entry consists of a longword identifier
value and longword identifier attributes, as shown in Table SYS-13.
Allocate a buffer that is sufficient to hold the process rights list
because $GETJPI returns only as much of the list as will fit in the
buffer.
JPI$_PROC_INDEX
Returns, as a longword integer value, the process index number of the
process. The process index number is a number between 1 and the system
parameter MAXPROCESSCNT, which identifies the process. Although process
index numbers are reassigned to different processes over time, at any
one instant, each process in the system has a unique process index
number.
You can use the process index number as an index into system global
sections. Because the process index number is unique for each process,
its use as an index into system global sections guarantees no
collisions with other system processes accessing those sections.
The process index is intended to serve users who formerly used the
low-order word of the PID as an index number.
JPI$_PROCPRIV
Returns the default privileges of the process in a quadword bit mask.
JPI$_RIGHTSLIST
Returns, as an array of quadword identifiers, all identifiers
applicable to the process. This includes the process rights list
(JPI$_PROCESS_RIGHTS) and the system rights list (JPI$_SYSTEM_RIGHTS).
Each entry consists of a longword identifier value and longword
identifier attributes, shown in Table SYS-13. Allocate a buffer that
is sufficient to hold the rights list because $GETJPI returns only as
much of the list as will fit in the buffer.
JPI$_RIGHTS_SIZE
Returns the number of bytes required to buffer the rights list. The
rights list includes both the system rights list and the process rights
list. Because the space requirements for the rights list can change
between the time you request the size of the rights list and the time
you fetch the rights list with JPI$_RIGHTSLIST, you might want to
allocate a buffer that is 10 percent larger than this item indicates.
JPI$_RMS_DFMBC
Returns the default multiblock count.
JPI$_RMS_DFMBFIDX
Returns the default multibuffer count for local buffers for indexed
file operations.
JPI$_RMS_DFMBFREL
Returns the default multibuffer count for local buffers for relative
file operations.
JPI$_RMS_DFMBFSDK
Returns the default multibuffer count for local buffers for sequential
file operations on disk.
JPI$_RMS_DFMBFSMT
Returns the default multibuffer count for local buffers for sequential
file operations on magnetic tape.
JPI$_RMS_DFMBFSUR
Returns the default multibuffer count for file operation on unit record
devices.
JPI$_RMS_DFNBC
Returns the default block count for local buffers for network access to
remote files.
JPI$_RMS_EXTEND_SIZE
Returns the default number of blocks used to extend a sequential file.
JPI$_RMS_FILEPROT
Returns the default file protection.
JPI$_RMS_PROLOGUE
Returns the default prolog level for indexed files.
JPI$_SCHED_POLICY
On Alpha systems, returns the current scheduling policy of the
specified process. Definitions of the policy values are in the $JPIDEF
macro. The buffer length of the item descriptor should specify 4
(bytes).
JPI$_SHRFILLM
Returns the maximum number of open shared files allowed for the job to
which the process specified in the call to $GETJPI belongs. This limit
is set in the UAF record of the user who owns the process. The number
is returned as a word decimal value. A value of 0 means that there is
no limit on the number of open shared files for that job.
JPI$_SITESPEC
Returns the per-process, site-specific longword, which is a longword
integer value.
JPI$_SLOW_VP_SWITCH
Returns an unsigned longword containing the number of times this
process has issued a vector instruction that resulted in an inactive
vector processor being enabled with a full vector context switch. This
vector context switch involves the saving of the vector context of the
process that last used the vector processor and the restoration of the
vector context of the current process.
JPI$_STATE
Returns the state of the process, which is a longword integer value.
Each state has a symbolic representation. If the process is currently
executing, its state is always SCH$K_CUR. The $STATEDEF macro defines
the following symbols, which identify the various possible states:
| State |
Description |
|
SCH$C_CEF
|
Common event flag wait
|
|
SCH$C_COM
|
Computable
|
|
SCH$C_COMO
|
Computable, out of balance set
|
|
SCH$C_CUR
|
Current process
|
|
SCH$C_COLPG
|
Collided page wait
|
|
SCH$C_FPG
|
Free page wait
|
|
SCH$C_HIB
|
Hibernate wait
|
|
SCH$C_HIBO
|
Hibernate wait, out of balance set
|
|
SCH$C_LEF
|
Local event flag wait
|
|
SCH$C_LEFO
|
Local event flag wait, out of balance set
|
|
SCH$C_MWAIT
|
Mutex and miscellaneous resource wait
|
|
SCH$C_PFW
|
Page fault wait
|
|
SCH$C_SUSP
|
Suspended
|
|
SCH$C_SUSPO
|
Suspended, out of balance set
|
JPI$_STS
Returns the first longword of the process status flags, which are
contained in a longword bit vector. The $PCBDEF macro defines the
following symbols for these flags:
| Symbol |
Description |
|
PCB$V_ASTPEN
|
AST pending
|
|
PCB$V_BATCH
|
Process is a batch job
|
|
PCB$V_DELPEN
|
Delete pending
|
|
PCB$V_DISAWS
|
Disable automatic working set adjustment
|
|
PCB$V_FORCPEN
|
Force exit pending
|
|
PCB$V_HARDAFF
|
Process bound to a particular CPU
|
|
PCB$V_HIBER
|
Hibernate after initial image activate
|
|
PCB$V_INQUAN
|
Initial quantum in progress
|
|
PCB$V_INTER
|
Process is an interactive job
|
|
PCB$V_LOGIN
|
Log in without reading authorization file
|
|
PCB$V_NETWRK
|
Process is a network connect object
|
|
PCB$V_NOACNT
|
No accounting for process
|
|
PCB$V_NODELET
|
No delete
|
|
PCB$V_PHDRES
|
Process header resident
|
|
PCB$V_PREEMPTED
|
Kernel mode suspend has overridden supervisor mode suspend
|
|
PCB$V_PSWAPM
|
Process swap mode (1=noswap)
|
|
PCB$V_PWRAST
|
Power fail AST
|
|
PCB$V_RECOVER
|
Process can recover locks
|
|
PCB$V_RES
|
Resident, in balance set
|
|
PCB$V_RESPEN
|
Resume pending, skip suspend
|
|
PCB$V_SECAUDIT
|
Mandatory security auditing
|
|
PCB$V_SOFTSUSP
|
Process is in supervisor mode suspend
|
|
PCB$V_SSFEXC
|
System service exception enable (kernel)
|
|
PCB$V_SSFEXCE
|
System service exception enable (exec)
|
|
PCB$V_SSFEXCS
|
System service exception enable (super)
|
|
PCB$V_SSFEXCU
|
System service exception enable (user)
|
|
PCB$V_SSRWAIT
|
System service resource wait disable
|
|
PCB$V_SUSPEN
|
Suspend pending
|
|
PCB$V_WAKEPEN
|
Wake pending, skip hibernate
|
|
PCB$V_WALL
|
Wait for all events in mask
|
JPI$_STS2
Returns the second longword of the process status flags, which are
contained in a longword bit vector. The $PCBDEF macro defines the
following symbol for these flags:
| Symbol |
Description |
|
PCB$V_NOUNSHELVE
|
Process does not automatically unshelve files.
|
JPI$_SWPFILLOC
Returns the location of the process's swapping file, which is a
longword hexadecimal value. If the number returned is positive, the
fourth byte of this value identifies a specific swapping file, and the
lower three bytes contain the VBN within the swapping file. If the
number returned is 0 or negative, the swap file location information is
not currently available for the process.
JPI$_SYSTEM_RIGHTS
Returns the system rights list as an array of quadword identifiers.
Each entry consists of a longword identifier value and longword
identifier attributes, shown in Table SYS-13. Allocate a buffer that
is sufficient to hold the system rights list because $GETJPI only
returns as much of the list as will fit in the buffer.
JPI$_TABLENAME
Returns the file specification of the process's current command
language interpreter (CLI) table. Because the file specification can
include up to 255 characters, the buffer length field in the item
descriptor should specify 255 bytes.
JPI$_TERMINAL
Returns, for interactive users, the process's login terminal name as a
character string. Because the terminal name can include up to 8
characters, the buffer length field in the item descriptor should
specify at least 8 bytes. Trailing zeros are written to the output
buffer if necessary.
JPI$_THREAD_INDEX
Returns the kernel thread index for the target thread or process, which
is a longword integer value.
JPI$_TMBU
Returns the termination mailbox unit number, which is a longword
integer value.
JPI$_TQCNT
Returns the remaining timer queue entry quota of the process, which is
a longword integer value.
JPI$_TQLM
Returns the process's limit on timer queue entries, which is a longword
integer value.
JPI$_TT_ACCPORNAM
Returns the access port name for the terminal associated with the
process. (The terminal name is returned by JPI$_TERMINAL.) If the
terminal is on a terminal server, this item returns the terminal server
name and the name of the line port on the server. If the terminal is a
DECnet for OpenVMS remote terminal, this item returns the source system
node name and the user name on the source system; otherwise, it returns
a null string.
JPI$_TT_PHYDEVNAM
Returns the physical device name of the terminal associated with the
process. This name is the same as JPI$_TERMINAL unless virtual
terminals are enabled, in which case JPI$_TERMINAL returns the name of
the virtual terminal and JPI$_TT_PHYDEVNAM returns the name of the
physical terminal. If JPI$_TERMINAL is null or if the virtual terminal
is disconnected from the physical terminal, JPI$_TT_PHYDEVNAM returns a
null string.
JPI$_UAF_FLAGS
Returns the UAF flags from the UAF record of the user who owns the
process. The flags are returned as a longword bit vector. For a list of
the symbolic names of these flags, see the UAI$_FLAGS item code under
the $GETUAI system service.
JPI$_UIC
Returns the UIC of the process in the standard longword format.
JPI$_USERNAME
Returns the user name of the process as a 12-byte string. If the name
is less than 12 bytes, $GETJPI fills out the 12 bytes with trailing
blanks and always returns 12 as the string length.
JPI$_VIRTPEAK
Returns the peak virtual address size---in pages for VAX or pagelets
for Alpha---of the process.
On VAX systems, the value returned is a longword integer. On Alpha
systems, the value returned requires a quadword of storage. If the
buffer size supplied is not equal to 8 bytes, and the virtual peak
exceeds the maximum value that can be represented in a longword,
$GETJPI returns the largest positive 32-bit integer: 2147483647.
JPI$_VOLUMES
Returns the number of volumes that the process currently has mounted,
which is a longword integer value.
JPI$_VP_CONSUMER
Returns a byte, the low-order bit of which, when set, indicates that
the process is a vector consumer.
JPI$_VP_CPUTIM
Returns an unsigned longword that contains the total amount of time the
process has accumulated as a vector consumer.
JPI$_WSAUTH
Returns the maximum authorized working set size, in pages (on VAX
systems) or pagelets (on Alpha systems), of the process. This is a
longword integer value.
JPI$_WSAUTHEXT
Returns, in pages (on VAX systems) or pagelets (on Alpha systems), the
maximum authorized working set extent of the process as a longword
integer value.
JPI$_WSEXTENT
Returns, in pages (on VAX systems) or pagelets (on Alpha systems), the
current working set extent of the process as a longword integer value.
JPI$_WSPEAK
Returns, in pages (on VAX systems) or pagelets (on Alpha systems), the
peak working set size of the process as a longword integer value.
JPI$_WSQUOTA
Returns, in pages (on VAX systems) or pagelets (on Alpha systems), the
working set size quota of the process as a longword integer value.
JPI$_WSSIZE
Returns, in pages (on VAX systems) or pagelets (on Alpha systems), the
current working set size of the process as a longword integer value.
Description
The Get Job/Process Information service returns information about one
or more processes on the system or across the cluster. Using $GETJPI
with $PROCESS_SCAN, you can perform selective or clusterwide searches.
|
