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

Add user pointers to avoid using global variables in callbacks (IDFGH-12601) #13599

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

Conversation

carlosbar
Copy link

The motivation to propose this change is based on the callbacks used both by:

GAP: (esp_ble_gap_register_callback, esp_ble_gap_get_callback)
GATTS: (esp_ble_gatts_register_callback, esp_ble_gatts_get_callback)

The proposed solution is to add 2 new more entry points for each of the profiles:

GAP: (esp_ble_gap_register_ptr, esp_ble_gap_get_ptr)
GATTS: (esp_ble_gatts_register_ptr, esp_ble_gatts_get_ptr)

With these new entry points, the registered callbacks now have to ability to retrieve a pre-set user pointer, avoiding, in this way, the use of global variables, which is consolidated as a bad practice and should be avoided when possible. This problem yet has another weight in multi-core environments.

@CLAassistant
Copy link

CLAassistant commented Apr 12, 2024

CLA assistant check
All committers have signed the CLA.

Copy link

Messages
📖 🎉 Good Job! All checks are passing!

👋 Hello carlosbar, 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 3b9e001

@espressif-bot espressif-bot added the Status: Opened Issue is new label Apr 12, 2024
@github-actions github-actions bot changed the title Add user pointers to avoid using global variables in callbacks Add user pointers to avoid using global variables in callbacks (IDFGH-12601) Apr 12, 2024
@zhp0406
Copy link
Collaborator

zhp0406 commented Apr 15, 2024

In practical usage, the callback functions for GAP and GATT are not frequently modified, and instances of competition or deadlock are rare.

What other issues do you think might arise from this approach?

@carlosbar
Copy link
Author

In practical usage, the callback functions for GAP and GATT are not frequently modified, and instances of competition or deadlock are rare.

What other issues do you think might arise from this approach?

The issues that arise from globals I'm quite sure are possible race conditions and lack of easy tracking to whown performed some change. Besides that, not related with issues but with best practices and design, the use of global variables prevent isolation/encapsulation (as this is aware of parts of the code it is not related), prevents abstraction/compartmentalization because of almost the same reason (touching an external piece of code and not minding its own bits). Interfaces are created to comply with these, and the proposed change it is a form of interface.

Of course this is going to be only (in most cases) a single variable outside of the callback context, but the simple usage of it breaks some of the above architecture patterns.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Opened Issue is new
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants