Skip to content

Conversation

@AdrianSoundy
Copy link
Member

@AdrianSoundy AdrianSoundy commented Nov 10, 2024

Description

Adjust memory for ESP32_C6 after IDF 2.2.3 upgrade

Motivation and Context

Reported discord
](https://discord.com/channels/478725473862549535/1304472705302532096/1304472708578410596)

How Has This Been Tested?

locally
Memory before upgrade
01/01/1970 00:12:38- Memory All (startup) Managed:79896 Native total:299588/Free:100712/Largest:67584

After IDF 5.2.3 - Version 1.12.1.1
01/01/1970 00:08:07- Memory All (startup) Managed:73416 Native total:293140/Free:100648/Largest:67584

After this change
01/01/1970 00:02:15- Memory All (startup) Managed:82488 Native total:292164/Free:90512/Largest:58368

Configured for 10K more for managed, let's hope it doesn't cause any other issues.

So there is just a bit more managed heap then before upgrade.

Types of changes

  • Improvement (non-breaking change that improves a feature, code or algorithm)
  • Bug fix (non-breaking change which fixes an issue with code or algorithm)
  • New feature (non-breaking change which adds functionality to code)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Config and build (change in the configuration and build system, has no impact on code or features)
  • Dev Containers (changes related with Dev Containers, has no impact on code or features)
  • Dependencies/declarations (update dependencies or assembly declarations and changes associated, has no impact on code or features)
  • Documentation (changes or updates in the documentation, has no impact on code or features)

Checklist

  • My code follows the code style of this project (only if there are changes in source code).
  • My changes require an update to the documentation (there are changes that require the docs website to be updated).
  • I have updated the documentation accordingly (the changes require an update on the docs in this repo).
  • I have read the CONTRIBUTING document.
  • I have tested everything locally and all new and existing tests passed (only if there are changes in source code).

Summary by CodeRabbit

  • New Features

    • Introduced support for the ESP32C6 target with enhanced memory allocation logic.
    • Improved resource management by adjusting memory allocation based on available SPIRAM and total free space.
  • Bug Fixes

    • Ensured sufficient free space for IDF memory reservations through updated allocation checks.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 10, 2024

Walkthrough

The changes introduce a new conditional compilation directive for the ESP32C6 target in the Memory.cpp file, defining a minimum free memory requirement for IDF as 90 KB. Adjustments were made to the HeapLocation function to enhance memory allocation logic, checking for available SPIRAM and recalculating memory caps accordingly. The function now logs the allocation process and ensures sufficient free space for IDF memory reservations, while maintaining the overall control flow.

Changes

File Path Change Summary
targets/ESP32/_nanoCLR/Memory.cpp Added conditional compilation for ESP32C6 with 90 KB memory requirement; enhanced HeapLocation logic for SPIRAM checks and memory allocation.

Possibly related PRs

Suggested labels

Area: Config-and-Build, Platform: ESP32, Series: ESP32C6


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
🪧 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.
    • 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 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 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 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 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.

Copy link
Contributor

@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: 0

🧹 Outside diff range and nitpick comments (1)
targets/ESP32/_nanoCLR/Memory.cpp (1)

Line range hint 1-300: Architecture maintains robust memory management across all targets.

The implementation elegantly integrates the ESP32C6 memory requirements while preserving the existing robust memory management strategy. The code continues to:

  • Handle both SPIRAM and internal RAM scenarios
  • Account for additional memory needs (BLE, Thread)
  • Provide comprehensive logging
  • Maintain proper error handling

Consider adding a comment explaining the rationale behind the 90KB requirement for ESP32C6 to help future maintenance.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between d66876a and d27ca40.

📒 Files selected for processing (1)
  • targets/ESP32/_nanoCLR/Memory.cpp (1 hunks)
🧰 Additional context used
📓 Learnings (1)
targets/ESP32/_nanoCLR/Memory.cpp (1)
Learnt from: AdrianSoundy
PR: nanoframework/nf-interpreter#2940
File: targets/ESP32/_nanoCLR/Memory.cpp:140-140
Timestamp: 2024-10-08T15:52:09.445Z
Learning: In the `targets/ESP32/_nanoCLR/Memory.cpp` file, the `largestFreeBlock` value is already logged in the message: `ESP_LOGI(TAG, "Managed heap allocated: %d (from max:%d)", managedHeapSize, largestFreeBlock);`.
🔇 Additional comments (1)
targets/ESP32/_nanoCLR/Memory.cpp (1)

26-27: LGTM! Memory requirements align with provided statistics.

The 90KB minimum free memory requirement for ESP32C6 is well-justified by the memory statistics provided in the PR description. After this change, the system shows:

  • Improved managed memory: 82,488 bytes (up from 73,416 bytes)
  • Available free memory: 90,512 bytes (aligns with the 90KB requirement)

Let's verify no other memory requirement changes were missed:

✅ Verification successful

Let me check the complete context of these memory definitions to ensure they are properly guarded by the correct target conditionals.


Memory definitions are correctly structured and properly guarded

The memory requirements are well-organized with proper conditional compilation guards:

  • ESP32H2: 20KB
  • ESP32C6: 90KB (new addition)
  • Others: 100KB

The implementation follows the established pattern and the value of 90KB for ESP32C6 sits logically between the existing values, matching the memory statistics provided in the PR description.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for any other MINIMUM_FREE_MEMORY_FOR_IDF definitions
rg "MINIMUM_FREE_MEMORY_FOR_IDF" --type cpp

Length of output: 390


Script:

#!/bin/bash
# Get the complete context of the memory definitions with surrounding conditionals
rg "MINIMUM_FREE_MEMORY_FOR_IDF" -B2 -A2 --type cpp

Length of output: 1084

@AdrianSoundy AdrianSoundy merged commit 9d8ffca into nanoframework:main Nov 10, 2024
18 checks passed
@AdrianSoundy AdrianSoundy deleted the memoryC6 branch November 10, 2024 00:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants