z/OS DFSMSdfp Advanced Services
Previous topic |
Next topic
|
Contents
|
Contact z/OS
|
Library
|
PDF
Contents (exploded view)
z/OS DFSMSdfp Advanced Services
SC23-6861-01
Abstract for DFSMSdfp Advanced Services
Changes for z/OS V2R1, as updated March 2014
z/OS Version 2 Release 1 summary of changes
Using the Volume Table of Contents
VTOC Components
Data Set Control Block (DSCB) Types
Format-0 DSCB
Name
Function
How Many
How Found
Format-1 and Format-8 DSCBs
Name
Function
How Many
How Found
Format-2 DSCB
Format-3 DSCB
Name
Function
How Many
How Found
Format-4 DSCB
Name
Function
How Many
How Found
Format-5 DSCB
Name
Function
How Many
How Found
Format-7 DSCB
Name
Format-9 DSCB
Name
Function
How Many
How Found
Allocating and Releasing DASD Space
The VTOC Index
VTOC Index Records
VTOC Index Entry Record
VTOC Pack Space Map
VTOC Index Map
VTOC map of DSCBs
Structure of an Indexed VTOC
Accessing the VTOC with DADSM Macros
Requesting DASD Volume Information Using LSPACE
LSPACE—Standard Form
LSPACE-Execute Form
LSPACE—List Form
LSPACE–DSECT Form
Return Codes from LSPACE
LSPACE Information Return Areas
Message Return Area
Expanded Message Return Area
Data Return Area
Format-4 DSCB Return Area
LSPACE Examples
Reading DSCBs from the VTOC Using OBTAIN
Reading a DSCB by Data Set Name
Example
Return Codes from OBTAIN (Reading by Data Set Name)
Reading a DSCB by Absolute Device Address
Example
Return Codes from OBTAIN (Reading by Absolute Device Address)
Releasing Unused Space from a DASD Data Set Using PARTREL
The PARTREL Macro
PARTREL–Execute Form
PARTREL—List Form
PARTREL–DSECT Form
Description
Return Codes From PARTREL
Creating (Allocating) a DASD Data Set Using REALLOC
REALLOC–Execute Form
REALLOC–List Form
REALLOC–DSECT Form
REALLOC Parameter List
Return Codes from REALLOC
Accessing the VTOC with CVAF Macros
Serializing and Updating
Identifying the Volume
Generating a CVPL (CVAF Parameter List)
Using Buffer Lists
Buffer List Header
Buffer List Entry
Using Macro ICVEDT02 to Map the Extents Area
Accessing the DSCB Directly
Specifying a Data Set Name to Read or Write a DSCB
Specifying the DSCB Location
Releasing Buffers and Buffer Lists Obtained by CVAF
Accessing DSNs or DSCBs in Sequential Order
Initiating Indexed Access (DSN Order)
Initiating Physical-Sequential Access
Reading Sets of DSCBs with CVAF Filter
RESUME Capability
Filter Criteria List (FCL)
Example of CVAFFILT Macro Sequences
Coding CVAF VTOC Access Macros
CVAFDIR Macro Overview and Specification
ACCESS: Read or Write a DSCB or VIRs, or Release Buffer Lists
DSN: Specify the Name of the DSCB
BUFLIST: Specify One or More Buffer Lists
VERIFY: Verify that a DSCB is a Format-0 DSCB
UCB or DEB: Specify the VTOC to Be Accessed
IOAREA: Keep or Free the I/O Work Area
MAPRCDS: Keep or Free MAPRCDS Buffer List and Buffers
IXRCDS: Retain VIERS in Virtual Storage
BRANCH: Specify the Entry to the Macro
EADSCB: Specify the support level for extended attribute DSCBs
MULTIPLEDSCBS: Specify whether multiple DSCBs should be processed
MF: Specify the Form of the Macro
Return Codes from CVAFDIR
Example of Using the CVAFDIR Macro with a VTOC
Example of Using the CVAFDIR Macro with an Indexed VTOC
Example of Using the CVAFDIR macro to read multiple DSCBs
CVAFDSM Macro Overview and Specification
ACCESS: Request Information from Index Space Maps or the VTOC
MAP: Identify the Map to Be Accessed
EXTENTS: Storage Area Where Extents Are Returned
RTA4BYTE: Specify the Type of Extent Area Used
MAPRCDS: Keep or Free MAPRCDS Buffer List and Buffers
UCB or DEB: Specify the VTOC to Be Accessed
COUNT: Obtain a Count of Unallocated DSCBs or VIRs
CTAREA: Supply a Field to Contain the Number of Format-0 DSCBs
HADSCB: Supply a Field to Contain the CCHHR of the Highest Allocated DSCB
IOAREA: Keep or Free the I/O Work Area
BRANCH: Specify the Entry to the Macro
EADSCB: Specify the support level for extended attribute DSCBs
MF: Specify the Form of the Macro
Return Codes from CVAFDSM
CVAFFILT Macro Overview and Specification
Control Block Address Resolution: Keyword=addr or (reg)
ACCESS: Retrieve a DSCB, or Release FLTAREA and/or IOAREA
BUFLIST: Specify a Buffer List
UCB or DEB: Specify the VTOC to Be Accessed
FCL: Specify a Filter Criteria List
FLTAREA: Keep or Free the Filter Save Area
IOAREA: Keep or Free the I/O Work Area
BRANCH: Specify the Entry to the Macro
EADSCB=value: Specify the support level for extended attribute DSCBs.
MF: Specify the Form of the Macro
Return Codes from CVAFFILT
Partially-Qualified Names for CVAFFILT
Example of Using the CVAFFILT Macro
Sample JCL for the CVAFFILT macro
Code example of the CVAFFILT Macro
CVAFSEQ Macro Overview and Specification
ACCESS: Specify Relationship between Supplied and Returned DSN
BUFLIST: Specify One or More Buffer Lists
DSN: Specify Access by DSN Order or by Physical-Sequential Order
UCB or DEB: Specify the VTOC to Be Accessed
DSNONLY: Specify That Only the Data Set Name Is Read
ARG: Specify Where the Argument of the DSCB Is to Be Returned
IOAREA: Keep or Free the I/O Work Area
IXRCDS: Retain VIERs in Virtual Storage
BRANCH: Specify the Entry to the Macro
EADSCB=value: Specify the support level for extended attribute DSCBs.
MF: Specify the Form of the Macro
Return Codes from CVAFSEQ
Example of using the CVAFSEQ macro with an indexed VTOC
Example of using the CVAFSEQ macro to process a volume in physical sequential order
Sample JCL for CVAFSEQ macro to process a volume in sequential order
Code example of the CVAFSEQ macro to process a volume in sequential order
CVAFTST Macro Overview and Specification
UCB: Specify the VTOC to Be Tested
Return Codes from CVAFTST
VTOC Index Error Message and Associated Codes
Error Message
Explanation
System Action
Programmer Response
Routing and Descriptor Codes
Codes Put in the CVSTAT Field
VTOC Error Responses
Recovering from System or User Errors
GTF Trace
VTOC and VTOC Index Listings
Managing the Volume Table of Contents
Creating the VTOC and VTOC Index
Protecting the VTOC and VTOC Index
RACF®
APF
Password Protection
Copying/Restoring/Initializing the VTOC
Volumes Containing a Nonindexed VTOC
Volumes Containing an Indexed VTOC
Deleting a Data Set from the VTOC
Specifying the Volumes Affected
Erasing Sensitive Data
System-Managed-Storage Considerations
General Considerations and Restrictions
SCRATCH and CAMLST Macro Specification
Example
SCRATCH Parameter List
Return Codes from SCRATCH
Status Codes from SCRATCH
Renaming a Data Set in the VTOC
Specifying the Volumes Affected
System-Managed-Storage Considerations
General Considerations and Restrictions
Multivolume Considerations
Unrenamable Data Sets and UNIX Files
Data Set Security
Renaming a Data Set That Might be in Use
RENAME and CAMLST Macro Specification
Example
RENAME Parameter List
Return Codes from RENAME
Status Codes from RENAME
Using Catalog Management Macros
Application Program Considerations
Catalog Search Order
Retrieving Information from a Catalog
Retrieving Information by Data Set Name (LOCATE and CAMLST NAME)
Example
Retrieving Information by Generation Data Set Name (LOCATE and CAMLST NAME)
Example
Retrieving Information by Alias (LOCATE and CAMLST NAME)
Example
Reading a Block by Relative Block Address (LOCATE and CAMLST BLOCK)
Return Codes from LOCATE
Using Non-VSAM Data Set Catalog Entries
Cataloging a Non-VSAM Data Set (CATALOG and CAMLST CAT)
Programming Considerations for Multiple-Step Jobs
Example
Uncataloging a Non-VSAM Data Set (CATALOG and CAMLST UNCAT)
Example
Recataloging a Non-VSAM Data Set (CATALOG and CAMLST RECAT)
Example
Return Codes from CATALOG
Executing Your Own Channel Programs
Comparing EXCP and EXCPVR
Using EXCP and EXCPVR
Allocating the Data Set or Device
Opening the Data Set
Direct Data Set Considerations
VSAM Data Set Considerations
Creating the Channel Program
CCW Channel Program
zHPF Channel Program
Comparing CCW and zHPF channel programs
EXCP 64-bit Storage Considerations
IDAW Requirements for EXCP Requests
IDAW Requirements for EXCPVR Requests
MIDAW Requirements
TIDAW requirements for EXCP requests
An EXCP Request with a Single 16K Storage Area
An EXCP Request with a virtual TIDAL
Determining Whether zHPF is Supported for a Device
Modifying a Channel Program During Execution
VIO Considerations
Creating the EXCP-Related Control Blocks
Input/Output Block (IOB)
Input/Output Block Common Extension (IOBE)
Event Control Block (ECB)
Input/Output Error Data Block (IEDB)
Data Control Block (DCB)
Data Control Block Extension (DCBE)
Data Extent Block (DEB)
Executing the Channel Program
Using the EXCP macro instruction
Using the EXCPVR macro instruction
Initiating the Channel Program
Translating the Channel Program
DASD Channel Program Prefix CCW Commands
DASD Rotational Positioning Sensing
Command Retry Considerations
Magnetic Tape Considerations
Lost Data Condition on IBM 3800
Processing the I/O Completion Status
Interruption Handling and Error Recovery Procedures
Reexecuting Channel Programs by Error Recovery Procedures
Example
Requesting Extended Error Information
Requesting Different Levels of ERP Processing
VIO considerations
Invalid ending status
Device No Longer Supports zHPF or Required zHPF functions
Handling End of Volume and End-Of-Data-Set Conditions
Closing the Data Set
Control Block Fields
Data Control Block (DCB) Fields
DCB Fields that do not have Macro Parameters
DCBOFLGS
DCBIFLGS
DCBTIOT
Foundation Block Parameters
EXCP Interface Parameters
Foundation Block Extension and Common Interface Parameters
Device-Dependent Parameters
Mapping the DCB
Data Control Block Extension (DCBE) Fields
Set and Retrieve Data Set Block Size
Input/Output Error Data Block (IEDB) Fields
Input/Output Block (IOB) Fields
IOBFLAG3 and IOBCSW Format for Different Channel Program Types
Input/Output Block Common Extension (IOBE) Fields
Event Control Block (ECB) Fields
Data Extent Block (DEB) Fields
EXCP and EXCPVR Appendages
Making Appendages Available to the System
The Authorized Appendage List (IEAAPP00)
Start-I/O Appendage
Page Fix and EXCPVR Start I/O Appendage
PGFX Appendage
SIO Appendage
Program-Controlled Interruption Appendage
End-of-Extent Appendage
Abnormal-End Appendage
Channel-End Appendage
Converting a Relative Track Address to an Actual Track Address
Return Codes from the Relative to Actual Conversion Routine
Converting an Actual Track Address to a Relative Track Address
Return Codes from the Conversion Routine
Using the IECTRKAD Callable Service or the TRKADDR Macro
Obtaining the Sector Number of a Block on an RPS Device
Using XDAP to Read and Write to Direct Access Devices
Using XDAP
Macro Instructions Used with XDAP
Defining a Data Control Block (DCB)
Initializing a Data Control Block (OPEN)
End of Volume (EOV)
Restoring a Data Control Block (CLOSE)
Executing Direct Access Programs
Control Blocks Used with XDAP
Input/Output Block
Event Control Block
Direct Access Channel Program
RPS Device Sector Numbers
Using Password Protected Data Sets
Providing Data Set Security
PASSWORD Data Set Characteristics
Creating Protected Data Sets
Tape Volumes Containing Multiple Password-protected Data Sets
Protection Feature Operating Characteristics
Terminating the Protection Feature Process
Password Protection When Switching Volumes
Password Protection When Concatenating Data Sets
Password Protection SCRATCH and RENAME Functions
Maintaining the Counter for Password Protection
Maintaining the PASSWORD Data Set Using PROTECT
Record Format
Protection-Mode Indicator
PROTECT Macro Specification
PROTECT Macro Parameter Lists
ADD Function
REPLACE Function
DELETE Function
LIST Function
Return Codes from the PROTECT Macro
Using System Macro Instructions
Ensuring Data Security by Validating the Data Extent Block (DEBCHK macro)
DEBCHK Macro Specification
Return Codes from DEBCHK
Obtaining I/O Device Characteristics (DEVTYPE macro)
DEVTYPE Macro Specification
Minimum Type Call
UCBLIST or INFOLIST Type of Call
DEVTYPE—Execute Form
DEVTYPE—List Form
DEVTYPE—Info Form
Device Characteristics Information
DEVTYPE—Return Codes and Reason Codes
DEVTYPE—Example 1—Referring to a DD Statement
DEVTYPE—Example 2—Includes Building a Parameter List
DEVTYPE—Example 3—Building a Parameter List and Using IHADVA
IHADVA Mapping macro
Reading and Modifying a Job File Control Block (RDJFCB Macro)
RDJFCB Macro Specification
Example
Type 07 JFCB Exit List Entry
RDJFCB Security
RDJFCB Use by Authorized Programs
Using BSAM or EXCP for Random I/O to a Multivolume Data Set
Type 13 JFCB Exit List Entry
Using RDJFCB to Retrieve Allocation Information
Example
DEQ at Demount Facility for Tape Volumes
High-Speed Cartridge Tape Positioning
OPEN - Initialize Data Control Block for Processing the JFCB
Purging and Restoring I/O Requests (PURGE and RESTORE macros)
PURGE Macro Specification
Return Codes from PURGE
Modifying the IOB Chain
RESTORE Macro Specification
Performing Track Calculations (TRKCALC macro)
Using TRKCALC
Determining the number of equal-length records that can be written on a track
Determining the total track capacity
Determine whether a record can be written in the space remaining on a track and return the new track balance
Determine the track balance if the last record were removed from a track
Determine the length of the longest possible record that can be written on a track
Restrictions
TRKCALC Macro Specification
TRKCALC—Standard Form
TRKCALC—Execute Form
TRKCALC—List Form
TRKCALC—DSECT Only
Input Register Usage for All Forms of MF
Output from TRKCALC
Return Codes from TRKCALC
TRKCALC Macro Examples
Perform calculations and conversions with 28-bit cylinder addresses (TRKADDR macro)
Calculate the relative track number on the volume (TRKADDR ABSTOREL)
Parameters
Compare two track addresses (TRKADDR COMPARE)
Parameters
Extract 28-bit cylinder number (TRKADDR EXTRACTCYL)
Parameters
Extract 4-bit track number (TRKADDR EXTRACTTRK)
Parameters
Increment track address (TRKADDR NEXTTRACK)
Parameters
Normalize cylinder number (TRKADDR NORMALIZE)
Parameters
Convert a relative track number to a 28-bit cylinder address (TRKADDR RELTOABS)
Parameters
Set cylinder number from register (TRKADDR SETCYL)
Parameters
Convert normalized track address into an absolute 28-bit track address (TRKADDR NORMTOABS)
Parameters
Determining Level and Name of DFSMS
Determining Version, Release, and Modification Level of DFSMS
Determining Name of DFSMS
Determining DFARELS During Assembler Macro Phase
Displaying Messages on Cartridge Magnetic Tape Subsystems (MSGDISP macro)
MSGDISP—Displaying a Mount Message
MSGDISP—Displaying a Verify Message
MSGDISP—Displaying a Ready Message
MSGDISP—Displaying a Demount Message
MSGDISP—Resetting the Message Display
MSGDISP—Providing the Full Range of Display Options
Return Codes from MSGDISP
Using DFSMSdfp Callable Services
Call for DFSMS Level Determination
Format
Parameters
Return Codes
Example
Call for Data Set Attribute Retrieval
Format
Parameters
Return Codes
Example
Call for Data Set Backup-While-Open Support
Format
Parameters
Return Codes
Example
Using the Backup-While-Open Facility
Call for DFSMSdfp Share Attributes
Format
Parameters
Return Codes
IGWASYS, IGWASMS, IGWABWO, IGWLSHR Return and Reason Codes
Call for Record-Level Sharing Query (IGWARLS)
Format
Parameters
Return Codes
Example
Call for converting and comparing 28-bit cylinder addresses (IECTRKAD)
Format
Parameters
Character Data Representation Architecture (CDRA) APIs
Using the DESERV Exit
Task Level Exit
Global Exit
Interactions Between the Task Level and Global Exits
Establishing Multiple Task level or Multiple Global Exits
Issuing DESERV FUNC=EXIT (invocation environment)
Invocation Syntax
Installing or Replacing the DESERV Exit
Deleting the DESERV Exit
Determining If a DESERV Exit Is Active
Writing the DESERV Exit
Parameters Related to the GET Function
Parameters Related to the PUT Function
PUT Return and Reason Codes
Parameters Related to the DELETE Function
Parameters Related to the RENAME Function
Parameters Related to the UPDATE Function
Entry Environment for Exit Routine
Exit Environment for Exit routine
Registers on Entry to the DESERV Exit
Registers on Return from the DESERV Exit
DESERV Exit Return and Reason Codes
DESERV FUNC=EXIT Return and Reason Codes
Example of the DESERV Exit
Managing Hierarchical File System Data Sets
Creating Hierarchical File System Data Sets
Defining the Root File System
Creating and Mounting the Root File System
Creating Additional File Systems and Directories
Adding and Mounting File Systems to the Root File System
Managing File System Size
Managing File System Activity
Accessing HFS Data Set Attributes
Transporting a File System
Removing (Deleting) a File System
Migrating a File System
Backing Up File Systems
Recovering a Backed-Up File System
HFS Deferred File System Synchronization
How to specify a SYNC value
Using pfsctl (BPX1PCT) Physical File System Control for HFS
DisplayBufferLimits Command
Usage Notes
ChangeBufferLimits Command
Usage Notes
DisplayGlobalStats Command
Usage Notes
DisplayFSStats Command
Usage Notes
ExtendFS Command
Usage Notes
BPX1PCT Return and Reason Codes
User Access to Subsystem Statistics, Status, and Counts Information
Register 1 Parameter List
Passed Argument List -- SSGARGL
Control Blocks
Data Extent Block (DEB) Fields
Data Facilities Area (DFA) Fields
Maintaining the System Image Library
UCS Images in SYS1.IMAGELIB
Examples of UCS Image Coding
UCS Image Alias Names
UCS Image Tables in SYS1.IMAGELIB
Alias Names in UCS Image Tables
Adding or Modifying a UCS Image Table Entry
Adding to the UCS Image Table
Verifying the UCS Image
FCB Images in SYS1.IMAGELIB
Adding an FCB Image to the Image Library
Modifying an FCB Image
Return Codes from IMGLIB
JES Support for the 3211 Indexing Feature
Using the extended address volume (EAV) migration assistance tracker
Information conventions for the EAV migration assistance tracker
Tracking information
Tracking value
DFSMS instances tracked by the EAV migration assistance tracker
LSPACE (SVC 78)
DEVTYPE (SVC 24)
IDCAMS LISTDATA PINNED
IEHLIST LISTVTOC
IDCAMS DCOLLECT
IDCAMS LISTCAT
OBTAIN (SVC 27)
CVAFDIR
CVAFSEQ
CVAFDSM
CVAFFILT
CVAFVSM
DCB Open of a VTOC
DCB Open of EAS eligible data set
Other Sample exclusion list
Recommend exclustion list
Summary of DFSMS instances
FOOTER
Copyright IBM Corporation 1990, 2014