OS 2200 Collector Programming Reference Manual - Public Support ...

ClearPath OS 2200
Collector Programming Reference Manual
February 2011 7830 9887–001
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. Introduction
Section 2. Using the Collector
2.1. Collector Input .......................................................................... 2–1
2.1.1. Collector Language Conventions .................................... 2–3
2.1.2. Files ................................................................................. 2–4
2.2. Collector Output ....................................................................... 2–4
2.2.1. Collector-Produced Relocatable Elements ...................... 2–4
2.2.2. Collector-Produced Absolute Output .............................. 2–5
2.2.3. Listing .............................................................................. 2–5
2.3. @MAP-Collector Initiation and Termination ............................. 2–7
Section 3. Inclusion and Exclusion of Elements
Section 4. Banking
3.1. Explicit Inclusion and Exclusion ............................................... 3–1
3.1.1. IN - Element Inclusion ..................................................... 3–1
3.1.2. FRSTIN - First Element Included ..................................... 3–3
3.1.3. FORM - Source Language Structure Duplication ............ 3–3
3.1.4. NOT - Element Exclusion ................................................ 3–4
3.1.5. CLASS - Element Selection Determination
through Version Names .............................................. 3–6
3.2. Implicit Inclusion-File Searching ............................................... 3–8
3.2.1. LIB-File Searching............................................................ 3–8
3.2.2. RLIB - File Searching ..................................................... 3–10
3.2.3. DLIB - Directed LIB for the Default Libraries ................ 3–10
3.2.4. Sequence of File Searching ........................................... 3–10
3.2.4.1. System Library Searching ..................................... 3–11
3.2.4.2. Altering the Search Sequence - INFO Group
12 Keywords .................................................... 3–12
3.2.4.3. Determining the Search Sequence Used ............. 3–14
3.2.4.4. Searching User-Specified Search Files ................. 3–16
3.2.5. @PREP of Library Files .................................................. 3–17
4.1. Introduction .............................................................................. 4–1
4.2. Banking Directives ................................................................... 4–1
4.2.1. IBANK, DBANK — Bank Structuring ............................... 4–1
4.2.2. BANKINFO — Specifying Bank Attributes ...................... 4–6
4.2.3. $Ics — Location Counter Set Specification ................... 4–10
4.2.4. INFO Group 3 ................................................................ 4–12
7830 9887–001 iii

Contents
4.3. Bank-Implied Collections ........................................................ 4–12
4.4. Bank-Named Collections ........................................................ 4–13
4.4.1. Bank Address Assignments ........................................... 4–13
4.4.2. Initially Based Banks ...................................................... 4–14
4.4.3. The Control Bank ........................................................... 4–14
4.4.4. Element Inclusion .......................................................... 4–15
4.4.4.1. Global Elements .................................................... 4–16
4.4.4.2. Local Elements ...................................................... 4–16
4.4.4.3. Local-Global Conflicts ............................................ 4–18
4.4.5. Element Placement ........................................................ 4–18
4.5. Bank Switching for Basic Mode ............................................. 4–20
4.5.1. IBJ$/DBJ$ ...................................................................... 4–20
4.5.2. BBJ$ ............................................................................... 4–21
4.5.3. Use of MAPBDR$ .......................................................... 4–21
4.5.4. Use of the BDI with IBJ$/DBJ$/BBJ$ ........................... 4–22
4.5.5. TYPE IBJLNK and BDICALL$/IBJ$ ................................ 4–23
4.5.5.1. Using BDICALL$ and IBJ$ .................................... 4–23
4.5.5.2. System-Provided Procedures ................................ 4–23
4.5.5.3. Using TYPE IBJLNK............................................... 4–24
4.5.5.4. Resolution of BDICALL$, IBJ$, and TYPE
IBJLNK .............................................................. 4–24
4.5.6. BDICALL$/IBJ$ Return .................................................. 4–25
4.6. Bank Switching for Extended Mode ....................................... 4–26
4.6.1. Use of the BDI ............................................................... 4–26
4.6.2. Example Using LOCL and CALL .................................... 4–27
4.7. BDI and Entry-Point Definitions .............................................. 4–28
4.8. Use of BANKINFO AFCB ........................................................ 4–30
4.9. MAPCALL$, MAPGOTO$, and the VECTOR Attribute .......... 4–35
4.9.1. MAPCALL$ .................................................................... 4–35
4.9.2. MAPGOTO$ ................................................................... 4–36
4.9.3. MAP$CALLGOTO .......................................................... 4–36
4.10. Link Vector Processing ........................................................... 4–38
Section 5. Program Parameter Specification
5.1. TYPE Directive .......................................................................... 5–1
5.2. Absolute Element Arithmetic Fault Mode
Determination ....................................................................... 5–5
5.3. Exec Action Produced by Absolute Element ............................ 5–6
5.4. Third- and Quarter-Word Sensitivity ......................................... 5–6
Section 6. Other Directives
6.1. COR — Corrections .................................................................. 6–1
6.2. DEF — External Definition Retention ....................................... 6–3
6.3. END — End of Input ................................................................. 6–4
6.4. ENT — Starting Address Redefinition ...................................... 6–4
6.5. EQU — External Reference Definition ..................................... 6–5
6.6. LEVEL — Specifying the Bank Descriptor Table (BDT)
Level ..................................................................................... 6–5
6.7. MINGAP, MINSIZ — Absolute Element Optimization.............. 6–7
iv 7830 9887–001

Contents
6.8. REF — External Reference Retention ................................... 6–10
6.9. SNAP — Snapshot Dumps .................................................... 6–11
6.10. WINDOW — Creation of 4K Windows .................................. 6–14
Section 7. Collector-Defined Symbols
Section 8. Efficient Use of the Collector
8.1. Introduction .............................................................................. 8–1
8.2. Use of the IN Directive ............................................................ 8–1
8.3. @PREP of TPF$ ........................................................................ 8–1
8.4. Relocatable Element Structure ................................................ 8–1
8.5. Use of the Location Counter .................................................... 8–5
8.6. Use of the C Option ................................................................. 8–5
Appendix A. TYPE EXEC Collections
A.1. TYPE EXEC .............................................................................. A–1
A.2. XSEG — Executive Function Arrangement .............................. A–1
A.3. FIRSTBDI.................................................................................. A–3
A.4. BDICALL$, BDIREF$, LBDI$, LBDICALL$, and
LBDIREF$ ............................................................................ A–4
Appendix B. Collection Examples
B.1. Bank-Implied and Bank-Named Collections ............................. B–1
B.1.1. Bank-Implied Collection ................................................... B–1
B.1.2. Bank-Named Collection ................................................... B–2
B.2. Bank-Implied Segmentation ..................................................... B–3
B.3. Bank-Named Segmentation ..................................................... B–7
Appendix C. Processing Element Preambles
Appendix D. Restrictions
C.1. Introduction .............................................................................. C–1
C.2. INFO Groups ............................................................................ C–1
D.1. 262K Banks .............................................................................. D–1
D.2. 65K Location Counters ............................................................. D–1
D.3. Relocation Order ...................................................................... D–1
D.4. Relocatable Element Format Errors ......................................... D–1
D.5. EQU .......................................................................................... D–2
D.6. Implicit Call for Non-TPF$ File .................................................. D–2
D.7. Truncation of Negative Fields .................................................. D–2
D.8. LIB/NOT of Same File .............................................................. D–2
D.9. Static Diagnostic Text .............................................................. D–3
D.10. Location Counters Restricted to 2047 ..................................... D–3
7830 9887–001 v

Contents
Appendix E. Collector Diagnostic Messages
E.1. Introduction .............................................................................. E–1
E.2. FATAL ERROR Messages ....................................................... E–1
E.3. ERROR Messages ................................................................... E–8
E.4. WARNING Messages ............................................................ E–30
E.5. Information Messages ........................................................... E–35
Appendix F. Program Segmentation
F.1. Introduction ............................................................................... F–1
F.2. Segmentation Directives .......................................................... F–1
F.2.1. SEG — Program Segmentation ....................................... F–2
F.2.2. DSEG — Dynamic Segments .......................................... F–6
F.2.3. RSEG — Relocatable Segments ...................................... F–6
F.3. Loading Program Segments ..................................................... F–7
F.3.1. L$OAD,LOAD$ — Direct Method ................................... F–8
F.3.2. Reloading the Main Segment ........................................ F–10
F.3.3. D$LOAD,DLOAD$ — Loading Dynamic
Segments .................................................................. F–10
F.3.4. Indirect Loading ............................................................. F–11
F.3.5. D$REL,DREL$ — Releasing a Segment’s
Program Area ............................................................. F–12
F.3.6. Segment Load Table ...................................................... F–13
F.4. Segmentation within Bank-Named Collections ...................... F–13
F.5. Common Blocks ..................................................................... F–14
Appendix G. ROR$E-Relocatable Output Routine
G.1. Introduction .............................................................................. G–1
G.2. SROR$EB—Start Relocatable Output Routine with
External Buffer .................................................................... G–1
G.3. ROR$EB—Generation of Relocatable Output with
External Buffer .................................................................... G–2
G.3.1. ROR$EB Item Format ..................................................... G–2
G.3.2. Special Relocation Items ................................................. G–3
G.4. EROR$EB—End Relocatable Output Routinewith
External Buffer .................................................................... G–5
G.5. TBLWR$EB—Table Write Subroutine with External
Buffer .................................................................................. G–6
G.6. Optimization Information ......................................................... G–7
Index ............................................................................................. 1
vi 7830 9887–001

Figures
1–1. Creating an Absolute Element ........................................................................... 1–1
2–1. Collector Input and Output ................................................................................. 2–2
4–1. Bank of Global References .............................................................................. 4–17
B–1. I Bank Main Storage Map for the Segmented MAPABS ................................... B–5
B–2. D Bank Main Storage Map for the Segmented MAPABS ................................. B–6
B–3. Bank Structure of the Program ABS ................................................................ B–10
B–4. Segment Structure of Bank1 in Program ABS ................................................. B–11
B–5. Segment Structure of Bank2 in Program ABS’ ................................................ B–11
B–6. Segment Structure of Bank3 and Bank4 in Program ABS ............................... B–12
B–7. Segment Structure of Bank5 and Bank6 in Program ABS ............................... B–13
7830 9887–001 vii

Figures
viii 7830 9887–001

Tables
2–1. @MAP Statement Options ................................................................................. 2–8
2–2. SIR$: Symbolic Input/Output Routine Options .................................................. 2–9
4–1. IBANK and DBANK Directive Attributes ............................................................ 4–4
4–2. BANKINFO Directive Attributes ......................................................................... 4–6
4–3. BDICALL$ and IBJ$ (DBJ$) Resolution ........................................................... 4–25
4–4. MAPCALL$ and MAPGOTO$ Resolutions ...................................................... 4–38
5–1. Parameters Specified with the TYPE Directive .................................................. 5–1
B–1. Elements in FILEA.............................................................................................. B–1
F–1. Placement of Common Blocks Defined in One Element................................. F–15
F–2. Placement of Common Blocks Defined in More Than One Element .............. F–15
7830 9887–001 ix

Tables
x 7830 9887–001

Section 1
Introduction
The OS 1100 Collector combines or collects relocatable elements generated by language
processors with relocatable library elements to form an executable (absolute) element.
Figure 1–1. Creating an Absolute Element
The Collector produces an absolute element structured so that the Exec program loader
can place it in execution. Once the Collector creates the absolute program (that is,
collects it), it can be saved and re-executed many times. You re-collect the program only
if the program changes.
A program execution control statement (@XQT) or processor call within the runstream
places an absolute element (program) in execution. When the Exec encounters an @XQT
or processor call statement, it retrieves the program from its mass storage file, loads it
into main storage, and executes it. If you use a processor call (@processor), the Exec
presents (in table form) the parameter fields from the call when the processor performs
its first symbiont input (READ$ or SYMB$) request. If you use @XQT, the first symbiont
input obtains the first data image following the @XQT.
During execution, an absolute element can control which of its parts are in main storage
by requesting that the Exec load previously defined program overlay segments or by
accessing program banks. In addition, the executing program can attach to other
previously defined banks provided by other absolutes. This program structure supports
the dynamic sharing of both code (usually reentrant) banks and data banks between
multiple users. Such shared banks are called common banks.
7830 9887–001 1–1

Introduction
1–2 7830 9887–001

Section 2
Using the Collector
2.1. Collector Input
The @MAP statement calls the Collector. It provides a direct means of collecting or
combining relocatable elements to produce an executable program called an absolute
element. Optionally, you can use the Collector to create a single relocatable element
from a collection of several relocatable elements.
Input to the Collector (see Figure 2-1) comes from these three sources:
• Parameters supplied on the @MAP statement
• Information supplied by the Collector directives
• Relocatable elements taken from various program files:
− Temporary program file (TPF$)
− User-created program files
− Implied library file (MAP$PF)
− System library files (SYS$*DATA$.LIB$NAMES)
− System relocatable library (SYS$*RLIB$)
The Collector produces the following output:
• An absolute or relocatable element
• A symbolic element (optional)
• A program listing (optional)
7830 9887–001 2–1

Using the Collector
Figure 2–1. Collector Input and Output
The primary output of the Collector is the absolute or relocatable element that results
from collecting the various relocatable elements. This element is given a name and
placed within a program file for subsequent use. You can specify both the element name
and the file in which the element is placed.
Usually, the Collector includes a set of tables within an absolute element for diagnostic
systems to use. You can suppress this output by specifying the Z option (see Table 2-2)
on the @MAP statement. You can produce extended diagnostic tables for the absolute
element by specifying the TYPE directive with the EXTDIAG parameter. See Table 5-1.
A program is partitioned into logical entities called banks. This is done by explicitly
naming the bank, using the Collector IBANK or DBANK directive, and then by directing
the Collector as to what partitions of the program to put into the separate banks. This is
called a bank-named collection. If no IBANK or DBANK directives are specified, the
Collector creates an absolute element with two banks. This is called a bank-implied
collection. When more than two banks are created, the program is commonly called a
multibanked program.
By convention, but not necessity, the instructions of a program are placed under odd
location counters, while the data is placed under even location counters. This separates
instructions and data, with instructions allocated to I banks and data to D banks.
2.1.1. Collector Language Conventions
The Collector directives enable the programmer to control the collection of the program.
These directives have the following characteristics:
2–2 7830 9887–001

2.1.2. Files
• Free-form and can begin in any column of the source language image.
• Limited in length to 80 characters.
• Can contain comments preceded by the blank-period-blank construction.
Using the Collector
• Can be continued by using the continuation character, the semicolon ( ; ), anywhere
a space is allowed. A comment can contain any character except the semicolon ( ; ).
Using the continuation character within a comment causes the Collector to treat the
line following the current line as a comment.
• Follow the standard dropout rules pertaining to file names and element names. See
the Executive Control Language (ECL) and FURPUR Reference Manual for standard
file name and element name notation.
• Can have leading blanks following a parameter field separator ( , ).
Collector directives can follow the @MAP statement or can be contained in a symbolic
element in a program file that is specified as input on the @MAP statement. You have
the same access and updating facilities for this symbolic element as for any other type of
symbolic element.
Certain Collector directives can be used only in bank-named collections. These directives
are IBANK, DBANK, BANKINFO, FORM, WINDOW, $lcs (location counter set), and
certain formats of the IN and LIB directives.
On all Collector directives, in all fields and subfields, a parameter consisting of a set of
characters contained within apostrophes (for example, ’XYZ-ABC’) is treated as an
alphanumeric name. Any normal termination characters are considered to be characters
within the name. This method can also be used to process ASCII characters such as the
underscore. Though the underscore (Fieldata 077) is not printed by Fieldata processors
because it is the timesharing ER TREAD$ stop code, the Collector processes it normally
if the name containing the underscore is included in apostrophes.
Numbers on Collector directives are assumed to be decimal numbers; a leading zero can
be used to specify an octal number. A unary minus ( - ) can be used to indicate a
negative number.
In Collector directive formats, parameters in italic type indicate information that is
supplied by the programmer; parameters in regular type must be coded as shown.
The Collector dynamically assigns all files that are necessary for the collection if they are
not already assigned to the run. If the file is accessed with a write function, the file must
be assigned exclusively to the run; if necessary, the Collector dynamically assigns the file
exclusively. If a file referenced in the collection needs a unique internal name, the
Collector attaches an internal name to the file. For the default installation mode of the
Collector, the Collector restores all files referenced in the collection to their original
assign state at the end of the collection. The Collector frees the files it assigned and
removes all internal names attached by the Collector. The Collector provides an alternate
installation mode that leaves the files assigned if so desired for performance reasons.
7830 9887–001 2–3

Using the Collector
2.2. Collector Output
The Collector produces relocatable and absolute elements.
2.2.1. Collector-Produced Relocatable Elements
Although the Collector is generally used to produce an absolute element, a relocatable
element can be produced by specifying the R option on the @MAP statement. All
indicated relocatable elements are merged into a single relocatable element. The
external definitions specified with the DEF directive and the external references
specified with the REF directive are retained. All other external definitions are
submerged in the new relocatable element.
Relocatable elements in SYS$*RLIB$, files specified in SYS$*DATA$.LIB$NAMES, and
files specified by INFO group 12, are not implicitly included in an R option collection. For
more information about INFO groups, see the Meta-Assembler (MASM) Programming
Reference Manual. Location counter specification is preserved; that is, information
contained in location counter n for all input relocatable elements is placed under location
counter n of the output relocatable element with the exception of common blocks that
are combined according to common block name and reassigned a location counter
number.
Only the following directives can be specified with an R option collection. All others
produce a diagnostic message and the collection continues:
CLASS EQU NOT
DEF FRSTIN REF
END IN TYPE
ENT LIB
You can use the R option to include two relocatable elements with duplicate entry points
in the same collection. To accomplish this, perform an R option collection, using the EQU
directive to redefine the entry point. Do not specify the duplicated entry point on a DEF
directive, but do specify the redefined entry point. This causes the duplicated entry point
to be submerged in the newly created relocatable element. The resulting element can
then be collected with the other element that contains the duplicate entry point to form a
single absolute element.
You can also use the R option to combine a group of library routines into a single
relocatable element to reduce the number of IN directives needed to include them in the
collection. Similarly, you can use an R option collection to create an element to be used
with the FRSTIN directive. This element can include a group of elements to be placed at
the beginning of a bank or segment. The R option collection is necessary in this case
since the FRSTIN directive can be used only to specify placement of a single element
within a bank or segment.
2–4 7830 9887–001

2.2.2. Collector-Produced Absolute Output
Using the Collector
The primary output of the Collector is the absolute element. The absolute element
contains four basic parts:
• The header table
• Tables used by the Exec
• Absolute text (and access control words (ACW))
• Tables accessible to the user
The absolute element produced by the Collector is structured so that the Exec program
loader can place it in execution. Once the absolute program has been created (collected),
it can be saved and re-executed many times. If changes are made to the program, recollect
it to create a new absolute.
The absolute element format is documented in the Data Structures Programming
Reference Manual.
2.2.3. Listing
The Collector produces four different listings depending on the options specified on the
@MAP statement:
• N option listing
The N option listing lists all fatal error messages.
• No option listing
The no option listing contains all information produced by the N option listing plus
the following items:
− Starting address
− Program size
− Nonfatal error messages, warnings
In batch mode, the listing also includes the bank, segment, and element address
assignments
• S option listing
The S option listing includes all information produced when no option is specified
plus the following items:
− The source input with CTS line numbers, if present
− The main storage allocated to each element and segment
− The common bank table containing the bank descriptor index (BDI) and name for
all common banks referenced in the collection
− The bank and segment index values
− A scale drawing of program segmentation and bank structure
7830 9887–001 2–5

Using the Collector
• L option listing
The L option listing contains all information produced by the S option listing plus the
following items:
− The external references of each element.
− The program address of all external definitions.
− A list of the files available for element inclusion; the list contains the internal file
name specified and the full external file name. This list also indicates if the file
was available for library searching, if it was searched for elements appearing on
IN directives with no file name attached, if it was searched to resolve external
references, if it is an RLIB type file, and if the keyword for the file was specified
in an INFO group 12 item. The files marked for searching in the table are listed in
the order in which they were searched to satisfy external references. (See 3.2.3
for additional information.)
The Collector sign-on and sign-off lines are always produced. The sign-on line format for
Collector is as follows:
Collector level (yymmdd hhmm:ss) yyyy Mmm dd Ddd hhmm:ss
where:
level
is the level of the Collector.
yymmdd hhmm:ss
is the date and time that the Collector was created. For example, 901124 0923:47.
yyyy Mmm dd Ddd hhmm:ss
is the current date and time. For example, 1990 Nov 24 Sat 2143:51.
The sign-off line format is
where:
END MAP. ERRORS: n TIME: s.mmm STORAGE: a/b/c/d/e
n is the number of errors detected by the Collector.
s.mmm are the number of seconds and milliseconds of SUPS for the collection.
a is the amount of temporary memory space used.
b is the amount of temporary memory space freed.
c is the amount of permanent memory space used.
d is the number of MCORE$ requests.
2–6 7830 9887–001

e is the highest address allocated by Collector for its own use.
Using the Collector
2.3. @MAP-Collector Initiation and Termination
Purpose
The @MAP statement specifies that the Collector is to combine a set of relocatable
elements into one absolute or relocatable element. All @MAP statement parameters are
optional. The Collector can also be called implicitly by the @XQT control statement.
Format
@label:MAP,options si,ro,so
where:
options
si
ro
so
(See Table 2-1.)
specifies the input symbolic element that contains the Collector source language.
specifies the absolute output element. When the R option is specified, ro names the
relocatable output element.
specifies the output Collector source language element.
See the Executive Control Language (ECL) and FURPUR Reference Manual for processor
call statement conventions. See Table 2-2 for a description of the symbolic input/output
routine (SIR$) options.
At the end of the collection, a termination line is printed. This line includes the number of
errors encountered, the standard unit of processing (SUP) time used by the collection,
and Collector internal storage information. See 2.2.3 for more information
Table 2–1. @MAP Statement Options
Option Description
A Under no circumstances is the error exit (ER
ERR$) to be taken during the collection. The
absolute is not marked in error.
7830 9887–001 2–7

Using the Collector
Table 2–1. @MAP Statement Options
Option Description
B Mark the absolute element so that the
program area is not cleared to zero before
loading the program and any indirectly loaded
segments (see F.3.4).
C Expand the storage area of the Collector using
larger allocation amounts. This can reduce the
number of times the Collector references
MCORE$. Use larger buffers to reduce I/O
requests. Attempt to retain information in
memory instead of writing to scratch files.
D Print a diagnostic message for all possible
addresses over 65K (0177777). Check for
possible instruction format violations of text
words that are relocated.
E Allow program addresses to exceed 65K. If
this option is omitted and the program’s D
bank exceeds 65K, the D bank starting
address is moved downward so that all (or as
many as possible) of the addresses over 65K
are forced below 65K. In bank-named
collections, all possible D bank starting
addresses are moved downward.
F Mark the output absolute or relocatable
element as quarter-word sensitive. This is
equivalent to the TYPE QUARTER directive.
(See T option.)
L Produce the most comprehensive listing (see
2.2.3).
N Produce the most abbreviated print listing
available, consisting of the sign-on and
termination lines and any fatal errors (see
2.2.3).
R Generate a relocatable element instead of an
absolute element (see 2.2.1).
S Produce a summary listing (see 2.2.3).
T Do not mark the output element as quarterword
sensitive. This is equivalent to the TYPE
THIRD directive. See 5.4.
2–8 7830 9887–001

Table 2–1. @MAP Statement Options
Option Description
Using the Collector
X If an error is detected, terminate the collection
without producing an output element and exit
using ER ERR$. When the X option is omitted,
the results of the collection are accepted, even
though there can be minor errors, as long as
an absolute element can be produced. The X
option is assumed when the Collector is
automatically called by @XQT.
Z Suppress generation of diagnostic tables in the
absolute element that are used by diagnostic
systems. This does not suppress INFO 8
(static diagnostic) text.
Table 2–2. SIR$: Symbolic Input/Output Routine Options
Option Description
G Input is compressed symbolic in columns 1-80 of the symbolic images. Applies only
with the I option.
H Input contains sequence numbers in columns 73-80 of the symbolic images. Applies
only with the I option.
I Read images from the runstream and insert them into a new symbolic. If the I option
is present without any si specification, SIR$ reads images from the runstream and
passes them to the caller.
J Input contains compressed symbolic images in columns 1-72 of the images and
sequence numbers in columns3-8 70. These sequence numbers are not checked by
the K option. Applies only with the I option.
K Check sequence numbers in columns 73-80 of the symbolic images (valid only with
H and I options).
P Indicates that the symbolic element produced by the Collector should be in Fieldata
format.
Q Indicates that the symbolic element produced by the Collector should be in ASCII
format.
P and Q Indicates that the symbolic element produced by the Collector can be a combination
of Fieldata format and ASCII format.
Neither
P nor Q
Indicates that the symbolic element produced by the Collector can be a combination
of Fieldata format and ASCII format When the I option is included the format is
determined by the format of the runstream images. When the I option is not
included the format is determined by the format of the symbolic input element
images.
U Read change images from the runstream, apply them to the symbolic input element,
and produce a new cycle of the symbolic element.
7830 9887–001 2–9

Using the Collector
Table 2–2. SIR$: Symbolic Input/Output Routine Options
Option Description
W List change images.
Examples:
@MAP
The name for the absolute element is automatically assigned by the Collector. The
printed output and internal table entries would appear as if the @MAP statement had
been
@MAP,I ,TPF$.NAME$
If no directives follow, the directive IN TPF$. is assumed.
@MAP OLDFILE.OLDELEMENT,A,NEWFILE.NEW/ELEMENT
Element OLDELEMENT from file OLDFILE is updated by any source language
statements following the @MAP statement. The output source language goes into file
NEWFILE, element NEW/ELEMENT. The absolute element A goes into TPF$.
@MAP SYMIN/C,BACKUP.ABSOUT
Version C of element SYMIN from TPF$ is the input symbolic element. The absolute
output element ABSOUT is written in file BACKUP. No source language output is
produced; any successive change lines are applied but not saved.
@MAP,I BACKUP.SYMOUT, .ABSOUT
The source language statements (Collector directives) following the @MAP statement
are inserted as the symbolic output element SYMOUT in file BACKUP. The absolute
element ABSOUT is also put into file BACKUP.
@MAP,U SYMIN(3),ABSOUT/REVISED
Cycle 3 of element SYMIN located in TPF$ is updated to produce cycle 4 of element
SYMIN. Any change lines are saved. Version REVISED of absolute output element
ABSOUT is also put in TPF$.
@MAP,IRXLD ARB,ARB
The source language statements following the @MAP statement become the symbolic
element ARB in the file TPF$. The output element goes into TPF$ as relocatable element
ARB. If errors are encountered during the collection, the run is terminated. A full listing is
produced. Diagnostics are printed for addresses over 65K.
2–10 7830 9887–001

Using the Collector
7830 9887–001 2–11

Using the Collector
2–12 7830 9887–001

Section 3
Inclusion and Exclusion of Elements
3.1. Explicit Inclusion and Exclusion
The following directives enable you to explicitly include or exclude elements in the
collection process.
3.1.1. IN - Element Inclusion
Purpose
The IN directive allows you to specifically include an element or all relocatable elements
of a file in the collection of a program. An element can be preceded by a file name. The
elements indicated on an IN directive are placed in the segment named by the preceding
SEG directive (see F.2.1) and in the bank named by the preceding IBANK or DBANK
directive (see 4.2.1).
SYS$RLIB$ID is considered a non-supported SYSLIB routine. See the System Service
Routines Library (SYSLIB) Programming Reference Manual for more information about
SYS$RLIB$ID.
All IN directive parameters are optional. If all parameters are omitted, the following is
assumed:
IN TPF$.
Formats
IN name-1,name-2,name-3,...,name-n
IN(bank-list) name-1($lcs),name-2($lcs),...,name-n($lcs)
where:
name
specifies the element or entire file to be included in the collection.
bank-list
$lcs
is a list of bank-names to be used with local element inclusion.
7830 9887–001 3–1

Inclusion and Exclusion of Elements
specifies which location counters of name-i are to be included in this part of the
program
Description
The bank-list and $lcs parameters are used only with bank-named collections (see
4.4.4.2).
By stating a file name without a following element name, you can specify the inclusion
of all relocatable elements in a program file. In bank-implied collections, if some
elements of a file have been explicitly named, these are included as specified and the IN
file name serves to bring in only the remaining elements in the file. When specifying an
entire file for inclusion, a period must follow the file name.
When name consists of an element name only, with no version specified, any
relocatable element with that name, irrespective of version, is eligible for inclusion. If
relocatable elements with the same element name but different version names exist in
the same file, ambiguities arise. The CLASS directive (see 3.1.5) can be used to
overcome the ambiguity. Alternatively, the ambiguity is not present if the version name
is explicitly stated as part of name on the IN directive:
IN name /^^^^^^^^^^^^
This format of the name parameter must be used to specifically select a relocatable
element with a version name consisting of 12 space characters, (denoted by ^) when
other relocatable elements with version names exist in the file. Each relocatable element
included in the collection must have a unique element name. It is not possible to include
two relocatable elements with the same element name having different version names
or file names in the same collection.
Common blocks can be named on IN directives, but must not have an associated implicit
or explicit file name because they are embedded within other elements. For inclusion of
a common block in the collection, see F.5.
For the order of elements explicitly and implicitly included in the collection, see 4.4.1 and
4.4.5.
For efficiency considerations, see 8.2.
Examples
IN FILEA.,FILEB.
All relocatable elements in FILEA and FILEB are included in the collection.
IBANK BDAY2 .
IN COLLECTOR*F8(1).INIT/REV
The relocatable element INIT version REV in file COLLECTOR*F8 (1) is included in the
collection of the IBANK BDAY2. (See 4.2 for the use of the banking directives.)
DBANK ADAY1 .
3–2 7830 9887–001

IN FILEB.BB, .CC,DD
Inclusion and Exclusion of Elements
Elements BB and CC from file FILEB and element DD (whose file name is not indicated)
are included in the collection of the DBANK ADAY1. TPF$, all specified library (LIB) files,
MAP$PF, files specified by INFO group 12 keywords, files specified in
SYS$*DATA$.LIB$NAMES and SYS$*RLIB$ are searched in that order for element DD
until it is found in one of them. If element DD is not found, a diagnostic is printed.
3.1.2. FRSTIN - First Element Included
For either format of the IN directive, you can use FRSTIN instead of IN. If FRSTIN is
used, it must be the first element inclusion statement in a bank-implied collection or
must immediately follow an IBANK, DBANK, or SEG directive. FRSTIN specifies that the
first named element is to be positioned at the beginning of the bank or segment in which
it is collected. Only one FRSTIN directive can be specified for each IBANK, DBANK, or
SEG directive. Only the first element name is used on the FRSTIN directive. Other
elements named will be positioned as if they were named on an IN directive.
3.1.3. FORM - Source Language Structure Duplication
Purpose
Allows the duplication of a portion of a program structure previously defined within a
collection without requiring repetition of the source language used to define that
structure.
Formats
FORM bank-name
FORM bank-name*segment-name
where:
bank-name
specifies the bank whose structure is to be duplicated
segment-name
specifies the segment within the bank whose element inclusion structure is to be
duplicated.
Description
When placed following an IBANK or DBANK directive, a “FORM bank-name” directive
causes the full segment tree of the named bank to be regenerated for the bank being
defined, except that the location counter set presently in control must differ from the
one that was in control for the bank named on the FORM directive. If an explicit location
counter set is specified, it must precede the FORM directive. Since FORM bank-name
creates an exact duplication of a previous bank structure, no additional SEG, DSEG,
RSEG, or IN directives can be specified for the bank being generated.
7830 9887–001 3–3

Inclusion and Exclusion of Elements
A “FORM bank-name*segment-name” directive causes the IN directives within the
specified segment to be regenerated.
Only SEG, DSEG, and IN directives within a structure are duplicated when a FORM on
that structure is specified.
Examples
1a. IBANK I1 1b. IBANK I1
SEG MAIN SEG MAIN
IN A,B IN A,B
SEG SG SEG SG
IN FILE.ELT,.ELT1 IN FILE.ELT,.ELT1
DBANK D1 DBANK D1
SEG MAIN FORM I1
IN A,B
SEG SG
IN FILE.ELT,.ELT1
The “FORM bank-name” directive is used in example 1b to produce the same results as
in example 1a.
2. IBANK I1
SEG MAIN
IN A,B
SEG SG
IN FILE.ELT,.ELT1
DBANK D1
SEG MAIN
FORM I1*MAIN
SEG SG
FORM I1*SG
The “FORM bank-name*segment-name” directive is used in example 2 to produce the
same results as in example 1.
3.1.4. NOT - Element Exclusion
Purpose
The NOT directive names the elements or files that are to be excluded from the entire
collection.
All NOT directive parameters are optional. If all parameters are omitted, the following is
assumed:
NOT TPF$.
Formats
NOT name-1,name-2,...,name-n
3–4 7830 9887–001

NOT DEFAULT$LIBS.
name-n
Inclusion and Exclusion of Elements
specifies the element, with or without a file name, or the file to be excluded from
the collection. If the version name or file name is omitted, all elements of the
specified name are excluded.
DEFAULT$LIBS.
refers to all the default system files specified in SYS$*DATA$.LIB$NAMES.
Note: The period is required for NOT DEFAULT$LIBS. If the period is omitted, the
Collector treats DEFAULT$LIBS as an element rather than as the default system
files.
Description
When all elements of a file are to be excluded, the entire file can be designated for
exclusion with a NOT directive. The effect of excluding a whole file is to make the file
inaccessible for searching as a library file. A period must follow the file name to ensure
that it is not interpreted as an element name. The file name specified on the NOT
directive should be the same as it appears elsewhere in the collection on IN or LIB
directives. The NOT directive affects the entire collection.
If a file name with no following element names appears on a NOT directive, elements
within the named file can still be explicitly included during the collection. This is useful
only with TPF$, MAP$PF, files specified in SYS$*DATA$.LIB$NAMES, and SYS$*RLIB$,
since these are the only files that are normally searched automatically. They must be
specified as TPF$, MAP$PF, DEFAULT$LIBS, and SYS$*RLIB$ on the NOT directive to
override the automatic search. If you do not include elements from TPF$, specify the
NOT TPF$ directive. See 8.3 for more information about efficient use of Collector.
Examples
NOT CWW,LRR
All elements named CWW and LRR in any file are excluded from the collection; if no IN
directives are present, all other relocatable elements in TPF$ are included.
IN FILEA.
NOT FILEA.CL,.AB
All elements named CL and AB from FILEA are excluded from the collection; all other
relocatable elements in FILEA are included.
IN FIL1.
NOT SYS$*RLIB$.
NOT TPF$.
Relocatable elements from SYS$*RLIB$ and TPF$ are excluded from the collection. All
elements from FIL1 are included.
7830 9887–001 3–5

Inclusion and Exclusion of Elements
NOT DEFAULT$LIBS.
Relocatable elements for all of the files specified in SYS$*DATA$.LIB$NAMES are
excluded from the collection. These files will not be searched for elements without file
names or for unresolved references. All relocatable elements in TPF$ are included.
3.1.5. CLASS - Element Selection Determination through
Version Names
Purpose
The CLASS directive uniquely specifies one element version in a program file when more
than one element has the same element name but different version names. In the
collection this occurs when
• The version of the element was not specified on an IN directive and more than one
relocatable element has that name.
• More than one relocatable element with the same name contains an entry point that
defines an external reference.
• A file name was not specified with the element on an IN directive and the element
with different version names is present in more than one file.
Format
CLASS string
where string consists of 12 alphanumeric characters, asterisks, a dollar sign ( $ ), a minus
sign ( - ), and blanks representing the versions of the elements. The string begins with
the first nonblank character following CLASS, and is terminated after 12 characters, or by
the blank-period-blank comment delimiter. If fewer than 12 characters have been
processed upon termination of the string, significant blanks are filled in on the right to
make a 12-character string.
Description
The CLASS directives in a collection have a cumulative effect; therefore, different
orderings of CLASS directives can give different results.
Asterisks in a string (wild card characters) represent character positions to be ignored in
the version name. Blanks in a string are valid to Collector.
When several elements qualify to be included in the collection, the Collector compares
the value of the string parameter on the CLASS directive with the version names of the
available elements. If the element version name is not identical to the string parameter,
it is not included in the collection.
If, after the first comparison, more than one element qualifies, the string on the next
CLASS directive is used in eliminating the remaining versions.
3–6 7830 9887–001

7830 9887–001
If all the CLASS directives have been used and more than one element qualifying
element still remains none of the remaining elements is used in the collection and the
Collector prints a diagnostic message.
Examples:
@MAP,I SAMP,ALPHA
IN SIZE
CLASS D***********
CLASS ***B********
CLASS *****4******.
The IN directive does not specify which version of the SIZE element is to be used in the
collection. The three CLASS directi directives ves specify that the DCOB14 version be used in the
collection. Graphically, this can be shown as follows:
@MAP,I SA
IN ELT1
CLASS D*LA********
Inclusion and Exclusion of Elements
The CLASS D*LA******** directive specifies that the D2LARGE version of the ELT1
element be used in the collection. Graphically, this can be shown as follows:
3–7

Inclusion and Exclusion of Elements
3.2. Implicit Inclusion-File Searching
The following directives enable you to implicitly include files in the library search.
3.2.1. LIB-File Searching
Purpose
The LIB directive specifies which files (libraries) are to be searched to include the
following:
• An element named on an IN directive for which no file specification was made; for
example, IN ELT
• An element that satisfies external references that are not defined by elements
already included in the collection
If, after searching all of the library files, an element is not found that fulfills either of the
above purposes, the Collector prints a diagnostic message.
All LIB directive parameters are optional, except file-name-1.
Format
LIB file-name-1,file-name-2,...file-name-n
LIB file-name-1(bank-name/$lcs,bank-name/$lcs,...),file-name-2...
LIB (bank-name/$lcs,bank-name/$lcs...)
LIB file-name-1( ),file-name-2( ),...file-name-n( )
where:
file-name-n
specifies a file to be searched.
bank-name
$lcs
( )
specifies a bank in which implicitly included elements are to be placed. An implicitly
included element is an element that has not been named on an IN directive but
which satisfies an external reference.
specifies which location counters of the implicit elements go to the corresponding
banks.
indicates that the parameters specified on the last preceding LIB (bank-name/$lcs,...)
directive are to be applied for the file name specified.
Description
3–8 7830 9887–001

Inclusion and Exclusion of Elements
You can use the second, third, and fourth formats only in bank-named collections (see
4.4.5).
The third format, which is called a “directed LIB” directive, is used to specify the
appropriate bank and location counter set for all elements included from files named in
format 4.
To use a directed LIB directive with TPF$, you must include a NOT TPF$ directive in the
MAP symbolic.
The Collector does not guarantee the order of implicitly included elements within a bank.
The LIB directive affects the entire collection.
Examples
LIB A
IN E1
.
.
.
LIB B
IN E2
LIB directives have a cumulative effect. Files A and B are used for the search sequences
for elements E1 and E2.
The following example has the same effect:
LIB A,B
IN E1
.
.
.
IN E2
LIB (IB1/$1,3,DB1/$2,4)
The directed LIB directive dictates that location counters 1 and 3 from implicitly included
elements go to the bank IB1. Similarly, location counters 2 and 4 from implicitly included
elements go to the bank DB1. This line is meaningless unless format 4 LIB directives are
also encountered.
LIB F1( ),F2( )
Implicit elements from files F1 and F2 are placed in banks IB1 and DB1 according to the
directed LIB directive, which also must be provided.
LIB F3(IB2/$1,3)
Location counters 1 and 3 from implicitly included elements in file F3 are placed in I-bank
IB2.
7830 9887–001 3–9

Inclusion and Exclusion of Elements
3.2.2. RLIB - File Searching
RLIB can be used instead of LIB in all formats. Any element from a file on such a
statement is treated as being from SYS$*RLIB$ or from the files specified in
SYS$*DATA$.LIB$NAMES. The result is that these elements are not dumped by @PMD
unless the L option is used with the PostMortem Dump processor (PMD) request, nor
will they be traced by the Program Trace Routine (SNOOPY).
3.2.3. DLIB - Directed LIB for the Default Libraries
Purpose
The DLIB directive is used to specify which location counters are to be placed in a
particular bank when implicitly included elements are brought in from the files specified
in SYS$*DATA$.LIB$NAMES. The DLIB directive is used as a directed LIB for the default
libraries (the files specified in SYS$*DATA$.LIB$NAMES). The DLIB directive will not
change the default library search order as the LIB directive does. The DLIB directive is
not allowed in an R option collection since the default libraries are not searched for an R
option collection.
Format
DLIB DEFAULT$LIBS.(bank-name/$lcs,...,bank-name/$lcs)
where:
bank-name
$lcs
specifies a bank in which implicitly included elements are to be placed.
specifies which location counters of the implicit elements go to the corresponding
banks.
Description
The DLIB directive is a “directed LIB” of all the files specified in
SYS$*DATA$.LIB$NAMES.
The collection must be a bank-named collection.
Note: The period after DEFAULT$LIBS is optional.
3.2.4. Sequence of File Searching
The library sequence for file searching is as follows:
1. TPF$
2. Files specified on LIB and RLIB directives-in the order in which they are specified
3. MAP$PF-the implied library file (if it exists)
3–10 7830 9887–001

Inclusion and Exclusion of Elements
4. Files specified by INFO group 12 keywords within the relocatables. These files are
searched in the order in which the elements containing the INFO group 12 keywords
are included in the collection
5. Files specified in SYS$*DATA$.LIB$NAMES
6. SYS$*RLIB$
Any of these implicit or explicit files can be excluded from the search using the NOT
directive.
NOT DEFAULT$LIBS. is used to exclude (NOT) all of the files specified in
SYS$*DATA$.LIB$NAMES. See 3.1.4 for an example.
SYS$*RLIB$, files specified in SYS$*DATA$.LIB$NAMES, and files specified by INFO
group 12 are not searched in an R option collection unless they are specified on a LIB
directive. The INFO group 12 information is carried forward to the R option output
element.
There are two types of library searching in a collection:
1. During the first search, all libraries are searched once in the previously described
search sequence for elements specified on IN directives. This is called an element
search.
Note: If you do not use @PREP with TPF$, elements in TPF$ are treated in a special
manner by the Collector (see 3.2.5).
2. During the second search, all libraries are searched once again in the predescribed
sequence for elements satisfying external references. This is called a reference
search.
The first element found in either of the two types of library searches is included in the
collection. If an element with the same name exists or if two different elements satisfy
the same external reference, the first element encountered is included in the collection.
If these situations occur with elements existing in the same file, a message concerning
element or entry-point ambiguity is also printed. If the elements are in different files, no
message is printed.
Note: The Collector terminates its library searching if all elements specified on IN
directives are found, or if all external references are satisfied before all the library
files have been searched.
3.2.4.1. System Library Searching
Searching of SYS$*DATA$.LIB$NAMES is as follows:
The Collector searches sequentially through LIB$NAMES. The library preference order
(also known as the file sequence number or the group-sequence) and the order of
installation are used to determine the order of the product installation files within
LIB$NAMES. There are 10 preference order specifications available. The lowernumbered
library preference order files are processed first. Within each library
preference level, the files appear in LIB$NAMES in the reverse order that they were
7830 9887–001 3–11

Inclusion and Exclusion of Elements
installed. For example, consider these files installed in the following order with the
preference level in parentheses:
SYS$LIB$*SORT (7)
SYS$LIB$*ACOB (4)
SYS$LIB$*FTN (4)
In LIB$NAMES, the files would appear and would be searched in the following order:
SYS$LIB$*FTN
Lowest preference order level and last file installed at that level.
SYS$LIB$*ACOB
Same lowest preference order but installed before FTN.
SYS$LIB$*SORT
Next preference order and last at that preference level. It occurs after the lower
preference level files even though SORT was installed first.
Each installation (INSTALL) can change the order of the files in LIB$NAMES. Continuing
from the preceding example, if SYS$LIB$*ACOB were installed again, the search order
would now be
SYS$LIB$*ACOB
SYS$LIB$*FTN
SYS$LIB$*SORT
Since FTN and ACOB had the same preference order specification, ACOB would now be
before FTN because it was installed after FTN. Within a preference level, no search order
can be assumed.
The Collector searches through the files in a forward manner. Once a library file has been
searched, it is not searched again, unless the file name appears on multiple LIB
directives, or unless the file falls in more than one of the library search sequence steps.
The Collector terminates the search order when all references are resolved.
3.2.4.2. Altering the Search Sequence - INFO Group 12 Keywords
INFO group 12 keywords are specified using the MASM $INFO group 12 directive.
These keywords alter the Collector search sequence. When an INFO group 12 keyword
is encountered in a relocatable element, the product installation file corresponding to the
INFO group 12 keyword is included in the INFO 12 search chain to satisfy any external
3–12 7830 9887–001

Inclusion and Exclusion of Elements
references. This is true unless LIB$NAMES is already being searched. If this is the case,
the system file corresponding to the INFO group 12 keyword is searched next.
The element SYS$*DATA$.LIB$NAMES contains the INFO group 12 keywords defined
on the system and their corresponding product installation files. The files are searched in
the order that the relocatable elements containing the keywords are included in the
collection. After all files named by keywords have been searched, and if any unsatisfied
references remain, all entries in the element SYS$*DATA$.LIB$NAMES are processed
sequentially until all files have been searched, or all external references have been
satisfied.
If no INFO group 12 keywords are specified in an element, the Collector searches the
library files in the order they appear in the element SYS$*DATA$.LIB$NAMES.
The Collector skips library search sequence steps 4 and 5 (see 3.2.4) in the library search
sequence if the element SYS$*DATA$.LIB$NAMES does not exist or is empty. This is
provided for upward compatibility.
The order in which the files appearing in the element SYS$*DATA$.LIB$NAMES are
searched can be altered at collection time. Files appearing in the element
SYS$*DATA$.LIB$NAMES that are specified by INFO group 12 keywords in the
relocatable elements included in the collection, either explicitly or implicitly, are searched
before going sequentially through all the files appearing in SYS$*DATA$.LIB$NAMES.
Files specified by INFO group 12 keywords are searched in the order that relocatable
elements containing the keywords are included in the collection. You can also supply LIB
directives for system library files to ensure that specific system library files are searched
before the INFO group 12 keyword and SYS$*DATA$.LIB$NAMES search chains. Files
specified on LIB directives are searched in the order they are specified.
This altered search order causes the files specified by the INFO group 12 keyword and
the LIB directive to be searched more than once during the same search pass, once in
each altered position, and once during the sequential search of all the files listed in the
element SYS$*DATA$.LIB$NAMES if all references have not been satisfied.
Here are considerations when using INFO group 12 keywords:
• If there is more than one INFO group 12 keyword in a relocatable element, the
corresponding files are searched in the order the keywords appear in the element.
• If the same INFO group 12 keyword is specified more than once in an element, the
corresponding file is searched again if necessary.
ELT1
$INFO 12 ’FORTRAN’ . FORTRAN searched
$INFO 12 ’SORT’ . SORT searched
$INFO 12 ’FORTRAN’ . FORTRAN searched
Note: The $INFO statements are taken from a MASM element.
• If the Collector is searching sequentially through SYS$*DATA$.LIB$NAMES and
includes an element that contains an INFO group 12 keyword, the corresponding
system file is searched next.
7830 9887–001 3–13

Inclusion and Exclusion of Elements
• An INFO group 12 keyword is ignored if it is the same as the last INFO group 12
keyword in the previous element.
ELT1
$INFO 12 ’FORTRAN’ . FORTRAN searched
$INFO 12 ’FORTRAN’ . FORTRAN ignored
$INFO 12 ’SORT’ . SORT searched
ELT2
$INFO 12 ’SORT’ . SORT ignored
$INFO 12 ’FORTRAN’ . FORTRAN searched
$INFO 12 ’SORT’ . SORT searched
Note: The $INFO statements are taken from a MASM element.
• If an element implicitly included contains an INFO group 12 keyword, the file
corresponding to that keyword is attached to the INFO group 12 search chain.
The search is terminated as soon as the external references are satisfied.
3.2.4.3. Determining the Search Sequence Used
The files searched are included in the long Collector output listing (@MAP,L). For
example, assume that the Collector directives are as follows:
LIB PLSLIB
IN REL$.PROG-MAIN
IN REL$.INFOR-SUB
Also assume that the element PROG-MAIN contains this directive:
$INFO 12 ’SYSLIB’
The resulting Collector output listing can appear as in the following example. The file
SYS$LIB$*SYSLIB appears twice in the output listing, with the occurrence caused by
the INFO 12 keyword noted by an asterisk under the INFO 12 column. The file
SYS$LIB$*SYSLIB is thus searched twice to satisfy external references.
Example
Files Available for Element Inclusion (in Search Order):
-------------------------------------------------------
Search Element Reference
Specified Name External Filename File Search Search RLIB INFO 12
------------------------------------------------------------------------------
TPF$ COS*TPF$(0) * * *
PLSLIB PLS*7R1(2) * * *
REL$ COMUS4R2*RO(77)
SYS$LIB$*SYSLIB(4) SYS$LIB$*SYSLIB(4) * * * *
SYS$LIB$*DPS(4) SYS$*LIB$*DPS(4) * * *
SYS$LIB$*ACOB(10) SYS$*LIB$*ACOB(10) * * *
SYS$LIB$*FTN(5) SYS$*LIB$*FTN(5) * * *
3–14 7830 9887–001

Inclusion and Exclusion of Elements
UDS$$SRC*D$MR(2) UDS$$SRC*D$MR(2) * * *
SYS$LIB$*PCIOS(3) SYS$LIB$*PCIOS(3) * * *
SYS$LIB$*UCSRTS(4) SYS$LIB$*UCSRTS(4) * * *
SYS$LIB$*SORT(4) SYS$LIB$*SORT(4) * * *
SYS$LIB$*CML(3) SYS$LIB$*CML(3) * * *
SYS$LIB$*SYSLIB(4) SYS$LIB$*SYSLIB(4) * * *
SYS$LIB$*RLIB SYS$LIB$*RLIB(1) * * *
where:
Specified Name
is the internal file name specified on a LIB directive, an IN directive, a NOT directive,
or included implicitly by the Collector.
Files are printed in the following order:
− TPF$, unless TPF$ appears on a directive
− Files specified on LIB, NOT, or IN directives, in the order specified in the map
symbolic. Each file will be printed once except
ο Files specified on more than one LIB directive
ο File or file.element specified on an IN directive and the same file specified
on any other directive
− MAP$PF, if it exists
− Files specified by INFO group 12 keywords-in the order in which the elements
containing the INFO 12 keywords are included in the collection
− Files used from the element SYS$*DATA$.LIB$NAMES
− SYS$*RLIB$
External Filename
corresponds to the external file name. The external file name is not printed for a NOT
directive of an entire file.
Search File
indicates the file was available for an element or reference search.
Element Search
indicates the files that were searched for elements, without file names, specified on
IN directives. The files were searched in the same order as they appear in the output
listing.
Reference Search
7830 9887–001 3–15

Inclusion and Exclusion of Elements
RLIB
indicates the files that were searched to satisfy external references in the elements
specified on IN directives or in elements implicitly included. The files were searched
in the same order as they appear in the output listing.
indicates that the file appeared on an RLIB directive or is treated as a system library
file (SYS$*RLIB$ and files in SYS$*DATA$.LIB$NAMES).
INFO 12
indicates that the file was referenced by an INFO group 12 keyword in an element.
3.2.4.4. Searching User-Specified Search Files
A user-specified file can be searched more than once if the file name appears more than
once on a LIB directive. Assume that the following appears in the Collector symbolic:
IN XXX.ELT
Also assume that XXX.ELT contains the external reference XREFA.
You also need the following:
LIB Y,Z,Y
This statement includes all elements to satisfy all external references if the following
situation occurred:
Notes:
1. To satisfy external reference XREFA from element XXX.ELT, element Y.A is included
in the collection. (SEARCH LIB FILE 1)
2. Element Y.A contains a reference to XREFB. The Collector will not find entry point
XREFB in the rest of the search of file Y, so it searches the next library in the library
search chain, file Z. (SEARCH LIB FILE 2)
3–16 7830 9887–001

Inclusion and Exclusion of Elements
3. To satisfy the reference to XREFB from element Y.A, element Z.B is included in the
collection.
4. Element Z.B contains a reference to XREFC. The Collector will not find entry point
XREFC in the rest of the search of file Z, so it searches the next library in the library
search chain, file Y. (SEARCH LIB FILE 3)
5. To satisfy the reference to XREFC from element Z.B, element Y.C is included in the
collection.
6. If only LIB Y,Z had been specified, file Y would have been searched only once and
element Y.C would not have been included in the collection and thus entry point
XREFC would have remained undefined
LIB directives such as the preceding are necessary because the Collector searches
through the libraries in a forward manner. Once a library file has been searched, it is not
searched again unless specified. However, it is redundant to specify the same file twice
consecutively (for example, LIB Y,Y) since a file is fully searched even if an element from
that file is added to the collection.
3.2.5. @PREP of Library Files
The @PREP function (see the Executive Control Language (ECL) and FURPUR Reference
Manual) creates an entry-point table for a file. The Collector accesses this entry-point
table to determine if any of the file’s entry points satisfy external references in the
collection.
You must prepare (@PREP) all library files specified on LIB or RLIB directives that are
used to satisfy external references. If a file has not been prepared, it is included in the
first search (for element inclusion) but not in the second search (for satisfying external
references). If a file has not been prepared, the Collector prints a diagnostic message.
If TPF$ is not prepared, it is treated in a special manner by the Collector. All of the
elements in TPF$ are tentatively included in the collection unless specifically excluded by
the NOT directive. If any of these elements are not necessary for satisfying external
references (or if they have not been named on an IN directive), they are discarded later in
the collection.
When TPF$ is prepared, the same procedure is used as with all prepared files. When
TPF$ is not prepared, the Collector must read in all of the TPF$ elements, process their
preambles, and create its own entry-point table. This implicit @PREP of TPF$ by the
Collector is less efficient than an explicit @PREP.
Files specified in SYS$*DATA$.LIB$NAMES are prepared when they are installed.
For efficiency considerations see 8.3.
7830 9887–001 3–17

Inclusion and Exclusion of Elements
3–18 7830 9887–001

Section 4
Banking
4.1. Introduction
A bank is the basic container of information for OS 1100 systems. Banks in main storage
are called physical banks. A physical bank is a region of main storage that has been
allocated for a particular user. Each physical bank has an associated data structure called
a bank descriptor, which lists characteristics of the physical bank. A bank is recognized
as a unit of an absolute element. Through the use of the bank directives, you have more
control over the execution and storage allocation of the program.
A bank template is a copy of a bank that is not installed on the system. Bank templates
reside in the absolute elements, but never in main storage or in the swapfile (meaning
swapped out of main storage into SWAP$FILE).
Bank attributes are determined from control information that accompanies the bank
template in the absolute element or from attributes named in the bank’s system
definition. See the Exec System Software Common Banks Programming Guide for more
information on banking.
The maximum number of banks per absolute that the Collector allows is 4089 (07771).
This value is determined by the Collector's maximum internal user-bank BDI value of
4092 (07774).
4.2. Banking Directives
This subsection describes bank directives and bank directive attributes.
4.2.1. IBANK, DBANK — Bank Structuring
Purpose
The IBANK and DBANK directives specify program banks within a bank-named
collection.
All parameters on the IBANK and DBANK directives are optional, except name-1.
Format
IBANK,attributes name-1,bank-list level-#,bdr-#
DBANK,attributes name-1,bank-list level-#,bdr-#
7830 9887–001 4–1

Banking
where:
attributes
are described in Table 4-1. For alternate file common (shared) banks (AFCB),
attributes in the bank’s system definition can override attributes in the absolute
element when the bank is installed. For nonconfigured common banks (NCCB), the
attributes are strictly from the absolute element. See the Exec System Software
Common Banks Programming Guide.
name-1
specifies the name of the bank. For nonconfigured common banks (NCCB), this is
the name of the absolute element containing the NCCB when the bank is the only
bank in the absolute element. All characters are allowed in a bank name if they are
enclosed in single quotes.
bank-list
specifies the address relationship between the bank named in name-1 and other
program banks. Names present in a bank-list can be I bank or D bank names. The
bank-list parameter has several formats that determine the starting address of the
bank named in name-1:
no entry
When bank-list is void, the starting address of the name-1 bank is the next
address that is a multiple of 01000 following the highest address of the most
recently defined I bank (if name-1 is an I bank) or D bank (if name-1 is a D bank).
name-2
The starting address of the name-1 bank is the same as that of the name-2
parameter. Name-2 can be either a bank name, a numeric value, or a bank name
± offset, where offset is an integer value that is added to or subtracted from the
starting address of the bank name.
(name-2)
The starting address of the name-1 bank is the next address that is a multiple of
01000 following the name-2 bank. Name-2 can be bank name or a bank name ±
offset, where offset is applied to the bank’s last address.
(name-2,name-3,...,name-n)
level-#
The starting address of the name-1 bank is the next address that is a multiple of
01000 following the highest address of the name-2,...,name-n banks. Each of the
name-2,. ..,name-n parameters can be a bank name, a bank name ± offset
(where offset is applied to the bank’s last address) or an integer value.
4–2 7830 9887–001

dr-#
Description
Banking
specifies the bank descriptor table (BDT) level for a particular bank. This level
overrides the global level when referencing the bank specified on the bank
directive. Level-# must be an integer from 0 to 3. The level-# for a bank is
required by extended mode programs to reference a bank. The default level-# is
2. For collections with the TYPE EXEC directive, the default level-# is 1 (see 6.6).
The level for each level-# is
0 System
1 Application
2 Program
3 Activity
specifies the bank descriptor registerf (BDR) associated with a bank. The bdr-#
field must be an integer from 0 to 3. The default BDR is 0 unless the M or U
option is specified on the bank directive. The M and U options will set the BDR
as follows
IBANK,M BDR is 0.
IBANK,U BDR is 1.
DBANK,M BDR is 2.
DBANK,U BDR is 3.
IBANK,MU BDR is 0. The M option overrides the U option.
DBANK,MU BDR is 2.
The bdr-# field satisfies references to that bank’s BDR. It is not placed in the
bank load table. If the bdr-# field and options on the bank directive conflict, an
error message is issued. The BDR as defined by the options will then be used.
For information on how the Collector assigns BDIs to banks, see A.3.
The starting address of a bank is the INFO group 3 directive specified minimum address
for an element included in the bank if the minimum address for the element would not
otherwise be met. However, the INFO 3 directive is ignored if the O option is specified
on the IBANK or DBANK directive or an integer starting address is specified of the
following forms:
IBANK bank1, 03000
DBANK bank1, 010000
The following forms do not cause the INFO 3 directive to be ignored.
IBANK bank1, (bank2, 05000)
DBANK bank1, (bank2, 050000)
For additional information on bank-named collections, see 4.4.
7830 9887–001 4–3

Banking
Table 4–1. IBANK and DBANK Directive Attributes
Attributes Description
A This attribute is used on common banks that can process contingencies for
errors received in program banks. It indicates that the bank is available for
processing program bank contingencies.
B This attribute indicates that the bank template is not to be marked as requiring
extended mode even if an INFO 10 location counter is included in the bank.
C The bank template is to be the control bank. This attribute can be specified only
once in a collection. If no C option appears in a collection, the control bank is
selected from the initially based banks. The order of precedence is as follows:
Main D bank
Utility D bank
Main I bank
Utility I bank
D The bank template has the dynamic attribute. If this attribute is not specified,
the bank template has the static attribute. In most cases, dynamic banks are
more efficient than static banks. See the Exec System Software Common Banks
Programming Guide.
G The bank template has the guaranteed entry attribute. When a bank basing an
instruction is executed to a guaranteed entry bank, the jump must be made to
the address specified as the guaranteed entry.
H The bank template has the program contingency handling attribute. See the
Exec System Software Executive Requests Programming Reference Manual
and the Exec System Software Common Banks Programming Guide for more
details.
L All references to BDICALL$ and IBJ$, where the associated reference is defined
in an L option bank, are to be satisfied by 0 and LMJ, respectively. This option is
assumed for the control bank. If the bank is not an initially based static bank, a
warning message is printed.
M This bank is to be initially based (BDR0 or BDR2 for the 1100/60, 1100/70, and
1100/80, systems, or B12 or B14 on the extended mode architecture). This
option can be used only once with an IBANK directive and once with a DBANK
directive. If no M or U options are specified, the M option is assumed for the
first IBANK and first DBANK directives. Once the M option is specified, no
assumptions are made regarding the M or U option.
N This bank requires extended mode.
O The starting address specified by bank-list is to override any minimum address
(INFO 3) specifications found in elements in this bank. This option is assumed if
bank-list is a number without parentheses (see 4.2.4).
Q The bank template has the test-and-set (TS) queuing attribute. When TS
conflicts occur within a bank with this attribute, the system queues the activity
to the TS cell. See the Exec System Software Common Banks Programming
Guide.
4–4 7830 9887–001

Table 4–1. IBANK and DBANK Directive Attributes
Attributes Description
R The bank template has the read-only (write-protected) attribute.
Banking
S The bank is to be a nonconfigured common bank (NCCB). This option is usually
used with multibanking techniques. See the Exec System Software Common
Banks Programming Guide for more details.
T This bank must start on an absolute 2,048 (04000) word boundary.
U This bank is to be initially based (BDR1 or BDR3 for the 1100/60, 1100/70, and
1100/80 systems, or B13 or B15 on the extended mode architecture). This
option can be used only once with an IBANK directive and once with a DBANK
directive. The U option is never assumed on an IBANK or DBANK directive.
V The bank template is not placed in the absolute element.
X The bank is represented by a configured bank descriptor index (BDI). These
types of common banks include configured common banks (CCB) and alternate
file common banks (AFCB). A CERU$ or CBEP$$ element included in the
collection provides the bank’s BDI. This type of common bank cannot be the
control bank.
Z This is a void bank template. This bank is assigned the next consecutive BDI,
starting with a value of 4, ahead of all other banks in the collection, including S
option and D option banks. Only the D option can be specified with the Z option.
No FORM, IN, or SEG directives are allowed following a Z option bank.
Example
The program is divided into four I banks and five D banks.
1. IBANK I1
2. IBANK I2
3. DBANK D1
4. IBANK I3,I2
5. DBANK D2,036000
6. DBANK D3,(I2,D1)
7. DBANK D4,(I3)
8. IBANK I4,I2+03000
9. DBANK D5,(D3+02000,D4,D2,042000)
The starting addresses of these banks are as follows:
1. I1 starts at address 01000.
2. I2 starts at the next 01000 following I1.
3. D1 starts at 040000 or at the next 01000 following the longest I bank, whichever
address is higher.
7830 9887–001 4–5

Banking
4. I3 starts at the same address as I2.
5. D2 starts at address 036000.
6. D3 starts at the next 01000 following the highest ending address of I2 and D1.
7. D4 starts at the next 01000 following I3.
8. I4 starts at the address obtained by adding 03000 to the start address of I2.
9. D5 starts at the next 01000 following the highest ending address of D4, D2,
D3+02000, and 042000.
4.2.2. BANKINFO — Specifying Bank Attributes
Purpose
The BANKINFO directive specifies the attributes that are to be associated with the
previous bank. The BANKINFO directive is used to improve the readability of a collection.
It is also used to create AFCBs and a link vector bank.
Format
BANKINFO attribute-list
where attribute-list specifies the attributes for the preceding bank directive. (See Table 4-
2.) Each attribute is separated by a comma to create the attribute list. Most of these
attributes correspond with the attributes (options) that can be specified on the BANK
directive (see Table 4-1).
Description
The attributes can be abbreviated to six characters and can be no longer than twelve
characters. The Collector uses only the first six characters to determine the desired
attribute. Attributes followed by a value in parentheses indicate the existence of a
subattribute. The subattributes are described with the attributes to which they apply.
Table 4–2. BANKINFO Directive Attributes
Attribute Option Description
AFCB X The bank is represented by a configured BDI. These types
of common banks include CCBs and AFCBs. The bank’s
BDI will be obtained from a CERU$ or CBEP$$ element
included in the collection. This type of common bank
cannot be the control bank.
4–6 7830 9887–001

Table 4–2. BANKINFO Directive Attributes
Banking
AFCB(bankname,bdi) * The bank is to be a common bank that is represented by a
configured BDI. These types of common banks include
CCBs and AFCBs. The bank name and BDI value are
specified in parentheses. The bank name specified is the
name used to install the common bank with COMUS. The
BDI value should be in octal format (040nnnn). See the
Exec System Software Common Banks Programming
Guide. The name specified on the bank directive will then
be treated as if it were received from a CBEP$$ element
(CB1 * EQU 040nnnn). (See 4.8).
ALLOWCONTIN A This attribute is used on common banks that can process
contingencies for errors received in program banks. It
indicates that the bank is available for processing program
bank contingencies.
BDR(#) * This attribute specifies the BDR associated with a bank.
The BDR value must be an integer from 0 to 3. The default
BDR is 0 unless the bank is initially based. The BDR
associated with an initially based bank is as follows:
MAINI BDR is 0
MAIND BDR is 2
UTILI BDR is 1
UTILD BDR is 3
The BDR value satisfies references to that bank’s BDR,
typically using MAPBDR$. It is not placed in the bank
loadtable. If the BDR value and the basing options or
attributes conflict, an error message is issued. A BDR value
will then be determined by where the bank is based using
the chart just shown.
CODESTRIPPED V The bank template is not placed in the absolute element.
CONTINGENCY H The bank template has the program contingency handling
attribute. See the Exec System Software Executive
Requests Programming Reference Manual for more details.
CONTROL C The bank template is to be the control bank. This attribute
can be specified only once in a collection. If no C option or
CONTROL attribute appears in a collection, the control bank
is selected from the initially based banks. The order of
precedence is as follows:
Main D bank
Utility D bank
Main I bank
Utility I bank
DYNAMIC D The bank template has the dynamic attribute. If this
attribute is not specified, the bank template has the static
attribute. See the OS 1100 Exec System Software
Common Banks Programming Guide.
EXTENDED N This bank requires extended mode.
7830 9887–001 4–7

Banking
Table 4–2. BANKINFO Directive Attributes
GUARANTEED G The bank template has the guaranteed entry-point attribute.
When a bank basing instruction is executed to a guaranteed
entry-point bank, the jump must be made to the address
specified as the guaranteed entry point.
INITIAL(subattribute) M,U This bank is to be initially based. The subattributes are
MAINI or BDR0 (based on BDR0)
MAIND or BDR2 (based on BDR2)
UTILI or BDR1 (based on BDR1)
UTILD or BDR3 (based on BDR3)
Each subattribute can be used for only one bank. If no
subattributes (or M or U options) are specified, the MAINI
(BDR0) is assumed for the first IBANK directive and the
MAIND (BDR2) is assumed for the first DBANK directive.
Once the MAINI (BDR0) and the MAIND (BDR2) or the M
option is specified, no assumptions are made regarding the
other subattributes (or the M or U options).
Bank descriptor registers BDR0, BDR1, BDR2, and BDR3
are used for the 1100/60, 1100/70, and 1100/80 systems.
Base registers B12, B13, B14, and B15 are used on the
extended mode architecture. For extended mode
architecture, BDR0, BDR1, BDR2, and BDR3 are synonyms
for B12, B13, B14, and B15 respectively.
LEVEL(#) * This attribute specifies the BDT level for a particular bank.
This level overrides the global level when referencing the
bank specified on the bank directive (see 6.6). The number
(#) specified on the LEVEL attribute must be an integer
from 0 to 3.
LMJ L All references to BDICALL$ and IBJ$, where the associated
reference is defined in an L option or LMJ attribute bank,
are to be satisfied by 0 and LMJ, respectively. This attribute
is assumed for the control bank. If the bank is not an initially
based static bank, a warning message is printed.
NCCB S The bank is to be a nonconfigured common bank. This
attribute is usually used with multibanking techniques. See
the Exec System Software Common Banks Programming
Guide for more details.
NOTEXTENDED B This attribute indicates the bank template is not to be
marked as requiring extended mode even if an INFO 10
location counter is included in the bank.
OVERRIDEMIN O The starting address specified by bank-list is to override any
minimum address (INFO 3) specifications found in
elements in this bank. This attribute is assumed if bank-list
is a number without parentheses (see 4.2.4).
4–8 7830 9887–001

Table 4–2. BANKINFO Directive Attributes
READONLY R The bank template has the read-only (write-protected)
attribute.
Banking
TSQUEUING Q The bank template has the test-and-set (TS) queuing
attribute. When TS conflicts occur within a bank with this
attribute, the system queues the activity to the TS cell. See
the Exec System Software Common Banks Programming
Guide.
VECTOR
(Bn[,Xn] [Bn[,Xn]] ...)
Bn is a B register 2 to 15, or 2 to 31 for TYPE EXEC. Xn is
an X register 1 to 15. This bank is to be the link vector bank.
The Collector creates the contents of this bank as the
Collector defined tags MAPCALL$ and MAPGOTO$ are
encountered. Collections using this attribute cannot contain
segmentation. For more information, see 4.9.
VOID Z This is a void bank template. This bank is assigned the next
consecutive BDI starting with a value of 4, ahead of all
other banks in the collection, including NCCB attribute (S
option) and DYNAMIC (D option) banks. Only the DYNAMIC
attribute (D option) can be specified with the VOID (Z
option) attribute. No FORM, IN, or SEG directives are
allowed following a VOID bank.
2048BOUNDARY T This bank must start on an absolute 2048 (04000) word
boundary.
* The asterisk indicates that this attribute is not available as an option on the BANK
directive.
Examples:
1a. IBANK,MD IB1 1b. IBANK IB1
BANKINFO INITIAL(MAINI),DYNAMIC
The BANKINFO directive is used in example 1b to produce the same results as shown in
example 1a.
2a. DBANK,MDRC DB1 2b. DBANK DB1
BANKINFO INITIAL(MAIND),DYNAMIC
BANKINFO READONLY,;
CONTROL
More than one attribute can be specified on a BANKINFO directive by using a comma
between the attributes. More than one BANKINFO directive can be used for each BANK
directive. A semicolon can also be used to continue the BANKINFO directive.
3a. IBANK,XM AFCBNAME 3b. IBANK AFCBNAME
DBANK BANKNAME BANKINFO INITIAL(MAINI),AFCB
IN FILE.ELT DBANK BANKNAME
IN CBEP$$ELT IN FILE.ELT
IN CBEP$$ELT
7830 9887–001 4–9

Banking
The BANKINFO directive is used in example 3b to produce the same results as shown in
example 3a.
4. IBANK AFCBNAME
BANKINFO AFCB(INSTALLNAME,0400103),DYNAMIC
IN FILE.ELT
An integrated AFCB can be created in one collection. The bank name specified on the
IBANK or DBANK directive, AFCBNAME, becomes an entry point that the Collector uses
to resolve references to the bank. This is the name that is used when referencing the
bank from elements within this collection. It has the BDI value specified on the
BANKINFO directive.
The bank name specified on the BANKINFO directive (INSTALLNAME) is the externally
visible name for the common bank. This name is used for the COMUS INSTALL
command and on the unsolicited console keyin RL. This name is listed on the Collector
listing as the bank name.
The M or U option or the INITIAL attribute can also be specified. The common bank is
based, not the bank name specified on the BANKINFO directive. The basing of this bank
is not printed on the Collector output listing.
4.2.3. $Ics — Location Counter Set Specification
Purpose
The $lcs directive specifies the set of location counters to be included in the current
bank from elements explicitly included in the collection by IN directives.
Format
$lcs
where $lcs specifies the set of location counters either by means of a keyword or
explicit naming as follows:
$ALL
$NONE
$ODD
$EVEN
Include all location counters.
Include no location counters (used to create dummy or skeletal structures).
Include only odd location counters (default for I banks).
Include only even location counters (default for D banks).
4–10 7830 9887–001

$n-1,n-2,...,n-m
Include only those location counters specified.
$ALLBUT,n-1 ,n-2,...,n-m
Include all location counters except those specified.
Description
Banking
The location counter set specification is used only in conjunction with a bank-named
collection. The specified set remains in effect until the next $lcs or IBANK or
DBANKdirective is encountered. A bank directive automatically sets the location counter
set to $ODD for IBANK and $EVEN for DBANK.
The location counter set specified for a bank can be overridden for individual elements or
files by using the optional $lcs field on the IN directive (see 3.1.1).
In formats 2 and 3 of the LIB directive, $lcs is also used to direct implicit elements to
specific banks (see 3.2.1).
Each location counter of each element can be globally included only once in a collection.
However, a location counter can be locally included as many times as desired.
Example
LIB (I/$ALL,D/$NONE)
LIB F1( )
LIB F2(I/$1,3,7,010,D/$2,4,5,6)
IBANK I
$ALLBUT,2,4
IN E1,E2,E3($2),E4
.
.
.
$1,3
IN E5
.
.
.
DBANK D
$2,4
IN E1,E2,E3($ALLBUT,2),E4
.
.
.
$ALLBUT,1,3
IN E5
7830 9887–001 4–11

Banking
Bank Included
Element
I E1,E2,E4
E3
E5
D E1,E2,E4 E3
E5
Location
Counter
All but 2 and 4
4–12 7830 9887–001
2
1 and 3
2 and 4
All but 2
All but 1 and 3
All implicit elements from file F1 will go to I bank I. Location counters 1, 3, 7, and 8 from
the implicit elements from file F2 will go to I bank I, and location counters 2, 4, 5, and 6
from the implicit elements from file F2 will go to D bank D.
4.2.4. INFO Group 3
The MASM INFO group 3 (INFO 3) directive allows you to specify the minimum I bank
and D bank addresses of the element that contains the directive. The INFO 3 specified
minimum I bank address applies to the I bank containing location counter one of the
element that contains the INFO 3 specified minimum I bank address.
The INFO 3 specified minimum D bank address applies to the D bank containing location
counter zero of the element that contains the INFO 3 specified minimum D bank
address.
4.3. Bank-Implied Collections
The Collector provides the capability of dividing an absolute element into logical
structures called banks. If you do not wish to define this structure by means of the
IBANK or DBANK directives, the Collector generates a two-bank absolute element. This
is called a bank-implied collection. A bank-implied collection creates basic mode
instruction banks.
In a bank-implied collection, location counters from both explicitly and implicitly included
elements are split with the odd location counters going to the I bank and the even ones
going to the D bank.
The starting address of the I bank (instruction area) is normally 01000; however, it can be
altered by the MASM $INFO group 3 directive. The starting address of the D bank (data
area) depends on the size of the I bank, the use of the MASM INFO group 3 directive,
the total program size, and the options specified on the @MAP statement. The first
address of the D bank, however, is always a multiple of 01000 and is often given the
default value 040000.
Your program can reference the first and last I bank and the first and last D bank
addresses by the symbols FRSTI$, LASTI$, FRSTD$, and LASTD$, respectively. In
addition, the symbols LASTIR$ and LASTDR$ return the values of LASTI$ and LASTD$
rounded to the end of the main storage block. The Collector replaces these symbols with
the actual assigned address values.

Banking
An unnamed common block (that is, blank common), if required in the program, is placed
in the D bank under the name BLANK$COMMON. If the program contains segments,
the unnamed common block is attached to the main segment. It can be positioned in
another segment or bank by an IN BLANK$COMMON directive.
Named common blocks are always placed in the D bank. If the program contains
segmentation, named common blocks (if not named on an IN directive) are attached to a
global segment that contains all segments referencing the named common block. This is
to ensure that the common block is loaded if any of the referencing segments is loaded.
4.4. Bank-Named Collections
One of the advantages of a multibanked program (that is, a program with more than one
I bank and D bank) is that banks containing code not necessary for a certain portion of
the program need not be in main storage until they are required. This subsection
provides information regarding some guidelines and considerations that you need to
keep in mind when creating bank-named collections.
4.4.1. Bank Address Assignments
The relative starting address of a bank can be explicitly given on the IBANK or DBANK
directive as a numeric value or as an address to be determined in relation to the size of
other banks. This bank starting address should be a multiple of 01000. This is a hardware
restriction since the lower 9 bits of the address are not retained. When no such address
specification exists, the following guidelines apply:
1. The I bank specified by means of the first IBANK directive starts at the higher of the
following:
a. 01000
b. A MASM $INFO group 3 specified address from an element included in this I
bank unless the O option is specified
2. The D bank specified by means of the first DBANK directive starts at the highest of
the following:
a. 040000
b. The next address that is a multiple of 01000 following the highest assigned I
bank address
c. A MASM $INFO group 3 specified address from an element included in this D
bank (if the element placement is such that the minimum specified address
would not otherwise be met) unless the O option is specified
3. I banks follow I banks and D banks follow D banks; that is, an I bank (D bank) that
has no explicit address assignment is assigned a starting address that is the next
multiple of 01000 following the last address assigned to the previous I bank (D bank)
defined in the Collector source language.
No bank address can be greater than 0777777 (262K). The total size of all I banks (D
banks) can be greater than 0777777 if there is some overlap of program address
assignments within banks, so that the total address space does not exceed 0777777
(262K).
7830 9887–001 4–13

Banking
Note: For older unsupported Series 1100 systems, there is an I bank restriction that no I
bank address can be greater than 0177777 (65K).
Overlap of bank address assignments can be achieved by using the IBANK and DBANK
directives. Overlay banks that have the same address space refer to separate physical
storage and can be used to contain different data or instructions. Access to the specific
data or instructions is controlled by the basing and unbasing of the respective banks.
Although banks occupy different space in memory, the visibility of the banks based must
not overlap within the Collector address space or parts of a bank will not be accessible.
Bank overlaps can be necessary for large collections. The banks chosen to overlap
should be logically separate so they are not based at the same time.
In addition to the Collector-defined tags FRSTI$, LASTI$, LASTIR$, FRSTD$, LASTD$,
and LASTDR$ (see Section 7), the tags FIRST$, LAST$, LASTR$, and BDI$ are defined
for bank-named collections. These tags are defined to be the first assigned address, last
assigned address, rounded last assigned address, and BDI value for the bank in which
the reference is contained.
4.4.2. Initially Based Banks
An initially based bank is a bank that can be referenced at the start of execution of a
program. This means that the bank is described in one of the basing registers (BDR0 to
BDR3 on the 1100/60, 1100/70, and 1100/80 systems or B12 to B15 on the extended
mode architecture). A bank can be specified for initial basing by means of the M or U
option on the IBANK and DBANK directives (see 4.2.1), or by means of the BANKINFO
directive (see 4.2.2). Each option can be used with a maximum of one IBANK and one
DBANK directive. When there is no initial basing specified for any banks, the first I bank
and the first D bank defined in the Collector source language are initially based on BDR0
and BDR2 (1100/60, 1100/70, 1100/80 systems) or B12 and B14 (extended mode
architecture) respectively. A bank is never assigned to be based on BDR1 or BDR3
(1100/60, 1100/70, 1100/80 systems) or B13 or B15 (extended mode architecture) by
default. Thus, if a bank is to be initially based on BDR1 or BDR3 (1100/60, 1100/70,
1100/80 systems) or B13 or B15 (extended mode architecture), it must have the U
option specified on the IBANK and DBANK directives. If a bank is not initially based, it
can be based dynamically by means of the LBJ, LIJ, or LDJ instructions (see 4.5) for
basic mode banks and the LBU, CALL, or GOTO instructions (see 4.6) for extended
mode banks.
4.4.3. The Control Bank
The control bank is the normal place in which to collect such components of a program
as permanent flags, central control routines for sets of dependent library subroutines,
test-and-set cells, and locations designed to capture interrupts (such as guard mode
contingency) that can result at varied or unpredictable locations throughout the program.
Certain tables produced by the Collector, including the segment load table (SLT$), are
located at the beginning of the control bank. A bank is specified as the control bank by
using the BANKINFO directive with the CONTROL attribute or by specifying the C option
on an IBANK or DBANK directive. The control bank normally is defined as an initially
based D bank.
4–14 7830 9887–001

Banking
In a basic mode instruction environment, the Collector assumes that the control bank will
not normally be unbased by means of an LIJ, LDJ, or LBJ for another bank. In the
extended mode instruction mode environment, this assumption cannot be made.
If a control bank is not specified, the Collector selects an initially-based bank to be the
control bank in the order of
1. Main D bank based on the BDR2 (1100/60, 1100/70, 1100/80 systems) or B14
(extended mode architecture)
2. Utility D bank based on the BDR3 (1100/60, 1100/70, 1100/80 systems) or B15
(extended mode architecture)
3. Main I bank based on the BDR0 (1100/60, 1100/70, 1100/80 systems) or B12
(extended mode architecture)
4. Utility I bank based on the BDR1 (1100/60, 1100/70, 1100/80 systems) or B13
(extended mode architecture)
4.4.4. Element Inclusion
All of the rules of element inclusion and file searching for bank-implied collections are
applicable to bank-named collections with a few important additions. When banks are
not named in the Collector symbolic, any element to be included is split, with its odd
location counters going to the I bank (instruction area) and its even counters to the D
bank (data area). However, in a bank-named collection, in addition to naming an element
for inclusion, you can also designate which location counters of the element are to be
included within a bank. Normally, the selected location counters of an element are
determined by the location counter set that is active at the time the element is named
for inclusion (see 4.2.3). The selection can be overridden on an individual basis by using
the $lcs field for the element named on the IN directive (see 3.1.1). Thus, the element
name can appear on several IN directives, but different location counters must be
included each time the element is named for global inclusion.
All location counters of an element are included in a collection. Therefore, if an element
has a location counter that was not specified for inclusion, that location counter is placed
in the control bank.
Example
IBANK I1
BANKINFO INITIAL(BDR0),DYNAMIC
$1,5
IN ELTA
IBANK I2
BANKINFO INITIAL(BDR1),DYNAMIC
$7,9,3
IN ELTB($ODD),ELTA
$ALL
IN ELTC,ELTD
DBANK D1
BANKINFO INITIAL(BDR2),CONTROL
IN ELTA,ELTB
7830 9887–001 4–15

Banking
The following chart shows which location counters of each element are placed in the
various banks:
ELTA
ELTB
ELTC
ELTD
I1 I2 D1
1,5 7,9,3
4–16 7830 9887–001
ODD
ALL
ALL
EVEN,11
EVEN
Note that the even location counters of ELTA and ELTB are placed in D1 since $ODD is
assumed for I banks and $EVEN is assumed for D banks. Also note that all of the odd
location counters for ELTB go to I2, overriding the active location counter set of $7,9,3.
Location counter 11 in ELTA was placed in the control bank because no direction was
given for its placement.
4.4.4.1. Global Elements
An element is global in nature when its entry points are known to any nonlocal elements
in the collection, and when its external references can be satisfied by any nonlocal
element. Because of the global nature of elements, they can be included only once in a
collection. All of the elements in the example in 4.4.4 are global in nature.
4.4.4.2. Local Elements
By specification, an element (or one or more of its location counters) can be made local
to a set of banks and thereby be included in the collection more than once. The locality
of these elements is determined by the specification of a local bank set list on the IN
directive.
Note: An entry-point name can be defined in only one place whether defined by a
Collector directive or by a relocatable element.
The locality of an element implies the following:
1. All of the external references in the local element are satisfied only by elements
defined in the set of banks that make up the local bank set list.
2. The external labels (entry points) of the local element satisfy only references by
elements defined in the set of banks that make up the local bank set list.
The local bank set list consists of the banks named in the bank-list on the IN directive
and the bank named on the preceding IBANK or DBANK directive.
The entry points of a local element satisfy only references made by other elements
within the banks to which it is local. No other banks have access to these entry points.
Within a given bank, elements and location counters can be included only once.

Banking
This feature allows duplication of heavily used routines in different banks without
causing entry-point conflicts and without forcing unnecessary repetitive switching of
bank bases to base very short pieces of heavily used code.
Entry points can thus appear many times locally (satisfying references from within the
local bank set), but can appear only once globally (satisfying references from all elements
not named locally). Entry points named on the COR, SNAP, EQU, ENT, and DEF
Collector directives apply to the global specification of that entry point.
Any element desired for local inclusion must be named on the IN directive along with the
local bank set list. No implicitly included element can be included locally.
Elements included more than once using local element inclusion must be identical for
each inclusion of the element. To include different elements with identical names or
entry points, use relocatable elements produced by the Collector (see 2.2.1).
Example
IBANK I1
IN(I2) ELTA
IN() ELTB
IBANK I2
IN ELTB($1)
IN(I1) ELTB($3)
IBANK I3
IN( ) ELTA,ELTB($3)
DBANK D1
BANKINFO CONTROL
IN ELTA($1),ELTB,ELTC
Figure 4-1 shows how external references from globally included elements for the
various banks in the example are satisfied. For example, an element in bank I3
referencing an entry point defined under location counter 1 of element ELTB would
receive the definition of that entry point in bank I2 since location counter 1 of ELTB is not
included in bank I3, but is included globally in bank I2. Location counters that are not
shown for a bank are undefined for the element in that bank.
Figure 4–1. Bank of Global References
7830 9887–001 4–17

Banking
References made by locally included elements follow the same rules, except that the
defining bank must be in the locally included element’s bank list. For example, if an
element in bank I1 references an entry point in element ELTC, the referencing element
must either be made local to banks I1 and D1, or it must be made global.
4.4.4.3. Local-Global Conflicts
A situation can arise where a conflict occurs between the local nature of an element, its
entry points and external references, and their global nature.
A local-global conflict occurs when a reference has been made to a location counter of
an element and that location counter appears in more than one place. The reference can
either be a reference to an entry point or a reference made by means of the relocation
information in the text. If there is no reference to a location counter included both locally
and globally, there is no local-global conflict.
The local-global conflict presents a problem to the Collector, because it cannot determine
which value to place in the reference. When a local-global conflict occurs, a message is
printed.
Examples:
IBANK I1
IN E1
IBANK I2
$ALL
IN(I1) E2
IBANK I3
$ALL
IN E2
In this example, element E2 and its entry points are local to I banks I1 and I2. It is also
global because of its explicit inclusion in I bank I3 (that is, the entry points of element E2
are also defined in I bank I3). If element E1 references one of the entry points of E2, the
Collector does not know if it should return the local definition or the global definition for
the reference.
IBANK I1
IN E1
IBANK I2
IN(I1) E2
IBANK I3
IN(I1) E2
This example shows another conflict that the Collector cannot resolve. E2 is defined
locally twice (to I banks I1 and I2 and to I banks I1 and I3). Therefore, if E1 references an
entry point in E2, the Collector cannot determine which definition it should use.
4.4.5. Element Placement
An element is included in a collection because it is either
4–18 7830 9887–001

1. Explicitly included (named on an IN directive)
Banking
2. Implicitly included (through the library search sequence it has been found to satisfy
external references in elements already included in the collection)
Explicitly included elements are placed in the bank that is named on the preceding
IBANK or DBANK directive.
Although elements can be split by location counters between banks, the entire element,
that is, all its location counters, are included somewhere in the absolute element. If all of
the location counters of an explicitly included element are not specified on IN directives
or on $lcs directives, remaining location counters are placed in the control bank (see
4.4.3).
The placement of implicitly included elements is dependent upon the placement of the
referencing elements. For bank-implied collections, the implicitly included elements are
split with odd location counters to the I bank and even location counters to the D bank.
For bank-named collections, the following conditions apply:
1. One bank
The location counters of the referencing elements can be anywhere, and implicitly
included elements are entirely included in the bank.
2. Two banks based only on BDR0 and BDR2, and the banks are not dynamic
The location counters of the referencing elements can be anywhere, and implicitly
included elements are split, with odd location counters to the I bank and even
location counters to the D bank.
3. Conditions of 2 not met
The location counters of the referencing elements are all in one bank, and implicitly
included elements are split, with odd location counters to the referencing bank and
even location counters to the control bank.
4. Conditions of 2 not met
The location counters of the referencing elements are in more than one bank, and
implicitly included elements are placed entirely in the control bank.
The only way to override the Collector’s placement of implicitly included elements is to
use formats 2 or 4 of the LIB directive (see 3.2.1).
Condition 3 does not apply to references from implicitly included elements. Consider the
following situation:
7830 9887–001 4–19

Banking
Element CALL is contained entirely in one bank and the requirements of condition 2 are
not met. Because of this, the location counters of DEF1 are split, with the odd ones
placed in the referencing bank and the even ones placed in the control bank.
When the references of element DEF1 are processed and DEF2 is included in the
collection, condition 4 applies because DEF1 (the referencing element) is not contained
entirely in one bank. All of the location counters of DEF2 are placed in the control bank.
4.5. Bank Switching for Basic Mode
Your program can switch control between banks as needed. When the bank is already
based, a jump to an entry point suffices. When the bank is not based, the bank must be
based by means of the LBJ, LIJ, or LDJ instructions.
For an expanded discussion on bank switching techniques, see the Exec System
Software Common Banks Programming Guide.
4.5.1. IBJ$/DBJ$
IBJ$ and DBJ$ are Collector-defined symbols that are used in the bank switching
operation. When the Collector encounters IBJ$ (DBJ$), it determines if an LMJ
instruction or LIJ (LDJ) instruction should be generated. In general, an LMJ instruction is
generated if the entry point to which the jump will be made is contained in the same
bank in which the call occurs. An LIJ (LDJ) instruction is generated if the entry point is in
a different bank from the calling bank. Further details concerning the situations governing
the generation of these instructions are discussed in 4.5.5.
IBJ$ (DBJ$) is not an assembler instruction, but an external reference you pass to the
Collector in the text of the relocatable element. Bits 0 through 9 of the text word must
be relocated by the external reference “IBJ$” (“DBJ$”).
An assembler procedure that generates the correct external reference should include the
following (DBJ$ (LDJ) will no longer be mentioned, since anything that applies to IBJ$
(LIJ) applies to it):
IBJ* PROC 1,1
F FORM 10,4,4,18
F IBJ$,IBJ(1,1),IBJ(1,3),IBJ(1,2)
END
4–20 7830 9887–001

where:
4.5.2. BBJ$
IBJ(1,1) is the a field (must be an X register).
IBJ(1,2) is the u field.
IBJ(1,3) is the x field.
Banking
BBJ$ is a Collector-defined symbol that is used in the bank switching operation. It is
identical to IBJ$ except that an LBJ instruction is generated instead of an LIJ instruction.
When the Collector encounters BBJ$, it determines if an LBJ instruction or an LMJ
instruction should be generated. An LMJ instruction is generated if the entry point to
which the jump will be made is contained in the same bank in which the call occurs. An
LBJ instruction is generated if the entry point is in a different bank from the calling bank.
An assembler procedure to generate the correct external reference should include the
following:
BBJ* PROC 1,1
F FORM 10,4,4,18
F BBJ$,BBJ(1,1),BBJ(1,3),BBJ(1,2)
END
Where:
BBJ(1,1) is the a field (must be an X register).
BBJ(1,2) is the u field.
BBJ(1,3) is the x field.
Here is an example of a typical call:
LXI,U X11,BDICALL$+MAPBDR$+label
BBJ X11,label
BDICALL$ and MAPBDR$ are Collector-defined tags (see 4.5.3 and 4.5.4).
4.5.3. Use of MAPBDR$
MAPBDR$ must be used with BDICALL$ or BDIREF$. The tag MAPBDR$ tells the
Collector to return the BDR for the bank in which the associated label is defined. This
facilitates specification of the BDR for LBJ instructions. If MAPBDR$ is used without
BDICALL$ or BDIREF$, it is ignored.
MAPBDR$ should be used in the following format:
LXI,U X11,BDICALL$+MAPBDR$+label
7830 9887–001 4–21

Banking
or
LXI,U X11,BDIREF$+MAPBDR$+label
The BDR returned is the value specified on the IBANK or DBANK directive for the bank
containing the label. For more information on BDR specification, refer to 4.2.1.
4.5.4. Use of the BDI with IBJ$/DBJ$/BBJ$
When using the LIJ instruction, your program must place the BDI of the destination bank
in H1 of the X register used in the instruction. The BDI is a unique (collection-dependent)
number given by the Collector to all of the banks in a collection. In the case of common
banks, it is a unique number registered in the system element SYS$*RLIB$.CERU$ or in
the CBEP$$ element of the program’s product file. The use of the BDI by the Exec is a
method for identifying a bank for loading.
It is not advisable to hard-code the BDI in H1 of the X register used in the IBJ$
instruction because the BDI could change if the collection was rearranged or if CERU$
changed. For these reasons, it is possible to pass the Collector a set of specifications
that direct it to find the proper BDI. Three Collector-defined symbols are used for this
purpose. The Collector resolves them as follows:
• BDI$
BDI for the bank in which the reference is made.
• BDIREF$
BDT level and BDI for the bank in which the associated label is defined. If the value
of the associated label is an absolute 36-bit number, the lower 18 bits are used (H2).
• BDICALL$
Same as BDIREF$, unless the collection is bank-implied or the reference is in the
control bank or in the same bank in which the label is defined. In these cases, the
value is zero. If the value of the associated label is an absolute 36-bit number, the
upper 18 bits are used (H1).
In conjunction with IBJ$, these symbols are used as follows (X11 is used only for these
examples; any X register can be used):
LXI,U X11,BDICALL$+label
IBJ X11,label
In the preceding example, IBJ refers to a call of the procedure in 4.5.1.
BDICALL$ must precede the label in the relocatable; that is, label+BDICALL$ will not
work correctly. If the label is a complex expression, the last relocatable value in the
expression is used to determine the value of BDICALL$+label (See 4.5.5 for a discussion
of BDICALL$.)
BDI$ is not normally used for bank switching operations. It is used when the BDI of the
currently executing bank is required.
4–22 7830 9887–001

Banking
BDIREF$ must precede the label in the relocatable; that is, label+BDIREF$ will not work
correctly. BDIREF$ is used when you are certain that the bank to which control is to be
transferred will not be based when the reference is made, and hence is used with an
explicit LIJ, LDJ, or LBJ instruction. Also see 4.7.
The format returned for BDIREF$ and BDICALL$ is affected by the TYPE EXEC directive.
For more information regarding TYPE EXEC collections, see Appendix A.
4.5.5. TYPE IBJLNK and BDICALL$/IBJ$
4.5.5.1. Using BDICALL$ and IBJ$
BDICALL$ and IBJ$, together with the TYPE IBJLNK parameters, provide a means of
coding subroutines and their calls so that the correct linkages and BDICALL$/IBJ$
parameters can be generated at collection time rather than at compile time. When
coding calls to subroutines, especially for library routines used in high-level languages,
the programmer does not need to know whether the subroutine is to be collected in the
same bank as the call, whether it is to be collected in a different bank in the program, or
whether it resides in a common bank.
BDICALL$ and IBJ$ are used in the following format, where the instructions must be in
the order shown but other instructions can be placed between the LXI and IBJ
instructions. I$BJ is a SYSLIB procedure that generates a word in instruction format with
bits 0 through 9 (the f and j fields) relocated by the external reference IBJ$. X11 is used
for convenience in the examples; however, any index register could be used.
Format
LXI,U X11,BDICALL$+label
IBJ X11,label
In the preceding example, IBJ refers to a call of the procedure in 4.5.1.
4.5.5.2. System-Provided Procedures
The system-defined procedure calls I$BJ and D$BJ generate the IBJ$ (DBJ$) calling
sequences used in bank switching.
Format
I$BJ Xn,ep-name[,Xx]
D$BJ Xn,ep-name[,Xx]
where:
Xn
is an X register.
ep-name
7830 9887–001 4–23

Banking
Xx
is an entry point defined as either a simple address or as an absolute value in the
form
ep-name* $EQU bdi*/18+ep-value
(bdi and ep-value must not be external references)
is an optional X register used in LMJ/LIJ.
The I$BJ and D$BJ procedures generate the following code:
LXI,U Xn,BDICALL$+ep-name .
IBJ$ Xn,ep-name[,Xx] . (or DBJ$ Xn,ep-name[,Xx])
4.5.5.3. Using TYPE IBJLNK
Using TYPE IBJLNK, linkages can be set up to a common routine, where the
BDICALL$/IBJ$ parameters are specified at collection time. The element name on the
IBJLNK directive can contain the absolute values of different tags.
If you use the following MASM instruction and Collector directive, and label is defined in
element-name, H1 of the 36-bit absolute value label is placed in H1 of the X register.
MASM Instruction
LXI,U X11,BDICALL$+label
Collector Directive
TYPE IBJLNK element-name,address
The IBJ$ reference is then satisfied as LMJ X11,address, where address is the value
found on the TYPE IBJLNK directive (see F.2.1).
The main advantage of TYPE IBJLNK is that you can supply a jump-to address for the
IBJ$ symbol to the Collector at collection time. Another advantage is that a dummy
element can be included and used as the TYPE IBJLNK parameter. The values defined
for the entry points in this dummy element override any absolute value definitions of the
entry point found in library elements.
4.5.5.4. Resolution of BDICALL$, IBJ$, and TYPE IBJLNK
Table 4-3 shows how the BDICALL$ and IBJ$ (DBJ$) collector defined symbols are
resolved for different cases.
4–24 7830 9887–001

label Defined
Case 1:
In the same bank
as the reference,
or
In the control
bank, or
In a bank with
the L option
Case 2:
In a bank other
than the bank
where the
reference was
made
Case 3:
As a 36-bit
absolute value:
label* $EQU;
bdi*/1 8+;
ep-value
Case 4:
As a 36-bit
absolute value:
label*$EQU;
bdi*/1 8+;
ep-value
Table 4–3. BDICALL$ and IBJ$ (DBJ$) Resolution
Other
Conditions
OR Collection is
bank-implied
AND Collection is
bank-named
AND Element defining
label is not
specified on
TYPE IBJLNK
AND Element defining
label is specified
on TYPE IBJLNK
4.5.6. BDICALL$/IBJ$ Return
BDICALL$+
label
Satisfied
as:
IBJ$
(DBJ$
)
Satisfi
ed as:
Banking
Calling Sequence
Generated by
Collector
0 LMJ LXI,U X11,0
BDI of the
bank
defining
label
Value from
H1 of label
Value from
H1 of label
taken from
element
specified on
TYPE
IBJLNK
LIJ
(LDJ)
LIJ
(LDJ)
LMJ X11,label
LXI,U X11,bdi
LIJ X11,label
LXI,U X11,H1 of label
LIJ X11,H2 of label
LMJ LXI,U X11,H1 of label
LMJ X11,address
(from TYPE IBJLNK)
When BDICALL$ and IBJ$ are satisfied in one of the first three ways described in Table
4-3, that is, without the use of a TYPE IBJLNK specification, the called subroutinecan
appropriately determine the type of call and type of return. The type of return is
determined by examining the value passed in the increment portion (H1) of X11, as
follows:
TAG .
S X11,RETURN . Save return address
.
. . Process subroutine
.
7830 9887–001 4–25

Banking
L X11,RETURN . Restore return address
TZ,H1 RETURN . Call by LIJ or LMJ?
LIJ X11,0,X11 . LIJ, return with LIJ
J 0,X11 . LMJ, return with JUMP
4.6. Bank Switching for Extended Mode
Your program can switch control between banks as needed. Register B0 always points
to the current bank (instruction stream). To pass control to a location within the current
bank, use the LOCL instruction. To pass control to a location in a bank other than the
current bank, use the CALL or GOTO instructions.
Registers B2 through B11 are available for user data banks. Registers B12 through B15
can point to either code or data in basic mode but only to data in extended mode. The
LBU instruction is used to load a user B register.
4.6.1. Use of the BDI
When you use the CALL instruction, the operand is the address of a virtual address. H1
of the virtual address contains the LBDI of the target bank and H2 contains the offset
into the bank. Three Collector-defined symbols are used for this purpose. The Collector
resolves them as follows:
• LBDI$
BDT level and BDI for the bank in which the reference is made.
• LBDIREF$
BDT level and BDI for the bank in which the associated label is defined. If the value
of the associated label is an absolute 36-bit number, then the lower 18 bits are used
(H2).
• LBDICALL$
Same as LBDIREF$, unless the collection is bank-implied or the reference is in the
same bank in which the label is defined. In these cases, the value is zero. If the value
of the associated label is an absolute 36-bit number, the upper 18 bits are used (H1).
The BDT level is always formatted in the returned value in the extended mode virtual
address (see 4.2.1 and 6.6).
LBDIREF$ and LBDICALL$ must precede the label in the relocatable; that is,
label+LBDIREF$ or label+LBDICALL$ will not work correctly.
The format returned for LBDI$, LBDIREF$, and LBDICALL$ is affected by the TYPE
EXEC directive (see Appendix A).
If the reference and the label are in different banks, use the CALL instruction with
LBDICALL$. If the reference and the label are in the same bank, use LOCL.
4–26 7830 9887–001

4.6.2. Example Using LOCL and CALL
Banking
Following is an example of the LOCL and CALL instructions. When the program is
executed, it begins in element RB$.BM6. An LBJ instruction is used to jump to the label
EMSTART in element RB$.EM4. Register B2 is used to point to the literal pool.
An LOCL instruction is then used, since the label EM4TAG is within the same bank.
Register A4 is loaded to show that the control was transferred to the label EM4TAG. The
RTN instruction returns to the line after the LOCL instruction. Register A5 is loaded to
show that the control was returned.
A CALL instruction is then executed using LBDICALL$ since the label EM5TAG is in a
different bank. Control is transferred to the element RB$.EM5 at the label EM5TAG.
Register A6 is loaded to show that the CALL worked correctly. The RTN instructions are
followed back and the L$SNAP is performed. After the program execution, A4 contains
4, A5 contains 5, and A6 contains 6.
@ . Assemble extended mode relocatable EM4
@MASM,L ,RB$.EM4
$INCLUDE ’MAXR$’ . Register mnemonics
$EXTEND . Generate extended mode
. instructions
$(3) $LIT B2 .
LITPOOL .
$(1) .
EMSTART* . Entry point
LA,U A2,LITPOOL . Load address of literal
. pool in A2
LXI,U A2,LBDIREF$+LITPOOL . Load bdi of this bank
LBU B2,A2 . Base literal pool on
. register b2
LOCL EM4TAG . Local call
LA,U A5,5 .
CALL (LBDICALL$+EM5TAG,EM5TAG) . Call another bank
RTN . Return to caller
EM4TAG . A local entry point
LA,U A4,4 .
RTN . Return to caller
END .
@EOF
@ . Assemble extended mode relocatable EM5.
@MASM,L ,RB$.EM5
$INCLUDE ’MAXR$’ . Register mnemonics
$EXTEND . Generate extended mode
. instructions
$(1) .
EM5TAG* . Tag
LA,U A6,6 .
RTN .
END .
@EOF
7830 9887–001 4–27

Banking
@ . Assemble basic mode relocatable BM6.
@MASM,L ,RB$.BM6
$INCLUDE ’MAXR$’ . Register mnemonics
$BASIC .
$(3) $LIT .
START* . Begin execution in
. basic mode
LX,U X11,EMSTART . Starting address in
. em routine
LXI,U X11,BDICALL$+EMSTART . BDI of em routine
LBJ X11,0,X11 . Jump to em routine
L$SNAP ’A4-A6’,2,0,0 .
ER EXIT$ .
END START .
@EOF
@PREP RB$.
@MAP,S ,RB$.ABS
NOT TPF$. .
TYPE BLOCKSIZE64 . Required for extended
. mode programs
LIB RB$. .
IBANK EM4BANK . Extended mode bank
BANKINFO EXTENDED
IN EM4 .
IBANK EM5BANK . Extended mode control Bank
BANKINFO EXTENDED
IN EM5 .
IBANK BM6BANK . Basic mode bank
BANKINFO INITIAL(MAINI)
IN BM6 .
@EOF
@XQT RB$.ABS
4.7. BDI and Entry-Point Definitions
Internally, the Collector recognizes two types of definitions for BDIs and entry points as
follows:
• Absolute values
BDIs or entry points that have been equated to a value.
• Values defined by Collector
For BDIs, these are the BDIs assigned by the Collector to the banks in the collection.
For entry points, these are also known as relative values or values that are relative to
a location counter.
BDIs of all alternate file common banks are defined in CERU$ or in individual CBEP$$
elements. In addition, entry-point absolute values for use with IBJ$ are defined in
4–28 7830 9887–001

Banking
relocatable elements in compiler libraries that have CBEP$$ as the first 6 characters of
their name. This naming convention allows the use of common banks to be detected so
their BDIs can be placed in a list in the absolute element. When the absolute element is
loaded, the Exec can ensure that any common banks referenced are available. You can
also define banks and entry points using absolute values; however, you should follow the
above naming conventions.
Absolute values must be defined as follows:
bank-name* $EQU bdi
ep-name* $EQU bdi*/18+ep-value
The fields bdi and ep-value can be either a nonrelocatable number or an external
reference (for example, a bank name). However, in each bdi*/18+ep-value, at least one
of the fields must be a nonrelocatable number.
The Collector expects the BDI to be in H2 of the absolute value when processing
BDIREF$ and LBDIREF$ and to be in H1 when processing BDICALL$ and LBDICALL$
for an entry point.
Because of this difference, you must use the following command to obtain the BDI for a
bank defined as an absolute value:
LXI,U X11,BDIREF$+bank-name
You must use the following command to obtain the BDI for a bank containing an entry
point defined as an absolute value:
LXI,U X11,BDICALL$+ep-name
When defining the BDIs of common banks in a CBEP$$ element, the appropriate format
must be used (see 6.6). Level 1 is used for alternate file common banks (AFCB). The
formats are:
• For basic mode:
bank-name* $EQU 0400103 . AFCB BDI
entrypt* $EQU 0400103001000 . entry point
• For extended mode:
embank-name* $EQU 0200103 . AFCB BDI
ementrypt* $EQU 0200103001000 .entry point
• For either mode:
MAPBDT$+bankname
BDT level and BDI for the bank named. The BDT level is determined by the Collector
using the appropriate format. If the referencing bank is an extended mode bank, the
extended mode format (L) is used. If the referencing bank is a basic mode bank, the
basic mode format (E,LS) is used. (See 6.6.) MAPBDT$+bankname is useful for
basing program data banks to be used by a program.
7830 9887–001 4–29

Banking
4.8. Use of BANKINFO AFCB
The BANKINFO directive simplifies the creation of integrated AFCB absolutes. Before
the BANKINFO AFCB(bankname,bdi) attribute was available, you had to package
programs running with or as AFCBs so that the AFCB banks were handled separately
from local banks (such as D-banks). This meant that the AFCB banks were collected
separately from the local banks, and the BDI relationships were defined by entry points
in a CBEP$$ element.
The BANKINFO directive allows you to specify the configured BDI to be used to
reference an AFCB bank within a collection. A reference to an AFCB bank name then
produces the correct BDI for referencing the bank, in the same manner as for local
banks.
User programs that reference an AFCB and do not create it still need a CBEP$$ element
to define the BDIs. This is because AFCBs are not collected as banks within the user
program’s absolute. The AFCB can be considered an external reference from the user
program, not part of it, so the BDIs are needed only by the user programs.
The Collector obtains the common bank BDI value for references to entry points in a
common bank for the following Collector-defined symbols: BDI$, BDIREF$, BDICALL$,
LBDI$, LBDICALL$, LBDIREF$, and MAPBDT$. The Collector assumes Level 1 for a
bank created with a BANKINFO AFCB(bankname,bdi) directive. All common banks are
maintained at Level 1 (see 6.6). For more information on common banks, refer to the OS
1100 Exec System Software Common Banks Programming Guide.
If a bank list is necessary, the name specified on the BANKINFO directive should be
used, not the name on the BANK directive.
Example 1
ep* Res 1
.
.
.
MYFILE.CALL
LXI,U X11,BDICALL$+EP
.
.
.
LXI,U X11,BDIREF$+EP
.
.
.
LXI,U X11,LBDICALL$+EP
.
.
.
LXI,U X11,LBDIREF$+EP
4–30 7830 9887–001

MYFILE.BDI
.
.
.
MYFILE.MAPBDT
MYFILE.MAP
LXI,U X11,BDI$
.
.
.
LXI,U X11,LBDI$
.
.
.
LXI,U X11,MAPBDT$+CBNAME3
.
.
.
IBANK I1
BANKINFO AFCB(CBNAME,0400444)
IN MYFILE.EP
IBANK I2
BANKINFO INITIAL(MAINI)
IN MYFILE.CALL
DBANK D1
BANKINFO CONTROL,INITIAL(MAIND)
END
Resolutions of the BDI value:
BDICALL$ = 0400444
BDIREF$ = 0400444
LBDICALL$ = 0200444
LBDIREF$ = 0200444
Banking
CBNAME is the name of the common bank. Use this name to install the common bank
with COMUS. I1 becomes an entry point with an absolute value of 0400444.
Example 2
IBANK I1
BANKINFO AFCB(CBNAME2,0400555)
IN MYFILE.BDI
DBANK D2
BANKINFO CONTROL,INITIAL(MAIND)
END
7830 9887–001 4–31

Banking
Resolutions of the BDI value:
BDI$ = 0400555
LBDI$ = 0200555
Example 3
IBANK I1
BANKINFO AFCB(CBNAME3,0400666)
IBANK I2
IN MYFILE.MAPBDT
DBANK D1
BANKINFO CONTROL,INITIAL(MAIND)
END
Resolution of the BDI value:
MAPBDT$ = 0400666
The basic mode format is used since I2, the referencing bank, is a basic mode bank.
Example 4
IBANK I1
BANKINFO AFCB(CBNAME3,0400333)
IBANK I2
BANKINFO EXTENDED
IN MYFILE.MAPBDT
DBANK D1
BANKINFO CONTROL,INITIAL(MAIND)
END
Resolution of the BDI value:
MAPBDT$ = 0200333
The extended mode format is used since I2, the referencing bank, is an extended mode
bank.
The following is an example that shows the distinctions between the CBEP$$
mechanism and the BANKINFO mechanism.
Elements
CBEP$$ element
CB1* EQU 0400444
CB2* EQU 0400555
EP0* EQU 0400444001000
EP1* EQU 0400444001001
EP2* EQU 0400555001000
EP3* EQU 0400555001001
4–32 7830 9887–001

MYFILE.CALL
LXI,U X11,BDICALL$+EP0
.
.
.
LXI,U X11,BDICALL$+EP3
.
.
.
MYFILE.JUMPVECTOR
JV1* J ABC
JV2* J DEF
.
.
.
MYFILE.JUMPVECTOR2
JV3* J GHI
JV4* J JKL
.
.
.
Here is a collection to create common banks (before BANKINFO):
TYPE COMMONBANK
IBANK,DR I1,01000
FRSTIN MYFILE.JUMPVECTOR
IN -----
IBANK,DR I2,03000
FRSTIN MYFILE.JUMPVECTOR2
IN -----
IBANK,DV I3
IN MYFILE.CALL
DBANK,DCV D1
IN CBEP$$xxx
IN -----
END
Here is a collection to execute common banks (before BANKINFO):
IBANK,XM CB1
IBANK,XU CB2
IBANK,DV I1,01000
FRSTIN MYFILE.JUMPVECTOR
IN -----
IBANK,DV I2,03000
FRSTIN MYFILE.JUMPVECTOR2
IN -----
Banking
7830 9887–001 4–33

Banking
IBANK,D I3
IN MYFILE.CALL
DBANK,DCM D1
IN CBEP$$xxx
IN -----
END
Description of CBEP$$ mechanism
The COMUS INSTALL command associates the bank name with these BDI values:
I1 – 0400444
I2 - 0400555
The names used to reference the bank, however, are given by the CBEP$$ definitions of
CB1 and CB2.
Here are the resolutions of the element CALL by the CBEP$$ element:
LXI,U X11,BDICALL$+EP0 => 0400444001000
LXI,U X11,BDICALL$+EP3 => 0400555001001
Following is the collection to create and execute the common bank using BANKINFO:
TYPE COMMONBANK
IBANK I1,01000
BANKINFO DYNAMIC,READONLY,AFCB(CB1,0400444),INITIAL(MAINI)
FRSTIN MYFILE.JUMPVECTOR
IN -----
IBANK I2,01000
BANKINFO DYNAMIC,READONLY,AFCB(CB2,0400555) ,INITIAL(UTILI)
FRSTIN MYFILE.JUMPVECTOR2
IN -----
IBANK I3
BANKINFO DYNAMIC
IN MYFILE.CALL
DBANK D1
BANKINFO DYNAMIC,CONTROL,INITIAL(MAIND)
IN -----
END
Description of BANKINFO mechanism:
The COMUS INSTALL command associates the bank name with these BDI values:
CB1 – 0400444
CB2 - 0400555
These AFCBs can now be referenced by the bank name (CB1 and CB2), so that the
CBEP$$ definition is unnecessary.
Here are the resolutions of the element CALL by the Collector:
4–34 7830 9887–001

LXI,U X11,BDICALL$+EP0 => 0400444+001000
LXI,U X11,BDICALL$+EP3 => 0400555+001001
Banking
No CBEP$$ element is necessary. The INITIAL attribute causes the common bank rather
than the local bank, to be initially based at initial load time.
4.9. MAPCALL$, MAPGOTO$, and the VECTOR
Attribute
The Collector provides an assembler procedure, MAP$CALLGOTO, which generates the
Collector-defined tags MAPCALL$ and MAPGOTO$. The user-visible interface is as
follows:
MAPGOTO$ e
MAPCALL$ e
where e is an external entry point or tag relocated by a location counter + offset.
4.9.1. MAPCALL$
Basic Mode Output
The MAPCALL$ procedure entry generates the respective output words for basic mode:
MI$ FORM 10,4,4,2,16
LXI,U X11,BDIVECT$
MI$ MAPCALL$,0,0,0,e
where:
MAPCALL$
is an XREF that can be specifically recognized by the Collector. The function is similar
to IBJ$/DBJ$/BBJ$.
BDIVECT$
is a Collector-defined tag that is resolved by the Collector to the BDI value of the link
vector bank.
Extended Mode Output
The MAPCALL$ procedure entry generates the respective output word for extended
mode:
MI$ FORM 10,4,4,2,16
MI$ MAPCALL$,0,0,0,e
where MAPCALL$ is an XREF that can be specifically recognized by the Collector. The
function is similar to IBJ$/DBJ$/BBJ$.
7830 9887–001 4–35

Banking
4.9.2. MAPGOTO$
Basic Mode Output
The MAPGOTO$ procedure entry generates the respective output words for basic
mode:
MI$ FORM 10,4,4,2,16
LXI,U X11,010000+BDIVECT$ . 010000 sets the
MI$ MAPGOTO$,0,0,0,e . IS field to 1
where:
MAPGOTO$
is an XREF that can be specifically recognized by the Collector. The function is similar
to IBJ$/DBJ$/BBJ$.
BDIVECT$
is a Collector-defined tag that is resolved by the Collector to the BDI value of the link
vector bank.
Extended Mode Output
The MAPGOTO$ procedure entry generates the respective output word for extended
mode:
MI$ FORM 10,4,4,2,16
MI$ MAPGOTO$,0,0,0,e
where MAPGOTO$ is an XREF that can be specifically recognized by the Collector. The
function is similar to IBJ$/DBJ$/BBJ$.
4.9.3. MAP$CALLGOTO
The procedure provided by the Collector, MAP$CALLGOTO, performs some assemblytime
error detection on parameter e. Errors (E flags) are generated at assembly time if
the parameter e has
• No relocation attached
• A form attached
• Multiple relocation attached
Each user entry point or tag with relocation by location counter + offset that occurs in
the same word as MAPCALL$ or MAPGOTO$ receives special handling.
MAPCALL$
If the target location is in a different bank than the MAPCALL$ word and the
referencing bank is an extended mode bank, an operation code, op code (f-j-a), for
4–36 7830 9887–001

Banking
the CALL instruction is provided. The target location receives link vector processing.
The offset into the link vector for the entry point and the B (and X) register from the
BANKINFO directive are used to complete the instruction.
See 4.10 for more information about link vector processing.
If the target location is in a different bank than the MAPCALL$ word and the
referencing bank is a basic mode bank, an op code for the LBJ instruction is
provided. The target location receives link vector processing. The Collector fills in the
u field with the offset into the GOTO list in the link vector bank. The GOTO list is
described in later paragraphs.
If the target location is in the same bank as the MAPCALL$ word and the
referencing bank is an extended mode bank, an op code for the LOCL instruction is
provided. The target location does not receive link vector processing. The actual
address of the target location is used to complete the instruction.
If the target location is in the same bank as the MAPCALL$ word and the
referencing bank is a basic mode bank, then processing depends on whether the
collection is TYPE EXEC. If the collection is not TYPE EXEC, an op code for the LMJ
instruction is provided. The target location does not receive link vector processing.
The actual address of the target location is used to complete the instruction. For
TYPE EXEC collections, an op code for the LBJ instruction is provided. The target
location receives link vector processing. The Collector fills in the u field with the
offset into the GOTO list in the link vector bank.
MAPGOTO$
If the target location is in a different bank than the MAPGOTO$ word and the
referencing bank is an extended mode bank, an op code for the GOTO list is
provided. The target location receives link vector processing. The offset into the link
vector for the entry point and the B (and X) register from the BANKINFO directive are
used to complete the instruction.
If the target location is in a different bank than the MAPGOTO$ word and the
referencing bank is a basic mode bank, an op code for the LBJ instruction is
provided. The target location receives link vector processing. The Collector fills in the
u field with the offset into the GOTO list in the link vector bank.
If the target location is in the same bank as the MAPGOTO$ word and the
referencing bank is an extended mode bank or a basic mode bank, an op code for J
is provided, but the target location does not receive link vector processing. The 16-bit
basic mode address of the target location is used to complete the instruction.
Table 4-4 summarizes reference resolutions with MAPCALL$ and MAPGOTO$.
7830 9887–001 4–37

Banking
Table 4–4. MAPCALL$ and MAPGOTO$ Resolutions
Resolution
MAPCALL$
Different bank
MAPCALL$
Same bank
MAPGOTO$
Different bank
MAPGOTO$
Same bank
CALL
Referencing bank is
extended mode
lv processing offset into lv B
and X register
LOCL
address of e
GOTO
lv processing offset into lv B
and X register
J (extended mode)
address of e
4.10. Link Vector Processing
Referencing bank is
basic mode
4–38 7830 9887–001
LBJ
lv processing offset into
goto list
LMJ
address of e
LBJ - TYPE EXEC
lv processing offset into
goto list
LBJ
lv processing offset into
goto list
J (basic mode) address of
e
If link vector processing is needed, the Collector assigns a link vector offset and a B (and
X) register to the entry point. These values are then used to complete the instruction
being built and the link vector.
The link vector contains the L,BDI, OFFSET virtual address of the target location. If there
are any basic mode banks, the link vector is doubled in size. The second half is the
GOTO list, and contains GOTO instructions, which point to the respective entries in the
first half of the link vector by using the B (and X) register specified on the BANKINFO
directive.
The first B (and X) register specified on the BANKINFO directive is used for the first 4096
link vector entries created, the second B (and X) register is used for the next 4096, and
so forth. If the number of B registers needed is greater than the number of B registers
supplied, an error occurs. The same B register specification is used for the second half of
the link vector used for basic mode, which also starts on a 4096-word boundary.
Only one BANKINFO directive specifying a link vector bank per collection is allowed. If
more than one is specified, an error message is printed.
The link vector is always allocated on 4K boundaries. Each 4K boundary associates with a
B register specified on a BANKINFO directive with the VECTOR attribute specified.
The upper limit of the link vector bank must be less than 65K if addressed by a basic
mode bank.

Banking
The link vector bank must be a noninitially based extended mode dynamic bank. The
Collector internally sets the bank as extended mode and dynamic. The user can specify
that the bank is dynamic, extended, read-only, or overridden minimum address by
specifying the D, N, R, or O options respectively on the BANK directive or by specifying
the DYNAMIC, EXTENDED, READONLY or OVERRIDEMIN attributes on the BANKINFO
directive.
7830 9887–001 4–39

Banking
4–40 7830 9887–001

Section 5
Program Parameter Specification
5.1. TYPE Directive
Purpose
The TYPE directive is used to specify conditions in the created absolute element.
Format
TYPE parameter-1,parameter-2,...,parameter-n
The parameters are described in Table 5-1. Please note that the parameters can appear
in any order on the TYPE directive table 5-1.
Table 5–1. Parameters Specified with the TYPE Directive
Parameters Description Use of Parameters by TYPE Directive
SETAFCM Set arithmetic fault
compatibility mode for the
absolute or relocatable
element (set PSR D20 at
initial load). See 5.3.
CLRAFCM Set arithmetic fault
noninterrupt mode for the
absolute or relocatable
element (clear PSR D20 at
initial load). See 5.3.
INSAFCM Set the absolute or
relocatable element to ignore
the setting of SETAFCM and
CLRAFCM. See 5.3.
Parameters SETAFCM, CLRAFCM, and
INSAFCM override any related indicators
present in the individual relocatable
elements included in the collection.
Parameters SETAFCM, CLRAFCM, and
INSAFCM override any related indicators
present in the individual relocatable
elements included in the collection.
Parameters SETAFCM, CLRAFCM, and
INSAFCM override any related indicators
present in the individual relocatable
elements included in the collection.
7830 9887–001 5–1

Program Parameter Specification
Table 5–1. Parameters Specified with the TYPE Directive
Parameters Description Use of Parameters by TYPE Directive
BLOCKSIZE64
Set bank sizes in the absolute
element to 64-word
multiples.
COMMONBANK Suppress certain error
messages regarding the start
address during commonbanked
collections.
When BLOCKSIZE64 is specified on the
TYPE directive, all banks of the program
will have their sizes stored in the bank
load table of the absolute element in 64word
blocks. In the absence of the
BLOCKSIZE64 specification, sizes will be
stored in 512-word blocks. For all basic
mode banks, either block size can be
used; however, Exec main storage use
will be improved if TYPE BLOCKSIZE64
is used. For all extended mode
architecture extended mode banks, TYPE
BLOCKSIZE64 is required by the
hardware if the activity local storage or
the return control stack is used. The
CALL instruction uses both. The values
of the Collector-defined symbols,
BLOCKSIZE$, LASTR$, LASTIR$, and
LASTDR$, are also affected by this
parameter.
When COMMONBANK is specified on
the TYPE directive, certain annoying error
messages are suppressed. The error
messages indicate a situation that
intentionally exists when performing
COMMONBANK collections. The
suppression of these messages resolves
some anxiety that often exists when
using an absolute that supposedly
contains errors. However, do not use this
directive to suppress the error messages
unless they should be suppressed.
5–2 7830 9887–001

Program Parameter Specification
Table 5–1. Parameters Specified with the TYPE Directive
Parameters Description Use of Parameters by TYPE Directive
COMSEG Include all text for a common
block in the segment that the
COMMON block is attached
to.
EXEC Allow use of special
directives for the collection of
the Exec.
EXTDIAG Produce extended diagnostic
tables for the absolute
element.
Location counters from many elements
define text included in a common block.
These location counters can be placed in
different segments. The segment at the
common point of the other location
counters contains the actual area to be
occupied by the common block. The
loading of one of the segments
containing text for the common block
causes reinitialization of part of the
common block.
The presence of the COMSEG parameter
causes all location counters defining text
for a common block to be included in the
same segment as the common block
area, thus avoiding any reinitialization of
the common block unless that segment
is reloaded. This parameter is valid only
for bank-named collections. See F.5.
With the introduction of the extended
mode architecture systems, additional
bank descriptor table levels were
defined. The Exec expects to find its
banks at a higher level of the BDT. (See
6.6). When EXEC is specified on the
TYPE directive, the Collector sets up this
default level for the collection and
provides additional special processing.
See Appendix A.
Within the absolute element’s diagnostic
tables, the normal entry-point name table
contains only referenced entry points.
The absolute value table contains only
referenced absolute entry points and
does not include any absolute entry
points defined in the elements ERU$ or
CERU$. The specification of EXTDIAG
prevents any of these exclusions so that
all entry points from all the elements are
included in these diagnostic tables.
7830 9887–001 5–3

Program Parameter Specification
Table 5–1. Parameters Specified with the TYPE Directive
Parameters Description Use of Parameters by TYPE Directive
IBJLNK
elementname,address
Extend the use of the
BDICALL$/IBJ$ feature to
allow collection time
definition. element-name is
the name of an element
included in the collection and
address is a symbol or
numeric value representing
an address in the absolute
element. If address is a
symbol, it does not cause
automatic inclusion of an
element from a file named on
a LIB directive.
NPEDIAG Provide the capability to use
the NPE DIAG$ format in
dumps generated for mixed
mode absolutes.
QUARTER Mark the output absolute,
relocatable, or symbolic
element quarter-word
sensitive (set PSR D10 (D32
on the 1100/90 system) at
initial load). See 5.4.
The values specified for element-name
(which must be included in the collection)
and address are used in satisfying
references to BDICALL$ and IBJ$. When
a reference to BDICALL$+label is found
and if label is defined in element-name,
the value of label is used to satisfy the
reference.
Since BDICALL$ always takes the BDI
from H1 of a 36-bit absolute value, label
as defined in element-name must also be
a 36-bit absolute number with the
required value in the upper 18 bits. When
a reference such as IBJ$ X11, label is
used and label is defined in elementname,
the instruction generated is LMJ
X11,address. (See 4.5.5)
The Collector provides an indicator in the
Absolute Header Table of an absolute.
This indicator will cause the operating
system to create a dump as though it
came from an "Object Module-Based
Program." When any activity of such an
absolute terminates abnormally
(restricted to activity abnormal
termination), only the activity local banks
are written to the DIAG$ file. The last
activity to terminate will write all program
local banks to the DIAG$ file. (Refer to
the Exec System Software Executive
Requests Programming Reference
Manual section for additional information
describing the operating system action
concerning this absolute indicator.)
This parameter is equivalent to the F
option on the @MAP statement. If the F
or T options are specified, they override
any TYPE QUARTER directives found. If
more than one TYPE QUARTER or TYPE
THIRD directive is found, the first one
found is used.
5–4 7830 9887–001

Program Parameter Specification
Table 5–1. Parameters Specified with the TYPE Directive
Parameters Description Use of Parameters by TYPE Directive
THIRD Mark the output absolute,
relocatable, or symbolic
element third-word sensitive
(clear PSR D10 (D32 on the
1100/90 system) at initial
load). See 5.4.
READONLY Mark the I bank of a bankimplied,
unsegmented, readonly
absolute.
REALTIME All initial loads and reloads of
absolute elements of type
REALTIME are performed at
real-time request priority with
real-time positioning. This
does not affect processor
switching priority.
This parameter is equivalent to the T
option on the @MAP statement. If the F
or T options are specified, they override
any TYPE THIRD directive found.
If more than one TYPE QUARTER or
TYPE THIRD directive is found, the first
one found is used.
The I bank of this bank-implied,
unsegmented collection is marked readonly.
The R option on the IBANK directive
should be used for bank-named
collections.This directive is independent
of any read-only specifications (INFO 9)
contained in the input relocatables. See
4.2.4 for more information about the
INFO groups.
The parameter REALTIME is used to
designate an absolute element as realtime
for storage request purposes. The
switching level and real-time activity
count of the program are not affected
until the program does an ER RT$. The
storage priority of in-storage banks of the
program are always real-time, unless all
of the program’s activities are nonrealtime
and in a long-wait state, in which
case the in-storage banks are marked
long-wait and are able to be swapped.
This parameter has no effect if the user
executing the resulting program is not
authorized to use the real-time capability.
5.2. Absolute Element Arithmetic Fault Mode
Determination
The Collector marks the arithmetic fault mode of an absolute element or relocatable
element produced by the Collector in the following order of precedence:
1. If explicit sensitivity is given on the TYPE directive, the output element is marked
accordingly, regardless of the sensitivities of the input relocatable elements.
2. If all input relocatable elements have the same sensitivity, the output element is
marked with the sensitivity.
3. If both SETAFCM and CLRAFCM relocatable elements are present, the presence or
absence of INSAFCM for relocatable elements where the sensitivity is not specified
7830 9887–001 5–5

Program Parameter Specification
is irrelevant. In this case (both the SETAFCM and CLRAFCM relocatable elements
are present), the output element is marked with the sensitivity of the relocatable
element containing the program start address; if that element is marked INSAFCM
or if no starting address exists, the output element is marked UNKNOWN.
4. If SETAFCM relocatable elements are present in addition to INSAFCM and for
relocatable elements where the sensitivity is not specified, the output element is
marked SETAFCM.
5. If CLRAFCM relocatable elements are present in addition to INSAFCM and for
relocatable elements where the sensitivity is not specified, the output element is
marked CLRAFCM.
6. If INSAFCM and for conditions where sensitivity is not specified on relocatable
elements existing by themselves, the output element is marked UNKNOWN.
For more information on arithmetic fault compatibility mode, see the processor and
storage reference manual for your Series 1100 and 2200 systems.
5.3. Exec Action Produced by Absolute Element
The arithmetic fault mode sensitivity of the absolute element is used by the Executive in
determining the initial setting of PSR bit D20 on 1100/60, 1100/70, and 1100/80 systems
or bit DB29 on the extended mode architecture systems. For more information about
these bit settings, see the systems processor and storage reference manual for the OS
1100 system in use at your site. The following actions are taken by the Executive:
1. If the absolute element’s sensitivity is UNKNOWN, the system standard value set at
system generation is used.
2. If the absolute element’s sensitivity is SETAFCM, D20 (DB29) is initially set.
3. If the absolute element’s sensitivity is CLRAFCM, D20 (DB29) is initially cleared.
4. If the absolute element’s sensitivity is INSAFCM, D20 (DB29) is initially cleared.
5.4. Third- and Quarter-Word Sensitivity
If sensitivity is not specified by option or TYPE directive, program sensitivity is
determined as follows:
1. If only third-word sensitive elements and elements with neither T nor F sensitivity
are present, T is used.
2. If only quarter-word sensitive elements and elements with neither T nor F sensitivity
are present, F is used.
3. If both third-word and quarter-word sensitive elements are present, the sensitivity of
the element containing the program starting address as specified by the ENT
directive is used. If the ENT directive is not used, the absolute element is marked as
being not sensitive.
5–6 7830 9887–001

Section 6
Other Directives
6.1. COR — Corrections
Purpose
The COR directive specifies that a location in the absolute element is to be changed
without altering the corresponding location in the original relocatable element. A COR
directive can replace any text word with one of the following:
• An instruction word
• A data word
• A data word containing up to two symbols or values representing the upper and
lower halves of the word
Format
COR element-name
Where element-name specifies the element to which the corrections are to be made.
The correction data images that follow the COR directive can be in any one of the
following formats:
address,lc-1 f j a x h i u
address,lc-1 data-word
address,lc-1 data,lc-2 data,lc-3
where:
address,lc-1
specifies the relative address and location counter of the relocatable element to
which the corrections are being made.
f j a x h i u
specifies field values in instruction word format that are to be inserted. Blanks are
used to separate each part of the instruction correction. The u field can be
− A symbol
− A symbol and offset
7830 9887–001 6–1

Other Directives
− An address in the form integer,lc-2,element-name-1
data-word
data
specifies a numeric value.
specifies a symbol, symbol and offset, or integer correction.
lc-2, lc-3
specifies that the u- or data fields that are relative to the value of the specified
location counter. If omitted, the fields are assumed to contain absolute values.
element-name-1
specifies the element to which the location counter (lc-2) belongs; if omitted, the
element being corrected is assumed.
Description
The corrections contained in a COR directive are ignored if the R option was specified on
the @MAP statement. Any number of correction data images can follow the COR
directive.
COR directives cannot contain instructions that are jumps to any indirectly loaded
segment.
A symbol must be an externalized label.
In bank-named collections, a COR directive and its parameters can apply only to global
elements (see 4.4.4.1 and 4.4.4.2).
Example
1. COR ELT1
2. 000001,01 051 00 00 00 0 0 000011,01,ELT2
3. 000004,01 006 00 015 00 0 0 DUMMY+1
4. 000007,01 0000000000114
5. 000011,01 00000111 DUMMY+1
6. 000006,02 0000112,01 0000013
7. 000011,02 DUMMY+2
8. 000014,02 02,02 DUMMY+2
9. 000016,03 027 00 017 00 0 0 01176,02
Description
1. Corrections to the specified lines in element ELT1 are to be applied to the final
absolute element.
2. The word being collected under element ELT1 at relative address 01, location
counter 1, is modified to set the function code to 051, and the j, a, x, h, and i fields to
6–2 7830 9887–001

Other Directives
zero. The u field is given the value of 011 relative to location counter 1 of element
ELT2.
3. The word appearing at relative address 04 under location counter 1 of ELT1 is
modified to set the function code to 06, the a field to 015, and the u field to
DUMMY+1. The j, x, h, and i fields are set to zero.
4. The word appearing at relative address 07 under location counter 1 is changed to
contain 0114.
5. The word at relative address 011 under location counter 1 is changed to contain
0111 in H1 and DUMMY+1 in H2.
6. The data at relative address 06 under location counter 2 contains the following:
a. H1: 0112, relative to location counter 1 of ELT1
b. H2: 013
7. The data at relative address 011 under location counter 2 receives the value of
symbol and offset, DUMMY+2.
8. The data at relative address 014 under location counter 2 receives the data 02
relative to location counter 2 in H1, and the value of symbol DUMMY+2 in H2.
9. The instruction word appearing at relative address 016 under location counter 3
receives the function code 027, the a field 017, and the u field 01176, relative to
location counter 2 of ELT1. The j, x, h, and i fields are set to zero.
6.2. DEF — External Definition Retention
Purpose
In the collection of an absolute, each DEF directive label specified creates an entry in the
table ENTRY$, which is generated by the Collector.
In an R option collection, each label specified remains externalized in the resulting
relocatable element.
All DEF directive parameters are optional.
Format
DEF label-1,label-2,...,label-n
where label-i specifies the external definitions to be retained.
Description
The DEF directive is normally used in R option collections. In an R option collection, the
DEF directive causes the Collector to create an entry (for each specified label) in the
entry-point table of the preamble of the resulting relocatable element.
During an absolute collection, the DEF directive causes the Collector to build not only the
ENTRY$ table but also the common block table, COMMN$. Both tables can be accessed
7830 9887–001 6–3

Other Directives
by the user program through the Collector-defined symbols ENTRY$ and COMMN$.
COMMN$ is also built if the DEF directive is present with no parameters.
If the label specified on the DEF directive is not contained in any explicitly included
elements, a search of the library files is made to find an element in which the label is
defined.
6.3. END — End of Input
Purpose
The END directive specifies the end of the source language input for the Collector. The
END directive is optional. If not given, the end of Collector source language is indicated
by the next control statement.
Format
END
6.4. ENT — Starting Address Redefinition
Purpose
The ENT directive provides you with the capability of overriding any start addresses
provided by relocatable elements. Upon program initialization (@XQT or @processor call),
control is transferred to the absolute address of the named label.
Format
ENT name
where name must be an externally defined label.
Description
The absolute address of the label found with the ENT directive becomes the starting
address for the resultant absolute. In the absence of an ENT directive, the last start
address encountered in processing the relocatable elements becomes the program start
address. If start addresses are found in both explicitly and implicitly included elements,
the last explicitly included element is used. For compiled languages, a relocatable
element containing a start address usually corresponds to a main program.
The start address must be in the address range of an initially based bank. If there are
initially based common banks, the Collector may not be able to ascertain if the start
address is actually within the common banks. Thus, a warning message is printed even
though a TYPE COMMONBANK statement was included in the collection.
If the program contains segments, the start address must be contained in the main
segment as this is the only segment initially loaded at execution time.
6–4 7830 9887–001

6.5. EQU — External Reference Definition
Purpose
Other Directives
The EQU directive provides the means to assign, during the collection, a value to an
undefined symbol or to change the value of an external label.
All EQU directive parameters are optional except name-1/value-1.
Format
EQU name-1/value-1,name-2/value-2,...,name-n/value-n
where:
name-i
value-i
specifies the label to be defined.
is the value to be assigned to the preceding name-i parameter. Value-i can be
specified as follows:
− An integer
− A symbol (for example, BOB)
− A symbol with an offset (for example, BOB+4)
Description
Any symbol used in the value parameter must be a bank name, segment name, or
externally defined in one of the elements specified for inclusion in the collection. If you
use a bank name or segment name in the value parameter, the EQU directive must
appear after the BANK or SEG directive. Therefore, no search is performed on files
named on LIB directives. If an external label that duplicates an EQU name is found, the
value of the external label is the value found on the EQU line and a message is printed.
In bank-named collections, only global symbols can be used on the EQU directive (see
4.4.4.1 and 4.4.4.2). A bank or segment name should not be used as name-i and should
appear only once as value-i.
Example
EQU JOE/0200,ABE/SAM+10
The external references JOE and ABE are defined as 0200 8 and SAM+10 10 respectively.
6.6. LEVEL — Specifying the Bank Descriptor Table
(BDT) Level
Purpose
7830 9887–001 6–5

Other Directives
The LEVEL directive allows you to specify a BDT level for the collection. This value is
returned with the Collector-defined tags LBDI$, LBDICALL$, LBDIREF$, BDICALL$, and
BDIREF$.
The LEVEL directive was implemented when the Bank Descriptor Table was defined
with 4 levels of address space. Since then the definition of the Bank Descriptor Table
(BDT) has been expanded to 8 levels of address space called levels (L) 0-7. The level L is
intended to indicate scope, with L0 most global and L7 most local. In general, the
Collector LEVELs 0-3 still provide this capability matching the first 2 bits, where L = 0, 2,
4, and 6, of the possible 3 bits used to indicate the 8 levels L0-L7. The Collector LEVEL
directive does not provide the capability to indicate the odd L levels where L = 1, 3, 5,
and 7.
The default LEVEL for normal collections is 2 and for TYPE EXEC is 1.
Format
LEVEL value
where value must be an integer from 0 to 3.
Description
If multiple LEVEL directives are given in the collection, the last LEVEL directive overrides
all previous LEVEL directives.
The LEVEL directive is not allowed for R option collections.
Different values are associated with each BDT level that is used with the Collectordefined
symbols LBDI$, LBDICALL$, LBDIREF$, BDICALL$, and BDIREF$. Two formats
are used, one for basic mode (Collector symbols BDICALL$ and BDIREF$) and one for
extended mode (Collector symbols LBDI$, LBDICALL$, and LBDIREF$).
Extended mode format
L BDI OFFSET
0 2 3
Basic mode format
E BDR L
S
0 1 2 3 4 5 6
17 18
IS BDI OFFSET
17 18 35
Because of the extended mode and basic mode formats, different values for the BDT
level are associated with the Collector-defined symbols LBDI$, LBDICALL$, LBDIREF$,
6–6 7830 9887–001
35

Other Directives
BDICALL$, and BDIREF$. The following table shows the relationships between each
level and each format.
The L (Level) field of an extended mode virtual address was expanded from 2 bits to 3
bits to allow for the 8 levels of address space. The basic mode virtual address still has
only 2 bits (E and LS) to select the Bank Descriptor Table. Only the even L values
translate directly to E,LS values as seen in the Level diagram above. The odd L values (L
= 1, 3 ,5, and 7) are translated to E,LS = 1,1. Thus the Collector retains its original
implementation where the Collector levels 0-3 indicate the first 2 bits of the L field which
are the even L levels 0, 2, 4, and 6.
Collector LEVEL value (L bits 0,
1)
Basic Mode (E,LS):
bits 0,3
0 — System 1,1 0,0,0 (0)
1 — Application (TYPE EXEC) 1,0 0,1,0 (2)
2 — Program (default) 0,0 1,0,0 (4)
3 — Activity 0,1 1,1,0 (6)
Extended Mode (L):
bits 0,1,2
The Collector-defined symbols can be used in a basic mode or in an extended mode
program.
In an absolute element, the level of a bank is not specified. For absolutes that are
executed as programs, the Exec loads all banks produced by the Collector at level 2.
Alternate file common banks (AFCB) are further processed during COMUS installation to
have banks at level 1. Consequently, there is no provision for the creation of an activity
local bank (level 3) by the Collector within an absolute. Activity local banks must be
created dynamically and the Collector-defined tags can be used to appropriately
manipulate their BDIs for basing.
Programs that were constructed for systems without the extended mode architecture
enhancements use the basic mode virtual address. These programs always have the LS
field clear (zero). This means the virtual addresses with L=0 or L=3 are not available to
these programs.
You can override the LEVEL value for a specific bank by means of the IBANK/DBANK
directive or the BANKINFO directive. For more information, refer to 4.2.1 and 4.2.2.
6.7. MINGAP, MINSIZ — Absolute Element
Optimization
Purpose
The MINGAP and MINSIZ directives enable the user to modify the resultant absolute
element to minimize the I/O transfer time when the program is loaded for execution.
7830 9887–001 6–7

Other Directives
Format
MINGAP value
MINSIZ value
where value specifies any positive integer.
Description
One of the tasks of the Collector is to insert information into the absolute element that
describes how the absolute element is structured and how it is to be loaded into main
storage by the Exec loader. This information is conveyed by means of access control
words (ACW). ACWs have the following basic format:
Z length program start address for load
0 1 17 18 35
where:
length
Z
is the number of words to load.
if set, indicates that the loader is to zero-fill the area. ACWs with Z set are called
zero-fill ACWs. ACWs with Z not set are called text ACWs.
Program areas created by assembler RES directives or compiler array declarations do not
contain meaningful data or instructions at load time. Therefore, the Collector has two
alternatives when creating the ACW to describe the RES area:
1. The area could be zero-filled by the Collector.
This increases the size of the absolute element (affecting the mass storage
requirements of the element) and the number of words that must be transferred by
the loader when bringing the block of text into mass storage for execution.
2. The area could be left void by the Collector (bit 0 set in the ACW).
This decreases the size of the absolute element but increases the number of ACWs
used by the loader and, hence, the number of I/O operations needed to transfer the
element to main storage for execution.
The MINGAP and MINSIZ directives give the user control over the creation of the ACWs
as follows:
MINGAP
6–8 7830 9887–001

Other Directives
Any RES area greater than or equal to MINGAP words is left void. Any RES area less
than MINGAP words is zero-filled.
MINSIZ
This directive controls the minimum number of words to be transferred per ACW
(bits 1 through 17 of the ACW).
Both MINGAP and MINSIZ are initially set to 10. The Collector uses a combination of
MINGAP and MINSIZ to create the ACWs. In general, text ACWs always describe at
least MINSIZ words and zero-fill ACWs describe at least MINGAP words. If the length of
a text ACW is less than MINSIZ, enough words of the adjacent RES area are converted
by the Collector into text words of zeros so that the length of the text ACW equals
MINSIZ. If a RES area is less than MINGAP, it is merged with the two adjoining text
areas and filled with zeros.
Examples
All examples in this section assume MINGAP and MINSIZ = 10. The length in the ACW
is described in octal.
In example 1, the size of the text areas is less than MINSIZ (10). Five words from the
adjacent RES area are zero-filled and combined in the text ACW. Therefore, the zero-fill
ACW describes five words less than the original RES area.
7830 9887–001 6–9

Other Directives
In example 2, the Collector initially attempted to create an ACW for area 1 with the
following format:
000012 program address
This, however, left only five words in the RES area. Because 5 < MINGAP (10), the
Collector combined area 1, area 2, and area 3 into one ACW and zero-filled the RES area.
ACWs do not cross segment boundaries. If the text and RES areas of the main segment
do not reach to the end of a main storage block, the Collector creates a zero-fill ACW to
describe this area. If a RES area occurs at the end of the main segment, the Collector
does not combine the ACW describing the final RES area with the ACW describing the
area between the end of the user’s segment and the main storage block.
In this example, a main storage block is defined to be 512 or 64 words, depending on the
use of the TYPE BLOCKSIZE64 directive.
6.8. REF — External Reference Retention
Purpose
In the collection of an absolute, each REF directive label specified creates an entry in the
XREF$ table, which is generated by Collector.
6–10 7830 9887–001

In a R option collection, each label specified remains undefined in the resulting
relocatable element.
All REF directive parameters are optional.
Format
REF label-1,label-2,...,label-n
where label-i specifies the external references to be retained.
Description
Other Directives
During an absolute collection, the REF directive causes the common block table,
COMMN$, to be built in addition to the XREF$ table. Both can be accessed by the user
program by means of the Collector-defined symbols XREF$ and COMMN$. No attempt
is made to satisfy any references to the names indicated on REF directives. In an
absolute collection, all references are satisfied with the address of the third word of the
entry created in XREF$ for the label.
In an R option collection, the REF directive causes the Collector to create an entry (for
each specified label) in the external reference list of the preamble of the resulting
relocatable element. In an R option collection, all references to the names on the REF
directive are given relocation information.
If an external definition (entry point) that is identical to a REF name is encountered, a
message is printed and the external definition is ignored.
Example
REF VALUE1,VALUE2,SUBROUTINE4
In an absolute collection, the listed external references (VALUE 1, VALUE2, and
SUBROUTINE4) are retained after the collection in the XREF$ table of the resultant
element. Any references to these symbols are satisfied with the address of the third
word of the appropriate entry in the XREF$ table.
In an R option collection, the listed labels are placed in the external reference list of the
preamble.
6.9. SNAP — Snapshot Dumps
Purpose
The SNAP directive specifies the elements in which a snapshot dump is to be taken. The
snap data images immediately following the SNAP directive specify the address within
the element where the snapshot dump is to be taken, the length of the dump, and the
frequency of the dump.
All data image parameters are optional except address-1, lc-1, address-2, and length.
7830 9887–001 6–11

Other Directives
Format
SNAP element-name
where element-name specifies the element name where the dump is taken.
The SNAP data image format is as follows:
address-1,lc-1 address-2 length,registers times,frequency
where:
address-1,lc-1
specifies the address and the location counter within the relocatable element of the
instruction at which the snap request (SLJ SNAP$$) is placed. This field cannot
contain a symbol.
address-2
length
specifies the starting address of the program area to be dumped. This field can be in
the form address, location-counter, element-name, or symbol + offset.
specifies the length in words of the program area to be dumped.
registers
times
specifies which registers are to be dumped. The following codes are used:
00 No registers dumped
01 Only R registers dumped
02 Only A registers dumped
03 Both A and R registers dumped
04 Only X registers dumped
05 Both X and R registers dumped
06 Both X and A registers dumped
07 X, A, and R registers dumped
specifies the maximum number of times the snapshot dump is to be taken. If
omitted, the value of decimal 100 is assumed.
6–12 7830 9887–001

frequency
Other Directives
specifies at what frequency of reference the dump is to be taken. If omitted, the
value 1 (which dumps every time the SNAP directive is encountered) is assumed.
Description
No more than 16 snapshot dumps can be requested in any one collection. If more than
one snapshot of the same element is to be taken, multiple data images can follow the
SNAP directive.
When the dump request instruction SLJ SNAP$$ is inserted at the specified address, the
instruction appearing there is placed in a table in element SNAP$. After the dump is
taken, the saved instruction is executed from within the SNAP$ element as if it had not
been moved. If the saved instruction is a jump instruction, control transfers immediately
to the location specified in the jump instruction; otherwise, control is transferred to the
location following the location from which the SNAP$ element was called. Because the
replaced instruction is executed from within the SNAP$ element, the replaced
instruction must not be
• Altered during program execution
• Referenced as data or by indirect addressing
• An SLJ instruction that specifies indirect addressing or indexing
• An LMJ instruction that specifies indirect addressing or indexing
• An LIJ, LDJ, or LBJ instruction
• An EX instruction that references an LMJ or SLJ instruction
• A test and skip instruction
• Used in reentrant code
In a bank-named collection, the SNAP directive and its parameters can apply only to
global elements and entry points. The SNAP$ element must be entirely included in the
control bank.
Example 1
1. SNAP LARK
2. 010,1 012,1 020,07 0200,010
Description
A snapshot dump is taken in element LARK. Line 2 gives the parameters for the dump.
The instruction at address 010 under location counter 1 is the location where the
snapshot request is placed. The address 012 under location counter 1 is the starting
address of the dump. Sixteen locations in main storage are dumped along with the
contents of the A, X, and R registers. The dump is to be taken a maximum of 128 times,
but only once every eighth reference.
Example 2
7830 9887–001 6–13

Other Directives
1. SNAP JACK
2. 0132,02 HAH+2 256,4
Description
A snapshot is to be taken in element JACK. Line 2 specifies that the instruction at
location 0132 under location counter 2 is the location where the snapshot request is
placed. The address HAH+2 (where HAH must be externally defined) is the starting
address of the dump. The contents of the X registers and 256 or 0400 main storage
locations are to be dumped. Since the times and frequency parameters are not specified,
the system assumes a value of 100 for times and 1 for frequency. The common block is
initialized every time a segment containing the text defining the common block is loaded.
If all the text defining the common block is in the same segment, the common block is
initialized to only one set of the values.
6.10. WINDOW — Creation of 4K Windows
Purpose
The WINDOW directive is used to create 4K windows into a bank and to specify which
base/index register is associated with a particular 4K window.
Format
WINDOW [address] (Bn[,Xn] [Bn[,Xn]] ...) [[address] (Bn[,Xn] [Bn[,Xn]] ...)] ...
where:
address
Bn
Xn
is an externally defined tag defined within the bank, an absolute value (for example,
defined on Collector EQU directive), or a numerical value. The value must be
preceded with a 0 for the value to be octal.
indicates B register 2 to 15 or indicates B register 2 to 31 for TYPE EXEC.
indicates X register 1 to 15.
Description
Each base/index register pair targets consecutive 4K windows in the bank associated
with the WINDOW directive. The first pair points to the address specified. If no address
is specified, the start address of the bank is used.
An absolute value or a numerical value can be used to begin the bank at any address for
a specified base register or set of base registers. This address may or may not fall within
the bank limits. It is your responsibility to properly use this capability. Also, an address
6–14 7830 9887–001

Other Directives
specification of zero does not maintain the Collector generated addresses within the
confines of the base registers provided. However, Collector does issue an error when an
externally defined tag is not defined within the bank limits and used as the address on
the WINDOW directive.
The Collector intercepts low order, 12-bit relocation (d field) by XREF or LC+offset, and
checks if the final relocated address is within a window. If the B register field is zero in
the instruction, then the appropriate B register from the WINDOW directive is used. (The
Collector cannot distinguish between B0 and no B register specified. Therefore, the
WINDOW directive treats register B0 and no B register as no B register specified.) The
window directive treats the X register field in the same way.
The 12-bit field obtains the address of the referenced tag minus the start address of the
corresponding 4K window. If no WINDOW directive is found, the Collector performs
normal relocation and error checking.
Absolute value entry points are not considered relocated; thus, no B or X register
substitution occurs for references to absolute value entry points.
A warning is issued if the WINDOW directive is used in a bank that is not marked as an
extended mode bank and the collection is not TYPE EXEC.
If any WINDOW directives are present, the SEG directive cannot be used.
If a 12-bit field is relocated by multiple relocation, each part must be defined in the same
bank for window processing to be performed.
You are responsible for basing the B register at the address specified on the WINDOW
directive.
You are also responsible for overlapping problems if more than one window is specified
for a bank. The Collector uses the first base/index pair specified on the WINDOW
directive that contains the relocated value.
Example 1
IBANK NAME,01000
WINDOW (B3 B4,X4) tag2(B5)
IN -----
For this example, the bank limits are 01000 to 040000. Tag2 has a value of 022000.
The first window starts at the beginning of the bank because no address was specified.
The second window starts 4K after the first. The third window starts at tag2.
Window 1 01000 to 010777, B3
Window 2 011000 to 020777, B4,X4
Window 3 022000 to 031777, B5
7830 9887–001 6–15

Other Directives
If a 12-bit field is encountered and the tag it references has a value of 02000, the
Collector uses window 1. B3 is used in the instruction, with an offset value of 01000
(02000-01000) for the 12-bit field.
If a 12-bit field is encountered and the tag it references has a value of 021500, the
Collector cannot find a window with the value 021500 in its range. Normal relocation is
performed, which causes a truncation error to occur.
Example 2
For this example the same map symbolic is used and the bank limits remain the same,
but tag2 has a value of 020000.
Window 1 and 2 remain the same. Window 3 now has a different range.
Window 1 01000 to 010777, B3
Window 2 011000 to 020777, B4,X4
Window 3 020000 to 027777, B5
If a 12-bit field is encountered and the tag it references has a value of 020500, the
second window is chosen by the Collector. B4 and X4 are used in the instruction, and
the 12-bit field receives a value of 07500 (020500-011000).
The Collector searches the windows in the order they are specified on the WINDOW
directive. It simply checks to see if the address being relocated is in the range of the
window.
Assume the following WINDOW directive:
WINDOW tag2(B5) (B3 B4,X4)
If tag2 had a value of 020000, the windows would be as follows:
Window 1 020000 to 027777, B5
Window 2 01000 to 010777, B3
Window 3 011000 to 020777, B4,X4
If a 12-bit field is encountered and the tag it references has a value of 020500, the first
window is used. (Window 1 here is window 3 in the previous example.) B5 would be
used in the instruction and the 12-bit field would receive a value of 0500 (020500-
020000=0500). The third window is nearly useless. Only 07000 words can actually be
seen by the Collector, 011000 to 017777 (020000 to 020777 is not visible).
6–16 7830 9887–001

Other Directives
7830 9887–001 6–17

Other Directives
6–18 7830 9887–001

Section 7
Collector-Defined Symbols
References to the following symbols are satisfied by the Collector during the collection:
BBJ$
BDI$
Same as IBJ$ except that LBJ is generated in place of LIJ (see 4.5.2 and 4.5.4).
Bank descriptor index (BDI) for the bank in which the reference is made (see 4.5.4).
BDICALL$
Same as BDIREF$, unless the collection is bank-implied or the reference is in the
same bank in which the label is defined. In these cases, the value is zero. If the value
of the associated label is an absolute 36-bit number, the upper 18 bits are used (see
4.5.3 through 4.5.6). Thus, for an entry point, the BDI is expected to be in H1.
BDIREF$
BDI for the bank in which the associated label is defined (see 4.5.4).The BDI is
expected to be in H2 of the absolute value.
BDIVECT$
BDI value of the link vector bank created by the BANKINFO directive with the
VECTOR attribute specified.
BLOCKSIZE$
Number of words in a main storage block (normally 512; 64 if TYPE BLOCKSIZE64
was used).
COMMN$
DBJ$
D$ATE
First address of the common block table (see 6.2 and 6.8).
Same as IBJ$ except that LDJ is generated in place of LIJ (see 4.5.1 and 4.5.4).
7830 9887–001 7–1

Collector-Defined Symbols
The date, in TDATE$ format (upper 18 bits), that the absolute element was created.
ENTRY$
FIRST$
First address of the entry-point table (see 6.2).
Lowest address assigned to the bank in which the reference is made.
FIRSTBDI$
Symbol that returns the number specified on the FIRSTBDI directive. If no FIRSTBDI
directive is given, the Collector uses the default value of 4.
FRSTD$
FRSTI$
IBJ$
LAST$
Lowest D bank address assigned to the program.
Lowest I bank address assigned to the program.
Used in the f and j fields of an instruction. The LIJ operation code is put in the f and j
fields if the tag in the u field of the instruction is an absolute value or is defined in a
bank other than that in which the reference is made, except for bank-implied
collections. The LMJ operation code is put in the f and j fields if the collection is
bank-implied, or the tag in the u field is defined in the same bank as that in which the
reference is made (see 4.5.1, 4.5.2, and 4.5.6).
Highest address assigned to the bank in which the reference is made, including
dynamic segments.
LASTD$
Highest D bank address assigned to the program, including dynamic segments.
LASTDR$
LASTI$
Same as LASTD$, rounded to the end of the main storage block.
Highest I bank address assigned to the program, including dynamic segments.
LASTIR$
Same as LASTI$, rounded to the end of the main storage block.
7–2 7830 9887–001

LASTR$
LBDI$
Same as LAST$, rounded to the end of the main storage block.
Collector-Defined Symbols
BDI for the bank in which the reference is made, with the BDT level bits set (see
4.6.1 and 6.6).
LBDICALL$
Same as LBDIREF$, unless the collection is bank-implied or the reference is in the
same bank in which the label is defined. In these cases, the value is zero. If the value
of the associated label is an absolute 36-bit number, the upper 18 bits are used. The
BDT level bits are set (see 4.6.1 and 6.6).
LBDIREF$
BDI for the bank in which the associated label is defined. If the value of the
associated label is an absolute 36-bit number, then the lower 18 bits are used (H2).
The BDT level bits are set (see 4.6.1 and 6.6).
MAPBDR$
BDR for the bank in which the associated label is defined (see 4.5.3).
MAPBDT$
Bank descriptor table (BDT) level and BDI for the named bank. If the referencing
bank is an extended mode bank, the extended mode format is used. If the
referencing bank is a basic mode bank, the basic mode format is used (see 4.7 and
6.6 ).
MAPCALL$
Symbol that flags the Collector for link vector processing and to create instructions.
See 4.9.
MAPGOTO$
SLT$
T$IME
XREF$
Flags the Collector for link vector processing and to create instructions. See 4.9.
First address of the segment load table.
The time, in TDATE$ format (lower 18 bits), that the absolute element was created
Compare with D$ATE.
7830 9887–001 7–3

Collector-Defined Symbols
First address of the external reference table (see 6.8).
D$ATE and T$IME provide 18-bit values for the date and time of the absolute element
creation, which may be edited using the SYSLIB AEDIT$SFDT editing routine to provide
a means of verifying the version of the program being executed.
If you redefine a Collector-defined symbol, your supplied value is taken as the value of
the symbol. You can only specify a value for the Collector-defined symbol, by using the
Collector EQU directive or by defining a value for the Collector-defined symbol in an
element that is explicitly included in the collection.
7–4 7830 9887–001

Section 8
Efficient Use of the Collector
8.1. Introduction
There are ways you can make a collection more efficient. The suggestions in the
following paragraphs either reduce the amount of main storage used by the Collector or
the amount of Collector processing.
8.2. Use of the IN Directive
Using file-name.element-name on the IN directive instead of just element-name reduces
Collector processing because the Collector does not need to search all of the libraries in
the collection for the element. If library files are used only for element searching and not
for satisfying external references, it is more efficient to use file-name. element-name for
each element on the IN directive. However, the use of file-name. element-name makes
the Collector symbolic less flexible.
Elements included from a library file should not be named on IN directives if they do not
need to be. Implicit element inclusion is slightly faster than explicit element inclusion.
When IN file-name is used, processing is most efficient when the file contains only
nondeleted, relocatable elements.
8.3. @PREP of TPF$
If TPF$ does not have an entry-point table (created by @PREP or @PACK,P), the Collector
brings all of the elements from TPF$ into the collection, processes their preambles, and
creates an entry-point table. In effect, the Collector is doing an implicit @PREP of TPF$.
After determining which elements are necessary for satisfying external references, the
Collector discards the unnecessary TPF$ elements.
Obviously, a prep of TPF$ is more efficient in both space and processing time. If no
implicitly included elements from TPF$ are needed, the most efficient approach is to use
a NOT TPF$ directive.
8.4. Relocatable Element Structure
You can reduce collection time and Collector storage requirements by carefully
structuring the relocatable element.
7830 9887–001 8–1

Efficient Use of the Collector
Internally, when preparing the text for output as an absolute element, the Collector
creates three-word packets to describe blocks of text within the relocatable element.
These packets describe contiguous blocks of code and if a relocatable element has
contiguous blocks of code, there are fewer packets. After processing all of the text for a
segment, the packets are rearranged to describe a solid block of code within the
absolute.
Example 1
.
.
.
TAG1 + 1 .
TAG2 + 2 .
TAG3 + 3 . Packet required for 3 words
RES 10 .
TAG4 + 4 .
TAG5 + 5 . Packet required for 2 words
RES 5 .
TAG6 + 6 . Packet required for 1 word
.
.
.
This sequence of code is less efficient and requires more internal
Collector storage than the following sequence:
.
.
.
TAG1 + 1 .
TAG2 + 2 .
TAG3 + 3 .
TAG4 + 4 .
TAG5 + 5 .
TAG6 + 6 . Packet required for 6 word2
RES 15 .
.
.
.
In the second half of Example 1, the Collector uses two-thirds less
storage than in the first half.
Example 2
INTEGER ARRAY (3,4)
DATA ((ARRAY(I,J),J=1,4),I=1,3)/1,2,3,4,5,6,7,8,9,10,11,12/
This FORTRAN example creates an array that is filled as follows:
8–2 7830 9887–001

7830 9887–001
This array appears as follows in a relocatable element:
Address
0
3
6
9
1
4
7
10
2
5
8
11
In order for the Collector to describe sequential addresses in the absolute text, a three-
word packet must be constructed for each word of this array and then analyzed and
unchained so that the text reads as follows:
Address
0
1
Contents
1
2
3
4
5
6
7
8
9
10
11
12
Contents
1
5
Efficient Use of the Collector
8–3

Efficient Use of the Collector
2 9
3 2
4 6
5 10
6 3
7 7
8 11
9 4
10 8
11 12
To conserve both time and storage, a more efficient array is
INTEGER ARRAY(3,4)
DATA ((ARRAY(I,J),I=1,3),J=1,4)/1,2,3,4,5,6,7,8,9,10,11,12/
This creates the following array:
The relocatable element for this array is constructed as follows:
Address Contents
0 1
1 2
2 3
8–4 7830 9887–001

3 4
4 5
5 6
6 7
7 8
8 9
9 10
10 11
11 12
Only one Collector packet is necessary to describe this array.
Efficient Use of the Collector
The Collector creates the three-word packets per segment. When all of the code has
been described for a segment, it unchains the packets and releases the storage that they
used. (If an element spans segments, a few packets describing that element are held
until the other segments are processed.) If it is not possible for the programmer to
employ the coding techniques previously shown, yet more efficient Collector storage
utilization is necessary, a collection with more segments reduces the amount of storage
the Collector needs to process the packets. More segmentation, however, increases the
execution time of the resulting absolute.
8.5. Use of the Location Counter
The Collector and the relocatable element format favor the use of location counters 1
and 2. I/O and mass storage use are reduced if only these location counters are used.
Therefore, if two location counters are sufficient, location counters 1 and 2 should be
used.
8.6. Use of the C Option
The C option is designed to improve the collection time performance of the Collector for
large collections. Small collections will probably not show a noticeable improvement in
collection time, and will be wasting internal memory if the C option is used. To
determine the amount of internal space your collection uses, refer to 2.2.3 (which
describes the values of the storage information given on the sign-off line, including the
number of calls being made to MCORE$).
7830 9887–001 8–5

Efficient Use of the Collector
8–6 7830 9887–001

Appendix A
TYPE EXEC Collections
A.1. TYPE EXEC
Purpose
The TYPE EXEC directive has the following effect on collections:
• Allows the use of XSEG and FIRSTBDI directives
• Suppresses the error message ’*ERROR: NO START ADDRESS’
• Assumes LEVEL 1 unless overridden by the LEVEL directive in the map symbolic
• Changes the format of the values returned for BDICALL$, BDIREF$, LBDI$,
LBDICALL$, and LBDIREF$
The TYPE EXEC directive is not allowed for R option collections.
Format
TYPE EXEC
A.2. XSEG — Executive Function Arrangement
Purpose
The XSEG directive arranges the segments in the collection of the Executive to minimize
the size of the function overlay area. This directive is intended for use only in collections
of the OS 2200 Executive system. All XSEG directive parameters are optional, except
name-1.
Format
XSEG name-1,segment-list
where:
name-1
specifies the name of the segment. When name-1 is followed by an asterisk (*), the
named segment is automatically loaded when referenced by a jump instruction.
7830 9887–001 A–1

TYPE EXEC Collections
Such a segment is called an indirect load segment. The asterisk is allowed on all SEG
directives, but is ignored if the directive defines the main segment.
segment-list
specifies the address relationship between the segment named in name-1 and the
other program segments. (See F.2.1 for segment-list formats.)
Description
An XSEG directive functions the same as a SEG directive, except that the initial relative
starting address is reduced, if possible, by multiples of 01000. The resulting final starting
address is equal to the starting address of the bank that the segment is in, plus the
number of words by which the initial relative starting address exceeds a multiple of
01000.
Example
@MAP, I TEST,TEST
IBANK XS1,02000
1. SEG MAIN
IN EL1
2. XSEG A
IN EL2
3. XSEG B
IN EL3
4. SEG C,B
IN EL4
5. XSEG D,(B,C)
IN EL5
Use the following octal lengths and address ranges for this example:
Segment
If the Octal Length
Is:
MAIN 01143 02000-03142
A 02054 02143-04216
B 02712 02217-05130
C 04364 02217-06602
D 0115 02603-02717
Description
The Assigned Address
Range Is:
1. Segment MAIN is assigned a start address of 02000 (see F.2.1 for bank start
address assignment) and an end address of 03142.
2. Segment A, an XSEG that follows segment MAIN, starts at address 02143 and ends
at address 04216. Segment A is initially assigned a start address of 03143,
A–2 7830 9887–001

TYPE EXEC Collections
immediately following segment MAIN. However, since segment A is an XSEG, its
start address of 02143 is formed by adding 0143 (the number of words that 03143 is
over a multiple of 01000) to 02000 (the start address of bank XS1).
3. Segment B, an XSEG that follows segment A, starts at address 02217 and ends at
address 05130. Segment B is initially assigned a start address of 04217, immediately
following segment A. Since segment B, like segment A, is an XSEG, its actual start
address is 02217 (0217 + 02000).
4. Segment C starts at the same address as segment B with a start address of 02217
and an end address of 06602.
5. Segment D is an XSEG that follows the highest address assigned to segment B and
C. The initial start address is 06603 immediately following segment C. The actual
start address for segment D is 02603 (0603 + 02000), since it is also an XSEG.
A.3. FIRSTBDI
Purpose
The FIRSTBDI directive allows you to specify the starting bank descriptor index (BDI) for
the banks in the collection. The following restrictions apply to this directive:
• The default starting BDI is 4. BDIs 0 through 3 are reserved in the user’s bank
description table (BDT).
• A check is made to ensure that the BDI does not exceed the Collector's maximum
internal user-bank BDI value of 4092 (07774); an error message is issued if the
number is too large.
• Multiple FIRSTBDI directives result in the last FIRSTBDI directive overriding all
previous FIRSTBDI directives.
• The FIRSTBDI directive is not allowed in an R option collection.
Format
FIRSTBDI number
where number specifies the starting BDI. The number must not exceed the Collector's
maximum internal user-bank BDI value of 4092 (07774).
Note: The maximum number of banks is limited by the maximum BDI value, 4092
(07774), not by the maximum number of user banks per absolute (4089-07771).
Therefore, using FIRSTBDI to start at a higher BDI value will result in fewer available
user banks.
Description
Banks are assigned ascending BDIs, starting with the FIRSTBDI value, as follows:
• Z option banks
• S option banks
7830 9887–001 A–3

TYPE EXEC Collections
• Dynamic banks that are not initially based
• Dynamic banks that are initially based
• Static banks
• Control bank
• INFO 11 banks
• Link vector bank
A.4. BDICALL$, BDIREF$, LBDI$, LBDICALL$, and
LBDIREF$
For TYPE EXEC collections, the BDT level is always returned with the BDI of the bank
when the tags just shown are referenced.
BDICALL$ and BDIREF$ return the BDT level and BDI in basic mode virtual address
form.
LBDI$, LBDICALL$, and LBDIREF$ return the BDT level and BDI in extended mode
virtual address form.
BDI$ is not affected.
For more information regarding the use of these Collector-defined tags, refer to 4.5.4
and 4.6.1.
A–4 7830 9887–001

Appendix B
Collection Examples
B.1. Bank-Implied and Bank-Named Collections
Table B-1 shows the elements in FILEA and their required outside references. These
symbolics pertain to the partial runstreams for the bank-implied and bank-named
collections.
FILEA
Table B–1. Elements in FILEA
MAIN FILEA.SUB1,.SUB2
SUB1 LIB1.SUB3
SUB2 LIB1.SUB4
B.1.1. Bank-Implied Collection
Elements In Which FILEA
References Are Defined
This partial runstream uses a bank-implied collection to produce an absolute element
named ABS.
1. @PREP LIB1.
2. @MAP,IS MAPSYM,ABS
3. IN FILEA.MAIN
4. IN FILEA.SUB1,.SUB2
5. LIB LIB1.
6. END
Description
1. FURPUR is called to create the relocatable entry-point table for file LIB1.
2. Call the Collector. The I option specifies that symbolic element MAPSYM is introduced
from file TPF$. The S option produces a listing. The absolute element (ABS) is placed in
the file TPF$.
3. The element MAIN in file FILEA is included with the odd location counters placed in the I
bank ($IBANK) and the even location counters placed in the D bank ($DBANK). The
Collector generates the bank names, $IBANK and $DBANK, because IBANK and
DBANK directives have not been included in the symbolic input.
7830 9887–001 B–1

Collection Examples
4. The elements SUB1 and SUB2 from FILEA are included with the odd location counters
placed in the I bank ($IBANK) and the even location counters placed in the D bank
($DBANK).
5. The file LIB1 is searched for the entry points to satisfy the external references from
elements SUB1 and SUB2. The elements LIB1.SUB3 and LIB1.SUB4, which are
implicitly included to satisfy these external references, are split so that their odd
location counters are included in the I bank ($IBANK) and their even location counters in
the D bank ($DBANK).
6. Signifies the end of input to the Collector.
B.1.2. Bank-Named Collection
This partial runstream uses a bank-named collection to produce the absolute element
named ABS.
1. @PREP LIB1.
2. @MAP,IS MAPSYM,ABS
3. IBANK $IBANK
4. BANKINFO INITIAL(MAINI)
5. IN FILEA.MAIN
6. IN FILEA.SUB1,.SUB2
7. DBANK $DBANK
8. BANKINFO INITIAL(MAIND),CONTROL
9. FORM $IBANK
10. LIB LIB1.($IBANK/$ODD,$DBANK/$EVEN)
Description
1. FURPUR is called to create the relocatable entry-point table for file LIB1.
2. Call the Collector. The I option specifies that symbolic element MAPSYM is introduced
from the file TPF$. The S option produces a listing. The absolute element (ABS) is
placed in the file TPF$.
3. I bank $IBANK is a static bank.
4. I bank $IBANK is based on BDR0.
5. The odd location counters from element MAIN in file FILEA are included in bank $IBANK.
6. The odd location counters from elements SUB1 and SUB2 from FILEA are included in
bank $IBANK.
7. D bank $DBANK is a static bank.
8. D bank $DBANK is the control bank and is based on BDR2.
9. The FORM directive causes the structure of $IBANK to be duplicated and included in
bank $DBANK.
10. The file LIB1 is searched for the entry points to satisfy the external references from
elements SUB1 and SUB2. The elements LIB1.SUB3 and LIB1.SUB4, which are
implicitly included to satisfy these external references, are split so that their odd
location counters are included in bank $IBANK and their even location counters in bank
$DBANK.
B–2 7830 9887–001

B.2. Bank-Implied Segmentation
Collection Examples
The following is an example of a segmented program showing the elements in the file
FILEA and their external references
The following example demonstrates the use of Collector directives to produce a
segmented program:
1. @PREP LIB1.
2. @PREP LIB2.
3. @MAP,IL MAPSYM,MAPABS
4. SEG MAIN
5. IN FILEA.MAIN
6. SEG ALPHA*, (MAIN)
7. IN FILEA.ALPHA1/A,.ALPHA2/A,.ALPHA3/A
8. SEG BETA*, (ALPHA)
9. IN FILEA.BETA1/B,.BETA2/B,.BETA3/B
10. SEG CHI*,BETA
11. IN FILEA.CHI1/C,.CHI2/C
7830 9887–001 B–3

Collection Examples
12. SEG DELTA*, (BETA,CHI)
13. IN FILEA.DELTA1/D,.DELTA2/D
14. SEG EPSO*, DELTA
15. IN FILEA.EPSO1/E,.EPSO2/E
16. SEG GAMMA*, (MAIN)
17. IN FILEA.GAMMA1/G,.GAMMA2/G
18. SEG PHI*, (DELTA,GAMMA)
19. IN FILEA.PHI1,.PHI2
20. LIB LIB1,LIB2
21. END
Description
1. File LIB1 is prepared (@PREP) to create the relocatable entry-point table.
2. File LIB2 is prepared (@PREP) to create the relocatable entry-point table.
3. Calls the Collector. The I option specifies that symbolic element MAPSYM is
introduced from the runstream. The L option specifies that a complete listing is to be
produced. The absolute output element is called MAPABS. Both MAPSYM and
MAPABS are placed in TPF$.
4. Segment MAIN is the program’s main segment.
5. Element MAIN is found in file FILEA.
6. Segment ALPHA is marked for indirect loading. The starting address of ALPHA
follows the last address of segment MAIN.
7. Elements ALPHA1/A, ALPHA2/A, and ALPHA3/A are found in file FILEA and are
included in the collection of segment ALPHA.
8. Segment BETA is marked for indirect loading. The starting address of BETA follows
the last address of segment ALPHA.
9. Elements BETA1/B, BETA2/B, and BETA3/B are found in file FILEA and are included
in the collection of segment BETA.
10. Segment CHI is marked for indirect loading. The starting address of segment CHI is
the same as the starting address of segment BETA.
11. Elements CHI1/C and CHI2/C are in FILEA and are included in the collection of
segment CHI.
12. Segment DELTA is marked for indirect loading. The starting address of segment
DELTA follows the last address of either segment BETA or segment CHI, whichever
is longer.
13. Elements DELTA1/D and DELTA2/D are in file FILEA and are included in the
collection of segment DELTA.
14. Segment EPSO is marked for indirect loading. The starting address of segment
EPSO is the same as the starting address of segment DELTA.
15. Elements EPSO1/E and EPSO2/E are in file FILEA and are included in the collection
for segment EPSO.
16. Segment GAMMA is marked for indirect loading. The starting address of segment
GAMMA follows the last address of segment MAIN.
B–4 7830 9887–001

Collection Examples
17. Elements GAMMA1/G and GAMMA2/G are in file FILEA and are included in the
collection of segment GAMMA.
18. Segment PHI is marked for indirect loading. The starting address of segment PHI
follows the last address of either segment DELTA or segment GAMMA, whichever
is longer.
19. Elements PHI1 and PHI2 in file FILEA are included in the collection of segment PHI.
20. Files LIB1 and LIB2 are searched before searching the system library for the
collection elements.
21. End of the Collector directives.
Figure B-1 and Figure B-2 show the instruction and data areas of main storage for the
preceding example.
Figure B–1. I Bank Main Storage Map for the Segmented MAPABS
7830 9887–001 B–5

Collection Examples
Figure B–2. D Bank Main Storage Map for the Segmented MAPABS
B–6 7830 9887–001

B.3. Bank-Named Segmentation
Collection Examples
The following is an example of a bank-named segmented program showing the
elements in file FILEA and their required outside references:
The following example demonstrates the use of Collector directives to produce a banknamed
segmented program named ABS:
1. @PREP LIB1.
2. @PREP LIB2.
3. @MAP,IL MAPSYM,MAPABS
4. IBANK,MD BANK1
5. SEG MAIN
6. IN FILEA.MAIN
7. SEG ALPHA
8. IN FILEA.ALPHA1/A,.ALPHA2/A
9. SEG BETA*
10. IN FILEA.BETA1/B
11. DBANK,MC BANK2
7830 9887–001 B–7

Collection Examples
12. SEG MAIN
13. IN FILEA.MAIN
14. SEG ALPHA
15. IN FILEA.ALPHA1/A,.ALPHA2/A
16. SEG BETA*
17. IN FILEA.BETA1/B
18. IN FILEA.BETA2/B($ALL)
19. IBANK BANK5,(BANK1)
20. $ALL
21. SEG MAIN
22. IN FILEA.CHI3/C
23. SEG EPSO
24. IN FILEA.EPSO1/E,.EPSO2/E
25. SEG PHI
26. IN FILEA.PHI1,.PHI2
27. SEG MAIN
28. IBANK,U BANK3,BANK5-02000
29. IN FILEA.BETA3/B
30. SEG CHI
31. IN FILEA.CHI1/C,.CHI2/C
32. SEG DELTA,CHI
33. IN FILEA.DELTA1/D,.DELTA2/D
34. DBANK,U BANK4
35. FORM BANK3
36. DBANK BANK6,BANK4
37. $ALL
38. SEG MAIN
39. IN FILEA.GAMMA1/G
40. SEG GAMMA
41. IN FILEA.ALPHA3/A,.GAMMA2/G
Description
1. An entry-point table is prepared for file LIB1.
2. An entry-point table is prepared for file LIB2.
3. Calls the Collector. The I option specifies that symbolic element MAPSYM is
introduced from the runstream. The L option specifies that a complete listing is to be
produced. The absolute output element is called ABS. Both MAPSYM and ABS are
placed in TPF$.
4. I bank BANK1 is a dynamic bank that is based on BDR0.
5. Segment MAIN is the main segment for BANK1.
6. The odd location counters from element MAIN in file FILEA are to be included.
7. Segment ALPHA follows segment MAIN.
8. The odd location counters from elements ALPHA1/A and ALPHA2/A in FILEA are to
be included.
9. Segment BETA follows segment ALPHA and is indirectly loaded.
10. The odd location counters from element BETA1/B in FILEA are to be included.
B–8 7830 9887–001

11. D bank BANK2 is the control bank and is based on BDR2.
12. Segment MAIN is the main segment in BANK2.
Collection Examples
13. The even location counters from element MAIN in FILEA are to be included.
14. Segment ALPHA follows segment MAIN.
15. The even location counters from elements ALPHA1/A and ALPHA2/A in FILEA are to
be included.
16. Segment BETA is indirectly loaded and follows segment ALPHA.
17. The even location counters from element BETA1/B in FILEA are to be included.
18. All location counters from element BETA2/B in FILEA are to be included.
19. I bank BANK5 is a static bank and follows BANK1.
20. The $lcs specification is for the inclusion of all location counters of an element.
21. Segment MAIN is the main segment of BANK5.
22. All location counters from element CHI3/C in FILEA are to be included.
23. Segment EPSO follows segment MAIN.
24. All location counters from elements EPSO1/E and EPSO2/E in FILEA are to be
included.
25. Segment PHI follows segment EPSO.
26. All location counters from elements PHI1 and PHI2 in FILEA are to be included.
27. I bank BANK3 is a static bank based on BDR1. Its starting address is equal to the
starting address of BANK5 minus 02000.
28. Segment MAIN is the main segment of BANK3.
29. The odd location counters from element BETA3/B in FILEA are to be included.
30. Segment CHI follows segment MAIN.
31. The odd location counters from elements CHI1/C and CHI2/C in FILEA are to be
included.
32. Segment DELTA starts at the same address as segment CHI.
33. The odd location counters from elements DELTA1/D and DELTA2/D in FILEA are to
be included.
34. D bank BANK4 is a static bank based on BDR3. It follows D bank BANK2.
35. The same segmentation structure and element inclusions for BANK3 are to be
placed in BANK4, except that the even location counters of the elements are to be
included rather than the odd location counters as in BANK3.
36. D bank BANK6 is a static bank that starts at the same address as BANK4.
37. The $lcs specification is for the inclusion of all location counters for the following
included elements.
38. Segment MAIN is the main segment of BANK6.
39. All location counters of element GAMMA1/G in FILEA are to be included.
7830 9887–001 B–9

Collection Examples
40. Segment GAMMA follows segment MAIN.
41. All location counters from elements ALPHA3/A and GAMMA2/G in FILEA are to be
included.
Figure B-3 through Figure B-7 show the bank structure of the program, the segment
structure within each bank, and the element inclusion within the segments and banks.
Figure B–3. Bank Structure of the Program ABS
Note: Address space increases from left to right in the following diagrams.
B–10 7830 9887–001

Figure B–4. Segment Structure of Bank1 in Program ABS
Figure B–5. Segment Structure of Bank2 in Program ABS’
Collection Examples
7830 9887–001 B–11

Collection Examples
Figure B–6. Segment Structure of Bank3 and Bank4 in Program ABS
B–12 7830 9887–001

Collection Examples
Figure B–7. Segment Structure of Bank5 and Bank6 in Program ABS
7830 9887–001 B–13

Collection Examples
B–14 7830 9887–001

Appendix C
Processing Element Preambles
C.1. Introduction
An element preamble is attached to every relocatable element created by the language
processors and by the Collector. The element preamble provides the following
information that is needed when relocatable elements are collected to form an absolute
or relocatable element:
• The definition and location of each externally-defined name (entry point) in the
element
• The length, in words, under each location counter in the element
• The table of the undefined symbols appearing in the element
• Common blocks in the element
When the preamble is processed
• The entry points in the element are added to the Collector entry-point table.
• Undefined symbols appearing in the element that have no corresponding entry in the
entry-point table are listed in the undefined symbol table.
• Undefined symbols in the element that have a name corresponding to an entry point
in another element are linked to the entry-point table.
Symbols are removed from the undefined symbol table as corresponding entry point
names are found. Newly encountered undefined symbol names are added at the end of
the undefined symbol table.
C.2. INFO Groups
One of the tables in the preamble of the relocatable contains INFO items that are used
for communication between the language processors and the Collector. INFO groups 2,
4, 7, 8, 9, and 10 are associated with a location counter. INFO group 11 is a void bank
created in an absolute element. INFO group 12 includes a library search for INFO group
12 items (for example, keywords and directives). The following INFO groups are
recognized by the Collector:
Group 2:
Labeled Common
7830 9887–001 C–1

Processing Element Preambles
Group 4:
Blank Common
Group 7:
Even starting address. A location counter that is associated with this group always
starts on an even address; if necessary, it leaves the word preceding it unused.
Group 8:
Static diagnostic information. The text for a location counter that belongs to INFO 8
is not loaded into main storage, but is available in the absolute element for use by
diagnostic processors, such as the ASCII FORTRAN walkback routine.
Group 9:
Read-only. A nonvoid bank is classified as read-only if it meets the following criteria
− It contains only location counters that are marked as read-only.
− It is not segmented.
− It does not contain any tables generated by the Collector (for example, the
segmented load table).
Compare the INFO 9 directive with the action of the TYPE READONLY directive and the
use of the R option on the IBANK and DBANK directives.
Group 10:
Extended mode location counter. The bank this location counter is included in is
marked as requiring extended mode, unless the B option is specified on the bank
directive. If an INFO 10 directive appears in an element in an unprepped TPF$ that is
not included in the collection, the bank that it is tentatively included in will still be
marked as requiring extended mode.
Group 11:
Void bank. A void bank is created in the absolute element. The bank descriptor index
(BDI) assigned to the bank is one higher than the BDI of the last “normal” user bank.
A bank name can appear on more than one INFO 11 directive and is ignored after the
first appearance. If an INFO 11 name appears in any other form in the collection
(entry point, segment name, or non INFO 11 bank name) an error message is
printed. The D (dynamic bank) option, (bit 16 of word 2 of control information table
(CIT) item) and S (shared bank) option (bit 17 of word 2 of CIT item) are allowed. Void
banks are assumed to be D banks unless the I bank option bit (bit 15 of word 2 of
CIT item) is set. If an INFO 11 directive appears in an R option collection, it is
maintained in the resulting relocatable. If an INFO 11 directive appears in an element
in an unprepped TPF$ that is not included in the collection, a void bank is created in
the resulting absolute.
Group 12:
C–2 7830 9887–001

Processing Element Preambles
Library search. The order in which files specified by INFO 12 keywords are searched
is the same as the order of the INFO 12 directives and can vary between collections
because elements containing INFO group 12 items can be included in the collection
in a different order. Any number of INFO 12 directives can appear within a
relocatable element. Duplicate INFO group 12 items are allowed. Keywords are
related to a file by use of an integer index created by COMUS. For example, the
FORTRAN compiler can produce an INFO 12 directive of the form INFO 12
‘FORTRAN’. The Collector would then search the index for the keyword FORTRAN
and retrieve the integer index for it. The integer index would then be used to find the
file name corresponding to this keyword; for example, the file name can be
FOR*RLIB. This file would then be searched if necessary to satisfy external
references. The actual keyword in the INFO group 12 item is in Fieldata. Meta-
Assembler (MASM) performs the translation from ASCII if necessary. (For further
information on INFO group 12 keywords and the search order, see 3.2.4.)
These INFO Groups can be created by the MASM processor (see the Meta-Assembler
(MASM) Programming Reference Manual.)
In addition, the MASM processor recognizes Groups 1, 3, 5, and 6 and converts them to
other types of information in the relocatable.
7830 9887–001 C–3

Processing Element Preambles
C–4 7830 9887–001

Appendix D
Restrictions
D.1. 262K Banks
Due to the internal design of the Collector, the number of words in a bank is limited to
262,143 (addresses 0 through 0777776), which is one less than the hardware limit of
262,144. There are also some areas of the Exec that impose this limitation.
D.2. 65K Location Counters
No text word can have an offset of more than 65,535 (65K) from the start of a location
counter. This restriction is essential to the old format of the relocatable. With the advent
of the enhanced relocatable output routine, described in Appendix G, this restriction has
been lifted to an offset of 262,143 (262K) from the start of a location counter. The Meta-
Assembler (MASM) has been modified to generate this enhanced relocatable format.
D.3. Relocation Order
The relocation information for the special external references IBJ$ and DBJ$ must
precede any relocation information for the u field of the same text word.
The relocation information for the special external references BDICALL$, BDIREF$,
LBDICALL$, and LBDIREF$ must precede any other relocation information for the u field
of the same text word. This means that the assembler language programmer must use
these references as BDICALL$+value, not value+BDICALL$.
D.4. Relocatable Element Format Errors
Some format errors in relocatable elements are not detected, because of their infrequent
occurrence and the relatively high overhead required to detect these errors. These errors
are caused only if the program creating the relocatable element is in error or if the
element has been corrupted. Errors known not to be detected include
• Incorrect length in location counter table (LCT)
If the location counter table in the relocatable preamble specifies a location counter
length that is too small, this error is undetected and may cause initial load errors. It is
not an error to specify a length that is “too large,” since this implies the existence of
a RES area at the end of the location counter.
• Incorrect word count
7830 9887–001 D–1

Restrictions
D.5. EQU
It is possible for the word count field in the relocation information to specify an illegal
length.
EQU directives of the form EQU ep1/ep2 have the following restrictions:
1. If ep1 specifies a bank or segment name, the EQU directive is ignored.
2. If ep2 specifies a bank or segment name and a later EQU directive specifies the
same bank or segment name, the first EQU directive is ignored.
3. The element containing ep2 must be included in the collection; it is not searched for
in a LIB file.
D.6. Implicit Call for Non-TPF$ File
If you use the following statement where the file (file-name) contains no absolute
elements or the most recent absolute of the file has been deleted, Collector is called
implicitly, just as it is for TPF$. Note that there is no element specified on the @XQT
statement.
@XQT file-name.
There is no last absolute for a file if the file contains no absolutes or the most recent
absolute of the file has been deleted. In either case, the following message is output
from the processor interface routine PREPRO, and an ER ERR$ termination of the
Collector takes place.
SI: BADLY CODED FIELD
D.7. Truncation of Negative Fields
To avoid problems with common-bank entry points, truncation of a negative field is not
detected.
D.8. LIB/NOT of Same File
Currently, the Collector does not always recognize cases where two different names
refer to the same file. Consider the following Collector directives:
LIB USENAME.
NOT FILE.ELT
If USENAME and FILE refer to the same file, the NOT directive does not have the
desired effect. This also applies if a file is referenced as “QUAL*FILE” and “FILE” since
it is not obvious that FILE is not an @USE name.
In addition, the directive “NOT SYS$*RLIB$” must specify the qualifier and file name in
order to have the desired effect.
D–2 7830 9887–001

D.9. Static Diagnostic Text
Restrictions
If static diagnostic (INFO group 8) text is present in more than one bank of a bankimplied,
segmented collection, it is not processed correctly. To minimize this problem, all
INFO group 8 text should be under odd-numbered location counters. Compilers that
generate INFO group 8 text meet this requirement.
D.10. Location Counters Restricted to 2047
The total number of location counters must not exceed 2,047, numbered 0 through
2,046.
7830 9887–001 D–3

Restrictions
D–4 7830 9887–001

Appendix E
Collector Diagnostic Messages
E.1. Introduction
The diagnostic messages in this appendix are categorized into four different types:
FATAL ERROR, ERROR, WARNING, and Information. The error count in the Collector’s
end line includes only messages that are of type FATAL ERROR or ERROR.
• FATAL ERROR
This type of error is always printed by the Collector and has the prefix “*FATAL
ERROR:.” It causes the Collector to stop processing, and no absolute relocatable
element is produced.
• ERROR
This type of message is not printed if the N option is specified on the @MAP
statement. If the X option is specified on the @MAP statement, then no output is
produced. If the X option is not specified, processing continues and the resulting
output is marked in error. ERROR messages have the prefix “*ERROR:.”
• WARNING
This type of message is not counted in the end line as an error; however, incorrect
results can occur. WARNING messages are not printed if the N option is specified on
the @MAP statement. WARNING messages have the prefix “*WARNING:.”
• Information
This is not an error message, but a normal notification of an action taken. This type
of message is printed only if the S or L option is specified on the @MAP statement.
Information messages do not have any prefix.
E.2. FATAL ERROR Messages
*FATAL ERROR: Above BANK directive not processed due to format error
The immediately preceding IBANK or DBANK directive is improperly formatted.
*FATAL ERROR: Addresses exceed 0777776 (262K)
In a bank-implied collection, the assigned D bank addresses exceed 262,143.
*FATAL ERROR: Addresses exceed 0777776 (262K) for D-bank bank-name
7830 9887–001 E–1

Collector Diagnostic Messages
In a bank-named collection, the assigned addresses for the named D bank exceed
262,143.
*FATAL ERROR: Addresses exceed 0777776 (262K) for I-bank bank-name
In a bank-named collection, the assigned addresses for the named I bank exceed
262,143.
*FATAL ERROR: Address too large
An address or offset on an IBANK or DBANK directive exceeds 0777000.
*FATAL ERROR: Assumed main segment name $MAIN$ duplicated by entry
point or bank name
If there are no SEG directives in a collection, a main segment named $MAIN$ is created.
At the time this segment is created, $MAIN$ has already been used as a bank or entrypoint
name.
*FATAL ERROR: Attempting to read Element Table for file file-name -
BSP$ (RPFET$) status: status
An error occurred trying to read the specified file’s element table. See the System
Service Routines Library (SYSLIB) Programming Reference Manual for a description of
status bits.
*FATAL ERROR: Attempting to read Entry Point Table for file file-name -
BSP$ (RPFEPT$) status: status
An error occurred trying to read the entry-point table for the specified file that was
named on a LIB directive. See the System Service Routines Library (SYSLIB)
Programming Reference Manual for a description of status bits.
*FATAL ERROR: Bank bank-name duplicately defined
The specified bank name has already been encountered on an IBANK or DBANK
directive.
*FATAL ERROR: Bank indirectly defines itself
A bank in the bank structure is related to another bank that is directly or indirectly related
to the first bank. For example, bank A follows bank B and bank B follows bank A.
*FATAL ERROR: Bank bank-name is not properly defined
The named bank has not been specified in the name-1 subfield on an IBANK or DBANK
directive, but was used as a bank name in a LIB, IN, IBANK, or DBANK directive.
*FATAL ERROR: Bank list must contain at least one bank name
The bank-list subfield contains only numbers in parentheses.
E–2 7830 9887–001

Collector Diagnostic Messages
*FATAL ERROR: BSP$ error return for file file-name at address address
BSP$ status status
Indicates an internal error or a corrupted file. See the System Service Routines Library
(SYSLIB) Programming Reference Manual, for a description of status bits.
*FATAL ERROR: Collection invalid - None of the banks in this collection
can be the control bank or initially based
The link vector bank cannot be the control bank or initially based. Z option (VOID) banks
cannot be the control bank or initially based.
*FATAL ERROR: Collector storage exhausted; processing terminated.
Restructure your collection to avoid excessive memory use.
Restructure your collection to avoid excessive memory use.
*FATAL ERROR: CSMS - Insufficient space in CDB internal storage for
last transaction
*FATAL ERROR: CSMS - Internal storage address is bad
*FATAL ERROR: CSMS - Internal storage control information is bad
*FATAL ERROR: CSMS - Internal storage free chain is bad
*FATAL ERROR: CSMS - CDB BDI or allocation offset information is bad
*FATAL ERROR: CSMS - CDB or area is too short for initialization
*FATAL ERROR: CSMS - Illegal reference to CDB storage
*FATAL ERROR: CSMS - Attempted store beyond allocated limits
*FATAL ERROR: CSMS - Free of memory allocated by another run
*FATAL ERROR: CSMS - Second attempt to free storage
*FATAL ERROR: CSMS - Internal CDB error information in A0-A3
Indicates an internal Collector error. Please submit a tape containing the necessary
relocatables and libraries needed to re-create the problem.
*FATAL ERROR: Element element for RSEG segment cannot load data into
common block common-block located in segment segment
*FATAL ERROR: Element element for segment segment cannot load data into
common block common-block located in RSEG segment
*FATAL ERROR: Element element has more than 2,047 location counters.
Location counter numbers must be in the range 0 - 2,046
7830 9887–001 E–3

Collector Diagnostic Messages
The specified relocatable element has more than 2,047 location counters. This can be
caused by an internal Collector error or a corrupted relocatable element.
*FATAL ERROR: Fatal error occurred while interpreting map symbolic
This message follows one or more messages describing the error. Segment LANG
interprets the Collector directives.
*FATAL ERROR: FIRSTBDI value is too large: Maximum BDI 4092 (007774)
The Collector's maximum internal user-bank descriptor index (BDI) value cannot exceed
4092 (07774).
*FATAL ERROR: FIRSTBDI value is too large for the number of banks
There are 12 bits available for a BDI value; therefore, the maximum BDI value is 07777.
Banks specified on a $INFO 11 directive are also given a BDI value.
*FATAL ERROR: First segment for last bank is not main segment
The first segment specified for the last bank in the collection does not have the same
main segment name as the other banks.
*FATAL ERROR: entry-point has already been used as bankname
The entry point specified on the WINDOW directive has already been used on a BANK
directive.
*FATAL ERROR: bank-name has already been used as non-bank name
A bank name must be different from all segment names and entry points in the
collection.
*FATAL ERROR: Highest location counter number allowed is 2047 - highest
location counter needed is location-counter
In an R option collection, all common blocks are assigned location counter numbers
greater than the highest location counter number found in any of the included relocatable
elements. This message occurs when there are not enough location counter numbers
available for assignment to all common blocks.
*FATAL ERROR: Internal Collector error – can not buy bank to create
link vector bank
Unable to perform the ER BANK$ to acquire a bank to be used as the link vector bank.
*FATAL ERROR: Internal Collector error: unexpected return from ADDIN
An error was returned from the ADDIN routine that builds the internal Collector tables for
elements specified on IN directives.
E–4 7830 9887–001

Collector Diagnostic Messages
*FATAL ERROR: value is illegal length for location counter locationcounter
in element element
The relocatable element's preamble specifies a length of greater than 65,535 for the
given location counter or the given location counter is nonexistent and a length of greater
than zero is specified. In either case, this indicates that the relocatable was incorrectly
generated or that the file containing the relocatable has been corrupted.
*FATAL ERROR: file-name is not a program file
*FATAL ERROR: The level of Collector Common Bank COLLECTOR$01 (0403030)
does not match the level of the Collector D Bank DATACON being
executed.
The Collector absolute element containing only the Collector D banks and requiring the
installed Collector common I banks has been copied from a tape or file and executed out
of its normal installed environment. In order to successfully execute the absolute
element, it must be installed correctly with its matching Collector absolute element
containing the matching Collector common I banks. These Collector absolute elements
are not intended to be executed out of alternative files.
*FATAL ERROR: Main segment name must be same for all banks
In a bank-named collection, the main segment of each bank must have the same name
as the main segment of all other banks.
*FATAL ERROR: No available bank for control bank
In a bank-named collection, there is no bank that can be the control bank.
*FATAL ERROR: No files available to Collector
Due to facility errors or NOT directives, no files are available.
*FATAL ERROR: No relocatable element created - status from ER PFWL$:
status
An error occurred in an R option collection attempting to output the relocatable element.
The error was received while attempting to retrieve the next write location address of
the program file. See the Exec System Software Executive Requests Programming
Reference Manual for a complete description of the statuses.
*FATAL ERROR: No relocatable element created - I/O error: status
An I/O error occurred in an R option collection attempting to output the relocatable
element. See the Exec System Software Executive Requests Programming Reference
Manual for a complete description of the statuses.
*FATAL ERROR: No relocatable element created - ROR$E internal error:
An internal error occurred in an R option collection attempting to output the relocatable
element. This can indicate a problem with the ROR$E routine.
7830 9887–001 E–5

Collector Diagnostic Messages
*FATAL ERROR: No relocatable element created - status from ER PFI$:
status
An I/O error occurred in an R option collection attempting to output the relocatable
element. The error was received while attempting to update the element table of the
program file. See the Exec System Software Executive Requests Programming
Reference Manual for a complete description of the statuses.
*FATAL ERROR: No relocatable element created - invalid Base Table
information: status
An error occurred in an R option collection attempting to output the relocatable element.
See G.5 a complete description of the error.
*FATAL ERROR: Number of banks n exceeds maximum number of user banks
007771
n indicates the number of banks in the collection. While the Collector is interpreting the
map symbolic, n indicates the number of banks it encounters. The Collector processes
VOID ($INFO 11) banks later in the collection and does each one individually. Thus
whenever a VOID bank exceeds the maximum number, this message is displayed and
the collection terminated, because there is no way to know at that point whether there
will be more void banks to process.
*FATAL ERROR: Only common bank directives - collection invalid
Only IBANK and DBANK directives with the X option appeared in the collection. No
absolute element is produced.
*FATAL ERROR: Only Z option bank directives - collection invalid
Only IBANK and DBANK directives with the Z option appeared in the collection. No
absolute element is produced.
*FATAL ERROR: PFWL$ error status status for file file-name
See the Exec System Software Executive Requests Programming Reference Manual for
a description of the program file package (PFP) status.
*FATAL ERROR: Previous FORM on bank precludes defining another SEG for
this bank
Since a FORM on a bank-name creates an exact duplication of a previous bank structure,
no additional SEG, DSEG, or RSEG directives can be specified for the bank being
generated.
*FATAL ERROR: Relocatable element element contains an invalid
relocation bit stream
An error occurred while processing the text of the relocatable element. This indicates
that the format of the relocatable element is in error or unknown to this level of the
Collector.
E–6 7830 9887–001

Collector Diagnostic Messages
*FATAL ERROR: Relocatable element element has an illegal format or is
of a format value1 not handled by the relocatable binary format value1
available with this Collector.
The relocatable format version specified in the base table of the relocatable is an
unknown format. This can indicate a relocatable format which is in error or unknown to
this level of the collector.
*FATAL ERROR: Return from BSP$ attempting to access file at filename at
address address - I/O status status
An I/O error occurred while the Collector was trying to read or write the specified file at
the specified address in the file. See the Exec System Software Executive Requests
Programming Reference Manual for status description.
*FATAL ERROR: Return from SIR$ (CLOSR$) - status from I/O (or PFI$ if
04000xx): status
An error occurred while the Collector was trying to close the source input element. See
the Exec System Software Executive Requests Programming Reference Manual for
status description.
*FATAL ERROR: Return from SIR$ (GETSR$) - status from I/O: status
An error occurred while the Collector was requesting the next source image from the
source input element. See the Exec System Software Executive Requests Programming
Reference Manual for status description.
*FATAL ERROR: Return from SIR$ (OPNSR$) - status from I/O: status
An error occurred while the Collector was trying to open the source input element for
reading. See the Exec System Software Executive Requests Programming Reference
Manual for status description.
*FATAL ERROR: RSEG segment has size value greater than 65K - not
included in collection
The specified RSEG is larger than 65,535 by the specified size. It is not included in the
collection since the maximum size of an RSEG is 65,535.
*FATAL ERROR: Scratch files could not be assigned - GETPSF$ status:
status
The files PSF$ and PSF1$ used by the Collector could not be assigned. See the System
Service Routines Library (SYSLIB) Programming Reference Manual for a description of
the GETPSF$ status.
*FATAL ERROR: Segment indirectly defines itself
A segment in the segment structure is related to another segment that is directly or
indirectly related to the first segment. For example, segment A follows segment B and
segment B follows segment A.
7830 9887–001 E–7

Collector Diagnostic Messages
*FATAL ERROR: Segment name segment duplicated
The specified name has been used to define more than one segment in the collection.
*FATAL ERROR: Segment segment not properly defined
The segment name has not been specified in the name-1 subfield on a SEG or DSEG
directive.
*FATAL ERROR: Source input is invalid SDF - SIR$ (OPNSR$) error
The symbolic element specified in the source input field on the @MAP processor call
statement does not contain general symbolic type SDF (TYPE S).
*FATAL ERROR: Symbol name name duplication error
The specified name, present on an RSEG, SEG, DSEG, IBANK, or DBANK directive, has
already been found as a nonsegment or nonbank name. This produces a fatal error.
E.3. ERROR Messages
*ERROR: Above directive ignored - duplicate RSEG name
RSEG names must be unique.
*ERROR: Above directive ignored - not allowed in collections with the
WINDOW directive
Segments are not allowed in collections that contain WINDOW directives.
*ERROR: Above directive not allowed after Z option or VOID attribute
bank
No FORM, IN, or SEG directives are allowed following a Z option or VOID attribute bank.
*ERROR: Above directive not allowed following a common bank
Following an IBANK or DBANK directive specifying a common bank, another IBANK or
DBANK directive must precede any SEG, DSEG, RSEG, XSEG, or IN directive.
*ERROR: Above directive not allowed following the link vector bank
No IN, SEG, or FORM directives are allowed for the link vector bank.
*ERROR: Above directive not processed due to format error
The immediately preceding source directive is improperly formatted. The directive is
ignored.
*ERROR: Above directive not processed - if banks are desired a BANK
directive must precede any SEG or IN directives
E–8 7830 9887–001

Collector Diagnostic Messages
The first IBANK or DBANK directive was encountered after a SEG, RSEG, DSEG, XSEG,
or IN directive has been processed.
*ERROR: Above F-cycle subfield not properly formatted
The F-cycle subfield in the immediately preceding source directive is improperly
formatted.
*ERROR: Above read-key subfield not properly formatted
The read key subfield in the immediately preceding source directive is improperly
formatted.
*ERROR: A common bank can have no relationships
An IBANK or DBANK directive with an X option has a bank-list subfield specified.
*ERROR: AFCB attribute ignored - no bank name specified
No bank name was specified with parentheses. If the parentheses are used, a bank
name must also be specified.
*ERROR: AFCB attribute ignored - no BDI value specified
No BDI value was specified within the parentheses. If the parentheses are used, a BDI
value must also be specified.
*ERROR: AFCB attribute ignored - previous IN, SEG or FORM directive
encountered
No FORM, IN, or SEG directives are allowed with the alternate file common bank (AFCB)
attribute unless the BDI value is also specified.
*ERROR: name already defined
The symbol has appeared in the first subfield of two or more EQU directives, or it is a
bank or segment name.
*ERROR: value at address address bits bits - bits element element is
possible over-65K address field
The D option was specified and an address field contains a value greater than 65,535.
*ERROR: B and N option conflict - both ignored
Both the B and N options were specified on the same BANK directive.
*ERROR: Bad placement of character char
The character is in an illegal position. This can indicate use of a bank-list field on an IN
directive with no preceding IBANK or DBANK directive.
7830 9887–001 E–9

Collector Diagnostic Messages
*ERROR: Bank already based on BDR 0 - MAINI or BDR0 subattribute
ignored
The M option, the BANKINFO INITIAL(MAINI), or the BANKINFO INITIAL(BDR0) has
been specified for more than one BANK directive.
*ERROR: Bank already based on BDR 0 - M option ignored
The M option, the BANKINFO INITIAL(MAINI), or the BANKINFO INITIAL(BDR0) has
been specified for more than one BANK directive.
*ERROR: Bank already based on BDR 1 - UTILI or BDR1 subattribute
ignored
The U option, the BANKINFO INITIAL(UTILI), or the BANKINFO INITIAL(BDR1) has been
specified for more than one BANK directive.
*ERROR: Bank already based on BDR 1 - U option ignored
The U option, the BANKINFO INITIAL(UTILI), or the BANKINFO INITIAL(BDR1) has been
specified for more than one BANK directive.
*ERROR: Bank already based on BDR 2 - MAIND or BDR2 subattribute
ignored
The M option, the BANKINFO INITIAL(MAIND), or the BANKINFO INITIAL(BDR2) has
been specified for more than one BANK directive.
*ERROR: Bank already based on BDR 2 - M option ignored
The M option, the BANKINFO INITIAL(MAIND), or the BANKINFO INITIAL(BDR2) has
been specified for more than one BANK directive.
*ERROR: Bank already based on BDR 3 - UTILD or BDR3 subattribute
ignored
The M option, the BANKINFO INITIAL(UTILD), or the BANKINFO INITIAL(BDR3) has
been specified for more than one BANK directive.
*ERROR: Bank already based on BDR 3 - U option ignored
The M option, the BANKINFO INITIAL(UTILD), or the BANKINFO INITIAL(BDR3) has
been specified for more than one BANK directive.
*ERROR: Bank directive must precede BANKINFO directive - BANKINFO
directive ignored
The BANKINFO directive defines the previous bank. Therefore, a BANK directive must
precede the BANKINFO directive.
*ERROR: BANK directive must precede WINDOW directive - WINDOW directive
ignored
E–10 7830 9887–001

Collector Diagnostic Messages
Windows are defined for particular banksA BANK directive must precede a WINDOW
directive.
*ERROR: BANK directives not allowed in R option collection
An IBANK or DBANK directive appeared in an R option collection.
*ERROR: BANKINFO attribute AFCB(bankname,bdi) conflicts with a previous
AFCB BANKINFO attribute or an X attribute specification on the BANK
directive - attribute is ignored.
The previous BANK directive contains an X attribute specification or the BANKINFO
attribute AFCB without subattributes has already been specified for a bank. The
BANKINFO attribute AFCB (bankname,bdi) cannot also be specified for the same bank
since these attributes produce conflicting results.
*ERROR: BANKINFO attribute AFCB conflicts with a previous BANKINFO AFCB
attribute which contains subattributes - attribute is ignored.
The BANKINFO attribute AFCB (bankname,bdi) has already been specified for a bank.
The BANKINFO attribute AFCB without subattributes cannot also be specified for the
same bank since these attributes produce conflicting results.
*ERROR: BANKINFO directive ignored - no attributes specified
The BANKINFO directive was ignored because no attributes were specified.
*ERROR: Bank, segment, or segment within bank not previously defined
A FORM directive has been performed on an undefined segment or bank, or on a
segment that is not contained in the specified bank.
*ERROR: BDI of entry point entry-point not available to element due to
local inclusion
The entry point has been referenced by BDICALL$ or BDIREF$, but because of local
element inclusion, it is not defined for the referencing bank.
*ERROR: BDI value on BANKINFO directive is in error - AFCB attribute
ignored
The bank descriptor index (BDI) value cannot contain alphabetic characters. Only numeric
characters are allowed.
*ERROR: BDR attribute ignored - no BDR value specified
The bank descriptor register (BDR) attribute was specified on a BANKINFO directive
without a BDR value. The BDR value must be an integer from 0 to 3.
*ERROR: BDR value conflicts with BANKINFO attributes or bank options -
BDR value will be ignored
7830 9887–001 E–11

Collector Diagnostic Messages
The BDR value must be an integer from 0 to 3. The BDR value must not conflict with the
M and U options on the bank directive or with the subattributes specified with the
INITIAL attribute on the BANKINFO directive. The order of precedence is as follows:
IBANK,M or MAINI = BDR is 0
IBANK,U or UTILI = BDR is 1
DBANK,M or MAIND = BDR is 2
DBANK,U or UTILD = BDR is 3
*ERROR: BDR value conflicts with bank options - BDR value will be
ignored
The BDR value must be an integer from 0 to 3. The BDR value must not conflict with the
M and U options on the bank directive.
IBANK,M = BDR 0
IBANK,U = BDR 1
DBANK,M = BDR 2
DBANK,U = BDR 3
*ERROR: BDR value on bank card is in error - default values will be
used
The BDR value must be an integer from 0 to 3. Default values for initially loaded banks
are as follows:
IBANK,M = BDR 0
IBANK,U = BDR 1
DBANK,M = BDR 2
DBANK,U = BDR 3
The default value of 0 is used for banks that are not initially loaded.
*ERROR: BDR value on BANKINFO card is in error - default values will be
used
The BDR value must be an integer from 0 to 3. Default values for initially based banks
are as follows:
IBANK,M or MAINI = BDR is 0
IBANK,U or UTILI = BDR is 1
E–12 7830 9887–001

DBANK,M or MAIND = BDR is 2
DBANK,U or UTILD = BDR is 3
Collector Diagnostic Messages
The default value of 0 is used for banks that are not initially based. The format is as
follows:
BANKINFO BDR(#)
*ERROR: Bit limits defining field invalid in element element
The relocatable element is formatted incorrectly. It was either created incorrectly or has
been corrupted.
*ERROR: Both T and F options given - both ignored
The @MAP processor call statement contained both the T and F options.
*ERROR: CLRAFCM sensitivity of absolute element conflicts with SETAFCM
sensitivity of start address element
When the program is loaded for execution, the arithmetic fault compatibility mode is set
so that no interrupt is taken when a floating-point overflow, floating-point underflow, or
divide fault occurs. However, when execution is initialized, the program’s code expects
interrupts to be taken. This is a logical conflict.
*ERROR: Collector tag MAPCALL$ or MAPGOTO$ used without a link vector
bank
The Collector defined tags MAPCALL$ and MAPGOTO$ are used with a link vector bank.
A link vector bank is defined with the VECTOR attribute specified on the BANKINFO
directive.
*ERROR: Combined location counter location-counter length exceeds 262K
This message occurs with an R option collection when the combined lengths of all
location counters of the specified number in the included relocatable elements exceed
262K.
*ERROR: Common bank cannot be control bank - CONTROL attribute ignored
The X option or the BANKINFO AFCB(#) has been specified with the BANKINFO
CONTROL. The BANKINFO CONTROL is ignored.
*ERROR: Common bank cannot be control bank - C option ignored
Both C and X options have been specified on the same IBANK or DBANK source
directive. The C option (control bank) is ignored.
*ERROR: Common bank cannot be control bank - C option or CONTROL
attribute ignored
7830 9887–001 E–13

Collector Diagnostic Messages
The X option or the BANKINFO AFCB(#) has been specified with the BANKINFO
CONTROL or with the C option on the bank directive. The C option or the CONTROL
attribute is ignored.
*ERROR: Common block common-block included more than once either
directly or by FORM - only first IN of common block processed
The specified common block was either named on two or more IN directives or was
included more than once by use of the FORM directive.
*ERROR: Common block location counter used as INFO-8 location counter
in element element
The same location counter cannot be used both as INFO 8 and as a common block.
*ERROR: Control bank ambiguity - CONTROL attribute ignored
The C option or the BANKINFO CONTROL can be specified only once in a collection for
either an IBANK or DBANK source directive. The C option or the CONTROL attribute has
already been specified once.
*ERROR: Control bank ambiguity - C option ignored
The C option can be specified only once in a collection on either an IBANK or DBANK
source directive. The C option has already been specified once.
*ERROR: Control bank has S option - segmentation not allowed
A program whose control bank has the S option specified contains segments.
*ERROR: COR calls on undefined location counter location-counter in
element element
The specified location counter number is not present in the named relocatable element.
*ERROR: COR ignored - No global location counter location-counter in
element element
A COR source directive specified a location counter that was not included globally in a
bank-named collection.
*ERROR: COR not used with R option
A COR source directive appeared in an R option collection. The source directive is
ignored.
*ERROR: COR of nonexistent element element
A COR source directive specified an element that was not included in the collection.
*ERROR: CSF$ status status from image
E–14 7830 9887–001

Collector Diagnostic Messages
The image was rejected by ER CSF$. The file named is excluded from the collection. See
the Exec System Software Executive Requests Programming Reference Manual for
status description.
*ERROR: DBJ$ is not used in an op code field - referenced in element
The symbol DBJ$ must appear as an external reference in bits 0 through 9. See 4.5.1 for
correct use of DBJ$.
*ERROR: DEF and REF not allowed with V option
A DEF or REF directive has been specified with a V option collection. The directives are
ignored because the tables generated by these directives are placed in the program’s D
bank, which will be nonexistent in the absolute element.
*ERROR: Directed LIB for file file-name illegal - LIB file-name assumed
A directed LIB directive has been found in a bank-implied collection. The directive is
processed as LIB file-name.
*ERROR: DLIB directive is valid only for bank named collections -
directive ignored
A directed LIB (DLIB) directive has been found in a bank-implied collection. The directive
is ignored.
*ERROR: DLIB directive is valid only with DEFAULT$LIBS - directive
ignored
The keyword DEFAULT$LIBS must be used on the DLIB directive. The format is - DLIB
DEFAULT$LIBS.(bank-name/$lcs,…)
*ERROR: DLIB directive ignored - first occurrence of DLIB directive
will be used
The DLIB directive can be used only once. The first occurrence of the DLIB directive will
be used. All other occurrences are ignored.
*ERROR: DLIB directive not allowed in R option collections
Default libraries are not searched during R option collections. The DLIB directive is not
allowed in R option collections.
*ERROR: bank-name does not exist as a common bank
The name of the common bank specified for initial basing is not defined in the collection.
*ERROR: Element element ambiguity in file file-name Element list:
The specified element name is found for more than one relocatable element in the file.
The list following the message contains the element name and version name for each
7830 9887–001 E–15

Collector Diagnostic Messages
such element in the file. None of the listed elements is included in the collection. CLASS
directives can resolve the ambiguity.
*ERROR: Element element exists in file file-name with different
versions
The specified element exists in the named file with more than one version name.
*ERROR: Element element/version in file file-name bypassed - duplicates
element name already specified
In processing a whole file IN (IN file-name.), an element in file-name is found that
duplicates the name of an element from an IN directive from another file.
*ERROR: Element element in file file-name bypassed - duplicates already
encountered common block
A relocatable element with the same name as a common block that has already been
included in the collection is encountered. The relocatable element is ignored.
*ERROR: Element inclusion is not allowed after FORM directive on a bank
A directive of the form FORM bank-name was followed by an IN directive. The IN
directive is ignored since the FORM directive implies that the bank structure is to be the
same as the specified bank.
*ERROR: Element element not found in file file-name
The element specified on an IN directive could not be found in the named file.
*ERROR: Element element not included - has zero length location counter
location-counter - no value given
The specified element contains a zero length location counter and is excluded from the
collection.
*ERROR: Element element specified on TYPE IBJLNK not included in
collection
A TYPE IBJLNK source directive was specified with the named element that was not
included in the collection.
*ERROR: Element element start address not used - not initially loaded
The specified element is not in an initially based bank.
*ERROR: Element element start address address not used - outside main
segment limits
The specified element’s start address is not included in the main segment of a bank.
E–16 7830 9887–001

Collector Diagnostic Messages
*ERROR: Element element used BDICALL$/BDIREF$ with label which is
defined under zero length location counter - cannot be satisfied
The label used with BDICALL$/BDIREF$ in the named element is defined under a zero
length location counter.
*ERROR: Element element used BDICALL$/BDIREF$ with label which is local
to another bank - cannot be satisfied
The specified element used BDICALL$/BDIREF$ with a label that is defined in an
element that was locally included in another bank.
*ERROR: Element element was not found for COR
An element named on a COR parameter was not found.
*ERROR: Element element was not found for SNAP
An element named on a SNAP parameter was not found.
*ERROR: ENT directive cannot have a numeric field
The parameter field of the ENT directive must contain an externalized entry-point name.
*ERROR: ENT entry point entry-point not global - not used
The named entry point that was specified on an ENT directive is included only locally.
*ERROR: Entry point entry-point ambiguity in file file-name Element
list:
The specified entry point was found in more than one element in the file. A list of the
elements in which it was found follows. CLASS or NOT directives can help correct the
problem. This message is not printed for FORTRAN library entry points B2L$ and B2O$,
which are handled as special cases.
*ERROR: Entry point entry-point in indirect segment referenced
illegally with offset from element
An entry point in the I bank of an indirectly loaded segment cannot be referenced with a
plus or minus offset unless the reference is made from within the segment containing
the entry point. If the reference is from outside the segment containing the entry point,
the offset is ignored.
*ERROR: Entry point entry-point not defined in bank bank-name - no
window created
The entry point/tag specified on the WINDOW directive must be defined in the bank
where the window is defined.
*ERROR: Entry point entry-point not global - zero used in COR
7830 9887–001 E–17

Collector Diagnostic Messages
A value of zero has been used for an entry point specified in a COR source directive as
no global value was found for the entry point.
*ERROR: Entry point entry-point not global - zero used in SNAP
A value of zero has been used for an entry point specified in a SNAP source directive as
no global value was found for the entry point.
*ERROR: Entry point entry-point not valid in both REF and DEF
The same entry-point name has been specified on both a DEF and REF source directive.
The first source directive with the name is the only one processed. All others are
ignored.
*ERROR: Entry point entry-point referenced from element element is
undefined name
A reference to an entry point that is not defined in any of the elements included in the
collection has occurred. This message is not printed if the reference is made from a
code-stripped bank.
*ERROR: Entry point entry-point referenced from element element is
undefined name for bank bank-name
Because of local element inclusion, the specified entry point cannot be referenced from
the named bank.
*ERROR: Entry point entry-point referenced from entry point entry-point
is undefined name
A reference to an entry point from another entry point has occurred. The first entry point
is not defined in any of the elements included in the collection.
*ERROR: Entry point entry-point specified on TYPE IBJLNK not defined in
collection
A TYPE IBJLNK source directive was specified with an entry point that was not defined
in any element included in the collection.
*ERROR: Entry point entry-point used to define entry point entry-point
is not an absolute value
A reference to an entry point from another entry point has occurred. The first entry point
is not an absolute value.
*ERROR: ENT specified entry point entry-point is not in an initially
based bank
The program start address must be in an initially based bank.
*ERROR: ENT specified entry point entry-point is not in any included
element - not used
E–18 7830 9887–001

Collector Diagnostic Messages
The entry point specified on an ENT source directive could not be found in any element
included in the collection.
*ERROR: ENT specified entry point entry-point is not in the main
segment
The program start address must be in the main segment.
*ERROR: EXTENDED and NOTEXTENDED attribute conflict - both ignored
Both the B option or EXTENDED attribute and the N option or NOTEXTENDED attribute
were specified for the same BANK directive.
*ERROR: File file-name does not contain an entry point table
The named file specified on a LIB directive has either not been prepared (@PREP) or
contains no entry points. The file is not searched for entry points but it can be searched
for elements named on IN directives with no file name.
*ERROR: File file-name is empty
The specified file that was named on a source directive in the collection contains no
elements.
*ERROR: File file-name not properly released - error return from
POSTPR$ - CSF$ status: status
An error occurred while the Collector was trying to perform an @FREE command on the
named file. See the Exec System Software Executive Requests Programming Reference
Manual for status description.
*ERROR: FIRSTBDI specification is allowed only for TYPE EXEC
collections
The collection must be TYPE EXEC to use the FIRSTBDI directive.
*ERROR: FIRSTBDI value is in error - directive ignored
An integer must be specified in the value field. The default value of 4 will be used.
*ERROR: First segment is main segment - may not be DSEG
The first segment named in a bank-implied collection and the first segment named
following a bank statement in a bank-named collection cannot be a dynamic segment.
*ERROR: First segment is main segment - may not be RSEG
The first segment named in a bank-implied collection and the first segment named
following a bank statement in a bank-named collection cannot be a relocatable segment.
*ERROR: FORM cannot specify current bank and segment
7830 9887–001 E–19

Collector Diagnostic Messages
The FORM source directive was specified with the same bank-name and segment name
as those that are currently being defined.
*ERROR: FORM ignored - SEG directive needed immediately preceding FORM
In a segmented collection, a FORM bank-name*segment-name directive immediately
follows an IBANK or DBANK directive. The main segment must be named on a SEG
directive preceding the FORM directive.
*ERROR: FORM on bank-name not allowed after SEG or IN directive
A SEG or IN directive appeared before a FORM directive that specified only the bank
name; that is, FORM bank-name.
*ERROR: FRSTIN ignored - not allowed with filename only
A FRSTIN source directive was specified with a file name only. An element name must
also be given on the FRSTIN directive.
*ERROR: FRSTIN ignored - only allowed for first element in segment
A previous FRSTIN source directive had appeared for this segment. This directive is
treated as an IN directive for the element.
*ERROR: Generated address address in element element is out of range
The D option was specified and an address field has been detected that is outside the
address limits for the program.
*ERROR: file-name has wrong project for private file
The wrong project was specified for a private file.
*ERROR: IBJ$ is not used in an op code field - referenced in element
element
The symbol IBJ$ must appear as an external reference in bits 0 through 9. See 4.5.1 for
correct use of IBJ$.
*ERROR: name ignored - format or terminator error
The TYPE directive has an illegal terminator following the specified parameter, or the
parameter is illegal.
*ERROR: name ignored - TYPE parameter conflict
The named parameter directly contradicts a parameter already processed on a TYPE
directive or an option on the processor call statement.
*ERROR: Illegal attribute name ignored
E–20 7830 9887–001

Collector Diagnostic Messages
The named illegal attribute was specified on a BANKINFO source directive. The attribute
is ignored and the collection is continued.
*ERROR: Illegal group number value in INFO directive in element element
is ignored
The specified group number named on an INFO directive in the named relocatable
element is not a legal value.
*ERROR: Illegal option char disregarded
The named illegal option was specified on an IBANK or DBANK source directive. The
option is ignored and the collection is continued.
*ERROR: Illegal subattribute name ignored
The named illegal subattribute was specified on a BANKINFO source directive. The
subattribute is from the INITIAL attribute. Legal subattributes are: MAINI, MAIND, UTILI,
UTILD, BDR0, BDR1, BDR2, and BDR3. The subattribute is ignored and the collection
continues.
*ERROR: Indirect load subroutines not available - IDL entries filled
with ER ERR$ instructions
The indirect load routines are required if a segment must be indirectly loaded. They have
been excluded from this collection, possibly because of a NOT SYS$*RLIB$ directive.
*ERROR: INFO 11 entry for bank-name ignored in element element -
duplicates existing name
The name specified on a Meta-Assembler (MASM) INFO group 11 directive can appear
only on another INFO group 11 directive.
*ERROR: INITIAL attribute ignored - no subattributes specified
The INITIAL attribute must have one or more of the following subattributes specified:
MAINI, MAIND, UTILI, UTILD, BDR0, BDR1, BDR2, or BDR3. The INITIAL attribute is
ignored because there were no subattributes specified.
*ERROR: file-name is not a sector-formatted mass storage file
*ERROR: file-name is not cataloged or assigned
The specified file that was named on a source directive in the collection is not a
cataloged file or is not assigned to this run.
*ERROR: entry-point is not defined - no window created for bank bankname
The entry point/tag specified on the window directive is not defined.
*ERROR: LEVEL attribute ignored - no LEVEL value specified
7830 9887–001 E–21

Collector Diagnostic Messages
The LEVEL attribute was specified on a BANKINFO directive without a LEVEL value. The
LEVEL value must be an integer from 0 to 3. Default value of 2 is used.
ERROR: LEVEL specification not allowed with R-option collections
The LEVEL directive has no meaning for collections producing relocatable element
output.
ERROR: LEVEL value is in error - directive ignored
The LEVEL value field must be an integer from 0 to 3. The default value of 2 is used.
ERROR: LEVEL value on bank card is in error - default values will be
used
The LEVEL field must be an integer from 0 to 3. The default LEVEL for the collection is
assigned to the bank.
*ERROR: LEVEL value on BANKINFO directive is in error - default values
will be used
The LEVEL value must be an integer from 0 to 3. The default value of 2 is used.
ERROR: LEVEL 1 is assumed for Common Banks - specified level is ignored
The BANKINFO AFCB(name,bdi) attribute was specified. Level 1 is assumed for
common banks (see 6.6). Either the level was specified on the bank directive or on the
LEVEL directive. The specified level is ignored and level 1 is used for the common bank.
*ERROR: Limit is 16 SNAPs per collection
The immediately preceding SNAP directive is ignored because 16 snaps have already
been made.
*ERROR: Local-global conflict - entry point entry-point referenced by
location counter location-counter element element bank bank-name
Due to local inclusion of the location counter under which the entry point is named, more
than one value for that entry point can be referenced from the named bank. A value of
zero is used to satisfy the reference to the entry point.
*ERROR: Local-global conflict - location counter location-counter
referenced by location counter location-counter element element
*ERROR: Local-global conflict - location counter location-counter
referenced by location counter location-counter element element bank
bank-name
The first location counter has been locally included so that the named bank can access
the location counter in more than one bank. A value of zero is used for the location
counter’s assigned value because it is impossible to determine which of the available
values should be used.
E–22 7830 9887–001

Collector Diagnostic Messages
*ERROR: Location counter location-counter unknown to location counter
location-counter in element element
In a bank-implied collection, this message usually indicates an erroneously formatted
relocatable that contains a reference to a nonexistent location counter.
*ERROR: Location counter location-counter unknown to location counter
location-counter in element element bank bank-name
Because of local inclusion of the element, the reference made to the first location
counter number cannot be satisfied as it is not in any bank set specified for the second
location counter number. In rare cases, this can indicate an erroneously formatted
relocatable that contains a reference to a nonexistent location counter.
*ERROR: MAPCALL$ is not used in an op code field - referenced in
element element
The symbol MAPCALL$ must appear as an external reference in bits 0 through 9.
*ERROR: MAPGOTO$ is not used in an op code field - referenced in
element element
The symbol MAPGOTO$ must appear as an external reference in bits 0 through 9.
*ERROR: Minimum gap size in error - system value of 10 is used
A format error was detected on the MINGAP source directive. The directive is ignored
and the system value is assumed.
*ERROR: Minimum load size in error - system value of 10 is used
A format error was detected on the MINSIZ source directive. The directive is ignored and
the system value is assumed.
*ERROR: file-name needs a read-key or is write-only
*ERROR: No absolute element produced by Collector
A fatal error in the collection or the presence of the X option has prevented the output of
an absolute element. The preceding diagnostic messages specify the error or errors.
*ERROR: No continuation statement found
No further statement was found following the continuation character (;).
*ERROR: No element with DEF entry point entry-point
No element was found that contained the specified DEF entry point.
*ERROR: No relocatable element produced by Collector
7830 9887–001 E–23

Collector Diagnostic Messages
Due to a fatal error or the X option, no relocatable element was produced in an R option
collection. The preceding messages specify the error or errors.
*ERROR: No start address
No ENT directive was used in the collection and none of the preambles of the included
relocatable elements indicated a start address.
*ERROR: Not enough B(X) registers specified on the VECTOR attribute
Another B register is needed on the BANKINFO directive with the VECTOR attribute
specified. Each B register corresponds to 4,096 link vector entries.
*ERROR: Number in COR address field is over 0177777 (65K)
A COR source directive was specified with an address field greater than 0177777 (65K).
*ERROR: Offset not numeric on EQU directive
An EQU source directive was specified with a non-numeric offset field. The offset field
on the right-hand side of an EQU directive must be numeric.
*ERROR: Only D (Dynamic), R (Readonly), N (Extended), and O
(Overridemin) options (attributes) allowed with VECTOR attribute - all
others ignored
Only the D, R, N, and O options are allowed with the link vector bank. Only the Dynamic,
Readonly, Extended and Overridemin attributes are allowed with the link vector bank. All
other options or attributes are ignored.
*ERROR: PFI$ error status status for file file-name
An ER PFI$ was performed and received an error status. The possible values are defined
in the Exec System Software Executive Requests Programming Reference Manual.
*ERROR: Previous ENT directive overrides this one
An ENT directive appeared previously in the collection. This directive is ignored.
*ERROR: Previous IN overrides this one for file file-name
In a bank-implied collection, an IN directive of a whole file can occur only once. Only the
first IN file-name is processed.
*ERROR: Previous IN overrides this one for the element name element
In a bank-implied collection, an element can be included only once in a collection. Only
the first inclusion is processed.
*ERROR: $ prefixed to common block name to avoid duplicating element
name element
E–24 7830 9887–001

Collector Diagnostic Messages
A common block was included that had the same name as the named element that was
previously included.
*ERROR: Relocatable element element is in error
The specified element was marked in error by the processor that generated it.
*ERROR: Relocatable element element not found
The element specified on an IN directive with no file name could not be found in any of
the files named on LIB directives.
*ERROR: Relocatable element element/version not found
The specified element was named on an IN directive with no file name and could not be
found in any of the files named on LIB directives.
*ERROR: Required subfield missing on above directive
A required subfield was omitted.
*ERROR: RSEG cannot be used to define a SEG
A relocatable segment cannot be present in the relationship field of a SEG directive. The
RSEG is ignored in the relationship list.
*ERROR: RSEG directive uses no fields or characters other than name
An RSEG source directive was specified other than as RSEG segment-name.
*ERROR: S-option banks do not allow segmentation - treated as dynamic
A SEG directive has appeared for a bank that was specified with an S option.
*ERROR: S-option bank invalidates Z option on processor call
The S option on a bank directive overrides the Z option on the processor call because the
Exec requires the diagnostic tables to process nonconfigured common banks (NCCB).
*ERROR: Same location counter used for different common blocks in
element element
The same location counter was specified in the named relocatable to define more than
one common block.
*ERROR: SEG cannot overlay main segment - has been changed to follow
main segment
A SEG source directive of the form SEG A,B was specified where B is the main segment
name.
*ERROR: SEG not used with R option
7830 9887–001 E–25

Collector Diagnostic Messages
A SEG source directive appeared in an R option collection.
*ERROR: SETAFCM sensitivity of absolute element conflicts with CLRAFCM
sensitivity of start address element
When the program is loaded for execution, the arithmetic fault compatibility mode will be
set so that an interrupt is taken when a floating-point overflow, floating-point underflow,
or divide fault occurs. However, when execution begins, the program’s code does not
expect an interrupt to occur. This is a logical conflict.
*ERROR: SIR$ detected an error for the symbolic input image or the
symbolic output image
A SIR$ error message is printed immediately before this message. The System Service
Routines Library (SYSLIB) Programming Reference Manual, Appendix B contains a complete
description of SIR$ error messages. All messages indicate an error for Collector source
language input from the runstream or from the SI element or for Collector source output
to the SO element.
*ERROR: SNAP calls on undefined location counter location-counter in
element element
The location counter number on a SNAP directive does not exist for the element.
*ERROR: SNAP$ element not found - no snapshots taken
The SNAP$ element that produces the requested snapshot dumps has not been found.
*ERROR: SNAP ignored - no global location counter location-counter in
element element
A SNAP source directive specified a location counter that was not included globally in a
bank-named collection.
*ERROR: SNAP not used with R option
A SNAP source directive appeared in an R option collection.
*ERROR: SNAP of nonexistent element element
*ERROR: Storage Preference specification is no longer allowed. E, P,
$E, or $P option ignored
The E, P, $E, and $P options refer to storage preference on older hardware no longer
supported by the Executive. Please remove them from the map symbolic since they can
be reused in a future release of the Collector.
*ERROR: Text generated under location counter location-counter outside
range for element element
More text was generated under a location counter than was specified in the preamble of
the named relocatable element. This usually means an erroneous relocatable.
E–26 7830 9887–001

*ERROR: This segment is used to define itself
Collector Diagnostic Messages
The segment being defined in the immediately preceding SEG or DSEG directive has its
own name present in the relationship list. The name in the relationship list is ignored.
*ERROR: Too many characters in a subfield
A subfield in the immediately preceding source directive has too many characters. The
source directive is bypassed.
*ERROR: Too many register pairs - only 14 allowed, others ignored
A register pair is a B register or a B register followed by an X register, specified on the
VECTOR attribute, BANKINFO VECTOR(B2 B3,X3). The first register pair is B2. The
second register pair is B3,X3. Only 14 pairs are allowed with the VECTOR attribute.
*ERROR: Truncation of field value at address address bits bits - bits
in element element
The value to be placed in the specified field size is too large and was truncated. The left
portion of the value is truncated. This occurs, for instance, when an address over 65,535
is supposed to be placed in the U portion of an instruction that is only 16 bits long.
*ERROR: TYPE COMSEG ignored for bank-implied collection
A TYPE COMSEG directive appeared in a bank-implied collection. This directive is
ignored.
*ERROR: TYPE EXEC not allowed with R-option collection
TYPE EXEC has no meaning for collections producing relocatable element output.
*ERROR: TYPE NPEDIAG directive not allowed with R-option collection
TYPE NPEDIAG has no meaning for collections producing relocatable element output.
*ERROR: TYPE READONLY ignored for banked or segmented collection
The TYPE READONLY directive can be used only with bank-implied collections. In a
bank-named collection, use the R option on IBANK and DBANK directives instead. A
read-only bank cannot be segmented.
*ERROR: Use of bank-name or segment-name segment not allowed with
BDICALL$/BDIREF$ - entry point must be used
The specified bank name or segment name was used with either BDICALL$ or
BDIREF$. An entry point must be used with BDICALL$ or BDIREF$.
*ERROR: VECTOR attribute ignored - B register is out of range
B register can be a value from B2 to B15, or B2 to B31 for TYPE EXEC collections.
7830 9887–001 E–27

Collector Diagnostic Messages
*ERROR: VECTOR attribute ignored - Common Bank cannot be the Link
Vector bank
The X option of AFCB attribute was specified for the link vector bank. The link vector
bank cannot be a common bank.
*ERROR: VECTOR attribute ignored - Link vector bank already defined
There can be only one link vector bank per collection.
*ERROR: VECTOR attribute ignored - No B register specified
The BANKINFO directive with the VECTOR attribute was specified without a B register.
BANKINFO VECTOR(B3).
*ERROR: VECTOR attribute ignored - No X register specified.
The VECTOR attribute was specified on the BANKINFO directive with a comma after the
B register but no X register. There must be a comma between the B and X register.
There must be a space between each pair of B and X registers: BANKINFO VECTOR
(B3,X3 B4,X4)
*ERROR: VECTOR attribute ignored - SEG, IN or FORM specified
The Collector builds the link vector bank; therefore, no SEG, IN, or FORM directives can
be specified for the link vector bank.
*ERROR: VECTOR attribute ignored - SEGs used in collection
No SEG directives are allowed in a collection that contains a link vector bank.
*ERROR: VECTOR attribute ignored - X register is out of range
X register can be a value from X1 to X15.
*ERROR: VOID attribute ignored - only allowed with D option or DYNAMIC
attribute
Only the D option or the Dynamic attribute from the BANKINFO directive is allowed with
the VOID attribute or the Z option for the IBANK and DBANK directives.
*ERROR: VOID attribute ignored - previous IN, SEG or FORM directive
encountered
The bank will not be VOID; no IN, SEG, or FORM directives are allowed for a VOID bank.
*ERROR: entry-point was a DEF entry point but was never defined
A DEF source directive specified an entry point that was never defined by any element
included in the collection.
E–28 7830 9887–001

Collector Diagnostic Messages
*ERROR: WINDOW address defined by entry point entry point is a negative
value
This error indicates that the entry point used in the address field of the WINDOW
directive has a negative value.
*ERROR: WINDOW directive ignored - address specified is a negative
value
This error indicates that the constant value specified in the address field of the WINDOW
directive is negative.
*ERROR: WINDOW directive ignored - B register out of range
B register specified on the WINDOW directive is out of range. The range is B2 to B15 for
normal collections, and B2 to B31 for TYPE EXEC collections.
*ERROR: WINDOW directive ignored - No B register specified
No B register was specified on the WINDOW directive. See 6.10 for the proper syntax of
the WINDOW directive.
*ERROR: WINDOW directive ignored - No X register specified
No X register was specified on the WINDOW directive. See 6.10 for the proper syntax of
the WINDOW directive.
*ERROR: WINDOW directive ignored - SEGs used in collection
The WINDOW directive cannot be used in collections with segmentation.
*ERROR: WINDOW directive ignored - syntax error - a space must separate
the WINDOW directive from its parameters
There must be a space after the WINDOW directive and a space before either the
address specified or the parentheses.
*ERROR: WINDOW directive ignored - syntax error while processing the
window address
This indicates that an error was encountered while processing the address field of the
WINDOW directive. You may have used an invalid character in the address field.
*ERROR: WINDOW directive ignored - X register out of range
X register specified on the WINDOW directive is out of range. The range is X1 to B15.
*ERROR: XSEG directives allowed only for TYPE EXEC collections - XSEG
directive ignored
XSEG directives cannot be used unless a TYPE EXEC directive was given previously
within the collection.
7830 9887–001 E–29

Collector Diagnostic Messages
*ERROR: Z option ignored - not allowed with options other than D
Only the D option is allowed with the Z option on the IBANK and DBANK directives.
E.4. WARNING Messages
*WARNING: Bank bank-name is not an extended mode bank and a WINDOW
directive was specified
The bank containing the WINDOW directive is not an extended mode bank.
*WARNING: BDR attribute overrides previous BDR value specified
A BDR value has already been specified either on the bank directive or on a previous
BDR attribute specified on a BANKINFO directive. The new BDR value is used.
*WARNING: Blank specification - TPF$ assumed
There is a void subfield on an IN or NOT directive. This is not necessarily an error, but it
can indicate a typographical error in a Collector directive.
*WARNING: Common block common-block not in D-bank - minimum address
ignored
The INFO 3 value is for a common block not included in the D bank; thus it is ignored.
*WARNING: Control bank changed to bank-name - S and C option conflict
on bank bank-name
A nonconfigured common bank (NCCB) cannot be a control bank.
*WARNING: Control bank bank-name not initially based
The control bank is assumed to be always based, so tables generated by the Collector
and some implicitly included routines are placed there. Attempts to reference these
tables and routines cannot be successful.
*WARNING: Control bank will be code stripped
The V and C options have been used together on a bank directive, thus causing the
control bank to be code-stripped.
*WARNING: Element element entry point entry-point already defined
The specified entry point found in the named element has already been defined in
another element. The entry point in the named element is not used.
WARNING: Element element entry point entry-point already defined by
BANK directive
E–30 7830 9887–001

Collector Diagnostic Messages
The specified entry point found in the named element has already been defined by an
IBANK or DBANK directive. The entry point in the named element is not used.
*WARNING: Element element entry point entry-point already defined by
EQU directive
The specified entry point found in the named element has already been defined by an
EQU directive. The entry point in the named element is not used.
*WARNING: Element element entry point entry-point already defined by
REF directive
The specified entry point found in the named element has already been defined by a REF
directive. The entry point in the named element is not used.
*WARNING: Element element entry point entry-point already defined by
SEG directive
The specified entry point found in the named element has already been defined by a
SEG, DSEG, RSEG, or XSEG directive. The entry point in the named element is not used.
*WARNING: Element element has no location counters - not included
The named element contains no code, possibly because of ON and OFF directives. It is
not included in the collection.
*WARNING: Element element minimum address ignored - bank has user
specified starting address or O option
Location counter 0 in the element is contained in a bank that has a numeric start address
specified by the user. The INFO 3 value for the element is ignored.
*WARNING: Element element minimum address ignored - location counter 0
not in D-bank
The INFO 3 value for the element applies to location counter 0. Location counter 0 must
be contained in a D bank; if it is not, the INFO 3 value is ignored.
*WARNING: Element element minimum address ignored - location counter 1
not in I-bank
The INFO 3 value for the element applies to location counter 1. Location counter 1 must
be contained in an I bank; if it is not, the INFO 3 value is ignored.
*WARNING: Element element referencing external reference value at
address address greater than largest defined in this relocatable
*WARNING: Element element referencing location counter location-counter
at address address greater than largest defined in this relocatable
*WARNING: Element element referencing location counter location-counter
undefined for this relocatable
7830 9887–001 E–31

Collector Diagnostic Messages
The preceding three messages indicate probable format errors in a relocatable element.
*WARNING: Element element start address not used - alternative found
A previous element included in the collection has already specified the start address for
the absolute. The specified element’s start address is ignored.
*WARNING: Element element start address used - bank containing start
address is not initially based
This warning is issued for TYPE COMMONBANK collections. The program will not load
and execute unless the bank containing the start address is the template for an AFCB
bank that is initially based.
*WARNING: ENT specified entry point entry-point may not be in an
initially based bank
An ENT directive was used to specify an entry point in a common bank.
*WARNING: Entry point entry-point is undefined - EQU invalid
When using the EQU directive in the form ’EQU name/symbol’, the symbol must be
defined. If it is not defined, the EQU is invalid. The name remains undefined in the
relocatable being produced.
*WARNING: Entry point entry-point not found for COR
The specified entry point named on a COR source directive could not be found in any
element included in the collection.
*WARNING: Entry point entry-point not found for SNAP
The specified entry point named on a SNAP source directive could not be found in any
element included in the collection.
*WARNING: Entry point entry-point under void location counter locationcounter
assigned value value
An entry point that is assigned under a location counter with no length has been given
the specified value.
*WARNING: Error occurred trying to access SYS$*DATA$.LIB$NAMES
*WARNING: Extended mode requirement from element overridden by B option
on bank bank-name
An element containing an INFO 10 location counter was included in a bank that was
marked as not requiring extended mode.
*WARNING: FIRSTBDI overrides previous FIRSTBDI directives
E–32 7830 9887–001

Collector Diagnostic Messages
Only one FIRSTBDI value can be specified. The value used is taken from the last
FIRSTBDI directive.
*WARNING: I-bank bank-name address exceeds 0177777 (65K)
This is a restriction on older unsupported Series 1100 systems. The restriction does not
apply to supported systems. This warning is printed for a bank-named collection.
*WARNING: I-bank address exceeds 0177777 (65K)
This is a restriction on older unsupported Series 1100 systems. The restriction does not
apply to supported systems. This warning is printed for a bank-implied collection.
*WARNING: Keyword name not found in SYS$*DATA$.LIB$NAMES
A keyword entry in an INFO group 12 item could not be located in the element
LIB$NAMES.
*WARNING: L option used on bank bank-name that is not a based static
bank
The L option was specified on an IBANK or DBANK directive that either did not have the
M or U option specified, or had the D (dynamic) option specified.
*WARNING: LEVEL attribute overrides previous LEVEL value specified
A LEVEL value has already been specified on the bank directive, on the LEVEL directive,
or on a previous LEVEL attribute specified on a BANKINFO directive. The new level value
is used.
*WARNING: LEVEL overrides previous LEVEL directives
Only one LEVEL value can be specified. The value is taken from the last LEVEL directive.
*WARNING: LIB file name ignored - no previous LIB direction given
The named file is not searched because no format 3 LIB (bank-name/$lcs...) was given.
*WARNING: Location counter list specified without leading $ - assumed
*WARNING: More than one global inclusion of location counter locationcounter
element element
In a bank-named collection, the element or part of the element has been included more
than once without a local bank-set list. An element or part of an element can be included
locally many times but can be included globally only once.
*WARNING: More than one global inclusion of location counter locationcounter
for element element (Location counter is void)
In a bank-named collection, the element or part of the element has been included more
than once without a local bank-set list. An element or part of an element can be included
7830 9887–001 E–33

Collector Diagnostic Messages
locally many times but can be included globally only once. The specified location counter
is void.
*WARNING: * not needed - main segment stays loaded
The indirect load indicator (*) was used in specifying the main segment. The asterisk is
ignored.
*WARNING: N option bank requires TYPE BLOCKSIZE64 if activity local
stack or return control stack is used
The activity local stack and the return control stack are used with the CALL instruction.
This is required by the hardware. The warning can be avoided by using TYPE
BLOCKSIZE64 in the map symbolic.
*WARNING: Number of words of INFO-8 text in the collection exceed
0777777 (262K) - no INFO-8 text output
The number of INFO 8 text words exceeded 262,143 in the collection. No words are
output because the length of this table is stored in a half-word in the absolute element
header table.
*WARNING: value possible bad instruction at address in element element
The D option was specified and an instruction appears to be illegal. Possible causes
include illegal address in u field, illegal j-designator on register transfer, or illegal jdesignator
for sign-extended reference.
*WARNING: Start of D-bank set as far as necessary or possible below
current standard 040000 to minimize using addresses over 0177777 -
program may not work correctly with standard common banks - alternative
is to use the E option
The start of the D bank was lowered to minimize using addresses over 65,535.
*WARNING: The V and Y options have been removed from the Collector
processor call statement. To void either Ibanks or Dbanks, use the Voption
on the bank directive.
*WARNING: Truncation and over-65K messages suppressed - max of value
reached
Only the first value truncation and address over 65,535 messages are printed. The value
is configuration dependent and is set at 50 in the released version.
*WARNING: segment used as main segment name unspecified in bank
In a bank-named, segmented collection, a bank did not have a main segment specified
by a SEG directive. Since all banks must have the same main segment name, a main
segment is created.
E–34 7830 9887–001

E.5. Information Messages
Collector Diagnostic Messages
An implicit @PREP of TPF$ occurred during this collection.
The Collector is designed to do special processing of file TPF$ if an @PREP is not
performed on the file at collection time. In order to do this, all elements in TPF$ are
temporarily brought into the collection whether referenced or not. This may cause some
unexpected side effects that can be resolved when the user knows that an implicit
@PREP of TPF$ occurred.
AFCM status of output element is CLRAFCM
The arithmetic fault compatibility mode for the output element is marked as clear. At
initial load time, the arithmetic fault compatibility mode setting is such that no interrupt
occurs for floating-point overflow, floating-point underflow, or divide fault.
AFCM status of output element is INSAFCM
The arithmetic fault compatibility mode for the output element is marked as insensitive.
At initial load time, the arithmetic fault compatibility mode setting is such that no
interrupt occurs for floating-point overflow, floating-point underflow, or divide fault.
AFCM status of output element is SETAFCM
The arithmetic fault compatibility mode for the output element is marked as set. At initial
load time, the arithmetic fault compatibility mode is such that an interrupt occurs for
floating-point overflow, floating-point underflow, and divide fault.
AFCM status of output element is UNKNOWN
The arithmetic fault compatibility mode for the output element is marked as unknown. At
initial load time, the arithmetic fault compatibility mode is determined by a system
generation parameter.
Value at address address in element element - will activate SNAP dump
prior to execution
A snapshot dump is taken at the specified address and then the specified instruction is
executed.
COR: value replaced value at address address in element element
The correction requested by a COR directive has been applied.
D-bank bank-name assigned such that INFO-3 or minimum specification
value address for element element is satisfied
The start address of the named bank has been adjusted so that the specified INFO group
3 value has been satisfied. The start addresses of all other banks related to this bank are
determined by the adjusted start address.
7830 9887–001 E–35

Collector Diagnostic Messages
ER ERRPR$ error value printing above message
An ER ERRPR$ has returned an error status.
(File Name: name * name)
This is printed for I/O errors following the description of the error.
I-bank bank-name assigned such that INFO-3 or minimum specification
value address for element element is satisfied
The start address of the named bank has been adjusted so that the specified INFO group
3 value has been satisfied. The start addresses of all other banks related to this bank are
determined by the adjusted start address.
Minimum address requirement address for element element reduced to
address to avoid addresses greater than 262K
In a bank-implied collection, the specified value of INFO group 3 was reduced to avoid
addresses greater than 262,143.
Minimum address requirement address for element element reduced to
address to avoid addresses greater than 262K for D-bank bank-name
The specified value of the INFO group 3 was reduced so that addresses did not exceed
262,143 for the named D bank.
Minimum address requirement address for element element reduced to
address to avoid addresses greater than 262K for I-bank bank-name
The specified value of the INFO group 3 was reduced so that addresses did not exceed
262,143 for the named I bank.
No elements in segment segment
This message is produced in bank-implied collections when a segment is found to have
no elements included in it.
No elements in segment segment, bank bank-name
This message is produced in bank-named collections when a segment is found to have
no elements included in it.
Quarter/Third-word insensitive
The absolute element is insensitive to the setting of PSR bit DB32; that is, it contains no
quarter-word or third-word references. It is executed in third-word mode.
Quarter-word sensitive
The absolute element requires PSR bit DB32 to be set initially; that is, it uses quarterword
references.
E–36 7830 9887–001

Collector Diagnostic Messages
Start of D-bank set above current standard 040000 in order to meet
minimum address requirement address of common block common-block
Start of D-bank set above current standard 040000 in order to meet
minimum address requirement address of element element
The start of the D bank was increased to satisfy the INFO 3 value specified by the
named element or common block.
Start of I-bank set above current standard 01000 in order to meet
minimum address requirement address of element element
The start of the I bank was increased to satisfy the INFO 3 value specified by the named
element.
Third-word sensitive
The absolute element requires PSR bit DB32 to be cleared initially; that is, it uses thirdword
references.
TPF$ treated as element
An IN TPF$ was encountered. Because no period followed the name, the name is
assumed to be that of an element. On the IN directive, all files must have a period
immediately following the file name. This is not necessarily an error, but it can indicate a
typographical error in a Collector directive.
7830 9887–001 E–37

Collector Diagnostic Messages
E–38 7830 9887–001

Appendix F
Program Segmentation
F.1. Introduction
The OS 2200 Collector still supports segmentation for compatibility with old programs.
However, segments are now considered obsolete because the OS 2200 hardware
supports banking rather than segmentation. A change from one bank to another often
requires only a single instruction (for example, LBJ) and is performed entirely by the
hardware, once the bank is initially loaded from the absolute element. Segments must
be loaded from the absolute element and require Exec involvement by an Executive
request interrupt. Therefore, banking is more efficient and is the preferred way of
dividing a program. Programs that currently use segmentation should be converted to
banking if possible, and new programs should use banking and avoid segmentation.
When an absolute program is being executed, it must reside in main storage. However,
there may not be enough available address space to contain the complete program.
Therefore, the program must be subdivided so that the various parts can be made
accessible as they are needed by the program being executed.
A segmented program consists of
• One main segment that resides in main storage throughout the execution of the
program.
• Subordinate segments that are loaded into main storage as they are needed.
As each subordinate segment is loaded into main storage, it may overlay and thus
destroy all or part of a previously loaded segment. The area overlayed is equal in size to
the size of the new segment. The main segment is never allowed to be overlayed except
by a relocatable segment (RSEG).
The absolute element resulting from the collection of various relocatable elements may
or may not be segmented. However, a nonsegmented program could be considered to
be a segmented program with only a main segment named $MAIN$. Likewise, a
program containing only segments can be considered to be a banked program with
precisely two banks, IBANK and DBANK. However, almost all segment control
information (specifically the segment load table) is omitted if segments are not used in
the program.
F.2. Segmentation Directives
The directives used to specify program segmentation are as follows:
7830 9887–001 F–1

Program Segmentation
SEG
RSEG
DSEG
IN
Informs the Collector of the beginning of a segment (see F.2. 1).
Informs the Collector of the beginning of a relocatable segment (see F.2.3).
Informs the Collector of the beginning of a dynamic segment (see F.2.2).
Specifies the elements to be included in the segment (see 3.1.1).
Segments may be loaded and executed independently. However, elements used by
other segments must be loaded in memory when the referencing segments are
executed.
Since each segment has a path leading back to the main segment (defined by the
relationships specified on the segmentation directives), elements that are implicitly
included and that are referenced by two or more segments are attached to the segment
that is located at the common point in the paths to the main segment of all referencing
segments. Elements specified on IN directives are never moved from the segment in
which they were specifically placed.
A segment cannot be loaded into a read-only bank.
F.2.1. SEG — Program Segmentation
Purpose
The SEG directive informs the Collector of the beginning of a program segment. All SEG
directive parameters are optional, except name-1.
Format
SEG name-1,segment-list
where:
name-1
specifies the name of the segment. When name-1 is followed by an asterisk (*), the
named segment is automatically loaded when referenced by a jump instruction.
Such a segment is called an indirect load segment. The asterisk is allowed on all
SEG directives, but is ignored if the directive defines the main segment.
segment-list
F–2 7830 9887–001

Program Segmentation
specifies the address relationship between the segment named in name-1 and the
other program segments named in segment-list. The segment-list parameter has
several formats that determine the addresses of the segment named in name-1:
No Entry
When segment-list is void, the starting address of the name-1 segment immediately
follows the last address of the segment named on the preceding SEG directive.
name-2
Specifies that the starting address of the name-1 segment is the same as the
starting address of the name-2 segment. These two segments can never exist in
main storage at the same time.
(name-2)
Specifies that the starting address of the name-1 segment immediately follows the
last address of the name-2 segment.
(name-2,...,name-n)
Specifies that the starting address of the name-1 segment immediately follows the
highest address of the segments specified in name-2, name-3, name-4, and so forth,
in each of the banks in which segment name-1 resides. Note that because segments
may span banks, the highest address of the last I bank may be a different value than
the value of the highest address of the last D bank.
( )
Specifies that the starting address of the name-1 segment immediately follows the
highest address of all segments previously named.
Description
The IN directive specifies the files and elements to be included in a segment. If no SEG
directive is encountered before the first IN directive following the @MAP control
statement, an implied SEG directive is assumed by the Collector. This segment is given
the name $MAIN$ by the Collector and is the segment that is processed until a SEG,
RSEG, or DSEG directive is encountered.
The segment name can contain 1 to 12 alphanumeric characters (with $ and - allowed).
The segment name must contain at least one alphabetic character and must not be the
same as any entry-point name in the collection. If the segment name is the same as an
entry-point name, the value of the segment is used to satisfy external references and a
message is printed.
The Collector assigns a number to each segment beginning with zero for the main
segment and continuing with 1 for the first segment name after the main segment, 2 for
the second segment, and so forth. This number is used as the value of the segment
name and is found in the Bank and Segment Index table in L and S option listings.
7830 9887–001 F–3

Program Segmentation
Within a segment, the Collector places any elements included to satisfy undefined
symbols at the beginning of the segment in the inverse order of their inclusion; that is,
the last included element is the first element in the segment. Following these implicitly
included elements are those named on IN directives in the exact order they were
named. When all elements within a file are included in a segment by specifying only the
file name on the IN directive, the ordering of the file’s elements within the segment is
undefined.
Example 1
1. SEG A
2. SEG B
3. SEG C,(A)
The program is to be divided into three segments.
1. Specifies segment A as the main segment.
2. Specifies that the starting address of segment B is immediately after the last
address of main segment A.
3. Specifies that the starting address of segment C is immediately after the last
address of main segment A. Segments B and C can never exist in main storage at
the same time.
Example 2
1. SEG A . MAIN SEGMENT
2. SEG B . Starting address of B immediately follows
. last address of A
3. SEG C . Starting address of C immediately follows
. last address of B
4. SEG D,(C) . Starting address of D immediately follows
. last address of C
F–4 7830 9887–001

Program Segmentation
5. SEG E,C . Starting address of E is the same as starting
. address of C
6. SEG F,(E) . Starting address of F immediately follows
. last address of E
7. SEG G,F . Starting address of G is the same as starting
. address of F
8. SEG M,B . Starting address of M is the same as starting
. address of B
9. SEG H,(M) . Starting address of H immediately follows
. last address of M
10. SEG I,H . Starting address of I is the same as starting
. address of H
11. SEG J,H . Starting address of J is the same as starting
. address of H
12. SEG K,(H,I,J). Starting address of K immediately follows the
. last address of H, I, or J, whichever is longest
13. SEG L*,() . Starting address of L immediately follows the
. highest last address of all the segments.
. Segment L is automatically loaded whenever an
. entry point included in the segment is referenced
. by a jump instruction.
Here is a diagram of this structure:
For a more extensive example, see Appendix B.
7830 9887–001 F–5

Program Segmentation
F.2.2. DSEG — Dynamic Segments
Purpose
The DSEG directive specifies the beginning of a dynamic segment. When indicated, the
program area occupied by a segment is not included in the initial program requirement
for main storage.
Format
DSEG name-1,segment-list
where:
name-1
specifies the name of the segment. When name-1 is followed by an asterisk (*), the
named segment is automatically loaded when referenced by a jump instruction.
Such a segment is called an indirect load segment. The asterisk is allowed on all SEG
directives, but is ignored if the directive defines the main segment.
segment-list
specifies the address relationship between the segment named in name-1 and the
other program segments (see F.2.1).
Description
Dynamic segments are identical to normal overlay segments (defined by the SEG
directive - see F.2.1) in all aspects except one: The program area assigned exclusively to
dynamic segments is not included when determining initial program size. It is the
programmer’s responsibility to guarantee that the program area is available by using the
MCORE$ request before requesting segment loading or to request segment loading by
means of the SYSLIB routine DLOAD$, which obtains the necessary program area
before initiating the segment load (see F.3.3).
Dynamic segments can be defined as indirect load and can be placed anywhere within
the segment structure of a program.
The program addresses assigned to DSEGs are not considered when determining the
initial I and D bank limits for a program. However, in assigning the values in LASTD$,
LASTDR$, LASTI$, LASTIR$, FIRST$, LAST$, and LASTR$, (see Section 7), DSEG
addresses are used.
F.2.3. RSEG — Relocatable Segments
Purpose
The RSEG directive specifies the named segment as a relocatable segment. A
relocatable segment (RSEG) is one whose location within the program is determined
dynamically by the program during execution rather than at collection time. RSEG text is
F–6 7830 9887–001

Program Segmentation
relocated by the Exec loader at load time. An RSEG can reference entry points within the
program, but the relocatable segment itself cannot contain definitions for references
located elsewhere in the program (unless the reference is of the form J TAG,x, where x,
an index register, contains the address at which the RSEG was loaded), since only
internal RSEG addressing is relocated during segment loading.
Format
RSEG name
where name specifies the relocatable segment.
Description
Elements included in relocatable segments must be explicitly named on IN directives
(see 3.1.1). When an element that is referenced by more than one segment is implicitly
included, it is placed in a segment other than the RSEG. Generally, it is advisable that if
an element is referenced by more than one segment (one of which is an RSEG), the
element should be explicitly included in the main segment.
Relocatable segments cannot be indirectly loaded. See F.3. 1 for the direct method of
loading segments.
The starting address of a relocatable segment has no relationship to other segments in
the collection. An RSEG may be loaded at whatever starting address is given in register
A2 during the LOAD$ calling sequence (see F.3.1). The LOAD$ request adds the value in
register A2 to all relative address references internal to the named relocatable segment.
This adds additional overhead to loading an RSEG. You must modify any references to
RSEG labels from outside the relocatable segment by the value in register A2.
All instructions and data in a relocatable segment are collected together with all odd
location counters followed by all even location counters.
A relocatable segment can be loaded into either an I bank or D bank of the program.
An element within an RSEG can define a common block that is located outside that
RSEG only if the common block of the RSEG element contains no text. Take note of this
if you use higher level languages such as FORTRAN.
F.3. Loading Program Segments
When a segmented program is called for execution (see 2.2.1), only the main segment is
initially loaded, but main storage is allocated for all segments except DSEGs and RSEGs.
Your program must load all other segments by either
• The direct method
• The indirect method
Whenever a segment is loaded, an initial copy of the segment is loaded. Once loaded, a
segment remains marked as loaded until all or part of its main storage space is overlayed
by another segment or released by means of ER LCORE$.
7830 9887–001 F–7

Program Segmentation
When a segmented program produced by a bank-named collection is called by an @XQT
control statement, only the main segment of each static bank or initially based dynamic
bank is loaded. The main segment of any other dynamic bank is automatically loaded
upon execution of an LIJ, LDJ, or LBJ instruction to that bank.
F.3.1. L$OAD,LOAD$ — Direct Method
When using the direct method of loading, you must use the L$OAD procedure or the
Executive request ER LOAD$. The L$OAD procedure is an assembler procedure located
in SYS$*RLIB$ or SYS$LIB$*SYSLIB. See the Exec System Software Executive
Requests Programming Reference Manual for information on the use of ER LOAD$.
Format
L$OAD name,jump,clear,rseg-addr,bank-name
where:
name
jump
clear
specifies the name of the segment to be loaded.
specifies the location where control is to be transferred after the segment is loaded;
if omitted, control passes to the location following the ER LOAD$.
determines whether or not the program area containing the segment is zero-filled. If
greater than zero, the area is not zero-filled before segment load. If zero or negative,
the area is zero-filled before segment load.
rseg-addr
specifies the starting address for the relocatable segment, if the segment was
defined by an RSEG directive. If omitted when loading a relocatable segment, the
address must be in register A2 before the call is made:
L,U A2,rseg-address
The address can be defined as an octal value or a tag not contained in an RSEG.
bank-name
is used only for loading an RSEG within a bank-named collection. It specifies the
bank into which the RSEG is to be loaded. If omitted, the bank-name must be in
register A2 along with the RSEG starting address:
LXI,U A2,bank-name
F–8 7830 9887–001

Description
Program Segmentation
The L$OAD procedure produces a sequence of code that loads register A0 with the
segment name, register A1 with jump address, register A2 with bank name and address
for RSEG, and generates the ER LOAD$. The L$OAD request takes the following form:
L,U A0,segment-name or L A0,(0400000,segment-name)
L,U A1,jump
L,U A2,rseg-addr or L A2,(bank-name,rseg-addr)
ER LOAD$
The segment-name is the same as the contents of the name-1 parameter on the SEG
directive (see F.2.1).
When bit 0 of register A0 is set, the segment loader does not clear the main storage
area to be occupied by the segment. This decreases the time required to load the
segment; however, as a result, any areas within the segment that are not initialized with
data and instructions cannot be assumed to be zero.
Segments within bank-named collections are directly loaded in the same manner as
segments within a bank-implied collection. However, a consideration in bank-named
collections is that each portion of that segment will be loaded into its respective bank.
Thus, all banks that contain portions of that segment must be either static or currently
based on the BDR0-3 at the time the segment is directly or indirectly loaded.
Examples
1. L$OAD NEW,ORG1
2. L$OAD CAP,YELL,0,01350
Description
1. After segment NEW is loaded, transfer control to location ORG1. The area occupied
by segment NEW is zero-filled before loading. The L$OAD procedure produces the
same effect as the following code:
L,U A1,ORG1
L,U A0,NEW
ER LOAD$
2. The area to be occupied by relocatable segment CAP is zero-filled before loading.
The starting address for segment CAP is 01350. After the segment is loaded, control
is passed to YELL. The L$OAD procedure produces the same effect as the following
code:
L,U A2,01350
L,U A1,YELL
L,U A0,CAP
ER LOAD$
7830 9887–001 F–9

Program Segmentation
F.3.2. Reloading the Main Segment
It may be desirable to reestablish the main segment of a program for either error
recovery or reinitialization. This is done by the LOAD$ request. The LOAD$ request
reloads the entire main segment including all initially produced Collector tables. The main
storage requirements remain unchanged.The calling sequence is
L A0,(clear,0400000)
L,U A1,reentry-addr
ER LOAD$
Register A0 is loaded with the segment-id of 0400000. The parameter clear functions as
follows:
• If clear is less than 0, the main segment area is not cleared before loading.
• If clear is greater than or equal to 0, the main segment area is cleared before loading
Register A1 is loaded with the reentry-addr according to the following:
• If the reentry-addr is equal to 0, control is returned to the instruction following the
LOAD$ request.
• If the reentry-addr is not zero, control is passed to that address.
In both bank-implied and bank-named programs, the same calling sequence is used to
reload the main segment.
The following considerations also apply to the main segment reload in bank-named
programs:
• Main segment is reloaded for all static banks and any dynamic banks that were
initially based.
• Any initially based dynamic bank must be based at the time of the main segment
reload. If not, the program will terminate in error.
• Any currently based dynamic banks that were not initially based will not have their
main segments reloaded.
• At the time of the reload, the current main storage requirements for all banks in
which the main segment is reloaded cannot be less than the banks’ initial main
storage requirements.
• All banks that are based at the time of a main segment reload are still based after the
reload has been performed.
F.3.3. D$LOAD,DLOAD$ — Loading Dynamic Segments
Dynamic segments can be loaded by referencing the dynamic load routine, which is a
relocatable element contained in SYSLIB. You can reference this routine explicitly, or
implicitly by the indirect load routine when a DSEG is marked for indirect load. The
dynamic load routine can be called for loading either DSEGs or normal segments.
The dynamic load routine determines whether the segment to be loaded is in fact a
dynamic segment. If it is not, an ER LOAD$ is executed for the segment. If the segment
F–10 7830 9887–001

Program Segmentation
is a dynamic segment, the routine acquires the necessary DSEG areas by means of ER
MCORE$ and then executes an ER LOAD$ to load the DSEG.
You can reference the dynamic load routine by using the D$LOAD procedure or by a
jump to DLOAD$.
Format
D$LOAD segment-name,jump,clear
where:
segment-name
jump
clear
specifies the name of the segment to be loaded.
specifies the location where control is to be transferred after the segment is loaded.
If control is to be passed to the location following the jump to DLOAD$, a *0 must
be placed in the jump parameter field or a tag must be placed on the line following
the D$LOAD procedure call and must be specified in the jump parameter field.
determines whether or not the program area containing the segment to be loaded is
zero-filled. If greater than zero, the area is not zero-filled before segment load. If zero
or negative, the area is zero-filled before segment load.
Description
The D$LOAD procedure generates the following sequence of code:
L,U A0,segment-name or L A0,(0400000,segment-name)
L,U A1,jump
J DLOAD$
When bit 0 of register A0 is set, the segment loader does not clear the main storage
area to be occupied by the segment.
F.3.4. Indirect Loading
Whenever a segment that is marked for indirect loading is referenced by any jump
instruction that passes control to an entry point in the segment’s I bank area, the
segment is automatically loaded if it is not already in main storage. Segments to be
loaded by the indirect method must be marked accordingly on the SEG directive.
The mechanics for such loading are set up by the Collector and carried out by the Exec
loader. The Collector replaces the address portion of the jump command with the
address of an indirect load table entry. The indirect load table performs an SLJ instruction
to the indirect load routine, which in turn performs an ER to the segment loader (if the
7830 9887–001 F–11

Program Segmentation
segment is not already loaded) and jumps to the location of the externally defined
symbol. All registers are preserved by the process. The Collector places the indirect load
table in the beginning of the main segment of the control bank.
If indirect loading is used, the reference cannot be made to an external symbol with an
offset.
If the B option was specified on the @MAP control statement, the indirect load routine
indicates that the segment’s main storage area need not be zero-filled.
Segments marked for indirect loading can also be loaded by the direct method.
There is no instruction interpretation performed to ensure that a referencing instruction
is in fact a jump instruction. An EX instruction cannot be done to an indirectly loaded
segment.
The indirect load routine is nonreentrant.
The reference to an entry point that causes the indirect load of a segment cannot be
from the same element that contains that entry point, even if that portion of the element
making the reference is in another segment of the program.
Example
SEG NINE*,(FR,SX)
Segment NINE is automatically loaded when any externalized I bank entry point is
referenced.
F.3.5. D$REL,DREL$ — Releasing a Segment’s Program Area
When the main storage area occupied by a segment is no longer required by the
program,the space can be released by referencing the dynamic release routine, which is
a relocatable element contained in SYSLIB. This routine can be referenced by either the
D$REL procedure or by a jump to DREL$.
Format
D$REL segment-name,jump
where:
segment-name
jump
specifies the name of the segment area to be released.
specifies the location where control is to be transferred after the segment’s area is
released; if omitted, control passes to the location following the J DREL$ call.
F–12 7830 9887–001

Description
The D$REL procedure generates the following sequence of code:
LXI,U A1,segment-name LXI,U A1,segment-name
LXM,U A1,jump or LMJ A1,DREL$
J DREL$
Program Segmentation
The dynamic release routine determines the program I bank start address of the named
segment. This segment can be either a DSEG or an overlay segment. This address
minus one is placed in A0 and an ER LCORE$ is executed. The D bank start address
minus one is then used for an ER LCORE$. Following the release of the program area,
the segment is marked as a dynamic segment. Its area can then be reacquired by
referencing DLOAD$.
If the released program areas are occupied by more segments than that specified on the
D$REL call, the other segments will not be marked as unloaded. This includes all
segments that follow the specified segment, in addition to those that overlap the
specified segment. Therefore, it is your responsibility to call DREL$ for each segment
actually released and to assure the necessary program areas are reacquired before a
subsequent reload of any such segment.
F.3.6. Segment Load Table
The segment load table (SLT) is generated by Collector and is created for all collections
containing segments other than the main segment. The SLT contains entries that
describe every segment of the program.
The SLT is placed in the control bank at the beginning of the main segment. In a bankimplied
segmented collection where there is no program data in the collection (for
example, there are no even location counters in the collection), the D bank contains only
the SLT.
F.4. Segmentation within Bank-Named Collections
A segmentation structure can be specified within each user-defined bank, although it
would be more efficient to make another bank. If a bank has no segments, the bank is
considered to be composed of one main segment. When segmentation does exist
within banks, the same name must be used for the main segment of each bank. The
segmentation structure within a bank can be entirely different from, or entirely the same
as, the segmentation structure of another bank. A segment can be contained within one
bank, or it can span (be named and contained in) several banks. When a spanning
segment is to be loaded, each portion of the segment is loaded into its respective bank.
A bank-implied program, which has segments defined, can be thought of as a two-bank
program (one I bank and one D bank) with each bank having the same segment structure
and each segment spanning the two banks.
Relocatable segments cannot span banks and must be included in their entirety in one
bank.
7830 9887–001 F–13

Program Segmentation
When using segmentation within a bank-named collection, any location counters from
any element that were not specified for inclusion are placed in the main segment of the
control bank. If particular location counters are needed in a particular segment of a bank,
place them there by an appropriate IN statement after the appropriate SEG statement.
F.5. Common Blocks
The Collector produces, in the absolute element, load control specifications for the
LOAD$ routine. These specifications indicate which text words (data and instructions)
are to be put at which locations in main storage when the segment is loaded.
If a common block is given initial values (filled with text, rather than simply set aside as a
reserved area), the Collector produces specifications to put in these values when the
segment containing the element that defines the initial values is loaded.
For example, if five different elements define five different initial values for the same
common block and each of these five elements is located in a different segment, the
same common block located in a segment common to all referencing segments would
be reinitialized each time one of the five different segments was loaded. This occurs
regardless of where the referenced common block is located within the user’s program
area.
The TYPE COMSEG directive causes the Collector to place all location counters defining
common blocks and the common block area itself in one segment. The use of this
directive avoids reinitialization of the common block unless, of course, the segment
containing it and the defining location counters is reloaded.
Any areas of the common blocks in which text is not loaded upon reinitialization are not
changed as long as the reinitialization is caused by the loading of a segment other than
the one in which the common block resides.
If TPF$ does not have an entry-point table (created by @PREP or @PACK,P), the final size
of the common block (in the absolute or relocatable element) is determined by the
largest declaration of the common block in TPF$ and any other element. Otherwise, the
largest common block declared in any element is used as the size of the common block.
Bank-named collections cannot contain locally included common blocks (see 4.4.4.2).
The location counters defining a common block are placed in the same bank as the
common block. If the location counters are already in the same bank as the common
block, they are not moved. If they are in a different bank, the segment where the
location counters are placed is determined by whether the original segment (containing
the location counters) spans the two banks. If the original segment spans the two banks,
the location counters remain in that segment in the new bank; otherwise, they are
placed in the main segment. To determine the segment in which the text defining the
common block is placed, examine the listing that the Collector produces for the following
format:
element-name $lcs common-block
F–14 7830 9887–001

Program Segmentation
The text defining the common block is placed in the common referencing segment. If
more than one bank references the common block, the text defining the common block
is placed in the main segment of the control bank.
Table F–1. Placement of Common Blocks Defined in One Element
Number of times the element is
specified on an IN directive
Bank where common block is placed
1 Same bank where the element is included (IN)
> 1 Control bank
Table F–2. Placement of Common Blocks Defined in More Than One
Element
Number of times each element is
specified on an IN directive
Where elements are
included (IN)
Bank where common
block is placed
Once per element In the same bank Same banks where the
elements are included (IN)
Once per element In different banks Control bank
More than once for any element Control bank
Example
Element X contains the definition of the common block:
IBANK I1
IN X
DBANK,C CONTROL
The common block is placed in the I bank I1:
IBANK I1
IN X
DBANK,C CONTROL
IN X
The common block is placed in the control bank.
Element Y also contains the definition of the same common block:
IBANK I1
IN X
IN Y
DBANK,C CONTROL
7830 9887–001 F–15

Program Segmentation
The common block is placed in the I bank I1:
IBANK I1
IN X
IN Y
DBANK D1
IN X
IN Y
DBANK,C CONTROL
The common block is placed in the control bank.
You can explicitly specify the placement of the text defining the common block by
means of an IN directive. On IN directives (see 3.1.1), common blocks are always
specified without a file name. A common block name must not be identical to an
element name. An unnamed common block (that is, blank common) may be included in
the program and positioned by using IN BLANK$COMMON.
The common block is initialized each time a segment containing the text defining the
common block is loaded. If all the text defining the common block is in the same
segment, the common block is initialized to only one set of the values.
F–16 7830 9887–001

Appendix G
ROR$E-Relocatable Output Routine
G.1. Introduction
The relocatable output routine produces a relocatable element that is used for input to
the Collector. The relocatable element is produced from relocatable items generated by
the language processors.
The relocatable output routine contains user interfaces SROR$EB, ROR$EB, EROR$EB,
and TBLWR$EB. The following subsections describe these interfaces. Do not call the
relocatable output routine from a minor register set activity. Registers X8 through X11;
A0 through A5; R1, R2, and R3 define the minor register set.
The Collector library element, ROR$E, comes installed in the standard product file
SYS$LIB$*MAP. Since the Collector’s product file is not registered with the Collector to
be processed during library searching, this relocatable element must be explicitly
included in any collection that needs it.
G.2. SROR$EB—Start Relocatable Output Routine
with External Buffer
SROR$EB initializes ROR$E before writing any relocatable text words.
Calling sequence
L,U A0,k-bit-count
LXI A1,external-buffer-length
LXM A1,address-of-external-buffer
LMJ X11,SROR$EB
error return
normal return
where:
k-bit-count
is the number of bits required to contain either the largest control counter or the
number of undefined symbols for the relocation, whichever is larger.
external-buffer-length
is the length in words of the external buffer provided to ROR$E.
7830 9887–001 G–1

ROR$E-Relocatable Output Routine
address-of-external-buffer
is the address of the external buffer provided to ROR$E.
SROR$EB saves the K-bit count for the relocatable element and establishes the
programfile write location for the element by means of ER PFWL$. (See the Exec
System Software Executive Requests Programming Reference Manual.) SROR$EB
adjusts the output buffer to minimize read-before-write operations, if possible.
The error return occurs when a nonzero status code is encountered in register A2.
Register A2 contains the status code from ER PFWL$. (See the Exec System Software
Executive Requests Programming Reference Manual.)
G.3. ROR$EB—Generation of Relocatable Output
with External Buffer
ROR$EB formats relocatable items and outputs text to the relocatable element. This
routine uses the external buffer that was passed to SROR$EB.
Calling sequence
L,U A0,address-of-item
LMJ X11,ROR$EB
error return
normal return
ROR$E is called for every text word that will be inserted in the relocatable element.
(Examples of text words are an instruction or data word.) For each call, the calling
program must supply the text word and its relocation information in an item.
The minimum length of the item is three words; however, it may be larger. Any
relocation of a text word, other than a simple relocation of the right address under the
same location counter that applies to the text word, must be handled through special
relocation items. Any number of special relocation items can be appended to the item.
G.3.1. ROR$EB Item Format
The following shows the ROR$EB item format.
00 n not used l r
01 text word
02 f zero lc address
03 special relocation items
.. …
n-1 special relocation items
G–2 7830 9887–001

Word 0
n
l
r
Item length, including any special relocation items.
12 sign bits for a left address or left half-word field.
12 sign bits for a right address or right half-word field.
Word 1
text word
Word 2
f
lc
Bit 3 = 1, right address (bits 20-35) relocatable.
Bit 2 = 1, left address (bits 2-17) relocatable.
ROR$E-Relocatable Output Routine
Contains the location counter the text word is under. Can be overridden by a special
relocation item type 013.
address
Address of the text word. This address can be an 18-bit value.
Words 3, 4, and so forth, can contain special relocation items.
G.3.2. Special Relocation Items
Location Counter
The location counter relocation item, type 011, format is as follows:
01 011 l r lc
This item is used for relocation by a location counter other than the one specified in S3
of word 2.
7830 9887–001 G–3

ROR$E-Relocatable Output Routine
l
r
lc
The left margin of the field of relocation (a bit number in the range 0 through 35).
The right margin of the field of relocation (a bit number in the range 0 through 35,
with r less than or equal to l).
Location counter number; a signed 12-bit integer. The starting address of the
location counter is added if lc is positive or subtracted if lc is negative.
External Reference
The external reference item (two words), type 012, format is as follows:
02 012 l r signs
sequence number of the external reference in the preamble
This item is used for relocation by the value of an externally defined symbol.
l
r
signs
The left margin of the field of relocation.
The right margin of the field of relocation.
12 bits of all zeros or ones, depending on whether the external reference is to be
added or subtracted respectively.
Large Location Counter
The large location counter item, type 013, format is as follows:
01 013 not used lc
If this special item is used, it must be the first special item appended to the item.
This item overrides the lc in Word 2 of the item. This allows location counters greater
than 63.
G–4 7830 9887–001

lc
Location counter number the text will be under.
ROR$E-Relocatable Output Routine
ROR$E formats the text words and the relocation information into blocks and writes the
blocks to the relocatable element.
The error return is taken when
• An I/O error occurs; A1 contains the status.
• An internal inconsistency occurred in ROR$EB; A1 is zero.
G.4. EROR$EB—End Relocatable Output
Routinewith External Buffer
EROR$EB terminates ROR$E after the last text word has been processed. This routine
uses the external buffer that was passed to SROR$EB.
Calling sequence
L A0, (transfer-addr,transfer-addr-lc)
LMJ X11,EROR$EB
error return
normal return
Note: If a transfer location is not specified (for example, if the element is a subroutine),
A0 must contain negative zero: 0777777777777.
where:
transfer-addr
is the location of the first instruction to be executed in the main program. This can be
an 18-bit value.
transfer-addr-lc
is the location counter to which the address applies.
EROR$EB outputs the last block built by ROR$EB and generates a transfer image. The
transfer image is a special word group. The format is described in the Data Structures
Programming Reference Manual.
The error return is taken when an I/O error occurs. The status is returned in A1.
7830 9887–001 G–5

ROR$E-Relocatable Output Routine
G.5. TBLWR$EB—Table Write Subroutine with
External Buffer
TBLWR$EB writes the preamble constructed by the calling program to the program file
that contains the relocatable text. ROR$EB must have already written the element text
to the program file, and EROR$EB must have been called.
The preamble consists of one to five tables and is described in the Data Structures
Programming Reference Manual.
Calling sequence
L,U A0,preamble-addr
L,U A1,preamble-length
LMJ X11,TBLWR$EB
error return
normal return
TBLWR$EB writes the preamble supplied by the calling program to the program file. The
entries in PARTBL+29 through 38 are updated to reflect the preamble length, preamble
location, and the element type (5 = relocatable). For more information on the contents of
PARTBL, see the System Service Routines Library (SYSLIB) Programming Reference
Manual. The format of the preamble is described in the Data Structures Programming
Reference Manual.
An ER PFI$ is done to update the file’s table of contents.
The error return is taken when
• An I/O error occurs. A1 contains the status.
• An error occurs on the ER PFI$. A1 equals 0 and A2 is the status.
• A TBLWR$EB error occurs. A1 and A2 equal 0 and A3 contains the TBLWR$EB
status.
In the case of a TBLWR$EB error, the base table that was to be written contains invalid
information.
• If A3 contains a 1, the base table indexes point into the base table.
• If A3 contains a 2, the table indexes point beyond the end of the preamble.
• If A3 contains a 3, the relocatable version specified in the base table is not valid.
An externalized tag, ROR$VERSION, is provided by ROR$E which contains the current
valid relocatable version. This value should be used when setting the relocatable version
in the base table.
It is highly recommended to use TBLWR$EB to write the base table of the preamble.The
added checking of the base table helps to ensure that a valid relocatable is generated.
G–6 7830 9887–001

G.6. Optimization Information
ROR$E-Relocatable Output Routine
ROR$E and the Collector are more efficient if the instructions and data are coded under
control of location counters one and two respectively. ROR$E has less processing to do
and produces a more compact relocatable element. The Collector has a smaller bit
stream to analyze.
7830 9887–001 G–7

ROR$E-Relocatable Output Routine
G–8 7830 9887–001

Index
Symbols
$Ics, 4-10
$n, 4-11
$NONE, $lcs, 4-10
$ODD, $lcs, 4-10
@MAP, 2-7
A option, 2-7
@PREP
of TPF$, 8-1
TPF$, 3-17
Numbers
262K bank restriction, D-1
65K location counter, D-1
A
A attribute, IBANK/DBANK directive
(Table), 4-4
A option, @MAP, 2-7
absolute elements
Arithmetic Fault Mode Determination, 5-5
EXEC action produced by arithmetic fault
mode sensitivity, 5-6
optimization, 6-7
producing extended diagnostic tables, 5-3
quarter-word sensitive, 5-4
setting bank size to 64, 5-2
third-word sensitive, 5-5
absolute output, 2-5
absolute values, entry point, 4-28
access control words, 6-8
allocating
data, 2-2
instructions, 2-2
ALLOWCONTIN, 4-7
Altering the Search Sequence, 3-12
alternate file common banks, 4-5, 4-28, 4-29
arithmetic fault compatibility, setting, 5-1
arithmetic fault noninterrupt, setting, 5-1
array, efficient use of, 8-2, 8-4
array, efficient use of, setting, 8-3
assignment, exclusive, 2-3
attribute-list, BANKINFO, 4-6
attributes, BANKINFO directive, 4-6
7830 9887–001 Index–1
B
B attribute, IBANK/DBANK directive
(table), 4-4
B optionm @MAP, 2-8
bank
address assignments, 4-13
attributes, 4-1
control bank, 4-14
initially based, 4-14
nonconfigured common bank, 4-5
physical, 4-1
structuring, 4-1
switching banks, 4-20
bank descriptor, 4-1
bank descriptor register, 4-3
bank descriptor table, 4-3
bank structuring
DBANK, 4-1
IBANK, 4-1
bank switching
basic mode, 4-20
extended mode, 4-29
bank template
DYNAMIC, 4-7
general information, 4-1
read-only, 4-5
void, 4-5

Index
VOID, 4-9
bank-implied collections
common blocks, 4-13
FRSTIN directive, 3-3
BANKINFO AFCB, using, 4-30
BANKINFO directive
2048BOUNDARY, 4-9
AFCB, 4-2
ALLOWCONTIN, 4-7
attribute-list, 4-6
attributes, 4-6
BDR, 4-7
CODESTRIPPED, 4-7
CONTINGENCY, 4-7
CONTROL, 4-7, 4-14
DYNAMIC, 4-9
EXTENDED, 4-7
GUARANTEED, 4-8
INITIAL, 4-8
LEVEL(#), 4-8
LMJ, 4-8
NCCB, 4-8
NOTEXTENDED, 4-8
OVERRIDEMIN, 4-8
READONLY, 4-9
TSQUEING, 4-9
VECTOR, 4-9
bank-named
example, B-2
general information, 2-3
bank-named collection
segmentation within, F-14
bank-named collections
segmentation consideration, F-10
basic mode
bank switching, 4-23
BDT level, 4-22
BBJ$
general information, 4-21
symbol, 7-1
BDI
DBJ$, 4-24
BDI$
general information, 4-22
symbol, 7-1
BDI, using with
BBJ$, 4-22
IBJ$, 4-22
BDI+entry points
absolute values, 4-28
Collector-defined values, 4-28
BDICALL$
allowing collection time definition, 5-4
general information, 4-22, A-4
return, 4-25
symbol, 7-1
using with IBJ$, 4-24
BDIREF$
general information, 4-21, A-4
symbol, 7-1
BDIVECT$
general information, 4-35
symbol, 7-1
BDR, 4-3
BDT level
definition, 4-29
extended mode, 4-26
BLANK$COMMON
general information, 4-13
positioning, 4-13
BLOCKSIZE$ symbol, 7-1
BLOCKSIZE64 parameter, TYPE directive, 5-2
BTD level
basic mode, 4-29
Index–2 7830 9887–001
C
C attribute, IBANK-DBANK directive
(table), 4-4
C option
@MAP, 2-8
C Option
efficient use of, 8-5
CALL
op code, 4-36
using, 4-27
CBEP$$, 4-5, 4-6, 4-7, 4-22, 4-28, 4-30, 4-32,
4-34
CERU$ element, 4-5, 4-6, 4-22, 4-28
character length, 2-3
CLASS directive
element selection determination through
version names, 3-6
valid string characters, 3-6
clear PSR D10 at initial load, 5-5
clear PSR D20, 5-1
clear PSR D32 at initial load, 5-4
CLRAFCM parameter, TYPE directive, 5-1,
5-6
CODESTRIPPED, 4-7
collection
bank-implied, 3-2
bank-named, 3-9

common-banked, suppress error
messages, 5-2
default LEVEL, 6-6
collection, bank-imlpied
general information, 2-2
collection, bank-implied
FRSTIN directive, 3-3
collection, bank-named
general information, 3-9
segmentation within, F-13
Collector
absolute output, 2-5
control statement options, 2-7
COR directive, 6-1
DEF directive, 6-3
directives, 2-10
entry-point table, C-1
file searching, 3-10
FIRSTBDI directive, A-3
initiation, 2-7
initiation, @MAP, 2-7
input, 2-1
language conventions, 2-2
output, 2-4
relocatable elements, 2-4
RES directive, 6-8
RSEG directive, F-6
sign-off line, 2-6
sign-on line, 2-6
SNAP directive, 6-11
termination, 2-7
TYPE COMSEG directive, F-14
TYPE EXEC directive, definition, A-1
using, 1-1
XSEG directive, A-1
Collector defined symbol
BDICALL$, 7-1
Collector defined symbols
BBJ$, 7-1
BDIREF$, 7-1
BDIVECT$, 7-1
BLOCKSIZE$, 7-1
COMMN$, 7-1
D$ATE, 7-1
DBJ$, 7-1
ENTRY$, 7-2
FIRST$, 7-2
FIRSTBDI$, 7-2
FRSTD$, 7-2
FRSTI$, 7-2
IBJ$, 7-2
LAST$, 7-2
LASTD$, 7-2
LASTDR$, 7-2
LASTI$, 7-2
LASTIR$, 7-2
LASTR$, 7-3
LBDI$, 7-3
LBDICALL$, 7-3
LBDIREF$, 7-3
MAPBDR$, 7-3
MAPBDT$, 7-3
MAPCALL$, 7-3
MAPGOTO$, 7-3
SLT$, 7-3
T$IME, 7-3
XREF$, 7-3
Collector definied symbols
BDI$, 7-1
Collector directives
COR, 6-1
DEF, 2-4
DSEG, F-6
END, 6-4
ENT, 6-4
EQU, 6-5
FIRSTBDI, A-3
FRSTIN, 2-4
LEVEL, 6-6
MINGAP, 6-7
MINSIZ, 6-7
REF, 6-11
RLIB, file-searching, 3-10
RSEG, F-6
SEG, F-2
SNAP, 6-11
TYPE, 2-2
XSEG, A-1
Collector directives, BANKINFO
AFCB, 4-10
ALLOWCONTIN, 4-7
BDR, 4-7
CODESTRIPPED, 4-7
CONTINGENCY, 4-7
CONTROL, 4-7
DYNAMIC, 4-7
EXTENDED, 4-7
GUARANTEED, 4-8
INITIAL, 4-8
LEVEL(#), 4-8
LMJ, 4-8
NCCB, 4-8
NOTEXTENDED, 4-8
OVERRIDEMIN, 4-8
READONLY, 4-9
TSQUEUING, 4-9
Index
7830 9887–001 Index–3

Index
VOID, 4-9
Collector directives, CLASS
general information, 3-6
Collector directives, DBANK
attributes parameter, 4-2
bank-list parameter, 4-2
level-# parameter, 4-2
name-1parameter, 4-2
Collector directives, DLIB
bank-name parameter, 3-10
Collector directives, FORM
bank-name parameter, 3-3
segment-name parameter, 3-3
Collector directives, IBANK
attributes parameter, 4-2
bank structuring, 4-1
bank-list parameter, 4-2
general information, 2-2
Collector directives, IN
$lcs parameter, 3-1
bank-list parameter, 3-1
efficient use of, 8-1
general information, 3-1
name parameter, 3-1
Collector directives, LIB
$lcs parameter, 3-8
bank-name parameter, 3-8
file-name parameter, 3-8
general information, 3-8
Collector directives, NOT
DEFAULT$LIBS parameter, 3-5
general information, 3-4
name parameter, 3-5
Collector diretives, IBANK
bdr-# parameter, 4-3
Collector TYpe directive
CLRAFCM, 5-6
Collector TYPE directive
BLOCKSIZE64 parameter, 5-2
COMMONBANK parameter, 5-2
COMSEG parameter, 5-3
EXEC parameter, 5-3
EXTDIAG parameter, 5-3
IBJLNK parameter, 5-4
INSAFCM parameter, 5-6
QUARTER parameter, 5-4
READONLY parameter, 5-5
REALTIME parameter, 5-5
SETAFCM parameter, 5-5
THIRD parameter, 5-4
Collector, using
C option efficiently, 8-5
location counters efficiently, 8-5
Collector-defined tags, 4-14
Collector-produced absolute output, 2-5
Collector-produced relocatable elements
DEF directive, 6-3
determining arithmetic fault mode, 5-5
END, 6-4
IN, 3-1
LIB, 3-8
NOT, 3-4
REF directive, 6-10
TYPE directive, 5-1
COMMN$ symbol, 7-1
common blocks
bank-implied collection, 4-12
include text segment, 5-3
loading, F-7
placement, F-15
R option collection, 2-4
TYPE COMSEG, F-14
common-bank collection, suppress error
messages, 5-2
conflicts
local-global, 4-18
CONTINGENCY, 4-7
continuation character, 2-3
CONTROL, 4-7
control bank
common block, F-15
error messages, E-3, E-5, E-13, E-30
FIRSTBDI value, A-3
general information, 4-14
indirect load table, F-11
segment load table, F-13
SNAP$ element, 6-13
using segmentation, F-13
control statement
@MAP, 2-7
options, 2-7
COR directive
corrections, 6-1
corrections, for a relocatable element, 6-3
data images, 6-1
indirectly loaded segment, 6-2
Index–4 7830 9887–001
D
D attribute, IBANK/DBANK directive
(table), 4-4
D bank general information, 4-14, 4-15
D bank symbols
FRSTD, 4-14

LASTD$, 4-14
LASTDR$, 4-14
D option, @MAP, 2-7, 2-8
D$ATE symbol, 7-1
D$BJ, 4-23
D$LOAD/DLOAD$, loading dynamic
segments, F-10
D$REL/DREL$ ,releasing segment program
area, F-12
data allocation, 2-2
data area, 4-15
DBANK directive, 4-15
$EVEN, general information, 4-11
attributes, 4-9
attributes parameter, 4-2
bank-list parameter, 4-2
bdr-# parameter, 4-3
first directive, 4-13
general information, 4-13
level-# parameter, 4-2
location counters, 4-12
name-1parameter, 4-2
options, 4-3
structuring, 4-1
DBANK directive bank-list parameter
name-2 format, 4-2
DBANK directive, bank-list parameter
name-n format, 4-2
no entry format, 4-2
DBJ$ symbol, 7-1
DEF directive
absolute collection, 6-3
COMMN$, 6-3
ENTRY$, 6-4
external defininition collection, 6-3
R option collection, 6-3
definitions
BDI and entry point, 4-28
external, 2-4
destination bank, 4-22
determining search sequence, 3-14
diagnostic messages
ERROR, E-8
FATAL ERROR, E-23
WARNING, E-30
directed LIB directive, 3-8
directive
COR, 6-1
directives
BANKINFO, 4-30
banking, 4-1
Collector, 2-2
DBANK, 4-14
DEF, 6-3
directed LIB, 3-9
END, 6-4
ENT, 6-4
EQU, 6-5
IBANK, 4-14
IN, 4-15
INFO Group 3, 4-12
REF, 6-10
RES, 6-8
RSEG, F-6
SEG considerations, F-3
segmentation, F-1
SNAP, 6-11
directives, segmentation
DSEG, F-2
IN, F-2
RSEG, F-2
SEG, F-2
DLIB directive
$lcs parameter, 3-10
bank-name parameter, 3-10
DSEG
considerations, F-6
DSEG directive
considerations, F-6
dynamic segments, F-6
MCORE$ request, F-6
dumps, SNAP directive, 6-13
DYNAMIC, 4-7
dynamic segments
general information, F-10
loading, F-10
Index
7830 9887–001 Index–5
E
E option, @MAP, 2-8
element
exclusion, 3-5
explicitly included, 4-10
global, 4-11
implicitly included, 4-12
inclusion, 3-17
local, 4-16
placement, 4-19
element name rules, 2-3
element placement
arithmetic fault mode determination, 5-5
element search, 3-11
elements, absolute

Index
EXEC action produced by arithmetic fault
mode, 5-6
elements, relocatable
Collector produced, 2-4
corrections, 6-1
example
bank-implied collections, B-1
F
F option, @MAP, 2-8
FATAL ERROR Messages, E-1
file name rules, 2-3
file searching
implicit inclusion, 3-8
sequence number, 3-11
files, 2-3
FIRST, 4-14
FIRSTBDI directive, A-3
FIRSTBDI$ symbol, 7-2
FORM directive, 3-3
format
errors for a relocatable element, D-1
SNAP data image, 6-12
FRSTD, 4-14
FRSTD$ symbol, 7-2
FRSTI$, 4-14
FRSTI$ symbol, 7-2
FRSTIN directive
first element included, 3-3
general information, 2-4
G
G attribute, IBANK/DBANK directive
(table), 4-4
G option, SIR$, 2-9
global elements, 4-16
global-local conflicts, 4-18
GOTO, op code, 4-26
group-sequence, 3-11
GUARANTEED, 4-8
H
H attribute, IBANK/DBANK directive
(table), 4-4
H option, SIR$, 2-9
Index–6 7830 9887–001
I
I bank symbols, 4-12
I option, SIR$, 2-9
IBANK directive, 4-12
IBANK directive, bank list parameter, 4-1
IBANK/ DBANK, 4-1
IBJ$, 4-20, 4-23
IBJ$ symbol, 7-2
IBJ$/DBJ$, use of BDI, 4-20
IBJLNK parameter, TYPE directive, 5-4
implicitly included elements, 4-12
implied SEG directive, F-3
IN Directive, 8-1
indirect loading of segments, F-11
INFO Groups, C-1
information messages, E-35
initially based banks, 4-14
input to the Collector, 2-7
instruction
allocation, 2-2
area, 4-14
J
J option, SIR$, 2-9
J, op code, 4-37
K
K option, SIR$, 2-9
keywords, INFO group 12, 3-11
L
L attribute, IBANK/DBANK directive
(table), 4-4
L option, @MAP, 2-8
L$OAD/LOAD$, F-8
language conventions, 2-2
LAST$, 4-14
LAST$ symbol, 7-2
LASTD$, 4-12
LASTD$ symbol, 7-2
LASTDR$, 4-12
LASTDR$ symbol, 7-2
LASTI$, 4-12
LASTI$ symbol, 7-2

LASTIR$, 4-12
LASTIR$ symbol, 7-2
LASTR$ symbol, 7-3
LBDI$, 4-26
LBDI$ symbol, 7-3
LBDICALL, 4-26
LBDICALL$ symbol, 7-3
LBDIREF$, 4-26
LBDIREF$ symbol, 7-3
leading blanks, 2-3
length, character, 2-3
LEVEL(#), 4-8
LIB directive, 2-3
library, 3-11
link vector, 4-9
LMJ, 4-8
LOAD$ request, reloading the main
segment, F-10
loading, F-14
local elements, 4-16
Local-Global Conflicts, 4-18
location counter, 4-11
LOCL, 4-26
M
M attribute, IBANK/DBANK directive
(table), 4-4
MAP$PF, 2-1
MAPBDR$ symbol, 7-3
MAPBDT$ symbol, 7-3
MAPCALL$ symbol, 7-3
MASM $INFO group 3 directive, 4-12
MINGAP, 6-7
multibanked program, 4-13
N
N attribute, IBANK/DBANK directive
(table), 4-4
N option, @MAP, 2-8
NCCB, 4-2
negative fields, D-2
Neither P nor Q option, SIR$, 2-9
NITIAL, 4-8
no option listing, @MAP, 2-5
nonconfigured common bank, 4-2, 4-8
notation, 2-3
NOTEXTENDED, 4-8
number on Collector directives, 2-3
Index
7830 9887–001 Index–7
O
O attribute, IBANK/DBANK directive
(table), 4-4
odd location counters, 2-2
operation code, 4-36
options
@MAP, 2-7
SIR$, 2-9
output, 2-2
OVERRIDEMIN, 4-39
P
P and Q option, SIR$, 2-9
P option, SIR$, 2-9
physical bank, 4-1
placement, element, 4-19
print diagnostic message, 2-7
procedures, system-provided, 4-23
program segments
direct method, F-8
dynamic release, F-12
indirect method, F-11
segment load table, F-13
PTF$
size of common block, F-14
Q
Q attribute, IBANK/DBANK directive
(table), 4-4
Q option, SIR$, 2-9
QUARTER, 5-4
quarter-word sensitive, 5-4
queuing, test-and-set, 4-4
R
R attribute, IBANK/DBANK directive
(table), 4-5
R option, @MAP, 2-8
READONLY, 4-9, 5-5
REALTIME, 5-5
REF directive, 6-10
reference search, 3-11
references
external, 2-4, 2-6

Index
reloading main segment, F-10
relocatable elements, 2-4
relocatable segments, F-7
relocation order restriction, D-1
RES directive, 6-8
restrictions, D-2
return, 4-25
RSEG, F-2
rules, 2-3
S
S attribute, IBANK/DABNK directive
(table), 4-5
S option, @MAP, 2-8
search, 3-11
search sequence
altering, 3-12
determining, 3-14
searching user-specified search files, 3-16
SEG directive
$MAIN$, F-3
directive, F-2
element inclusion, F-3
example, B-3
implied, F-3
indirect load segment, F-6
indirect loading, F-11
value, F-3
segment load table, 4-14
segmentation, F-1
sensitivity, quarter-word, 5-6
sensitivity, third-word, 5-5
SETAFCM parameter, TYPE directive, 5-1
sign-off line, 2-6
sign-on line, 2-6
SIR$ options, 2-9
SLT$ symbol, 7-3
SNAP data image format, 6-12
SNAP directive, 6-11
snapshot dumps, 6-11
statement options, @MAP, 2-7
static diagnostic text, D-3
storage area, expand, 2-8
subattributes, 4-6
subroutine calls, 4-25
suppresses error messages during commonbanked
collection, 5-2
symbolic element, 5-4
SYS$*DATA$.LIB$NAMES, 3-13
SYS$*RLIB$, 2-4
SYS$LIB$*ACOB, 3-12
SYS$LIB$*FTN, 3-12
SYS$LIB$*SORT, 3-12
SYS$RLIB$ID, 3-1
system library searching, 3-11
system-provided procedures, 4-23
Index–8 7830 9887–001
T
T attribute, IBANK/DBANK directive
(table), 4-5
T option, @MAP, 2-8
T$IME symbol, 7-3
target location, 4-36
template bank, 4-1
termination, 2-7
test-and-set queuing, 4-9
text ACW, 6-8
THIRD parameter, TYPE directive, 5-5
third-word sensitivity, 5-5
TPF$
@PREP of, 8-1
file searching, 3-10
truncation of negative fields, restriction, D-2
TSQUEUING, 4-9
TYPE COMSEG directive, F-14
TYPE EXEC
definition, A-1
general information, 4-37
TYPE EXEC collection, A-4
TYPE IBJLNK
general information, 4-23
using, 4-24
U
U attribute, IBANK /DBANK directive
(table), 4-5
U option, SIR$, 2-9
undefined symbols, C-1
V
V attribute, IBANK /DBANK directive
(table), 4-5
VECTOR attribute, 4-9
VOID, 4-9
void bank template, 4-5, 4-9

W
W option, SIR$, 2-10
WARNING messages, E-30
word count, incorrect, D-1
write function process, 2-3
write-protected, 4-5
X
X attribute, IBANK /DBANK directive
(table), 4-5
X option, @MAP, 2-9
X11,BDICALL$, 4-29
X11,BDIREF$, 4-29
XREF$ symbol, 7-3
XSEG directive, Executive function
arrangement, A-1
Z
Z attribute, IBANK/DBANK directive
(table), 4-5
Z option, @MAP, 2-9
zero-fill
ACW, 6-8
segment, F-11
Index
7830 9887–001 Index–9

Index
Index–10 7830 9887–001

*78309887-001*
7830 9887–001