Skip to content

Commit 9405d5a

Browse files
authored
[DFSan] Add missing documentation for -dfsan-reaches-function-callbacks. (#84218)
1 parent 2bd369b commit 9405d5a

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

clang/docs/DataFlowSanitizer.rst

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -233,6 +233,28 @@ labels of just ``v1`` and ``v2``.
233233
or, and can be accessed using
234234
``dfsan_label dfsan_get_labels_in_signal_conditional();``.
235235

236+
* ``-dfsan-reaches-function-callbacks`` -- An experimental feature that inserts
237+
callbacks for data entering a function.
238+
239+
In addition to this compilation flag, a callback handler must be registered
240+
using ``dfsan_set_reaches_function_callback(my_callback);``, where my_callback is
241+
a function with a signature matching
242+
``void my_callback(dfsan_label label, dfsan_origin origin, const char *file, unsigned int line, const char *function);``
243+
This signature is the same when origin tracking is disabled - in this case
244+
the dfsan_origin passed in it will always be 0.
245+
246+
The callback will be called when a tained value reach stack/registers
247+
in the context of a function. Tainted values can reach a function:
248+
* via the arguments of the function
249+
* via the return value of a call that occurs in the function
250+
* via the loaded value of a load that occurs in the function
251+
252+
The callback will be skipped for conditional expressions inside signal
253+
handlers, as this is prone to deadlock. Tainted values reaching functions
254+
inside signal handlers will instead be aggregated via bitwise or, and can
255+
be accessed using
256+
``dfsan_label dfsan_get_labels_in_signal_reaches_function()``.
257+
236258
* ``-dfsan-track-origins`` -- Controls how to track origins. When its value is
237259
0, the runtime does not track origins. When its value is 1, the runtime tracks
238260
origins at memory store operations. When its value is 2, the runtime tracks

0 commit comments

Comments
 (0)