gtpm2m1sMigration Guide: Program Update Tapes

TPF Collection Support Enhancements (APAR PJ25332)

The following section discusses the migration considerations for TPF collection support (TPFCS) enhancements. See TPF Collection Support (APAR PJ25098) for more information about TPFCS.

Prerequisite APARs

See the APEDIT for APAR PJ25332 for information about prerequisite APARs.

Functional Overview

The enhancements to TPFCS are as follows:

Architecture

There are no changes.

Operating Environment Requirements and Planning Information

There are none.

Interface Changes

The following section summarizes interface changes.

C/C++ Language

The following section summarizes C/C++ language changes. This information is presented in alphabetic order by the type of C/C++ language information. See the TPF C/C++ Language Support User's Guide and TPF Application Programming for more information about the C/C++ language.

Build Scripts

Table 507 summarizes changes to the build scripts used by the build tool. This information is presented in alphabetic order by the name of the build script.

Table 507. Changes to Build Scripts for TPF Collection Support Enhancements

Build Script Type New, Changed, or No Longer Supported? Description of Change
CJ00BS DLM Changed Build script for TPFCS central routines.
CJ10BS DLM Changed Build script for the ZBROW command.
CJ13BS DLM Changed Build script for TPFCS recoup central routines.
CJ17BS DLM Changed Build script for TPFCS recoup central routines.

Dynamic Load Module (DLM) Stubs

There are no changes.

General Use C/C++ Language Header Files

Table 508 summarizes the general use C/C++ language header file changes. This information is presented in alphabetic order by the name of the general use C/C++ language header file.

General use means these header files are available for your use.

Table 508. Changes to General Use C/C++ Language Header Files for TPF Collection Support Enhancements

C/C++ Language Header File New, Changed, or No Longer Supported? Do You Need to Recompile Segments?
c$to2.h Changed No
c$globz.h Changed No

Implementation-Specific C/C++ Language Header Files (IBM Use Only)

Table 509 summarizes the general use C/C++ language header file changes that are for IBM use only. This information is presented in alphabetic order by the name of the general use C/C++ language header file.

Table 509. Changes to Implementation-Specific C/C++ Language Header Files (IBM Use Only) for TPF Collection Support Enhancements

C/C++ Language Header File (IBM Use Only) New, Changed, or No Longer Supported? Do You Need to Recompile Segments?
c$bk0rp.h New No
c$to2m.h Changed No
c$to2r.h New No

Library Interface Scripts

Table 510 summarizes changes to the library interface scripts used by the library interface tool and the build tool. This information is presented in alphabetic order by the name of the library interface script.

Table 510. Changes to Library Interface Scripts for TPF Collection Support Enhancements

Library Interface Script New, Changed, or No Longer Supported? Description of Change
CJ00XV Changed Changed the library interface script for TPFCS.

Library Members (Object Files)

Table 511 summarizes the library member (object file) changes. This information is presented in alphabetic order by the name of the library member (object file).

Table 511. Changes to Library Members (Object Files) for TPF Collection Support Enhancements

Library Member (Object File) Library Module Name New, Changed, or No Longer Supported? Type Description of Change
CJ000 CJ00 Changed Assembler Updated for TPFCS.
CJ005 CJ00 Changed Assembler Updated for TPFCS DS and I/O control.
CJ006 CJ00 New Assembler Created for a TPFCS recoup routine.

Link-Edited Modules

There are no changes.

Members (Object Files)

Table 512 summarizes changes to members (object files). This information is presented in alphabetic order by the name of the member (object file).

Notes:

  1. You must recompile or reassemble a member (object file) if it has changed.

  2. You must prelink and link a dynamic load module (DLM) if it has changed.

Table 512. Changes to Members (Object Files) for TPF Collection Support Enhancements

Member (Object File) DLM/DLL New, Changed, or No Longer Supported? Type Description of Change
CJ01 CJ01 Changed Assembler Updated the ZOODB command parser.
CJ02 CJ01 Changed Assembler Updated the ZOODB command parser.
CJ03 CJ03 Changed Assembler Updated for the TPFCS task services routine.
CJ04 CJ04 Changed Assembler Updated for the TPFCS restart scheduler exit.
CJ106 CJ10 Changed C Language Updated for the ZBROW COLLECTION routine.
CJ110 CJ10 New C Language Created for the ZBROW DISPLAY FA routine.
CJ13 CJ13 Changed Assembler Updated for the TPFCS recoup routine.
CJ14 CJ13, CJ17 New C Language Created for the TPFCS recoup routines.
CJ17 CJ17 Changed Assembler Updated for the TPFCS recoup routine.

Object Code Only (OCO) Stubs

There are no changes.

Configuration Constant (CONKC) Tags

There are no changes.

Control Program Interface (CINFC) Tags

There are no changes.

Copy Members

Table 513 summarizes the copy member changes. This information is presented in alphabetic order by the name of the copy member.

Table 513. Changes to Copy Members for TPF Collection Support Enhancements

Copy Member Type CSECT Where Copy Member Is Located New, Changed, or No Longer Supported? Description of Change
CJ001 Real-Time Assembler CJ003 Changed Updated for TPFCS library C function support routines.
CJ002 Real-Time Assembler CJ000, CJ003, CJ004, CJ005, CJ006 Changed Updated for TPFCS common macro definitions.
CJ015 Real-Time Assembler CJ005 Changed Updated for TPFCS system services class.
CJ020 Real-Time Assembler CJ000 Changed Updated for base class definitions.
CJ021 Real-Time Assembler CJ006 Changed Updated for TPFCS directory entry support.
CJ022 Real-Time Assembler CJ005 Changed Updated for TPFCS database support objects.
CJ025 Real-Time Assembler CJ006 Changed Updated for TPFCS collection class definitions.
CJ026 Real-Time Assembler CJ006 Changed Updated for TPFCS cursor class definitions.
CJ030 Real-Time Assembler CJ004 Changed Updated for TPFCS structure class definitions.
CJ036 Real-Time Assembler CJ004 Changed Updated for TPFCS index structure support.
CJ037 Real-Time Assembler CJ004 Changed Updated for TPFCS flat structure support.
CJ038 Real-Time Assembler CJ004 Changed Updated for TPFCS hash structure support.
CJ101 Real-Time Assembler CJ100 Changed Updated for the ZBROW command.
CJ102 Real-Time Assembler CJ100 Changed Updated for the ZBROW command.
CJ103 Real-Time Assembler CJ100 Changed Updated for the ZBROW command.

Fixed File Records

There are no changes.

Macros

The following section summarizes the macro changes. This information is presented in alphabetic order by the type of macro.

Advanced Program-to-Program Communications (APPC) Macros

There are no changes.

Communication Macros and Statements

There are no changes.

Data Macros

Table 514 summarizes the data macro (DSECT) changes. This information is presented in alphabetic order by the name of the data macro (DSECT).

Table 514. Changes to Data Macros (DSECTs) for TPF Collection Support Enhancements

Data Macro (DSECT) New, Changed, or No Longer Supported? Do You Need to Reassemble Programs Using This Data Macro?
BK0RP Changed No
ITO2 Changed No

General Macros

There are no changes.

Selected Equate Macros

Table 515 summarizes the selected equate macro changes. This information is presented in alphabetic order by the name of the selected equate macro.

Table 515. Changes to Selected Equate Macros for TPF Collection Support Enhancements

Selected Equate Macro New, Changed, or No Longer Supported? Do You Need to Reassemble Programs?
BRPEQ Changed No

Structured Programming Macros (SPMs)

There are no changes.

System Initialization Program (SIP) Skeleton and Internal Macros (Inner Macros)

Table 516 summarizes the system initialization program (SIP) skeleton and internal macro changes. This information is presented in alphabetic order by the name of the SIP skeleton and internal macro. If the SIP skeleton and internal macro (inner macro) is changed, you must reassemble the SIP Stage I deck and run the appropriate job control language (JCL) jobs from the SIP Stage II deck.

Table 516. Changes to SIP Skeleton and Internal Macros for TPF Collection Support Enhancements

SIP Skeleton and Internal Macro New, Changed, or No Longer Supported?
SPPGML Changed

System Initialization Program (SIP) Stage I Macros and Statements

There are no changes.

System Initialization Program (SIP) Stage II Macros

Table 517 summarizes system initialization program (SIP) Stage II macro changes. This information is presented in alphabetic order by the name of the SIP Stage II macro. If IBMPAL is changed, you must run the system allocator (SALO) and load the new program allocation table (PAT) to the TPF 4.1 system.

