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

#### IPMBK

Prolog

Control Block Contents
IPMBK DSECT
IPMENTRY 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 :
                  HCPIPNLM - Created to list IP MultiCast subscriptions
     DELETED BY :
                  HCPIPNXM - Destroyed after using IP MultiCast list
     USAGE NOTES  :
                  HCPIPNLM Interface:
                  When you call HCPIPNLM to List Multicast subscriptions,
                  the output is a pointer to an IPMBK (the first of a
                  NULL-terminated chain).  Each IPMBK contains a number
                  of IPMENTRY entries.  Each IPMENTRY describes a
                  subscriber to the specified IP MultiCast Address.
                  The structure of the output IPMBK chain is:
                  Pointer to IPMBK
                  ***************-
                  |
                  V
                  +-------------+                 +-------------+
                  | IPMBK(1)    |                 | IPMBK(n)    |
                  |-------------|                 |-------------|
                  | IPMFPNT------------/.../----->| IPMFPNT=0   |
                  | IPMBPNT=0   |<-----/.../--------IPMBPNT=0   |
                  |             |                 |             |
                  | IPMLSTCT    |                 | IPMLSTCT    |
                  |-------------|                 |-------------|
                  | 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 (MACADDR, NIDBK, NICBK).

#### 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        Next IPMBK
    0004    4 Signed       4 IPMBPNT        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 Address      4 IPMLSTPT       Pointer last IPMENTRY + 1
              00000018       IPMHDRLN       *-IPMHDR Length of frame header
                                            in bytes
    0018   24 Bitstring   20 IPMLIST (203)  Array of IPMENTRY slots
    1000 4096 Bitstring    1 IPM$END (0)    END of IPMBK frame
         IPMENTRY - This defines a single IPMLIST element.

    IPMENTRY DSECT

    Hex   Dec Type/Val   Lng Label (dup)    Comments
    ---- ---- --------- ---- -------------- --------
    0000    0 Structure      IPMENTRY       IP Multiple Entry structure
         These fields are provided for internal linkage.
    0000    0 Bitstring    1 IPMEXTYP       Entry Type (see IPNTYPE)
    0001    1 Bitstring    3 *              Reserved
    0004    4 Address      4 IPMEXNID       Pointer to NIDBK
         These fields represent an ARP response.
    0008    8 Bitstring   12 IPMEXARP (0)   ARP Cache Response Data
    0008    8 Bitstring    1 IPMEXPAT       Physical Address Type
              00000001       IPMEXLAN       X'01' - LAN MAC Address (6 bytes)
              00000002       IPMEXATM       X'02' - ATM Address (20 bytes)
                                            (N/A)
    0009    9 Bitstring    1 IPMEXIAT       IP Address Type
              00000001       IPMEXIV4       X'01' - IPv4 (4 bytes)
              00000002       IPMEXIV6       X'02' - IPv6 (16 bytes)
    000A   10 Bitstring    6 IPMEXMAC       MAC Address (for IPMEXLAN)
    0010   16 Bitstring    4 IPMEXIPA       IP Address (for IPMEXIV4)
         End of one IPMENTRY.
              00000014       IPMENTNX       * Beginning of next entry
              00000014       IPMENTLN       *-IPMENTRY Length of one IPMENTRY
                                            in bytes
              000000CB       IPMENTMX       (4096-IPMHDRLN)/IPMENTLN Max
                                            IPMENTRY count

    IPMBK Storage Layout

    *** IPMBK - IP Multiple Entry structure
    *
    *     +---------------------------+---------------------------+
    *   0 |         IPMFPNT           |         IPMBPNT           |
    *     +---------------------------+---------------------------+
    *   8 |         IPMFRMID          |         IPMFRMS           |
    *     +---------------------------+---------------------------+
    *  10 |         IPMLSTCT          |         IPMLSTPT          |
    *     +---------------------------+---------------------------+
    *  18 |                                                       |
    *     =                       IPMLIST                         =
    *     |                           +---------------------------+
    * FF0 |                           |///////////////////////////|
    *     +---------------------------+///////////////////////////|
    *     |///////////////////////////////////////////////////////|
    *     +-------------------------------------------------------+
    *
    *** IPMBK - IP Multiple Entry structure

    *** IPMENTRY - IP Multiple Entry structure
    *
    *     +------+--------------------+---------------------------+
    *   0 |:EXTYP|////////////////////|         IPMEXNID          |
    *     +------+------+-------------+---------------------------+
    *   8 |:EXPAT|:EXIAT|                IPMEXMAC                 |
    *     +------+------+-------------+---------------------------+
    *  10 |         IPMEXIPA          | 14
    *     +---------------------------+
    *
    *** IPMENTRY - IP Multiple Entry structure

    IPMBK Cross Reference

    Symbol         Dspl Value
    -------------- ---- -----
    IPM$END        1000
    IPMBPNT        0004
    IPMENTLN       0010 00000014
    IPMENTMX       0010 000000CB
    IPMENTNX       0010 00000014
    IPMEXARP       0008
    IPMEXATM       0008 00000002
    IPMEXIAT       0009
    IPMEXIPA       0010
    IPMEXIV4       0009 00000001
    IPMEXIV6       0009 00000002
    IPMEXLAN       0008 00000001
    IPMEXMAC       000A
    IPMEXNID       0004
    IPMEXPAT       0008
    IPMEXTYP       0000
    IPMFPNT        0000
    IPMFRMID       0008
    IPMFRMS        000C
    IPMHDR         0000
    IPMHDRLN       0014 00000018
    IPMLIST        0018
    IPMLSTCT       0010
    IPMLSTPT       0014

    This information is
    based on z/VM V4R3.0.
    Last updated on 1 May 2002 at 09:00:08 EDT.

    Copyright IBM Corporation, 1990, 2002