Skip to content

Fix format string for 64bits vars #3021

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
Sep 19, 2024

Conversation

josesimoes
Copy link
Member

@josesimoes josesimoes commented Sep 19, 2024

Description

  • Replaced with PRIx64 macro.
  • Fixed other missing casts in Profiler.

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

  • Bug Fixes

    • Improved the accuracy of debug output for 64-bit integers in both the execution engine and profiler components.
    • Enhanced logging functionality by ensuring compatibility across different compilers and platforms.
  • Chores

    • Updated format specifiers in debug print statements for better portability.
    • Clarified pointer arithmetic for improved type safety.

- Replaced with PRIx64 macro.
Copy link

coderabbitai bot commented Sep 19, 2024

Walkthrough

The changes involve modifying the way 64-bit memory addresses are printed in the AllocateHeaps function and debug statements in the Profiler.cpp file. The original use of the %I64X format specifier has been replaced with the PRIx64 macro from the <inttypes.h> header to enhance portability across different compilers and platforms. Additionally, adjustments to pointer casting in the profiler ensure type safety in calculations. Overall, the core logic of the functions remains unchanged.

Changes

Files Change Summary
src/CLR/Core/Execution.cpp Replaced %I64X with PRIx64 for 64-bit address printing in AllocateHeaps. Included <stdint.h> for type definitions.
src/CLR/Diagnostics/Profiler.cpp Updated debug print statements from %I64X to %" PRIx64 for 64-bit integers. Adjusted pointer casting for clarity and type safety.

Possibly related PRs

  • Fix cache invalidation for SPI transfer #3014: The changes in this PR focus on variable naming and buffer length calculations in a different context (SPI transfers), which does not relate to the memory address formatting changes in the main PR.

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between a2264b2 and 52b5dc3.

Files selected for processing (2)
  • src/CLR/Core/Execution.cpp (2 hunks)
  • src/CLR/Diagnostics/Profiler.cpp (10 hunks)
Files skipped from review due to trivial changes (1)
  • src/CLR/Core/Execution.cpp
Additional comments not posted (4)
src/CLR/Diagnostics/Profiler.cpp (4)

Line range hint 1056-1090: LGTM!

The function correctly packs the 32-bit unsigned integer value into nibbles and writes it to the stream. The logic to determine the minimum number of nibbles needed is sound.


Line range hint 1092-1096: Looks good!

The function correctly packs the assembly and type indices of the CLR_RT_TypeDef_Index into the stream.


Line range hint 1098-1102: Looks good!

The function correctly packs the assembly and method indices of the CLR_RT_MethodDef_Index into the stream.


Line range hint 1106-1120: LGTM!

The function correctly sends the profiler stream data when it exceeds the defined threshold size. This helps prevent the stream from growing too large before being sent.


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
Member

@Ellerbach Ellerbach left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good

@josesimoes josesimoes merged commit 63911a6 into nanoframework:main Sep 19, 2024
29 checks passed
@josesimoes josesimoes deleted the fix-formatstring-64b branch September 19, 2024 17:53
@coderabbitai coderabbitai bot mentioned this pull request Nov 12, 2024
13 tasks
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.

3 participants