AllYarnsAreBeautiful / ayab-firmware

Contains the Arduino Firmware for the AYAB Shield
GNU General Public License v3.0
23 stars 19 forks source link

Allocate class instances statically #191

Closed jonathanperret closed 3 months ago

jonathanperret commented 3 months ago

Issue

The classes that make up the AYAB firmware are currently dynamically allocated with new at the top level of main.cpp:

https://github.com/AllYarnsAreBeautiful/ayab-firmware/blob/e960ad4d9cd86daa4b3abbafad90de51ad102da5/src/ayab/main.cpp#L50-L56

Since these objects are allocated at the start of the program and never freed, there is no advantage to having them dynamically allocated. On the other hand, there are disadvantages:

That last point in particular can hide the fact that the memory requirements for the firmware exceed the target microcontroller's RAM size (2048 bytes for the Atmega328p on an Arduino Uno).

Proposed solution

This PR replaces the use of new by the creation of statically allocated instances. The global pointers are then initialized to point to these instances.

Before this PR, here is what the output of the PlatformIO builder looks like:

RAM:   [======    ]  60.2% (used 1232 bytes from 2048 bytes)

Which looks reasonable. But after including the firmware's main objects in the statically allocated area as this PR does, here is the output:

RAM:   [========= ]  91.3% (used 1869 bytes from 2048 bytes)

Revealing that the memory actually available for the stack is much less than was suggested by the earlier output, causing issues like #190.

The memory saved here seems to fix #190 partially. At least, even with stack overflow detection enabled, the firmware can now survive reqInit and even knitting, from my quick test.

Note that this PR also deletes a series of uninitialized constant pointers that appear to have been remains from an earlier attempt at these global pointers.

Summary by CodeRabbit

coderabbitai[bot] commented 3 months ago

[!CAUTION]

Review failed

The pull request is closed.

Walkthrough

The recent changes in src/ayab/main.cpp involve a significant refactor of singleton instance management. Instead of using constexpr pointers to dynamically allocated instances, the code now utilizes stack-allocated instances, enhancing memory management safety and performance by eliminating potential memory leaks and overhead from heap allocations.

Changes

Files Change Summary
src/ayab/main.cpp Replaced constexpr pointers to singleton classes with direct stack-allocated instances.

Assessment against linked issues

Objective Addressed Explanation
Memory gets corrupted when processing serial messages (#190)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `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 generate unit testing code for this file.` - `@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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@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.` 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 as 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 resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.