1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
|
/*=========================================================================
Program: Visualization Toolkit
Module: vtkBreakPoint.h
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
All rights reserved.
See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
/**
* @class vtkBreakPoint
* @brief Utility function to debug with gdb and MPI.
*
* Wherever you need to set a break point inside a piece of code run by MPI,
*
* Step 1: call vtkBreakPoint::Break() in the code.
* Step 2: start MPI, each process will display its PID and sleep.
* Step 3: start gdb with the PID: gdb --pid=<PID>
* Step 4: set a breakpoint at the line of interest: (gdb) b <option>
* Step 5: go out of the sleep: (gdb) set var i=1
* Original instructions at the OpenMPI FAQ:
* http://www.open-mpi.de/faq/?category=debugging#serial-debuggers
* - 6 Can I use serial debuggers (such as gdb) to debug MPI applications?
* - 6.1. Attach to individual MPI processes after they are running.
*
* @par Implementation:
* This function is in Common, not in Parallel because it does not depend on
* MPI and you may want to call vtkBreakPoint::Break() in any class of VTK.
*/
#ifndef vtkBreakPoint_h
#define vtkBreakPoint_h
#include "vtkCommonCoreModule.h" // For export macro
#include "vtkObject.h" // to get VTKCOMMONCORE_EXPORT
class VTKCOMMONCORE_EXPORT vtkBreakPoint
{
public:
//@{
/**
* Process fall asleep until local variable `i' is set to a value different
* from 0 inside a debugger.
*/
static void Break();
};
//@}
#endif // #ifndef vtkBreakPoint_h
// VTK-HeaderTest-Exclude: vtkBreakPoint.h
|
