Programming Interface Information: This page documents intended Programming Interfaces that allow the customer to write programs to obtain the services of z/VM.

#### SFBLOK

Prolog

Control Block Contents
SFBLOK DSECT

Storage Layout

Cross Reference (Contains links to field and bit definitions)

#### SFBLOK Prolog

     NAME       : SFBLOK
     DESCRIPTION: VM/SP 370 SPOOL FILE CONTROL BLOCK
     DSECT      : SFBLOK
     FUNCTION   : THIS DSECT IS USED TO WHEN SPOOL FILES ARE TO BE
                  TRANSLATED TO VM/SP FORMAT.  (IT IS ANALOGOUS TO
                  THE VM/XA SPFBK.)
     CREATED BY : HCPSXSFB FOR SPFBK TO SFBLOK TRANSLATIONS.  THIS IS
                  DONE FOR DIAGNOSE X'14' AND SPTAPE COMMANDS.
     DELETED BY : NOT APPLICABLE

#### SFBLOK Control Block Content

#### SFBLOK DSECT

    Hex   Dec Type/Val   Lng Label (dup)    Comments
    ---- ---- --------- ---- -------------- --------
    0000    0 Structure      SFBLOK         VM/SP 370 SPOOL FILE CONTROL
                                            BLOCK
    0000    0 Signed       4 SFBPNT         POINTER TO NEXT SFBLOK
    0004    4 Signed       4 SFBSTART       DASD LOC. OF FIRST PAGE BUFFER
    0008    8 Character    8 SFBUSER        VMUSER IDENTIFICATION OF FILE
                                            OWNER
    0010   16 Character    8 SFBORIG        VMUSER IDENTIFICATION OF FILE
                                            ORIGIN
    0018   24 Signed       4 SFBRECNO       NUMBER OF DATA RECORDS IN FILE
    001C   28 Signed       2 SFBRECSZ       LOGICAL RECORD SIZE - EXCLD. CCWS
    001E   30 Signed       2 SFBFILID       BINARY SYSTEM FILE NUMBER
    0020   32 Bitstring    1 SFBFLAG        S*1 SFBLOK CONTROL FLAGS
              1... ....      SFBINUSE       X'80' FILE BEING PROCESSED
              .1.. ....      SFBRECOK       X'40' ALLOCATION RECORDS COMPLETE
              ..1. ....      SFBUHOLD       X'20' FILE IN USER HOLD STATUS
              ...1 ....      SFBDUMP        X'10' FILE IS A CP SYSTEM DUMP
              .... 1...      SFBOPEN        X'08' INPUT FILE HAS BEEN OPENED
              .... .1..      SFBSHOLD       X'04' FILE IN SYSTEM HOLD STATUS
              .... ..1.      SFBEOF         X'02' INPUT FILE HAS REACHED EOF
              .... ...1      SFBRECER       X'01' SFBREC CHAIN INCOMPLETE
    0021   33 Bitstring    1 SFBTYPE        DEVICE TYPE FOR SPOOL OUTPUT
    0022   34 Signed       2 SFBMISC1       USE VARIES ACCORDING TO CALLER
    0024   36 Signed       4 SFBRECS        POINTER TO RECBLOKS FOR ACTIVE
                                            FILE
    0028   40 Character   12 SFBFNAME       FILE NAME
    0034   52 Character   12 SFBFTYPE       FILE TYPE
    0040   64 Character    8 SFBDATE        CREATION DATE OF SPOOL FILE
    0048   72 Character    8 SFBTIME        CREATION TIME OF SPOOL FILE
    0050   80 Signed       4 SFBLAST        DASD LOC. (DCHR) OF LAST PAGE
                                            BUFFER
    0054   84 Signed       2 SFBCOPY        NUMBER OF COPIES REQUESTED
    0056   86 Bitstring    1 SFBCLAS        SPOOL FILE CLASS CHARACTER
    0057   87 Bitstring    1 SFBFLAG2       SFBLOK CONTROL FLAGS - BYTE 2
              1... ....      SFBHOLD        X'80' SAVE INPUT FILE; HOLD
                                            OUTPUT FILE
              .1.. ....      SFBNOHLD       X'40' DELETE INPUT FILE; NOHOLD
                                            OUTPUT
              ..1. ....      SFBFLNMT       X'20' FILE NOT EMPTY IF ON
              ...1 ....      SFBRSTRT       X'10' RESTART IN PROGRESS
              .... 1...      SFBTICER       X'08' BUFFER TIC ERROR
              .... .1..      SFBPURGE       X'04' PURGE OPEN SPOOL FILE
              .... ..1.      SFBFIRST       X'02' INDICATE FIRST PAGE WRITTEN
              .... ...1      SFBMON         X'01' MONITOR CLASS FILE
    0058   88 Character    8 SFBDIST        DISTRIBUTION CODE
    0060   96 Character    4 SFBFLASH       OVERLAY NAME FOR 3800 FLASHING
    0064  100 Bitstring    1 SFBSTCPY       CURRENT STARTING COPY NUMBER
    0065  101 Bitstring    1 SFBFLAG3       SFBLOK CONTROL FLAGS - BYTE 3
              1... ....      SFBLDBEG       X'80' 3800 LOAD CCWS AT BEGINNING
              .1.. ....      SFBLDMID       X'40' 3800 LOAD CCWS ALL THRU
                                            FILE
              ..1. ....      SFBFCB         X'20' INDICATE FCB CCWS NOW IN
                                            FILE
              .... .1..      SFBACNT        X'04' ACCOUNTING TYPE FILE
              .... ..1.      SFBSEEN        X'02' 'FILE PREVIOUSLY SEEN' FLAG
              .... ...1      SFBXFER        X'01' 'FILE TRANSFERRED' FLAG
    0066  102 Bitstring    1 SFBCKPMP       CHECKPOINT MAP NUMBER FOR SLOT
    0067  103 Bitstring    1 SFBFLAG4       MORE STATUS FLAGS - BYTE 4
              1... ....      SFBINVS        X'80' SFBLOK IS IN SYSSPOOL's
                                            VIRTUAL STORAGE
              .1.. ....      SFBTUSE        X'40' FILE IN TEMPORARY USE BY
                                            SYSTEM
              ..1. ....      SFBNORET       X'20' NORETURN FLAG
              ...1 ....      SFBVLEN        X'10' Original record length
                                            available
              .... 1...      SFBPURGD       X'08' File is 'to be purged'
              .... .1..      SFBCONV        X'04' File has been converted
              .... ..1.      SFBBCONV       X'02' File being converted
              .... ...1      SFBXABER       X'01' AN XAB DISK RECORD IS
                                            INCORRECT SFBFLASH CONTAINS THE
                                            DISK ADDRESS OF THE INCORRECT
                                            RECORD.
              0000000D       SFBDSIZE       (*-SFBLOK)/8 DEFAULT SIZE, NON
                                            EXTENDED
    0068  104 Dbl-Word     8 SFBUFORM       USER SPECIFIED FORM NUMBER
    0070  112 Dbl-Word     8 SFBOFORM       OPERATOR SPECIFIED FORM NUMBER
              0000000F       SFBR2SIZ       (*-SFBLOK)/8 VM/SP RELEASE 2 SIZE
                                            IN DBL WDS
    0078  120 Signed       2 SFBFCBNL       LONGEST IMBEDDED FCB (3211-TYPE)
    007A  122 Signed       2 SFBFCBXL       LONGEST IMBEDDED FCB (EXTENDED)
         The following 4 bytes are reserved for SPTAPE to save spool file
         information that is not available on the VM/370 systems such as VM/ESA
         Release 1.5. This data is also saved here when Diagnose x'14' and *SPL
         return an SFBLOK to the user. In particular, the bits that are useful
         to Diag x'14' and *SPL are the ones which indicate the KEEP/NOKEEP
         status (SFBXKEEP) and the MSG/NOMSG status (SFBXMSG) of the file.
    007C  124 Bitstring    1 SFBXSPT (4)    RESERVED FOR VM/XA SPTAPE USE
    0080  128 Dbl-Word     8 SFBDEST        USER SPECIFIED DESTINATION
    0088  136 Signed       4 SFBXAB         DASD ADDRESS OF XAB (CCPD/PPPD)
                                            EXTENDED ATTRIBUTE BUFFER
    008C  140 Signed       2 SFBXABL        LENGTH OF XAB EXTENDED ATTRIBUTE
                                            BUFFER
    008E  142 Bitstring    1 SFBFLG4A       SFBLOK FLAG
              1... ....      SFBREAD        X'80' INPUT SPOOL FILE HAS BEEN
                                            READ
              .1.. ....      SFBPCHEK       X'40' ALREADY CHECKED FOR PURGE
              ..1. ....      SFBORIGN       X'20' DIAGNOSE X'F8' ORIGINATING
                                            NODE AND USERID ARE STORED IN THE
                                            FIRST SPLINK
              ...1 ....      SFBVAFP        X'10' File created on VAFP type
                                            printer
    008F  143 Bitstring    1 SFBCENT        Hexadecimal representation of the
                                            century portion of the year in
                                            SFBDATE
    0090  144 Signed       4 SFBSYSID       SYSTEM UNIQUE FILE-ID
    0094  148 Bitstring    1 SFBFLAG5       FLAG
              1... ....      SFBCDMP        X'80' INDICATE CURRENT DUMP
                                            SFBLOK
              .1.. ....      SFBCONTO       X'40' CONSOLE SPOOLED TO ANOTHER
                                            VM
              ..1. ....      SFBRSVBT       X'20' RESERVED FOR IBM USE
              ...1 ....      SFBOPFRE       X'10' COPY OF AN OPEN READER FILE
    0095  149 Address      3 SFBOPCPY       ADDRESS OF SFBLOK IN FREE STORAGE
                                            FOR OPEN READER FILES
    0098  152 Character    1 SFBSHSPS (0)   START OF ISF CHANGES
              00000018       SFBSZ5         (*-SFBDEST) SIZE IN BYTES OF HPO5
                                            UNIQUE DATA
    0098  152 Bitstring    1 SFBSYQIX       SYSTEM INDEX OWNING THE LOCK
    0099  153 Bitstring    1 SFBORGIX       SYSTEM INDEX OWNING TEMP SPACE
    009A  154 Signed       2 SFBORGID       SPOOL FILE ID ON THE OWNING
                                            SYSTEM
    009C  156 Bitstring    1 SFBSHPST       SHARED SPOOL FILE STATUS
    009D  157 Bitstring    1 SFBSHPFL       SHARED SPOOL FILE FLAGS
    009E  158 Bitstring    1 SFBSHPCK       COPY SFBLOK CHECKPOINT STATUS
    009F  159 Bitstring    1 SFBBITS        BROADCAST BITS - BIT MAP OF
                                            SYSTEMS WITH COPIES OF THIS
                                            ORIGINAL SFBLOK
    00A0  160 Character    1 SFBSHSPN (0)   END OF ISF ENTRIES
    00A0  160 Character    8 SFBXFEE        VM userid of file's previous
                                            owner
    00A8  168 Dbl-Word     8 * (2)          RESERVED FOR FUTURE USE
    00B8  184 Character    8 SFBSCLAB       SPOOL FILE SECLABEL
              00000018       SFBSIZE        (*-SFBLOK)/8 SIZE IN DOUBLE WORDS
              00000018       SFBFNFT        L'SFBFNAME+L'SFBFTYPE
    007C  124 Bitstring    1 SFBXQUE        SPFQUEUE saved here for SPTAPE
    007D  125 Bitstring    1 SFBXSYTY       SPFSYSTY saved here for SPTAPE
    007E  126 Bitstring    1 SFBXSTAT       SPFSTAT saved here for SPTAPE
              1... ....      SFBXINUS       X'80' SPFINUSE (always turned off
                                            because SPTAPE LOAD restores the
                                            entire bit and should never load
                                            a file with the in use flag on)
                                            The in-use status of the file is
                                            recorded in SFBFLAG.SFBINUSE
                                            flag.
              .... 1...      SFBXKEEP       X'08' SPFKEEP
              .... .1..      SFBXMSG        X'04' SPFMSG
    007F  127 Bitstring    1 SFBXTYPE       SPFTYPE saved here for SPTAPE

