Programming Interface Information: This information is NOT intended to be used as Programming Interfaces of z/VM.

#### FTPBK

Prolog

Control Block Contents
FTPBK DSECT

Storage Layout

Cross Reference (Contains links to field and bit definitions)

#### FTPBK Prolog

     NAME       : HCPFTPBK
     DESCRIPTION: FOOT-PRINT BLOCK
     DSECT      : FTPBK
     FUNCTION   : PROVIDE FOOT-PRINTING OF THE RECOVERY
                  PROCESS FOR SUBSEQUENT DEBUGGING
     LOCATED BY : HCPWRKFP IS THE ANCHOR FOR THIS BLOCK.
     CREATED BY : THE ASSEMBLY OF HCPWRK.  THE
                  FOOT-PRINT BLOCK ALWAYS REMAINS
                  IN THE HOST CONTROL PROGRAM CRITICAL
                  WORKAREA.  EACH OF THE FOLLOWING
                  MODULES 'OWN' AN AREA IN FTPBK
                  WHICH THEY USE FOR RECORDING :
                  HCPVRRMS
                  HCPMCWMD
                  HCPWRP
                  HCPDMP
                  HCPCKP/HCPWRM
     DELETED BY : NONE, HOWEVER THE BLOCK IS CLEARED
                  BY HCPWRP

#### FTPBK Control Block Content

#### FTPBK DSECT

    Hex   Dec Type/Val   Lng Label (dup)    Comments
    ---- ---- --------- ---- -------------- --------
    0000    0 Structure      FTPBK          FOOT-PRINT BLOCK
    0000    0 Dbl-Word     8 FTPVRWCD (8)   Record user before a bounce
    0040   64 Dbl-Word     8 * (8)          Reserved for IBM use
    0080  128 Dbl-Word     8 FTPVRTST (9)   Restart user footprints
    00C8  200 Dbl-Word     8 FTPVRRMS (8)   TERMINATION MSG BUFFER STATUS
    0108  264 Dbl-Word     8 FTPMCWMD (35)  FINAL STATUS OF EACH CPU
    0220  544 Dbl-Word     8 FTPWRP (6)     System termination footprints
    0250  592 Dbl-Word     8 FTPIST (2)     Storage Initialization footprints
    0260  608 Dbl-Word     8 FTPDMP (8)     DUMP FOOTPRINTING
              00000054       FTPGSVDW       (*-FTPBK+7)/8 GSURV FOOTPRINT
                                            SIZE IN DBL-WORDS
    02A0  672 Dbl-Word     8 * (16)         Reserved for IBM use
    0320  800 Dbl-Word     8 FTPCKWRM (8)   CHECKPOINT/WARMSTART FOOTPRINTS
              00000008       FTPCKWDW       (*-FTPCKWRM+7)/8 FTPCKWRM SIZE IN
                                            DOUBLE-WORDS
    0360  864 Dbl-Word     8 FTPBUFSZ       TERM MESSAGE BUFFER SIZE
              00000001       FTPBUFSL       (*-FTPBUFSZ+7)/8 FTPBUFSZ IN
                                            DOUBLEWORDS
              0000006D       FTPSIZE        (*-FTPBK+7)/8 FTPBK SIZE IN
                                            DOUBLE-WORDS
    0108  264 Character    8 FTPMDNAM       THE NAME 'HCPMCWMD' GOES HERE.
    0110  272 Bitstring    1 FTPMDFF (0)    INITIALIZE TO FF'S. (SEE
                                            FTPLEN2).
    0110  272 Dbl-Word     8 FTPTOD (0)     TIMESTAMP ON ENTRY TO HCPMCWMD.
                                            (ZEROS IF STORE-CLOCK FAILS.)
    0110  272 Bitstring    1 *
    0111  273 Bitstring    1 FTPTODB1       FIRST BYTE OF FOOTPRINT TOD FIELD
    0112  274 Bitstring    1 * (6)
    0118  280 Signed       4 FTPMDTAB (64)  TABLE OF FOOTPRINTS, ONE ENTRY
                                            FOR EACH CPU. WE SUPPORT AS MANY
                                            AS 64 CPU'S.
              00000108       FTPLEN2        *-FTPMDFF LENGTH TO BE
                                            INITIALIZED TO FF'S.
    0218  536 Dbl-Word     8 FTPFENCE       THIS 'FENCE' OF ZEROES AT THE END
                                            OF THE INITIALLY ALL-FF'S TABLE
                                            PREVENTS US FROM RUNNING OFF THE
                                            END IN THE EVENT OF A MESSED UP
                                            CHAIN OF PREFIX PAGES.
              00000118       FTPLEN3        *-FTPMCWMD LENGTH OF AREA USED BY
                                            HCPMCWMD.
    0118  280 Bitstring    1 FTPENTRY (0)
    0118  280 Bitstring    1 FTPCPUAD       CONTAINS CPUID IN STAP FORMAT,
                                            LOW ORDER BYTE ONLY.
    0119  281 Bitstring    1 FTPMFLG1
              1... ....      FTPUNKWN       X'80' FTPUNKWN CPU IS IN AN
                                            'UNKNOWN' STATE (HCPSGPST COULD
                                            NOT COMMUNICATE WITH IT).
              .1.. ....      FTPCPUON       X'40' FTPCPUON CPU ASSOCIATED
                                            WITH THE PREFIX PAGE WAS ONLINE.
                                            (EXPECT IT TO BE OFFLINE AT TIMES
                                            SINCE PFX PAGE IS KEPT FOR 2
                                            MINUTES AFTER VARY OFF.)
              ..1. ....      FTPSTATX       X'20' FTPSTATX THE STATE OF THE
                                            CPU HOLDING THE THE TERMINATION
                                            LOCK WAS NOT 'PFXAVAIL'.
              ...1 ....      FTPSOFER       X'10' FTPSOFER HCPMCWMD FOUND
                                            POSSIBLE SOFTWARE ERROR.
              .... 1...      FTPHABEN       X'08' FTPHABEN HAD ABEND ON THIS
                                            CPU (AS REPORTED BY THE PFXHABEN
                                            FLAG IN ITS PREFIX PAGE).
              .... .1..      FTPCKSTP       X'04' FTPCKSTP CPU IS
                                            CHECK-STOPPED AND FIRST NOTICED
                                            DURING CURRENT INCIDENT (NOT A
                                            RE-DISCOVERY OF A CHECK-STOP
                                            HANDLED EARLIER).
              .... ..1.      FTPMCHKX       X'02' FTPMCHKX A MACHINE CHECK
                                            OCCURRED AND FOR SOME REASON THE
                                            MACHINE-CHECK FLIH NEVER FINISHED
                                            HANDLING IT.
              .... ...1      FTPBROAD       X'01' FTPBROAD MACHINE CHECK IS
                                            ESSENTIALLY IDENTICAL TO AN
                                            EARLIER ONE AND IS REGARDED AS A
                                            'BROADCAST' MACHINE CHECK.
                 CAUTION: THE DATA IN THE BYTE BELOW IS SIMPLY COPIED
                       FROM THE MCKBK AND MAY NOT APPLY TO THE CURRENT
                       INCIDENT (ESPECIALLY IN THE CASE OF A CPU THAT IS
                       NOT THE ONE HOLDING THE SYSTEM TERMINATION LOCK).
                       IF NO ERROR WAS HANDLED ON (OR FOR) THIS CPU DURING
                       THE CURRENT INCIDENT, THEN THESE FLAGS ARE SIMPLY
                       LEFT OVER FROM A PREVIOUS INCIDENT.
    011A  282 Bitstring    1 FTPMFLG2
              1... ....      FTPFSIE        X'80' FTPFSIE WE WERE RUNNING SIE
                                            (PFXHSIE WAS SET).
              .1.. ....      FTPFERCS       X'40' FTPFERCS ERROR WAS
                                            CHECK-STOP, NOT MACHINE CHECK.
              ..1. ....      FTPF2ND        X'20' FTPF2ND A SECONDARY ERROR
                                            OCCURRED WHILE HANDLING A MACHINE
                                            CHECK.
              ...1 ....      FTPF2CS        X'10' FTPF2CS SECONDARY ERROR WAS
                                            A CHECK-STOP.
              .... 1...      FTPFMCIC       X'08' FTPFMCIC INVALID MCIC
                                            (REQUIRED BITS MISSING).
              .... .1..      FTPFABND       X'04' FTPFABND POSSIBLE SOFTWARE
                                            ERROR ENCOUNTERED. WHERE WE
                                            CANNOT ISSUE HCPABEND, WE SET
                                            THIS FLAG, THEN TERMINATE.
              .... ..1.      FTPFATSK       X'02' FTPFATSK ATTEMPTED TO RUN
                                            INTERRUPTED SYSTEM TASK TO
                                            COMPLETION.
              .... ...1      FTPFXTSK       X'01' FTPFXTSK ATTEMPT TO
                                            COMPLETE INTERRUPTED SYSTEM TASK
                                            WAS SUCCESSFUL.
                 CAUTION: THE DATA IN THE BYTE BELOW IS SIMPLY COPIED
                       FROM THE MCKBK AND MAY NOT APPLY TO THE CURRENT
                       INCIDENT (ESPECIALLY IN THE CASE OF A CPU THAT IS
                       NOT THE ONE HOLDING THE SYSTEM TERMINATION LOCK).
                       IF NO ERROR WAS HANDLED ON (OR FOR) THIS CPU DURING
                       THE CURRENT INCIDENT, THEN THESE FLAGS ARE SIMPLY
                       LEFT OVER FROM A PREVIOUS INCIDENT.
                 NOTES      : THE MCKFDIE2 AND MCKFIPLI FLAGS WILL NEVER BE SET
                       IN THE BYTE BELOW SINCE THE BYTE BELOW IS COPIED
                       FROM THE FLIH MCKBK, NOT THE SLIH MCKBK.
    011B  283 Bitstring    1 FTPMFLG3
              1... ....      MCKFEMER       X'80' MCKFEMER EMERGENCY HOST
                                            TERMINATION REQUIRED (AND OTHER
                                            FLAGS MAY BE MEANINGLESS).
              .1.. ....      MCKFNOTM       X'40' MCKFNOTM HOST TERMINATION
                                            NOT REQUIRED BY THE MACHINE-CHECK
                                            FLIH.
              ..1. ....      MCKFDIE1       X'20' MCKFDIE1 HOST TERMINATION
                                            WAS REQUIRED BY THE MACHINE-CHECK
                                            FLIH.
              ...1 ....      MCKFDIE2       X'10' MCKFDIE2 HOST TERMINATION
                                            WAS REQUIRED BY THE MACHINE-CHECK
                                            SLIH.
              .... 1...      MCKFIPL        X'08' MCKFIPL SOFT-RE-IPL AFTER
                                            TERMINATE DISALLOWED.
              .... .1..      MCKFIPLI       X'04' MCKFIPLI SOFT-RE-IPL
                                            DISALLOWED BY IO SUB-SYSTEM.
              00000004       FTPELEN        *-FTPENTRY LENGTH OF A SINGLE
                                            ENTRY IN TABLE.
    011C  284 Bitstring    1 FTPNEXTE (0)   START OF NEXT ENTRY OF THE TABLE.
    0320  800 Dbl-Word     8 FTPWRMST       WARM START TIME
              00000008       FTPWRMSL       *-FTPCKWRM WARM START TIME LENGTH
    0328  808 Dbl-Word     8 FTPWRMCT       WARM START COMPLETED TIME
              00000008       FTPWRMCL       *-FTPWRMCT WARM START COMPLETED
                                            TIME LENGTH
    0000    0 Character    3 FTPRCDFP       Entered HCPWRP
    0003    3 Bitstring    1 *              Reserved for IBM use
    0004    4 Signed       4 *              Reserved for IBM use
    0008    8 Bitstring    3 *              Reserved for IBM use
    000B   11 Bitstring    1 FTPUNLOK       V=F Area is unlocked
    0080  128 Character    3 FTPTSTFP       Entered HCPISU
    0083  131 Bitstring    1 FTPZMIVI       CALL HCPZMIVI TO VERIFY STORAGE
                                            INITIALIZATION FOR I/O
                                            INTERPRETATION
    0084  132 Signed       4 * (2)          Reserved for IBM use
    008C  140 Bitstring    1 *              Reserved for IBM use
    008D  141 Bitstring    1 FTPTSTCM       VRTST DONE, BOUNCE OVER
    00C8  200 Character    3 FTPRMSFP       ENTERED HCPVRRMS ALREADY
    00CB  203 Bitstring    1 FTPMSGST       STATUS OF MESSAGE BUFFER
    00CC  204 Signed       4 FTPMSGCT       COUNT OF MESSAGES IN BUFFER
    00D0  208 Signed       4 FTPMSGLN       LENGTH OF MESSAGE BUFFER USED
    0220  544 Character    3 FTPWRPFP       HCPWRP FOOTPRINT
    0223  547 Bitstring    1 *              RESERVED FOR ALIGNMENT
    0224  548 Signed       4 FTPWRPIN       HCPWRPUP INPUT PARAMETERS
    0228  552 Bitstring    1 FTPWRPDS       DUMP STATUS
              .... ..1.      FTPDMPIP       X'02' FTPDMPIP DUMP IN PROGRESS
                                            FLAG
              .... ...1      FTPDMPFI       X'01' FTPDMPFI DUMP TAKEN FLAG
    0229  553 Bitstring    1 FTPWRPTS       TERMINATION STATUS
              .... ....      FTPTRMIP       X'00' FTPTRMIP TERMINATION IN
                                            PROGRESS
              .... ...1      FTPTRMFI       X'01' FTPTRMFI TERMINATION
                                            COMPLETE FLAG
              .... ..1.      FTPTRMER       X'02' FTPTRMER TERMINATION
                                            UNSUCCESSFUL
    022A  554 Bitstring    1 *              RESERVED FOR IBM USE
    022B  555 Bitstring    1 FTPWRPER       ERROR STATUS
              .... ...1      FTPPRGCK       X'01' FTPPRGCK PROGRAM CHECK
                                            CAUSED WAIT 921
              .... ..1.      FTPSVCIN       X'02' FTPSVCIN SVC INTERRUPT
                                            CAUSED WAIT 921
    022C  556 Bitstring    1 FTPNEWNC       STATUS OF TRANSFERRING CONTROL TO
                                            A NEW NUCLEUS
              .... ...1      FTPIPLRD       X'01' IPL RECORD OF NEW NUCLEUS
                                            READ
              .... ..1.      FTPNEWRD       X'02' HCPLOD OF NEW NUCLEUS WAS
                                            READ
              .... ..11      FTPTRANS       X'03' TRANSFER OF CONTROL TO NEW
                                            NUCLEUS ATTEMPTED
    0250  592 Character    3 FTPISTFP       HCPWRP footprint
    0253  595 Bitstring    1 FTPISTST       HCPIST status footprint
    0360  864 Signed       4 FTPMSGSZ       LENGTH OF AVAILABLE MESSAGE
                                            BUFFER

#### FTPBK Storage Layout

    *** FTPBK - FOOT-PRINT BLOCK
    *
    *     +-------------------------------------------------------+
    *   0 |                                                       |
    *     =                       FTPVRWCD                        =
    *     |                                                       |
    *     +-------------------------------------------------------+
    *  40 |///////////////////////////////////////////////////////|
    *     =///////////////////////////////////////////////////////=
    *     |///////////////////////////////////////////////////////|
    *     +-------------------------------------------------------+
    *  80 |                                                       |
    *     =                       FTPVRTST                        =
    *     |                                                       |
    *     +-------------------------------------------------------+
    *  C8 |                                                       |
    *     =                       FTPVRRMS                        =
    *     |                                                       |
    *     +-------------------------------------------------------+
    * 108 |                                                       |
    *     =                       FTPMCWMD                        =
    *     |                                                       |
    *     +-------------------------------------------------------+
    * 220 |                                                       |
    *     =                        FTPWRP                         =
    *     |                                                       |
    *     +-------------------------------------------------------+
    * 250 |                        FTPIST                         |
    *     |                                                       |
    *     +-------------------------------------------------------+
    * 260 |                                                       |
    *     =                        FTPDMP                         =
    *     |                                                       |
    *     +-------------------------------------------------------+
    * 2A0 |///////////////////////////////////////////////////////|
    *     =///////////////////////////////////////////////////////=
    *     |///////////////////////////////////////////////////////|
    *     +-------------------------------------------------------+
    * 320 |                                                       |
    *     =                       FTPCKWRM                        =
    *     |                                                       |
    *     +-------------------------------------------------------+
    * 360 |                       FTPBUFSZ                        |
    *     +-------------------------------------------------------+
    * 368
    *
    *** FTPBK - FOOT-PRINT BLOCK

    *** Overlay for FTPMCWMD in FTPBK
    *
    *     +-------------------------------------------------------+
    * 108 |                       FTPMDNAM                        |
    *     +------+------+-----------------------------------------+
    * 110 |//////|:TODB1|/////////////////////////////////////////|
    *     +------+------+-----------------------------------------+
    * 118 |                                                       |
    *     =                       FTPMDTAB                        =
    *     |                                                       |
    *     +-------------------------------------------------------+
    * 218 |                       FTPFENCE                        |
    *     +-------------------------------------------------------+
    * 220
    *
    *** Overlay for FTPMCWMD in FTPBK

    *** Overlay for FTPMDTAB in FTPBK
    *
    *     +------+------+------+------+
    * 118 |:CPUAD|:MFLG1|:MFLG2|:MFLG3|
    *     +------+------+------+------+
    *
    *** Overlay for FTPMDTAB in FTPBK

    *** Overlay for FTPCKWRM in FTPBK
    *
    *     +-------------------------------------------------------+
    * 320 |                       FTPWRMST                        |
    *     +-------------------------------------------------------+
    * 328 |                       FTPWRMCT                        |
    *     +-------------------------------------------------------+
    * 330
    *
    *** Overlay for FTPCKWRM in FTPBK

    *** Overlay for FTPVRWCD in FTPBK
    *
    *     +--------------------+------+---------------------------+
    *   0 |     FTPRCDFP       |//////|///////////////////////////|
    *     +--------------------+------+---------------------------+
    *   8 |////////////////////|:UNLOK| C
    *     +--------------------+------+
    *
    *** Overlay for FTPVRWCD in FTPBK

    *** Overlay for FTPVRTST in FTPBK
    *
    *     +--------------------+------+---------------------------+
    *  80 |     FTPTSTFP       |:ZMIVI|///////////////////////////|
    *     +--------------------+------+------+------+-------------+
    *  88 |///////////////////////////|//////|:TSTCM| 8E
    *     +---------------------------+------+------+
    *
    *** Overlay for FTPVRTST in FTPBK

    *** Overlay for FTPVRRMS in FTPBK
    *
    *     +--------------------+------+---------------------------+
    *  C8 |     FTPRMSFP       |:MSGST|         FTPMSGCT          |
    *     +--------------------+------+---------------------------+
    *  D0 |         FTPMSGLN          | D4
    *     +---------------------------+
    *
    *** Overlay for FTPVRRMS in FTPBK

    *** Overlay for FTPWRP in FTPBK
    *
    *     +--------------------+------+---------------------------+
    * 220 |     FTPWRPFP       |//////|         FTPWRPIN          |
    *     +------+------+------+------+------+--------------------+
    * 228 |:WRPDS|:WRPTS|//////|:WRPER|:NEWNC| 22D
    *     +------+------+------+------+------+
    *
    *** Overlay for FTPWRP in FTPBK

    *** Overlay for FTPIST in FTPBK
    *
    *     +--------------------+------+
    * 250 |     FTPISTFP       |:ISTST| 254
    *     +--------------------+------+
    *
    *** Overlay for FTPIST in FTPBK

    *** Overlay for FTPBUFSZ in FTPBK
    *
    *     +---------------------------+
    * 360 |         FTPMSGSZ          | 364
    *     +---------------------------+
    *
    *** Overlay for FTPBUFSZ in FTPBK

#### FTPBK Cross Reference

    Symbol         Dspl Value
    -------------- ---- -----
    FTPBROAD       0119 01
    FTPBUFSL       0360 00000001
    FTPBUFSZ       0360
    FTPCKSTP       0119 04
    FTPCKWDW       0320 00000008
    FTPCKWRM       0320
    FTPCPUAD       0118
    FTPCPUON       0119 40
    FTPDMP         0260
    FTPDMPFI       0228 01
    FTPDMPIP       0228 02
    FTPELEN        011B 00000004
    FTPENTRY       0118
    FTPFABND       011A 04
    FTPFATSK       011A 02
    FTPFENCE       0218
    FTPFERCS       011A 40
    FTPFMCIC       011A 08
    FTPFSIE        011A 80
    FTPFXTSK       011A 01
    FTPF2CS        011A 10
    FTPF2ND        011A 20
    FTPGSVDW       0260 00000054
    FTPHABEN       0119 08
    FTPIPLRD       022C 01
    FTPIST         0250
    FTPISTFP       0250
    FTPISTST       0253
    FTPLEN2        0118 00000108
    FTPLEN3        0218 00000118
    FTPMCHKX       0119 02
    FTPMCWMD       0108
    FTPMDFF        0110
    FTPMDNAM       0108
    FTPMDTAB       0118
    FTPMFLG1       0119
    FTPMFLG2       011A
    FTPMFLG3       011B
    FTPMSGCT       00CC
    FTPMSGLN       00D0
    FTPMSGST       00CB
    FTPMSGSZ       0360
    FTPNEWNC       022C
    FTPNEWRD       022C 02
    FTPNEXTE       011C
    FTPPRGCK       022B 01
    FTPRCDFP       0000
    FTPRMSFP       00C8
    FTPSIZE        0360 0000006D
    FTPSOFER       0119 10
    FTPSTATX       0119 20
    FTPSVCIN       022B 02
    FTPTOD         0110
    FTPTODB1       0111
    FTPTRANS       022C 03
    FTPTRMER       0229 02
    FTPTRMFI       0229 01
    FTPTRMIP       0229 00
    FTPTSTCM       008D
    FTPTSTFP       0080
    FTPUNKWN       0119 80
    FTPUNLOK       000B
    FTPVRRMS       00C8
    FTPVRTST       0080
    FTPVRWCD       0000
    FTPWRMCL       0328 00000008
    FTPWRMCT       0328
    FTPWRMSL       0320 00000008
    FTPWRMST       0320
    FTPWRP         0220
    FTPWRPDS       0228
    FTPWRPER       022B
    FTPWRPFP       0220
    FTPWRPIN       0224
    FTPWRPTS       0229
    FTPZMIVI       0083
    MCKFDIE1       011B 20
    MCKFDIE2       011B 10
    MCKFEMER       011B 80
    MCKFIPL        011B 08
    MCKFIPLI       011B 04
    MCKFNOTM       011B 40

This information is based on z/VM V6R1.0. Last updated on 18 Feb 2010 at 08:42:26 EDT.
Copyright IBM Corporation, 1990, 2008