Skip to content

Commit

Permalink
doc: Update README.md for user space function tracing
Browse files Browse the repository at this point in the history
uftrace provides mulitiple ways for user space function tracing, but it
might be confusing to users suggesting all the options in README.md.

We better inform a few options including -pg, -finstrument-functions and
-fpatchable-function-entry=N.

Signed-off-by: Honggyu Kim <[email protected]>
  • Loading branch information
honggyukim committed Jul 2, 2023
1 parent 6721fec commit 09a94c9
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ the name uftrace stems from the combination of user and ftrace.

It can record data from:
- User space C/C++/Rust functions (by dynamically patching functions at runtime,
or with code compiled with with `-pg`, `-mfentry`, `-finstrument-functions`,
or using clang with `-fxray-instrument`)
or with code compiled with with `-pg`, `-finstrument-functions` or using
`-fpatchable-function-entry=N` with selective NOP patching at runtime)
- C/C++/Rust Library functions (through PLT hooking)
- Python functions (using Python's trace/profile infrastructure)
- Kernel functions (using the ftrace framework in Linux kernel)
Expand Down

0 comments on commit 09a94c9

Please sign in to comment.