0023880: Integration of grid "ncl" into the new testing system
[occt.git] / dox / dev_guides / debug / debug.md
1 Debugging tools and hints {#occt_dev_guides__debug}
2 =========================
3
4 @tableofcontents
5
6 @section occt_debug_intro Introduction
7
8 This manual describes facilities included in OCCT to support debugging, and provides some hints for more efficient debug.
9
10 @section occt_debug_macro Compiler macro to enable extended debug messages
11
12 Many OCCT algorithms can produce extended debug messages, usually printed to cout.
13 These include messages on internal errors and special cases encountered, timing etc.
14 In OCCT versions prior to 6.8.0 most of these messages were activated by compiler macro *DEB*, enabled by default in debug builds.
15 Since version 6.8.0 this is disabled by default but can be enabled by defining compiler macro *OCCT_DEBUG*.
16
17 To enable this macro on Windows when building with Visual Studio projects, edit file custom.bat and add the line:
18
19     set CSF_DEFINES=OCCT_DEBUG
20
21 Some algorithms use specific macros for yet more verbose messages, usually started with OCCT_DEBUG_.
22 These messages can be enabled in the same way, by defining corresponding macro.
23
24 Note that some header files are modified when *OCCT_DEBUG* is enabled, hence binaries built with it enabled are not compatible with client code built without this option; this is not intended for production use.
25
26 @section occt_debug_exceptions Calling JIT debugger on exception
27
28 On Windows platform when using Visual Studio compiler there is a possibility to start the debugger automatically if an exception is caught in a program running OCCT. For this, set environment variable *CSF_DEBUG* to any value. Note that this feature works only if you enable OCCT exception handler in your application by calling *OSD::SetSignal()*.
29
30 @section occt_debug_bop Self-diagnostics in Boolean operations algorithm
31
32 In real-world applications modeling operations are often performed in a long sequence, while the user sees only the final result of the whole sequence. If the final result is wrong, the first debug step is to identify the offending operation to be debugged further. Boolean operation algorithm in OCCT provides a self-diagnostic feature which can help to do that step.
33
34 This feature can be activated by defining environment variable *CSF_DEBUG_BOP*, which should specify an existing writeable directory.
35
36 The diagnostic code checks validity of the input arguments and the result of each Boolean operation. When an invalid situation is detected, the report consisting of argument shapes and a DRAW script to reproduce the problematic operation is saved to the directory pointed by *CSF_DEBUG_BOP*.
37
38 @section occt_debug_call Functions for calling from debugger
39
40 Modern interactive debuggers provide the possibility to execute application code at a program break point. This feature can be used to analyse the temporary objects available only in the context of the debugged code. OCCT provides several global functions that can be used in this way.
41
42 Note that all these functions accept pointer to variable as <i>void*</i> to allow calling the function even when debugger does not recognize type equivalence or can not perform necessary type cast automatically. It is responsibility of the developer to provide the correct pointer. In general these functions are not guaranteed to work, thus use them with caution and at your own risk.
43
44 @subsection occt_debug_call_draw Interacting with DRAW
45
46 Open CASCADE Test Harness or @ref occt_user_guides__test_harness "DRAW" provides an extensive set of tools for inspection and analysis of OCCT shapes and geometric objects and is mostly used as environment for prototyping and debugging OCCT-based algorithms.
47
48 In some cases the objects to be inspected are available in DRAW as results of DRAW commands. In other cases, however, it is necessary to inspect intermediate objects created by the debugged algorithm. To support this, DRAW provides a set of commands allowing the developer to store intermediate objects directly from the debugger stopped at some point during the program execution (usually at a breakpoint).
49
50 ~~~~~
51 const char* Draw_Eval (const char *theCommandStr)
52 ~~~~~
53
54 Evaluates a DRAW command or script.
55 A command is passed as a string parameter.
56
57 ~~~~~
58 const char* DBRep_Set (const char* theNameStr, void* theShapePtr)
59 ~~~~~
60
61 Sets the specified shape as a value of DRAW interpreter variable with the given name.
62 - *theNameStr* - the DRAW interpreter variable name to set.
63 - *theShapePtr* - a pointer to *TopoDS_Shape* variable.
64
65 ~~~~~
66 const char* DrawTrSurf_Set (const char* theNameStr, void* theHandlePtr)
67 const char* DrawTrSurf_SetPnt (const char* theNameStr, void* thePntPtr)
68 const char* DrawTrSurf_SetPnt2d (const char* theNameStr, void* thePnt2dPtr)
69 ~~~~~
70
71 Sets the specified geometric object as a value of DRAW interpreter variable with the given name.
72 - *theNameStr* - the DRAW interpreter variable name to set.
73 - *theHandlePtr* - a pointer to the geometric variable (Handle to *Geom_Geometry* or *Geom2d_Curve* or descendant) to be set.
74 - *thePntPtr* - a pointer to the variable of type *gp_Pnt* to be set.
75 - *thePnt2dPtr* - a pointer to the variable of type *gp_Pnt2d* to be set.
76
77 All these functions are defined in *TKDraw* toolkit and return a string indicating the result of execution.
78
79 @subsection occt_debug_call_brep Saving and dumping shapes and geometric objects
80
81 The following functions are provided by *TKBRep* toolkit and can be used from debugger prompt:
82
83 ~~~~~
84 const char* BRepTools_Write (const char* theFileNameStr, void* theShapePtr)
85 ~~~~~
86
87 Saves the specified shape to a file with the given name.
88 - *theFileNameStr* - the DRAW interpreter variable name to set.
89 - *theShapePtr* - a pointer to *TopoDS_Shape* variable.
90
91 ~~~~~
92 const char* BRepTools_Dump (void* theShapePtr)
93 const char* BRepTools_DumpLoc (void* theShapePtr)
94 ~~~~~
95
96 Dumps shape or its location to cout.
97 - *theShapePtr* - a pointer to *TopoDS_Shape* variable.
98
99 The following function is provided by *TKMesh* toolkit:
100
101 ~~~~~
102 const char* BRepMesh_Dump (void* theMeshHandlePtr, const char* theFileNameStr)
103 ~~~~~
104
105 Stores mesh produced in parametric space to BREP file.
106 - *theMeshHandlePtr* - a pointer to *Handle(BRepMesh_DataStructureOfDelaun)* variable.
107 - *theFileNameStr* - name of file the mesh sould be stored to.
108
109 The following additional function is provided by *TKGeomBase* toolkit:
110
111 ~~~~~
112 const char* GeomTools_Dump (void* theHandlePtr)
113 ~~~~~
114
115 Dump geometric object to cout.
116 - *theHandlePtr* - a pointer to the geometric variable (<i>Handle</i> to *Geom_Geometry* or *Geom2d_Curve* or descendant) to be set.
117
118 @section occt_debug_vstudio Using Visual Studio debugger 
119
120 @subsection occt_debug_vstudio_command Command window 
121
122 Visual Studio debugger provides the Command Window (can be activated from menu <b>View / Other Windows / Command Window</b>), which can be used to evaluate variables and expressions interactively in a debug session (see http://msdn.microsoft.com/en-us/library/c785s0kz.aspx). Note that the Immediate Window can also be used but it has some limitations, e.g. does not support aliases.
123
124 When the execution is interrupted by a breakpoint, you can use this window to call the above described functions in context of the currently debugged function. Note that in most cases you will need to specify explicitly context of the function by indicating the name of the DLL where it is defined.
125
126 For example, assume that you are debugging a function, where local variable *TopoDS_Edge* *anEdge1* is of interest.
127 The following set of commands in the Command window will save this edge to file *edge1.brep*, then put it to DRAW variable *e1* and show it maximized in the axonometric DRAW view:
128
129 ~~~~~
130 >? ({,,TKBRep.dll}BRepTools_Write)("d:/edge1.brep",(void*)&anEdge1)
131 0x04a2f234 "d:/edge1.brep"
132 >? ({,,TKDraw.dll}DBRep_Set)("e1",(void*)&anEdge1)
133 0x0369eba8 "e1"
134 >? ({,,TKDraw.dll}Draw_Eval)("donly e1; axo; fit")
135 0x029a48f0 ""
136 ~~~~~
137
138 For convenience it is possible to define aliases to commands in this window, for instance (here ">" is prompt provided by the command window; in the Immediate window this symbol should be entered manually):
139
140 ~~~~~
141 >alias deval      ? ({,,TKDraw}Draw_Eval)
142 >alias dsetshape  ? ({,,TKDraw}DBRep_Set)
143 >alias dsetgeom   ? ({,,TKDraw}DrawTrSurf_Set)
144 >alias dsetpnt    ? ({,,TKDraw}DrawTrSurf_SetPnt)
145 >alias dsetpnt2d  ? ({,,TKDraw}DrawTrSurf_SetPnt2d)
146 >alias saveshape  ? ({,,TKBRep}BRepTools_Write)
147 >alias dumpshape  ? ({,,TKBRep}BRepTools_Dump)
148 >alias dumploc    ? ({,,TKBRep}BRepTools_DumpLoc)
149 >alias dumpmesh   ? ({,,TKMesh}BRepMesh_Dump)
150 >alias dumpgeom   ? ({,,TKGeomBase}GeomTools_Dump)
151 ~~~~~ 
152
153 Note that aliases are stored in the Visual Studio user's preferences and it is sufficient to define them once on a workstation. With these aliases, the above example can be reproduced easier (note the space symbol after alias name!):
154
155 ~~~~~
156 >saveshape ("d:/edge1.brep",(void*)&anEdge1)
157 0x04a2f234 "d:/edge1.brep"
158 >dsetshape ("e1",(void*)&anEdge1)
159 0x0369eba8 "e1"
160 >deval ("donly e1; axo; fit")
161 0x029a48f0 ""
162 ~~~~~
163
164 Note that there is no guarantee that the call will succeed and will not affect the program execution, thus use this feature at your own risk. In particular, the commands interacting with window system (such as *axo*, *vinit*, etc.) are known to cause application crash when the program is built in 64-bit mode. To avoid this, it is recommended to prepare all necessary view windows in advance, and arrange these windows to avoid overlapping with the Visual Studio window, to ensure that they are visible during debug. 
165
166 @subsection occt_debug_vstudio_watch Customized display of variables content
167
168 Visual Studio provides a way to customize display of variables of different types in debugger windows (Watch, Autos, Locals, etc.).
169
170 In Visual Studio 2005-2010 the rules for this display are defined in file *autoexp.dat* located in  subfolder *Common7\\Packages\\Debugger* of the Visual Studio installation folder (hint: the path to that folder is given in the corresponding environment variable, e.g. *VS100COMNTOOLS* for vc10). This file contains two sections: *AutoExpand* and *Visualizer*. The following rules can be added to these sections to provide more convenient display of some OCCT data types. 
171
172 ### \[AutoExpand\] section 
173
174 ~~~~~
175 ; Open CASCADE classes
176 Standard_Transient=<,t> count=<count,d>
177 Handle_Standard_Transient=<entity,x> count=<entity->count,d> <,t>
178 TCollection_AsciiString=<mylength,d> <mystring,s>
179 TCollection_HAsciiString=<myString.mylength,d> <myString.mystring,s>
180 TCollection_ExtendedString=<mylength,d> <mystring,su>
181 TCollection_HExtendedString=<myString.mylength,d> <myString.mystring,su>
182 TCollection_BaseSequence=size=<Size,d> curr=<CurrentIndex,d>
183 TCollection_BasicMap=size=<mySize,d>
184 NCollection_BaseSequence=size=<mySize,d> curr=<myCurrentIndex,d>
185 NCollection_BaseList=length=<myLength,d>
186 NCollection_BaseMap=size=<mySize,d> buckets=<myNbBuckets>
187 NCollection_BaseVector=length=<myLength,d>
188 TDF_Label=<myLabelNode,x> tag=<myLabelNode->myTag>
189 TDF_LabelNode=tag=<myTag,d>
190 TDocStd_Document=format=<myStorageFormat.mystring,su> count=<count,d> <,t>
191 TopoDS_Shape=<myTShape.entity,x> <myOrient>
192 gp_XYZ=<x,g>, <y,g>, <z,g>
193 gp_Pnt=<coord.x,g>, <coord.y,g>, <coord.z,g>
194 gp_Vec=<coord.x,g>, <coord.y,g>, <coord.z,g>
195 gp_Dir=<coord.x,g>, <coord.y,g>, <coord.z,g>
196 gp_XY=<x,g>, <y,g>
197 gp_Pnt2d=<coord.x,g>, <coord.y,g>
198 gp_Dir2d=<coord.x,g>, <coord.y,g>
199 gp_Vec2d=<coord.x,g>, <coord.y,g>
200 gp_Mat2d={<matrix[0][0],g>,<matrix[0][1],g>}, {<matrix[1][0],g>,<matrix[1][1],g>}
201 gp_Ax1=loc={<loc.coord.x,g>, <loc.coord.y,g>, <loc.coord.z,g>} vdir={<vdir.coord.x,g>, <vdir.coord.y,g>, <vdir.coord.z,g>}
202 ~~~~~ 
203
204 ### \[Visualizer\] section
205
206 ~~~~~
207 ; Open CASCADE classes
208
209 NCollection_Handle<*> {
210   preview ( *((($T0::Ptr*)$e.entity)->myPtr) )
211   children ( (($T0::Ptr*)$e.entity)->myPtr )
212 }
213
214 NCollection_List<*> {
215   preview ( #( "NCollection_List [", $e.myLength, "]" ) )
216   children ( #list( head: $c.myFirst, next: myNext ) : #(*($T1*)(&$e+1)) )
217 }
218
219 NCollection_Array1<*> {
220   preview ( #( "NCollection_Array1 [", $e.myLowerBound, "..", $e.myUpperBound, "]" ) )
221   children ( #array( expr: $c.myData[$i], size: 1+$c.myUpperBound ) )
222 }
223
224 math_Vector {
225   preview ( #( "math_Vector [", $e.LowerIndex, "..", $e.UpperIndex, "]" ) )
226   children ( #array ( expr: ((double*)($c.Array.Addr))[$i], size: 1+$c.UpperIndex ) )
227 }
228
229 TColStd_Array1OfReal {
230   preview ( #( "Array1OfReal [", $e.myLowerBound, "..", $e.myUpperBound, "]" ) )
231   children ( #array ( expr: ((double*)($c.myStart))[$i], size: 1+$c.myUpperBound ) )
232 }
233
234 Handle_TColStd_HArray1OfReal {
235   preview ( #( "HArray1OfReal [",
236                ((TColStd_HArray1OfReal*)$e.entity)->myArray.myLowerBound, "..", 
237                ((TColStd_HArray1OfReal*)$e.entity)->myArray.myUpperBound, "] ",
238                [$e.entity,x], " count=", $e.entity->count ) )
239   children ( #array ( expr: ((double*)(((TColStd_HArray1OfReal*)$e.entity)->myArray.myStart))[$i],
240                       size: 1+((TColStd_HArray1OfReal*)$e.entity)->myArray.myUpperBound ) )
241 }
242
243 TColStd_Array1OfInteger {
244   preview ( #( "Array1OfInteger [", $e.myLowerBound, "..", $e.myUpperBound, "]" ) )
245   children ( #array ( expr: ((int*)($c.myStart))[$i], size: 1+$c.myUpperBound ) )
246 }
247
248 Handle_TColStd_HArray1OfInteger {
249   preview ( #( "HArray1OfInteger [",
250                ((TColStd_HArray1OfInteger*)$e.entity)->myArray.myLowerBound, "..", 
251                ((TColStd_HArray1OfInteger*)$e.entity)->myArray.myUpperBound, "] ",
252                [$e.entity,x], " count=", $e.entity->count ) )
253   children ( #array ( expr: ((int*)(((TColStd_HArray1OfInteger*)$e.entity)->myArray.myStart))[$i],
254                       size: 1+((TColStd_HArray1OfInteger*)$e.entity)->myArray.myUpperBound ) )
255 }
256
257 Handle_TCollection_HExtendedString {
258   preview ( #( "HExtendedString ", [$e.entity,x], " count=", $e.entity->count, 
259                " ", ((TCollection_HExtendedString*)$e.entity)->myString ) )
260   children ( #([actual members]: [$e,!] ) )
261 }
262
263 Handle_TCollection_HAsciiString {
264   preview ( #( "HAsciiString ", [$e.entity,x], " count=", $e.entity->count, 
265                " ", ((TCollection_HAsciiString*)$e.entity)->myString ) )
266   children ( #([actual members]: [$e,!], 
267              #array( expr: ((TCollection_HAsciiString*)$e.entity)->myString.mystring[$i], 
268                      size: ((TCollection_HAsciiString*)$e.entity)->myString.mylength) ) )
269 }
270 ~~~~~
271
272 In Visual Studio 2012 and later, visualizers can be put in a separate file in subdirectory *Visualizers*. See file *occt.natvis* for example.
273
274 @section occt_debug_perf Performance measurement tools
275
276 It is recommended to use specialized performance analysis tools to profile OCCT and application code.
277 However, when such tools are not available or cannot be used for some reason, tools provided by OCD package can be used: see low-level C functions and macros defined OSD_PerfMeter.h, and OSD_PerfMeter class.
278
279 This tool maintains an array of 100 global performance counters that can be started and stopped independently.
280 Adding performance counter to a function of interest allows to get statistics on number of calls and total execution time of the function.
281 In C++ code, this can be achieved by creating local variable OSD_PerfMeter in each block of code to be measured.
282 In C or Fortran code, use functions perf_start_meter and perf_stop_meter to start and stop the counter.
283 Note that this instrumentation is intended to be removed when profiling is completed.
284 Macros provided in OSD_PerfMeter.h can be used to keep instrumentation code permanently, but enable it only when macro PERF_ENABLE_METERS is defined.
285 Each counter has its name shown when the collected statistics are printed.
286
287 In DRAW, use command dperf to prints all performance statistics.
288
289 Note that performance counters are not thread-safe.