Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

dynamic: Display enhanced dynamic stats #1751

Open
wants to merge 27 commits into
base: master
Choose a base branch
from

Conversation

clementguidi and others added 27 commits June 30, 2023 11:34
This is in preparation of runtime dynamic patching. This commit
guarantees that dynamic info is read only once for the target binary and
for each module.

Co-authored-by: Gabriel-Andrew Pollo-Guilbert <gabrielpolloguilbert@gmail.com>
Signed-off-by: Clément Guidi <cguidi@ciena.com>
If 'mcount_dynamic_update' is called multiple times (e.g. at runtime),
it initializes the size filter only once.

Signed-off-by: Clément Guidi <cguidi@ciena.com>
Skip the initialization of the disassembly engine with it has already
been performed.

Signed-off-by: Clément Guidi <cguidi@ciena.com>
The dynamic pattern list is not reused from a dynamic update to another,
keeping libmcount stateless in that regard.

Co-authored-by: Gabriel-Andrew Pollo-Guilbert <gabrielpolloguilbert@gmail.com>
Signed-off-by: Clément Guidi <cguidi@ciena.com>
The 'mcount_dynamic_update' is now safe to call multiple times,
including at runtime. On each call, it will perform patching and
unpatching of the target (not implemented yet).

Signed-off-by: Clément Guidi <cguidi@ciena.com>
Install a trampoline for each loaded module map, on initialization. Keep
the trampolines in memory to allow for dynamic patching at runtime.
Clear the trampolines on libmcount exit.

Co-authored-by: Gabriel-Andrew Pollo-Guilbert <gabrielpolloguilbert@gmail.com>
Signed-off-by: Clément Guidi <cguidi@ciena.com>
Trigger architecture specific dynamic initialization when initializing
the dynamic instrumentation mechanics.

Co-authored-by: Gabriel-Andrew Pollo-Guilbert <gabrielpolloguilbert@gmail.com>
Signed-off-by: Clément Guidi <cguidi@ciena.com>
Originally, when the user asks to only unpatch functions, uftrace would
patch all other functions by default. This is counter-intuitive,
especially when using the agent to unpatch at runtime. The user doesn't
expect functions to be patched when they only unpatch funtions.

This commit removes this behavior, and requires the user to explicitly
define functions to patch.

Co-authored-by: Gabriel-Andrew Pollo-Guilbert <gabrielpolloguilbert@gmail.com>
Signed-off-by: Clément Guidi <cguidi@ciena.com>
Libmcount would try to unpatch by default any function that is not
matched by the user patch or unpatch options.

We remove this implicit behavior, so the user explicitly choses which
function to unpatch.

Signed-off-by: Clément Guidi <cguidi@ciena.com>
Return whether a symbol is positively or negatively matched against a
pattern list, or not matched at all.

Co-authored-by: Gabriel-Andrew Pollo-Guilbert <gabrielpolloguilbert@gmail.com>
Signed-off-by: Clément Guidi <cguidi@ciena.com>
Runtime dynamic patching requires cache synchronization. This is best
achieved by using the 'MEMBARRIER_CMD_PRIVATE_EXPEDITED_SYNC_CORE'
memory barrier. However it was introduced in Linux 4.16. We set a flag
indicating whether this membarrier can be used or if libmcount has to
rely on other mechanisms (e.g. signals).

Signed-off-by: Clément Guidi <cguidi@ciena.com>
Glibc < 2.30 doen't provide wrappers for 'gettid()' and 'tgkill()' so we
define them.

Signed-off-by: Clément Guidi <cguidi@ciena.com>
Functions to setup real-time signals and broadcast signals to all
threads in an application. Useful for runtime synchronization
mechanisms.

Co-authored-by: Gabriel-Andrew Pollo-Guilbert <gabrielpolloguilbert@gmail.com>
Signed-off-by: Clément Guidi <cguidi@ciena.com>
Skip the functions where uftrace already injected a call to a
trampoline.

Signed-off-by: Clément Guidi <cguidi@ciena.com>
Refactor for more clarity.

Signed-off-by: Clément Guidi <cguidi@ciena.com>
Refactor 'patch_code' so it can later be used at runtime.

Co-authored-by: Gabriel-Andrew Pollo-Guilbert <gabrielpolloguilbert@gmail.com>
Signed-off-by: Clément Guidi <cguidi@ciena.com>
Check if instruction at a given address is ENDBR64.

Signed-off-by: Clément Guidi <cguidi@ciena.com>
When patching a function at runtime, first insert an int3 trap so any
incoming thread is diverted from the patching region, to avoid executing
partially modified code.

The trap handler emulates a call to the trampoline, thus enabling the
instrumentation.

The trap is eventually removed in subsequent commits.

Co-authored-by: Gabriel-Andrew Pollo-Guilbert <gabrielpolloguilbert@gmail.com>
Signed-off-by: Clément Guidi <cguidi@ciena.com>
When cross-modifying code, the software needs to ensure that all cores
will execute valid instructions at any time.

When modifications are not atomic, we issue a specific memory
barrier (or execute a serializing instruction on Linux < 4.16) to
serialize the execution across all cores. This flushes the different
caches, especially the processor pipelines that may have partially
fetched straddling instructions.

Co-authored-by: Gabriel-Andrew Pollo-Guilbert <gabrielpolloguilbert@gmail.com>
Signed-off-by: Clément Guidi <cguidi@ciena.com>
When patching at runtime, no thread can enter the patching region due to
the trap that is inserted at the start of it.

But threads that entered the region before the trap is installed can
still be executing instructions in the region.

We broadcast a real-time signal instruction all threads to check their
instruction pointer, and execute out-of-line if they are in the patching
region.

Co-authored-by: Gabriel-Andrew Pollo-Guilbert <gabrielpolloguilbert@gmail.com>
Signed-off-by: Clément Guidi <cguidi@ciena.com>
Synchronization requires sending signals to threads inside the process.
This is performed for every symbols, which means a lot of signal can be
sent. This has a major performance impact. This commit batches the
initial and final steps of the patching process so we only need to send
one signal per thread for every batch.

Co-authored-by: Gabriel-Andrew Pollo-Guilbert <gabrielpolloguilbert@gmail.com>
Signed-off-by: Clément Guidi <cguidi@ciena.com>
This commit add for dynamically unpatching functions for the x86_64
architecture. The process is executed concurrently by replacing using a
trap to resolve race conditions between thread (similar to how optimized
kprobes are done).

Co-authored-by: Gabriel-Andrew Pollo-Guilbert <gabrielpolloguilbert@gmail.com>
Signed-off-by: Clément Guidi <cguidi@ciena.com>
Synchronization requires sending signals to threads inside the process.
This is performed for every symbols, which means a lot of signal can be
sent. This has a major performance impact. This commit batches the
initial and final steps of the patching process so we only need to send
one signal per thread for every batch.

Co-authored-by: Gabriel-Andrew Pollo-Guilbert <gabrielpolloguilbert@gmail.com>
Signed-off-by: Clément Guidi <cguidi@ciena.com>
Add support for the '--patch' and '--unpatch' options in the client.
When used, the agent patches or unpatches symbols on the fly.

Co-authored-by: Gabriel-Andrew Pollo-Guilbert <gabrielpolloguilbert@gmail.com>
Signed-off-by: Clément Guidi <cguidi@ciena.com>
Use a global flag to indicate the state of the target. When the target
is not running, tasks such as dynamic patching can be performed with
less constraints.

If libmcount.so is dynamically injected (not implemented yet), the
'mcount_target_running' flag indicates that libmcount has to be
initialized in a running target.

Signed-off-by: Clément Guidi <cguidi@ciena.com>
When patching a binary before its execution, we can skip the
serialization and critical zone exclusion steps. These steps are only
use full when cross-modification occurs, at runtime.

Signed-off-by: Clément Guidi <cguidi@ciena.com>
Print dynamic stats for patching and unpatching.

Signed-off-by: Clément Guidi <cguidi@ciena.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant