UPGRADE YOUR BROWSER

We have detected your current browser version is not the latest one. Xilinx.com uses the latest web technologies to bring you the best online experience possible. Please upgrade to a Xilinx.com supported browser:Chrome, Firefox, Internet Explorer 11, Safari. Thank you!

AR# 55854

Vivado - What can I do to resolve a Vivado crash, exception, or abnormal program termination?

Description

I have experienced a crash, internal exception, or abnormal program termination while using the Vivado Integrated Design Environment.

Are there any recommended procedures or guidelines available to report this event and get a resolution?

Solution

The following are some types of Vivado crashes or application errors:


  • An unexpected error has occurred
  • A process fails abruptly with no error message
  • Warning message with the message Abnormal program termination
  • Process fails with message "Failed" but without any additional error message
  • An unexpected error has occurred

Please report crashes, internal exceptions, or abnormal program terminations to Xilinx so that the quality of the tools can be improved.

In cases of similar types of Vivado crashes, please provide the following files and information:


  • Steps to reproduce
    • If the crash is repeatable, please provide exact steps that are used to reproduce the problem.
    • If the crash is not repeatable, please provide as much detail as possible about what steps and processes were being run at the time of the crash. Include the log files as indicated below.
  • Design and project files
    • If the crash is design specific, please submit the design if possible. It is usually best to provide the project initially in order to save time and debugging effort.
      However, if the project cannot be submitted, please verify if the same issue occurs with a simple test design that can be submitted or with one of the example designs installed with Vivado.
  • Log Files
    • The Vivado_pidcxxxx.debug file, located in the CWD directory, is created when an Internal Application Error occurs in Vivado IDE and contains information related to the IE.
    • hs_err_pidxxxx.log - The hs_err_pid####.log, located in the CWD directory, is the stack trace file that contains information related to the nature of the crash.
    • The log file (vivado.log) - The Vivado.log file captures the contents of the messages created from running Vivado IDE commands. To view the file, select File > Open Log File from the main menu.
    • The journal file (vivado.jou) - The journal file (vivado.jou) captures the Tcl commands from a Vivado IDE session. A previous journal file will be stored as vivado vivado.backup.jou.

The error files can provide valuable information for debugging the Vivado IDE in the event of an unexpected interrupt. The error files should be provided even if the project files cannot be submitted. In many (but not all) cases, the information in these files can point the developer to the source of the crash.

If the Vivado IDE issues a dialog box that warns of an internal exception error, the vivado_pidxxxx.debug file will be created and saved automatically. The hs_err_pidxxxx.log is saved in event of a Fatal Application error.


Internal Exception

An internal exception is a situation where the tools have become unstable, but you can generally save your work before exiting the program.

In this case, the Vivado tools will create two debug files in the directory of the tool in which it was started.


  • Start in directory:
    • Most users of Windows use a shortcut. On the shortcut properties window, look at the "Start in" directory for the location where Vivado was started. This will typically be "%APPDATA%\Xilinx\Vivado".
    • Most users of Linux start the Vivado tools from a command shell. In this case, the "Start in" directory is the directory they were in when Vivado was launched.
  • Vivado_pid####.debug. The debug file contains the internal tool state. There is no information about your design. In some cases, Xilinx Software developers will be able to figure out what is going on based on this file.
  • Vivado_pid####.str, available in Vivado 2013.1 and later. The STR file contains the user actions that led to the internal exception. There may be instance names from your design in the STR file.

Hard Crash

In the case of a hard crash, the Vivado Integrated Design Environment can suddenly close without warning and the OS might issue a message about an Abnormal Program Termination or Unexpected Error.

Alternatively, if a Run crashes, it might look like the Run is taking an extremely long time.

  • The crash is reported in the hs_err####.log file.
  • A crash on windows may also contain a hs_err####.dmp file.

The files will either be in the start in directory, or if a Run crashed, the files will be in the run directory.

This file contains no design information. It is a trace of the internal tool state.

There is an easy way to check if a run directory contains crash logs.


  1. Select the run.
  2. From the popup menu select Open Run Directory. A file browser will open showing all the files in the run directory.


Additional items to check.

  • If the crash is reproducible, provide the following information to Xilinx Technical Support:
    • The steps to reproduce
    • The available .log, .str, .debug and .dmp files as indicated above
    • If the issue is design dependent, provide the design (if possible)
    • A Xilinx System Information report. This can be obtained by running "report_environment -file sytem_info.txt".
      For 2013.x Vivado installs, xinfo.exe could alternatively be run. It is located under the Xilinx\Vivado\2013.x\ids_lite\ISE\bin\<OS> directory
  • If the crash is not reproducible, provide the following information to Xilinx Technical Support:
    http://www.xilinx.com/support/service-portal/contact-support.html
    • As complete as possible a description of when the crash happened / happens.
    • The available .log, .str, .debug and .dmp files as indicated above.
    • Multiple sets of files might give more information if a crash happens at seemingly random times.
    • If the issue is design dependent, provide the design (if possible).
    • A Xilinx System Information report. This can be obtained by running "report_environment -file sytem_info.txt".
      For 2013.x Vivado installs, xinfo.exe could alternatively be run. It is located under the Xilinx\Vivado\2013.x\ids_lite\ISE\bin\<OS> directory

  • For IP catalog related crashes you can try setting the following debug output before customizing your core. You can turn on debug output by typing the following commands into the Tcl console:

    • debug::add_scope scope HACG
    • debug::add_scope scope HACGIP
    • debug::set_visibility level 10

Linked Answer Records

Associated Answer Records

Answer Number Answer Title Version Found Version Resolved
57386 Vivado - "Error when launching vivado.bat: Launcher time out" N/A N/A
AR# 55854
Date Created 05/03/2013
Last Updated 10/06/2015
Status Active
Type General Article
Tools
  • Vivado Design Suite