Skip to content

Fix execution of static constructors #3168

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 3 commits into from
May 8, 2025

Conversation

josesimoes
Copy link
Member

@josesimoes josesimoes commented May 8, 2025

Description

  • These are now skipped if they contain generic parameters or they live in a generic type definition.

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 filtering to ensure only valid static constructors are considered, excluding those that are generic or belong to generic type definitions.
  • Style

    • Minor whitespace cleanup and formatting improvements in debug output and macro usage.

- These are now skipped if they contain generic parameters or they live in a generic type definition.
@josesimoes josesimoes added the Area: Interpreter Everything related with the interpreter, execution engine and such label May 8, 2025
@nfbot nfbot added the Type: bug label May 8, 2025
Copy link

coderabbitai bot commented May 8, 2025

Walkthrough

The update refines internal logic in the type system implementation. It enhances the static constructor search by adding checks to exclude generic methods and types, consolidates a macro call for array creation into a single line, and performs minor whitespace cleanup in debug output. No public interfaces or signatures are changed.

Changes

File(s) Change Summary
src/CLR/Core/TypeSystem.cpp Refined static constructor search to exclude generics, consolidated macro call, and cleaned up whitespace in debug output.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant TypeSystem
    participant MethodDef
    participant TypeDef

    Caller->>TypeSystem: FindNextStaticConstructor()
    TypeSystem->>MethodDef: Get method definition by index
    TypeSystem->>TypeDef: Initialize type from method
    TypeSystem->>TypeDef: Check genericParamCount == 0
    TypeSystem->>MethodDef: Check MD_ContainsGenericParameter flag
    alt Not generic and no generic params
        TypeSystem-->>Caller: Return static constructor
    else
        TypeSystem-->>Caller: Skip and continue search
    end
Loading

Tip

⚡️ Faster reviews with caching
  • CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.

Enjoy the performance boost—your workflow just got faster.


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d7c40c5 and d9dd0fa.

📒 Files selected for processing (1)
  • src/CLR/Core/TypeSystem.cpp (3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (5)
  • GitHub Check: nf-interpreter (Nightly build) (Build_STM32_targets ORGPAL_PALX)
  • GitHub Check: nf-interpreter (Nightly build) (Build_STM32_targets ORGPAL_PALTHREE)
  • GitHub Check: nf-interpreter (Check_Code_Style)
  • GitHub Check: nf-interpreter (Nightly build) (Check_Build_Options)
  • GitHub Check: nf-interpreter (Check_Build_Options)
🔇 Additional comments (2)
src/CLR/Core/TypeSystem.cpp (2)

3844-3848: Change is fine – just a style consolidation

The CLR_RT_HeapBlock_Array::CreateInstance call is now a single-liner; functionality is unchanged and readability improves. ✅


4789-4803:

❌ Incorrect review comment

Guard against failed InitializeFromMethod() to avoid NULL‐dereference

Great call adding the extra filters – it matches the PR goals.
However, typeDefInst.InitializeFromMethod(methodDefInst) can legally return false (e.g. malformed metadata).
If that happens typeDefInst.target is nullptr, and the subsequent
typeDefInst.target->genericParamCount dereference will seg-fault.

A tiny early-continue (or assert) keeps us safe with zero perf cost:

@@
-        CLR_RT_TypeDef_Instance typeDefInst;
-        typeDefInst.InitializeFromMethod(methodDefInst);
+        CLR_RT_TypeDef_Instance typeDefInst;
+
+        if (!typeDefInst.InitializeFromMethod(methodDefInst) || typeDefInst.target == nullptr)
+        {
+            // Malformed metadata – skip and keep looking.
+            continue;
+        }

🏁 Script executed:

#!/bin/bash
# Locate the CLR_RT_TypeDef_Instance struct and its InitializeFromMethod signature/implementation
rg -n "struct CLR_RT_TypeDef_Instance" -A15
rg -n "CLR_RT_TypeDef_Instance::InitializeFromMethod" -A5
rg -n "InitializeFromMethod" -C3

Length of output: 11411


🏁 Script executed:

#!/bin/bash
# Display the full implementation of InitializeFromMethod for MethodDef_Instance
sed -n '780,860p' src/CLR/Core/TypeSystem.cpp

Length of output: 2191


🏁 Script executed:

#!/bin/bash
# Show context around the snippet in TypeSystem.cpp
sed -n '4760,4830p' src/CLR/Core/TypeSystem.cpp

Length of output: 2108


No additional null‐check needed for InitializeFromMethod here

After inspecting CLR_RT_TypeDef_Instance::InitializeFromMethod(const CLR_RT_MethodDef_Instance&), it always returns true for every valid md (and this loop only iterates over valid method indices) and unconditionally sets target to a valid CLR_RECORD_TYPEDEF*. There is no legal path into the false branch in this context, so typeDefInst.target can’t be nullptr and the suggested guard is unnecessary.

Likely an incorrect or invalid review comment.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

nfbot and others added 2 commits May 8, 2025 15:35
Automated fixes for code style.
…99ec-4eac-403b-96d4-2430ec7623b0

Code style fixes for nanoframework/nf-interpreter PR#3168
@josesimoes
Copy link
Member Author

@coderabbitai review

Copy link

coderabbitai bot commented May 8, 2025

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@josesimoes josesimoes merged commit 99d3245 into nanoframework:develop May 8, 2025
24 checks passed
@josesimoes josesimoes deleted the fix-cctors branch May 8, 2025 16:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Interpreter Everything related with the interpreter, execution engine and such Type: bug
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants