z/OS MVS Assembler Services Reference ABE-HSP

760 Pages·2017·3.9 MB·English

z/OS
Version 2 Release 3
MVS Programming: Assembler Services
Reference, Volume 1 (ABE-HSP)
IBM
SA23-1369-30
Note
Before using this information and the product it supports, read the information in “Notices” on page
707.
This edition applies to Version 2 Release 3 of z/OS (5650-ZOS) and to all subsequent releases and modifications until
otherwise indicated in new editions.
Last updated: 2019-02-16
© Copyright International Business Machines Corporation 1988, 2017.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract with
IBM Corp.
Contents
List of Figures................................................................................................... xxxi
List of Tables...................................................................................................xxxiii
About this information......................................................................................xxxv
Who should use this information............................................................................................................xxxv
How to use this information...................................................................................................................xxxv
z/OS information.....................................................................................................................................xxxv
How to send your comments to IBM.................................................................xxxvi
If you have a technical problem............................................................................................................xxxvi
Summary of changes......................................................................................xxxvii
Summary of changes for z/OS Version 2 Release 3.............................................................................xxxvii
Summary of changes for z/OS Version 2 Release 2.............................................................................xxxvii
z/OS Version 2 Release 1 summary of changes...................................................................................xxxvii
Chapter 1. Using the services.................................................................................1
Compatibility of MVS macros.......................................................................................................................1
Addressing mode (AMODE).........................................................................................................................2
Address space control (ASC) mode.............................................................................................................3
ALET qualification...................................................................................................................................3
User parameters.....................................................................................................................................4
Telling the system about the execution environment ................................................................................5
Specifying a macro version number............................................................................................................6
How to request a macro version using PLISTVER.................................................................................6
Register use..................................................................................................................................................7
Handling return codes and reason codes....................................................................................................8
Handling program errors........................................................................................................................8
Handling environmental and system errors...........................................................................................9
Using X-macros............................................................................................................................................9
Macro forms...............................................................................................................................................10
Conventional list form macros.............................................................................................................10
Alternative list form macros.................................................................................................................11
Coding the macros.....................................................................................................................................11
Continuation lines.................................................................................................................................13
Coding the callable services......................................................................................................................14
Including equate (EQU) statements....................................................................................................14
Link-editing linkage-assist routines.....................................................................................................15
Service summary.......................................................................................................................................15
Chapter 2. ABEND — Abnormally terminate a task................................................ 23
Description.................................................................................................................................................23
Environment.........................................................................................................................................23
Programming requirements.................................................................................................................23
Restrictions...........................................................................................................................................23
Input register information....................................................................................................................24
Output register information.................................................................................................................24
Performance implications....................................................................................................................24
Syntax...................................................................................................................................................24
Parameters...........................................................................................................................................25
ABEND codes........................................................................................................................................26
Return and reason codes.....................................................................................................................26
Example 1.............................................................................................................................................26
iii
Example 2.............................................................................................................................................26
Example 3.............................................................................................................................................26
Chapter 3. ALESERV — Control entries in the access list........................................27
Description.................................................................................................................................................27
Environment.........................................................................................................................................27
Programming requirements.................................................................................................................28
Restrictions...........................................................................................................................................28
Input register information....................................................................................................................28
Output register information.................................................................................................................28
Performance implications....................................................................................................................28
Syntax...................................................................................................................................................28
Parameters...........................................................................................................................................30
ABEND codes........................................................................................................................................31
Return and reason codes.....................................................................................................................31
Example of adding an entry to a DU-AL...............................................................................................38
ALESERV - List form...................................................................................................................................38
Parameters...........................................................................................................................................38
ALESERV - Execute form............................................................................................................................38
Syntax...................................................................................................................................................38
Parameters...........................................................................................................................................40
Chapter 4. ASASYMBM and ASASYMBF — Substitute text for symbols...................41
Description.................................................................................................................................................41
Environment.........................................................................................................................................41
Programming requirements.................................................................................................................42
Restrictions...........................................................................................................................................42
Input register information....................................................................................................................42
Output register information.................................................................................................................42
Performance implications....................................................................................................................43
Syntax...................................................................................................................................................43
Parameters...........................................................................................................................................43
Return and reason codes.....................................................................................................................43
Examples of calls to ASASYMBM or ASASYMBF.................................................................................44
Chapter 5. ATTACH and ATTACHX — Create a new task..........................................45
ATTACH and ATTACHX description............................................................................................................45
Environment.........................................................................................................................................45
Programming requirements.................................................................................................................46
Restrictions...........................................................................................................................................46
Input register information....................................................................................................................46
Output register information.................................................................................................................46
Performance implications....................................................................................................................47
Syntax...................................................................................................................................................47
Parameters...........................................................................................................................................49
ABEND codes........................................................................................................................................54
Return and reason codes.....................................................................................................................54
Example 1.............................................................................................................................................55
Example 2.............................................................................................................................................55
Example 3.............................................................................................................................................55
Example 4.............................................................................................................................................55
ATTACHX—Create a new task....................................................................................................................56
Syntax...................................................................................................................................................56
Parameters...........................................................................................................................................58
Example................................................................................................................................................61
ATTACH and ATTACHX—List form..............................................................................................................61
Syntax...................................................................................................................................................61
iv
Parameters...........................................................................................................................................63
ATTACH and ATTACHX—Execute form......................................................................................................63
Syntax...................................................................................................................................................64
Parameters...........................................................................................................................................66
Chapter 6. BLDMPB — Build a message parameter block.......................................69
Description.................................................................................................................................................69
Environment.........................................................................................................................................69
Programming requirements.................................................................................................................69
Restrictions...........................................................................................................................................69
Input register information....................................................................................................................69
Output register information.................................................................................................................69
Performance implications....................................................................................................................70
Syntax...................................................................................................................................................70
Parameters...........................................................................................................................................71
Return and reason codes.....................................................................................................................71
Example................................................................................................................................................71
Chapter 7. BLSABDPL — Map dump formatting exit data.......................................73
Description.................................................................................................................................................73
Environment.........................................................................................................................................73
Programming requirements.................................................................................................................73
Restrictions...........................................................................................................................................73
Register information.............................................................................................................................73
Performance implications....................................................................................................................73
Syntax...................................................................................................................................................73
Parameters...........................................................................................................................................74
Example................................................................................................................................................76
Chapter 8. BLSACBSP — Map the control block status (CBSTAT) parameter list......77
Description.................................................................................................................................................77
Environment.........................................................................................................................................77
Programming requirements.................................................................................................................77
Restrictions...........................................................................................................................................77
Register information.............................................................................................................................77
Performance implications....................................................................................................................77
Syntax...................................................................................................................................................77
Parameters...........................................................................................................................................78
Example................................................................................................................................................78
Chapter 9. BLSADSY — Map the add symptom service parameter list.....................79
Description.................................................................................................................................................79
Environment.........................................................................................................................................79
Programming requirements.................................................................................................................79
Restrictions...........................................................................................................................................79
Register information.............................................................................................................................79
Performance implications....................................................................................................................79
Syntax...................................................................................................................................................79
Parameters...........................................................................................................................................80
Example................................................................................................................................................80
Chapter 10. BLSAPCQE — Map the contention queue element (CQE) create
service parameter list......................................................................................81
Description.................................................................................................................................................81
Environment.........................................................................................................................................81
Programming requirements.................................................................................................................81
v
Restrictions...........................................................................................................................................81
Register information.............................................................................................................................81
Performance implications....................................................................................................................81
Syntax...................................................................................................................................................81
Parameters...........................................................................................................................................82
Example................................................................................................................................................82
Chapter 11. BLSQFXL — Map the format exit routine list (FXL)...............................83
Description.................................................................................................................................................83
Environment.........................................................................................................................................83
Programming requirements.................................................................................................................83
Restrictions...........................................................................................................................................83
Register information.............................................................................................................................83
Performance implications....................................................................................................................83
Syntax...................................................................................................................................................83
Parameters...........................................................................................................................................84
Example................................................................................................................................................84
Chapter 12. BLSQMDEF — Define a control block format model............................. 85
Description.................................................................................................................................................85
Environment.........................................................................................................................................85
Programming requirements.................................................................................................................85
Restrictions...........................................................................................................................................85
Register information.............................................................................................................................85
Performance implications....................................................................................................................85
Syntax...................................................................................................................................................85
Parameters...........................................................................................................................................87
Chapter 13. BLSQMFLD — Specify a formatting model field...................................91
Description.................................................................................................................................................91
Environment.........................................................................................................................................91
Programming requirements.................................................................................................................91
Restrictions...........................................................................................................................................91
Register information.............................................................................................................................91
Performance implications....................................................................................................................91
Syntax...................................................................................................................................................91
Parameters...........................................................................................................................................94
Examples..............................................................................................................................................99
Chapter 14. BLSQSHDR — Generate model subheader........................................ 105
Description...............................................................................................................................................105
Environment.......................................................................................................................................105
Programming requirements...............................................................................................................105
Restrictions........................................................................................................................................105
Register information...........................................................................................................................105
Performance implications..................................................................................................................105
Syntax.................................................................................................................................................105
Parameters.........................................................................................................................................106
Examples............................................................................................................................................106
Chapter 15. BLSRDRPX — Map dump record prefix..............................................107
Description...............................................................................................................................................107
Environment.......................................................................................................................................107
Programming requirements...............................................................................................................107
Restrictions........................................................................................................................................107
Register information...........................................................................................................................107
Performance implications..................................................................................................................107
vi
Syntax.................................................................................................................................................107
Parameters.........................................................................................................................................108
Chapter 16. BLSRESSY — Map IPCS symbol table data........................................109
Description...............................................................................................................................................109
Environment.......................................................................................................................................109
Programming requirements...............................................................................................................109
Restrictions........................................................................................................................................109
Register information...........................................................................................................................109
Performance implications..................................................................................................................109
Syntax.................................................................................................................................................109
Parameters.........................................................................................................................................110
Example..............................................................................................................................................110
Chapter 17. BLSRNAMP — Map the name service parameter list..........................111
Description...............................................................................................................................................111
Environment.......................................................................................................................................111
Programming requirements...............................................................................................................111
Restrictions........................................................................................................................................111
Register information...........................................................................................................................111
Performance implications..................................................................................................................111
Syntax.................................................................................................................................................111
Parameters.........................................................................................................................................112
Example..............................................................................................................................................112
Chapter 18. BLSRPRD — Map dump record......................................................... 113
Description...............................................................................................................................................113
Environment.......................................................................................................................................113
Programming requirements...............................................................................................................113
Restrictions........................................................................................................................................113
Register information...........................................................................................................................113
Performance implications..................................................................................................................113
Syntax.................................................................................................................................................113
Parameters.........................................................................................................................................114
Chapter 19. BLSRPWHS — Map the WHERE service parameter list.......................115
Description...............................................................................................................................................115
Environment.......................................................................................................................................115
Programming requirements...............................................................................................................115
Restrictions........................................................................................................................................115
Register information...........................................................................................................................115
Performance implications..................................................................................................................115
Syntax.................................................................................................................................................115
Parameters.........................................................................................................................................116
Example..............................................................................................................................................116
Chapter 20. BLSRSASY — Map IPCS storage map data........................................ 117
Description...............................................................................................................................................117
Environment.......................................................................................................................................117
Programming requirements...............................................................................................................117
Restrictions........................................................................................................................................117
Register information...........................................................................................................................117
Performance implications..................................................................................................................117
Syntax.................................................................................................................................................117
Parameters.........................................................................................................................................118
Example..............................................................................................................................................118
vii
Chapter 21. BLSRXMSP — Map the storage map service parameter list................119
Description...............................................................................................................................................119
Environment.......................................................................................................................................119
Programming requirements...............................................................................................................119
Restrictions........................................................................................................................................119
Register information...........................................................................................................................119
Performance implications..................................................................................................................119
Syntax.................................................................................................................................................119
Parameters.........................................................................................................................................120
Example..............................................................................................................................................120
Chapter 22. BLSRXSSP — Map the symbol service parameter list........................ 121
Description...............................................................................................................................................121
Environment.......................................................................................................................................121
Programming requirements...............................................................................................................121
Restrictions........................................................................................................................................121
Register information...........................................................................................................................121
Performance implications..................................................................................................................121
Syntax.................................................................................................................................................121
Parameters.........................................................................................................................................122
Example..............................................................................................................................................122
Chapter 23. BLSUPPR2 — Map the expanded print service parameter list............123
Description...............................................................................................................................................123
Environment.......................................................................................................................................123
Programming requirements...............................................................................................................123
Restrictions........................................................................................................................................123
Register information...........................................................................................................................123
Performance implications..................................................................................................................123
Syntax.................................................................................................................................................123
Parameters.........................................................................................................................................124
Example..............................................................................................................................................124
Chapter 24. CALL — Pass control to a control section...........................................125
CALL description......................................................................................................................................125
Environment.......................................................................................................................................125
Programming requirements...............................................................................................................125
Register information...........................................................................................................................126
Syntax.................................................................................................................................................126
Parameters.........................................................................................................................................127
Return and reason codes...................................................................................................................128
Example..............................................................................................................................................128
CALL - List form........................................................................................................................................129
Syntax.................................................................................................................................................129
Parameters.........................................................................................................................................129
CALL - Execute form................................................................................................................................129
Syntax.................................................................................................................................................130
Parameters.........................................................................................................................................130
Chapter 25. CHAP — Change dispatching priority................................................131
Description...............................................................................................................................................131
Environment.......................................................................................................................................131
Programming requirements...............................................................................................................131
Restrictions........................................................................................................................................131
Input register information..................................................................................................................131
Output register information...............................................................................................................131
viii
Performance implications..................................................................................................................132
Syntax.................................................................................................................................................132
Parameters.........................................................................................................................................132
ABEND codes.....................................................................................................................................133
Return and reason codes...................................................................................................................133
Example 1...........................................................................................................................................133
Example 2...........................................................................................................................................133
Chapter 26. CnzConv -- Convert console name and ID ........................................135
Description...............................................................................................................................................135
Environment.......................................................................................................................................135
Programming requirements...............................................................................................................135
Programming considerations.............................................................................................................136
CnzConv -- List form................................................................................................................................143
Syntax.................................................................................................................................................143
Parameters.........................................................................................................................................143
CnzConv -- Execute form.........................................................................................................................144
Syntax.................................................................................................................................................144
Parameters.........................................................................................................................................145
Chapter 27. CNZTRKR — Tracking interface macro..............................................147
Description...............................................................................................................................................147
Environment.......................................................................................................................................147
Programming requirements...............................................................................................................147
Restrictions........................................................................................................................................148
Input register information..................................................................................................................148
Output register information...............................................................................................................148
Syntax.................................................................................................................................................148
Parameters.........................................................................................................................................149
ABEND codes.....................................................................................................................................149
Return and reason codes...................................................................................................................149
Chapter 28. CONVCON — Retrieve console information........................................151
Description...............................................................................................................................................151
Environment.......................................................................................................................................151
Programming requirements...............................................................................................................151
Programming considerations.............................................................................................................153
Chapter 29. CONVTOD — Convert to time-of-day clock format.............................159
Description...............................................................................................................................................159
Environment.......................................................................................................................................159
Programming requirements...............................................................................................................159
Restrictions........................................................................................................................................159
Input register information..................................................................................................................159
Output register information...............................................................................................................159
Performance implications..................................................................................................................160
Syntax.................................................................................................................................................160
Parameters.........................................................................................................................................161
ABEND codes.....................................................................................................................................163
Return and reason codes...................................................................................................................163
Example 1...........................................................................................................................................163
Example 2...........................................................................................................................................164
Example 3...........................................................................................................................................164
CONVTOD—List form...............................................................................................................................164
Syntax.................................................................................................................................................164
Parameters.........................................................................................................................................165
CONVTOD—Execute form........................................................................................................................165
ix
Syntax.................................................................................................................................................165
Parameters.........................................................................................................................................166
Chapter 30. CPOOL — Perform cell pool services.................................................167
Description...............................................................................................................................................167
Environment.......................................................................................................................................167
Programming requirements...............................................................................................................167
Restrictions........................................................................................................................................167
Input register information..................................................................................................................168
Output register information...............................................................................................................168
Performance implications..................................................................................................................169
Syntax.................................................................................................................................................169
Parameters.........................................................................................................................................171
ABEND codes.....................................................................................................................................174
Return and reason codes...................................................................................................................174
Example 1...........................................................................................................................................175
Example 2...........................................................................................................................................175
Example 3...........................................................................................................................................175
Example 4...........................................................................................................................................175
Example 5...........................................................................................................................................175
CPOOL - List form....................................................................................................................................176
Syntax.................................................................................................................................................176
Parameters.........................................................................................................................................178
CPOOL - Execute form.............................................................................................................................178
Syntax.................................................................................................................................................178
Parameters.........................................................................................................................................179
Chapter 31. CPUTIMER — Provide current CPU timer value................................. 181
Description...............................................................................................................................................181
Environment.......................................................................................................................................181
Programming requirements...............................................................................................................181
Restrictions........................................................................................................................................181
Input register information..................................................................................................................181
Output register information...............................................................................................................181
Performance implications..................................................................................................................182
Syntax.................................................................................................................................................182
Parameters.........................................................................................................................................182
ABEND codes.....................................................................................................................................183
Return codes......................................................................................................................................183
Example 1...........................................................................................................................................183
Example 2...........................................................................................................................................184
Example 3...........................................................................................................................................184
Example 4...........................................................................................................................................184
Chapter 32. CSRCESRV — Compress and expand data.........................................185
Description...............................................................................................................................................185
Environment.......................................................................................................................................185
Programming requirements...............................................................................................................185
Restrictions........................................................................................................................................185
Input register information for SERVICE=QUERY...............................................................................186
Output register information for SERVICE=QUERY............................................................................186
Input register information for SERVICE=COMPRESS........................................................................186
Output register information for SERVICE=COMPRESS.....................................................................187
Input register information for SERVICE=EXPAND............................................................................187
Output register information for SERVICE=EXPAND..........................................................................188
Performance implications..................................................................................................................189
Syntax.................................................................................................................................................189
x