Document revision date: 30 March 2001

## OpenVMS System Services Reference Manual

Previous | Contents | Index

Because this number is a word in length, the buffer length field in the item descriptor should specify 2 (bytes).

#### SYI$_CLUSTER_FSYSID

Returns 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_FTIME

Returns 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_MEMBER

Returns 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_NODES

Returns 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_QUORUM

Returns 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_VOTES

Returns 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_ID

On Alpha systems, returns the integer Galaxy community ID.

#### SYI$_CONTIG_GBLPAGES

Returns 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$_CPU

On VAX systems, returns the CPU processor type, as represented in the processor's system identification (SID) register.

For example, the integer 1 represents a VAX--11/780 system and the integer 6 represents a VAX 8530, VAX 8550, VAX 8700, or VAX 8800 system.

Because the processor type is a longword decimal number, the buffer length field in the item descriptor should specify 4 (bytes).

The $PRDEF macro defines the following symbols for the processor types:

Processor | Symbol
--- | ---
VAX-11/730 | PR$_SID_TYP730
VAX-11/750 | PR$_SID_TYP750
VAX-11/780, 785 | PR$_SID_TYP780
VAXstation II, II/GPX, and MicroVAX II | PR$_SID_TYPUV2
VAXstation 2000/MicroVAX 2000 | PR$_SID_TYP410
VAX 8200, 8250, 8300, 8350 | PR$_SID_TYP8SS
VAX 8530, 8550, 8810 (8700), and 8820-N (8800) | PR$_SID_TYP8NN
VAX 8600, 8650 | PR$_SID_TYP790
VAX 8820, 8830, 8840 | PR$_SID_TYP8PS
VAXft 3000 Model 310 | PR$_SID_TYP520
VAXstation, MicroVAX 3100 series | PR$_SID_TYP420
MicroVAX 3300, 3400, 3500, 3600, 3800, 3900 | PR$_SID_TYP650
VAXstation 3520, 3540 | PR$_SID_TYP60
VAX 4000-300 | PR$_SID_TYP670
VAX 6000-200, 6000-300 series | PR$_SID_TYP9CC
VAX 6000-400 series | PR$_SID_TYP9RR
VAX 9000-200, 9000-400 series | PR$_SID_TYP9AQ

On Alpha systems, $GETSYI returns PR$_SID_TYP_NOTAVAX.

For information about extended processor type codes, see the description for the SYI$_XCPU item code.

#### SYI$_CPUCAP_MASK

On Alpha 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$_CPUCONF

On Alpha systems, returns the CPU Configuration bit mask: 0 through 31.

#### SYI$_CPU_FAILOVER

On Alpha systems, returns the array of CPU failover partitions.

#### SYI$_CPUTYPE

On Alpha 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:

Processor Code | Processor
--- | ---
2 | 21064
4 | 21066
5 | 21164
6 | 21064A
7 | 21164A
8 | 21264

#### SYI$_CWLOGICALS

Returns 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_OVERRIDE

Returns 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_SECONDARY

Returns 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_EMULATED

Returns 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_FULLNAME

Returns, 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_EMULATED

Returns 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_MAX

On Alpha 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_MIN

On Alpha 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$_ERLBUFFERPAGES

Returns the number of pages (on VAX systems) or pagelets (on Alpha systems) in an error log buffer.

Because this number is a longword, the buffer length field in the item descriptor should specify 4 (bytes).

#### SYI$_ERRORLOGBUFFERS

Returns the number of system pages (on VAX systems) or pagelets (on Alpha systems) 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_EMULATED

Returns 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_GBLPAGES

Returns 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_GBLSECTS

Returns 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_EMULATED

Returns 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_ID

On Alpha systems, returns the 128-bit Galaxy ID.

#### SYI$_GALAXY_MEMBER

On Alpha systems, returns 1 if you are member of a Galaxy sharing community, 0 if you are not a member.

#### SYI$_GALAXY_PLATFORM

On Alpha systems, returns 1 if you are running on a Galaxy platform, 0 if you are not running on a Galaxy platform.

#### SYI$_GALAXY_SHMEMSIZE

On 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.

#### SYI$_GH_RSRVPGCNT

