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

#### IPMBK

Prolog

Control Block Contents
IPMBK DSECT
IPMLM_ENTRY DSECT
IPMQC_ENTRY DSECT

Storage Layout

Cross Reference (Contains links to field and bit definitions)

#### IPMBK Prolog

     NAME       : HCPIPMBK
     DESCRIPTION: IP Multiple Entry structure
     DSECT      : IPMBK
     FUNCTION   :
                  The IPMBK defines a frame containing multiple entries.
                  Each entry (IPMENTRY) represents the information for
                  a single IP Multicast subscription.
     LOCATED BY -
       HCPIPNLM - Interface Registers
     CREATED BY :
                  HCPARPQC - Create IPMBK list to return ARP cache data
                  HCPARPLM - Create IPMBK list to return ARP targets
     DELETED BY :
                  HCPARPRL - Release storage used by IPMBK list
     USAGE NOTES  :
                  When Rx is a pointer to an IPMBK list -
                  The IPMBK is the first of a NULL-terminated chain.
                  Each IPMBK contains one or more IPMENTRY entries.
                  Each IPMENTRY describes an IP Address entry.
                  The structure of the output IPMBK chain is:
         Pointer to IPMBK
         ----------------
            |
            V
         +-------------+                 +-------------+
         | IPMBK(1)    |                 | IPMBK(n)    |
         |-------------|                 |-------------|
         | IPMFPNT------------/.../----->| IPMFPNT=0   |
         | IPMBPNT=0   |<-----/.../--------IPMBPNT     |
         |             |                 |             |
         | IPMLSTCT    |                 | IPMLSTCT    |
         | IPMLSTPT--------              | IPMLSTPT--------
         |-------------|   |             |-------------|   |
         | IPMLIST(1)  |   |             | IPMLIST(1)  |   |
         | (IPMENTRY)  |   |             | (IPMENTRY)  |   |
         |-------------|   |             |-------------|   |
         | ...         |   |             | ...         |   |
         |-------------|   |             |-------------|   |
         | IPMLIST(n)  |   |             | IPMLIST(n)  |   |
         | (IPMENTRY)  |   |             | (IPMENTRY)  |   |
         +-------------+<--              +-------------+<--
         (where "n" = IPMLSTCT in each IPMBK frame)
                  Each IPMENTRY contains a description of the
                  subscribed target (depending on the function).
                  The IPMBK exists in the system execution space and
                  may be backed anywhere in storage.

#### IPMBK Control Block Content

#### IPMBK DSECT

####

####

####

####

    Hex   Dec Type/Val   Lng Label (dup)    Comments
    ---- ---- --------- ---- -------------- --------
    0000    0 Structure      IPMBK          IP Multiple Entry structure
    0000    0 Dbl-Word     8 IPMHDR (0)     IPMBK Frame Header
    0000    0 Signed       4 IPMFPNT        HL address of next IPMBK
    0004    4 Signed       4 IPMBPNT        HL address of previous IPMBK
    0008    8 Signed       4 IPMFRMID       Frame Number
    000C   12 Signed       4 IPMFRMS        Total Number of Frames
    0010   16 Signed       4 IPMLSTCT       Number of entries in this frame
    0014   20 Signed       4 IPMLSTRM       Number of bytes remaining
    0018   24 Address      4 IPMLSTPT       HL address of next IPMLIST slot
    001C   28 Address      4 IPMWRKPT       Work Pointer
    0020   32 Bitstring   16 IPMXID         Original search ID
              00000030       IPMHDRLN       *-IPMHDR Length of frame header
                                            in bytes
              00000030       IPMLIST        * First available IPMLIST slot
              00000FD0       IPMAVAIL       (4096-IPMHDRLN) Space for IPMLIST
                                            array
    0020   32 Bitstring   16 IPMIPAV6       IPv6 Search ID
    0020   32 Bitstring   12 *              Unused
    002C   44 Bitstring    4 IPMIPAV4       IPv4 Search ID
          IPMLM_ENTRY - Define an entry for List Multiple data.

    IPMLM_ENTRY DSECT

    Hex   Dec Type/Val   Lng Label (dup)    Comments
    ---- ---- --------- ---- -------------- --------
    0000    0 Structure      IPMLM_ENTRY    IP Multiple Entry structure
    0000    0 Address      4 IPMLM_NIDBK    HL address of NIDBK
              00000004       IPMLM_LEN      (*-IPMLM_ENTRY) Length of
                                            IPMLM_ENTRY
          IPMQC_ENTRY - Define an entry for Query Cache data.

    IPMQC_ENTRY DSECT

    Hex   Dec Type/Val   Lng Label (dup)    Comments
    ---- ---- --------- ---- -------------- --------
    0000    0 Structure      IPMQC_ENTRY    IP Multiple Entry structure
    0000    0 Bitstring    1 IPMEXPAT       Physical Address Type
              00000001       IPMEXLAN       X'01' IPMEXLAN - LAN MAC Address
                                            (6 bytes)
              00000002       IPMEXATM       X'02' IPMEXATM - ATM Address (20
                                            bytes) (N/A)
    0001    1 Bitstring    1 IPMEXIAT       IP Address Type
              00000001       IPMEXIV4       X'01' IPMEXIV4 - IPv4 (4 bytes)
              00000002       IPMEXIV6       X'02' IPMEXIV6 - IPv6 (16 bytes)
    0002    2 Bitstring    6 IPMEXMAC       MAC Address (for IPMEXLAN)
    0008    8 Bitstring   16 IPMEXIPA (0)   IP Address (LEFT justified)
    0008    8 Bitstring    4 IPMEXIP4 (0)   IPv4 Address
    0008    8 Bitstring   16 IPMEXIP6       IPv6 Address
              00000018       IPMQC_LEN      (*-IPMQC_ENTRY) Length of
                                            IPMQC_ENTRY

    IPMBK Storage Layout

    *** IPMBK - IP Multiple Entry structure
    *
    *     +---------------------------+---------------------------+
    *   0 |         IPMFPNT           |         IPMBPNT           |
    *     +---------------------------+---------------------------+
    *   8 |         IPMFRMID          |         IPMFRMS           |
    *     +---------------------------+---------------------------+
    *  10 |         IPMLSTCT          |         IPMLSTRM          |
    *     +---------------------------+---------------------------+
    *  18 |         IPMLSTPT          |         IPMWRKPT          |
    *     +---------------------------+---------------------------+
    *  20 |                        IPMXID                         |
    *     |                                                       |
    *     +-------------------------------------------------------+
    *  30
    *
    *** IPMBK - IP Multiple Entry structure

    *** Overlay for IPMXID in IPMBK
    *
    *     +-------------------------------------------------------+
    *  20 |                       IPMIPAV6                        |
    *     |                                                       |
    *     +-------------------------------------------------------+
    *  30
    *
    *** Overlay for IPMXID in IPMBK

    *** Overlay for IPMXID in IPMBK
    *
    *     +-------------------------------------------------------+
    *  20 |///////////////////////////////////////////////////////|
    *     |///////////////////////////+---------------------------+
    *  28 |///////////////////////////|         IPMIPAV4          |
    *     +---------------------------+---------------------------+
    *  30
    *
    *** Overlay for IPMXID in IPMBK

    *** IPMLM_ENTRY - IP Multiple Entry structure
    *
    *     +---------------------------+
    *   0 |       IPMLM_NIDBK         | 4
    *     +---------------------------+
    *
    *** IPMLM_ENTRY - IP Multiple Entry structure

    *** IPMQC_ENTRY - IP Multiple Entry structure
    *
    *     +------+------+-----------------------------------------+
    *   0 |:EXPAT|:EXIAT|                IPMEXMAC                 |
    *     +------+------+-----------------------------------------+
    *   8 |                       IPMEXIP6                        |
    *     |                                                       |
    *     +-------------------------------------------------------+
    *  18
    *
    *** IPMQC_ENTRY - IP Multiple Entry structure

    IPMBK Cross Reference

    Symbol         Dspl Value
    -------------- ---- -----
    IPMAVAIL       0020 00000FD0
    IPMBPNT        0004
    IPMEXATM       0000 00000002
    IPMEXIAT       0001
    IPMEXIPA       0008
    IPMEXIP4       0008
    IPMEXIP6       0008
    IPMEXIV4       0001 00000001
    IPMEXIV6       0001 00000002
    IPMEXLAN       0000 00000001
    IPMEXMAC       0002
    IPMEXPAT       0000
    IPMFPNT        0000
    IPMFRMID       0008
    IPMFRMS        000C
    IPMHDR         0000
    IPMHDRLN       0020 00000030
    IPMIPAV4       002C
    IPMIPAV6       0020
    IPMLIST        0020 00000030
    IPMLM_LEN      0000 00000004
    IPMLM_NIDBK    0000
    IPMLSTCT       0010
    IPMLSTPT       0018
    IPMLSTRM       0014
    IPMQC_LEN      0008 00000018
    IPMWRKPT       001C
    IPMXID         0020

    This information is
    based on z/VM V6R1.0.
    Last updated on 18 Feb 2010 at 08:44:43 EDT.

    Copyright IBM Corporation, 1990, 2008