UFM - Formatting user exit parameter list

Table 1. UFM data area

This table has 6 columns and 2 header rows. In the first header row, the "Offsets" heading spans columns 1 and 2. The "Offsets" heading has 2 subheadings in the second header row: "Dec" in column 1 and "Hex" in column 2.

Offsets Type Access Len Name and description
Dec Hex
0 (0) CHAR R/O 4 VERSION

Parameter list version (currently 0001).

4 (4) CHAR R/W 100 USEROPTIONTITLE

Report section heading for output from all Formatting user exits run using the Exits option. Initialized to the heading set by any previously called Formatting user exit. The initial default for the batch report is "U S E R", and for the interactive reanalysis report it is "User".

104 (68) CHAR R/O 91 (Reserved)
195 (C3) CHAR R/O 5 NUM_EVENTS

Total number of events (decimal).

All fields from here on are populated with data for a single event only. To populate with data for another event, use the IDIEventInfo command.
200 (C8) CHAR R/W 5 EVENT_NO

Current® event number (nnnnn).

205 (CD) CHAR R/O 5 NEXT_EVENT_NO

Next available event number (decimal).

210 (D2) CHAR R/O 5 PREVIOUS_EVENT_NO

Previous available event number (decimal).

215 (D7) CHAR R/O 1 POF

Point of failure (Y/N).

216 (D8) CHAR R/O 30 EVENT_TYPE

Event type in the same format as shown in the Event Summary section of the analysis report, for example, "Abend S0C7".

If data for this field exceeds the field size, then a buffered data format is used. For details, see Non-REXX user exit buffered data format. The format of this field is transparent to users of REXX exits.

If Language(JPN) is in effect, then the event type description provided in this field is subject to translation into Japanese.

246 (F6) CHAR R/O 12 MODULE_NAME

Module name.

If data for this field exceeds the field size, then a buffered data format is used. For details, see Non-REXX user exit buffered data format. The format of this field is transparent to users of REXX exits.

258 (102) CHAR R/O 8 MODULE_ADDRESS

Module address.

266 (10A) CHAR R/O 8 MODULE_LENGTH

Module length (hexadecimal).

274 (112) CHAR R/O 12 PROGRAM_NAME

Program name.

If data for this field exceeds the field size, then a buffered data format is used. For details, see Non-REXX user exit buffered data format. The format of this field is transparent to users of REXX exits.

286 (11E) CHAR R/O 8 PROGRAM_ADDRESS

Program address.

294 (126) CHAR R/O 8 PROGRAM_LENGTH

Program length (hexadecimal).

302 (12E) CHAR R/O 12 EP_NAME

Entry point name.

If data for this field exceeds the field size, then a buffered data format is used. For details, see Non-REXX user exit buffered data format. The format of this field is transparent to users of REXX exits.

314 (13A) CHAR R/O 8 EP_ADDRESS

Entry point address.

322 (142) CHAR R/O 64 EVENT_LOCATION

Event location in the same format as shown in the Event Summary section of the analysis report, for example, "L#31 P+3D4".

If data for this field exceeds the field size, then a buffered data format is used. For details, see Non-REXX user exit buffered data format. The format of this field is transparent to users of REXX exits.

386 (182) CHAR R/O 44 LOADED_FROM

Information about from where the module was loaded in the same format as shown in the Event Summary section of the analysis report, for example, a data set name.

If data for this field exceeds the field size, then a buffered data format is used. For details, see Non-REXX user exit buffered data format. The format of this field is transparent to users of REXX exits.

430 (1AE) CHAR R/O 8 INSTRUCTION_ADDRESS

The event instruction address.

438 (1B6) CHAR R/O 2 AMODE

The event addressing mode (24/31/64).

440 (1B8) CHAR R/O 16 PSW

The event PSW.

456 (1C8) CHAR R/O 8 GPREG0

General purpose register 0.

464 (1D0) CHAR R/O 8 GPREG1

General purpose register 1.

472 (1D8) CHAR R/O 8 GPREG2

General purpose register 2.

480 (1E0) CHAR R/O 8 GPREG3

General purpose register 3.

488 (1E8) CHAR R/O 8 GPREG4

General purpose register 4.

496 (1F0) CHAR R/O 8 GPREG5

General purpose register 5.

504 (1F8) CHAR R/O 8 GPREG6

General purpose register 6.

512 (200) CHAR R/O 8 GPREG7

General purpose register 7.

520 (208) CHAR R/O 8 GPREG8

General purpose register 8.

528 (210) CHAR R/O 8 GPREG9

General purpose register 9.

536 (218) CHAR R/O 8 GPREG10

General purpose register 10.

