Skip to content

Fix getting file size for NativeFileInfo #2996

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
Aug 1, 2024

Conversation

josesimoes
Copy link
Member

@josesimoes josesimoes commented Aug 1, 2024

Description

  • Add code to set the struct property in all drivers.
  • Fix managed type name for NativeFileInfo.

Motivation and Context

How Has This Been Tested?

Screenshots

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

    • Enhanced file information retrieval with accurate size and attributes for better usability.
    • Improved handling of directory vs. file distinctions in file attributes.
  • Bug Fixes

    • Resolved initialization issues in file info retrieval processes, ensuring data integrity.
  • Chores

    • Adjusted task management for optimized performance on the ESP32 platform.

@nfbot nfbot added the Type: bug label Aug 1, 2024
Copy link

coderabbitai bot commented Aug 1, 2024

Warning

Rate limit exceeded

@josesimoes has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 8 minutes and 59 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 85c24ef and 598b6b3.

Walkthrough

The recent changes enhance the file information retrieval mechanisms across multiple classes in the system, specifically targeting the GetFileInfo methods. Improvements include zero-initialization of structures, accurate size assignments, and enhanced handling of file attributes. These updates aim to prevent system panics when accessing file lengths and improve overall robustness and clarity in file operations.

Changes

Files Change Summary
src/System.IO.FileSystem/...NativeFindFile.cpp, targets/ChibiOS/_FatFs/fatfs_FS_Driver.cpp, targets/ESP32/_FatFs/fatfs_FS_Driver.cpp, targets/ESP32/_littlefs/littlefs_FS_Driver.cpp, targets/netcore/littlefs/littlefs_FS_Driver.cpp Enhanced GetFileInfo methods to include accurate file size and attributes. Zero-initialization added for clarity.
targets/ESP32/_IDF/esp32/app_main.c Adjusted task core allocations for receiver_task and main_task to optimize performance on ESP32.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant System
    participant FileSystem

    User->>System: Request file length
    System->>FileSystem: Call GetFileInfo
    FileSystem-->>System: Return file size and attributes
    System-->>User: Provide file length
Loading

Assessment against linked issues

Objective Addressed Explanation
Get File Length without crashing (#1523)
Prevent system panic during file access (#1523)

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

@josesimoes josesimoes added Area: Common libs Everything related with common libraries Platform: STM32 Everything related specifically with ChibiOS platform Platform: ESP32 Everything related specifically with ESP32 platform Platform: Virtual Device & WIN32 Everything related specifically with WIN32 and .NET tool builds labels Aug 1, 2024
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: 0

Outside diff range, codebase verification and nitpick comments (1)
targets/ChibiOS/_littlefs/littlefs_FS_Driver.cpp (1)

1217-1217: Formatting improvement.

The addition of a newline character at the end of the g_LITTLEFS_FILE_SYSTEM_DriverInterface declaration improves the code's formatting.

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between a2cd773 and 85c24ef.

Files selected for processing (7)
  • src/System.IO.FileSystem/nf_sys_io_filesystem_System_IO_NativeFindFile.cpp (1 hunks)
  • targets/ChibiOS/_FatFs/fatfs_FS_Driver.cpp (1 hunks)
  • targets/ChibiOS/_littlefs/littlefs_FS_Driver.cpp (2 hunks)
  • targets/ESP32/_FatFs/fatfs_FS_Driver.cpp (1 hunks)
  • targets/ESP32/_IDF/esp32/app_main.c (1 hunks)
  • targets/ESP32/_littlefs/littlefs_FS_Driver.cpp (1 hunks)
  • targets/netcore/littlefs/littlefs_FS_Driver.cpp (1 hunks)
Additional comments not posted (11)
targets/ESP32/_IDF/esp32/app_main.c (2)

64-64: Verify the rationale behind changing core affinity.

The receiver_task is now pinned to core 1. Ensure this change optimizes the task scheduling and does not introduce any race conditions.


67-67: Verify the rationale behind changing core affinity.

The main_task is now pinned to core 0. Ensure this change optimizes the task scheduling and does not introduce any race conditions.

src/System.IO.FileSystem/nf_sys_io_filesystem_System_IO_NativeFindFile.cpp (2)

28-29: Enhance robustness by zero-initializing structures.

Zero-initializing the fileInfo structure prevents the use of uninitialized data, enhancing robustness.


36-36: Ensure consistency with type definition lookup.

Updating the type definition lookup to NativeFileInfo ensures consistency with the intended representation.

targets/ESP32/_FatFs/fatfs_FS_Driver.cpp (3)

645-649: Differentiate file attributes for directories.

Setting fileInfo->Attributes to FileAttributes::FileAttributes_Directory for directories enhances the accuracy of file metadata.


650-653: Differentiate file attributes for archives.

Setting fileInfo->Attributes to FileAttributes::FileAttributes_Archive for non-directory files enhances the accuracy of file metadata.


659-659: Store file sizes explicitly.

Storing the file size in fileInfo->Size improves the functionality of the GetFileInfo method by providing more detailed metadata.

targets/ChibiOS/_FatFs/fatfs_FS_Driver.cpp (1)

747-749: LGTM! The addition correctly sets the file size.

The new line of code enhances the functionality by ensuring the file size is included in the information returned to the caller.

targets/ESP32/_littlefs/littlefs_FS_Driver.cpp (1)

702-704: LGTM! The addition correctly sets the file size.

The new line of code enhances the functionality by ensuring the file size is included in the information returned to the caller.

targets/netcore/littlefs/littlefs_FS_Driver.cpp (1)

705-706: LGTM! The addition correctly sets the file size.

The new line of code enhances the functionality by ensuring the file size is included in the information returned to the caller.

targets/ChibiOS/_littlefs/littlefs_FS_Driver.cpp (1)

736-737: LGTM! The file size assignment is a significant enhancement.

The addition of fileInfo->Size = info.size; ensures that the file size is now populated in the returned fileInfo structure, allowing callers to access the file size directly.

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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between a2cd773 and 85c24ef.

Files selected for processing (7)
  • src/System.IO.FileSystem/nf_sys_io_filesystem_System_IO_NativeFindFile.cpp (1 hunks)
  • targets/ChibiOS/_FatFs/fatfs_FS_Driver.cpp (1 hunks)
  • targets/ChibiOS/_littlefs/littlefs_FS_Driver.cpp (2 hunks)
  • targets/ESP32/_FatFs/fatfs_FS_Driver.cpp (1 hunks)
  • targets/ESP32/_IDF/esp32/app_main.c (1 hunks)
  • targets/ESP32/_littlefs/littlefs_FS_Driver.cpp (1 hunks)
  • targets/netcore/littlefs/littlefs_FS_Driver.cpp (1 hunks)
Additional comments not posted (10)
targets/ESP32/_IDF/esp32/app_main.c (2)

64-64: Verify the impact of changing receiver_task to core 1.

Ensure that assigning receiver_task to core 1 does not introduce any race conditions or performance issues.


67-67: Verify the impact of changing main_task to core 0.

Ensure that assigning main_task to core 0 does not introduce any race conditions or performance issues.

src/System.IO.FileSystem/nf_sys_io_filesystem_System_IO_NativeFindFile.cpp (2)

28-29: Good practice: Zero-initialization of fileInfo.

Zero-initializing the fileInfo structure prevents potential issues related to uninitialized memory, improving reliability.


36-36: Improvement: Update type definition to NativeFileInfo.

Updating the type definition to NativeFileInfo reflects a more accurate representation of the data being handled, improving semantic clarity.

targets/ESP32/_FatFs/fatfs_FS_Driver.cpp (2)

645-653: Improvement: Accurate handling of file attributes.

The conditional check to determine if the file is a directory or an archive improves the accuracy of file attribute representation.


658-659: Improvement: Setting file size.

Explicitly setting fileInfo->Size to info.st_size ensures that the file size is correctly stored in the fileInfo structure, enhancing the completeness of the information provided.

targets/ChibiOS/_FatFs/fatfs_FS_Driver.cpp (1)

747-749: LGTM! Ensure st_size is correctly populated.

The change correctly sets the Size attribute of the fileInfo structure. Ensure that the st_size field in the info object is always correctly populated.

targets/ESP32/_littlefs/littlefs_FS_Driver.cpp (1)

702-704: LGTM! Ensure st_size is correctly populated.

The change correctly sets the Size attribute of the fileInfo structure. Ensure that the st_size field in the info object is always correctly populated.

targets/netcore/littlefs/littlefs_FS_Driver.cpp (1)

705-706: LGTM! Ensure size is correctly populated.

The change correctly sets the Size attribute of the fileInfo structure. Ensure that the size field in the info object is always correctly populated.

targets/ChibiOS/_littlefs/littlefs_FS_Driver.cpp (1)

736-737: LGTM! The file size assignment is correctly added.

The addition of fileInfo->Size = info.size; ensures that the file size is correctly populated in the fileInfo structure, addressing the issue of missing file size information.

- Add code to set the struct property in all drivers.
- Fix managed type name for NativeFileInfo.

Fix getting file size for NativeFileInfo

- Add code to set the struct property in all drivers.
- Fix managed type name for NativeFileInfo.
@josesimoes josesimoes merged commit 76e688e into nanoframework:main Aug 1, 2024
28 checks passed
@josesimoes josesimoes deleted the fix-file-sys branch August 1, 2024 17:05
@coderabbitai coderabbitai bot mentioned this pull request Oct 10, 2024
13 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Common libs Everything related with common libraries Platform: ESP32 Everything related specifically with ESP32 platform Platform: STM32 Everything related specifically with ChibiOS platform Platform: Virtual Device & WIN32 Everything related specifically with WIN32 and .NET tool builds Type: bug
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Internal Storage Get File Length causes system panic
2 participants