Description

The requirements for the caller with BRANCH=NO are:

Assuming that one of the above conditions has been satisfied, other requirements for callers with BRANCH=YES are:

To generate reentrant code, code the list and execute forms of the SDUMP macro. Because the execute form of the macro is dependent on the length determined by the list form, the list form must appear before the execute form in a reentrant program.

SDUMPBEG SDUMP SDATA=(SUM),SUMLIST=SLIST,MF=L
SDUMPEND EQU   *
SDUMPLEN DC    A(SDUMPEND-SDUMPBEG)

Callers that issue SDUMP with BRANCH=YES must include the CVT mapping macro.

For SVC entry, the caller cannot have an EUT FRR established.

Upon invocation, general purpose register (GPR) 13 must contain the address of a 72-byte savearea if BRANCH=YES is specified.

After the caller issues the macro, the system might use some registers as work registers or might change the contents of some registers. When the system returns control to the caller, the contents of these registers are not the same as they were before the macro was issued. Therefore, if the caller depends on these registers containing the same value before and after issuing the macro, the caller must save these registers before issuing the macro and restore them after the system returns control.

None.

The standard form of the SDUMP macro is written as follows:

The parameters are explained as follows:

,ASID=ASID addr

,ASIDLST=list addr

Specifies the address of a halfword or a list of halfwords containing the hexadecimal address space identifier of an address space to be dumped. If register notation is used, the low-order halfword of the register contains the address space identifier of the address space to be dumped. If both parameters are omitted, the primary address space is dumped. If 0 is specified for the address space identifier, a dump is scheduled for the home address space of the issuer of the SDUMP macro. No private area storage is included in the dump for the specified address space if either of the following events occurred:

• No SDATA parameters were specified that apply to the private area of the requested address space.
• The CHNGDUMP operator command was used to set an overriding parameter in the system dump options list that limits SVC dumps to areas outside of the private area.

The ASID list can contain a maximum of 15 address space identifiers. The high-order bit of the halfword containing the last identifier of the list must be set to 1, and all other high-order bits must be set to 0.

,BRANCH=NO

,BRANCH=YES

Specifies that a branch entry is to be used for interfacing with SVC dump to schedule a dump (YES), or that an SVC instruction is to be generated for interfacing with SVC dump (NO).

For BRANCH=YES, MVS produces a scheduled (asynchronous) SVC dump. For BRANCH=NO, the parameters you code to identify storage determine whether MVS produces a scheduled or synchronous SVC dump. MVS produces a scheduled dump when you code BRANCH=NO with one or more of the following:

• ASIDLIST
• ASID=asid addr
• TYPE=XMEM or TYPE=XMEME
• LISTA
• LISTD=list addr, when the STOKEN represents either an address space other than the primary address space, or a SCOPE=SINGLE data space owned by a program that is not running in the primary address space.
• SUBPLST=subpool id list addr, when the list of address spaces with associated subpool IDs contains at least one address space other than the primary address space.

You might make different design decisions for your program based on the type of dump MVS produces. See z/OS MVS Programming: Authorized Assembler Services Guide for guidance about designing your program to handle each type of dump. If BRANCH=YES is specified and the caller has not specified at least one of the following keywords: ASID, ASIDLST, TYPE=XMEM, TYPE=XMEME, or LISTA, the dump is scheduled to the home address space. Routines that issue SDUMP with BRANCH=YES must provide a 72-byte save area pointed to by register 13, and must include the CVT mapping macro.

For BRANCH=YES entry by reentrant recovery routines, SDUMP processing moves the data supplied by the following parameters to a system area:

• HDR
• HDRAD
• ID
• IDAD
• ASIDLIST
• STORAGE
• LIST
• LISTA
• SUBPLST
• KEYLIST

This enables the recovery routine to free its storage on return from SDUMP although the dump has not completed.

,BUFFER=NO

,BUFFER=YES

Specifies that the contents of the SQA buffer is (YES) or is not (NO) to be included in the dump. This is an archaic interface so consider obtaining a summary dump instead. Details about summary dump invocations are associated with the SUMDUMP parameter of the SDUMPX macro description. (The SQA buffer does not include the SDUMP parameter list or any data pointed to by the parameter list.) Callers who specify BUFFER=YES on the SDUMP macro will obtain a dump of a 4KB buffer reserved in the SQA for the callers of SVC dump. You can reserve the buffer by setting the high-order bit of the CVTSDBF field in the communications vector table (CVT). Once you have reserved the buffer, you can fill it with data before issuing SDUMP. Programs that are involved with data that might change before SDUMP can dump it should instead use the SUMDUMP parameter to request a summary dump. Some of the problems associated with using the BUFFER=YES parameter are addressed using the SUMDUMP interface.

