z/OS MVS Using the Subsystem Interface
Previous topic |
Next topic
|
Contents
|
Contact z/OS
|
Library
|
PDF
Contents (exploded view)
z/OS MVS Using the Subsystem Interface
SA38-0679-00
Note
About this document
Who should use this document
How to use this document
Where to find more information
How to send your comments to IBM
Summary of changes
z/OS Version 2 Release 1 summary of changes
Introduction to Subsystems and the Subsystem Interface (SSI)
What is a subsystem?
What is the SSI?
Unique Attributes of the SSI
Types of subsystem requests
Controlling SSI Processing
Why Write Your Own Subsystem?
What is a Dynamic Subsystem?
Making a Request of a Subsystem
Set Up the Environment
Subsystem Options Block (SSOB)
SSOB Function Dependent Area
Subsystem Identification Block (SSIB)
Make the Request with the IEFSSREQ Macro
Check the Return Code
Summary of Steps
SSI Function Codes Your Program Can Request
SSI Function Code Descriptions
Process SYSOUT Data Sets Call — SSI Function Code 1
Type of Request
Use Information
Issued to
Related SSI Codes
Related Concepts
Environment
Input Register Information
Input Parameters
Output Register Information
Return Code Information
Output Parameters
Processing Flow for Single Data Set Requests
External Writer Considerations
The Writer Communication Area
Example
User Destination Validation/Conversion — SSI Function Code 11
Type of Request
Issued to
Related SSI Codes
Related Concepts
Environment
Input Register Information
Input Parameters
Output Register Information
Return Code Information
Output Parameters
Verify Subsystem Function Call — SSI Function Code 15
Type of Request
Issued to
Related SSI Codes
Related Concepts
Environment
Input Register Information
Input Parameters
Output Register Information
Return Code Information
Output Parameters
Request Job ID Call — SSI Function Code 20
Type of Request
Use Information
Issued to
Related SSI Codes
Related Concepts
Environment
Input Register Information
Input Parameters
Output Register Information
Return Code Information
Output Parameters
Restrictions
Considerations When Using the Automatic Restart Manager
Return Job ID Call — SSI Function Code 21
Type of Request
Use Information
Issued to
Related SSI Codes
Related Concepts
Environment
Input Register Information
Input Parameters
Output Register Information
Return Code Information
Output Parameters
Request Subsystem Version Information Call — SSI Function Code 54
Type of Request
Use Information
Issued to
Related SSI Codes
Related Concepts
Environment
Input Register Information
Input Parameters
Fixed Header Input Section
Output Register Information
Return Code Information
Output Parameters
Fixed Header Output Section
System Variable Output Section
Installation Variable Output Section
Format of the Variable Output Sections
Specifying Keywords
Example
Scheduler Facilities Call - SSI Function Code 70
Type of Request
Use Information
Issued to
Related SSI Codes
Related Concepts
Environment
Input Register Information
Input Parameters
Output Register Information
Return Code Information
Output Parameters
JES Job Information Services— SSI Function Code 71
JES Job Information Services Request Types
SPOOL Read Service
Type of Request
Use Information
Issued to
Related SSI Codes
Related Concepts
Environment
Input Register Information
Input parameters
Output Register Information
Return Code Information
Output Parameters
JES2 Health monitor information
Type of Request
Use Information
Issued to
Related SSI Codes
Related Concepts
Environment
Input Register Information
Input Parameters
Output Register Information
Return Code Information
Output Parameters
Job Class Information
Type of Request
Use Information
Issued to
Related SSI Codes
Related Concepts
Environment
Input Register Information
Input Parameters
Output Register Information
Return Code Information
Output Parameters
Convert Device ID Service
Type of Request
Use Information
Issued to
Related SSI Codes
Related Concepts
Environment
Input Register Information
Input Parameters
Output Register Information
Return Code Information
Output Parameters
Checkpoint Version Information Service
Type of Request
Use Information
Issued to
Related SSI Codes
Related Concepts
Environment
Input Register Information
Input parameters
Output Register Information
Return Code Information
Output Parameters
Notify User Message Service Call — SSI Function Code 75
Type of Request
Use Information
Issued to
Related SSI Codes
Related Concepts
Environment
Input Register Information
Input Parameters
Output Register Information
Return Code Information
Output Parameters
SYSOUT Application Program Interface (SAPI) — SSI Function Code 79
Differences Between SSI Function Codes 1 and 79
Requesting SAPI Processing
SYSOUT Application Program Interface Request Types
General Programming Considerations — Applicable to All Calls
PUT/GET Requests
COUNT Requests
BULK MODIFY Requests
Use of the Client Token
Keeping Processed Data Sets
Type of Request
Use Information
Issued to
Related SSI Codes
Related Concepts
Environment
Input Register Information
Input Parameters
Input-only fields (Optional)
Input disposition fields (optional)
Output Register Information
Return Code Information
Output Parameters
Reason Codes for SSOBRETN being SSS2LERR
Reason Codes for SSOBRETN being SSS2BDIS
Reason Codes for SSOBRETN being SSS2EODS
Output-Only Fields
Job-Level Output-Only Fields
Extended Status Function Call — SSI Function Code 80
Extended Status Request Types
Type of Request
Use information
Use information for verbose requests
Use Information for data set list requests
Issued to
Related SSI Codes
Related concepts
Environment
Input Register Information
Input Parameters
Output Register Information
Return Code Information
Output Parameters
Job information elements
Job queue element sections
SYSOUT information elements
JES3 Unsupported Flags and Fields
Text lookup service (IAZTLKUP)
Example
JES Properties — SSI Function Code 82
JES Property Information Services Request Types
NJE Node Information
Type of Request
Use Information
Issued to
Related SSI Codes
Related Concepts
Environment
Input Register Information
Input Parameters
Output Register Information
Return Code Information
Output Parameters
SPOOL Volume Information
Type of Request
Use Information
Issued to
Related SSI Codes
Related Concepts
Environment
Input Register Information
Input Parameters
Output Register Information
Return Code Information
Output Parameters
Initiator Information
Type of Request
Use Information
Issued to
Related SSI Codes
Related Concepts
Environment
Input Register Information
Input Parameters
Output Register Information
Return Code Information
Output parameters
JESPLEX Information
Type of Request
Use Information
Issued to
Related SSI Codes
Related Concepts
Environment
Input Register Information
Input Parameters
Output Register Information
Return Code Information
Output Parameters
Job Class Information
Type of Request
Use Information
Issued to
Related SSI Codes
Related Concepts
Environment
Input Register Information
Input Parameters
Output Register Information
Return Code Information
Output Parameters
JES device information services — SSI function code 83
Requesting device information services processing
Considerations for 64-bit addressable virtual storage
JES device information services request types
Type of request
Use information
Issued to
Related SSI Codes
Related Concepts
Environment
Input register information
Input Parameters
Output Register Information
Return Code Information
Output Parameters
Data structures returned by the JES Device Information services:
System/member information
System information header (JDSIHDR)
Device information
Common fields
Device type value
Attributes used in work selection criteria
Representation of variable size data
Data structures returned by the interface
Common prefix section (JDCXPREF)
Remote workstation console data header (JDCHCONS)
Console device common section (JDCCCONS)
JES2 console device section (JDC2CONS)
JES3 console device section (JDC3CONS)
Logon device data header (JDGHLOGN)
Logon device common section (JDGCLOGN)
Logon device JES2 section (JDG2LOGN)
Logon device JES3 section (JDG3LOGN)
NETSRV device header (JDNHNSRV)
NETSRV common section (JDNCNSRV)
NETSRV device JES2 section (JDN2NSRV)
NETSRV JES3 section (JDN3NSRV)
Line device data header (JDLHLINE)
Line device common section (JDLCLINE)
Line device JES2 section (JDL2LINE)
Line device JES3 section (JDL3LINE)
Remote Workstation data
Remote Workstation data header (JDWHRMTW)
Remote workstation common section (JDWCRMTW)
Remote workstation SNA section (JDWNSNA)
Remote workstation BSC section (JDWBSC)
Remote workstation JES2 section (JDW2RMTW)
Printer/punch device data
Printer/punch data header (JDPHPRPU)
Printer/punch common section (JDPCPRPU)
Printer/punch work selection section (JDPWRKSL)
Non-impact printer section (JDPFPRT)
Printer/punch JES2 section (JDP2PRPU)
Printer/punch JES3 section (JDP3PRPU)
Remote printer section (JDPRPRT)
Reader device data header (JDRHRDR)
Reader common section (JDRCRDR)
Reader JES2 section (JDR2RDR)
Reader JES3 section (JDR3RDR)
OFFLOAD device data header (JDOHOFLD)
OFFLOAD device common section (JDOCOFLD)
OFFLOAD device JES2 section (JDO2OFLD)
Job receiver data header (JDBHJRCV)
Job receiver common section (JDBCJRCV)
Job receiver OFFLOAD section (JDBOJRCV)
Job receiver device JES2 section (JDB2JRCV)
SYSOUT receiver device data header (JDSHSRCV)
SYSOUT receiver common section (JDSCSRCV)
SYSOUT receiver OFFLOAD section (JDSOSRCV)
SYSOUT receiver JES2 section (JDS2SRCV)
Job transmitter data header (JDXHJXMT)
Job transmitter common data (JDXCJXMT)
Job transmitter NJE section (JDXNJXMT)
Job transmitter OFFLOAD section (JDXOJXMT)
Job transmitter JES2 section (JDX2JXMT)
SYSOUT transmitter data header (JDYHSXMT)
SYSOUT transmitter common section (JDYCSXMT)
SYSOUT transmitter NJE section (JDYNSXMT)
SYSOUT transmitter OFFLOAD section (JDYOSXMT)
SYSOUT transmitter device JES2 section (JDY2SXMT)
NJE connection data header (JDJHNJEC)
NJE connection common section (JDJCNJEC)
Storage management control block DSECT (JDSGSTRG)
Common sections
SNA application section (JDAPPLIC)
SNA application JES2 section (JDA2APPL)
TCP socket section (JDSKSOCK)
TCP socket JES2 section (JDK2SOCK)
Current job information section (JDJBINFO)
Current output information section (JDUTINFO)
Current output information JES2 section (JDU2INFO)
Current output information JES3 section (JDU3INFO)
Binary route code structure (JDD2DEST)
Modify Job Function Call — SSI Function Code 85
Modify job request types
Type of Request
Use information
Issued to
Related SSI Codes
Related Concepts
Environment
Input Register Information
Input parameters
Output Register Information
Return code information
Output Parameters
Job feedback elements (SSJF)
System Information
Setting Up Your Subsystem
Function Routines/Function Codes
Environment
Recovery and Integrity
Placement of Function Routines
Do You Need a Subsystem Address Space?
Defining Your Subsystem
Naming your subsystem
Passing parameters
The primary subsystem
Providing a Routine to Initialize Your Subsystem
What Your Subsystem Initialization Routine Can Do
How to Initialize Your Subsystem
Specifying an Initialization Routine
Using the START Command
Starting Your Subsystem With the START Command
Passing Accounting Parameters to Your Subsystem
Processing the SUBPARM Option
Initializing the SMF Parameters
Initializing the Subsystem
Modifying the SUBPARM Value
Using an SMF Console Command
Using an SMF Macro
Example
Services for Building and Using Your Subsystem
Adding Your Subsystem
Using the IEFSSNxx Parmlib Member
Using the IEFSSI macro
Using the SETSSI command
Initializing Your Subsystem
Coding the Initialization Routine
Defining What Your Subsystem Can Do
Building the SSVT
Changing What Your Subsystem Can Do
Enabling Your Subsystem for New Functions
Disabling Previously Supported Functions
Associating a New Function Routine with a Supported Function Code
Activating Your Subsystem
Using the IEFSSVT macro
Using the IEFSSI macro
Considerations
Reactivating a Subsystem after Deactivation
Deactivating Your Subsystem
Swapping Subsystem Functions
Storing and Retrieving Subsystem-specific Information
Storing Subsystem-specific Information
Retrieving Subsystem-specific Information
Defining Subsystem Options
Responding to the SETSSI Command
Starting Your Subsystem Under the Primary Subsystem
Querying Subsystem Information
Using the Subsystem Query Request of the IEFSSI Macro
Using the Display SSI Command
Maintaining Information About the Callers of Your Subsystem
SSAFF: Set/Obtain Subsystem Affinity
SSI Function Codes Your Subsystem Can Support
SSI Function Code Descriptions
End-of-Task Call — SSI Function Code 4
Type of Request
Use Information
Issued to
Related SSI Codes
Related Concepts
Environment
Input Register Information
Input Parameters
Output Register Information
Return Code Information
End-of-Address Space (End-of-Memory) Call — SSI Function Code 8
Type of Request
Use Information
Issued to
Related SSI Codes
Related Concepts
Environment
Input Register Information
Input Parameters
Output Register Information
Return Code Information
WTO/WTOR Call — SSI Function Code 9
Type of Request
Use Information
Issued to
Related SSI Codes
Related Concepts
Environment
Input Register Information
Input Parameters
Output Register Information
Return Code Information
Output Parameters
Command Processing Call — SSI Function Code 10
Type of Request
Use Information
Issued to
Related SSI Codes
Related Concepts
Environment
Input Register Information
Input Parameters
Output Register Information
Return Code Information
Output Parameters
Restrictions
General Considerations
Delete Operator Message — SSI Function Code 14
Type of Request
Use Information
Issued to
Related SSI Codes
Related Concepts
Environment
Input Register Information
Input Parameters
Output Register Information
Return Code Information
Output Parameters
Restrictions
General Considerations
Help Call — SSI Function Code 48
Type of Request
Use Information
Issued to
Related SSI Codes
Related Concepts
Environment
Input Register Information
Input Parameters
Output Register Information
Return Code Information
Early Notification of End-of-Task Call — SSI Function Code 50
Type of Request
Use Information
Issued to
Related SSI Codes
Related Concepts
Environment
Input Register Information
Input Parameters
Output Register Information
Return Code Information
Request Subsystem Version Information Call — SSI Function Code 54
Type of Request
Use Information
Issued to
Related SSI Codes
Related Concepts
Environment
Input Register Information
Input Parameters
Output Register Information
Return Code Information
Output Parameters
SMF SUBPARM Option Change Call — SSI Function Code 58
Type of Request
Use Information
Issued to
Related SSI Codes
Related Concepts
Environment
Input Register Information
Input Parameters
Output Register Information
Return Code Information
Restrictions
Example
Installation Supplied Subsystem
Tape Device Selection Call — SSI Function Code 78
Type of Request
Use Information
Issued to
Related SSI Codes
Related Concepts
Environment
Input Register Information
Input Parameters
Output Register Information
Return Code Information
Output Parameters
Restrictions
Example
Troubleshooting Errors in Your Subsystem
Handling Initialization Errors
Handling function request errors
Capturing the System Dump
Identifying the Type of Error
Identifying the Problem Type when the VRA is Available
Identifying Problem Type when the VRA is not Available
Determining the Cause of the Error
Identifying the Failing Subsystem
Identifying the Requested Subsystem Function
Identifying the Subsystem Function Routine
Identifying the Caller of the SSI
Identifying the Failing Exit Routine
Examples — Subsystem Interface Routines
Example 1 — Subsystem Initialization Routine (TSYSINIT)
Example 2 — Subsystem Function Routine (WRITEIT)
Example 3 — Subsystem Function Routine (DELETEIT)
Example 4 — Subsystem Function Routine (LISTEN)
Example 5 — Subsystem Requesting Routine (TSYSCALL)
Using IEFJSVEC with Your Subsystem
Defining What Your Subsystem Can Do
Building the SSVT
Environment
Input Register Information
Input Parameters
Output Register Information
Return Code Information
Output Parameters
Changing What Your Subsystem Can Do
Enabling Your Subsystem for New Functions
Environment
Restrictions
Input Register Information
Input Parameters
Output Register Information
Return Code Information
Output Parameters
Disabling Previously Supported Functions
Environment
Input Register Information
Input Parameters
Output Register Information
Return Code Information
Output Parameters
Accessibility
Notices
Trademarks
FOOTER
Copyright IBM Corporation 1990, 2014