|
Programming Interface Information:
This information is NOT
intended to be
used as Programming Interfaces of VM/ESA. It is to be used for diagnosis only. |
MSGBK
Cross Reference (Contains links to field and bit definitions)
MSGBK Prolog
NAME : HCPMSGBK
DESCRIPTION: MESSAGE BLOCK MAPPING MACRO
STATUS : VM/ESA Version 2, Release 3.0
DSECT : MSGBK
FUNCTION : TO HOLD IUCV MESSAGE INFORMATION THROUGH THE
COMPLETE MESSAGE CYCLE.
LOCATED BY : THE FOLLOWING FIELDS IN HCPCCTBK:
CCTSNDHD - WHEN ON SEND QUEUE
CCTRCVHD - WHEN ON RECEIVE QUEUE
CCTRPYHD - WHEN ON REPLY QUEUE
THE ALLOCATE MSGBK CREATED BY THE APPCVM CONNECT
FUNCTION (HCPIUP) IS CONTAINED WITHIN CONBK.
THE PIP DATA MSGBK CREATED BY THE APPCVM CONNECT
FUNCTION (HCPIUP) IS CHAINED FROM THE MSGFPNT FIELD
OF THE ALLOCATE MSGBK.
CREATED BY : IUCV SEND FUNCTION (HCPIUWSE)
APPCVM CONNECT FUNCTION (HCPIUP)
APPC SEND/RECIEVE FUNCTION (HCPIUNSR)
DELETED BY : IUCV RECEIVE FUNCTION (HCPIUDRC)
IUCV REPLY FUNCTION (HCPIUHRP)
IUCV TEST COMPLETE FUNCTION (HCPIUCTC)
SEVER FUNCTION (PIP MSGBK) (HCPIUL )
APPC SEND/RECIEVE FUNCTION (HCPIUNSR)
NOTES : THIS COPY FILE REQUIRES THE FOLLOWING IN ORDER TO
GENERATE PROPERLY:
- IPARML
MSGBK Control Block Content
MSGBK DSECT
Hex Dec Type/Val Lng Label (dup) Comments ---- ---- --------- ---- -------------- -------- 0000 0 Structure MSGBK MESSAGE BLOCK MAPPING MACRO 0000 0 Address 4 MSGFPNT POINTER TO NEXT MESSAGE BLOCK 0004 4 Bitstring 1 MSGKEY STORAGE PROTECT KEY FOR BUFFERS 0005 5 Bitstring 1 MSGFLAGS STATUS 1... .... MSGPRMD X'80' MESSAGE IN THE PARAMETER LIST .1.. .... MSGPARTL X'40' MESSAGE PARTIALLY RECEIVED ..1. .... MSGPRTY X'20' PRIORITY MESSAGE OR REPLY ...1 .... MSGNORPY X'10' ONE WAY PROTOCOL .... 1... MSGPURGE X'08' MESSAGE HAS BEEN PURGED X'04' IS RESERVED FOR MSGNOFL (SP) MSGNOFL EQU X'04' MESSAGE SENT TO QDROP OFF TARGET .... ..1. MSGDESC X'02' MESSAGE HAS BEEN DESCRIBED .... ...1 MSGCCSSN X'01' MESSAGE SENT BY *CCS 000000B0 MSGMASK1 MSGPRMD+MSGPRTY+MSGNORPY USER OPTION MASK 00000030 MSGMASK2 IPNLUWOK+IPRESYNC APPC OPTION MASK 0006 6 Bitstring 1 MSGFLAG2 1... .... MSGAPPC X'80' INDICATES APPC/VM MSGBK .1.. .... MSGBLIST X'40' INDICATES BUFFER LIST OPTION EQU X'20' RESERVED ...1 .... MSGSKEEP X'10' KEEP=YES SPECIFIED ON SEVER .... 1... MSGALIST X'08' INDICATES ANSWER LIST OPTION EQU X'04' RESERVED EQU X'02' RESERVED FOR IPSYNCFL USE EQU X'01' RESERVED 0007 7 Bitstring 1 MSGFLAG3 1... .... MSGFLSRC X'80' FLUSH SPECIFIED BY SOURCE .1.. .... MSGFLTRG X'40' FLUSH SPECIFIED BY PARTNER ..1. .... MSGLDSRC X'20' LOG_DATA SENT BY SOURCE ...1 .... MSGLDTRG X'10' LOG_DATA SENT BY PARTNER .... 1... MSGDATMV X'08' DATA WAS MOVED INTO RECEIVE AREA .... .1.. MSGCTLS X'04' MESSAGE SENT ON CONTROL PATH .... ..1. MSGCTLT X'02' MESSAGE SENT TO CONTROL PATH MSGUSED EQU X'01' PERMANENT MSGBK IN USE (SP) 0008 8 Signed 4 MSGID (0) UNIQUE MESSAGE ID 0008 8 Bitstring 2 MSGERROR ERROR/SEVER CODE 000A 10 Bitstring 1 MSGWHTRC FUNCTION THAT COMPLETED THE SEND 000B 11 Bitstring 1 MSGSNDOP FUNCTION THAT INITIATED THE SEND 000C 12 Signed 4 MSGTAG (0) MESSAGE TAG 000C 12 Bitstring 1 MSGWTRC2 SYNCPT CONTROL MODIFIER RECEIVED 000D 13 Bitstring 1 MSGSNDO2 SYNCPT CONTROL MODIFIER INITIATED 000E 14 Bitstring 2 * RESERVED 0010 16 Signed 4 MSGSCCLS (0) SOURCE MESSAGE CLASS 0010 16 Signed 2 MSGTKNLN HEADER TOKEN LENGTH FOR PARSE 0012 18 Bitstring 2 MSGTOKEN CURRENT PARSED GDS TOKEN 0014 20 Bitstring 1 MSGFLAG4 (0) STATUS 1... .... MSGGDSHD X'80' PIP VARIABLE GDS PARSED .1.. .... MSGFLSDR X'40' FLUSH ISSUED FROM DEFER_RECEIVED IPNLUWOK, IPURGBKR, IPRESYNC, IPSYNCFL AND IPFREPTH ARE DEFINED IN IPARML. THIS WAS DONE TO KEEP BOTH THE IPARML AND MSGBK CONSISTENT WITH EACH OTHER. BOTH IPARML AND MSGBK HAVE THE SAME MEANING FOR THESE FIVE FIELDS. IPNLUWOK EQU X'20' SENDER OF FORGET SUPPORTS SENDLU IPURGBKR EQU X'20' SEVER PURGED BKOUT_REQ INTERRUPT IPRESYNC EQU X'10' INVOKER SPECIFIED RESYNC=YES .... 1... MSGSYNCL X'08' LODGATA SENT DURING SYNCPT EQU X'04' RESERVED IPSYNCFL EQU X'02' SEVER ISSUED DURING SYNCPT IPFREPTH EQU X'01' SEVER ISSUED TO FREE UP PATH ID 0014 20 Signed 4 MSGTGCLS TARGET MESSAGE CLASS 0018 24 Bitstring 8 MSGPRM (0) PARAMETER LIST DATA 0018 24 Address 4 MSGSNDAD SEND BUFFER ADDRESS 001C 28 Signed 4 MSGSNDLN SEND BUFFER LENGTH 0020 32 Address 4 MSGANSAD ANSWER BUFFER ADDRESS 0024 36 Signed 4 MSGANSLN ANSWER BUFFER LENGTH 0028 40 Signed 2 MSGSCPID SOURCE PATH ID 002A 42 Signed 2 MSGTGPID TARGET PATH ID 002C 44 Bitstring 4 MSGAUDIT (0) AUDIT TRAIL FOR THIS MESSAGE 002C 44 Bitstring 1 MSGAUDT1 AUDIT TRAIL BYTE 1 1... .... MSGARPLE X'80' REPLY TOO LONG FOR BUFFER .1.. .... MSGASNPX X'40' PROTECTION EXCEPTION ON SEND BUFF ..1. .... MSGASNAX X'20' ADDRESSING EXCEPTION ON SEND BUFF ...1 .... MSGAANPX X'10' PROTECTION EXCEPT ON ANSWER BUFF .... 1... MSGAANAX X'08' ADDRESSING EXCEPT ON ANSWER BUFF .... .1.. MSGARJCT X'04' MESSAGE WAS REJECTED .... ..1. MSGAPRMD X'02' REPLY SENT IN PARAMETER LIST .... ...1 MSGAPGNR X'01' MESSAGE PURGED ON SEND OR RECEIVE QUEUE 002D 45 Bitstring 1 MSGAUDT2 AUDIT TRAIL BYTE 2 1... .... MSGARCPX X'80' PROTECTION EXCEPT ON RECEIVE BUFF .1.. .... MSGARCAX X'40' ADDRESSING EXCEPT ON RECEIVE BUFF ..1. .... MSGARPPX X'20' PROTECTION EXCEPT ON REPLY BUFF ...1 .... MSGARPAX X'10' ADDRESSING EXCEPT ON REPLY BUFF .... 1... MSGASVRD X'08' PATH WAS SEVERED .... .1.. MSGARLST X'04' INVALID RECEIVE/REPLY LIST 002E 46 Bitstring 1 MSGAUDT3 AUDIT TRAIL BYTE 3 1... .... MSGABLEN X'80' BAD LENGTH IN SEND BUFFER LIST .1.. .... MSGAALEN X'40' Invalid SEND / ANSWER bufferlist such as bad address or length ..1. .... MSGABTOT X'20' Invalid total send buffer length ...1 .... MSGAATOT X'10' Invalid total send answer length .... 1... MSGATINV X'08' INVALID LRECL IN PARTNER'S DATA .... .1.. MSGAIINV X'04' INVALID LRECL IN YOUR DATA .... ..1. MSGATTRN X'02' LOGICAL RECORD TRUNCATION BY PARTNER .... ...1 MSGAITRN X'01' LOGICAL RECORD TRUNCATION BY YOU 002F 47 Bitstring 1 MSGASYRC ASYNCHRONOUS RETURN CODE 00000001 IPRCNPTH 1 INVALID PATH ID 00000002 IPRCNSND 2 PATH QUIESCED - NO SENDS ALLOWED Notes : IPRCNSND will also be issued if, during SEND processing, it is determined that the Target has severed the path or a SEVER is in progress. 00000003 IPRCMSCT 3 MESSAGE LIMIT EXCEEDED 00000004 IPRCNPTY 4 PRTY MESSAGES NOT ALLOWED ON PATH 00000005 IPRCRCVS 5 BUFFER TOO SHORT FOR MESSAGE 00000006 IPRCPRTC 6 FETCH PROTECTION EXCEPTION 00000007 IPRCADRC 7 ADDRESSING EXCEPTION 00000008 IPRCNODT 8 MSGID FND, BUT CLASS/PATH INVALID 00000009 IPRCPRGD 9 MESSAGE HAS BEEN PURGED 0000000A IPRCMSLN 10 MESSAGE LENGTH NEGITIVE 0000000B IPRCNLOG 11 TARGET IS NOT LOGGED ON 0000000C IPRCNTRG 12 TARGET HAS NOT DECLARED A BUFFER 0000000D IPRC2MYI 13 INVOKER MAX CONNECTIONS EXCEEDED 0000000E IPRC2MYT 14 TARGET MAX CONNECTIONS EXCEEDED 0000000F IPRCBADR 15 NOT AUTHORIZED TO CONNECT TO TARG 00000010 IPRCINSV 16 INVALID CP SYSTEM SERVICE NAME 00000011 IPRCBDFN 17 INVALID FUNCTION CODE 00000012 IPRCBDLM 18 INVALID MSGLIMIT 00000013 IPRCHSBF 19 ALREADY HAS DECLARED A BUFFER 00000014 IPRCPTSV 20 PATH HAS BEEN SEVERED 00000015 IPRCNPRM 21 PARAM. LIST MESSAGE NOT ALLOWED 00000016 IPRCSLST 22 SEND LIST INVALID 00000017 IPRCNLEN 23 NEGATIVE LENGTH IN LIST 00000018 IPRCTLEN 24 TOTAL LENGTH IS NOT LIST LENGTH INVALID TOTAL LIST LENGTH 00000019 IPRCPLST 25 PRMMSG & BUF/ANSLIST NOT ALLOWED 0000001A IPRCBBND 26 BUFFER LIST NOT D-WORD ALIGNED 0000001B IPRCABND 27 ANSWER LIST NOT D-WORD ALIGNED 0000001C IPRCNCTL 28 NO CONTROL BUFFER EXISTS 0000001D IPRCCSRV 29 NOT AUTHORIZED AS COMM. SERVER 0000001E IPRCNAPP 30 APPC FUNCTION ON AN IUCV PATH 0000001F IPRCAPPC 31 APPC PATH TRIED AN IUCV ONLY FUNC 00000020 IPRCCONN 32 INVALID FUNC. FROM CONNECT STATE 00000021 IPRCSEND 33 INVALID FUNC. FROM SEND STATE 00000022 IPRCRECV 34 INVALID FUNC. FROM RECEIVE STATE 00000023 IPRCCONF 35 INVALID FUNC. FROM CONFIRM STATE 00000024 IPRCSEVR 36 INVALID FUNC. FROM SEVER STATE 00000025 IPRCSYNC 37 CONN. ESTABLISHED SYNCLVL=NONE 00000026 IPRCSNOP 38 INV. SEND FUNC. CODE (IPSENDOP) 00000027 IPRCCENL 39 INV. CONNECTION EXTENSION LEN. 00000028 IPRCLUNM 40 INVALID LU_NAME SPECIFIED 00000029 IPRCMODE 41 INVALID MODE NAME SPECIFIED 0000002A IPRCIRLN 42 INVOKER HAD INVALID LOGICAL RECORD LENG 0030 48 Bitstring 1 MSGFLAG9 STATUS 1... .... MSGSVEND X'80' SVM TRANSACTION END .1.. .... MSGAPPCP X'40' Message may be purged ..1. .... MSGDWRAP X'20' INDICATE INVOKE HCPDWRAP EQU X'10' RESERVED EQU X'08' RESERVED EQU X'04' RESERVED .... ..1. MSGDELAY X'02' Drive CSS msg complete on PURGE .... ...1 MSGCLONE X'01' THIS IS A CLONED MSGBK 0031 49 Bitstring 3 * RESERVED 0034 52 Signed 4 * RESERVED 00000007 MSGSIZE (*-MSGBK+7)/8 MSGBK SIZE IN DOUBLEWORDS
MSGBK Storage Layout
*** MSGBK - MESSAGE BLOCK MAPPING MACRO * * +---------------------------+------+------+------+------+ * 0 | MSGFPNT |MSGKEY|:FLAGS|:FLAG2|:FLAG3| * +-------------+------+------+------+------+------+------+ * 8 | MSGERROR |:WHTRC|:SNDOP|:WTRC2|:SNDO2|/////////////| * +-------------+------+------+------+------+-------------+ * 10 | MSGTKNLN | MSGTOKEN | MSGTGCLS | * +-------------+-------------+---------------------------+ * 18 | MSGSNDAD | MSGSNDLN | * +---------------------------+---------------------------+ * 20 | MSGANSAD | MSGANSLN | * +-------------+-------------+------+------+------+------+ * 28 | MSGSCPID | MSGTGPID |:AUDT1|:AUDT2|:AUDT3|:ASYRC| * +------+------+-------------+------+------+------+------+ * 30 |:FLAG9|////////////////////|///////////////////////////| * +------+--------------------+---------------------------+ * 38 * *** MSGBK - MESSAGE BLOCK MAPPING MACRO
MSGBK Cross Reference
(contains links to field and bit definitions)Symbol Dspl Value -------------- ---- -----IPRCABND 002F 0000001B
IPRCADRC 002F 00000007
IPRCAPPC 002F 0000001F
IPRCBADR 002F 0000000F
IPRCBBND 002F 0000001A
IPRCBDFN 002F 00000011
IPRCBDLM 002F 00000012
IPRCCENL 002F 00000027
IPRCCONF 002F 00000023
IPRCCONN 002F 00000020
IPRCCSRV 002F 0000001D
IPRCHSBF 002F 00000013
IPRCINSV 002F 00000010
IPRCIRLN 002F 0000002A
IPRCLUNM 002F 00000028
IPRCMODE 002F 00000029
IPRCMSCT 002F 00000003
IPRCMSLN 002F 0000000A
IPRCNAPP 002F 0000001E
IPRCNCTL 002F 0000001C
IPRCNLEN 002F 00000017
IPRCNLOG 002F 0000000B
IPRCNODT 002F 00000008
IPRCNPRM 002F 00000015
IPRCNPTH 002F 00000001
IPRCNPTY 002F 00000004
IPRCNSND 002F 00000002
IPRCNTRG 002F 0000000C
IPRCPLST 002F 00000019
IPRCPRGD 002F 00000009
IPRCPRTC 002F 00000006
IPRCPTSV 002F 00000014
IPRCRCVS 002F 00000005
IPRCRECV 002F 00000022
IPRCSEND 002F 00000021
IPRCSEVR 002F 00000024
IPRCSLST 002F 00000016
IPRCSNOP 002F 00000026
IPRCSYNC 002F 00000025
IPRCTLEN 002F 00000018
IPRC2MYI 002F 0000000D
IPRC2MYT 002F 0000000E
MSGAALEN 002E 40
MSGAANAX 002C 08
MSGAANPX 002C 10
MSGAATOT 002E 10
MSGABLEN 002E 80
MSGABTOT 002E 20
MSGAIINV 002E 04
MSGAITRN 002E 01
MSGALIST 0006 08
MSGANSAD 0020
MSGANSLN 0024
MSGAPGNR 002C 01
MSGAPPC 0006 80
MSGAPPCP 0030 40
MSGAPRMD 002C 02
MSGARCAX 002D 40
MSGARCPX 002D 80
MSGARJCT 002C 04
MSGARLST 002D 04
MSGARPAX 002D 10
MSGARPLE 002C 80
MSGARPPX 002D 20
MSGASNAX 002C 20
MSGASNPX 002C 40
MSGASVRD 002D 08
MSGASYRC 002F
MSGATINV 002E 08
MSGATTRN 002E 02
MSGAUDIT 002C
MSGAUDT1 002C
MSGAUDT2 002D
MSGAUDT3 002E
MSGBLIST 0006 40
MSGCCSSN 0005 01
MSGCLONE 0030 01
MSGCTLS 0007 04
MSGCTLT 0007 02
MSGDATMV 0007 08
MSGDELAY 0030 02
MSGDESC 0005 02
MSGDWRAP 0030 20
MSGERROR 0008
MSGFLAGS 0005
MSGFLAG2 0006
MSGFLAG3 0007
MSGFLAG4 0014
MSGFLAG9 0030
MSGFLSDR 0014 40
MSGFLSRC 0007 80
MSGFLTRG 0007 40
MSGFPNT 0000
MSGGDSHD 0014 80
MSGID 0008
MSGKEY 0004
MSGLDSRC 0007 20
MSGLDTRG 0007 10
MSGMASK1 0005 000000B0
MSGMASK2 0005 00000030
MSGNORPY 0005 10
MSGPARTL 0005 40
MSGPRM 0018
MSGPRMD 0005 80
MSGPRTY 0005 20
MSGPURGE 0005 08
MSGSCCLS 0010
MSGSCPID 0028
MSGSIZE 0034 00000007
MSGSKEEP 0006 10
MSGSNDAD 0018
MSGSNDLN 001C
MSGSNDOP 000B
MSGSNDO2 000D
MSGSVEND 0030 80
MSGSYNCL 0014 08
MSGTAG 000C
MSGTGCLS 0014
MSGTGPID 002A
MSGTKNLN 0010
MSGTOKEN 0012
MSGWHTRC 000A
MSGWTRC2 000C
Last updated on 3 Aug 1999 at 12:15:25 EDT.
Copyright IBM Corporation, 1990, 1999