OpenVMS System Services Reference Manual

If you specify astadr, the AST routine executes at the same access mode as the caller of the $GETJPI service.

astprm

OpenVMS usage:	user_arg
type:	longword (unsigned)
access:	read only
mechanism:	by value

AST parameter to be passed to the AST service routine specified by the astadr argument. The astprm argument is the longword parameter.

ITEM CODES

JPI$_ACCOUNT
When you specify JPI$_ACCOUNT, $GETJPI returns the account name of the process, which is an 8-byte string, filled with trailing blanks if necessary.
JPI$_APTCNT
When you specify JPI$_APTCNT, $GETJPI returns, in pages (on VAX systems) or pagelets (on Alpha systems), the active page table count of the process, which is a longword integer value.
JPI$_ASTACT
When you specify JPI$_ASTACT, $GETJPI returns the names of the access modes having active ASTs. This information is returned in a longword bit vector. When bit 0 is set, an active kernel mode AST exists; bit 1, an executive mode AST; bit 2, a supervisor mode AST; and bit 3, a user mode AST.
JPI$_ASTCNT
When you specify JPI$_ASTCNT, $GETJPI returns a count of the remaining AST quota, which is a longword integer value.
JPI$_ASTEN
When you specify JPI$_ASTEN, $GETJPI returns the names of the access modes having ASTs enabled. This information is returned in a longword bit vector. When bit 0 is set, kernel mode has ASTs enabled; bit 1, executive mode; bit 2, supervisor mode; and bit 3, user mode.
JPI$_ASTLM
When you specify JPI$_ASTLM, $GETJPI returns the AST limit quota of the process, which is a longword integer value.
JPI$_AUTHPRI
When you specify JPI$_AUTHPRI, $GETJPI returns the authorized base priority of the process, which is a longword integer value. The authorized base priority is the highest priority a process without ALTPRI privilege can attain by means of the $SETPRI service.
JPI$_AUTHPRIV
When you specify JPI$_AUTHPRIV, $GETJPI returns the privileges that the process is authorized to enable. These privileges are returned in a quadword privilege mask and are defined by the $PRVDEF macro.
JPI$_BIOCNT
When you specify JPI$_BIOCNT, $GETJPI returns a count of the remaining buffered I/O quota, which is a longword integer value.
JPI$_BIOLM
When you specify JPI$_BIOLM, $GETJPI returns the buffered I/O limit quota of the process, which is a longword integer value.
JPI$_BUFIO
When you specify JPI$_BUFIO, $GETJPI returns a count of the buffered I/O operations of the process, which is a longword integer value.
JPI$_BYTCNT
When you specify JPI$_BYTCNT, $GETJPI returns the remaining buffered I/O byte count quota of the process, which is a longword integer value.
JPI$_BYTLM
When you specify JPI$_BYTLM, $GETJPI returns the buffered I/O byte count limit quota of the process, which is a longword integer value.
JPI$_CHAIN
When you specify JPI$_CHAIN, $GETJPI processes another item list immediately after processing the current one. The buffer address field in the item descriptor specifies the address of the next item list to be processed. You must specify the JPI$_CHAIN item code last in the item list.
You can chain together 32-bit and 64-bit item lists.
JPI$_CLINAME
When you specify JPI$_CLINAME, $GETJPI returns the name of the command language interpreter that the process is currently using. Because the CLI name can include up to 39 characters, the buffer length field in the item descriptor should specify 39 bytes.
JPI$_CPU_ID
When you specify JPI$_CPU_ID, $GETJPI returns, as a longword integer, the ID of the CPU on which the process is running or on which it last ran. This value is returned as --1 if the system is not a multiprocessor.
JPI$_CPULIM
When you specify JPI$_CPULIM, $GETJPI returns the CPU time limit of the process, which is a longword integer value.
JPI$_CPUTIM
When you specify JPI$_CPUTIM, $GETJPI returns the process's accumulated CPU time in 10-millisecond ticks, which is a longword integer value.
JPI$_CREPRC_FLAGS
When you specify JPI$_CREPRC_FLAGS, $GETJPI returns the flags specified by the stsflg argument in the $CREPRC call that created the process. The flags are returned as a longword bit vector.
JPI$_CURPRIV
When you specify JPI$_CURPRIV, $GETJPI returns the current privileges of the process. These privileges are returned in a quadword privilege mask and are defined by the $PRVDEF macro.
JPI$_CURRENT_AFFINITY_MASK
On Alpha systems, when you specify JPI$_CURRENT_AFFINITY_MASK, $GETJPI returns the current explicit affinity mask for the associated kernel thread.
JPI$_CURRENT_USERCAP_MASK
On Alpha systems, when you specify JPI$_CURRENT_USERCAP_MASK, $GETJPI returns the current user capability mask for the associated kernel thread.
JPI$_DFMBC
When you specify JPI$_DFMBC, $GETJPI returns the default multibuffer count for a process as a longword integer value.
JPI$_DFPFC
When you specify JPI$_DFPFC, $GETJPI returns the default page fault cluster size of the process, which is a longword integer value measured in pages (on VAX systems) or pagelets (on Alpha systems).
JPI$_DFWSCNT
When you specify JPI$_DFWSCNT, $GETJPI returns, in pages (on VAX systems) or pagelets (on Alpha systems), the default working set size of the process, which is a longword integer value.
JPI$_DIOCNT
When you specify JPI$_DIOCNT, $GETJPI returns the remaining direct I/O quota of the process, which is a longword integer value.
JPI$_DIOLM
When you specify JPI$_DIOLM, $GETJPI returns the direct I/O quota limit of the process, which is a longword integer value.
JPI$_DIRIO
When you specify JPI$_DIRIO, $GETJPI returns a count of the direct I/O operations of the process, which is a longword integer value.
JPI$_EFCS
When you specify JPI$_EFCS, $GETJPI returns the state of the process's local event flags 0 through 31 as a longword bit vector.
JPI$_EFCU
When you specify JPI$_EFCU, $GETJPI returns the state of the process's local event flags 32 through 63 as a longword bit vector.
JPI$_EFWM
When you specify JPI$_EFWM, $GETJPI returns the event flag wait mask of the process, which is a longword bit vector.
JPI$_ENQCNT
When you specify JPI$_ENQCNT, $GETJPI returns the remaining lock request quota of the process, which is a longword integer value.
JPI$_ENQLM
When you specify JPI$_ENQLM, $GETJPI returns the lock request quota of the process, which is a longword integer value.
JPI$_EXCVEC
When you specify JPI$_EXCVEC, $GETJPI returns the address of a list of exception vectors for the process. Each exception vector in the list is a longword. There are eight vectors in the list: these are, in order, a primary and a secondary vector for kernel mode access, for executive mode access, for supervisor mode access, and for user mode access.
The $GETJPI service cannot return this information for any process other than the calling process; if you specify this item code and the process is not the calling process, $GETJPI returns the value 0 in the buffer.
JPI$_FAST_VP_SWITCH
When you specify JPI$_FAST_VP_SWITCH, $GETJPI 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 without the expense of a vector context switch. In other words, this count reflects those instances where the process has reenabled a vector processor on which the process's vector context has remained intact.
JPI$_FILCNT
When you specify JPI$_FILCNT, $GETJPI returns the remaining open file quota of the process, which is a longword integer value.
JPI$_FILLM
When you specify JPI$_FILLM, $GETJPI returns the open file limit quota of the process, which is a longword value.
JPI$_FINALEXC
When you specify JPI$_FINALEXC, $GETJPI returns the address of a list of final exception vectors for the process. Each exception vector in the list is a longword. There are four vectors in the list, one for each access mode, in this order: kernel, executive, supervisor, and user.
The $GETJPI service cannot return this information for any process other than the calling process; if you specify this item code and the process is not the calling process, $GETJPI returns the value 0 in the buffer.
JPI$_FREP0VA
When you specify JPI$_FREP0VA, $GETJPI returns the address of the first free page at the end of the program region (P0 space) of the process.
JPI$_FREP1VA
When you specify JPI$_FREP1VA, $GETJPI returns the address of the first free page at the end of the control region (P1 space) of the process.
JPI$_FREPTECNT
When you specify JPI$_FREPTECNT, $GETJPI returns the number of pages (on VAX systems) or pagelets (on Alpha systems) that the process has available for virtual memory expansion.
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 number of free pagelets exceeds the maximum value that can be represented in a longword, $GETJPI returns the largest positive 32-bit integer: 2147483647.
JPI$_GETJPI_CONTROL_FLAGS
The JPI$_GETJPI_CONTROL_FLAGS item code, which is specified in the $GETJPI item list, provides additional control over $GETJPI. Therefore, $GETJPI might be unable to retrieve all the data requested in an item list because JPI$_GETJPI_CONTROL_FLAGS requests that $GETJPI not perform certain actions that might be necessary to collect the data. For example, a $GETJPI control flag might instruct the calling program not to retrieve a process that has been swapped out of the balance set.
If $GETJPI is unable to retrieve any data item because of the restrictions imposed by the control flags, it returns the data length as 0. To verify that $GETJPI received a data item, examine the data length to be sure that it is not 0. To ensure the verification, be sure to specify the return length for each item in the $GETJPI item list when any of the JPI$_GETJPI_CONTROL_FLAGS flags is used.
Unlike other $GETJPI item codes, the JPI$_GETJPI_CONTROL_FLAGS item is an input item. The item list entry should specify a longword buffer. The desired control flags should be set in this buffer.
Because the JPI$_GETJPI_CONTROL_FLAGS item code tells $GETJPI how to interpret the item list, it must be the first entry in the $GETJPI item list. The error code SS$_BADPARAM is returned if it is not the first item in the list.
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
When you specify JPI$_GPGCNT, $GETJPI 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
When you specify JPI$_GRP, $GETJPI returns, as a longword integer value, the group number of the process's UIC.
JPI$_IMAGECOUNT
When you specify JPI$_IMAGECOUNT, $GETJPI returns, as a longword integer value, the number of images that have been run down for the process.
JPI$_IMAGE_RIGHTS
When you specify JPI$_IMAGE_RIGHTS, $GETJPI 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-11. 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-11 Attributes of an Identifier
Symbolic Name Description

