├── .cruft.json ├── .github └── workflows │ ├── build_wheels.yml │ ├── flake.yml │ └── main.yml ├── .gitignore ├── AUTHORS ├── CODE_OF_CONDUCT.md ├── CONTRIBUTING.md ├── LICENSE ├── MANIFEST.in ├── README.md ├── cydoctest.py ├── memory_allocator ├── __init__.pxd ├── __init__.py ├── memory.pxd ├── memory_allocator.pxd ├── memory_allocator.pyx ├── signals.pxd └── test.pyx ├── pyproject.toml ├── setup.py └── test.py /.cruft.json: -------------------------------------------------------------------------------- 1 | { 2 | "template": "https://github.com/mkoeppe/sage", 3 | "commit": "b73d4e2fad3b71c74b62740aa83f37e98faa3f15", 4 | "checkout": "sagemath-environment-cookiecutter", 5 | "context": { 6 | "cookiecutter": { 7 | "project_name": "memory_allocator", 8 | "_template": "https://github.com/mkoeppe/sage" 9 | } 10 | }, 11 | "directory": "pkgs/sage-project-cookiecutter/sage_project_cookiecutter/sagemath-upstream-package-template" 12 | } 13 | -------------------------------------------------------------------------------- /.github/workflows/build_wheels.yml: -------------------------------------------------------------------------------- 1 | name: Build wheels and sdist 2 | 3 | on: 4 | pull_request: 5 | types: [opened, synchronize] 6 | push: 7 | tags: 8 | - '*' 9 | workflow_dispatch: 10 | 11 | jobs: 12 | 13 | sdists_for_pypi: 14 | name: Build sdist (and upload to PyPI on release tags) 15 | runs-on: ubuntu-latest 16 | env: 17 | CAN_DEPLOY: ${{ secrets.SAGEMATH_PYPI_API_TOKEN != '' }} 18 | steps: 19 | - uses: actions/checkout@v4 20 | - uses: actions/setup-python@v4 21 | - name: make sdist 22 | run: | 23 | pipx run build -s 24 | - uses: actions/upload-artifact@v3 25 | with: 26 | path: "dist/*.tar.gz" 27 | name: dist 28 | - uses: pypa/gh-action-pypi-publish@release/v1 29 | with: 30 | user: __token__ 31 | password: ${{ secrets.SAGEMATH_PYPI_API_TOKEN }} 32 | skip_existing: true 33 | verbose: true 34 | if: env.CAN_DEPLOY == 'true' && github.event_name == 'push' && startsWith(github.ref, 'refs/tags') 35 | 36 | build_wheels: 37 | name: Build wheels on ${{ matrix.os }} 38 | runs-on: ${{ matrix.os }} 39 | strategy: 40 | matrix: 41 | os: [ubuntu-latest, macOS-latest, macOS-14] 42 | 43 | steps: 44 | - uses: actions/checkout@v4 45 | 46 | # Used to host cibuildwheel 47 | - uses: actions/setup-python@v4 48 | 49 | - name: Build wheels 50 | uses: pypa/cibuildwheel@v2.17.0 51 | 52 | - uses: actions/upload-artifact@v3 53 | with: 54 | name: wheels 55 | path: ./wheelhouse/*.whl 56 | 57 | pypi-publish: 58 | # https://github.com/pypa/gh-action-pypi-publish 59 | name: Upload wheels to PyPI 60 | needs: build_wheels 61 | if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags') 62 | runs-on: ubuntu-latest 63 | env: 64 | CAN_DEPLOY: ${{ secrets.SAGEMATH_PYPI_API_TOKEN != '' }} 65 | steps: 66 | 67 | - uses: actions/download-artifact@v3 68 | with: 69 | name: wheels 70 | path: wheelhouse 71 | 72 | - name: Publish package distributions to PyPI 73 | uses: pypa/gh-action-pypi-publish@release/v1 74 | with: 75 | user: __token__ 76 | password: ${{ secrets.SAGEMATH_PYPI_API_TOKEN }} 77 | packages_dir: wheelhouse/ 78 | skip_existing: true 79 | verbose: true 80 | if: env.CAN_DEPLOY == 'true' 81 | -------------------------------------------------------------------------------- /.github/workflows/flake.yml: -------------------------------------------------------------------------------- 1 | name: memory_allocator-flake8 2 | 3 | on: 4 | pull_request: 5 | types: [opened, synchronize] 6 | push: 7 | tags: 8 | - '*' 9 | 10 | jobs: 11 | build: 12 | runs-on: [ubuntu-latest] 13 | steps: 14 | - name: Set up the repository 15 | uses: actions/checkout@v2 16 | with: 17 | submodules: recursive 18 | fetch-depth: 0 19 | - name: Set up Python 20 | uses: actions/setup-python@v2 21 | with: 22 | python-version: 3.8 23 | - name: Install dependencies 24 | run: | 25 | python -m pip install --upgrade pip 26 | pip install setuptools Cython Sphinx flake8 27 | - name: Lint with flake8 28 | run: | 29 | # stop the build if there are Python syntax errors or undefined names 30 | flake8 . --exclude cysignals --count --select=E9,F63,F7,F82 --show-source --statistics 31 | # The GitHub editor is 127 chars wide 32 | flake8 . --exclude cysignals --count --max-complexity=10 --max-line-length=127 --statistics 33 | -------------------------------------------------------------------------------- /.github/workflows/main.yml: -------------------------------------------------------------------------------- 1 | # Much taken from https://github.com/Ezibenroc/PyRoaringBitMap/blob/master/.github/workflows/main.yml 2 | name: test memory_allocator 3 | 4 | on: 5 | pull_request: 6 | types: [opened, synchronize] 7 | push: 8 | tags: 9 | - '*' 10 | branches: 11 | - main 12 | 13 | jobs: 14 | build: 15 | runs-on: ${{ matrix.os }} 16 | strategy: 17 | fail-fast: false 18 | matrix: 19 | os: [ubuntu-latest, macos-latest, windows-latest] 20 | python-version: ['3.8', '3.9', '3.10', '3.11', '3.12', '3.13-dev'] 21 | architecture: [x64, x86] 22 | exclude: 23 | - os: ubuntu-latest 24 | architecture: x86 25 | - os: macos-latest 26 | architecture: x86 27 | steps: 28 | - name: Set up the repository 29 | uses: actions/checkout@v4 30 | with: 31 | submodules: recursive 32 | fetch-depth: 0 33 | - name: Set up Python ${{ matrix.python-version }} 34 | uses: actions/setup-python@v5 35 | with: 36 | python-version: ${{ matrix.python-version }} 37 | architecture: ${{ matrix.architecture }} 38 | - name: Install dependencies 39 | run: | 40 | python -m pip install --upgrade pip 41 | pip install setuptools Cython Sphinx flake8 42 | - name: Freeze pip 43 | run: | 44 | pip freeze 45 | - name: Local build 46 | run: | 47 | python setup.py build_ext -i 48 | python test.py || exit 1 49 | git clean -xfd 50 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | *.c 9 | 10 | # Distribution / packaging 11 | .Python 12 | build/ 13 | develop-eggs/ 14 | dist/ 15 | downloads/ 16 | eggs/ 17 | .eggs/ 18 | lib/ 19 | lib64/ 20 | parts/ 21 | sdist/ 22 | var/ 23 | wheels/ 24 | pip-wheel-metadata/ 25 | share/python-wheels/ 26 | *.egg-info/ 27 | .installed.cfg 28 | *.egg 29 | MANIFEST 30 | 31 | # PyInstaller 32 | # Usually these files are written by a python script from a template 33 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 34 | *.manifest 35 | *.spec 36 | 37 | # Installer logs 38 | pip-log.txt 39 | pip-delete-this-directory.txt 40 | 41 | # Unit test / coverage reports 42 | htmlcov/ 43 | .tox/ 44 | .nox/ 45 | .coverage 46 | .coverage.* 47 | .cache 48 | nosetests.xml 49 | coverage.xml 50 | *.cover 51 | *.py,cover 52 | .hypothesis/ 53 | .pytest_cache/ 54 | 55 | # Translations 56 | *.mo 57 | *.pot 58 | 59 | # Django stuff: 60 | *.log 61 | local_settings.py 62 | db.sqlite3 63 | db.sqlite3-journal 64 | 65 | # Flask stuff: 66 | instance/ 67 | .webassets-cache 68 | 69 | # Scrapy stuff: 70 | .scrapy 71 | 72 | # Sphinx documentation 73 | docs/_build/ 74 | 75 | # PyBuilder 76 | target/ 77 | 78 | # Jupyter Notebook 79 | .ipynb_checkpoints 80 | 81 | # IPython 82 | profile_default/ 83 | ipython_config.py 84 | 85 | # pyenv 86 | .python-version 87 | 88 | # pipenv 89 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 90 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 91 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 92 | # install all needed dependencies. 93 | #Pipfile.lock 94 | 95 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow 96 | __pypackages__/ 97 | 98 | # Celery stuff 99 | celerybeat-schedule 100 | celerybeat.pid 101 | 102 | # SageMath parsed files 103 | *.sage.py 104 | 105 | # Environments 106 | .env 107 | .venv 108 | env/ 109 | venv/ 110 | ENV/ 111 | env.bak/ 112 | venv.bak/ 113 | 114 | # Spyder project settings 115 | .spyderproject 116 | .spyproject 117 | 118 | # Rope project settings 119 | .ropeproject 120 | 121 | # mkdocs documentation 122 | /site 123 | 124 | # mypy 125 | .mypy_cache/ 126 | .dmypy.json 127 | dmypy.json 128 | 129 | # Pyre type checker 130 | .pyre/ 131 | -------------------------------------------------------------------------------- /AUTHORS: -------------------------------------------------------------------------------- 1 | Jeroen Demeyer (main author) 2 | Nathann Cohen 3 | Jonathan Kliem (setting up the pip installable package) 4 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | This is an open-source project maintained by the SageMath community. 2 | 3 | The [Code of Conduct](https://github.com/sagemath/sage/blob/develop/CODE_OF_CONDUCT.md) 4 | of the Sage community applies. 5 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | This is an open-source project maintained by the SageMath community. 2 | 3 | Contributions of all sorts are heartily welcomed. 4 | 5 | See https://github.com/sagemath/sage/blob/develop/CONTRIBUTING.md for general 6 | guidance on how to contribute. 7 | 8 | Open issues or submit pull requests at https://github.com/sagemath/memory_allocator 9 | and join https://groups.google.com/group/sage-devel to discuss. 10 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /MANIFEST.in: -------------------------------------------------------------------------------- 1 | include AUTHORS 2 | include setup.py cydoctest.py test.py pyproject.toml 3 | graft memory_allocator 4 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # MemoryAllocator 2 | An extension class to allocate memory easily with cython. 3 | 4 | This extension class started as part of the [Sage](https://sagemath.org) software. 5 | 6 | It provides a single extension class `MemoryAllocator` with `cdef` methods 7 | 8 | - `malloc`, 9 | - `calloc`, 10 | - `allocarray`, 11 | - `realloc`, 12 | - `reallocarray`, 13 | - `aligned_malloc`, 14 | - `aligned_calloc`, 15 | - `aligned_allocarray`. 16 | 17 | Memory is freed when the instance of `MemoryAllocator` is deallocated. 18 | On failure to allocate the memory, a proper error is raised. 19 | 20 | # Changelog 21 | 22 | ## 0.1.4 23 | 24 | - Modernize Python metadata, require Python >= 3.8. 25 | [#9](https://github.com/sagemath/memory_allocator/pull/9) by @mkoeppe 26 | - Add missing `noexcept` clauses for Cython 3 27 | [#8](https://github.com/sagemath/memory_allocator/pull/8) by @tornaria 28 | 29 | ## 0.1.3 30 | 31 | - Python 3.11 compatible. 32 | 33 | ## 0.1.2 34 | 35 | - Provide wheels build by github actions. 36 | 37 | ## 0.1.1 38 | 39 | - Fixed doctests on 32bit systems. 40 | -------------------------------------------------------------------------------- /cydoctest.py: -------------------------------------------------------------------------------- 1 | #!python 2 | """ 3 | Taken from 4 | https://github.com/cython/cython/wiki/FAQ#how-can-i-run-doctests-in-cython-code-pyx-files 5 | 6 | Cython-compatible wrapper for doctest.testmod(). 7 | 8 | Usage example, assuming a Cython module mymod.pyx is compiled. 9 | This is run from the command line, passing a command to Python: 10 | python -c "import cydoctest, mymod; cydoctest.testmod(mymod)" 11 | 12 | (This still won't let a Cython module run its own doctests 13 | when called with "python mymod.py", but it's pretty close. 14 | Further options can be passed to testmod() as desired, e.g. 15 | verbose=True.) 16 | """ 17 | 18 | import sys 19 | import doctest 20 | import inspect 21 | 22 | 23 | def _from_module(module, object): 24 | """ 25 | Return true if the given object is defined in the given module. 26 | """ 27 | if module is None: 28 | return True 29 | elif inspect.getmodule(object) is not None: 30 | return module is inspect.getmodule(object) 31 | elif inspect.isfunction(object): 32 | return module.__dict__ is object.func_globals 33 | elif inspect.isclass(object): 34 | return module.__name__ == object.__module__ 35 | elif hasattr(object, '__module__'): 36 | return module.__name__ == object.__module__ 37 | elif isinstance(object, property): 38 | return True # [XX] no way not be sure. 39 | else: 40 | raise ValueError("object must be a class or function") 41 | 42 | 43 | def fix_module_doctest(module): 44 | """ 45 | Extract docstrings from cython functions, that would be skipped by doctest 46 | otherwise. 47 | """ 48 | module.__test__ = {} 49 | for name in dir(module): 50 | value = getattr(module, name) 51 | if (inspect.isbuiltin(value) 52 | and isinstance(value.__doc__, str) 53 | and _from_module(module, value)): 54 | module.__test__[name] = value.__doc__ 55 | 56 | 57 | def testmod(m=None, *args, **kwargs): 58 | """ 59 | Fix a Cython module's doctests, then call doctest.testmod() 60 | All other arguments are passed directly to doctest.testmod(). 61 | """ 62 | fix_module_doctest(m) 63 | result = doctest.testmod(m, optionflags=doctest.ELLIPSIS, *args, **kwargs) 64 | if result.failed > 0: 65 | sys.exit('%d test(s) failed' % result.failed) 66 | -------------------------------------------------------------------------------- /memory_allocator/__init__.pxd: -------------------------------------------------------------------------------- 1 | from memory_allocator.memory_allocator cimport MemoryAllocator 2 | -------------------------------------------------------------------------------- /memory_allocator/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sagemath/memory_allocator/edb57395bbd032c13905acec61f2345d45ea3d43/memory_allocator/__init__.py -------------------------------------------------------------------------------- /memory_allocator/memory.pxd: -------------------------------------------------------------------------------- 1 | # Copied from 2 | # https://github.com/sagemath/cysignals/blob/master/src/cysignals/memory.pxd 3 | 4 | # Note that this is no longer interruption safe, 5 | # as we efficiently remove ``sig_block``/``sig_unblock``. 6 | """ 7 | Memory allocation functions which are interrupt-safe 8 | 9 | The ``sig_`` variants are simple wrappers around the corresponding C 10 | functions. The ``check_`` variants check the return value and raise 11 | ``MemoryError`` in case of failure. 12 | """ 13 | 14 | # **************************************************************************** 15 | # Copyright (C) 2011-2016 Jeroen Demeyer 16 | # 17 | # cysignals is free software: you can redistribute it and/or modify it 18 | # under the terms of the GNU Lesser General Public License as published 19 | # by the Free Software Foundation, either version 3 of the License, or 20 | # (at your option) any later version. 21 | # 22 | # cysignals is distributed in the hope that it will be useful, 23 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 24 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 25 | # GNU Lesser General Public License for more details. 26 | # 27 | # You should have received a copy of the GNU Lesser General Public License 28 | # along with cysignals. If not, see . 29 | # 30 | # **************************************************************************** 31 | 32 | 33 | cimport cython 34 | from libc.stdlib cimport malloc, calloc, realloc, free 35 | from .signals cimport sig_block, sig_unblock 36 | 37 | cdef extern from *: 38 | int unlikely(int) nogil # Defined by Cython 39 | 40 | 41 | cdef inline void* sig_malloc "sig_malloc"(size_t n) noexcept nogil: 42 | sig_block() 43 | cdef void* ret = malloc(n) 44 | sig_unblock() 45 | return ret 46 | 47 | 48 | cdef inline void* sig_realloc "sig_realloc"(void* ptr, size_t size) noexcept nogil: 49 | sig_block() 50 | cdef void* ret = realloc(ptr, size) 51 | sig_unblock() 52 | return ret 53 | 54 | 55 | cdef inline void* sig_calloc "sig_calloc"(size_t nmemb, size_t size) noexcept nogil: 56 | sig_block() 57 | cdef void* ret = calloc(nmemb, size) 58 | sig_unblock() 59 | return ret 60 | 61 | 62 | cdef inline void sig_free "sig_free"(void* ptr) noexcept nogil: 63 | sig_block() 64 | free(ptr) 65 | sig_unblock() 66 | 67 | 68 | @cython.cdivision(True) 69 | cdef inline size_t mul_overflowcheck(size_t a, size_t b) noexcept nogil: 70 | """ 71 | Return a*b, checking for overflow. Assume that a > 0. 72 | If overflow occurs, return (-1). 73 | We assume that malloc(-1) always fails. 74 | """ 75 | # If a and b both less than MUL_NO_OVERFLOW, no overflow can occur 76 | cdef size_t MUL_NO_OVERFLOW = ((1) << (4*sizeof(size_t))) 77 | if a >= MUL_NO_OVERFLOW or b >= MUL_NO_OVERFLOW: 78 | if unlikely(b > (-1) // a): 79 | return (-1) 80 | return a*b 81 | 82 | 83 | cdef inline void* check_allocarray(size_t nmemb, size_t size) except? NULL: 84 | """ 85 | Allocate memory for ``nmemb`` elements of size ``size``. 86 | """ 87 | if nmemb == 0: 88 | return NULL 89 | cdef size_t n = mul_overflowcheck(nmemb, size) 90 | cdef void* ret = sig_malloc(n) 91 | if unlikely(ret == NULL): 92 | raise MemoryError("failed to allocate %s * %s bytes" % (nmemb, size)) 93 | return ret 94 | 95 | 96 | cdef inline void* check_reallocarray(void* ptr, size_t nmemb, size_t size) except? NULL: 97 | """ 98 | Re-allocate memory at ``ptr`` to hold ``nmemb`` elements of size 99 | ``size``. If ``ptr`` equals ``NULL``, this behaves as 100 | ``check_allocarray``. 101 | 102 | When ``nmemb`` equals 0, then free the memory at ``ptr``. 103 | """ 104 | if nmemb == 0: 105 | sig_free(ptr) 106 | return NULL 107 | cdef size_t n = mul_overflowcheck(nmemb, size) 108 | cdef void* ret = sig_realloc(ptr, n) 109 | if unlikely(ret == NULL): 110 | raise MemoryError("failed to allocate %s * %s bytes" % (nmemb, size)) 111 | return ret 112 | 113 | 114 | cdef inline void* check_malloc(size_t n) except? NULL: 115 | """ 116 | Allocate ``n`` bytes of memory. 117 | """ 118 | if n == 0: 119 | return NULL 120 | cdef void* ret = sig_malloc(n) 121 | if unlikely(ret == NULL): 122 | raise MemoryError("failed to allocate %s bytes" % n) 123 | return ret 124 | 125 | 126 | cdef inline void* check_realloc(void* ptr, size_t n) except? NULL: 127 | """ 128 | Re-allocate memory at ``ptr`` to hold ``n`` bytes. 129 | If ``ptr`` equals ``NULL``, this behaves as ``check_malloc``. 130 | """ 131 | if n == 0: 132 | sig_free(ptr) 133 | return NULL 134 | cdef void* ret = sig_realloc(ptr, n) 135 | if unlikely(ret == NULL): 136 | raise MemoryError("failed to allocate %s bytes" % n) 137 | return ret 138 | 139 | 140 | cdef inline void* check_calloc(size_t nmemb, size_t size) except? NULL: 141 | """ 142 | Allocate memory for ``nmemb`` elements of size ``size``. The 143 | resulting memory is zeroed. 144 | """ 145 | if nmemb == 0: 146 | return NULL 147 | cdef void* ret = sig_calloc(nmemb, size) 148 | if unlikely(ret == NULL): 149 | raise MemoryError("failed to allocate %s * %s bytes" % (nmemb, size)) 150 | return ret 151 | -------------------------------------------------------------------------------- /memory_allocator/memory_allocator.pxd: -------------------------------------------------------------------------------- 1 | cimport cython 2 | from libc.stdint cimport uintptr_t 3 | 4 | 5 | cdef extern from *: 6 | int unlikely(int) nogil # defined by Cython 7 | 8 | 9 | cdef inline void* align(void* ptr, size_t alignment) noexcept: 10 | """ 11 | Round up ``ptr`` to the nearest multiple of ``alignment``, which 12 | must be a power of 2 13 | """ 14 | cdef uintptr_t x = ptr 15 | x = (x + alignment - 1) & ~(alignment - 1) 16 | return x 17 | 18 | 19 | @cython.final 20 | cdef class MemoryAllocator: 21 | cdef size_t n 22 | cdef size_t size 23 | cdef void** pointers 24 | cdef void* static_pointers[16] # If n <= 16, store pointers here 25 | 26 | cdef void* malloc(self, size_t size) except? NULL 27 | cdef void* calloc(self, size_t nmemb, size_t size) except? NULL 28 | cdef void* allocarray(self, size_t nmemb, size_t size) except? NULL 29 | cdef void* realloc(self, void* ptr, size_t size) except? NULL 30 | cdef void* reallocarray(self, void* ptr, size_t nmemb, 31 | size_t size) except? NULL 32 | 33 | cdef int resize(self, size_t new_size) except -1 34 | cdef void** find_pointer(self, void* ptr) except NULL 35 | 36 | cdef inline int enlarge_if_needed(self) except -1: 37 | r""" 38 | Enlarge the list of pointers if needed such that there is at 39 | least one free entry. 40 | """ 41 | if unlikely(self.n >= self.size): 42 | return self.resize(self.size * 2) 43 | 44 | cdef inline void* aligned_malloc(self, size_t alignment, 45 | size_t size) except? NULL: 46 | r""" 47 | Returns new aligned pointer. Stores it to be automatically freed later. 48 | 49 | Alignment must be a power of two. 50 | 51 | .. NOTE:: 52 | 53 | If you want to allocate multiple (small) aligned arrays with the 54 | same alignment and really want to be memory efficient, you can 55 | allocate one large aligned array instead. 56 | """ 57 | cdef size_t extra = alignment - 1 58 | return align(self.malloc(size + extra), alignment) 59 | 60 | cdef inline void* aligned_calloc(self, size_t alignment, size_t nmemb, 61 | size_t size) except? NULL: 62 | r""" 63 | Returns new aligned pointer. Stores it to be automatically freed later. 64 | 65 | Alignment must be a power of two. 66 | 67 | .. NOTE:: 68 | 69 | If you want to allocate multiple (small) aligned arrays with the 70 | same alignment and really want to be memory efficient, you can 71 | allocate one large aligned array instead. 72 | """ 73 | # Find extra such that (nmemb + extra) * size >= nmemb * size + alignment - 1 74 | # ⇔ extra * size >= alignment - 1 75 | # ⇔ extra >= ceil( (alignment - 1) / size) 76 | # ⇔ extra >= (alignment - 1 + size - 1) // size 77 | cdef size_t extra = (alignment + size - 2) // size 78 | return align(self.calloc(nmemb + extra, size), alignment) 79 | 80 | cdef inline void* aligned_allocarray(self, size_t alignment, size_t nmemb, 81 | size_t size) except? NULL: 82 | r""" 83 | Returns new aligned pointer. Stores it to be automatically freed later. 84 | 85 | Alignment must be a power of two. 86 | 87 | .. NOTE:: 88 | 89 | If you want to allocate multiple (small) aligned arrays with the 90 | same alignment and really want to be memory efficient, you can 91 | allocate one large aligned array instead. 92 | """ 93 | # Find extra such that (nmemb + extra) * size >= nmemb * size + alignment - 1 94 | # ⇔ extra * size >= alignment - 1 95 | # ⇔ extra >= ceil( (alignment - 1) / size) 96 | # ⇔ extra >= (alignment - 1 + size - 1) // size 97 | cdef size_t extra = (alignment + size - 2) // size 98 | return align(self.allocarray(nmemb + extra, size), alignment) 99 | -------------------------------------------------------------------------------- /memory_allocator/memory_allocator.pyx: -------------------------------------------------------------------------------- 1 | from .memory cimport * 2 | 3 | 4 | cdef class MemoryAllocator: 5 | r""" 6 | An object for memory allocation, whose resources are freed upon 7 | ``__dealloc__``. 8 | 9 | EXAMPLES:: 10 | 11 | >>> from memory_allocator.test import TestMemoryAllocator 12 | >>> mem = TestMemoryAllocator() 13 | >>> for n in range(100): 14 | ... ptr = mem.malloc(n) 15 | ... _ = mem.realloc(ptr, 2*n) 16 | ... _ = mem.calloc(n, n) 17 | ... ptr = mem.allocarray(n, n) 18 | ... _ = mem.reallocarray(ptr, n + 1, n) 19 | ... _ = mem.aligned_malloc(32, (n//32 + 1)*32) 20 | ... _ = mem.aligned_calloc(16, n, 16) 21 | ... _ = mem.aligned_allocarray(8, n, 8) 22 | """ 23 | def __cinit__(self): 24 | """ 25 | EXAMPLES:: 26 | 27 | >>> from memory_allocator.test import TestMemoryAllocator 28 | >>> _ = TestMemoryAllocator() 29 | >>> _ = malloc(10000) 30 | >>> mem.n() 31 | 1 32 | >>> mem.size() 33 | 16 34 | """ 35 | self.n = 0 36 | self.size = 16 37 | self.pointers = self.static_pointers 38 | 39 | cdef int resize(self, size_t new_size) except -1: 40 | r""" 41 | Resize the list of pointers to contain ``new_size`` elements. 42 | 43 | It is required that ``new_size`` is at least ``self.n``, but 44 | this condition is not checked. 45 | """ 46 | cdef size_t i 47 | if self.pointers == self.static_pointers: 48 | # Case 1: allocate pointers for the first time 49 | self.pointers = check_allocarray(new_size, sizeof(void*)) 50 | for i in range(self.n): 51 | self.pointers[i] = self.static_pointers[i] 52 | else: 53 | # Case 2: resize pointers 54 | self.pointers = check_reallocarray(self.pointers, 55 | new_size, sizeof(void*)) 56 | self.size = new_size 57 | 58 | cdef void** find_pointer(self, void* ptr) except NULL: 59 | r""" 60 | Return the address in the list of stored pointers where ``ptr`` 61 | is stored. If ``ptr`` is not found in the existing pointers and 62 | ``ptr`` is not ``NULL``, then an exception is raised. If ``ptr`` 63 | is ``NULL``, then we simply add ``NULL`` as an additional 64 | pointer and return the address of that. 65 | """ 66 | cdef size_t i = 0 67 | for i in range(self.n): 68 | if self.pointers[i] == ptr: 69 | return &self.pointers[i] 70 | if ptr != NULL: 71 | raise ValueError("given pointer not found in MemoryAllocator") 72 | self.enlarge_if_needed() 73 | addr = &self.pointers[self.n] 74 | self.n += 1 75 | return addr 76 | 77 | cdef void* malloc(self, size_t size) except? NULL: 78 | r""" 79 | Returns a new pointer and stores it to be automatically freed later. 80 | """ 81 | self.enlarge_if_needed() 82 | cdef void* val = check_malloc(size) 83 | self.pointers[self.n] = val 84 | self.n += 1 85 | return val 86 | 87 | cdef void* calloc(self, size_t nmemb, size_t size) except? NULL: 88 | r""" 89 | Returns a new pointer and stores it to be automatically freed later. 90 | """ 91 | self.enlarge_if_needed() 92 | cdef void* val = check_calloc(nmemb, size) 93 | self.pointers[self.n] = val 94 | self.n += 1 95 | return val 96 | 97 | cdef void* allocarray(self, size_t nmemb, size_t size) except? NULL: 98 | r""" 99 | Returns a new pointer and stores it to be automatically freed later. 100 | """ 101 | self.enlarge_if_needed() 102 | cdef void* val = check_allocarray(nmemb, size) 103 | self.pointers[self.n] = val 104 | self.n += 1 105 | return val 106 | 107 | cdef void* realloc(self, void* ptr, size_t size) except? NULL: 108 | r""" 109 | Re-allocates `ptr` and automatically frees it later. 110 | """ 111 | cdef void** addr = self.find_pointer(ptr) 112 | cdef void* val = check_realloc(ptr, size) 113 | addr[0] = val 114 | return val 115 | 116 | cdef void* reallocarray(self, void* ptr, size_t nmemb, 117 | size_t size) except? NULL: 118 | r""" 119 | Re-allocates `ptr` and automatically frees it later. 120 | """ 121 | cdef void** addr = self.find_pointer(ptr) 122 | cdef void* val = check_reallocarray(ptr, nmemb, size) 123 | addr[0] = val 124 | return val 125 | 126 | def __dealloc__(self): 127 | r""" 128 | Free the allocated resources 129 | 130 | EXAMPLES:: 131 | 132 | >>> from memory_allocator.test import TestMemoryAllocator 133 | >>> _ = TestMemoryAllocator() 134 | """ 135 | cdef size_t i 136 | for i in range(self.n): 137 | sig_free(self.pointers[i]) 138 | if self.pointers != self.static_pointers: 139 | sig_free(self.pointers) 140 | -------------------------------------------------------------------------------- /memory_allocator/signals.pxd: -------------------------------------------------------------------------------- 1 | # ``memory.pxd`` is a strict copy of the version in ``cysignals``. 2 | 3 | # Usage of ``sig_block`` / ``sig_unblock`` is not necessary 4 | # for ``MemoryAllocator``: 5 | # One should not wrap its methods with ``sig_on`` ... ``sig_off`` anyway. 6 | 7 | cdef inline void sig_block() noexcept nogil: 8 | pass 9 | 10 | cdef inline void sig_unblock() noexcept nogil: 11 | pass 12 | -------------------------------------------------------------------------------- /memory_allocator/test.pyx: -------------------------------------------------------------------------------- 1 | from .memory_allocator cimport MemoryAllocator 2 | 3 | 4 | cdef class TestMemoryAllocator(): 5 | cdef MemoryAllocator mem 6 | 7 | def __init__(self): 8 | self.mem = MemoryAllocator() 9 | 10 | def malloc(self, size): 11 | """ 12 | TESTS:: 13 | 14 | >>> from memory_allocator.test import TestMemoryAllocator 15 | >>> mem = TestMemoryAllocator() 16 | >>> _ = mem.malloc(100) 17 | >>> mem.malloc(mem.size_t_max()) 18 | Traceback (most recent call last): 19 | ... 20 | MemoryError: failed to allocate ... bytes 21 | """ 22 | return self.mem.malloc(size) 23 | 24 | def calloc(self, nmemb, size): 25 | """ 26 | TESTS:: 27 | 28 | >>> from memory_allocator.test import TestMemoryAllocator 29 | >>> mem = TestMemoryAllocator() 30 | >>> _ = mem.calloc(100, 10) 31 | >>> mem.calloc(mem.size_t_max(), 1) 32 | Traceback (most recent call last): 33 | ... 34 | MemoryError: failed to allocate ... * 1 bytes 35 | """ 36 | return self.mem.calloc(nmemb, size) 37 | 38 | def allocarray(self, nmemb, size): 39 | """ 40 | TESTS:: 41 | 42 | >>> from memory_allocator.test import TestMemoryAllocator 43 | >>> mem = TestMemoryAllocator() 44 | >>> _ = mem.allocarray(100, 10) 45 | >>> mem.allocarray(mem.size_t_max(), 1) 46 | Traceback (most recent call last): 47 | ... 48 | MemoryError: failed to allocate ... * 1 bytes 49 | """ 50 | return self.mem.allocarray(nmemb, size) 51 | 52 | def realloc(self, size_t ptr, size): 53 | """ 54 | TESTS:: 55 | 56 | >>> from memory_allocator.test import TestMemoryAllocator 57 | >>> def test_realloc_good(): 58 | ... mem = TestMemoryAllocator() 59 | ... ptr = mem.malloc(20) 60 | ... mem.realloc(ptr, 21) 61 | >>> def test_realloc_NULL(): 62 | ... mem = TestMemoryAllocator() 63 | ... mem.realloc(0, 21) 64 | >>> def test_realloc_bad(): 65 | ... mem = TestMemoryAllocator() 66 | ... mem2 = TestMemoryAllocator() 67 | ... ptr = mem.malloc(20) 68 | ... mem2.realloc(ptr, 21) 69 | >>> test_realloc_good() 70 | >>> test_realloc_NULL() 71 | >>> test_realloc_bad() 72 | Traceback (most recent call last): 73 | ... 74 | ValueError: given pointer not found in MemoryAllocator 75 | """ 76 | return self.mem.realloc( ptr, size) 77 | 78 | def reallocarray(self, size_t ptr, nmemb, size): 79 | """ 80 | TESTS:: 81 | 82 | >>> from memory_allocator.test import TestMemoryAllocator 83 | >>> def test_reallocarray_good(): 84 | ... mem = TestMemoryAllocator() 85 | ... ptr = mem.allocarray(20, 8) 86 | ... mem.reallocarray(ptr, 21, 8) 87 | >>> def test_reallocarray_NULL(): 88 | ... mem = TestMemoryAllocator() 89 | ... mem.reallocarray(0, 21, 8) 90 | >>> def test_reallocarray_bad(): 91 | ... mem = TestMemoryAllocator() 92 | ... mem2 = TestMemoryAllocator() 93 | ... ptr = mem.allocarray(20, 8) 94 | ... mem2.reallocarray(ptr, 21, 8) 95 | >>> test_reallocarray_good() 96 | >>> test_reallocarray_NULL() 97 | >>> test_reallocarray_bad() 98 | Traceback (most recent call last): 99 | ... 100 | ValueError: given pointer not found in MemoryAllocator 101 | """ 102 | return self.mem.reallocarray( ptr, nmemb, size) 103 | 104 | def aligned_malloc(self, alignment, size): 105 | """ 106 | TESTS:: 107 | 108 | >>> from memory_allocator.test import TestMemoryAllocator 109 | >>> mem = TestMemoryAllocator() 110 | >>> for i in range(12): 111 | ... ptr = mem.aligned_malloc(2**i, 4048) 112 | ... assert ptr == ptr & ~(2**i-1) 113 | """ 114 | return self.mem.aligned_malloc(alignment, size) 115 | 116 | def aligned_calloc(self, alignment, nmemb, size): 117 | """ 118 | TESTS:: 119 | 120 | >>> from memory_allocator.test import TestMemoryAllocator 121 | >>> mem = TestMemoryAllocator() 122 | >>> for i in range(12): 123 | ... ptr = mem.aligned_calloc(2**i, i, 4048) 124 | ... assert ptr == ptr & ~(2**i-1) 125 | """ 126 | return self.mem.aligned_calloc(alignment, nmemb, size) 127 | 128 | def aligned_allocarray(self, alignment, nmemb, size): 129 | """ 130 | TESTS:: 131 | 132 | >>> from memory_allocator.test import TestMemoryAllocator 133 | >>> mem = TestMemoryAllocator() 134 | >>> for i in range(12): 135 | ... ptr = mem.aligned_allocarray(2**i, i, 4048) 136 | ... assert ptr == ptr & ~(2**i-1) 137 | """ 138 | return self.mem.aligned_allocarray(alignment, nmemb, size) 139 | 140 | def n(self): 141 | return self.mem.n 142 | 143 | def size(self): 144 | return self.mem.size 145 | 146 | def size_t_max(self): 147 | return -1 148 | -------------------------------------------------------------------------------- /pyproject.toml: -------------------------------------------------------------------------------- 1 | [build-system] 2 | requires = [ 3 | "setuptools>=61.2", 4 | "Cython", 5 | "Cython>=0.29.30; python_version > '3.10'" 6 | ] 7 | build-backend = "setuptools.build_meta" 8 | 9 | [project] 10 | name = "memory_allocator" 11 | version = "0.1.4" 12 | description = "An extension class to allocate memory easily with cython" 13 | authors = [ 14 | {name = "Jeroen Demeyer, Nathann Cohen, Jonathan Kliem", email = "sage-devel@googlegroups.com"}, 15 | ] 16 | dependencies = [ 17 | "Cython", 18 | ] 19 | requires-python = ">=3.8" 20 | readme = "README.md" 21 | license = {text = "GPLv3"} 22 | classifiers = [ 23 | "Development Status :: 6 - Mature", 24 | "Intended Audience :: Science/Research", 25 | "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", 26 | "Programming Language :: Cython", 27 | "Programming Language :: Python :: 3", 28 | "Topic :: Scientific/Engineering :: Mathematics", 29 | ] 30 | 31 | [project.urls] 32 | Homepage = "https://github.com/sagemath/memory_allocator" 33 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | from setuptools import setup, find_packages 2 | from setuptools.extension import Extension 3 | from distutils.command.build_ext import build_ext as du_build_ext 4 | 5 | 6 | class build_ext(du_build_ext): 7 | def run(self): 8 | from Cython.Build.Dependencies import cythonize 9 | self.distribution.ext_modules[:] = cythonize( 10 | self.distribution.ext_modules, 11 | language_level=3) 12 | du_build_ext.run(self) 13 | 14 | 15 | extensions = [ 16 | Extension( 17 | "memory_allocator.memory_allocator", 18 | sources=["memory_allocator/memory_allocator.pyx"]), 19 | Extension( 20 | "memory_allocator.test", 21 | sources=["memory_allocator/test.pyx"]), 22 | ] 23 | 24 | 25 | setup( 26 | packages=find_packages(), 27 | ext_modules=extensions, 28 | ) 29 | -------------------------------------------------------------------------------- /test.py: -------------------------------------------------------------------------------- 1 | import cydoctest 2 | import memory_allocator.test 3 | import memory_allocator.memory_allocator 4 | 5 | 6 | # The actual tests. 7 | 8 | cydoctest.testmod(memory_allocator.test, verbose=True) 9 | cydoctest.testmod(memory_allocator.memory_allocator, verbose=True) 10 | --------------------------------------------------------------------------------