The CVTSDBF field of the CVT points to the buffer. Before using the buffer, use compare and swap logic to serialize on the high-order bit of CVTSDBF. If the bit was on (B'1'), the buffer is in use, and you should continue processing as though a dump could not be taken. If the bit was off (B'0'), the bit is set to B'1' by the compare and swap instruction. You must also set the ASCBSDBF bit of the home address space ASCB immediately after setting the CVTSDBF high-order bit to B'1', also by the compare and swap instruction. You can then fill the buffer and issue SDUMP. If the compare and swap instruction sets the CVTSDBF bit, SDUMP resets both CVTSDBF and ASCBSDBF for you. If you do not take the SDUMP, you must reset both bits (resetting ASCBSDBF first, by the compare and swap instruction). SDUMP resets the CVTSDBF bit if your home address space terminates.

,DCB=dcb addr

Specifies the address of a previously opened data control block (DCB) for the data set that is to contain the dump. If this parameter is omitted, one of the SYS1.DUMP data sets is used. When you specify the DCB parameter, the dump contains data from only the requestor's home address space. The DCB must be addressable from the home address space. The control blocks built by OPEN must also be addressable from the home address space. The DCB must support EXCP. You must specify the following parameters on the DCB macro: RECFM=FB, LRECL=4160, and BLKSIZE=4160.

The DCB must reference device types supported by SVC dump. Eligible device types are unlabeled 9-track 2400-series tape devices (or tape devices compatible with the 2400-series) and any direct access devices supported by the system that have a track size of at least 4160 bytes. (4160 bytes equals 1 SVC dump output record.) SVC dump does not support secondary extents on DCB data sets.

SVC dump does not close the dump data set. Use the CLOSE macro to close the data set and cause an end-of-file mark or a tape mark to be placed after the dump data. SVC dump sets up the DCB so that CLOSE works correctly and positions the end-of-file mark or tape mark at the correct place on the data set. For tape data sets, you can write a tape mark to separate multiple dumps without using the CLOSE macro.

Because it is the caller's responsibility to close the dump data set and the data set may be closed only after all the data has been written to it, the caller needs to receive notification when the dump writing phase is complete. Therefore, if you specify the DCB parameter with the ECB parameter, the system posts the ECB at the completion of the dump writing phase. The ECB parameter is required when a DCB is provided for scheduled dumps. If an ECB is not provided with the DCB for a synchronous dump, SVC dump returns to the caller at the completion of the dump writing phase. See z/OS MVS Programming: Authorized Assembler Services Guide for descriptions of scheduled and synchronous dumps.

,ECB=(ecb addr)

,SRB=(srb addr)

Specifies how the system should synchronize your program with dump processing. Note that these interfaces will not be driven if the call to SDUMP results in a non-zero return code.

ECB specifies that the system should post the event control block (ECB) indicated by ecb addr. The system normally posts the ECB at the completion of the capture phase. However, if you specify the DCB parameter with the ECB parameter, the system posts the ECB at the completion of the dump writing phase. If the capture phase is not successful, the system posts the ECB at the completion of SVC dump processing.

If an A-type address is specified, ecb addr specifies the address of a fullword containing the address of the ECB. If a register operand is used, the register must contain the actual address of the ECB. If this parameter is omitted, the caller is not notified of the completion of the capture phase. The fullword and the ECB must be addressable from the home address space. The fullword address that points to the ECB must be a 24-bit or 31-bit address.

SRB specifies that the system should schedule the service request block (SRB) indicated by srb addr. The system normally schedules the SRB at the completion of the capture phase. However, if you specify the DCB parameter with the SRB parameter, the system schedules the SRB at the completion of the dump writing phase. If the capture phase is not successful, the system schedules the SRB at the completion of SVC dump processing.

When the caller builds the SRB, the caller may pass the address of a status area in the SRBPARM field. This status area, SDSTATUS, is mapped by IHASDST. SVC dump passes information about the dump to the SRB routine by means of this status area. If SVC dump schedules the SRB at the completion of the capture phase, the name of the dump data set is not passed to the caller.

Note: If you want SVC dump to pass the name of the dump data set to the caller, use the SDUMPX macro and specify SRB=(srb addr,WRITE).

HDR=’dump title’

HDRAD=dump title addr

Specifies the title or address of the title to be used for the dump. If HDR is specified, the title must be 1-100 characters enclosed in apostrophes, although the apostrophes do not appear in the actual title. If HDRAD is specified, the first byte at the indicated address specifies the length of the title in bytes.

If the length of the title is greater than 100, SVC dump issues an abend with a completion code of X'233', reason code X'14', then returns to the caller with a return code of 8. If the length of the title is zero, SVC dump continues processing as if the HDR or HDRAD parameter was not specified.

If these keywords are specified with BRANCH=YES or ASID/ASIDLST (that is, to cause a scheduled dump), the system moves the title to SVC dump storage before it returns control to the caller. There is no requirement to synchronize with the completion of the dump.

,ID=’identifier’

,IDAD=identifier addr

Specifies an identifier that is included in the dump message IEA911E or IEA611I, which is issued at the completion of the dump. The identifier must be from one to 50 printable characters. If ID is specified, the identifier must be enclosed in apostrophes, although the apostrophes do not appear in the actual identifier. If IDAD is specified, the first byte at the indicated address specifies the length of the identifier in bytes. If the length of the identifier is greater than 50, SVC dump issues an abend with a completion code of X'233', reason code X'8C', then returns to the caller with a return code of 8. If the length of the identifier is zero, SVC dump continues processing as if the ID or IDAD parameter was not specified.

,KEYLIST=storage key list addr

Specifies the address of a list of storage keys associated with the virtual storage to be dumped. If the key of a subpool specified in SUBPLST does not match a key in this list, the data in the subpool is not dumped. SUBPLST must be specified if the KEYLIST option is used. If you do not specify KEYLIST, all storage (regardless of key) associated with the requested subpools is included in the dump. Therefore, if you want to dump the storage corresponding to all 16 keys, do not specify this parameter.

The list contains one-byte entries and starts on a halfword boundary. The first byte indicates the length of the list (including this byte). The list has a maximum length of 16 bytes so that up to 15 keys can be specified. Specify each key in the left-most four bits of each byte, except the length byte.

,PLISTVER=1

,PLISTVER=2

Specifies the length of the parameter list used. When PLISTVER=1 is specified, SDUMP uses a parameter list of up to 68 bytes. PLISTVER=2 specifies a 128-byte parameter list. The default is PLISTVER=1, unless you specify SYMREC, ID, IDAD, PSWREGS, SDATA=DEFAULTS, SDATA=NODEFAULTS, or SDATA=IO, in which case the default is PLISTVER=2.

,PSWREGS=list addr

Specifies a PSW or register area to be passed to SVC dump. This area may contain a PSW, control registers 3 and 4, all the general purpose registers (GPRs), and all the access registers (ARs). When PSWREGS is specified, SVC dump includes the following information in the summary dump portion of the dump:

• The PSWREGS parameter list.
• If the PSW is provided, 4K of storage before and 4K after the PSW address from the primary address space.
• 4K of storage before and 4K of storage after each of the GPRs from the primary and secondary address spaces.
• If the ARs are provided, they qualify the addresses of the area that includes the 4K of storage before and 4K of storage after each of the GPRs. GPRs will be used to locate storage; ARs (if provided along with a PSW in AR mode) will be used to identify the source address space or data space.

Note: If the control registers are provided, they will be used to determine the primary and secondary address spaces. If no control registers are provided, then the storage will be dumped from the caller's primary and secondary address spaces.

The PSWREGS parameter allows programs running in a nonabend environment, where there is no SDWA, to request SVC dump and dump suppression services similar to those available in an abend environment, where an SDWA is present.

The parameter list for the PSWREGS parameter must reside in the address space currently addressable by SVC dump. The caller must provide at least the length and the mask field. Each bit in the mask refers to a data area.

• If a mask bit is set, SVC dump expects that the data area and the appropriate size in the length field to be supplied.
• If a mask bit is off , but any lower-order mask bit is on, the corresponding storage area must still be included in the parameter list, and the total length specified must match the entire area. For instance, if only general purpose registers are specified. Set bit 3 on, store the register values starting at X'14' into the parameter list, and set the total length to 84 (64+8+8+2+2). This total length is the same whether or not the user wants to supply PSW or control registers 3 and 4 information.

