Skip to content

docs(cargo-php): Custom Allocators #523 #618

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

Open
kakserpom wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs(cargo-php): Custom Allocators #523 #618

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
21 changes: 21 additions & 0 deletions guide/src/getting-started/cargo-php.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,27 @@ OPTIONS:
Print stubs to stdout rather than write to file. Cannot be used with `out`
```

### Custom Allocators

If your extension uses a custom global allocator (e.g., `mimalloc`, `jemalloc`),
you may encounter a crash when running `cargo php stubs` with an error like
"pointer being freed was not allocated".

This happens because `cargo php stubs` builds your extension in debug mode and
loads it to extract type information. Custom allocators can conflict with this
process.

**Workaround:** Conditionally enable your custom allocator only in release builds:

```rust,ignore
#[cfg(not(debug_assertions))]
#[global_allocator]
static GLOBAL: mimalloc::MiMalloc = mimalloc::MiMalloc;
```

See [issue #523](https://github.com/davidcole1340/ext-php-rs/issues/523) for more
details.

## Extension Installation

When PHP is in your PATH, the application can automatically build and copy your
Expand Down
Loading