On Alpha 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$_H_FLOAT_EMULATED

Returns 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$_HW_MODEL

Returns a small integer that can be used to identify the model type of the node.

An integer greater than 1023 indicates an Alpha 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. See the tables under the SYI$_HW_NAME item code for the VAX processor names and the corresponding model types.

Because SYI$_HW_MODEL is a word, the buffer length field in the item descriptor should specify 2 (bytes).

#### SYI$_HW_NAME

Returns the model name string of the node. The model name is a character string that describes the model of the node (such as VAX 8800, MicroVAX II). 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 31 characters, the buffer length field in the item descriptor should specify 31 (bytes).

The following table lists the Alpha model processor names and the corresponding model types:

Alpha Model Processor Name | Alpha Model Type
--- | ---
DEC 3000 400 | ALPHA$K_A3000_400W
DEC 3000 400S | ALPHA$K_A3000_400S
DEC 3000 500 | ALPHA$K_A3000_500W
DEC 3000 500S | ALPHA$K_A3000_500S
DEC 4000 610 | ALPHA$K_A4000_610
DEC 4000 620 | ALPHA$K_A4000_620
DEC 4000 630 | ALPHA$K_A4000_630
DEC 4000 640 | ALPHA$K_A4000_640
DEC 7000 Model 610 | ALPHA$K_A7000_610
DEC 7000 Model 620 | ALPHA$K_A7000_620
DEC 7000 Model 630 | ALPHA$K_A7000_630
DEC 7000 Model 640 | ALPHA$K_A7000_640
DEC 10000 Model 610 | ALPHA$K_A10000_610
DEC 10000 Model 620 | ALPHA$K_A10000_620
DEC 10000 Model 630 | ALPHA$K_A10000_630
DEC 10000 Model 640 | ALPHA$K_A10000_640

The following table lists the VAX model processor names and the corresponding model types:

VAX Model Processor Name | VAX Model Type
--- | ---
VAX-11/730 | VAX$K_V730
VAX-11/750 | VAX$K_V750
VAX-11/780 | VAX$K_V780
VAX-11/785 | VAX$K_V785
MicroVAX II | VAX$K_VUV2
VAXstation II | VAX$K_VWS2
VAXstation II/GPX | VAX$K_VWSD
VAXstation 2000 | VAX$K_VWS2000
MicroVAX 2000 | VAX$K_VUV2000
VAXstation 2000/GPX | VAX$K_VWSD2000
VAX 8200 | VAX$K_V8200
VAX 8250 | VAX$K_V8250
VAX 8300 | VAX$K_V8300
VAX 8350 | VAX$K_V8350
VAX 8530 | VAX$K_V8500
VAX 8550 | VAX$K_V8550
VAX 8600 | VAX$K_V8600
VAX 8650 | VAX$K_V8650
VAX 8810 (8700) | VAX$K_V8700
VAX 8820-N (8800) | VAX$K_V8800
VAX 8820, 8830, or 8840 with one CPU enabled | VAX$K_V8810
VAX 8820 | VAX$K_V8820
VAX 8830 | VAX$K_V8830
VAX 8840 | VAX$K_V8840
VAXft 3000 Model 310 | VAX$K_V520FT
VAXstation 3520 | VAX$K_V3520L
VAXstation 3540 | VAX$K_V3540L
VAX 4000-300 timeshare | VAX$K_V670
VAX 4000-300 server | VAX$K_V670_S
VAX 6000-210 timeshare | VAX$K_V6210_T
VAX 6000-220 timeshare | VAX$K_V6220_T
VAX 6000-230 timeshare | VAX$K_V6230_T
VAX 6000-240 timeshare | VAX$K_V6240_T
VAX 6000-250 timeshare | VAX$K_V6250_T
VAX 6000-260 timeshare | VAX$K_V6260_T
VAX 6000-210 server | VAX$K_V6210_S
VAX 6000-220 server | VAX$K_V6220_S
VAX 6000-310 timeshare | VAX$K_V6310_T
VAX 6000-320 timeshare | VAX$K_V6320_T
VAX 6000-330 timeshare | VAX$K_V6330_T
VAX 6000-340 timeshare | VAX$K_V6340_T
VAX 6000-350 timeshare | VAX$K_V6350_T
VAX 6000-360 timeshare | VAX$K_V6360_T
VAX 6000-310 server | VAX$K_V6310_S
VAX 6000-320 server | VAX$K_V6320_S
VAX 6000-410 timeshare | VAX$K_V9RR10_T
VAX 6000-420 timeshare | VAX$K_V9RR20_T
VAX 6000-430 timeshare | VAX$K_V9RR30_T
VAX 6000-440 timeshare | VAX$K_V9RR40_T
VAX 6000-450 timeshare | VAX$K_V9RR50_T
VAX 6000-460 timeshare | VAX$K_V9RR60_T
VAX 6000-410 server | VAX$K_V9RR10_S
VAX 6000-420 server | VAX$K_V9RR20_S
VAX 9000-210 | VAX$K_V9AR10
VAX 9000-410 | VAX$K_V9AQ10
VAX 9000-420 | VAX$K_V9AQ20
VAX 9000-430 | VAX$K_V9AQ30
VAX 9000-440 | VAX$K_V9AQ40

#### SYI$_IO_PREFER_CPU

On Alpha systems, returns the bit mask of CPUs available to be Fast Path preferred CPUs.

#### SYI$_ITB_ENTRIES

On Alpha 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_CPUS

On Alpha systems, returns the maximum number of CPUs that can exist in the current configuration of the symmetric multiprocessing (SMP) system.

#### SYI$_MAX_PFN

Returns 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$_MEMSIZE

Returns 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_AREA

Returns 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_CSID

Returns 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_EVOTES

Returns 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_HWVERS

Returns the hardware version of the node. The high word of the buffer length contains the CPU type. The $VAXDEF and $ALPHADEF macros define the CPU types.

Because the hardware version is a 12-byte hexadecimal number, the buffer length field in the item descriptor should specify 12 (bytes).

#### SYI$_NODE_NUMBER

Returns 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_QUORUM

Returns 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_SWINCARN

Returns 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_SWTYPE

Returns the software type of the node. The software type indicates whether the node is a VAX system, an Alpha 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_SWVERS

Returns 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_SYSTEMID

Returns 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_VOTES

Returns 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$_NODENAME

Returns, 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_FREE

Returns 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_PAGE

Returns 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_SIZE

Returns the number of CPU-specific bytes per page in the system.

On VAX systems, $GETSYI always returns 512.

On Alpha systems, CPU page size varies from system to system.

On Alpha and VAX systems, because this number is a longword, the buffer length field in the item descriptor should specify 4 (bytes).

#### SYI$_PARTITION_ID

On Alpha systems, returns the integer Galaxy partition ID.

#### SYI$_PFN_MEMORY_MAP

Returns a map describing the system's use of physical memory. The following figure shows an example of a physical memory map:

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.

Bit | Meaning When Set
--- | ---
PMM$V_CONSOLE | The physical memory descriptor is in use by the console (hardware).
PMM$V_OPENVMS | The physical memory descriptor is in use by OpenVMS.
PMM$V_AVAILABLE | The physical descriptor is not in use by either the console (hardware) or OpenVMS.
Remaining bits | The remaining bits in the PMM$W_FLAGS word are reserved for Compaq.

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, Compaq recommends using the following steps when using this item code:

1. Call $GETSYI first using the SYI$_PMD_COUNT to obtain the number of physical memory descriptors.
2. Dynamically create a buffer to which $GETSYI can copy the physical memory map. The size of the buffer can be computed with the following formula:

       map_buffer_size = (PMM$C_LENGTH * ret-val) + 4

   where:
   - PMM$C_LENGTH is the size of an individual physical memory descriptor.
   - ret-val is the return value from a call to $GETSYI specifying the SYI$_PMD_COUNT item code.
   - 4 is the number of bytes occupied by the descriptor count in the physical memory map.

#### SYI$_PHYSICALPAGES

Returns the total number of PFNs that exist between the first PFN (typically PFN 0) and the highest numbered PFN.

Previous | Next | Contents | Index

| privacy and legal statement |
4527PRO_054.HTML