KGB$M_DYNAMIC Identifier can be enabled or disabled.

KGB$M_RESOURCE Resources can be charged to the identifier.

+VAX specific

JPI$_IMAGNAME
When you specify JPI$_IMAGNAME, $GETJPI returns, as a character string, the directory specification and the image file name.
JPI$_IMAGPRIV
When you specify JPI$_IMAGPRIV, $GETJPI 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$_JOBPRCCNT
When you specify JPI$_JOBPRCCNT, $GETJPI returns the total number of subprocesses owned by the job, which is a longword integer value.
JPI$_JOBTYPE
When you specify JPI$_JOBTYPE, $GETJPI 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$_LAST_LOGIN_I
When you specify JPI$_LAST_LOGIN_I, $GETJPI 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
When you specify JPI$_LAST_LOGIN_N, $GETJPI 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
When you specify JPI$_LOGIN_FAILURES, $GETJPI 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
When you specify JPI$_LOGIN_FLAGS, $GETJPI returns a longword bitmask 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
When you specify JPI$_LOGINTIM, $GETJPI returns the time at which the process was created, which is a standard 64-bit absolute time.
JPI$_MASTER_PID
When you specify JPI$_MASTER_PID, $GETJPI returns the process identification (PID) of the master process in the job. The PID is a longword hexadecimal value.
JPI$_MAXDETACH
When you specify JPI$_MAXDETACH, $GETJPI 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
When you specify JPI$_MAXJOBS, $GETJPI 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
When you specify JPI$_MEM, $GETJPI returns the member number of the process's UIC, which is a longword integer value.
JPI$_MODE
When you specify JPI$_MODE, $GETJPI 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
When you specify JPI$_MSGMASK, $GETJPI returns the default message mask of the process, which is a longword bit mask.
JPI$_NODENAME
When you specify JPI$_NODENAME, $GETJPI returns, as a character string, the name of the OpenVMS Cluster node on which the process is running.
JPI$_NODE_CSID
When you specify JPI$_NODE_CSID, $GETJPI returns, as a longword hexadecimal integer, the cluster ID of the OpenVMS Cluster node on which the process is running.
JPI$_NODE_VERSION
When you specify JPI$_NODE_VERSION, $GETJPI returns, as a character string, the operating system version number of the OpenVMS Cluster node on which the process is running.
JPI$_OWNER
When you specify JPI$_OWNER, $GETJPI returns the process identification (PID) of the process that created the specified process. The PID is a longword hexadecimal value.
JPI$_PAGEFLTS
When you specify JPI$_PAGEFLTS, $GETJPI returns the total number of page faults incurred by the process. This is a longword integer value.
JPI$_PAGFILCNT
When you specify JPI$_PAGFILCNT, $GETJPI 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
When you specify JPI$_PAGFILLOC, $GETJPI 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$_PERMANENT_AFFINITY_MASK
On Alpha systems, when you specify JPI$_PERMANENT_AFFINITY_MASK, $GETJPI returns the permanent explicit affinity mask for the associated kernel thread.
JPI$_PERMANENT_USERCAP_MASK
On Alpha systems, when you specify JPI$_PERMANENT_USERCAP_MASK, $GETJPI returns the permanent user capability mask for the associated kernel thread.
JPI$_PGFLQUOTA
When you specify JPI$_PGFLQUOTA, $GETJPI 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
When you specify JPI$_PHDFLAGS, $GETJPI returns the process header flags as a longword bit vector.
JPI$_PID
When you specify JPI$_PID, $GETJPI 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
When you specify JPI$_PPGCNT, $GETJPI 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
When you specify JPI$_PRCCNT, $GETJPI 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
When you specify JPI$_PRCLM, $GETJPI returns the subprocess quota of the process, which is a longword integer value.
JPI$_PRCNAM
When you specify JPI$_PRCNAM, $GETJPI 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
When you specify JPI$_PRI, $GETJPI returns the current priority of the process, which is a longword integer value.
JPI$_PRIB
When you specify JPI$_PRIB, $GETJPI returns the base priority of the process, which is a longword integer value.
JPI$_PROCESS_RIGHTS
When you specify JPI$_PROCESS_RIGHTS, $GETJPI 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-11. 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
When you specify JPI$_PROC_INDEX, $GETJPI returns, as a longword integer value, the process index number of the process. The process index number is a number between 1 and the SYSGEN parameter MAlphaROCESSCNT, 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
When you specify JPI$_PROCPRIV, $GETJPI returns the default privileges of the process in a quadword bit mask.
JPI$_RIGHTSLIST
When you specify JPI$_RIGHTSLIST, $GETJPI 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-11. 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
When you specify JPI$_RIGHTS_SIZE, $GETJPI 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$_SCHED_POLICY
On Alpha systems, when you specify JPI$_SCHED_POLICY, $GETJPI 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
When you specify JPI$_SHRFILLM, $GETJPI 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
When you specify JPI$_SITESPEC, $GETJPI returns the per-process, site-specific longword, which is a longword integer value.
JPI$_SLOW_VP_SWITCH
When you specify JPI$_SLOW_VP_SWITCH, $GETJPI 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
When you specify JPI$_STATE, $GETJPI 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
When you specify JPI$_STS, $GETJPI 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
When you specify JPI$_STS2, $GETJPI 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
When you specify JPI$_SWPFILLOC, $GETJPI 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
When you specify JPI$_SYSTEM_RIGHTS, $GETJPI 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-11. 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
When you specify JPI$_TABLENAME, $GETJPI 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
When you specify JPI$_TERMINAL, $GETJPI 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$_TMBU
When you specify JPI$_TMBU, $GETJPI returns the termination mailbox unit number, which is a longword integer value.
JPI$_TQCNT
When you specify JPI$_TQCNT, $GETJPI returns the remaining timer queue entry quota of the process, which is a longword integer value.
JPI$_TQLM
When you specify JPI$_TQLM, $GETJPI returns the process's limit on timer queue entries, which is a longword integer value.
JPI$_TT_ACCPORNAM
When you specify JPI$_TT_ACCPORNAM, $GETJPI 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
When you specify JPI$_TT_PHYDEVNAM, $GETJPI 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
When you specify JPI$_UAF_FLAGS, $GETJPI 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
When you specify JPI$_UIC, $GETJPI returns the UIC of the process in the standard longword format.
JPI$_USERNAME
When you specify JPI$_USERNAME, $GETJPI 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
When you specify JPI$_VIRTPEAK, $GETJPI returns the peak virtual address size---in pages for VAX or pagelets for Alpha---of the process.

Previous | Next | Contents | [Home] | [Comments] | [Ordering info] | [Help]
  4527P038.HTM
  OSSG Documentation
  22-NOV-1996 12:59:43.76
Copyright © Digital Equipment Corporation 1996. All Rights Reserved.

Legal

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.

Symbolic Name	Description
KGB$M_DYNAMIC	Identifier can be enabled or disabled.
KGB$M_RESOURCE	Resources can be charged to the identifier.

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

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.

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

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