COMPAKT and SIMULATE Statements

TYPE=FASTCPK statement syntax

The following table lists the operands available for Fast COMPAKTion (TYPE=FASTCPK), a COMPAKT-in-place that does not use a backup. Only the major statement (COMPAKT or SIMULATE) and TYPE=FASTCPK are required, all other operands are optional.

Fast COMPAKTion operands

Certain options that were documented in previous releases, such as BADCHAIN=, CPKDSNMX=, CPKMULTX=, FIT=, LRDAYS=, MINRLSE=, OBJECT=, SORT=, and %FOLD= have been removed from this manual because they are rarely used or not recommended. For documentation on these options, see the member $$CPK in the FDR Installation Control Library (ICL).

TYPE=RLSE statement syntax

The following table lists the operands available for COMPAKTOR RELEASE (TYPE=RLSE), the fast space release option. Only the major statement (COMPAKT or SIMULATE) and TYPE=RELEASE are required, all other operands are optional.

COMPAKTOR RELEASE Operands

Certain options that were documented in previous releases, such as BADCHAIN= and MINRLSE= have been removed from this manual because they are rarely used or not recommended. For documentation on these options, see the member $$CPK in the FDR Installation Control Library (ICL).

TYPE=COMPAKT statement syntax

The following table lists operands available for a COMPAKT-from-backup (TYPE=COMPAKT). Only the major statement name (COMPAKT or SIMULATE) is required; all operands are optional. If TYPE= omitted a COMPAKT-from-backup is done (see TYPE=FASTCPK Statement Syntax and TYPE=RLSE Statement Syntax for required operands for FASTCPK and RELEASE).

COMPAKT-From-Backup operands

Certain options that were documented in previous releases, such as BADCHAIN=, CPKDSNMX=, CPKMULTX=, DEVCYL=, FIT=, LRDAYS=, MINRLSE=, OBJECT=, SORT=, and %FOLD= have been removed from this manual because they are rarely used or not recommended. For documentation on these options, see the member $$CPK in the FDR Installation Control Library (ICL).

COMPAKT statement

The COMPAKT or CPK statement invokes either a full COMPAKTion of one or more DASD volumes, or causes just release of free space in data sets, depending on the TYPE= operand.

SIMULATE statement

The SIMULATE or SIM statement invokes a simulation of a real COMPAKTion, so that you can see what the results would be if the COMPAKTion was actually done. The BEFORE and AFTER maps and summary (depending on the MAPS= operand) are printed. TYPE=RLSE can be specified to simulate space release.

COMPAKT and SIMULATE statement operands

Abbreviations for the operands are shown under the operand name where applicable.

Specifies that COMPAKTOR is to perform a Fast COMPAKTion-in-place on one or more DASD volumes. No FDR backup is needed or used. TYPE=FASTCPK assumes that the volume may be active and assumes ACTMESS=NO, CONFMESS=NO, TEMPS=KEEP, and DSNENQ=USE (NONE for SIMULATE); active data sets are not moved. Data sets may not be scratched, the VTOC cannot be moved or expanded, and the VVDS cannot be moved.

Specifies that COMPAKTOR is to release excess space from PS, PO, and/or VSAM data sets on one or more DASD volumes. No FDR backup is needed or used. At least one operand requesting space release must be specified on the COMPAKT/SIMULATE statement or on a SELECT statement. TYPE=RLSE assumes that the volume may be active and assumes ACTMESS=NO, CONFMESS=NO, DSNENQ=USE (NONE for SIMULATE); space is not released from active data sets. No data sets are moved.

Specifies that COMPAKTOR is to perform a COMPAKTion on one DASD volume, from an FDR full-volume backup. If DUMP=YES is specified, COMPAKTOR invokes FDR to take that backup and then read it back. Otherwise, the backup must have been taken previously. TYPE=COMPAKT assumes that the volume is not active and that all data sets are movable; FASTCPK is used to COMPAKT active volumes. You must use TYPE=COMPAKT instead of FASTCPK if the output volume is not the same DASD device as the input volume, if data sets are to be scratched, or if the VTOC is to be moved or expanded or if the VVDS is to be moved.

Default: TYPE=COMPAKT.

Specifies that for data sets from which CPK is releasing space, this percentage of the data set be left as free space after COMPAKTion. PSRLSE=, PORLSE=, and/or VSRLSE= must also be specified or these parameters are ignored.

