|
HP OpenVMS Systems Documentation |
|
HP OpenVMS System Services Reference Manual
The size of the returned bitmap is determined by the number of supported CPUs on the system. You can compute the number of bytes needed for the bitmap as follows: Use the $GETSYI system service with an item code of SYI$_MAX_CPUS to find the minimum number of bits needed, round this number up to a multiple of 64, and divide the result by 8. SYI$_AVAIL_CPU_MASKNote that this item code is becoming obsolete; HP recommends that you not use it because it represents only up to 64 CPUs. The service continues to return the correct data for systems with up to 64 CPUs but fails for systems with more than 64 CPUs. For greater flexibility, use item code SYI$_AVAIL_CPU_BITMAP instead.On Alpha and Integrity server systems, returns a value that represents a CPU-indexed bitvector. When a particular bit position is set, the processor with that CPU ID value is a member of the instance's configure set---those owned by the partition and controlled by the issuing instance. SYI$_AVAILCPU_CNTReturns the number of CPUs available in the current boot of the symmetric multiprocessing (SMP) system.Because this number is a longword, the buffer length field in the item descriptor should specify 4 (bytes). SYI$_BOOT_DEVICEReturns the name of the device from which the system was booted as a character string. For a system with a shadowed system disk, SYI$_BOOT_DEVICE returns the name of the member device from which the shadow set was formed.SYI$_BOOTTIMEReturns the time when the node was booted.Because the returned time is in the standard 64-bit absolute time format, the buffer length field in the item descriptor should specify 8 (bytes). SYI$_CHARACTER_EMULATEDReturns the number 1 if the character string instructions are emulated on the CPU and the value 0 if they are not.Because this number is a Boolean value (1 or 0), the buffer length field in the item descriptor should specify 1 (byte). SYI$_CLUSTER_EVOTESReturns the number of votes expected to be found in the OpenVMS Cluster system. The cluster determines this value by selecting the highest number from all of the following: each node's system parameter EXPECTED_VOTES, the sum of the votes currently in the cluster, and the previous value for the number of expected votes.Because this number is a word in length, the buffer length field in the item descriptor should specify 2 (bytes). SYI$_CLUSTER_FSYSIDReturns the system identification of the founding node, which is the first node in the OpenVMS Cluster system to boot.The cluster management software assigns this system identification to the node. You can obtain this information by using the DCL command SHOW CLUSTER. Because the system identification is a 6-byte hexadecimal number, the buffer length field in the item descriptor should specify 6 (bytes). SYI$_CLUSTER_FTIMEReturns the time when the founding node is booted. The founding node is the first node in the OpenVMS Cluster system to boot.Because the returned time is in the standard 64-bit absolute time format, the buffer length field in the item descriptor should specify 8 (bytes). SYI$_CLUSTER_MEMBERReturns the membership status of the node in the OpenVMS Cluster system. The membership status specifies whether the node is currently a member of the cluster.Because the membership status of a node is described in a 1-byte bit field, the buffer length field in the item descriptor should specify 1 (byte). If bit 0 in the bit field is set, the node is a member of the cluster; if it is clear, then it is not a member of the cluster. SYI$_CLUSTER_NODESReturns the number (in decimal) of nodes currently in the OpenVMS Cluster system.Because this number is a word in length, the buffer length field in the item descriptor should specify 2 (bytes). SYI$_CLUSTER_QUORUMReturns the number (in decimal) that is the total of the quorum values held by all nodes in the OpenVMS Cluster system. Each node's quorum value is derived from its system parameter EXPECTED_VOTES.Because this number is a word in length, the buffer length field in the item descriptor should specify 2 (bytes). SYI$_CLUSTER_VOTESReturns the total number of votes held by all nodes in the OpenVMS Cluster system. The number of votes held by any one node is determined by that node's system parameter VOTES.Because this decimal number is a word in length, the buffer length field in the item descriptor should specify 2 (bytes). SYI$_COMMUNITY_IDOn Alpha and Integrity server systems, returns the hardware community ID for the issuing instance within the hard partition. Supported only on AlphaServer systems that support partitioning.SYI$_CONTIG_GBLPAGESReturns the maximum number of free, contiguous global CPU-specific pages. This number is the largest size global section that can be created.Because this number is a longword, the buffer length in the item descriptor should specify 4 (bytes). SYI$_CPUAs the processor type is a longword decimal number, the buffer length field in the item descriptor should specify 4 (bytes). On Alpha and Integrity server systems, $GETSYI returns PR$_SID_TYP_NOTAVAX.For information about extended processor type codes, see the description for the SYI$_XCPU item code. SYI$_CPU_AUTOSTARTOn Alpha and Integrity server systems, returns a list of zeroes and ones, separated by commas and indexed by CPU ID. Any entry with a value of one indicates that specific CPU will be brought into the OpenVMS active set if it transitions into the current instance from outside, or is powered up while already owned.SYI$_CPU_FAILOVERReturns list of numeric partition IDs, separated by commas and indexed by CPU ID, that define the destination of the processor if the current instance should crash. Supported only on AlphaServer systems that support partitioning.SYI$_CPUCAP_MASKOn Alpha and Integrity server systems, returns an array of quadword user capability masks for all CPUs in the system. This array is indexed by CPU ID and contains as many elements as the amount of space specified by the buffer length field in the item descriptor.To minimize wasted space, a prior call to $GETSYI with SYI$_MAX_CPUS will provide the number of CPUs that need to be retrieved. Multiplying that value by 8 bytes for each quadword provides the value to be written in the buffer length field of the item descriptor. SYI$_CPUCONFNote that this item code is becoming obsolete; HP recommends that you not use it because it represents only up to 64 CPUs. The service continues to return the correct data for systems with up to 64 CPUs but fails for systems with more than 64 CPUs. For greater flexibility, use item code SYI$_AVAIL_CPU_BITMAP instead.On Alpha and Integrity server systems, returns a value that represents a CPU-indexed bitvector. When a particular bit position is set, the processor with that CPU ID value is a member of the instance's configure set---those owned by the partition and controlled by the issuing instance. SYI$_CPUTYPEOn Alpha and Integrity server systems, returns the processor type, as stored in the hardware restart parameter block (HWRPB).For example, the value of 2 represents a DECchip 21064 processor. Because this number is a longword, the buffer length field in the item descriptor should specify 4 (bytes). The following table shows the processor codes and processors:
SYI$_CWLOGICALSReturns the number 1 if the clusterwide logical name database has been initialized on the CPU, or the value 0 if it has not been initialized. Because this number is a Boolean value (1 or 0), the buffer length field in the item descriptor should specify 1 (byte).SYI$_DAY_OVERRIDEReturns the number 1 if the SET DAY command has been used to override the default primary and secondary day types in the user authorization file that are used to control user logins. $GETSYI returns the number 0 if no override is currently in effect, and the contents of user authorization file records for each user are being honored.SYI$_DAY_SECONDARYReturns the number 1 if any override with the SET DAY command has been used to specify that the current day is to be considered a Secondary day for user login purposes. $GETSYI returns the number 0 if any override with the SET DAY command has been used to specify that the current day is to be considered a Primary day for user login purposes.If $GETSYI returns the number 0 for SYI$_DAY_OVERRIDE, the number returned for SYI$_DAY_SECONDARY is meaningless. 
SYI$_DECIMAL_EMULATEDReturns the number 1 if the decimal string instructions are emulated on the CPU and the value 0 if they are not.Because this number is a Boolean value (1 or 0), the buffer length field in the item descriptor should specify 1 (byte). SYI$_DECNET_FULLNAMEReturns, as a character string, the DECnet for OpenVMS full name of the node.Because the DECnet for OpenVMS full name of a node can contain up to 255 characters, the buffer length field in the item descriptor should specify 255 (bytes). SYI$_D_FLOAT_EMULATEDReturns the number 1 if the D_floating instructions are emulated on the CPU and 0 if they are not.Because this number is a Boolean value (1 or 0), the buffer length field in the item descriptor should specify 1 (byte). SYI$_DEF_PRIO_MAXOn Alpha and Integrity server systems, returns the maximum priority for the default scheduling policy.Because this number is a longword, the buffer length field in the item descriptor should specify 4 (bytes). SYI$_DEF_PRIO_MINOn Alpha and Integrity server systems, returns the minimum priority for the default scheduling policy.Because this number is a longword, the buffer length field in the item descriptor should specify 4 (bytes). SYI$_ERLBUFFERPAGESReturns the number of pagelets in an error log buffer.Because this number is a longword, the buffer length field in the item descriptor should specify 4 (bytes). SYI$_ERRORLOGBUFFERSReturns the number of system pagelets in use as buffers for the error logger.Because this number is a word in length, the buffer length field in the item descriptor should specify 2 (bytes). SYI$_F_FLOAT_EMULATEDReturns the number 1 if the F_floating instructions are emulated on the CPU and 0 if they are not.Because this number is a Boolean value (1 or 0), the buffer length field in the item descriptor should specify 1 (byte). SYI$_FREE_GBLPAGESReturns the current number of free global pages. The system parameter GBLPAGES sets the number of global pages that can exist systemwide.Because the current number is a longword, the buffer length in the item descriptor should specify 4 (bytes). SYI$_FREE_GBLSECTSReturns the current number of free global section table entries. The system parameter GBLSECTIONS sets the maximum number of global sections that can exist systemwide.Because the current number is a longword, the buffer length in the item descriptor should specify 4 (bytes). SYI$_G_FLOAT_EMULATEDReturns the number 1 if the G_floating instructions are emulated on the CPU and the value 0 if they are not.Because this number is a Boolean value (1 or 0), the buffer length field in the item descriptor should specify 1 (byte). SYI$_GALAXY_IDOn Alpha systems, returns the 128-bit Galaxy ID. Supported only on AlphaServer GS series systems.SYI$_GALAXY_MEMBEROn Alpha systems, returns 1 if you are member of a Galaxy sharing community, 0 if you are not a member. Supported only on AlphaServer GS series systems.SYI$_GALAXY_PLATFORMOn Alpha systems, returns 1 if you are running on a Galaxy platform, 0 if you are not running on a Galaxy platform. Supported only on AlphaServer GS series systems.SYI$_GALAXY_SHMEMSIZEOn Alpha systems, returns the number of shared memory pages. If the current instance is not a member of a Galaxy, no shared memory is reported. Supported only on AlphaServer GS series systems.SYI$_GH_RSRVPGCNTOn Alpha and Integrity server systems, returns the number of pages covered by granularity hints to reserve for use by the Install utility after system startup has completed.Because this number is a longword, the buffer length field in the item descriptor should specify 4 (bytes). SYI$_GLX_FORMATIONOn Alpha systems, returns the a time-stamp string when the Galaxy configuration, of which this instance is a member, was created. Supported only on AlphaServer GS series systems.SYI$_GLX_MAX_MEMBERSOn Alpha systems, returns the maximum count of instances that may join the current Galaxy configuration. Supported only on AlphaServer GS series systems.SYI$_GLX_MBR_MEMBEROn Alpha systems, returns the 64-byte integer. Each 8 bytes represents a Galaxy member number, listed from 7 to 0. The value is 1 if the instance is currently a member, 0 if not a member. Supported only on AlphaServer GS series systems.SYI$_GLX_MBR_NAMEOn Alpha systems, returns a string indicating the names that are known in the Galaxy membership. Returned names are separated by two spaces, with an additional two spaces following the last name in the list. Supported only on AlphaServer GS series systems.SYI$_GLX_TERMINATIONOn Alpha systems, returns a time-stamp string when the Galaxy configuration, of which this instance last was a member, was terminated. Supported only on AlphaServer GS series systems.SYI$_H_FLOAT_EMULATEDReturns the number 1 if the H_floating instructions are emulated on the CPU and the value 0 if they are not.Because this number is a Boolean value (1 or 0), the buffer length field in the item descriptor should specify 1 (byte). SYI$_HP_ACTIVE_CPU_CNTReturns the number of active CPUs in this hard partition that are not currently in firmware console mode. For OpenVMS, this implies that the CPU is in, or in the process of joining, the active set in one of the instances in the hard partition. Supported only on AlphaServer systems that support partitioning.SYI$_HP_ACTIVE_SP_CNTReturns the count of active operating system instances currently executing within the hard partition. Supported only on AlphaServer systems that support partitioning.SYI$_HP_CONFIG_SBB_CNTReturns a count of the existing system building blocks within the current hard partition. Supported only on AlphaServer systems that support partitioning.SYI$_HP_CONFIG_SP_CNTReturns the maximum count of soft partitions within the current hard partition. This count does not imply that an operating system instance is currently running within any given soft partition. Supported only on AlphaServer systems that support partitioning.SYI$_HW_MODELReturns a small integer that can be used to identify the model type of the node.An integer greater than 1023 indicates an Alpha and Integrity servers node. An integer less than or equal to 1023 indicates a VAX node. The $ALPHADEF and $VAXDEF macros in SYS$LIBRARY:STARLET define the model type integers. Because SYI$_HW_MODEL is a word, the buffer length field in the item descriptor should specify 2 (bytes). SYI$_HW_NAMEReturns the model name string of the node. The model name is a character string that describes the model of the node . The model name usually corresponds to the nameplate that appears on the outside of the CPU cabinet.Because SYI$_HW_NAME can include up to 60 characters plus one for the byte count, the buffer length field in the item descriptor should specify 61 (bytes). An example of an Integrity servers processor follows:
The following table lists the Alpha model processor names and the corresponding model types:
SYI$_IO_PRCPU_BITMAPThe return argument is a bitmap with a bit indicating a preferred CPU -- one available for Fast Path operations.The size of the returned bitmap is determined by the number of supported CPUs on the system. You can compute the number of bytes needed for the bitmap as follows: Use the $GETSYI system service with an item code of SYI$_MAX_CPUS to find the minimum number of bits needed, round this number up to a multiple of 64, and divide the result by 8. SYI$_IO_PREFER_CPUNote that this item code is becoming obsolete; HP recommends that you not use it because it represents only up to 64 CPUs. The service continues to return the correct data for systems with up to 64 CPUs but fails for systems with more than 64 CPUs. For greater flexibility, use item code SYI$_IO_PRCPU_BITMAP instead.On Alpha and Integrity server systems, returns the bit mask of CPUs available to be Fast Path preferred CPUs. The service continues to return the correct data for systems with up to 64 CPUs but fails for systems with more than 64 CPUs. SYI$_ITB_ENTRIESOn Alpha and Integrity server systems, returns the number of instruction stream translation buffer entries that support granularity hints to be allocated for resident code.Because this number is a longword, the buffer length field in the item descriptor should specify 4 (bytes). SYI$_MAX_CPUSOn Alpha and Integrity server systems, returns the maximum number of CPUs that could be recognized by this instance.SYI$_MAX_PFNReturns the highest numbered PFN in use by the operating system. The highest numbered PFN used by OpenVMS is influenced by the PHYSICAL_MEMORY system parameter.Because this number is a longword, the buffer length field in the item descriptor should specify 4 (bytes). SYI$_MEMSIZEReturns the total number of pages of physical memory in the system configuration.Because this number is a longword, the buffer length field in the item descriptor should specify 4 (bytes). SYI$_NODE_AREAReturns the DECnet area of the node.Because the DECnet area is a longword decimal number, the buffer length field in the item descriptor should specify 4 (bytes). SYI$_NODE_CSIDReturns the OpenVMS Cluster system ID (CSID) of the node. The CSID is a longword hexadecimal number assigned to the node by the cluster management software.Because the CSID is a longword, the buffer length field in the item descriptor should specify 4 (bytes). SYI$_NODE_EVOTESReturns the number of votes the node expects to find in the OpenVMS Cluster system. This number is determined by the system parameter EXPECTED_VOTES.Because the number is a word in length, the buffer length field in the item descriptor should specify 2 (bytes). SYI$_NODE_HWVERSReturns the platform-specific hardware version information associated with the node. The high word of the buffer contains the CPU type. The $VAXDEF and $ALPHADEF macros define the CPU model types for VAX and Alpha systems, respectively. (HP recommends acquiring the model type using the SYI$_HW_MODEL item code.)Because the hardware version is a 12-byte hexadecimal number, the buffer length field in the item descriptor should specify 12 (bytes). SYI$_NODE_NUMBERReturns the DECnet for OpenVMS number of the node.Because the DECnet for OpenVMS number is a longword decimal number, the buffer length field in the item descriptor should specify 4 (bytes). SYI$_NODE_QUORUMReturns the value (in decimal) of the quorum held by the node. This number is derived from the node's system parameter EXPECTED_VOTES.Because this number is a word in length, the buffer length field in the item descriptor should specify 2 (bytes). SYI$_NODE_SWINCARNReturns the software incarnation of the node.Because the software incarnation of the node is an 8-byte hexadecimal number, the buffer length field in the item descriptor should specify 8 (bytes). SYI$_NODE_SWTYPEReturns the software type of the node. The software type indicates whether the node is an Alpha or Integrity servers system, or an HSC storage controller.Because the software type is a 4-byte ASCII string, the buffer length field in the item descriptor should specify 4 (bytes). SYI$_NODE_SWVERSReturns the software version of the node.Because the software version is a 4-byte ASCII string, the buffer length field in the item descriptor should specify 4 (bytes). SYI$_NODE_SYSTEMIDReturns the system identification of the node.The OpenVMS Cluster management software assigns this system identification to the node. You can obtain this information by using the DCL command SHOW CLUSTER. Because the system identification is a 6-byte hexadecimal number, the buffer length field in the item descriptor should specify 6 (bytes). SYI$_NODE_VOTESReturns the number (in decimal) of votes held by the node. This number is determined by the node's system parameter VOTES.Because this number is a word in length, the buffer length field in the item descriptor should specify 2 (bytes). SYI$_NODENAMEReturns, as a character string, the name of the node in the buffer specified in the item list.Because this name can include up to 15 characters, the buffer length field in the item descriptor should specify 15 (bytes). SYI$_PAGEFILE_FREEReturns the number of free pages in the currently installed page files.Because this number is a longword, the buffer length field in the item descriptor should specify 4 (bytes). SYI$_PAGEFILE_PAGEReturns the number of pages in the currently installed page files.Because this number is a longword, the buffer length field in the item descriptor should specify 4 (bytes). SYI$_PAGE_SIZEReturns the number of CPU-specific bytes per page in the system.On Alpha and Integrity server systems, CPU page size varies from system to system. On Alpha, and Integrity servers, because this number is a longword, the buffer length field in the item descriptor should specify 4 (bytes). SYI$_PARTITION_IDOn Alpha and Integrity server systems, returns the soft partition ID. Supported only on AlphaServer systems that support partitioning.SYI$_PFN_MEMORY_MAP---Alpha OnlyReturns a map describing the system's use of physical memory. Figure SYS-1 shows an example of a physical memory map.Figure SYS-1 SYI$_PFN_MEMORY_MAP---Alpha Only 
The first longword of the physical memory contains a count of descriptors. This number is equal to the value returned when the SYI$_PMD_COUNT item code is specified. Each descriptor contains at least 3 longwords: a word containing the length of the descriptor (always use PMM$C_LENGTH when determining descriptor size); a flags word (whose bits are defined in the following table); and the starting PFN for that physical memory cluster and the number of PFNs in that cluster.
The structure definition for the physical memory descriptor resides in PMMDEF.H. Because the size of the physical memory map returned by $GETSYI can vary from system to system, HP recommends using the following steps when using this item code:
SYI$_PFN_MEMORY_MAP_64---on Alpha and Integrity serversReturns a map describing the system's use of physical memory on Alpha and Integrity servers only. Figure SYS-2 shows an example of a physical memory map.Figure SYS-2 SYI$_PFN_MEMORY_MAP---Alpha and Integrity servers 
The first longword of the physical memory contains a count of descriptors. This number is equal to the value returned when the SYI$_PMD_COUNT item code is specified. Each descriptor contains at least 3 longwords: a word containing the length of the descriptor (always use PMM64$C_LENGTH when determining descriptor size); a flags word (whose bits are defined in the following table); and the starting PFN for that physical memory cluster and the number of PFNs in that cluster.
|