The following describes the expected length of the entire parameter list relative to the highest bit set in the mask:

• If bit 4 is set (indicating ARs are included), the length must be 148.
• If bit 3 is set (GPRs are included), the length must be 84.
• If bit 2 is set (CRs are included), the length must be 20.
• If bit 1 is set (PSW is included), the length must be 12.
• If none of the bits are to be set ('nothing' is indicated), the length must be 4.

The following table describes the parameter list:

Table 1. PSWREGS parameter list

Offset in Hex	Length	Field Description
00	2	The total length of the PSWREGS parameter list
02	2	Bit mask describing data areas included in the PSW/register area
	1...	Bit 1: On - The PSW is included in the PSW/register area
	.1..	Bit 2: On - Control registers 3 and 4 are included in the PSW/register area
	..1.	Bit 3: On - General purpose registers are included in the PSW/register area
	...1	Bit 4: On - ARs are included in the PSW/register area.
		Bits 5 - 16: Initialize these bits to zero.
04	8	PSW: Data only supplied if the PSW mask bit is set
0C	8	Control registers 3 and 4: Data only supplied if mask bit is set.
14	64	General purpose registers 0 - 15: Data only supplied if mask bit is set.
54	64	ARs 0 - 15: Data only supplied if mask bit is set.

,QUIESCE=YES

,QUIESCE=NO

Specifies that the system is to be set nondispatchable until the contents of the SQA and the CSA are dumped (YES), or that the system is to be left dispatchable (NO). If the SDATA parameter does not specify SQA or CSA, the QUIESCE=YES request is ignored.

Notes:

1. Summary dumps (SUMDUMP) for branch entries (BRANCH=YES) always cause the system to be set nondispatchable until the summary dump is written.
2. A Q=YES|NO setting for the CHNGDUMP command overrides this parameter. For the use of the CHNGDUMP command, see z/OS MVS System Commands.

,SDATA=(sdata options)

Specifies the system is to dump the following:

Option

Data to be dumped

ALLNUC

The DAT-ON and DAT-OFF nuclei. The read-only (page-protected) area of the nucleus and the DAT-OFF nucleus is not included in the dump unless this keyword is specified.

ALLPSA

All of the prefixed storage areas (PSAs) in the system.

CSA

Dumps the following storage:

• The CSA and ECSA subpools (subpools 227, 228, 231, and 241)

  Only those obtained pages that have something stored into them are dumped. The dump does not include pages of storage that are in a freshly-obtained state.

• Virtual storage for 64-bit addressable memory objects created using one of the following services:
  • IARV64 REQUEST=GETCOMMON,DUMP=LIKECSA
  • IARCP64 COMMON=YES,DUMP=LIKECSA
  • IARST64 COMMON=YES,TYPE=PAGEABLE
  

GRSQ

Global resource serialization control blocks.

LPA

The active link pack area modules and SVCs for each address space being dumped.

LSQA

Dumps the following storage:

• The LSQA and ELSQA for each address space being dumped (subpools 203-205, 213-215, 223-225, 233-235, and 253-255)
• Virtual storage for 64-bit addressable memory objects created using one of the following services:
  • IARV64 REQUEST=GETSTOR,DUMP=LIKELSQA
  • IARCP64 COMMON=NO,DUMP=LIKELSQA
  • IARST64 COMMON=NO
  

NOALLPSA

NOALL

The PSA for one processor is dumped. This is either the processor at the time of the error or the processor at the time of the dump.

NOSQA

The system queue area is not dumped.

NOSUMDUMP

NOSUM

A summary dump is not included in the SVC dump.

NUC

The non-page-protected areas of the DAT-ON nucleus. (The ALLNUC parameter must be specified to obtain the entire nucleus, including the page-protected areas of the DAT-ON nucleus and the DAT-OFF nucleus.)

PSA

The PSA for one processor is dumped. This is either the processor at the time of the error or the processor at the time of the dump.

RGN

Dumps the following storage:

• The allocated pages in the private area of each address space being dumped. This includes the following areas:

  Subpools	Storage
  0-127, 129-132, 229, 230, 240, 244, 249, 250-252	All storage allocated to these subpools
  203-205, 213-215, 223-225, 233-235, 253-255	All storage allocated to the LSQA and ELSQA
  236, 237	All storage allocated to the SWA and ESWA

  Only those obtained pages that have something stored into them are dumped. The dump does not include pages of storage that are in a freshly-obtained state. This reduces the number of page faults that occur during SVC dump processing, decreases the time required to take a dump, and reduces the size of the dump.

• Virtual storage for 64-bit user region memory objects created using one of the following services:
  • IARV64 REQUEST=GETSTOR,DUMP=LIKERGN
  • IARV64 REQUEST=GETSTOR,SVCDUMPRGN=YES
  • IARCP64 COMMON=NO,DUMP=LIKERGN
  • IARST64 COMMON=NO
  
• Data-in-virtual (DIV) pages are dumped when they have been changed since the last DIV macro (that specified the SAVE service) executed. DIV pages that have not been changed, are considered to be in a freshly-obtained state.

SQA

Dumps the following storage:

• The SQA and ESQA subpools (226, 239, 245, 247, and 248)

  Only those obtained pages that have something stored into them are dumped. The dump does not include pages of storage that are in a freshly-obtained state.

• Virtual storage for 64-bit addressable memory objects created using one of the following services:
  • IARV64 REQUEST=GETCOMMON,DUMP=LIKESQA
  • IARCP64 COMMON=YES,DUMP=LIKESQA
  • IARST64 COMMON=YES,TYPE=FIXED
  • IARST64 COMMON=YES,TYPE=DREF
  

SUMDUMP

SUM

A summary dump is to be included with the SVC dump output. The trace table is included in the nonsummary portion of the dump if this option is specified or used as a default.

The type of summary dump depends on how you specify the BRANCH and SUSPEND parameters:

• If you specify BRANCH=YES and SUSPEND=NO, you get a disabled summary dump.
• If you specify BRANCH=YES and SUSPEND=YES, you get a suspend summary dump.
• If you specify BRANCH=NO, you get an enabled summary dump.

For a description of the dump contents, see z/OS MVS Diagnosis: Tools and Service Aids.

SWA

The scheduler work area subpools for each address space being dumped (subpools 236 and 237). This includes all storage allocated above and below 16 megabytes.

TRT

The system trace table, the GTF trace records, and master trace data if these types of traces are active.

DEFAULTS

DEFS

The following default SDATA options are included in the SVC dump:

• ALLPSA
• SQA
• SUMDUMP
• IO
• Any default SDATA options specified by the CHNGDUMP command when CHNGDUMP is in ADD mode.

Note:

1. DEFAULTS is not required. All SVC dumps include the default SDATA options unless NODEFAULTS is specified.
2. DEFAULTS and NODEFAULTS are mutually exclusive.

NODEFAULTS

NODEFS

The SDATA defaults are NOT included in the SVC dump. Specifying NODEFAULTS reduces the size of an SVC dump by excluding the following default SDATA options:

• ALLPSA
• SQA
• SUMDUMP
• IO
• Any default SDATA options specified by the CHNGDUMP command when CHNGDUMP is in ADD mode.

If a data area relating to an SDATA option is required in the dump, the programmer can code that SDATA option on the SDUMP macro invocation. All keywords and SDATA options are valid when NODEFS is coded.

If you specify NODEFAULTS, the dump still contains some default system areas that are included in all dumps.

IO

The IO data areas are included in the SVC dump.

,STORAGE=(strt addr,end addr)

,LIST=list addr

,LISTA=listaddr

Specifies one or more pairs of starting and ending addresses (STORAGE), a list of starting and ending addresses (LIST), or a list of ASIDs and storage ranges (LISTA). Each starting address must be less than its corresponding ending address.

When LIST or STORAGE is specified, the list must contain an even number of addresses, and each address must occupy one fullword. In the list, the high-order bit of the fullword containing the last ending address of the list must be set to 1; all other high-order bits must be set to 0.

When LISTA is specified, the first fullword of the storage list contains the number of bytes (including the first word) in the list. LISTA specifies a list of ASIDs and storage ranges as follows:

Note: If LISTA or SUBPLST is specified for a scheduled dump request and if the list does not exceed 484 bytes in size, SVC dump will move the list to SVC dump storage. The caller can free or reuse this space on return from SVC dump. No synchronization with SVC dump completion is required. If the list exceeds 484 bytes, SVC dump will not move the list and synchronization with SVC dump completion is required.

,SUBPLST=subpool id list address

Specifies a list of ASIDs with associated subpool ids corresponding to subpools of virtual storage that are to be included in the SVC dump.

The first fullword of the list contains the number of bytes (including the first word) in the list. The list can contain a maximum of 200 bytes consisting of unique ASIDs and subpool IDs. If the list contains duplicate ASIDs or subpool IDs, the length can exceed 200 bytes because SDUMP stores the unique subpool IDs in a 200-byte work area.

The structure of the list for each ASID follows:

• The first word contains the ASID in bits 0-15 and the number of subpools associated with this ASID (n) in bits 16 - 31. If 0 is specified as the ASID, the caller's home ASID is used.
• The next n halfwords contain the subpool IDs (right justified) corresponding to the virtual storage to be included in the SVC dump. The manner in which these subpools are dumped depends on whether they are private or common area subpools.
  • If a private area subpool (related to a TCB) is specified, all virtual storage associated with this subpool, for all TCBs in the specified address space, is dumped.
  • If a common area subpool is specified, all of the virtual storage allocated in the subpool is dumped.

SVC dump does not dump all the obtained storage in an address space if the SUBPLST list keyword for private subpools is coded. This reduces the number of page faults that occur during SVC dump processing and the time required to take a dump. It also reduces the size of dumps on tape or DASD.

For storage that is not related to data-in-virtual, only obtained pages that have something stored into them are dumped. This eliminates the pages of storage that are in a freshly obtained state.

For storage that is related to data-in-virtual, only pages that are in central storage are dumped, as well as pages that have been changed since the last data-in-virtual SAVE operation.

Notes:

1. SVC dump ignores unassigned subpool IDs and ASIDs.
2. If an invalid subpool or ASID (ASID greater than ASVTMAXU) is specified, the caller receives a 233 ABEND and SDUMP processing terminates the dump.
3. If all ASIDs specified in SUBPLST are the current ASID, SUBPLST does not force a scheduled dump. However, if any of the ASIDs are different, a scheduled (or asynchronous) dump results.
4. SDUMP callers executing in key 0 and supervisor state, who request storage from subpool 0 via GETMAIN obtain that storage from subpool 252 instead. Therefore, when these callers want to dump this storage, they must specify subpool 252 rather than subpool 0.

,SUMLIST=list addr

,SUMLSTA=list addr

Specifies a list of starting and ending addresses of areas to be included in a summary dump (SUMLIST) or specifies a combined list of ASIDs and storage ranges (SUMLSTA). SUMDUMP must be specified as an SDATA parameter and each starting address must be less than its corresponding ending address.

For SUMLIST, the storage list must contain an even number of addresses, and each address must occupy one fullword. In the list, the high-order bit of the fullword containing the last ending address of the list must be set to 1, and all other high-order bits must be set to 0.

For SUMLSTA, the first fullword of the list contains the number of bytes (including the first word) in the list. SUMLSTA specifies a list of ASIDs and storage ranges as follows:

Restriction: The maximum number of ASIDs that the combined TYPE=XMEM, TYPE=XMEME, LISTA, ASIDLST, ASID, and SUBPLST parameters can specify is fifteen.

Note: There is no restriction on the number of ASIDs that the SUMLSTA can specify.

When BRANCH=YES and SUSPEND=NO are also specified, the list must be addressable using the addressability established when SVC dump was entered. The lists themselves and all ranges specified must reference paged-in data. Paged-out data is not dumped by summary dump.

When BRANCH=YES and SUSPEND=YES are also specified, the lists must be addressable using the addressability established when SVC dump was entered. The lists and referenced data can either be in paged in or paged out areas. The maximum amount of summary dump data with this type of dump is 8M.

When BRANCH=NO is also specified, the lists must be addressable in all address spaces in which the dump will be taken (those address spaces specified by ASID, ASIDLST, LISTA, or TYPE=XMEM, TYPE=XMEME, or SUBPLST). Synchronization with the capture phase via the SRB or ECB option is also required, as you cannot free the storage containing these lists until the capture phase is completed. The lists and referenced data can be in paged-in or paged-out areas. The maximum amount of summary dump data possible with this type of dump is dependent only on the size of the dump data set.

Each ASID specified with SUMLSTA must represent a valid, swapped-in address space in order for the data to be dumped.

Programming Notes: The total number of distinct ASIDs that can be specified by TYPE=XMEM, TYPE=XMEME, LISTA, ASID, SUBPLST and ASIDLST is fifteen. If more than fifteen are requested, only the first fifteen are processed. There is no restriction on the number of ASIDs specified by the SUMLSTA parameter, nor do SUMLSTA ASIDs contribute toward the fifteen ASID limit.

