pymembar 0.0.1__cp312-cp312-win_amd64.whl

membar/__init__.py

@@ -0,0 +1,11 @@
+# Import the C extension module and expose its functions
+try:
+    from ._membar import wmb, rmb, fence  # Import from private C extension
+    __all__ = ['wmb', 'rmb', 'fence']
+except ImportError as e:
+    # Fallback error message if the C extension cannot be imported
+    raise ImportError(f"Could not import C extension module: {e}")
+
+# do NOT alter the following line in any way EXCEPT changing
+# the version number. no comments, no rename, whatsoever
+__version__ = "0.0.1"

pymembar-0.0.1.dist-info/METADATA

@@ -0,0 +1,102 @@
+Metadata-Version: 2.4
+Name: pymembar
+Version: 0.0.1
+Summary: Memory barrier utilities for Python - provides wmb, rmb, and fence operations
+Author-email: fwkrumm <fwkrumm@github.com>
+Maintainer-email: fwkrumm <fwkrumm@github.com>
+Project-URL: Homepage, https://github.com/fwkrumm/pymembar
+Project-URL: Repository, https://github.com/fwkrumm/pymembar
+Project-URL: Issues, https://github.com/fwkrumm/pymembar/issues
+Project-URL: Documentation, https://github.com/fwkrumm/pymembar/blob/master/README.md
+Keywords: memory-barriers,concurrency,low-level,synchronization,threading
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: MacOS
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: C
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Hardware
+Classifier: Topic :: System :: Operating System
+Classifier: Typing :: Typed
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Dynamic: license-file
+
+# Python Memory Barrier (pymembar)
+
+Memory barrier utilities for Python - provides low-level memory ordering primitives for concurrent programming. Usually you would not need this in Python due to GIL and generally strong memory ordering on x86/x86_64. However, on weakly-ordered architectures like ARM, memory barriers can be useful for ensuring correct visibility and ordering of memory operations when for example working with shared memory, named semaphores, or lock-free data structures.
+
+I used AI (GitHub Copilot) to help generate parts of this README, documentation strings, and some configuration files. Please report any inaccuracies or errors you may find.
+
+
+## Overview
+
+This package provides Python bindings for memory barrier operations, ensuring that memory operations are visible to other processes and threads in the correct order. Memory barriers do not provide synchronization themselves, but rather control the visibility and ordering of memory operations across CPU cores and processes.
+
+The package includes three core functions:
+
+- `wmb()` - Write memory barrier
+- `rmb()` - Read memory barrier
+- `fence()` - Full memory fence
+
+## Installation
+
+```bash
+pip install pymembar
+```
+
+## Usage
+
+```python
+import membar
+
+# Write memory barrier - ensures all write operations before this point
+# are visible to other processes/threads before any writes after this point
+membar.wmb()
+
+# Read memory barrier - ensures all read operations before this point
+# complete before any read operations after this point
+membar.rmb()
+
+# Full memory fence - ensures all memory operations before this point
+# are visible to other processes/threads before any operations after this point
+membar.fence()
+```
+
+## When Are Memory Barriers Needed?
+
+Memory barriers are primarily needed on weakly-ordered CPU architectures like ARM, where the processor may reorder memory operations for performance optimization. On x86/x86_64 architectures, the strong memory ordering model means that memory barriers are often not strictly necessary for most use cases, as the hardware already provides strong ordering guarantees.
+
+However, memory barriers can still be useful on x86 in specific scenarios:
+- When interfacing with memory-mapped I/O
+- In lock-free programming with specific compiler optimizations
+- When precise ordering is critical for correctness
+
+**Note:** Most Python applications will not need memory barriers due to the Global Interpreter Lock (GIL) and Python's threading model.
+
+## Requirements
+
+- Python 3.8+
+- Compatible with Windows, Linux, and macOS
+
+## Contributing
+
+I am not a C expert and would be happy to receive any constructive feedback, suggestions, or contributions to improve this library. Feel free to open issues or submit pull requests on the [GitHub repository](https://github.com/fwkrumm/pymembar).
+
+## Disclaimer
+
+Parts of the core code, this README, and documentation strings were generated with AI assistance.
+
+
+# TODOs
+- Is it possible to write tests for the functionality
+- Add ARM build to CI/CD pipeline as soon as they are available via GitHub Actions

pymembar-0.0.1.dist-info/RECORD

@@ -0,0 +1,7 @@
+membar/__init__.py,sha256=-Xm1ccC6hwimL_Z4DEGCka_yDAkWIiqedebyYpAmEkU,487
+membar/_membar.cp312-win_amd64.pyd,sha256=mtjNJOc947ZLzH3X5uozgzqXW9ucgymGvMfS2Dkd3KQ,10752
+pymembar-0.0.1.dist-info/licenses/LICENSE.txt,sha256=7EMH6cj__2wGBWdxHt8WcQlboBf5-C-Z84pZ4l0U4ds,1527
+pymembar-0.0.1.dist-info/METADATA,sha256=MLi0LoLgILTughq4LB2q28EpjZ8S0_HedD64x7b3BzA,4674
+pymembar-0.0.1.dist-info/WHEEL,sha256=8UP9x9puWI0P1V_d7K2oMTBqfeLNm21CTzZ_Ptr0NXU,101
+pymembar-0.0.1.dist-info/top_level.txt,sha256=FTuLb28Ianih6q3VxqZmPeRo7ppIhVkSpLcVkbNrxow,7
+pymembar-0.0.1.dist-info/RECORD,,

pymembar-0.0.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: false
+Tag: cp312-cp312-win_amd64
+

pymembar-0.0.1.dist-info/licenses/LICENSE.txt

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2024, Fabian Krumm
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

pymembar-0.0.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+membar