IPNBK - 32-bit CP - V4R4.0

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

#### IPNBK

Prolog

Control Block Contents
IPNBK DSECT

Storage Layout

Cross Reference (Contains links to field and bit definitions)

#### IPNBK Prolog

     NAME       : HCPIPNBK
     DESCRIPTION: IP Node block
     DSECT      : IPNBK
     FUNCTION   :
                  The IPNBK structure defines a relationship between
                  a specific IP Address and a specific network device
                  (represented by a NIDBK).  When a device is subscribed
                  to an IP Address, the IPNBK can be found by looking up
                  the IP Address in the LAN IP Table or by following the
                  subscription chain anchored within the NIDBK (NIDIPNHD).
     LOCATED BY -
       LANIPTBL - LAN IP Table structure.
       NIDIPTBL - Device IP Table structure.
       LANBCTBL - LAN Broadcast Table
       NIDBCTBL - Device Broadcast IPNBK entries
       LANMCTBL - LAN Multicast Router Table
       NIDMCTBL - Device Router IPNBK entries
     CREATED BY :
                  IP Address functions in module HCPIPN.
     DELETED BY :
                  IP Address functions in module HCPIPN.

#### IPNBK Control Block Content

#### IPNBK DSECT

    Hex   Dec Type/Val   Lng Label (dup)    Comments
    ---- ---- --------- ---- -------------- --------
    0000    0 Structure      IPNBK          IP Node block
          IP Table Node (for an IP Unicast/Multicast entry).
    0000    0 Character    1 IPNTYPE        IPNBK Type
              000000E4       IPNTYPUC       C'U' Unicast IPNBK
              000000D4       IPNTYPMC       C'M' Multicast IPNBK
              000000C2       IPNTYPBC       C'B' Broadcast IPNBK
              000000D9       IPNTYPRX       C'R' Router IPNBK IPNPROTO
                                            represents the IP Protocol (see
                                            HCPIPABK IPAIPVER)
    0001    1 Bitstring    1 IPNPROTO       IPNBK Protocol (IPv4/IPv6)
              00000004       IPNIPV4        4 IPv4 Protocol
              00000006       IPNIPV6        6 IPv6 Protocol IPNARPFL
                                            represents SETIP Flag byte 3 (see
                                            HCPIPABK). Notes : IPABK defines
                                            IPAIPARP as 0 but the IP Assist
                                            document indicates x'01'. In
                                            practice, this is the default so
                                            it does not matter. I am using a
                                            value of x'01' because it seems
                                            more consistent with the general
                                            structure of the IP Assists.
    0002    2 Bitstring    1 IPNARPFL       SETIP Flag byte 3 (ARP flags)
              .... ...1      IPNARPRQ       B'00000001' ARP this request
                                            (normal)
              .... ..1.      IPNNARP        B'00000010' DO NOT ARP this req
                                            (takeover)
              .... .1..      IPNNFAIL       B'00000100' DO NOT FAIL a
                                            matching ARP req
    0003    3 Bitstring    1 IPNFLAGS       IPNBK Flags
              1... ....      IPNDEACT       X'80' DEACTIVATED from LAN IP
                                            Table
              .1.. ....      IPNLOCAL       X'40' LOCAL to this LAN Segment
              ..1. ....      IPNREMOT       X'20' Remote (soft) IP Entry
              ...1 ....      IPNPROXY       X'10' Set by ARP Add Address
                                            Entry
              .... 1...      IPNINUSE       X'08' Indicate recent activity
    0004    4 Address      4 IPNLINK        Pointer to associated device
          Linkage for Device IP Table chain.
    0008    8 Address      4 IPNFPNT        Pointer to next Device IPNBK
    000C   12 Address      4 IPNBPNT        Pointer to previous Device IPNBK
          Linkage for LANBK IP Table chain.
    0010   16 Address      4 IPNXFPNT       Pointer to next LAN IPNBK
    0014   20 Address      4 IPNXBPNT       Pointer to previous LAN IPNBK
          IP Node Identification.
    0018   24 Bitstring   16 IPNXID         Space for IP Node Identification
          Common fields.
    0028   40 Bitstring    2 IPNMSKNN       Netmask bits
    002A   42 Bitstring    6 IPNMACAD       MACADDR registered
    0030   48 Bitstring    2 IPNOSID        OSID value
    0032   50 Bitstring    2 IPNVLAN        Current VLAN ID
    0034   52 Bitstring    4 *              Reserved
    0038   56 Bitstring    8 IPNTOD         TOD Clock created/refreshed
          End of the IPNBK.
    0040   64 Dbl-Word     8 IPN$END (0)    End of the IPNBK structure
              00000040       IPNBKLN        *-IPNBK Length of IPNBK in bytes
              00000008       IPNBKSZ        (*-IPNBK+7)/8 Size of IPNBK in
                                            doublewords
     IP Multicast Address (IPM) indicator.
       When the IP Address byte 0 is in the range of 224-239
       (x'E0'-x'EF') it designates an IP Multicast address.
       To determine if an IP Address is an IPM Address:
       (1) TM byte0,IPNMCON; If cc<3 it is NOT an IPM
       (2) TM byte0,IPNMCOFF; If cc>0 it is NOT an IPM
       The address must pass BOTH tests to be accepted as
       a Multicast IP Address.
              1111 ....      IPNMCMSK       X'F0' IPM Byte 0 - Significant
                                            bits
              111. ....      IPNMCON        X'E0' IPM Byte 0 - These bits are
                                            ON
              ...1 ....      IPNMCOFF       X'10' IPM Byte 0 - These bits are
                                            OFF
          Redefine IPNXID for a generic IP Address (right-justified).
    0018   24 Bitstring   16 IPNADDR        Generic IP Address (128 bits)
          Redefine IPNXID for an IPv4 IP Address.
    0018   24 Bitstring   12 IPNIPXV4       IPv4 (unused bits)
    0024   36 Bitstring    4 IPNIPAV4       IPv4 Address (32 bits)
          Redefine IPNXID for an IPv6 IP Address.
    0018   24 Bitstring   16 IPNIPAV6       IPv6 Address (128 bits)
          Redefine IPNXID for a Broadcast/Routing device entry.
    0018   24 Character    8 IPNXUSER       Userid of device owner
    0020   32 Bitstring    2 IPNXDVNO       Binary (16-bit) vdev address
    0022   34 Bitstring    6 *              Unused

#### IPNBK Storage Layout

    *** IPNBK - IP Node block
    *
    *     +------+------+------+------+---------------------------+
    *   0 |:TYPE |:PROTO|:ARPFL|:FLAGS|         IPNLINK           |
    *     +------+------+------+------+---------------------------+
    *   8 |         IPNFPNT           |         IPNBPNT           |
    *     +---------------------------+---------------------------+
    *  10 |         IPNXFPNT          |         IPNXBPNT          |
    *     +---------------------------+---------------------------+
    *  18 |                        IPNXID                         |
    *     |                                                       |
    *     +-------------+-----------------------------------------+
    *  28 |  IPNMSKNN   |                IPNMACAD                 |
    *     +-------------+-------------+---------------------------+
    *  30 |  IPNOSID    |  IPNVLAN    |///////////////////////////|
    *     +-------------+-------------+---------------------------+
    *  38 |                        IPNTOD                         |
    *     +-------------------------------------------------------+
    *
    *** IPNBK - IP Node block

    *** Overlay for IPNXID in IPNBK
    *
    *     +-------------------------------------------------------+
    *  18 |                       IPNADDR                         |
    *     |                                                       |
    *     +-------------------------------------------------------+
    *  28
    *
    *** Overlay for IPNXID in IPNBK

    *** Overlay for IPNXID in IPNBK
    *
    *     +-------------------------------------------------------+
    *  18 |                       IPNIPXV4                        |
    *     |                           +---------------------------+
    *  20 |                           |         IPNIPAV4          |
    *     +---------------------------+---------------------------+
    *  28
    *
    *** Overlay for IPNXID in IPNBK

    *** Overlay for IPNXID in IPNBK
    *
    *     +-------------------------------------------------------+
    *  18 |                       IPNIPAV6                        |
    *     |                                                       |
    *     +-------------------------------------------------------+
    *  28
    *
    *** Overlay for IPNXID in IPNBK

    *** Overlay for IPNXID in IPNBK
    *
    *     +-------------------------------------------------------+
    *  18 |                       IPNXUSER                        |
    *     +-------------+-----------------------------------------+
    *  20 |  IPNXDVNO   |/////////////////////////////////////////|
    *     +-------------+-----------------------------------------+
    *  28
    *
    *** Overlay for IPNXID in IPNBK

#### IPNBK Cross Reference

    Symbol         Dspl Value
    -------------- ---- -----
    IPN$END        0040
    IPNADDR        0018
    IPNARPFL       0002
    IPNARPRQ       0002 01
    IPNBKLN        0040 00000040
    IPNBKSZ        0040 00000008
    IPNBPNT        000C
    IPNDEACT       0003 80
    IPNFLAGS       0003
    IPNFPNT        0008
    IPNINUSE       0003 08
    IPNIPAV4       0024
    IPNIPAV6       0018
    IPNIPV4        0001 00000004
    IPNIPV6        0001 00000006
    IPNIPXV4       0018
    IPNLINK        0004
    IPNLOCAL       0003 40
    IPNMACAD       002A
    IPNMCMSK       0040 F0
    IPNMCOFF       0040 10
    IPNMCON        0040 E0
    IPNMSKNN       0028
    IPNNARP        0002 02
    IPNNFAIL       0002 04
    IPNOSID        0030
    IPNPROTO       0001
    IPNPROXY       0003 10
    IPNREMOT       0003 20
    IPNTOD         0038
    IPNTYPBC       0000 000000C2
    IPNTYPE        0000
    IPNTYPMC       0000 000000D4
    IPNTYPRX       0000 000000D9
    IPNTYPUC       0000 000000E4
    IPNVLAN        0032
    IPNXBPNT       0014
    IPNXDVNO       0020
    IPNXFPNT       0010
    IPNXID         0018
    IPNXUSER       0018

This information is based on z/VM V4R4.0. Last updated on 6 Aug 2003 at 08:56:06 EDT.
Copyright IBM Corporation, 1990, 2003