CPK only releases space on PS, PO, and VSAM data sets and never increases these data sets in size. For example, if a data set occupies 100 tracks of which 20 tracks are used, %FREE=50 leaves the final data set with 40 tracks. Values may be from zero (0) specifying that all of the unused space is to be freed, to 99 which says that 99% of the data set is to be left free.

%FREE applies to PS, PO, and VSAM data sets. %PSFREE applies only to PS data sets, %POFREE only to PO data sets, and %VSFREE only to VSAM data sets. If %FREE is coded along with one or more of the others, it applies to any of the data set types for which the specific keyword was not coded.

Default: 0 for all the keywords.

Specifies that CPK notify the operator if the volume being COMPAKTed is currently active (has more than one open DCB). The operator must then reply to the FDRW81 message before CPK continues compacting the volume.

Specifies that CPK suppress the active message.

Default: YES, for TYPE=COMPAKT unless overridden in the FDR option table.

Default: NO, for TYPE=RLSE and TYPE=FASTCPK. ACTMESS is ignored for SIMULATE or VTOC=COMPAKT.

Specifies that CPK ask the operator, via a WTOR, if the COMPAKTion can proceed. The operator must reply “YES” to the FDRW80 message to begin the COMPAKTion.

Specifies that CPK begin the COMPAKTion without asking the operator for confirmation.

Default: YES, for TYPE=COMPAKT; NO, for TYPE=RLSE and TYPE=FASTCPK. CONFMESS is ignored for SIMULATE.

These operands define an amount of fragmentation that you consider acceptable. If neither of these operands has a non-zero value, COMPAKTion is done unconditionally. If one or both of these operands are non-zero, COMPAKTion of a given volume is performed only if one of them is exceeded on that volume. These operands can only be specified with TYPE=COMPAKT,DUMP=YES or TYPE=FASTCPK.

Specifies the largest fragmentation index that a volume may have before it is to be COMPAKTed. The index is calculated from an IBM formula and is discussed in COMPAKTOR Algorithms. A decimal point is assumed in front of the value, for example, CPKFRAGI=2, CPKFRAGI=20 and CPKFRAGI=200 all refer to an index of .200.

Specifies the maximum number of free space areas that can exist before the volume is to be COMPAKTed.

CPYVOLID=

Specifies that the volume serial number of the target volume (the volume specified in the TODD= parameter) is to be retained. This applies only to TYPE=COMPAKT when the target volume is not the same as the original volume.

The target volume receives the serial number of the dumped volume.

Default: YES.

Specifies that all allocated tracks of PS, PO, and VSAM data sets are moved if the data set is moved by a Fast COMPAKTion, except for tracks that are released by COMPAKTOR.

Specifies that only the used tracks of PS, PO, and VSAM data sets are moved by a Fast COMPAKTion (TYPE=FASTCPK). This improves COMPAKTOR elapsed time and should be used unless there are data sets on the volume whose last block pointer or HI-USED-RBA is unreliable.

Default: USED.

Specifies that COMPAKTOR is to enqueue all of the data sets on the volume being processed, issuing an exclusive enqueue with a major name of “SYSDSN” and a minor name of the data set name. This is the enqueue used by the job scheduler. If the enqueue fails, COMPAKTOR issues a warning message for the data set and considers it an active data set (the data set is not moved and does not have any space released). Data sets that are not moved or released are not enqueued (for Fast COMPAKTion they may be enqueued briefly and dequeued).

DSNENQ= is independent of ENQ= that prevents new data sets from being allocated and old data sets from being scratched.

DSNENQ= can be used only if TYPE=RLSE or TYPE=FASTCPK has been specified.

No data set enqueue is issued; active data sets are not detected and may be moved or released.

The data sets are only tested to see if they are active at the time the COMPAKTion starts. The data sets are not enqueued.

The data sets are enqueued for the duration of the COMPAKTion of the volume. If they are enqueued to another task, they are considered active.

Default: USE, for COMPAKT; NONE for SIMULATE, but only for the TYPE=FASTCPK and TYPE=RLSE options. For COMPAKT TYPE=COMPAKT with DUMP=YES, the DSNENQ= option on the FDR DUMP statement must be used to detect active data sets.

For further information on enqueues, see the member ENQ in the FDR Installation Control Library (ICL).

DUMP=

CPK is to restore from an existing FDR backup tape.

Specifies that COMPAKTOR must invoke FDR to dump the DASD volume prior to COMPAKTion. The dump is always from the DISK1 DD statement to the TAPE1 statement; this is not affected by the FROMDD= or TODD= operands.

Default: NO.

Specifies that CPK issue an ENQUEUE/RESERVE against the VTOC on the volume being COMPAKTed. The volume is not accessible by other systems sharing this DASD volume until the COMPAKTion completes, unless your cross-CPU enqueue system converts SYSVTOC RESERVEs into cross-CPU enqueues.

Specifies that CPK not enqueue the VTOC. ENQ=NO is not valid for TYPE=FASTCPK and TYPE=RELEASE.

Specifies that CPK enqueue the VTOC for the duration of the operation (but not RESERVE it).

Default: RESERVE.

EXTENTS=

Specifies that all multi-extent non-VSAM data sets are to retain the number and size of their extents. If used with PSRLSE= and/or PORLSE=, the unused space is freed down to the requested boundary, but the extents occupied by the remaining used portion of the data set are not merged.

If omitted, COMPAKTOR automatically attempts to reduce most multi-extent data sets down to a single extent. This does not apply to TYPE=RLSE, since remaining extents are not moved.

ddn

Specifies the ddname of the input DD statement.

For TYPE=FASTCPK or TYPE=RLSE it points to the DASD volume to be processed.

For COMPAKT TYPE=COMPAKT this must point to an FDR backup file on tape or DASD.

For SIMULATE TYPE=COMPAKT, if you wish to simulation COMPAKTion from an FDR backup data set on DASD, you must specify FROMDD=TAPEx. If the FROMDD= does not start with TAPE, COMPAKTOR simulates COMPAKTion of the DASD volume pointed to by the DD statement.

Default: TAPE1, on COMPAKT TYPE=COMPAKT; DISK1, in all other cases.

HILIGHT=

Specifies no highlighting.

Specifies that CPK highlight certain data on the maps in order to make it stand out. This is done by overprinting the line three times.

Default: YES, unless HILIGHT=NO is set in the FDR option table.

nnn

Specifies the number of lines COMPAKTOR is to print per page, from 10 to 999.

Default: 58 lines to a page unless overridden in the FDR option table.

Specifies that no FDRW82 console messages are issued.

Specifies that CPK issue console operator messages FDRW82 indicating when begins and ends modification of a DASD volume. This may aid the operator in determining whether a COMPAKTOR operation has completed successfully.

Default: NO.

Specifies that the EAV map format for the BEFORE and AFTER maps are used that supports 7-digit cylinder numbers to accommodate EAV volumes and 8-digit numbers for the extent length. With MAPFORMAT=EAV, the “M” (millions) suffix is used for fields in the combined summary reports when values exceed 999,999.

Specifies that a new format for the BEFORE and AFTER maps are used that supports 5-digit cylinder numbers to accommodate very large DASD volumes such as the 3390-9.

Specifies that the old map format, with 4-digit cylinder numbers and 5-digit relative track numbers, be used. If MAPFORMAT=OLD is specified for the large DASD volumes, inaccurate cylinder and track numbers may be printed.

Default: EAV for EAV DASD volumes, NEW for DASD volumes with over 65535 tracks (such as the 3390-9), and OLD for all other DASD volumes.

Specifies which maps are to be printed on SYSMAP:

Specifies that only the AFTER COMPAKTion or SIM (simulation) map is to be printed.

Specifies that both the BEFORE and AFTER maps are to be printed.

Specifies that a full track/extent map is desired.

Specifies that CPK is to print only free areas.

Specifies that only a summary report is produced (no detail maps).

One or more of these may be entered in any order; if more than one is used, they must be surrounded by parenthesis.

Default: (ALL,EXTENTS) except for TYPE=RLSE where the default is SUMMARY.

Specifies how COMPAKTOR treats PS, PO, and VSAM data sets that do not have any secondary allocation quantity defined.

Do not release space from any data set that does not have a secondary allocation.

Data sets with no secondary allocation are candidates for space release.

Default: RLSE, unless overridden in the FDR option table (see NOSECOND).

Specifies that CPK not move or release data sets specified in the COMPAKTOR Unmovable Table, or that are active, or are unmovable for other reasons.

Specifies that CPK honor SELECT control statements to move or release data sets specified in the COMPAKTOR Unmovable Table, or that were flagged as “active” by the DSNENQ= option, or other types as specified in COMPAKTOR-Data-Set-Types.

Default: NO.

PSRLSE=

Specifies that unused tracks within Physical Sequential (PS) data sets are to be freed (this includes extended format (striped) PS data sets). CPK uses the last block pointer (DS1LSTAR) field in the VTOC to determine how many tracks of the data set are used. If this field is all zeros, CPK does not free any space from the data set. Some additional tracks may be retained as free space for expansion if %FREE= or %PSFREE= is coded.

For track-allocated data sets, all unused tracks are to be freed. For cylinder-allocated data sets, only unused cylinders are freed.

Only wholly unused extents are to be freed.

All of the unused tracks are to be freed even for data sets that are cylinder allocated.

If omitted, all PS data sets retain their original number of tracks unless they are affected by the RLSE= operand of a SELECT statement.

PORLSE=

This parameter is identical to the PSRLSE parameter, but applies only to partitioned data sets (DSORG=PO). This also applies to Partitioned Data Set Extended (PDSE), except that an internal high-block number is used for the free space calculation; space is not released from PDSEs by a COMPAKT-from-backup without DUMP=YES. %FREE= or %POFREE= may cause some free space to be retained for expansion.

Specifies that CPK is to print a list of the unmovable and active data sets.

Specifies that CPK ignore SELECT statements meeting the above conditions. SELTERR=NO also suppresses the error termination U0888 that normally occurs if one or more volumes specified by the VOL= operand are not found.

Specifies that CPK terminate processing on a volume if:

vA SELECT statement is entered that does not match any data set on the volume.

vA SELECT statement is entered for an unmovable data set (either from the COMPAKTOR Unmovable Table or identified as active by the DSNENQ= option), unless that SELECT specifies POS=KEEP.

Default: YES, unless SELTERR=NO is set in the FDR option table.

SIZEKEEP=

This is a performance option that reduces the number and size of the data sets to be moved by COMPAKTOR while still providing most of the free space consolidation benefits of COMPAKTion. Since data sets that are not moved do not have their tracks restored, this significantly reduces COMPAKTOR elapsed time. There are three sub-parameters:

• The first sub-parameter “size” specifies that COMPAKTOR is to search for groups of allocated tracks greater than or equal to this size; a group is a contiguous set of tracks, belonging to one or more data sets, with a free space extent on either side of it. These groups are initially made unmovable. “size” may range from 0 to 999999.
• The second parameter “pct” specifies a percentage reduction in the number of free space areas that COMPAKTOR must achieve (for example, 50 specifies that CPK must reduce the number of free space areas on the volume by at least 50 percent). If COMPAKTOR cannot achieve goal, it makes some of the track groups selected by the first sub parameter movable (the smaller groups in the list) and try again, repeating this until the desired percentage reduction is achieved or until all groups have been made movable. “pct” may range from 1 to 100.
• The third parameter “mx” is the maximum number of extents that a multi-extent data set may have to be included in SIZEKEEP processing. Data sets with more than “mx” extents are not considered part of any SIZEKEEP track group, and COMPAKTOR tries to combine their extents. If some, but not all, of the extents of a data set with “mx” or fewer extents are part of SIZEKEEP track groups, COMPAKTOR may move the other extents but does not combine them. “mx” may range from 1 to 60.
• The fourth sub-parameter "trks" sets a limit on the maximum number of tracks FASTCPK can attempt to move. The default value is 15000. The recommended value is 15000, except for EAV volumes where the recommended value is 50000.

If a data set that would be made unmovable by SIZEKEEP is positioned by a SELECT statement with POS=, the SELECT is honored. Space release is honored for SIZEKEEP data sets. SIZEKEEP is honored only for COMPAKTion in-place (TYPE=FASTCPK or TYPE=COMPAKT).

Specifying SIZEKEEP=0 disables this option for a COMPAKT-from-backup, but Fast COMPAKTion may still apply it to groups over 100 tracks as long as it can reduce the volume to one or two free areas.

Default: SIZEKEEP=(100, 90, 60). These defaults can be overridden in the FDR Global Options. The parenthesis can be omitted if only “size” is specified. For detailed recommendations on the use of SIZEKEEP= see CPK-Hints-and-Recommendations.

Specifies that CPK force CPYVOLID=YES when the input volume has the SMS-managed indicator in the VTOC, and enforce the rule that an SMS-managed volume can only be restored to a volume whose UCB indicates SMS management, and that a non-SMS volume must be restored to a non-SMS volume. This applies only to TYPE=COMPAKT when the target volume is not the original volume.

Bypasses the above SMS checks, and honors CPYVOLID=NO if specified.

Default: ALL.

Specifies the names of one or more SMS storage groups. COMPAKTOR interfaces to SMS to obtain all of the DASD volume serials that are defined to each of the specified storage group names, and processes them as if a VOL= operand was specified for them.

The syntax for STORGRP= is the same as for VOL= as documented below. You may specify a single storage group, a list of groups, and/or a “group” of group names (for example, STORGRP=DB*).

