LANBK - 32-bit CP - V4R4.0

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

#### LANBK

Prolog

Control Block Contents
LANBK DSECT
LANRDD DSECT

Storage Layout

Cross Reference (Contains links to field and bit definitions)

#### LANBK Prolog

     NAME       : HCPLANBK
     DESCRIPTION: Virtual LAN block
     DSECT      : LANBK
     FUNCTION   :
                  Define a structure to represent a Virtual LAN
                  (Local Area Network) in CP.
     LOCATED BY -
       SLMLANTB - The System LAN Table
     CREATED BY :
                  CP DEFINE LAN command
     DELETED BY :
                  CP DETACH LAN processing
     REFERENCES :
                  HCPEQUAT COPY - General CP equates

#### LANBK Control Block Content

#### LANBK DSECT

####

####

####

    Hex   Dec Type/Val   Lng Label (dup)    Comments
    ---- ---- --------- ---- -------------- --------
    0000    0 Structure      LANBK          Virtual LAN block
          Static Area -
            The fields in this area are relatively static.
            They are set when the LANBK is constructed.
    0000    0 Character   16 LANID (0)      LAN Fully-Qualified Identifier
    0000    0 Character    8 LANOWNER       LAN Owner (user who defined it)
    0008    8 Character    8 LANNAME        LAN Name
    0010   16 Character    8 LANDESC        LAN Description
    0018   24 Character    8 LANDEFBY       LAN Defined By <userid>
    0020   32 Signed       4 LANDFTOD       CPU TOD (high-order word) when
                                            this LAN was defined
    0024   36 Bitstring    1 LANTYPE        LAN Type
              00000001       LANHIPR        1 - HiperSockets LAN
              00000002       LANQDIO        2 - QDIO LAN
    0025   37 Bitstring    1 LANPROTO       LAN Protocol
              00000001       LANENET        X'01' - Ethernet / Fast Ethernet
              00000002       LANTRNET       X'02' - High Speed Token Ring
              00000003       LANGBE         X'03' - Gigabit Ethernet
              00000010       LAN10GE        X'10' - 10 Gig Ethernet
              00000080       LANQDIOP       X'80' - QDIO Protocol
              00000081       LANATME        X'81' - ATM Emulated Enet Port
              00000082       LANATMTR       X'82' - ATM Emulated Token Ring
                                            Port
              00000083       LANATMGE       X'83' - ATM Emulated GbEnet + MTU
                                            size
              00000088       LANATMP        X'88' - ATM Emulated Port +
                                            autoconfig
              00000090       LANATM         X'90' - Native ATM
    0026   38 Bitstring    1 LANLEVEL       LAN Level
              00000001       LANGLAN        1 - Level 1 - Guest Lan
              00000002       LANVSW         2 - Level 2 - Vswitch
    0027   39 Bitstring    1 *              Reserved
          LAN Lock -
          Note that certain fields are additionally serialized by
          LANCTLCK. See below for more information.
          Notes      : LKWRDSIZ == 3 doublewords.
    0028   40 Dbl-Word     8 LANLKWRD (3)   LAN Lockword
          LAN Management Area -
    0040   64 Bitstring    1 LANCFLG        LAN Configuration Flags
              1... ....      LANINPRG       X'80' - Initialization in
                                            Progress
              .1.. ....      LANDLPRG       X'40' - Delete in Progress
              ..1. ....      LANLIMCN       X'20' - Limit connections by
                                            LANMAXCN
              ...1 ....      LANLIMID       X'10' - Limit connections by
                                            userid
              .... 1...      LANSYSLN       X'08' - Registered System LAN
              .... .1..      LANUSRLN       X'04' - Private LAN
              .... ..1.      LANTRANS       X'02' - Transient LAN
              .... ...1      LANACNT        X'01' - Accounting Enabled
    0041   65 Bitstring    1 LANCFLG2       More LAN Configuration Flags
              1... ....      LANRDV         X'80' - RDEV was specified for
                                            VSWITCH
              .1.. ....      LANDLDIP       X'40' - LANBK on Delete In
                                            Progress Chain
              ..1. ....      LANPRTRQ       X'20' - PRIROUTER was specified
                                            for VSWITCH
    0042   66 Signed       2 LANIPTO        IP Timeout value (in 30 sec tics)
    0044   68 Signed       4 LANRFCTR       LAN Reference Counter
    0048   72 Address      4 LANFPNT        Pointer to next LANBK
    004C   76 Address      4 LANBPNT        Pointer to previous LANBK
    0050   80 Address      4 LANACLHD       Pointer to first ACLBK
    0054   84 Address      4 LANACLTL       Pointer to last ACLBK
    0058   88 Signed       4 LANMFS         Maximum Frame Size in bytes
    005C   92 Signed       4 LANMAXCN       Maximum number of connections
    0060   96 Address      4 LANCNLST       Pointer to Connected NICBK List
    0064  100 Signed       4 LANCNCTR       LAN Connection Counter
    0068  104 Character    8 LANUPDBY       LAN Updated By <userid>
    0070  112 Character    8 LANPORT        Portname
    0078  120 Character    8 LANCONT        Controller
    0080  128 Address      4 LANVQSBK       Pointer to VQSBK for VSWITCH
    0084  132 Signed       2 LANRDEV        Rdev
    0086  134 Bitstring    1 LANFSV         Queuestorage value (1-8)
    0087  135 Bitstring    1 *              Reserved
          LANIPTBL - LAN IP Table
            LANIPTBL is a pointer to a HASH Table that uses the
            IP Address as the key.  Each IPNBK in the hash table
            represents an IP Address pointing to a network device
            (NIDBK).
    0088  136 Address      4 LANIPTBL       Pointer to LAN IP Table
    008C  140 Signed       2 LANIPCTR       Number of entries in LANIPTBL
    008E  142 Bitstring    2 *              Reserved
          LANBCLST - LAN Broadcast List
            Each IPNBK in the Broadcast List represents a device
            (NIDBK) which is enabled for inbound broadcast.
    0090  144 Address      4 LANBCLST       Pointer to Broadcast IPNBK list
    0094  148 Signed       2 LANBCCTR       Number of Broadcast entries
    0096  150 Bitstring    2 *              Reserved
          LANMRLST - Multicast Router List
            Each IPNBK in the Multicast Router List represents a
            device (NIDBK) which is set as a Multicast Router.
    0098  152 Address      4 LANMRLST       Pointer to MC Router IPNBK list
    009C  156 Signed       2 LANMRCTR       Number of MC Router entries
    009E  158 Bitstring    2 *              Reserved
          LANRXLST - Unicast Router List
            Each IPNBK in the Unicast Router List represents a
            device (NIDBK) which is the active unicast router
            for an adapter coupled to this LAN.
    00A0  160 Address      4 LANRXLST       Pointer to UC Router IPNBK list
    00A4  164 Signed       2 LANRXCTR       Number of UC Router entries
    00A6  166 Bitstring    2 *              Reserved
          LANDXLST - LAN Device Connection List
            Each IPNBK in the LAN Device Connection List represents
            a device (NIDBK) which is active on this LAN (that is,
            a STRTLAN primitive has been issued by the driver for
            this device).
    00A8  168 Address      4 LANDXLST       Pointer to LAN Device IPNBK list
    00AC  172 Signed       2 LANDXCTR       Number of LANDXLST entries
    00AE  174 Bitstring    2 *              Reserved
          LANPXLST - LAN Observer (Promiscuous) List
            Each IPNBK in the Observer List represents a device
            (NIDBK) which is operating in promiscuous mode.
    00B0  176 Address      4 LANPXLST       Pointer to Observer IPNBK list
    00B4  180 Signed       2 LANPXCTR       Observer count
    00B6  182 Bitstring    2 *              Reserved
          LANDFNIC/LANDFNIC - Default Router to External Network.
            These fields are only used for a VSWITCH LAN.  When
            the External Link is active, they point to the device
            that represents the data connection.
    00B8  184 Address      4 LANDFNIC       Pointer to Default Router NICBK
    00BC  188 Address      4 LANDFNID       Pointer to Default Router NIDBK
          Queue of Pending IP Functions (VSWITCH ONLY).
    00C0  192 Address      4 LANPIFHD       Head of Pending IP Functions
    00C4  196 Address      4 LANPIFTL       Tail of Pending IP Functions
          Chain of pending IP address entries (VSWITCH ONLY).
            This is the anchor for pending IP Address entries.
            Each entry is an IPNBK representing an IP Address
            that was referenced as the target of a datagram.
            Entries are added via CS logic while LANLKWRD is
            held SHARED, and removed while LANLKWRD is held
            in EXCLUSIVE mode.
    00C8  200 Address      4 LANIPPND       Pointer to pending IP entries
    00CC  204 Signed       4 LANIPPID       ICMP Identifier for IPPND
         ******** Start of Virtual Switch Controller Section
          The Virtual Switch Controller section of this structure is
          serialized by a combination of LANLKWRD and LANCTLCK.
          To reference these fields, the LANLKWRD must be held at
          least SHARED.
          To modify these fields, either:
            1) Obtain the LANLKWRD EXCLUSIVE, or
            2) Obtain the LANLKWRD SHARED and the LANCTLCK EXCLUSIVE.
          The second choice allows access to the controller-
          related fields without interference with data transfer
          among the guest hosts coupled to the virtual switch.
    00D0  208 Dbl-Word     8 LANCTLCK (3)   LAN CONTROLLER lock word
    00E8  232 Address      4 LANCTPTR       Pointer to controller entry
    00EC  236 Signed       2 LANVDEV        Vdev assigned by controller
    00EE  238 Signed       2 LANMXMTU       MaxMTU reported by H/W
    00F0  240 Bitstring    1 LANCTSTA       VSwitch Controller State
              .... ...1      LANCTDEF       X'01' - Virtual switch defined
              .... ..1.      LANCTNOC       X'02' - Controller not available
              .... ..11      LANCTOPR       X'03' - Operator intervention
                                            required
              .... .1..      LANCTDIS       X'04' - Disconnected
              .... .1.1      LANCTATT       X'05' - VDEVs attached to
                                            controller
              .... .11.      LANCTINI       X'06' - OSA initialization in
                                            progress
              .... .111      LANCTNOT       X'07' - OSA device not ready
              .... 1...      LANCTRDY       X'08' - OSA device ready
              .... 1..1      LANCTDET       X'09' - OSA devices being
                                            detached
              .... 1.1.      LANCTDEL       X'0A' - VSWITCH delete pending
    00F1  241 Bitstring    1 LANCTFLG       VSwitch Controller Flag
              1... ....      LANXIPV6       X'80' - VSWITCH RDEV supports
                                            IPv6
              .1.. ....      LANPRTAC       X'40' - PRIROUTER is active on
                                            VSWITCH
    00F2  242 Bitstring    6 LANDVMAC       VSwitch RDEV MAC address
    00F8  248 Address      4 *
    00FC  252 Signed       4 * (0)
    00FC  252 Bitstring   36 LANRRDEV       Array of LANRDD elements
         ********  End of Virtual Switch Controller Section
          End of the LANBK.
              00000120       LAN$END        * End of the LANBK
              00000120       LANBKLN        *-LANBK Length of LANBK in bytes
              00000024       LANBKSZ        (*-LANBK+7)/8 Size of LANBK in
                                            doublewords
          Define the LANRDD structure.
            This structure maps each element of the LANRRDEV array.
            LANRDD_LAST=1 for the last valid element in this array.

    LANRDD DSECT

    Hex   Dec Type/Val   Lng Label (dup)    Comments
    ---- ---- --------- ---- -------------- --------
    0000    0 Structure      LANRDD         Virtual LAN block
    0000    0 Signed       2 LANRDD_RDEV    Real device address
    0002    2 Bitstring    1 LANRDD_FLAG    Device status flags:
              1... ....      LANRDD_LAST    X'80' - Last active descriptor
              .1.. ....      LANRDD_INOP    X'40' - Inoperative device
              ..1. ....      LANRDD_VDEV    X'20' - VDEV not available at
                                            chosen controller
              ...1 ....      LANRDD_PRT     X'10' - Port name specified
    0003    3 Bitstring    1 *              Reserved
    0004    4 Character    8 LANRDD_PORT    Port name for this device
              0000000C       LANRDDLN       *-LANRDD Length of each LANRDD in
                                            bytes

    LANBK Storage Layout

    *** LANBK - Virtual LAN block
    *
    *     +-------------------------------------------------------+
    *   0 |                       LANOWNER                        |
    *     +-------------------------------------------------------+
    *   8 |                       LANNAME                         |
    *     +-------------------------------------------------------+
    *  10 |                       LANDESC                         |
    *     +-------------------------------------------------------+
    *  18 |                       LANDEFBY                        |
    *     +---------------------------+------+------+------+------+
    *  20 |         LANDFTOD          |:TYPE |:PROTO|:LEVEL|//////|
    *     +---------------------------+------+------+------+------+
    *  28 |                                                       |
    *     =                       LANLKWRD                        =
    *     |                                                       |
    *     +------+------+-------------+---------------------------+
    *  40 |:CFLG |:CFLG2|  LANIPTO    |         LANRFCTR          |
    *     +------+------+-------------+---------------------------+
    *  48 |         LANFPNT           |         LANBPNT           |
    *     +---------------------------+---------------------------+
    *  50 |         LANACLHD          |         LANACLTL          |
    *     +---------------------------+---------------------------+
    *  58 |          LANMFS           |         LANMAXCN          |
    *     +---------------------------+---------------------------+
    *  60 |         LANCNLST          |         LANCNCTR          |
    *     +---------------------------+---------------------------+
    *  68 |                       LANUPDBY                        |
    *     +-------------------------------------------------------+
    *  70 |                       LANPORT                         |
    *     +-------------------------------------------------------+
    *  78 |                       LANCONT                         |
    *     +---------------------------+-------------+------+------+
    *  80 |         LANVQSBK          |  LANRDEV    |LANFSV|//////|
    *     +---------------------------+-------------+------+------+
    *  88 |         LANIPTBL          |  LANIPCTR   |/////////////|
    *     +---------------------------+-------------+-------------+
    *  90 |         LANBCLST          |  LANBCCTR   |/////////////|
    *     +---------------------------+-------------+-------------+
    *  98 |         LANMRLST          |  LANMRCTR   |/////////////|
    *     +---------------------------+-------------+-------------+
    *  A0 |         LANRXLST          |  LANRXCTR   |/////////////|
    *     +---------------------------+-------------+-------------+
    *  A8 |         LANDXLST          |  LANDXCTR   |/////////////|
    *     +---------------------------+-------------+-------------+
    *  B0 |         LANPXLST          |  LANPXCTR   |/////////////|
    *     +---------------------------+-------------+-------------+
    *  B8 |         LANDFNIC          |         LANDFNID          |
    *     +---------------------------+---------------------------+
    *  C0 |         LANPIFHD          |         LANPIFTL          |
    *     +---------------------------+---------------------------+
    *  C8 |         LANIPPND          |         LANIPPID          |
    *     +---------------------------+---------------------------+
    *  D0 |                                                       |
    *     =                       LANCTLCK                        =
    *     |                                                       |
    *     +---------------------------+-------------+-------------+
    *  E8 |         LANCTPTR          |  LANVDEV    |  LANMXMTU   |
    *     +------+------+-------------+-------------+-------------+
    *  F0 |:CTSTA|:CTFLG|                LANDVMAC                 |
    *     +------+------+-------------+---------------------------+
    *  F8 |///////////////////////////|                           |
    *     +---------------------------+                           |
    * 100 |                                                       |
    *     =                       LANRRDEV                        =
    *     |                                                       |
    *     +-------------------------------------------------------+
    * 120
    *
    *** LANBK - Virtual LAN block

    *** LANRDD - Virtual LAN block
    *
    *     +-------------+------+------+---------------------------+
    *   0 |LANRDD_RDEV  |(002) |//////|       LANRDD_PORT-        |
    *     +-------------+------+------+---------------------------+
    *   8 |          -(004)           | C
    *     +---------------------------+
    *
    *** LANRDD - Virtual LAN block

    LANBK Cross Reference

    Symbol         Dspl Value
    -------------- ---- -----
    LAN$END        00FC 00000120
    LANACLHD       0050
    LANACLTL       0054
    LANACNT        0040 01
    LANATM         0025 00000090
    LANATME        0025 00000081
    LANATMGE       0025 00000083
    LANATMP        0025 00000088
    LANATMTR       0025 00000082
    LANBCCTR       0094
    LANBCLST       0090
    LANBKLN        00FC 00000120
    LANBKSZ        00FC 00000024
    LANBPNT        004C
    LANCFLG        0040
    LANCFLG2       0041
    LANCNCTR       0064
    LANCNLST       0060
    LANCONT        0078
    LANCTATT       00F0 05
    LANCTDEF       00F0 01
    LANCTDEL       00F0 0A
    LANCTDET       00F0 09
    LANCTDIS       00F0 04
    LANCTFLG       00F1
    LANCTINI       00F0 06
    LANCTLCK       00D0
    LANCTNOC       00F0 02
    LANCTNOT       00F0 07
    LANCTOPR       00F0 03
    LANCTPTR       00E8
    LANCTRDY       00F0 08
    LANCTSTA       00F0
    LANDEFBY       0018
    LANDESC        0010
    LANDFNIC       00B8
    LANDFNID       00BC
    LANDFTOD       0020
    LANDLDIP       0041 40
    LANDLPRG       0040 40
    LANDVMAC       00F2
    LANDXCTR       00AC
    LANDXLST       00A8
    LANENET        0025 00000001
    LANFPNT        0048
    LANFSV         0086
    LANGBE         0025 00000003
    LANGLAN        0026 00000001
    LANHIPR        0024 00000001
    LANID          0000
    LANINPRG       0040 80
    LANIPCTR       008C
    LANIPPID       00CC
    LANIPPND       00C8
    LANIPTBL       0088
    LANIPTO        0042
    LANLEVEL       0026
    LANLIMCN       0040 20
    LANLIMID       0040 10
    LANLKWRD       0028
    LANMAXCN       005C
    LANMFS         0058
    LANMRCTR       009C
    LANMRLST       0098
    LANMXMTU       00EE
    LANNAME        0008
    LANOWNER       0000
    LANPIFHD       00C0
    LANPIFTL       00C4
    LANPORT        0070
    LANPROTO       0025
    LANPRTAC       00F1 40
    LANPRTRQ       0041 20
    LANPXCTR       00B4
    LANPXLST       00B0
    LANQDIO        0024 00000002
    LANQDIOP       0025 00000080
    LANRDD_FLAG    0002
    LANRDD_INOP    0002 40
    LANRDD_LAST    0002 80
    LANRDD_PORT    0004
    LANRDD_PRT     0002 10
    LANRDD_RDEV    0000
    LANRDD_VDEV    0002 20
    LANRDDLN       0004 0000000C
    LANRDEV        0084
    LANRDV         0041 80
    LANRFCTR       0044
    LANRRDEV       00FC
    LANRXCTR       00A4
    LANRXLST       00A0
    LANSYSLN       0040 08
    LANTRANS       0040 02
    LANTRNET       0025 00000002
    LANTYPE        0024
    LANUPDBY       0068
    LANUSRLN       0040 04
    LANVDEV        00EC
    LANVQSBK       0080
    LANVSW         0026 00000002
    LANXIPV6       00F1 80
    LAN10GE        0025 00000010

    This information is
    based on z/VM V4R4.0.
    Last updated on 11 Mar 2004 at 08:22:58 EDT.

    Copyright IBM Corporation, 1990, 2003