File: structSanitizer__CallbackData.html

package info (click to toggle)
nvidia-cuda-toolkit 12.5.0-1
  • links: PTS, VCS
  • area: non-free
  • in suites: experimental
  • size: 13,247,276 kB
  • sloc: ansic: 214,716; cpp: 65,455; javascript: 24,274; python: 22,339; xml: 11,484; makefile: 3,079; sh: 2,288; perl: 356
file content (143 lines) | stat: -rw-r--r-- 8,762 bytes parent folder | download
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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>SanitizerApi: Sanitizer_CallbackData Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.8 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
      <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>Sanitizer_CallbackData Struct Reference<br>
<small>
[<a class="el" href="group__SANITIZER__CALLBACK__API.html">Sanitizer Callback API</a>]</small>
</h1><!-- doxytag: class="Sanitizer_CallbackData" -->Data passed into a runtime or driver API callback function.  
<a href="#_details">More...</a>
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Data Fields</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__SANITIZER__CALLBACK__API.html#g0bc24cc0af4c2b8f9c50355c1c1d36ae">Sanitizer_ApiCallbackSite</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSanitizer__CallbackData.html#f1fbd9c50f2714f75ec1de051151124d">callbackSite</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">CUcontext&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSanitizer__CallbackData.html#6952454cc861e5a97c40d9e459a90351">context</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSanitizer__CallbackData.html#cffbfadfe4c7af894d8e39407595efd2">functionName</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">const void *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSanitizer__CallbackData.html#3866442ee35daa08d5bbd2eeb366f91f">functionParams</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">const void *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSanitizer__CallbackData.html#b523a3af8e202cbbdd706277014041fa">functionReturnValue</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSanitizer__CallbackData.html#1ee030118e093f440f953d896ee80be6">symbolName</a></td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Data passed into a runtime or driver API callback function as the <code>cbdata</code> argument to <a class="el" href="group__SANITIZER__CALLBACK__API.html#gf031ccd4dcc013ab017d9ee1032858c4">Sanitizer_CallbackFunc</a>. The <code>cbdata</code> will be this type for <code>domain</code> equal to SANITIZER_CB_DOMAIN_DRIVER_API or SANITIZER_CB_DOMAIN_RUNTIME_API. The callback data is valid only within the invocation of the callback function that is passed the data. If you need to retain some data for use outside of the callback, you must make of a copy of that data. For example, if you make a shallow copy of <a class="el" href="structSanitizer__CallbackData.html" title="Data passed into a runtime or driver API callback function.">Sanitizer_CallbackData</a> within a callback, you cannot dereference <code>functionParams</code> outside of that callback to access the function parameters. <code>functionName</code> is an exception: the string pointed to by <code>functionName</code> is a global constant and so may be accessed outside of the callback. <hr><h2>Field Documentation</h2>
<a class="anchor" name="f1fbd9c50f2714f75ec1de051151124d"></a><!-- doxytag: member="Sanitizer_CallbackData::callbackSite" ref="f1fbd9c50f2714f75ec1de051151124d" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__SANITIZER__CALLBACK__API.html#g0bc24cc0af4c2b8f9c50355c1c1d36ae">Sanitizer_ApiCallbackSite</a> <a class="el" href="structSanitizer__CallbackData.html#f1fbd9c50f2714f75ec1de051151124d">Sanitizer_CallbackData::callbackSite</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Point in the runtime or driver function from where the callback was issued. 
</div>
</div><p>
<a class="anchor" name="6952454cc861e5a97c40d9e459a90351"></a><!-- doxytag: member="Sanitizer_CallbackData::context" ref="6952454cc861e5a97c40d9e459a90351" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">CUcontext <a class="el" href="structSanitizer__CallbackData.html#6952454cc861e5a97c40d9e459a90351">Sanitizer_CallbackData::context</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Driver context current to the thread, or null if no context is current. This value can change from the entry to exit callback of a runtime API function if the runtime initialized a context. 
</div>
</div><p>
<a class="anchor" name="cffbfadfe4c7af894d8e39407595efd2"></a><!-- doxytag: member="Sanitizer_CallbackData::functionName" ref="cffbfadfe4c7af894d8e39407595efd2" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* <a class="el" href="structSanitizer__CallbackData.html#cffbfadfe4c7af894d8e39407595efd2">Sanitizer_CallbackData::functionName</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Name of the runtime or driver API function which issued the callback. This string is a global constant and so may be accessed outside of the callback. 
</div>
</div><p>
<a class="anchor" name="3866442ee35daa08d5bbd2eeb366f91f"></a><!-- doxytag: member="Sanitizer_CallbackData::functionParams" ref="3866442ee35daa08d5bbd2eeb366f91f" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const void* <a class="el" href="structSanitizer__CallbackData.html#3866442ee35daa08d5bbd2eeb366f91f">Sanitizer_CallbackData::functionParams</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Pointer to the arguments passed to the runtime or driver API call. See generated_cuda_runtime_api_meta.h and generated_cuda_meta.h for structure definitions for the parameters for each runtime and driver API function. 
</div>
</div><p>
<a class="anchor" name="b523a3af8e202cbbdd706277014041fa"></a><!-- doxytag: member="Sanitizer_CallbackData::functionReturnValue" ref="b523a3af8e202cbbdd706277014041fa" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const void* <a class="el" href="structSanitizer__CallbackData.html#b523a3af8e202cbbdd706277014041fa">Sanitizer_CallbackData::functionReturnValue</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Pointer to the return value of the runtime or driver API call. This field is only valid within the SANITIZER_API_EXIT callback. For a runtime API <code>functionReturnValue</code> points to a <code>cudaError_t</code>. For a driver API <code>functionReturnValue</code> points to a <code>CUresult</code>. 
</div>
</div><p>
<a class="anchor" name="1ee030118e093f440f953d896ee80be6"></a><!-- doxytag: member="Sanitizer_CallbackData::symbolName" ref="1ee030118e093f440f953d896ee80be6" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* <a class="el" href="structSanitizer__CallbackData.html#1ee030118e093f440f953d896ee80be6">Sanitizer_CallbackData::symbolName</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Name of the symbol operated on by the runtime or driver API function which issued the callback. This entry is valid only for driver and runtime launch callbacks, where it returns the name of the kernel. 
</div>
</div><p>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Apr 15 23:05:33 2024 for SanitizerApi by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
</body>
</html>