8000 gh-131591: Add remote debugging attachment protocol documentation by ivonastojanovic · Pull Request #132638 · python/cpython · GitHub
[go: up one dir, main page]
Skip to content

gh-131591: Add remote debugging attachment protocol documentation #132638

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.

Sign up for GitHub

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

Merged
merged 4 commits into from
Apr 21, 2025
Merged

gh-131591: Add remote debugging attachment protocol documentation #132638

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
34c64f1
gh-131591: Add remote debugging attachment protocol documentation
Apr 17, 2025
bb9d85d
fixup! gh-131591: Add remote debugging attachment protocol documentation
ivonastojanovic Apr 20, 2025
1730c05
fixup! gh-131591: Add remote debugging attachment protocol documentation
ivonastojanovic Apr 20, 2025
c8a9a61
Add details per arch
pablogsal Apr 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
fixup! gh-131591: Add remote debugging attachment protocol documentation
  • Loading branch information
@ivonastojanovic
ivonastojanovic committed Apr 20, 2025
commit 1730c05519a5810cb4ef6383015e896fc95b3207
18 changes: 10 additions & 8 deletions Doc/howto/remote_debugging.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ detailed explanation of the underlying protocol, which takes as input the
executed. This information supports independent reimplementation of the
protocol, regardless of programming language.


.. warning::

The execution of the injected script depends on the interpreter reaching a
Expand Down Expand Up @@ -149,10 +148,11 @@ To find the ``PyRuntime`` structure on Windows:
<https://learn.microsoft.com/en-us/windows/win32/api/tlhelp32/nf-tlhelp32-module32next>`_.
2. Identify the module corresponding to :file:`python.exe` or
:file:`python{XY}.dll`, where ``X`` and ``Y`` are the major and minor
version numbers of the Python version (for example, ``python311.dll``), and
record its base address.
3. Locate the ``PyRuntim`` section. Section names in the PE format are limited
to 8 characters.
version numbers of the Python version, and record its base address.
3. Locate the ``PyRuntim`` section. Due to the PE format's 8-character limit
on section names (defined as ``IMAGE_SIZEOF_SHORT_NAME``), the original
name ``PyRuntime`` is truncated. This section contains the ``PyRuntime``
structure.
4. Retrieve the section’s relative virtual address (RVA) and add it to the base
address of the module.

Expand All @@ -171,16 +171,18 @@ The following is an example implementation::
pid, name_contains="python3"
)

# Step 3: Parse PE section headers to get PyRuntim RVA
# Step 3: Parse PE section headers to get the RVA of the PyRuntime
# section. The section name appears as "PyRuntim" due to the
# 8-character limit defined by the PE format (IMAGE_SIZEOF_SHORT_NAME).
section_rva = parse_pe_section_offset(binary_path, "PyRuntim")

# Step 4: Compute PyRuntime address in memory
return base_address + section_rva



RReading _Py_DebugOffsets
=========================
Reading _Py_DebugOffsets
========================

Once the address of the ``PyRuntime`` structure has been determined, the next
step is to read the ``_Py_DebugOffsets`` structure located at the beginning of
Expand Down
Loading
0