LINKMAP - Generate Link-Edit Maps for Load-Modules and Program Objects

[Home] [Products] [Support] [Documents] [Partners] [Contact Us] [Search]

The LINKMAP TSO/E command reads existing load-modules and program objects and prints or displays their link-edit maps in the TSO/E or ISPF environment. LINKMAP runs in the batch and on-line environments on OS/390 and z/OS and supports Load-Libraries (PDS) as well as Program Libraries (PDSE).

Highlights

LINKMAP helps programmers, consultants and auditors quickly obtain an enhanced link-edit map in a format similar to that produced by the DFSMS Binder. In addition, LINKMAP performs the following:

Read the directory of the specified load-library (PDS) or program library (PDSE) and select members based on a list of names specified by the user. Member names can be fully-qualified, or contain wildcard characters, e.g. ABC* or %P*GH*.
Generate a formatted display of the directory entry, including module size, date, attributes, and other linkage-editor options
Generate a link-edit map in a format which is similar to that produced by the DFSMSdfp Binder when the load-module was link-edited or the program object was bound.
Retrieve the AMODE, RMODE and IDR information and display it along with the corresponding CSECT. IDR information includes the translator code and compilation julian date.

LINKMAP is an affordable product. A free, time-limited version is available for evaluation.

Command Syntax

LINKMAP is a TSO/E command and standard TSO/E rules for command syntax apply. Below is a list of options and parameters which can be specified. Please refer to the sample JCL for coding examples.

LINKMAP	(defaults)
dsname	Mandatory
MEMBERS(member filters)	n/a
EXCLUDEMEMBERS(member filters 2)	n/a
CSECTS(symbol filters)	*
EXCLUDECSECTS(symbol filters 2)	n/a
VOLUME(volser)	catalog
LastReferenceDate(KEEP\|UPDATE)	KEEP
SHR\|OLD	SHR
BASE(address)\|TUCK	BASE(0)
TEXT\|NOTEXT	NOTEXT
PUTLINE\|SYSPRINT\|BRIF	see note

'dsname' specifies the data set name of the load-library or program library to process. If 'dsname' is not enclosed in apostrophes, it is prefixed with the TSO prefix. 'dsname' may include a fully-qualified member name in parentheses, in which case the corresponding program will be processed - see Specifying Member Names below.
'volser' is the optional volume serial number of an uncatalogued data set. If 'volser' is not specified, the volume serial is retrieved from the catalog.
LastReferenceDate indicates whether or not the Last Reference Date (field DS1REFD of each data set's format-1 DSCB) should be kept unchanged (KEEP) or set to the system date (UPDATE). KEEP is the default.
SHR and OLD are mutually exclusive key-words which indicate what DISP should be used to allocate the library. SHR is the default.
'member filters' is an optional list of fully or partially qualified member names that should be processed. The following formats are valid:
1. ABCDEF represents a fully qualified name
2. ABC* lists all members whose name begins with the characters ABC
3. ABC%EF* lists all members whose names are at least 6-characters long, beginning with ABC and having the characters EF in 5th and 6th positions.
'member filters 2' is an optional list of fully or partially qualified member names that should be ignored. The format of this operand is identical to that of the MEMBERS operand, above.
'symbol filters' and 'symbol filters 2' are optional lists of fully or partially qualified CSECT names used to filter the members which will be processed. The format of these operands is identical to that of the MEMBERS operand, above. For more information, please see CSECT-based Member Selection below.
'address' is an optional 8-character hexadecimal value used by LINKMAP to adjust offset values displayed in the module map. Specifying 'address' relieves the user from having to perform hexadecimal arithmetic calculations to match an address found in a storage dump listing to the corresponding offset in the link-edit map. TUCK is an alternative to specifying BASE(address). When TUCK is specified, the origin of the first CSECT is set to the number of bytes necessary to round up the module size to the next 4k-page. In effect, TUCK simulates the loading of the module in virtual storage by the system, where the last byte of a load-module coincides with the last byte of a 4k-page.
TEXT is an optional key-word which indicates that the contents of each CSECT should be displayed in DUMP format. NOTEXT is the default. TXT and NOTXT are equivalent to TEXT and NOTEXT.
PUTLINE, SYSPRINT or BRIF specify how the link-edit map should be displayed. BRIF specifies the ISPF Browse Interface, PUTLINE the PUTLINE macro, and SYSPRINT the SYSPRINT data set. BRIF is the default when LINKMAP runs in the ISPF on-line environment; otherwise, PUTLINE is the default.

Specifying Member Names

When no member name is specified in the LINKMAP command, all of the members of the specified load-library are processed. The entire load-library is also processed when MEMBERS(*) is specified. The user can press the ATTN key to terminate the processing.

The user can limit the processing by specifying which member (or members) should be processed, as follows:

A single member name can be specified as part of the data set name of the load-library: LINKMAP 'SYS1.LINKLIB(AMBLIST)'
A list of member names can be specified in the MEMBERS parameter: LINKMAP 'SYS1.LINKLIB' MEMBERS(AMBLIST,IEHLIST)'
A list of generic member names can be specified in the MEMBERS parameter: LINKMAP 'SYS1.LINKLIB' MEMBERS(IEB*,%MB*)'
The above options can be mixed: LINKMAP 'SYS1.LINKLIB(AMBLIST)' MEMBERS(IEHLIST,%MB*,BPX*)'

CSECT-based Member Selection

LINKMAP checks the name of each CSECT (SD-type symbol) found in a member against the lists of symbols specified in the CSECTS and/or EXCLUDECSECTS operands, when specified. If CSECTS is not specified, CSECTS(*) is assumed. If one or more CSECTs in a member pass the test (i.e. match the CSECTS filters and does not match any of the EXCLUDECSECTS filters), the corresponding link-edit map is generated.

Usage in the ISPF On-Line Environment

LINKMAP can be invoked in the ISPF on-line environment, for example via the TSO command, or by entering LINKMAP in the command window of an enhanced member list. LINKMAP can also be invoked by entering LINKMAP in the command window of a data set list, in which case LINKMAP processes the entire load-library.

When LINKMAP runs in the ISPF on-line environment, the default output mode is automatically set to BRIF unless the PUTLINE or SYSPRINT options are specified. When the BRIF output mode is used, the link-edit maps are displayed via the BROWSE Interface (BRIF). In the ISPF V5 environment, the V command can be used to switch from BROWSE to VIEW, thereby allowing the user to enter EDIT commands such as CREATE or CUT, or EDIT macros such as ROUTE.

When LINKMAP is invoked to produce several maps, it desynchronises the building of the maps from their displaying via the BRIF interface, allowing the user to see the first map as soon as it is produced. Additional maps are made visible as they are are produced, each time the user presses the Enter key or enters the DOWN command. Entering the END command terminates LINKMAP's processing.

Sample JCL

LINKMAP runs as a TSO command on-line or in batch. The following sample job stream shows how to set up a TMP job step to execute several LINKMAP commands in a batch job.

 //LINKMAP3 JOB (acct#),'LINK MAP',CLASS=U,MSGCLASS=H
 //*
 //*      Generate Link-Edit Maps
 //*
 //LINKMAP EXEC PGM=IKJEFT01
 //STEPLIB  DD DSN=<LINKMAP Load Library>,DISP=SHR
 //SYSTSPRT DD SYSOUT=*
 //SYSTSIN  DD *

  /* Process a single program */

 LINKMAP 'SYS1.LINKLIB(AMBLIST)'

  /* Process an entire library */

 LINKMAP 'SYS1.LINKLIB'
  or
 LINKMAP 'SYS1.LINKLIB' MEMBERS(*)

  /* Process selected programs */

 LINKMAP 'SYS1.LINKLIB' MEMBERS(ADRDSSU IEB* %MA* ) XMEM(IEBDG)

  /* Process programs which contain the specified CSECTs */

 LINKMAP 'APPL.LOADLIB' MEMBERS(PAY1* PAY2*) CSECT(SUB0* SUB1472) XCSECT(SUB011 SUB%2*)

  /* Process a single program in an uncataloged library, show TEXT */

 LINKMAP 'SYS1.LINKLIB(AMBLIST)' VOL(NEWRES) TEXT

 /*

Sample Output

A sample output listing produced by LINKMAP is available.

Search key-words: ibm mvs os/390 os390 z/os zos clist rexx os/vs load-module analyse analyser analyze analyzer analysis identify compile date compiler translator tool data id cobol assembler pl/1 pl1 pl/i pli link-edit map link-edit date linkdate lkeddate csect list report idr data esd cesd rld txt cross-reference xref determine extract display date load-library load-libraries loadlib lib load-module length date load-modules lengths le language environment compilation options program library program object objects pds pdse pds/e binder linkage editor linkedit link edit lked properties attributes attr attrib rent reus amode a24 a31 aany amin rmode rany r24 compilation date time signature product code codes idrdata load object module modules generic wildcard wildcards wild-card wild-cards partially-qualified fully-qualified determine module entry points terminal utility batch delink relink amblist iehlist 5740-cb1 5740cb1 5740cb103 5752SC104 566528408 566529508 5695DF108 5695PMB01