EZBCTAPI NMI: Passing options to the trace formatter

The EZBYPTO macro describes a data area that can be passed using the EZBCTAPI OPTIONS keyword. This data area contains flags, values, and pointers that describe packet trace formatter options. Table 1 shows the option and field settings required to select the option.

These same options are available through the SYSTCPDA and SYSTCPOT CTRACE formatter. You can find a detailed explanation in the packet trace (SYSTCPDA) for TCP/IP stacks and OSAENTA trace (SYSTCPOT) information in z/OS Communications Server: IP Diagnosis Guide.

Table 1. Available EZBYPTO options
Option	Field setting	Field format
ASCII	Pto_Dump=1;Pto_DmpCd=PtoAscii;	Bit flag
BASIC(DETAIL)	Pto_Basic=1;Pto_BasDtl=1;	Bit flag
BASIC(SUMMARY)	Pto_Basic=1;Pto_BasDtl=0;	Bit flag
BOTH	Pto_Dump=1;Pto_DmpCd=PtoBoth;	Bit flag
CLEANUP(nnnnn)	Pto_Cleanup=1;Pto_GcIntvl=nnnnn;	Bit flag
DEVICE(list)	Pto_Device@=Addr(list);Pto_Device#=nn	List of 32-bit word pairs
DISCARD(list)	Pto_Discard@=Addr(list),Pto_Discard#=nn	List of 16-bit word pairs
DUMP	Pto_Dump=1;	Bit flag
DUMP(nnnnn)	Pto_Dump=1;Pto_MaxDmp=nnnnn;	Bit Flag; 31-bit word
EBCDIC	Pto_Dump=1;Pto_DmpCd=PtoEbcdic;	Bit flag; Value
ELEMENT(list)	Pto_Element@=Addr(list);Pto_Element=nn	List of 32-bit word pairs
ETHTYPE(list)	Pto_EthType@=Addr(list);Pto_EthType#=nn	List of 32-bit word pairs
FLAGS(flags)	Pto_Flags@=Addr(Pto_Flagss), Pto_Flags#=size(Pto_Flagss);	16 bytes of bit flag used to select packets
FLAGS(ANY\|ALL)	Pto_FlgAny=1	Select a packet that has any flags in Pto_Flagss set.
FORMAT(DETAIL)	Pto_Format=1;Pto_FmtDtl=1;	Bit flags
FORMAT(SUMMARY)	Pto_Format=1;Pto_FmtDtl=0;	Bit flags
FULL	Pto_Dump=1,Pto_Format=1,Pro_FmtDtl=1;	Bit flags
HEX	Pto_Dump=1;Pto_DmpCd=PtoHex;	Bit flags
HPRDIAG	Pto_HprSess=1;Pto_HprRpt=Pto_HprSummary;	Bit flags
INTERFACE	Pto_Links@=Addr(list),Pto_Links#=nn	List of 16-byte character strings
IPADDR(list)	Pto_Addr@=Addr(list);Pto_Addr#=nn	List of 16-byte byte IPv6 addresses
MACADDR(list)	Pto_MacAddr@=Addr(list);Pto_MacAddr#=nn	List of 6-byte Mac addresses
PORT(list)	Pto_Port@=Addr(list);Pto_Port#=nn	List of 16-bit word pairs
PROTOCOL(list)	Pto_Proto@=Addr(list);Pto_Proto#=nn	List of 32-bit word pairs
REASSEMBLY(nnnnn)	Pto_ReAsm=1;Pto_MaxRsm=nnnnn	Bit flags
REASSEMBLY(DETAIL)	Pto_ReAsm=1;Pto_RsmSum=0	Bit flags
REASSEMBLY(SUMMARY)	Pto_ReAsm=1;Pto_RsmSum=1	Bit flags
NOREASSEMBLY	Pto_ReAsm=0;	Bit flag
SEGMENT	Pto_Segment=1;	Bit flag
NOSEGMENT	Pto_Segment=0;	Bit flag
SESSION(DETAIL)	Pto_SesRpt=Pto_SesDetail; Pto_Session=1;	Bit flag
SESSION(SUMMARY)	Pto_SesRpt=Pto_SesSummary; Pto_Session=1;	Bit flag
SESSION(STATE)	Pto_SesRpt=Pto_SesState; Pto_Session=1;	Bit flag
SPEED(local,remote)	Pto_LSpeed=nnn;Pto_RSpeed=nnn	Two 32-bit words
STATISTICS(DETAIL)	Pto_Stats=1;Pto_StcSum=0;	Bit flag
STATISTICS(SUMMARY)	Pto_Stats=1;Pto_StcSum=1;	Bit flag
STREAMS(nnn)	Pto_Streams=1;Pto_StrmBuf=nnn	Bit flag
STREAMS(DETAIL)	Pto_Streams=1;Pto_StmSum=0;	Bit flag
STREAMS(SUMMARY)	Pto_Streams=1;Pto_StmSum=1;	Bit flag
SUBAREA(list)	Pto_Subarea@=Addr(list);Pto_SubArea#=nn	List of 32-bit word pairs
SUMMARY	Pto_Summary=1;	Bit flag
TCID(list)	Pto_Tcid@=Addr(list);Pto_Tcid#=nn	List of 8-byte hex strings
TH5SA(list)	Pto_Th5SA@=Addr(list);Pto_Th5SA#=nn	List of 8-byte hex strings
TALLY	Pto_Stats=1;Pto_StcSum=0;	Bit flag
VLANID(list)	Pto_VlanId@=Addr(list);Pto_VlanId#=nn	List of 32-bit word pairs

Notes:

The traced data might span multiple trace records. In this case, the related trace records are called segmented records. See Segmented trace records for more information about these trace records. When segmented records are encountered, the SEGMENT option re-creates the traced data as a single trace record. The traced data is not used until the last trace segment record is passed to the formatter. Until that time, the packet is saved in a temporary buffer. Use the NOSEGMENT option to prevent this. The CLEANUP value can be used to free the temporary buffers for segments that will not be completed. The QUIT or TERM function frees all unprocessed segments.
When the NOSEGMENT option is used, only the first segment has the IP header and protocol headers.
A packet might be fragmented. When you specify the REASSEMBLY option, the formatter saves the fragments in a temporary buffer until all the fragments have been processed to recreate the original complete packet. The packet is not used until the last trace record is passed to the formatter. The CLEANUP value frees temporary buffers that have not completed, for reassembly. The QUIT or TERM function frees all unprocessed fragments.
Use the NOREASSEMBLY option to prevent this saving of records.
If the CLEANUP value is 0, then the temporary buffers are not released until the QUIT or TERM function.
You can use the EZBYPTO options control block to request multiple reports.
Use of the EZBCTAPI TERM function creates the SESSION, STATISTICS, and STREAMS reports.
The EZBYPTO data area is not processed by the SETUP function call. The values in the data area and values pointed from the data area must remain intact until after the first FORMAT, TERM, or QUIT function call.
For packet trace records, if the first and only discard reason code in the Pto_Discard1(1) field is 65535 (X'FFFF'), then all packets with a nonzero discard reason code are selected. If one of the discard reason codes is 0, then packets that were not discarded are selected.