HISYSMPX information

HISYSMPX programming interface information

HISYSMPX is a programming interface.

HISYSMPX heading information

Common name: HIS Sampling Exit Interface
Macro ID: HISYSMPX
DSECT name: HisSmpParm HisSDB_Trailer HisSmp_GenericEntry HisSmp_Basic1Entry
Owning component: Hardware Instrumentation Services (SCHIS)
Eye-catcher ID: HisSmpParm -- NONE
HisSDB_Trailer -- NONE
HisSmp_GenericEntry -- NONE
HisSmp_Basic1Entry -- NONE
Offset:  NONE
Length:  NONE
Storage attributes: Subpool:   230 (HIS Private)
Key:       0
Residency: Above 16M line
HisSDB_Trailer/HisSmp_GenericEntry/HisSmp_Basic1Entry
Size: HisSmpParm -- X'0020' bytes
HisSDB_Trailer -- X'0040' bytes
HisSmp_GenericEntry -- X'0004' bytes
HisSmp_Basic1Entry -- X'0020' bytes
Created by: Caller
Pointed to by: HisSmpParm -- Register 1 on entry to the exit routine
HisSDB_Trailer -- Trailer of each SDB (no explicit ptr)
HisSmp_GenericEntry -- Entry within SDB (no explicit ptr)
HisSmp_Basic1Entry -- Entry within SDB (no explicit ptr)
Serialization: None
Function: Maps the parameter area and associated areas passed
into the HISSERV exit routine when the reason the
exit routine is called is to handle a sampling exit
callback.

HISYSMPX mapping

Table 1. Structure HISSMPPARM
Offset
Dec		 Offset
Hex		 Type Len Name(Dim) Description
0 (0) STRUCTURE 0 HISSMPPARM  
0 (0) CHARACTER 4  HISSMPPARM_INFO The common portion of the exit routine parameter area, mapped by DSECT HisExitParm in macro HISYEXIT.
4 (4) SIGNED 4  HISSMPPARM_SERVICESEQ The sequence number representing the sampling state of the service for when this data was provided.
8 (8) SIGNED 2  HISSMPPARM_CPUID The CPU ID these SDBs were filled by
10 (A) BITSTRING 2  HISSMPPARM_FLGS   
   Bit definitions:
      1... ....  HISSMPPARMFLGS_LAST "X'80'" This is the last sample exit that will be received from this CPU, either because a HISSERV REQUEST=PROFILE,ACTION=STOP request was made or the service is updating or is disabling. If the service is updating, sample exit callbacks will resume once the update has completed.
12 (C) SIGNED 4  HISSMPPARM_SDBLENGTH The size of each SDB
16 (10) ADDRESS 8  HISSMPPARM_FIRSTSDBADDR The address of the first SDB to be processed, if zero there are no SDBS to process.
24 (18) ADDRESS 8  HISSMPPARM_LASTSDBADDR The address of the last SDB to be processed, will be greater or equal to HisSmpParm_FirstSDBAddr
32 (20) CHARACTER 1  HISSMPPARM_END(0)  
32 (20) X'1' 0  HISSMPPARM_KVERSIONMAX "1"
32 (20) X'1' 0  HISSMPPARM_KVERSION1 "1"
32 (20) X'1' 0  HISSMPPARM_KVERSIONMIN "1"
32 (20) X'20' 0  HISSMPPARM_LEN "*-HisSmpParm"
Table 2. Structure HISSDB_TRAILER
Offset
Dec		 Offset
Hex		 Type Len Name(Dim) Description
0 (0) STRUCTURE 0 HISSDB_TRAILER  
0 (0) CHARACTER 16  HISSDBTRAILER0_15  
0 (0) CHARACTER 1  HISSDBTRAILER_CTL   
   Bit definitions:
      1... ....  HISSDBTRAILER_FULL "X'80'" Block full indicator
      ..1. ....  HISSDBTRAILER_FULLTODASSTCKE
      "X'20'" Timestamp format, when ON, HisSDBTrailer_FullTOD contains the full timestamp in STCKE format. When OFF, HisSDBTrailer_FullTOD_Low contains the full timestamp in STCK format.
