DFHFCMT (file control table manager)

Call mechanism

Kernel subroutine call. Automatic stack storage acquired as part of the call.

Entry address

DFHFCMT. The entry point address is held in FC static storage in a field named FC_FCMT_ADDRESS, which is set by DFHFCRP when it loads DFHFCMT.

Purpose

The file control table manager is part of the file control component. This program is called to add, delete, and set FCT entries, and to return attributes of an FCT entry (inquire).

Called by

DFHAMFC
Inquire on, add, or delete a newly created FCT entry to the system
DFHAMPFI
Add the entry in the FCT for the CSD to the system
DFHDMPCA
Inquire on and set the attributes of the FCT entry for the CSD
DFHEDFX
Inquire on the attributes of an FCT entry
DFHEIQDS
Inquire on or set the attributes of FCT entries, or delete an FCT entry.

Inputs

The FCMT parameter list, as defined by the DFHFCMTA assembler DSECT, is created as part of the subroutine call.

The input parameters are:

Common parameters:
    File name
    String number
    Journal ID
    Recovery characteristics
    Journaling characteristics
    Enablement status
    Open time
    Data set disposition
    Service request attributes
    Record format
    Number of data buffers
    Number of index buffers
    Whether to catalog the FCT entry

VSAM-specific parameters:
    VSAM password
    Empty status
    Data set name sharing
    LSR pool ID
    Base name
    Forward recovery log ID
    BWO eligibility
    RLS access mode
    Read integrity

BDAM-specific parameters:
    Exclusive control

Outputs

Output parameters, as part of the FCMT parameter list. Apart from the response, all these are returned on the inquire or browse requests. The output parameters are:

Common parameters:
    File type
    String number
    Record size
    Key length
    Key position
    Recovery characteristics
    Journaling characteristics
    Enablement status
    Open status
    Open time
    Data set type
    Data set disposition
    Data set name
    Base data set name
    Service request attributes
    Record format
    Block format
    Access method
    Remote name
    Remote system

VSAM-specific parameters:
    VSAM password
    Empty status
    Object type
    Data set name sharing
    Number of data buffers
    Number of index buffers
    Number of active strings
    LSR pool ID
    Whether using shared resources
    Forward-recovery log ID
    RLS access mode
    Read integrity

BDAM-specific parameters:
    Block size
    Block key length
    Relative address form
    Exclusive control
    Response
    Reason

Data Table specific parameters:
    Table type
    Table size

Operation

  • Add:

    Storage for the new FCT entry is obtained out of the VSAM FCT storage subpool.

    The new FCT entry is completed by filling in the information from the caller's parameter list.

    The name of the new FCT entry is added to the TMP index.

    Finally the information in the new entry is written to the CICS global catalog if required.

  • Delete:

    The request is rejected if there are uncommitted updates for the file; that is, there are retained locks. DFHTMP is called to locate and quiesce the FCT entry.

    Any DSN block that is connected to the FCT entry is disconnected.

    The FCT entry name is deleted from the TMP index.

    The storage for the FCT entry is freed. In the case of a BDAM FCT entry, its DCB storage is also freed.

    Any catalog entries for the FCT entry are deleted.

  • Set:

    DFHTMP is called to locate the FCT entry.

    The request is rejected if there are uncommitted updates for the file; that is, there are retained locks.

    If the FCT entry is not marked ‘closed' and ‘disabled' (or ‘unenabled'), the request is rejected.

    Changes are made to the information in the FCT according to the caller's parameter list.

    Finally the changes are recorded by writing them to the CICS global catalog.

  • Inquire:

    DFHTMP is called to locate the FCT entry.

    The attributes are returned in the FCMT parameter list.

  • Connect:

    DFHTMP is called to locate the FCT entry.

    The connect count is incremented. The FCT token is returned to the caller.

  • Disconnect:

    DFHTMP is called to quiesce the FCT entry.

    A check is made to ensure that the file is closed and disabled (or unenabled). If the check fails, an error is returned to the caller.

    The connect count in the FCT is cleared and a call is again made to DFHTMP to release the quiesce.

How loaded

By DFHFCRP as part of file control initialization.



dfhs3fk.html | Timestamp icon Last updated: Monday, 5 June 2017