Skip to content
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

fix(esp_ringbuf): Fixed no split buffer in case of wrap around with dummy data (IDFGH-14146) #14948

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

Conversation

upolc-lg
Copy link

@upolc-lg upolc-lg commented Nov 28, 2024

Description

Fixed no split buffer in case of wrap around with dummy data. This is a corner case of the issue #14568.

I added an additional check and exit condition to prvGetItemDefault. The reason for this is to avoid moving the read pointer in prvCheckItemAvail.

Related

Fixes #14568

Testing

A new unit test was added to cover this scenario (test_ringbuf_common.c: TEST_CASE("Test no-split buffers always receive items in order (with dummy)", "[esp_ringbuf][linux]").


Checklist

Before submitting a Pull Request, please ensure the following:

  • 🚨 This PR does not introduce breaking changes.
  • All CI checks (GH Actions) pass.
  • Documentation is updated as needed.
  • Tests are updated or added as necessary.
  • Code is well-commented, especially in complex areas.
  • Git history is clean — commits are squashed to the minimum necessary.

@CLAassistant
Copy link

CLAassistant commented Nov 28, 2024

CLA assistant check
All committers have signed the CLA.

Copy link

github-actions bot commented Nov 28, 2024

Messages
📖 🎉 Good Job! All checks are passing!

👋 Hello upolc-lg, we appreciate your contribution to this project!


📘 Please review the project's Contributions Guide for key guidelines on code, documentation, testing, and more.

🖊️ Please also make sure you have read and signed the Contributor License Agreement for this project.

Click to see more instructions ...


This automated output is generated by the PR linter DangerJS, which checks if your Pull Request meets the project's requirements and helps you fix potential issues.

DangerJS is triggered with each push event to a Pull Request and modify the contents of this comment.

Please consider the following:
- Danger mainly focuses on the PR structure and formatting and can't understand the meaning behind your code or changes.
- Danger is not a substitute for human code reviews; it's still important to request a code review from your colleagues.
- To manually retry these Danger checks, please navigate to the Actions tab and re-run last Danger workflow.

Review and merge process you can expect ...


We do welcome contributions in the form of bug reports, feature requests and pull requests via this public GitHub repository.

This GitHub project is public mirror of our internal git repository

1. An internal issue has been created for the PR, we assign it to the relevant engineer.
2. They review the PR and either approve it or ask you for changes or clarifications.
3. Once the GitHub PR is approved, we synchronize it into our internal git repository.
4. In the internal git repository we do the final review, collect approvals from core owners and make sure all the automated tests are passing.
- At this point we may do some adjustments to the proposed change, or extend it by adding tests or documentation.
5. If the change is approved and passes the tests it is merged into the default branch.
5. On next sync from the internal git repository merged change will appear in this public GitHub repository.

Generated by 🚫 dangerJS against cc132c6

@espressif-bot espressif-bot added the Status: Opened Issue is new label Nov 28, 2024
@github-actions github-actions bot changed the title fix(esp_ringbuf): Fixed no split buffer in case of wrap around with dummy data fix(esp_ringbuf): Fixed no split buffer in case of wrap around with dummy data (IDFGH-14146) Nov 28, 2024
@sudeep-mohanty
Copy link
Collaborator

Hi @upolc-lg,
Thank you for providing the fix. However, I debugged the issue further and it turns out that the problem lies in the prvSendItemDoneNoSplit() function. I do not see a need for an additional check in prvCheckItemAvail() or the functions dealing with allow-split buffers which do not support acquiring space on a buffer before writing to it.

So, we would not merge this fix and instead create a new one which fixes your problem. Thanks.

@sudeep-mohanty sudeep-mohanty reopened this Dec 5, 2024
@espressif-bot espressif-bot added Status: Reviewing Issue is being reviewed and removed Status: Opened Issue is new labels Dec 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Reviewing Issue is being reviewed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Ringbuf: Acquiring entire ring buffer results in items being received prematurely (IDFGH-13694)
4 participants