| Programming Interface Information: This information is NOT intended to be used as Programming Interfaces of z/VM. | 
TKTBK
Control Block Contents  
   TKTBK DSECT
Cross Reference (Contains links to field and bit definitions)
TKTBK Prolog
 Name       : HCPTKTBK
 DESCRIPTION: SPXTAPE File Control Information Block
 DSECT      : TKTBK
 FUNCTION   : Holds control information for files dumped
              or loaded by SPXTAPE
 Located by :
              Routines:  HCPSPX** - SPXTAPE DUMP commands
              HCPSPY** - SPXTAPE DUMP commands
              HCPSPN** - SPXTAPE LOAD/SCAN commands
              HCPSPZ** - SPXTAPE LOAD/SCAN commands
              HCPSPW** - SPXTAPE service routines
              HCPSPO** - SPXTAPE service routines
              Fields:    SPTTKTQ  - queue of files ready to go
              CHPTKTS  - files to be released when the
              current channel program completes
 CREATED BY : HCPSPXDR - SPXTAPE DUMP commands
              HCPSPZRI - SPXTAPE LOAD and SCAN commands
 DELETED BY : HCPSPORR - SPXTAPE service routine
              HCPSPNDW - SPXTAPE LOAD commands
              HCPSPZRT - SPXTAPE SCAN commands
TKTBK Control Block Content
TKTBK DSECT
Hex   Dec Type/Val   Lng Label (dup)    Comments
---- ---- --------- ---- -------------- --------
0000    0 Structure      TKTBK          SPXTAPE File Control Information
                                        Block
0000    0 Address      4 TKTNEXT        Pointer to next block on q
0004    4 Address      4 TKTSDFLX       Pointer to next SDF ticket that
                                        has its symbolic lock held. There
                                        will be only one lock request for
                                        any given name, no matter how
                                        many instances of the name are
                                        open at the same time.
     Flags
0008    8 Bitstring    1 TKTFLAG        Ticket flags
          1... ....      TKTNOSEL       X'80' Too early to select file
          .1.. ....      TKTSETUP       X'40' In setup mode - don't help
                                        now for DUMP.
          .1.. ....      TKTMSEG        TKTSETUP Multi-segment file being
                                        processed for LOAD.
          ..1. ....      TKTTAKEN       X'20' File has been chosen by a
                                        tape for processing
          .... 1...      TKTEOF         X'08' Turned on when all DASD
                                        reads have been done (DUMP) or
                                        when the tape has read last page
                                        (LOAD)
          .... .1..      TKTREADY       X'04' All DASD reads complete
          .... ...1      TKTEOSEG       X'01' Tape read last on reel, not
                                        EOF
0009    9 Bitstring    1 TKTEFLG        Error flags
          1... ....      TKTPAGER       X'80' Map paging error - skip
                                        rest of file
          .1.. ....      TKTSKIPX       X'40' Problem reading XAB pages -
                                        skip XAB page processing
          ..1. ....      TKTBAD         X'20' File will not be dumped to
                                        tape
000A   10 Bitstring    1 TKTFLAG1       Ticket flags extension
          1... ....      TKTCOMPL       X'80' Complete file
          .1.. ....      TKTXABWR       X'40' Indicator to DASD write
                                        that data currently being written
                                        is XAB data.
          ..1. ....      TKTERRCV       X'20' Tkt waiting for tape write
                                        error recovery
          ...1 ....      TKTDUPF        X'10' File duplicates one already
                                        on the system.
          .... 1...      TKTNOLOD       X'08' Didn't LOAD file
000B   11 Bitstring    1 TKTRESOR       Flags to hold resource status for
                                        SDF
          1... ....      TKTSDFLK       X'80' Set if file is an SDF and
                                        it is locked - same meaning as
                                        SPTSDFLK
          .1.. ....      TKTPONCL       X'40' Purge Tkt on close
          ..1. ....      TKTNEWUS       X'20' New user assigned because
                                        user not known on this system or
                                        user ran out of spool ids
          ...1 ....      TKTPUTSH       X'10' File has been placed in
                                        system hold; used to suppress
                                        redundant reasons/messages
     Task counters
000C   12 Signed       4 TKTTAPWT       CPEBK for Tape drive waiting for
                                        more data
0010   16 Signed       4 TKTWKRCT       Count of worker tasks in progress
0014   20 Signed       4 TKTWKRMX       Maximum count of workers needed
0018   24 Signed       4 TKTSEGLO       File segments loaded - match to
001C   28 Signed       4 TKTSEGDU       Segments dumped (saved in last
                                        header)
     File Lock
0020   32 Dbl-Word     8 TKTBKLK (3)    Lock held shared while any
                                        activity for block. Gotten
                                        exclusive before releasing, I/O
                                        error processing, or moving to
                                        TAPTKTQD.
0038   56 Signed       4 TKTLKTRA       R14 of last lock or unlock
                                        request for debugging
     File pointers and counters
003C   60 Signed       4 TKTRELPG       Relative Page to start next SSQBK
0040   64 Signed       4 TKT1STRP       First relative page number on
                                        tape. It applies to the active
                                        segment now being written. It is
                                        updated when the tape volume is
                                        successfully closed. The next
                                        drive to select the file will
                                        start from the new value. If the
                                        tape is aborted, the file is
                                        requeued with the original
                                        starting value.
0044   68 Signed       4 TKTSPLPG       Pages processed to date
0048   72 Signed       4 TKTSPLOV       Page overhead count For DUMP,
                                        this field includes map & XAB
                                        pages For LOAD, this field
                                        includes only XAB pages
004C   76 Signed       4 TKTSPMOF       Section offset into map page
0050   80 Signed       4 TKTSSQ         Top SSQBK
0054   84 Signed       4 TKTNASSQ       Number of active SSQ (Quorums)
                                        used in scheduling storage.
                                        Selected tkts can not be stopped
                                        for the lack of storage.
          00000004       TKTQLIM        4 The Minimum number of quorums a
                                        selected tkt must be allowed
0058   88 Signed       4 TKTCMSSQ       SSQBK containing the last
                                        committed page. Used for restart
                                        if there is an I/O error. Updated
                                        to TKTSSQ when I/O completes
                                        successfully.
005C   92 Signed       4 TKTCMXAB       XAB length that remains to be
                                        written in next block when XAB
                                        spans blocks.
0060   96 Address      4 TKT1STMP       First map page
0064  100 Address      4 TKTCURMP       Current map page
0068  104 Signed       4 TKTCURMI       Index of map page currently
                                        pointed to by TKTCURMP.
006C  108 Signed       4 TKTCURPG       Current data page slot
0070  112 Signed       4 TKTCURPT       Offset of next slot
0074  116 Signed       4 TKTPGCNT       Count of slots remaining in page
0078  120 Signed       4 TKTSPFBK       SPFBK of file ticket controls and
                                        represents
007C  124 Signed       4 TKTBDBCT       Count of blks that were
                                        unreadable from DASD
     Pseudo SSQBK fields for DASD write routines. TKTDASWT and TKTWTCNT
     serve the same purpose as SSQDASWT and SSQWTCNT. The fields must be in
     the same order and have the same displacement from each other. They are
     used for writing XAB data to DASD.
0080  128 Signed       4 TKTDASWT       Waiting CPEBK when DASD I/O done
0084  132 Signed       4 TKTWTCNT       Count of DASD tasks to end wait
          00000064       TKTPSSSQ       TKTDASWT-SSQDASWT+SSQBK Offset of
                                        PSEUDO SSQBK
0088  136 Signed       4 TKTXABS (8)    XAB virtual page assignments
          00000020       TKTXLEN        *-TKTXABS Length of the area
     Miscellaneous fields
00A8  168 Signed       4 TKTRSPT        Address of SPTBK that was used to
                                        select this file. Used to write
                                        the command in the logs and to
                                        locate the selecting SPTBK when
                                        the file is logged.
00AC  172 Signed       2 TKTUOSPD       User spool file ID when dumped.
00AE  174 Signed       2 *              Reserved
     SPFBK Descriptor
     The data definitions between TKTDESC and TKTDESCL are those which are
     included in the SPFBK description that is put out on the tape during
     SPXTAPE DUMP. If any changes are made to this area of the TKTBK, then
     tape format compatibility must be considered.
00B0  176 Dbl-Word     8 TKTDESC (0)
     Other file field to be carried on tape
00B0  176 Dbl-Word     8 * (0)
00B0  176 Dbl-Word     8 TKTIDTS        Time that the file started to
                                        dump. Used to uniquely identify
                                        pieces of a multi- segment file.
00B8  184 Signed       4 TKTMAPCT       Map pages needed for file
00BC  188 Signed       4 TKTPAGNO       On tape, first relative page of
                                        this segment. While writing or
                                        reading from tape, this field has
                                        the relative page processed to
                                        date.
00C0  192 Signed       4 TKTBLKNO       Relative data block number
                                        currently being written to tape.
00C4  196 Signed       4 *              Reserved for future use
00C8  200 Dbl-Word     8 TKTSRCND       Original node ID
00D0  208 Dbl-Word     8 TKTSRCUS       Originating user ID
     SPFBK ID Fields
00D8  216 Character    8 TKTOWNER       File owner
00E0  224 Character    8 TKTORIG        File originator on this system
00E8  232 Signed       4 TKTSYSID       System ID when dumped
00EC  236 Signed       2 TKTUSPID       User spool file ID when dumped
00EE  238 Character    1 TKTSPCLS       Class
00EF  239 Character    1 *              Reserved
00F0  240 Character    8 TKTFN          File name
00F8  248 Character    8 TKTFT          File type
0100  256 Character    8 TKTDIST        Distribution
0108  264 Dbl-Word     8 TKTDEST        Destination
0110  272 Character    8 TKTUFORM       User form name
0118  280 Character    8 TKTOFORM       Operator form name
0120  288 Character    8 TKTSCLAB       Seclabel of spool file
0128  296 Character    8 TKTXFEE        Userid of previous file owner
0130  304 Bitstring    1 TKTCOPY        Copy count
0131  305 Bitstring    1 * (3)          Reserved for future use
     SPFBK Statistics
0134  308 Signed       4 TKTDPCNT       Data pages in use
0138  312 Signed       4 TKTXABLN       XAB length in bytes
013C  316 Bitstring    2 TKTCCWMX       Maximum CCW length
013E  318 Signed       2 TKTFCBLN       Maximum FCB length
0140  320 Signed       4 TKTRCNT        Record count
0144  324 Signed       2 TKTLRECL       Logical record length
0146  326 Bitstring    2 *              Reserved for future use
0148  328 Dbl-Word     8 TKTCLKOP       File open time
0150  336 Signed       4 TKTCLKCL       File close time
     SPFBK Flags
0154  340 Bitstring    1 TKTSTAT        Status flags
0155  341 Bitstring    1 TKTTYPE        Origin queue for spool files
0156  342 Bitstring    1 TKTQUEUE       Current queue
0157  343 Bitstring    1 TKTSYSTY       Special system file types
0158  344 Bitstring    1 TKTDVTYP       Originating device type
0159  345 Bitstring    1 TKTPSFF        PSF flags
015A  346 Bitstring    1 TKTSHPST       Spool file status
015B  347 Bitstring    1 TKTSHTDN       Shutdown open file flag
     SPFBK 3800 Fields
015C  348 Bitstring    1 TKTPRTFL       3800 print file flags
015D  349 Bitstring    1 TKTSTCPY       3800 starting copy count
015E  350 Bitstring    1 TKTPGCPY       3800 copies per page
015F  351 Bitstring    1 TKTMODNO       3800 modification number
0160  352 Bitstring    1 TKTFLSCT       3800 flash count
0161  353 Bitstring    1 TKTPGLEN       3800 page length
0162  354 Bitstring    2 *              Reserved for future use
0164  356 Signed       4 * (0)
0164  356 Character   16 TKTCHARS       Character sets
0174  372 Character    4 TKTFCB         FCB name for file
0178  376 Signed       4 TKTMOD         Modification character set
017C  380 Character    4 TKTCMOD        Character modification
0180  384 Character    4 TKTFLASH       Flash name
0184  388 Signed       4 * (8)          Reserved future use
          000000F4       TKTDESCL       *-TKTDESC Descriptor-length
                                        written to tape
          00000035       TKTLENDW       (*-TKTBK+7)/8 Size of the TKTBK
                                        block in DW's
TKTBK Storage Layout
          
*** TKTBK - SPXTAPE File Control Information Block
*
*     +---------------------------+---------------------------+
*   0 |         TKTNEXT           |         TKTSDFLX          |
*     +------+------+------+------+---------------------------+
*   8 |:FLAG |:EFLG |:FLAG1|:RESOR|         TKTTAPWT          |
*     +------+------+------+------+---------------------------+
*  10 |         TKTWKRCT          |         TKTWKRMX          |
*     +---------------------------+---------------------------+
*  18 |         TKTSEGLO          |         TKTSEGDU          |
*     +---------------------------+---------------------------+
*  20 |                                                       |
*     =                       TKTBKLK                         =
*     |                                                       |
*     +---------------------------+---------------------------+
*  38 |         TKTLKTRA          |         TKTRELPG          |
*     +---------------------------+---------------------------+
*  40 |         TKT1STRP          |         TKTSPLPG          |
*     +---------------------------+---------------------------+
*  48 |         TKTSPLOV          |         TKTSPMOF          |
*     +---------------------------+---------------------------+
*  50 |          TKTSSQ           |         TKTNASSQ          |
*     +---------------------------+---------------------------+
*  58 |         TKTCMSSQ          |         TKTCMXAB          |
*     +---------------------------+---------------------------+
*  60 |         TKT1STMP          |         TKTCURMP          |
*     +---------------------------+---------------------------+
*  68 |         TKTCURMI          |         TKTCURPG          |
*     +---------------------------+---------------------------+
*  70 |         TKTCURPT          |         TKTPGCNT          |
*     +---------------------------+---------------------------+
*  78 |         TKTSPFBK          |         TKTBDBCT          |
*     +---------------------------+---------------------------+
*  80 |         TKTDASWT          |         TKTWTCNT          |
*     +---------------------------+---------------------------+
*  88 |                                                       |
*     =                       TKTXABS                         =
*     |                                                       |
*     +---------------------------+-------------+-------------+
*  A8 |         TKTRSPT           |  TKTUOSPD   |/////////////|
*     +---------------------------+-------------+-------------+
*
*** TKTBK - SPXTAPE File Control Information Block
          