1 (1) CHARACTER 3  
4 (4) SIGNED 2  HISSDBTRAILER_BSDES Basic sample data entry size in bytes
6 (6) SIGNED 2  HISSDBTRAILER_DSDES Diagnostic sampling data entry size in bytes
8 (8) SIGNED 8  HISSDBTRAILER_OVERFLOWCOUNT
          Number of sampling entries written into this SDB when the SDB is already indicated as full (HisSDBTrailer_Full is one)
16 (10) CHARACTER 16  HISSDBTRAILER_FULLTOD The TOD clock value at the time the SDB became full, in STCKE format. Use when HisSDBTrailer_FullTODAsSTCKE is on
16 (10) CHARACTER 8  HISSDBTRAILER_FULLTOD_HIGH  
24 (18) CHARACTER 8  HISSDBTRAILER_FULLTOD_LOW The TOD clock value at the time the SDB became full, in STCK format. Use when HisSDBTrailer_FullTODAsSTCKE is off
32 (20) CHARACTER 16  
48 (30) CHARACTER 16  HISSDBTRAILER_USERAREA User control area used by the service
48 (30) ADDRESS 8  HISSDBTRAILERUSER_VIRTBUFPTR
          Virtual address of the SDB this trailer is a part of
64 (40) CHARACTER 1  HISSDBTRAILER_END(0)  
64 (40) X'40' 0  HISSDBTRAILER_KLENGTH "64"
64 (40) X'40' 0  HISSDB_TRAILER_LEN "*-HisSDB_Trailer"
Table 3. Structure HISSMP_GENERICENTRY
Offset
Dec		 Offset
Hex		 Type Len Name(Dim) Description
0 (0) STRUCTURE 0 HISSMP_GENERICENTRY  
0 (0) CHARACTER 2  HISSMPGENERICENTRY_FORMAT The type of sampling entry being looked at. Can be one of the the HisSmpEntryFormat* equates.
2 (2) CHARACTER 2  HISSMPGENERICENTRY_CTL  
2 (2) BITSTRING 1  HISSMPGENERICENTRYCTL_BYTE0
3 (3) BITSTRING 1  HISSMPGENERICENTRYCTL_BYTE1 
   Bit definitions:
      .... ...1  HISSMPGENERICENTRY_INVALID "X'01'" Whether this sampling entry is invalid.
4 (4) CHARACTER 1  HISSMPGENERICENTRY_END(0)  
      .... ....  HISSMPENTRYFORMAT_KNONE "X'0000'"
4 (4) BITSTRING 0  HISSMPENTRYFORMAT_KDIAG1 "X'8001'"
4 (4) BITSTRING 0  HISSMPENTRYFORMAT_KDIAG2 "X'8002'"
4 (4) BITSTRING 0  HISSMPENTRYFORMAT_KDIAG3 "X'8003'"
4 (4) BITSTRING 0  HISSMPENTRYFORMAT_KDIAG4 "X'8004'"
4 (4) BITSTRING 0  HISSMPENTRYFORMAT_KDIAG5 "X'8005'"
4 (4) BITSTRING 0  HISSMPENTRYFORMAT_KDIAG6 "X'8006'"
4 (4) BITSTRING 0  HISSMPENTRYFORMAT_KDIAG7 "X'8007'"
4 (4) X'40' 0  HISSMPENTRYLENGTH_KDIAG1 "64"
4 (4) X'4A' 0  HISSMPENTRYLENGTH_KDIAG2 "74"
4 (4) X'55' 0  HISSMPENTRYLENGTH_KDIAG3 "85"
4 (4) X'70' 0  HISSMPENTRYLENGTH_KDIAG4 "112"
4 (4) X'9F' 0  HISSMPENTRYLENGTH_KDIAG5 "159"
4 (4) X'A5' 0  HISSMPENTRYLENGTH_KDIAG6 "165"
4 (4) X'AD' 0  HISSMPENTRYLENGTH_KDIAG7 "173"
4 (4) X'4' 0  HISSMP_GENERICENTRY_LEN "*-HisSmp_GenericEntry"
Table 4. Structure HISSMP_BASIC1ENTRY
Offset
Dec		 Offset
Hex		 Type Len Name(Dim) Description
0 (0) STRUCTURE 0 HISSMP_BASIC1ENTRY  
0 (0) CHARACTER 2  HISSMPBASIC1ENTRY_FORMAT Format code of the data entry, should be equal to HisSmpEntryFormat_kBasic1
2 (2) CHARACTER 1  HISSMPBASIC1ENTRY_STATE1   
   Bit definitions:
      .... 1111  HISSMPBASIC1ENTRY_UNIQUEINSTR
      "X'0F'" The number of unique instructions simultaneously executing during this sample.
3 (3) CHARACTER 1  HISSMPBASIC1ENTRY_STATE2   
   Bit definitions:
      ..1. ....  HISSMPBASIC1ENTRY_DAT "X'20'" DAT mode bit of PSW
      ...1 ....  HISSMPBASIC1ENTRY_WAIT "X'10'" Wait state bit of PSW
      .... 1...  HISSMPBASIC1ENTRY_PROBLEM "X'08'" Problem state bit of PSW
      .... .11.  HISSMPBASIC1ENTRY_ASC "X'06'" Address-space control of PSW
      .... ...1  HISSMPBASIC1ENTRY_INVALID "X'01'" Indicates entry is invalid
4 (4) CHARACTER 1  HISSMPBASIC1ENTRY_STATE3   
   Bit definitions:
      11.. ....  HISSMPBASIC1ENTRY_CONFIGLEVEL
      "X'C0'" Configuration Level of the CPU during sample cycle. '10'b indicates virtual machine level '01'b indicates LPAR (logical partition) level '00'b and '11'b are reserved
      ..1. ....  HISSMPBASIC1ENTRY_ISHOST "X'20'" Host Indicator - On when the basic-sampling data entry (BSDE) is stored to sample-data blocks (SDB) established by a control program run at the logical partition level. Value is not meaningful when HisSmpBasic1Entry_ConfigLevel is '00'b
5 (5) CHARACTER 1  
6 (6) SIGNED 2  HISSMPBASIC1ENTRY_PASN Primary ASN from control register 4
8 (8) ADDRESS 8  HISSMPBASIC1ENTRY_INSTRADDR
          The address of the instruction being executed.
16 (10) CHARACTER 8  HISSMPBASIC1ENTRY_GPP The program parameter most recently set by the CPU at the virtual machine level (the guest OS).
24 (18) CHARACTER 8  HISSMPBASIC1ENTRY_HPP The program parameter most recently set by the CPU at the logical partition level (the host OS).
32 (20) CHARACTER 1  HISSMPBASIC1ENTRY_END(0)  
      .... ...1  HISSMPENTRYFORMAT_KBASIC1 "X'0001'"
32 (20) X'20' 0  HISSMPENTRYLENGTH_KBASIC1 "32"
32 (20) X'20' 0  HISSMP_BASIC1ENTRY_LEN "*-HisSmp_Basic1Entry"
Table 5. Cross Reference for HISYSMPX
Name Offset Hex Tag
HISSDB_TRAILER 0
HISSDB_TRAILER_LEN 40 40
HISSDBTRAILER_BSDES 4
HISSDBTRAILER_CTL 0
HISSDBTRAILER_DSDES 6
HISSDBTRAILER_END 40
HISSDBTRAILER_FULL 0 80
HISSDBTRAILER_FULLTOD 10
HISSDBTRAILER_FULLTOD_HIGH 10
HISSDBTRAILER_FULLTOD_LOW 18
HISSDBTRAILER_FULLTODASSTCKE 0 20
HISSDBTRAILER_KLENGTH 40 40
HISSDBTRAILER_OVERFLOWCOUNT 8
HISSDBTRAILER_USERAREA 30
HISSDBTRAILERUSER_VIRTBUFPTR 30
HISSDBTRAILER0_15 0
HISSMP_BASIC1ENTRY 0
HISSMP_BASIC1ENTRY_LEN 20 20
HISSMP_GENERICENTRY 0
HISSMP_GENERICENTRY_LEN 4 4
HISSMPBASIC1ENTRY_ASC 3 6
HISSMPBASIC1ENTRY_CONFIGLEVEL 4 C0
HISSMPBASIC1ENTRY_DAT 3 20
HISSMPBASIC1ENTRY_END 20
HISSMPBASIC1ENTRY_FORMAT 0
HISSMPBASIC1ENTRY_GPP 10
HISSMPBASIC1ENTRY_HPP 18
HISSMPBASIC1ENTRY_INSTRADDR 8
HISSMPBASIC1ENTRY_INVALID 3 1
HISSMPBASIC1ENTRY_ISHOST 4 20
HISSMPBASIC1ENTRY_PASN 6
HISSMPBASIC1ENTRY_PROBLEM 3 8
HISSMPBASIC1ENTRY_STATE1 2
HISSMPBASIC1ENTRY_STATE2 3
HISSMPBASIC1ENTRY_STATE3 4
HISSMPBASIC1ENTRY_UNIQUEINSTR 2 F
HISSMPBASIC1ENTRY_WAIT 3 10
HISSMPENTRYFORMAT_KBASIC1 20 1
HISSMPENTRYFORMAT_KDIAG1 4 8001
HISSMPENTRYFORMAT_KDIAG2 4 8002
HISSMPENTRYFORMAT_KDIAG3 4 8003
HISSMPENTRYFORMAT_KDIAG4 4 8004
HISSMPENTRYFORMAT_KDIAG5 4 8005
HISSMPENTRYFORMAT_KDIAG6 4 8006
HISSMPENTRYFORMAT_KDIAG7 4 8007
HISSMPENTRYFORMAT_KNONE 4 0
HISSMPENTRYLENGTH_KBASIC1 20 20
HISSMPENTRYLENGTH_KDIAG1 4 40
HISSMPENTRYLENGTH_KDIAG2 4 4A
HISSMPENTRYLENGTH_KDIAG3 4 55
HISSMPENTRYLENGTH_KDIAG4 4 70
HISSMPENTRYLENGTH_KDIAG5 4 9F
HISSMPENTRYLENGTH_KDIAG6 4 A5
HISSMPENTRYLENGTH_KDIAG7 4 AD
HISSMPGENERICENTRY_CTL 2
HISSMPGENERICENTRY_END 4
HISSMPGENERICENTRY_FORMAT 0
HISSMPGENERICENTRY_INVALID 3 1
HISSMPGENERICENTRYCTL_BYTE0 2
HISSMPGENERICENTRYCTL_BYTE1 3
HISSMPPARM 0
HISSMPPARM_CPUID 8
HISSMPPARM_END 20
HISSMPPARM_FIRSTSDBADDR 10
HISSMPPARM_FLGS A
HISSMPPARM_INFO 0
HISSMPPARM_KVERSIONMAX 20 1
HISSMPPARM_KVERSIONMIN 20 1
HISSMPPARM_KVERSION1 20 1
HISSMPPARM_LASTSDBADDR 18
HISSMPPARM_LEN 20 20
HISSMPPARM_SDBLENGTH C
HISSMPPARM_SERVICESEQ 4
HISSMPPARMFLGS_LAST A 80