◐ Shell
clean mode source ↗

Guard `Packer` buffer protocol hooks with Cython critical sections by Copilot · Pull Request #686 · msgpack/msgpack-python

Copilot

Under free-threaded Python, memoryview(packer) can race with concurrent pack() calls because Packer.__getbuffer__ / Packer.__releasebuffer__ were not using the per-object critical section used by other public Packer methods. This change closes that gap by synchronizing both buffer-protocol hooks.

  • Scope

    • Update only msgpack/_packer.pyx in the Packer buffer-protocol path.

  • Change

    • Add @cython.critical_section directly above:
      • Packer.__getbuffer__(self, Py_buffer *buffer, int flags)
      • Packer.__releasebuffer__(self, Py_buffer *buffer)

  • Consistency impact

    • Aligns buffer acquisition/release with existing Packer method-level synchronization strategy, so exported-buffer bookkeeping (self.exports) is protected under the same lock discipline.
@cython.critical_section
def __getbuffer__(self, Py_buffer *buffer, int flags):
    PyBuffer_FillInfo(buffer, self, self.pk.buf, self.pk.length, 1, flags)
    self.exports += 1

@cython.critical_section
def __releasebuffer__(self, Py_buffer *buffer):
    self.exports -= 1
Original prompt

Create a pull request in repository msgpack/msgpack-python that fixes the free-threading race described in issue #683 by adding @cython.critical_section to Packer.__getbuffer__ and Packer.__releasebuffer__ in _packer.pyx.

Context:

  • The repository is msgpack/msgpack-python.
  • Issue: A (tentative) TODO list? (Generated from Claude Code plugins) #683, titled A (tentative) TODO list? (Generated from Claude Code plugins).
  • The specific requested change is limited to adding @cython.critical_section to the two buffer-protocol methods.
  • The issue text says these methods currently miss the decorator, which can allow concurrent memoryview(packer) and pack() operations to race under free-threaded Python.

Requirements:

  1. Modify the Cython source file that defines Packer.__getbuffer__ and Packer.__releasebuffer__.
  2. Add @cython.critical_section immediately above both methods.
  3. Keep the change minimal and focused only on these two methods unless a tiny adjacent edit is required for correctness.
  4. Regenerate generated artifacts only if this repository expects checked-in generated files to be updated as part of source changes.
  5. Open a pull request with a concise description referencing issue A (tentative) TODO list? (Generated from Claude Code plugins) #683 and explaining that this protects buffer protocol access with the same per-object critical section used by other public methods.

Suggested validation:

  • Run the relevant tests if feasible, especially any packing/free-threading related tests.
  • If there is an established command to regenerate Cython output, use it if needed by repo conventions.

The following is the prior conversation context from the user's chat exploration (may be truncated):

User: Packer.__getbuffer__ と __releasebuffer__ に @cython.critical_section を追加するPRを作って。

Assistant: PR作成の確認待ちです。GitHub 側の承認が完了したら、その変更で続けて進めます。

This pull request was created from Copilot chat.