544 (220) CHAR R/O 8 GPREG11

General purpose register 11.

552 (228) CHAR R/O 8 GPREG12

General purpose register 12.

560 (230) CHAR R/O 8 GPREG13

General purpose register 13.

568 (238) CHAR R/O 8 GPREG14

General purpose register 14.

576 (240) CHAR R/O 8 GPREG15

General purpose register 15.

584 (248) CHAR R/O 8 AREG_DATA_ADDRESS

Address of storage area containing access registers in hexadecimal format (AR0 through AR15).

592 (250) CHAR R/O 122 (Reserved)
714 (2CA) CHAR R/O 16 BEAR

Breaking event address register.

730 (2DA) CHAR R/W 5 DATA_LENGTH

Data length (nnnnn). This field specifies the length of the record placed in UFM.DATA_BUFFER.

735 (2DF) CHAR R/W 1024 DATA_BUFFER

Data buffer.

No upper case translation is performed on the contents of this field. Truncation by null character (X'00') of this field is not permitted. The length must be provided in the UFM.DATA_LENGTH field.
Note: The purpose of this field is to serve as a record buffer when passing records back to Fault Analyzer from a load module user exit using the ENV.WRITE_ROUTINE_EP program. For details on how to use this buffer, see Formatting user exit. REXX user exits need not use this field as data can be passed back to Fault Analyzer directly using the IDIWRITE command.
1759 (6DF) CHAR R/O 1 (Reserved)
1760 (6E0) CHAR R/O 16 FPREG0

Floating-point register 0.

1776 (6F0) CHAR R/O 16 FPREG1

Floating-point register 1.

1792 (700) CHAR R/O 16 FPREG2

Floating-point register 2.

1808 (710) CHAR R/O 16 FPREG3

Floating-point register 3.

1824 (720) CHAR R/O 16 FPREG4

Floating-point register 4.

1840 (730) CHAR R/O 16 FPREG5

Floating-point register 5.

1856 (740) CHAR R/O 16 FPREG6

Floating-point register 6.

1872 (750) CHAR R/O 16 FPREG7

Floating-point register 7.

1888 (760) CHAR R/O 16 FPREG8

Floating-point register 8.

1904 (770) CHAR R/O 16 FPREG9

Floating-point register 9.

1920 (780) CHAR R/O 16 FPREG10

Floating-point register 10.

1936 (790) CHAR R/O 16 FPREG11

Floating-point register 11.

1952 (7A0) CHAR R/O 16 FPREG12

Floating-point register 12.

1968 (7B0) CHAR R/O 16 FPREG13

Floating-point register 13.

1984 (7C0) CHAR R/O 16 FPREG14

Floating-point register 14.

2000 (7D0) CHAR R/O 16 FPREG15

Floating-point register 15.

2016 (7E0) CHAR R/O 8 FPCR

Floating-point control register.

2024 (7E8) CHAR R/O 1 GPREGS_64BIT

64-bit general purpose registers available (Y/N).

2025 (7E9) CHAR R/O 16 GPREG0_64BIT

General purpose register 0 (64-bit).

2041 (7F9) CHAR R/O 16 GPREG1_64BIT

General purpose register 1 (64-bit).

2057 (809) CHAR R/O 16 GPREG2_64BIT

General purpose register 2 (64-bit).

2073 (819) CHAR R/O 16 GPREG3_64BIT

General purpose register 3 (64-bit).

2089 (829) CHAR R/O 16 GPREG4_64BIT

General purpose register 4 (64-bit).

2105 (839) CHAR R/O 16 GPREG5_64BIT

General purpose register 5 (64-bit).

2121 (849) CHAR R/O 16 GPREG6_64BIT

General purpose register 6 (64-bit).

2137 (859) CHAR R/O 16 GPREG7_64BIT

General purpose register 7 (64-bit).

2153 (869) CHAR R/O 16 GPREG8_64BIT

General purpose register 8 (64-bit).

2169 (879) CHAR R/O 16 GPREG9_64BIT

General purpose register 9 (64-bit).

2185 (889) CHAR R/O 16 GPREG10_64BIT

General purpose register 10 (64-bit).

2201 (899) CHAR R/O 16 GPREG11_64BIT

General purpose register 11 (64-bit).

2217 (8A9) CHAR R/O 16 GPREG12_64BIT

General purpose register 12 (64-bit).

2233 (8B9) CHAR R/O 16 GPREG13_64BIT

General purpose register 13 (64-bit).

2249 (8C9) CHAR R/O 16 GPREG14_64BIT

General purpose register 14 (64-bit).

2265 (8D9) CHAR R/O 16 GPREG15_64BIT

General purpose register 15 (64-bit).

2281 (8E9) CHAR R/O 32 VFREG0

Vector facility register 0.

2313 (909) CHAR R/O 32 VFREG1

Vector facility register 1.

2345 (929) CHAR R/O 32 VFREG2

Vector facility register 2.

2377 (949) CHAR R/O 32 VFREG3

Vector facility register 3.

2409 (969) CHAR R/O 32 VFREG4

Vector facility register 4.

2441 (989) CHAR R/O 32 VFREG5

Vector facility register 5.

2473 (9A9) CHAR R/O 32 VFREG6

Vector facility register 6.

2505 (9C9) CHAR R/O 32 VFREG7

Vector facility register 7.

2537 (9E9) CHAR R/O 32 VFREG8

Vector facility register 8.

2569 (A09) CHAR R/O 32 VFREG9

Vector facility register 9.

2601 (A29) CHAR R/O 32 VFREG10

Vector facility register 10.

2633 (A49) CHAR R/O 32 VFREG11

Vector facility register 11.

2665 (A69) CHAR R/O 32 VFREG12

Vector facility register 12.

2697 (A89) CHAR R/O 32 VFREG13

Vector facility register 13.

2729 (AA9) CHAR R/O 32 VFREG14

Vector facility register 14.

2761 (AC9) CHAR R/O 32 VFREG15

Vector facility register 15.

2793 (AE9) CHAR R/O 32 VFREG16

Vector facility register 16.

2825 (B09) CHAR R/O 32 VFREG17

Vector facility register 17.

2857 (B29) CHAR R/O 32 VFREG18

Vector facility register 18.

2889 (B49) CHAR R/O 32 VFREG19

Vector facility register 19.

2921 (B69) CHAR R/O 32 VFREG20

Vector facility register 20.

2953 (B89) CHAR R/O 32 VFREG21

Vector facility register 21.

2985 (BA9) CHAR R/O 32 VFREG22

Vector facility register 22.

3017 (BC9) CHAR R/O 32 VFREG23

Vector facility register 23.

3049 (BE9) CHAR R/O 32 VFREG24

Vector facility register 24.

3081 (C09) CHAR R/O 32 VFREG25

Vector facility register 25.

3113 (C29) CHAR R/O 32 VFREG26

Vector facility register 26.

3145 (C49) CHAR R/O 32 VFREG27

Vector facility register 27.

3177 (C69) CHAR R/O 32 VFREG28

Vector facility register 28.

3209 (C89) CHAR R/O 32 VFREG29

Vector facility register 29.

3241 (CA9) CHAR R/O 32 VFREG30

Vector facility register 30.

3273 (CC9) CHAR R/O 32 VFREG31

Vector facility register 31.

The following GPREGn_VALID fields apply to both GPREGn and GPREGn_64BIT general purpose register values. That is, if the value for register n is 'N', then neither GPREGn nor GPREGn_64BIT are valid.

3305 (CE9) CHAR R/O 1 GPREG0_VALID

General purpose register 0 valid (Y/N).

3306 (CEA) CHAR R/O 1 GPREG1_VALID

General purpose register 1 valid (Y/N).

3307 (CEB) CHAR R/O 1 GPREG2_VALID

General purpose register 2 valid (Y/N).

3308 (CEC) CHAR R/O 1 GPREG3_VALID

General purpose register 3 valid (Y/N).

3309 (CED) CHAR R/O 1 GPREG4_VALID

General purpose register 4 valid (Y/N).

3310 (CEE) CHAR R/O 1 GPREG5_VALID

General purpose register 5 valid (Y/N).

3311 (CEF) CHAR R/O 1 GPREG6_VALID

General purpose register 6 valid (Y/N).

3312 (CF0) CHAR R/O 1 GPREG7_VALID

General purpose register 7 valid (Y/N).

3313 (CF1) CHAR R/O 1 GPREG8_VALID

General purpose register 8 valid (Y/N).

3314 (CF2) CHAR R/O 1 GPREG9_VALID

General purpose register 9 valid (Y/N).

3315 (CF3) CHAR R/O 1 GPREG10_VALID

General purpose register 10 valid (Y/N).

3316 (CF4) CHAR R/O 1 GPREG11_VALID

General purpose register 11 valid (Y/N).

3317 (CF5) CHAR R/O 1 GPREG12_VALID

General purpose register 12 valid (Y/N).

3318 (CF6) CHAR R/O 1 GPREG13_VALID

General purpose register 13 valid (Y/N).

3319 (CF7) CHAR R/O 1 GPREG14_VALID

General purpose register 14 valid (Y/N).

3320 (CF8) CHAR R/O 1 GPREG15_VALID

General purpose register 15 valid (Y/N).