Sort/Merge Programming Guide - Public Support Login - Unisys

OS 2200 

Sort/Merge 

Programming Guide 

ClearPath OS 2200 Release 12.1 

June 2010 7831 0687–010 

unisys 

imagine it. done.

NO WARRANTIES OF ANY NATURE ARE EXTENDED BY THIS DOCUMENT. Any product or related information 

described herein is only furnished pursuant and subject to the terms and conditions of a duly executed agreement to 

purchase or lease equipment or to license software. The only warranties made by Unisys, if any, with respect to the 

products described in this document are set forth in such agreement. Unisys cannot accept any financial or other 

responsibility that may be the result of your use of the information in this document or software material, including 

direct, special, or consequential damages. 

You should be very careful to ensure that the use of this information and/or software material complies with the laws, 

rules, and regulations of the jurisdictions with respect to which it is used. 

The information contained herein is subject to change without notice. Revisions may be issued to advise of such 

changes and/or additions. 

Notice to U.S. Government End Users: This is commercial computer software or hardware documentation developed at 

private expense. Use, reproduction, or disclosure by the Government is subject to the terms of Unisys standard 

commercial license for the products, and where applicable, the restricted/limited rights provisions of the contract data 

rights clauses. 

Unisys and ClearPath are registered trademarks of Unisys Corporation in the United States and other countries. 

All other brands and products referenced in this document are acknowledged to be the trademarks or registered 

trademarks of their respective holders.

Contents 

Section 1. Getting Started 

1.1. Scope ....................................................................................... 1–1 

1.2. Notation Conventions .............................................................. 1–2 

1.3. Sort/Merge Processor .............................................................. 1–3 

1.3.1. SORT Processor Operation ............................................. 1–3 

1.3.2. Modes of Processor Operation ....................................... 1–4 

1.4. Sort/Merge Subroutines ........................................................... 1–4 

1.4.1. Modes of Subroutine Operation ...................................... 1–5 

1.4.2. Accessing the SORT Subroutines ................................... 1–5 

1.5. Release History ........................................................................ 1–6 

1.6. New Features and Enhancements .......................................... 1–7 

1.6.1. SORT Level 22R2A Enhancements ................................ 1–7 

1.6.2. SORT Level 22R2 Enhancements ................................... 1–7 

1.6.3. SORT Level 22R1 Enhancements ................................... 1–8 

1.6.4. SORT Level 21R1E Enhancements................................. 1–8 

1.6.5. SORT Level 21R1D Enhancements ................................ 1–9 

1.6.6. SORT Level 21R1C Enhancements ................................ 1–9 

1.6.7. SORT Level 21R1 Enhancements ................................. 1–10 


1.6.9. SORT Level 20R1C Enhancements .............................. 1–11 

1.6.10. SORT Level 20R1B Enhancements .............................. 1–11 









1.7. Compatibility .......................................................................... 1–15 

1.7.1. SORT Level 22R2B Compatibility.................................. 1–15 

1.7.2. SORT Level 22R2A Compatibility.................................. 1–15 

1.7.3. SORT Level 22R2 Compatibility .................................... 1–16 


1.7.5. SORT Level 21R1F Compatibility .................................. 1–17 

1.7.6. SORT Level 21R1E Compatibility .................................. 1–18 

1.7.7. SORT Level 21R1D Compatibility ................................. 1–18 

1.7.8. SORT Level 21R1C Compatibility.................................. 1–19 

1.7.9. SORT Level 21R1B Compatibility.................................. 1–20 





7831 0687–010 iii

Contents 

1.7.14. SORT Level 20R1D Compatibility .................................. 1–23 

1.7.15. SORT Level 20R1C Compatibility .................................. 1–23 

1.7.16. SORT Level 20R1B Compatibility .................................. 1–24 

1.7.17. SORT Level 20R1A Compatibility .................................. 1–25 

1.7.18. SORT Level 20R1 Compatibility ..................................... 1–25 









Section 2. Basic Mode versus Extended Mode Selection 

2.1. OS 2200 Environments ............................................................ 2–1 

2.2. Using the SORT Processor in Extended Mode ........................ 2–2 

2.3. Using the SORT Subroutines in Extended Mode ..................... 2–6 

Section 3. The SORT Processor 

3.1. Activating the SORT Processor ................................................ 3–1 

3.2. Using Parameter Specifications ................................................ 3–2 

3.2.1. Types of Parameters ........................................................ 3–3 

3.2.2. SORT Processor Program Structure ................................ 3–6 

3.2.3. Syntax Rules for SORT Processor Parameter 

Specifications............................................................... 3–6 

3.2.4. Syntax Rules for Local Parameter Specifications ............ 3–8 

3.2.5. SORT Processor Runstream Example ............................. 3–9 

3.2.6. SORT Processor Parameter Groups .............................. 3–10 

3.3. SORT Processor Parameters .................................................. 3–11 

3.3.1. ACCEPT Parameter ........................................................ 3–11 

3.3.2. ALLOW Parameter ......................................................... 3–13 

3.3.3. BIAS Parameter ............................................................. 3–16 

3.3.4. BLOCK Parameter .......................................................... 3–16 

3.3.5. BMBLOCK Parameter .................................................... 3–17 

3.3.6. CHECK Parameter .......................................................... 3–18 

3.3.7. CHECKSUM Parameter ................................................. 3–18 

3.3.8. CKPT Parameter ............................................................. 3–19 

3.3.9. CODE-TYPE Parameter .................................................. 3–20 

3.3.10. CONSOLE Parameter .................................................... 3–21 

3.3.11. COPY Parameter ............................................................ 3–21 

3.3.12. CORE Parameter ............................................................ 3–21 

3.3.13. DATA Parameter ............................................................ 3–22 

3.3.14. DEFYEAR Parameter ..................................................... 3–23 

3.3.15. DELCON Parameter ....................................................... 3–23 

3.3.16. DELDUPS Parameter ..................................................... 3–23 

3.3.17. DELLOG Parameter ....................................................... 3–24 

3.3.18. DISKS Parameter ........................................................... 3–24 

3.3.19. DRUM Parameter .......................................................... 3–25 

iv 7831 0687–010

Contents 

3.3.20. EQUIP Parameter .......................................................... 3–27 

3.3.21. ESORT Parameter ......................................................... 3–27 

3.3.22. ESTIMATE Parameter ................................................... 3–28 

3.3.23. FAST Parameter ............................................................ 3–29 

3.3.24. FILEID Parameter .......................................................... 3–30 

3.3.25. FILEIN Parameter .......................................................... 3–30 

3.3.26. FILEOUT Parameter ...................................................... 3–32 

3.3.27. FILESIN Parameter ........................................................ 3–33 

3.3.28. ISKEY Parameter ........................................................... 3–33 

3.3.29. ISKEYW Parameter ....................................................... 3–34 

3.3.30. JOIN Parameter ............................................................. 3–35 

3.3.31. KEY Parameter .............................................................. 3–35 

3.3.32. KEYW Parameter........................................................... 3–38 

3.3.33. LABEL Parameter .......................................................... 3–41 

3.3.34. LIMDRM Parameter ...................................................... 3–41 

3.3.35. LIMFST Parameter ........................................................ 3–42 

3.3.36. LINKSZ Parameter ......................................................... 3–42 

3.3.37. LOCALE Parameter ....................................................... 3–43 

3.3.38. LOG Parameter ............................................................. 3–44 

3.3.39. MERGE Parameter ........................................................ 3–44 

3.3.40. MODE Parameter .......................................................... 3–44 

3.3.41. MOVE Parameter .......................................................... 3–47 

3.3.42. MSKEY Parameter......................................................... 3–48 

3.3.43. MSKEYW Parameter ..................................................... 3–49 

3.3.44. NUMREC Parameter ..................................................... 3–50 

3.3.45. OWN Parameter ............................................................ 3–50 

3.3.46. PREP Parameter ............................................................ 3–51 

3.3.47. PRESERVE Parameter ................................................... 3–51 

3.3.48. PROCESSING Parameter .............................................. 3–52 

3.3.49. RECORD Parameter ...................................................... 3–52 

3.3.50. REELS Parameter .......................................................... 3–53 

3.3.51. REJECT Parameter ........................................................ 3–53 

3.3.52. RETRIEVE Parameter .................................................... 3–55 

3.3.53. REVMSAMBLK Parameter ............................................ 3–56 

3.3.54. RSZ Parameter .............................................................. 3–57 

3.3.55. SELECT Parameter ........................................................ 3–59 

3.3.56. SEQ Parameter .............................................................. 3–60 

3.3.57. SEQA Parameter ........................................................... 3–60 

3.3.58. SEQC Parameter ........................................................... 3–61 

3.3.59. SEQX Parameter ........................................................... 3–61 

3.3.60. SKIPL Parameter ........................................................... 3–62 

3.3.61. SORT Parameter ........................................................... 3–63 

3.3.62. SPLIT Parameter ........................................................... 3–63 

3.3.63. STOP Parameter ............................................................ 3–64 

3.3.64. STOPAPP Parameter ..................................................... 3–67 

3.3.65. TAG Parameter .............................................................. 3–68 

3.3.66. TAGFILE Parameter....................................................... 3–69 

3.3.67. TAPES Parameter .......................................................... 3–70 

3.3.68. VOLUME Parameter...................................................... 3–71 

3.4. Operator Information ............................................................. 3–71 

3.4.1. Estimations .................................................................... 3–71 

7831 0687–010 v

Contents 

3.4.2. Scratch Facility Assignment ........................................... 3–72 

3.5. SORT Processor Use of the Run-Condition Word .................. 3–74 

Section 4. User Exit Coding Considerations 

4.1. Procedures for Using Your Own Routines ............................... 4–1 

4.2. Using Exit Numbers .................................................................. 4–1 

4.3. User Exit Number Explanation .................................................. 4–3 

4.3.1. User Exit 01 ..................................................................... 4–3 

4.3.2. User Exit 10 ..................................................................... 4–3 

4.3.3. User Exit 11 or 45 ............................................................ 4–4 

4.3.4. User Exit 12 or 46 ............................................................ 4–4 

4.3.5. User Exit 13 ..................................................................... 4–5 

4.3.6. User Exit 14 or 21 ............................................................ 4–5 

4.3.7. User Exit 15 or 47 ............................................................ 4–6 

4.3.8. User Exit 31 or 41 ............................................................ 4–6 

4.3.9. User Exit 32 or 42 ............................................................ 4–7 

4.3.10. User Exit 33 or 43 ............................................................ 4–7 

4.3.11. User Exit 34 or 44 ............................................................ 4–8 

4.4. SRTGEN .................................................................................... 4–8 

Section 5. The SORT Subroutine Parameter Tables for MASM 

Programs 

5.1. Introduction ............................................................................... 5–1 

5.2. R$FILE Assembly-Time Parameters ......................................... 5–2 

5.2.1. BIAS Parameter ............................................................... 5–6 

5.2.2. CHECK Parameter ............................................................ 5–6 

5.2.3. CHECKD Parameter ......................................................... 5–7 

5.2.4. CHECKF Parameter .......................................................... 5–8 

5.2.5. CHECKK Parameter ......................................................... 5–8 

5.2.6. CHECKT Parameter .......................................................... 5–9 

5.2.7. COMP Parameter ............................................................. 5–9 

5.2.8. CONSOLE Parameter .................................................... 5–10 

5.2.9. CONTA Parameter ......................................................... 5–10 

5.2.10. CONTB Parameter ......................................................... 5–11 

5.2.11. CONTC Parameter ......................................................... 5–12 

5.2.12. COPY Parameter ............................................................ 5–12 

5.2.13. CORE Parameter ............................................................ 5–13 

5.2.14. DEFYEAR Parameter ..................................................... 5–14 

5.2.15. DELCON Parameter ....................................................... 5–15 

5.2.16. DELLOG Parameter ....................................................... 5–15 

5.2.17. DROC Parameter ........................................................... 5–15 

5.2.18. ERROR Parameter ......................................................... 5–16 

5.2.19. FILES Parameter ............................................................ 5–18 

5.2.20. FINAL Parameter ........................................................... 5–19 

5.2.21. FPOC Parameter ............................................................ 5–19 

5.2.22. KEY Parameter ............................................................... 5–20 

5.2.23. KEYW Parameter ........................................................... 5–24 

5.2.24. LOCALE Parameter ........................................................ 5–27 

5.2.25. LOG Parameter .............................................................. 5–28 

vi 7831 0687–010

Contents 

5.2.26. LPOC Parameter ........................................................... 5–28 

5.2.27. NODISK Parameter ....................................................... 5–29 

5.2.28. NOMASS Parameter ..................................................... 5–29 

5.2.29. NOTAPE Parameter....................................................... 5–29 

5.2.30. OPTION Parameter ....................................................... 5–30 

5.2.31. PAD Parameter .............................................................. 5–31 

5.2.32. PARTA Parameter ......................................................... 5–31 

5.2.33. PARTB Parameter ......................................................... 5–33 

5.2.34. PARTC Parameter ......................................................... 5–34 


5.2.36. RECAREA Parameter .................................................... 5–34 

5.2.37. REDOA Parameter ........................................................ 5–35 

5.2.38. REDOB Parameter ........................................................ 5–36 

5.2.39. RSZ Parameter .............................................................. 5–37 

5.2.40. RSZA Parameter ............................................................ 5–37 

5.2.41. RSZB Parameter ............................................................ 5–38 

5.2.42. RSZW Parameter........................................................... 5–38 

5.2.43. SEQ Parameter .............................................................. 5–39 

5.2.44. SEQA Parameter ........................................................... 5–40 

5.2.45. SEQB Parameter ........................................................... 5–41 

5.2.46. SEQC Parameter ........................................................... 5–42 

5.2.47. SEQD Parameter ........................................................... 5–43 

5.2.48. SEQE Parameter ........................................................... 5–43 

5.2.49. SEQF Parameter ............................................................ 5–44 

5.2.50. SEQK Parameter ........................................................... 5–45 

5.2.51. SMRG Parameter .......................................................... 5–46 

5.2.52. VOL Parameter .............................................................. 5–47 

5.2.53. VRSZ Parameter ............................................................ 5–47 

5.2.54. VRSZA Parameter.......................................................... 5–48 

5.2.55. VRSZB Parameter.......................................................... 5–48 

5.2.56. VRSZW Parameter ........................................................ 5–49 

5.3. Coding Parameter Table Entries as Constants ...................... 5–50 

5.4. Using Execution-Time Parameters ........................................ 5–51 

5.4.1. LIMDRM Parameter ...................................................... 5–52 

5.4.2. LIMFST Parameter ........................................................ 5–52 

5.4.3. PSORT Parameter ......................................................... 5–53 

5.4.4. R$NCDS Procedure ....................................................... 5–53 

5.5. Using Multiple Parameter Tables ........................................... 5–53 

Section 6. MASM Program Linkages 

6.1. MASM Procedure Definition Elements ................................... 6–2 

6.2. MASM Sort Program Linkages ................................................ 6–3 

6.2.1. MASM Sort Open Linkages ............................................ 6–4 

6.2.2. MASM Sort Release Linkages ........................................ 6–5 

6.2.2.1. MASM Sort Release Linkages (WORD 

Length Records) ................................................. 6–5 

6.2.2.2. MASM Sort Release Linkages (NON- 

WORD Length Records) .................................... 6–7 

6.2.3. MASM Sort Sort Linkages .............................................. 6–8 

6.2.4. MASM Sort Return Linkages .......................................... 6–9 

7831 0687–010 vii

Contents 

6.2.5. MASM Sort Quick End Linkages ................................... 6–10 

6.3. MASM Tape Sort Linkages ..................................................... 6–11 

6.3.1. IPURI$ ............................................................................ 6–11 

6.3.2. RENCY$ ......................................................................... 6–12 

6.3.3. RINFO$ .......................................................................... 6–13 

6.4. MASM Merge Program Linkages ........................................... 6–14 

6.4.1. MASM Merge Open Linkages ....................................... 6–14 

6.4.2. MASM Merge Release Linkages ................................... 6–16 

6.4.3. MASM Merge Request Linkages .................................. 6–17 

6.4.4. MASM Merge Close Linkages ....................................... 6–18 

6.5. Interface Aids to the SORT Subroutine MASM 

Linkages ............................................................................. 6–19 

6.6. User Routine Substitution Considerations ............................. 6–20 

6.6.1. User COMP Code .......................................................... 6–21 

6.6.2. User DROC Code ........................................................... 6–22 

Section 7. The SORT Subroutine Parameter Tables for UCS C 

Programs 

7.1. Introduction ............................................................................... 7–1 

7.2. Setting Up the UCS C Parameter Table ................................... 7–2 

7.3. UCS C Program Parameters ..................................................... 7–4 

7.3.1. COMP Parameter ............................................................. 7–5 

7.3.2. CONSOLE Parameter ...................................................... 7–6 

7.3.3. COPY Parameter .............................................................. 7–7 

7.3.4. CORE Parameter .............................................................. 7–7 

7.3.5. DROC Parameter ............................................................. 7–8 

7.3.6. END Parameter .............................................................. 7–10 

7.3.7. FILES Parameter ............................................................ 7–10 

7.3.8. INFO Parameter ............................................................. 7–11 

7.3.9. KEY Parameter ............................................................... 7–12 

7.3.10. LOCALE Parameter ........................................................ 7–14 

7.3.11. LOG Parameter .............................................................. 7–15 

7.3.12. OPTION Parameter ........................................................ 7–15 

7.3.13. PAD Parameter .............................................................. 7–16 


7.3.15. RSZ Parameter ............................................................... 7–17 

7.3.16. SEQ Parameter .............................................................. 7–18 

7.3.17. START Parameter .......................................................... 7–19 

7.3.18. VOL Parameter .............................................................. 7–20 

7.3.19. VRSZ Parameter ............................................................. 7–20 

7.4. User Routine Substitution Considerations ............................. 7–21 

7.4.1. User Compare Code ...................................................... 7–22 

7.4.2. User Duplicate Record Code.......................................... 7–23 

Section 8. SORT Subroutine Linkages for UCS C Programs 

8.1. UCS C File Inclusion Element ................................................... 8–1 

8.2. UCS C Program Linkage Parameters........................................ 8–2 

8.2.1. Result Status Parameter .................................................. 8–2 

8.2.2. D-Bank Address Parameter.............................................. 8–4 

viii 7831 0687–010

Contents 

8.2.3. Parameter Table Parameter ............................................ 8–4 

8.2.4. Record Information Packet Parameter ............................ 8–4 

8.2.4.1. Record Information Packet Definition .................... 8–4 

8.2.4.2. Record Information Packet version Field ................ 8–6 

8.2.4.3. Record Information Packet buffer_gran 

Field .................................................................... 8–6 

8.2.4.4. Record Information Packet record_gran 

Field .................................................................... 8–6 

8.2.4.5. Record Information Packet type Field .................... 8–6 

8.2.4.6. Record Information Packet subtype Field .............. 8–7 

8.2.4.7. Record Information Packet record_length 

Field .................................................................... 8–8 

8.2.4.8. Record Information Packet buffer_length 

Field .................................................................... 8–8 

8.2.4.9. Record Information Packet 

number_of_records Field ................................... 8–8 

8.2.4.10. Record Information Packet pad_word Field ........... 8–9 

8.2.5. Record Address Parameter ............................................. 8–9 

8.3. Bulk Interface ........................................................................... 8–9 

8.3.1. Fixed Records Buffer Format ........................................ 8–10 

8.3.2. Variable1 Records Buffer Format .................................. 8–11 

8.3.3. Variable2 Records Buffer Format .................................. 8–12 

8.4. UCS C Sort Program Linkages ............................................... 8–14 

8.4.1. UCS C Sort Open Linkage ............................................. 8–14 

8.4.2. UCS C Sort Release Linkage ......................................... 8–15 

8.4.3. UCS C Sort Sort Linkage ............................................... 8–18 

8.4.4. UCS C Sort Return Linkage ........................................... 8–18 

8.4.5. UCS C Sort Close Linkage ............................................. 8–21 

8.5. UCS C Merge Program Linkages ........................................... 8–21 

8.5.1. UCS C Merge Open Linkage ......................................... 8–21 

8.5.2. UCS C Merge Release Linkage ..................................... 8–22 

8.5.3. UCS C Merge Request Linkage .................................... 8–23 

8.5.4. UCS C Merge Close Linkage ......................................... 8–25 

Section 9. Configuration Parameters 

9.1. AUTOMATIC Configuration Parameter .................................... 9–1 

9.2. CCSLOCNUM Configuration Parameter .................................. 9–2 

9.3. CCSLOCNUMCHK Configuration Parameter ........................... 9–2 

9.4. CONSOLE Configuration Parameter ........................................ 9–3 

9.5. DEFBMCORE Configuration Parameter .................................. 9–3 

9.6. DEFDK Configuration Parameter ............................................. 9–4 

9.7. DEFLOCALE Configuration Parameter .................................... 9–4 

9.8. DEFTP Configuration Parameter .............................................. 9–5 

9.9. DEFXA Configuration Parameter ............................................. 9–5 

9.10. DEFXB Configuration Parameter ............................................. 9–6 

9.11. LOG Configuration Parameter.................................................. 9–6 

9.12. MAXIMUM Configuration Parameter ...................................... 9–7 

9.13. MINIMUM Configuration Parameter ....................................... 9–7 

9.14. MSAMBLOCK Configuration Parameter .................................. 9–8 

9.15. NUMRECWARN Configuration Parameter .............................. 9–8 

7831 0687–010 ix

Contents 

9.16. PRCERRCONS Configuration Parameter ................................. 9–9 

9.17. PROCESSING Configuration Parameter ................................. 9–10 

9.18. PREPDEFAULT Configuration Parameter ............................... 9–11 

9.19. RBSIZE Configuration Parameter ........................................... 9–11 

Section 10. Sort Types and Variable-Length Sorting 

Considerations 

10.1. The CORE Parameter ............................................................. 10–1 

10.2. Sort Types ............................................................................... 10–2 

10.2.1. Basic Mode or Extended Mode Main-Storage- 

Only Sorts .................................................................. 10–2 

10.2.2. Basic Mode and Extended Mode Disk Sorts ................. 10–3 

10.2.3. One-Level (M1) and Two-Level (M1–M2) Mass 

Storage Sorts ............................................................. 10–5 

10.2.4. Tape Sorts ...................................................................... 10–6 

10.3. Variable-Length Record Considerations ................................. 10–6 

Section 11. Key Field Translation 

11.1. Using MASM Compare Instructions ....................................... 11–1 

11.2. Sort/Merge Key Fields ............................................................ 11–2 

11.2.1. A - Fieldata Alphanumeric Format .................................. 11–2 

11.2.2. B - OS 2200 Signed Binary Format ................................ 11–3 

11.2.3. D - Fieldata Sign-Leading Separate-Decimal 

Format ....................................................................... 11–3 

11.2.4. DATE - ASCII Alphanumeric Date Leading 18-Bit 

Year Format ............................................................... 11–4 

11.2.5. G - Fieldata Sign-Trailing Separate-Decimal 

Format ....................................................................... 11–5 

11.2.6. I - International Character Set Format ............................ 11–5 

11.2.7. J - Packed Decimal Format ............................................ 11–6 

11.2.8. L - Fieldata Sign-Leading Overpunch Format ................. 11–7 

11.2.9. M - IBM Signed Binary Format ...................................... 11–7 

11.2.10. P - Fieldata Sign-Trailing Overpunch Format .................. 11–7 

11.2.11. Q - ASCII Sign-Trailing Overpunch Format ..................... 11–8 

11.2.12. R - ASCII Sign-Leading Separate-Decimal Format ......... 11–8 

11.2.13. S - ASCII Alphanumeric Format ..................................... 11–9 

11.2.14. T - ASCII Sign-Trailing Separate-Decimal Format ........... 11–9 

11.2.15. U - Unsigned Binary Format ......................................... 11–10 

11.2.16. V - ASCII Sign-Leading Overpunch Format .................. 11–10 

Section 12. Tape Sort Operations 

12.1. SORT Subroutines Tape Sort Operations ............................... 12–1 

12.1.1. Automatic Tape Sorts .................................................... 12–1 

12.1.2. Nonautomatic Tape Sorts .............................................. 12–2 

12.2. Tape Merge Power Calculations ............................................. 12–3 

12.3. Tape Sort Console Messages ................................................. 12–4 

12.3.1. Distribution Phase .......................................................... 12–4 

x 7831 0687–010

Contents 

12.3.2. Intermediate Merge Phase ........................................... 12–6 

12.3.3. Final Merge Phase....................................................... 12–10 

12.3.4. CONTA – CONTB – CONTC ........................................ 12–11 

12.3.5. REDOA – REDOB ........................................................ 12–11 

Appendix A. Summary and Diagnostic Messages 

A.1. SORT Processor Error Messages ............................................ A–1 

A.2. SORT Subroutine Error Messages ......................................... A–18 

A.3. SORT Subroutine Summary Messages ................................. A–34 

Appendix B. Examples of Processor Usage 

B.1. Printing the Contents of a File ................................................. B–1 

B.2. Sorting a File and Producing the Resulting Output File ........... B–2 

B.3. Merging Files into One Output File ......................................... B–5 

B.4. Selecting a Certain Classification of Records .......................... B–5 

B.5. Determining or Assigning Scratch Facilities ............................ B–8 

B.6. Performing a TAG/RETRIEVE Sort ......................................... B–10 

B.7. Creating or Reading Indexed Files ......................................... B–11 

B.8. Dynamically Assigning the Output File .................................. B–12 

B.9. Specifying Overlapping Keys ................................................. B–12 

B.10. Performing an Extended Mode Sort ...................................... B–12 

Appendix C. Sample Programs Using Common Bank Interface 

Appendix D. Sample Programs with UCS C Program Linkages 

D.1. Sample Sort Program ............................................................... D–1 

D.2. Sample Merge Program ........................................................... D–5 

D.3. Sample UCS C Buffer Program ................................................ D–9 

Appendix E. Configuration of Internal Parameters 

E.1. Sample DEFAULT$ Configuration Session – Full- 

Screen Mode ....................................................................... E–1 

E.2. Sample DEFAULT$ Configuration Session – Line 

Mode ................................................................................... E–9 

Glossary ............................................................................................. 1 

Index ............................................................................................. 1 

7831 0687–010 xi

Contents 

xii 7831 0687–010

Figures 

1–1. SORT Processor Data Flow Example................................................................. 1–3 

1–2. SORT Subroutines Data Flow Example ............................................................. 1–5 

8–1. Record Information Packet Version 1 Structure ................................................ 8–4 

8–2. Record Information Packet Version 2 Structure ................................................ 8–5 

8–3. Fixed Records Buffer Format ........................................................................... 8–10 

8–4. Variable1 Records Buffer Format ..................................................................... 8–11 

8–5. Variable1 Records RCW Format ...................................................................... 8–11 

8–6. Variable2 Records Buffer Format ..................................................................... 8–13 

7831 0687–010 xiii

Figures 

xiv 7831 0687–010

Tables 

1–1. SORT Processor Operation Modes .................................................................... 1–4 

1–2. SORT Subroutines Operation Modes ................................................................ 1–5 

2–1. Sort/Merge Environment Operations ................................................................. 2–1 

2–2. SORT Processor Extended Mode Selection, AUTOMATIC Set to YES ............. 2–3 

2–3. SORT Processor Extended Mode Selection, AUTOMATIC Set to NO .............. 2–4 

2–4. SORT Processor Extended Mode Selection, Y Option Specified ...................... 2–5 

2–5. SORT Subroutines Extended Mode Selection ................................................... 2–6 

3–1. SORT Processor Global/Local Parameters ......................................................... 3–3 

3–2. Overlapping Types ........................................................................................... 3–38 

3–3. Determining Processor Record Size ................................................................ 3–58 

4–1. SORT Processor User Exit Numbers ................................................................. 4–2 

5–1. MASM Parameter Table Generation Methods .................................................. 5–1 

5–2. R$FILE Assembly-Time Parameters .................................................................. 5–2 

5–3. Key Types ......................................................................................................... 5–24 

5–4. Execution-Time Parameters ............................................................................. 5–52 

6–1. MASM Statements for Sort Open Linkage Types ............................................. 6–4 

6–2. MASM Statements for Sort Release Linkage Types ......................................... 6–6 

6–3. MASM Statements for MASM Sort Release Linkage Types (OPTION 

Bits 30 or 31 Are Set) .................................................................................... 6–7 

6–4. MASM Statements for Sort Sort Linkage Types ............................................... 6–8 

6–5. MASM Statements for Sort Return Linkage Types ........................................... 6–9 

6–6. MASM Statements for Sort Quick End Linkages ............................................ 6–10 

6–7. MASM Statements for the IPURI$ Tape Sort Linkage .................................... 6–11 

6–8. MASM Statements for the RENCY$ Tape Sort Linkages ................................ 6–12 

6–9. MASM Statements for the RINFO$ Tape Sort Linkages ................................. 6–13 

6–10. MASM Statements for Merge Open Linkages ................................................ 6–15 

6–11. MASM Statements for Merge Release Linkages ............................................ 6–16 

6–12. MASM Statements for Merge Request Linkages ........................................... 6–17 

7–1. UCS C Program Parameters .............................................................................. 7–4 

7–2. Collating Sequence Table Types ...................................................................... 7–19 

8–1. Severity Code Values ......................................................................................... 8–2 

8–2. Record Information Packet Type Field Values ................................................... 8–6 

8–3. Record Information Packet Subtype Field Values When Type Field 

Equals 1 ......................................................................................................... 8–7 

8–4. Variable1 Records Buffer Fields ....................................................................... 8–12 

7831 0687–010 xv

Tables 

8–5. Sort Release Record Information Packet Input ................................................ 8–15 

8–6. Sort Release Record Information Packet Exit Condition .................................. 8–17 

8–7. Sort Return Record Information Packet Input .................................................. 8–19 

8–8. Sort Return Record Information Packet Exit Conditions .................................. 8–20 

10–1. M1 Main Storage Assignment and Reservation Guidelines ............................. 10–5 

10–2. M1–M2 Main Storage Assignment and Reservation Guidelines...................... 10–5 

11–1. Sort/Merge Key Field Translation ..................................................................... 11–2 

11–2. Example of Steps in Key Field Translation ........................................................ 11–4 

11–3. Example of Steps in Restoring Translated Key Fields ...................................... 11–5 

xvi 7831 0687–010

Section 1 

Getting Started 

Sort/Merge is a software package that performs sorting and merging operations. 

Sort/Merge provides you with the ability to do the following: 

1.1. Scope 

• Read input files from different media 

• Perform record manipulation operations 

• Create specially formatted output files 

The Sort/Merge software package consists of the following: 

• The SORT processor (see 1.3, 2.1, 2.2, and Sections 3 and 4) 

• The SORT subroutines basic mode MASM linkages (see 1.4, 2.1, 2.3, and Sections 5 

and 6) 

• The SORT subroutines Universal Compiling System (UCS) C linkages (see 1.4, 2.1, 

2.3 and Sections 7 and 8) 

Sort/Merge operates on Unisys ClearPath HMP IX Series and 2200 Series systems. 

This guide provides an overview of the Sort/Merge software package and describes the 

SORT processor and SORT subroutines in detail. It specifies sort parameters and 

explains how to define and generate parameter tables to control Sort/Merge operations. 

Programmers can use procedures in this guide to create MASM and UC programs that 

interface with the SORT subroutines. 

This programming guide tells programmers how to: 

• Perform SORT, MERGE, COPY, or ESTIMATE operations using the SORT processor. 

• Tailor the Sort/Merge operations using the SORT subroutines. 

• Transfer control from your programs to the SORT subroutines. 

Documentation Updates 

This document contains all the information that was available at the time of publication. 

Changes identified after release of this document are included in problem list entry (PLE) 

18721031. To obtain a copy of the PLE, contact your Unisys representative or access 

the current PLE from the Unisys Product Support Web site: 

http://www.support.unisys.com/all/ple/18721031 

Note: If you are not logged into the Product Support site, you will be asked to do so. 

7831 0687–010 1–1


1.2. Notation Conventions 

The following syntax notation conventions are used in this guide: 

• Procedure and processor calls appear as uppercase words and should be entered 

exactly as shown. For example: 

@SORT,A 

ROPN$X 

• Sort/Merge commands consist of parameters and variables. 

− A parameter is a word that you enter exactly as shown. Parameter names for 

the SORT processor and MASM appear as uppercase words; UCS C parameter 

types are lowercase. For example: 

SORT processor: ESTIMATE=N 

MASM: ′DELLOG′ 

UC: sm_log_parameter_type 

− A variable is a word that represents data you supply (for example, a word, letter, 

or number). Variables appear as lowercase, italicized words. For example: 

tagÄfileÄname 

• In examples that illustrate a user/system dialogue, user-supplied input is in bold text. 

For example: 

COMMAND ? íCONFIGURE 

• Default values in command formats are in bold text. For example: 

BIAS=AVG 

• Brackets enclose optional words, phrases, or alternatives. For example: 

@SORT[,options] 

• Macro names and defined constants use underscores. For example: 

sm_keyw_parameter 

• Changes made since the last version of the manual are shown with yellow 

highlighting in the online version (and may appear as shading in the printed version). 

1–2 7831 0687–010

1.3. Sort/Merge Processor 


The Sort/Merge processor, referred to as the SORT processor, is an independent 

processor that performs copying, sorting, and merging operations. The SORT processor 

is recommended in either of the following situations: 

• Performing specific sort or merge operations. 

• Interface with the Sort/Merge software package in conjunction with other 

independent programs. 

You access the SORT processor using Executive Control Language (ECL) to do the 

following: 

• Read input files from cards, mass storage, and tape 

• Perform copy, estimate, merge, retrieve, or sort operations 

• Create output files 

1.3.1. SORT Processor Operation 

You activate the SORT processor with an ECL processor call. ECL call options and 

parameters provide the information necessary to perform the operation you request. 

Such information includes the following: 

• Processor mode (see 1.3.2) 

• Type of input data 

• File formats 

When you activate a SORT processor operation, the SORT subroutines actually perform 

the sort and merge operations. See 1.4, 2.3, and Sections 5 and 6 for information about 

the SORT subroutines. 

Figure 1–1 represents the data flow of the SORT processor for a sort operation. 

Figure 1–1. SORT Processor Data Flow Example 

7831 0687–010 1–3


1.3.2. Modes of Processor Operation 

The SORT processor performs six operations. These operations are divided into three 

modes: sort, merge, and copy. These modes and their respective operations are shown 

in Table 1–1. 

Table 1–1. SORT Processor Operation Modes 

Processor Mode Operation Parameter Description 

Sort SORT Passes complete input data records through 

the sort process. 

TAG/SELECT Tells the SORT processor how to reformat 

data records before passing them through 

the sort process. 

TAG/RETRIEVE Tells the SORT processor to perform a 

retrieve operation. 

ESTIMATE Tells the SORT processor to perform a time 

estimate for a SORT or TAG operation. 

Merge MERGE Merges up to 24 input files into a single 

output file using sort keys or an entry point 

name of a user routine. 

Copy COPY Copies up to 24 input files into a single new 

output file without sorting. 

You request a SORT processor mode by specifying parameters after the processor call. 

Section 3 explains how to specify parameters and provides the parameter formats. 

You can direct the SORT processor to perform a SORT or TAG operation either in a basic 

mode environment as a basic mode sort, or in an extended mode environment as an 

extended mode sort (see Section 2). An extended mode sort takes advantage of the 

large memory available with the extended mode environment. 

See Sections 3 and 4 for detailed information about the SORT processor. 

1.4. Sort/Merge Subroutines 

The Sort/Merge subroutines, referred to as the SORT subroutines, are used by the SORT 

processor to perform the actual sort and merge operations you request. 

When you need to tailor a specific Sort/Merge operation to fit an application exactly, you 

can access the SORT subroutines directly through your own MASM programs using 

Basic Mode MASM program linkages (see Sections 5 and 6) or through your UCS C 

program using the UCS C program linkages (see Sections 7 and 8). You can also 

substitute some of your subroutines for the SORT subroutines provided with the 

Sort/Merge package. As a result, the Sort/Merge package offers flexibility to perform 

Sort/Merge functions at your site. 

1–4 7831 0687–010

1.4.1. Modes of Subroutine Operation 


Like the SORT processor, the SORT subroutines perform different modes of operations, 

as shown in Table 1–2. 

Subroutine 

Mode 

Table 1–2. SORT Subroutines Operation Modes 

Description 

Sort You pass unsorted data records as input to the SORT subroutines. The sort 

operation is performed and the records are returned in sorted order. 

You can direct the SORT subroutines to perform the operation in a basic mode 

environment as a basic mode sort, or in an extended mode environment as an 

extended mode sort. An extended mode sort takes advantage of the large 

memory available with the extended mode environment. 

Merge You can use presorted data from up to 24 files as input to the SORT 

subroutines. The subroutines merge the data from these files using the key 

fields you specify. The merged records are then returned to the user program. 

1.4.2. Accessing the SORT Subroutines 

You access the SORT subroutines from MASM programs by using procedure calls or 

MASM statements with the following types of linkages: 

• Standard 

• Extended 

• Common bank 

Section 6 describes these linkages. See Sections 5 and 6 for detailed information about 

the SORT subroutines MASM linkages. 

You access the SORT subroutines from UCS C programs by using function calls to the 

UCS C SORT subroutines linkages. See Sections 7 and 8 for detailed information about 

the SORT subroutines UCS C linkages. 

Figure 1–2 represents the data flow of the SORT subroutines. 

Figure 1–2. SORT Subroutines Data Flow Example 

7831 0687–010 1–5


1.5. Release History 

This subsection states the release history for Sort/Merge since level 17R1. It provides 

the release level, release date, and the immediate prior release levels to this release. 

This information should be used in conjunction with the compatibility and the new 

feature and enhancement sections. 

Release Level Release Date Prior Releases 

22R2B 22R2A 

22R2A June 16, 2009 22R2 

22R2 September 29, 2008 22R1 

22R1 November 10, 2006 21R1F 

21R1F October 10, 2005 21R1E 

21R1E April 7, 2005 21R1D 

21R1D March 19, 2004 21R1C 

21R1C August 8, 2003 21R1B 

21R1B January 17, 2003 21R1A 

21R1A June 6, 2002 21R1 

21R1 January 2, 2002 20R2A 

20R2A April 12, 2001 20R2 

20R2 November 15, 2000 20R1D 

20R1D June 23, 2000 20R1C 

20R1C October 2, 1999 20R1B 

20R1B April 9, 1999 20R1A 

20R1A February 23, 1999 20R1 

20R1 August 17, 1998 18R3, 19R1 

19R1 October 17, 1997 17R4, 18R3 

18R3 June 30, 1997 17R2A, 18R2 

17R4 June 30, 1997 17R2A 

18R2 August 29, 1996 18R1A 

18R1A March 29, 1996 18R1 

18R1 December 9, 1995 17R2A 

17R2A August 24, 1995 17R2 

17R2 October 28, 1994 17R1 

17R1 March 26, 1994 16R1B 

1–6 7831 0687–010

1.6. New Features and Enhancements 


This subsection describes the new features and enhancements to Sort/Merge based on 

release level. An identifier is also attached to each item to have a reference ID for each 

item and to identify the same functionality when the item is introduced in more than one 

symbolic level. 

1.6.1. SORT Level 22R2A Enhancements 

The following enhancements have been made to Sort/Merge level 22R2A since level 

22R2. 

Enhancement 

ID Feature Name Description 

E1650 Log Message 

Run-id 

1.6.2. SORT Level 22R2 Enhancements 

The initial SORT subroutines LOG message is modified 

to include the original and the generated run-id. This 

permits log analysis programs that examine sort log 

messages to identify the run or transaction associated 

with the sort information. For transactions, the original 

run-id is the transaction name. 

The following enhancements have been made to Sort/Merge level 22R2 since level 

22R1. 

Enhancement 

ID 

Feature Name 

E1643 LTO3-HP, 

LTO4-HP, T10000, 

and T9840D tape 

adapts 

Description 

Sort/Merge adapts to the LTO3-HP, LTO4-HP, T10000, 

and T9840D tape devices. The adapts for these devices 

allow input files, output files, and scratch files for a tape 

sort to reside on these devices. Please note restriction 

C1643 concerning the use of these tapes as input devices 

in the SORT Level 22R2 Compatibility section of this 

guide. 

7831 0687–010 1–7




21R1E. 

Enhancement 

ID 

Feature Name 

E1599 Processor errors 

to console 

1.6.4. SORT Level 21R1E Enhancements 

Description 

The SORT processor has been enhanced to optionally 

send error messages to the system console. SORT 

console configuration parameter PRCERRCONS is 

provided to configure SORT to display SORT processor 

errors to the system console. PRCERRCONS can be set 

to ON or OFF. (OFF is the default.) Additional information 

about this enhancement can be found in 9.16, E.1, and 

E.2. 

When PRCERRCONS is ON, errors detected before the 

first parameter is requested and after the @EOF 

terminating the parameter input are sent to the system 

console. Errors detected after the first parameter is 

entered and before the @EOF terminating the parameter 

input are not sent to the system console. 

Regardless of the PRCERRCONS setting, all processor 

error messages are displayed in the run's print listing. 

The following enhancements have been made to Sort/Merge level 21R1E since level 

21R1D. 

Enhancement 

ID 

Feature Name 

E1586 RDMS UCS-2 

Adapt 

Description 

In conjunction with RDMS 14R1 introducing character 

columns with a UCS-2 CCS, the RDMS SORT interface 

has changed. SORT now recognizes these UCS-2 

character columns and properly sorts these RDMS fields. 

Please note SORT Level 21R1E Compatibility C1586 (see 

1.7.6) associated with this enhancement. 

1–8 7831 0687–010

1.6.5. SORT Level 21R1D Enhancements 


The following enhancements have been made to Sort/Merge level 21R1D since level 

21R1C. 

Enhancement 

ID 

Feature Name 

E1582 CTC9840 Tape 

Adapt 

1.6.6. SORT Level 21R1C Enhancements 

Description 

Sort/Merge adapts to the CTC9840 tape subsystem 

(U9840C). This adapt allows input files, output files, and 

scratch files for a tape sort to reside on a CTC9840 tape 

device (U9840C). Please note restriction C1582 

concerning the use of these tapes as input devices in the 

SORT Level 21R1D section of this guide. 

The following enhancements have been made to Sort/Merge level 21R1C since level 

21R1. 

Enhancement 

ID 

Feature Name 

E1567 CTS9940B Tape 

Adapt 

E1573 BM to EM 

Intercept Routines 

Description 

Sort/Merge adapts to the CTS9940B tape subsystem. 

This adapt allows input files, output files, and scratch files 

for a tape sort to reside on a CTS9940B tape device. 

Please note restriction C1567 concerning the use of these 

tapes as input devices in the SORT Level 21R1C section 

of this guide. 

Sort/Merge introduces two new intercept routines to aid 

in the quick conversion of a Basic MASM routine to an 

extended mode common-bank SORT. Additional 

information and restrictions about this enhancement can 

be found in 6.5. 

7831 0687–010 1–9




20R2A. 

Enhancement 

ID 

Feature Name 

E1468 Nonword 

processing 


Description 

The SORT processor has been enhanced to create and 

process (without change) nonword length records. This 

feature primarily affects MODE=SDF or MODE=DSDF 

files; however, MODE=ANSI and MODE=MSAM files are 

also affected. A new SORT processor parameter, 

PROCESSING, has been created along with the 

PROCESSING configuration parameter. The LINKSZ 

parameter and the RSZ parameter have been enhanced to 

permit bit-length record sizes to be specified. Additional 

information about the processor portion of this 

enhancement can be found in 3.3.36, 3.3.48, 3.3.54, and 

9.17. 

The SORT subroutines have also been enhanced to handle 

nonword length records. The record size and variable 

record size parameter interfaces and the record size fields 

in the various subroutine linkages and packets have been 

enhanced to permit nonword length record lengths to be 

specified. Additional information about the subroutine 

portion of this enhancement can be found in 5.2.30, 

5.2.39-5.2.42, 5.2.53-5.2.56, 6.2.2, 6.2.4, 7.3.15, 7.3.19, 

8.2.4, 8.3-8.3.3, 8.4.2, 8.4.4, 8.5.2, and 8.5.3. 


20R1C. 

Enhancement 

ID 

Feature Name 

Description 

E1437 NUMRECWARN A new configuration parameter that causes the SORT 

processor to issue a warning message if a NUMREC 

parameter is specified and the input file contains 

additional records. Additional information about this 

enhancement can be found in 3.3.44 and 9.15. 

1–10 7831 0687–010

1.6.9. SORT Level 20R1C Enhancements 


The following enhancements have been made to Sort/Merge level 20R1C since level 

20R1B. 

Enhancement 

ID 

Feature Name 

Description 

E1411 EE Tape Adapt The SORT processor now recognizes CTS5236 tape 

devices as capable of processing EE tapes for input files. 

The EE tapes can also be used as output files and scratch 

files for a tape sort. 

E1416 CTS9840 Tape 

Adapt 

1.6.10. SORT Level 20R1B Enhancements 

Sort/Merge adapts to the CTS9840 tape subsystem. This 

adapt allows input files, output files, and scratch files for a 

tape sort to reside on a CTS9840 tape device. Please 

note restriction C1416 concerning the use of these tapes 

as input devices in the 20R1C Compatibility section of this 

guide (see 1.7.15). 

The following enhancements have been made to Sort/Merge level 20R1B since level 

20R1. 

Enhancement 

ID 

Feature Name 

E1380 DLT7000 Tape 

Adapt 

Description 

Sort/Merge adapts to the DLT7000 tape subsystem. This 

adapt allows input files, output files, and as scratch files 

for a tape sort to reside on a DLT7000 tape system tape 

device. Please note the restrictions in the 20R1B 

Compatibility section of this guide (see 1.7.16). 

7831 0687–010 1–11




19R1. 

Enhancement 

ID 

Feature Name 

E1324 Virtual Tape 

Adapt 

Description 

Sort/Merge adapts to the separately priced virtual tape 

feature of the Exec. This adapt allows virtual tape files 

to be used as input files, output files, and scratch files 

for a tape sort. 

E1284 Bulk Interface Enhancement to the SORT subroutines UCS C SORT 

linkages to allow passing a block or buffer of records 

between the UCS C program and the SORT subroutines. 

Additional information about this feature can be found 

throughout Sections 7 and 8 and in an example in D.3. 

E1280 DEFBMCORE A new configuration parameter that limits the amount of 

CORE for a basic mode sort for the SORT processor 

when a CORE parameter is not specified (see 9.5). 



18R3. 

Enhancement 

ID 

Feature Name 

Description 

E1153 STOP Parameter New processor parameters that cause the SORT 

processor to end examination of input data. See 3.3.63 

and 3.3.64 for additional information. 

E1149 Delete Duplicate 

Records 

E1140 Extended Mode 

Entry Points 

Allows the SORT processor and SORT subroutines to 

eliminate duplicate key records without the specification 

of user-written data reduction own code (DROC) routine. 

See 3.3.16 and 5.2.30 for additional information. This 

feature also allows a DROC routine to be specified for a 

variable length record sort operation. 

The SORT subroutines have been enhanced to include 

entry points (linkages) for UCS C programs to call the 

extended mode Sort/Merge subroutines. See Sections 7, 

8, and D.1 and D.2 for additional information. 

E1105 I18N Delivery 2 The SORT processor and SORT subroutines have been 

enhanced to allow the specification of keys that are 

ordered according to internationalization (I18N) 

conventions. For additional information see 2.2, 3.3.9, 

3.3.31, 3.3.32, 3.3.37, 5.2.22 through 5.2.24, 9.2, 9.3, 9.7, 

9.19, 11.2.6, and Appendix E. 

1–12 7831 0687–010




18R2. 

Enhancement 

ID 

Feature Name 

E1247 CTS5236 Tape 

Adapt 

Description 

Allows Sort/Merge to access files on the CTS5236 tape 

device. 

E1213 Date Key Adds a new key type to the SORT processor and SORT 

subroutines for sorting 2-digit years with respect to the 

Year 2000. Additional information about this feature can 

be found in 3.3.14, 3.3.31, 3.3.32, 5.2.14, 5.2.22, 5.2.23, 

and 11.2.4. 

E1106 Literal Syntax The SORT processor has been enhanced to allow the 

specification of nonnumeric literals in specific fields of 

some parameters. See 3.2.3 and 3.3.24 for additional 

information. 



18R2. 

Enhancement 

ID 

Feature Name 

Description 

E1213 Date Key Adds a new key type to the SORT processor and SORT 

subroutines for sorting 2-digit years with respect to the 

Year 2000. Additional information about this feature can 

be found in 3.3.14, 3.3.31, 3.3.32, 5.2.14, 5.2.22, 5.2.23, 

and 11.2.4. 

E1106 Literal Syntax The SORT processor has been enhanced to allow the 

specification of nonnumeric literals in specific fields of 

some parameters. See 3.2.3 and 3.3.24 for additional 

information. 

E1024 OST5136 Tape 

Adapt 

This functionality allows Sort/Merge to reference tape files 

on the OST5136 tape device. 

E1014 MSAM Block Size This feature allows the user of the SORT processor more 

control over the size of MSAM file block sizes. For 

additional information, see 3.3.53 and 9.14. 

7831 0687–010 1–13




18R1. 

Enhancement 

ID 

Feature Name 

E1024 OST5136 Tape 

Adapt 


Description 

This functionality allows Sort/Merge to reference tape files 

on the OST5136 tape device. 


17R2. 

Enhancement 

ID 

Feature Name 

Description 

E1070 ExPipe This feature allows the ExPipe product to be used in 

conjunction with the SORT processor. 

E1014 MSAM Block Size This feature allows the user of the SORT processor more 

control over the size of MSAM file block sizes. For 

additional information see 3.3.53 and 9.14. 



17R1. 

Enhancement 

ID 

Feature Name 

E1024 36 Track Tape 

Support 

Description 

Adapt to support 36-track tapes via the CTS 5136 Tape 

Device. Also tape compression recognition is supported. 

E995 Solarization Sort/Merge can now be installed with SOLAR. 



16R1. 

Enhancement 

ID 

Feature Name 

Description 

E953 Error Information This feature provides additional information for some 

SORT subroutine I/O error messages. For additional 

information, see 5.2.18 and A.2. 

E946 Large Files Allows the SORT processor and SORT subroutine to 

access large files (greater than 262143 tracks) as input, 

output, and scratch files. 

1–14 7831 0687–010

1.7. Compatibility 


Sort/Merge maintains upward compatibility whenever possible. However, at times new 

features or defect corrections introduce incompatibilities. The following subsections 

describe the known incompatibilities or potential compatibility issues based on the 

Sort/Merge level. An identifier is also attached to each item to identify the same 

incompatibility issue when it is introduced in more than one symbolic level. Use these 

sections along with 1.5 and 1.6 when moving from one Sort/Merge level to another level 

for determining the incompatibilities you might encounter as a result of the product level 

upgrade. 

1.7.1. SORT Level 22R2B Compatibility 

The following describes the incompatibility introduced in Sort/Merge level 22R2B since 

level 22R2A. 

Compatibility 

ID Description 

C1662 The SORT subroutines are now limited to using 16777215 words of memory 

as opposed to 16777216. Previous levels of SORT could have corrupted one 

word of random records, if 16777216 words of memory were used as the 

CORE area. It is possible that previous levels of SORT could have incorrectly 

sorted some records due to this corruption and it was not detected. With this 

correction, the operation will proceed correctly without any record corruption. 

However, incorrectly sorted records from past sorts could produce an error 

while attempting to use the file as part of a merge operation. In addition, it is 

possible that the reduction of one word of memory for the CORE area could 

cause equivalent records to be ordered differently. 

1.7.2. SORT Level 22R2A Compatibility 

The following describes the incompatibilities introduced in Sort/Merge level 22R2A since 

level 22R2. 

Compatibility 

ID Description 

C1650 Enhancement E1650 modified one of the SORT subroutines LOG messages 

by moving the location of the TOURNAMENT and CORE fields and inserting 

the ORIGINAL RUNID and RUNID fields. If a program at a site reads or 

analyzes the LOG file and processes or examines the LOG for this SORT LOG 

entry, the movement of these fields and the insertion of the new fields might 

cause the LOG analysis program to either no longer find this message or pick 

up the fields incorrectly. The LOG analysis program must be modified to 

handle the new format of this message. SORT 22R2A will issue the new 

format of the message; however, both forms of the message can be issued 

on a system. If a program or product is collected with the SORT subroutines 

included as a relocatable library, the level of SORT used to collect the 

program or product will determine the format of the message issued 

regardless of the installed SORT level. 

7831 0687–010 1–15


1.7.3. SORT Level 22R2 Compatibility 

The following describes the incompatibilities introduced in Sort/Merge level 22R2 since 

level 22R1. 

Compatibility 

ID 

Description 

C1625 The SORT configuration parameter DEFCTYPE is removed as the default codetype 

was always associated with either the locale in force or the CCS 

associated with the input data. The removal of this configuration parameter is 

not expected to cause any problem and in fact the removal was necessary to 

fix a problem related to the specification of a code-type / locale and Fieldata 

data. If an attempt is made to use a previous version of the SORT configuration 

element as the SORT 22R2 configuration element and the DEFCTYPE variable 

is not removed, then the SORT processor will issue error 83 for all operations. 

C1630 Some sorts may change from a memory only to a disk sort or from a basic 

mode sort to an extended mode sort when performing a sort with a small 

volume and variable length records. The change of a sort from a basic mode 

sort to an extended mode sort can cause the output file to be created with a 

different block size which could cause other programs that read that file to 

encounter an error. For instances where this difference occurs, the same 

difference could have occurred without any change to SORT if the input data 

volume had increased such that the sort changed from basic mode to 

extended mode. 

C1634 The SORT processor will now create output MSAM files with the correct 

maximum record size when a SELECT parameter is specified and the input 

file(s) do not contain any records. In prior levels, the SORT processor may have 

set the wrong information in the bits in the last word field of the MSAM file 

label. 

C1643 As with other extremely large tape volumes, the SORT processor assumes that 

any LTO, T9840D, and T10000 tape volumes only contain a data volume of 2 

GB. If input volume on a LTOx, T9840D, or T10000 tape volume is greater than 

2 GB, either the scratch files must be assigned prior to invoking the SORT 

processor or another data volume parameter (e.g., RECORD or NUMBER) must 

be specified. Failure to provide this information might result in an error 

termination of the SORT processor after considerable processing has occurred. 

If the input file is a multi-volume tape file, the above restriction applies only to 

the last volume of the multi-volume set. All volumes other than the last volume 

of a multi-volume tape file set are assumed to be full volumes. 

1–16 7831 0687–010




level 21R1F. 

Compatibility 

ID 

Description 

C1597 In prior levels, the SORT processor or SORT subroutines may have executed 

successfully despite a scratch file having two different names, if the scratch 

file assignments and sort volume were such that usage overlap did not occur 

for the files. Since SORT has now eliminated the duplicate file entry, it is 

possible that the SORT processor / SORT subroutines could fail and issue an 

error due to insufficient resources (in other words, number of scratch files, 

total size of the scratch file, and so on.). It is also possible that the type of sort 

could change, thus causing changes to the remaining scratch files (for 

example, size of a scratch file reduced or scratch file ignored). The chance of 

this incompatibility occurring should be extremely remote. The resolution of 

this incompatibility is to correct the ECL assignment of the scratch files so that 

each scratch file name passed to SORT is assigned to a distinct physical file. 

C1600 The SORT processor for levels 21R1D through 21R1F could have created files 

with an incorrect record size if the first input file was a sequential SDF file, no 

RSZ parameter was specified, and the record length was less than 132 

characters. The SORT processor now creates the file with the correct record 

size, assuming that the input file was not created with an incorrect record size. 

An input file with the incorrect record size could cause unexpected errors to 

exist in other runstreams that reference the file. Some runstreams could fail if 

they were created or updated based upon the incorrect size. These 

runstreams could be other SORT processor calls, COBOL programs, and so on 

that reference the file created by SORT. 

C1603 The SORT subroutines have introduced a new error status, K0. This error 

status is issued if a basic mode sort is being performed and the CORE area 

cannot be allocated due to addressing limitations. This situation occurs only 

when the file R$CORE is used to define the size of the CORE area and a CORE 

parameter is not specified. 

C1606 The SORT processor and SORT subroutines may detect errors previously 

ignored or not detected. These errors are primarily associated with files (input 

files, output files, or tape scratch files) assigned to a tape device. It is more 

likely for additional errors to be detected if tape mark buffering (BUFFIL or 

BUFTAP) is specified. 

C1614 Previously, the SORT processor may have aborted with an I/O or ER 

contingency instead of issuing a processor or subroutine error. The SORT 

processor will now issue a subroutine I/O error message (for example, D5 or 

X4) whenever an error occurs while accessing a scratch file. In addition, SORT 

processor error 3 will be issued instead of an ER contingency when a FILEOUT 

parameter is specified with the dynamic file assignment syntax that contains 

invalid @ASG syntax. 

1.7.5. SORT Level 21R1F Compatibility 

No incompatibilities were introduced in Sort/Merge level 21R1F. 

7831 0687–010 1–17


1.7.6. SORT Level 21R1E Compatibility 

The following describes the incompatibilities introduced in Sort/Merge level 21R1E since 

level 21R1D. 

Compatibility 

ID 

Description 

C1585 The level 21R1D SORT processor may have processed the wrong input SDF 

file if the file resided on a tape device and the MOVE parameter was specified. 

SORT 21R1E now processes the correct file. 

C1586 Prior to installing RDMS 14R1 in any application group, SORT 21R1E must be 

installed. The SORT/RDMS interface has changed due to RDMS introducing 

character columns associated with the UCS-2 character set. Having an 

incorrect level of SORT installed will cause a 33840 (B0) or 34361 (C9) error to 

be returned to RDMS level 14R1 or higher for all RDMS functions that call the 

SORT subroutines. SORT 21R1E interfaces properly with RDMS levels prior to 

14R1. 

C1588 For some small volume sorts, the SORT processor may now choose an 

Extended Mode sort instead of a Basic Mode sort. This decision has always 

been internal unless an explicit direction was indicated via parameter 

specification or scratch file assignment. 

If the SORT processor now performs an Extended Mode sort instead of a Basic 

Mode sort, the output file block size may be different from the previous levels 

of SORT. This happens primarily when the output file has a MODE=SDF. This 

difference in sizes is not a new incompatibility but a side effect of the SORT 

processor choosing an Extended Mode sort. If the input volume had been 

slightly larger, the SORT processor would have chosen an Extended Mode sort 

and the same output block size issue would have also existed. A Basic Mode 

sort is still performed if the only input is from the default symbiont file 

(FILEIN=CARDS MODE=CARDS). 

1.7.7. SORT Level 21R1D Compatibility 

The following describes the incompatibilities introduced in Sort/Merge level 21R1D since 

level 21R1C. 

Compatibility 

ID 

Description 

C1580 The SORT processor now correctly sorts data for a SELECT or TAG sort 

when a Fieldata key type (A, D, G, L, or P) or a binary key type (B, J, M, or U) 

is specified. The level 21R1C SORT processor may have incorrectly sorted 

the records but did not cause any data corruption. Prior to SORT 21R1C, the 

data was correctly sorted. 

1–18 7831 0687–010

Compatibility 

ID 

Description 


C1582 As with other extremely large tape volumes, the SORT processor assumes 

that CTC9840 (U9840C) tape volumes only contain a data volume of 2 GB. If 

the input volume on a CTC9840 (U9840C) tape volume is greater than 2 GB, 

either scratch files must be assigned prior to invoking the SORT processor or 

another data volume parameter (for example, RECORD or NUMREC) must be 

specified. Failure to provide this information may result in an error 

termination of the SORT processor after considerable processing has 

occurred. 

1.7.8. SORT Level 21R1C Compatibility 

The following describes the incompatibilities introduced in Sort/Merge level 21R1C since 

level 21R1B. 

Compatibility 

ID 

Description 

C1556 MSAM files created by the SORT processor may cause other programs to 

receive errors due to slight changes in the size of the record in the MSAM file. 

An RSZ parameter that specifies a nonword multiple size must be specified. 

C1561 Warning message 165 is now issued when an input record is truncated by the 

SORT processor. 

C1563 The SORT processor now space-fills output record fields when the length of 

the input record is shorter than the specified SELECT field. Previously, the 

content of the SELECT field character positions beyond the end of the input 

record were unpredictable. This unpredictability could cause problems for 

programs that relied upon this incorrect data. 

C1565 The level 21R1C SORT processor creates MODE=SDF file with a different 

record size than in level 21R1, 21R1A, or 21R1B for a COPY operation, when 

multiple input files are specified with different record sizes. 

C1567 As with other extremely large tape volumes, the SORT processor assumes that 

CTS9940B tape volumes only contain a data volume of 2 GB. If the input 

volume on a CTS9940B tape volume is greater than 2 GB, either scratch files 

must be assigned prior to invoking the SORT processor or another data 

volume parameter (for example, RECORD or NUMREC) must be specified. 

Failure to provide this information may result in an error termination of the 

SORT processor after considerable processing has occurred. 

C1568 The SORT processor now properly handles a MOVE parameter with a value 

greater than 63. Prior to level 21R1C, the SORT processor would truncate any 

MOVE parameter value greater than 63. This change causes the proper file to 

be processed, while previously an incorrect file was processed. 

C1569 The level 21R1A and 21R1B SORT processor could create MSAM files with an 

incorrect maximum record length if a SELECT parameter is specified and a RSZ 

parameter is specified. The incorrect maximum record size occurs if the size of 

the SELECT parameter is smaller than the RSZ parameter. This error could 

cause other programs to be unable to read the MSAM file and/or to receive an 

error. 

7831 0687–010 1–19


Compatibility 

ID 

Description 

C1571 ANSI files created by the SORT processor for a COPY or MERGE operation 

may have a different size than ANSI files created by SORT processor levels 

21R1, 21R1A, or 21R1B. This may cause another program or processor to 

encounter an error, if the program or runstream information was based on an 

incorrect size produced by one of these SORT processor levels. 


No incompatibilities were introduced in Sort/Merge level 21R1B. 



level 21R1. 

Compatibility 

ID 

Description 

C1521 The SORT processor may create the output file with a different record size and 

block size when a SELECT parameter is specified and the record size of the 

input file is not the same as the SELECT parameter. The record size now used 

is documented in subsection 3.3.54, Table 3-3. The change in the block and 

record size may cause problems or errors for other programs or processors 

attempting to process a SORT-created file. 



level 20R2A. 

Compatibility 

ID 

Description 

C1468 Incompatibilities will exist if invocations to existing Sort or Merge interfaces 

have nonzero garbage values contained in the new length granularity fields. 

In SORT levels prior to level 21R1, some of these fields were reserved while 

others were undefined, and the SORT subroutines did not enforce that these 

fields contain a zero value. If these fields contain garbage values, a SORT 

error or record truncation/corruption could now occur. In particular, the 

Record Information Packet of the SORT subroutines C linkages should be 

cleared prior to setting values in the individual fields of the packet. 

1–20 7831 0687–010

Compatibility 

ID 

Description 


If you create a relocatable, object module, or absolute on a system using the 

common banked MASM linkages or the C linkages with SORT level 21R1 or 

higher installed, and then execute the program on a different system where 

an earlier level of SORT is installed, an undetected backward incompatibility 

problem may exist. Normally, this is not an issue because an unrecognized 

parameter specification is diagnosed by the SORT processor or an assembly 

or compilation error is issued when an undefined field is referenced. 

However, in this case it is possible that the subroutine errors may not be 

detected. If an error is not detected by the SORT subroutines, the potential 

side effects of this situation include record truncation or a Storage 

Limits/Write Protection Violation. 

Sort/Merge now creates PCIOS system data format (SDF) files containing a 

processor code value of 04 instead of 05. This change occurs whether or not 

enhancement E1468 is enabled or used and should cause few (if any) 

incompatibilities. 

The SORT processor now correctly sets the significant bits in the last word 

field when creating PCIOS SSDF and DSDF files. 

As a result of enhancement E1468, the record size used by the SORT 

processor to create MODE=ANSI, MODE=DSDF, MODE=MSAM, and 

MODE=SDF files may differ from previous SORT levels. A change in the 

record size or block size can cause problems or errors when these files are 

subsequently processed by the SORT processor or other programs or 

processors. In most cases, the setting of the significant bits in the last word 

of MODE=SDF and MODE=DSDF files is not sufficient to cause 

incompatibility problems. 

Compatibility issues with record size changes are most likely to be seen 

when creating one of the above four file types along with any or all of the 

following conditions: 

• A COPY or MERGE operation being performed. 

• An inaccurate RSZ parameter or no RSZ parameter. 

• Multiple input files with different record sizes, usually when the first 

input file does not contain the longest records. 

• A PCIOS SSDF or DSDF input file containing bit length information (file 

originator equals 2, 3, or 4). 

• An RSZ parameter with a record size that is within the last word of the 

actual record size but less than a complete last word. Note that this 

condition is most likely to affect the record size of MSAM and ANSI 

output files. 

The record size used by the SORT processor to create the output file should 

be as documented in 3.3.54, Table 3-3. Most of the information in this table 

is unchanged, except that record sizes now apply to the bit length level as 

opposed to word length. Under some of the above circumstances, previous 

levels of the SORT processor did not always follow these rules. 

7831 0687–010 1–21




level 20R2. 

Compatibility 

ID 

Description 

C1454 The SORT processor now correctly accepts or rejects records via the ACCEPT 

and STOP parameter when 

• The data type is ASC and the test-value field of the ACCEPT or STOP 

parameter contains a character represented by the encoding values 0100, 

0133-0140, or 0173-0177. 

• The data type field is ASC and the record contains data with encoding 

values 0100, 0133-0140, or 0173-0177 in the character positions 

associated with the ACCEPT or STOP parameter. 

This difference could result in different records being accepted via the ACCEPT 

parameter and a different input termination point be determined for the STOP 

parameter. 

Enhancement E1454 could also cause the SORT processor to issue error 7, 86, 

or 130 when the ACCEPT or STOP parameter has a data type field of ASC or 

CAS and the first character of the value field is an apostrophe (') or a quotation 

mark ("). 



level 20R1D. 

Compatibility 

ID 

Description 

C1447 The SORT processor now creates the output file with a record length as 

documented in this guide. As a result, the record size and the block size used 

by the SORT processor to create the output file may be different than previous 

levels. The change in the record size and/or block size may cause programs 

that read the output file to issue errors. The difference in the record size will 

most likely occur when two or more input files are specified and the record 

length of the first input file is not the longest. It is also possible that important 

data could now be truncated due to the use of the smaller record size. 

C1453 The UCS C SORT linkages will no longer corrupt the last word of every record 

when a PRESERVE parameter is specified and a fixed length record sort is 

requested. 

1–22 7831 0687–010

1.7.14. SORT Level 20R1D Compatibility 


The following describes the incompatibilities introduced in Sort/Merge level 20R1D since 

level 20R1C. 

Compatibility 

ID 

Description 

C1432 The SORT UCS C macro sm_start_char_to_start_word will now produce the 

correct value. As the key is now defined in the correct but different location, 

different results or various errors may be encountered depending upon the 

data in the records and how the sorted records were subsequently used. 

C1433 The SORT subroutines will now correctly sort an RDMS I18N column when the 

SORT subroutines are called from RDMS and the RDMS I18N column is 

specified in an ORDERED BY or DISTINCT phrase. 

1.7.15. SORT Level 20R1C Compatibility 

The following describes the incompatibilities introduced in Sort/Merge level 20R1C since 

level 20R1B. 

Compatibility 

ID 

Description 

C1385 The SORT processor may allow different records to be processed when a 

ACCEPT, ALLOW, REJECT, or STOP parameter is specified. If an input record 

is shorter than the field location specified the SORT processor allows the 

condition specified by the parameter to fail. For the ACCEPT and ALLOW 

parameters, some records may not be processed, even though they were 

processed previously. For the REJECT parameter, some records may be 

processed, even if previously they were rejected. For the STOP parameter, the 

input termination condition may not be encountered in the same location and 

results in additional records from an individual file or all files to be processed. 

C1403 The SORT processor now creates a correct tape label on the second and later 

tape volumes of the output file. Previous levels of Sort/Merge may have 

created these volumes of the tape output file with incorrect FILE–ID, expiration 

date, etc. information. 

C1411 As a result of enhancement E1411, input files residing on CTS5236 tape 

devices will be assumed to reside on an EE tape. Since the SORT processor 

has no method to determine the actual type of tape mounted, when the 

volume mounted is not an EE tape the enhancement will cause larger scratch 

facilities to be requested which may cause excessively sized scratch files to be 

assigned. This increase in the scratch facilities may also cause some runs to 

abort due to quota limits. 

7831 0687–010 1–23


Compatibility 

ID 

Description 

C1416 The SORT processor previously had always assumed that any input tape 

volume was a completely full tape volume. With the extremely large tape 

volumes associated with the CTS9840 tape system, the SORT processor will 

assume these tape volumes only contain a data volume of 2 GB. If the input 

volume on a CTS9840 tape volume is greater than 2 GB, either scratch files 

MUST be assigned prior to invoking the SORT processor or another data 

volume parameter (for example, RECORD or NUMREC) must be specified. 

Failure to provide this information may result in an error termination of the 

SORT processor after considerable processing has occurred. 


The following describes the incompatibilities introduced in Sort/Merge level 20R1B since 

level 20R1A. 

Compatibility 

ID 

Description 

C1376 The SORT processor incorrectly underestimated or overestimated the size of 

most tape files. This defect has been corrected and all tape files, except those 

noted in C1380, will be assumed to be full tape volumes. This may cause large 

scratch files to be assigned by the SORT processor. In some circumstances, 

the SORT processor may be unable to assign these larger files, which causes 

various error messages to be issued. 

C1380 The SORT processor previously has always assumed that any input tape 

volume was a complete full tape volume. With the introduction of the 

extremely large tape volumes associated with the DLT7000 tape system, the 

SORT processor assumes that these tape volumes only contain a data volume 

of 2 GB. If the input data volume on these tape volumes is greater that 2 GB, 

either scratch files MUST be assigned prior to invoking the SORT processor or 

another data volume indicator (for example, RECORD or NUMERC parameter) 

must be specified. Failure to provide this information may result in an error 

termination of the SORT processor after considerable processing has occurred. 

1–24 7831 0687–010




level 20R1. 

Compatibility 

ID 

Description 

C1365 The SORT processor in level 20R1 at times underestimated the size of a virtual 

tape file (VTH). The maximum size of a VTH file will now be correctly 

estimated which may cause larger scratch files to be assigned. In some 

circumstances, the SORT processor may be unable to assign these larger files, 

which causes various error messages to be issued. 

C1372 The SORT subroutines Sort Close and Merge Close linkages now will always 

release all data areas allocated by the extended mode SORT subroutines. This 

was the intent in previous levels, but under certain circumstances some areas 

were not released. 



level 19R1. 

Compatibility 

ID 

Description 

C1334 As a result of enhancement E1284, the SORT subroutines UCS C Release 

Linkage now requires that the record length field of the record information 

packet parameter be set for a fixed length sort operation. Previously, the 

length of the record was assumed to be equal to the RSZ parameter. As a 

result, some existing sort operations may receive an unexpected result status. 

C1316 If the UFTN FSORT or FMERGE statements are used to call the SORT 

subroutines and a COMP or DROC routine is specified, URTS level 9R1A or 

higher is required. 

C1309 The SORT subroutines may allocate an additional bank when performing an 

extended mode sort. This causes an increase in the total amount of memory 

used but should eliminate many X0 or X8 errors while improving the 

performance of most large sorts. 

C1286 As a result of enhancement E1284, some calls to the UCS C sort release and 

UCS C sort return linkages that previously failed may now return with a 

nonfailure result status. Thus, the UCS C program can be written to recover 

from the error and continue the operation. In addition, record padding and 

record truncation capabilities have been implemented for the UCS C sort 

release and UCS C sort return linkages. Releasing a record via the UCS C sort 

release linkage with a length longer than the RSZ parameter will now cause a 

record truncation result status to be returned (a nonfailure condition) instead of 

a failure result status. 

7831 0687–010 1–25


Compatibility 

ID 

Description 

C1280 If the value assigned to the DEFBMCORE configuration parameter is reduced 

from the default value of 210000, some sorts will be changed from a basic 

mode sort to an extended mode sort while preventing many 79 errors. In a 

few instances, it might be possible that a sort that previously completed may 

now fail if the AUTOMATIC configuration parameter is set to NO. 



level 18R3. 

Compatibility 

ID 

Description 

C1290 A new format to the SORT subroutines KEY and KEYW parameter exists. This 

new format exists when a second continuation entry is specified. If existing 

KEY parameters contained two continuation entries, the new definition is 

assumed. Previously, the second continuation entry was ignored. As a result 

of this change, the maximum word offset where a key can begin within a 

record has been increased. 

C1201 As part of enhancement E1105, the SORT subroutines MASM merge common 

banked linkages and the UCS C merge linkages are directed to an extended 

mode merge operation. An early termination of the merge operation may 

cause banks to remain allocated unless a merge close linkage is called. 

C1153 If the SORT processor is assigning the scratch files, the processor may 

overestimate the scratch file size when a significant number of records remain 

after the STOP condition has been met. 

C1149 If you specify the OWN processor parameter with exit numbers 14 or 21 or the 

COMP subroutine parameter, any key translation as a result of specifying the 

KEY parameters no longer occurs. This may affect SORT runstreams where a 

user data reduction routine is specified with a user compare routine and a key 

parameter. It can also affect the user compare routine because the key 

translation will no longer occur. 

C1140 As a result of enhancement E1140, Sort/Merge can no longer be installed with 

COMUS. 

C1105 As part of enhancement E1105, SDF, DSDF, and PRINT files may be created 

with a code type other than 0 or 1. This should not be a problem for Unisys 

products, but user programs/products that expect a code type of 0 or 1 could 

encounter problems. 

Enhancement E1105 also causes Sort/Merge to require URTS level 9R1 or 

higher if any UCS sort or merge interface is requested. 

1–26 7831 0687–010




level 18R2. 

Compatibility 

ID 

Description 

C1106 SORT processor runstreams where the file-identifier of the FILEID parameter 

begins with an apostrophe or a quotation mark will fail because the SORT 

processor now considers that as a nonnumeric literal. 



level 17R2A. 

Compatibility 

ID 

Description 

C1133 The SORT processor now uses ER SYMB$ to create PRINT and CARD files. 

Records that end with trailing spaces no longer have these spaces implicitly 

truncated. Thus, the records written to the file may be longer than in previous 

levels and the file sizes may expand. Trailing spaces can be explicitly truncated 

via the SORT processor T option. 

C1106 SORT processor runstreams where the file-identifier of the FILEID parameter 

begins with an apostrophe or a quotation mark will fail because the SORT 

processor now considers that as a nonnumeric literal. 



level 18R1A. 

Compatibility 

ID 

Description 

C1133 The SORT processor now uses ER SYMB$ to create PRINT and CARD files. 

Records that end with trailing spaces will no longer have these spaces 

implicitly truncated. Thus, the records written to the file may be longer than in 

previous levels and the size of files may expand. Trailing spaces can be 

explicitly truncated with the SORT processor T option. 


No incompatibilities were introduced in Sort/Merge level 18R1A. 


No incompatibilities were introduced in Sort/Merge level 18R1. 

7831 0687–010 1–27



No incompatibilities were introduced in Sort/Merge level 17R2A. 



level 17R1. 

Compatibility 

ID 

Description 

C1024 As part of enhancement E1024, the SORT processor now recognizes 

compression when determining the volume of data on a cartridge tape. This 

changes the size of scratch files assigned by the SORT processor, which could 

cause the quota limits to be exceeded as well as change the information 

provided by the ESTIMATE operation. 

C999 The minimum D-bank size increased from 0200 words to 0500 words for calls 

to the merge linkages in the SORT subroutines. This change was necessary to 

provide additional workspace for the merge operation as well as provide room 

for future enhancements. 

C995 The format of the Sort/Merge release tape has changed as a result of 

enhancement E995. 

1–28 7831 0687–010

Section 2 

Basic Mode versus Extended Mode 

Selection 

This section discusses the selection of basic mode and extended mode as the 

environment for using either the SORT processor or the SORT subroutines. 

2.1. OS 2200 Environments 

Unisys supports two environments on OS 2200 systems: 

• The basic mode environment 

• The extended mode environment 

You can direct the SORT processor or the SORT subroutines to perform the sort 

operation you desire in either of the two environments, as shown in Table 2–1. 

Table 2–1. Sort/Merge Environment Operations 

Environment Sort Operation Description 

Basic mode Basic mode sort The SORT processor and the SORT subroutines perform 

a memory, disk, one-level mass storage, two-level mass 

storage, or tape sort using a basic mode memory area of 

up to 262K words. 

Extended mode Extended mode 

sort 

For large sorts, the SORT processor and the SORT 

subroutines are unable to access the extended memory 

capacity of current OS 2200 systems. 

The SORT processor and the SORT subroutines perform 

a memory or disk sort using an extended memory area 

of up to 16 megawords (16,777,216 words). The actual 

memory that can be used is based on the configuration 

of the Sort/Merge product at your site. 

For large sorts, significant performance gains result from 

using extended memory. 

7831 0687–010 2–1

Basic Mode versus Extended Mode Selection 

2.2. Using the SORT Processor in Extended Mode 

To cause the SORT processor to unconditionally perform an extended mode sort, use 

the ESORT parameter (see 3.3.21) or I key type (see 3.3.31). 

Do not specify the ESORT parameter or I key type when one of the following conditions 

exists, since these conditions prevent the selection of an extended mode sort: 

• The X option is specified on the SORT processor call statement (see 3.1). 

• The DRUM, FAST, or TAPE parameter is present. 

• A one-level (M1) or a two-level (M1–M2) mass storage sort is requested. 

• A sort scratch file (XA, XB, ..., XZ) is assigned to a tape device. 

Table 2–2 and Table 2–3 summarize the extended mode sort versus basic mode sort 

selection process when none of the above conditions exist and the Y option is not 

specified on the SORT processor call statement. 

When the Y option is specified on the SORT processor call statement a basic mode core 

sort or an extended mode core sort is performed. If the ESORT parameter or an I key is 

specified, an extended mode sort is always performed. Table 2–4 summarizes the 

extended mode sort versus basic mode sort selection process when the Y option is 

specified on the SORT processor call statement. 

Note: Use the terms and their equivalents below with the following tables: 

• MAXIMUM – MAXIMUM configuration parameter value 

• MINIMUM – MINIMUM configuration parameter value 

• DEFBMCORE – DEFBMCORE configuration parameter value 

2–2 7831 0687–010


Table 2–2. SORT Processor Extended Mode Selection, AUTOMATIC Set to YES 

Scratch 

Files 

Specified 

CORE Parameter Size (CS) 

Data Volume (DV) 

Sort Type 

Actual Sort 

Core Size 

None None DV < MINIMUM EM, Core MINIMUM 

None MINIMUM < DV < MAXIMUM EM, Core DV 

None DV > MAXIMUM EM, Disk MAXIMUM 

CS < 10000 DV < 10000 BM, Core 10000 

CS < 10000 DV >10000 BM, Disk 10000 

10000 < CS < 210000 DV < CS BM, Core CS 

10000 < CS < 210000 DV >CS BM, Disk CS 

210000 < CS < MINIMUM DV < MINIMUM EM, Core MINIMUM 

210000 < CS < MINIMUM DV > MINIMUM EM, Disk MINIMUM 

MINIMUM < CS < 

MAXIMUM 


MAXIMUM 

DV < CS EM, Core CS 

DV >CS EM, Disk CS 

CS > MAXIMUM DV < MAXIMUM EM, Core MAXIMUM 

CS > MAXIMUM DV > MAXIMUM EM, Disk MAXIMUM 

Yes None DV < MINIMUM EM, Disk MINIMUM 

None MINIMUM < DV < MAXIMUM EM, Disk DV 

None DV > MAXIMUM EM, Disk MAXIMUM 

CS < 10000 – – – BM, Disk 10000 

10000 < CS < 210000 – – – BM, Disk CS 

210000 < CS < MINIMUM – – – EM, Disk MINIMUM 


MAXIMUM 

– – – EM, Disk CS 

CS > MAXIMUM – – – EM, Disk MAXIMUM 

7831 0687–010 2–3


Table 2–3. SORT Processor Extended Mode Selection, AUTOMATIC Set to NO 

Scratch 

Files 

Specified 




None None DV < 10000 BM, Core 10000 

None 10000 < DV < DEFBMCORE BM, Core DV 


Core Size 

None DV >DEFBMCORE BM, Disk DEFBMCORE 

CS < 10000 DV < 10000 BM, Core 10000 

CS < 10000 DV >10000 BM, Disk 10000 


10000 < CS < 210000 DV >CS BM, Disk CS 


210000 < CS < MINIMUM DV > MINIMUM EM, Disk MINIMUM 


MAXIMUM 


MAXIMUM 


DV >CS EM, Disk CS 


CS > MAXIMUM DV > MAXIMUM EM, Disk MAXIMUM 

Yes None DV < 10000 BM, Disk 10000 

None 10000 < DV < DEFBMCORE BM, Disk DV 

None DV >DEFBMCORE BM, Disk DEFBMCORE 

CS < 10000 – – – BM, Disk 10000 

10000 < CS < 210000 – – – BM, Disk CS 

210000 < CS < MINIMUM – – – EM, Disk MINIMUM 


MAXIMUM 

– – – EM, Disk CS 

CS > MAXIMUM – – – EM, Disk MAXIMUM 

2–4 7831 0687–010


Table 2–4. SORT Processor Extended Mode Selection, Y Option Specified 

AUTOMATIC 

Configuration 

Parameter 





Core Size 

Yes None DV < MINIMUM EM, Core MINIMUM 

None MINIMUM < DV < MAXIMUM EM, Core DV 

None DV > MAXIMUM ERROR 

CS < 10000 DV < CS BM, Core 10000 

CS < 10000 DV >CS ERROR 


10000 < CS < 210000 DV >CS ERROR 


210000 < CS < MINIMUM DV > MINIMUM ERROR 


MAXIMUM 


MAXIMUM 


DV >CS ERROR 


CS > MAXIMUM DV > MAXIMUM ERROR 

No None DV < 10000 BM, Core 10000 

None 10000 < DV < DEFBMCORE BM, Core DV 

None DV >DEFBMCORE ERROR 

CS < 10000 DV < CS BM, Core 10000 

CS < 10000 DV >CS ERROR 


10000 < CS < 210000 DV >CS ERROR 


210000 < CS < MINIMUM DV > MINIMUM ERROR 


MAXIMUM 


MAXIMUM 


DV >CS ERROR 


CS > MAXIMUM DV > MAXIMUM ERROR 

7831 0687–010 2–5


2.3. Using the SORT Subroutines in Extended Mode 

Like the SORT processor, the SORT subroutines can also perform an extended mode 

sort. You direct the SORT subroutines to perform an extended mode sort in either of 

two ways: 

• By passing a CORE parameter table entry specifying a core size greater than 210,000 

words 

• By assigning an R$CORE file with a maximum granularity exceeding 210 

If you do not specify the CORE parameter table entry, an R$CORE file must be assigned 

before you execute the sort open call. If neither a CORE parameter table nor an 

R$CORE file is specified, the SORT subroutines terminate the sort with an error. 

The SORT subroutines use a set of factors to select an extended mode sort, as shown in 

Table 2–5. 

Table 2–5. SORT Subroutines Extended Mode Selection 

Core Parameter Table Entry R$CORE 

Specified Core Size Size SORT Chosen Memory Size Allocated 

Yes (no 77 entries) < 210000 

>210000 

Yes (one 77 entry) < 262143 

>262143 

Yes (two 77 entries) < 210000 

>210000 

No Not specified 

Not specified 

Ignored 

Ignored 

Ignored 

Ignored 

Ignored 

Ignored 

< 210000 

>210000 

Extended mode 

Extended mode 

Basic mode 

Error * 

Error * 

Extended mode 

Basic mode 

Extended mode 

* See A.2 for a listing of the SORT subroutines diagnostic messages. 

Notes: 

CORE parameter size 


CORE parameter 

Not applicable 

Not applicable 


(no MINIMUM or 

MAXIMUM checks) 

R$CORE size 

R$CORE size 

• When extended mode is selected, the core size allocated is never less than 

MINIMUM configuration parameter or greater than MAXIMUM configuration 

parameter, except where noted. 

• The R$CORE size is 1,000 times the maximum granularity specified on the R$CORE 

assignment statement. 

2–6 7831 0687–010

Section 3 

The SORT Processor 

This section describes the SORT processor in detail, including 

• How to call the SORT processor 

• Which SORT processor options are available to you 

• How to specify SORT processor parameters to control the sort operations you 

perform 

• What the SORT processor parameters are, notably 

− When to use them 

− What considerations apply to them 

− The exact format of the parameter specifications 

3.1. Activating the SORT Processor 

Activate the SORT processor with Executive Control Language (ECL) using one of the 

following processor calls: 

SORT processor call for reentrant sort 

@SORT [,options] 

SORT processor call for nonreentrant sort 

@SORTNR [,options] 

where options is one or more of the following values. 

Option Description 

A All files are ACOB data files with ASCII character data. You can override this 

option on individual files with the MODE parameter (see MODE in 3.3.40). This 

is the default SORT processor option. 

C All files are COBOL File Handler (CFH) data files with Fieldata character data. 

You can override this option on individual files with the MODE parameter (see 

MODE in 3.3.40). 

E Print the sort input parameters after reading them. This is the default in batch 

mode. 

I All input ACOB or CFH files are single buffered. The default is double buffering. 

7831 0687–010 3–1


Option Description 

K This option indicates that the only output you want is a printed listing of the 

sorted records. However, if the K option is specified for a TAG operation, a 

TAGFILE is created. Prints any size record with no truncation. 

L Print a listing of the sorted output records. Prints any size record with no 

truncation. 

M All data is in Fieldata characters. If you use the M option with the A or S option, 

the character type is equivalent to DATA=FIELDATA (see DATA in 3.3.13). 

O The output file is a single buffered ACOB or CFH file. The default is double 

buffering. 

S All files are system data format (SDF) files with ASCII character data. Do not 

use this option for files produced by symbionts (PRINT$ and SYMB$). You can 

override this option with the MODE parameter (see MODE in 3.3.40). 

T Truncate trailing spaces in records after a sort. Does not preserve spaces that 

were originally in the input records. 

X Perform a one-level mass storage (M1) sort with an internally or externally 

assigned file called XA. All other externally assigned scratch files are ignored. 

Y Perform a memory-only sort; no scratch files are used. All externally assigned 

scratch files are ignored. 

Z Open all input files simultaneously during a sort or copy operation. Normally all 

records from one input file are read before the next file is opened. You must 

assign all input files before calling the SORT processor. Do not use this option 

for a merge operation. 

3.2. Using Parameter Specifications 

After you call the SORT processor, you supply the parameters that control its operation 

by defining the following: 

• Type of operation to perform 

• Format of the input files and the output file 

• Character type of the records to be processed 

• Number of records to process 

• Key field definitions 

3–2 7831 0687–010

3.2.1. Types of Parameters 

There are two types of SORT processor parameters: 

• Global parameters 


You can use these parameters anywhere within the parameter specifications to 

define the following: 

− The working environment in which the operation takes place. 

− The attributes of the input files and the output file. The attributes of the input 

and output files are always the same unless you change an attribute using the 

local parameters. 

• Local parameters 

These parameters define the attributes of the input file or files or the output file and 

can override global parameters. You can only use these parameters with the 

following three file identification parameters (see 3.2.6): 

− FILEIN 

Specifies an input file to the SORT processor; required for all operations 

(see 3.3.25) 

− FILESIN 

Specifies one or more input files to the SORT processor (see 3.3.27) 

− FILEOUT 

Specifies the output file for the SORT processor (see 3.3.26) 

Table 3–1 defines the global and local parameters and indicates the subsection where 

you can find the particular SORT processor parameter. 

Parameter 

Table 3–1. SORT Processor Global/Local Parameters 

Local FILEIN Local 

FILESIN 

Local 

FILEOUT 

Global 

Reference 

ACCEPT X 3.3.1 

ALLOW X 3.3.2 

BIAS X 3.3.3 

BLOCK X X X X 3.3.4 

BMBLOCK X 3.3.5 

CHECK X 3.3.6 

CHECKSUM X 3.3.7 

CKPT X 3.3.8 

CODE–TYPE X 3.3.9 

7831 0687–010 3–3


Parameter 



FILESIN 

Local 

FILEOUT 

Global 

Reference 

CONSOLE X 3.3.10 

COPY X 3.3.11 

CORE X 3.3.12 

DATA X 3.3.13 

DEFYEAR X 3.3.14 

DELCON X 3.3.15 

DELDUPS X 3.3.16 

DELLOG X 3.3.17 

DISKS X 3.3.18 

DRUM X 3.3.19 

EQUIP X X X X 3.3.20 

ESORT X 3.3.21 

ESTIMATE X 3.3.22 

FAST X 3.3.23 

FILEID X X X 3.3.24 

ISKEY X 3.3.28 

ISKEYW X 3.3.29 

JOIN X X 3.3.30 

KEY X 3.3.31 

KEYW X 3.3.32 

LABEL X X X X 3.3.33 

LIMDRM X 3.3.34 

LIMFST X 3.3.35 

LINKSZ X 3.3.36 

LOCALE X 3.3.37 

LOG X 3.3.38 

MERGE X 3.3.39 

MODE X X X X 3.3.40 

MOVE X X X 3.3.41 

MSKEY X 3.3.42 

MSKEYW X 3.3.43 

3–4 7831 0687–010

Parameter 



FILESIN 

Local 

FILEOUT 


Global 

Reference 

NUMREC X X X 3.3.44 

OWN X 3.3.45 

PREP X X X X 3.3.46 

PRESERVE X 3.3.47 

PROCESSING X 3.3.48 

RECORD X 3.3.49 

REELS X X 3.3.50 

REJECT X 3.3.51 

RETRIEVE X 3.3.52 

REVMSAMBLK X 3.3.53 

RSZ X 3.3.54 

SELECT X X X 3.3.55 

SEQ X 3.3.56 

SEQA X 3.3.57 

SEQC X 3.3.58 

SEQX X 3.3.59 

SKIPL X X 3.3.60 

SORT X 3.3.61 

SPLIT X 3.3.62 

STOP X 3.3.63 

STOPAPP X X 3.3.64 

TAG X 3.3.65 

TAGFILE X 3.3.66 

TAPES X 3.3.67 

VOLUME X 3.3.68 

7831 0687–010 3–5


3.2.2. SORT Processor Program Structure 

The general structure of a SORT processor program execution includes global, local, and 

file parameters, as follows: 

@SORT,options 

global-parameter-a1 global-parameter-a2 ... global-parameter-an 

. 

. 

. 

FILEIN=filename local-parameter-a1 local-parameter-a2 ; 

local-parameter-a3 ... local-parameter-an 

global-parameter-b1 ... global-parameter-bn 

global-parameter-c1 

global-parameter-d1 

FILESIN=filename2,filename3 ... filename4 local-parameter-b1 ; 

local-parameter-b2 local-parameter-b3 ... local-parameter-bn 

global-parameter-e1 

FILEOUT=outfile local-parameter-c1 local-parameter-c2 ; 

local-parameter-c3 ... local-parameter-cn 

global-parameter-f1 

global-parameter-g1 

. 

. 

. 

@EOF 

As you can see from the preceding structure, you can insert global parameters anywhere 

between the processor call line (@SORT,options) and the @EOF. However, local 

parameters are only allowed following a FILEIN (see 3.3.25), FILESIN (see 3.3.27), or 

FILEOUT (see 3.3.26) parameter. 

See 3.2.1 for the definitions of the global and local parameters. See Appendix B for 

more examples using SORT processor parameters and options. 

3.2.3. Syntax Rules for SORT Processor Parameter 

Specifications 

The SORT processor parameter specification is described in this subsection. 

Format 

parameter-name [ = field-1 [,field-2] ... ] 

where 

parameter-name 

is a parameter recognized by the SORT processor. 

3–6 7831 0687–010

field-n 


is either an integer, a decimal, a Fieldata character string, an ASCII character string, 

or a nonnumeric literal, as defined by the individual parameter descriptions. All 

character strings are recognized as Fieldata character strings except for those 

parameters that have fields that allow ASCII character strings and provide a way to 

specify it as such. Nonnumeric literals are not limited to the Fieldata or ASCII 

character sets. A nonnumeric literal can contain any character in the computer’s 

character set. 

The following syntax rules apply to all SORT processor parameter specifications: 

• You must separate parameters on a single input line by one or more spaces. No 

spaces are allowed within a parameter specification. One or more spaces can 

appear before the first parameter on an input line. 

• You must use a semicolon ( ; ) to continue a parameter specification onto the next 

input line. You can begin the continuation line with spaces if the parameter 

specification that began on the previous line ends with a comma directly followed by 

a semicolon ( ,; ), otherwise, no spaces are allowed within a continued parameter 

specification. 

Example 

The following example shows a parameter that continues on a second line, with a 

comment on the first line: 

FILEIN=TAPE3 BLOCK=30,RECORDS MODE=ANSI ; .Input file definition 

LABEL=STANDARD 

• A period ( . ) with at least one preceding space terminates syntax scanning; 

therefore, you can add comments after the period. 

• A nonnumeric literal is described by the following: 

General Format 

{ ’ } {character-1} ... { ’ } 

or 

{ ” } {character-1} ... { ” } 

Syntax Rules 

1. Character-1 can be any character in the computer character set. 

2. If character-1 is to represent a quotation mark (042), and the literal is delimited 

by a quotation mark, you must use two contiguous quotation mark characters to 

represent a single occurrence of that character. 

3. If character-1 is to represent an apostrophe (047), and the literal is delimited by 

an apostrophe, you must use two contiguous apostrophe characters to 

represent a single occurrence of that character. 

7831 0687–010 3–7


General Rules 

1. A nonnumeric literal can be 1 through 82 characters in length. 

2. The value of a nonnumeric literal in the processor runstream is the value 

represented by character-1 or the combination thereof. 

3. The apostrophe or quotation mark that delimits the nonnumeric literal is not part 

of the value of the literal string. 

4. The space, comma, and semicolon are treated as part of the nonnumeric literal 

and do not have their normal syntactical meanings when embedded within the 

delimiters of the nonnumeric literal. 

3.2.4. Syntax Rules for Local Parameter Specifications 

The following syntax rules apply only to local parameter specifications: 

• The format for a local parameter specification is: 

file-identification-parameter local-parameter-1 ...local-parameter-a; 

local-parameter-b local-parameter-c. 

where file-identification-parameter is FILEIN, FILESIN, or FILEOUT. 

• Specify local parameters on the same logical input line as you specify a FILEIN, 

FILESIN, or FILEOUT parameter. 

• Local parameters can follow a FILEIN, FILESIN, or FILEOUT input line. Use a 

semicolon (;) to link the local parameter input lines together. If a semicolon appears 

anywhere on a parameter input line except within a comment, the next input line is 

considered to be a continuation of the previous line. 

• A period (.) with at least one preceding space terminates syntax scanning; therefore, 

you can add comments after the period. 

• If you do not specify required file attributes with local parameters, the corresponding 

global parameter specifications or defaults are assumed except where otherwise 

noted. 

Example 

The following example illustrates the syntax rules for the local SORT processor 

parameter specifications: 

FILEIN=TAPE1 BLOCK=15,RECORDS MODE=ANSI ; .Input file definition 

LABEL=STANDARD 

3–8 7831 0687–010

3.2.5. SORT Processor Runstream Example 


The following example shows a SORT processor runstream that contains several SORT 

processor parameters. The parameters included are those that identify 

• The type of operation to perform 

• The format of the input files and the output file 

• The character type of the records 

• The key field definitions 

The runstream also contains 

• Comments 

• Global and local parameter types 

• A continued parameter specification 

Example 

@SORT,E . line 1 

RECORD=200 . line 2 

KEY=1,4,S,D:17,10,S,A . line 3 

RSZ=80,CHARACTERS LINKSZ=40,CHARACTERS . line 4 

MODE=PRINT . line 5 

FILEIN=DATA1 BLOCK=1792,WORDS MODE=SDF ; . line 6 

LABEL=OMITTED . line 7 

DATA=ASCII . line 8 

BIAS=AVG . line 9 

. FILEIN=DATA6 MODE=SDF . line 10 

FILEOUT=OUTFILE . line 11 

SORT . line 12 

@EOF . line 13 

Explanation 

Line 1 Call the reentrant SORT processor. 

Line 2 Specify the global RECORD (see 3.3.49) parameter. 

Line 3 Specify the global KEY (see 3.3.31) parameter. 

Line 4 Specify the RSZ (see 3.3.54) and LINKSZ (see 3.3.36) global parameters. Notice that 

you can specify multiple global parameters on the same input line. 

Line 5 Specify a global MODE (see 3.3.40) parameter. 

Lines 6–7 Specify an input file with the FILEIN parameter (see 3.3.25). Also specify the local 

parameters BLOCK (see 3.3.4), MODE, and LABEL (see 3.3.33). The local MODE 

parameter overrides the global MODE parameter specified in line 5. Notice the use 

of the continuation character on the input line. This continuation causes the LABEL 

parameter on line 7 to become a local parameter to the file DATA1. 

Line 8 Specify a global DATA (see 3.3.13) parameter. 

Line 9 Specify a global BIAS (see 3.3.3) parameter. 

Line 10 The period (.) makes this line a comment. 

7831 0687–010 3–9


Line 11 Specify the output file with the FILEOUT parameter (see 3.3.26). This output file’s 

mode is PRINT because the global MODE parameter is specified in line 5. 

Line 12 Specify the global SORT parameter (see 3.3.60). This is the default SORT processor 

operation. 

Line 13 End the input of the parameter specification runstreams by the user and start the 

sort operation. 

See Appendix B for additional SORT processor examples. 

3.2.6. SORT Processor Parameter Groups 

The SORT processor operates through a number of parameters, which are discussed in 

3.3. Two groups of these parameters have special purposes for the SORT processor. 

• Operation control parameters 

These parameters tell the SORT processor what kind of function to perform. The 

default operation control parameter is SORT. These parameters are the following: 

− COPY (see 3.3.11) 

− ESTIMATE (see 3.3.22) 

− MERGE (see 3.3.39) 

− RETRIEVE (see 3.3.52) 

− SORT (see 3.3.61) 

− TAG (see 3.3.65) 

When requesting either a SORT or a TAG operation, you can direct the SORT 

processor to perform the operation either in a basic mode environment with a basic 

mode sort or in an extended mode environment with an extended mode sort. An 

extended mode sort takes advantage of the large memory available with the 

extended mode environment. 

• File identification parameters 

Use file identification parameters to define the files used by the SORT processor for 

input and output operations. Each parameter has a set of corresponding local 

parameters (see 3.2). The file identification parameters are the following: 

− FILEIN (see 3.3.25) 

− FILEOUT (see 3.3.26) 

− FILESIN (see 3.3.27) 

3–10 7831 0687–010

3.3. SORT Processor Parameters 


The following subsections contain an alphabetical listing of the SORT processor 

parameters with descriptions. 

3.3.1. ACCEPT Parameter 

This parameter performs a test to determine which records are processed by the SORT 

processor. You can specify up to 200 ACCEPT parameters, but you must list them 

consecutively. 

Type 

Global 

Format 

ACCEPT=sc,nc,type,test-operation,value[,logical-operation] 

where 

sc 

nc 

type 

is an integer that indicates at which character position within the data record the 

ACCEPT parameter test is to begin. The first character position of a record is 

number one (1). 

is an integer that specifies the number of characters to be tested. 

specifies the kind of data the value field contains. The valid type field specifications 

are the following: 

ASC 

CAS 

DEC 

The value field is specified in ASCII in the range 0000-0377 and that the sb and 

nb fields represent 9-bit characters. This data type is not case sensitive. For 

data comparison purposes, lowercase alphabetic characters a-z (0141-0172) will 

be folded to uppercase. Thus, characters 0133-0140 will be considered to be 

greater than either an uppercase Z or a lowercase z. 


nb fields represent 9-bit characters. For data comparison purposes, uppercase 

(0101-0132) and lowercase (0141-0172) letters are treated as unequal. 

The value field is specified in decimal and that the sb and nb fields represent 

9-bit characters. 

7831 0687–010 3–11


DECFD 

FD 

OCT 



The value field is specified in Fieldata and that the sb and nb fields represent 


The value field is specified in octal and that the sb and nb fields represent 9-bit 

characters. 

OCTFD 

test-operation 


characters. 

specifies how the test data is compared to the data in the area you are testing. The 

valid test-operation field specifications are the following: 

E 

G 

GE 

L 

value 

LE 

NE 

specifies a test equal operation. 

specifies a test greater operation. 

specifies a test greater or equal operation. 

specifies a test less operation. 

specifies a test less or equal operation. 

specifies a test not equal operation. 

contains the test data to be compared with the part of the record you specify in the 

sc and nc fields. If the test data is decimal, it cannot exceed 36 bits and its value 

cannot be greater than 68,719,476,734 (0777777777776 octal). If the type field is 

ASC or CAS, the test value may be entered as a character string or as a nonnumeric 

literal. The literal must not exceed 60 characters (excluding the delimiters). For all 

other types of data, this field can be up to 60 characters in length. 

3–12 7831 0687–010


Note: You can specify a character string containing an embedded space, comma, 

or semicolon in one of three ways: 

• Use the nonnumeric literal syntax. (Valid only for ASC and CAS data types). 

• Specify the entire string as an octal value. 

• Specify the characters preceding the space, comma, or semicolon using one 

ACCEPT parameter; specify the space, comma, or semicolon character as an octal 

value using another ACCEPT parameter; and specify the remaining characters using 

a third ACCEPT parameter. 

logical-operation 

controls the acceptance of records with more than one ACCEPT parameter. The test 

operations and the logical operations you specify with the ACCEPT parameters form 

a logical expression that determines whether a record is processed by the SORT 

processor. If the logical expression is true, the record is accepted and processed. 

The valid logical-operation field specifications are the following: 

AND 

OR 

Notes: 

consecutive ACCEPT parameters are connected with the logical AND operation. 

consecutive ACCEPT parameters are connected with the logical OR operation. 

This is the default field specification. 

If you omit this field, the OR operation is used for consecutive ACCEPT parameters. 

• You cannot specify the ALLOW and REJECT parameters in the same parameter list 

with the ACCEPT parameter. 

• The ACCEPT parameter replaces the ALLOW and REJECT parameters and offers 

you greater capability and flexibility. 

3.3.2. ALLOW Parameter 

This parameter performs a test that determines which records are processed through 

the SORT processor. Records that fail the specified test conditions are ignored and, 

therefore, are not sent to the output file. This parameter has been replaced by the 

ACCEPT parameter (see 3.3.1). 

Type 

Global 

Format 

ALLOW=test-word,test-operation,value,type[,partial-word] 

where 

7831 0687–010 3–13


test-word 

is an integer that specifies the word within each record to be tested. The first word 

of a record is number 1. 



valid test-operation field specifications are the following values: 

E 

G 

value 

type 

LE 

NE 

specifies a test equal operation 

specifies a test greater operation 

specifies a test less or equal operation 

specifies a test not equal operation 

is an octal number, a decimal number, or a character string. If it is a character string 

that is less than a full word, the string is right-justified and space-filled. 



ASC 

CAS 

The value field is specified in ASCII (uppercase and lowercase letters will match) 

The value field is specified in ASCII (case sensitive; uppercase and lowercase 

letters will not match) 

DEC or D 

FD or C 

The value field is specified in decimal 

The value field is specified in Fieldata 

OCT or O 

The value field is specified in octal 

3–14 7831 0687–010

partial-word 


is used to test a specific portion of test-word. The partial-word field is optional; the 

valid partial-word specifications are the following: 

H1 

H2 

Q1 

Q2 

Q3 

Q4 

S1 

S2 

S3 

S4 

S5 

S6 

Notes: 

tests H1 of test-word 

tests H2 of test-word 

tests Q1 of test-word 




tests S1 of test-word 






• Do not specify more than one ALLOW parameter. If you do specify more than one, 

the processor defaults to the last ALLOW parameter you specified. 

• To specify a character string containing an embedded space, comma, or semicolon, 

you must specify the entire string as an octal value. 

• Use the ACCEPT parameter for greater capability and flexibility. 

7831 0687–010 3–15


3.3.3. BIAS Parameter 

This parameter tells the SORT processor how the input data is ordered. The bias of the 

data is the volume of data divided by the number of ordered sequences within the data. 

Type 

Global 

Format 

BIAS=input-bias 

where input-bias is the value that specifies the bias of the data. The variable input-bias 

can be either an integer that equals the bias of the data multiplied by 10 or one of the 

following field specifications: 

AVG 

INV 

RND 

SEQ 

the input data is almost in random order, but it has a few ordered sequences. Bias 

equals 15. This is the default field specification. 

the input data is in approximately reverse order from the way it must be sorted. Bias 

equals 10. 

the input data is in random order. Bias equals 20. 

most records in the input data are in the ordered sequence desired for output. Bias 

equals 30. 

3.3.4. BLOCK Parameter 

This parameter defines the blocking characteristics of the input and output files. 

If you do not specify the BLOCK parameter, the block size of the input file is used for the 

output file whenever possible. When this is not possible, standard defaults for each file 

type are used. The default values are multiples of the prep size of the output file mode 

(see PREP in 3.3.46). 

Type 

Global or local 

Format 

BLOCK=blocking-factor[,block-granularity] 

where 

blocking-factor 

is an integer that specifies the number of granules within a block. 

3–16 7831 0687–010

lock-granularity 


is used to specify the blocking-factor. This field is optional. The valid blockgranularity 

field specifications are the following: 

CHARACTERS 

specifies that the blocking-factor is characters per block. The A, C, or M SORT 

processor options, as well as the DATA parameter, determine whether the 

characters are ASCII or Fieldata. 

RECORDS 

specifies that the blocking-factor is records per block. This is the default field 


WORDS 

specifies that the blocking-factor is in words per block. 

When an extended mode sort is performed and a Processor Common Input/Output 

System (PCIOS) sequential system data format (SDF) mass storage file is used as an 

input or output file (see MODE in 3.3.40), the blocking-factor can be increased for 

efficiency. No increase occurs if this file resides on tape or the BMBLOCK parameter 

(see 3.3.5) is specified as a local parameter with the FILEOUT parameter. 

3.3.5. BMBLOCK Parameter 

This parameter tells the processor to use the same block size if 

• An extended mode or basic mode sort is performed 

• The output file is a Processor Common Input/Output System (PCIOS) sequential data 

format (SDF) file 

Type 

Local (FILEOUT parameter only) 

Format 

BMBLOCK 

Description 

This parameter is a local parameter to the FILEOUT parameter and is meaningful only 

when 

• An extended mode sort is performed 

• A mass-storage sequential SDF file is created 

If an extended mode sort is performed and the BMBLOCK parameter is specified, the 

processor uses the same block size that would be used if a basic mode sort were 

performed. 

7831 0687–010 3–17


If you do not specify this parameter and an extended mode sort is performed that results 

in a mass-storage sequential SDF file as the output file 

• The block size may be increased 

• A different block size may be written to the block size field in the label record 

3.3.6. CHECK Parameter 

This parameter eliminates the checksum operations normally done by the SORT 

subroutines modules specified with the CHECKSUM parameter. 

Type 

Global 

Format 

CHECK=mod-1[,mod-2][,mod-3][,mod-4] 

where mod-1, mod-2, mod-3, and mod-4 are specific portions of the module or level of 

mass storage. The valid mod-n field specifications are the following: 

D 

F 

K 

T 

eliminates the checksum operations for the one-level mass-storage (M1) module. 

eliminates the checksum operations for the two-level mass-storage (M2) module. 

eliminates the checksum operations for the basic mode disk module. The 

CHECKSUM operation is not implemented for the extended mode disk module. 

eliminates the checksum operations for the tape module. 

3.3.7. CHECKSUM Parameter 

This parameter sets a mesh number that tells the SORT processor how often to perform 

checksum calculations. The default mesh number is 1, which causes the SORT 

processor to sum every word of input or output in the module you specify. 

Type 

Global 

Format 

CHECKSUM=mod-1:mesh-1[,mod-2:mesh-2]...[,mod-4:mesh-4] 

where 

3–18 7831 0687–010

mod-1, mod-2, ..., mod-4 

indicates which module the mesh field refers to. The valid mode-n field 

specifications are the following: 

D 

F 

K 

T 

for the one-level mass storage (M1) module. 

for the two-level mass storage (M2) module. 


for the basic mode disk module. The CHECKSUM operation is not performed for 

an extended mode disk sort. 

for all tape modules. 

mesh-1, mesh-2, ..., mesh-4 

is an integer that specifies the mesh or interval at which checksum operations are 

computed. The normal mesh number is 1, which means that every word in the 

module you specify is summed before being written and after being read. By setting 

a larger mesh number, you can save time during computation by doing fewer 

CHECKSUM operations. 

3.3.8. CKPT Parameter 

This parameter tells the SORT processor to write a checkpoint of all temporary sort files. 

Type 

Global 

Format 

CKPT=ckpt-file[,repeat] 

where 

ckpt-file 

repeat 

is the name of a cataloged public file used to write the checkpoint. You must assign 

this file before calling the SORT processor. 

is an integer that indicates how many checkpoints you want to write. If you omit 

repeat, checkpoints are written at the following places: 

• At the end of every reel of input for file types ACOB and COBOL File Handler (CFH) 

• At the end of every file on mass storage 

• After all input files are read but before records are returned 

• After the sort is completed 

7831 0687–010 3–19


3.3.9. CODE-TYPE Parameter 

This parameter tells the SORT processor what character set to write in the header of an 

SDF, DSDF, or mass storage alternate symbiont file created by the SORT processor. 

This parameter is local to the FILEOUT parameter and has meaning for all operations 

(that is, COPY, MERGE, SORT, TAG, RETRIEVE, and TAG/RETRIEVE). 

Type 


Format 

CODE-TYPE=code-type 

where code-type is an integer value. If the leftmost digit is zero, the SORT processor 

assumes that it is an octal number. If the leftmost digit is nonzero, the SORT processor 

assumes that a decimal number is being entered. The minimum value that can be 

entered is zero; the maximum value is 077. For a list of valid code types, see the ER 

Programming Reference Manual. 

Description 

This parameter is a local parameter to the FILEOUT parameter and is meaningful only 

when the mode of the output file is CARDS, DSDF, PRINT, or mass storage SDF. This 

parameter overrides the DATA parameter (see 3.3.13). 

The code type written in the header of an SDF, DSDF, or alternate symbiont file created 

by the SORT processor is determined by the following rules: 

1. If the CODE-TYPE parameter is specified, the CODE-TYPE parameter value is 

written. 

2. If the CODE-TYPE parameter is not specified but an I key or LOCALE parameter is 

specified, the code type associated with the locale currently in force or the locale 

specified by the LOCALE parameter is written. This applies even if the operation is 

not a sort or merge. 

3. If neither the CODE-TYPE nor LOCALE parameter is specified and the I key type is 

not specified, the following rules apply: 

a. If the CCSLOCNUM configuration parameter is PREI18N, a value of 0 or 1 is 

written depending on the data type (0 if Fieldata, 1 if ASCII). 

b. If the CCSLOCNUM configuration parameter is DEFAULT, the code type 

associated with the locale specified by the DEFLOCALE configuration parameter 

value is written. 

c. If the CCSLOCNUM configuration parameter is INPUTDATA, the value of the 

input file’s code type is written. If the input files are multi-indexed sequential 

access method (MSAM) files, the code type associated with the locale in the 

input MSAM file header block is written. 

3–20 7831 0687–010

3.3.10. CONSOLE Parameter 


This parameter tells the SORT processor to issue all operator console messages during 

the sort run. This parameter is the opposite of the DELCON parameter (see 3.3.15) and 

overrides the CONSOLE configuration parameter (see 9.4). 

Type 

Global 

Format 

CONSOLE 

3.3.11. COPY Parameter 

This parameter tells the SORT processor to perform a COPY operation. 

Type 

Global 

Format 

COPY 

Description 

Allows you to copy up to 24 input files to a single output file. The input files can be 

recorded in any of the modes (see 3.3.40) recognized by the SORT processor. 

3.3.12. CORE Parameter 

This parameter tells the SORT processor how much main storage can be used for the 

sorting algorithm. This parameter is used by the SORT processor when determining 

whether a basic mode or an extended mode sort will be performed. See Section 2 for a 

detailed description of the selection process. 

Type 

Global 

Format 

CORE=sort-core-amount[granularity] 

where 

sort-core-amount 

is a decimal number specifying the amount of main storage you want. 

7831 0687–010 3–21


granularity 

specifies what sort-core-amount must be multiplied by. The valid granularity field 


K 

M 

the sort-core-amount is multiplied by 1000. 

the sort-core-amount is multiplied by 1048576 (or octal 04000000). 

If sort-core-amount is immediately followed by a K or M, it can contain a decimal point 

and up to two decimal digits. All excess decimal digits are ignored. If a K or M is not 

specified, the decimal point is not allowed. 

3.3.13. DATA Parameter 

This parameter determines the character type of the data processed by the SORT 

processor. No conversion of data is done by the SORT processor. 

Type 

Global 

Format 

DATA=character-type 

where character-type is the character type of the data. The valid field specifications are 

the following: 

ASCII 

9BIT 

specifies that all character data is ASCII. This is the default character type if you do 

not specify the C or M option on the SORT processor call (see 3.1). 

specifies that all character data is 9-bit character data. It does not mean that the 

character data is ASCII. 

FIELDATA or 6BIT 

specifies that all character data is Fieldata. This is the default character type if you 

specify the C or M option on the SORT processor call. 

Description 

The DATA parameter is used to determine the number of characters per word and the 

mode to use (Fieldata versus 9-bit) when reading and writing MODE=CARDS and 

MODE=PRINT files. 

3–22 7831 0687–010

3.3.14. DEFYEAR Parameter 


This parameter tells the SORT processor which year is the first year of a 100-year 

interval to use when ordering a DATE key field (see KEY in 3.3.31 or KEYW in 3.3.32). 

Type 

Global 

Format 

DEFYEAR=defyear-value 

where defyear-value is an integer in the range 0 to 99 that specifies the first year of a 

100-year interval used to order a DATE key field. 

Description 

If the defyear-value is zero, a DATE key field is ordered from 0 to 99. If the defyear-value 

is nonzero, a DATE key field is ordered from defyear-value, defyear-value+1, 

defyear-value+2, ... , 99, 00, ... , defyear-value–1. If no DEFYEAR parameter is 

specified, a default defyear-value of 28 is used when a DATE key field is ordered. 

3.3.15. DELCON Parameter 

This parameter tells the SORT processor to delete all operator console messages during 

the sort run. This parameter is the opposite of the CONSOLE parameter (see 3.3.10) 

and overrides the CONSOLE configuration parameter (see 9.4). 

Type 

Global 

Format 

DELCON 

3.3.16. DELDUPS Parameter 

This parameter tells the SORT processor to delete duplicate records. 

Type 

Global 

Format 

DELDUPS 

7831 0687–010 3–23


Description 

The DELDUPS parameter causes a record to be deleted each time records with equal 

keys are encountered when comparing records. This parameter is valid only for a sort 

operation (see 3.3.60) or a tag operation (see 3.3.64) and is ignored by all other 

operations. It is also ignored if a PRESERVE parameter (see 3.3.47) or an OWN 

parameter with exit number 32 or 42 (see 3.3.45 and 4.3.9) is specified. 

3.3.17. DELLOG Parameter 

This parameter tells the SORT processor to delete all normal sort completion messages 

from the run log. This parameter is the opposite of the LOG parameter (see 3.3.38) and 

overrides the LOG configuration parameter (see 9.11). 

Type 

Global 

Format 

DELLOG 

3.3.18. DISKS Parameter 

This parameter tells the SORT processor that mass storage files are to be used as 

scratch files and that a disk sort (see 10.2.2) will be performed. 

Type 

Global 

Format 

DISKS=number-of-files[(min-number,max-number)] 

[,equipment-type,granularity,file-size[(min-size,max-size, est-number)]] 

where 

number-of-files 

is an integer between 3 and 26, inclusive, which causes a disk sort to be performed. 

The disk files are assigned with the names XA, XB, ..., XZ. The first file assigned is 

named XC if the number-of-files is 3 through 24; the first file is named XB if the 

number-of-files is 25; and the first file is named XA if the number-of-files is 26. If you 

assign these names to any disk files before calling the SORT processor, they are 

used as scratch files. 

min-number and max-number 

identify the range of the number of disk files that can be used to perform the sort. 

These fields are only used with the ESTIMATE operation (see 3.3.22). 

3–24 7831 0687–010

equipment-type 


specifies any valid sector-formatted mass storage @ASG equipment type. If you 

omit this field, the DEFDK configuration parameter (see 9.6) is assumed. 

granularity 

specifies granularity, with the following valid field specifications: 

POS 

TRK 

file-size 

specifies position granularity. 

specifies track granularity; this is the default field specification. 

is an integer specifying the number of granules to be assigned. 

The maximum value allowed for this field is 262,143. If a value greater than 262,143 

is specified and the granularity field is not specified or specifies TRK, the granularity 

will be changed to positions and the file size converted to the position equivalent. If 

a value greater than 262,143 is specified and the granularity field specifies POS, a 

value of 262,143 will be used. 

min-size and max-size 

are integers referring to the size of the disk files and are expressed as a range of the 

number of granules per file. These fields are optional and used only with the 

ESTIMATE operation (see 3.3.22). 






est-number 

refers to the number of estimates you want within the file size range you specify. 

This field is used only with the ESTIMATE operation (see 3.3.22). 

3.3.19. DRUM Parameter 

This parameter tells the SORT processor about the file that is to be used as a scratch file 

for the one-level mass storage (M1) module (see 10.2.3). 

Type 

Global 

Format 

DRUM=equipment-type[,granularity[,file-size[(min-size,max-size,est-number)]]] 

where 

7831 0687–010 3–25



specifies an @ASG value for sector-formatted mass storage, high-speed disk, or 

word-addressable drum equipment types. If you specify a word-addressable drum, 

the specified file size is treated as words regardless of the granularity specified. If 

you omit this field, the DEFXA configuration parameter (see 9.9) is assumed. 

granularity 


POS 

TRK 

file-size 




For a sector-formatted mass storage file, the maximum value for this field is 

262,143. If a value greater than 262,143 is specified and the granularity field is not 

specified or specifies TRK, the granularity will be changed to positions and the file 

size converted to the position equivalent. If a value greater than 262,143 is specified 

and the granularity field specifies POS, a value of 262,143 will be used. 

For a word-addressable drum file where the granularity field is not specified or 

specifies TRK, the maximum value for this field is 469,760,256. If a value greater 

than 469,760,256 is specified, the granularity will be changed to positions. If the 

granularity field specifies POS, the maximum value for this field is 30,064,656,384. 

If a value greater than 30,064,656,384 is specified, a value of 30,064,656,384 will be 

used. 


are integers referring to the size of the disk files and are expressed as a range of the 

number of granules per file. These fields are optional and only used with the 


For a sector-formatted mass storage file, the maximum value for this field is 

262,143. If a value greater than 262,143 is specified and the granularity field is not 

specified or specifies TRK, the granularity will be changed to positions and the file 

size converted to the position equivalent. If a value greater than 262,143 is specified 

and the granularity field specifies POS, a value of 262,143 will be used. 

For a word-addressable drum file where the granularity field is not specified or 

specifies TRK, the maximum value for this field is 469,760,256. If a value greater 

than 469,760,256 is specified, the granularity will be changed to positions. If the 

granularity field specifies POS, the maximum value for this field is 30,064,656,384. 

If a value greater than 30,064,656,384 is specified, a value of 30,064,656,384 will be 

used. 

3–26 7831 0687–010

est-number 


is an integer referring to the number of estimates you want within the file size range 

you specify. This field is used only with the ESTIMATE operation (see 3.3.22). 

3.3.20. EQUIP Parameter 

This parameter tells the SORT processor what type of equipment FILEIN, FILESIN, and 

the FILEOUT files are assigned to. The EQUIP parameter is only used by the ESTIMATE 

parameter (see 3.3.22) and is ignored by all other operations. 

Type 


Format 

EQUIP=equipment-type 

where equipment-type can be any of the valid @ASG values for mass storage (see the 

ER Programming Reference Manual) or tape assignments. 

3.3.21. ESORT Parameter 

This parameter tells the SORT processor to unconditionally perform an extended mode 

memory or disk sort. 

Type 

Global 

Format 

ESORT 

Description 

The ESORT parameter cannot be specified in the following cases: 

• The DRUM (see 3.3.19) , FAST (see 3.3.23), or TAPES (see 3.3.66) parameter is 

specified 

• The X option is used on the SORT processor call statement 

• A sort scratch file is assigned to a tape device or a one-level (M1) or a two-level (M2) 

mass storage sort is requested by scratch file assignment prior to the SORT 

processor call. 

Note: This parameter is ignored when requesting a MERGE, COPY, or RETRIEVE 

operation without the TAG operation. 

7831 0687–010 3–27


3.3.22. ESTIMATE Parameter 

This parameter tells the SORT processor to perform a time estimate for the operation. 

The ESTIMATE operation can be performed in conjunction with a SORT or TAG 

operation. 

Type 

Global 

Format 

ESTIMATE[=estimate-option] 

where estimate-option is optional. It controls the amount of estimate information that is 

printed by the SORT processor and can be one of the following values: 

L 

N 

S 

Description 

provides a complete listing of the information generated by the ESTIMATE 

operation. 

provides a time estimate only. This is the default option. 

provides a short listing of the information generated by the ESTIMATE operation. 

The ESTIMATE operation does not assign scratch files. If you do not assign scratch files, 

and none are specified using the DISKS (see 3.3.18), DRUM (see 3.3.19), FAST (see 

3.3.23), or TAPES (see 3.3.66) parameters, the SORT processor determines the files that 

are needed and bases its estimate on those values. 

Estimates for sorts using tape scratch files must use the TAPES parameter to show the 

number and type of tapes assigned. Other sort types can use the appropriate parameter 

or can assign the actual scratch files. 

The SORT (see 3.3.60) or TAG (see 3.3.64) operation you specify is not actually 

performed until you remove the ESTIMATE parameter from the parameter list. 

Notes: 

• If you use the ESTIMATE parameter, you do not have to assign the input files or the 

output file before calling the SORT processor. 

• When you use the ESTIMATE parameter, you must specify the record size with the 

RSZ parameter (see 3.3.54) and the block size for the input and output files with the 

BLOCK parameter (see 3.3.4). 

3–28 7831 0687–010

3.3.23. FAST Parameter 


This parameter tells the SORT processor about the file to be used as the scratch file for 

the two-level mass storage (M2) module (see 10.2.3). 

Type 

Global 

Format 

FAST=equipment-type[,granularity[,file-size[(min-size,max-size,est-number)]]] 

where 


specifies an @ASG value for a sector-formatted mass storage equipment type. If 

you omit this field, the DEFXB configuration parameter (see 9.10) is assumed. 

granularity 


POS 

TRK 

file-size 










are integers specifying the size of the disk files and are expressed as a range of the 

number of granules per file. These fields are optional and only used with the 


If a value greater than 262,143 is specified and the granularity field is not specified or 

specifies TRK, the granularity will be changed to positions and the file size converted 

to the position equivalent. If a value greater than 262,143 is specified and the 

granularity field specifies POS, a value of 262,143 will be used. 

est-number 

is an integer specifying the number of estimates you want within the file size range. 

This field is optional and is only used with the ESTIMATE operation (see 3.3.22). 

7831 0687–010 3–29


3.3.24. FILEID Parameter 

This parameter tells the SORT processor that the identifier for the file should be set or 

reset to file-id. This parameter is used for files with a mode of ACOB, ANSI, DSDF, 

MSAM, or SDF. 

Type 

Local 

Format 

FILEID=file-id 

where file-id is the name of the file identifier with the maximum size of 17 characters. It 

can be specified as either a character string or nonnumeric literal. 

The FILEID parameter values are ignored for files with a mode other than ACOB, ANSI, 

DSDF, MSAM, or SDF. 

3.3.25. FILEIN Parameter 

This parameter specifies an input file to the SORT processor and is required for all 

operations. This is one of the parameters referred to as a file identification parameter. 

Format 

FILEIN=input-file-name[,input-option] 

where 

input-file-name 

is a 1- to 12-character internal file name. 

input-option 

can be one of the following specifications: 

F or FREE 

HOLD 

releases the input file from the run after the input has been read from the file. 

You cannot use this option if a RETRIEVE operation is specified because the 

input file is needed for output processing. 

used in conjunction with the SAVE option to specify the tape files to read or 

write through the same tape unit. The HOLD option must appear on all FILEIN 

parameters that use the same tape unit that the FILEIN parameter with the 

SAVE option uses. The REELS parameter is ignored unless the HOLD option 

appears on the FILEIN parameter. 

3–30 7831 0687–010


The SORT processor assigns the specified tape file when it is needed for an 

input operation. The SORT processor uses the same assignment options used 

to assign the original tape file. If the tape file is not cataloged, use the REELS 

parameter to specify the reel numbers of the tapes to be mounted. HOLD 

cannot be used with the MERGE parameter (see 3.3.39) or with the Z processor 

call option. 

NORWD 

specifies that no rewind operation is to take place before beginning any input 

operations. 

NORWDX 

RWD 

RWDI 

SAVE 

UNLD 

Description 

specifies that no rewind operation is to take place before beginning any input 

operation or after completing all input operations. 

specifies that the input tape is to be rewound before any input operations occur. 

This is the default operation before starting any input operations from tape. 

is the same as RWD except that the tape is rewound with interlock, meaning 

that operator intervention is needed to allow further access to the tape. 

saves the tape unit for future input or output operations. You must assign the 

specified tape file to the run before calling the SORT processor. 

You can assign a single tape unit to handle all tape I/O. All tapes must be 

compatible. The SAVE option can appear on only one FILEIN parameter. 

is the same as the F or FREE options. 

The following conditions apply to all input files: 

• You must assign to the run any mass storage file you specify before you call the 


• If you specify a mass storage file with a maximum granule value greater than 4095 

positions, the MODE of the file must be either CARDS, DSDF, PRINT, or SDF. 

• You must assign to the run any tape file you specify before you call the SORT 

processor, unless HOLD appears in the input-option field. 

7831 0687–010 3–31


3.3.26. FILEOUT Parameter 

This parameter specifies the file used for output operations. This is one of the 

parameters referred to as a file identification parameter. 

Format 

FILEOUT=output-file-name[,[output-option],[asg-options],[type], 

[packid-reels],[expiration-date if tape]] 

where 

output-file-name 

is a 1- to 12-character internal file name. 

output-option 

can be one of the following specifications: 

F or FREE 

HOLD 

releases the output file from the run after output completion. 

specifies that a tape unit is being held for tape output. To use this option, a 

FILEIN parameter must specify the SAVE option. The SORT processor assigns 

the tape file at the proper time. It uses the options that were specified when 

the tape unit was initially assigned to the run. 

If the tape is not cataloged, the REELS parameter must be used to specify the 

reel numbers of the output tape file. HOLD is ignored if the syntax for dynamic 

assignment is given. 

NORWD 

RWD 

RWDI 

UNLD 

specifies that the output tape is not rewound after output completion. 

specifies that the tape file is rewound after output operations are completed. 

This is the default operation for a tape file. 

is the same as RWD except that the tape is rewound with interlock, meaning 

that operator intervention is required to allow further access to the tape. 

specifies that the tape drive is released after output completion. This is the 

same as the F or FREE option. 

3–32 7831 0687–010

Description 


The assign syntax fields (asg-options, type, packid-reels, and expiration-date) should 

appear as they would for any valid ASG statement (see the ER Programming Reference 

Manual). The total length of these four fields is limited to 216 characters. When you 

specify any of these fields, the SORT processor assigns the file just before returning the 

records. 

Use the REELS parameter when a HOLD option and no assign syntax appear on the 

FILEOUT parameter. 

The following conditions apply to the output files: 

• If you specify a mass storage file, you must assign it to the run before calling the 

SORT processor, unless you specify the assign syntax to dynamically assign the file 

or the ESTIMATE operation is specified (see 3.3.22). 

• If you specify a mass storage file with a maximum granule value greater than 4095 

positions, the MODE of the file must be either CARDS, DSDF, PRINT, or SDF. 

• If you provided a tape file, you must assign it to the run before calling the SORT 

processor unless HOLD appears in the output-option field or the syntax for dynamic 

assignment is provided, or the ESTIMATE operation is specified (see 3.3.22). 

3.3.27. FILESIN Parameter 

This parameter specifies the files used for input operations. This is one of the 

parameters referred to as a file identification parameter. 

Format 

FILESIN=input-file-name-1[,input-file-name-2,...,input-file-name-24] 

where input-file-name-1, input-file-name-2, ..., input-file-name-24 specify one to 24 input 

files that have equal record lengths. 

Description 

You must assign the input files prior to calling the SORT processor unless the ESTIMATE 

operation is specified (see 3.3.22). If you specify a mass storage file with a maximum 

granule value of greater than 4095 positions, the MODE of the file must be CARDS, 

DSDF, PRINT, or SDF. 

3.3.28. ISKEY Parameter 

This parameter specifies an ascending index key for an indexed sequential-access 

method (ISAM) output file. You must specify the ISKEY or the ISKEYW parameter for an 

ISAM output file. 

Type 

Global 

7831 0687–010 3–33


Format 

ISKEY=sc,nc 

where 

sc 

nc 

is an integer specifying the start character of the index key within the ISAM file. The 

first character position of a record is number one (1). 

is an integer specifying the number of characters of the index key within the ISAM 

file. The SORT processor determines whether the characters are ASCII or Fieldata 

using the DATA parameter or the A, C, or M SORT processor call options. 

Note: This parameter is related to ISAM files. Use of this type of file is no longer 

recommended. Support of this parameter and ISAM files may be dropped in a future 

release. MSAM files are the recommended replacement for ISAM files. No 

enhancement will be made for ISAM files. 

3.3.29. ISKEYW Parameter 

This parameter specifies an ascending index key for an ISAM output file. You must 

specify the ISKEY or ISKEYW parameter for an ISAM output file. 

Type 

Global 

Format 

ISKEYW=sw,sb,nb 

where 

sw 

sb 

nb 

is an integer specifying the start word of the index key within the ISAM file. The first 

word within a record is number one (1). 

is an integer specifying the start bit of the index key within the ISAM file. The most 

significant, or leftmost bit of a word is number 35; the least significant, or rightmost 

bit is number 0. 

is an integer specifying the length, in bits, of the index key in the ISAM file. 





3–34 7831 0687–010

3.3.30. JOIN Parameter 


This parameter combines index keys with their corresponding ISAM input records. 

Type 

Local (FILEIN or FILESIN only) 

Format 

JOIN 

Description 

Use the JOIN parameter with ISAM input files whose index key data does not reside in 

the records. If the index key data resides in both the records and the index key area, the 

use of this parameter is redundant. 

JOIN places the key and the record one right after the other within the record, leaving no 

slack bits. Therefore, if the key size is not a multiple of a whole character, the data to 

the right of the key in the record is misaligned with the character boundaries. Once you 

use JOIN, any further parameters apply to the combined form of the record. 





3.3.31. KEY Parameter 

This parameter tells the SORT processor that a certain part of each record is to be 

treated as a key field. The KEY parameter has no effect when the OWN parameter with 

exit codes 14 or 21 is also specified. 

Type 

Global 

Format 

KEY=sc1,nc1,type1[(subtype1)],ad1[,fldn1]:...:sc64,nc64,type64[(subtype64)], 

ad64[,fldn64] 

where 

sc1, ..., sc64 

are integers indicating the starting character of the key field. The first character 

position of a record is number one (1). 

nc1, ..., nc64 

are integers indicating the length, in characters, of the key field. The SORT 

processor determines whether the characters are ASCII or Fieldata using the DATA 

parameter or the A, C, or M SORT processor call options. If a DATE key type is 

specified, the length of the key field must be at least 2. 

7831 0687–010 3–35


type1, ..., type64 

specifies the key type. The valid type field specifications are the following: 

A 

B 

CH 

D 

DATE 

G 

I 

J 

L 

M 

P 

Q 

R 

S 

specifies that the key is Fieldata alphanumeric. 

specifies that the key is signed binary. 

specifies that the key is type A or S, depending upon the character type of the 

records. 

specifies that the key is Fieldata sign-leading separate decimal. 

specifies that the key is ASCII alphanumeric containing a date where the first 18 

bits represent a year. 

specifies that the key is Fieldata sign-trailing separate decimal. 

specifies that the key contains 9-bit data and that an international sort or merge 

should be performed. The data will be ordered according to the rules of the 

locale. 

specifies that the key is signed packed decimal. 

specifies that the key is Fieldata sign-leading overpunched decimal. 

specifies that the key is IBM fixed-point binary. 

specifies that the key is Fieldata sign-trailing overpunched decimal. 

specifies that the key is ASCII sign-trailing overpunched decimal. 

specifies that the key is ASCII sign-leading separate decimal. 

specifies that the key is ASCII alphanumeric. 

3–36 7831 0687–010

T 

U 

V 

specifies that the key is ASCII sign-trailing separate decimal. 

specifies that the key is unsigned binary. 

specifies that the key is ASCII sign-leading overpunched decimal. 

subtype1, ..., subtype64 


specifies additional information about the type of the key. The optional subtype field 

specification is only valid when the type field specifies I. The valid subtype field 

specifications for I keys are the following: 

IGNORETSP 

specifies that trailing spaces within the I key field should be ignored when 

ordering the records. 

INCLUDETSP 

ad1, ..., ad64 

specifies that trailing spaces within the I key field should be included when 

ordering the records. If the subtype field is not specified for an I key type, this is 

the default specification. 

specifies the sort or merge sequence. The valid ad field specifications are the 

following: 

A 

D 

fldn1, ..., fldn64 

specifies an ascending sort or merge sequence 

specifies a descending sort or merge sequence 

are integers specifying the significance of the key fields from 1 to 64, or major to 

minor. If you use this field on one key field definition, you must use it on all key field 

definitions. 

If you do not specify fldn fields, the first key field defined is considered the major 

key, and any subsequent key fields defined are minor keys. 

Description 

Key fields specified by the KEY or KEYW parameters are required for all merge and sort 

operations unless an OWN parameter with an exit number 14 or 21 is specified. The 

KEY parameter is used to define key fields based on a start character within the record 

and a character length. Whereas, the KEYW parameter defines key fields based on a 

start word and bit within the record and a bit length. 

7831 0687–010 3–37


Key fields can overlap. If they do, you must observe the rules for overlapping key types 


Table 3–2. Overlapping Types 

If the major key is ... Then the overlapping minor key types can be only ... 

A, D, G, L, or P A* or U 

B, J, M, or U U 

I B, I, Q, R, S, T, U, or V 

DATE, Q, R, S, T, or V S** or U 

* The overlapping minor key type can be A only if an alternate Fieldata collating sequence is 

not specified. 

** The overlapping key type can be S only if a 128-character or 256-character collating sequence 

is not specified. 

3.3.32. KEYW Parameter 

This parameter tells the SORT processor that a certain part of each record is to be 

treated as a key field. The KEYW parameter has no effect when the OWN parameter 

with exit codes 14 or 21 is specified. 

Type 

Global 

Format 

KEYW=sw1,sb1,nb1,type1[(subtype1)],ad1[,fldn1]:...:sw64,sb64,nb64, 

type64[(subtype64)],ad64[,fldn64] 

where 

sw1, ..., sw64 

are integers indicating the starting word number of the key field. The first word of 

the record is number one (1). 

sb1, ..., sb64 

are integers indicating the starting bit number within the start word of the key field. 

The leftmost or most significant bit number is 35 and the least significant bit number 

is zero (0). 

nb1, ..., nb64 

is an integer that specifies the number of bits in the key field. If a DATE key type is 

specified, the length of the key field must be at least 18. 

3–38 7831 0687–010

type1, ..., type64 


specifies the key type. The valid type field specifications are the following: 

A 

B 

CH 

D 

DATE 

G 

I 

J 

L 

M 

P 

Q 

R 

S 



specifies that the key is type A or S, depending upon the character type of the 

records. 






should be performed. The data will be ordered according to the rules of the 

locale. 








7831 0687–010 3–39


T 

U 

V 




subtype1, ..., subtype64 




IGNORETSP 



INCLUDETSP 

ad1, ..., ad64, 


ordering the records. If the subtype field is not specified for I key type, this is 


specifies the sort or merge sequence. The valid ad field specifications are the 

following: 

A 

D 

fldn1, ..., fldn64 

specifies an ascending sort or merge sequence 

specifies a descending sort or merge sequence 

are integers specifying the significance of the key fields from 1 to 64, or major to 

minor. If you use this field on one key field definition, you must use it on all key field 

definitions. 

If you do not specify fldn fields, the first key field defined is considered the major 

key, and any subsequent key fields defined are minor keys. 

Description 



KEYW parameter defines key fields based on a start word and bit within the record and a 

bit length. Whereas, the KEY parameter is used to define key fields based on a start 

character within the record and a character length. 

Key fields can overlap. If they do, you must observe the rules for overlapping key types 


3–40 7831 0687–010

3.3.33. LABEL Parameter 


This parameter tells the SORT processor what type of label is present or required. 

Type 

Local or global 

Format 

LABEL=label-type 

where label-type is the type of the label. The valid field specifications are the following: 

FORM01 

NONE 

specifies that the labels are FORM01 type as created by ASCII COBOL 

specifies that no labels are present 

OMITTED 

specifies that the labels have been omitted 

STANDARD 

specifies that standard labels are present or required; this is the default field 

specification 

Description 

The LABEL parameter specifies whether a file contains or requires a label. If labels are 

present, the LABEL parameter specifies the type of label present or required. 

3.3.34. LIMDRM Parameter 

This parameter provides the SORT processor with the minimum acceptable block size 

for the one-level mass storage (M1) module. 

Type 

Global 

Format 

LIMDRM=minimum-M1 

where minimum–M1 is an integer that specifies the minimum block size in words. If the 

SORT processor calculates a block size that is smaller than this value, it prints an error 

message and terminates the sort. 

7831 0687–010 3–41


3.3.35. LIMFST Parameter 

This parameter provides the SORT processor with the minimum acceptable block size 

for the two-level mass storage (M2) module. 

Type 

Global 

Format 

LIMFST=minimum-M2 

where minimum-M2 is an integer that specifies the minimum block size in words. If the 

SORT processor calculates a block size that is smaller than this value, it prints an error 

message and terminates the sort. 

3.3.36. LINKSZ Parameter 

This parameter tells the SORT processor how much of any variable length record is 

significant to the sort operation being performed. 

Type 

Global 

Format 

LINKSZ=link-size[,link-granularity] 

where 

link-size 

is an integer that is at least large enough to include all key fields you defined. Link 

size is important in determining the efficiency of the memory sort. 

link-granularity 

specifies the granularity of the link-size field. The following field specification values 

are valid: 

CHARACTERS 

specifies that the link-size field is in characters. The SORT processor determines 

whether the characters are ASCII or Fieldata by checking the DATA parameter or 

by the A, C, or M SORT processor call options. This is the default field 


WORDS 

specifies that the link-size field is in words. 

3–42 7831 0687–010

Description 

Specify the LINKSZ parameter for all files with variable-length records. 


Note: For more information on sorting variable-length records, see Section 10. 

3.3.37. LOCALE Parameter 

This parameter tells the SORT processor which locale to use for an international sort or 

merge. 

Type 

Global 

Format 

LOCALE=locale-name 

where locale-name is the name of the locale. The locale name can consist of 1 to 16 

characters from the ISO 8859.1 code set. You can specify it as either a character string 

or a nonnumeric literal. No verification is made to determine whether this is the code 

set being used to enter the parameter. 

The locale name can also be _QUERY or _DEFAULT (case sensitive). When the locale 

name is _QUERY the locale currently in force is used in the international sort or merge. 

When the locale name is _DEFAULT the default locale in the system is used in the 

international sort or merge. 

Description 

The LOCALE parameter specifies the desired locale for the sort or merge operation. 

Only one LOCALE parameter should be specified. In the Unisys implementation of 

internationalization, each locale name has a locale number associated with it. This locale 

number will be written in the header block of an MSAM file for any SORT processor 

operations including COPY. 

The locale number written in the header of an MSAM file created by the SORT processor 

is determined by the following rules: 

1. If the LOCALE parameter is specified, the locale number associated with the 

LOCALE parameter is written. 

2. If the LOCALE parameter is not specified, but an I key is specified, the locale 

number associated with the DEFLOCALE configuration parameter is written. 

3. If neither the LOCALE parameter nor an I key is specified 

a. If the CCSLOCNUM configuration parameter is PREI18N, 0 is written. 

b. If the CCSLOCNUM configuration parameter is DEFAULT, the locale number 

associated with the DEFLOCALE configuration parameter is written. 

c. If the CCSLOCNUM configuration parameter is INPUTDATA, the input files 

locale number is written or, if the input files are not MSAM files, 0 is written. 

7831 0687–010 3–43


3.3.38. LOG Parameter 

This parameter tells the SORT processor to issue all normal sort completion messages 

to the run log. This parameter is the opposite of the DELLOG parameter (see 3.3.17) 

and overrides the LOG configuration parameter (see 9.11). 

Type 

Global 

Format 

LOG 

3.3.39. MERGE Parameter 

This parameter tells the SORT processor to perform a MERGE operation. This is one of 

the parameters referred to as an operation control parameter. 

Type 

Global 

Format 

MERGE 

Description 

The MERGE operation informs the SORT processor that up to 24 sorted input files are 

being merged into one output file. This operation is based on the KEY or KEYW 

parameters (see 3.3.31 and 3.3.32) specified or a user compare routine (the OWN 

parameter in 3.3.45 with exit numbers 14 or 21). This parameter requires the 

specification of the KEY parameter, the KEYW parameter, or the OWN parameter with 

exit number 14 or 21. 

3.3.40. MODE Parameter 

This parameter tells the SORT processor the file type of the files with which the SORT 

processor is working. This parameter applies to both the input and output files. 

Type 


Format 

MODE=recording-mode 

where recording-mode is the file type. The valid field specifications are the following: 

ACOB 

specifies ASCII COBOL internal file format on tape or mass storage as defined by 

the American National Standard COBOL X3.23-1968. This is the default field 


3–44 7831 0687–010


You can create and process ACOB files with the SORT processor or with the ASCII 

COBOL processor. Other processors, such as UCS COBOL, cannot process this file 

format nor is it supported by the Processor Common Input/Output System (PCIOS). 

For more information about ACOB file structure, refer to the OS 1100 ASCII COBOL 

Supplementary Reference (UP-8584). 

ANSI [,rf] 

specifies American National Standard tape format as supported by PCIOS. 

The rf field is the ANSI record format. This field is used to determine the block size 

for I/O operations on ANSI tape. The valid rf specifications are as follows: 

F 

S 

U 

V 

specifies fixed record format. In this format, no control information is appended 

to the record when it is written. A fixed record format can be either fixed 

unblocked or fixed blocked. For fixed unblocked, each data block contains only 

one fixed length record. For fixed blocked, each data block holds one or more 

fixed-length records with each block having the same number of records. An 

exception is the last data block which is smaller if it does not contain the full 

number of records. 

specifies a segmented record format. A segmented record format can be either 

variable unblocked segmented or variable blocked segmented. For a variable 

unblocked segmented format, the record is segmented at the block boundary. 

Five characters of control information are appended to each record segment. 

The first character is the record segment indicator. The remaining four 

characters specify the segment length. The data block holds only one segment 

of the record. Variable blocked segmented records are similar to variable 

unblocked segmented records, however, each block may hold more than one 

record segment. It never holds more than one segment of the same record. 

specifies undefined record format. No control information is appended to the 

record when it is written. Each data block contains only one record and the 

records may be variable in length. 

specifies variable record format. In this format, four ASCII characters of control 

information are appended to each record to indicate its length. A variable record 

format can be either variable unblocked or variable blocked. For variable 

unblocked, each data block contains only one variable length record. For variable 

blocked, each data block contains as many complete records as possible. This is 

the default record format field. 

Whether the record format is blocked or unblocked is determined by the presence or 

absence of the BLOCK parameter (see 3.3.4). If you omit the rf field, the record 

format is defined by the presence or absence of the blocking factor. 

7831 0687–010 3–45


You can produce ANSI files as output from the SORT processor or from another 

processor (that is, ASCII COBOL or UCS COBOL). If you create the ANSI tape file 

with a processor other than the SORT processor, you should know which default file 

characteristics your processor assumes (for example, if the records are variablelength 

or fixed-length). You should also know how the particular processor sets up 

the records in the file you create. 

CARDS 

CFH 

DSDF 

specifies symbiont or alternate symbiont card file format. 

specifies COBOL File Handler (CFH) file format on tape or mass storage. This is the 

default field specification if the SORT processor call option is C (see 3.1). 

specifies direct system data format SDF (DSDF) format as defined by PCIOS, which 

is used to read and write DSDF files. DSDF files must be on mass storage. 

MSAM[,am,[additional buffers]] 

specifies MSAM file format as defined by PCIOS, which is used to read and write 

MSAM files. MSAM files must be on mass storage. 

The variable am indicates the access mode for the output file. The valid am field 


D 

R 

S 

specifies dynamic access. 

specifies random access. This is the default field specification for COPY 

operations. 

specifies sequential access. This is the default field specification for all 

operations except COPY. 

Since records must be in ascending order on the primary key for sequential output, 

the sequential access mode automatically changes to random access when one of 

the following occurs: 

• A descending order sort or an alternative collating sequence is specified on the first 

KEY/KEYW parameter. 

• The start position of the primary MSKEY/MSKEYW parameter is not equal to the 

start position of the first KEY/KEYW. 

• The length of the primary MSKEY/MSKEYW is greater than the length of the first 

KEY/KEYW. 

• A KEY parameter is used with an MSKEYW parameter or a KEYW parameter is used 

with an MSKEY parameter. 

• A SELECT parameter is specified. 

3–46 7831 0687–010

• A user compare routine is specified. 

• The type of the first key is not A, CH, S, or U. 

PRINT 

SDF 


The am field can be used with either a global or local MODE parameter. However, if 

the am field is specified with a local MODE parameter for the FILEIN or FILESIN 

parameter, the am option is ignored. If the MODE parameter is global, the am 

option is applied to the output file only. If the output file has a mode of MSAM, you 

must specify an MSKEY or MSKEYW parameter. 

The number of additional buffers is only meaningful for an MSAM output file. The 

total number of buffers used is 

4 + number of MSKEYS + additional buffers 

Zero is used for additional buffers if none are specified. The maximum number of 

buffers that can be used is 63. 

specifies symbiont or alternate symbiont print file format. The spacing 

characteristics are not preserved when symbiont print files are sorted, merged, or 

copied. 

specifies system data format (SDF) as defined by PCIOS, which is used to read and 

write SDF files. SDF files can be on tape or mass storage. Do not specify files 

produced by the symbionts as SDF files; specify CARDS or PRINT instead. SDF files 

produced by processors such as @DATA, @ED, @CTS, or ExPipe files must be 

specified as MODE=SDF. This is the default field specification if the SORT 

processor call option is S (see 3.1). 

Description 

Specify the MODE parameter when you specify SORT processor call options other than 

A, C, or S (see 3.1). 

See Appendix B for examples using these various file types. 

Note: If the MODE specified is either CARDS or PRINT, and the associated file name is 

CARDS or PRINT, then standard symbiont input or output is indicated. Input cards must 

directly follow the @EOF ending parameter input. 

3.3.41. MOVE Parameter 

This parameter specifies the number of tape marks that the SORT processor must 

bypass before it performs any input operations. 

Type 

Local (FILEIN or FILESIN only) and global 

7831 0687–010 3–47


Format 

MOVE=move-number 

where move-number is an integer that specifies the number of tape marks to bypass. 

If you use the MOVE parameter as a global parameter, all input tapes are moved. 

3.3.42. MSKEY Parameter 

This parameter defines the index keys of a MSAM output file. You must specify either 

the MSKEY or MSKEYW parameter for MSAM output files. 

Type 

Global 

Format 

MSKEY=sc1,nc1:sc2,nc2[,akt2]:...:sc40,nc40[,akt40] 

where 

sc1, sc2, ..., sc40 

are integers specifying the start character of the index keys in the MSAM file. The 

first character position of a record is number one (1). 

nc1, nc2, ..., nc40 

are integers specifying the length, in characters, of the index key in the MSAM file. 

The SORT processor determines whether the characters are ASCII or Fieldata using 

the DATA parameter or the A, C, or M SORT processor call options. 

akt2, ..., akt40 

indicates whether alternate MSAM keys can have duplicates. The valid field 


D 

N 

Duplicate keys are allowed; this is the default field specification. 

Duplicate keys are not allowed. 

If you specify the akt field on the primary key, the field is ignored and a warning 

message is issued. The primary key must not have duplicates. 

Description 

The first MSKEY or MSKEYW definition is the primary index key. The remaining MSKEY 

definitions are alternate keys in the order that they appear in the parameter list. You can 

define up to 40 index keys with this parameter. 

3–48 7831 0687–010

3.3.43. MSKEYW Parameter 


This parameter defines the index keys of a MSAM output file. You must specify either 

the MSKEY or MSKEYW for MSAM output files. 

Type 

Global 

Format 

MSKEYW=sw1,sb1,nb1:sw2,sb2,nb2[,akt2]:...:sw40,sb40,nb40[,akt40] 

where 

sw1, sw2, ..., sw40 

are integers specifying the start word of the index keys in the MSAM file. The first 

word within a record is number one (1). 

sb1, sb2, ..., sb40 

are integers specifying the start bit within the start word of the index keys in the 

MSAM files. The most significant, or leftmost bit of a word is number 35; the least 

significant, or rightmost bit is number 0. 

nb1, nb2, ..., nb40 

are integers specifying the length, in bits, of the index keys in the MSAM file. 

akt2, ..., akt40 

indicates whether alternate MSAM keys can have duplicates. The valid field 


D 

N 

duplicate keys are allowed; this is default field specification. 

duplicate keys are not allowed. 

If you specify the akt field on the primary key, the field is ignored and a warning 

message is issued. The primary key must not have duplicates. 

Description 

The first MSKEY or MSKEYW definition is the primary index key. The remaining 

MSKEYW definitions are alternate keys in the order in which they appear in the 

parameter list. You can define up to 40 index keys with this parameter. 

7831 0687–010 3–49


3.3.44. NUMREC Parameter 

This parameter specifies the number of records to process. 

Type 

Local (FILEIN or FILESIN only) and global 

Format 

NUMREC=record-count 

where record-count is an integer between 1 and 34,359,738,367 that specifies the 

number of records to be processed. 

If you use the NUMREC parameter as a local parameter, the number specified applies to 

each file on a FILESIN parameter. When the number of records specified has been 

processed and more records exist in the input file controlled by the local NUMREC 

parameter, a warning will be issued if the NUMRECWARN configuration parameter is set 

to ALL or LOCAL (see 9.15). 

If you use the NUMREC parameter as a global parameter, the number specified is used 

to count the total records processed, not the number of records processed from each 

input file. If the number of records specified has been processed and more records exist 

in the input file currently being processed or in an unopened input file, a warning will be 

issued if the NUMRECWARN configuration parameter is set to ALL or GLOBAL (see 

9.15). 

3.3.45. OWN Parameter 

This parameter causes your routines to be executed instead of certain standard SORT 

processor routines. If you use the OWN parameter, you must regenerate the SORT 

processor so that it includes your routines (see 4.4). When exit number 32 or 42 is 

specified, this parameter overrides the DELDUPS parameter (see 3.3.16). When exit 

number 14 or 21 is specified, this parameter overrides the KEY and KEYW parameters. 

Type 

Global 

Format 

OWN=exit-1,entry-1:exit-2,entry-2:...:exit-n,entry-n 

where 

exit-1, exit-2, ..., and exit-n 

are integers that specify the exit numbers (see Section 4). 

entry-1, entry-2, ..., and entry-n 

are the corresponding entry point names for your routines. 

3–50 7831 0687–010

3.3.46. PREP Parameter 


This parameter tells the SORT processor that the mass storage device where the file 

resides has a prepping factor requirement that is different from the default prepping 

factors. 

Type 


Format 

PREP=prepping-factor 

where prepping-factor is a prepping factor different from the default factors. This 

parameter must be expressed in words and be a multiple of 28. 

The default prepping factors, according to file type, are the following. 

File Type Prepping Factor in Words 

ACOB Equal to the PREPDEFAULT configuration parameter (see 9.18) 

ANSI Ignored 

ISAM 28 words 

MSAM 448 words 

SDF, DSDF 112 words 

3.3.47. PRESERVE Parameter 

This parameter preserves the order of input records that have equal keys. 

Type 

Global 

Format 

PRESERVE 

Description 

The MERGE operation automatically preserves the order of all input records within one 

input file, so you do not need to specify the PRESERVE parameter with the MERGE 

parameter. If you perform a SORT operation without PRESERVE, input records having 

equal keys may not remain in the order they were input to the SORT processor. This 

parameter overrides the DELDUPS parameter (see 3.3.16). 

7831 0687–010 3–51


3.3.48. PROCESSING Parameter 

This parameter tells the SORT processor to process (that is, release and return) records 

according to a word or bit length. 

Type 

Global 

Format 

PROCESSING=value 

where the valid value field specifications are the following: 

WORD 

indicates that SORT will process (that is, release and return) records on a word 

oriented basis. 

NONWORD 

indicates that SORT will process (that is, release and return) records on a nonword 

oriented basis. This is the default field specification. 

Description 

This parameter overrides the value specified in the PROCESSING configuration 

parameter (see 9.17). If SORT is processing records on a nonword-oriented basis 

and creating a PCIOS SSDF or PCIOS DSDF file, the significant bits in the last word 

field will contain a value in the octal range 01 to 044. If SORT is processing records 

on a word-oriented basis and creating a PCIOS SSDF or PCIOS DSDF file, the 

significant bits in the last word field will always contain a value of octal 044. 

The effects of the PROCESSING parameter are undefined when you are creating a 

MODE ANSI or MSAM file. The PROCESSING parameter has no meaning when you 

are creating a file with a MODE of ACOB, CARDS, CFH, or PRINT, as these files are 

word oriented. 

3.3.49. RECORD Parameter 

This parameter tells the SORT processor approximately how many input records there 

are to be sorted. 

Type 

Global 

Format 

RECORD=sort-record-count 

3–52 7831 0687–010


where sort-record-count is an integer between 1 and 1,073,741,823 that specifies the 

approximate number of records in thousands of records. For example, if you define sortrecord-count 

as 100, the number of input records to be sorted equals approximately 

100,000. 

If you specify this parameter, scratch files are used more efficiently. 

Note: If the number of records specified is too small, the sort operation may not 

successfully complete. If the number of records specified is significantly too large, 

inefficient or unused scratch files will be assigned. 

3.3.50. REELS Parameter 

This parameter specifies the tape reel numbers of noncataloged tape files when the 

HOLD option is specified. 

Type 

Local (FILEIN or FILEOUT only) 

Format 

REELS=reel-number-1,reel-number-2,...,reel-number-20 

where reel-number-1, reel-number-2, ..., reel-number-20 are the reel numbers of 

noncataloged tape files. You can specify a maximum of 20 reel numbers. You can use 

REELS=SCRTCH with the FILEOUT parameter if you are using scratch tapes for output 

operations. Do not use REELS=SCRTCH with the FILEIN parameter. 

Note: If both the HOLD option and the assign syntax appear on the FILEOUT 

parameter, the REELS parameter is ignored (see HOLD in the FILEOUT parameter in 

3.3.26). 

3.3.51. REJECT Parameter 

This parameter performs a test that selectively rejects records from processing by the 

SORT processor. The records that are rejected are ignored and are not included in the 

output file. This parameter has been replaced by the ACCEPT parameter (see 3.3.1). 

Type 

Global 

Format 

REJECT=test-word,test-operation,value,type[, partial-word] 

where 

test-word 

is an integer that specifies the word within each record to be tested. The first word 

of a record is number one (1). 

7831 0687–010 3–53




valid test-operation field specifications are the following: 

E 

G 

value 

type 

LE 

NE 

specifies a test-equal operation. 

specifies a test-greater operation. 

specifies a test-less-or-equal operation. 

specifies a test-not-equal operation. 

can be an octal number, a decimal number, or a character string. If it is a character 

string that is less than a full word, the string is right-justified and space-filled. 

is used to define the type of the value specified. The valid type field specifications 


ASC 

CAS 

The value field is specified in ASCII (uppercase and lowercase letters will match). 

The value field is specified in ASCII (case sensitive—uppercase and lowercase 

letters will not match). 

DEC or D 

FD or C 

The value field is specified in decimal. 

The value field is specified in Fieldata. 

OCT or O 

partial-word 

The value field is specified in octal. 

is used to test a specific portion of test-word. The partial-word field is optional; the 

valid partial-word specifications are the following: 

H1 

H2 

tests H1 of test-word. 

tests H2 of test-word. 

3–54 7831 0687–010

Q1 

Q2 

Q3 

Q4 

S1 

S2 

S3 

S4 

S5 

S6 

Notes: 

tests Q1 of test-word. 




tests S1 of test-word. 







• You can specify only one REJECT parameter. If you specify more than one, the 

processor defaults to the last REJECT parameter you specify. 

• To specify a character string containing an embedded space comma, or semicolon, 

you must specify the entire string as an octal value. 

• Use the ACCEPT parameter if you require greater capability and flexibility. 

3.3.52. RETRIEVE Parameter 

This parameter tells the SORT processor to perform a RETRIEVE operation. This is one 

of the parameters referred to as an operation control parameter. 

Type 

Global 

7831 0687–010 3–55


Format 

RETRIEVE 

Description 

Use the RETRIEVE parameter in conjunction with the TAG operation (but not necessarily 

in the same @SORT call). The SORT processor uses the tag file created during a TAG 

operation and defined by the TAGFILE parameter (see 3.3.65) to read records randomly 

from the file specified on the FILEIN parameter. The SORT processor then writes these 

records to the file specified on the FILEOUT parameter. 

You can specify only a single mass storage file with a MODE of ACOB, CFH, DSDF, 

ISAM, or MSAM as input for the RETRIEVE and TAG parameters. This file must not be 

changed between the time that the TAG operation completes and the time that the 

RETRIEVE operation starts. 

The RETRIEVE parameter is particularly useful for sorts of very large records with small 

key fields. Using the TAG and RETRIEVE parameters, you read the input records twice: 

once sequentially and once randomly. You write the output record only once. This may 

be faster and more efficient than passing entire records through all phases of the sort. 

See Section 10 for more details about efficient sorting. 

3.3.53. REVMSAMBLK Parameter 

This parameter informs the SORT processor to reverse the meaning of the 

MSAMBLOCK configuration parameter (see 9.14) and causes the SORT processor to 

create the MSAM file with the appropriate block size. 

Type 


Format 

REVMSAMBLK 

Description 

This parameter is a FILEOUT local parameter and is meaningful only when the MODE of 

the FILEOUT file is MSAM. This parameter affects the block size used to create the 

MSAM file by reversing the meaning of the MSAMBLOCK configuration parameter. If 

this parameter is specified and the MSAMBLOCK configuration parameter is set to 

DEFAULTCALC, the MSAM file is created with the block size specified by the BLOCK 

parameter associated with this file rounded to the next prep size. If this parameter is 

specified and the MSAMBLOCK configuration parameter is set to BLOCKPARAM, the 

MSAM file is created with the greater of the block size specified by the BLOCK 

parameter associated with this file rounded to the next prep size or a default minimum 

block size calculated by the SORT processor rounded to the next prep size. Sort uses 

the greater of the following formulas as the calculation of the minimum block size: 

or 

10 * (maximum record word length + number of MSKEYs with duplicates + 2) + 6 

3–56 7831 0687–010

200 * (maximum MSKEY word length + number of alternate MSKEYs + 1) + 8 


If a BLOCK parameter is not applicable to the FILEOUT parameter, the block size used to 

read the first input file is substituted for the block size specified by the BLOCK 

parameter associated with this file. 

If this parameter is not specified and the MODE of the FILEOUT file is MSAM, the 

MSAMBLOCK configuration parameter setting determines the block size used to create 

the MSAM file. 

3.3.54. RSZ Parameter 

This parameter tells the SORT processor the length of the records that it processes. 

Type 

Global 

Format 

RSZ=record-size[, record-granularity] 

where 

record-size 

must be an integer that states the number of words, characters, or bits per record. 

For fixed-length records, specify the exact record size. For variable length records, 

specify the maximum record size. 

For ANSI files, the record size you specify on the RSZ parameter must match the 

record size that appears in the record control word of the file (see MODE in 3.3.40). 

record-granularity 

specifies the granularity of the record-size field. The valid record-granularity 

specification fields are as follows: 

CHARACTERS 

specifies that the record-size field is in characters. The SORT processor 

determines whether the characters are ASCII or Fieldata by the DATA parameter 

or by the A, C, or M SORT processor call options. This is the default field 


WORDS 

BITS 

specifies that the record-size field is in words. 

specifies that the record-size field is in bits. 

7831 0687–010 3–57


Description 

The RSZ parameter is required when the first input file is one of the following: 

• Unlabeled 

• An index sequential-access method (ISAM) or MSAM file 

• An ACOB file and a LINKSZ parameter is given 

The SORT processor will determine the record size as indicated in Table 3–3. 

Table 3–3. Determining Processor Record Size 

Operation Z Option Not Specified Z Option Specified 

COPY SELECT The record size is the record size 

resulting from the SELECT 

parameter. 

NO SELECT The word record size is either the 

record size of the RSZ parameter 

or the record size of the FIRST 

input file, whichever is larger. The 

number of bits in the last word is 

further determined by the longest 

record in any input file. 

MERGE SELECT The record size is the record size 


parameter. 

NO SELECT The record size is either the record 

size of the RSZ parameter or the 

input file with the largest record 

size. 

SORT SELECT The record size is the record size 


parameter. 

NO SELECT The word record size is either the 

record size of the RSZ parameter 

or the record size of the FIRST 

input file, whichever is larger. The 

number of bits in the last word is 

further determined by the longest 

record in any input file. 

The record size is the 

record size resulting 

from the SELECT 

parameter. 

The record size is either 

the record size of the 

RSZ parameter or the 

input file with the 

largest record size. 




parameter. 









parameter. 






3–58 7831 0687–010

3.3.55. SELECT Parameter 

This parameter tells the SORT processor how to reformat data records. 

Type 

Local (FILEIN or FILESIN only) or global 

Format 

SELECT=sc1,nc1[[, ocp1]:...:sc40,nc40[, ocp40]] 

where 

sc1, ..., sc40 


are integers specifying the starting character positions of the select fields within the 

input record. The first character position in the record is number one (1). 

nc1, ..., nc40 

are integers specifying the number of characters in each select field. 

ocp1, ..., ocp40 

are integers specifying the output character positions that the select fields occupy in 

the new record. You can omit the ocp specifications. If you omit an ocp for a 

selected field, that field begins immediately after the last character of the previous 

field you selected. The resulting record consists of only those fields that you select. 

Description 

The SELECT parameter tells the SORT processor how to reformat data records by 

specifying 1 to 40 fields from the input records to be used to create the output record. 

Notes: 

• The KEY parameter refers to the fields in the input record before the record is 

reformatted according to the specifications of the SELECT parameter. 

• You can use the SELECT parameter with the SORT, MERGE, COPY, and TAG 

parameters. 

• Different SELECT parameters can create different record sizes; however, all records 

are space-filled to make them the same size. 

• If needed, the SORT processor generates a default global SELECT with one field, 

using the RSZ parameter or SELECT record size, whichever is larger. 

• Do not use the LINKSZ and SELECT parameters together because SELECT 

parameter processing always creates fixed length records. 

7831 0687–010 3–59


3.3.56. SEQ Parameter 

This parameter specifies an alternate collating sequence used with type A key fields (see 

3.3.31). This parameter cannot be used with the SEQX parameter with option SEQF 

(see SEQX in 3.3.59). 

Type 

Global 

Format 

SEQ=n1,n2,n3[,UPTO],ni,nj[,ALL] 

where 

n1, n2, n3, ni, and nj 

UPTO 

ALL 

are octal values that represent the new collating order for type A key fields. You can 

list all 64 values, if necessary. If you do not list them all, you must use the ALL 

option to fill in the collating table with the remainder of the values that you do not 

explicitly specify. 

can be used to specify a range of numbers that is to appear in sequence in the 

collating table. 

lists all octal values in the collating table that you do not explicitly specify in the n 

fields. 

3.3.57. SEQA Parameter 

This parameter specifies an alternate 128-character collating sequence used with type S 

key fields. You use the SEQA parameter just as you use the SEQC parameter, except 

that 128 characters are generated. This parameter cannot be used with the SEQC 

parameter or with the SEQX parameter with options SEQB, SEQD, SEQE, or SEQK. 

Type 

Global 

Format 

SEQA=n1,n2,n3[,UPTO],ni,nj[,ALL] 

where 


are octal values that represent the new collating order for type S key fields. You can 




3–60 7831 0687–010

UPTO 

ALL 





fields. 

3.3.58. SEQC Parameter 

This parameter specifies an alternate 256-character collating sequence used in type S 

key fields. You use the SEQC parameter just as you use the SEQA parameter except 

that 256 characters are generated. The SEQC parameter cannot appear in the same 

parameter list as the SEQA parameter or with the SEQX parameter with options SEQB, 

SEQD, SEQE, or SEQK. 

Type 

Global 

Format 

SEQC=n1,n2,n3[,UPTO],ni,nj[,ALL] 

where 


UPTO 

ALL 








fields. 

3.3.59. SEQX Parameter 

This parameter generates automatic character collating sequences of 64, 128, or 256 

characters. The generated collating sequence is defined by the seq-type. 

The SEQX parameter with the SEQF seq-type cannot appear in the same parameter list 

as the SEQ parameter. Also, the SEQX parameter with the SEQB, SEQD, SEQE, or 

SEQK seq-type cannot appear in the same parameter list as the SEQA or SEQC 

parameters. 

7831 0687–010 3–61


Type 

Global 

Format 

SEQX=seq-type 

where seq-type defines the collating sequence generated. The collating sequence is 

defined with the following specifications: 

SEQB 

SEQD 

SEQE 

SEQF 

SEQK 

generates a 128-character table for use with all type S keys. The sequence 

generated is space, letters (A,a,B,b...Z,z), and numbers, followed by all special 

characters from 0 to 0177 octal. 

generates a 256-character sequence used with all type S keys. The sequence 

generated is the same as for the SEQB parameter except that the last character is 

0377 octal. 

generates a 256-character sequence used by all type S keys. The sequence 

generated follows the EBCDIC collating sequence. 

specifies a Fieldata collating sequence that is used with all type A keys. The 

sequence generated is space, letters, numbers, followed by all special characters 

starting with 0 and ending with 077 octal. 

generates a 256-character sequence used by all type S keys. The sequence 

generated is the normal katakana character sequence. 

Note: Two SEQX parameters can appear in the same parameter list only if one of the 

SEQX parameters specifies the seq-type SEQF while the other SEQX parameter 

specifies a SEQB, SEQD, SEQE, or SEQK seq-type. 

3.3.60. SKIPL Parameter 

This parameter tells the SORT processor to skip a certain number of logical records 

before taking records as sort input. 

Type 

Local (FILEIN or FILESIN only) or global 

Format 

SKIPL=logical-records 

3–62 7831 0687–010


where logical-records is an integer between 1 and 34,359,738,367 that specifies the 

number of records to skip. Its value is unrelated to the record blocking factor. You can 

use the SKIPL parameter to skip both fixed and variable length records on input. 

If you use the SKIPL parameter as a global parameter, the number you specify refers to 

the total input skip count, not the skip count for each input file. 

3.3.61. SORT Parameter 

This parameter tells the SORT processor to perform a sort operation. This is one of the 

parameters referred to as an operation control parameter; it is the default operation 

control parameter. 

Type 

Global 

Format 

SORT 

Description 

When performing a SORT operation, you can supply additional information with other 

SORT processor parameters. If you do not specify an operation control parameter, the 

SORT processor assumes the operation is SORT. As many as 24 files can be used for 

input. 

This operation is based on the KEY or KEYW parameters (see 3.3.31 and 3.3.32) 

specified or a user compare routine (the OWN parameter in 3.3.45 with exit numbers 14 

or 21). This parameter requires the specification of the KEY parameter, the KEYW 

parameter, or the OWN parameter with exit number 14 or 21. 

3.3.62. SPLIT Parameter 

This parameter separates the index key from the record when the record is output to an 

ISAM file. This avoids duplication of the index key in the record and index areas of the 

ISAM file. 

Type 


Format 

SPLIT 

Description 

The SORT processor copies the index key from the part of the record defined by the 

ISKEY or ISKEYW parameters. It then moves the rest of the record into the area that 

formerly contained the index key. If the index key size is not a multiple of a whole 

character, the part of the record that is moved is misaligned with the character 

boundaries. 

7831 0687–010 3–63


Any other parameters you specify (for example ALLOW, RSZ, and SELECT) apply to the 

original form of the record before the index key was separated. 





3.3.63. STOP Parameter 

The STOP processor parameter allows you to conditionally stop the processing of input 

records when a specified condition is met. 

Type 

Global 

Format 

STOP=sc,nc,type,test-operation,value[, logical-operation] 

where 

sc 

nc 

type 

is an integer that indicates at which character position within the data record the 

STOP parameter test is to begin. The first character position of a record is number 

one (1). 

is an integer that specifies the number of characters to be tested. 



ASC 

CAS 

DEC 


nb fields represent 9-bit characters. This data type is not case sensitive. For 

data comparison purposes, lowercase alphabetic characters a-z (0141-0172) will 

be folded to uppercase. Thus, characters 0133-0140 will be considered to be 

greater than either an uppercase Z or a lowercase z. 


nb fields represent 9-bit characters. For data comparison purposes, uppercase 

(0101-0132) and lowercase (0141-0172) letters are treated as unequal. 



3–64 7831 0687–010

DECFD 

FD 

OCT 


value 




The value field is specified in Fieldata and that the sb and nb fields represent 



characters. 

specifies how the test data is compared to the data in the area you are testing. 

The valid test-operation field specifications are the following: 

E 

G 

GE 

L 

LE 

NE 

specifies a test equal operation. 

specifies a test greater operation. 

specifies a test greater or equal operation. 

specifies a test less operation. 

specifies a test less or equal operation. 

specifies a test not equal operation. 

contains the test data to be compared with the part of the record you specify in 

the sc and nc fields. If the test data is decimal, it cannot exceed 36 bits and its 

value cannot be greater than 68,719,476,734 (0777777777776 octal). For all 

other types of data, this field can be up to 60 characters in length. If the type 

field is ASC or CAS, the test value may be entered as a character string or as a 

nonnumeric literal. The literal must not exceed 60 characters (excluding the 

delimiters). 

7831 0687–010 3–65


Note: You specify a character string containing an embedded space, comma or 

semicolon in one of three ways: 

• Use the nonnumeric literal syntax. (Valid only for ASC and CAS data types). 

• Specify the entire string as an octal value. 

• Specify the characters preceding the space, comma, or semicolon by using one 

STOP parameter; specify the space, comma, or semicolon character as an octal 

value by using another STOP parameter; and specify the remaining characters by 

using a third STOP parameter. 

logical-operation 

controls the conditional stop of records with more than one STOP parameter. 

The test operations and logical operations you specify with the STOP parameters 

form a logical expression that determines whether the SORT processor 

processes a record. If the logical expression is true, the SORT processor stops 

the processing of the following records. Valid field specifications for logical 

operation are the following: 

AND 

OR 

Description 

Consecutive STOP parameters are connected with the logical AND 

operation. 

Consecutive STOP parameters are connected with the logical OR operation. 

This is the default field specification. 

This parameter stops the processing of input records for all the input files when more 

than one input file is specified (using multiple FILEIN parameters or a single FILESIN 

parameter). See the STOPAPP parameter (see 3.3.64) to apply stop conditions on 

individual input files. 

The STOP parameter is independent from the specification of NUMREC (both local and 

global) and the SKIPL parameter. The conditions for SKIPL and NUMREC have higher 

precedence than those for STOP. If the maximum record count, specified by the 

NUMREC parameter, is met before the condition specified in the STOP parameter, then 

only the number of records specified using NUMREC are processed, and vice-versa. 

You can specify this parameter along with the ACCEPT, ALLOW and REJECT processor 

parameters to further reduce the number of input records to be processed. If both 

ACCEPT (or ALLOW or REJECT) and STOP conditions are satisfied on the same record, 

that record is not processed (that is, the STOP parameter has higher precedence than 

the ACCEPT parameter). You can specify multiple STOP parameters for multiple STOP 

conditions, but all STOP parameters must occur consecutively (as in the case of the 

ACCEPT processor parameter). Otherwise, the SORT processor issues an appropriate 

error and terminates. The maximum number of consecutive STOP parameters allowed 

is 50. 

You can specify this parameter for all operations. 

3–66 7831 0687–010

3.3.64. STOPAPP Parameter 


This local FILEIN or FILESIN parameter indicates how the STOP parameter condition 

applies to a record from a particular input file. The STOPAPP parameter can accept three 

values: ALL, YES and NO. If the STOPAPP parameter is specified on a FILESIN 

parameter, its meaning applies to all files specified on the FILESIN parameter. 

If you do not specify the STOPAPP parameter and the STOP parameter is specified, 

when a record satisfies a STOP condition then 

• The record is not released. 

• The input file is closed. 

• No more records from any input file are released. 

• Any opened input file is closed. 

If the STOPAPP parameter is specified and a STOP parameter is not specified, the 

STOPAPP parameter is ignored and no error message is issued. It is illegal to specify 

the STOPAPP parameter as global or local to a FILEOUT parameter. 

Type 

Local (FILEIN or FILESIN only) 

Format 

STOPAPP=stop-condition-file-implication 

where stop-condition-file-implication can be one of the following values: 

ALL 

YES 

NO 

This stop-condition-file-implication value is the default value and means that if a 

record in this input file satisfies the conditions from the STOP parameter, no more 

records (including the current record) will be released from any input file. 

This stop-condition-file-implication value means that if a record in this input file 

satisfies the conditions from the STOP parameter, no more records (including the 

current record) are released from this input file. This input file will be closed and the 

next record released will come from another input file. 

This stop-condition-file-implication value means that if a record in this input file 

satisfies the conditions from the STOP parameter, the STOP parameter condition will 

be ignored and the current record will be released. 

7831 0687–010 3–67


Example 

FILEIN=IN1 MODE=SDF STOPAPP=YES 

FILEIN=IN2 MODE=SDF STOPAPP=NO 

FILEIN=IN3 MODE=SDF STOPAPP=ALL 

FILEIN=IN4 MODE=SDF STOPAPP=NO 

. 

. 

. 

STOP=1,2,ASC,E,MN 

If a record from IN1 satisfies the STOP condition, no more records including the record 

that satisfies the condition are released from IN1. IN1 is closed and records are released 

from the other files. 

Since STOPAPP=NO for IN2 and IN4, the records in IN2 and IN4 are released without 

testing for the STOP condition. 

If a record from IN3 satisfies the STOP condition, no more records from IN3 or from any 

other input file are released because STOPAPP=ALL. Any opened input file is closed. 

3.3.65. TAG Parameter 

This parameter tells the SORT processor to perform a tag sort. 

Type 

Global 

Format 

TAG[=sc1,nc1[[,ocp1]:...:sc40,nc40[,ocp40]]] 

where 

sc1, ..., sc40 

are integers specifying the starting character positions of the select fields within the 

input record. The first character position in a record is number one (1). 

nc1, ..., nc40 

are integers specifying the length, in characters, of the select fields. 

ocp1, ..., ocp40 

are integers specifying the new character positions for the select fields in the output 

record. If they are present, the fields you specify appear in the TAG parameter file 

created by the SORT processor. 

3–68 7831 0687–010

Description 


Use the TAG parameter in conjunction with the RETRIEVE operation (but not necessarily 

in the same @SORT call). The SORT processor uses the tag file defined by the TAGFILE 

parameter (see 3.3.65) to save the sorted records during the TAG operation. The SORT 

processor then uses the TAGFILE during the RETRIEVE operation to randomly read the 

records from the input file. 

You can specify only a single mass storage file with a MODE of ACOB, CFH, DSDF, 

ISAM or MSAM as input for the TAG and RETRIEVE parameters. This file must not be 

changed between the time that the TAG operation completes and the time that the 

RETRIEVE operation starts. 

The TAG and RETRIEVE parameter is particularly useful for sorts of very large records 

with small key fields. Using the TAG and RETRIEVE parameters, you read the input 

records twice: once sequentially and once randomly. You write the output record only 

once. This is faster and more efficient than passing entire records through all phases of 

the sort. See Section 10 for more details about efficient sorting. 

This operation is based on the KEY or KEYW parameters (see 3.3.31 and 3.3.32) 

specified or a user compare routine (the OWN parameter in 3.3.45 with exit numbers 14 

or 21). This parameter requires the specification of the KEY parameter, the KEYW 

parameter, or the OWN parameter with exit number 14 or 21. 

When you specify a TAG sort, always use the DISKS parameter (see 3.3.18) to cause a 

disk sort to be performed. 

3.3.66. TAGFILE Parameter 

This parameter specifies the name of the tag file to be used during a TAG or RETRIEVE 

operation. 

Type 

Global 

Format 

TAGFILE=tag-file-name 

where tag-file-name is the file created by the TAG parameter and used by the SORT 

processor operation with the RETRIEVE parameter. If the TAG and RETRIEVE 

parameters are specified in different processor invocations, the same TAGFILE must be 

used in both invocations. If you specify the TAG or RETRIEVE parameter without a 

TAGFILE parameter, the SORT processor uses a temporary file called TAG$FILE as the 

default file. The file you specify as tag-file-name must be assigned before you enter the 


7831 0687–010 3–69


Tag File Record Structures 

The following record structures show the format of a tag file record for use in a TAG 

sort. If you are coding your own COMP or DROC routines (see 6.6), use the respective 

record structure for the tag file, as follows: 

+0 

+1 

+2 

3.3.67. TAPES Parameter 

This parameter tells the SORT processor about the tape files to be used as scratch files 

for the tape sort. 

Type 

Global 

Format 

TAPES[=number-of-tapes[(min-number,max-number)][, equipment-type]] 

where 

ACOB/CFH Input File DSDF Input File ISAM/MASM Input File 

number-of-tapes 

is an integer (3 to 24) specifying the number of tapes to be assigned. If this field is 

omitted or has a value of zero, the SORT processor determines the number of tapes 

it needs. 

The tape files are assigned with names from XC through XZ. If you assign these 

names to any tapes before calling the SORT processor, these tapes are used as 

scratch files. 

min-number and max-number 

are integers that specify the range of the number of tapes that can be used to 

perform the sort. This field is used only with the ESTIMATE parameter (see 3.3.22). 

The SORT processor prints the best combination of processing time and number of 

tapes in the range. 


Mass Storage 

Address 

Mass Storage 

Offset 

+0 

+1 

+0 

Record Number Primary Index Key 

Select Fields Select Fields Select Fields 

is a valid @ASG equipment code for any tape assignment, except streaming tape or 

1/4-inch cartridge tape (see the ER Programming Reference Manual). If you do not 

specify equipment-type, the DEFTP configuration parameter (see 9.8) is assumed. 

3–70 7831 0687–010 

+n

3.3.68. VOLUME Parameter 


This parameter tells the SORT processor the approximate volume of input to the sort so 

that it can determine the scratch facilities required. 

Type 

Global 

Format 

VOLUME=volume-range 

where volume-range is a value that identifies a range of approximate input volume, with 

the following valid field specifications: 

SMALL 

specifies less than 3 million words. 

MEDIUM 

LARGE 

Notes: 

specifies between 3 million words and 11 million words. 

specifies between 11 million words and 23 million words. 

• If you know the record count, use the RECORD parameter instead of VOLUME to 

provide the SORT processor with a more accurate volume indication. 

• Do not use the VOLUME parameter for input volumes over 23 million words. 

3.4. Operator Information 

The SORT processor uses operator information to determine what kind of sort to 

execute. There are two factors that affect the sort operation, as follows: 

• Estimations 

• Scratch facility assignment 

These two sort operation factors are discussed in the following subsections. 

3.4.1. Estimations 

If you specify the ESTIMATE parameter (see 3.3.22), the SORT processor does not 

assign any scratch facilities. If you assign scratch facilities, the information they provide 

is used to determine the type of sort (for example, main-storage-only, M1 only, M1–M2, 

disk, or tape) and the volume of the sort. 

7831 0687–010 3–71


You can also specify this information with the SORT processor call options X or Y (see 

3.1), or with the CORE (see 3.3.12), DISKS (see 3.3.18), DRUM (see 3.3.19), FAST (see 

3.3.23), NUMREC (see 3.3.44), RECORD (see 3.3.49), TAPES (see 3.3.67), or VOLUME 

(see 3.3.68) parameters. If you provide facility information, the SORT processor 

determines the scratch facilities needed and bases its estimation on those values. 

To estimate SORT processor input and output time, information pertaining to the input 

and output files is used. The input files and output file do not have to be assigned to the 

run when an ESTIMATE parameter is present. The EQUIP parameter (see 3.3.20) can be 

used to specify information about these files if they are not assigned. The BLOCK 

parameter (see 3.3.4) must be present to supply block sizes for input and output files. 

After an estimation is completed, the ESTIMATE parameter can be removed from the 

parameter list and a new SORT processor call initiated to perform the sort operation. 

3.4.2. Scratch Facility Assignment 

You can assign scratch files before calling the SORT processor. If you assign scratch 

files before calling the SORT processor, the DISKS (see 3.3.18), DRUM (see 3.3.19), 

FAST (see 3.3.23), or TAPES (see 3.3.66) parameters, as well as the SORT processor call 

options X and Y can be affected (see 3.1). 

Name Assignment Guidelines 

The only valid internal file names for SORT processor scratch files are XA through XZ. 

If you assign the SORT processor scratch facilities before calling the SORT processor, 

the file names you use must be within the range of XA through XZ. In addition, you 

must follow these guidelines when you assign the scratch files: 

• If you want a one-level mass storage (M1) sort, the file name you assign should be 

XA. Any other file name can cause a different type of sort to be performed, 

depending on the parameters and options specified. 

• If you want a two-level mass storage (M2) sort, the file names you assign should be 

XA and XB. Any other file names can cause a different type of sort to be performed. 

You can use the SORT processor call option X to perform an M1 sort. This option can be 

used with the DRUM parameter but not with the FAST, TAPES, or DISKS parameters. 

If you do not assign scratch files, the SORT processor call option X is not specified, and 

the DRUM, FAST, TAPES, or DISKS parameters are not specified, the SORT processor 

assigns the scratch files and selects the type of sort to perform. This determination is 

based on the information available for input volume. See the RSZ (3.3.54) and LINKSZ 

parameters (3.3.36), the VOLUME parameter (3.3.68), and the RECORD parameter 

(3.3.49). 

3–72 7831 0687–010

Determining Input Volume 


The SORT processor determines the input volume using the following order of 

precedence: 

• RECORD parameter, if the RSZ parameter is also specified 

• NUMREC parameter, if the RSZ parameter is also specified 

• VOLUME parameter 

• Input volume estimation 

The input volume estimation is determined automatically by adding all of the input file 

sizes. The SORT processor uses an ER FITEM$ input volume estimation to check the 

highest granule referenced for disk files and the highest word for word-addressable 

mass storage files. Tape files are assumed to be full volumes except for files assigned 

to the CTS9840, CTC9840 (U9840C), CTS9940, DLT7CT, LTO3, LTO4, UT10KA, and 

U9840D tape subsystems. For some file types, the SORT processor examines the input 

file label to determine the input volume. The SORT processor cannot estimate the input 

volume for an ExPipe input file. 

For files assigned to the CTS9840, CTC9840 (U9840C), CTS9940, DLT7CT, LTO3, LTO4, 

UT10KA, and U9840D tape subsystems, the input volume is estimated at 2 GB unless 

other parameters (for example, RECORD or NUMREC) are specified. If these 

parameters are not specified and the input volume is greater than 2 GB, the scratch files 

must be explicitly assigned prior to invoking the SORT processor. If the input file is a 

multi-volume tape file, only the last volume of the multi-volume set is assumed to have a 

2GB volume. All volumes, other than the last volume, are assumed to be full volumes. 

The following table describes the scratch facility assignment process. 

If ... Then the SORT processor ... 

You specify the X processor option or the 

DRUM parameter 

Tries to assign a temporary mass storage file named 

XA. If a mass storage file named XA is already 

assigned, that file is used instead. 

The FAST parameter is used Tries to assign temporary mass storage files named 

XA and XB. If mass storage files named XA and XB 

are already assigned, these files are used instead. 

The TAPES parameter is used Tries to assign temporary tape files starting with the 

name XC. If tape files with the same names are 

already assigned, these previously assigned tape 

files are used. 

The DISKS parameter is used Tries to assign temporary disk files starting with the 

name XC if 3 to 24 files are requested, XB if 25 files 

are requested, and XA if 26 files are requested. If 

disk files with the same names are already assigned, 

these previously assigned disk files are used. 

No scratch facilities were assigned before 

entering the SORT processor and no 

facility parameters were specified 

Determines the scratch facilities needed and assigns 

them to provide an efficient sort. 

7831 0687–010 3–73


After the SORT processor performs the desired operation, all scratch files that it 

assigned are freed. 

3.5. SORT Processor Use of the Run-Condition 

Word 

The run-condition word is established by the Executive system. The SORT processor 

uses bits 7 and 8 (bit 0 on the left) of the run-condition word to indicate the termination 

status of an activation of the SORT processor as follows: 

• Bit 7 – If bit 8 is already set prior to initialization of the SORT processor, bit 7 is set to 

indicate that some previous task in this runstream has registered an error. 

• Bit 8 – During initialization of the SORT processor, bit 8 is set. If this task completes 

normally and does not issue a nonrecoverable error, bit 8 is cleared prior to 

termination. Otherwise, bit 8 remains set. 

After the call to the SORT processor, you can test the value of these bits with the ECL 

@TEST statement. 

For more information on the run-condition word, see the Executive Requests 

Programming Reference Manual. 

3–74 7831 0687–010

Section 4 

User Exit Coding Considerations 

This section explains how to gain control of a sort operation by accessing your own 

routines through the SORT processor. It describes the exit numbers you need to code 

as well as other coding you must do before returning to normal processing. 

4.1. Procedures for Using Your Own Routines 

Before deciding to include your own routines, check the ACCEPT parameter (see 3.3.1), 

as well as other SORT processor parameters (see 3.3), to see whether they include the 

capabilities you are trying to gain by using your own routine. If you choose to write your 

own routines, be aware of the following: 

1. You must write your code routines in basic mode. 

2. Re-collect the SORT processor so that your routines are incorporated into the SORT 

processor code. 

Note: If you plan to use your routines again, be sure to save the SORT absolute. 

3. Select the user exit number or numbers appropriate to your routines (see 4.2). Be 

aware of the entry conditions and return requirements for the routine (see 4.3). 

4.2. Using Exit Numbers 

You can call your routines by specifying an OWN parameter (see 3.3.45) when the SORT 

processor is executed. The exit numbers and the routine called by an exit number are 

determined by the OWN parameter. Each exit has a specific purpose, entry conditions, 

and return requirements. 

Table 4–1 contains the available user exit numbers, the purpose of the exit number when 

a routine associated with the exit number is called, and the subsection where you can 

locate the particular information about the exit number. 

Note: Not all exit numbers are available for all file types. These situations are noted 

within the related subsections. 

7831 0687–010 4–1


Exit 

Number 

Table 4–1. SORT Processor User Exit Numbers 

Time of Access 

01 Immediately after the OWN 

parameter is processed. 

10 Before the I/O operation on each 

input label. 

11, 45 After the I/O operation on each 

input label 

12, 46 After each block of data is read 

by the SORT processor. 

13 Before each record is input to the 

SORT processor 

14, 21 Each time records are to be 

compared. 

15, 47 When an unrecoverable read 

error occurs. 

31, 41 Immediately before each output 

label is written. 

32, 42 Each time equal records are 

found on the compare. 

33, 43 Before each record is moved to 

the output buffer. 

34, 44 Before each block of output data 

is written. 

Purpose 

Lets your routine read any user control 

statements. 

Lets your routine do the I/O needed to 

process input label records. 

Lets your routine check nonstandard 

header and trailer labels on an input file 

Lets your routine alter or delete a block 

of data from an input file 

Lets your routine examine the records 

before they are processed by the SORT 

processor 

Lets your routine compare two records 

to see which is first in the sorting 

sequence. 

Reference 

4–2 7831 0687–010 

4.3.1 

4.3.2 

4.3.3 

4.3.4 

4.3.5 

4.3.6 

Lets your routine process the error. 4.3.7 

Lets your routine write nonstandard 

header and trailer labels on an output 

file. 

Lets your routine alter or delete records 

with equal keys. 

Lets your routine alter, add, or delete 

records. 

Lets your routine alter or eliminate the 

entire block. 

4.3.8 

4.3.9 

4.3.10 

4.3.11

4.3. User Exit Number Explanation 


The following subsections describe the user exit numbers shown in Table 4–1 and define 

the return requirements. 

Note: On all user exits, you must either save and restore register X9 or not alter this 

register at all. 

4.3.1. User Exit 01 

Purpose 

This exit is activated immediately after the OWN parameter (see 3.3.45) statement is 

processed. This exit lets your routine read any user control statements. 

Control is transferred to your routine, which can read any user control statement. The 

control statements must directly follow the OWN parameter statement. Other SORT 

processor parameters can follow the user control statements. 

Return Requirements 

Your routine must return to the SORT processor with a J 0,X6 instruction. 


Purpose 

This exit is activated before the I/O operation on each input label occurs. This exit lets 

your routine do the I/O needed to process input label records. 

When this exit is activated, register A0 contains the address of a 28-word label buffer. 


Upon return, H1 of A0 must contain one of the following values: 

Fieldata F (013) 

End of file 

Fieldata V (033) 

End of volume 

Octal 1 

Ignore the label 

Octal 2 

Process the label 

In addition, A1 must contain the record size in words and A2 must contain the block size 

in words. 

7831 0687–010 4–3


Your routine must return with a J 0,X6 instruction. 

Note: This exit is available for all file types except symbiont. 

4.3.3. User Exit 11 or 45 

Purpose 

These two exit numbers have identical meanings to the SORT processor. They are 

activated after the I/O operation on each input label occurs. These exit numbers let your 

routine check nonstandard header and trailer labels on an input file. 

When exit number 11 or 45 is activated, register A0 contains the address of the first 

word of the label. 


On return, H1 of register A0 must contain one of the following values: 


End of file 


End of volume 

Octal 1 


Octal 2 


In addition, H2 of register A0 must contain the address of the label area. 


Note: This exit is available for all files except symbiont. 

4.3.4. User Exit 12 or 46 

Purpose 

These exits have identical meaning to the SORT processor. They are activated each 

time a block of input data is read by the SORT processor. These exit numbers let your 

routine alter or delete a block of data from an input file. 

When exit number 12 or 46 is activated, register A0 contains the address of the 

beginning of the block. 


On return, whether the block is altered or unaltered, H2 of register A0 must contain the 

block address. However, if the block is altered, the ending block address must be in H1 

of register A0. 

4–4 7831 0687–010


The size of the block cannot be increased if altered and the data file structure of the 

block must be maintained. If the block is to be deleted, then register A0 must be 

returned as zero. 


Note: This exit is only available for ACOB and COBOL file-handler (CFH) files. 


Purpose 

This exit is activated before each record is processed by the SORT processor. This exit 

lets your routine examine the records and alter, add, or delete them. If records are 

altered, they cannot exceed the original length of the record. This exit is not available for 

TAG (see 3.3.65) or SELECT sorts (see 3.3.55). 

When you activate exit number 13, H2 of register A0 contains the address of the first 

word of the record. If you are processing variable length records, H1 of register A0 

contains the word length of the record. 


If the record is to be deleted, register A0 must be set to zero. 

If a record is to be inserted, H1 of register A1 must be zero and H2 of register A1 must 

contain the address of the first word of the record to be inserted. If you are processing 

variable length records, H1 of register A0 contains the word length of the record to be 

inserted. The record to be inserted cannot be located at the address contained in 

register A0 prior to the beginning of the record insertion. 

If record insertion is completed or no record insertion is to occur, H1 of register A1 must 

contain a nonzero value or register A1 must be zero. The record at the address 

contained in register A0 prior to the beginning of record insertion will then be returned 

(altered or unaltered). If you are processing variable length records, H1 of register A0 

must contain the length of the record. 


Note: This exit is available for all types of data. 

4.3.6. User Exit 14 or 21 

Purpose 

These exits have identical meanings to the SORT processor. They are activated each 

time a comparison is made between two records to see which is first in the sorting 

sequence. These exits let your routine compare two records to see which is first in the 

sorting sequence. 

Your routine must be consistent in that equal keys are always chosen in the same order. 

When you activate exit number 14 or 21, registers A0 and A1 contain the addresses of 

the first word of each record. 

7831 0687–010 4–5



If the record addressed by register A0 is first in the sorting sequence, use a J 0,X11 

instruction to return to the SORT processor. If the record addressed by register A1 is 

first in the sorting sequence, use a J 1,X11 instruction to return to the SORT processor. 

If the two records have equal keys, use a J 2,X11 instruction to return to the SORT 

processor. 

Notes: 

• This exit is available for all types of files. For more information, see 6.6. 

• This exit overrides the KEY and KEYW parameter; that is, no key translation occurs. 

4.3.7. User Exit 15 or 47 

Purpose 

These exits have identical meanings to the SORT processor. They are activated when an 

unrecoverable error occurs while reading from an input file. These exits let your routine 

process the error. 


No return to the SORT processor is expected. 

4.3.8. User Exit 31 or 41 

Purpose 

These exits have identical meanings to the SORT processor. They are activated 

immediately before each output label is written. These exit numbers let your routine 

write nonstandard header and trailer labels on an output file. 


word of the buffer area. 


On return, H1 of register A0 must contain one of the following values: 


End of file 


Octal 1 

Octal 2 

End of volume 



H2 of register A0 should still contain the buffer address upon returning to the SORT 

processor. 

4–6 7831 0687–010


Note: This exit is available for all files except symbiont. 

4.3.9. User Exit 32 or 42 

Purpose 



time equal records are found on the compare. These exits let your routine leave the 

records as they are, modify the records, or delete one of the records. If the only purpose 

of your routine is to delete duplicate records, then use the DELDUPS parameter (see 

3.3.16) instead. 

If your routine modifies the records, only non-key portions of the records can be altered. 

For fixed-length records, all nonkey portions of the entire record can be altered. For 

variable-length records, only the nonkey portions of the first link of each record can be 

altered. 

When exit number 32 or 42 is activated, registers A0 and A1 contain the addresses of 

the first word of each record. 


If your routine returns both records, the two record addresses in registers A0 and A1 

must still be intact and you must use a J 0,X11 instruction to return to the SORT 

processor. If your routine deletes one of the records, the record returned must be 

addressed by register A0 and you must use a J 1,X11 instruction to return to the SORT 

processor. 

Note: This exit is available for all file formats and recording modes. For more 

information, see 6.6. This exit overrides the DELDUPS parameter. 

4.3.10. User Exit 33 or 43 

Purpose 

These exits have identical meanings to the SORT processor. They are activated before 

each record is written. This exit lets your routine alter, add, or delete records. 

The following are specific record handling requirements for this user exit: 

• If the record is to be deleted, you must set register A0 to zero. 

• If a record is to be inserted, you must put the address of the new record in H2 of 

register A1 with H1 of register A1 set to any value other than 1 or 2. To terminate 

record insertion, you must set H1 of register A1 to 1. 

• If your routine writes out the record, you must set H1 of register A1 to 2. 

• If this is a variable-record sort, H1 of register A0 contains the record length in words. 

If variable-length records are inserted, you must set in H1 of register A0 to the word 

size of the record whose address is in register A1. The length of the record is 

always passed in words regardless of whether the processing is in words or bits. 

7831 0687–010 4–7



word of the record. 


On return, whether altered or unaltered, register A0 must contain the record address. 


4.3.11. User Exit 34 or 44 

Purpose 


time a physical block of data is ready to be written by the SORT processor. These exits 

let your routine alter or eliminate the entire block. 

When exit number 34 or 44 is activated, register A0 contains the beginning address of 

the block. 


On return, whether altered or unaltered, H2 of register A0 must contain the block 

address. However, if the block is altered, you must set in H1 of register A0 to the end 

address of the block. 

The block can be shortened, but can never be expanded in length. If you delete the 

block, you must set register A0 to zero. If your routine writes out the block, you must 

set H1 of register A1 to any nonzero value. 


Note: This exit is available only for ACOB and CFH files. 

4.4. SRTGEN 

SRTGEN is a Symbolic Stream Generator (SSG) skeleton provided in file 1 (CO$UTIL) of 

the Sort/Merge release tape. It facilitates the inclusion of user relocatables into a new 

Sort/Merge absolute. 

The only stream generation statement (SGS) recognized by SRTGEN is SRTMRG. The 

format of this SGS is as follows: 

Format 

SRTMRG NAME,a ELEMENT,b1,b2,... ENTRY,c1,c2,... 

4–8 7831 0687–010

Description 

where 

a 

is the name of the absolute element to be produced. 

b1,b2,... 

c1,c2,... 


indicate names of user relocatable elements to be included in the collection. 

indicate the entry point names of the user subroutines contained in bn. 

All entries on the SRTMRG SGS are optional with the exception of the NAME entry (the 

absolute element to be produced). 

The SORT relocatables, as well as the user relocatables, are assumed to be in a file with 

the name REL$. You must copy file 15 (REL$) of the release tape and user relocatables 

into the REL$ file. 

Example 

The following sample runstream shows the use of the SGS SRTMRG and a SORT 

processor call using user exit numbers: 

1. @SSG SRTGEN 

2. SGS 

3. SRTMRG NAME,SORT2 ELEMENT,011,01,012 ENTRY,OWN01,OWN11,OWN12 

4. @EOF 

5. @EOF 

6. @.SORT2 

7. RSZ=84 

8. BLOCK=5 

9. FILEIN=INFILE 

10. FILEOUT=OUTFILE 

11. KEYW=1,35,36,A,A 

12. OWN=1,OWN01:11,OWN11:12,OWN12 

13. @EOF 

Description of Coding Lines 

Line 1 

Line 2 

Line 3 

Call to the Symbolic Stream Generator (SSG) indicating the skeleton to be processed 

(SRTGEN). 

Indicates that stream generation statements (SGS) follow. 

The SGS SRTMRG, which indicates a SORT processor, is built with the absolute 

element name of SORT2. The user relocatable elements named 01, 011, and 012 

are included in the collection and the entry points OWN01, OWN11, OWN12 are 

contained in the included relocatable elements. 

7831 0687–010 4–9


Line 4 and 5 

Line 6 

Starts SSG processing. 

Calls the new SORT processor, which includes user exit numbers. 

Line 7–11 

Line 12 

Indicates the SORT processor parameters. 

Tells the SORT processor that a user routine is activated (The statement 1,OWN01 

indicates that exit number 1 is activated and that OWN01 will be called). 

4–10 7831 0687–010

Section 5 

The SORT Subroutine Parameter Tables 

for MASM Programs 

This section explains how to perform a sort or merge operation in a MASM program 

using the SORT subroutines. It explains how to generate a parameter table to define the 

sort or merge operation. 

5.1. Introduction 

When you give control to the SORT subroutines by specifying the appropriate linkages 

within your source program as described in Section 6, you must provide the following: 

• The records to sort 

• The operations to perform 

• The system facilities to use 

• Key definitions 

You do this by generating a parameter table. A parameter table is made up of a number 

of parameter entries that contain table entry codes that specify such items as the record 

size, key definitions, the operation to perform, and the facilities to use. 

Table 5–1 lists the parameter types, the generation methods, and indicates the 

subsection where you can find more information about them. 

Table 5–1. MASM Parameter Table Generation Methods 

Parameter Generation 

Method 

Description 

Reference 

R$FILE assembly-time Use with the R$FILE table generation procedure. 5.2 

Coding parameter entries as 

constants 

Bypass automatic parameter table generation. 5.3 

Execution-time Use with R$FILE parameters or with any cards 

punched by the IPURI$ linkage (see 6.3.1). 

7831 0687–010 5–1 

5.4

The SORT Subroutine Parameter Tables for MASM Programs 

The following subsections describe and define the particular SORT subroutines 

parameter types. 

5.2. R$FILE Assembly-Time Parameters 

The R$FILE procedure is a predefined MASM procedure that is provided with the 

Sort/Merge product. To use the R$FILE procedure to generate a parameter table, you 

must first make it available to your MASM program (see 6.1) by entering a call that 

activates the R$FILE procedure. 

Format 

R$FILE 'parameter-1' 'parameter-2' ... 'parameter-n' 

where parameter-1, parameter-2, ... parameter-n are the R$FILE parameters that 

correspond to the operation you want to perform (see Table 5–2). Note that R$FILE 

parameters are always in single quotation marks. 

You do not need to specify a start table or end table entry. Both of these entries are 

generated automatically by the R$FILE procedure. 

You specify the R$FILE assembly-time parameters when you use the R$FILE procedure 

described in 5.1. These parameters are generated when your program is assembled. 

Table 5–2 lists the R$FILE assembly-time parameters. 

Table 5–2. R$FILE Assembly-Time Parameters 

Parameter Code Description Subsection 

BIAS 06 Informs the SORT subroutines how many 

ordered sequences already exist in the input 

data set. 

CHECK 060 Forces the elimination of the checksum 

operations normally done by the SORT 

subroutines module you specify. 

CHECKD 066 Sets the mesh count for checksum operations 

in the one-level mass storage module (M1). 

CHECKF 066 Sets the mesh count for checksum operations 

in the two-level mass storage module (M1– 

M2). 

CHECKK 066 Sets the mesh count for checksum calculations 

in the basic mode disk module. 

CHECKT 066 Sets the mesh count for checksum calculations 

in the tape module. 

COMP 041, 077 Tells the SORT subroutines to execute a user 

routine each time two records are compared. 

CONSOLE 063 Tells the SORT subroutines to issue all 

operator console messages during a sort run. 

5–2 7831 0687–010 

5.2.1 

5.2.2 

5.2.3 

5.2.4 

5.2.5 

5.2.6 

5.2.7 

5.2.8




CONTA 036, 050, 

052 

Tells the SORT subroutines that an interrupted 

PARTA sort is continued. 

CONTB 037, 053 Tells the SORT subroutines that an interrupted 

PARTB sort is continued. 

CONTC 047, 054 Tells the SORT subroutines that an interrupted 

PARTC sort is continued. 

COPY 070, 077 Allows parameters to be accepted from more 

than one parameter table. 

CORE 020, 077 Specifies the amount of memory and the type 

of memory (basic mode or extended mode) to 

be used for the sort. 

DEFYEAR 026 Indicates the first year of a 100-year interval 

used to order DATE key fields. 

DELCON 063 Tells the SORT subroutines to delete all 

operator console messages during a sort run. 

DELLOG 065 Omits the normal sort completion messages 

from the run log. 

DROC 040, 077 Tells the SORT subroutines to execute a user 

routine each time it is determined that two 

records have equal keys. 

ERROR 045, 077 Tells the SORT subroutines where to transfer 

control if an error occurs in the SORT 

subroutines. 

FILES 023, 077 Lists the names of the scratch files the SORT 

subroutines are to use during a sort operation. 

FINAL 044, 077 Tells the SORT subroutines where to transfer 

control after completion of a PARTA or PARTB 

sort. 

FPOC 042, 077 Tells the SORT subroutines the address to 

return to after the sort is initialized. 

KEY 03, 077 Specifies a key field for the sort or merge 

operation. 

KEYW 03, 077 Specifies a key field for a sort or merge 

operation. 

LOCALE 025, 077 Tells the SORT subroutines the desired locale 

for I keys for the sort or merge operation. 

LOG 065 Tells the SORT subroutines to issue normal 

sort completion messages to the run log. 

LPOC 043, 077 Tells the SORT subroutines the address to 

return to when the subroutines return sorted 

records to your program. 

7831 0687–010 5–3 

5.2.9 

5.2.10 

5.2.11 

5.2.12 

5.2.13 

5.2.14 

5.2.15 

5.2.16 

5.2.17 

5.2.18 

5.2.19 

5.2.20 

5.2.21 

5.2.22 

5.2.23 

5.2.24 

5.2.25 

5.2.26




NODISK 016 Tells the SORT subroutines that the disk 

module is not collected into your program. 

NOMASS 017 Tells the SORT subroutines that the M1 and 

the M1–M2 mass storage modules are not 

collected into your program. 

NOTAPE 016 Tells the SORT subroutines that the tape 

module is not collected into your program. 

OPTION 067 Tells the SORT subroutines general information 

to perform specific actions. 

PAD 072 Saves space in the parameter table for 

additional information. 

PARTA 031, 010, 

011, 012, 

013 

PARTB 032, 012, 

014, 015 

Tells the SORT subroutines to perform the 

distribution phase of a nonautomatic tape sort. 

Tells the SORT subroutines to perform the 

intermediate merge phase of a nonautomatic 

tape sort. 

PARTC 033, 014 Tells the SORT subroutines to perform the final 

merge phase of a nonautomatic tape sort. 

PRESERVE 05 Determines the output order of records that 

have equal keys. 

RECAREA 046, 077 Tells the SORT subroutines, when executing 

an extended mode sort, where to put the 

record so that it is visible to a basic mode user 

routine. 

REDOA 034, 050, 

051, 052 

5.2.27 

5.2.28 

5.2.29 

5.2.30 

5.2.31 

5.2.32 

5.2.33 

5.2.34 

5.2.35 

5.2.36 

Recreates a portion of a PARTA sort. 5.2.37 

REDOB 035, 053 Recreates a portion of a PARTB sort. 5.2.38 

RSZ 01 Specifies the size of fixed-length records in 

terms of 6-bit characters. 

RSZA 01 Specifies the size of fixed-length records in 

terms of 9-bit characters. 

RSZB 01 Specifies the size of fixed-length records in 

terms of bits. 

RSZW 01 Specifies the size of fixed-length records in 

terms of words. 

SEQ 04, 077 Generates an alternate Fieldata collating 

sequence for type A key fields. 

SEQA 07, 077 Generates a 128-character collating table for 

type S key fields. 

5.2.39 

5.2.40 

5.2.41 

5.2.42 

5.2.43 

5.2.44 

5–4 7831 0687–010




SEQB 07, 077 Generates a 128-character collating table for 


SEQC 024, 077 Generates a 256-character collating table for 


SEQD 024, 077 Generates a 256-character collating table for 


SEQE 024, 077 Generates a 256-character collating table with 

the EBCDIC collating sequence for type S key 

fields 

SEQF 04, 077 Generates a Fieldata collating table for type A 

key fields. 

SEQK 024, 077 Generates a 256-character collating table in the 

same manner as the SEQD parameter except 

that the katakana character sequence is 

included before the special characters. 

SMRG 030, 010, 

011, 012 

Tells the SORT subroutines to perform an 

automatic tape sort. 

VOL 064 Tells the SORT subroutines approximately how 

many records in thousands are to be sorted. 

VRSZ 01, 02 Specifies the maximum size of variable-length 

records and the minimum link size of the input 

record set in terms of 6-bit characters. 

VRSZA 01, 02 Specifies the maximum size of variable-length 


record set in terms of 9-bit characters. 

VRSZB 01,02 Specifies the maximum size of variable-length 


record set in terms of bits. 

VRSZW 01, 02 Specifies the maximum size of variable-length 


record set in terms of words. 

5.2.45 

5.2.46 

5.2.47 

5.2.48 

5.2.49 

5.2.50 

5.2.51 

5.2.52 

5.2.53 

5.2.54 

5.2.55 

5.2.56 

7831 0687–010 5–5


The following subsections describe each of these parameters in detail. Default values in 

command formats are in bold text. 

5.2.1. BIAS Parameter 

Function 

Informs the SORT subroutines how many ordered sequences already exist in the input 

data set. 

Format 

'BIAS', bias-factor 

where bias-factor must be the actual bias of the data multiplied by 10. You cannot 

specify a decimal point. 

Generated Entry 

060000bbbbbb 

where bbbbbb is the 18-bit octal bias of the data multiplied by 10. 

5.2.2. CHECK Parameter 

Function 

Forces the elimination of the checksum operations for the sort modules you specify. 

Normally, the SORT subroutines perform checksum operations. 

Format 

'CHECK', 'mod-1' [,'mod-2'] [,'mod-3'] [,'mod-4'] 

where mod-1, mod-2, mod-3, and mod-4 can be any of the following values: 

D 

F 

K 

T 

omits the M1 module checksum. 

omits the M2 module checksum. 

omits the basic mode disk module checksums. 

omits tape module checksum operations. 

The CHECK parameter has no meaning when an extended mode sort is being 

performed. 

5–6 7831 0687–010


60ddttffkk00 

where 

dd 

tt 

ff 

kk 


is the checksum value in effect for an M1 sort. If dd is 011, checksums are not 

performed. Any other value allows checksums to be performed for the M1 module. 

is the checksum value in effect for a tape sort. If tt is 031, checksums are not 

performed. Any other value allows checksums to be performed for the tape module. 

is the checksum value in effect for an M2 sort. If ff is 013, checksums are not 

performed. Any other value allows checksums to be performed for the M2 module. 

is the checksum value in effect for basic mode disk module specifications. If kk is 

020, checksums are not performed. Any other value allows checksums to be 

performed for the basic mode disk module. 

5.2.3. CHECKD Parameter 

Function 

Sets the mesh count for checksum operations in the one-level mass storage (M1) 

module. 

Format 

'CHECKD', mesh-count 

where mesh-count is an integer that specifies the mesh or interval at which checksum 

operations are computed. The default mesh count is 1, which means that every word in 

a block is summed before being written and after being read. By setting a larger mesh 

count, you can save time during the sort by doing fewer checksum operations. If the 

mesh count is set to 0, checksum calculations are disabled. 

The CHECKD parameter has no meaning when an extended mode sort is being 

performed. 


660001mmmmmm 

where mmmmmm is the 18-bit octal mesh count used in checksum calculations. 

7831 0687–010 5–7


5.2.4. CHECKF Parameter 

Function 

Sets the mesh count for checksum operations in the two-level mass storage (M2) 

module. 

Format 

'CHECKF', mesh-count 






The CHECKF parameter has no meaning when an extended mode sort is being 

performed. 


660002mmmmmm 


5.2.5. CHECKK Parameter 

Function 

Sets the mesh count for checksum calculations in the disk module. 

Format 

'CHECKK', mesh-count 






The CHECKK parameter has no meaning when an extended mode sort is being 

performed. 


660004mmmmmm 


5–8 7831 0687–010

5.2.6. CHECKT Parameter 

Function 


Sets the mesh count for checksum calculations in the tape module. 

Format 

'CHECKT', mesh-count 






The CHECKT parameter has no meaning when an extended mode sort is being 

performed. 


660003mmmmmm 


5.2.7. COMP Parameter 

Function 

Tells the SORT subroutines to execute a user routine each time two records are 

compared. See 6.6.1 for more information about user compare routines. The COMP 

parameter causes KEY or KEYW parameters to be ignored. 

Format 

'COMP', [*]comp-routine-address 

where 

* 

is an asterisk that must be coded if the COMP routine resides in a common bank or 

is called by the SORT subroutines common bank. The asterisk generates a 

BDICALL$ Collector directive rather than the normal BDIREF$ directive. 

comp-routine-address 

is the address of the user routine that is executed. 

7831 0687–010 5–9


Generated Entries 

410000aaaaaa 

770000bbbbbb 

where 

aaaaaa 

bbbbbb 

is the 18-bit octal address of the user compare routine. 

is the 18-bit octal bank descriptor index (BDI) of the bank containing the COMP 

routine. 


Function 

Tells the SORT subroutines to issue all operator console messages during the sort run. 

This parameter is the opposite of the DELCON parameter and overrides the CONSOLE 

configuration parameter (see 9.4). 

Format 

'CONSOLE' 


630000000001 

5.2.9. CONTA Parameter 

Function 

Tells the SORT subroutines that an interrupted PARTA sort is continued (see 5.2.32). 

Format 

'CONTA', cycle-number, start-record 

where 

cycle-number 

is the cycle number of the next PARTA tape created. 

start-record 

is the number of the record at which the continuation begins. This number should 

be one more than the last record number on the last PARTA tape created. 

All of the input data must be available to the SORT subroutines. The cycle number and 

the start record appear in console messages during a PARTA sort and are also listed in 

the system log file (see 12.3). 

5–10 7831 0687–010


360000000000 

520000000ccc 

50ssssssssss 

where 

ccc 


is the 9-bit octal cycle number of the PARTA output. 

ssssssssss 

is the 30-bit octal start record number. 

5.2.10. CONTB Parameter 

Function 

Tells the SORT subroutines that an interrupted PARTB sort is continued (see 5.2.33). 

Format 

'CONTB', 'tape-label', reel-number 

where 

tape-label 

is the tape label assigned to the first tape created after restart. 

reel-number 

is the reel number of that tape. The values for the tape-label and reel-number fields 

appear in console messages during a PARTB sort and are also listed in the system 

log file (see 12.3). 


370000000000 

530000aaaaaa 

where aaaaaa is the 18-bit octal address of the 2-word packet that contains the tape label 

and reel number of the first tape created after restart. 

The structure of the 2-word packet is the following: 

word-1 llllllllllll (See tape-label) 

word-2 00000000rrrr (See reel-number) 

7831 0687–010 5–11


5.2.11. CONTC Parameter 

Function 

Tells the SORT subroutines that an interrupted PARTC sort is continued (see 5.2.34). 

Format 

'CONTC', tape-repositioning-table 

where tape-repositioning-table is the address of the table where all the necessary 

PARTC continuation information is located (see 5.2.34). This information is available 

throughout a PARTC operation through the SORT subroutines entry points. It is also 

listed in the system log file (see 12.3). 


470000000000 

540000aaaaaa 

where aaaaaa is the 18-bit octal address of the PARTC tape repositioning table. 


Function 

Allows parameters to be accepted from more than one parameter table. 

Format 

'COPY', copy-address 

where copy-address must be the address of another parameter table that is to be 

scanned. 

You can nest the COPY parameters within several parameter tables. You can also use 

COPY to add a standard set of several sort parameters to your own sort or merge 

programs. 


700000aaaaaa 

770000bbbbbb 

where 

aaaaaa 

is the 18-bit octal address of a parameter table that is searched before completing 

the search of the current parameter table. 

bbbbbb 

is the 18-bit octal bank descriptor index in L,BDI format of the bank containing the 

copy address. This entry is optional. If it is specified, it is used only in an extended 

mode sort or an extended mode merge. 

5–12 7831 0687–010


Function 


Specifies the amount and location of the memory for the sort and specifies the type of 

memory area to be used in a basic mode or extended mode sort. 

For a merge operation, the memory associated with the COMP parameter is only used if 

a CORE parameter is also specified. In this case, the memory must be a basic mode 

memory area with a size greater than the largest record size. 

Format 

'CORE', number-of-words [ ,core-address ] 

where 

number-of-words 

must be the number of words of memory that the sort can use. You must make 

sure that the memory area is at least as large as this value. 

core-address 

is the address of the memory area to be used. If you specify this optional value, the 

SORT subroutines will not generate a memory area. If you omit this value, the SORT 

subroutines 

− Automatically generate the memory area immediately following the parameter 

table if the number-of-words value is less than or equal to 210,000. 

− Allocate an extended mode memory area when the number-of-words value is 

greater than 210,000. 

A 20 entry with one 77 table entry indicates a basic mode memory area. A 20 entry with 

no 77 entries or two 77 table entries indicates an extended mode memory area. 

Generated Entries for Basic Mode 

20wwwwwwwwww 

770000aaaaaa 

where: 

wwwwwwwwww 

aaaaaa 

is the 30-bit octal number of words of memory. 

is the 18-bit octal address where the memory begins. 

The minimum number of words allowed for the CORE parameter is 2000; the maximum 

number is 262143. 

Note: The minimum size of 2000 is an absolute minimum; for some sorts, the 

minimum will be greater. 

7831 0687–010 5–13


Generated Entries for Extended Mode 

20wwwwwwwwww 

770000aaaaaa 

770000bbbbbb 

where 

wwwwwwwwww 

aaaaaa 

bbbbbb 

is the 30-bit octal number of words of memory. 

is the 18-bit octal address where the memory begins. 

is the 18-bit octal L,BDI of the bank containing the beginning of the memory. 

The 77 continuation entries are optional. However, one cannot be specified without the 

other. 

No 77 continuation entries direct the SORT subroutines to allocate the storage used for 

the memory area. The number of words actually allocated falls within the range defined 

by the MINIMUM and MAXIMUM configuration parameters (see 9.12 and 9.13). 

Specifying the 77 continuation entries indicates to the SORT subroutines that you 

allocated the memory area. The number of words allocated must be greater than 

210,000. 

5.2.14. DEFYEAR Parameter 

Function 

This parameter tells the SORT subroutines which year is the first year of a 100-year 

interval to use when ordering a DATE key field. See 5.2.22 or 5.2.23 (the KEY or KEYW 

parameters). 

Format 

'DEFYEAR', defyear-value 

where defyear-value is an integer in the range 0 to 99 to specify the first year of a 100year 

interval that Sort/Merge uses to order a DATE key field. 


260000000ddd 

where ddd is the 9-bit octal value representing a year. 

A defyear-value of zero causes a DATE key field to be ordered from 0 to 99. A nonzero 

defyear-value causes a DATE key field to be ordered from defyear-value, defyearvalue+1, 

defyear-value+2, ... , 99, 00, ... , defyear-value–1. If no DEFYEAR parameter is 

specified, a default defyear-value of 28 is used when a DATE key field is ordered. 

5–14 7831 0687–010

5.2.15. DELCON Parameter 

Function 


Tells the SORT subroutines to delete all operator console messages during the sort run. 

The SORT subroutines still print error termination messages on the operator console. 

This parameter is the opposite of the CONSOLE parameter and overrides the CONSOLE 


Format 

'DELCON' 


630000000000 

5.2.16. DELLOG Parameter 

Function 

Omits the normal sort completion messages from the run log. This parameter is the 

opposite of the LOG parameter and overrides the LOG configuration parameter (see 

9.11). 

Format 

'DELLOG' 


650000000000 

5.2.17. DROC Parameter 

Function 

Tells the SORT subroutines to execute a user routine, called a data reduction own code 

(DROC) routine, each time two records have equal keys. The DROC parameter overrides 

the OPTION parameter’s delete duplicate records field (bit 32). (See 6.6.2 for more 

information about user data reduction routines.) This parameter cannot be used with an 

international sort and is ignored for merge operations. 

Format 

'DROC', [*]droc-routine-address 

where 

* 

is an asterisk that must be coded if the DROC routine resides in a common bank or 

is called by the SORT subroutine common bank. The asterisk generates a BDICALL$ 

Collector directive rather than the normal BDIREF$ directive. 

7831 0687–010 5–15


droc-routine-address 

is the address of the user routine to be executed. 


400000aaaaaa 

770000bbbbbb 

where 

aaaaaa 

bbbbbb 

is the 18-bit octal address of the data reduction own code (DROC) routine. 

is the 18-bit octal bank descriptor index (BDI) of the bank containing the DROC 

routine. 

5.2.18. ERROR Parameter 

Function 

Tells the SORT subroutines where to transfer control if an error occurs in the SORT 

subroutines. 

Format 

'ERROR', [*]error-routine-address 

where 

* 

is an asterisk that must be coded if the ERROR routine resides in a common bank or 



error-routine-address 

is the address where control transfers when an error occurs. 

Once control is transferred to the error-routine-address, SORT or MERGE cannot be 

reentered unless you specify one of the following entry points: 

• ROPN$ 

• ROPN$X 

• ROPN$CB 

• RMGOPN$ 

• RMGOPN$X 

• RMGOPN$CB 

5–16 7831 0687–010


450000aaaaaa 

770000bbbbbb 

where 

aaaaaa 

bbbbbb 


is the 18-bit octal address where control is transferred when an error occurs. 

is the 18-bit octal BDI of the bank containing the ERROR routine. 

On return to the ERROR routine, H1 of register A0 contains either a zero or an error 

packet address, while H2 of register A0 contains the sort error code (see A.2) as two 

Fieldata characters, right-justified and zero-filled. 

The format of register A0 is as follows. 

Zero or address of error packet Fieldata error code (RJZF) 

H2 of the first word in the error packet will always contain an error identifier. If the error 

identifier is a 1, then a D5, an F5, or an X4 error has occurred and the error packet is 

defined as follows. 

where 

error address error identifier 

Internal file name characters 1-6 

Internal file name characters 7-12 

status function error type Reserved Reserved Reserved 

error address 

Reserved I/O packet address 

is the address within the sort where the error occurred. 

error identifier 

status 

is the identifier for the error packet. 

is the I/O error status. 

function 

is the I/O error function code. 

7831 0687–010 5–17


error type 

the error mode type. 

I/O packet address 

is the address of the scratch file I/O packet receiving the I/O error. 

Initialization errors C2, C3, C7, L6, and L7 are not returned to the ERROR routine. 

Register X11 is destroyed when control is transferred to the ERROR routine. All other 

registers are saved and restored. 

5.2.19. FILES Parameter 

Function 

Lists the names of the scratch files to be used by the SORT subroutines during a sort 

operation. 

Format 

'FILES', 'file-name-1', 'file-name-2', ... , 'file-name-26' 

where file-name-1, file-name-2, ..., file-name-26 are the internal names of files to be used 

as scratch files by the SORT subroutines during the sort operation. These names can be 

from 1 to 12 characters long with no qualifiers. The SORT subroutines will not assign 

these files so they must be assigned to the run before initiating the sort operation. Any 

file specified in the list that is not assigned to the run will be ignored and the SORT 

subroutines will only use those scratch files actually assigned to the run. The order of 

the names of the files appearing in the list is immaterial. The FILES parameter is ignored 

for merge operations. 


230000aaaaaa 

770000bbbbbb 

where 

aaaaaa 

is the 18-bit octal address of the 2-word Fieldata left-justified, space-filled internal file 

name. A 23 entry is built for each file name you specify. If you do not use R$FILE, 

you must build a table of internal file names. 

bbbbbb 


address of the internal file name. This entry is optional. If it is specified, it is used 

only for an extended mode sort. 

5–18 7831 0687–010


Note: The SORT subroutines provide a predefined parameter table with the names of 

the files XA through XZ. If you want to use some or all of these files as the scratch files, 

then you may be able to use this predefined parameter table. To use the predefined 

parameter table to define the files XA through XZ as scratch, insert the following 

parameter in your R$FILE procedure call: 

'COPY' ,RSTD$ 

5.2.20. FINAL Parameter 

Function 

Tells the SORT subroutines where to transfer control after completion of a PARTA or 

PARTB sort. 

Format 

'FINAL', [*] final-routine-address 

where 

* 

is an asterisk that must be coded if the FINAL routine resides in a common bank or 



final-routine-address 

is the address where control is returned after completing a PARTA or PARTB sort. 


440000aaaaaa 

770000bbbbbb 

where 

aaaaaa 

is the 18-bit octal address where control is transferred after completion of a PARTA 

or a PARTB sort. If you do not specify this entry, the SORT subroutines terminates 

program execution through ER EXIT$. 

bbbbbb 

is the 18-bit octal BDI of the bank containing the FINAL routine. 

5.2.21. FPOC Parameter 

Function 

Tells the SORT subroutines the address to return to after the sort is initialized. 

Format 

'FPOC', [*]fpoc-routine-address 

7831 0687–010 5–19


where 

* 

is an asterisk that must be coded if the FPOC routine resides in a common bank or is 

called by the SORT subroutines common bank. The asterisk generates a BDICALL$ 


fpoc-routine-address 

is the address where the user program supplies records to the SORT subroutines 

after initialization. 


420000aaaaaa 

770000bbbbbb 

where 

aaaaaa 

bbbbbb 

is the 18-bit octal address where control is transferred after sort initialization. 

is the 18-bit octal BDI of the bank containing the FPOC routine. 


Function 

Specifies a key field used for the sort or merge operation. The KEY parameter has no 

effect if the COMP parameter is specified. 



KEY parameter is used to define key fields based on a start character within the record 

and a character length. Whereas, the KEYW parameter defines key fields based on a 

start word and bit within the record and a bit length. 

Format 

'KEY', char-pos, number-of-char, 'type[(subtype)]' [,['order'] [,field-number]] 

where 

char-pos 

is an integer specifying the starting character of the key stated in either 6-bit or 9-bit 

characters. For key types A, B, D, G, L, M, P, or U, the field is in 6-bit characters. 

For key types DATE, I, J, Q, R, S, T, or V, the field is in 9-bit characters. The first 

character position of a record is number one (1). 

5–20 7831 0687–010

number-of-char 

type 


specifies the length of the key in 6-bit byte characters (for example, Fieldata 

characters) or 9-bit byte characters (for example, ASCII characters), depending on the 

type of the key. If a DATE key type is specified, the length of the key field must be 

at least 2. 

specifies the key type using the following values (see Section 11 for complete 

explanations): 

A 

B 

D 

DATE 

G 

I 

J 

L 

M 

P 

Q 

R 








should be performed. The data is ordered according to the rules of the locale. 







7831 0687–010 5–21


S 

T 

U 

V 

subtype 

order 








IGNORETSP 



INCLUDETSP 




is an optional field. If you specify order, you must assign one of the following values: 

A 

D 

field-number 

specifies an ascending sort or merge on this key field. This is the default value. 

specifies a descending sort or merge on this key field. 

is an integer between 1 and 64 that indicates the significance of the key field: 1 is 

the most significant or major key field; 64 is the least significant field. 

If you specify field-number for any key field, you must specify it for all the key fields. 

If you do not specify field-number, the first key field defined is the major key and any 

subsequent key fields are the minor keys. 


Format 1 

03ttoobbffff 

77wwwwnnnnnn 

5–22 7831 0687–010

Format 2 

03ttoobbffff 

7700ssnnnnnn 

770000wwwwww 

where 

tt 

oo 

bb 

ffff 


is the 6-bit octal representation of the Fieldata character used in the type field. For 

the DATE key type, the type field will be an octal 40 (040). 

is the 6-bit octal representation of the Fieldata character used for the order field. 

is a 6-bit octal representation of the most significant bit within the starting word of 

the key field. The most significant bit position within a word is 1, the least significant 

is 36. 

is the 12-bit octal representation of the field-number. It is 0000 if no field-number is 

specified. 

wwww or wwwwww 

ss 

is the 12-bit (Format 1) or 18-bit (Format 2) octal representation of the starting word 

of the key. The first word of the record is number 0. The SORT subroutines 

determine the format of the KEY parameter based on the specification of the second 

continuation (77) entry and thus the location of the key starting word field. 

is the 6-bit octal representation of the subtype field. 0 represents a subtype field of 

INCLUDETSP and 1 represents a subtype field of IGNORETSP. This field is only 

valid for Format 2 of the KEY parameter. 

nnnnnn 

is the 18-bit octal representation for the number of bits in the key field. 

The format of the KEY parameter is based on the specification of the second 

continuation (77) entry. 

Note: Key fields can overlap. If they do, you must observe the guidelines for key types 

contained in Table 5–3. 

7831 0687–010 5–23


If your major key type is ... 

Table 5–3. Key Types 

Then the overlapping minor key types 

can be only ... 

A, D, G, L, or P A* or U 

B, J, M, or U U 

I B, I, Q, R, S, T, U, or V 

DATE, Q, R, S, T, or V S** or U 

* The overlapping key type can be A only if an alternate Fieldata collating sequence is not 

specified. 

** The overlapping key type can be S only if a 128-character or 256-character collating 

sequence is not specified. 

5.2.23. KEYW Parameter 

Function 

Specifies a key field for a sort or merge operation. The KEYW parameter has no effect if 

the COMP parameter is also specified. 



KEYW parameter defines key fields based on a start word and bit within the record and a 

bit length. Whereas, the KEY parameter is used to define key fields based on a start 

character within the record and a character length. 

Format 

'KEYW',word-pos, bit-pos, number-of-bits, 'type[(subtype)]' [,['order'] [,field-number]] 

where 

word-pos 

bit-pos 

must be the starting word number of the key field. The first word within a record is 

number 1. 

indicates the most significant bit of the key field within the first word of the key. The 

most significant bit position is number 35, the least significant is number 0. 

number-of-bits 

specifies how many bits are in the key field. If a DATE key type is specified, the 

length of the key field must be at least 18. 

5–24 7831 0687–010

type 


specifies the key type using the following values (see Section 11 for complete 

explanations): 

A 

B 

D 

DATE 

G 

I 

J 

L 

M 

P 

Q 

R 

S 

T 








should be performed. The data is ordered according to the rules of the locale. 









7831 0687–010 5–25


U 

V 

subtype 

order 






IGNORETSP 



INCLUDETSP 




is an optional field. If you specify order, you must assign one of the following values: 

A 

D 

field-number 

specifies an ascending sort or merge on this key field. This is the default value. 

specifies a descending sort or merge on this key field. 

is an integer between 1 and 64 that indicates the significance of the key field: 1 is 

the most significant or major key field; 64 is the least significant field. 

If you specify field-number for any key field, you must specify it for all the key fields 

you specified. If you do not specify field-number, the first key field defined is the 

major key and any subsequent key fields that are defined are the minor keys. 


Format 1 

03ttoobbffff 

77wwwwnnnnnn 

Format 2 

03ttoobbffff 

7700ssnnnnnn 

770000wwwwww 

where 

5–26 7831 0687–010

tt 

oo 

bb 

ffff 


is the 6-bit octal representation of the Fieldata character used in the type field. For 

the DATE key type, the type field will be an octal 40 (040). 

is the 6-bit octal representation of the Fieldata character used for the order field. 

is a 6-bit octal representation of the most significant bit within the starting word of 

the key field. The most significant bit position within a word is 1, the least significant 

is 36. 

is the 12-bit octal representation of the field-number. It is 0000 if no field-number is 

specified. 

wwww or wwwwww 

ss 

is the 12-bit (Format 1) or 18-bit (Format 2) octal representation of the starting word 

of the key. The first word of the record is number 0. The SORT subroutines 

determine the format of the KEYW parameter based on the specification of the 

second continuation (77) entry and thus the location of the key starting word field. 

is the 6-bit octal representation of the subtype field. 0 represents a subtype field of 

INCLUDETSP, and 1 represents a subtype field of IGNORETSP. This field is only 

valid for Format 2 of the KEYW parameter. 

nnnnnn 

is the 18-bit octal representation for the number of bits in the key field. 

The format of the KEYW parameter is based on the specification of the second 

continuation (77) entry. 

Note: Key fields can overlap. If they do, you must observe the guidelines for key types 

contained in Table 5–3. 


Function 

Specifies the desired locale for the sort or merge operation. Only one LOCALE 

parameter should be specified. If an international sort or merge is requested (presence 

of an I key) and a LOCALE parameter is not specified, the locale currently in force is used 

for the sort or merge operation. 

Format 

'LOCALE', 'locale-name' 

where locale-name is a string that indicates the desired locale for the sort or merge 

operation. The locale name can be 1 to 16 characters in length. 

7831 0687–010 5–27



25nn00aaaaaa 

770000bbbbbb 

where 

nn 

aaaaaa 

bbbbbb 

is the number of 9-bit characters in the locale name. 

is the 18-bit octal address of the locale name. 


address of the locale name. 


Function 

Tells the SORT subroutines to issue normal sort completion messages to the run log. 

This parameter is the opposite of the DELLOG parameter and overrides the LOG 


Format 

'LOG' 


650000000001 

5.2.26. LPOC Parameter 

Function 

Tells the SORT subroutines the address to return to when it is ready to return sorted 

records to the user program. 

Format 

'LPOC', [*]lpoc-routine-address 

where 

* 

is an asterisk that must be coded if the LPOC routine resides in a common bank or is 

called by the SORT subroutines common bank. The asterisk generates a BDICALL$ 


lpoc-routine-address 

is the address returned after sorting. 

5–28 7831 0687–010


430000aaaaaa 

770000bbbbbb 

where 

aaaaaa 


is the 18-bit octal address where the SORT subroutines return when they are ready 

to transfer sorted records back to the user program. 

bbbbbb 

is the 18-bit octal BDI of the bank containing the LPOC routine. 

5.2.27. NODISK Parameter 

Function 

Tells the SORT subroutines that the disk module is not collected into your program. 

Format 

'NODISK' 


160100000000 

5.2.28. NOMASS Parameter 

Function 

Tells the SORT subroutines that the M1 module and the M1–M2 mass storage modules 

are not collected into your program. 

Format 

'NOMASS' 


170000000000 

5.2.29. NOTAPE Parameter 

Function 

Tells the SORT subroutines that the tape module is not collected into your program. 

Format 

'NOTAPE' 


160000000000 

7831 0687–010 5–29


5.2.30. OPTION Parameter 

Function 

Tells the SORT subroutines what extra information to use during a sort operation. 

You can specify multiple OPTION parameters. You must specify an option field in one of 

the parameters to be invoked. If you specify the same option field in multiple OPTION 

parameters, it is redundant and has the effect of invoking the option field’s functionality. 

Format 

'OPTION','option-field-1' [,'option-field-2'] ... 

where option-field-n specifies the extra information being passed to the SORT 

subroutines using the following values: 

NO-P-OPTION 

indicates that the SORT XQT P option should be suppressed when it is used at 

execution time. This permits the use of @XQT,P for other purposes (for example, 

TIP). (See 5.4.) 

DELETE-DUPS 

indicates that duplicate records are to be deleted from the sort. 

6BIT-LENGTH 

Indicates that 6-bit length records are passed. 

9BIT-LENGTH 

Indicates that 9-bit length records are passed. 

BIT-LENGTH 

Indicates that bitlength records are passed. 


67bbbbbbbbbb 

where bbbbbbbbbb is a 30-bit field where each bit is an indicator to Sort/Merge. The 

leftmost or most significant bit number is 6 and the least significant bit number is 35. 

Each bit is reserved and has the following purpose: 

bits 6–29 

are reserved for future use. These bits should be zero. 

5–30 7831 0687–010

its 30-31 

bit 32 

bit 33 

bit 34 

bit 35 

5.2.31. PAD Parameter 

Function 


is a two-bit field used to indicate how records are processed. 

Bit 30 Bit 31 Description 

0 0 Word length records are passed 

0 1 ‘6BIT-LENGTH’ records are passed. 

1 0 ‘9BIT-LENGTH’ records are passed. 

1 1 ‘BIT-LENGTH’ records are passed. 

indicates that DELETE–DUPS is specified. 

indicates that the SORT subroutines were called by the Relational Database 

Management System (RDMS). 

indicates that the SORT subroutines were called by the SORT processor. 

indicates that NO–P–OPTION is specified. 

Saves space in the parameter table for additional information. 

Format 

'PAD', number-of-words 

where number-of-words is the number of words you want to reserve for future 

information. You must place any added information in these locations before the sort is 

opened. 


720000000000 

A 72 entry is entered in the parameter table for each word you reserve. 

5.2.32. PARTA Parameter 

Function 

Tells the SORT subroutines to perform the distribution phase of a nonautomatic tape sort 

(see Section 12). At least one tape drive must be assigned to the run. 

7831 0687–010 5–31


Format 

'PARTA', 'output-label-prefix'[,recs-per-cycle, reels-per-cycle, block-size] 

where 

output-label-prefix 

is two characters long and contains the first two characters of each tape label 

created. 

recs-per-cycle 

is the maximum number of records to be sorted in any cycle. This field is optional 

and is used only when the value is less than the physical record volume limit that can 

be sorted with the total facilities assigned. 

reels-per-cycle 

is optional and specifies the maximum number of tape reels to be produced during 

any sort cycle. 

block-size 

is optional and specifies an integer that represents the maximum block size in words 

used on tape. The block size field is ignored if it is greater than 1000 words. 


310000000000 

12000000pppp 

where pppp is the 12-bit octal representation of the 2-character prefix for all tape labels 

created. 

If the optional fields are present, the following entries are also generated: 

10rrrrrrrrrr 

11tttttttttt 

13000000bbbb 

where 

rrrrrrrrrr 

tttttttttt 

bbbb 

the 30-bit octal maximum records per cycle. 

is the 30-bit octal maximum number of reels created per cycle. 

is the 12-bit octal maximum block size in words allowed on tape. 

5–32 7831 0687–010

5.2.33. PARTB Parameter 

Function 


Tells the SORT subroutines to perform the intermediate merge phase of a nonautomatic 

tape sort (see Section 12). At least three tape drives must be assigned to the run. 

Format 

'PARTB', 'output-label-prefix', 'output-file-name', 'input-file-name-1', 

'input-file-name-2' ,..., 'input-file-name-n' 

where 


is 2 characters long and contains the first 2 characters of each tape label created. 

output-file-name 

is used to assign the tape drive for output. It is from 1 to 12 characters with no 

qualifier specified. 

input-file-name-1, input-file-name-2, ..., input-file-name-n 

are the 6-character labels of the tapes created by a PARTA sort. 


320000000000 

12000000pppp 

150000oooooo 

140000iiiiii 

where 

pppp 

oooooo 

iiiiii 

is the 12-bit octal representation of the 2-character prefix for all labels created. 

is the 18-bit octal address of a 2-word packet that contains the external output file 

name. 

is the 18-bit octal address of a 1-word entry that contains an input tape label. A 14 

entry is generated for each input tape to the PARTB sort. 

7831 0687–010 5–33


5.2.34. PARTC Parameter 

Function 

Tells the SORT subroutines to perform the final merge phase of a nonautomatic tape 

sort (see Section 12). 

Format 

'PARTC', 'input-file-name-1',...,'input-file-name-n' 

where input-file-name-1, ..., input-file-name-n are the tape labels created by the last 

PARTB sort done on the input tapes. The same number of tape drives used in the last 

PARTB sort must be assigned for the PARTC operation. 


330000000000 

140000iiiiii 

where iiiiii is the 18-bit octal tape label of an input tape to the PARTC sort. Each input 

tape to a PARTC sort must have a 14 entry in the parameter table. 


Function 

Determines the output order of records that have equal keys. If you specify PRESERVE, 

the output order of records with equal keys is the same as the order in which they were 

input. If you perform a merge operation, the order of the records within one input file is 

always preserved and PRESERVE is ignored. If you specify PRESERVE and the 

DELETE–DUPS bit in the OPTION parameter is specified, the DELETE–DUPS option is 

ignored. 

Format 

'PRESERVE' 


050000000000 

5.2.36. RECAREA Parameter 

Function 

Tells the SORT subroutines where to put the records so that they will be visible to a 

basic mode user routine when executing an extended mode sort or an extended mode 

merge (in other words, a merge operation initiated by the MASM merge open commonbanked 

linkages (see 6.4.1). 

Format 

'RECAREA', [*]record-area-1,[*]record-area-2 

where 

5–34 7831 0687–010

* 


generates an LBDICALL$ Collector directive. If only one asterisk is specified on 

either record-area, the generated L,BDI is used for both record-areas. If an asterisk 

is specified for both record-areas, an L,BDI is generated separately for each recordarea. 

If an asterisk is not specified, the SORT subroutines determine the L,BDI for 

each record-area. 

record-area-1 and record-area-2 

are addresses where the records will be placed. These addresses cannot be the 

same and must be able to hold the largest record. 


460000aaaaaa 

770000bbbbbb 

770000cccccc 

770000dddddd 

where 

aaaaaa 

bbbbbb 

cccccc 

is the 18-bit octal address of the first record area. 

is the 18-bit octal address of the second record area. 

is the 18-bit octal L,BDI of the first record area. If the third 77 entry is not present, 

cccccc is also the L,BDI of the second record area. If the second 77 entry is not 

present, then the SORT subroutine determines the L,BDI of each record area by 

examining the banks based on base registers B12–B15. 

dddddd 

is the 18-bit octal L,BDI of the second record area if the third 77 entry is present. 

The second and third 77 entries are optional. 

5.2.37. REDOA Parameter 

Function 

Recreates a portion of a PARTA sort. 

Format 

'REDOA', cycle-number, start-record, end-record 

where 

cycle-number 

is an integer that specifies the output cycle number after restarting PARTA. 

7831 0687–010 5–35


start-record 

is an integer that specifies the record number at which the restart begins. 

end-record 

is an integer that specifies the record number at which the restart ends. The entire 

input volume must be accessible to the SORT subroutines to reexecute a portion of 

the PARTA output. 

The values for the cycle-number, start-record, and end-record fields appear in console 

messages during a PARTA sort, and are also listed in the system log file (see 12.3). 


340000000000 

520000000ccc 

50ssssssssss 

51eeeeeeeeee 

where 

ccc 

is the 9-bit octal cycle number of the PARTA output. 

ssssssssss 

is the 30-bit octal start record number. 

eeeeeeeeee 

is the 30-bit octal record of the last record re-created. 

5.2.38. REDOB Parameter 

Function 

Re-creates a portion of a PARTB sort. 

Format 

'REDOB', 'tape-label', reel-number 

where 

tape-label 

is the label assigned to the tape that contains rerun information for the tape that is 

re-created. After a PARTB tape is created, rerun information for that tape is written 

at the beginning of the next PARTB tape. 

reel-number 

is the actual reel number of the tape containing the rerun information needed to recreate 

the PARTB tape. The values for the tape-label and reel-number fields appear 

as console messages during a PARTB sort, and are also listed in the system log file 

(see 12.3). 

5–36 7831 0687–010


350000000000 

530000aaaaaa 


where aaaaaa is the 18-bit octal address of a 2-word packet containing the tape label and 

reel number of the tape that holds the rerun information. The 2-word packet has the 

following structure: 

word-1: llllllllllll (See tape-label) 

word-2: 00000000rrrr (See reel-number) 


Function 

Specifies the size of fixed-length records in terms of 6-bit characters. 

Format 

'RSZ', 6-bit-characters-per-record 

where 6-bit-characters-per-record is the fixed-length record size in terms of 6-bit 

characters. 


01ggnnnnnnnn 

where 

gg 

is a 6-bit field indicating the granularity of nnnnnnnn. This field is set to 01 for the 

RSZ specification to indicate 6-bit character granularity. 

nnnnnnnn 

is a 24-bit octal number of 6-bit characters per record. 

5.2.40. RSZA Parameter 

Function 

Specifies the size of fixed-length records in terms of 9-bit characters. 

Format 

'RSZA', 9-bit-characters-per-record 

where 9-bit-characters-per-record is the fixed-length record size in 9-bit characters. 


01ggnnnnnnnn 

where 

7831 0687–010 5–37


gg 


RSZA specification to indicate 9-bit character granularity. 

nnnnnnnn 

is a 24-bit octal number of 9-bit characters per record. 

5.2.41. RSZB Parameter 

Function 

Specifies the size of fixed-length records in terms of bits. 

Format 

'RSZB', bits-per-record 

where bits-per-record is the fixed-length record size as expressed in bits. 


01ggnnnnnnnn 

where 

gg 


RSZB specification to indicate bit granularity. 

nnnnnnnn 

is a 24-bit octal number of bits per record. 

5.2.42. RSZW Parameter 

Function 

Specifies the size of fixed-length records in terms of words. 

Format 

'RSZW', words-per-record 

where words-per-record is the fixed-length record size. 


01ggnnnnnnnn 

where 

gg 


RSZW specification to indicate word granularity. 

5–38 7831 0687–010

nnnnnnnn 


is a 24-bit octal number of words per record. 


Function 

Generates an alternate Fieldata collating sequence table for type A key fields (see 5.2.22 

and 5.2.23). 

The SEQ and SEQF parameters cannot be specified in the list of parameters for a sort or 

merge operation. The SEQ parameter can be specified with SEQA, SEQB, SEQC, 

SEQD, SEQE, or SEQK parameters. 

Format 

'SEQ', n1, n2, n3 [,'UPTO'], ni, nj [,'ALL'] 

where 


UPTO 

ALL 

are octal values that represent the new collating order for type A key fields. You can 







fields. 


040000aaaaaa 

770000bbbbbb 

where 

aaaaaa 

bbbbbb 

is the 18-bit octal address of the alternate Fieldata collating sequence. 

is the 18-bit octal bank descriptor index in the L,BDI format of the bank containing 

the address of the alternate Fieldata sequence. This entry is optional and is used for 

an extended mode sort only. 

7831 0687–010 5–39


If you do not use R$FILE to define your parameter table, your program must generate a 

64-word table that contains the type A key fields with the alternate collating sequence 

you want in the rightmost bit positions of each word. Only one character per word is 

allowed. 

5.2.44. SEQA Parameter 

Function 

Generates a 128-character collating sequence table used by type S key fields (see 5.2.22 

and 5.2.23). 

The SEQA parameter cannot be specified with the SEQB, SEQC, SEQD, SEQE, or SEQK 

parameters in the list of parameters for a sort or merge operation. The SEQA parameter 

can be specified with either the SEQ or SEQF parameter. 

Format 

'SEQA', n1, n2, n3 [,'UPTO'], ni, nj [,'ALL'] 

where 


UPTO 

ALL 








fields. 


070000aaaaaa 

770000bbbbbb 

where 

aaaaaa 

bbbbbb 

is the 18-bit octal address of the 128-character collating sequence table. 


the address of the collating sequence table. This entry is optional and is used for an 

extended mode sort only. 

5–40 7831 0687–010



128-word table that contains the type S key fields with the alternate collating sequence 


allowed. 

5.2.45. SEQB Parameter 

Function 

Generates a 128-character collating sequence table for type S key fields (see 5.2.22 and 

5.2.23) with the following sequence: 

1. Space 

2. Alphabetic characters (A, a, B, b,...) 

3. Numeric characters 

4. Special characters from 0 to 0177 

The SEQB parameter cannot be specified with the SEQA, SEQC, SEQD, SEQE, or SEQK 

parameters in the list of parameters for a sort or merge operation. The SEQB parameter 


Format 

'SEQB' 


070000aaaaaa 

770000bbbbbb 

where 

aaaaaa 

bbbbbb 








allowed. 

7831 0687–010 5–41


5.2.46. SEQC Parameter 

Function 

Generates a 256-character collating sequence table used with type S key fields (see 

5.2.22 and 5.2.23). 

The SEQC parameter cannot be specified with the SEQA, SEQB, SEQD, SEQE, or SEQK 

parameters in the list of parameters for a sort or merge operation. The SEQC parameter 


Format 

'SEQC', n1, n2, n3 [,'UPTO'], ni, nj [,'ALL'] 

where 


UPTO 

ALL 








fields. 

Description 

Specify the fields in the same way you specify SEQA. Do not use SEQC in the same 

program with SEQA. 


240000aaaaaa 

770000bbbbbb 

where 

aaaaaa 

bbbbbb 





5–42 7831 0687–010





allowed. 

5.2.47. SEQD Parameter 

Function 

Automatically generates a 256-character collating sequence table used with type S key 

fields (see 5.2.22 and 5.2.23) in the following sequence: 

1. Alphabetic characters (A, a, B, b) 


3. Space 

4. Special characters 

The SEQD parameter cannot be specified with the SEQA, SEQB SEQC, SEQE, or SEQK 

parameters in the list of parameters for a sort or merge operation. The SEQD parameter 


Format 

'SEQD' 


240000aaaaaa 

770000bbbbbb 

where 

aaaaaa 

bbbbbb 








allowed. 

5.2.48. SEQE Parameter 

Function 

Automatically generates a 256-character collating sequence table used with type S key 

fields (see 5.2.22 and 5.2.23). The sequence is based on the EBCDIC collating 

sequence. 

7831 0687–010 5–43


The SEQE parameter cannot be specified with the SEQA, SEQB SEQC, SEQD, or SEQK 

parameters in the list of parameters for a sort or merge operation. The SEQE parameter 


Format 

'SEQE' 


240000aaaaaa 

770000bbbbbb 

where 

aaaaaa 

bbbbbb 


is the bank descriptor index in the L,BDI format of the bank containing the address of 

the collating sequence table. This entry is optional and is used for an extended 

mode sort only. 




allowed. 

5.2.49. SEQF Parameter 

Function 

Automatically generates a 64-character Fieldata collating sequence table in the following 

sequence for all type A key fields: 

1. Space 

2. Alphabetic characters 


4. All special characters from 0 to 077 

The SEQF and SEQ parameters cannot be specified in the list of parameters for a sort or 

merge operation. The SEQF parameter can be specified with SEQA, SEQB, SEQC, 

SEQD, SEQE, or SEQK parameters. 

Format 

'SEQF' 


040000aaaaaa 

770000bbbbbb 

5–44 7831 0687–010

where 

aaaaaa 

bbbbbb 


is the address of the alternate Fieldata collating sequence. 


the Fieldata collating sequence table. This entry is optional and is used for an 



64-word table that contains the type A key fields with the alternate collating sequence 


allowed. 

5.2.50. SEQK Parameter 

Function 

Automatically generates a 256-character collating sequence table in the same manner as 

the SEQD parameter except that the katakana character sequence is included before the 

special characters. 

The SEQK parameter cannot be specified with the SEQA, SEQB SEQC, SEQD, or SEQE 

parameters in the list of parameters for a sort or merge operation. The SEQK parameter 


Format 

'SEQK' 


240000aaaaaa 

770000bbbbbb 

where 

aaaaaa 

bbbbbb 

is the address of the 256-character collating sequence table. 


the collating sequence table. This entry is optional and is only used for an extended 

mode sort. 

If you do not use R$FILE to define your table, your program must generate a 256-word 

table that contains the type S key fields with the alternate collating sequence you want 

in the rightmost bit positions of each word. Only one character per word is allowed. 

7831 0687–010 5–45


5.2.51. SMRG Parameter 

Function 

Tells the SORT subroutines to perform an automatic tape sort (see 12.3). This type of 

sort requires at least three tape drives. The operator is also required to label and mount 

tapes as needed. 

Format 

'SMRG', 'output-label-prefix' [,records-per-cycle, reels-per-cycle] 

where 


is two characters, used as the first two characters of each tape label created. 

records-per-cycle 

is a number that specifies the maximum number of records that are sorted in any 

cycle. This field is optional and is used only when this value is less than the physical 

record volume limit that can be sorted with the total facilities assigned. 

reels-per-cycle 

is a number that specifies the maximum number of tape reels to be produced in any 

sort cycle. This is an optional field. 


300000000000 

12000000pppp 

where pppp is the 12-bit octal representation of the 2-character prefix for all tape labels 

created. 

If the optional fields are present, the following entries are generated: 

10rrrrrrrrrr 

11tttttttttt 

where 

rrrrrrrrrr 

tttttttttt 

is the 30-bit octal maximum records per cycle. 

is the 30-bit octal maximum number of reels created per cycle. 

5–46 7831 0687–010

5.2.52. VOL Parameter 

Function 


Tells the SORT subroutines approximately how many records to sort. 

Format 

'VOL', thousands-of-records 

where thousands-of-records gives the record count in thousands of records. 


64nnnnnnnnnn 

where nnnnnnnnnn is the 30-bit octal record count in thousands of records. 

5.2.53. VRSZ Parameter 

Function 

Specifies the maximum length of variable-length records and the minimum link size of 

the input record in terms of 6-bit characters. 

Format 

'VRSZ', max-char-per-rec, min-char-per-link 

where 

max-char-per-rec 

specifies the maximum number of 6-bit characters a record can contain. 

min-char-per-link 

specifies the minimum number of 6-bit characters required to contain all the key 

fields in the records. See Section 10 for variable-length record efficiency 

considerations. 


01ggnnnnnnnn 

02ggllllllll 

where 

gg 

is a 6-bit field indicating the granularity of the nnnnnnnn or llllllll. This field is set 

to 01 for the VRSZ specification to indicate 6-bit granularity. 

nnnnnnnn 

is the 24-bit octal number of 6-bit characters per record in the largest record. 

7831 0687–010 5–47


llllllll 

is the 24-bit octal representation of the minimum link size in 6-bit characters. 

5.2.54. VRSZA Parameter 

Function 


the input record in terms of 9-bit characters. 

Format 

'VRSZA', max-char-per-rec, min-char-per-link 

where 

max-char-per-rec 

specifies the maximum number of 9-bit characters a record can contain. 

min-char-per-link 

specifies the minimum number of 9-bit characters required to contain all the key 

fields in the records. See Section 10 for variable-length record efficiency 

considerations. 


01ggnnnnnnnn 

02ggllllllll 

where 

gg 


to 02 for the VRSZA specification to indicate 9-bit granularity. 

nnnnnn 

is the 24-bit octal number of 9-bit characters per record in the largest record. 

llllllll 

is the 24-bit octal representation of the minimum link size in 9-bit characters. 

5.2.55. VRSZB Parameter 

Function 


the input record in terms of bits. 

Format 

'VRSZB', max-bits-per-rec, min-bits-per-link 

where 

5–48 7831 0687–010

max-bits-per-rec 


specifies the maximum number of bits a record can contain. 

min-bits-per-link 

specifies the minimum number of bits required to contain all the key fields in the 

records. See Section 10 for variable-length record efficiency considerations. 


01ggnnnnnnnn 

02ggllllllll 

where 

gg 


to 03 for the VRSZB specification to indicate bit granularity. 

nnnnnn 

is the 24-bit octal number of bits per record in the largest record. 

llllllll 

is the 24-bit octal representation of the minimum link size in bits. 

5.2.56. VRSZW Parameter 

Function 


the input record in terms of words. 

Format 

'VRSZW', max-words-per-rec, min-words-per-link 

where 

max-words-per-rec 

specifies the maximum number of words a record can contain. 

min-words-per-link 

specifies the minimum number of words required to contain all the key fields in the 

records. See Section 10 for variable-length record efficiency considerations. 


01ggnnnnnnnn 

02ggllllllll 

where 

7831 0687–010 5–49


gg 


to 00 for the VRSZW specification to indicate word granularity. 

nnnnnn 

is the 24-bit octal number of words per record in the largest record. 

llllllll 

is the 24-bit octal representation of the minimum link size in words. 

5.3. Coding Parameter Table Entries as Constants 

Follow these steps to code the parameter table entries as constants in your MASM 

program: 

1. Code a start table entry and an end table entry: 

Format 

000000aaaaaa (start table entry) 

710000aaaaaa (end table entry) 

where aaaaaa is the 18-bit octal address of the table in both the start table and end 

table entries. 

2. Code the table entries that define the information being passed to the SORT 

subroutines between the start table entry and the end table entry: 

a. Find the appropriate R$FILE parameter. 

b. Check the generated entry or entries for the parameter (see 5.2) 

c. Code the value of the generated entries as constants in your MASM program. 

Example 

Perform the following steps to code the amount of memory to be allocated for a sort 

as a constant. 

Step 1: Find the R$FILE parameter. The parameter is CORE. 

Step 2: Check the CORE parameter description (see 5.2.13) to find the entries 

generated by the CORE parameter. The generated entries for basic mode are 

the following: 

20wwwwwwwwww 

770000aaaaaa 

where 

wwwwwwwwww 

is the 18-bit octal number of words of memory to be allocated. 

5–50 7831 0687–010

770000 

aaaaaa 


is the continuation code to show that more than one specification is required for 

the parameter. 

is the 18-bit octal address where working storage begins. 

3. Code the values of the generated entries as constants in your MASM program. See 

the MASM Programming Reference Manual for help. 

5.4. Using Execution-Time Parameters 

The SORT subroutines read most parameters at assembly time. However, some are 

read at execution time. Any cards punched by the IPURI$ linkage (see 6.3.1) must be 

read at execution time during a CONTC operation. You must use the following 

runstream pattern to force the SORT subroutines to read parameter cards or the IPURI$ 

deck: 

@XQT,P sort-program-name 

. 

. 

. 

parameters/IPURI$ cards 

. 

. 

. 

@EOF A 

When the sort program encounters the P execution option, it issues an AREAD$ 

Executive request that causes the execution-time parameters to be read. 

Use the R$FILE parameter OPTION, NO–P–OPTION to suppress the use of the P option 

for SORT execution-time parameters (see 5.2.30). 

Note: The P option is ignored and therefore cannot include execution-time parameters 

when your sort program is running under Transaction Processing (TIP) (AREAD$ is an 

invalid Executive request under TIP). 

The following R$FILE parameters can be accepted at execution time: 

BIAS, CHECK, CHECKD, CHECKF, CHECKK, CHECKT, CONTA, CONTB, CONTC, DELCON, 

DELLOG, PARTA, PARTB, PARTC, REDOA, REDOB, SMRG, VRSZ, VRSZW, VOL 

The format for these parameters is the same as the format for assembly-time 

parameters, described in 5.3. 

7831 0687–010 5–51


The following are non-R$FILE parameters and are accepted at execution time only. 

These parameters are not enclosed in quotation marks because they are not R$FILE 

parameters. Table 5–4 contains the execution-time parameters. 

Table 5–4. Execution-Time Parameters 

Parameter Description 

LIMDRM Specifies the minimum acceptable block size for the one-level (M1) module. 

LIMFST Specifies the minimum acceptable block size for the two-level (M1–M2) 

module. 

PSORT Deletes all parameter table entries that were generated by the SMRG 

parameter. 

R$NCDS Omits the execution-time parameter routine from the final sort program 

collection. 

The following subsections describe and define each of these parameters in detail. 

5.4.1. LIMDRM Parameter 

Function 

Tells the SORT subroutines that the minimum block size acceptable for the M1 module 

is specified by the minimum–M1 field. If a block size for M1 is calculated less than this 

value, an error message is issued and the sort program terminates. 

Format 

LIMDRM, minimum-M1 

where minimum–M1 is the minimum block size in words. 

5.4.2. LIMFST Parameter 

Function 

Is the same as LIMDRM except that it applies to the block size calculation for the M2 

module. 

Format 

LIMFST, minimum-M2 

where minimum–M2 is the minimum block size in words. 

5–52 7831 0687–010

5.4.3. PSORT Parameter 

Function 


Deletes all parameter table entries that were generated by the SMRG parameter. This 

parameter is mainly for ASCII COBOL users since the parameter table generated by 

ASCII COBOL always has SMRG specified. If no tapes are assigned to the sort program, 

this parameter is not needed. 

Format 

PSORT 

5.4.4. R$NCDS Procedure 

If execution-time parameters are not being used by a particular sort program, you can 

use the R$NCDS procedure to omit the execution-time parameter routine from the final 

sort program collection. The R$NCDS procedure is only meaningful when you use the 

standard or extended linkages (see 6.2). 

You must not use the R$NCDS procedure call in a sort program that uses the @XQT 

statement with a P option, unless the OPTION, NO–P–OPTION R$FILE parameter is 

specified. If you do, the sort program issues a diagnostic message and terminates. 

5.5. Using Multiple Parameter Tables 

The SORT subroutines allow a single sort or merge run to use more than one parameter 

table. For each COPY parameter (070 table entry) found during a search, the SORT 

subroutines interrupt the search pattern and go to the next parameter table you 

specified. When an end table code (the 071 table entry) is found, the SORT subroutines 

return to the point where the COPY parameter was found in the previous table. This 

sequence can be nested. 

The following graphic illustrates the multitable searching process. 

(1) 00 entry 

. 

. 

. 

Main–Table Table–1 Table–2 

(2) 070 entry (to Table-1) 

(9) . 

. 

. 

(3) 00 entry 

. 

. 

. 

(4) 070 entry (to Table-2) 

(7) . 

. 

. 

(5) 00 entry 

(10) 071 entry (8) 071 entry (to Main-Table) (6) 071 entry (to Table-1) 

7831 0687–010 5–53 

. 

. 

. 

. 

. 

.


The search sequence with these parameter tables follows this pattern: 

1. Start search in Main-Table at the 00 entry. 

2. Link to Table-1 at the 070 entry in Main-Table. 

3. Continue search in Table-1 at the 00 entry. 

4. Link to Table-2 at the 070 entry in Table-1. 

5. Continue search in Table-2 at the 00 entry. 

6. Return to Table-1 upon finding the 071 entry in Table-2. 

7. Search Table-1 starting at the point of return from Table-2. 

8. Return to Main-Table upon finding the 071 entry in Table-1. 

9. Search Main-Table starting at the point of return from Table-1. 

10. End search upon finding the 071 entry in Main-Table. 

When the SORT subroutines find the code for which they are searching, the search 

operation stops. The next search operation then starts at the 00 entry in Main-Table. 

5–54 7831 0687–010

Section 6 

MASM Program Linkages 

This section describes the standard, extended, and common bank linkages you use to 

call the SORT subroutines from a MASM program. 

To enter standard or common bank linkages, you can use procedure calls alone, 

procedure calls combined with MASM statements, or MASM statements alone. The 

methods for procedure calls alone and MASM statements alone are shown in the 

subsections that follow. You choose the method you prefer. 

There are no procedure calls for extended linkages, so you must code the MASM 

statements into your program to use them. The MASM statements you need are shown 

for each extended linkage. 

Both standard and extended linkages access the relocatable SORT subroutines, but they 

differ in how they handle the D-bank space reserved for the SORT subroutines. This 

difference is explained as follows: 

• Standard linkages reference relocatable D-bank elements supplied by the SORT 

subroutines. These linkages are available for compatibility reasons, but are not 

recommended. 

• Extended linkages require you to supply the address for the D-bank space located in 

your own MASM program. 

Common bank linkages access the common bank SORT subroutines. You supply the 

address for the D-bank space located in your MASM program, just as you do for 

extended linkages. 

The common bank SORT subroutines do not require you to re-collect your program when 

you modify the Sort/Merge product. For this reason, use the common bank subroutines 

whenever you can. To access the extended mode SORT subroutines, you must use the 

common bank subroutines. 

7831 0687–010 6–1


6.1. MASM Procedure Definition Elements 

Before you can access the SORT subroutines with the MASM linkages, you must make 

the SORT procedure definitions available to your MASM source program. The following 

are two methods for making these definitions available: 

Method 1 

Use this method for standard and common bank linkages. 

This method accesses a MASM definition-mode element called RPROC$. MASM runs 

more efficiently with definition-mode elements and RPROC$ provides better error 

diagnostics than does the RPROCS$ method. This method also supports all parameters, 

options, and standard common bank linkages. The RPROCS$ method does not support 

some of the newer parameters and options. 

Code the following source statement in your program: 

$INCLUDE 'RPROC$' 

See Appendix C for an example using the $INCLUDE statement. For more information 

on coding an $INCLUDE statement, see the MASM Programming Reference Manual. 

If the SORT subroutines common bank is called from another common bank, special 

care is required for any COMP, DROC, ERROR, FINAL, FPOC or LPOC routines. 

A collector EQU directive must be entered for each routine used. The format for this 

directive is as follows: 

Format 

EQU epname/0bbbbbbeeeeee 

where 

epname 

is the externally-defined label of the COMP, DROC, ERROR, FINAL, FPOC or LPOC 

routine. 

bbbbbb 

eeeeee 

is the 18-bit octal Exec BDI value for the bank containing the routine. 

is the 18-bit octal Collector address assigned to the external label (obtainable from an 

L-option MAP). The eeeeee value can change if the subprogram containing the 

routine is changed. 

6–2 7831 0687–010

Method 2 

Use this method for standard linkages only. 


This method accesses the Procedure Definition Processor (PDP) element RPROCS$. 

The RPROCS$ procedure element is installed in the system procedure library file 

SYS$LIB$*PROC$ (part of the MASM library search chain). 

You cannot use the I$PURI, R$MGREL, R$MGREQ, R$MGOPN, or R$QEND linkages 

with RPROCS$. Also RPROCS$ does not support some of the newer parameters and 

options. 

6.2. MASM Sort Program Linkages 

From a MASM program you can perform standard, extended, and common bank 

linkages. The following subsection describes the linkages you use to perform a sort 

operation. 

When you perform a sort operation, follow five basic steps using the appropriate sort 

linkage to do each one. To establish the sort linkages, do the following: 

1. Open the sort operation with one of the following sort linkages: 

a. ROPN$ (standard) 

b. ROPN$X (extended) 

c. ROPN$CB (common bank) 

2. Release records to the sort with one of the following sort linkages: 

a. RREL$ (standard) 

b. RREL$X (extended) 

c. RREL$CB (common bank) 

3. End input of records and start the sort with one of the following sort linkages: 

a. RSORT$ (standard) 

b. RSORT$X (extended) 

c. RSORT$CB (common bank) 

4. Retrieve sorted records from the sort with one of the following sort linkages: 

a. RRET$ (standard) 

b. RRET$X (extended) 

c. RRET$CB (common bank) 

5. Close the sort with one of the following sort linkages: 

a. RQEND$ (standard) 

b. RQEND$X (extended) 

c. RQEND$CB (common bank) 

7831 0687–010 6–3


The following subsections describe the particular SORT subroutine program linkages. 

6.2.1. MASM Sort Open Linkages 

The sort open linkages initialize the SORT subroutines. A sort open linkage must be the 

first linkage to the SORT subroutines from every user sort program. 

Table 6–1 describes the call formats and MASM statements for each SORT subroutine 

sort open linkage type. 

Table 6–1. MASM Statements for Sort Open Linkage Types 

Linkage Type Call Format MASM Statements 

Standard Procedure Call R$OPN [parameter-table-address] 

MASM Code If an FPOC address is specified (see 5.2.21): 

Extended Procedure Call None 

LA,U A3,parameter-table-address 

J ROPN$ 

If an FPOC address is not specified: 


LMJ X11,ROPN$ 

MASM Code If an FPOC address (see 5.2.21) is specified: 

LX X9,(sort-dbank-size,sort-dbank-address) 


J ROPN$X 

If an FPOC address is not specified: 

LX X9,(sort-dbank-size,sort-dbank-address) 


LMJ X11,ROPN$X 

Common Bank Procedure Call R$OPNCB[,sort-dbank-size,sort-dbank-address] 

[parameter-table-address] 

MASM Code LX X9,(sort-dbank-size,sort-dbank-address) 


I$BJ X11,ROPN$CB 

Note: When using the procedure call format, you can specify addresses with either tag 

names or index registers. For example: 

R$OPNCB,02200,DBANK PARAMS 

or 

R$OPNCB,SIZE,0,X2 0,X5 

6–4 7831 0687–010

Required Input 


Register A3 must contain the address of the first word of the sort parameter table. If 

you are using a procedure call and you specify the parameter-table-address field, register 

A3 is loaded with the parameter table address for you before the SORT open subroutine 

is called. 

For the extended and common bank linkages: 

1. The sort-dbank-size must be at least 02200 words. This space must be reserved by 

the user program before calling the SORT open subroutine. 

2. The upper half of register X9 must contain the size of the D-bank reserved for the 

SORT subroutines, and the lower half of register X9 must contain the address of the 

D-bank reserved for the SORT subroutines. If you are using a procedure call and you 

specify the sort-dbank-size and sort-dbank-address fields, register X9 is loaded for 

you before entering the SORT open subroutine. 

Exit Conditions 

In a PARTB sort, control returns to the address specified by the FINAL parameter. If 

FINAL is not specified, the SORT subroutines execute an ER EXIT$ instruction to end the 

sort program. 

If an FPOC address is specified, SORT returns control at that address by jumping to it 

through X11; otherwise, SORT returns on either a J 0,X11 or LIJ X11,0,X11 instruction. 

The SORT subroutines save and restore all registers except X11. 

6.2.2. MASM Sort Release Linkages 

You call the sort release linkages to pass records to be sorted to the SORT subroutines. 

If OPTION bits 30 and 31 are not set, the WORD record length functionality is invoked 

for the SORT subroutines MASM linkages. This is described in 6.2.2.1. If either OPTION 

bits 30 or 31 are set, the non-word record length functionality is invoked for the SORT 

subroutines MASM linkages. 

6.2.2.1. MASM Sort Release Linkages (WORD Length Records) 

If OPTION bits 30 and 31 are not set, then the WORD record length functionality is 

invoked. This is the format that has always been used prior to SORT level 21R1. Table 

6–2 describes the call formats and MASM statements for each SORT subroutine sort 

release linkage type. 

7831 0687–010 6–5


Table 6–2. MASM Statements for Sort Release Linkage Types 


Standard Procedure Call R$REL [( record-length,record-address )] 

MASM Code LA A0,( record-length,record-address ) 


LMJ X11,RREL$ 

MASM Code LX,U X9,sort-dbank-address 

LA A0,( record-length,record-address ) 

LMJ X11,RREL$X 

Common Bank Procedure Call R$RELCB[, sort-dbank-address] [( record-length, record-address)] 


LA A0,( record-length,record-address ) 

I$BJ X11,RREL$CB 

Note: When using the procedure call format, you can specify addresses with either 

tag names or index registers. For example: 

R$RELCB,DBANK (RSIZE,BUFFER) 

or 

R$RELCB,0,X2 96,X4 X4 + 96 points to a word 

containing length in H1 and 

record-address in H2. 


The lower half of register A0 must contain the address of the record being passed to the 

SORT subroutines when entering through any sort release linkage. If the records are of 

variable length, the upper half of register A0 must contain the record length. If the 

records are fixed length, the upper half of register A0 is ignored. If you are using a 

procedure call and you specify the record-length and record-address fields, register A0 is 

loaded for you before entering the SORT release subroutine. 

For the extended and common bank linkages, the lower half of register X9 must contain 

the address of the D-bank reserved for the SORT subroutines. If you are using a 

procedure call and you specify the sort-dbank-address field, register X9 is loaded for you 

before the SORT release subroutine is called. 


The SORT subroutines return control to the user program with either a J 0,X11 or an LIJ 

X11,0,X11 instruction. 


6–6 7831 0687–010


6.2.2.2. MASM Sort Release Linkages (NON-WORD Length Records) 

If either OPTION bits 30 or 31 is set, then the NON-WORD record length functionality is 

invoked. This is a new format effective in SORT level 21R1. Table 6–3 describes the call 

formats and MASM statements for each SORT subroutine release linkage type. 

Table 6–3. MASM Statements for MASM Sort Release Linkage Types 

(OPTION Bits 30 or 31 Are Set) 


Standard Procedure Call R$REL [ record-address record-length] ] 

MASM Code LA A0,( record -address ) 


LXI,U A0,0 

LA A1,record_length . if variable length records 


LA A0, record-address 

LXI,U A0,0 

LA A1, record-length . if variable length records 

LMJ X11,RREL$X 

Common Bank Procedure Call R$RELCB[,sort-dbank-address] [record-address [ record-length] ] 



LA A0,record--address 

LXI,U A0,0 

LA A1,record-length . if variable length records 

I$BJ X11,RREL$CB 

The lower half of register A0 must contain the address of the record being passed to the 

SORT subroutines when entering through any sort linkage. H1 of register A0 should be 

0. If a variable length sort operation is occurring, register A1 will contain the length of 

the record being passed to the SORT subroutines in terms stated by the setting of 

OPTION bits 30 and 31. If you are using a procedure call and you specify the recordlength 

and record-address fields, registers A0 and A1 are loaded for you before entering 

the SORT release subroutine. 




before the SORT release subroutine is called. 


The SORT subroutines return control to the user program with either a J 0,X11 or an LIJ 


7831 0687–010 6–7


The SORT subroutines save and restore all registers except register X11. 

6.2.3. MASM Sort Sort Linkages 

MASM sort sort linkages tell the SORT subroutines that all the records have been 

released to SORT through a release linkage. 


sort sort linkage type. 

Table 6–4. MASM Statements for Sort Sort Linkage Types 


Standard Procedure Call R$SORT 

MASM Code If an LPOC address is specified (see 5.2.26) 


J RSORT$ 

If an LPOC address is not specified 

LMJ 11,RSORT$ 

MASM Code If an LPOC address (see 5.2.26) is specified: 

LX,U X9,sort-dbank-address 

J RSORT$X 

If an LPOC address is not specified: 


LMJ X11,RSORT$X 

Common Bank Procedure Call R$SORTCB[,sort-dbank-address] 


I$BJ X11,RSORT$CB 

Note: When using the procedure call format, you can specify addresses with either tag 

names or index registers. For example: 

R$SORTCB,DBANK or R$SORTCB,0,X2 





before the SORT sort subroutine is called. 


In a PARTA sort (see 5.2.32), control returns to the address specified by the FINAL 

parameter. If FINAL is not specified, the SORT subroutines execute an ER EXIT$ 

instruction to terminate the user program. 

6–8 7831 0687–010


If an LPOC address is specified, SORT returns control at that address by jumping to it 

through register X11; otherwise, control returns with either a J 0,X11 or an LIJ X11,0,X11 

instruction. 

The SORT subroutines save and restore all registers except register X11. 

6.2.4. MASM Sort Return Linkages 

MASM sort return linkages tell the SORT subroutines to retrieve a sorted record from 

the SORT subroutine. 


sort return linkage type. 

Table 6–5. MASM Statements for Sort Return Linkage Types 


Standard Procedure Call R$RET end-address 

MASM Code LMJ X11,RRET$ 


+ end-address 


LMJ X11,RRET$X 

+ end-address 

Common Bank Procedure Call R$RETCB[,sort-dbank-address] [end-address] 

[output-record-address] 

MASM Code LA,U A0,output-record-address 


I$BJ X11,RRET$CB 

J end-address 



R$RETCB,DBANK EOF OUTREC 

or 

R$RETCB,0,X2 10,X5 12,X6 





before the SORT return subroutine is called. 

7831 0687–010 6–9


For the common bank linkages, when an extended mode sort is being performed, you 

must supply output-record-address in register A0. The record to be returned will be 

moved by SORT to the storage location associated with the output record address. The 

length of the storage location must be at least the record size in words. For example, if 

the record size is 9 ASCII characters, the length of the storage area must be at least 3 

words. 


The normal return is either a J 1,X11 or an LIJ X11,1,X11 instruction with register A0 or 

registers A0 and A1 containing the return record information. The lower half of register 

A0 always contains the address for the record being returned. If the records are of 

variable length, the length of the record will be returned in either the upper half of 

register A0 or in register A1. If word length granularity is specified (OPTION parameter 

bits 30 and 31 are 0), the upper half of register A0 will contain the word length of the 

record. If 6-bit character, 9-bit character, or bit granularity is specified (OPTION 

parameter bit 30 or 31 or both are set), register A1 will contain the length of the record in 

the requested granularity. 

If a sort return linkage is entered and there are no more records to be returned, control 

transfers to the address specified by end-address. 

The record area addressed by register A0 must not be altered by your user program. 

The SORT subroutines save and restore all registers except X11, A0, and A1. 

6.2.5. MASM Sort Quick End Linkages 

A MASM sort quick end linkage terminates the return record phase of a sort before all 

the records have been returned. 


sort quick end linkage type. 

Table 6–6. MASM Statements for Sort Quick End Linkages 


Standard Procedure Call R$QEND 

MASM Code LMJ X11,RQEND$ 



LMJ X11,RQEND$X 

Common Bank Procedure Call R$QENDCB[,sort-dbank-address] 


I$BJ X11,RQEND$CB 

6–10 7831 0687–010




R$QENDCB,DBANK 

or 

R$QENDCB,0,X2 





before the SORT quick end subroutine is called. 


The SORT subroutines return to the user program with either a J 0,X11 or an LIJ 



6.3. MASM Tape Sort Linkages 

From a MASM program you can perform standard, extended, and common bank 

linkages to perform a tape sort operation. Use the linkages described in the following 

subsections for tape sort operations. 

6.3.1. IPURI$ 

IPURI$ punches the tape repositioning table on cards that are read by the SORT 

subroutines during a CONTC operation. 


IPURI$ tape sort linkage type. 

Table 6–7. MASM Statements for the IPURI$ Tape Sort Linkage 


Standard Procedure Call I$PURI 

MASM Code LMJ X11,IPURI$ 



Common Bank Procedure Call None 

LMJ X11,IPURI$X 


I$BJ X11,IPURI$CB 

7831 0687–010 6–11



None 


The following exit conditions apply to IPURI$: 

• The SORT subroutines return to the user program with either a J 0,X11 or an LIJ 


• IPURI$ destroys registers A2, A3, A4, A5, R1, and X11. 

6.3.2. RENCY$ 

The RENCY$ linkage terminates an input cycle during a PARTA sort (see 5.2.32). 


RENCY$ tape sort linkage type. 

Table 6–8. MASM Statements for the RENCY$ Tape Sort Linkages 


Standard Procedure Call R$ENCY 

MASM Code LMJ X11,RENCY$ 





None 


LMJ X11,RENCY$X 


The following exit conditions apply to RENCY$: 

I$BJ X11,RENCY$CB 

• The SORT subroutines return control to the user program with either a J 0,X11 or an 

LIJ X11,0,X11 instruction. 

• The SORT subroutines save and restore all registers they use during RENCY$ except 

X11 and A0. 

6–12 7831 0687–010

6.3.3. RINFO$ 


RINFO$ linkage requests the address of the tape repositioning table needed to do a 

CONTC operation during a PARTC sort (see 5.2.34). 


RINFO$ tape sort linkage type. 

Table 6–9. MASM Statements for the RINFO$ Tape Sort Linkages 


Standard Procedure Call R$INFO 

MASM Code LMJ X11,RINFO$ 





None 


LMJ X11,RINFO$X 


The following exit conditions apply to RINFO$: 

I$BJ X11,RINFO$CB 

• The SORT subroutines return control to the user program with either a J 0,X11 or an 

LIJ X11,0,X11 instruction. 

• On return, register A0 contains the address of the tape repositioning table and 

register A1 contains the length of the table. The user program must save the table 

for a CONTC run. 

• RINFO$ destroys the contents of registers A2, A3, A4, A5, R1, and X11. 

7831 0687–010 6–13


6.4. MASM Merge Program Linkages 

When you perform a merge operation, follow four basic steps using the appropriate 

merge linkage. 

1. Open the merge operation with one of the following: 

a. RMGOPN$ (standard) 

b. RMGOPN$X (extended) 

c. RMGOPN$CB (common bank) 

2. Release the first record of each input file to the merge operation with one of the 

following: 

a. RMGREL$ (standard) 

b. RMGREL$X (extended) 

c. RMGREL$CB (common bank) 

3. Request a record from, and release the next input record to, the merge operation 

with one of the following: 

a. RMGREQ$ (standard) 

b. RMGREQ$X (extended) 

c. RMGREQ$CB (common bank) 

4. Close the merge operation with one of the following: 

a. RQEND$ (standard) 

b. RQEND$X (extended) 

c. RQEND$CB (common bank) 

6.4.1. MASM Merge Open Linkages 

A merge open linkage initializes a merge operation. It must be the first linkage to the 

SORT subroutines from every user merge program. 


merge open linkage type. 

6–14 7831 0687–010


Table 6–10. MASM Statements for Merge Open Linkages 


Standard Procedure Call R$MGOPN [parameter-table-address] 

MASM Code LA,U A0,parameter-table-address 


LMJ X11,RMGOPN$ 

MASM Code LX X9,(merge-dbank-size,merge-dbank-address) 


LMJ X11,RMGOPN$X 

Common Bank Procedure Call R$MGOPNCB[,merge-dbank-size,merge-dbank-address] 

[parameter-table-address] 

MASM Code LX X9,(merge-dbank-size,merge-dbank-address) 


I$BJ X11,RMGOPN$CB 



R$MGOPNCB,0500,DBANK TABLE 

or 

R$MGOPNCB,0500,0,X2 10,X3 


Register A0 must contain the address of the first word of the merge parameter table. If 

you are using a procedure call and you specify the parameter-table-address field, register 

A0 is loaded with the parameter table address for you before the merge open linkage is 

called. 

For the extended and common bank linkages: 

• The merge-dbank-size must be at least 0500 words. If a CORE entry is not present, 

merge-dbank-size (in words) must be at least 0500 + (2 * record-size). This space 

must be reserved prior to calling merge open linkage. 

• The upper half of register X9 must contain the size of the D-bank reserved for the 

SORT subroutines, and the lower half of register X9 must contain the address of the 

D-bank reserved for the SORT subroutines. If you are using a procedure call and you 

specify the merge-dbank-size and merge-dbank-address fields, register X9 is loaded 

for you before the merge open linkage is called. 


The SORT subroutines return control with either a J 0,X11 or an LIJ X11,0,X11 

instruction. All registers used by SORT subroutines are saved and restored except X11. 

7831 0687–010 6–15


6.4.2. MASM Merge Release Linkages 

A merge release linkage releases the first record of each input file to the SORT 

subroutines. It must be entered once for each input file being merged. 


merge release linkage type. 

Table 6–11. MASM Statements for Merge Release Linkages 


Standard Procedure Call R$MGREL [record-address [file-identifier] ] 

MASM Code LA,U A0,record-address 


LA A1,file-identifier 

LMJ X11,RMGREL$ 

MASM Code LX,U X9,merge-dbank-address 

LA,U A0,record-address 


LMJ X11,RMGREL$X 

Common Bank Procedure Call R$MGRELCB[,merge-dbank-address] 

[record-address [file-identifier] ] 




I$BJ X11,RMGREL$CB 



R$MGRELCB,DBANK BUFFER 1 

or 

R$MGRELCB,0,X2 0,X4 '2' The ‘2’ indicates a character string. 


Register A0 must contain the address of the first record from an input file. The record 

area addressed by register A0 must not be altered by the user program until that record 

is returned through a request linkage. If you are using a procedure call and you specify 

the record-address field, register A0 is loaded with the record address for you before the 

merge release linkage is called. 

The lower half of register A1 must contain an identifier for the input file. Each input file 

should have a unique identifier that remains constant throughout the merge operation. If 

you are using a procedure call and you specify the file-identifier field, register A1 is 

loaded with the file identifier for you before the merge release linkage is called. 

6–16 7831 0687–010




procedure call and you specify the merge-dbank-address field, register X9 is loaded for 

you before the merge release linkage is called. 


The SORT subroutines return control with either a J 0,X11 or an LIJ X11,0,X11 

instruction. All registers used by SORT subroutines are saved and restored except X11. 

6.4.3. MASM Merge Request Linkages 

A merge request linkage requests a record from the SORT subroutines and also enters 

the next input record into the merge operation. 


merge request linkage type. 

Table 6–12. MASM Statements for Merge Request Linkages 


Standard Procedure Call R$MGREQ [record-address] 

MASM Code LA,U A0,record-address 


LMJ X11,RMGREQ$ 



LMJ X11,RMGREQ$X 

Common Bank Procedure Call R$MGREQCB[,merge-dbank-address] [record-address] 



I$BJ X11,RMGREQ$CB 



R$MGREQCB,DBANK BUFFER 

or 

R$MGREQCB,0,X2 5,X4 


No input is required the first time you enter the request linkage. On all subsequent calls, 

register A0 must contain the address of the next record to enter the merge. This record 

must be the next input record from the file where the last record was returned by the 

request linkage. 

7831 0687–010 6–17


The data area addressed by register A0 cannot be altered until that record returns from 

the merge operation. When all records from an input file have entered through the 

request linkage, register A0 must be set to negative zero (–0) to inform the SORT 

subroutines that an input file is exhausted. 

If you are using a procedure call and you specify the record-address field, register A0 is 

loaded with the record address for you before the merge request linkage is called. 

For the extended and common bank linkages the lower half of register X9 must contain 


procedure call and you specify the merge-dbank-address field, register X9 is loaded for 

you before the merge release linkage is called. 


The SORT subroutines return control with a J 0,X11 instruction. Register A0 contains 

the address of the record being returned. Register A1 contains the identifier of the input 

file for the returning record addressed by register A0. If all records are returned when 

the request linkage is entered, a negative zero (–0) is returned in register A0 to signify 

the end of the merge operation. 

The upper half of register A0 can be used during a merge operation; its contents are not 

changed by the SORT subroutines. All registers used by SORT subroutines are saved 

and restored except A0, A1, and X11. 

6.4.4. MASM Merge Close Linkages 

A merge close linkage terminates a merge operation before all records have been 

requested from the SORT subroutines. 

There are no MASM merge linkages for the purpose of ending the merge operation 

before all records have been requested from the SORT subroutines. If it is necessary to 

close a merge operation before all records have been returned, use the MASM sort 

close linkages (see 6.2.5). 

6–18 7831 0687–010


6.5. Interface Aids to the SORT Subroutine MASM 

Linkages 

All installations of the Sort/Merge product provide five relocatable interface (intercept) 

elements that can provide quick conversion (for example, relocatable to common-banked 

interface, basic mode to extended mode) or testing of another MASM linkage. These 

elements, depending on the selected installation mode, are installed into either 

SYS$LIB$*SORT or SYS$*SRT$PAR. 

The five relocatable interface elements and their functions are the following: 

• RINTRCPT 

Redirects standard linkage calls to the common-banked linkages and subroutines. 

• RINTRCPT-EM 

Redirects standard linkage calls to the common-banked linkages and subroutines, 

and provides some basic mode to extended mode conversion assistance. 

• RINTRCPTX 

Redirects extended linkage calls to the common-banked linkages and subroutines. 

• RINTRCPTX-EM 

Redirects extended linkage calls to the common-banked linkages and subroutines, 

and provides some basic mode to extended mode conversion assistance. 

• RINTRCPTCB 

Redirects common-banked linkage calls and subroutines to the relocatable 

subroutine extended linkage calls. 

These intercept routines (except RINTRCPTCB) can also be used to reduce the changes 

necessary to the MASM routine in order to change a basic mode sort to an extended 

mode sort. For RINTRCPT and INTRCPTX to be used for converting to an extended 

mode sort, the following changes to the MASM program are still required: 

1. Change the SORT RETURN linkage call to pass a record area address in register A0. 

This record area is used by the extended mode sort subroutines to place the record 

to be returned. For basic mode sorts, the sort subroutines simply return the address 

of the record being returned. 

2. If a COMP or a DROC parameter is specified, a RECAREA parameter defining two 

record areas must be specified. These record areas are used by the sort subroutines 

to provide access to the records that are being passed to the COMP or DROC 

routine. 

3. If a CORE parameter is specified, the size of the CORE area must be increased to a 

size greater than 210,000 words. If the assignment of file R$CORE is used to state 

the size of the sort core area, the maximum reserve for the file R$CORE must be 

increased to a size greater than 210 granules. 

4. If an M1, M1-M2, or tape sort is being performed, the type of the sort being 

performed must be changed to a memory or a disk sort. 

7831 0687–010 6–19


The elements RINTRCPT-EM and RINTRCPTX-EM are intended for converting MASM 

basic mode sorts to an extended mode sort, but it is not required that the sort be an 

extended mode sort (in other words, these intercept routines will work for a basic mode 

sort). When RINTRCPT-EM and RINTRCPTX-EM are used, steps 1 and 2 above are 

resolved automatically, so the only user requirements are steps 3 and 4. 

It should be noted that both of these routines have a couple of restrictions with regard to 

the maximum length of a record related to the automatic resolution of steps 1 and 2. 

The maximum record length is 1000 words if no COMP or DROC routine is specified. If 

a COMP or DROC routine is specified, then for a fixed length sort the record length must 

be less than or equal to 500 words; for a variable length sort, the link size (VRSZ 

parameter) is limited to 500 words and the maximum record size is limited to 1000 

words. These routines do not verify these limitations. 

A site can increase these limits locally with a local CHG to these elements, which alters 

the EQUated value of the tag “rszmax.” 

For example, when Sort/Merge is installed using mode A, a standard linkage call to the 

relocatable SORT subroutines can be redirected to the common bank SORT subroutines 

by specifying the following at collection time: 

IN SYS$*SRT$PAR.RINTRCPT 

Conversely, a common-banked linkage call to the common bank SORT subroutines can 

be redirected to the relocatable SORT subroutines by specifying the following at 

collection time: 

IN SYS$*SRT$PAR.RINTRCPTCB 

NOT SYS$LIB$*SORT.CBEP$$SORT 

6.6. User Routine Substitution Considerations 

One of the more powerful features of the Sort/Merge product is its ability to substitute 

your routines for certain SORT functions. This ability gives you greater control over the 

Sort/Merge process, allowing you to do the following: 

• Determine your own comparison criteria. 

By writing and substituting your own comparison criteria routine, you can perform 

comparisons based on criteria different from that normally used by the comparison 

SORT routine. 

• Determine how duplicate data is processed. 

You can write and substitute the SORT data reduction routine with a subroutine that 

changes what occurs when two records being compared are found to have equal 

keys. 

6–20 7831 0687–010


The following describes specific coding considerations you should know when writing 

and substituting your routines for certain SORT routines. 

6.6.1. User COMP Code 

Function 

You can write your own COMP routine to perform a comparison based on criteria 

different from those normally used by the SORT subroutines. To give control to your 

COMP routine, specify the COMP parameter with the address of your routine (see 

5.2.7). 

Coding Considerations 

The following are coding considerations to observe when writing your own COMP 

routine when you are using the SORT subroutine MASM linkages. 

When the SORT subroutines transfer control to the COMP routine, registers A0 and A1 

contain the addresses of the two records compared. The following table describes 

transfer control considerations. 

If ... 

The record addressed by A0 precedes the 

record addressed by A1 

The record addressed by A1 precedes the 

record addressed by A0 

Then return control to the 

SORT subroutines with an ... 

R$A0 procedure call 

R$A1 procedure call 

Two records have equal keys R$AE procedure call 

For an extended mode sort, the RECAREA parameter (see 5.2.36) must be specified to 

make the records that are to be compared visible to the basic mode environment. 

Key Translation 

No key translation occurs. 

Register Usage 

Your COMP code cannot destroy the contents of registers A0, A1, A2, A3, or X11. 

Registers A4, A5, X1 through X10, and R1 through R3 may not be the same as when the 

SORT subroutines were entered. 

7831 0687–010 6–21


6.6.2. User DROC Code 

Function 

You can write a routine that changes what normally occurs when two records being 

compared are found to have equal keys (that is, duplicate records). You can do the 

following: 

• Delete the duplicate record 

• Combine the two records 

• Leave the records as they are 

When you write a DROC routine, you specify what to do with duplicate records. If the 

records are fixed-length and one or both are modified, the non-key portions of the entire 

record can be altered. If the records are variable-length and one or both are modified, 

only the non-key portions in the first link of each record can be altered. To give control to 

your DROC routine, specify the DROC parameter with the address of your routine (see 

5.2.17). 

Coding Considerations 

Observe the following specific coding considerations while coding your own DROC 

routine when you are using the MASM SORT subroutine linkages. 

When the SORT subroutines transfer control to the DROC routine, registers A0 and A1 

contain the addresses of the two records that have equal keys. The following table 

describes the case control considerations. 

If ... Then… 

Your DROC routine decides to return one of 

the records and delete the other record 

Your DROC routine decides to return both 

records where none, one, or both have been 

modified 

Register A0 must contain the address of the 

record to be returned and control should be 

returned to the SORT subroutines with an 

R$DLT procedure call. 

Registers A0 and A1 must contain the record 

addresses of the two records and control 

should be returned to the SORT subroutines 

with an R$NDLT procedure call. 

For an extended mode sort, you must specify the RECAREA parameter (see 5.2.36) to 

make the records that are candidates for possible data reduction visible to the basic 

mode environment. 

Key Translation 

If a COMP routine was specified, no key translation occurs. Otherwise, if you specify a 

KEY or KEYW parameter, the key fields of records are translated according to the 

descriptions in Section 11. Your DROC routine must take this translation into 

consideration when inspecting key fields. 

6–22 7831 0687–010

Register Usage 


Your DROC code cannot destroy the contents of registers A0, A1, A2, A3, or X11. 

Registers A4, A5, X1 through X10 and R1 through R3 may not be the same as the user 

calling registers to the SORT subroutines. 

7831 0687–010 6–23


6–24 7831 0687–010

Section 7 

The SORT Subroutine Parameter Tables 

for UCS C Programs 

This section explains how to create the parameter tables in Universal Compiling System 

(UCS) C programs that the SORT subroutines use to perform sort and merge operations. 

In addition, this section shows the formats and considerations for using each of the 

available SORT subroutine parameters. 

You must install Sort/Merge with Software Library Administrator (SOLAR) in an 

installation mode that makes the common bank SORT subroutines available before the 

UCS C program linkages can be used. 

7.1. Introduction 

When you give control to the SORT subroutines by specifying the appropriate linkages 

within your source program, as described in Section 8, you must provide 

• The records to sort or merge 

• The operations to perform 

• The system facilities to use 

• Key definitions 

• Additional descriptive information 

The records to sort or merge and the operation to perform are provided by the 

appropriate linkages. 

You describe the operation by creating a parameter table. A parameter table is made up 

of a number of parameter entries that contain table entry codes specifying such items as 

the record size, key definitions, and which facilities to use. 

7831 0687–010 7–1

The SORT Subroutine Parameter Tables for UCS C Programs 

7.2. Setting Up the UCS C Parameter Table 

Include Element 

You can include into a user program an element that contains definitions used for 

creating a parameter table in a UCS C program. The element is included into the 

program as follows: 

#include 

Contained within the include element is 

• A typedef for each parameter 

• Constant definitions for each parameter type and some parameter fields 

• Macro definitions for determining some parameter field values 

The naming convention used by identifiers in sm$prmtbl.h is to begin each definition or 

tag name with sm_ to indicate that the identifier is a Sort/Merge identifier. Structure and 

union member names do not necessarily follow this naming convention. Also, all names 

are in lowercase. 

Parameter Table Declaration 

Typedefs are available that define each parameter type. The parameter table can be 

declared as a structure using the parameter typedefs (see 7.3). An example of a 

parameter table declaration is: 

struct { sm_start_parameter_type start_parameter; 

sm_core_parameter_type core_parameter; 

sm_rsz_parameter_type rsz_parameter; 

sm_key_parameter_type key_parameter; 

sm_end_parameter_type end_parameter; 

} prm_tbl; 

The first parameter in the parameter table must be the START parameter. The last 

parameter in the parameter table must be the END parameter. The other parameters 

that you include in your parameter table depends on the specifics of the sort or merge 

operation that you want to perform. 

Parameter Table Initialization 

The SORT subroutines view the parameter table as an array of one-word entries. Each 

parameter entry is at least one full word and some may be multiple words in length. The 

words associated with a parameter are further broken down into parameter fields. 

Not all parts of a word associated with a parameter entry may be defined as a parameter 

field. These undefined areas of a parameter entry, identified as reserved in 7.3, are 

reserved for future use. It is recommended that the undefined areas contain zero 

values. Initializing the parameter table to zeros before entering any parameter table 

values ensures that no unexpected values exist in the parameter table. 

7–2 7831 0687–010


The following code sequence is an example of one way to initialize the parameter table: 

int i, *int_ptr; 





sm_end_parameter_type end_parameter; 

} prm_tbl; 

int_ptr = (int *) &prm_tbl; 

for (i = 0; i < (sizeof(prm_tbl) / 4); i++) 

*int_ptr++ = 0; 

Addresses Within the Parameter Table 

Some parameter entries define fields that contain pointers or addresses. An address in a 

UCS C parameter is in a different format than an address recognized by the SORT 

subroutines. A Sort/Merge macro is available that converts UCS C pointers into 

addresses that the SORT subroutines recognize. The macro is described as follows: 

sm_ptr_conversion(parameter_pointer); 

where 

parameter_pointer 

is the pointer to be given to the SORT subroutines. 

The following UCS C coding sequence is an example of how the sm_ptr_conversion 

macro is used: 

/*Declare an array that will contain the file names in the parameter table.*/ 

char *file_list[36]; 

struct { ... 

sm_files_parameter files_parameter; 

... } prm_tbl; 

/* Fill in the fields of the FILES parameter. */ 

prm_tbl.files_parameter.code = sm_files; 

prm_tbl.files_parameter.number_of_files = 3; 

prm_tbl.files_parameter.sm_address = sm_ptr_conversion(*file_list); 

7831 0687–010 7–3


7.3. UCS C Program Parameters 

Table 7–1 contains the parameters processed by the SORT subroutines when called 

through the UCS C program linkages. 

Table 7–1. UCS C Program Parameters 

Parameter Description Reference 

COMP Tells the SORT subroutines to execute a user compare routine each 

time two records are compared. 

CONSOLE Indicates whether or not operator console messages are issued 

during the course of a sort run. 

COPY Allows parameters to be accepted from more than one parameter 

table. 

CORE Specifies the amount of memory to be used for the sort and 

optionally the location of that memory. 

DROC Tells the SORT subroutines to execute a user data reduction routine 

each time it is determined that two records have equal keys. 

7–4 7831 0687–010 

7.3.1 

7.3.2 

7.3.3 

7.3.4 

7.3.5 

END Indicates the end of the parameter table to the SORT subroutines. 7.3.6 

FILES Lists the names of the scratch files to be used by the SORT 

subroutines during a sort operation. 

7.3.7 

INFO Tells the SORT subroutines of predefined additional information. 7.3.8 

KEY Specifies a key field for sort and merge operations. 7.3.9 

LOCALE Specifies a locale name for international sort or merge operations. 7.3.10 

LOG Indicates whether or not completion messages are written to the 

run log. 

OPTION Tells the SORT subroutines general information to perform specific 

actions. 

7.3.11 

7.3.12 

PAD Saves space in the parameter table for additional information. 7.3.13 

PRESERVE Maintains the order of input records that have equal keys. 7.3.14 

RSZ Specifies the maximum record size. 7.3.15 

SEQ Specifies a collating sequence table for determining the order of 

values in a key field. 

7.3.16 

START Indicates the start of the parameter table to the SORT subroutines. 7.3.17 

VOL Tells the SORT subroutines approximately how many records are to 

be sorted. 

VRSZ Specifies variable-length records and the minimum link size of the 

records. 

7.3.18 

7.3.19


The following subsections describe each of the parameters in detail. 

7.3.1. COMP Parameter 

Function 

The COMP parameter tells the SORT subroutines to execute a user routine each time 

two records are compared in a sort or merge operation. When a COMP parameter is not 

specified, the compare routine internal to the SORT subroutines is used to compare the 

records. See 7.4.1 for compare routine coding considerations. Specifying the COMP 

parameter overrides the KEY and SEQ parameters. Your sort or merge operation 

requires either a COMP or KEY parameter. 

Format 

typedef struct 

{ 

unsigned code : 6; 

unsigned reserved : 30; 

unsigned int sm_address; 

} sm_comp_parameter_type; 

The parameter fields for the COMP parameter are described as follows. 

Parameter Field Parameter Field Descriptions Parameter Field Value 

code Identifies the COMP parameter. sm_comp (041) 

sm_address Contains a pointer to a storage area that 

contains the compare routine function 

pointer. 

Address in SORT subroutines 

format. 

Function pointers in UCS C and the SORT subroutines are in different formats. A 

Sort/Merge macro is available that converts a UCS C function pointer into an address 

that the SORT subroutines can use. The macro is described as follows: 

sm_function_ptr_conversion(compare_lve, compare_pointer); 

where 

compare_lve 

is a pointer to the storage area that will contain the converted function pointer. 

Declare this storage area using the Sort/Merge typedef sm_link_vector_entry_type. 

compare_pointer 

is the function pointer to the compare routine. 

7831 0687–010 7–5


Example 

/* Declare the variable that will contain the compare routine address 

in the parameter table. */ 

sm_link_vector_entry_type comp_lve; 

void comp_routine( ); 

struct { ... 

sm_comp_parameter comp_parameter; 


/* Convert the function pointer and move it to comp_lve. Fill in 

the fields of the COMP parameter. */ 

sm_function_ptr_conversion(comp_lve, comp_routine); 

prm_tbl.comp_parameter.code = sm_comp; 

prm_tbl.comp_parameter.sm_address = sm_ptr_conversion(comp_lve); 

/* Declaration of the compare routine. */ 

#pragma interface comp_routine 

void comp_routine(void *record_one, void *record_two, int *comp_result) {...} 


Function 

The CONSOLE parameter is an optional parameter that indicates to the SORT 

subroutines whether or not all operator console messages should be issued during the 

sort operation. If specified, it overrides the CONSOLE configuration parameter (see 9.4). 

If this parameter is not specified, the CONSOLE configuration parameter takes effect, if 

present. Otherwise, no operator console messages are issued. 

Format 


{ 



unsigned messages : 6; 

} sm_console_parameter_type; 

The parameter fields for the CONSOLE parameter are described as follows. 


code Identifies the CONSOLE parameter. sm_console (063) 

messages Indicates whether or not operator console 

messages are to be issued. 

sm_off (0) 

sm_on (1) 

7–6 7831 0687–010


Function 


The COPY parameter is an optional parameter that allows parameters to be accepted 

from more than one parameter table. It can be used for both sort and merge operations. 

Format 


{ 




} sm_copy_parameter_type; 

The parameter fields for the COPY parameter are described as follows. 


code Identifies the COPY parameter. sm_copy (070) 


contains the nested parameter table. 


format. 

The parameter table associated with the COPY parameter can be considered a nested 

parameter table. Processing of the current parameter table is suspending while the 

nested parameter table is processed. When the nested parameter table is completely 

processed, the parameter table that had processing suspended has processing resumed 

at the next parameter following the COPY parameter. 


Function 

The CORE parameter is used to specify the amount of memory that the sort operation is 

to use for sorting records. The memory can either be allocated by the user program or 

by the SORT subroutines. The CORE parameter is ignored for merge operations. 

Format 


{ 


unsigned size : 30; 


} sm_core_parameter_type; 

7831 0687–010 7–7


The parameter fields for the CORE parameter are described as follows. 


code Identifies the CORE parameter. sm_core (020) 

size Specifies the number of words of memory 

that the sort can use. If you are providing 

the memory area, you must make sure that 

the memory area is at least as large as this 

value. 

sm_address Contains a pointer to the memory area to 

be used for sorting records. 

An integer value in the range 

262,144 to 16,777,215. 

Address in SORT subroutine 

format or NULL. 

If the user program allocates the memory, sm_address is used to give the SORT 

subroutines the pointer to the memory. If you want the SORT subroutines to allocate 

the memory, sm_address must be the NULL pointer. 

The SORT subroutines always perform an extended mode sort when called through the 

UCS C program linkages. Therefore, if the core size specified is not consistent with a 

size required by an extended mode sort, the size is adjusted taking the MAXIMUM (see 

9.12) and MINIMUM (see 9.13) configuration parameters into consideration. If the core 

size specified is not consistent with a size required by an extended mode sort and a user 

core area is specified, an error status is returned. See 2.3, 10.2.1, and 10.2.2 for more 

information on extended mode sorts. 

If the CORE parameter is not specified, the core size is determined by the R$CORE file 

assignment (see 10.1). You must either specify a CORE parameter or use the R$CORE 

file assignment. 

7.3.5. DROC Parameter 

Function 

The DROC parameter tells the SORT subroutines to execute a user routine each time it 

is determined that two records have equal keys in a sort operation. When the DROC 

parameter is not specified, the order of the records with equal keys is undefined unless 

the PRESERVE parameter is specified. See 7.4.2 for data reduction routine coding 

considerations. The DROC parameter overrides the delete_dups bit in the OPTION 

parameter (see 7.3.12) and is ignored for merge operations. 

Format 


{ 




} sm_droc_parameter_type; 

7–8 7831 0687–010


The parameter fields for the DROC parameter are described as follows. 


code Identifies the DROC parameter. sm_droc (040) 


contains the data reduction routine function 

pointer. 


format. 

Function pointers in UCS C and the SORT subroutines are in different formats. A 

Sort/Merge macro is available that converts a UCS C function pointer into an address 

that the SORT subroutines can use. The macro is described as follows: 

sm_function_ptr_conversion (data_reduction_lve, data_reduction_pointer); 

where 

data_reduction_lve 

is a pointer to the storage area that will contain the converted function pointer. 

Declare this storage area using the Sort/Merge typedef sm_link_vector_entry_type. 

data_reduction_pointer 

is the function pointer of the data reduction routine. 

Example 

/* Declare the variable that will contain the data reduction routine address 

in the parameter table. */ 

sm_link_vector_entry_type droc_lve; 

void droc_routine( ); 

struct { ... 

sm_droc_parameter droc_parameter; 


/* Convert the function pointer and move it to droc_lve. Fill in the fields 

of the DROC parameter. */ 

sm_function_ptr_conversion(droc_lve, droc_routine); 

prm_tbl.droc_parameter.code = sm_droc; 

prm_tbl.droc_parameter.sm_address = sm_ptr_conversion(droc_lve); 

/* Declaration of the data reduction routine. */ 

#pragma interface droc_routine 

void droc_routine(void *record_one, void *record_two, int *droc_result) {...} 

7831 0687–010 7–9


7.3.6. END Parameter 

Function 

Indicates the end of the parameter table to the SORT subroutines. Each parameter table 

is required to have the END parameter as its last entry. 

Format 


{ 



} sm_end_parameter_type; 

The parameter fields for the END parameter are described as follows. 


code Identifies the END parameter. sm_end (071) 

7.3.7. FILES Parameter 

Function 

The FILES parameter is used to list the names of the scratch files to be used by the 

SORT subroutines during a sort operation. The SORT subroutines do not assign these 

scratch files so the files must be assigned to the run prior to calling the UCS C Sort Open 

Linkage. If any scratch files are assigned to the run, at least 3 files must be assigned, 

with a maximum of 26. If any of the scratch files are not assigned to the run, those files 

are ignored and the sort operation will proceed using only those files that are assigned to 

the run. Giving the SORT subroutines scratch files indicates that a disk sort (see 10.2.2) 

is to be performed. The FILES parameter is ignored by the merge operation. 

Format 


{ 


unsigned number_of_files : 6; 

unsigned character_type : 6; 



} sm_files_parameter_type; 

7–10 7831 0687–010


The parameter fields for the FILES parameter are described as follows. 


code Identifies the FILES parameter. sm_files (023) 

character_type Indicates the character type of the file 

names. 

sm_ascii (1) 

number_of_files Indicates how many files exist. An integer value in the range 1 

to 26. 


holds the file names. 


format. 

The format of the storage area that contains the file names is assumed to be an array of 

number_of_files character strings, each 12 characters in length. Also, each file name is 

assumed to be left-justified and space-filled when it is less than 12 characters in length. 

7.3.8. INFO Parameter 

Function 

The INFO parameter allows the SORT subroutines to pick up predefined, additional 

information. The INFO parameter is used only internally by Unisys. 

Format 


{ 


unsigned type : 6; 

unsigned version : 6; 



} sm_info_parameter_type; 

The parameter fields for the INFO parameter are described as follows. 


code Identifies the INFO parameter. sm_info (022) 

type Specifies the type of information contained 

in the associated storage area. 

version Specifies the version of the information 

contained in the associated storage area. 


contains additional information for the 

SORT subroutines. 

An integer value in the range 0 

to 63. 


to 63. 

Address in SORT subroutine 

format. 

7831 0687–010 7–11



Function 

The KEY parameter specifies a key field for a sort or merge operation. The KEY 

parameter has no effect when the COMP parameter is specified. Your sort or merge 

operation requires either a COMP or KEY parameter. 

Format 

typedef struct { unsigned code :6; 

unsigned key_type :6; 

unsigned order :6; 

unsigned start_bit :6; 

unsigned field_number :12; 

unsigned code_1 :6; 

unsigned reserved_1 :6; 

unsigned key_subtype :6; 

unsigned bit_count :18; 

unsigned code_2 :6; 

unsigned reserved_2 :12; 

unsigned start_word :18; 

} sm_key_parameter_type; 

The parameter fields for the KEY parameter are described as follows. 


code Identifies the KEY parameter. sm_key (03) 

key_type Indicates the key type. See Section 11 

for a complete explanation of key types. 

sm_a (06), sm_b (07), 

sm_d (011), sm_g (014), 

sm_i (016), sm_j (017), 

sm_l (021), sm_m (022), 

sm_p (025), sm_q (026), 

sm_r (027), sm_s (030), 

sm_t (031), sm_u (032), 

sm_v (033), sm_date (040) 

order Indicates the order of the key. sm_ascending (06), 

sm_descending (011) 

start_bit Specifies the most significant bit of the 

key field within the first word of the key. 

The most significant bit position is 1; the 

least significant is 36. 


1 to 36. 

7–12 7831 0687–010



field_number Indicates the significance of the key field, 

1 identifying the most significant or major 

key field and 64 identifying the least 

significant key field. If one key field 

specifies a field number, all key fields 

must specify field numbers. Use 0 when 

field numbers are not being used, in 

which case the order of significance is the 

order in which the keys are specified. 

code_1 Identifies the continuation of the KEY 

parameter. 


0 to 64. 

sm_continuation (077) 

key_subtype Identifies the subtype of an I key type. sm_include_trailing_spaces 

(0) sm_ignore_trailing_spaces 

(1) 

bit_count Specifies the number of bits in the key 

field. 

code_2 Identifies the continuation of the KEY 

parameter. 

start_word Specifies the start word of the key field. 

The first word position of a record is 0. 


1 to 262,143. 

sm_continuation (077) 

An integer in the range 0 to 

65,535. 

If you do not know the start word, start bit, and bit count of the key but know the start 

character and the character count, a set of Sort/Merge macros is available to determine 

these key field values. The macros are described as follows: 

sm_start_char_to_start_word(start_character, key_type) 

sm_start_char_to_start_bit(start_character, key_type) 

sm_char_count_to_bit_count(character_count, key_type) 

where 

start_character 

is an integer specifying the start character of the key. The first character position of 

a record is 1. 

character_count 

is the number of characters in the key. 

key_type 

is the key field type. 

7831 0687–010 7–13


Example 

/* Declare the parameter table. */ 

struct { ... 

sm_key_parameter key_parameter; 


/* Fill in the fields of the KEY parameter. Assume the key field starts with the 5th 

character of the record and is 20 characters in length. */ 

prm_tbl.key_parameter.code = sm_key; 

prm_tbl.key_parameter.key_type = sm_s; 

prm_tbl.key_parameter.order = sm_ascending; 

prm_tbl.key_parameter.field_number = 0; 

prm_tbl.key_parameter.code_1 = sm_continuation; 

prm_tbl.key_parameter.code_2 = sm_continuation; 

prm_tbl.key_parameter.start_word = sm_start_char_to_start_word(5, sm_s); 

prm_tbl.key_parameter.start_bit = sm_start_char_to_start_bit(5, sm_s); 

prm_tbl.key_parameter.bit_count = sm_char_count_to_bit_count(20, sm_s); 


Function 

The LOCALE parameter specifies the desired locale for the sort or merge operation. 

Only one LOCALE parameter should be specified. If an international sort or merge is 

requested (with the presence of an I key) and a LOCALE parameter is not specified, the 

locale currently in force will be used for the sort or merge operation. 

Format 


{ 


unsigned locale_name_length : 6; 



} sm_locale_parameter_type; 

The parameter fields for the LOCALE parameter are described as follows. 


code Identifies the LOCALE parameter. sm_locale (025) 

locale_name_length Specifies the character length of the 

locale name. 

sm_address Contains a pointer to a storage location 

that contains the locale name. 


to 16. 


format. 

7–14 7831 0687–010


Function 


The LOG parameter is an optional parameter that indicates to the SORT subroutines 

whether or not normal sort completion messages should be issued to the run log. If 

specified, it overrides the LOG configuration parameter (see 9.11). If this parameter is 

not specified, the LOG configuration parameter takes effect, if present. Otherwise, 

normal sort completion messages are issued. See A.3 for a list of sort messages that 

are written to the system log file. 

Format 


{ 



unsigned messages : 6; 

} sm_log_parameter_type; 

The parameter fields for the LOG parameter are described as follows. 


code Identifies the LOG parameter. sm_log (065) 

messages Indicates whether or not log messages are 

to be issued. 

7.3.12. OPTION Parameter 

Function 

sm_off (0) 

sm_on (1) 

The OPTION parameter tells the SORT subroutines general information to perform 

specific actions. 

Format 


{ 


unsigned reserved_1 : 26; 

unsigned delete_dups : 1; 

unsigned rdms_caller : 1; 

unsigned reserved_2 : 1; 

unsigned no_p_option : 1; 

} sm_option_parameter_type; 

7831 0687–010 7–15


The parameter fields for the OPTION parameter are described as follows. 


code Identifies the OPTION parameter. sm_option (067) 

delete_dups Indicates whether or not duplicate records 

are to be deleted by the SORT subroutines. 

This setting is ignored when the DROC 

parameter or PRESERVE parameter is 

specified. 

rdms_caller Reserved for Unisys internal use. 

no_p_option Indicates whether or not the P option is to 

be suppressed at execution time. 

Execution time parameters are not available 

when using the UCS C program linkages. 

sm_no (0) 

sm_yes (1) 

sm_no (0) 

sm_yes (1) 

You can use the OPTION parameter multiple times for the same sort or merge operation 

without destroying or overriding the effects of the previous option settings. 

7.3.13. PAD Parameter 

Function 

The PAD parameter is an optional parameter that reserves space in the parameter table. 

Format 


{ 



} sm_pad_parameter_type; 

The parameter fields for the PAD parameter are described as follows. 


code Identifies the PAD parameter. sm_pad (072) 


Function 

The PRESERVE parameter determines the output order of records that have equal keys. 

When the PRESERVE parameter is specified, records with equal keys are returned in the 

order in which they were released to the SORT subroutines. The PRESERVE parameter 

overrides the delete_dups bit in the OPTION parameter (see 7.3.12) and is ignored for 

the merge operation. 

7–16 7831 0687–010

Format 



{ 



} sm_preserve_parameter_type; 

The parameter fields for the PRESERVE parameter are described as follows. 


code Identifies the PRESERVE parameter. sm_preserve (05) 


Function 

The RSZ parameter is used to specify the size of records being sorted or merged. When 

sorting variable-length records, the size specified is the maximum length of the record. 

Every sort or merge operation must specify a record size. 

Format 

typedef struct { 


unsigned size_type : 6; 


} sm_rsz_parameter_type; 

The parameter fields for the RSZ parameter are described as follows. 


code Identifies the RSZ parameter. sm_rsz (1) 

size_type Indicates that the size is either a count of 

words, 6-bit fields, 9-bit fields, or 1-bit 

fields. 

size Specifies the maximum length of a record 

in size_type terms. 

sm_word (0) 

sm_6bit (1) 

sm_9bit or sm_char (2) 

sm_bit (3) 

An integer in the range 1 to 

16,777,215. 

7831 0687–010 7–17



Function 

The SEQ parameter is an optional parameter that specifies a collating sequence table 

that the SORT subroutines are to use when determining the order of records from values 

contained in the key fields (see 7.3.9). This parameter, when specified, is used by both 

the sort and merge operations. This parameter has no effect when the COMP 

parameter is specified. 

Format 


{ 


unsigned table_type : 6; 



} sm_sequence_parameter_type; 

The parameter fields for the SEQ parameter are described as follows. 

Parameter Field Parameter Field Description Parameter Field Value 

code Identifies the SEQ parameter and the length 

in words of the collating sequence table. 

table_type Indicates which collating sequence table 

type is to be used. See Table 7–2 for a 

description of table types. 

sm_address Contains a pointer to a storage location that 

contains the collating sequence table when 

the table_type fields equal sm_user_defined; 

otherwise, this field is ignored. 

sm_seq_64 (4) 

sm_seq_128 (7) 

sm_seq_256 (024) 

sm_user_defined (0) 

sm_fieldata (1) 

sm_ascii_128 (2) 

sm_ascii_256 (3) 

sm_ebcdic_256 (4) 

sm_katakana_256 (5) 


format. 

7–18 7831 0687–010


Table 7–2 describes the table sequence of each table type. 

Table 7–2. Collating Sequence Table Types 

Table Type Explanation of Table Sequence 

sm_user_defined A 64–, 128–, or 256–word user-created sequence table. The address of 

the table is given to the SORT subroutines by using the sm_address field. 

The format of the table must have one word representing one character 

with the octal representation of the character contained in H2 of the 

word. 

sm_fieldata A 64-word Fieldata sequence table supplied by Sort/Merge that is used 

with all type A keys. The sequence is space, letters, numbers, followed 

by all special characters starting with 0 and ending with 077 octal. 

sm_ascii_128 A 128-character sequence table supplied by Sort/Merge for use with all 

type S keys. The sequence is space, letters (A,a,B,b,...,Z,z), and 

numbers, followed by all special characters from 0 to 0177 octal. 

sm_ascii_256 A 256-character sequence table supplied by Sort/Merge used with all 

type S keys. The sequence is the same as for sm_ascii_128 except that 

the last character is 0377 octal. 

sm_ebcdic_256 A 256-character sequence table supplied by Sort/Merge used by all type 

S keys. The sequence follows the EBCDIC collating sequence. 

sm_katakana_256 A 256-character sequence table supplied by Sort/Merge used by all type 

S keys. The sequence is the normal katakana character sequence. 

7.3.17. START Parameter 

Function 

Indicates the start of the parameter table to the SORT subroutines. This parameter is 

required to be the first parameter in every parameter table used by both the sort and 

merge operations. 

Format 


{ 


unsigned version : 6; 


} sm_start_parameter_type; 

7831 0687–010 7–19


The parameter fields for the START parameter are described as follows. 


code Identifies the START parameter. sm_start (00) 

version Indicates the parameter table version. 1 

7.3.18. VOL Parameter 

Function 

The VOL parameter tells the SORT subroutines approximately how many thousands of 

records are to be sorted. This parameter is only used for sort operations when a disk 

type sort (see 10.2.2) is being performed. 

Format 


{ 


unsigned thousands_of_records : 30; 

} sm_vol_parameter_type; 

The parameter fields for the VOL parameter are described as follows. 


code Identifies the VOL parameter. sm_vol (064) 

thousands_of_records Specifies the record count in 

thousands of records. 

7.3.19. VRSZ Parameter 

Function 

An integer value in the range 1 to 

1,073,741,823. 

The VRSZ parameter is used to specify that variable-length records are being sorted and 

to specify the minimum link size of the input records. If you are using the KEY 

parameter, the key must be contained within the first link. If you are using the COMP or 

DROC parameters, only the first link of the record can be accessed by the user routine. 

See 10.3 for variable-length record efficiency considerations. The VRSZ parameter is 

ignored for merge operations. 

7–20 7831 0687–010

Format 



{ 


unsigned size_type : 6; 


} sm_vrsz_parameter_type; 

The parameter fields for the VRSZ parameter are described as follows. 


code Identifies the VRSZ parameter. sm_vrsz (2) 

size_type Indicates that the size is either a count of 

words, 6-bit fields, or 9-bit fields. 

size Specifies the minimum acceptable length 

of a link in size_type terms. All keys must 

be defined within this size. 

sm_word (0) 

sm_6bit (1) 

sm_9bit or sm_char (2) 

sm_bit(3) 

An integer in the range 

1 to 16,777,215 

7.4. User Routine Substitution Considerations 

One of the more powerful features of the Sort/Merge product is its ability to support the 

substitution of your routines for certain Sort/Merge functions. This ability gives you 

greater control over the Sort/Merge process, allowing you to do the following: 

• Determine your own comparison criteria 

By writing and substituting your own comparison routine, you can perform 

comparisons based on criteria different from those normally used by the SORT 

subroutines. 

• Determine how duplicate records are processed 

You can write and substitute the SORT subroutine duplicate record processing with 

a routine that changes what normally occurs when two records being compared are 

found to have equal keys. 

The following describes specific coding considerations you should know when writing 

and substituting your routines for certain SORT functions. 

7831 0687–010 7–21


7.4.1. User Compare Code 

You can write your own compare routine to perform a comparison based upon criteria 

that are different from those normally used by the SORT subroutines. To give control to 

your compare routine, specify the COMP parameter with the address of your routine. 

See the COMP parameter in 7.3.1. 

The interface between the SORT subroutines and a user compare routine when using 

the UCS C program linkages is defined as follows: 

• The SORT subroutines call the UCS C user routine with three parameters, passed by 

reference. The parameters are 

− The address of the first of two records 

− The address of the second of two records 

− The address of a one-word storage area provided by the SORT subroutines that 

the user routine will fill in with the result value 

Result of Compare 

Result Parameter 

Value 

(record one) precedes (record two) 0 

(record one) follows (record two) 1 

(record one) equals (record two) 2 

• The user compare routine does not return a function value. 

An example declaration of a user-provided compare routine is as follows: 

#pragma interface user_comp 

void user_comp(void *record_one, void *record_two, int *comp_result) 

{ 

enum result_value { one_precedes_two, /* 0 */ 

one_follows_two, /* 1 */ 

one_eq_two, /* 2 */ 

error=262144}; /* force a full-word enum value */ 

enum result_value *result_ptr = (enum result_value *) comp_result; 

. . . 

} 

By default, UCS C pointer and array parameters are not compatible with non-UCS C 

reference parameters. The pragma interface allows passing object pointer and array 

parameters to UCS C from non-UCS C reference parameters. 

7–22 7831 0687–010


7.4.2. User Duplicate Record Code 

You can write a subroutine that changes what occurs when two records being compared 

are found to be equal (that is, duplicate records). You can do the following: 

• Delete the duplicate record 

• Combine the two records 

• Leave the records as they are 

When you write a data reduction routine, you specify what to do with duplicate records. 

To give control to your data reduction routine, specify the DROC parameter with the 

address of your routine. See the DROC parameter in 7.3.5. 

The interface between the SORT subroutines and the data reduction routine when using 

the UCS C program linkages is defined as follows: 

• The SORT subroutines call the user UCS C routine with three parameters, passed by 

reference. 

− The address of the first of two records 

− The address of the second of two records 

− The address of a one-word storage area provided by Sort/Merge that the user 

routine will fill in with the result value 

Result of Data Reduction 

Result Parameter 

Value 

No action 0 

(Record one) is optionally altered and 

(record two) is deleted 

• The user data reduction routine does not return a function value. 

An example declaration of a user-provided data reduction routine is as follows: 

#pragma interface user_droc 

void user_droc(void *record_one, void *record_two, int *droc_result) { 

enum result_value { no_change, /* 0 */ 

record_deleted, /* 1 */ 

error=262144}; /* force a full-word enum value */ 

enum result_value *result_ptr = (enum result_value *) droc_result; 

. . . 

} 

By default, UCS C pointer and array parameters are not compatible with non-UCS C 

reference parameters. The pragma interface allows passing object pointer and array 

parameters to UCS C from non-UCS C reference parameters. 

7831 0687–010 7–23 

1


7–24 7831 0687–010

Section 8 

SORT Subroutine Linkages for UCS C 

Programs 

This section describes the Universal Compiling System (UCS) C linkages you use to call 

the SORT subroutines from a UCS C program. 

When you use the UCS C program linkages, the common bank SORT subroutines are 

accessed. You must install Sort/Merge with Software Library Administrator (SOLAR) 

using an installation mode that makes the common bank SORT subroutines available 

before the UCS C program linkages can be used. 

8.1. UCS C File Inclusion Element 

A Sort/Merge element must be included into your program that contains definitions that 

will assist in using the UCS C linkages. The element is included into your program as 

follows: 

#include 

This element contains 

• Function prototypes for the UCS C linkages 

• A typedef of the record information packet and constant definitions for some field 

values 

• A typedef of the result status and constant definitions for some field values 

The naming convention used by identifiers in sm$defs.h is to begin each definition or tag 

name with sm_ to indicate that the identifier is a Sort/Merge identifier. Structure 

member names, union member names, and function names do not necessarily follow 

this naming convention. All names are in lowercase except function names, which are in 

uppercase. 

7831 0687–010 8–1

SORT Subroutine Linkages for UCS C Programs 

8.2. UCS C Program Linkage Parameters 

The SORT subroutines and the user UCS C program communicate by using function 

parameters. A description of each function parameter follows. See 8.4 and 8.5 for 

descriptions of how to call UCS C linkages. 

8.2.1. Result Status Parameter 

The function calls to the UCS C program linkages do not return function values. Instead, 

each UCS C linkage has a result status parameter. The user program is required to 

allocate a variable for the result status parameter. The result status is defined by the 

Sort/Merge typedef sm_result_status_type and is described by the following: 

Format 


{ 

unsigned severity : 3; 

unsigned component_id : 15; 

unsigned message_id : 18; 

} sm_result_status_type; 

where 

severity 

indicates the severity of the condition detected. The possible values are listed in 

Table 8–1. 

Severity 

Code 

Severity Class 

Table 8–1. Severity Code Values 

Explanation 

0 Success The requested operation completed successfully (constant 

definition: sm_success). 

2 Informational The requested operation completed normally but some 

additional information such as end of data is being 

returned (constant definition: sm_informational). 

3 Warning The requested operation performed an action that it 

determined the caller requested. If the caller did not 

intend for this action to occur, the current operation must 

be restarted to correct the situation. If the caller intended 

this action to occur, the operation can continue. The 

action taken, such as padding a record, should be 

harmless (constant definition: sm_warning). 

8–2 7831 0687–010

Severity 

Code 

Severity Class 


Table 8–1. Severity Code Values 

Explanation 

5 Minor The requested operation performed an action that it 

determined the caller requested. The action taken, such 

as truncating a record, could be detrimental to the 

operation or the data. If the caller did not intend for this 

action to occur, the current operation must be restarted to 

correct the situation. If the caller intended this action to 

occur, the operation can continue (constant definition: 

sm_minor). 

6 Major A situation has been encountered that prevents the 

requested call from continuing without being corrected. 

The caller can attempt to correct the situation and perform 

the call again. The operation is in a state that can be 

resumed (constant definition: sm_major). 

7 Failure A situation has been encountered that prevents the 

requested call and operation from continuing. The caller 

cannot resume this operation and the operation must be 

closed. The caller must restart the operation from the 

beginning (constant definition: sm_failure). 

If the SORT subroutines encounter more than one situation that results in the setting 

of the result status parameter, only the most severe will be returned. All major or 

failure severity errors are returned immediately. 

component_id 

is the assigned Extended Language Message System (ELMS) code for Sort/Merge. 

This code is LSM (053626 octal, 22422 decimal) and is always set. 

Note: Sort/Merge is currently not using the ELMS, but has an assigned 

component_id and is setting it to maintain compatibility if ELMS is used in the future. 

message_id 

The message_id field of the result status parameter contains the message identifier 

of the condition returned. It should be noted that messages that are not issued 

from basic mode are not printed at this time; only the status is returned. If Sort 

implements an ELMS interface, the message could be printed if requested by the 

caller. The possible values are as follows. 

Message_Id Value Description 

0 No errors were detected (constant definition: sm_ok). 

Nonzero SORT subroutines error code (see A.2) 

0777776 With a severity of informational, indicates that all records have been 

returned (constant definition: sm_eof). 

7831 0687–010 8–3


The SORT subroutines always set the result status. By testing the result status, the 

calling program can determine whether or not the SORT subroutines call was successful. 

8.2.2. D-Bank Address Parameter 

The d-bank address parameter is the address of a one-word storage area in the user 

program. The SORT subroutines open linkages fill in this word of storage with a value 

that identifies the storage area allocated by the SORT subroutines. Each subsequent call 

to the SORT subroutines for the same sort or merge operation must pass the identifier 

to the SORT subroutines so the sort or merge operation can be continued correctly. 

8.2.3. Parameter Table Parameter 

The sort or merge operation is defined by the parameter entries in the parameter table. 

Subsection 7.3 describes the parameter table in detail. The parameter table address 

parameter gives the address of a storage area that contains the user-created parameter 

table. 

8.2.4. Record Information Packet Parameter 

The UCS C linkages that transfer records to or from the SORT subroutines have four or 

five parameters: a result status, a dbank address, a record information packet, and one or 

two record virtual addresses to handle the transfer. The user program must allocate 

storage for the record information packet and for the record areas and pass the address 

of the record information packet and the addresses of the record areas as parameters. 

When transferring data to the SORT subroutines, the user puts record information in the 

record information packet and data in the record area. When the data is transferred back 

to the user program, the SORT subroutines put record information in the record 

information packet and the data in the record area. The record information packet and its 

fields are described on the pages that follow. 

8.2.4.1. Record Information Packet Definition 

The structure of the record information packet (version 1) is illustrated in Figure 8–1. 

Figure 8–1. Record Information Packet Version 1 Structure 

8–4 7831 0687–010


The structure of the record information packet (version 2) is illustrated in Figure 8–2. 

Version 2 is the current version of the record information packet and was first defined in 

SORT 20R1. 

Figure 8–2. Record Information Packet Version 2 Structure 

The UCS C definition of the current version of the record information packet is found in 

the header element sm$defs/h. This definition can be used to pass either version of the 

record information packet. The record information packet version 2 is defined by the 

Sort/Merge typedef sm_record_packet_type and is described in the following format. 

Format 

typedef struct { unsigned version:9; 

unsigned reserved_1:3; 

unsigned buffer_gran:3; 

unsigned record_gran:3 

unsigned type:9; 

unsigned subtype:9; 

unsigned record_length; 

unsigned buffer_length; 

unsigned file_id:18; 

unsigned reserved_2:18; 

unsigned number_of_records; 

union { unsigned pad_word; 

char pad_word_char[4]; } 

unsigned reserved_3; 





unsigned reserved_8; } sm_record_packet_type; 

7831 0687–010 8–5


8.2.4.2. Record Information Packet version Field 

The record information packet version field indicates the format of the record information 

packet. Prior to SORT 20R1 the only valid value for the version field was 1. The bulk 

interface introduced in SORT 20R1 increased the size of the record information packet 

with a new field defined in the expanded area. Thus, 2 is a valid value for the version 

field, indicating that an expanded packet exists and that the field pad_word contains a 

meaningful value. A version field with a value of 1 is still valid, whether or not the bulk 

interface is being used, and indicates that the field pad_word does not exist. 

8.2.4.3. Record Information Packet buffer_gran Field 

The record information packet buffer_gran field defines the granularity (words, 6-bit 

characters, 9-bit characters [bytes], or bits) of the buffer_length field of the record 

information packet. Specific meaning of the various fields will be described in the 

appropriate interface subsections. 

8.2.4.4. Record Information Packet record_gran Field 

The record information packet record_gran field defines the granularity (words, 6-bit 

characters, 9-bit characters [bytes], or bits) of the record_length field of the record 

information packet. Specific meaning of the various fields will be described in the 

appropriate interface subsections. 

8.2.4.5. Record Information Packet type Field 

The record information packet type field identifies how records are being transferred on 

calls to the SORT subroutines UCS C Sort Release, UCS C Sort Return, UCS C Merge 

Release, and UCS C Merge Request linkages. The valid values for the record 

information packet type field, when passing records to and from the SORT subroutines, 

are summarized in Table 8–2. 

Value 

Table 8–2. Record Information Packet Type Field Values 

UCS C Defined 

Constant Values 

Explanation 

0 sm_single_record A single record at an address in memory. 

1 sm_blocked_records A buffer of records formatted as described by the 

subtype field, located at an address in memory. 

None of the 

above 

Error situation. 

The record information packet type field only pertains to the particular call to the linkage 

where it is set. Subsequent calls to the same linkage or a different linkage within the 

same sort operation may have a different type field specified. The record information 

packet subtype field (see 8.2.4.6) further identifies the format of the records being 

passed. The valid formats for records in a record buffer are identified in 8.3. For a 

merge operation only single record interfaces are valid. 

8–6 7831 0687–010

8.2.4.6. Record Information Packet subtype Field 


The subtype field provides additional information about the record. Since the bulk 

interface supports different ways of formatting records within the buffer, the record 

information packet subtype field is used to indicate to the SORT subroutines the format 

of the records within the buffer. When the UCS C Sort Release Linkage is called, the 

SORT subroutine accepts records from the buffer in the format specified by the subtype 

field. When the UCS C Sort Return Linkage is called, the SORT subroutine formats 

records in the buffer according to the value specified in the subtype field. 

When the record information packet type field is sm_single_record, the only valid value 

for the subtype field is sm_single_record. 

Table 8–3 summarizes the valid values of the record information packet subtype field 

when passing a record buffer to and from the SORT subroutines (type field equals 

sm_blocked_records). 

Table 8–3. Record Information Packet Subtype Field Values When Type 

Field Equals 1 

Value 

UCS C Defined 

Constant Values 

Explanation 

0 sm_fixed_records The buffer at record_address parameter is a 

fixed record buffer format (see 8.3.1). 

1 sm_variable1_records The buffer at record_address parameter is a 

variable1 records buffer format (see 8.3.2). 

2 sm_variable2_records The buffer at record_address parameter is a 

variable2 records buffer format (see 8.3.3). 

None of the above Error situation. 

The record information packet subtype field is only effective for the duration of the call to 

the release or return linkage and does not have to be the same for all calls to the release 

and return linkages for the same sort operation. For example: 

• Records may be released to the sort operation using one format and then returned 

using a different format. 

• Some records may be released to the SORT subroutines in a fixed records format, 

whereupon additional records could be released in a variable1 records formatted 

buffer and the records returned in a variable1 records formatted buffer format. 

Almost any combination of record information packet subtype field values are allowed on 

individual calls to the SORT subroutines. However, the records can be padded or 

truncated, as necessary, if all records are not released and returned in the same format. 

To ensure the correct format, a variable2 records formatted buffer can be returned only if 

all records were released via a variable2 records formatted buffer and no record padding 

or record truncation occurred. 

7831 0687–010 8–7


8.2.4.7. Record Information Packet record_length Field 

The record_length field in the record information packet contains an integer in the range 

of 1 to 07777777777 (2**30–1 = 1,073,741,823). When one record at a time is 

released, this field contains the length of the record in terms of the record_gran field. 

When a single record is returned, this field contains the length of the record returned in 

terms of the record_gran field. When releasing and returning a fixed records formatted 

buffer, this field contains the record length in terms of the record_gran field of each 

record in the fixed records formatted buffer. This field has no meaning when a variable1 

records formatted buffer or a variable2 records formatted buffer is released or returned. 

Upon return from the call to the UCS C Sort Release Linkage, this field may be altered 

from its input state when the type field of the record information packet indicates 

sm_blocked_records. Additional information about the entry and exit conditions of the 

record_length field is stated when describing each UCS C Sort or Merge Linkage (see 

8.4 and 8.5). 

8.2.4.8. Record Information Packet buffer_length Field 

The buffer_length field in the record information packet contains an integer in the range 

of 1 to 07777777777 (2**30–1 = 1,073,741,823). When a single record or any format of 

a buffer is returned, this field must be set to the length of the area pointed to by the 

record_address parameter of the UCS C Sort Return Linkage or the out_record_address 

of the UCS C Merge Request Linkage. Upon the return from the call to the UCS C Sort 

Return Linkage for any format of a record buffer, this field contains the length of the data 

inserted into the buffer by the SORT subroutines. The buffer_gran field defines the 

granularity of the length contained in this field. 

When releasing any format of a record buffer with UCS C Sort Release Linkage, this field 

must contain the length of the data contained in the buffer being released. The field 

should not contain the maximum length of the buffer. If the number_of_records field in 

the record information packet is provided when releasing any format of a buffer, this field 

must contain a value in the range: 

length of data in buffer


8.2.4.10. Record Information Packet pad_word Field 

The pad_word and pad_word_char fields in the record information packet define a field 

that contains the integer or characters respectively that the SORT subroutines should 

use to pad records. Throughout this guide pad_word will be used when referencing this 

field. The pad_word field exists only when the version field of the record information 

packet has a valid value other than 1 (currently the only other valid value is 2). The 

pad_word field is valid for both sm_single_record and sm_blocked_records record 

transfers. 

8.2.5. Record Address Parameter 

The UCS C linkages that transfer records to or from the SORT subroutines have one or 

two record address parameters. When releasing records to the SORT subroutines, the 

record address parameter contains the address where the SORT subroutines can find 

the record or record buffer. When records are returned from the SORT subroutines, the 

record address parameter contains the address of a user-allocated storage area where 

the SORT subroutines will place the returned record or records. The storage area 

associated with the record for address parameter must be at least as large as the size 

indicated in the buffer_gran and buffer_length fields of the record information packet. 

8.3. Bulk Interface 

The SORT bulk interface provides the capability to pass a buffer or block of records 

between a user program and the SORT subroutines. Prior to SORT 20R1, the SORT 

interface required a separate call for each record. To use the bulk interface feature, a 

sort operation must be invoked using the SORT subroutines UCS C Sort Release Linkage 

or the UCS C Sort Return Linkage. A buffer cannot be passed from the Basic Mode 

MASM linkages or any UCS C Merge Linkages. 

The bulk interface supports different ways of formatting records within the buffer. The 

formatting of the records in the buffer is indicated by the setting of the subtype field of 

the record information packet as described in “Record Information Packet subtype 

Field”. The following subsections describe in detail the buffer formats. All buffer 

formats require that only complete records be passed in a buffer. A record cannot begin 

in one buffer and then the remaining part of the record be passed in the next buffer. 

Also, in all buffer formats the records are packed into the buffer with no padding or 

space between records. The last bit of a record is immediately followed by the first bit 

of the next record. Thus, depending upon the length of the records, some or all of the 

records in the buffer may not be aligned to a word or character boundary. The 

illustrations of the buffer formats that follow may look as through the records are word 

aligned, but that is not the case unless the buffer begins on a word boundary and the 

length of all records are a multiple of a word. 

7831 0687–010 8–9


8.3.1. Fixed Records Buffer Format 

The fixed records buffer format is used when the subtype field of the record information 

packet is sm_fixed_records and the type field of the record information packet is 

sm_blocked_records. Either a fixed length record sort or variable length record sort can 

use the fixed records buffer format as the record transfer format. However, the records 

in the buffer must be fixed length (that is, all the records in the buffer are the same 

length). The length of the records in the fixed records buffer format is defined by the 

record_gran and record_length fields of the record information packet. 

Format 

There is no record control information in the fixed records buffer format. This means 

that based on the record_gran and record_length fields passed in the record information 

packet, SORT may need to pad or truncate records depending on how the record length 

compares to other information passed to SORT (for example, record size in the 

parameter table). If padding must take place, the value of the pad_word field of the 

record information packet is used if the record information packet version field is two. If 

the record information packet version field is 1, then ASCII spaces are used for any 

necessary padding. When padding occurs using pad_word or a word of ASCII spaces, 

the padding will occur beginning with the bit of the pad word following the last bit of the 

record when the record has been word aligned. Figure 8–3 illustrates the structure of 

the fixed records buffer format. 

Figure 8–3. Fixed Records Buffer Format 

8–10 7831 0687–010

8.3.2. Variable1 Records Buffer Format 


This subsection describes the variable1 records buffer format. Either a fixed length sort 

or a variable length sort can have records transferred by the variable1 records buffer 

format. 

Format 

This format allows records of different lengths to exist in a buffer. The length of each 

record is defined in a record control word (RCW) that precedes the record. The length of 

the record does not include the RCW. When the records are passed to the SORT 

subroutines, the RCW is not passed; thus, word 0 of the sort internal record is the word 

immediately following the RCW. When the caller requests that a variable1 records 

buffer format be returned, the SORT subroutines insert the RCW followed by the record. 

Figure 8–4 illustrates the variable1 records buffer format. 

Figure 8–4. Variable1 Records Buffer Format 

Figure 8–5 illustrates the format of the record control word (RCW) for the variable1 

records buffer format. 

Figure 8–5. Variable1 Records RCW Format 

7831 0687–010 8–11


Table 8–4 describes the fields with a special meaning for a variable1 records buffer 

format. 

Table 8–4. Variable1 Records Buffer Fields 

Item Releasing Records Returning Records 

RCW granularity 

Set by the caller. Contains the 

granularity of the RCW record length 

field. Valid value for this field are: 

0 – Words 

1 – 6-bit characters 

2 – 9-bit characters (bytes) 

3 – Bits 

RCW record length Set by the caller. Contains the length 

of the record not including the 

record control word in terms of the 

RCW granularity field. 

8.3.3. Variable2 Records Buffer Format 

Set by the SORT subroutines. 

Contains the granularity of the 

RCW record length field. Valid 

value for this field are: 

0 – Words 

1 – 6-bit characters 

2 – 9-bit characters (bytes) 

3 – Bits 

Set by the SORT subroutines. 

Contains the length of the record 

not including the record control 

word in terms of the RCW 

granularity field. 

This subsection describes the variable2 records buffer format. A variable2 records buffer 

format is used when the subtype field of the record information packet is 

sm_variable2_records and the type field is sm_blocked_records. The variable2 records 

buffer format transfer method is another method for passing records of varying length. 

It is similar to the variable1 records buffer format and can be used for either a fixed 

length record sort or a variable length record sort. 

Format 

This method requires that the length of the record to be located in bits 18-35 of word 0 

of each record, and that the record_gran field of the record information packet defines 

the granularity of record length for all records in the buffer. In other words the record 

control word (RCW) is part of the record. When records are passed to the SORT 

subroutines, the RCW is also passed; thus, word 0 of the sort internal record is the word 

containing the record length. When a variable2 records buffer format is requested to be 

returned, the format requires that the records contain the RCW. To ensure that all 

records meet this criteria, the variable2 records buffer format can be returned only when 

all records were released via a variable2 records buffer format, the same record_gran 

field value was specified for all release linkages, and no records were padded or 

truncated during the release linkages. In addition, the record_gran field specified on the 

return linkage must match the record_gran field of the release linkages. 

8–12 7831 0687–010


To avoid padding/truncating, a variable length record sort operation should be performed. 

These limitations avoid problems that require the insertion of a record control word or 

the alteration of the existing record length in word zero of the record. Figure 8–6 

illustrates the variable2 records buffer format. 

Figure 8–6. Variable2 Records Buffer Format 

7831 0687–010 8–13


8.4. UCS C Sort Program Linkages 

The five following sort functions are available to perform a sort operation: 

• Open the sort operation. 

• Release records to the sort. 

• End input of records and start the sort. 

• Retrieve sorted records from the sort. 

• Close the sort before all records are retrieved. 

From a UCS C program, you can perform these sort functions by using the UCS C sort 

linkages. Descriptions of the SORT subroutines UCS C sort program linkages follow. 

8.4.1. UCS C Sort Open Linkage 

The sort open linkage initializes the SORT subroutines for the requested Sort operation. 

The sort open linkage must be the first linkage to the SORT subroutines for every sort 

operation and can be called only once per sort operation. 

Format 

SRTOPEN(&result_status, &dbank_address, &parameter_table); 


result_status 

is the address of a one-word storage area that will contain the status returned by the 

SORT subroutines (see 8.2.1). 

dbank_address 

is the address of a one-word storage area that will contain a value that uniquely 

identifies the newly opened sort operation (see 8.2.2). 

parameter_table 

is the address of a storage area that contains the parameter table that is used to 

define the sort operation (see 8.2.3). 


The storage area associated with result_status contains the status returned by the SORT 

subroutines. 

The storage area associated with dbank_address contains a value that uniquely identifies 

the sort operation. On subsequent calls to the SORT subroutines, this value is used to 

identify this sort operation. 

8–14 7831 0687–010

8.4.2. UCS C Sort Release Linkage 


The sort release linkage passes records to be sorted to the SORT subroutines. The UCS 

C SORT Release Linkage allows either a single record or a buffer of records to be passed 

to the SORT subroutines. 

Format 

SRTRELEASE(&result_status, &dbank_address, &record_information_packet, 

&record_address); 


result_status 

is the address of a 1-word storage area that contains the status returned by the 


dbank_address 

is the address of a 1-word storage area that contains the value assigned during the 

sort open phase, which uniquely identifies the sort operation (see 8.2.2). 

record_information_packet 

provides information about the data located at the record_address parameter (see 

8.2.4 and Table 8–5 for the required field definition). 

record_address 

is the address of the record or record buffer being passed to the SORT subroutines 

(see 8.2.5). 

Table 8–5. Sort Release Record Information Packet Input 

Field Field Purpose Valid Contents 

version Identifies the version of the 

record information packet. 

buffer_gran Identifies the granularity of the 

buffer_length field. 

record_gran Identifies the granularity of the 

record_length field. 

type Identifies whether the data 

located at record_address is a 

single record or a buffer. 

1 or 2 

0 – sm_word 

1 – sm_6bit 

2 – sm_9bit or sm_char 

3 – sm_bit 

0 – sm_word 

1 – sm_6bit 


3 – sm_bit 

0 – single record (sm_single_record) 

1– record buffer (sm_blocked_records) 

7831 0687–010 8–15


Table 8–5. Sort Release Record Information Packet Input 


subtype Identifies the format of data at 

record_address based upon the 

type field. 

record_length When the type field is 

sm_single_record, the length in 

terms of the record_gran field of 

the record at record_address. 

When the type field is 

sm_blocked_records and the 

subtype is sm_fixed_records, the 

length in terms of the record_gran 

field of each record in the record 

buffer. Otherwise, the field has 

no meaning. 

buffer_length When the type field is 

sm_blocked_records, the length 

in terms of the buffer_gran field 

of data contained in the record 

buffer at record_address. 

number_of_re 

cords 

If the type field is 

sm_blocked_records, this field 

states the number of records 

contained in the record buffer. 

This field is optional and overrides 

the buffer_length field. 

pad_word Defined only when the version 

field is 2. It defines the bit string 

that sort should use to pad 

records when required. 


When the type field is sm_single_record the 

only valid value is: 

0 – sm_single_record 

When the type field is sm_blocked_records 

the valid values are: 

0 – sm_fixed_records 

1 – sm_variable1_records 


1 to 07777777777 (2**30–1 = 

1,073,741,823) 

1 to 07777777777 (2**30–1 = 

1,073,741,823) 

0 to 07777777777 (2**30–1 = 

1,073,741,823) 

If 0, the buffer_length field must contain the 

length of data in the record buffer. If 

nonzero, the actual number of records in the 

record buffer and the buffer_length field 

must be set to a value where: 

length of data in buffer


Table 8–6. Sort Release Record Information Packet Exit Condition 

Field Return Value 

buffer_gran Identifies the granularity of the buffer_length field. This field may be 

changed from its input state. 

record_gran Identifies the granularity of the record_length field. This field may be 


record_length When the type field is sm_single_record, this field is not changed from its 

input state. When the result_status indicates that not all records have 

been released from the buffer, the record_length field contains the offset 

in the record buffer where processing stopped. When all records have 

been released from the buffer, this field may be changed from its input 

state. 

buffer_length When the type field is sm_single_record, this field is not used. When the 

type field is sm_blocked_records, this field contains the length of the 

buffer that was not processed in terms of the buffer_gran field. 

number_of_records When the type field is sm_blocked_records and this field was nonzero 

upon calling the UCS C Sort Release Linkage, this field is set to the input 

value minus the number of records processed. 

Padding Situations 

When records are released to the SORT subroutines by the UCS C Sort Release Linkage, 

some records may require padding. If padding is required, the value contained in the 

pad_word field of the record information packet is used when the version field of the 

record information packet is 2. If the version field is 1, ASCII spaces are used to pad the 

record. 

The minimum length in bits of a record is the greater of 1 or the highest bit that contains 

a sort key. If a record is shorter than the minimum, the result_status parameter is set 

with a major severity and message_id field of 33847. Records greater than or equal to 

the minimum length and less than the maximum record length, as defined by the RSZ 

parameter, are padded to the maximum record length for a fixed length sort operation. 

The result_status parameter is set with a warning severity and a message_id of 10000 to 

indicate a record has been padded. No padding will occur for a variable length sort. 

Truncating Situations 

When records are released to the SORT subroutines by the UCS C Sort Release Linkage 

some records are truncated to the maximum record length defined by the RSZ 

parameter. Truncation occurs when the length of the record is greater than the 

maximum record size. When truncation occurs the result_status parameter is set with a 

minor severity and a message_id of 10003 to indicate that a record was truncated. 

7831 0687–010 8–17


8.4.3. UCS C Sort Sort Linkage 

The sort linkage tells the SORT subroutines that all the records have been released to 

SORT through a release linkage. 

Format 

SRTSORT(&result_status, &dbank_address); 


result_status 



dbank_address 





subroutines. 

8.4.4. UCS C Sort Return Linkage 

The sort return linkage retrieves the sorted records from the SORT subroutines. The 

UCS C SORT Return Linkage allows either a single record or a buffer of records to be 

returned from the SORT subroutines. 

Format: 

SRTRETURN(&result_status, &dbank_address, &record_information_packet, 



result_status 

is the location where the SORT subroutines place the result of the call to the UCS C 

Sort Return Linkage (see 8.2.1). 

dbank_address 




provides information about the data located at the record_address parameter 

(see 8.2.4). 

8–18 7831 0687–010

ecord_address 


is the address of the record or record buffer where the SORT subroutines is to place 

the returned data (see 8.2.5). 

Table 8–7 lists the record information packet fields for input to the UCS C Sort Return 

Linkage. 

Table 8–7. Sort Return Record Information Packet Input 


version Identifies the version of the record 

information packet. 

buffer_gran Identifies the granularity of the 

buffer_length field. 

record_gran Identifies the granularity of the 


type Identifies whether the caller is 

requesting a single record or a record 

buffer from the SORT subroutines. 

subtype Identifies the format of the data to be 

inserted by the SORT subroutines at 

record_address based upon the type 

field. 

record_length When the type field is sm_single_record, 

this field has no meaning on entry to the 

linkage. 

When the type field indicates a 

sm_blocked_records and the subtype is 

sm_fixed_records, the length in terms of 

the record_gran field of each record 

requested. Otherwise, this field has no 

meaning. 

buffer_length The maximum length in terms of the 

buffer_gran field of data that can be 

placed in the record_address parameter 

for either a sm_single_record or a 

sm_blocked_records interface. 

pad_word Defined only when the version field is 2. 

It defines the bit string that sort should 

use to pad records when required. 

1 or 2 

0 – sm_word 

1 – sm_6bit 


3 – sm_bit 

0 – sm_word 

1 – sm_6bit 


3 – sm_bit 

0 – single record (constant sm_single_record) 

1– record buffer (constant sm_blocked_records) 

When the type field is sm_single_ record the 

only valid value is 0. 

When the type field is sm_blocked_records, the 

valid values are: 

0 – sm_fixed_records 

1 – sm_variable1_ records 


1 to 07777777777 (2**30–1 = 1,073,741,823) 

1 to 07777777777 (2**30–1 = 1,073,741,823) 

Any valid bit/character string. 

7831 0687–010 8–19



The results returned by the UCS C Sort Return Linkage are returned in the result_status 

and the record_information_packet. The record information packet fields that contain 

information returned by the UCS C Sort Return Linkage are identified in Table 8–8. All 

other fields remain unchanged from their input state. 

Table 8–8. Sort Return Record Information Packet Exit Conditions 

Field Return Value 

buffer_gran Identifies the granularity of the buffer_length field. This field may be 


record_gran Identifies the granularity of the record_length field. This field may be 


record_length For any format of a sm_blocked_records interface, this field is not altered 

from its input state. For the sm_single_record interface, this field is set 

to the length in terms of the record_gran field of the record returned. 

buffer_length For any format of a sm_blocked_records interface, the buffer_length field 

contains the length of the data that was inserted into the buffer by the 

SORT subroutines in terms of the buffer_gran field. For the 

sm_single_record interface, this field is not altered from its input state. 

number_of_records For any format of a sm_blocked_records interface, this field will be set to 

the number of records inserted into the buffer by the SORT subroutines. 

For the sm_single_record interface, this field is not used. 

Padding Situations 

When records are returned from the SORT subroutines by the UCS C Sort Return 

Linkage, some records may require padding. If padding is required, the value contained 

in the pad_word field of the record information packet will be used when the version 

field of the record information packet is 2. If the version field is 1, ASCII spaces are used 

to pad the record. Padding occurs only when requesting a fixed records buffer format 

with a record_length field that is greater than the length of the record being returned by 

the SORT subroutines. Whenever padding occurs, the result_status parameter is set 

with a warning severity and a message_id of 10000 to indicate that a record was padded. 

Truncating Situations 

When records are returned from the SORT subroutines by the UCS C Sort Return 

Linkage, some records are truncated to the record_length field of the record information 

packet. Truncation occurs when requesting a fixed records buffer format where the 

length of the record being returned is greater than the record_length field of the record 

information packet. When truncation occurs, the result_status parameter is set with a 

minor severity and a message_id of 10003 to indicate that a record was truncated. 

When requesting a single record from a variable1 records buffer format or a variable2 

records buffer format, truncation never occurs. If the size of a storage area is insufficient 

to contain one record, a major result_status is returned. 

8–20 7831 0687–010

8.4.5. UCS C Sort Close Linkage 


The sort close linkages terminates the return record phase of a sort before all the 

records have been returned. 

Also, this linkage can be called after an error return from any other sort linkage to release 

data areas allocated by SORT subroutines that may still exist. 

Format 

SRTCLOSE(&result_status, &dbank_address); 


result_status 



dbank_address 





subroutines. 

8.5. UCS C Merge Program Linkages 

The following four linkages are available to perform a merge operation: 

• Open the merge operation with the MRGOPEN linkage. 

• Release the first record of each input file to the merge operation with the 

MRGRELEASE linkage. 

• Request a record from and release the next input record to the merge operation with 

the MRGREQUEST linkage. 

• Close the merge operation with the MRGCLOSE linkage. 

From a UCS C program, you can perform these merge functions by using the UCS C 

Merge Linkages. Descriptions of the SORT subroutines UCS C Merge program linkages 

follow. 

8.5.1. UCS C Merge Open Linkage 

The merge open linkage initializes a merge operation. The linkage must be the first 

linkage to the SORT subroutines from every user merge program. 

Format 

MRGOPEN(&result_status, &dbank_address, &parameter_table); 

7831 0687–010 8–21



result_status 



dbank_address 

is the address of a 1-word storage area that contains a value that uniquely identifies 

the newly opened merge operation (see 8.2.2). 

parameter_table 

is the address of a storage area that contains the parameter table that is used to 

define the merge operation (see 8.2.3). 



subroutines. 

The storage area associated with dbank_address contains a value that uniquely identifies 

the merge operation. On subsequent calls to the SORT subroutines, this value is used 

to identify this merge operation. 

8.5.2. UCS C Merge Release Linkage 

The merge release linkage releases the first record of an input file to the SORT 

subroutines. This linkage must be entered once for each input file being merged. 

Format 

MRGRELEASE(&result_status, &dbank_address, &record_information_packet, 



result_status 



dbank_address 


merge open phase, which uniquely identifies the merge operation (see 8.2.2). 


is the address of a storage area that contains the record packet. The format of the 

record packet is described in 8.2.4. The required fields of the record packet for 

releasing records to a merge operation are described in the table that follows. 

8–22 7831 0687–010



version Identifies the version of 

the record information 

packet being used. 

record_gran Identifies the granularity 

of the record_length 

field. 

type Identifies how records 

are being released 

subtype A further identification of 

how the record is being 

released 

record_length The length in terms of 

the record_gran field of 

the record being passed 

at sm_record_address. 

file_id A user-defined value that 

uniquely identifies the 

input file of the record 

being released 

record_address 

1 or 2 

0 – sm_word 

1 – sm_6bit 


3 – sm_bit 



1 to 07777777777 (2**30 –1 = 1,073,741,823) 

Any unique value. A different value must be 

specified for each file being released. 

is the address of a storage area that contains the record being released to the merge 

operation (see 8.2.5). 



subroutines. 

8.5.3. UCS C Merge Request Linkage 

The merge request linkage requests a record from the SORT subroutines and also enters 

the next input record into the merge operation. 

Format 

MRGREQUEST(&result_status, &dbank_address, &record_information_packet, 

&in_record_address, &out_record_address); 


result_status 



7831 0687–010 8–23


dbank_address 


merge open phase, which uniquely identifies the merge operation (see 8.2.2). 


is the address of a storage area that contains the record packet. The format of the 

record packet is described in 8.2.4. The required fields of the record information 

packet when requesting records from a merge operation are shown in the table that 

follows. 


version Identifies the version of 

the record information 

packet being used. 

buffer_gran Identifies the granularity 

of the buffer_length field. 

record_gran Identifies the granularity 

of the record_length field. 

type Identifies how record is 

being passed to the SORT 

subroutines and how the 

record should be returned. 

subtype A further identification of 

how the record is being 

passed. 

record_length The length in terms of the 

record_gran field of the 

record being passed at 

record_address. 

file_id A user-defined value that 

uniquely identifies the 

input file of the record 

being released 

buffer_length The length in terms of the 

buffer_gran field of the 

storage area 

out_record_address. 

1 or 2 

0 – sm_word 

1 – sm_6bit 


3 – sm_bit 

0 – sm_word 

1 – sm_6bit 


3 – sm_bit 



1 to 07777777777 (2**30 –1 = 1,073,741,823) 

The value must be the same as the value set 

into it on the last call to MRGREQUEST. For the 

first call to MRGREQUEST this field is ignored. 

1 to 07777777777 (2**30 –1 = 1,073,741,823) 

8–24 7831 0687–010

in_record_address 


is the address of a storage area that contains the record being released to the merge 

operation. The first time the merge request linkage is called, in_record_address is 

ignored. On all subsequent calls, the next input record and last record returned must 

be from the same input file. If all records from an input file have been released to 

the merge operation, in_record_address should be set to NULL to inform the SORT 

subroutines that the input file is exhausted. 

out_record_address 

is the address of a storage area where the SORT subroutines are to move the record 

being returned. 



subroutines. If all the records have been returned 

• The severity_code field of the result_status parameter contains the informational (2) 

code. 

• The message_id field of the result_status parameter contains the sm_eof (0777776) 

value. 

• The merge operation has been closed (that is, a call to the merge close linkage is not 

required). 

If all of the records have not been returned 

• The storage area associated with the out_record_address parameter contains the 

record returned by the SORT subroutines. 

• The file_id field of the record information packet contains the value that identifies the 

input file of the record being returned. 

• The record_gran field of the record information packet contains the granularity of the 


• The record_length field of the record information packet contains the length of the 

record being returned in terms of the record_gran field. 

8.5.4. UCS C Merge Close Linkage 

The merge close linkage terminates a merge operation before all the records have been 

returned. 

You can also call this linkage after an error return from any merge linkage to release data 

areas allocated by the SORT subroutines that may still exist. 

Format 

MRGCLOSE(&result_status, &dbank_address); 

7831 0687–010 8–25



result_status 

is the address of a one-word storage area that contains the status returned by the 

SORT subroutines. (See 8.2.1.) 

dbank_address 

is the address of a one-word storage area that contains the value assigned during the 

merge open phase, which uniquely identifies the merge operation. (See 8.2.2.) 



subroutines. 

8–26 7831 0687–010

Section 9 

Configuration Parameters 

This section describes the Sort/Merge configuration parameters. The default value, the 

possible settings for the parameter, and the configuration menu where the parameter is 

defined are stated for each configuration parameter. The system administrator can 

change these parameters at the time of installation using the COMUS CONFIGURE 

command. Appendix E contains information about the Sort/Merge COMUS CONFIGURE 

process. The configuration parameters are found in the source element 

SYS$*SRT$PAR.SORTDEFAULTS/SORT22R2. 

9.1. AUTOMATIC Configuration Parameter 

Description 

AUTOMATIC indicates whether the SORT processor can perform an extended mode 

sort if it is not instructed to perform an extended mode sort. Instructions to perform an 

extended mode sort can be specified with the ESORT processor parameter, or the 

CORE parameter with a size greater than 210000. 

AUTOMATIC affects the SORT processor when a CORE parameter has not been 

specified and the SORT processor has not encountered any parameters or situations that 

prevent the selection of an extended mode sort. 

COMUS Configuration Menu 

CORE CONTROL 

Default Setting 

YES 

Possible Settings 

AUTOMATIC can be set to NO or YES. 

If AUTOMATIC is set to YES, the SORT processor can perform an extended mode sort 

even without explicit instructions, as long as no condition has been specified that would 

prevent the extended mode sort from occurring. 

If AUTOMATIC is set to NO, the SORT processor does not perform an extended mode 

sort unless an ESORT processor parameter is specified or a CORE processor parameter 

with a value greater than 210000 is specified. 

7831 0687–010 9–1


9.2. CCSLOCNUM Configuration Parameter 

Description 

CCSLOCNUM controls the setting of the locale number and code-type numbers for files 

created by the SORT processor. 

This parameter is overridden by the LOCALE and CODE-TYPE processor parameters. 


INTERNATIONALIZATION (I18N) CONTROL 


DEFAULT 


CCSLOCNUM can be set to PREI18N, DEFAULT, or INPUTDATA. 

If CCSLOCNUM is PREI18N, the SORT processor writes the same value in the codetype 

field or locale field as was written on SORT levels before Sort/Merge level 19R1. 

If CCSLOCNUM is DEFAULT, the SORT processor uses the DEFLOCALE configuration 

parameter to determine what is written to the file created by the SORT processor. 

If CCSLOCNUM is INPUTDATA, the SORT processor sets the code-type and locale fields 

based on the code-type and locale settings of the input files. 

9.3. CCSLOCNUMCHK Configuration Parameter 

Description 

CCSLOCNUMCHK indicates whether the SORT processor should perform code-type and 

locale conflict checking. 




ON 


CCSLOCNUMCHK can be set to ON or OFF. 

If CCSLOCNUMCHK is ON, the SORT processor checks for conflicts between the codetype 

and locale settings that are being used. 

If CCSLOCNUMCHK is OFF, the SORT processor does not check for conflicts between 

the code-type and locale settings. 

9–2 7831 0687–010

9.4. CONSOLE Configuration Parameter 

Description 


CONSOLE indicates whether or not the SORT processor and the SORT subroutines 

issue informational messages to the operator console. The CONSOLE configuration 

parameter is used unless a CONSOLE or DELCON SORT processor or SORT subroutines 

parameter is specified. 

CONSOLE affects the SORT processor and the SORT subroutines. 


MESSAGE CONTROL 


OFF 


CONSOLE can be set to OFF or ON. 

If CONSOLE is set to OFF, the SORT processor and SORT subroutines do not send 

informational messages to the operator console. 

If CONSOLE is set to ON, the SORT processor and SORT subroutines send informational 

messages to the operator console. 

9.5. DEFBMCORE Configuration Parameter 

Description 

DEFBMCORE indicates the maximum number of words of memory that can be used by 

the SORT processor for the core area when a basic mode sort is selected and no CORE 

parameter is specified. If the calculated input volume is greater than or equal to the 

DEFBMCORE value, the DEFBMCORE value is used as the core size. If the calculated 

input volume is less than DEFBMCORE, the calculated volume is used as the core size. 

This parameter affects the Basic Mode disk, M1, M1–M2, and tape sorts. 


CORE CONTROL 


210000 


DEFBMCORE can be set in the range 50000 to 210000. 

7831 0687–010 9–3


9.6. DEFDK Configuration Parameter 

Description 

DEFDK defines a default assign mnemonic used when the SORT processor assigns disk 

scratch files for a disk sort and an assign mnemonic is not specified in the DISKS SORT 

processor parameter. 

DEFDK affects the SORT processor parameter DISKS. 


DEVICE DEFAULTS 


F 


DEFDK can be set to any valid sector-formatted disk assign mnemonic. 

9.7. DEFLOCALE Configuration Parameter 

Description 

DEFLOCALE defines the default locale name to be used for internationalization 

operations. The locale name must contain from 1 to 16 characters. The locale name in 

the configuration element can consist of ASCII characters in the range 041 to 0176, 

except for the quotation mark (042), apostrophe (047), and slash (057) characters. Locale 

names are case-sensitive. Two locale names, _DEFAULT and _QUERY, are predefined 

and have special meanings. 

This configuration parameter can be overridden by the LOCALE SORT processor 

parameter. 




_QUERY 


DEFLOCALE can be set to any valid locale name, _QUERY, or _DEFAULT. 

If DEFLOCALE is _QUERY, the SORT processor uses the current locale of the program. 

The processor retrieves the locale name by calling the I18NLIB SETLOCALE routine with 

a requested locale of _QUERY. 

If DEFLOCALE is _DEFAULT, the SORT processor uses the system default locale. The 

processor retrieves the locale name by calling the I18NLIB SETLOCALE routine with a 

requested locale of _DEFAULT. 

9–4 7831 0687–010

9.8. DEFTP Configuration Parameter 

Description 


DEFTP defines the default assign mnemonic used when the SORT processor assigns 

tape scratch files for a tape sort and an assign mnemonic is not specified in the TAPES 

SORT processor parameter. 

DEFTP affects the SORT processor parameter TAPES. 




T 


DEFTP can be set to any valid tape assign mnemonic. 

9.9. DEFXA Configuration Parameter 

Description 

DEFXA defines the default assign mnemonic used when the SORT processor assigns 

the M1 scratch file for an M1 or M1–M2 sort and an assign mnemonic is not specified in 

the DRUM SORT processor parameter. 

DEFXA affects the SORT processor parameter DRUM. 




F40 


DEFXA can be set to any valid word-addressable drum, word-addressable mass-storage, 

sector-formatted mass-storage, or sector-formatted disk assign mnemonic. 

7831 0687–010 9–5


9.10. DEFXB Configuration Parameter 

Description 

DEFXB defines the default assign mnemonic used when the SORT processor assigns 

the M2 scratch file for an M1–M2 sort and an assign mnemonic is not specified in the 

FAST SORT processor parameter. 

DEFXB affects the SORT processor parameter FAST. 




F40 


DEFXB can be set to any valid sector-formatted mass-storage or sector-formatted disk 

assign mnemonic. 

9.11. LOG Configuration Parameter 

Description 

LOG indicates whether or not the SORT processor and the SORT subroutines send 

informational and statistical messages to the run log. The LOG configuration parameter 

is used unless a DELLOG or LOG SORT processor or SORT subroutines parameter is 

specified. 

LOG affects the SORT processor and the SORT subroutines. 




ON 


LOG can be set to OFF or ON. 

If LOG is set to OFF, the SORT processor and SORT subroutines do not send 

informational and statistical messages to the run log. 

If LOG is set to ON, the SORT processor and SORT subroutines send informational and 

statistical messages to the run log. 

9–6 7831 0687–010

9.12. MAXIMUM Configuration Parameter 

Description 


MAXIMUM indicates the maximum number of words of memory used for an extended 

mode sort for the core area when the SORT subroutines allocate the memory. If the 

size of the requested core area is greater than MAXIMUM, the request is reduced to the 

value of the MAXIMUM configuration parameter. 

MAXIMUM affects the SORT processor and the SORT subroutines. 


CORE CONTROL 


1000000 


MAXIMUM can be in the range 262144 to 16777216. However, MAXIMUM must be 

greater than or equal to the value of the MINIMUM configuration parameter (see 9.14). 

9.13. MINIMUM Configuration Parameter 

Description 

MINIMUM indicates the minimum number of words of memory used for an extended 

mode sort for the core area when the SORT subroutines allocate the memory. If the 

size of the requested core area is less than MINIMUM, the request will be increased to 

the value of MINIMUM. 

MINIMUM affects the SORT processor and the SORT subroutines. 


CORE CONTROL 


262144 


MINIMUM can be in the range 262144 to 16777216. However, MINIMUM must be 

less than or equal to the value of the MAXIMUM configuration parameter (see 9.12). 

7831 0687–010 9–7


9.14. MSAMBLOCK Configuration Parameter 

Description 

MSAMBLOCK affects the block size used to create MSAM files for all SORT processor 

operations. The setting of this parameter can be reversed with a SORT processor 

runstream by the specification of the SORT processor FILEOUT local parameter 

REVMSAMBLK. 


INPUT/OUTPUT FILE CONTROL 


DEFAULTCALC 


MSAMBLOCK can be set to DEFAULTCALC or BLOCKPARAM. 

If MSAMBLOCK is set to DEFAULTCALC, the block size used by the SORT processor to 

create MSAM files will be the greater of 

• The block size specified by the BLOCK parameter associated with the FILEOUT 

parameter file rounded to the next prep size 

• The minimum block size calculation rounded to the next prep size 

The SORT processor uses the greater of the following formulas as the calculation of the 

minimum block size: 

or 

10 * (maximum record word length + number of MSKEYs with duplicates + 2) + 6 

200 * (maximum MSKEY word length + number of alternate MSKEYs + 1) + 8 

If MSAMBLOCK is set to BLOCKPARAM, the block size used by the SORT processor to 

create MSAM files is the block size specified by the BLOCK parameter associated with 

the FILEOUT parameter file rounded to the next prep size. 

If a BLOCK parameter is not applicable to the FILEOUT parameter, the block size used to 

read the first input file is substituted for the block size specified by the BLOCK 

parameter associated with the FILEOUT file. 

9.15. NUMRECWARN Configuration Parameter 

Description 

NUMRECWARN indicates whether or not the SORT processor issues a warning when 

the number of records specified by a local NUMREC parameter has been processed and 

more records exist in the input file controlled by the local NUMREC parameter. The 

SORT processor may also issue a warning when the number of records specified by a 

global NUMREC parameter has been processed and more records exist in the input file 

currently being processed or in an unopened input file. 

9–8 7831 0687–010




NONE 


NUMRECWARN can be set to ALL, GLOBAL, LOCAL, or NONE. 


If NUMRECWARN is set to ALL, the SORT processor issues a warning when the 

number of records specified by a local NUMREC parameter has been processed and 

more records exist in the input file controlled by the local NUMREC parameter. If a 

global NUMREC parameter is specified, the SORT processor issues a warning when the 

number of records specified by the global NUMREC parameter has been processed and 

more records exist in the input file currently being processed or in an unopened input 

file. 

If NUMRECWARN is set to GLOBAL, the SORT processor issues a warning when the 

number of records specified by a global NUMREC parameter have been processed and 

more input records exist in the input file currently being processed or in an unopened 

input file. No warning is issued if the number of records specified by a local NUMREC 

parameter has been processed and more records exist in the input file controlled by the 

local NUMREC parameter. 

If NUMRECWARN is set to LOCAL, the SORT processor issues a warning when the 

number of records specified by a local NUMREC parameter has been processed and 

more input records exist in the input file controlled by the local NUMREC parameter. No 

warning is issued if the number of records specified by a global NUMREC parameter has 

been processed and more records exist in the input file currently being processed or in 

an unopened input file. 

If NUMRECWARN is set to NONE, the SORT processor does not issue a warning when 

the number of records specified by a local or a global NUMREC parameter has been 

processed and more input records exist. 

9.16. PRCERRCONS Configuration Parameter 

Description 

PRCERRCONS controls the issuance of nonsyntax SORT processor error messages to 

the operator console. 




OFF 

7831 0687–010 9–9



PRCERRCONS can be set to OFF or ON. 

If PRCERRCONS is set to OFF, SORT processor nonsyntax error messages are not sent 

to the operator console. All SORT processor error messages are printed to the run's 

print file. 

If PRCERRCONS is set to ON, SORT processor nonsyntax error messages are sent to 

the operator console. Errors detected before the first processor parameter is requested 

and errors detected after the @EOF terminating the processor parameter input are sent 

to the system console. Errors detected after the first processor parameter is entered and 

before the @EOF terminating the processor parameter input are not sent to the system 

console. In addition, all error messages are printed to the run's print file. 

9.17. PROCESSING Configuration Parameter 

Description 

PROCESSING indicates whether SORT should process records on a word or 

nonword-oriented basis. This configuration parameter can be overridden by the 

SORT processor global parameter PROCESSING. 

The effects of the PROCESSING configuration parameter are undefined when you are 

creating a MODE ANSI or MSAM file. The PROCESSING configuration parameter has 

no meaning when you are creating a file with a MODE of ACOB, CARDS, CFH, or PRINT, 

as these files are word oriented. 




NONWORD 


PROCESSING can be set to WORD or NONWORD. 

When PROCESSING is set to NONWORD, SORT processes (that is, releases and 

returns) records according to a nonword length and causes SORT to set an output files 

significant bits in the last word field to a value in the octal range 01-044. The primary 

purpose of this configuration parameter setting is to provide a means to enable this 

functionality without having to modify all existing runstreams. 

When PROCESSING is set to WORD, SORT processes (that is, releases and returns) 

records on a word-oriented basis, thus causing SORT to set an output files significant 

bits in the last word field to octal 044. The primary purpose of this configuration 

parameter setting is to disable the nonword processing functionality without having to 

modify all existing runstreams. 

9–10 7831 0687–010


9.18. PREPDEFAULT Configuration Parameter 

Description 

PREPDEFAULT defines the mass-storage prep size used by the SORT processor for 

mass-storage MODE ACOB or COBOL File Handler (CFH) files when the PREP 

processor parameter is not specified. 

PREPDEFAULT affects the SORT processor when reading and writing mass-storage 

MODE ACOB and CFH files. 




28 


PREPDEFAULT can be set to the values 28, 56, or 112. 

9.19. RBSIZE Configuration Parameter 

Description 

RBSIZE defines for both the SORT processor and the SORT subroutines the record bank 

size for an internationalization sort. It is more of an internal parameter than most of the 

other configuration parameters. In an internationalization sort, the SORT subroutines can 

no longer translate the key in place within the record, because the transformation may 

exceed the original key size. To accommodate this, the SORT subroutines creates a 

new bank (the record bank), which will hold the original records released by the user. 




16777216 


The RBSIZE configuration parameter value must be in the range 4194304 to 16777216. 

7831 0687–010 9–11


9–12 7831 0687–010

Section 10 

Sort Types and Variable-Length Sorting 

Considerations 

This section describes 

• The CORE parameter 

• The sort types 

• Variable-length sorting considerations 

10.1. The CORE Parameter 

The CORE parameter specifies the size of the core area to be allocated by the SORT 

processor. If the SORT subroutines are used and you do not specify a CORE parameter, 

the following control statement must be executed before the SORT subroutine open call: 

@ASG,T R$CORE.,F///n 

The SORT subroutines use the maximum assignment n to determine the size of the core 

area with the following computation: 

core size (in words) = 1000 * n 

The minimum value allowed for n is 1. 

See Section 2 for more information on core size and its effect on the selection of a basic 

mode or an extended mode main-storage-only sort. 

Note: The SORT processor does not recognize the R$CORE assignment. 

7831 0687–010 10–1

Sort Types and Variable-Length Sorting Considerations 

10.2. Sort Types 

The following is a list of the Sort types: 

• Basic mode main storage only 

• Extended mode main storage only 

• Basic mode disk 

• Extended mode disk 

• One-level mass storage (M1) 

• Two-level mass storage (M1–M2) 

• Tape 

10.2.1. Basic Mode or Extended Mode Main-Storage-Only Sorts 

A main-storage-only sort is attempted if no scratch files are assigned or if the Y 

processor option is specified on the SORT processor call statement. The only facility 

required for this type of sort is main storage. Generally, main-storage-only sorts provide 

the best performance. See Section 2 for more information on whether a basic mode or 

an extended mode main-storage-only sort is executed. In basic mode or extended mode 

main-storage-only sorts, the following formulas should be used as guidelines when 

calculating the amount of main storage used: 

• Basic mode fixed-length records 

main storage = safety-factor * (record-size + 1) * 

(number-of-records) + key-overhead 

where key-overhead equals 6 + 10 * (number of words in each record that contains 

key fields). 

As an example of the key-overhead calculation, the key-overhead is 36 for 

'KEY',1,9,S,A. 

If the PRESERVE parameter is specified, add 1 to the record size. 

• Extended mode fixed-length records 

main storage = safety-factor * (record-size + 2) * 


where key-overhead equals 9 + (9 * number of keys). 

If the PRESERVE parameter is specified, then add 1 to the number of keys and add 1 

to the record size. 

10–2 7831 0687–010

• Basic mode variable-length records 


First, you must round the record-size up to a multiple of link-size. 

main storage = safety-factor * (record-size + 

(record-size/link-size) + 1) * 


where key-overhead equals 8 + 14 * (number of words in each record that contains 

key fields). 

As an example of the key-overhead calculation, the key-overhead is 50 for 

'KEY',1,9,S,A. 

• Extended mode variable-length records 

First, you must round the record-size up to a multiple of link-size. 

main storage = safety-factor * (record-size + 

(record-size/link-size) + 2) * 


where key-overhead equals 9 + (9* number-of-keys). 

If the PRESERVE parameter is specified, add 1 to the number of keys and add 1 to the 

record size. 

Use a safety factor between 1.1 and 1.3 for both the fixed-length and variable-length 

formulas. 

10.2.2. Basic Mode and Extended Mode Disk Sorts 

The assignment of three or more sector-formatted scratch files causes a disk sort to be 

performed. A maximum of 26 scratch files can be used for a basic mode or extended 

mode disk sort. Use the scratch file names XA through XZ. 

If your sort volume is too large for a main-storage-only sort, use a disk sort. Generally, 

an extended mode disk sort is more efficient than a basic mode disk sort. See Section 2 

to determine when a basic mode or extended mode disk sort is executed. 

7831 0687–010 10–3


Disk sorts are not dependent on a bias factor and are the safest and most efficient way 

to sort. They use the sequential data for producing fewer number of strings. Providing 

that a sufficient number of scratch files exist, disk sorts always complete the sort 

operation regardless of the bias factor because they use an intermediate merge 

technique that reduces the number of strings. This technique makes the strings 

manageable so they can be handled in the main storage (core) provided. Consider the 

following when assigning the scratch files: 

• All scratch files should be assigned with the same maximum reserve. 

• The greater the number of scratch files assigned, the smaller the total amount of 

mass storage required. 

• Control the placement of the sort scratch files. Removable disk packs are the most 

desirable for sort scratch files. However, if removable disk packs are not available, 

use the logical or absolute placement field in the facility assignment statement to 

ensure that no two sort scratch files are allocated on the same physical disk unit. 

• For the best results, core size should be less than 25% of the size of a sort scratch 

file. 

• For an efficient determination of the internal merge power and block size, use the 

VOL and BIAS parameters through the SORT subroutines and use the RECORD and 

BIAS parameters through the SORT processor. 

• For a basic mode sort, the size of a scratch file must be greater than the size of the 

core. For an extended mode sort, the size of the scratch file must be at least 36 

tracks. 

To determine the size of each scratch file, use the following formula: 

file size = (sort-volume) * (safety-factor)/(total-number-of-files - 1) 

where safety-factor should be between 1.1 and 1.3. 

Note: If user compare code is present or if the key fields are not at the beginning of 

the records, then use the larger safety-factor value. 

Example 

For a sort involving 100,000 records at 100 words per record using six mass storage 

files, the size of each scratch file is determined as follows: 

• 100,000 records * 100 words per record equals 10,000,000 words of total sort-volume. 

• Apply the file size formula to get the following expression: 

file size = (1.3) * (10,000,000)/5 = 2,600,000 words per file 

• Convert the file size to tracks or positions 

2,600,000 / 1,792 = 1451 tracks per file or 

2,600,000 /114,688 = 23 positions per file 

10–4 7831 0687–010


10.2.3. One-Level (M1) and Two-Level (M1–M2) Mass Storage 

Sorts 

If you cannot use a main-storage-only sort or a disk sort, then use either a one-level (M1) 

or two-level (M1–M2) mass storage sort. 

A one-level mass storage sort assigns one mass storage scratch file only. In a two-level 

mass storage sort, the smaller file assigned is always used by the SORT subroutines as 

file M1, and the larger file is file M2. The M1 file can be assigned to a word-addressable 

drum device, a sector-formatted mass storage device, or a disk storage device. The M2 

file can be assigned for a sector-formatted mass-storage device or a disk storage device. 

When using a two-level mass storage sort, assign the M1 file to the faster device. 

Use the guidelines in Table 10–1 and Table 10–2 when assigning M1 and M2 files and 

reserving main storage. 

Table 10–1. M1 Main Storage Assignment and Reservation Guidelines 

Mass Storage Storage Guideline 

M1 for fixed-length records M1 > sort-volume 

M1 for variable-length records M1 > (record-size + 1) * (number-of-records) 

Main storage Main storage < M1/3 

Table 10–2. M1–M2 Main Storage Assignment and Reservation 

Guidelines 

Mass Storage Assignment Guideline 

M2 for fixed-length records M2 > sort-volume 

M2 for variable-length records M2 > (record-size + 1) * (number-of-records) 

M1 M1 < M2/2 

Main storage Must be < M1/3 or a K3 error occurs 

If the parameter table contains a PRESERVE entry, then add 1 to the record size in the 

previous formulas. 

For a one-level mass storage sort, the M1 file should be assigned 10 to 15 percent larger 

than the sort-volume. If the size of main storage (core) is greater than M1/3, the M1 

mass storage file is not used and the sort becomes a basic mode main-storage-only sort. 

For a two-level mass storage sort, the M2 file should be assigned 10 to 15 percent larger 

than the sort volume. If M1 is greater than M2/2, the sort remains a two-level mass 

storage sort that uses only the M2/2 portion of M1. 

7831 0687–010 10–5


10.2.4. Tape Sorts 

Assign the scratch files to tape devices only if the other sort types are not feasible. A 

minimum of 3 and a maximum of 24 tape units can be used. Use of the scratch file 

names XC through XZ is recommended. 

A tape sort can be performed in conjunction with a main storage, an M1, or an M1–M2 

sort. The following size restrictions apply to tape sorts according to the type of storage 

medium preceding the tape. 

Storage Medium Size Restriction 

Main storage to tape Main storage size < capacity of one tape reel 

M1 to tape M1 size < capacity of one tape reel 

M1–M2 to tape M2 size < capacity of one tape reel 

See Section 12 for tape sort considerations and console messages. 

10.3. Variable-Length Record Considerations 

The VRSZ, VRSZA, and VRSZW parameters inform the SORT subroutines of a 

variable-length record sort and the LINKSZ parameter informs the SORT processor of a 

variable-length record sort. In the absence of these parameters, a fixed-length record 

sort is assumed. 

Variable-length record sorting is not as efficient in the SORT subroutines as fixed-length 

record sorting. However, with some knowledge of the input data, the efficiency of a 

variable length record sort can be increased. During the main storage string generation 

phase of a sort, each record is broken into links. Each link has a control word and the 

link containing the last portion of the record is padded to the size of the link. You can 

adjust the link size so that a minimum amount of main storage is wasted on either 

padding or control words. Thus, more records fit into main storage and longer strings 

are generated, which causes greater efficiency in the merge phases of the sort. 

Please note that when performing an extended mode sort with records greater than 500 

words in length, the SORT subroutines may implicitly reduce the link size to improve 

efficiency and reduce main storage waste. 

In the absence of any information about the input file, the LINKSZ parameter should be 

as large as the smallest variable length record and close to a number of which the largest 

record is a multiple. The smallest variable length record must contain all the keys. 

Failure to ensure this condition results in error termination. 

10–6 7831 0687–010


The following discussion shows how different link sizes can affect a sort. Assume that a 

data file consists of records varying in length from 30 words to 200 words and that there 

are 10,000 words of main storage available to the sort for the record area after control, 

key, generated code, and output buffers are allocated. 

• If the majority of the records are 80 to 100 words in length and very few of the 

records are less than 90 words, a link size of 100 would probably be most efficient 

as one link would hold most of the records and padding would be held to a 

minimum. If a link size of 5 were used, which would be possible only if all the keys 

are in the first five words, 20 control words would be generated for every 100 words 

of data. 

• If the majority of the records were 30 to 50 words in length, a link size of 100 would 

cause almost all records to be padded to 100 words. In this case, a link size of 50 

would probably be most efficient. 

• If the majority of records are 130 to 150 words in length, a link size of 100 would be 

very inefficient. The second link would contain at least as many pad words as actual 

data. A link size of 150 would be more efficient than a link size of 100, but 

depending upon the number of records less than 100 words, a link size of 50 words 

might be most efficient. With a link size of 50, only three control words are 

generated for most records and padding could be held to a minimum. 

Take into account control words and padding caused by the link size when calculating 

main storage requirements if a main-storage-only sort is to be attempted. Refer to 

10.2.1. 

7831 0687–010 10–7


10–8 7831 0687–010

Section 11 

Key Field Translation 

This section explains how each key type is translated and describes the result of the key 

field translation for either a basic mode or an extended mode sort. 

11.1. Using MASM Compare Instructions 

The MASM compare instructions compare the words in two key fields. To make the 

MASM compare instructions work with any of the key types that the Sort/Merge product 

allows, some of the key fields need to be translated. Sort/Merge uses the following 

compare instructions. 

If you are performing ... Then the MASM compare instructions ... 

A basic mode sort TG, TE, and TLE compare the key fields 

An extended mode sort BIC and BICL compare the key fields 

Any key fields that need translation are translated when your program releases the 

record to SORT subroutines. The key fields are returned to their original form before the 

SORT subroutines pass the sorted records back to your program, except where noted. 

Note: For all key types, bit positions in a word are numbered from 1 to 36 from most 

significant to least significant. 

7831 0687–010 11–1


11.2. Sort/Merge Key Fields 

This subsection describes each Sort/Merge key field and the method used for translating 

the key field. The key field formats in Table 11–1 are included. 

Table 11–1. Sort/Merge Key Field Translation 


A Fieldata alphanumeric format. 

B OS 2200 signed binary format. 

D Fieldata sign-leading separate-decimal format. 

DATE ASCII alphanumeric date leading 18-bit year format. 

G Fieldata sign-trailing separate-decimal format. 

I International character set format. 

J Packed decimal format. 

L Fieldata sign-leading overpunch format. 

M IBM signed binary format. 

P Fieldata sign-trailing overpunch format. 

Q ASCII sign-trailing overpunch format. 

R ASCII sign-leading separate-decimal format. 

S ASCII alphanumeric format. 

T ASCII sign-trailing separate-decimal format. 

U Unsigned binary format. 

V ASCII sign-leading overpunch format. 

11.2.1. A - Fieldata Alphanumeric Format 

Description 

The key field contains alphanumeric characters 6 bits in length and sorted as unsigned 

binary numbers. 

To change the sorting order, create a Fieldata collating sequence table. The 

alphanumeric key field must start at a character boundary. Possible start bits for this key 

are 1, 7, 13, 19, 25, or 31. 

11–2 7831 0687–010

Translation Method 


The following describes the result of the key field translation for both a basic mode and 

an extended mode sort: 

• If you specify an alternate collating sequence, the characters are translated to the 

ordinal in the sequence. 

• If you do not specify an alternate collating sequence, no translation occurs. 

11.2.2. B - OS 2200 Signed Binary Format 

Description 

The key field contains a number in OS 2200 fixed-point or single-precision floating-point 

notation. 

• A positive number is denoted by a 0 in the leftmost bit position with the magnitude 

in binary notation in the remaining bit positions. 

• A negative number is represented by a 1 in the leftmost bit position and the 

complement of the binary representation of a positive number of the same 

magnitude in the remaining bit positions. 


If you are performing a basic mode sort, no translation occurs. 

If you are performing an extended mode sort, the sign bit is complemented and the 

remaining bit positions are left unchanged. 

11.2.3. D - Fieldata Sign-Leading Separate-Decimal Format 

Description 

The key field contains a signed number represented in Fieldata characters. 

• The leftmost character of the field is the sign. 

− For negative numbers, the character must be a Fieldata minus (-) 

− For positive numbers, the character should be a Fieldata space or a Fieldata plus 

(+). 

− Any character other than a Fieldata minus (-) as the leftmost character is 

assumed to represent a positive number. 

• The remaining characters can be any of the Fieldata integers, 0 through 9. 

• Possible start bits for this key are 1, 7, 13, 19, 25, or 31. 

7831 0687–010 11–3



The following describes the key field translation method for both a basic mode and an 

extended mode sort: 

• If the value of the key is positive, no translation occurs. 

• If the value of the key is negative, the entire key, excluding the sign character, is 

complemented. 

11.2.4. DATE - ASCII Alphanumeric Date Leading 18-Bit Year 

Format 

Description 

The key field contains an ASCII alphanumeric date where the first 18 bits represent a 2digit 

year. Each 9-bit field in the year portion of the key must be one of the ASCII 

characters 0 to 9. 

Possible start bits for this key are 1, 10, 19, or 28. 


For a basic mode and an extended mode sort, replace the first 18 bits of the key field by 

the least significant 18 bits of the following calculation: (first 18 bits of key field + 

01000000) - (18-bit representation of the DEFYEAR parameter value). 

For example, assume that DEFYEAR=28 and that KEY=1,2,DATE,A. Table 11–2 shows 

the steps of the key field translation for key values of 96 and 02. 

First 18 Bits 

of the Key 

Field, in 

Decimal 

Table 11–2. Example of Steps in Key Field Translation 

First 18 Bits 

of the Key 

Field, in 

Octal 

First 18 Bits 

of the Key 

Field + 

01000000, in 

Octal 

DEFYEAR 

Value, in 

Octal 

Arithmetic 

Difference, in 

Octal 

Least 

Significant 18 

Bits of the 

Translated Key 

Field, 

in Octal 

96 071066 01071066 062070 01006776 006776 

02 060062 01060062 062070 0775772 775772 

To restore the translated portion of the key field, replace the first 18 bits of the key field 

by the least significant 18 bits of the following calculation: (first 18 bits of key field) + 

(18-bit representation of the DEFYEAR parameter value) 

For example, using the translated key fields described above for the key values 96 and 

02, Table 11–3 shows the steps in restoring the key field. 

11–4 7831 0687–010


Table 11–3. Example of Steps in Restoring Translated Key Fields 

First 18 Bits of 

the Translated 

Key Field, 

in Octal 

DEFYEAR Value, 

in Octal 

Arithmetic Sum, 

in Octal 

Least 

Significant 18 

Bits of the 

Restored Key 

Field, in Octal 

First 18 Bits of 

the Restored 

Key Field, in 

Decimal 

006776 062070 071066 071066 96 

775772 062070 01060062 060062 02 

No translation occurs for the remainder of the key which is considered as unsigned 

binary (that is, a U key). 

11.2.5. G - Fieldata Sign-Trailing Separate-Decimal Format 

Description 

The key field contains a signed number represented in Fieldata characters: 

• The rightmost character of the field is the sign. 

− For negative numbers, the character must be a Fieldata minus (-). 

− For positive numbers, the character should be a Fieldata space or a Fieldata plus 

(+). 

− Any character other than a Fieldata minus (-) as the rightmost character is 

assumed to represent a positive number. 

• The remaining characters can be any of the Fieldata integers 0 through 9. 

• Possible start bits for this key are 1, 7, 13, 19, 25, or 31. 




• If the value of the key is positive, no translation occurs. 

• If the value of the key is negative, the entire key, excluding the sign character, is 

complemented. 

11.2.6. I - International Character Set Format 

Description 

The key field is in international characters. The collating sequence of this key field is 

determined by the locale currently in force or the locale specified by the LOCALE 

parameter. Depending on the specification of the subtype associated with this key field, 

trailing spaces within the key field are either ignored or included in the translation 

process. The inclusion of trailing spaces can affect the order sequence of the fields. An 

I key can only be specified for an extended mode sort or merge operation. 

7831 0687–010 11–5



The key field is translated into a binary-comparable format by the I18NLIB 

string_transform service routine. 

11.2.7. J - Packed Decimal Format 

Description 

The key is made up of quarter-word bytes. The leftmost bit of each byte is a slack bit 

and is not used. All slack bits are cleared. 

The remaining eight bits are used to represent two 4-bit decimal digits: 

• The rightmost byte consists of one slack bit and 

− One 4-bit decimal digit 

− One 4-bit sign field 

• The positive sign values are 

− Decimal: 0, 2, 4, 8, 10, 12, 14, and 15 

− Binary: 0000, 0010, 0100, 1000, 1010, 1100, 1110, and 1111 

• The negative sign values are 

− Decimal: 1, 3, 5, 7, 9, 11, and 13 

− Binary: 0001, 0011, 0101, 0111, 1001, 1011, and 1101 

• The number of bits in the key length must be a multiple of 9: 

− Calculate the start character field (sc) or character position field (char-pos) as the 

starting byte. 

− Use the number of characters field (nc) to specify the number of quarter-word 

bytes. 



For a basic mode sort, if the last four bits of the key represent a negative number, the 

entire key is complemented. 

For an extended mode sort, the leftmost bit is complemented. If the last four bits of the 

key represent a negative number, the key, excluding the four sign bits, is 

complemented. 

11–6 7831 0687–010

11.2.8. L - Fieldata Sign-Leading Overpunch Format 

Description 


The key field contains a decimal number represented in Fieldata characters. If present, 

the sign is represented by an overpunch character in the leftmost Fieldata character 

position. The overpunch character is restored only for negative representations. If the 

key field contains incompatible (illegal) characters, the results from the sort are 

undefined and the field may be altered and not restored to its initial state. 

Possible start bits for this key are 1, 7, 13, 19, 25, or 31. 


For a basic mode sort, the overpunch character is replaced with its appropriate numeric 

representation. 

For an extended mode sort, the overpunch character is replaced with its appropriate 

numeric representation. If the value of the key is negative, the key is complemented. 

See the ASCII COBOL Programming Reference Manual for additional information on 

overpunch characters. 

11.2.9. M - IBM Signed Binary Format 

Description 

The key field contains a number in the IBM 7090 fixed-point binary notation. 

• The leftmost bit is the sign bit, where 

− 0 indicates a positive number 

− 1 indicates a negative number 

• The remaining bit positions contain the magnitude of the number in binary notation. 




• If the value of the key is positive, the leftmost bit is complemented. 

• If the value of the key is negative, the entire key is complemented. 

11.2.10. P - Fieldata Sign-Trailing Overpunch Format 

Description 

The key field contains a decimal number represented in Fieldata characters. If present, 

the sign is represented by an overpunch character in the rightmost Fieldata character 

position. The overpunch character is restored only for negative representations. If the 

key field contains incompatible (illegal) characters, the results from the sort are 

undefined and the field may be altered and not restored to its initial state. 

Possible start bits for this key are 1, 7, 13, 19, 25, or 31. 

7831 0687–010 11–7









11.2.11. Q - ASCII Sign-Trailing Overpunch Format 

Description 

The key field contains a decimal number represented in ASCII characters. If present, the 

sign is represented by an overpunch in the rightmost character position. The overpunch 

character is restored only for negative representations. If the key field contains 

incompatible (illegal) characters, the results from the sort are undefined and the field 

may be altered and not restored to its initial state. 









11.2.12. R - ASCII Sign-Leading Separate-Decimal Format 

Description 

The key field contains a signed number represented in ASCII characters. 

• The leftmost character of the field is the sign. 

− For negative numbers, the character must be an ASCII minus (-). 

− For positive numbers, the character should be an ASCII space or an ASCII plus 

(+). 

− Any character other than an ASCII minus (-) as the leftmost character is assumed 

to represent a positive number. 

• The remaining characters can be any of the ASCII integers, 0 through 9. 

• Possible start bits for this key are 1, 10, 19, or 28. 

11–8 7831 0687–010



For a basic mode sort, if the key field has an ASCII minus sign as the leftmost character, 

the entire key field is complemented. If the key field has an ASCII plus sign as the 

leftmost character, the leftmost character is translated to an ASCII space before 

returning to the user. 

For an extended mode sort, the leftmost bit is complemented. If the value of the key is 

negative, the key, excluding the sign character, is complemented. 

11.2.13. S - ASCII Alphanumeric Format 

Description 

The key field is in ASCII characters. If you desire a format other than a normal ASCII 

order, one of the various sequence parameters for this key must be used. 





• If you specify an alternate collating sequence, the characters are translated to the 

ordinal in the sequence. Depending on the translation table specified, the key field is 

translated in 7 or 8 bit fields. 

• If the character exceeds a 7 bit field ( greater than 0177) or an 8 bit field (greater than 

0377), no translation occurs. 

If you do not specify an alternate collating sequence, no translation occurs. 

11.2.14. T - ASCII Sign-Trailing Separate-Decimal Format 

Description 

The key field contains a signed number represented in ASCII characters. 

• The rightmost character of the field is the sign. 

− For negative numbers, the character must be an ASCII minus (-). 

− For positive numbers, the character should be an ASCII space or an ASCII plus 

(+). 

− Any character other than an ASCII minus as the rightmost character is assumed 

to represent a positive number. 

• The remaining characters can be any of the ASCII integers 0 through 9. 


7831 0687–010 11–9



For a basic mode sort, if the key value of the field is negative, the entire key field is 

complemented. 

For an extended mode sort, the leftmost bit is complemented. If the value of the key is 

negative, the key, excluding the sign character, is complemented. 

11.2.15. U - Unsigned Binary Format 

Description 

The key field contains the magnitude of a number in unsigned binary notation. 


For a basic mode sort, the leftmost bit is complemented during translation. 

For an extended mode sort, no translation occurs. 

11.2.16. V - ASCII Sign-Leading Overpunch Format 

Description 

The key field contains a decimal number represented in ASCII characters. If present, the 

sign is represented by an overpunch character in the leftmost ASCII character position. 

The overpunch is restored only for negative representations. If the key field contains 

incompatible (illegal) characters, the results from the sort are undefined and the field 

may be altered and not restored to its initial state. 









11–10 7831 0687–010

Section 12 

Tape Sort Operations 

This section discusses special considerations for performing tape sorts. This section 

explains the following: 

• The two types of sort operations 

• The tape merge power calculations 

• The console messages that may appear when you perform a sort/merge operation 

from tape input 

12.1. SORT Subroutines Tape Sort Operations 

The SORT subroutines handles two types of tape sort operations 

• Automatic 

In an automatic tape sort, your program does not control the three phases of the sort 

(distribution, intermediate merge, and final merge) and all three phases are 

completed in a single SORT subroutines activation. 

• Nonautomatic 

In a nonautomatic tape sort, the three phases of the sort are controlled by the 

PARTA, PARTB, and PARTC parameters, and only one of these phases can be 

performed in any one SORT subroutines activation. 

12.1.1. Automatic Tape Sorts 

The SMRG parameter and a minimum of three tape units are required to perform an 

automatic tape sort. The following SORT subroutines linkages are also required (see 

6.2): 

• ROPN$ 

• RREL$ 

• RSORT$ 

• RRET$ 

In addition, three optional linkages can be used: 

• RENCY$ 

• RINFO$ 

• IPURI$ 

7831 0687–010 12–1


RINFO$ or IPURI$ are useful only when the tape sort has reached the final merge phase. 

This can be determined by the messages that the SORT subroutines print on the output 

listing. If the tape sort fails during final merge, the RINFO$ or IPURI$ information can be 

submitted to the SORT subroutines in another run with a CONTC parameter also being 

present. 

The SORT subroutines control dismounting, labeling, and remounting of tapes through 

operator console messages. 

12.1.2. Nonautomatic Tape Sorts 

Nonautomatic tape sorts are performed in the following three parts: 

• PARTA Distribution on tape 

• PARTB Intermediate merge on tape 

• PARTC Final tape merge to user program 

PARTA Tape Sort 

A PARTA sort requires the PARTA parameter; the FINAL parameter can also be used. 

The required SORT subroutines linkages are ROPN$, RREL$, and RSORT$. The 

RENCY$ linkage can also be used. A PARTA sort is executed only once for a given 

volume of data. If the sort program is interrupted during PARTA, it can be continued by 

adding the CONTA parameter to the original PARTA program and reexecuting it. To recreate 

a tape produced during a PARTA sort, a REDOA parameter must be added to the 

original PARTA program and the program reexecuted. 

PARTB Tape Sort 

A PARTB sort requires the PARTB parameter; the FINAL parameter can also be used. 

The only SORT subroutines linkage required is ROPN$. The PARTB sort must be 

executed until the number of tapes is reduced to the number that can be handled by a 

PARTC sort. If the sort program is interrupted during PARTB, it can be continued by 

adding the CONTB parameter to the original PARTB program and reexecuting it. To re– 

create a tape produced during a PARTB sort, a REDOB parameter must be added to the 

original PARTB program and the program must then be reexecuted. 

PARTC Tape Sort 

A PARTC sort requires the PARTC parameter. The required SORT subroutines linkages 

are ROPN$ and RRET$. The RINFO$ or IPURI$ linkages can also be used. If a sort 

program is interrupted during PARTC, it can be continued, provided the RINFO$ linkage 

or the IPURI$ linkage was in the original PARTC program. If the RINFO$ linkage is used, 

the PARTC sort may be continued by adding the CONTC parameter to the original 

program and then reexecuting it. If the IPURI$ linkage is used, the program can be 

continued by submitting the restart deck through an @XQT,P of the original PARTC 

program. 

12–2 7831 0687–010

12.2. Tape Merge Power Calculations 


The distribution phase of a tape sort produces one or more files, with each file consisting 

of one or more tape reels. 

The files created by the distribution phase are then used as the input for the 

intermediate merge phase. The intermediate merge phase consists of a partial merge 

operation (only if needed) followed by one or more successive merge operations. 

Nonautomatic Tape Sort 

For a nonautomatic tape sort, you must calculate how many files must be merged by the 

first PARTB run and how many files must be merged on successive PARTB runs. These 

two values are termed the initial merge power and the primary merge power 

respectively. They are calculated as follows: 

Step 1: Let T = the number of files produced by the PARTA run 

and let N = the number of tape units assigned for 

sorting. 

Step 2: Let P = the primary merge power (the number of tape 

units that can be used for merging), then P = N - 1 

since one must be saved for merged output. 

Note: If P is greater than or equal to T, a PARTB run is not needed and a 

PARTC run should be done instead. 

Step 3: If IP = the initial merge power, then 

IP = mod (T-1, P-1) + 1. 

Note: mod(A,B) is the remainder obtained when A is divided by B. 

If the IP calculated is zero, then an initial merge is not needed and the first PARTB run 

should merge P files. 

Automatic Tape Sort 

For an automatic tape sort, the initial merge power and the primary merge power are 

calculated internally. 

When only P files remain to be merged, they are used as the input to a PARTC run. 

7831 0687–010 12–3


12.3. Tape Sort Console Messages 

There are three phases during the operation of a tape sort 

• Distribution phase 

• Intermediate merge phase 

• Final merge phase 

During the operation of the tape sort, messages display on the operator console. The 

messages are also written into the system log file so that, if the sort is interrupted or a 

tape cannot be read, the information is available for the CONTA, CONTB, CONTC, 

REDOA, and REDOB parameters. 

The following is a breakdown of the console messages and appropriate response for 

each phase. 

12.3.1. Distribution Phase 

There are four distinct console messages displayed during the distribution phase. These 

messages are issued when 

1. The label block for an output reel is written. 

2. An end-of-reel or end-of-file block is written on an output reel. 

3. All reels of an output file are written. 

4. All the input data is distributed to PARTA files. 

The following are the specific console messages and the responses required. 

The Label Block for an Output Reel Message 

This message is displayed after the label block for an output reel is written. 

Message 

cc/uu LABEL: REEL n of //Accc 

where 

cc/uu 

n 

is the channel/unit. 

is the 6-digit reel number. 

12–4 7831 0687–010

Accc 

is the label, with the following components 

// 

A 

ccc 

Response 

is the user label prefix. 

is the PARTA output. 

is the cycle number. 


The operator should prepare an external label for the designated reel. No response is 

necessary for this message. 

End-of-Reel or End-of-File Block for an Output Reel Message 

This message is displayed after a tape unit swap following an end-of-reel or end-of-file 

block is written to an output reel. 

Message 

cc/uu DISMOUNT REEL n OF //Accc + BLANK 

Response 

The operator should dismount the output reel and mount a blank tape on the specified 

unit. A response of any one character is required for this message. 

All Reels of an Output File Are Written Message 

This message is displayed after all reels of an output file are written. 

Message 

CYC NO. ccc RECORDS NOS.yyyyyy - zzzzzz 

where 

ccc 

yyyyyy 

zzzzzz 

is the cycle number. 

is the first input record number on the file. 

is the last input record number on the file. 

7831 0687–010 12–5


Response 

This message requires no response and is displayed for CONTA and REDOA purposes. 

End of Distribution Phase Message 

This message is displayed after all the input data is distributed to PARTA files: 

Message 

END PART A 

Response 

No operator response is necessary. If this is an automatic tape sort, a listing is displayed 

of the merge operations needed to complete the sort. In a nonautomatic tape sort, the 

sort either terminates or returns control to a FINAL address. 

12.3.2. Intermediate Merge Phase 

There are seven distinct console messages displayed during the intermediate merge 

phase. These messages are issued when 

1. An optional automatic tape sort is performed. 

2. The label block for each output reel is written. 

3. An input reel is requested. 

4. A label check is performed on the input reel just mounted. 

5. An end-of-reel or end-of-file block is detected on an input reel. 

6. An end-of-reel or end-of-file sentinel block is written on an output reel. 

7. All intermediate merge operations are performed on an automatic tape sort, or the 

single merge operation is performed on a nonautomatic sort. 

The following subschemas describe the console messages and the required responses. 

An Optional Automatic Tape Sort Is Performed Message 

If an automatic tape sort is being performed, the following message is displayed at the 

start of each merge operation: 

Message 

START MRG NO. ppp 

where ppp is the merge number of the merge operation to be performed. 

Response 

No operator response is necessary for this message. 

12–6 7831 0687–010

The Label Block for Each Output Reel Is Written Message 


After the label block for each output reel is written, the following message is displayed: 

Message 

cc/uu LABEL: REEL n of //xmmm 

where 

cc/uu 

n 


is the reel number. 

//xmmm 

is the label, with the following components: 

// 

x 

mmm 

Response 

User label prefix 

Merge level (B–Z) 

Merge number within the level 

The operator attaches the external label on the designated reel, and this tape is now 

available for use if a CONTB is necessary. No response is required for this message. 

An Input Reel Is Requested Message 

Message 

An input reel is requested by the following message: 

cc/uu MOUNT REEL n of //xmmm 

where 

cc/uu 

n 



7831 0687–010 12–7


//xmmm 


// 

x 

mmm 

Response 

User label prefix 

Merge level (B–Z) 

Merge number within the level 

After the input reel is mounted, the message can be answered with any character. 

A Label Check Is Performed on the Input Reel Just Mounted Message 

A label check is performed on the input reel just mounted. If the label or reel number 

does not agree with the label or reel requested, the input reel is rewound with interlock 

and the following message is displayed: 

Message 

cc/uu LABEL ERROR: REEL n of //xmmm 

where 

cc/uu 

n 



//xmmm 


// 

x 

mmm 

Response 

is the user label prefix 

is the merge level (B–Z) 

is the merge number within the level 

This message requires no response, and the message to mount the requested reel is 

repeated. The invalid input reel should be dismounted and the correct reel mounted. 

12–8 7831 0687–010


An End-of-Reel or End-of-File Block Detected on an Input Reel 

Message 

When an end-of-reel or end-of-file block is detected on an input reel, the input reel is 

rewound with interlock and a tape unit swap is performed. The following message is 

displayed: 

Message 

cc/uu DISMOUNT REEL n of //xmmm 

where 

cc/uu 

n 



//xmmm 


// 

x 

mmm 

Response 




The operator should dismount the designated reel. No response is required for this 

message. 

An End-of-Reel or End-of-File Sentinel Block Is Written on an Output 

Reel Message 

After an end-of-reel or end-of-file sentinel block is written on an output reel, the output 

reel is rewound with interblock, a tape unit swap is performed, and the following 

message is displayed: 

Message 

cc/uu DISMOUNT REEL n of //xmmm + MOUNT BLANK 

where 

cc/uu 


7831 0687–010 12–9


n 


//xmmm 


// 

x 

mmm 

Response 




The operator should dismount the output reel and mount a blank tape on the designated 

tape unit. This message can be answered with any character. 

End of Intermediate Merge Phase Message 

After all intermediate merge operations are performed on an automatic tape sort, or the 

single merge operation is performed on a nonautomatic sort, the following message is 

displayed: 

Message 

END PART B 

Response 

No response is required for this message. 

12.3.3. Final Merge Phase 

If the user program employs the IPURI$ linkage, the following message displays each 

time that information is punched: 

Message 

CONTC RERUN INFORMATION ccc CYCLE nnn CARDS 

where 

ccc 

nnn 

is the deck number. 

is the number of cards punched. 

12–10 7831 0687–010

Response 


No response is required for this message. The operator should remove the cards from 

the card punch hopper and mark them with the cycle number. 

12.3.4. CONTA – CONTB – CONTC 

The messages displayed for these runs are the same as those displayed for the 

distribution, intermediate merge, and final merge phase of the tape sort. 

12.3.5. REDOA – REDOB 

After the requested tape reel is re-created, one of the following messages is displayed 

depending on the phase of the tape sort being executed: 

or 

END REDO A 

END REDO B 

At this time, the PARTA or PARTB reel is re-created and the next phase of the tape sort 

can be executed. 

7831 0687–010 12–11


12–12 7831 0687–010

Appendix A 

Summary and Diagnostic Messages 

This appendix lists error messages that occur in the SORT processor (see A.1) and in the 

SORT subroutines (see A.2). It also lists the SORT subroutines summary messages 

written to the system log file at sort completion (see A.3). 

An error message with a number less than 10000 indicates that the error was detected 

by the SORT processor. An error message with a letter prefix or a number greater than 

9999 indicates that an error occurred in the SORT subroutines. 

Note: On all internal errors, hardware errors, and I/O errors, you should rerun the sort 

program. If the error persists, submit a UCF and provide the following information to the 

Support Center via RSS, FTP, or send on an unlabeled half-inch cartridge tape in COPY,G 

format: 

1. A PMD,AL after the error has occurred. 

2. The trail sheet showing all file assignments and console messages. 

3. If applicable, the SORT processor runstream. 

4. When possible, all input data files. 

5. A list of all SORT CHGs applied to this level of Sort/Merge. 

A.1. SORT Processor Error Messages 

A SORT processor error message is displayed on the user’s batch listing or at the 

demand terminal. The message can be preceded by a file name or parameter name and 

followed by a status message if appropriate. 

An error message that contains a letter prefix or a number greater than 9999 indicates 

that the error was detected by the SORT subroutines and not by the SORT processor. 

Error messages issued by the SORT subroutines are shown in A.2. 

SORT processor error messages have the following format: 

error message description 

where nn is the error message number less than 10,000. 

7831 0687–010 A–1


The following are the SORT processor error messages, listed by error number, along 

with the error message text and a description of the cause of the error. 

Error 

Number 

0 

1 

SORT PROCESSOR INTERNAL ERROR 

Message Text and Description 

The SORT processor has detected an impossible situation. This error should 

not be issued and a UCF should be submitted to correct this situation. 

SORT PROCESSOR INITIAL LOAD ERROR 

The SORT processor cannot be loaded properly. The SORT processor was 

improperly mapped or improperly installed on your OS 2200 system. 

2 INVALID PARAMETER SPECIFIED 

The input line does not contain a valid SORT processor parameter. Recheck 

input. 

3 THE FILE CANNOT BE ASSIGNED 

The SORT processor cannot assign a temporary file. The filename of the file 

and the facility status received are printed with this error. 

4 THE FILE MUST BE ASSIGNED 

The SORT processor needs the input or output file for further processing. 

5 THE PARAMETER SPECIFIED IS NOT A VALID LOCAL PARAMETER 

The parameter cannot be used as a local parameter. 

6 PARAMETER CAUSES AN OPERATION OR PROCESSING CONFLICT 

The parameter specified causes conflicts with another parameter or SORT 

processor call option. 

7 INVALID PARAMETER SYNTAX SPECIFIED 

An improper syntax structure was detected. 

8 TOO MANY INPUT FILES 

A maximum of 24 input files may be used. 

9 DECIMAL TO OCTAL CONVERSION ERROR 

An attempt was made to convert a number on the previous entry which 

contained a nonnumeric character. This error can occur if the SORT processor 

is given an incorrect MODE. The default mode is ACOB. 

A–2 7831 0687–010

Error 

Number 

10 AN INPUT FILE IS REQUIRED 



All operations require at least one input file. 

11 AN OUTPUT FILE IS REQUIRED 

The operation specified must have an output file. 

12 KEY DEFINITION OR USER COMPARE CODE IS REQUIRED 

A sort or merge operation requires a key definition (KEY parameter) or user 

compare code (OWN parameter). 

13 THE PARAMETER SPECIFIED IS NOT A VALID GLOBAL PARAMETER 

The parameter on the previous entry may only be used as a local parameter. 

14 A BLOCK-SIZE IS REQUIRED FOR THIS FILE 

The input file specified must have a block size specified. It cannot be 

obtained from the label information on the file. 

15 THE ACTUAL BLOCK-SIZE DOES NOT MATCH SPECIFIED BLOCK-SIZE 

The user input and label information do not agree. 

16 THE ACTUAL RECORD-SIZE DOES NOT MATCH SPECIFIED RECORD-SIZE 

The user input and label information do not agree. 

17 A RECORD-SIZE IS REQUIRED FOR THIS FILE 

The record size for the file cannot be obtained from the label information. 

18 SAVE/HOLD TAPE OPTION USED IMPROPERLY 

A conflict within the parameters or SORT processor call options has been 

detected. 

19 AN INDEX KEY IS REQUIRED FOR OUTPUT 

The file cannot be created without the index key. 

7831 0687–010 A–3


Error 

Number 

20 I/O ERROR DETECTED 


A hardware I/O error was detected during processing. Resubmit the run. 

21 INVALID EQUIPMENT TYPE ASSIGNED 

The file cannot be processed with the device it is assigned to. 

22 THE FILE IS ALREADY OPEN 

The file is still being processed. 

23 THE FILE WAS NOT OPENED BEFORE I/O REQUEST 

The SORT processor has detected an impossible situation. If this error is 

issued, submit a UCF. 

24 THE BLOCK-SIZE SPECIFIED IS TOO LARGE 

The block size given cannot be used because it is too large. 

25 THE FILE IS LOCKED AND CANNOT BE OPENED 

The file cannot be processed through the SORT processor. 

26 INVALID FILE STRUCTURE 

The file internally does not correspond with the mode specified. 

27 INVALID DATA BLOCK STRUCTURE 


28 INVALID LABEL STRUCTURE 


29 THE FILE IS NOT AN SDF FILE 

The mode specified is incorrect. 

30 INVALID INDEX KEY OR RECORD NUMBER USED IN DIRECT ACCESS 

An internal RETRIEVE error has been detected. Data corruption has occurred 

in the pointers used to retrieve records from the tag file. The tag file has been 

either modified or destroyed since its creation. 

This error may also be issued when an attempt is made to write beyond the 

externally defined boundaries of the file. 

31 FILE OUTPUT OVERFLOW - TOO MANY RECORDS 

A larger file is required for output. 

A–4 7831 0687–010

Error 

Number 



32 I/O INHIBITED FOR THIS FILE - CANNOT ACCESS 

The file has keys or is read/write protected. 

33 I/O WAS ATTEMPTED PAST THE END-OF-FILE 

A bad I/O was performed. May indicate an internal error. Resubmit the run. 

34 FILE FORMAT SPECIFIED IS NOT THE ACTUAL FORMAT TYPE 

The ANSI record/block structure of the input file differs from the structure 

specified or implied. 

35 BLOCK-SIZE MUST BE A MULTIPLE OF RECORD-SIZE 

A proper blocking factor cannot be calculated. 

36 ILLEGAL TAPE FORMAT FOR AN ANSI FILE 

The tape being accessed is not an ANSI tape. 

37 INCORRECT DATA BLOCK COUNT 

A bad blocking factor was calculated. 

38 UNIT ASSIGNMENT INCONSISTENT WITH FILE MODE 

The file specified may not reside on the medium it is assigned to. 

39 ERROR ON TLBL$ REQUEST 

An 8-bit label cannot be processed. 

40 TOO MANY LEVELS OF INDEX FOR FILE SIZE 

A larger file is needed for output. Assign a larger output file and resubmit the 

run. 

41 SPECIFIED INDEX KEY INCONSISTENT WITH ACTUAL INDEX KEY 

The index key specified is not the originally created index key. 

42 ACTUAL FILE MODE INCONSISTENT WITH MODE SPECIFICATION 

The file mode does not match specifications. 

43 A TAG AND/OR RETRIEVE SORT REQUIRES ONE AND ONLY ONE INPUT FILE 

Only one mass storage input file may be used. 

44 INVALID INPUT FILE FOR A TAG AND/OR RETRIEVE SORT 

The input file must be ACOB, CFH, DSDF, ISAM, or MSAM. 

7831 0687–010 A–5


Error 

Number 


45 THE FILE CANNOT BE RELEASED FROM THE RUN 

A bad status was received when trying to @FREE a file. Data corruption has 

occurred in the CSF$ image generated by Sort/Merge. Rerun and check for 

random stores caused by user own code or hardware error. 

47 PREP FACTOR CONFLICT 

The mass storage prepping factor specified either in the PREP parameter or in 

the Sort PREPDEFAULT configuration parameter does not match the actual 

prepping factor for this file. This error may also be issued while processing an 

ACOB file assigned to mass storage when the LINKSZ parameter is specified. 

48 LABEL TYPE INVALID FOR THIS FILE MODE 

The labels specified are not available for this file. 

49 ATTEMPTED LABELED OUTPUT TO AN UNLABELED TAPE 

The tape must have a label skeleton. 

50 INTERNAL BLOCK-SIZE GREATER THAN SIZE READ 

An I/O operation has been truncated. Recalculate and resubmit. 

51 INCONSISTENT RECORD CONTROL WORD 

The record control word does not agree with actual record length. 

52 INVALID RETURN CODE FROM USER EXIT 

The return cannot be processed; it is undefined. 

53 USER EXIT REQUIRED FOR PROCESSING 

User own code cannot be found; processing is halted. 

54 ESTIMATE IS NOT ALLOWED WITH THIS OPERATION 

An estimation can be performed only on a sort operation. 

55 INDEX KEYS ARE OUT OF SEQUENCE OR DUPLICATED 

Either of these conditions causes the processing to halt. 

56 DATA TYPE INVALID FOR THE OUTPUT FILE MODE 

When the mode of the output file is ANSI, the data type associated with this 

operation must be ASCII or 9-bit. When the mode of the output file is CFH, 

the data type associated with this operation must be Fieldata or 6-bit. 

A–6 7831 0687–010

Error 

Number 

57 ERROR ON @CKPT REQUEST 



The CKPT operation cannot be completed. Check register A0 for the status 

returned by Checkpoint/Restart (CKRS), remedy the problem, and rerun. 

58 DUPLICATE INPUT FILENAMES NOT ALLOWED 

A file name may be used for input only once. 

59 SCRATCH FACILITY CONFLICT FOR DISK SORT 

DISKS may not be used with TAPES or FAST. 

60 MAXIMUM CORE LIMIT HAS BEEN REACHED 

A core only sort has been specified via the Y processor option. The SORT 

processor has determined that the memory required to successfully perform 

the sort is greater than the size specified in the CORE parameter or is greater 

than the maximum that the SORT processor can use based upon the SORT 

configuration parameters. 

61 VOLUME GREATER THAN SORT ASSIGNMENT LIMIT 

The SORT processor cannot assign facilities because of the volume. 

62 NO SCRATCH FACILITIES ASSIGNED BY SORT 

An error condition was encountered while assigning facilities. Examine file 

assign statements and resubmit. 

63 ESTIMATION TERMINATED 

An error condition was encountered while estimating. The estimation has 

been terminated due to the error previously printed. 

64 SORT VOLUME CANNOT BE DETERMINED 

ESTIMATE requires some volume specification. 

65 SORT RECORD-SIZE CANNOT BE DETERMINED 

ESTIMATE requires RSZ specification. 

66 INSUFFICIENT SCRATCH FACILITIES FOR ESTIMATION 

The facilities specified or assigned won’t handle the sort volume. 

67 WRITE ATTEMPTED ON INPUT FILE 

An internal sort error has occurred. 

68 READ ATTEMPTED ON OUTPUT FILE 


7831 0687–010 A–7


Error 

Number 


69 INVALID KEY CONDITION ON WRITE, FILE CAN'T BE RESTORED 

An invalid key condition occurred when attempting to write a record. The file 

is corrupted and cannot be restored. 

70 RANDOM READ ATTEMPTED ON SEQUENTIAL FILE OR VICE VERSA 

The type of read attempted does not agree with the access mode of the file. 

This is probably due to a sort internal error. 

71 THE SORT PROCESSOR DID NOT SUPPLY ENOUGH I/O BUFFERS 


72 KEY OF REFERENCE GREATER THAN ANY KEY TYPE IN FILE 

An internal sort error has occurred. The specified key type (prime or alternate) 

for the read record function does not match that found in the MSAM file. 

Data corruption has probably occurred in the working area used by sort. 

73 BLOCK SIZE TOO SMALL 

The specified block size is smaller than the actual allowed size for the file. 

74 RECORD TO BE WRITTEN IS LESS THAN MINIMUM RECORD SIZE 

An internal sort error has occurred. The size of the MSAM record to be 

written is less than the minimum record size specified when the MSAM file 

was opened. Data corruption has probably occurred in the working area used 

by sort. 

75 RECORD TO BE WRITTEN EXCEEDS MAXIMUM RECORD SIZE 

An internal sort error has occurred. The size of ISAM or MSAM record to be 

written is greater than the maximum record size specified when the file was 

opened. Data corruption has probably occurred in the working area used by 

sort. 

76 KEY FIELD TYPE IS INCONSISTENT WITH THE DATA TYPE 

An ASCII or 9-bit key type (for example, S or T) was used with 

DATA=FIELDATA or DATA=6BIT, or a Fieldata or 6-bit key type (for example, 

A or D) was used with DATA=ASCII or DATA=9BIT. 

77 BLOCK SIZE MUST BE SPECIFIED FOR AN ESTIMATION 

The BLOCK parameter must be present for the input and output file during an 

estimate. 

78 INSUFFICIENT CORE FOR AN ESTIMATE 

CORE is less than the sort volume for a core-only sort estimation. 

A–8 7831 0687–010

Error 

Number 



79 CORE EXPANSION DENIED, D-BANK EXPANSION LIMITED TO 262K 

A request for additional core was attempted, however, the requested amount 

would have extended the D-bank beyond 262142 words. Immediately 

following this message, the processor will print a message indicating the core 

available and the core requested. This is for informational purposes. 

There are many conditions that can cause this error to be issued. Possible 

corrective actions include: 

• Decrease the amount of core specified by the CORE parameter. 

• Decrease the blocking factor specified by the BLOCK parameter. 

• Reduce the blocking factor if a RETRIEVE operation is performed since 

RETRIEVE uses 10 input buffers. 

• Reduce the number of additional MSAM buffers specified on a 

MODE=MSAM parameter. 

80 PARAMETER EXCEEDS MAXIMUM LENGTH 

Too many characters were used to specify a set of fields in the parameter. 

81 PARAMETER NOT ALLOWED WITH FILEIN OR FILESIN 

You specified a parameter not supported by FILEIN or FILESIN. 

The following parameters are valid for FILEIN: BLOCK, EQUIP, FILEID, JOIN, 

LABEL, MODE, MOVE, NUMREC, PREP, REELS, SELECT, SKIPL, and 

STOPAPP. 

The following parameters are valid for FILESIN: BLOCK, EQUIP, FILEID, 

JOIN, LABEL, MODE, MOVE, NUMREC, PREP, SELECT, SKIPL, and 

STOPAPP. 

82 PARAMETER NOT ALLOWED WITH FILEOUT 

You specified a parameter not supported by FILEOUT. 

The following parameters are valid for FILEOUT: BLOCK, BMBLOCK, CODE- 

TYPE, EQUIP, FILEID, LABEL, MODE, PREP, REELS, REUMSAMBLK, and 

SPLIT. 

83 SRT$PAR.SORTDEFAULTS CONTAINS AN ERRONEOUS OR ILLEGAL IMAGE 

The format of SRT$PAR.SORTDEFAULTS is incorrect. It may be an invalid 

name or the equal sign between the name and value is missing. See the site 

installation manager for resolution. 

7831 0687–010 A–9


Error 

Number 


84 THESE PARAMETERS MUST BE AN UNINTERRUPTED SET 

Sort can accumulate several of these parameters only if they are given as an 

uninterrupted set. 

85 DECIMAL DATA TYPE IS NOT ALLOWED FOR FIELD 1 WORD 

Sort cannot split decimal values across word boundaries. 

86 INCONSISTENT TEST VALUE LENGTH 

The test value length must match the number of characters specified on the 

ACCEPT parameter. 

87 ACCEPT CANNOT BE USED WITH ALLOW OR REJECT 

The ACCEPT parameter is an alternative to the ALLOW and REJECT 

parameters. 

88 ERROR UPON INFO$ REQUEST 

INFO$ request returned an error status due to an internal sort error. 

89 ONLY 1 PERMITTED. THE LAST WILL BE USED. 

You specified more than one ALLOW parameter. In this case, the system 

accepts the last ALLOW and ignores previous ALLOW parameters. 

90 ONLY 1 PERMITTED. THE LAST WILL BE USED. 

You specified more than one REJECT parameter. In this case, the system 

accepts the last REJECT and ignores previous REJECT parameters. 

91 TAPE LABEL AND OBSERVED BLOCK COUNTS DIFFER 'RUN ABORTED' 

The SORT processor counts the blocks as it processes ACOB and CFH 

labeled tapes. If the final block count differs from what was specified in the 

tape trailer label, the sort is aborted. 

92 WARNING - FILEIN WITHOUT MAY GET TRUNCATED RECORDS 

SELECT processing is active, but the designated FILEIN has no applicable RSZ 

or SELECT parameter. The largest SELECT record determines the size of the 

designated FILEIN. Longer records from this file are truncated. 

93 NUMBER OF WORDS WRITTEN BY EXEC ARE LESS THAN NUMBER REQUESTED 

This error is issued when an error code 75 is returned from PCIOS. 

97 WARNING - DUPLICATE PRIMARY KEYS NOT ALLOWED - OPTION IGNORED 

A duplicates allowed (D) option is found on the primary MSKEY/MSKEYW 

parameter. The option is ignored for that key, and processing continues. 

A–10 7831 0687–010

Error 

Number 



98 WARNING - FOR NON-PCIOS SDF FILE, DEFAULT RSZ=33 WORDS 

You did not specify the RSZ parameter for a non-PCIOS SDF file. Therefore, 

RSZ=33 words is assumed. 

99 WARNING - DUPLICATE RSZ PARAMETER NOT ALLOWED 

100 INPUT FILE CANNOT BE USED AS AN OUTPUT FILE FOR THIS OPERATION 

The input file specified in the FILEIN or FILESIN parameter cannot be the 

same physical file as the output file specified in the FILEOUT parameter for 

the COPY, MERGE, RETRIEVE, or TAG/RETRIEVE operations. 

102 CONFLICTING ASCII TRANSLATE TABLES SPECIFIED 

Two or more ASCII translation tables are specified by using the SEQX 

parameters for an estimate operation. 

104 THE PREPPING FACTOR IS TOO LARGE 

When creating an ACOB file assigned to mass storage, the prepping factor is 

not one of the valid prepping factors (28, 56, or 112). If the prepping factor 

exceeds 112, the Sort processor will use 28. 

105 WARNING - TOO MANY MSAM BUFFERS ARE BEING USED; MAX ASSUMED 

Too many MSAM buffers have been requested. The maximum number of 

MSAM buffers that can be used is 63. The number of buffers being used is 

equal to 4 plus the number of index keys specified on the MSKEY or 

MSKEYW parameter plus the number of additional buffers requested via the 

MODE parameter. You must either reduce the number of index keys or 

reduce the number of additional buffers being used. The maximum of 63 

buffers will be used and the operation will continue. Please note that using 

this many MSAM buffers may result in the processor issuing error 79. 

106 INVALID NUMBER OF BITS/CHARACTERS IN DATE KEY 

When using the DATE key type in the KEY parameter, the number of 

characters specified in the number of characters field must be at least 2. 

When using the DATE key type in the KEYW parameter, the number of bits 

specified in the number of bits field must be at least 18. 

107 DEFYEAR PARAMETER SPECIFIES AN INVALID VALUE 

The value specified in a DEFYEAR parameter must be in the range 0 to 99. 

7831 0687–010 A–11


Error 

Number 


108 ERROR ON TAPE SWAP (ER TSWAP$) REQUEST 

A tape swap was requested and an error status was returned from the 

TSWAP$ Executive Request. The file name was printed before this error 

message and the error status returned on the ER TSWAP$ is printed after this 

error message. Please refer to the Executive Requests Programming 

Reference Manual for a further explanation of the TSWAP$ error code. 

110 THE MODE OF THIS FILE SHOULD BE CARDS NOT SDF 

The label control word indicates that this input file is a CARD file, not a PCIOS 

SDF file (for example, H1 contains 0502410). Please specify MODE=CARDS 

for this file. 

111 THE MODE OF THIS FILE SHOULD BE PRINT NOT SDF 

The label control word indicates that this input file is a PRINT file, not a PCIOS 

SDF file (for example, H1 contains 0502425). Please specify MODE=PRINT 

for this file. 

112 SPECIFIED RSZ LESS THAN ACTUAL RECORD SIZE - FILE CLOSED 

The specified RSZ parameter or default record size is less than the actual 

record size for this alternate symbiont input file. This causes the ER SYMB$ 

to do a partial read of the input image. This alternate symbiont input file has 

been closed using a @BRKPT file name. 

113 I/O BUFFER SIZE IS TOO SMALL TO ALLOW MSAM FILE TO BE BUILT 

This error is issued when PCIOS has returned a 26 error status to SORT. The 

I/O buffer size is too small to allow the MSAM file to be created. You must 

make the input record size large enough to hold the record. Consider 

changing the RSZ or BLOCK parameters. 

114 ILLEGAL FILENAME FOR SYMBIONT IO 

This file name should not be specified as an input or output file name when 

the MODE of the file is PRINT or CARDS. 

115 THE ACTUAL FILE-ID IN LABEL DOES NOT MATCH SPECIFIED FILEID 

The file-id in the label does not match the FILEID parameter. If the file 

identifier was specified as a character string, registers A5, A6, and A7 will 

contain the Fieldata equivalent of the ASCII file-id in the label. If the file 

identifier was specified as a nonnumeric literal, registers A5, A6, A7, A8, and 

A9 will contain the ASCII file-id in the label. 

116 THE FILEID PARAMETER NOT ALLOWED WITH THIS FILE TYPE 

The FILEID parameter is not allowed with this file type. Allowed file types are 

ACOB, ANSI, DSDF, MSAM, or SDF. 

A–12 7831 0687–010

Error 

Number 



117 THE PROCESSOR CANNOT PROCESS THIS ANSI RECORD FORMAT 

The SORT processor has encountered an invalid record format for an ANSI 

file. 

118 FILE SIZES GREATER THAN 262143 TRACKS NOT SUPPORTED BY FILE 

MODE 

An input or output file that has a size greater than 262143 tracks has been 

specified. The MODE associated with that file, either ACOB, CFH, ISAM, or 

MSAM, does not support such a file. 

119 WARNING - MAXIMUM FILE SIZE EXCEEDED, CONVERTED TO POSITIONS 

The maximum value that may be specified for a file size has been exceeded. 

When the granularity of the associated file is tracks, the file size and 

granularity are changed to positions. 

120 WARNING - PARAMETER VALUE EXCEEDS MAXIMUM, MAXIMUM ASSUMED 

The SORT processor has determined that the maximum value that may be 

specified for one or more of the fields in the current parameter has been 

exceeded. The maximum value for those fields will be used. 

121 ZERO LENGTH RECORD ENCOUNTERED 

A zero length record has been encountered during record processing. This 

error is known to occur as a result of describing a fixed unblocked or fixed 

blocked ANSI tape file as a variable unblocked or variable blocked file. 

122 MAXIMUM RECORD LENGTH EXCEEDED FOR ANSI OUTPUT FILE 

The maximum record length for a variable blocked or variable unblocked ANSI 

file is 9,999 (9-bit) characters. This limit includes the 4-character record 

control word. 

123 UNKNOWN OR INVALID EQUIPMENT TYPE SPECIFIED 

The ESTIMATE operation has encountered a scratch file assigned to an 

unknown device or the assign mnemonic specified on a scratch file facility 

parameter is unknown to the SORT processor. If you have not specified an 

incorrect assign mnemonic in a scratch file facility parameter, please submit a 

UCF so that this device or assign mnemonic can be added to the recognized 

list within the SORT processor. 

124 RECORD LENGTH MUST EQUAL MAXIMUM RECORD LENGTH 

All records that are being written on to a fixed formatted output ANSI file 

must be equal to the maximum record length. 

7831 0687–010 A–13


Error 

Number 


125 WARNING - FILEOUT LOCAL PARAMETER CONFLICTS WITH THE FILE MODE 

A local parameter associated with the FILEOUT parameter is not appropriate 

with the mode of the output file. For example, you have used the 

REVMSAMBLK parameter and the mode of the output file is not MSAM. The 

local parameter is ignored. 

126 LABEL RECORD CANNOT BE READ BY EXPIPE 

ExPipe returned an error to the SORT processor indicating that it was unable 

to read the label record for this ExPipe file. 

127 EXPIPE REQUEST IS NOT ALLOWED 

ExPipe returned an error to the SORT processor indicating that an illegal 

function was requested. This is an internal error and you should submit a 

UCF. 

128 ERROR IN ER SYMB$ REQUEST 

An error was returned after the SORT processor performed an ER SYMB$. 

129 THE LENGTH OF THE FILE IDENTIFIER IS INVALID 

The value specified for the file-id parameter must be 1 to 17 characters in 

length. The length does not include the delimiters when a nonnumeric literal 

is used. 

130 WARNING - NONNUMERIC LITERAL IS MISSING THE CLOSING DELIMITER 

A nonnumeric literal is a character string delimited on both ends with 

apostrophes or quotation marks. Both delimiters must be the same. The 

character string being processed has been recognized as a nonnumeric literal, 

but a closing delimiter is missing. 

131 AN I KEY MUST NOT BE SPECIFIED FOR THIS OPERATION 

This error is issued for a TAG, TAG/RETRIEVE, or a RETRIEVE operation. This 

error will not be issued for a copy or estimate operation. An I key type is 

meaningful only for a sort or merge operation. 

132 WARNING - A CODE-TYPE DOES NOT EXIST FOR THIS MODE 

The CODE-TYPE parameter should only be specified for files with a mode of 

CARDS, PRINT, SDF, or DSDF. These are the only file modes where a code 

type has meaning. 

133 WARNING - CODE-TYPE EXCEEDS THE MAXIMUM ALLOWED VALUE 

The CODE-TYPE value exceeded the maximum allowed value of 63 (077). A 

code type 01 will be assumed. 

A–14 7831 0687–010

Error 

Number 



134 CODE-TYPE SPECIFIED IS A UNISYS RESERVED CHARACTER SET VALUE 

A Unisys reserved character set value was specified in the CODE-TYPE 

parameter. Update the CODE-TYPE parameter with a valid value and rerun 

the job. 

135 DATA PARAMETER CONFLICTS WITH OTHER PARAMETERS OR OPTIONS 

The value specified on the DATA parameter conflicts with another parameter 

or with a processor call option. Potential parameter conflicts include 

specifying DATA=FIELDATA or DATA=6BIT with 

• An I key 

• A CODE-TYPE parameter with a value not equal to zero 

• A LOCALE parameter 

Or specifying DATA=ASCII or DATA=9BIT with 

• A CODE-TYPE parameter with a value equal to zero 

• Processor call option C or M 

136 WARNING - THE LENGTH OF THE LOCALE NAME IS INVALID 

The name specified on the LOCALE parameter contains an incorrect number 

of characters. The locale name must contain at least one character but no 

more than 16 characters. If the locale name contains more than 16 

characters, the locale name is truncated to 16 characters. 

137 I KEY NOT ALLOWED WITH THIS MODE 

An I key can only be specified when the mode of the output file is CARDS, 

PRINT, SDF, DSDF, MSAM, or ANSI. 

140 THE CODE-TYPE CONFLICTS WITH THE INPUT FILE(S) CODE TYPE 

A conflict exists between the code type specified on the FILEOUT parameter 

and the code type of the input files. The code type of the input files must 

either be 01 or match the code type specified on the FILEOUT parameter. 

One way to prevent this error is to ensure that the CCSLOCNUMCHK 

configuration parameter is set to OFF. 

141 I KEY TYPE CANNOT BE USED WITH A BASIC MODE SORT 

An I key type can be used only with an extended mode sort. 

7831 0687–010 A–15


Error 

Number 


142 WARNING - CODE-TYPE CONFLICTS WITH THE CODE TYPE OF LOCALE 

The value specified in the CODE-TYPE parameter does not match the code 

type associated with the locale that is in force. The value specified in the 

CODE-TYPE parameter is ignored, and any code-type number written to the 

output file will be the code type associated with the locale in force for this 

operation. 



143 LOCALE CONFLICT WITH MSAM FILES 

A conflict has been encountered involving the locale for an MSAM input file 

and the locale for the MSAM output file. This error may be issued when 

multiple input MSAM files exist and their respective locales are not the same. 



144 CODE-TYPE OF AN INPUT FILE AND MSAM OUTPUT FILE CONFLICT 

A conflict has been encountered between the code type associated with the 

locale for the MSAM output file and the code type of a non-MSAM input file. 

This error may be caused by the setting of the DEFCTYPE and DEFLOCALE 

configuration parameters. 



145 ERROR RETURNED BY I18NLIB SERVICE ROUTINE 

An I18NLIB service routine encountered an error that SORT did not expect. 

This error may be due to an internal sort error and you should submit a UCF. 

146 LOCALE NOT FOUND 

The desired locale for the operation could not be found on the system. Please 

verify that the name of the locale you specified is correct and that it is 

installed on the system. Remember that locale names are case sensitive. 

160 TOO MANY STOP PARAMETERS SPECIFIED 

The maximum number of STOP parameters is 50. This runstream exceeds 

the maximum number allowed. Reduce the number of STOP parameters and 

resubmit the run. 

A–16 7831 0687–010

Error 

Number 



161 WARNING - ACCESS MODE CHANGED FROM SEQUENTIAL TO RANDOM 

The SORT mode of the MSAM output file was changed from sequential to 

random by the SORT processor. Please refer to the MODE parameter in the 

Sort/Merge Programming Guide for conditions that cause the processor to 

issue this error. 

162 WARNING - SEQUENTIAL ACCESS SPECIFIED ON COPY 

An ACCESS mode of SEQUENTIAL has been specified for the MSAM output 

file. Please be positive that the records in the input files are in ascending 

order. If not you may encounter additional errors such as processor error 

. The default access mode specification for a COPY operation is 

RANDOM. 

163 WARNING - NUMREC RECORDS PROCESSED, MORE INPUT RECORDS MAY 

EXIST 

The number of records specified by a local NUMREC parameter have been 

processed and more records may exist in the file named immediately before 

this error message. The file is closed and processing continues. 

This error will also be issued when the number of records specified by a 

global NUMREC parameter have been processed and more records exist in 

the current input file or in an unopened input file. Input is terminated and 

processing continues. 

164 RECORD LENGTH EXCEEDS MAXIMUM RECORD LENGTH 

PCIOS has returned error code 59 to the SORT processor. This error code 

indicates that a record has been encountered with a length that exceeds the 

maximum record length that this file was expecting. 

165 WARNING - AN INPUT RECORD TRUNCATED ON OUTPUT 

The input file identified contains a record longer than the record length that 

SORT was expecting. Some records in the resultant output file have been 

truncated. The bit length of the record causing this warning and the current 

maximum bit length are stated in a subsequent message. To avoid receiving 

this warning, specify an RSZ parameter with a record length equal to or 

greater than the maximum record length from all input files. 

7831 0687–010 A–17


Error 

Number 

INCONSISTENT BLOCK SIZES 


The block size on the file does not agree with the block size supplied by the 

BLOCK parameter. 

INCONSISTENT RECORD SIZES 

CURRENT SIZE:xxxxxx CONFLICTING SIZE:xxxxxx 

The record size (xxxxxx) on the file does not agree with the record size 

supplied by the RSZ parameter. 

A.2. SORT Subroutine Error Messages 

SORT subroutine error messages are displayed in three ways 

• On the operator console 

• On the user’s batch listing 

• On the demand terminal 

SORT subroutine errors can also be returned to the program without being displayed on 

the operator’s console, user’s listing, or the demand terminal. For the basic mode 

MASM linkages, the 2-Fieldata-character error indicator for the error is returned to the 

error routine indicated by the ERROR parameter. 

For the UCS C linkages, most errors are returned as an integer value in the message_id 

field of the result status parameter (see 8.2.1). In some instances where the error 

cannot be returned via the result status parameter, the error message will be issued to 

either the user’s listing or the demand terminal. 

SORT subroutines error messages that appear on the operator’s console consist of the 

following types of errors: 

• Nonrecoverable errors 

The format of a nonrecoverable error is the following: 

SORT ERROR CODE = xx 

where xx is the 2-character alphanumeric error indicator. 

• Recoverable errors 

The format of a recoverable error is the following: 

SORT ERROR CODE = xx cc/uu ss GN 

A–18 7831 0687–010

where 

xx 

is the 2-character alphanumeric error indicator. 

cc/uu ss 

GN 


are the 2-character indicators for channel/unit and status of the device on which 

the error occurred. 

specifies the two possible operator responses: 

G = go 

N = no go 

The severity of an error message issued affects the status of the operation being 

performed. The operation is identified by basic mode MASM linkage sort dbank address 

or the UCS C linkage dbank address parameter. If multiple errors are encountered on 

one call to a SORT subroutines linkage, only the most severe error is returned. Major or 

failure severity errors are always returned. The following lists and describes the 

meaning and affect of each error severity in order from least severe to most severe: 

Warning The requested operation performed an action that it determined the caller 

requested. The action taken, such as padding a record, should be harmless. 

If the caller did not intend for this action to occur, the current operation must 

be restarted to correct the situation. If the caller intended this action to 

occur, the operation can continue. 

Minor The requested operation performed an action that it determined the caller 

requested. The action taken, such as truncating a record, could be 

detrimental to the operation or the data. If the caller did not intend for this 

action to occur, the current operation must be restarted to correct the 

situation. If the caller intended this action to occur, the operation can 

continue. 

Major A situation has been encountered that prevents the requested call from 

continuing without being corrected. The caller can attempt to correct the 

situation and perform the call again. The operation is in a state that can be 

resumed. 

Failure A situation has been encountered that prevents the requested call and 

operation from continuing. The caller cannot resume this operation and the 

operation must be closed. The caller must restart the operation from the 

beginning. 

The following are the SORT subroutine error messages with the UCS C linkage 

message_id, the basic mode MASM 2-character error indicator, the severity of the error, 

the text of the error message, and an explanation of the error message. The messages 

are listed in alphabetic/numerical error code order. If an error message is not issued by 

the basic mode MASM linkages or the UCS C linkages, the error code for that message 

is indicated by none in the appropriate column. 

7831 0687–010 A–19


UCS C 

Linkage 

BM 

Linkage 

Severity 


10000 None Warning RECORD PADDING OCCURRED 

When releasing records via the SORT subroutines UCS C Sort 

Release Linkage, one or more of the records was padded to the size 

specified in the RSZ parameter. The padding occurred because a 

fixed length sort was requested and the record was shorter than the 

record size defined by the RSZ parameter. 

When returning records in the fixed records formatted buffer via the 

SORT subroutines UCS C Sort Return Linkage, one or more of the 

records placed into the buffer was padded. The padding occurred 

because the length of the record was shorter than the length of the 

records requested as stated in the record_length field of the 

record_information_packet parameter. 

10001 None Warning NUMBER OF RECORDS OVERRODE BUFFER LENGTH 

When releasing a record buffer via the SORT subroutines UCS C 

Sort Release Linkage with a nonzero number_of_records field in the 

record_information_packet, the requested number of records have 

been released prior to the end of the buffer as specified by the 

buffer_length field of the record_information_packet. This is the 

defined situation; however, this status is being returned in case an 

inconsistency between the number_of_records and buffer_length 

fields should not have occurred. 

10002 None Warning RESERVED FIELD IN RECORD CONTROL WORD IS NONZERO 

When releasing records via the SORT subroutines UCS C Sort 

Release Linkage, at least one the records in the variable1 records 

formatted buffer had a record control word with a reserved field 

being nonzero. All reserved fields should be zero to eliminate future 

incompatibilities if the reserved field needs to be defined. The data 

in the reserved field has been ignored. 

10003 None Minor RECORD TRUNCATED 

The single record released or one or more of the records released in 

a record buffer call to the SORT subroutines UCS C Sort Release 

Linkage is longer than the maximum record size as stated in the RSZ 

parameter. The records longer than the maximum record size were 

truncated to the maximum size. All data beyond that point has been 

lost. 

When returning a fixed records formatted buffer, one or more of the 

records placed into the buffer was longer than the requested record 

length as specified in the record_length field of the 

record_information_packet. The records longer than record_length 

were truncated to that size and all data beyond that point has been 

lost. 

A–20 7831 0687–010

UCS C 

Linkage 

BM 

Linkage 

Severity 



10004 None Major RECORD BUFFER TOO SMALL 

When returning records via the SORT subroutines UCS C Sort 

Return Linkage, the length of the record buffer defined by the 

record_address parameter (buffer_length field of the 

record_information_packet) is smaller than the length of the next 

record to be returned. A larger buffer should be allocated and the 

call to the UCS C Sort Return Linkage should be attempted again 

with the larger buffer. 

10005 None Major COMPLETE RECORD NOT CONTAINED WITHIN RECORD BUFFER 

When releasing records via the SORT subroutines UCS C Sort Release 

Linkage, the current record is not completely contained within the 

buffer. The entire record must be contained within a buffer. The 

record_length field of the record_information_packet defines the offset 

within the buffer where the error was detected. All prior records have 

been released to the SORT subroutines. The operation can be 

continued by placing the entire record in the next buffer along with 

any additional records of the same record buffer format. 

10006 None Major ZERO LENGTH SPECIFIED IN RECORD CONTROL WORD 

When releasing records in a variable1 records formatted buffer or 

variable2 records formatted buffer, a record control word with a 

length field of zero (0) was encountered. The record_length field of 

the record_information_packet defines the offset within the buffer 

where the error was detected. All prior records have been released 

to the SORT subroutines. 

10007 None Major END OF BUFFER ENCOUNTERED BEFORE PROCESSING 

REQUESTED RECORD COUNT 

When releasing records in any buffer format, the end of the buffer 

as defined by the record_address parameter plus the buffer_length 

field of the record_information_packet was encountered before 

processing the number of records specified in the 

number_of_records field of the record_information_packet. All 

complete records have been processed. 

10008 None Major RETURN OF A VARIABLE2 RECORDS FORMATTED BUFFER 

ILLEGAL 

The request for returning records via a variable2 records formatted 

buffer is rejected since the requirements for returning that buffer 

format are not satisfied. To return records via a variable2 records 

formatted buffer the following conditions must be satisfied: 

• All records must be released via a variable2 records formatted 

buffer. 

• When the records were released, no record truncation or record 

padding occurred. 

7831 0687–010 A–21


UCS C 

Linkage 

BM 

Linkage 

Severity 


10009 None Warning GRANULARITY FIELD CHANGED 

The record_gran field or the buffer_gran field or both have changed. 

In order to return the correct information in the record_length or 

buffer_length fields, the requested or stated granularity of one or 

both of these fields has been changed. The data records released or 

returned are not affected 

10010 None Major INVALID GRANULARITY FIELD SPECIFICATION 

The value contained in the record_gran or the buffer_gran field of 

the Record Information Packet (RIP) is invalid or the granularity field 

in a variable1 records formatted buffer record control word (RCW) 

contains an invalid value. If the RIP is in error, no records have been 

released or returned. If a variable1 records formatted buffer RCW is 

in error, all records preceding the invalid RCW have been released. 

None A0 Failure SCRATCH TAPE TOO SHORT 

You must provide a larger capacity scratch tape or multiple volumes. 

None A1 Failure SEQUENCE ERROR ON TAPE 

An internal SORT subroutine error has occurred. If this error is 


None A2 Warning ILLEGAL NUMBER OF WORDS ON TAPE 

A discrepancy between words written and words read has been 

found. Data corruption has occurred in the working area used by 

Sort/Merge. 

None A3 Warning CHECKSUM ERROR ON TAPE 

A possible hardware malfunction has been detected. Examine the 

run termination messages for data check errors. 

None A4 Failure ER TINTL$, TLBL$, TSWAP$, OR CSF$ RETURNED AN ERROR 

An ER TINTL$, ER TLBL$, ER TSWAP$, or ER CSF$ returned an error for a 

tape sort scratch file. Sort was unable to recover from this error. 

None A5 Warning READ ERROR ON TAPE 

An I/O error has been detected by the Exec. 

None A6 Failure WRITE ERROR ON TAPE 


None A7 Warning BLOCK COUNT ERROR ON TAPE 

A possible hardware malfunction or SORT subroutine internal error 

has been detected. Data corruption may have occurred in the 

working area used by Sort/Merge. 

None A8 Failure ERROR ON TAPE RECOVERY ATTEMPT 

The attempt to recover from a tape error has been aborted. 

A–22 7831 0687–010

UCS C 

Linkage 

BM 

Linkage 

Severity 



None A9 Failure INVALID DEVICE NAME FOR A TAPE SCRATCH FILE 

A tape sort obtained an invalid device name or the tape module 

corrupted the device name. This error is an internal error to the tape 

module. Please submit a UCF if this error is issued. 

33840 B0 Failure PARAMETER TABLE FORMAT ERROR 

The SORT subroutines have detected that the parameter table has 

an incorrect format. 

33841 B1 Failure NO RECORD SIZE SPECIFIED 

33842 B2 Failure INVALID 'CORE' SIZE 

You must define record size in the parameter table. 

The CORE parameter has been specified with one of the following 

conditions: 

1. The size of the specified basic mode core area does not fit in the 

basic mode address range. 

2. The size of the specified extended mode core area is less than 

210000. 

33843 B3 Failure NO ‘CORE' SPECIFIED AND NO R$CORE ASSIGNMENT 

You must define a CORE parameter of at least 1000 or assign the 

file R$CORE. 

None B4 Failure INVALID 'CONTA' OR 'REDOA' PARAMETER 

An invalid CONTA or REDOA parameter was detected. Ensure that 

all required parameter entries have been specified. 

33845 B5 Failure LINK SIZE IS LARGER THAN RECORD SIZE 

You cannot define a link size larger than the record size. 

None B6 Failure INCONSISTENCY IN CONTROL PARAMETERS 

You cannot define more than one parameter from each of the 

following: 

SMRG, PARTA, PARTB, PARTC, or 

REDOA, REDOB, CONTA, CONTB, CONTC 

7831 0687–010 A–23


UCS C 

Linkage 

BM 

Linkage 

Severity 


33847 B7 Major RECORD LENGTH LESS THAN MINIMUM OR GREATER THAN 

MAXIMUM 

The length of a record released to sort was less than the minimum 

allowed or greater than the maximum. For any operation, the record 

must be long enough to contain all keys. For the basic mode sort 

release linkage, the length of a record cannot exceed the maximum 

record size defined by the RSZ parameter. 

33848 B8 Failure SCRATCH FILE FACILITY TYPE IMPROPERLY ASSIGNED 

You must assign scratch files on tape or mass storage. 

33849 B9 Failure INSUFFICIENT CORE FOR MERGE 

Main storage amount specified by the CORE parameter or R$CORE 

is insufficient for merge. Recalculate the main storage. 

34352 C0 Failure SORT ENCOUNTERED AN INVALID ADDRESS 

The Sort/Merge subroutines encountered an invalid address for a 

parameter table or a parameter that contains an address. 

None C1 Failure ATTEMPT TO REFERENCE AN ELEMENT NOT COLLECTED 

Reassemble your sort program with the appropriate R$FILE 

parameters. 

None C2 Failure NOT ENOUGH D-BANK PROVIDED FOR SORT OR MERGE 

The amount of D-bank space required by Sort/Merge has not been 

sufficiently allocated 

34355 C3 Failure PROPER D-BANK NOT PROVIDED FOR SORT OR MERGE 

D-bank area was not provided for Sort/Merge. 

None C4 Failure VARIABLE LENGTH RECORDS NOT ALLOWED WITH DATA 

REDUCTION 

Variable-length records are not allowed when data-reduction own 

code (DROC) is specified. 

34357 C5 Failure EXEC RETURNED AN ERROR STATUS TO CONTINGENCY 

REGISTRATION 

During the initialization of an extended mode sort, the Exec returned 

an error status while trying to register for extended mode 

contingencies. 

None C6 Failure MIXED MODE ENVIRONMENT DOES NOT FOLLOW URTS 

CONVENTIONS 

The UCS Runtime System (URTS) conventions were not followed 

when an extended mode sort was attempted using the basic mode 

entry points. 

A–24 7831 0687–010

UCS C 

Linkage 

BM 

Linkage 

Severity 



34359 C7 Major SORT SUBROUTINE CALLED WITH INVALID PARAMETER LIST 

Either an incorrect number of parameters were specified or Sort 

determined that one of the parameters specified in the parameter 

list was invalid on the call to the SORT subroutines. 

34360 C8 Failure INCORRECT NUMBER OF RECORDS RETURNED 

The SORT subroutine has detected a difference between the 

number of records released and the number of records returned. 

Any records removed by data reduction have been taken into 

account. 

34361 C9 Failure ILLEGAL PARAMETER FOR RDMS SORT 

The Sort parameter table contains an OPTION parameter indicating 

that RDMS has initiated the sort (bit 33 set) with one of the 

following illegal conditions: 

1. The CORE parameter indicates a basic mode sort. 

2. A COMP, a KEY, or a sequence parameter (for example, SEQ or 

SEQA) is specified. 

3. A MERGE operation is specified. 

4. The OPTION parameter indicates that the SORT subroutines 

were called by the SORT processor. 

None D0 Failure LOGICAL ERROR IN M1 MODULE 



None D4 Failure SEQUENCE ERROR IN M1 MODULE 



None D5 Failure READ/WRITE ERROR ON M1 


None D6 Failure CHECKSUM ERROR ON M1 

A possible hardware malfunction has been detected. Examine the 

run termination messages for data check errors. 

None D7 Failure BLOCK COUNT ERROR ON M1 




None D8 Failure M1 BLOCK SIZE IS LESS THAN MINIMUM 

Calculated block size is less than minimum allowed by LIMDRM 


7831 0687–010 A–25


UCS C 

Linkage 

BM 

Linkage 

Severity 


None E0 Failure INSUFFICIENT CORE ALLOCATED OR BLOCK SIZE SPECIFIED TOO 

SMALL 

You must increase either main storage or block size. 

None E1 Failure INSUFFICIENT CORE ALLOCATED TO PERFORM TAPE MERGE 

You must define larger main storage size. 

None E2 Failure OUTPUT TAPE FOR ‘REDOB' IS TOO SMALL 

You need a larger capacity tape. 

None E3 Failure NO RERUN INFORMATION ON ‘REDOB' OUTPUT TAPE 

You have a bad rerun tape. The REDOB must be re-executed 

because the output tape has been corrupted. 

None E4 Failure INSUFFICIENT NUMBER OF TAPES TO MERGE 

You need at least two tapes to do a tape merge. 

None E5 Failure INCORRECT ADDRESS OF ‘CONTC' INFORMATION 

You must check your parameter table. 

None E6 Failure REEL TABLE OR LABEL TABLE ENTRY MISSING 

The tape module internally maintains two tables, a label table and a 

reel table to identify and maintain a record of the tape scratch files. 

An entry in one of the tables is missing. This error is an internal 

error to the tape module. Please submit a UCF if this error is issued. 

None E7 Failure A PARAMETER TABLE 012 ENTRY IS REQUIRED 

A 012 entry is required following a 030, 031, or 032 to indicate the 

2-character prefix for tape labels. 

None E8 Failure REEL TABLE OR LABEL TABLE OVERFLOW 

The tape module internally maintains two tables, a label table and a 

reel table, to identify and maintain a record of the tape scratch files. 

One of the tables overflowed. For this sort to complete, the size of 

the table that overflowed must be increased. Please submit a UCF 

if this error is issued. 

None F0 Failure LOGICAL ERROR IN M2 MODULE 



None F4 Failure SEQUENCE ERROR IN M2 MODULE 



None F5 Failure READ/WRITE ERROR ON M2 


A–26 7831 0687–010

UCS C 

Linkage 

BM 

Linkage 

Severity 

None F6 Failure CHECKSUM ERROR ON M2 



A possible hardware malfunction has been detected. 

None F7 Failure BLOCK COUNT ERROR ON M2 




None F8 Failure M2 BLOCK SIZE IS LESS THAN MINIMUM 

Calculated block size is less than minimum allowed by LIMFST 

parameter. 

None G1 Failure PARAMETER CARD INCORRECT 

This is not a legal runtime parameter or the syntax is incorrect. 

None G2 Failure CARD TABLE OVERFLOWED 

There is not enough room in the runtime parameter table. 

37424 I0 Failure INVALID USER CORE AREA START ADDRESS AND LENGTH 

COMBINATION 

All or a part of the user core area provided is not within the current 

assigned address range. 

37425 I1 Failure ERROR STATUS RETURNED BY EXEC WHILE PROCESSING CORE 

The Exec was unable to create, delete, or inspect the core area as 

requested and has returned a failure status. 

37426 I2 Failure INVALID USER CORE ADDRESS 

The core area address provided is invalid or the core area is 

corrupted. The Exec returned an error status in specific_status. 

37427 I3 Failure INVALID ACCESS PERMISSION FOR USER CORE AREA 

The core area provided has an invalid general access permission. 

The core area must allow read and write permission and not allow 

execute permission. 

37428 I4 Failure INVALID BANK TYPE FOR USER CORE AREA 

The bank type of the core area provided has an incorrect type. The 

core area cannot be part of a code, SPSU (scientific processor 

storage unit), or contiguous BDI bank. 

7831 0687–010 A–27


UCS C 

Linkage 

BM 

Linkage 

Severity 


37429 I5 Failure THIS RUN WOULD EXCEED ITS MEMORY QUOTA LIMIT 

An extended mode sort was unable to allocate the core area as 

requested. The Exec returned a failure status which indicated that 

the size of the core area to be allocated would cause the run to 

exceed its memory quota limit. 

Possible corrective actions include: 

• Reduce the CORE parameter if one was specified. 

• Specify a CORE parameter if one was not specified. 

• Reduce the MAXIMUM configuration parameter. 

37430 I6 Failure TIP MEMORY TRANSACTION UNABLE TO ALLOCATE THE CORE 

AREA 



this transaction resided in TIP memory. 

37431 I7 Failure MEMORY IS NOT AVAILABLE TO ALLOCATE THE CORE AREA 



memory was not available to allocate the core area. Sort made 

multiple attempts to allocate the core area. However, sufficient 

memory never became available. 

Possible corrective actions include: 

• Reduce the CORE parameter if one was specified. 

• Specify a CORE parameter if one was not specified. 

• Reduce the MAXIMUM configuration parameter. 

None K0 Failure SORT UNABLE TO ALLOCATE REQUESTED CORE - INSUFFICIENT 

ADDRESS SPACE 

The basic mode SORT subroutines cannot allocate the core requested by 

the assignment of the file R$CORE. The allocation requested would cause 

the basic mode D-bank to exceed the maximum address of 0777776. 

Resolution of this error may be achieved by any of the following steps: 

1. If the program is using the common-banked SORT subroutines, convert 

the sort operation to an extended mode sort by increasing the 

maximum reserve of the file R$CORE to a value greater than 210. If an 

Extended Mode sort is not available, error K5 is issued. 

2. Reduce the requested CORE size by reducing the maximum reserve of 

the file R$CORE. 

3. Recollect the absolute with a lower D-bank start address. 

Please note that for some specific cases, options 2 and 3 may both be 

required to permit the execution of the sort operation. 

A–28 7831 0687–010

UCS C 

Linkage 

BM 

Linkage 

Severity 



38449 K1 Failure INSUFFICIENT SCRATCH FILES PROVIDED 

You must assign more scratch space. 

None K2 Failure ACTUAL BIAS DOES NOT MATCH EXPECTED BIAS 

Your input data requires that you supply a bias parameter according 

to the bias estimate provided with this message. 

This error can occur if the volume of data is greater than expected. You can 

assign more core or use the disk sort. The disk sort does not require using 

the BIAS parameter. 

None K3 Failure CORE MUST NOT BE GREATER THAN 1/3 OF M1 FILE SIZE 

You must assign a larger M1 file or less main storage. 

38452 K4 Failure CORE AMOUNT IS INSUFFICIENT 

You must supply more main storage. 

None K5 Failure EXTENDED MODE SORT IS UNAVAILABLE 

An extended mode sort was requested but is unavailable since the 

common-banked SORT subroutines were not used. Extended mode 

Sort requires that the SORT subroutines be invoked through the 

common-banked interfaces. 

38454 K6 Failure INCORRECT SCRATCH FILE FOR EXTENDED MODE SORT 

If an extended mode sort has been selected, it is illegal to also 

specify a tape, one-level (M1), or a two-level (M1-M2) sort either by 

parameters or scratch file assignment. 

None K7 Failure SORT VOLUME TOO LARGE FOR THE FACILITIES PROVIDED 

Sort is unable to continue sorting this data set with the facilities 

provided. This error is dependent upon the sort volume, the order of 

the input data, the core size, and the number of scratch files. 

This error can be avoided by increasing the core size, using a 

different number of disk scratch files, or using an extended mode 

disk sort. 

38456 K8 Failure DEFYEAR PARAMETER SPECIFIES AN INVALID VALUE 

The value specified in a DEFYEAR parameter must be in the range 0 

to 99. 

None K9 Failure INCORRECT ‘CONTC' INPUT CARD DECK 

You must define correct ‘CONTC’ input parameters. 

7831 0687–010 A–29


UCS C 

Linkage 

BM 

Linkage 

Severity 


38960 L0 Failure INVALID MIXING OF SORT/MERGE LINKAGE TYPES 

The SORT subroutines do not allow mixing of some linkage types. 

You cannot use both the MASM linkages and the UCS C linkages for 

the same sort or merge operation. You cannot use the MASM 

standard or extended linkages and the MASM common bank 

linkages in the same merge operation. 

38961 L1 Failure RREL$ LINKAGE ERROR 

This entry point used illegally. Check the sort program logic. 

None L2 Failure RENCY$ LINKAGE ERROR 


38963 L3 Failure RSORT$ LINKAGE ERROR 

38964 L4 Failure RRET$ LINKAGE ERROR 



None L5 Failure RQEND$ LINKAGE ERROR 


38966 L6 Failure MERGE IS NOT INITIALIZED 

Merge must be initialized using an RMGOPN$, RMGOPN$X, 

RMRGOPN$CB, or RMGOPEN call before any other calls to the 

SORT subroutines. Data corruption may have occurred in the 

working area or the parameter table used by Sort/Merge. 

38967 L7 Failure SORT IS NOT INITIALIZED 

Sort must be initialized through an ROPN$, RGOPN$X, ROPN$CB, 

or SRTOPEN call before any other calls to the SORT subroutines. 

Data corruption may have occurred in the working area or the 

parameter table used by Sort/Merge. 

39472 M0 Failure ILLEGAL KEY PARAMETER TYPE OR SUBTYPE FIELD 

A key parameter specified an invalid key type or key subtype. The 

valid key types are: A, B, D, G, I, J, L, M, P, Q, R, S, T, U, V, and 

DATE (which is represented by 040 or the character ‘)’). When the 

key type is I, the valid key subtypes are 0 and 1. The key subtype 

field is not used for other key types. 

39473 M1 Failure NO ‘COMP', ‘KEY' OR ‘KEYW' SPECIFIED 

You must specify one of the above parameters. 

A–30 7831 0687–010

UCS C 

Linkage 

BM 

Linkage 

Severity 



39474 M2 Failure INVALID STARTING BIT OR NUMBER OF BITS IN KEY 

You must define number of bits as nonzero and starting bit in the 

range 0 to 35. When specifying a DATE key type, the number of 

bits must be at least 18 and the key start bit must be 35, 26, 17, or 

8. 

39475 M3 Failure NUMBER OF KEYS SPECIFIED EXCEEDS 64 

You cannot define over 64 keys for the SORT subroutine. 

39476 M4 Failure INVALID COLLATING SEQUENCE SPECIFIED 

You cannot duplicate a code on a sequence parameter. 

39477 M5 Failure KEY FALLS OUTSIDE RECORD RANGE 

You must define your keys within the record size or specify LINKSZ 

parameter if sorting variable length records. 

39478 M6 Failure DUPLICATED OR MISSING KEY NUMBER 

You must be consistent in key sequencing. 

39479 M7 Failure CONFLICTING ASCII TRANSLATE TABLES SPECIFIED 

You cannot define both 7-bit and 8-bit ASCII collating tables in the 

same sort program. 

39480 M8 Failure INCOMPATIBLE KEY TYPES FOR OVERLAPPING KEYS 

Keys overlap and the key type specified for the minor key is not 

compatible with the key type specified for the major key. 

39481 M9 Failure UNKNOWN RDMS ITEM DATA TYPE 

RDMS has initiated an extended mode sort and the RDMS item data 

type is unknown to Sort/Merge. This error may indicate that RDMS 

passed an unknown item data type or that a system incompatibility 

exists between the installed levels of RDMS and Sort/Merge. 

41008 P0 Failure SEQUENCE ERROR IN CORE MODULE 

An internal SORT subroutine error has occurred or a user COMP 

routine has returned inconsistent results. 

42545 S1 Failure SEQUENCE ERROR ON INPUT FILE TO MERGE 

The merge input is not in sorted order. 

44592 W0 Failure ERROR RETURNED BY SERVICE ROUTINE 

An I18NLIB service routine encountered an error. 

7831 0687–010 A–31


UCS C 

Linkage 

BM 

Linkage 

Severity 

44593 W1 Failure LOCALE NOT FOUND 


The desired locale for the sort or merge operation could not be 

found on the system. Please verify that the name of the locale you 

specified is correct and that it is installed on the system. 

Remember that locale names are case sensitive. 

44594 W2 Failure I KEY NOT ALLOWED WITH DATA REDUCTION OR USER 

COMPARE ROUTINE 

An I key type is not allowed when a data-reduction own code 

(DROC) or a user compare (COMP) routine is specified. 

44595 W3 Failure I KEY TYPE CANNOT BE USED WITH BASIC MODE SORT 

An I key type can only be used with an extended mode sort. 

44596 W4 Failure INSUFFICIENT SCRATCH FILES FOR I18N SORT 

The scratch files are not large enough for this I18N sort operation. 

The scratch file size for an I18N sort should be larger than 36 tracks. 

44597 W5 Failure INSUFFICIENT RECORD BANK FOR CORE ONLY I18N SORT 

The record bank is not large enough for this I18N core-only sort. 

Increase the size of the RBSIZE configuration parameter or change 

the operation to an extended mode disk sort. 

45104 X0 Failure LOGICAL ERROR IN DISK MODULE 

This is an internal error that indicates the Sort Subroutines have 

encountered an unexpected situation during a disk sort. Changing 

the CORE size and/or the number or size of the scratch files may 

avoid this situation. 

If you receive this error, please inform your Unisys Support Center 

so that this condition can be reported and potentially resolved. 

Please provide the runstream, input data files, and any information 

necessary to reproduce this problem. 

45105 X1 Failure STRING CONTROL TABLE BANK OVERFLOW 

The Extended Mode sort internal String Control Table (SCT) has 

overflowed. This condition is a limitation with the current design of 

Sort/Merge and may be avoided by increasing the CORE parameter 

specified or by not specifying a CORE parameter for the SORT 

processor. If the size specified in the CORE parameter is greater 

than or equal to the SORT MAXIMUM configuration parameter, that 

parameter must be changed before any change of the CORE 

parameter. 

If you receive this error, please inform your Unisys Support Center 

so that this condition can be reported and potentially resolved. 

Please provide the runstream, input data files, and any information 

necessary to reproduce this problem. 

45108 X4 Failure READ/WRITE ERROR ON DISK 


A–32 7831 0687–010

UCS C 

Linkage 

BM 

Linkage 

Severity 

None X5 Failure CHECKSUM ERROR ON DISK 



A possible hardware malfunction has been detected. 

None X6 Failure BLOCK COUNT ERROR ON DISK 

A possible hardware error or a SORT subroutine internal error has 

been detected. Data corruption may have occurred in the working 

area by Sort/Merge. 

45111 X7 Failure SEQUENCE ERROR IN DISK MODULE 

An internal SORT subroutine error has occurred. Data corruption 

has occurred in the working area used by Sort/Merge. 

45112 X8 Failure INSUFFICIENT CORE FOR DISK FILES 

EOF CARD MISSING 

Increase your main storage allocation. 

An EOF card was not found after all the parameters had been read. The sort 

will continue. 

I/O STATUS (0xx) ON SCR FILE (file-name ) DURING A (0yy) FUNCTION 

Notes: 

where: 

xx 

is the octal I/O status. 

file-name 

yy 

is the internal scratch file name. 

is the octal function code value. 

1. On all internal errors, hardware errors, and I/O errors, you should rerun the sort 

program. If the error persists, a dump of the program, including the sort library plus 

any pertinent information, should be submitted as a user communication form (UCF). 

2. On all internal errors, hardware errors, and I/O errors, you should rerun the sort 

program. If the error persists, submit a UCF and provide the following information to 

the Support Center via RSS or FTP, or send it on an unlabeled half-inch cartridge tape 

in COPY,G format: 

• A PMD,AL after the error has occurred. 

• The trail sheet showing all file assignments and console messages. 

7831 0687–010 A–33


• If applicable, the program and all COPY/INCLUDE procedures calling the SORT 

subroutines. 

• When possible, all input data files. 

• A list of all Sort CHGs applied to this level of SORT. 

A.3. SORT Subroutine Summary Messages 

The following messages are written to the system log file at sort completion. 

Message 1 

Format 

SORT: T/R = ttttt.tMS BIAS= bbbb.b IC= iiiiiiiiiiii OC= oooooooooooo 

where 

ttttt.t 

bbbb.b 

iiiiiiiiiiii 

is the wall clock time per record for this run in milliseconds. 

is the bias factor of the input data. 

is the input record count for this run. 

oooooooooooo 

is the output record count for this run. 

Message 2 

Format 

M1 BLOCK SIZE: xxxx MERGE POWER: yyy EQU TYPE zz 

M2 BLOCK SIZE: xxxx MERGE POWER: yyy EQU TYPE zz 

where 

xxxx 

yyy 

zz 

is the block size used in I/O operations. 

is the maximum merge power at the given block size. 

is the equipment code for the file. 

If only one mass storage file is assigned, only the M1 message will appear. 

A–34 7831 0687–010

Message 3 

Format 

tt DISK BLOCK SIZE xxxxx, yyyyy EQUIPMENT: eeee 

tt DISK MERGE POWER aaaa, bbbb 

where 

tt 

xxxxx 

yyyyy 

aaaa 

bbbb 

eeee 


is either BM or EM to indicate a basic mode (BM) or extended mode (EM) disk sort. 

is the intermediate disk block size. 

is the final disk block size. 

is the intermediate merge power. 

is the final merge power. 

is the disk equipment type. 

This message occurs if three or more mass storage files are used during the sort. 

Message 4 

Format 

xx SORT, CORE: yyyyyyyy TOURNAMENT: zzzzzzzz ORIG RUNID: oooooo RUNID: rrrrrr 

where 

xx 

is BM if a basic mode sort is performed or EM if an extended mode sort is 

performed. 

yyyyyyyy 

zzzzzzzz 

is the actual amount of memory area used by the SORT subroutines. 

is the amount of memory in yy allocated to the sort tournament. 

7831 0687–010 A–35


oooooo 

rrrrrr 

is the original run-id specified on the @RUN statement. For transactions, it is the 

transaction name. 

is the system generated run-id for the run. For transactions, it is the TIP generated 

run-id. 

A–36 7831 0687–010

Appendix B 

Examples of Processor Usage 

This appendix consists of examples using the SORT processor with various 

combinations of parameters to accomplish typical Sort/Merge operations. 

B.1. Printing the Contents of a File 

These examples indicate that the SORT processor can be used to print the contents of a 

file. The type of file is indicated by the MODE statement or by the option on the call line. 

Example 1 

The following example shows how to print a variable–blocked ANSI file: 

Format 

@SORT,K 

FILEIN=file-name-1 MODE=ANSI 

BLOCK=2 

RSZ=11 

LINKSZ=3 

COPY 

@EOF 

Example 2 

The following example shows how to print an SDF file: 

Format 

@SORT,KS 

FILEIN=file-name-1 

COPY 

@EOF 

7831 0687–010 B–1


B.2. Sorting a File and Producing the Resulting 

Output File 

These examples indicate that files used as input can be sorted or merged and sent to an 

output file of another type. 

Example 1 

The following example shows how to create an ISAM output file sorted in ascending 

order from an SDF file: 

Format 

@SORT,E . E option echoes parameters 

FILEIN=file-name-1 MODE=SDF 

RSZ=120 

KEY=1,6,S,A 

DATA=ASCII 

FILEOUT=file-name-2 MODE=ISAM 

ISKEY=1,6 . Indicates the file index key 

@EOF 

Example 2 

The following example shows how to create an SDF file and guarantee that records with 

equal keys are output in the same order in which they were entered: 

Format 

@SORT,E . E option echoes parameters 

FILEIN=file-name-1 MODE=CARDS 

RSZ=120 

KEY=1,6,S,D 

DATA=ASCII 

FILEOUT=file-name-2 MODE=SDF 

PRESERVE . Preserve order of duplicate keys. 

@EOF 

Example 3 

The following example shows how to sort a very large variable–blocked ANSI file that is 

approximately in inverse order and to create an ACOB file; the records will be sorted in 

ascending order in the sequence: space, letters (A,a,B,b, ... ,Z,z), and numbers, followed 

by special characters from 0 to 0177: 

B–2 7831 0687–010

Format 


@SORT,E 

FILEIN=file-name-1 MODE=ANSI 

BLOCK=10 . Block size is 10 records 

RSZ=120 . Record size is 120 characters 

LINKSZ=20 . Variable-length records 

KEY=1,20,S,A 

VOLUME=LARGE 

SEQX=SEQB . Sequence used for ordering 

BIAS=INV . Records are close to inverse order 

FILEOUT=file-name-2 MODE=ACOB 

FILEID=file-id-value . Value for file-id for ACOB file 

LABEL=STANDARD . Standard labels are to be produced 

@EOF 

Example 4 

The following example shows how to sort a card file and produce an alternate print file 

as the output file: 

Format 

@SORT,E 

FILEIN=CARDS MODE=CARDS 

KEY=1,10,S,A 

FILEOUT=file-name-1 MODE=PRINT 

@EOF 

data cards to be used as input 

@EOF 

Example 5 

This example shows how to sort a card file containing ASCII dates in the format yymmdd 

(the dates 280607, 010101 and 271130 are in the 21st century). 

Format 

@SORT,E 


KEY=1,6,DATE,A .Uses the default DEFYEAR value of 28 


@EOF 

941005 

991231 

280607 

271130 

910201 

010101 

940812 

@EOF 

7831 0687–010 B–3


Output records 

280607 

910201 

940812 

941005 

991231 

010101 

271130 

Example 6 

The following example shows how to sort a card file containing ASCII dates in the format 

yyddd with DEFYEAR specified as 92: 

Format 

@SORT,E 


KEY=1,5,DATE,A 

DEFYEAR=92 


@EOF 

99231 

97018 

91365 

96209 

01001 

87286 

92001 

@EOF 


92001 

96209 

97018 

99231 

01001 

87286 

91365 

B–4 7831 0687–010

B.3. Merging Files into One Output File 

Example 1 


The following example shows how to merge three MSAM input files and create an 

ACOB output file: 

Format 

@SORT,E 

FILESIN=file-name-1,file-name-2,file-name-3 MODE=MSAM 

RSZ=33,WORDS 

KEY=10,20,S,A,1 . Multiple keys are defined 

KEY=1,8,S,A,2 

KEY=30,34,S,A,3 


MERGE 

@EOF 

Example 2 

The following example shows how to merge an ACOB file and a MSAM file into a 

PRINT$ output file: 

Format 

@SORT,E 

FILEIN=file-name-1 MODE=ACOB 

FILEIN=file-name-2 MODE=MSAM 

KEY=1,8,S,A 

RSZ=33,WORDS . Record size is in words 

FILEOUT=PRINT MODE=PRINT 

MERGE 

@EOF 

B.4. Selecting a Certain Classification of Records 

These examples demonstrate ways the SORT processor can be used to sort, merge, or 

copy selected records that meet specific criteria from the input file. 

Example 1 

The following example shows how to print records 5 through 20 of an ACOB file: 

Format 

@SORT,K 

FILE=file-name-1 MODE=ACOB 

SKIPL=4 . Skip first 4 records 

NUMREC=16 . Process 16 records 

COPY 

@EOF 

7831 0687–010 B–5


Example 2 

The following example shows how to sort the records from an ACOB file whose value in 

word 3 of the record is less than or equal to 126894 and greater than 11000; the 

selected records will be sorted on the Fieldata key in word 1 and output to another 

ACOB file: 

Format 

@SORT,E 

FILEIN=file-name-1 MODE=ACOB 

ALLOW=3,G,11000,D 

REJECT=3,G,126894,D 

KEY=1,6,A,A 

DATA=FIELDATA 


@EOF 

Example 3 

The ACCEPT parameter can perform the same type of record selection as ALLOW and 

REJECT but is more powerful and flexible. The following example sorts the ASCII 

records between 21000 and 80000 or less than 10000: 

Input records 

00021132 

00010321 

00092997 

00003776 

00086344 

00054942 

00062734 

00021195 

00072649 

00016150 

Format 

@SORT 

FILEIN=file-name-1 MODE=SDF 


ACCEPT=4,2,ASC,G,20,AND 

ACCEPT=4,2,ASC,L,80,OR 

ACCEPT=4,1,ASC,E,0 

KEY=1,8,S,A 

@EOF 


00003776 

00021132 

00021195 

00054942 

00062734 

00072649 

B–6 7831 0687–010

Example 4 


SORT can be used to reduce records to significant fields before they are used as input to 

the sort phase. The fields are specified with the SELECT parameter. The output records 

contain only the extracted fields. 

The following are the input records for the SELECT examples that follow them: 

abcdefghijklmnopqrstuvwxyz 

12345678901234567890123456 

ABCDEFGHIJKLMNOPQRSTUVWXYZ 

fthkiswixsiutqhemreigsurlt 

AAAAAA 

FFFFFF 

Example 4a 

@SORT 

DATA=ASCII 

FILEIN=IN MODE=CARDS 


SELECT=2,2:5,2:8,1,6:10,1:13,1,9:15,2:18,2,13:22,2:25,2 

KEY=1,6,S,A 

@EOF 


2356 80 356 892356 

AAAA 

BCEF HJ MOP RSVWYZ 

FFFF 

bcef hj mop rsvwyz 

this is the result 

Example 4b 

@SORT 

DATA=ASCII 

FILEIN=IN MODE=CARDS 


SELECT=1,1,10:3,1:5,1:6,1,18:9,1:18,3 

KEY=1,6,S,A 

@EOF 


135 69890 

AAA A 

ACE FIRST 

FFF F 

ace first 

fhi sxrei 

7831 0687–010 B–7


B.5. Determining or Assigning Scratch Facilities 

Example 1 

The following example shows how to perform a main–storage–only sort of a small SDF 

file by the first word of each record: 

Format 

@SORT,Y . Y option causes a main-storage-only sort 

FILE=file-name-1 

FILEOUT=file-name-2 

MODE=SDF 

KEY=1,4,S,A 

SORT . Sort operation is the default. 

@EOF 

Example 2 

The following example shows how to perform the same job as the previous example, 

explicitly specifying 24,000 words of main storage: 

Format 

@SORT,Y 



MODE=SDF 

KEY=1,4,S,A 

SORT 

CORE=24K . K causes multiplication by 1000. 

@EOF 

Example 3 

The following example shows how to sort an SDF file that contains approximately 8 

million words of data: 

Format 

@SORT 



MODE=SDF 

KEY=1,4,S,A . 8 million is MEDIUM. Sort will 

SORT . assign scratch files based on 

VOLUME=MEDIUM . this VOLUME parameter. 

@EOF 

B–8 7831 0687–010

Example 4 


The following example shows how to perform the same job as in the preceding 

example, with 400,000 records of 20 words each: 

Format 

@SORT 



MODE=SDF 

KEY=1,4,S,A 

SORT . Sort will calculate volume from 

RSZ=20,WORDS . RSZ and RECORD parameters. 

RECORD=400 . (thousands of records) 

@EOF 

Example 5 

The following example shows how to perform a similar sort of 15,000 records by using 

one–level mass storage (M1) sort: 

Format 

@SORT,X . X option for M1 only. 



MODE=SDF 

KEY=1,3,S,A 

DRUM=F . Sort will determine size needed. 

RECORD=15 . Provides sort with volume information. 

RSZ=20,WORDS 

@EOF 

Example 6 

The following example shows how to perform a disk sort with four disk files, each file 45 

tracks. Sort assigns the files according to the optional size specification and frees the 

files before terminating. 

Format 

@SORT 



MODE=SDF 

KEY=1,3,S,A 

DISKS=4,F33,TRK,45 

RSZ=80,CHARACTERS 

@EOF 

7831 0687–010 B–9


Example 7 

The following example has the same effect as the previous example except that sort 

does not free the scratch files: 

Format 

@ASG,T XC.,F33//TRK/45 

@ASG,T XD.,F33//TRK/45 

@ASG,T XE.,F33//TRK/45 

@ASG,T XF.,F33//TRK/45 

@SORT 



MODE=SDF 

KEY=1,3,S,A 


@EOF 

B.6. Performing a TAG/RETRIEVE Sort 

Example 1 

The following example shows how to do a tag sort on an ACOB file. The tag file 

produced is later referenced by a RETRIEVE operation to produce the final output file. 

Format 

@SORT,EA 

FILEIN=file-name-1 BLOCK=4 


RSZ=800 

KEY=8,10,S,A 

TAG=8,10 

BIAS=AVG 

VOLUME=SMALL 

DISKS=3 

@EOF 

Example 2 

The following example shows how to do the RETRIEVE operation of the tag file created 

in the preceding example and produce the sorted file. Note that neither the input file nor 

the tag file is changed from the TAG operation. 

Format 

@SORT,EA 

FILEIN=file-name-1 BLOCK=4 


RSZ=800 

KEY=8,10,S,A 


RETRIEVE 

@EOF 

B–10 7831 0687–010


The TAG and RETRIEVE operations can both be within the same sort execution. If this is 

the case, then the FILEIN, the TAGFILE (unless the default of the temporary tag file 

TAG$FILE is used), and the FILEOUT parameters should all be used. 

B.7. Creating or Reading Indexed Files 

Example 1 

The following example creates an ISAM file with the index keys extracted from the 

records: 

Input records 

123456789012 

RECKKKKRRRRR 

Format 

@SORT 

FILEIN=file-name-1 MODE=CARDS 

FILEOUT=file-name-2 MODE=ISAM SPLIT . Separate key from record 

ISKEY=4,4 

KEY=4,4,S,A 

RSZ=12,CHARACTERS . Use input-record size 

LINKSZ=12,CHARACTERS 

@EOF 


12389012 

RECRRRRR 

Example 2 

The following example reads the ISAM file created in the preceding example and creates 

a new file with the index keys replaced in the records: 

Input records 

12389012 

RECRRRRR 

Format 

@SORT 

FILEIN=file-name-2 MODE=ISAM JOIN . Replace keys in records 

FILEOUT=file-name-3 MODE=CARDS 

COPY 

RSZ=12,CHARACTERS . Use size of record 

LINKSZ=12,CHARACTERS . Combined with key 

@EOF 


456712389012 

KKKKRECRRRRR 

7831 0687–010 B–11


B.8. Dynamically Assigning the Output File 

Example 1 

The following example dynamically assigns the output file: 

Format 

@SORT 

FILEIN=INFILE 

FILEOUT=OUTFILE,FREE,CP,F30/100/TRK/1000 . Assign syntax for output file 

KEY=9,4,S,A 

MODE=SDF 


@EOF 

The output file, OUTFILE, is assigned by the SORT processor in the following manner: 

@ASG,CP OUTFILE.,F30/100/TRK/1000 

The output file is not assigned until the records are returned from the sort. The FREE 

option means that OUTFILE is freed (@FREE) when the sort completes. 

B.9. Specifying Overlapping Keys 

The following example performs a sort in which three overlapping keys are specified: 

Format 

@SORT 

FILEIN=IN1 MODE=SDF 

FILEOUT=OUT1 MODE=SDF 

KEY=9,4,S,A:5,16,S,A:17,8,U,A 

RSZ=10,WORDS 

@EOF 

All three of the specified keys overlap. This is allowable when the key types are 

compatible. 

B.10. Performing an Extended Mode Sort 

Example 1 

The following example shows how to perform a main–storage–only sort using 1,048,576 

words of main storage: 

Format 

@SORT,Y 



MODE=SDF 

RSZ=20,WORDS . Records are 20 words in length 

KEY=1,4,S,A 

CORE=1M . Specify 1,048,576 words of main-storage 

@EOF . End of SORT parameters 

B–12 7831 0687–010

Example 2 


Let the processor determine the CORE amount by volume calculations. This example 

assumes that the AUTOMATIC configuration parameter is set to YES. A basic mode sort 

is performed if AUTOMATIC is set to NO. 

Format 

@SORT 



MODE=SDF 


KEY=1,4,S,A 

RECORD=100 . Large volume causes extended mode CORE to be used. 


Example 3 

This example is the same as the previous example but with the AUTOMATIC 

configuration parameter set to NO. A basic mode CORE amount would be determined 

based on volume calculations, however the ESORT parameter is specified to force the 

extended mode sort. 

Format 

@SORT 



MODE=SDF 


KEY=1,4,S,A 

RECORD=100 . Indicate sort volume. 

ESORT . Perform Extended Mode sort. 


7831 0687–010 B–13


B–14 7831 0687–010

Appendix C 

Sample Programs Using Common Bank 

Interface 

This appendix contains a sample MASM program that uses the common bank interface 

to access the SORT subroutines as a common bank. 

Basically, this program reads records from READ$ (a symbiont file), then sorts and 

displays these records at PRINT$ (also a symbiont file). It also specifies a disk sort using 

the FILES parameters since this is more efficient than specifying a mass storage sort. 

Before you view the actual program, a brief explanation follows to help you to 

understand how the common bank is used to access SORT subroutines. 

Explanation 

When you access SORT subroutines using the common bank interface, you have the 

following advantages: 

• SORT subroutine modifications are easier to apply because calling programs do not 

need to be re–collected. 

• Universal compiling systems and object modules have access to the SORT 

subroutine common bank. 

The standard and extended sort linkages (described in Section 6) access the sort 

relocatable subroutines while the common bank sort linkages access the common bank 

entry points. 

While existing programs need no change to access the sort relocatable subroutines, 

MASM procedures should be used to access the sort common bank. Using these 

procedures generates the calls needed to access the SORT subroutine. Using a 

$INCLUDE 'RPROC$' MASM statement makes the procedures available. 

7831 0687–010 C–1

Sample Programs Using Common Bank Interface 

When working with the sort common data bank you must 

• Add the $INCLUDE 'RPROC$' MASM statement. 

• Use the following sort procedures: 

− R$MGOPNCB 

− R$MGRELCB 

− R$MGREQCB 

− R$OPNCB 

− R$QENDCB 

− R$RELCB 

− R$RETCB 

− R$SORTCB 

• Reserve a minimum of 02200 words for the D–bank before using the R$OPNCB 

procedure. Register X9 must point to this D–bank on each sort call. 

Sample Program 

The following sample program uses the SORT common-banked MASM linkages: 

-------------------------------------------------------------------------------------------------------- 

1000. / 

1010. AXR$ 

1020. $INCLUDE 'RPROC$' 

1030. PF $FORM 12,6,18 

1040. . 

1050. $(1),START 

1060. .****************************************************** 

1070. .** R$OPNCB initializes the sort and loads the X9 ** 

1080. .** register with the Dbank size and address. ** 

1090. .** Register A3 is loaded with the parameter table ** 

1100. .** address. This is the only call requiring the ** 

1110. .** Dbank size to be specified in X9. ** 

1120. .****************************************************** 

1130. . 

1140. R$OPNCB,DBANKSIZE,DBANK PARAMS . INITIALIZE SORT SUBROUTINES 

1150. . 

1160. . ******************************************************** 

1170. . **The RELEASE routine reads records from READ$ and ** 

1180. . **releases them to the sort. ** 

1190. . **The same Dbank address is specified in X9 - Notice ** 

1200. . **that no size value is required. A0 is loaded with ** 

1210. . **the record size and address. ** 

1220. . ******************************************************** 

1230. RELEASE 

1240. . GET INPUT RECORD. 

1250. R$EAD (SORT,BUF) . ON END-OF-FILE, GO TO SORT. 

1260. R$RELCB,DBANK (RSZ,BUF) . PASS RECORD TO SORT 

1270. J RELEASE . GET ANOTHER RECORD. 

1280. / 

1290. . ******************************************************** 

1300. . **The SORT routine takes the records released to it ** 

1310. . **through the RELEASE routine and begins sorting. ** 

1320. . **Again, only the Dbank address is specified through ** 

C–2 7831 0687–010


1330. . **the X9 register. ** 

1340. . ******************************************************** 

1350. SORT 

1360. P$RINT (PF 1,MSG1L,MSG1) . PRINT 'ALL RECORDS RELEASED' 

1370. R$SORTCB,DBANK . BEGIN SORTING 

1380. RETRIEVE 

1390. . ******************************************************** 

1400. . **Here, in the RETRIEVE routine, the sort returns the ** 

1410. . **sorted output records. At the end-of-file, control ** 

1420 . **is passed to the EOF routine. ** 

1430. . ******************************************************** 

1440. R$RETCB,DBANK EOF . RECORD IS RETURNED FROM SORT. 

1450. LXI,U A0,0 . PREPARE TO PRINT RECORD. 

1460. AA A0,((01*/24)++(RSZ*/18)) . SET LINE SPACE AND RECSIZE. 

1470. ER PRINT$ . DISPLAY RECORD TO PRINT$. 

1480. J RETRIEVE . GO GET NEXT RECORD FROM SORT. 

1490. . 

1500. EOF 

1510. P$RINT (PF 1,MSG2L,MSG2) . PRINT 'SORT END-OF-FILE' 

1520. ER EXIT$ 

1530. $(2) 

1540. RSZ $EQU 13 . RECSIZE IN WORDS 

1550. . ****************************************************************** 

1560. . **The PARAMS statement performs the following: ** 

1570. . ** ** 

1580. . **Builds the sort parameter table using the R$FILE procedure ** 

1590. . ** ** 

1600. . **Establishes the FPOC and LPOC labels as user-program ** 

1610. . **entry points. ** 

1620. . ** ** 

1630. . **Generates a BDIREF$ allowing FPOC and LPOC to be collected ** 

1640. . **into different banks. ** 

1650. . ** ** 

1660. . **Reserves 50000 words (via the CORE parameter) in the user's ** 

1670. . **Dbank for sort work area. ** 

1680. . ** ** 

1690. . **Establishes the FILES parameter used to specify 3 scratch ** 

1700. . **files for a disk sort. These files must be assigned by the ** 

1710. . **user before the sort begins. ** 

1720. . ****************************************************************** 

1730. PARAMS R$FILE ; 

1740. 'RSZ',RSZ*6 ; 

1750. 'KEY',1,20,'A' ; 

1760. 'CORE',50000 ; 

1770. 'FILES','XC,'XD','XE' ; 

1780. 'FPOC',RELEASE ; 

1790. 'LPOC',RETRIEVE ; 

1800. 

1810. DBANK $RES 02200 . A MINIMUM 02200 OCTAL WORD 

1820. DBANKSIZE $EQU $-DBANK . DBANK MUST BE PASSED TO THE 

1830. . SORT CB. 

1840. / 

1850. . The following are just informational messages to be displayed during 

1860. . the sample execution 

1870. . 

1880. BUF RES RSZ . INPUT BUFFER 

1890. MSG1 'ALL RECORDS HAVE BEEN RELEASED TO SORT.' 

1900. MSG1L $EQU $-MSG1 

1910. . 

1920. MSG2 'SORT END-OF-FILE EXIT TAKEN.' 

7831 0687–010 C–3


1930. MSG2L $EQU $-MSG2 

1940. / 

1950. . ****************************************************************** 

1960. . **RPROC$ procedures are flexible and addresses can be specified ** 

1970. . **using X registers as follows: ** 

1980. . ****************************************************************** 

1990. LX,U X3,PARAMS-5 . SORT PARAMETER TABLE ADDRESS 

2000. LX,U X4,DBANK-9 . DBANK ADDRESS 

2010. R$OPNCB,DBANKSIZE,9,X4 5,X3 

2020. . 

2030. . 

2040. . 

2050. . ****************************************************************** 

2060. . **Registers can be loaded by the user rather than the ** 

2070. . **procedure as follows: ** 

2080. ****************************************************************** 

2090. LX X9,(DBANKSIZE,DBANK) 

2100. LA,U A3,PARAMS 

2110. R$OPNCB 

2120. . 

2130. . 

2140. . 

2150. . ****************************************************************** 

2160. . **This example can be directed to perform an Extended Mode ** 

2170. . **sort by making the following changes: ** 

2180. ****************************************************************** 

2190. . 

2200. R$RETCB,DBANK EOF BUF . Add output record area 'BUF' 

2210. . to the RETRIEVE routine. 

2220. . 

2230. 'CORE',300000 . Increase the core area to a 

2240. . size that causes an Extended 

2250. . Mode sort to be performed. 

2260. . 

2270. END START 

-------------------------------------------------------------------------------------------------------- 

C–4 7831 0687–010

Appendix D 

Sample Programs with UCS C Program 

Linkages 

This appendix contains sample Universal Compiling System (UCS) C programs that use 

the UCS C program linkages to access the SORT subroutines. 

D.1. Sample Sort Program 

This sample program illustrates the use of UCS C linkages in a UCS C program to 

perform a sort operation. This program reads and releases records to the sort operation 

until an end-of-file status occurs when reading from the input file. Records are returned 

from the sort operation until an at-end condition is returned from the sort operation. Any 

errors that occur during the sort operation cause an error code to be displayed and the 

program to exit. Explanation of the program contents is recorded in the program code as 

comments. 

#include 

#include 

#define MAXLINE 80 

/* */ 

/* Make the Sort/Merge-supplied typedefs, constant definitions, */ 

/* and function prototypes available. */ 

/* */ 

#include 

#include 

main() { 

FILE *fp; 

char line[MAXLINE]; 

/* */ 

/* Allocate an area that will contain scratch file names used by */ 

/* the FILES parameter. */ 

/* */ 

char file_list[36]; 

/* */ 

/* Use the Sort/Merge typedef sm_result_status_type to allocate the*/ 

/* result status packet. */ 

/* */ 

sm_result_status_type my_result_status; 

/* */ 

/* Use the Sort/Merge typedef sm_record_packet_type to allocate the*/ 

/* record packet used for releasing and returning records. */ 

/* */ 

sm_record_packet_type my_record_packet; 

7831 0687–010 D–1

Sample Programs with UCS C Program Linkages 

/* */ 

/* Allocate an area that will contain the sort operation */ 

/* identifier. It is filled in during the sort open */ 

/* phase and passed to all other sort phases to continue the same */ 

/* sort operation. */ 

/* */ 

int dbank; 


/* */ 

/* Use selected Sort/Merge parameter typedefs to create a structure*/ 

/* that represents the parameter table. */ 

/* */ 





sm_files_parameter_type files_parameter; 

sm_end_parameter_type end_parameter; } my_prm_table; 

/* */ 

/* Initialize or clear the parameter table and record packet */ 

/* */ 

int_ptr=(int *)&my_prm_table; 

for (i=0; i < (sizeof (my_prm_table)/4); i++) *int_ptr++ = 0; 

int_ptr=(int *)&my_record_packet; 

for (i=0; i < (sizeof (my_record_packet)/4); i++) *int_ptr++ = 0; 

/* */ 

/* Fill in the parameter table entries as follows. */ 

/* - The first parameter is the START parameter, version 1 of the */ 

/* parameter table is being used. */ 

/* - The second parameter is the CORE parameter. The core size is */ 

/* 1000000 words and a core area has not been allocated by the */ 

/* user program. */ 

/* - The third parameter is the RSZ parameter. A record size of */ 

/* MAXLINE characters is being used. */ 

/* - The fourth parameter is the KEY parameter. The key fields */ 

/* are: */ 

/* - The key type is ASCII alphanumeric (sm_s) */ 

/* - The key order is ascending (sm_ascending) */ 

/* - The start character position is one, the */ 

/* sm_start_char_to_start_word macro is used to determine */ 

/* the start_word value, and the sm_start_char_to_start_bit */ 

/* is used to determine the start_bit value. */ 

/* - The number of characters is four, the */ 

/* sm_char_count_to_bit_count macro is used to determine the */ 

/* bit_count value */ 

/* - field_number is not being used */ 

/* - The fifth parameter is the FILES parameter. The three file */ 

/* names are first put into the area allocated for the file */ 

/* names; each is twelve characters, left justified and space filled. */ 

/* - The sixth parameter is the END parameter; */ 

D–2 7831 0687–010


/* */ 

my_prm_table.start_parameter.code = sm_start; 

my_prm_table.start_parameter.version = 1; 

my_prm_table.core_parameter.code = sm_core; 

my_prm_table.core_parameter.size = 1000000; 

my_prm_table.core_parameter.sm_address = sm_ptr_conversion(NULL); 

my_prm_table.rsz_parameter.code = sm_rsz; 

my_prm_table.rsz_parameter.size = MAXLINE; 

my_prm_table.rsz_parameter.size_type = sm_char; 

my_prm_table.key_parameter.code = sm_key; 

my_prm_table.key_parameter.key_type = sm_s; 

my_prm_table.key_parameter.order = sm_ascending; 

my_prm_table.key_parameter.start_word= 

sm_start_char_to_start_word(1,sm_s); 

my_prm_table.key_parameter.start_bit = 

sm_start_char_to_start_bit(1,sm_s); 

my_prm_table.key_parameter.bit_count = 

sm_char_count_to_bit_count(4,sm_s); 

my_prm_table.key_parameter.field_number = 0; 

my_prm_table.key_parameter.code_1 = sm_continuation; 


strcpy(file_list,"xc "); 

strcpy(file_list+12,"xd "); 

strcpy(file_list+24,"xe "); 

my_prm_table.files_parameter.code = sm_files; 

my_prm_table.files_parameter.number_of_files = 3; 

my_prm_table.files_parameter.character_type = sm_ascii; 

my_prm_table.files_parameter.sm_address = sm_ptr_conversion(file_list); 

my_prm_table.end_parameter.code = sm_end; 

/* */ 

/* Open the sort operation. */ 

/* */ 

SRTOPEN(&my_result_status, &dbank, &my_prm_table); 

if (my_result_status.message_id != sm_ok) 

goto error_exit; 

/* */ 

/* Open the input file. */ 

/* */ 

if ((fp = fopen("sortin", "r")) == NULL) { 

printf("*ERROR: can't open SORTIN\n"); 

return(1); 

} 

/* */ 

/* Put all required values in the record packet. The same record */ 

/* packet and values will be used for both the release and the */ 

/* return record phase. */ 

/* */ 

my_record_packet.version = 1; 

my_record_packet.type = sm_single_record; 

my_record_packet.subtype = sm_single_record; 

my_record_packet.record_gran = sm_word; 

my_record_packet.buffer_gran = sm_word; 

7831 0687–010 D–3


my_record_packet.record_length = MAXLINE / 4; 

my_record_packet.buffer_length = MAXLINE / 4; 

/* */ 

/* Release all records from the input file to the sort. */ 

/* */ 

while (fgets(line, MAXLINE, fp) != NULL) { 

SRTRELEASE(&my_result_status, &dbank, &my_record_packet, &line); 



} 

fclose(fp); 

/* */ 

/* End the release phase. */ 

/* */ 

SRTSORT(&my_result_status, &dbank); 



/* */ 

/* Open the output file. */ 

/* */ 

if ((fp = fopen("sortout", "w")) == NULL) { 

printf("*ERROR: can't open SORTOUT\n"); 

return(1); 

} 

/* */ 

/* Return all records from the SORT subroutines, the severity_code */ 

/* field value of 2 and the message_id field value of sm_eof */ 

/* (0777776) in the result status packet signifies that all records*/ 

/* have been returned. */ 

/* */ 

while (my_result_status.message_id == sm_ok) { 

SRTRETURN(&my_result_status, &dbank, &my_record_packet, &line); 

if (my_result_status.message_id == sm_ok) { 

fputs(line, fp); 

} 

} 

if (my_result_status.message_id == sm_eof) { 

fclose(fp); 

printf("SORT is finished.\n"); 

return(0); 

} 

/* */ 

/* Handle error situation returned by the SORT linkage. */ 

/* - Print the error code returned by the SORT linkage. */ 

/* - Close the sort operation (cause the SORT subroutines to delete*/ 

/* any of its storage areas that may still exist). This step is */ 

/* not required because the program immediately exits but it */ 

/* may be a desirable step if it is necessary to clean up */ 

/* unused data areas. */ 

/* */ 

D–4 7831 0687–010


error_exit: 

printf("*ERROR: sort linkage returned error code %u\n", 

my_result_status.message_id); 

SRTCLOSE(&my_result_status, &dbank); 

return(1); 

} 

D.2. Sample Merge Program 

This sample program illustrates the use of UCS C linkages in a UCS C program to 

perform a merge operation. This program merges the contents of two input files into a 

different output file. Any errors that occur during the merge operation cause an error 

code to be displayed and the program to exit. Further explanation of the program 

contents is recorded in the program code as comments. 

#include 

#include 

/* */ 

/* Make the Sort/Merge-supplied typedefs, constant definitions, and*/ 

/* function prototypes available. */ 

/* */ 

#include 

#include 


main() { 

FILE *fp_1, *fp_2, *fp_o; 

char in_line[MAXLINE]; 

char out_line[MAXLINE]; 

void *line_ptr; 

/* */ 

/* Use the Sort/Merge typedef sm_result_status_type to allocate */ 

/* the result status packet. */ 

/* */ 

sm_result_status_type my_return_status; 

/* */ 

/* Use the Sort/Merge typedef sm_record_packet_type to allocate */ 

/* the record packet used for releasing and requesting records. */ 

/* */ 


/* */ 

/* Allocate an area that will contain the merge operation */ 

/* identifier. It is filled in during the merge open phase and */ 

/* passed to all other merge phases to continue the same merge */ 

/* operation. */ 

/* */ 

int dbank; 


/* */ 

/* Use selected Sort/Merge parameter typedefs to create a structure*/ 

/* that represents the parameter table. */ 

/* */ 

struct { 

7831 0687–010 D–5


sm_start_parameter_type start_parameter; 




/* */ 

/* Initialize or clear the parameter table and record packet */ 

/* */ 

int_ptr=(int *)&my_prm_table; 

for (i=0; i < (sizeof (my_prm_table)/4); i++) *int_ptr++ = 0; 



/* */ 

/* Fill in the parameter table entries as follows: */ 

/* - The first parameter is the START parameter, version 1 of the */ 

/* parameter table is being used. */ 

/* - The second parameter is the RSZ parameter. A record size of */ 

/* MAXLINE characters is being used. */ 

/* - The third parameter is the KEY parameter. The key fields */ 

/* are: */ 

/* - The key type is ASCII alphanumeric (sm_s) */ 

/* - The key order is ascending (sm_ascending) */ 

/* - The start character position is one, the */ 

/* sm_start_char_to_start_word macro is used to determine */ 

/* the start_word value, and the sm_start_char_to_start_bit */ 

/* is used to determine the start_bit value */ 

/* - The number of characters is four, the */ 

/* sm_char_count_to_bit_count macro is used to determine the */ 

/* bit_count value */ 

/* - field_number is not being used */ 

/* - The fourth parameter is the END parameter; */ 

/* */ 




my_prm_table.rsz_parameter.size = MAXLINE; 

my_prm_table.rsz_parameter.size_type = sm_char; 




my_prm_table.key_parameter.start_word = 










printf("MERGE is beginning.\n"); 

D–6 7831 0687–010


/* */ 

/* Open the merge operation. */ 

/* */ 

MRGOPEN(&my_return_status, &dbank, &my_prm_table); 

if (my_return_status.message_id != sm_ok) 


/* */ 

/* Open the input files. */ 

/* */ 

if ((fp_1 = fopen("f1", "r")) == NULL) { 

printf("*ERROR: can't open FILE-1\n"); 

return(1); 

} 

if ((fp_2 = fopen("f2", "r")) == NULL) { 

printf("*ERROR: can't open FILE-2\n"); 

return(1); 

} 

/* */ 

/* Put values in the record packet. The same record packet and */ 

/* values will be use for both the release and return record phase.*/ 

/* */ 






my_record_packet.record_length = MAXLINE / 4; 

my_record_packet.buffer_length = MAXLINE / 4; 

/* */ 

/* Read one record from each input file and release it to the merge*/ 

/* operation. The input file is identified by setting the file_id */ 

/* field in the record packet. */ 

/* */ 

if (fgets(in_line, MAXLINE, fp_1) != NULL) { 

my_record_packet.file_id = 1111; 

MRGRELEASE(&my_return_status, &dbank, &my_record_packet, &in_line); 



} 

if (fgets(in_line, MAXLINE, fp_2) != NULL) { 

my_record_packet.file_id = 2222; 

MRGRELEASE(&my_return_status, &dbank, &my_record_packet, &in_line); 



} 

/* */ 

/* Open the output file. */ 

/* */ 

if ((fp_o = fopen("f3", "w")) == NULL) { 

printf("*ERROR: can't open FILE-OUT\n"); 

return(1); 

} 

/* */ 

/* Request records from the merge operation. The first request is */ 

7831 0687–010 D–7


/* made with a NULL value for the input record pointer. The file_id*/ 

/* of the record returned indicates which input file will be read */ 

/* to get the next input record. When all records from an input */ 

/* file have been read, a NULL value for the input record pointer */ 

/* is used. A severity_code field value of 2 and the message_id */ 

/* field value of sm_eof (0777776) in the result status packet */ 

/* signifies that all records have been returned. */ 

/* */ 

line_ptr = NULL; 

while (my_return_status.message_id == sm_ok) { 

MRGREQUEST(&my_return_status, &dbank, &my_record_packet, 

line_ptr, out_line); 

if (my_return_status.message_id == sm_ok) { 

fputs(out_line, fp_o); 

switch (my_record_packet.file_id) { 

case 1111: 

line_ptr = fgets(in_line, MAXLINE, fp_1); 

break; 

case 2222: 

line_ptr = fgets(in_line, MAXLINE, fp_2); 

break; 

default: 

printf("*ERROR: unexpected file-id returned 

from MRGREQUEST\n"); 

return(1); 

} 

} 

} 

if (my_return_status.message_id == sm_eof) { 

fclose(fp_1); 

fclose(fp_2); 

fclose(fp_o); 

printf("MERGE is ending.\n"); 

return(0); 

} 

/* */ 

/* Handle error situation returned by the MERGE linkage. */ 

/* - Print the error code returned by the MERGE linkage. */ 

/* - Close the merge operation (cause the SORT subroutines to */ 

/* delete any of its storage areas that may still exist). */ 

/* This step is not required because the program immediately */ 

/* exits but it may be a desirable step if it is necessary to */ 

/* clean up unused data areas. */ 

/* */ 

error_exit: 

printf("*ERROR: merge linkage returned error code %u\n", 

my_return_status.message_id); 

return(1); 

} 

D–8 7831 0687–010

D.3. Sample UCS C Buffer Program 


This UCS C program illustrates the use of UCS C Sort linkages that use the buffer 

interfaces as well as single record interfaces. The program also illustrates expected 

errors being returned and continued processing. Further explanation of the program is 

stated within the program comments. 

/* BULKFIXED - This UC test calls the Bulk Interface using fixed 

length records. Interspersed are calls using single records 

as well as the new "buffered" records. 

*/ 

Test 1 - Multiple calls to SRTRELEASE all using fixed length 

records. First, a buffer of records is released, then 

single records are released, and finally another buffer 

of records is released. During SRTRETURN, one record is 

returned using the old method followed by the rest of the 

records being returned using a fixed record buffer. 

Test 2 - Multiple calls to SRTRELEASE, some using fixed length 

records and some using variable length records. 

First, a buffer of fixed length records is released. Then, 

a buffer of variable1 records is released. Finally, a 

buffer of variable2 records is released. During SRTRETURN 

the records are returned using a fixed record buffer. 

#include 

#include 

#include 

#include 


#define BUFFERSIZE 64512 

#define CPW 4 

main() { 

FILE *fp, *fopen(); 

char line[MAXLINE]; 

char buffer[BUFFERSIZE]; 

char localen[16] = "fr_FR.8859-1"; 

char *locp = &localen; 

char *ptrc = (char *) &buffer; 

int *ptri; 

int totalwords = 0; 

sm_result_status_type my_return_status; 


int dbank, i, j, k, *pt_ptr; 





sm_locale_parameter_type locale_parameter; 

7831 0687–010 D–9



pt_ptr = (int *)&my_prm_table; 

for (i = 0; i < (sizeof(my_prm_table) / 4); i++) 

*pt_ptr++ = 0; 





my_prm_table.core_parameter.code = sm_core; 

my_prm_table.core_parameter.size = 1000000; 

my_prm_table.core_parameter.sm_address = sm_ptr_conversion(NULL); 


my_prm_table.rsz_parameter.size = 4; 

my_prm_table.rsz_parameter.size_type = sm_word; 






my_prm_table.key_parameter.start_word = 








/* ------------------------------------------------------------------ */ 

/* Open the sort operation. */ 

printf("Perform SRTOPEN #1.\n"); 

SRTOPEN(&my_return_status, &dbank, &my_prm_table); 

printf ("SRTOPEN #1 severity code = %o, error code = %d\n \n", 

my_return_status.severity,my_return_status.message_id); 

/* Release records to the sort (buffer1). */ 

if ((fp = fopen("f1", "r")) == NULL) { 

printf("*ERROR: can't open F1\n"); 

return(1); 

} 

printf("Release Fixed record buffers.\n"); 

j = 0; 

while (fgets(line, MAXLINE, fp) != NULL) 

{ 

D–10 7831 0687–010


i = strlen(line)-1; /* strip off line feed character */ 

k = (((i + CPW -1) / CPW) * CPW) - i; /* calculate line fill count */ 

while (k > 0) 

{ line[i++] = '^'; 

k--; 

} 

strncpy(ptrc,line,i); 

j++; 

ptrc = ptrc + i; 

} 

fclose(fp); 


my_record_packet.type = sm_blocked_records; 

my_record_packet.subtype = sm_fixed_records; 



my_record_packet.record_length = i / CPW; 

my_record_packet.buffer_length = (j * i) / CPW; 

my_record_packet.number_of_records = 0; 

totalwords += my_record_packet.buffer_length; 

printf ("RIP record length=%d, buffer length=%d, # of records=%d\n", 

my_record_packet.record_length,my_record_packet.buffer_length, 

my_record_packet.number_of_records); 

SRTRELEASE(&my_return_status, &dbank, &my_record_packet, &buffer); 

printf ("SRTRELEASE severity code = %o, error code = %d\n", 


printf ("RIP record length=%d, buffer length=%d, # of records=%d\n \n", 



/* Release records to the sort (single records2). */ 



return(1); 

} 

printf("Release single records.\n"); 





{ 

ptrc = &buffer[0]; 



while (k > 0) 

{ line[i++] = '^'; 

k--; 

7831 0687–010 D–11


} 

} 


j++; 














fclose(fp); 

/* Release records to the sort (buffer3). */ 



return(1); 

} 

printf("Release more Fixed Buffers.\n"); 


j = 0; 


{ 



while (k > 0) 

{ line[i++] = '^'; 

k--; 

} 


j += i; 


} 

fclose(fp); 





D–12 7831 0687–010



my_record_packet.buffer_length = j / CPW; 













printf("Perform SRTSORT.\n"); 

SRTSORT(&my_return_status, &dbank); 

printf ("SRTSORT severity code = %o, error code = %d\n \n", 


/* Returning a single record from SORT. Then get the rest of the */ 

/* records using a fixed block transfer method */ 




my_redord_packet.buffer_gran = sm_word; 

my_record_packet.buffer_length = BUFFERSIZE / CPW; 

printf("Return Single Record.\n"); 




SRTRETURN(&my_return_status, &dbank, &my_record_packet, &buffer); 

printf ("SRTRETURN severity code = %o, error code = %d\n", 





ptrc = (char *) &buffer; 

*(ptrc + (CPW * my_record_packet.record_length)) = '\0'; 

printf (" RECORD = %s \n", ptrc); 

printf ("\nReturn a fixed buffer 8 words records. \n"); 





7831 0687–010 D–13


my_record_packet.record_length = 8; 












for (i = 1; i



/* Release records to the sort (buffer1- fixed length records). */ 



return(1); 

} 

printf("Release fixed records.\n"); 


j = 0; 


{ 



while (k > 0) 

{ line[i++] = '^'; 

k--; 

} 


j += i; 


} 

fclose(fp); 


















/* Release records to the sort (buffer2 - variable1 records). */ 



return(1); 

} 

printf("Release variable1 records.\n"); 

7831 0687–010 D–15


j = 0; 


ptri = (int *) &buffer; 


{ 



while (k > 0) 

{ line[i++ + CPW] = '^'; 

k--; 

} 

*ptri = i / CPW; 

strncpy(ptrc + CPW,line,i); 

j += i + CPW; 

ptrc += i + CPW; 

ptri = (int *) ptrc; 

*ptri = 0; /* In case it's the last one */ 

} 

printf ("buffer_len = %d characters \n",j); 

fclose(fp); 




my_record_packet.subtype = sm_variable1_records; 




my_record_packet.buffer_length = (j / CPW); 

ptrc = ptrc - j; 










/* Release records to the sort (buffer3 - variable2 records). */ 



return(1); 

} 

ptrc = (char *) &buffer[4 * CPW]; /* Start after the 4 word header */ 


j = 0; 

D–16 7831 0687–010


printf("Release variable2 records.\n"); 


{ 



while (k > 0) 

{ line[i++ + CPW] = '^'; 

k--; 

} 

j = j + CPW + i; /* 4 chars in a word */ 

*ptri = (i / CPW) +1; /* set the RCW - length of record + RCW */ 

ptrc = ptrc + CPW; /* add the length of the RCW */ 




*ptri = 0; /* In case it's the last one */ 

} 

ptrc = ptrc-j; /* reset to the start of the buffer */ 

fclose(fp); 




my_record_packet.subtype = sm_variable2_records; 








SRTRELEASE(&my_return_status, &dbank, &my_record_packet, 

&buffer[4 * CPW]); 







printf("Perform SRTSORT.\n"); 

SRTSORT(&my_return_status, &dbank); 

printf ("SRTSORT severity code = %o, error code = %d\n \n", 


/* Returning records from SORT using a fixed block transfer method. */ 



7831 0687–010 D–17







my_record_packet.sort_pad.pad_word_char[0] = '‘'; 

my_record_packet.sort_pad.pad_word_char[1] = '|'; 

my_record_packet.sort_pad.pad_word_char[2] = '|'; 

my_record_packet.sort_pad.pad_word_char[3] = '‘'; 

printf ("Return records in a 8 word fixed format.\n"); 











for (i = 1; i

} 



printf ("Close the SORT operation. \n"); 

SRTCLOSE(&my_return_status, &dbank); 

printf ("SRTCLOSE severity code = %o, error code = %d\n \n", 


printf ("************** END OF SORT OPERATION ************ \n \n"); 

printf("Test is finished.\n"); 

return (1); 

7831 0687–010 D–19


D–20 7831 0687–010

Appendix E 

Configuration of Internal Parameters 

Internal parameters for the SORT processor and the SORT subroutines are contained in 

the following mass-storage program file element: 

SYS$*SRT$PAR.SORTDEFAULTS/SORT22R2 

This element is established during a COMUS installation of Sort/Merge and can be 

altered or checked under control of the COMUS CONFIGURE command. 

Note: During a COMUS or Software Library Administrator (SOLAR) installation of 

Sort/Merge, do not use the INSFILE parameter to alter the SYS$*SRT$PAR file name. 

This disables the parameter element and the ability to configure Sort/Merge. 

E.1. Sample DEFAULT$ Configuration Session – 

Full-Screen Mode 

Configure the Sort/Merge internal parameter defaults in the full-screen mode by using 

the following procedure: 

1. Establish the database qualifier: 

í@qual doc 

2. Call the COMUS processor by using the @COMUS command (the T option is for 

full-screen mode): 

íI:002333 QUAL complete. 

í@comus,t 

3. Begin the configuration process by using the CONFIGURE command: 

íCOMUS 6R9 (090505 0909:15) 2009 Sep 21 Mon 1657:46 

íCopyright (c) 1995Ä2009 Unisys Corporation. 

íAll rights reserved. 

íUNISYS CONFIDENTIAL 

íDatabase Qualifier: DOC 

íCOMMAND ? íconfigure 

7831 0687–010 E–1


4. Create a user set from DEFAULT$ set by using one of the following COPY 

commands: 

íThere are currently no user sets 

íTo create a user set, enter a copy directive: 

íCOPY PRODUCT=productÄname LEVEL=levelÄname TO=setÄname 

íor 

íCOPY ACTIVE PRODUCT=productÄname LEVEL=levelÄname TO=setÄname 

íDIRECTIVE ? ícopy product=sort level=22R2 to=dset 

5. Select Sort/Merge from user set DSET by entering 1: 

1 

Master Menu for Set=DSET Select the product you wish to configure 

PRODUCT LEVEL UPDATED 

1 SORT 22R2 

6. View the device defaults by entering 1: 

1 

E–2 7831 0687–010 

MAIN 

This is the main menu for Sort/Merge level 22R2B. 

Select the area you wish to view. 

1. DEVICE DEFAULTS 

2. MESSAGE CONTROL 

3. CORE CONTROL 

4. INPUT/OUTPUT FILE CONTROL 

5. INTERNATIONALIZATION (I18N) CONTROL 

7. Move to the previous COMUS display by using the BACK command: 

back 


The following represent all of the configurable Sort/Merge device 

defaults and are meaningful only to the SORT processor: 

DEFXA F40 

DEFXB F40 

DEFDK F 

DEFTP T

8. View the message control area by entering 2: 

2 


7831 0687–010 E–3 

MAIN 








9. Establish the update mode by using the MODE=UPDATE command: 

mode=update 


The following represent all of the configurable Sort/Merge message 

controls. CONSOLE and LOG apply to both the SORT processor and the SORT 

subroutines. PRCERRCONS applies to only the SORT processor 

CONSOLE OFF 

LOG ON 

PRCERRCONS OFF 

10. Change the LOG parameter by tabbing to the LOG field and overwriting it: 





CONSOLE OFF 

LOG OFF 


11. Make the changes permanent by using the COMMIT command: 

commit 





CONSOLE OFF 

LOG OFF 

PRCERRCONS OFF



back 





CONSOLE OFF 

LOG OFF 


13. View the core control area by entering 3: 

3 

E–4 7831 0687–010 

MAIN 









mode=update 

CORE CONTROL 

The following represent the configurable core controls. The first 

three parameters are extended mode Sort controls and are meaningful for 

the SORT processor and the SORT subroutine. DEFBMCORE represents a 

basic mode Sort control and is meaningful only to the SORT processor. 

AUTOMATIC YES 

MAXIMUM 1000000 

MINIMUM 262144 

DEFBMCORE 210000 

15. Change the AUTOMATIC parameter from YES to NO by tabbing to the AUTOMATIC 

field and overwriting it: 

CORE CONTROL 





AUTOMATIC NO 



DEFBMCORE 210000



commit 

CORE CONTROL 





AUTOMATIC NO 





back 

CORE CONTROL 





AUTOMATIC NO 




18. View the input/output file control area by entering 4: 

4 

7831 0687–010 E–5 

MAIN 








19. Establish the update mode using the MODE=UPDATE command: 

mode=update 


The following represent all of the configurable input/output file 

control parameters and are meaningful only to the SORT processor: 

MSAMBLOCK DEFAULTCALC 

PREPDEFAULT 28 

NUMRECWARN NONE 

PROCESSING NONWORD


20. Change the MSAMBLOCK parameter from DEFAULTCALC to BLOCKPARAM by 

tabbing to the MSAMBLOCK field and overwriting it: 




MSAMBLOCK BLOCKPARAM 



PROCESSING NONWORD 


commit 









back 








23. View the internationalization control area by entering 5: 

5 

This is the main menu for Sort/Merge level 22R2. 


E–6 7831 0687–010 

MAIN 





5. INTERNATIONALIZATION (I18N) CONTROL


24. Establish the update mode using the MODE=UPDATE COMMAND: 

mode=update 


The following represent all of the configurable Internationalization 

(I18N) controls. RBSIZE is meaningful to both the SORT processor and 

the SORT subroutines. The other I18N configuration parameters are 

meaningful only to the SORT processor. 

RBSIZE 16777216 

CCSLOCNUM DEFAULT 

CCSLOCNUMCHK ON 

DEFLOCALE _QUERY 

25. Change the CCSLOCNUMCHK configuration parameter from ON to OFF by tabbing 

to the CCSLOCNUMCHK field and overwriting it: 






RBSIZE 16777216 


CCSLOCNUMCHK OFF 



commit 






RBSIZE 16777216 




7831 0687–010 E–7


27. Apply the configuration changes to SORT by using the PROCESS command: 

process product=sort level=22R2 set=dset 






RBSIZE 16777216 




PROCESS in progress Ä Please Wait. 

. 

. 

. 

28. COMUS returns from the PROCESS command at the main menu. Exit from SORT 

configuration processing by entering E on the COMUS display: 

e 

PROCESS completed successfully. 

E–8 7831 0687–010 

MAIN 








29. Exit from COMUS by using the EXIT command: 

íFURPUR 32R4A (080924 1517:54) 2009 Sep 21 Mon 1659:08 

íEND PACK. TEXT=4,TOC=1,SYM=6,OMN=4 

íI:002333 FREE complete. 


íCONFIGURE TASK COMPLETED ************************* 

íCOMMAND ? íexit 

íEND COMUS


E.2. Sample DEFAULT$ Configuration Session – 

Line Mode 

Configure the Sort/Merge internal parameter defaults in line mode by using the following 

procedure: 

1. Establish the database qualifier: 

í@qual doc 

2. Call the COMUS processor by using the @COMUS command: 

íI:002333 QUAL complete. 

í@comus 

3. Begin the configuration process by using the CONFIGURE command: 

íCOMUS 6R9 (090505 0909:15) 2009 Sep 21 Mon 1659:51 

íCopyright (c) 1995Ä2009 Unisys Corporation. 

íAll rights reserved. 

íUNISYS CONFIDENTIAL 


íCOMMAND ? íconfigure 

4. Create a user set from DEFAULT$ set by using one of the following commands: 

íThere are currently no user sets 

íTo create a user set, enter a copy directive: 

íCOPY PRODUCT=productÄname LEVEL=levelÄname TO=setÄname 

íor 

íCOPY ACTIVE PRODUCT=productÄname LEVEL=levelÄname TO=setÄname 

íDIRECTIVE ? ícopy product=sort level=22R2 to=dset 

5. Access Sort/Merge from user set DSET by entering 1: 

íMaster Menu for Set=DSET Select the product you wish to configure 

í PRODUCT LEVEL UPDATED 

í 1 SORT 22R2 

íDIRECTIVE ? í1 

6. View the device defaults by entering 1: 

í MAIN 

í This is the main menu for SORT/MERGE level 22R2B. 

í Select the area you wish to view. 

í 1. DEVICE DEFAULTS 

í 2. MESSAGE CONTROL 

í 3. CORE CONTROL 

í 4. INPUT/OUTPUT FILE CONTROL 

í 5. INTERNATIONALIZATION (I18N) CONTROL 


7831 0687–010 E–9



í DEVICE DEFAULTS 

í The following represent all of the configurable Sort/Merge device 

í defaults and are meaningful only to the SORT processor: 

íDEFXA F40 

íDEFXB F40 

íDEFDK F 

íDEFTP T 

íDIRECTIVE ? íback 

8. View the message control display by entering 2: 

í MAIN 









9. Establish update mode by using the MODE=UPDATE command: 

í MESSAGE CONTROL 

í The following represent all of the configurable Sort/Merge message 

í controls. CONSOLE and LOG apply to both the SORT processor and the SORT 

í subroutines. PRCERRCONS applies to only the SORT processor 

íCONSOLE OFF 

íLOG ON 

íPRCERRCONS OFF 

íDIRECTIVE ? ímode=update 

10. Change the value of the LOG parameter by using the ASSIGN LOG=OFF command: 





íCONSOLE OFF 

íLOG ON 


íDIRECTIVE ? íassign log=off 






íCONSOLE OFF 

íLOG OFF 


íDIRECTIVE ? ícommit 

E–10 7831 0687–010






í subroutines. PRCERRCONS applies to only the SORT processor. 

íCONSOLE OFF 

íLOG OFF 



13. View the CORE CONTROL display by entering 3: 

í MAIN 










í CORE CONTROL 

í The following represent the configurable core controls. The first 

í three parameters are extended mode Sort controls and are meaningful for 

í the SORT processor and the SORT subroutine. DEFBMCORE represents a 

í basic mode Sort control and is meaningful only to the SORT processor. 

íAUTOMATIC YES 

íMAXIMUM 1000000 

íMINIMUM 262144 

íDEFBMCORE 210000 


15. Change the value of the AUTOMATIC parameter by using the ASSIGN 

AUTOMATIC=NO command: 






íAUTOMATIC YES 




íDIRECTIVE ? íassign automatic=no 







íAUTOMATIC NO 





7831 0687–010 E–11








íAUTOMATIC NO 





18. View the INPUT/OUTPUT display by entering 4: 

í MAIN 










í INPUT/OUTPUT FILE CONTROL 

í The following represent all of the configurable input/output file 

í control parameters and are meaningful only to the SORT processor: 

íMSAMBLOCK DEFAULTCALC 

íPREPDEFAULT 28 

íNUMRECWARN NONE 

íPROCESSING NONWORD 


20. Change the value of the PREPDEFAULT parameter by using the ASSIGN 

PREPDEFAULT=56 command: 








íDIRECTIVE ? íassign prepdefault=56 










E–12 7831 0687–010











23. View the INTERNATIONALIZATION (I18N) CONTROL display by entering 5: 

í MAIN 










í INTERNATIONALIZATION (I18N) CONTROL 

í The following represent all of the configurable Internationalization 

í (I18N) controls. RBSIZE is meaningful to both the SORT processor and 

í the SORT subroutines. The other I18N configuration parameters are 

í meaningful only to the SORT processor. 

íRBSIZE 16777216 

íCCSLOCNUM DEFAULT 

íCCSLOCNUMCHK ON 

íDEFLOCALE _QUERY 


25. Change the value of the CCSLOCNUM parameter by using the ASSIGN 

CCSLOCNUM=PREI18N command: 







íCCSLOCNUM DEFAULT 



íDIRECTIVE ? íassign ccslocnum=prei18n 

7831 0687–010 E–13









íCCSLOCNUM PREI18N 











íCCSLOCNUM PREI18N 




28. Apply the configuration changes to SORT by using the PROCESS command: 

í MAIN 








íDIRECTIVE ? íprocess product=sort level=22R2 set=dset 

íPROCESS in progress - Please Wait. 

. 

. 

. 

29. Exit the SORT configuration process by entering E: 

í MAIN 








íPROCESS completed successfully. 

íDIRECTIVE ? íe 

E–14 7831 0687–010

30. Exit from COMUS by using the EXIT command: 

íFURPUR 32R4A (080924 1517:54) 2009 Sep 21 Mon 1701:12 

íEND PACK. TEXT=4,TOC=1,SYM=6,OMN=4 

íI:002333 FREE complete. 


íCONFIGURE TASK COMPLETED ************************* 

íCOMMAND ? íexit 

íEND COMUS 


7831 0687–010 E–15


E–16 7831 0687–010

Glossary 

A 

ACOB 

activity 

Acronym for ASCII COBOL. 

A virtual central processing unit (CPU). The Exec maintains a CPU environment for an 

execution sequence or thread, called an activity. This activity appears to have continuous 

use of a single CPU as long as it desires, even though the Exec divides CPU usage 

among many activities or executes them on different CPUs. All program execution is 

performed by an activity. A program is initially assigned and typically needs just one 

activity; complex programs can register additional activities to be executed 

asynchronously. Synonym for task. 

activity local 

One of the four levels (also called sharing levels) at which banks in the system can be 

shared by multiple users. The other levels are application local, program local, and 

system local. System local and activity local have meaning only in extended mode. 

Activity-local banks are also called task local. See also virtual address. 

application local 


shared by multiple users. The other levels are activity local, program local, and system 

local. Application-local banks are common banks. See also virtual address. 

ASCII 

Abbreviation for American Standard Code for Information Interchange. 

average string length 

Sort/Merge computes the length of a string. It is equal to the product of the bias times 

the size of the tournament area, or the total data volume divided by the number of 

strings created. 

B 

bank 

(1) A data structure of computer hardware, representing an area of main storage. This is 

called a physical bank. (2) A collection of related code, data, and control information that 

is the main subdivision of an object module element. This is called a virtual bank, logical 

bank, or bank template. Virtual banks are produced by compilers or assemblers and are 

loaded into physical banks. 

7831 0687–010 Glossary–1

Glossary 

bank address 

The bank-relative address of a program location. 

bank descriptor 

A group of four words of storage that includes information on the base address, upper 

and lower limits, and security attributes for a bank. The bank descriptor also provides the 

basic storage structure used for managing the addressing environment. See also bank 

descriptor index, bank descriptor table. 

bank descriptor index (BDI) 

A bank identifier that points to one bank descriptor in a bank descriptor table. In a PADS 

low-level address, the symbol => identifies the immediately preceding integer 

expression as the bank descriptor index. See also address modifier. 

bank descriptor table 

A group of bank descriptors that corresponds to one of the addressing levels at which 

banks can be shared: system, application, program, or activity. 

bank name 

The name assigned to a bank during the collection of a program. 

base register 

One of 32 base (B) registers. The first 16 registers (B0 through B15) are user base 

registers that make an extended mode bank in main storage visible to an executing 

program. The last 16 registers (B16 through B31) are Exec base registers. 

based bank 

A bank that is currently pointed to by a base register. A bank must be based to be 

available to the executing program. 

basic mode sort 

A sort that performs its operation in basic mode (as opposed to extended mode). The 

possible basic mode sorts are basic mode memory, M1, M1-M2, basic mode disk, and 

tape. 

BDI 

bias 

See bank descriptor index. 

A measurement of the sorted order of the unsorted records of data. If the input data 

was in reverse order, the bias of the data would be 1.0. Sort calculates the bias of the 

data using the following formulas: 

average string length = input volume / number of strings created 

bias = average string length / size of the tournament area 

block size 

The amount of data in each read or write to the sort scratch file. The sort computes this 

as follows: 

available core/XA merge power 

Glossary–2 7831 0687–010

C 

character string 

A sequence of contiguous characters. 

Glossary 

core area 

The memory area used by the SORT subroutines to perform the sort operation. The area 

is defined by the SORT subroutine CORE parameter. The SORT processor internally 

defines this area based upon the SORT processor CORE parameter. As an example, this 

area includes the tournament area, input and output buffers. 

D 

decimal 

A numeric value that represents a decimal integer. 

disk sort 

A type of sort that requires 3 to 26 disk scratch files to be assigned. A disk sort can be 

either a basic mode disk sort, which is performed in basic mode, or an extended mode 

disk sort, which is performed in extended mode. All scratch files should be of the same 

size. 

DROC 

E 

ECL 

Abbreviation for data reduction code. 

Abbreviation for Executive Control Language. 

exception 

An error or other exceptional situation that arises during execution of a UCS Ada 

program. 

extended mode 

The mode of execution on 2200 Series systems that allows 

• Sixteen user base registers 

• Increased address space 

• Additional machine instructions 

extended mode sort 

A sort that performs its operation in extended mode (as opposed to basic mode). The 

possible extended mode sorts are extended mode memory and extended mode disk. 

7831 0687–010 Glossary–3

Glossary 

F 

file name 

A string of characters that identifies a file name. 

G 

GAP 

See general access permission. 

general access permission (GAP) 

A value assigned to a bank that specifies the type of access permitted to another activity 

accessing that bank. During static linking, general access permission (GAP) is called 

OTHER_ACCESS. The GAP value can specify any of the following types of access: 

• Read 

• Write 

• Execute 

• Combinations of the above 

• None (no access permitted to other activities) 

When the key of an activity does not match the lock of the bank, the activity can access 

the bank with the type of access permitted by the GAP value. See also special access 

permission. 

general register set (GRS) 

A set of 128 program-addressable 36-bit control registers. The set includes indexing 

registers, accumulators, repeat counters, a mask register, a real-time clock register, 

interrupt status words, captured timer value, byte manipulation, and control registers. 

H 

hexadecimal 

A numeric value that represents a hexadecimal integer. 

High-Volume Transaction Processing (HVTIP) 

A specialized technique used for applications requiring a high rate of throughput, and 

whose processing of a transaction can pass through an arbitrary sequence of 

subprograms. See also Transaction Processing. 

I 

integer 

An unsigned whole decimal number. 

Glossary–4 7831 0687–010

Glossary 

internationalization 

Unisys software features that develop and run applications customized to a specific 

language, culture, or business environment. These features provide support for 

numerous character sets and locales. 

J 

j-factor 

K 

A partial word designator, including half-words, H1 and H2, quarter-words, Q1 through 

Q4, sixth-words, S1 through S6, third-words T1 through T3, and whole-word, W. 

katakana 

A list or set of single-octet, phonetic Japanese characters, each one representing one 

syllable. Katakana is used for writing foreign words or documents such as telegrams. 

The characters have ordinal values in the range 161 through 254, depending on the 

output device. The ISO code set (JISCII), as well as the kanji code set, have the codes 

for the katakana characters. 

key 

L 

locale 

M 

M1 sort 

A field within a record that has specific properties that Sort/Merge uses to order the 

records. A maximum of 64 sort keys may be specified. 

A set of rules that establishes the national or cultural rules for usage of a coded character 

set. 

A basic mode sort with one mass-storage scratch file assigned. 

M1-M2 sort 

A basic mode sort with two mass-storage scratch files assigned. The smaller scratch file 

is the M1 scratch file and the larger is the M2 scratch file. If the two scratch files are 

assigned to different devices, the M1 scratch file should be assigned to the faster 

device. 

memory sort 

A type of sort that requires no scratch files to be assigned. For successful completion of 

the sort, all records must fit in the core area provided. 

7831 0687–010 Glossary–5

Glossary 

merge D-bank 

A data area passed to the SORT subroutines that contains basic control information 

about the merge operation. The minimum size for this area is 0500 words. This area is 

passed to the SORT subroutines through register X9 for the extended and commonbanked 

sort linkages. 

merge power 

The maximum number of strings that sort can merge together at one time. The strings 

that are merged either form a larger string or the final ordered set of records. 

N 

nonnumeric literal 

A character string bounded by apostrophes or quotation marks. The character string can 

include any character in the computer’s character set. 

numeric constant 

A numeric value represented in any specified base (binary, octal, decimal, or 

hexadecimal). 

O 

object module 

A type of compiled or assembled element in a program file that contains banks, bank 

control information, diagnostic information, and sufficient information to allow it to be 

statically linked or dynamically linked. The banks in an object module can be loaded into 

main storage and executed. Compilers use the Linking System to create and format 

object modules. The following types of object modules exist: standard object modules, 

bound object modules, and zero overhead object modules (ZOOM). See also element. 

octal 

P 

A numeric value that represents an octal integer. 

program local 


shared by multiple users. The other levels are application local, activity local, and system 

local. Program-local banks are program banks. See also virtual address. 

R 

RCW 

Abbreviation for record control word. 

Glossary–6 7831 0687–010

ecord 

An entity that consists of a set of characters or fields that form the basic unit that 

Sort/Merge defines as the item to be sorted. 

Glossary 

relocatable element 

For OS 2200 systems, a machine language element, produced by a basic mode compiler 

such as ASCII FORTRAN or ASCII COBOL, that is not yet ready for execution. The 

Collector links relocatable elements into an executable absolute element. 

S 

SAP 

See special access permission. 

scratch file 

A mass-storage disk or tape file that the SORT subroutines use as a scratch area to hold 

records when all the records will not fit in the core area. The number and type of scratch 

files provided determines the type of sort performed. The SORT processor assumes 

that the scratch files are named XA, XB, XC, XD,...,XY, and XZ. 

segment 

The name of a program segment as it appears in the MAP directives at program 

collection (or the collector default). 

sharing level 

One of four levels at which banks in the system can be shared by multiple users. The 

four sharing levels are system local, application local, program local, and activity (or task) 

local. System local and task local have meaning only in extended mode. See also 

application local; program local. 

sort D-bank 

A data area passed to the SORT subroutines that contains basic control information 

about the sort operation. The minimum size for this area is 02200 words. This area is 

passed to the SORT subroutines through register X9 for the extended and commonbanked 

sort linkages. 

special access permission (SAP) 

A value assigned to a bank that specifies the type of access permitted to the activity that 

owns the bank. During static linking, special access permission (SAP) is called 

OWN_ACCESS. The SAP value can specify any of the following types of access: 

• Read 

• Write 

• Execute 

• Combinations of the above 

When the key of an activity matches the lock of the bank, the activity can access the 

bank with the type of access permitted by the SAP value. See also general access 

permission. 

7831 0687–010 Glossary–7

Glossary 

start bit 

string 

An integer identifying the first bit in a word. 

An ordered subset of records that a sort creates internally. These strings are merged 

together to form the final ordered set of records. 

system local 


shared by multiple users. The other levels are application local, program local, and 

activity local. System local and task local have meaning only in extended mode. See 

also virtual address. 

T 

tape sort 

A basic mode sort with three to 24 tape scratch files assigned. In addition, one or two 

mass-storage scratch files may be assigned similar to an M1 sort or an M1-M2 sort. 

task local 

See activity local. 

TIP 

See Transaction Processing. 

tournament area 

The part of the core area that is used to hold the records and perform the sort operation. 

This area usually is the substantial portion of the core area. 

Transaction Processing (TIP) 

A modular extension of the Exec known as TIP that provides a high-performance system 

in which a user causes the execution of a predefined transaction program by entering an 

input message from a remote terminal. The program accesses the application database 

and returns a response to the user. 

types of sort 

Sort provides seven different types of sorts, which are 

• Basic mode memory sort 

• Basic mode disk sort 

• Extended mode memory sort 

• Extended mode disk sort 

• M1 Sort 

• M1-M2 Sort 

• Tape Sort 

Glossary–8 7831 0687–010

U 

Glossary 

use name 

A convenient short name used to designate an address, variable, procedure name, or file 

name that has been defined in a USE command. 

V 

variable 

A data storage area that can be assigned data or have data replaced with other data. A 

source program symbolic name associated with a program data location. 

virtual address ` 

A 36-bit address consisting of an address tree level, a bank descriptor index, and an 

address offset. See also system local; application local; program local; activity local. 

VTH 

Abbreviation for virtual tape file. 

7831 0687–010 Glossary–9

Glossary 

Glossary–10 7831 0687–010

Index 

A 

ACCEPT SORT processor parameter, 

description, 3-11 

accessing 

the SORT processor, 1-3 

the SORT subroutine, 1-4 

the SORT subroutines, through your own 

programs, 1-4 

ACOB/CFH input file, record structure, 3-70 

activating the SORT processor, 1-3, 3-1 

ALLOW SORT processor parameter, 


ascending index key, specifying, 3-33, 3-34 

ASCII 

alphanumeric key field, description, 11-9 

sign leading overpunch format key field, 


sign leading separate decimal key field, 


sign trailing overpunch key field, 


sign trailing separate decimal key field, 


assigning an R$CORE file, 2-6 

AUTOMATIC configuration parameter, 


automatic tape sorts, description, 12-1 

B 

basic mode 

disk sort, maximum number of scratch 

files, 10-3 

environment, 1-4, 2-1 

main storage sort 

formula for calculating main storage 

used, 10-2 

requirements, 10-2 

sort 

directing the SORT processor to 

perform, 1-4 

disk sorts, 10-3 

environment operations, 2-1 

fixed-length records, 10-2 

selecting, 2-1 

variable-length record, 10-3 

BIAS 

R$FILE assembly-time parameter, 


SORT processor parameter, 


bias factor, independent of disk sorts, 10-4 

BLOCK parameter, description, 3-16 

blocks 

characteristics, defining with BLOCK 

parameter, 3-16 

granules, specifying with BLOCK 


blocks, size 

minimum for M1 module, 3-41 

minimum for M2 module, 3-42 

bulk interface, 8-9 

7831 0687–010 Index–1 

C 

C program 

linkages, 7-1 

SORT subroutine linkages, 8-1 

CCSLOCNUM configuration parameter, 


CCSLOCNUMCHK configuration parameter, 


CHECK 





CHECKD R$FILE assembly-time parameter, 


CHECKF R$FILE assembly-time parameter, 


CHECKK R$FILE assembly-time parameter, 

description, 5-8

Index 

checkpoint, writing with CKPT 


checksum operations 

eliminating with CHECK parameter, 3-18 

forcing elimination with CHECKSUM 


setting the mesh count in 

disk modules, CHECKK R$FILE 


M1 mass storage, CHECKD R$FILE 


M2 mass storage, CHECKF R$FILE 


tape modules, CHECKT R$FILE 


specifying frequency, 3-18 

CHECKSUM SORT processor parameter, 


CHECKT R$FILE assembly-time parameter, 


CKPT SORT processor parameter, 


code-type numbers, setting, 9-2 

CODE-TYPE processor parameter, 3-20 

collating sequence 

automatic generation with SEQX 


specifying alternate 

with SEQ parameter, 3-60 

with SEQA parameter, 3-60 

with SEQC parameter, 3-61 

combining index keys with ISAM input 

records, 3-35 

common bank interface, sample program, C-1 

COMP C program parameter, 7-5 

COMP R$FILE assembly-time parameter, 


COMP routine, writing user own code, 6-21, 

7-22 

compatibility, with previous levels, 1-15 

completion messages, deleting with DELLOG 


COMUS, CONFIGURE command, E-1 

configuration of internal parameters, E-1 

configuration parameters, 9-1 

AUTOMATIC, 9-1 

CCSLOCNUM, 9-2 

CCSLOCNUMCHK, 9-2 

CONSOLE, 9-3 

DEFBMCORE, 9-3 

DEFDK, 9-4 

DEFLOCALE, 9-4 

DEFTP, 9-5 

DEFXA, 9-5 

DEFXB, 9-6 

LOG, 9-6 

MAXIMUM, 9-7 

MINIMUM, 9-7 

MSAMBLOCK, 9-8 

NUMRECWARN, 9-8 

PRCERRCONS, 9-9 

PREPDEFAULT, 9-11 

PROCESSING, 9-10 

RBSIZE, 9-11 

configuration procedure 

using full-screen mode, E-1 

using line mode, E-9 

CONFIGURE, COMUS command, E-1 

configuring Sort/Merge 

sample session 

using full-screen mode, E-1 

using line mode, E-9 

CONSOLE 





CONSOLE C program parameter, 7-6 

CONSOLE configuration parameter, 


console messages, deleting, 3-23 

CONTA R$FILE assembly-time parameter, 


CONTB R$FILE assembly-time parameter, 


CONTC R$FILE assembly-time parameter, 


COPY 





COPY C program parameter, 7-7 

copy operation, performing with COPY 


CORE 




description, 3-21, 10-1 

core area 

maximum size calculation, 10-1 

minimum size calculation, 10-1 

specifying size with CORE parameter, 10-1 

CORE C program parameter, 7-7 

Index–2 7831 0687–010

core memory 

maximum number of words, specifying 

with MAXIMUM parameter, 9-7 

minimum number of words, specifying 

with MINIMUM parameter, 9-7 

creating indexed files, examples, B-11 

D 

data 

records, reformatting with SELECT 


reduction own routine, executing with 

SORT subroutines, 5-15 

DATA SORT processor parameter, 


date 

18-bit format, 11-4 

setting year 2000, 5-14 

year 2000 format, 11-4 

DATE key field, defining first year, 3-23 

d-bank address parameter, 8-4 

DEFBMCORE configuration parameter, 


DEFDK configuration parameter, 


defining 

blocking characteristics, BLOCK 


SORT processor files, 3-10 

DEFLOCALE configuration parameter, 


DEFTP configuration parameter, 


DEFXA configuration parameter, 


DEFXB configuration parameter, 


DEFYEAR 

processor parameter, 3-23 



DELCON 





deleting console messages, DELCON 


Index 

DELLOG 





determining 

block size, disk sorts, 10-4 

character type of data processed, DATA 


input volume, order of precedence, 3-73 

internal merge power, 10-4 

diagnostic messages, listing and 

description, A-1 

directing 

the SORT processor, 2-1 

the SORT subroutines, 2-1 

disk scratch files 

assigning mnemonic 

DEFDK, 9-4 

DEFTP, 9-5 

disk sorts 

basic mode, 10-3 

conditions for using, 10-3 

differences between basic and 

extended, 10-3 

DISKS SORT processor parameter, 


extended mode, 10-3 

formula for determining the size of scratch 

files, 10-4 

producing fewest number of strings, 10-4 

scratch file assignment 

considerations, 10-4 

SORT processor operation, 2-1 

usage of sequential data, 10-4 

disk, module, not collected into program, 5-29 

DISKS SORT processor parameter 


scratch facility assignment process, 3-73 

distribution phase of a tape sort, 


DROC C program parameter, 7-8 

DROC R$FILE assembly-time parameter, 


DROC routine, writing user own code, 6-22, 

7-23 

DRUM SORT processor parameter 



DSDF input file, record structure, 3-70 

dynamically assigning the output file, 

examples, B-12 

7831 0687–010 Index–3

Index 

E 

ECL, See Executive Control Language 

eliminating checksum operations, 

CHECKSUM SORT processor 


END C program parameter, 7-10 

environment 

basic mode, 1-4, 2-1 

extended mode, 1-4, 2-1 

supported on OS 2200 system, 2-1 

EQUIP SORT processor parameter, 


equipment files, identifying with EQUIP 


ERROR R$FILE assembly-time parameter, 


ESORT SORT processor parameter 


limitations when using, 3-27 

unconditionally perform an extended mode 

sort, 2-2 

when not to be specified, 2-2 

ESTIMATE SORT processor parameter, 


estimating time for an operation, ESTIMATE 


estimations, factor that affects sort 

operation, 3-71 

execution-time parameters, 5-51 

Executive control language, options and 

parameters 

file formats, 1-3 

input data type, 1-3 

processor call, 1-3 

processor mode, 1-3 

exit numbers 

explanation of, 4-3 

using, 4-1 

extended core area, 2-1 

extended mode 

disk sorts, maximum number of scratch 

files, 10-3 

environment, 1-4, 2-1 

fixed-length record, 10-2 

main-storage-only, formula for calculating 

usage, 10-2 

selecting, 2-1 

sort 

directing the SORT processor to 

perform, 1-4 

disk sort, 10-3 

example, B-12 

performing with ESORT parameter, 3-27 

SORT subroutines selection factors, 2-6 

variable-length record, 10-3 

using the SORT processor in, 2-2 

using the SORT subroutine in, 2-6 

extended mode sort, permission setting 

(AUTOMATIC parameter), 9-1 

Index–4 7831 0687–010 

F 

FAST SORT processor parameter 



Fieldata 

alphanumeric key field, description, 11-2 

sign leading overpunch key field, 


sign leading separate key field, 


sign trailing overpunch key field, 


sign trailing separate decimal key field, 


file identification parameters, definition, 3-10 

file type, specifying with MODE 


FILEID SORT processor parameter, 


FILEIN SORT processor parameter, 


FILEOUT SORT processor parameter, 


FILES C program parameter, 7-10 

FILES R$FILE assembly-time parameter, 


FILESIN SORT processor parameter, 


final merge phase, 12-10 

FINAL R$FILE assembly-time parameter, 


fixed-length records 

compared with variable-length record 

sorting, 10-6 

formula for calculating basic mode 

memory storage, 10-2 

formula for calculating extended mode 

memory storage, 10-2 

safety factor for calculating main 

storage, 10-3

FPOC R$FILE assembly-time parameter, 


full-screen mode, sample configuration 

session, E-1 

G 

global parameters, list of, 3-3 

I 

IBM signed binary key field, description, 11-7 

include element for UCS C linkages, 8-1 

index keys 

combining with ISAM input records, 3-35 

identifying as MSAM output, MSKEY 


identifying as MSAM output, MSKEYW 


separating from record with SPLIT 


indexed files, creation example, B-11 

INFO C program parameter, 7-11 

input 

data ordering, BIAS parameter, 3-16 

file, specifying with FILEIN 


operation files, FILESIN parameter, 3-33 

volume, determining, 3-73 

input records 

number to sort with RECORD 


preserving the order, 3-51 

stop processing, 3-64 

inserting global parameters, example, 3-6 

intermediate 

merge phase of a tape sort, 12-6 

merge phase of a tape sort 


merge technique, used by disk sorts, 10-4 

internal parameters, configuration of, E-1 

Internationalization character set format, 11-5 

Internationalization, defining locale, 3-43 

IPURI$ MASM tape sort linkage, 6-11 

ISAM output file, specifying an ascending 

index key for, 3-33, 3-34 

ISAM/MSAM input file, record structure, 3-70 

ISKEY SORT processor parameter, 


Index 

ISKEYW SORT processor parameter, 


issuing 

completion messages, LOG 


operator console messages during sort 

run, CONSOLE parameter, 3-21 

7831 0687–010 Index–5 

J 

JOIN SORT processor parameter, 


K 

KEY 





KEY C program parameter, 7-12 

key field 

formats, list of, 11-2 

translations 

introduction, 11-1 

Sort/Merge key fields, 11-2 

using MASM compare instructions, 11-1 

treating parts of records as, 3-35, 3-38 

used for sort or merge operation 

KEY R$FILE assembly-time 


KEYW R$FILE assembly-time 


KEYW 





L 

LABEL SORT processor parameter, 


label, indicating the presence of with LABEL 


LIMDRM SORT processor parameter, 


LIMFST SORT processor parameter, 

description, 3-42

Index 

line mode, sample configuration session, E-9 

link sizes, affect on sorting, 10-7 

LINKSZ SORT processor parameter 


specifying size, 10-6 

local parameters 

list of, 3-3 

specification, syntax format, 3-8 

LOCALE C program parameter, 7-14 

locale number, setting, 9-2 

LOCALE processor parameter, 3-43 

LOCALE, R$FILE assembly-time parameter, 


LOG 





LOG C program parameter, 7-15 

LOG configuration parameter, description, 9-6 

log run 

issuing normal completion messages 

to, 5-28 

omitting sort completion messages 

from, 5-15 

logical records, skipping with SKIP 


LPOC R$FILE assembly-time parameter, 


M 

M1 scratch file, assigning mnemonic, DEFXA 

configuration parameter, 9-5 

M1:, See one-level mass storage sorts (M1)) 

M2, scratch file, assigning mnemonic 

DEFXB configuration parameter, 9-6 

M2:, See two-level mass storage sorts (M2) 

main storage used for sort algorithm, 3-21 

MASM merge program linkages, 6-14 

MASM program coding parameter table 

entries as constants, 5-50 

MASM program linkages, 6-1 

interface aids, 6-19 

procedure definition elements, 6-2 

sort 

open linkages, 6-4 

program linkages, 6-3 

quick end linkages, 6-10 

release linkages, 6-5 

return linkages, 6-9 

sort release linkages, 6-8 

tape sort linkages, 6-11 

IPURI$, 6-11 

user routine substitution 


MASM program linkages merge 

close linkages, 6-18 




request linkages, 6-17 

MASM program used to access SORT, 

examples, C-1 

mass storage 

files used as scratch files, 3-24 

modules (M1 and M2) not collected in 

program, 5-29 

prep size 

specifying with PREPDEFAULT 


MAXIMUM configuration parameter, 


memory 

sort, 2-1 

specifying amount for a sort, 5-13 

merge 

operation, performing with MERGE 


subroutine mode, description, 1-5 

merge phase 

final, 12-10 

intermediate, 12-6 

merge program linkages 

sample program, D-5 

UCS C, 8-21 

MERGE SORT processor parameter, 


merging files into output file, examples, B-5 

mesh count setting for checksum calculations 

disk module, 5-8 

one-level mass storage, 5-7 

tape modules, 5-9 

two-level mass storage, 5-8 

messages, issuing to operator console 

(CONSOLE parameter), 9-3 

MINIMUM configuration parameter, 


MODE SORT processor parameter, 


MOVE SORT processor parameter, 


Index–6 7831 0687–010

MSAM support 

MSAMBLOCK parameter description, 9-8 

removing, 3-56 

MSAMBLOCK configuration parameter, 


MSKEY SORT processor parameter, 


MSKEYW SORT processor parameter, 


N 

NODISK R$FILE assembly-time parameter, 


NOMASS R$FILE assembly-time parameter, 


nonautomatic tape sorts 


PARTA sorts, 12-2 

PARTB sorts, 12-2 

PARTC sorts, 12-2 

nonreentrant sort, processor call, 3-1 

NOTAPE R$FILE assembly-time parameter, 


NUMREC SORT processor parameter, 


NUMRECWARN configuration parameter, 


O 

one-level mass storage sorts (M1) 

description of, 10-5 

guidelines on assigning M1 file, 10-5 

identifying file information with DRUM 


M1 file assignment considerations, 10-5 

specifying minimum block size, LIMDRM 


operation control parameter 

definition, 3-10 

SORT processor parameter, 3-63 

operator 

console messages 

deleting during a sort, DELCON R$FILE 


deleting with DELCON parameter, 3-23 

executing during a sort, CONSOLE 

R$FILE parameter, 5-10 

issuing with CONSOLE parameter, 3-21 

Index 

information, definition, 3-71 

OPTION C program parameter, 7-15 

OPTION R$FILE assembly-time parameter, 


ordered sequences, informing SORT 

subroutines of number, 5-6 

OS 2200 

signed binary key field, description, 11-3 

systems, environments supported, 2-1 

output file 

dynamically assigning, example, B-12 

merging files into, B-5 

sorting and producing, B-2 

specifying with FILEOUT SORT processor 


output, operations, specifying file for, 3-32 

overlapping types, rules for, 3-38, 3-40 

OWN SORT processor parameter, 


7831 0687–010 Index–7 

P 

P execution-time option, 5-51 

Packed Decimal Format Key Field, 


PAD C program parameter, 7-16 

PAD R$FILE assembly-time parameter, 


parameter 

groups, SORT processor, 3-10 

internal, configuration of, E-1 

specifications, syntax rules, 3-8 

table 

coding entries as constants, 5-50 


generating and using, 5-1 


saving space for additional 

information, 5-31 

parameters, execution-time, 5-51 

PARTA 



sort 

continuing after interruption, 5-10 

transferring control after 

completion, 5-19 

PARTB 


description, 5-33

Index 

sort 

continuing after interruption, 5-11 

transferring control after 

completion, 5-19 

PARTC, R$FILE assembly-time parameter, 


performance, extended mode sort, 2-1 

performing a 

copy operation, COPY parameter, 3-21 

disk sort, DISKS parameter, 3-24 

extended mode sort, example, B-12 

MERGE operation, MERGE 


RETRIEVE operation, RETRIEVE 


TAG/RETRIEVE sort, example, B-10 

time estimate for an operation, ESTIMATE 


P-option, suppressing at execution time, 5-30 

PRCERRCONS configuration parameter, 


PREP SORT processor parameter, 


PREPDEFAULT configuration parameter, 


prepping factor, specifying, 3-51 

PRESERVE 

C program parameter, 7-16 





printing the contents of a file, examples, B-1 

PROCESSING configuration parameter, 


PROCESSING SORT processor parameter, 


processor 

mode 

COPY, description, 1-4 

MERGE, description, 1-4 

procedure for requesting, 1-4 

SORT, description, 1-4 

usage, examples, B-1 

processor parameters, See SORT processor 

parameters 

producing an output file, examples, B-2 

R 

R$FILE assembly-time parameters 

BIAS, 5-6 

CHECK, 5-6 

CHECKD, 5-7 

CHECKF, 5-8 

CHECKK, 5-8 

CHECKT, 5-9 

COMP, 5-9 

CONSOLE, 5-10 

CONTA, 5-10 

CONTB, 5-11 

CONTC, 5-12 

COPY, 5-12 

CORE, 5-13 

DEFYEAR, 5-14 

DELCON, 5-15 

DELLOG, 5-15 

DROC, 5-15 

ERROR, 5-16 

FILES, 5-18 

FINAL, 5-19 

FPOC, 5-19 

KEY, 5-20 

KEYW, 5-24 

listed, (table), 5-2 

LOCALE, 5-27 

LOG, 5-28 

LPOC, 5-28 

NODISK, 5-29 

NOMASS, 5-29 

NOTAPE, 5-29 

OPTION, 5-30 

PAD, 5-31 

PARTA, 5-31 

PARTB, 5-33 

PARTC, 5-34 

PRESERVE, 5-34 

RECAREA, 5-34 

REDOA, 5-35 

REDOB, 5-36 

RSZ, 5-37 

RSZA, 5-37 

RSZB, 5-38 

RSZW, 5-38 

SEQ, 5-39 

SEQA, 5-40 

SEQB, 5-41 

SEQC, 5-42 

SEQD, 5-43 

SEQE, 5-43 

SEQF, 5-44 

SEQK, 5-45 

SMRG, 5-46 

VOL, 5-47 

Index–8 7831 0687–010

VRSZ, 5-47 

VRSZA, 5-48 

VRSZB, 5-48 

VRSZW, 5-49 

RBSIZE configuration parameter, 


reading, indexed files, examples, B-11 

RECAREA R$FILE assembly-time parameter, 


record address parameter, 8-9 

record information packet parameter, 8-4 

RECORD SORT processor parameter, 


records 

determining output order, PRESERVE 

R$FILE parameter, 5-34 

executing a user routine when 

compared, 5-9 

indicating length with RSZ parameter, 3-57 

number to process using NUMREC 


number to sort with RECORD 


preserving the order of input, 3-51 

processed test, ACCEPT parameter, 3-11 

rejecting with REJECT parameter, 3-53 

selecting classifications, examples, B-5 

separating from index key with SPLIT 


REDOA R$FILE assembly-time parameter, 


REDOB R$FILE assembly-time parameter, 


REELS parameter, description, 3-53 

reentrant sort, processor call statement, 3-1 

reformatting data records with SELECT 


REJECT parameter, description, 3-53 

removable disk packs, used with sort scratch 

files, 10-4 

RENCY$ MASM tape sort linkage, 6-12 

requesting 

a SORT operation, 3-10 

a TAG operation, 3-10 

result status parameter, 8-2 

retrieve operation, performing with RETRIEVE 


RETRIEVE SORT processor parameter, 


REVMSAMBLK SORT processor parameter, 


Index 

RINFO$ MASM tape sort linkage, 6-13 

routines, executing user routines with OWN 


RSZ 





RSZ C program parameter, 7-17 

RSZA R$FILE assembly-time parameter, 


RSZB R$FILE assembly-time parameter, 


RSZW R$FILE assembly-time parameter, 


run log, LOG configuration parameter 


run-condition word, 3-74 

runstream example, SORT processor, 3-9 

7831 0687–010 Index–9 

S 

scratch facility 

assigning, examples, B-8 

assignment process, 3-73 

assignment, factor of sort operation, 3-72 

determining, examples, B-8 

scratch files 

controlling the placement in disk 

sorts, 10-4 

determining the size for a disk sort, 10-4 

disk sort assignment considerations, 10-4 

example for determining the size used in 

disk sorts, 10-4 

listing names used by SORT 

subroutines, 5-18 

maximum number when using disk 

sorts, 10-3 

names when using disk sorts, 10-3 

naming guidelines, 3-72 

tape files used as, 3-70 

using mass storage files as, 3-24 

SELECT SORT processor parameter, 


SEQ 



SORT processor parameter 


SEQ C program parameter, 7-18

Index 

SEQA 





SEQB R$FILE assembly-time parameter, 


SEQC 





SEQD R$FILE assembly-time parameter, 


SEQE R$FILE assembly-time parameter, 


SEQF R$FILE assembly-time parameter, 


SEQK R$FILE assembly-time parameter, 


SEQX SORT processor parameter, 


SKIPL SORT processor parameter, 


skipping logical records with SKIP 


SMRG R$FILE assembly-time parameter 

automatic tape sorts, 12-1 


sort 

disk, 2-1 

large, 2-1 

memory, 2-1 

tape, 2-1 

sort completion messages, deleting with 

DELLOG parameter, 3-24 

SORT operation 

factors that affect, 3-71 

performing with SORT parameter, 3-63 

requesting, 3-10 

SORT processor 

activating, 1-3, 3-1 

basic mode, 1-4 


error messages, A-1 


parameter groups, 3-10 

parameter types, 3-3 

processor modes 

COPY, 1-4 

MERGE, 1-4 

program structure, 3-6 

runstream example, 3-9 

syntax rules example, 3-7 

using in extended mode, 2-2 

SORT processor call statement 

X option, 2-2 

Y option, 2-2 

SORT processor parameters 

ACCEPT, 3-11 

ALLOW, 3-13 

BIAS, 3-16 

BLOCK, 3-16 

CHECK, 3-18 

CHECKSUM, 3-18 

CKPT, 3-19 

CODE-TYPE, 3-20 

CONSOLE, 3-21 

COPY, 3-21 

CORE, 3-21, 10-1 

DATA, 3-22 

DEFYEAR, 3-23 

DELCON, 3-23 

DELLOG, 3-24 


DISKS, 3-24 

DRUM, 3-25 

EQUIP, 3-27 

ESORT, 3-27 

ESTIMATE, 3-28 

FAST, 3-29 

FILEID, 3-30 

FILEIN, 3-30 

FILEOUT, 3-32 

FILESIN, 3-33 

ISKEY, 3-33 

ISKEYW, 3-34 

JOIN, 3-35 

KEY, 3-35 

KEYW, 3-38 

LABEL, 3-41 

LIMDRM, 3-41 

LIMFST, 3-42 

LINKSZ, 3-42 

list of, 3-3 

LOCALE, 3-43 

LOG, 3-44 

MERGE, 3-44 

MODE, 3-44 

MOVE, 3-47 

MSKEY, 3-48 

MSKEYW, 3-49 

NUMREC, 3-50 

OWN, 3-50 

PREP, 3-51 

PRESERVE, 3-51 

Index–10 7831 0687–010

PROCESSING, 3-52 

RECORD, 3-52 

REELS, 3-53 

REJECT, 3-53 

RETRIEVE, 3-55 

REVMSAMBLK, 3-56 

RSZ, 3-57 

SELECT, 3-59 

SEQ, 3-60 

SEQA, 3-60 

SEQC, 3-61 

SEQX, 3-61 

SKIPL, 3-62 

SORT, 3-63 

SPLIT, 3-63 

STOP, 3-64 

STOPAPP, 3-67 

TAG, 3-68 

TAGFILE, 3-69 

TAPES, 3-70 

VOLUME, 3-71 

SORT processor:, See also SORT 

subroutines 

SORT program linkages, sample program, D-1 

SORT subroutines, See also SORT processor 


error messages, A-18 


factors for selecting an extended mode 

sort, 2-6 

linkages for UCS C programs, 8-1 

parameter tables for MASM programs, 5-1 

processor mode, 1-5 

summary messages, A-34 

terminating the sort in error, 2-6 

transferring control after errors, 5-16 

UCS C merge 

close linkage, 8-25 

open linkage, 8-21 


release linkage, 8-22 

request linkage, 8-23 

UCS C program linkage parameters, 8-2 

UCS C program linkages 

d-bank address parameter, 8-4 

parameter table parameter, 8-4 


record packet parameter, 8-4 


UCS C programs, 7-1 

COMP parameter, 7-5 

CONSOLE parameter, 7-6 

COPY parameter, 7-7 

Index 

CORE parameter, 7-7 

DROC parameter, 7-8 

END parameter, 7-10 

FILES parameter, 7-10 

INFO parameter, 7-11 

KEY parameter, 7-12 

LOCALE parameter, 7-14 

LOG parameter, 7-15 

OPTION parameter, 7-15 

PAD parameter, 7-16 

parameters, 7-4 

PRESERVE parameter, 7-16 

RSZ parameter, 7-17 

SEQ parameter, 7-18 

setting up parameter table, 7-2 

START parameter, 7-19 

user routine substitution, 7-21 

VOL parameter, 7-20 

VRSZ parameter, 7-20 

UCS C sort 

close linkages, 8-21 




return linkages, 8-18 

sort linkages, 8-18 

using in extended mode, 2-6 

Sort types 

basic mode main-storage-only, 10-2 

extended mode main-storage-only, 10-2 

list of, 10-2 

Sort/Merge 

abilities, 1-1 


key field formats, 11-2 

sort/merge operation, tailoring, 1-4 

Sort/Merge processor, See SORT processor 

Sort/Merge subroutine, See SORT 

subroutines 

sorting 

a file, examples, B-2 

algorithm, identifying necessary main 

storage, 3-21 

specifying 

an ascending index key for an ISAM, 3-33, 

3-34 

input file with FILEIN parameter, 3-30 

specifying core area size, CORE 


SPLIT SORT processor parameter, 


START C program parameter, 7-19 

7831 0687–010 Index–11

Index 

stop conditionally input record 

processing, 3-64 

STOP processor parameter, 3-64 

STOPAPP processing parameter, 3-67 

subroutines, substituting, 1-4 

syntax rules 

example, SORT processor, 3-7 

for local parameter specifications, 3-8 

for SORT processor parameter 

specifications, 3-7 

T 

table parameters, allowing acceptance from 

more than one table, 5-12 

tag 

operation, requesting, 3-10 

sort, performing with TAG parameter, 3-68 

TAG SORT processor parameter, 


TAG/RETRIEVE sort, example, B-10 

tagfile 

record structures, 3-70 

specifying name used with RETRIEVE 


TAGFILE SORT processor parameter, 


tailoring the sort/merge operation, 1-4 

tape 

files, used as scratch files, 3-70 

marks, specifying number to bypass, 3-47 

merge power calculations, 12-3 

module 

not collected in program, 5-29 

setting the mesh count for checksum 

calculation, 5-9 

reel, specifying numbers of uncataloged 

tape files, 3-53 

sort 


performing distribution phase of 

nonautomatic sort, 5-31 

performing final phase of nonautomatic 

sort, 5-34 

performing intermediate phase of 

nonautomatic sort, 5-33 

size restrictions, 10-6 

types of operations, 12-1 

tape sorts 

automatic, 12-1 

nonautomatic, 12-2 

TAPES SORT processor parameter 



tapesort, tape files used as scratch files, 

TAPE parameter, 3-70 

time estimate for an operation, ESTIMATE 


time parameter, used with nonautomatic tape 

sorts, 12-2 

translating key fields, MASM compare 

instructions, 11-1 

treating parts of records as key fields 


KEYW parameter, 3-38 

two-level mass storage sorts 


guidelines when assigning M1 and M2 

files, 10-5 

M1 file assignment considerations, 10-5 

minimum block size, LIMFST 


specifying file information, 3-29 

type 

A key field, specifying alternate collating 

sequence, 3-60 

S key field, specifying alternate collating 

sequence, 3-60, 3-61 

Index–12 7831 0687–010 

U 

UCS C program linkages, 7-1 

sample merge program, D-5 

sample sort program, D-1 

UCS C programs 

bulk interface, 8-9 

C merge 





request linkage, 8-23 

C sort 




return linkage, 8-18 

sort linkage, 8-18 

C sort linkages, 8-14 

COMP parameter, 7-5 

CONSOLE parameter, 7-6 

COPY parameter, 7-7

CORE parameter, 7-7 

DROC parameter, 7-8 

END parameter, 7-10 

FILES parameter, 7-10 

INFO parameter, 7-11 


linkage parameters, 8-2 

LOCALE parameter, 7-14 

LOG parameter, 7-15 

OPTION parameter, 7-15 

PAD parameter, 7-16 

parameters, 7-4 

PRESERVE parameter, 7-16 

RSZ parameter, 7-17 

SEQ parameter, 7-18 

setting up parameter table, 7-2 

SORT subroutine linkages, 8-1 

dbank address parameter, 8-4 

parameter table parameter, 8-4 


record packet parameter, 8-4 


START parameter, 7-19 

user routine substitution, 7-21 

VOL parameter, 7-20 

VRSZ parameter, 7-20 

Unsigned Binary Format Key Field, 


unsorted data, using, 1-5 

user 

DROC code, function, 6-22 

routine 

executing when comparing records, 5-9 

substitution codes, overview, 6-20 

using MASM compare instructions, key field 

translations, 11-1 

using, exit numbers, 4-1 

V 

variable-length records 



formula for calculating 

basic mode memory storage, 10-3 

extended mode memory storage, 10-3 

indicating significance to the sort, 3-42 

safety factor for calculating main 

storage, 10-3 

sorting 

Index 

compared to fixed-length record 

sorting, 10-6 

increasing efficiency, 10-6 

VOL C program parameter, 7-20 

VOL R$FILE assembly-time parameter, 


volume of input, VOLUME parameter, 3-71 

VOLUME SORT processor parameter, 


VRSZ 



variable-length record parameter, 

purpose, 10-6 

VRSZ C program parameter, 7-20 

VRSZA R$FILE assembly-time parameter, 


VRSZB R$FILE assembly-time parameter, 


VRSZW 



variable-length record parameter, 

purpose, 10-6 

7831 0687–010 Index–13 

W 

writing, a checkpoint, CKPT parameter, 3-19 

X 

XQT parameters, 5-51 

Y 

year 2000 

date format, 11-4 

DEFYEAR processor parameter, 3-23 

Special Characters 

@ASG, specifying core area size, 10-1 

@SORT 

call statement, 3-1 

processor usage examples, B-1 

program structure example, 3-6

Index 

Index–14 7831 0687–010

© 2010 Unisys Corporation. 

All rights reserved. 

*78310687-010* 

7831 0687–010

Sort/Merge Programming Guide - Public Support Login - Unisys

You also want an ePaper? Increase the reach of your titles

Delete template?

Save as template?