|
Programming Interface Information:
This information is NOT intended to be used as Programming Interfaces of z/VM. |
IPMBK
Control Block Contents
IPMBK DSECT
IPMENTRY DSECT
Cross Reference (Contains links to field and bit definitions)
IPMBK Prolog
NAME : HCPIPMBK
DESCRIPTION: IP MultiCast Frame 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 MultiCast Frame 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 4064 IPMLIST 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 MultiCast Frame structure 0000 0 Bitstring 6 IPMENTMA MACADDR subscribed to IP Address 0006 6 Bitstring 2 * Reserved 0008 8 Address 4 IPMENTND Pointer to Device (NIDBK) 000C 12 Address 4 IPMENTNC Pointer to Adapter (NICBK) 00000010 IPMENTNX * Beginning of next entry 00000010 IPMENTLN *-IPMENTRY Length of one IPMENTRY in bytes 000000FE IPMENTMX (4096-IPMHDRLN)/IPMENTLN Max IPMENTRY count
IPMBK Storage Layout
*** IPMBK - IP MultiCast Frame structure * * +---------------------------+---------------------------+ * 0 | IPMFPNT | IPMBPNT | * +---------------------------+---------------------------+ * 8 | IPMFRMID | IPMFRMS | * +---------------------------+---------------------------+ * 10 | IPMLSTCT | IPMLSTPT | * +---------------------------+---------------------------+ * 18 | | * = IPMLIST = * | | * +-------------------------------------------------------+ * FF8 |///////////////////////////////////////////////////////| * +-------------------------------------------------------+ * *** IPMBK - IP MultiCast Frame structure *** IPMENTRY - IP MultiCast Frame structure * * +-----------------------------------------+-------------+ * 0 | IPMENTMA |/////////////| * +---------------------------+-------------+-------------+ * 8 | IPMENTND | IPMENTNC | * +---------------------------+---------------------------+ * 10 * *** IPMENTRY - IP MultiCast Frame structure
IPMBK Cross Reference
Symbol Dspl Value -------------- ---- ----- IPM$END 1000 IPMBPNT 0004 IPMENTLN 000C 00000010 IPMENTMA 0000 IPMENTMX 000C 000000FE IPMENTNC 000C IPMENTND 0008 IPMENTNX 000C 00000010 IPMFPNT 0000 IPMFRMID 0008 IPMFRMS 000C IPMHDR 0000 IPMHDRLN 0014 00000018 IPMLIST 0018 IPMLSTCT 0010 IPMLSTPT 0014
This information is based on z/VM V4R2.0. Last updated on 30 Oct 2001 at 15:39:11 EDT.
Copyright IBM Corporation, 1990, 2001