1 CLUE CLUE reads a dump file and displays a summary of the crash. A wild card filespec is supported. If no filetype is specified, .DMP is assumed. If the /CANASTA qualifier is specified, an input file for CANASTA will be generated. If /BINARY is specified, a summary of the crash will be written to a binary file. The binary file generated by CLUE/BINARY can be read by CLUE/DISPLAY. Format: CLUE dumpfile_spec 2 Logicals Define the logical CLUE$DIRECTORY to point to the location of CLUE.EXE. If CLUE$OUTPUT is defined, the files generated by the /OUTPUT and /BINARY qualifiers are placed in that directory. If CLUE$MAX_ENTRIES is defined, the number of entries in the binary file will be limited to the number specified by this logical by deleting the oldest entries. If CLUE$EXCLUDE_OPERS is defined, Operator Shutdowns will not be added to the history file when /BINARY is used. By default Operator Shutdowns are added to the history file. If CLUE$INHIBIT is defined, CLUE will not analyze a dump. This is used to suppress CLUE execution when CLUE is called from startup procedures. If CLUE$CLEANUP is defined, CLUE will delete the previous output listing. This ensures that only the latest CLUE listing is retained. If CLUE$NOSUMMARY is defined, CLUE will not extract the Summary of Processes from a dump. This provides a way to suppress the summary data without editing the command procedures containing the CLUE command. If analyzing a dump from another version of VMS and you have the Executive Images and Symbol table files from that version of VMS available, define logicals, CLUE$EXEC_IMAGES_Vxy and CLUE$STB_Vxy where x is the major VMS version Number and y is the minor version, e.g. for VMS V5.3, define logicals CLUE$EXEC_IMAGES_V53 and CLUE$STB_V53 to point to the directories where the appropriate files are located. If these logicals are not defined, CLUE will read symbols from the running system's executive images and symbol table files which may not give the correct symbolizing of the stack contents. If CANASTA$WORK is defined, the CANASTA file produced by the /CANASTA qualifier is placed in that directory. 2 /BINARY /BINARY = file Write the crash data to the specified binary file. If no filename is supplied, CLUE$HISTORY.DATA will be used. If CLUE$OUTPUT is defined, the binary file will be generated in that directory. 2 /CANASTA /CANASTA [= filename] CANASTA (Crash ANAlysiS Troubleshooting Assistant) is a tool that is used at the Customer Support Centers to assist Customer Support Center engineers in the complex task of analyzing operating system crashes. This tool uses the parameters collected and transferred from the customer site at the CSC to assist in resolving an operating system crash. To write the CANASTA parameters to an ASCII file for later transfer to the CSC use CLUE/CANASTA [=filename]. If a full filename.extension is specified, it will be used as the name of the CANASTA file. If no value is supplied, then CANASTA-INPUT-DATA.TMP will be the filename - using the nodename contained in the dump specified. If only the filename value is supplied then CANASTA-INPUT-DATA.TMP will be the name of the file. If the logical CANASTA$WORK is specified, the above named file will be created in that directory, otherwise the default directory is used. 2 /DEBUG /DEBUG This qualifier records the disk blocks retrieved from the dump and creates a file, CLUE.DBG, showing how many blocks were accessed. 2 /DISPLAY /DISPLAY = display_command/quals.. filename The display module of CLUE reads the specified CLUE History file, generated by the CLUE/BINARY command, and prompts for user action. A number of commands, as listed below, are available to the user from the "CLUE_DISPLAY >" prompt. These commands may also be given as a value with /DISPLAY from the DCL command line, for example: CLUE/DISPLAY=DIR/SINCE=1-JAN/OUT=TMP.LIS CLUE$HISTORY.DATA. If no filename is specified, the default filename is CLUE$HISTORY.DATA. 3 DIRECTORY DIRECTORY This displays a brief summary of each entry in the CLUE History file with the most recent entry shown first. The following qualifiers may be used with this command: 4 /MODULE /MODULE = failing_module This qualifier lists all crashes which failed in a particular module. 4 /OFFSET /OFFSET = nnnn This qualifier lists all crashes which failed at a particular offset. 4 /OUTPUT /OUTPUT = file This qualifier writes the directory listing to the specified file. The default filename is CLUE_DISPLAY_DIR.TXT. 4 /SINCE /SINCE = dd-mmm-yyyy This qualifier lists all crashes since a particular date. 4 /TYPE /TYPE = crash_type This qualifier lists all crashes of a particular type. 4 Examples # Node Time Type Process Name Module Offset 1 VAXA 19-FEB-1991 01:21 SECAUDEXH AUDIT_SERVER UNKNOWN 77FE 2 VAXA 14-JAN-1991 21:42 NETNOBUF NETACP NETACP 1969F 3 VAXA 1-NOV-1990 15:52 SSRVEXCEPT SNAPSHOT$DETCHD EXE$QIOW_3 0 4 VAXA 25-SEP-1990 11:52 NETNOSTATE NETACP NETACP 19B0C 5 VAXA 16-AUG-1990 08:24 INVEXCEPTN NONE PADRIVER 37A4 3 SHOW SHOW info_type n This command allows the user to see the detailed data associated with a particular crash. The types of information which can be displayed are :- CANASTA, CRASH, STACK, EXECUTIVE, ISTREAM, SUMMARY, SYMBOLS and ALL. If the crash number is not specified, the most recent crash, #1, is chosen by default. 3 EXTRACT EXTRACT n This command is used to extract specific record entries from a binary file and write them to either an ASCII or a binary file. The default is ASCII. 4 /OUTPUT /OUTPUT = filename.txt If no filename is specified, the default is CLUE_DISPLAY_EXTRACT.TXT. 4 /BINARY /BINARY = filename.bin This qualifier will write a CLUE History file entry to the specified filename. The default filename is the next version of the file which was read in. 3 DELETE DELETE n This command permanently removes a particular CLUE History entry. Upon exiting, the remainder of the data will be written to the next higher version of the CLUE History binary file. 3 EXIT EXIT This exits from CLUE. 2 /ERROR_LOGS /ERROR_LOGS = filename Extracts the Error Log messages from the Error Log buffers in the Dump and writes them to the specified file. The default file name is CLUE_ELOG.SYS. This file can later be analyzed using the VMS Error Log utility, ANAL/ERR. The Entry Type, Sequence Number, and Time of each error log entry in the dump will also be displayed on the output device. 2 /HELP /HELP Displays the CLUE Online Help. The following directories will be searched for the CLUE Help Library, CLUE.HLB: SYS$HELP CLUE$DIRECTORY the current directory 2 /LOCAL /LOCAL If /LOCAL is specified, the node name in the dump must match the node name of the running system. If the node names do not match, the CLUE History file will not be updated when /BINARY is used and the ASCII file generated will be truncated. If the node names do match, the CLUE History file will be updated (if /BINARY specified). When /LOCAL is used, a Symbol, CLUE$PREV_CRASH, will be defined by CLUE. This symbol will be set to the Crash type (e.g. INVEXCEPTN or OPERATOR). If the dump is not from the local system, this symbol will be set to "WRONG_NODE". The purpose of this symbol is allow other software to tell if CLUE processed a valid crash from this system. 2 /OUTPUT /OUTPUT = filename The data extracted from the dump file will be written to the specified file. If /OUTPUT is used without a filename, CLUE.LIS will be used. If CLUE$OUTPUT is defined, the output file will be placed in that directory. 2 /PCHB /PCHB = filename This qualifier is used to read a VAX9000 PC History Buffer file. After the CLUE analysis of the dump, the PC History Buffer file is read and the PCs interpreted. If the file is not a valid PCHB file, this qualifier is ignored. 2 /READ_SYMBOLS /READ_SYMBOLS = filename If the specified file is an .STB file, the global symbols will be read in by CLUE. Otherwise, the file should contain a list of .STB files. The symbols from the files listed in the specified file will be read in and added to the symbol tree. Executive images should not be specified with /READ_SYMBOLS as the base address will not yet be available when the symbols are being read in. 3 Examples: CLUE/READ_SYMBOLS = SYS$SYSTEM:SCSDEF.STB Reads the symbols from the Symbol Table file SCSDEF.STB. CLUE/READ_SYMBOLS = STB.FILS where STB.FILS contains, for example, SYS$SYSTEM:DCLDEF.STB SYS$SYSTEM:RMSDEF.STB SYS$SYSTEM:SYSDEF.STB Symbols from the above files will be read in. 2 /SUMMARY /[NO]SUMMARY A summary of the processes current on the System at the time of the crash will be displayed. The information shown for each process includes the Process Control Block (PCB), Process Name, Username, State, and Image name if available. Also a listing of major code modules will be displayed. This includes the name, address, and length of the code modules. Among the code modules displayed are the executive loaded images and all loaded drivers. If there is a current process, the recall buffer will be displayed. This qualifier is supplied by default. To suppress the summary data, use /NOSUMMARY. The summary data may also be suppressed by define a logical, CLUE$NOSUMMARY, to any value. This provides a simple mechanism to suppress the summary data without editing the command procedure containing the CLUE command. 2 /SYMBOLS /SYMBOLS = file The values of symbols listed in the specified file will be included in the output of CLUE. The file must conform to the following convention: Symbol_name Length Code "Code" can be one of (A)scii, (H)ex, or (T)ime. If Length or Code are not specified, defaults of 4 and H are assumed. 3 Examples /SYMBOLS = SYMBOL.FIL SYMBOL.FIL contains: EXE$GQ_SYSTIME 8 T SYS$GQ_VERSION 8 A EXE$GL_FLAGS The three symbols in SYMBOL.FIL will be found in the dump and displayed as a VMS Time string, 8 character ASCII string, and a Longword in HEX respectively. If the first character of a Symbol is "*", all symbols containing this string will be retrieved and displayed. If the first character is "@", the contents of the address pointed to by the symbol will be displayed. If no file is specified with the /SYMBOLS qualifier, symbols may be entered interactively as the dump is analyzed.