STORGRP= can be specified only for Fast COMPAKTion (TYPE=FASTCPK) or space release (TYPE=RLSE). You cannot specify STORGRP= and VOL= in the same run.

TEMPS=

Specifies that temporary data sets are to be retained when compacting. This is forced for TYPE=RLSE and TYPE=FASTCPK.

Default: Temporary data sets are automatically deleted under TYPE=COMPAKT.

ddn

For COMPAKT TYPE=COMPAKT, specifies the ddname of the DD statement pointing to the target DASD volume of the COMPAKTion. Must be a direct-access device.

Default: DISK1.

For SIMULATE TYPE=COMPAKT, may specify the ddname of a DD statement that points to a direct-access device with the capacity (that is, number of cylinders) desired for the target volume. Must be a device of the same basic type as the source volume. For example, if the source volume is a 3380 of any capacity (single, double, or triple), then TODD may specify a 3380 of any capacity, but not a 3390. The TODD volume is not altered in any way by SIMULATE.

Default: The target device is considered to have the same capacity (same number of cylinders) as the source volume.

Specifies that COMPAKTOR is to continue if an unusual condition occurs as listed on the CPK554E.

Specifying UNABLE=IGNORE suppresses the U0888 abend for the following reasons:

• INSUFFICIENT FREE STORAGE TRACKS
• NO FREE DSCB FOR RECOVERY LOG
• ALGORITHMS FAILED
• NO FREE TRACK FOR RECOVERY LOG

The following reasons are not affected by the specification of UNABLE=IGNORE and always issue a U0888 abend:

• I/O ERROR
• INSUFFICIENT STORAGE
• NON-STANDARD DATA SET NAME
• RECOVERY LOG FULL
• I/O ERROR WRITING RECOVERY LOG

Default: COMPAKTOR issues a U0888 abend.

Specifies one or more DASD volume serials that COMPAKTOR is to dynamically allocate and process. FROMDD= and VOL= may not both be specified. If VOL= is specified, there must be no DISK1 DD statement in the COMPAKTOR JCL.

For a COMPAKTion-from-backup (COMPAKT TYPE=COMPAKT or COMPAKT with no TYPE= operand), only one complete volume serial is allowed, for example, VOL=TSO001.

For TYPE=FASTCPK or TYPE=RLSE or SIMULATE, multiple volume serials may be specified:

• A list of volume serials may be given, enclosed in parentheses, up to a maximum of 254, for example, VOL=(TSO001,TSO002,TSO003)

COMPAKTOR processes the volumes in the order specified.

• A volume group may be specified by placing an asterisk at the end of the VOLSER prefix, for example, VOL=TSO*

Within that group, COMPAKTOR processes the volumes in the order that their UCBs exist in the operating system.

• The two may be combined, for example, VOL=(TSO*,PROD*,ABC001)

Each group is processed in the order described above before going on to the next group or volume.

• All online DASD volumes may be selected by: VOL=*

COMPAKTOR processes the volumes in the order that their UCBs exist in the operating system.

COMPAKTOR does not check for duplicate volume serials, so volumes selected more than once are processed more than once.

Specifies that all multi-extent VSAM components are to retain the number and size of their extents. If used with VSRLSE=ALL, the unused space is freed down to a Control Area (CA) boundary, but the extents occupied by the remaining used portion of the component is not merged.

Specifies that CPK is to attempt to merge most multi-extent VSAM components into a single extent.

Default: MERGE, except for a COMPAKT-from-backup with DUMP=NO, where the default is KEEP.

VSRLSE=

Specifies that unused tracks within VSAM components are to be freed. CPK uses the HI-USED-RBA field for the component to determine how much of the component is in use. If it is zero, CPK does not free any space from the data set.

Components of VSAM data sets are released to the Control Area (CA) boundary closest to the HI-USED-RBA; additional CAs may be retained as free space for expansion if %FREE= or %VSFREE= is specified. Space is not released from catalogs, the VVDS, or multi-volume components.

Space is not released from VSAM data sets, unless they are affected by the VSRLSE= operand of a SELECT statement.

Default: NO.

VTOC=

Specifies that the VTOC is to be COMPAKTed, embedded Format 0 DSCBs are to be eliminated. This option must be specified if you wish to change the location or size of the VTOC. VTOC=COMPAKT can be used only with a COMPAKT-from-backup (COMPAKT TYPE=CPK) and is invalid with TYPE=RLSE and TYPE=FASTCPK.

Specifies that the DSCB entries are to remain in the same location.

Default: NOCHANGE.