SORPL Back to Index page
 
Prolog 
Control Block Contents 
   SORPL DSECT
   SORWA DSECT
Storage Layout 
Cross Reference (Contains links to field and bit definitions)
Programming Interface Information:
This information is NOT intended to be
used as Programming Interfaces of z/VM.


  SORPL Prolog Top of page
 
 NAME       : HCPSORPL
 DESCRIPTION: Quicksort Parameter List
 DSECT      : SORPL and SORWA
 FUNCTION   : SORPL provides an interface definition for the HCPSORTL
              and HCPSORML entry points, which are used to sort a list
              of entries.
 LOCATED BY : Pointers maintained by the routine that created it.
 CREATED BY : Routines that call HCPSORTL or HCPSORML to sort a list of
              entries.
 DELETED BY : The routine that created it.
 REFERENCES : None.
 SERIALIZED : Serialization of fields is the responsibility of the
              creating routine.
 RELOCATION CONSIDERATIONS : Relocation considerations are the responsibility of
              the creating routine. If there are relocation
              considerations, they must be documented in a
              higher level control block containing this
              structure or a pointer to this structure.
 COMPATIBILITY AND MIGRATION CONCERNS : N/A
 NOTES      : To obtain storage for an SORPL structure, use
              HCPGETST LEN=(dwct) where dwct = SORHSIZ+(SOREntLn+7)/8
 
 
  SORPL Control Block Content Top of page
 

 SORPL DSECT Top of page
Hex Dec Type/Val Lng Label (dup) Comments ---- ---- --------- ---- -------------- -------- 0000 0 Structure SORPL Quicksort Parameter List Input fields. 0000 0 Address 4 SORArray Pointer to contiguous array of entries 0004 4 Signed 4 SOREntCt Number of entries in the array SOREntCt SOREntCtMx 100000 SOREntCtMx - Maximum of 100,000 entries sorted 0008 8 Signed 2 SOREntLn Length of each entry in bytes. - Must be a multiple of 4. 00000100 SOREntLnMx 256 - Maximum of 256 byte entries 000A 10 Signed 2 SOROffst Offset to sort field in an entry - Must be a multiple of 4. 000C 12 Signed 2 SORFldLn Length of sort field. - Must be 4 or 8. 000E 14 Bitstring 1 SOROrder Sort direction 000F 15 Bitstring 1 SORFlag Processing flags Output fields. 0010 16 Address 4 SORMin Position of latest entry guaranteed to be sorted when return code = 4. Fields used by HCPSORTL routine. 0014 20 Signed 4 SORRecur Count of times the array was subdivided and subsets sorted. 0018 24 Address 4 SORSubNxt Pointer to next available slot 001C 28 Signed 4 SORSubCt Number of subsets left to be sorted 00000004 SORHSIZ (*-SORPL+7)/8 Header size in double words 00000020 SORHBSIZ SORHSIZ*8 Header size in bytes 0020 32 Bitstring 1 SORWork Variable sized work area, actually SOREntLn in length 00000021 SOR$END * End of the SORPL structure SORWA is used to map the chain of pages for the HCPSORTL or HCPSORML work area. It is provided in R0 when those routines are called.
 SORWA DSECT Top of page
Hex Dec Type/Val Lng Label (dup) Comments ---- ---- --------- ---- -------------- -------- 0000 0 Structure SORWA Quicksort Parameter List 0000 0 Address 4 SORWAPrv Address of previous work area page 0004 4 Address 4 SORWANxt Address of next work area page 00000008 SORWAHL *-SORWA Length of chain fields 0008 8 Bitstring 4088 SORWAPge Remainder of work area page End of the SORPL and SORWA DSECTs. HCPSORTL Return Codes. 00000000 SORRCOK 0 Success 00000004 SORRCWrn 4 Warning - partial sort 0000000C SORRCErr 12 Error - invalid input parameter
 
 
  SORPL Storage Layout Top of page
 
          
*** SORPL - Quicksort Parameter List
*
*     +---------------------------+---------------------------+
*   0 |         SORARRAY          |         SORENTCT          |
*     +-------------+-------------+-------------+------+------+
*   8 |  SORENTLN   |  SOROFFST   |  SORFLDLN   |:ORDER|:FLAG |
*     +-------------+-------------+-------------+------+------+
*  10 |          SORMIN           |         SORRECUR          |
*     +---------------------------+---------------------------+
*  18 |        SORSUBNXT          |         SORSUBCT          |
*     +------+--------------------+---------------------------+
*  20 |:WORK | 21
*     +------+
*
*** SORPL - Quicksort Parameter List
          
*** SORWA - Quicksort Parameter List
*
*     +---------------------------+---------------------------+
*   0 |         SORWAPRV          |         SORWANXT          |
*     +---------------------------+---------------------------+
*   8 |                                                       |
*     =                       SORWAPGE                        =
*     |                                                       |
*     +-------------------------------------------------------+
*1000
*
*** SORWA - Quicksort Parameter List
 
 
  SORPL Cross Reference Top of page
 
 
Symbol         Dspl Value
-------------- ---- -----
SOR$END        0020 00000021
SORArray       0000
SOREntCt       0004
SOREntCtMx     0004 SOREntCt
SOREntLn       0008
SOREntLnMx     0008 00000100
SORFlag        000F
SORFldLn       000C
SORHBSIZ       001C 00000020
SORHSIZ        001C 00000004
SORMin         0010
SOROffst       000A
SOROrder       000E
SORRecur       0014
SORRCErr       0008 0000000C
SORRCOK        0008 00000000
SORRCWrn       0008 00000004
SORSubCt       001C
SORSubNxt      0018
SORWork        0020
SORWAHL        0004 00000008
SORWANxt       0004
SORWAPge       0008
SORWAPrv       0000
 
This information is based on z/VM 7.2.0 Last updated on 24 Jun 2020 at 09:30:40 EDT.
Copyright IBM Corporation, 1990, 2020