Difference between revisions of "GPU621/Debugging OpenMP"

From CDOT Wiki
Jump to: navigation, search
(Attach to Process)
(Registry Editor)
Line 72: Line 72:
  
 
==== Registry Editor ====
 
==== Registry Editor ====
 +
 +
The Windows Registry Editor can be used to automatically start a process in the debugger. This will allow you to debug the startup code for an app that is launched by another process, such as services.
 +
 +
# Start the Windows Registry Editor by running regedit.exe from the run window (Windows + R).
 +
# In the Registry Editor, go to HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Image File Execution Options.
 +
# Select the folder of the app to start in the debugger.
 +
## If the app isn't listed, right-click Image File Execution Options, select New > Key, and enter the application's name.
 +
# Right-click the new key in the tree and select New > String Value.
 +
# Change the name of the new value from ``New Value #1`` to <code>debugger</code>.
 +
# Right-click the new value and select Modify. Change the value data to <code>vsjitdebugger.exe</code> and select OK.
 +
# In the Edit String dialog box, enter <code>vsjitdebugger.exe</code> in the Value data box, and then select OK.
  
 
= User Interface =
 
= User Interface =

Revision as of 01:34, 29 November 2022

Group Members

  1. Jimmy Liu
  2. Sami Ali
  3. Leon Liu

// TODO: Create a tutorial on how to debug parallel programs using OpenMP in Visual Studio

// remember to add pictures if possible

// Steps

1. Read the Microsoft Documentation for your section

2. Paraphrase the contents of your section onto the Wiki

3. Test it yourself in Visual Studio and add examples

// Uploading Files

To upload a file, go to https://wiki.cdot.senecacollege.ca/wiki/Special:Upload

To include a file in a page, use [[File:File.jpg]] to use the full version of the file

Process and Thread

Process

A process is an instance of a program executed by the computer. Processes are started when programs are initiated, and they can be comprised of one or more threads.

On Windows operating systems, you can look at your running processes on the Task Manager.

Thread

A single thread is a set of instructions that the CPU schedules and executes independently. A process consists of one or more threads which are able to be run concurrently. This forms the basis of multithreading.

Multiple Processes

Background

Visual Studio supports the creation of solutions with multiple processes. Visual Studio's debugger will by default run the first project (selected in bold), but this can be changed in the Solution Explorer by right-clicking on a different project and selecting Set as Startup Project. This will allow you when debugging to switch between processes, as well as break, stop, and continue currently debugging processes.

Setup

Startup Project

To set the startup project or multiple projects:

  1. Right-click the solution in the Solution Explorer and select Properties.
  2. In the Properties window, select Common Properties > Startup Project.
  3. Here you can change the Startup Project to either the currently selected project, a single startup project (this is selected by default), or multiple startup projects.
    1. When selecting Multiple startup projects, you can modify the execution order and action for each project between Start, Start without debugging, or None.
  4. Save your settings by selected Apply or OK.

Startup-settings.png

Command Scope

When debugging with multiple processes, the break, step, and continue debugger commands will affect all processes by default. This can have unintended consequences when debugging. To gain more control over the targets, you can and should change these settings. You can do so by going to Tools (or Debug) > Options > Debugging > General, and clearing the checkbox Break all processes when one process breaks.

Break-processes.png

Attach to Process

The Visual Studio debugger has the capability to attach to applications running in processes outside of Visual Studio locally and remotely. You can use the debugger while attached to a separate app, though some features may be limited. To attach to a running process:

  1. With the app and Visual Studio running, select Debug > Attach to Process
  2. Select the desired process from the list and select Attach

Attach-to-process.png

Keep in mind that Visual Studio will not attach to any child process spawned by the debugged process. You will have to manually attach it to the new child.

Registry Editor

The Windows Registry Editor can be used to automatically start a process in the debugger. This will allow you to debug the startup code for an app that is launched by another process, such as services.

  1. Start the Windows Registry Editor by running regedit.exe from the run window (Windows + R).
  2. In the Registry Editor, go to HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Image File Execution Options.
  3. Select the folder of the app to start in the debugger.
    1. If the app isn't listed, right-click Image File Execution Options, select New > Key, and enter the application's name.
  4. Right-click the new key in the tree and select New > String Value.
  5. Change the name of the new value from ``New Value #1`` to debugger.
  6. Right-click the new value and select Modify. Change the value data to vsjitdebugger.exe and select OK.
  7. In the Edit String dialog box, enter vsjitdebugger.exe in the Value data box, and then select OK.

User Interface

// TODO: Show the window and explain what it does for every single window below (medium)

// documentation for windows are here: https://learn.microsoft.com/en-us/visualstudio/debugger/debug-threads-and-processes?view=vs-2022

Attach to Process Dialog Box

Process Window

Thread Window

Source Window

Debug Location Window

Parallel Stacks Window

Parallel Tasks Window

Parallel Watch Window

Walkthrough

// TODO: Step-by-step walkthrough on how to debug program with the specific window

// use same program for both tests

// can probably just take something from course notes and modify it to fit our parameters

Case A: Using the Thread Window

// TODO: walkthrough on using thread window to debug (medium)

// https://learn.microsoft.com/en-us/visualstudio/debugger/walkthrough-debugging-a-parallel-application?view=vs-2022&tabs=cpp

Case B: Using the Parallel Stacks Window

// TODO: walkthrough on using parallel stacks window to debug (long)

// https://learn.microsoft.com/en-us/visualstudio/debugger/using-the-parallel-stacks-window?view=vs-2022

https://en.wikipedia.org/wiki/Help:Cheatsheet