#### SFBLOK Storage Layout

    *** SFBLOK - VM/SP 370 SPOOL FILE CONTROL BLOCK
    *
    *     +---------------------------+---------------------------+
    *   0 |          SFBPNT           |         SFBSTART          |
    *     +---------------------------+---------------------------+
    *   8 |                       SFBUSER                         |
    *     +-------------------------------------------------------+
    *  10 |                       SFBORIG                         |
    *     +---------------------------+-------------+-------------+
    *  18 |         SFBRECNO          |  SFBRECSZ   |  SFBFILID   |
    *     +------+------+-------------+-------------+-------------+
    *  20 |:FLAG |:TYPE |  SFBMISC1   |         SFBRECS           |
    *     +------+------+-------------+---------------------------+
    *  28 |                       SFBFNAME                        |
    *     |                           +---------------------------+
    *  30 |                           |         SFBFTYPE          |
    *     +---------------------------+                           |
    *     |                                                       |
    *     +-------------------------------------------------------+
    *  40 |                       SFBDATE                         |
    *     +-------------------------------------------------------+
    *  48 |                       SFBTIME                         |
    *     +---------------------------+-------------+------+------+
    *  50 |         SFBLAST           |  SFBCOPY    |:CLAS |:FLAG2|
    *     +---------------------------+-------------+------+------+
    *  58 |                       SFBDIST                         |
    *     +---------------------------+------+------+------+------+
    *  60 |         SFBFLASH          |:STCPY|:FLAG3|:CKPMP|:FLAG4|
    *     +---------------------------+------+------+------+------+
    *  68 |                       SFBUFORM                        |
    *     +-------------------------------------------------------+
    *  70 |                       SFBOFORM                        |
    *     +-------------+-------------+---------------------------+
    *  78 |  SFBFCBNL   |  SFBFCBXL   |         SFBXSPT           |
    *     +-------------+-------------+---------------------------+
    *  80 |                       SFBDEST                         |
    *     +---------------------------+-------------+------+------+
    *  88 |          SFBXAB           |  SFBXABL    |:FLG4A|:CENT |
    *     +---------------------------+------+------+------+------+
    *  90 |         SFBSYSID          |:FLAG5|     SFBOPCPY       |
    *     +------+------+-------------+------+------+------+------+
    *  98 |:SYQIX|:ORGIX|  SFBORGID   |:SHPST|:SHPFL|:SHPCK|:BITS |
    *     +------+------+-------------+------+------+------+------+
    *  A0 |                       SFBXFEE                         |
    *     +-------------------------------------------------------+
    *  A8 |///////////////////////////////////////////////////////|
    *     |///////////////////////////////////////////////////////|
    *     +-------------------------------------------------------+
    *  B8 |                       SFBSCLAB                        |
    *     +-------------------------------------------------------+
    *  C0
    *
    *** SFBLOK - VM/SP 370 SPOOL FILE CONTROL BLOCK

    *** Overlay for SFBXSPT in SFBLOK
    *
    *                                 +------+------+------+------+
    *  78 ...                      7C |:XQUE |:XSYTY|:XSTAT|:XTYPE|
    *                                 +------+------+------+------+
    *  80
    *
    *** Overlay for SFBXSPT in SFBLOK

#### SFBLOK Cross Reference

    Symbol         Dspl Value
    -------------- ---- -----
    SFBACNT        0065 04
    SFBBCONV       0067 02
    SFBBITS        009F
    SFBCDMP        0094 80
    SFBCENT        008F
    SFBCKPMP       0066
    SFBCLAS        0056
    SFBCONTO       0094 40
    SFBCONV        0067 04
    SFBCOPY        0054
    SFBDATE        0040
    SFBDEST        0080
    SFBDIST        0058
    SFBDSIZE       0067 0000000D
    SFBDUMP        0020 10
    SFBEOF         0020 02
    SFBFCB         0065 20
    SFBFCBNL       0078
    SFBFCBXL       007A
    SFBFILID       001E
    SFBFIRST       0057 02
    SFBFLAG        0020
    SFBFLAG2       0057
    SFBFLAG3       0065
    SFBFLAG4       0067
    SFBFLAG5       0094
    SFBFLASH       0060
    SFBFLG4A       008E
    SFBFLNMT       0057 20
    SFBFNAME       0028
    SFBFNFT        00B8 00000018
    SFBFTYPE       0034
    SFBHOLD        0057 80
    SFBINUSE       0020 80
    SFBINVS        0067 80
    SFBLAST        0050
    SFBLDBEG       0065 80
    SFBLDMID       0065 40
    SFBMISC1       0022
    SFBMON         0057 01
    SFBNOHLD       0057 40
    SFBNORET       0067 20
    SFBOFORM       0070
    SFBOPCPY       0095
    SFBOPEN        0020 08
    SFBOPFRE       0094 10
    SFBORGID       009A
    SFBORGIX       0099
    SFBORIG        0010
    SFBORIGN       008E 20
    SFBPCHEK       008E 40
    SFBPNT         0000
    SFBPURGD       0067 08
    SFBPURGE       0057 04
    SFBREAD        008E 80
    SFBRECER       0020 01
    SFBRECNO       0018
    SFBRECOK       0020 40
    SFBRECS        0024
    SFBRECSZ       001C
    SFBRSTRT       0057 10
    SFBRSVBT       0094 20
    SFBR2SIZ       0070 0000000F
    SFBSCLAB       00B8
    SFBSEEN        0065 02
    SFBSHOLD       0020 04
    SFBSHPCK       009E
    SFBSHPFL       009D
    SFBSHPST       009C
    SFBSHSPN       00A0
    SFBSHSPS       0098
    SFBSIZE        00B8 00000018
    SFBSTART       0004
    SFBSTCPY       0064
    SFBSYQIX       0098
    SFBSYSID       0090
    SFBSZ5         0098 00000018
    SFBTICER       0057 08
    SFBTIME        0048
    SFBTUSE        0067 40
    SFBTYPE        0021
    SFBUFORM       0068
    SFBUHOLD       0020 20
    SFBUSER        0008
    SFBVAFP        008E 10
    SFBVLEN        0067 10
    SFBXAB         0088
    SFBXABER       0067 01
    SFBXABL        008C
    SFBXFEE        00A0
    SFBXFER        0065 01
    SFBXINUS       007E 80
    SFBXKEEP       007E 08
    SFBXMSG        007E 04
    SFBXQUE        007C
    SFBXSPT        007C
    SFBXSTAT       007E
    SFBXSYTY       007D
    SFBXTYPE       007F

This information is based on z/VM V4R4.0. Last updated on 30 Jul 2003 at 13:32:21 EDT.
Copyright IBM Corporation, 1990, 2003