,SUSPEND=NO

,SUSPEND=YES

Specifies that a suspend summary dump is requested (YES) or not requested (NO). SUSPEND=YES must be used together with the BRANCH=YES and SDATA=SUMDUMP parameters. This keyword should be used by routines that can experience page faults but that want to save dump information in a virtual storage buffer.

In releases prior to z/OS® V1R7, when SUSPEND=YES is specified with SDATA=TRT, an immediate attempt is made to capture system trace table status. If this fails, the capture is retried toward the end of the dumping process. z/OS V1R7 adds an earlier retry to the process, reacting to a blockage when the initial attempt is made by immediately scheduling an SRB to request the capture.

RTCTSDSU is supported in z/OS V1R7 and above to indicate the amount of enabled summary dump space is available.

,SYMREC=symrec addr

Specifies the address of a valid symptom record for DAE to use for dump suppression. DAE suppresses the SVC dump if the primary symptom string found in the symptom record matches previously known symptoms, and, suppression has been enabled by the installation.

The caller must build the symptom record and fill in at least the ‘SR’ identifier and the primary symptom string, which should uniquely identify the error.

SVC dump issues an abend with a completion code of X'233', reason code X'9C', then returns to the caller with a return code of 8 if the symptom record identifier is not 'SR', if the offset and length of the primary symptom string are not initialized, or if the first byte of the symptom record and the last byte of the secondary symptom string are not addressable.

SVC dump does not include the symptom record in the dump. The caller can use the SUMLIST keyword to include the symptom record in the dump.

See the dump analysis and elimination (DAE) section in z/OS MVS Programming: Authorized Assembler Services Guide for more information on symptom strings and how to build them.

The ADSR macro maps the symptom record. See z/OS MVS Data Areas in the z/OS Internet library for a macro mapping of the ADSR.

,TYPE=XMEM

,TYPE=XMEME

,TYPE=NOLOCAL

,TYPE=FAILRC

Specifies that the caller's cross memory mode determines the address spaces to dump (XMEM or XMEME) or that the caller cannot allow SDUMP to obtain a local lock (NOLOCAL) or that SVC dump should return a reason code with the return code to the DUMP command processor when the requested dump was not taken (FAILRC).

XMEM

Requests SVC dump to use the caller's cross memory mode at the time the SDUMP macro is executed.

XMEME

Requests SVC dump to use the caller's cross memory mode at the time of the error for which the dump is being taken. The home address space is dumped for both keywords. The relevant primary and secondary address spaces are also dumped if they are unique. If a cross memory local lock was held, the address space whose local lock is held is also dumped.

NOLOCAL

Indicates that the caller is in an environment where SDUMP cannot hold a local lock. This option has meaning only when BRANCH=YES is specified and the caller is enabled and unlocked (for example, the caller has an enabled unlocked task FRR established or is in SRB or cross memory mode).

FAILRC

Requests that the caller receive special information from SVC dump whenever the dump fails. Some information is already placed in SDWASDRC as a result of the SVC dump failure. When the caller receives control again after a dump failure (return code 8) and the caller has specified TYPE=FAILRC, the reason code is combined with the return code and passed to the caller in either register 15 or the ECB, or through the IHASDST mapping macro if the SRBPARM area was provided for an SRB. The reason code is in bits 16 - 23; the return code is in bits 24 - 31. When the return code is in the ECB, the POST flag is set on. SDUMP passes back a return code in register 15 and places the reason code in the SDWA. The reason code explains why the dump failed.

The following tables identify return codes and reason codes, tell what each means, and recommend actions that you should take.

If BRANCH=NO was specified and no ASIDs other than the current ASID were requested, register 15 contains one of the following hexadecimal return codes when control is returned at the completion of the capture phase:

If BRANCH=YES or any ASID other than the current ASID was requested, register 15 contains one of the following hexadecimal return codes when control is returned after the system has scheduled the dump:

If you specify the ECB or SRB parameter without the DCB parameter, the system also returns one of following hexadecimal codes in the ECB or SRB at the completion of the capture phase:

If you specify the DCB parameter with the ECB or SRB parameter, the system also returns one of the following hexadecimal codes in the ECB or SRB at the completion of the dump writing phase:

The reason codes are as follows: