Troubleshooting

Simulation Hangs

Did you directly call a function that is decorated as a coroutine, i.e. without using await or yield?

Increasing Verbosity

If things fail in the VPI/VHPI/FLI area, check your simulator’s documentation to see if it has options to increase its verbosity about what may be wrong. You can then set these options on the make command line as COMPILE_ARGS, SIM_ARGS or EXTRA_ARGS (see Build options and Environment Variables for details). If things fail from within Python, or coroutines aren’t being called when you expect, the COCOTB_SCHEDULER_DEBUG variable can be used to (greatly) increase the verbosity of the scheduler.

Attaching a Debugger

C and C++

In order to give yourself time to attach a debugger to the simulator process before it starts to run, you can set the environment variable COCOTB_ATTACH to a pause time value in seconds. If set, cocotb will print the process ID (PID) to attach to and wait the specified time before actually letting the simulator run.

For the GNU debugger GDB, the command is attach <process-id>.

Python

When executing the Makefile to run a cocotb test, a Python shell interpreter is called from within the VPI/VHPI/FLI library. Hence it is not possible to directly attach a Python debugger to the Python process being part of the simulator that uses the aforementioned library. Using import pdb; pdb.set_trace() directly is also frequently not possible, due to the way that simulators interfere with stdin.

To successfully debug your Python code use the remote_pdb Python package to create a pdb instance accessible via a TCP socket:

  1. In your code insert the line:

    from remote_pdb import RemotePdb; rpdb = RemotePdb("127.0.0.1", 4000)
    
  2. Then before the line of code you want the debugger to stop the execution, add a breakpoint:

    rpdb.set_trace()  # <-- debugger stops execution after this line
    <your code line>  # <-- next statement being evaluated by the interpreter
    
  3. Run the Makefile so that the interpreter hits the breakpoint line and hangs.

  4. Connect to the freshly created socket, for instance through telnet:

    telnet 127.0.0.1 4000