UCBINFO PAVINFO

The standard form of the PAVINFO option of the UCBINFO macro is written as follows:

The parameters are explained as follows:

PAVINFO

Obtain selected information that applies to each exposure of a Parallel Access Volume (PAV) device. The data returned by this function is mapped by the mapping macro IOSDPAVA and consists of a header and one or more entries. Depending on the input device, the following is returned:

• When the input device is a PAV-base, the first entry represents the base and each subsequent entry represents each of the bound PAV-alias devices associated with the base. Note that if the base has no bound PAV-aliases, then only the first entry is filled in.
• When the input is a non-PAV DASD device, only the first entry is filled in.
• When the input device is a PAV-alias or a non-DASD, a non-zero return code is returned.

PAVINFOSUM=NO

PAVINFOSUM=YES

Specifies whether to retrieve only a sum of channel measurement data and model dependent subchannel data for the base device and all of its aliases.

Note: The model dependent subchannel data is only retrieved if SCHINFO=YES.

NO

Do not just retrieve a total of channel measurement data and model dependent subchannel data for the base device and all of its aliases. This option causes a PAVA entry to be created for the base device and each of its aliases.

YES

Retrieve only a sum of channel measurement data and model dependent subchannel data for the base device and all of its aliases. This option causes the first PAVA entry to contain information on the base device, however, the measurement-related fields (such as PAVACMB, PAVASMDB, and PAVAECMB) will contain totals for the base and all of its aliases.

,PAVAREA=pavarea addr

Specifies the address of a required output field into which the system will return information about the alias UCBs for the specified base device number. This field is mapped by the mapping macro IOSDPAVA.

,PAVLEN=pavarea lengthaddr

Specifies the address or a register containing the length of the area specified by the PAVAREA parameter.

,SCHINFO=NO

,SCHINFO=YES

This parameter specifies whether or not to retrieve model-dependent subchannel data (control unit busy time, switch busy time, and device busy time) for the device. If you issue this request from a system running on a z990 or higher processor, the system ignores the SCHINFO parameter, but still returns the device busy time.

NO

Do not retrieve model-dependent subchannel data for the device. Note that even if you specify NO on a z990 or higher processor, the service will still return the device busy time.

YES

Retrieve model-dependent subchannel data for the device, which includes control unit busy time, switch busy time, and device busy time. If you specify YES on a z990 or higher processor, the service will still return the device busy time.

,EXTFORMAT=NO

,EXTFORMAT=YES

This parameter specifies whether an extended format PAV area should be created. An extended format PAV area contains a length field in each entry that defines the actual length of the entry. This allows the PAV entry to be extended compatibly to add new information. A non-extended format PAV area contains entries which are fixed in size (60 bytes) and cannot be extended to contain new data. See the mapping macro IOSDPAVA for more information.

Note: The value specified for the EXTFORMAT keyword on the UCBINFO PAVINFO macro must match the value specified on the IOSDPAVA macro. Otherwise, your program may not work correctly.

NO

Create the non-extended format PAV area.

YES

Create the extended format PAV area.

,OUTVERSION=outver

Specifies the output version to be used when creating an extended format PAV area. The output version controls the size of the PAV entries that are returned. This parameter is used only if EXTFORMAT(YES) is specified; it is ignored for EXTFORMAT(NO) requests. If an output version that is less than 3 is specified, version 3 is used. If an output version that is higher than the currently supported version is specified, the highest supported version is used.

Note: Currently, version 3 is the only supported value.

,DEVN=devn addr

Specifies the address of a halfword that contains the base device number in binary form.

,SCHSET=schset

,SCHSET=0

Specifies the name (RS-type), or address in register (2)-(12), of an optional byte input that specifies a subchannel set for which the information that applies to each exposure of a Parallel Access Volume (PAV) device is to be obtained. DEFAULT: 0.

,IOCTOKEN=ioctoken addr

Specifies the address of a 48-character storage area that contains the MVS I/O configuration token. The caller can obtain this token by issuing the IOCINFO macro. z/OS MVS Programming: Assembler Services Reference ABE-HSP If the I/O configuration token that is current when UCBINFO is invoked does not match the token whose address is supplied here, the system issues a return code to the caller.

If you set the input IOCTOKEN (specified by ioctoken addr) to binary zeros, UCBINFO sets IOCTOKEN to the current I/O configuration token.

,PLISTVER=IMPLIED_VERSION

,PLISTVER=MAX

,PLISTVER=plistver

Specifies the version of the macro. PLISTVER determines which parameter list the system generates. PLISTVER is an optional input parameter on all forms of the macro, including the list form. When using PLISTVER, specify it on all macro forms used for a request and with the same value on all of the macro forms. The values are:

• IMPLIED_VERSION, which is the lowest version that allows all parameters specified on the request to be processed. If you omit the PLISTVER parameter, IMPLIED_VERSION is the default.
• MAX, if you want the parameter list to be the largest size currently possible. This size might grow from release to release and affect the amount of storage that your program needs.

  If you can tolerate the size change, IBM recommends that you always specify PLISTVER=MAX on the list form of the macro. Specifying MAX ensures that the list-form parameter list is always long enough to hold all the parameters you might specify on the execute form; in this way, MAX ensures that the parameter list does not overwrite nearby storage.

• 2, if you use the currently available parameters.

To code, specify in this input parameter one of the following:

• IMPLIED_VERSION
• MAX
• A decimal value in the range of 1 - 3.

,RETCODE=retcode addr

Specifies the address of a fullword field into which the system copies the return code from GPR 15.

,RSNCODE=rsncode addr

Specifies the address of a fullword field into which the system copies the reason code from GPR 0.

When the UCBINFO PAVINFO macro returns control to your program, GPR 15 (or retcode addr, if you coded RETCODE) contains a return code, and GPR 0 (or rsncode addr, if you coded RSNCODE) contains a reason code.