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 (24)  FINAL STATUS OF EACH CPU
    01C8  456 Dbl-Word     8 * (8)          RESERVED FOR FUTURE IBM USE
    0208  520 Dbl-Word     8 * (16)         Reserved for IBM use TIMERS
    0288  648 Dbl-Word     8 FTPWRP (6)     System termination footprints
    02B8  696 Dbl-Word     8 FTPIST (2)     Storage Initialization footprints
    02C8  712 Dbl-Word     8 FTPDMP (8)     DUMP FOOTPRINTING
              00000061       FTPGSVDW       (*-FTPBK+7)/8 GSURV FOOTPRINT
                                            SIZE IN DBL-WORDS
    0308  776 Dbl-Word     8 * (16)         Reserved for IBM use
    0388  904 Dbl-Word     8 FTPCKWRM (8)   CHECKPOINT/WARMSTART FOOTPRINTS
              00000008       FTPCKWDW       (*-FTPCKWRM+7)/8 FTPCKWRM SIZE IN
                                            DOUBLE-WORDS
    03C8  968 Dbl-Word     8 FTPBUFSZ       TERM MESSAGE BUFFER SIZE
              00000001       FTPBUFSL       (*-FTPBUFSZ+7)/8 FTPBUFSZ IN
                                            DOUBLEWORDS
              0000007A       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 (31)  TABLE OF FOOTPRINTS, ONE ENTRY
                                            FOR EACH CPU. WE SUPPORT AS MANY
                                            AS 31 CPU'S (FOLLOWING THE
                                            SOMEWHAT ARBITRARY CONVENTION
                                            USED ELSEWHERE).
              00000084       FTPLEN2        *-FTPMDFF LENGTH TO BE
                                            INITIALIZED TO FF'S.
    0194  404 Signed       4 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.
              00000090       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' CPU IS IN AN 'UNKNOWN'
                                            STATE (HCPSGPST COULD NOT
                                            COMMUNICATE WITH IT).
              .1.. ....      FTPCPUON       X'40' 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' THE STATE OF THE CPU
                                            HOLDING THE THE TERMINATION LOCK
                                            WAS NOT 'PFXAVAIL'.
              ...1 ....      FTPSOFER       X'10' HCPMCWMD FOUND POSSIBLE
                                            SOFTWARE ERROR.
              .... 1...      FTPHABEN       X'08' HAD ABEND ON THIS CPU (AS
                                            REPORTED BY THE PFXHABEN FLAG IN
                                            ITS PREFIX PAGE).
              .... .1..      FTPCKSTP       X'04' CPU IS CHECK-STOPPED AND
                                            FIRST NOTICED DURING CURRENT
                                            INCIDENT (NOT A RE-DISCOVERY OF A
                                            CHECK-STOP HANDLED EARLIER).
              .... ..1.      FTPMCHKX       X'02' A MACHINE CHECK OCCURRED
                                            AND FOR SOME REASON THE
                                            MACHINE-CHECK FLIH NEVER FINISHED
                                            HANDLING IT.
              .... ...1      FTPBROAD       X'01' 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' WE WERE RUNNING SIE
                                            (PFXHSIE WAS SET).
              .1.. ....      FTPFERCS       X'40' ERROR WAS CHECK-STOP, NOT
                                            MACHINE CHECK.
              ..1. ....      FTPF2ND        X'20' A SECONDARY ERROR OCCURRED
                                            WHILE HANDLING A MACHINE CHECK.
              ...1 ....      FTPF2CS        X'10' SECONDARY ERROR WAS A
                                            CHECK-STOP.
              .... 1...      FTPFMCIC       X'08' INVALID MCIC (REQUIRED BITS
                                            MISSING).
              .... .1..      FTPFABND       X'04' POSSIBLE SOFTWARE ERROR
                                            ENCOUNTERED. WHERE WE CANNOT
                                            ISSUE HCPABEND, WE SET THIS FLAG,
                                            THEN TERMINATE.
              .... ..1.      FTPFATSK       X'02' ATTEMPTED TO RUN
                                            INTERRUPTED SYSTEM TASK TO
                                            COMPLETION.
              .... ...1      FTPFXTSK       X'01' 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' EMERGENCY HOST TERMINATION
                                            REQUIRED (AND OTHER FLAGS MAY BE
                                            MEANINGLESS).
              .1.. ....      MCKFNOTM       X'40' HOST TERMINATION NOT
                                            REQUIRED BY THE MACHINE-CHECK
                                            FLIH.
              ..1. ....      MCKFDIE1       X'20' HOST TERMINATION WAS
                                            REQUIRED BY THE MACHINE-CHECK
                                            FLIH.
              ...1 ....      MCKFDIE2       X'10' HOST TERMINATION WAS
                                            REQUIRED BY THE MACHINE-CHECK
                                            SLIH.
              .... 1...      MCKFIPL        X'08' SOFT-RE-IPL AFTER TERMINATE
                                            DISALLOWED.
              .... .1..      MCKFIPLI       X'04' 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.
    0388  904 Dbl-Word     8 FTPWRMST       WARM START TIME
              00000008       FTPWRMSL       *-FTPCKWRM WARM START TIME LENGTH
    0390  912 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
    0288  648 Character    3 FTPWRPFP       HCPWRP FOOTPRINT
    028B  651 Bitstring    1 *              RESERVED FOR ALIGNMENT
    028C  652 Signed       4 FTPWRPIN       HCPWRPUP INPUT PARAMETERS
    0290  656 Bitstring    1 FTPWRPDS       DUMP STATUS
              .... ..1.      FTPDMPIP       X'02' DUMP IN PROGRESS FLAG
              .... ...1      FTPDMPFI       X'01' DUMP TAKEN FLAG
    0291  657 Bitstring    1 FTPWRPTS       TERMINATION STATUS
              .... ....      FTPTRMIP       X'00' TERMINATION IN PROGRESS
              .... ...1      FTPTRMFI       X'01' TERMINATION COMPLETE FLAG
              .... ..1.      FTPTRMER       X'02' TERMINATION UNSUCCESSFUL
    0292  658 Bitstring    1 *              RESERVED FOR IBM USE
    0293  659 Bitstring    1 FTPWRPER       ERROR STATUS
              .... ...1      FTPPRGCK       X'01' PROGRAM CHECK CAUSED WAIT
                                            921
              .... ..1.      FTPSVCIN       X'02' SVC INTERRUPT CAUSED WAIT
                                            921
    0294  660 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
    02B8  696 Character    3 FTPISTFP       HCPWRP footprint
    02BB  699 Bitstring    1 FTPISTST       HCPIST status footprint
    03C8  968 Signed       4 FTPMSGSZ       LENGTH OF AVAILABLE MESSAGE
                                            BUFFER

#### FTPBK Storage Layout

    *** FTPBK - FOOT-PRINT BLOCK
    *
    *     +-------------------------------------------------------+
    *   0 |                                                       |
    *     =                       FTPVRWCD                        =
    *     |                                                       |
    *     +-------------------------------------------------------+
    *  40 |///////////////////////////////////////////////////////|
    *     =///////////////////////////////////////////////////////=
    *     |///////////////////////////////////////////////////////|
    *     +-------------------------------------------------------+
    *  80 |                                                       |
    *     =                       FTPVRTST                        =
    *     |                                                       |
    *     +-------------------------------------------------------+
    *  C8 |                                                       |
    *     =                       FTPVRRMS                        =
    *     |                                                       |
    *     +-------------------------------------------------------+
    * 108 |                                                       |
    *     =                       FTPMCWMD                        =
    *     |                                                       |
    *     +-------------------------------------------------------+
    * 1C8 |///////////////////////////////////////////////////////|
    *     =///////////////////////////////////////////////////////=
    *     |///////////////////////////////////////////////////////|
    *     +-------------------------------------------------------+
    * 208 |///////////////////////////////////////////////////////|
    *     =///////////////////////////////////////////////////////=
    *     |///////////////////////////////////////////////////////|
    *     +-------------------------------------------------------+
    * 288 |                                                       |
    *     =                        FTPWRP                         =
    *     |                                                       |
    *     +-------------------------------------------------------+
    * 2B8 |                        FTPIST                         |
    *     |                                                       |
    *     +-------------------------------------------------------+
    * 2C8 |                                                       |
    *     =                        FTPDMP                         =
    *     |                                                       |
    *     +-------------------------------------------------------+
    * 308 |///////////////////////////////////////////////////////|
    *     =///////////////////////////////////////////////////////=
    *     |///////////////////////////////////////////////////////|
    *     +-------------------------------------------------------+
    * 388 |                                                       |
    *     =                       FTPCKWRM                        =
    *     |                                                       |
    *     +-------------------------------------------------------+
    * 3C8 |                       FTPBUFSZ                        |
    *     +-------------------------------------------------------+
    * 3D0
    *
    *** FTPBK - FOOT-PRINT BLOCK

    *** Overlay for FTPMCWMD in FTPBK
    *
    *     +-------------------------------------------------------+
    * 108 |                       FTPMDNAM                        |
    *     +------+------+-----------------------------------------+
    * 110 |//////|:TODB1|/////////////////////////////////////////|
    *     +------+------+-----------------------------------------+
    * 118 |                                                       |
    *     =                       FTPMDTAB                        =
    *     |                           +---------------------------+
    * 190 |                           |         FTPFENCE          |
    *     +---------------------------+---------------------------+
    * 198
    *
    *** 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
    *
    *     +-------------------------------------------------------+
    * 388 |                       FTPWRMST                        |
    *     +-------------------------------------------------------+
    * 390 |                       FTPWRMCT                        |
    *     +-------------------------------------------------------+
    * 398
    *
    *** 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
    *
    *     +--------------------+------+---------------------------+
    * 288 |     FTPWRPFP       |//////|         FTPWRPIN          |
    *     +------+------+------+------+------+--------------------+
    * 290 |:WRPDS|:WRPTS|//////|:WRPER|:NEWNC| 295
    *     +------+------+------+------+------+
    *
    *** Overlay for FTPWRP in FTPBK

    *** Overlay for FTPIST in FTPBK
    *
    *     +--------------------+------+
    * 2B8 |     FTPISTFP       |:ISTST| 2BC
    *     +--------------------+------+
    *
    *** Overlay for FTPIST in FTPBK

    *** Overlay for FTPBUFSZ in FTPBK
    *
    *     +---------------------------+
    * 3C8 |         FTPMSGSZ          | 3CC
    *     +---------------------------+
    *
    *** Overlay for FTPBUFSZ in FTPBK

#### FTPBK Cross Reference

    Symbol         Dspl Value
    -------------- ---- -----
    FTPBROAD       0119 01
    FTPBUFSL       03C8 00000001
    FTPBUFSZ       03C8
    FTPCKSTP       0119 04
    FTPCKWDW       0388 00000008
    FTPCKWRM       0388
    FTPCPUAD       0118
    FTPCPUON       0119 40
    FTPDMP         02C8
    FTPDMPFI       0290 01
    FTPDMPIP       0290 02
    FTPELEN        011B 00000004
    FTPENTRY       0118
    FTPFABND       011A 04
    FTPFATSK       011A 02
    FTPFENCE       0194
    FTPFERCS       011A 40
    FTPFMCIC       011A 08
    FTPFSIE        011A 80
    FTPFXTSK       011A 01
    FTPF2CS        011A 10
    FTPF2ND        011A 20
    FTPGSVDW       02C8 00000061
    FTPHABEN       0119 08
    FTPIPLRD       0294 01
    FTPIST         02B8
    FTPISTFP       02B8
    FTPISTST       02BB
    FTPLEN2        0118 00000084
    FTPLEN3        0194 00000090
    FTPMCHKX       0119 02
    FTPMCWMD       0108
    FTPMDFF        0110
    FTPMDNAM       0108
    FTPMDTAB       0118
    FTPMFLG1       0119
    FTPMFLG2       011A
    FTPMFLG3       011B
    FTPMSGCT       00CC
    FTPMSGLN       00D0
    FTPMSGST       00CB
    FTPMSGSZ       03C8
    FTPNEWNC       0294
    FTPNEWRD       0294 02
    FTPNEXTE       011C
    FTPPRGCK       0293 01
    FTPRCDFP       0000
    FTPRMSFP       00C8
    FTPSIZE        03C8 0000007A
    FTPSOFER       0119 10
    FTPSTATX       0119 20
    FTPSVCIN       0293 02
    FTPTOD         0110
    FTPTODB1       0111
    FTPTRANS       0294 03
    FTPTRMER       0291 02
    FTPTRMFI       0291 01
    FTPTRMIP       0291 00
    FTPTSTCM       008D
    FTPTSTFP       0080
    FTPUNKWN       0119 80
    FTPUNLOK       000B
    FTPVRRMS       00C8
    FTPVRTST       0080
    FTPVRWCD       0000
    FTPWRMCL       0390 00000008
    FTPWRMCT       0390
    FTPWRMSL       0388 00000008
    FTPWRMST       0388
    FTPWRP         0288
    FTPWRPDS       0290
    FTPWRPER       0293
    FTPWRPFP       0288
    FTPWRPIN       028C
    FTPWRPTS       0291
    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 V5R2.0. Last updated on 12 Apr 2006 at 16:57:29 EDT.
Copyright IBM Corporation, 1990, 2005