*** Overlay for TKTDESC in TKTBK
*
*     +-------------------------------------------------------+
*  B0 |                       TKTIDTS                         |
*     +---------------------------+---------------------------+
*  B8 |         TKTMAPCT          |         TKTPAGNO          |
*     +---------------------------+---------------------------+
*  C0 |         TKTBLKNO          |///////////////////////////|
*     +---------------------------+---------------------------+
*  C8 |                       TKTSRCND                        |
*     +-------------------------------------------------------+
*  D0 |                       TKTSRCUS                        |
*     +-------------------------------------------------------+
*  D8 |                       TKTOWNER                        |
*     +-------------------------------------------------------+
*  E0 |                       TKTORIG                         |
*     +---------------------------+-------------+------+------+
*  E8 |         TKTSYSID          |  TKTUSPID   |:SPCLS|//////|
*     +---------------------------+-------------+------+------+
*  F0 |                        TKTFN                          |
*     +-------------------------------------------------------+
*  F8 |                        TKTFT                          |
*     +-------------------------------------------------------+
* 100 |                       TKTDIST                         |
*     +-------------------------------------------------------+
* 108 |                       TKTDEST                         |
*     +-------------------------------------------------------+
* 110 |                       TKTUFORM                        |
*     +-------------------------------------------------------+
* 118 |                       TKTOFORM                        |
*     +-------------------------------------------------------+
* 120 |                       TKTSCLAB                        |
*     +-------------------------------------------------------+
* 128 |                       TKTXFEE                         |
*     +------+--------------------+---------------------------+
* 130 |:COPY |////////////////////|         TKTDPCNT          |
*     +------+--------------------+-------------+-------------+
* 138 |         TKTXABLN          |  TKTCCWMX   |  TKTFCBLN   |
*     +---------------------------+-------------+-------------+
* 140 |         TKTRCNT           |  TKTLRECL   |/////////////|
*     +---------------------------+-------------+-------------+
* 148 |                       TKTCLKOP                        |
*     +---------------------------+------+------+------+------+
* 150 |         TKTCLKCL          |:STAT |:TYPE |:QUEUE|:SYSTY|
*     +------+------+------+------+------+------+------+------+
* 158 |:DVTYP|:PSFF |:SHPST|:SHTDN|:PRTFL|:STCPY|:PGCPY|:MODNO|
*     +------+------+------+------+------+------+------+------+
* 160 |:FLSCT|:PGLEN|/////////////|                           |
*     +------+------+-------------+                           |
*     |                       TKTCHARS                        |
*     |                           +---------------------------+
* 170 |                           |          TKTFCB           |
*     +---------------------------+---------------------------+
* 178 |          TKTMOD           |         TKTCMOD           |
*     +---------------------------+---------------------------+
* 180 |         TKTFLASH          |///////////////////////////|
*     +---------------------------+///////////////////////////|
* 188 |///////////////////////////////////////////////////////|
*     =///////////////////////////////////////////////////////=
*     |///////////////////////////+---------------------------+
*     |///////////////////////////| 1A4
*     +---------------------------+
*
*** Overlay for TKTDESC in TKTBK
TKTBK Cross Reference
Symbol Dspl Value -------------- ---- ----- TKTBAD 0009 20 TKTBDBCT 007C TKTBKLK 0020 TKTBLKNO 00C0 TKTCCWMX 013C TKTCHARS 0164 TKTCLKCL 0150 TKTCLKOP 0148 TKTCMOD 017C TKTCMSSQ 0058 TKTCMXAB 005C TKTCOMPL 000A 80 TKTCOPY 0130 TKTCURMI 0068 TKTCURMP 0064 TKTCURPG 006C TKTCURPT 0070 TKTDASWT 0080 TKTDESC 00B0 TKTDESCL 0184 000000F4 TKTDEST 0108 TKTDIST 0100 TKTDPCNT 0134 TKTDUPF 000A 10 TKTDVTYP 0158 TKTEFLG 0009 TKTEOF 0008 08 TKTEOSEG 0008 01 TKTERRCV 000A 20 TKTFCB 0174 TKTFCBLN 013E TKTFLAG 0008 TKTFLAG1 000A TKTFLASH 0180 TKTFLSCT 0160 TKTFN 00F0 TKTFT 00F8 TKTIDTS 00B0 TKTLENDW 0184 00000035 TKTLKTRA 0038 TKTLRECL 0144 TKTMAPCT 00B8 TKTMOD 0178 TKTMODNO 015F TKTMSEG 0008 40 TKTNASSQ 0054 TKTNEWUS 000B 20 TKTNEXT 0000 TKTNOLOD 000A 08 TKTNOSEL 0008 80 TKTOFORM 0118 TKTORIG 00E0 TKTOWNER 00D8 TKTPAGER 0009 80 TKTPAGNO 00BC TKTPGCNT 0074 TKTPGCPY 015E TKTPGLEN 0161 TKTPONCL 000B 40 TKTPRTFL 015C TKTPSFF 0159 TKTPSSSQ 0084 00000064 TKTPUTSH 000B 10 TKTQLIM 0054 00000004 TKTQUEUE 0156 TKTRCNT 0140 TKTREADY 0008 04 TKTRELPG 003C TKTRESOR 000B TKTRSPT 00A8 TKTSCLAB 0120 TKTSDFLK 000B 80 TKTSDFLX 0004 TKTSEGDU 001C TKTSEGLO 0018 TKTSETUP 0008 40 TKTSHPST 015A TKTSHTDN 015B TKTSKIPX 0009 40 TKTSPCLS 00EE TKTSPFBK 0078 TKTSPLOV 0048 TKTSPLPG 0044 TKTSPMOF 004C TKTSRCND 00C8 TKTSRCUS 00D0 TKTSSQ 0050 TKTSTAT 0154 TKTSTCPY 015D TKTSYSID 00E8 TKTSYSTY 0157 TKTTAKEN 0008 20 TKTTAPWT 000C TKTTYPE 0155 TKTUFORM 0110 TKTUOSPD 00AC TKTUSPID 00EC TKTWKRCT 0010 TKTWKRMX 0014 TKTWTCNT 0084 TKTXABLN 0138 TKTXABS 0088 TKTXABWR 000A 40 TKTXFEE 0128 TKTXLEN 0088 00000020 TKT1STMP 0060 TKT1STRP 0040
Copyright IBM Corporation, 1990, 2002