Table 517. Changes to SIP Stage II Macros for TPF Collection Support Enhancements

SIP Stage II Macro New, Changed, or No Longer Supported?
IBMPAL Changed

System Communication Keypoint (SCK) Generation Macros

There are no changes.

System Macros

Table 518 summarizes system macro changes. This information is presented in alphabetic order by the name of the system macro. See TPF System Macros for a complete description of all system macros.

Table 518. Changes to System Macros for TPF Collection Support Enhancements

System Macro New, Changed, or No Longer Supported? Do You Need to Reassemble Programs?
GROUP Changed Yes (BRFM, BPM0, BPM1, and BKDIND (offline))

System Macros (IBM Use Only)

There are no changes.

Segments

Table 519 summarizes segment changes. This information is presented in alphabetic order by the name of the segment.

Table 519. Changes to Segments for TPF Collection Support Enhancements

Segment Type Link-Edit Module (Where Offline Segment Is Linked) New, Changed, or No Longer Supported? Description of Change
BKA0 Real-Time Assembler Not Applicable Changed Updated for TPFCS recoup.
BKB0 Real-Time Assembler Not Applicable Changed Updated for TPFCS recoup.
BRPC Real-Time Assembler Not Applicable Changed Updated for TPFCS recoup.
BRPI Real-Time Assembler Not Applicable Changed Updated for TPFCS recoup.
BSSC Real-Time Assembler Not Applicable Changed Updated for TPFCS recoup.
Note:
This update was made for the High Performance Option (HPO) feature only.
CJ12 Real-Time Assembler Not Applicable Changed Updated for TPFCS recoup.
CJ15 Real-Time Assembler Not Applicable New Created for TPFCS.
CJ16 Real-Time Assembler Not Applicable Changed Updated for TPFCS recoup.
CTKS Real-Time Assembler Not Applicable Changed Updated for TPFCS.
CTKT Real-Time Assembler Not Applicable Changed Updated for TPFCS.

System Equates

There are no changes.

User Exits

There are no changes.

Functional and Operational Changes

The following section summarizes functional and operational changes. This information is presented in alphabetic order by the functional or operational change.

See Appendix A, "PUT 2-15 Interface Changes by Authorized Program Analysis Report (APAR)" for a summary of functional and operational changes by APAR.

Commands

Table 520 summarizes command changes. This information is presented in alphabetic order by the name of the command. See TPF Operations for a complete description of all commands.

Attention: Changes to commands can impact any automation programs you are using in your complex.

Table 520. Changes to Commands for TPF Collection Support Enhancements

Command New, Changed, or No Longer Supported? Description of Change
ZBROW DISPLAY Changed Updated to add the new FA parameter.
ZOODB CHANGE Changed Updated to add new DS options.
ZOODB DEFINE Changed Updated to add new DS options.
ZRECP TO2 Changed Updated to add the new TIMEOUT parameter.

Messages and System Errors

Table 521 summarizes message (offline and online messages) and system error changes.

The message IDs or system error numbers are listed in numeric order preceded by their alphabetic prefix. Some offline and online messages do not have a standard message ID. For these, the messages are presented in alphabetic order based on the initial message text; or for those messages that begin with variable information, the initial message text that follows that variable information. See Messages (System Error and Offline) and Messages (Online) for a complete description of all messages and system errors.

Attention: Changes to offline messages, online messages, and system errors may impact any automation programs you are using in your complex.

Table 521. Changes to Messages and System Errors for TPF Collection Support Enhancements

Message ID or System Error Number Message Type New, Changed, or No Longer Supported?
020410 System Error New
041006 System Error New
BROW0701I Online New
BROW0702I Online New
BROW0751E Online New
BROW0752E Online New
CJ040003I Online New
CJ040004I Online New
CJ040052E Online New
OODB0014I Online New
OODB0030I Online New
OODB0123E Online New
OODB0130E Online New
RECP0215I Online New
RECP0281E Online No Longer Supported
RECP0285E Online New
RECP0286E Online New
RECP0287E Online New
RECP0288E Online New
RECP0289E Online New
RECP0290E Online New

Performance or Tuning Changes

There are no changes.

Storage Considerations and Changes

There are no changes.

System Initialization Program (SIP) and System Generation Changes

There are no changes.

Loading Process Changes

There are no changes.

Online System Load Changes

There are no changes.

Publication Changes

Table 522 summarizes changes to the publications in the TPF library. This information is presented in alphabetic order by the publication title. See the TPF Library Guide for more information about the TPF library.

Table 522. Changes to TPF Publications for TPF Collection Support Enhancements

Publication Title Softcopy File Name Description of Change
TPF Application Programming GTPAPP08 Added information about the new TPFCS collection types.
TPF C/C++ Language Support User's Guide GTPCLU09 Added new C/C++ functions for TPFCS.
TPF Concepts and Structures GTPCON06 Updated with information about the new TPFCS collection types.
TPF Database Reference GTPDBR07 Updated with information about TPFCS and TPFCS recoup.
TPF Library Guide GTPDOC09 Updated with definitions for new terminology in the master glossary.
Messages (System Error and Offline) and Messages (Online) Not Applicable Updated with information about messages and system errors that were added, changed, and no longer supported for TPFCS.
TPF Migration Guide: Program Update Tapes GTPMIG09 Updated with migration considerations for TPFCS.
TPF Operations GTPOPR09 Updated with information about the commands that were added and changed for TPFCS.
TPF System Macros GTPSYS09 Updated the GROUP macro with information for TPFCS.

Host System Changes

There are no changes.

Application Programming Interface (API) Changes

There are no changes.

Database Changes

There are no changes.

Feature Changes

There are no changes.

Installation Validation

There are no changes.

Migration Scenarios

To add TPFCS enhancements to your existing TPF 4.1 system, do the following:

  1. Install program update tape (PUT) 9 and APAR PJ25805.
  2. Run the system allocator program (SALO) using IBMPAL and SPPGML additions for newly created segments to create an updated program allocation table (PAT) and system allocator (SAL) table. See Table 512 and Table 519 for more information about new segments.
  3. Run the LIBI offline program for all changed library interface scripts listed in Table 510.
  4. Run CBLD for build scripts listed in Table 507.
  5. Install the following:
  6. Reassemble or recompile the following:
  7. Link-edit the build scripts (DLMs) listed in Table 512.
  8. It is recommended but not required that existing applications be updated to use the renamed APIs. All new applications should use the renamed APIs.
    • The following three collection types have been renamed:
      • The dictionary collection has been renamed to key sorted set. As a result of that change, the following APIs have been renamed:
        • TO2_createDictionary renamed to TO2_createKeySortedSet
        • TO2_createDictionaryTemp renamed to TO2_createKeySortedSetTemp
        • TO2_createDictionaryWithOptions renamed to TO2_createKeySortedSetWithOptions.
      • The ordered collection has been renamed to sequence. As a result of that change, the following APIs have been renamed:
        • TO2_asOrderedCollection renamed to TO2_asSequenceCollection
        • TO2_createOrder renamed to TO2_createSequence
        • TO2_createOrderTemp renamed to TO2_createSequenceTemp
        • TO2_createOrderWithOptions renamed to TO2_createSequenceWithOptions.
      • The sorted collection has been renamed to sorted bag. As a result of that change, the following APIs have been renamed:
        • TO2_createSort renamed to TO2_createSortedBag
        • TO2_createSortTemp renamed to TO2_createSortedBagTemp
        • TO2_createSortWithOptions renamed to TO2_createSortedBagWithOptions.
  9. Migrate your applications to be compatible with the new support:
    • The TO2_getCollectionType function now returns the following:
      • KEYSORTEDSET for dictionary collections
      • SEQUENCE for ordered collections
      • KEYBAG for sorted collections.
    • Change any application that creates a recoup index associated with a BLOB to use the TO2_RECOUP_IGNORED value of the collectionType parameter of the TO2_createRecoupIndex function.
    • Be aware that the TO2_getDRprotect function now returns BOOL instead of long.
    • Ensure that all applications that code a TO2_createEnv function pass compatible parameter types because the third and fourth parameters on the TO2_createEnv function have changed from u_char * to char *.
  10. Load the updated object code to your TPF 4.1 system.
  11. Enter ZRECP TO2 SETUP specified before running recoup.
  12. Ensure that the TPF 4.1 system is in NORM state before running any application programs.
  13. Continue to set up your TPFCS database as described in TPF Application Programming.

Fallback and Coexistence

When using TPFCS consider the following fallback and coexistence information: