ICL 1900 Series George 3 Operating System Macros

LISTDUMP

Function

Lists the state of the filestore as held on a GEORGE dump tape for any required increment. It can be used as a free standing program or as a preliminary to the tape to tape processor.

Format

LISTDUMP parameter list

where entries in the parameter list are as described below.

All parameters to the command are optional and may be placed in any order.

Parameter format Function Default action if omitted
USERusername This causes information pertaining only to the named user and his inferiors to be listed. The program will not run in TTTP mode unless the user is :MASTER. The user :MASTER is assumed
INCincrement number This causes the information from this incrment to be listed. If run in TTTP mode, the TTTP files are checked to ensure that no overwriting can take place. Information from the latest increment will be listed provided that, in TTTP mode, no overwriting of earlier information occurs.
TAPEmagnetic tape description If this parameter is present the INCincrement number parameter must also be present. It is not allowed in TTTP mode. The first suitable tape containing the required increment is used
MODETTTP This causes the additional output to :DUMPER.USEFUL FILES and :DUMPER.INC LENGTHS to be given. The program is run in NOTTTP mode, and output to the files is surpressed
MODEINCLIST Lists :SYSTEM.INCINDEX only. This facility is included mainly for the LISTINCINDEX macro. LISTDUMP is run normally in NOTTTP mode
FULLIST or NOLIST Defines the level of line printer output required. In FULLIST mode information on each filestore entrant and each owned magnetic tape is produced. In NOLIST mode all line printer output is surpressed. It is only allowed in TTTP mode. Line printer output in SHORTLIST mode will be given. This produces a line of output for each user giving the number of files and tapes, etc. but not information about the individual entrants

Format of LISTDUMP in REVISION mode

By running LISTDUMP in REVISION mode, certain parameters in PROGRAM G3DR can be altered.

The command takes the form:-

LISTDUMP REVISION,parameter list

where entries in parameter list specify the revision to be carried out. Note that REVISION must be the first parameter, but the other parameters are optional and may be placed in any order:-

Parameter format Function
LINESn The number of lines per page of line printer output will be set to n. The initial value is 60.
USEFULFILESn The length of USEFUL FILES records will be set to n words. The initial value is 253.
INCLENGTHSn The length of INC LENGTHS records will be set to n words. The initial value is 253.
TOPRESIDENCEn The number of the highest filestore residence. The initial value is 63.
TAPESn The maximum number of copies per increment will be set to n tapes. The initial value is 20.
DEADWOODn Defines the age of deadwood. A file is called deadwood if it has not been accessed for n days. The initial value is 28.
RE ON
RE OFF		 Causes the program to (or not to) switch REALTIME ON internally as soon as it obtains a dump tape to read. Initially RE OFF is assumed.
REALTIME This checks the current REALTIMEn status of the program and gives an appropriate message.

If, in the first seven cases, the number n is omitted hten the current value is printed alongside the parameter listing.

If no parameter errors are made, the program will then overwrite itself in the filestore with the new version.

If contradicting parameters are given, then the rightmost parameter is used.

Where relevant, a check is made at run-time that these parameter values are reasonable and, if they are not, their initial values are used.

Forbidden contexts

USER except when under :DUMPER

Initialisation

Before LISTDUMP may be run, the files PROGRAM G3DR and LISTDUMP must be copied from the latest ICLKG3SYSTEM system tape. FILEIN can be used for this.

Execution

The LISTDUMP macro loads and enters PROGRAM G3DR. The parameters are analysed and :SYSTEM.INCINDEX is read and listed provided that TAPEmagnetic tape description is not specified. The storage arrays for any of the other files required (e.g. USEFUL FILES in MODETTTP) are set up at this point. The specified increment is read and each entrant is processsed in turn, the amount of information output being determined by the appropriate listing mode. The online size, special residences and offline size tables are updated for each entrant.

If TAPEmagnetic tape description is not given, :SYSTEM.INCINDEX is searched for the increment to be listed and the program tries to find an acceptable tape holding this increment and attempts to ONLINE it. In the event of an operator CANTDOing the tape the program looks for an alternative one. This alternative search also occurs if there is a read failure on the selected tape while actually running the program unless the command was issued in USER and OFFLINE context.

USEFUL FILES will contain pairs of words, the first of a pair containing an increment number and the second the file number of a useful file within that increment. A file is useful if no later copy of it exists and it has not been ERASEd. USEFUL FILES may be a simple file of a multifile. With a multifile each workfile copied becomes an element of the multifile and thereby reduces hte risk of USEFUL FILES becoming full.

INC LENGTHS will also contain pairs of words, this time holding and increment number and the total size of useful files within that increment. All current increments will have an entry pair in this file.

The restore-time macro MTGR alters LISTDUMP so that, after reading the restorable increment, it goes on to read the remaining increments of the batch, if any. The order in which details of directories are printed depends on the incrments in which they are dumped. LISTDUMP does not calculate the total size of a limb if directories in it are dumped in more than one increment; in this event a question mark appears in the TOTAL SIZE column.

If there are any missing increments, that is increments still containing useful files but which have been deleted from :SYSTEM.INCINDEX, a list of them is printed following the table of the sizes of increments. It the TAPE parameter is given and some directories are found to be dumped in earlier increments, these directories are not procressed but a list of them is printed at the end of the output.

LISTDUMP provides the following listings:-

  1. A table of status and magstate (magnetic tape status) word meanings in :SYSTEM.INCINDEX
  2. A listing of (the online copy of) :SYSTEM.INCINDEX, unless TAPEmagnetic tape description is specified
  3. A table giving the size of the processed increments
  4. A summary of directory entries in the filestore
  5. Statistics of the filestore at the time of the dump
  6. A table giving the size of the filestore on-line on each filestore residence
  7. A table giving the total size of files allocated to special residences
  8. A table giving the size of the off-line filestore

Files Accessed

:MACROS.LISTDUMP (execute)
:DUMPER.PROGRAM G3DR (execute)
:DUMPER.LITTLE INDEX (read)
:DUMPER.USEFUL FILES (write)
:DUMPER.INC LENGTHS (write)
:SYSTEM.INCINDEX (read)

Error Messages

increment number IMPROPERLY SPECIFIED
magnetic tape descriptionGIVEN BUT NO increment number
ERROR IN magnetic tape description OR TAPE UNAVAILABLE
INCREMENT NOT FOUND IN INCINDEX
DUMP NOT FOUND ON THIS TAPE
USER NOT FOUND IN THIS DUMP
INC UNSUITABLE FOR GENERAL RESTORE
REALTIME CANNOT BE SWITCHED ON
TAPE NOT A DUMP TAPE
ONLY 'USERMASTER' IN TTTP MODE
OVERWRITING LATER TTTP DETAILS
INCINDEX BUFFER TO SMALL
INC ALREADY USED IN TTTP MODE
mode parameter UNRECOGNISED
LISTDUMP ALREADY RUN IN mode parameter MODE
NO AVAILABLE DUMP TAPES
TRANSFER FAILURE ON *MT IN LISTDUMP
TWO LISTING MODES REQUIRED
NOLIST ONLY ALLOWED WITH MODETTTP
INCLIST REQUESTED IN MODE TTTP
ERROR IN LISTDUMP: MACRO ABANDONED