Programming Interface Information:
This information is NOT intended to be used as Programming Interfaces of z/VM. |
MDEBK
Control Block Contents
MDEBK DSECT
MDEBFENT DSECT
MDEADENT DSECT
Cross Reference (Contains links to field and bit definitions)
MDEBK Prolog
NAME : HCPMDEBK DESCRIPTION: ISFC Message Descriptor Block DSECT : MDEBK FUNCTION : Maintain information about an ISFC message. A complete MDEBK contains the virtual address of each data area that contains message data. LOCATED BY : Various queue anchors. CREATED BY : ISFC routines that generate messages or accept messages from outside the subsystem. DELETED BY : ISFC routines after the message has been transmitted. SERIALIZED : The ISFC global lock (HCPBDSGL). NOTES : THIS COPY FILE REQUIRES THE FOLLOWING IN ORDER TO GENERATE PROPERLY: - IPARMLX - HCPCARBK The MDEBK header describes the message, and the primary MDEBK contains pointers that lead to the buffers containing message data. The MDEBK header is copied into the beginning of each data buffer for transmission across a link. +---------------+ | MDEBK header | |- - - - - - - -| | | +------------+ | A(PGEBK.1) ------->| PGEBK.1 | | . | | Virt.Addr | | . | | Real.Addr | | . | +------------+ | . | +------------+ | A(PGEBK.n) ----------------->| PGEBK.n | | | | Virt.Addr | +---------------+ | Real.Addr --> +------------+ | V +-----------------------+ | MDEBK header | |- - - - - - - - - - - -| | Data contained in | | this page frame... | | | +-----------------------+
MDEBK Control Block Content
MDEBK DSECT
Hex Dec Type/Val Lng Label (dup) Comments ---- ---- --------- ---- -------------- -------- 0000 0 Structure MDEBK ISFC Message Descriptor Block Message Descriptor Block header. 0000 0 Bitstring 8 MDELNKHD Link header Message Definition. 0008 8 Bitstring 1 MDEFRMST (0) Start of this Message Definition 0008 8 Character 4 MDEMAIL Target mailbox name 000C 12 Signed 2 MDEPACCT Session-specific pacing count 000E 14 Bitstring 2 * Reserved 0010 16 Signed 2 MDECMHLN Communication Manager Header len 0012 18 Signed 2 MDEFRMLN Data length on the frame 0014 20 Bitstring 1 MDEFUNC Function 00000001 MDEOPEN 1 - Open 00000002 MDEOPENC 2 - Open Confirm 00000003 MDEREJ 3 - Reject 00000004 MDECLOSE 4 - Close 00000005 MDEQSRM 5 - IUCV Quiesce/Resume 00000006 MDESEND 6 - Send 00000008 MDESENDC 8 - Send Confirm 00000009 MDEDATGM 9 - Datagram 000000FD MDEOPENF 253 - Open with invalid FMH5 000000FE MDEPREQ 254 - Pacing Request 000000FF MDEPRESP 255 - Pacing Response 000000FF MDECOMP 255 - Completion MDEBK 0015 21 Bitstring 2 MDESEQ IUCV big send sequence number 0017 23 Bitstring 1 MDEFLAGS Flag byte: 1... .... MDEPACRQ X'80' - Pacing response requested .1.. .... MDEPACRS X'40' - Pacing response ..1. .... MDECFCL X'20' - Close originated by ISFC ...1 .... MDEPACNW X'10' - New session pacing value .... 1... MDESPLIT X'08' - Part of a split large message .... .1.. MDEMAST X'04' - Master MDEBK for large message .... ..1. MDEFRMED X'02' - Flag for frame count overflow .... ...1 MDEBIGD X'01' - Reply/data length over 1 Meg 0018 24 Signed 2 MDENUMB Frame number within msg 001A 26 Signed 2 MDEFRMS Total number of frames in msg 001C 28 Signed 4 MDETOTLN Total length of this msg 0020 32 Character 8 MDENODET Target Node ID 0028 40 Character 8 MDENODES Source Node ID 0030 48 Signed 4 MDETSESS Target Session ID 0034 52 Signed 4 MDESSESS Source Session ID 0038 56 Signed 2 MDEMSGID Unique message identifier 00000032 MDEHLEN *-MDEFRMST Length of Comm Mgr Header Mailbox Header. 003A 58 Bitstring 1 MDEMHEAD (0) Start of mailbox header 003A 58 Signed 2 MDEMHLEN Mailbox header length 003C 60 Bitstring 1 MDEMINFO (0) Start of mailbox information Mailbox Header for CP mailbox. 003C 60 Bitstring 4 * reserved 00000006 MDEPMHL *-MDEMHEAD Length of CPAP mailbox header CP mailbox parameter list. NOTES : The largest parameter list is defined first. The value of (CARSIZE*8) for BLOCKMAP is 9*8 = 72 0040 64 Bitstring 72 MDECLIST Reserve space for the CP mailbox parameter list Information in the Primary MDEBK. 0088 136 Bitstring 1 MDECMPDD (0) Start of CMP Data Definition 0088 136 Signed 2 * Reserved 008A 138 Bitstring 1 MDELCLFL Local flag byte: 1... .... MDEPTHRS X'80' - Resume the path .1.. .... MDECMPPC X'40' - CMP pacing message ...1 .... MDECFMSG X'10' - Indicate stand-alone ISFC msg .... 1... MDEPASS X'08' - This is a passthru message .... .1.. MDEPTARG X'04' - Send passthru message to target 008B 139 Bitstring 1 MDEERRFL Error flags for this MDEBK: 00000000 MDENOERR 0 - No errors during processing 00000001 MDEPAGER 1 - A paging error occurred 00000002 MDECMSER 2 - An error occurred in HCPCMSSN 00000003 MDEINVFN 3 - Invalid ISFC function 00000004 MDEINVMF 4 - Invalid mailbox function 00000005 MDEINITE 5 - Initialization error 00000006 MDEGENER 6 - Generic bad message 00000007 MDEINPIP 7 - Invalid PIP data received 00000007 MDEMAXER MDEINPIP - Maximum error value NOTES : The values defined in MDEERRFL are used as offsets in a branch table in HCPBUTRF. The branch table in HCPBUTRF must be updated to reflect any changes or additions to flags. 008C 140 Signed 4 MDENEXT Chain pointer 0090 144 Signed 2 MDEIOOUT Number of buffers being written 0092 146 Signed 2 MDEIODON Number of buffers already written 0094 148 Signed 4 MDEPTHAD Address of PTHBK 0098 152 Signed 4 MDELNKAD Address of LNKBK for LINK mailbox 009C 156 Signed 4 MDENODAD Address of NODBK if frames are a receive from a remote node. 00A0 160 Signed 4 MDESNDAD SENDDATA buffer address 00A4 164 Signed 4 MDEERROR Error field dependent on MDEERRFL Values contained in MDEERROR for each bit in MDEERRFL MDEPAGER then value is the bad virtual address MDECMSER then value is the protocol error code MDEINVFN then value is invalid ISFC function MDEINVMF then value is invalid mailbox function MDEINITE then value is queue address containing MDEBK MDEGENER then value is invalid MDEINPIP then value is IPRCODE 000000A8 MDECLRLN *-MDEBK Length of MDEBK to be cleared 00A8 168 Bitstring 1 MDECLEND (0) Start of second area to clear 00A8 168 Signed 4 MDEBLIST Buffer list area address 00AC 172 Signed 4 MDEDALST Data area list address 00B0 176 Dbl-Word 8 * (0) Force doubleword alignment 00B0 176 Bitstring 72 MDELIST Buffer List The value of MDEBMAX*MDEADDLN for BLOCKMAP is 9*12 = 108 00F8 248 Bitstring 108 MDEALST Data Area List 000000BC MDECLRL2 *-MDECLEND Length of second part of frame 0000002D MDESIZE (*-MDEBK+7)/8 Size, in doublewords, of MDEBK Mailbox Header for APPC and IUCV PLIST. 003C 60 Bitstring 2 MDECODE SENDERR/SEVER code MDECODE contains values defined for IPCODE 003E 62 Bitstring 1 MDETYPE SEND type MDETYPE contains values defined for IPWHATRC and IPSENDOP 003F 63 Bitstring 1 MDEAFLAG Flags (use varies by function) MDEAFLAG (for MDEFUNC=MDEOPEN): - IPLVLCF - IPMAPPED - IPIMMED MDEAFLAG (for MDEFUNC=MDESEND): - IPNOFLSH 00000006 MDEAMHL *-MDEMHEAD Length of APPC mailbox header 00000006 MDEIMHL *-MDEMHEAD Length of IUCV mailbox header APPC/IUCV PLIST. NOTES : The MDEPLIST size is based on the full size of the IPARML including the fields that are for CP use only and are not presented to a virtual machine. The value of (IPTSIZE*8) for BLOCKMAP is 6*8 = 48 0040 64 Bitstring 48 MDEPLIST Reserve space for an IUCV PLIST The following area is only used when an IUCV message is held on the PTHHLDQ (Hold Queue). This happens when the IUCV MSGLIMIT is exceeded and the message is held until the local path can accept more messages. 0070 112 Bitstring 1 MDEHLDFL Held Message flag 1... .... MDEHLDGO X'80' This message is ready to go 0074 116 Address 4 MDEHLDRP Addr of REPLY MDEBK (from R6) 0078 120 Address 4 MDEHLDPL Addr of IPARML area (from R8) 007C 124 Address 4 MDEHLDSB Addr of SEND Buffer (from R2) 0080 128 Address 4 MDEHLDSL Addr of SEND Length (from R3) Remap for IUCV mailbox header. 003C 60 Bitstring 4 MDEBIGCH (0) IUCV big send chain pointer Remapping of the Link Header. 0000 0 Character 2 MDECTCID CTC - Release identifier 0002 2 Signed 2 MDECTCMX CTC - Maximum Buffers per Write 0004 4 Signed 2 MDECTCNO CTC - Number of Buffers used 0006 6 Bitstring 1 MDECTCAP CTC - Capabilities 1... .... MDECTCWF X'80' - WEOF command supported 0007 7 Bitstring 1 * CTC - Reserved Mailbox Header for ISFC CLOSE. 003C 60 Signed 2 MDEMSENS Sense code for ISFC CLOSE: 00000001 MDEISNOD 1 - Invalid source node 00000002 MDEIMBOX 2 - Invalid mailbox 00000003 MDESQERR 3 - Sequence error on session 00000004 MDEISMSG 4 - Session msg not allowed 00000005 MDEIDMSG 5 - Datagram msg not allowed 00000006 MDEIOACK 6 - Invalid session in open ack 00000007 MDEISESN 7 - Invalid session ID 00000008 MDESNCMP 8 - Session not complete 00000009 MDEDEACT 9 - OPERATOR deactivated session 0000000A MDEITNOD 10 - Invalid target node 0000000B MDELNKCL 11 - Close due to link failure 0000000C MDEISIZE 12 - Invalid message size for func 0000000D MDERSPND 13 - ISFC close response to ISFC clse 0000000E MDEABCLS 14 - Mailbox session abnormal close 00000004 MDECMHLC *-MDEMHEAD Length of ISFC CLOSE header Mailbox Header for a LINK mailbox message. 003C 60 Bitstring 1 MDELMFUN Link Monitor function 00000001 MDELMFRQ 1 - Link Monitor Request 00000002 MDELMFRS 2 - Link Monitor Response 00000003 MDELMDWN 3 - Link Monitor 'Link Down' msg 003D 61 Bitstring 2 MDELMCNT - Link Monitor Count 003F 63 Bitstring 8 MDELINST - Link Instance Number 0000000D MDELMHL *-MDEMHEAD Length of LINK mailbox header Mailbox Header for a CMP mailbox SEND function. 003C 60 Bitstring 1 MDECMPFN CMP SEND function 00000001 MDECMPCP 1 - CMP send capabilities 00000002 MDECMPRS 2 - CMP send resources 00000003 MDECMPRT 3 - CMP resource table request 00000004 MDECMPRR 4 - CMP resource table req response 00000005 MDECMPBR 5 - CMP broadcast request 00000006 MDECMPBS 6 - CMP broadcast response 00000007 MDECMPJL 7 - CMP journalling message 00000008 MDECMPVN 8 - CMP verify node message 00000003 MDECMHLS *-MDEMHEAD Length of CMP SEND mailbox header 00000003 MDECMHL MDECMHLS Default len for MBX HDR definition Format for 'Send Node Capabilities' message. 0088 136 Bitstring 2 MDECAPLT Length of node capabilities 008A 138 Bitstring 1 MDECAPS Node capabilities 1... .... MDECAPRS X'80' - Resources are supported .1.. .... MDECAPUS X'40' - Userid search is supported ..1. .... MDECAPPW X'20' - Password checking supported 00000003 MDECAPSZ *-MDECAPLT Size of node capabilities Format for 'CS area'. .... 1.1. MDECSARL X'0A' Size of CS area FUNCTION : Format for a 'Buffer List' entry within an MDEBK. The MDELIST field contains MDEBMAX of these. LOCATED BY : MDEBLIST (part of the MDEBK).
MDEBFENT DSECT
Hex Dec Type/Val Lng Label (dup) Comments ---- ---- --------- ---- -------------- -------- 0000 0 Structure MDEBFENT ISFC Message Descriptor Block 0000 0 Signed 4 MDEBFADD Virtual Address of 1st data byte 0004 4 Signed 4 MDEBFLEN Length of the buffer 00000008 MDEBFBLN *-MDEBFENT Length of a buffer list entry FUNCTION : Format for an 'Address List' entry within an MDEBK. The MDEALST field contains MDEBMAX of these. LOCATED BY : MDEDALST (part of the MDEBK).
MDEADENT DSECT
Hex Dec Type/Val Lng Label (dup) Comments ---- ---- --------- ---- -------------- -------- 0000 0 Structure MDEADENT ISFC Message Descriptor Block 0000 0 Signed 4 MDEADVIR Virtual Address of data frame 0004 4 Signed 4 MDEADLEN (0) Length of the frame (with header) 0004 4 Bitstring 2 * High-order bytes of frame length 0006 6 Signed 2 MDEADHLN Halfword length of the frame 0008 8 Signed 4 MDEADPGE Address of PGEBK 0000000C MDEADDLN *-MDEADENT Length of a data area list entry
MDEBK Storage Layout
*** MDEBK - ISFC Message Descriptor Block * * +-------------------------------------------------------+ * 0 | MDELNKHD | * +---------------------------+-------------+-------------+ * 8 | MDEMAIL | MDEPACCT |/////////////| * +-------------+-------------+------+------+------+------+ * 10 | MDECMHLN | MDEFRMLN |:FUNC | MDESEQ |:FLAGS| * +-------------+-------------+------+-------------+------+ * 18 | MDENUMB | MDEFRMS | MDETOTLN | * +-------------+-------------+---------------------------+ * 20 | MDENODET | * +-------------------------------------------------------+ * 28 | MDENODES | * +---------------------------+---------------------------+ * 30 | MDETSESS | MDESSESS | * +-------------+-------------+---------------------------+ * 38 | MDEMSGID | MDEMHLEN |///////////////////////////| * +-------------+-------------+---------------------------+ * 40 | | * = MDECLIST = * | | * +-------------+------+------+---------------------------+ * 88 |/////////////|:LCLFL|:ERRFL| MDENEXT | * +-------------+------+------+---------------------------+ * 90 | MDEIOOUT | MDEIODON | MDEPTHAD | * +-------------+-------------+---------------------------+ * 98 | MDELNKAD | MDENODAD | * +---------------------------+---------------------------+ * A0 | MDESNDAD | MDEERROR | * +---------------------------+---------------------------+ * A8 | MDEBLIST | MDEDALST | * +---------------------------+---------------------------+ * B0 | | * = MDELIST = * | | * +-------------------------------------------------------+ * F8 | | * = MDEALST = * | +---------------------------+ * | | 164 * +---------------------------+ * *** MDEBK - ISFC Message Descriptor Block *** Overlay for MDEMINFO in MDEBK * * +-------------+------+------+ * 38 ... 3C | MDECODE |:TYPE |:AFLAG| * +---------------------------+-------------+------+------+ * 40 | | * = MDEPLIST = * | | * +------+--------------------+---------------------------+ * 70 |:HLDFL|////////////////////| MDEHLDRP | * +------+--------------------+---------------------------+ * 78 | MDEHLDPL | MDEHLDSB | * +---------------------------+---------------------------+ * 80 | MDEHLDSL | 84 * +---------------------------+ * *** Overlay for MDEMINFO in MDEBK *** Overlay for MDEMINFO in MDEBK * * *** Overlay for MDEMINFO in MDEBK *** Overlay for MDELNKHD in MDEBK * * +-------------+-------------+-------------+------+------+ * 0 | MDECTCID | MDECTCMX | MDECTCNO |:CTCAP|//////| * +-------------+-------------+-------------+------+------+ * 8 * *** Overlay for MDELNKHD in MDEBK *** Overlay for MDEMINFO in MDEBK * * +-------------+ * 38 ... 3C | MDEMSENS | 3E * +-------------+ * *** Overlay for MDEMINFO in MDEBK *** Overlay for MDEMINFO in MDEBK * * +------+-------------+------+ * 38 ... 3C |:LMFUN| MDELMCNT |(03F)-| * +---------------------------+------+-------------+------+ * 40 | -MDELINST | 47 * +------------------------------------------------+ * *** Overlay for MDEMINFO in MDEBK *** Overlay for MDEMINFO in MDEBK * * +------+ * 38 ... 3C |:CMPFN| 3D * +------+ * *** Overlay for MDEMINFO in MDEBK *** Overlay for MDECMPDD in MDEBK * * +-------------+------+ * 88 | MDECAPLT |:CAPS | 8B * +-------------+------+ * *** Overlay for MDECMPDD in MDEBK *** MDEBFENT - ISFC Message Descriptor Block * * +---------------------------+---------------------------+ * 0 | MDEBFADD | MDEBFLEN | * +---------------------------+---------------------------+ * 8 * *** MDEBFENT - ISFC Message Descriptor Block *** MDEADENT - ISFC Message Descriptor Block * * +---------------------------+-------------+-------------+ * 0 | MDEADVIR |/////////////| MDEADHLN | * +---------------------------+-------------+-------------+ * 8 | MDEADPGE | C * +---------------------------+ * *** MDEADENT - ISFC Message Descriptor Block
MDEBK Cross Reference
Symbol Dspl Value -------------- ---- ----- MDEABCLS 003C 0000000E MDEADDLN 0008 0000000C MDEADHLN 0006 MDEADLEN 0004 MDEADPGE 0008 MDEADVIR 0000 MDEAFLAG 003F MDEALST 00F8 MDEAMHL 003F 00000006 MDEBFADD 0000 MDEBFBLN 0004 00000008 MDEBFLEN 0004 MDEBIGCH 003C MDEBIGD 0017 01 MDEBLIST 00A8 MDECAPLT 0088 MDECAPPW 008A 20 MDECAPRS 008A 80 MDECAPS 008A MDECAPSZ 008A 00000003 MDECAPUS 008A 40 MDECFCL 0017 20 MDECFMSG 008A 10 MDECLEND 00A8 MDECLIST 0040 MDECLOSE 0014 00000004 MDECLRLN 00A4 000000A8 MDECLRL2 00F8 000000BC MDECMHL 003C 00000003 MDECMHLC 003C 00000004 MDECMHLN 0010 MDECMHLS 003C 00000003 MDECMPBR 003C 00000005 MDECMPBS 003C 00000006 MDECMPCP 003C 00000001 MDECMPDD 0088 MDECMPFN 003C MDECMPJL 003C 00000007 MDECMPPC 008A 40 MDECMPRR 003C 00000004 MDECMPRS 003C 00000002 MDECMPRT 003C 00000003 MDECMPVN 003C 00000008 MDECMSER 008B 00000002 MDECODE 003C MDECOMP 0014 000000FF MDECSARL 008A 0A MDECTCAP 0006 MDECTCID 0000 MDECTCMX 0002 MDECTCNO 0004 MDECTCWF 0006 80 MDEDALST 00AC MDEDATGM 0014 00000009 MDEDEACT 003C 00000009 MDEERRFL 008B MDEERROR 00A4 MDEFLAGS 0017 MDEFRMED 0017 02 MDEFRMLN 0012 MDEFRMS 001A MDEFRMST 0008 MDEFUNC 0014 MDEGENER 008B 00000006 MDEHLDFL 0070 MDEHLDGO 0070 80 MDEHLDPL 0078 MDEHLDRP 0074 MDEHLDSB 007C MDEHLDSL 0080 MDEHLEN 0038 00000032 MDEIDMSG 003C 00000005 MDEIMBOX 003C 00000002 MDEIMHL 003F 00000006 MDEINITE 008B 00000005 MDEINPIP 008B 00000007 MDEINVFN 008B 00000003 MDEINVMF 008B 00000004 MDEIOACK 003C 00000006 MDEIODON 0092 MDEIOOUT 0090 MDEISESN 003C 00000007 MDEISIZE 003C 0000000C MDEISMSG 003C 00000004 MDEISNOD 003C 00000001 MDEITNOD 003C 0000000A MDELCLFL 008A MDELINST 003F MDELIST 00B0 MDELMCNT 003D MDELMDWN 003C 00000003 MDELMFRQ 003C 00000001 MDELMFRS 003C 00000002 MDELMFUN 003C MDELMHL 003F 0000000D MDELNKAD 0098 MDELNKCL 003C 0000000B MDELNKHD 0000 MDEMAIL 0008 MDEMAST 0017 04 MDEMAXER 008B 00000007 MDEMHEAD 003A MDEMHLEN 003A MDEMINFO 003C MDEMSENS 003C MDEMSGID 0038 MDENEXT 008C MDENODAD 009C MDENODES 0028 MDENODET 0020 MDENOERR 008B 00000000 MDENUMB 0018 MDEOPEN 0014 00000001 MDEOPENC 0014 00000002 MDEOPENF 0014 000000FD MDEPACCT 000C MDEPACNW 0017 10 MDEPACRQ 0017 80 MDEPACRS 0017 40 MDEPAGER 008B 00000001 MDEPASS 008A 08 MDEPLIST 0040 MDEPMHL 003C 00000006 MDEPREQ 0014 000000FE MDEPRESP 0014 000000FF MDEPTARG 008A 04 MDEPTHAD 0094 MDEPTHRS 008A 80 MDEQSRM 0014 00000005 MDEREJ 0014 00000003 MDERSPND 003C 0000000D MDESEND 0014 00000006 MDESENDC 0014 00000008 MDESEQ 0015 MDESIZE 00F8 0000002D MDESNCMP 003C 00000008 MDESNDAD 00A0 MDESPLIT 0017 08 MDESQERR 003C 00000003 MDESSESS 0034 MDETOTLN 001C MDETSESS 0030 MDETYPE 003E
This information is based on z/VM V4R2.0. Last updated on 30 Oct 2001 at 15:39:25 EDT.
Copyright IBM Corporation, 1990, 2001