Skip to content

fix: memory leak #75

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.

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 1 commit into from
Jun 13, 2025
Merged

fix: memory leak #75

merged 1 commit into from
Jun 13, 2025

Conversation

kjdev
Copy link
Owner

@kjdev kjdev commented Jun 13, 2025

Summary by CodeRabbit

  • Bug Fixes
    • Improved memory management to prevent potential memory leaks and redundant operations during compression and decompression.
    • Enhanced error handling with early returns if memory allocation fails or if no data is read from the stream.

Copy link

coderabbitai bot commented Jun 13, 2025

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The changes revise memory management in brotli.c by removing redundant free/release calls for zend_string objects, simplifying buffer cleanup, adding early returns on allocation or read failures, and ensuring context cleanup on compression errors. No exported or public entity declarations were altered.

Changes

File(s) Change Summary
brotli.c Removed redundant zend_string free/release calls, improved buffer cleanup logic, added early returns on allocation/read failures, and ensured context cleanup on compression errors.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant brotli_compress
    participant php_brotli_context_close

    User->>brotli_compress: Request compression
    brotli_compress->>brotli_compress: Allocate resources
    alt Compression fails
        brotli_compress->>php_brotli_context_close: Cleanup context
        brotli_compress-->>User: Return FALSE
    else Compression succeeds
        brotli_compress-->>User: Return compressed data
    end
Loading

Possibly related PRs

Poem

In brotli’s burrow, memory’s tight,
Freed strings and buffers, all done right.
Early returns if things go wrong,
Cleanup now swift, error paths strong.
With hops and nibbles, leaks take flight—
A rabbit’s code, both safe and light! 🐇✨


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@kjdev
Copy link
Owner Author

kjdev commented Jun 13, 2025

@coderabbitai review

Copy link

coderabbitai bot commented Jun 13, 2025

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1b26100 and 8414871.

📒 Files selected for processing (1)
  • brotli.c (4 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (20)
  • GitHub Check: ci (8.4-zts-alpine, apcu, php, linux/amd64)
  • GitHub Check: ci (8.2, x64, ts, vs16, true)
  • GitHub Check: ci (8.3-alpine, php, linux/amd64)
  • GitHub Check: ci (8.1-zts-alpine, php, linux/amd64)
  • GitHub Check: ci (8.1-alpine, system, php, linux/amd64)
  • GitHub Check: ci (8.3-zts-alpine, apcu, php, linux/amd64)
  • GitHub Check: ci (8.2-zts-alpine, system, apcu, php, linux/amd64)
  • GitHub Check: ci (8.3-alpine, apcu, php, linux/amd64)
  • GitHub Check: ci (8.2-alpine, apcu, php, linux/386)
  • GitHub Check: ci (8.2, x64, ts, vs16, false)
  • GitHub Check: ci (7.2-alpine, ghcr.io/kjdev/php, linux/amd64)
  • GitHub Check: ci (8.1, x86, ts, vs16, true)
  • GitHub Check: ci (8.1, x64, ts, vs16, true)
  • GitHub Check: ci (8.2-alpine, php, linux/amd64)
  • GitHub Check: ci (8.2, x64, nts, vs16, false)
  • GitHub Check: ci (8.3, x64, ts, vs16, true)
  • GitHub Check: ci (8.1, x86, ts, vs16, false)
  • GitHub Check: ci (8.3, x86, nts, vs16, true)
  • GitHub Check: ci (8.3, x64, nts, vs16, true)
  • GitHub Check: ci (8.4, x86, nts, vs17, true)
🔇 Additional comments (4)
brotli.c (4)

473-478: Possible zend_string ownership leak – verify lifecycle.

dict is now passed straight through to php_brotli_context_create_encoder_ex() and never released.
If BrotliEncoderPrepareDictionary() copies the buffer this is fine, otherwise the zend_string will leak (previous code released it).

Please double-check the encoder implementation and either keep the release or document why the leak is acceptable.


823-824: No functional change – benign.


894-895: Good cleanup simplification.

Unconditional frees mean fewer branches and no leaks here – nice.


1520-1521: Correctly closing context on error – good catch.

Adding php_brotli_context_close(&ctx) prevents the encoder state from leaking on the failure path.

@kjdev kjdev force-pushed the fix/memory-leak branch from 8414871 to 30fd4ff Compare June 13, 2025 04:30
@kjdev kjdev merged commit 30fd4ff into master Jun 13, 2025
74 checks passed
@kjdev kjdev deleted the fix/memory-leak branch June 13, 2025 04:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant