Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Add support to process assemblies with generics <T> #183

Open
wants to merge 298 commits into
base: main
Choose a base branch
from
Open

Add support to process assemblies with generics <T> #183

wants to merge 298 commits into from
+4,651 −624,056

Conversation

josesimoes
Copy link
Member

@josesimoes josesimoes commented Mar 21, 2025 •
edited by coderabbitai bot
Loading

Description

  • Rework metadata tables to include elements to hold data on generic types and instances.
  • Add support for MethodSpec and TypeSpec.
  • Rework most of the tables to include data for generic types and instances.
  • Add sanity checks and code in a bunch of several places.
  • Rewrote PDBX writer from XML to json.
  • Add new extensions to improve usage.
  • Rewrote dumper to follow format from ILDASM.
  • Add new unit tests to cover changes.
  • Update dumper and writer unit tests.
  • Update dependencies on console, msbuild tasks and core.
  • Update sub-modules to ref generic branches (to be replaced with main, following merge).
  • Code style fixes throughout source files.
  • Add/update license header in all source files.

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)
  • Dependencies (update dependencies and changes associated, has no impact on code or features)
  • Unit Tests (add new Unit Test(s) or improved existing one(s), 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).
  • I have added new tests to cover my changes.

Summary by CodeRabbit

Summary by CodeRabbit

  • New Features

    • Introduced automated changelog generation with categorized entries and a consistent template.
    • Added a workflow that automatically creates release notes when new tags are pushed.

  • Chores

    • Updated various project dependencies to enhance performance, security, and compatibility, including the addition of new dependencies and updates to existing ones.
    • Refined build pipeline configurations with improved triggers, variable management, and task adjustments.
    • Adjusted file inclusion settings to streamline processing.
    • Removed outdated configuration files to simplify project structure, including several development container configurations and settings for Visual Studio Code.

@josesimoes
Serious rework on dumper
e54d632 
- Update dump layout to make it closer to ILDASM.
- nF tokens are now used along with real tokens.
- Strings are now output.
- Destination args are now output.
- Inline types are now output.
- IL offsets are now output.
- Add new enums for nF Metadata tokens, encoded inline types and PE tables.
- Add unit tests.
@josesimoes
Add and reorder tables
0c4565d
@josesimoes
Add property to expose table type
0fb8e2e
@josesimoes
Add member ref table
a5c2e85
@josesimoes
Reorder minimization order
1631397
@josesimoes
Add property exposing table type
96cb3bc
@josesimoes
Add and reorder tables
8ce1df7
@josesimoes
Add assert to MemberRef dependency crawler
bcd5f9d
@josesimoes
Add assert to TypeSpec dependency crawler
8302a5d
@josesimoes
Improve generics processing in Method crawler
ec68b14
@josesimoes
Improve tables context
8fd3aa9 
- Add member refs table.
- Add code to init refs.
@josesimoes
Fix MethodSpec table write
7db9f84
@josesimoes
Fix MethodRef table write
6320b7b
@josesimoes
Rework dumper genertor
da3b73b 
- Fix several tokens output.
- Fix TypeSpec output.
@josesimoes
Fix getting MethodSpec
3150791
@josesimoes
Rename comparer to match class
ac0c5a0
@josesimoes
Improve selection of methods with generic parameters
ffc36e0
@josesimoes
Add lengh check on typespec writing
f9c9de7
@josesimoes
Add RemoveUnusedItems to TypeSpecs table
add48c7
@josesimoes
Improve GetItems on TypeSpecs table
dc1c5fd
@josesimoes
Add property with CLR table to TypeSpec table
20a1dbf
@josesimoes
Improve TypeReferenceComparer
4e3d207
@josesimoes
Add TypeSpecBySignatureComparer
c40f397
@josesimoes
Improvements and fixes on TypeSpec table class
1f9bbab
@josesimoes
Fix GetOrCreateTypeSpecificationId
fad6156
@josesimoes
Fix TryGetTypeReferenceId
b4e40c2
@josesimoes
Move generic params table to the end of the other tables
3211718 
- Need to have all the others properly filled in order to get parameters types.
@josesimoes
GenericParameters now contain parameter type
9c11510
@josesimoes
Improve generic parameter type handling
7be37ee 
- Add crawler to find generic parameter type.
- Generic param PE record now includes parameter type.
@josesimoes
Replace inlineType enum with nf encoding
4a62847 
- Add extension to encode typeRef.
- Add helper class to encode/decode type tokens.
- Rework dumper to make use of these.
@josesimoes
Copy link
Member Author

Unit tests running nanoCLR failed as expected as the nanoCLR is not the correct version.

Ellerbach
Ellerbach reviewed Apr 3, 2025
View reviewed changes
MetadataProcessor.Shared/Tables/nanoSignaturesTable.cs Outdated
private byte[] GetSignature(Collection<GenericParameter> genericParameters)
{
using (var buffer = new MemoryStream())
using (var writer = new BinaryWriter(buffer)) // Only Write(Byte) will be used
Copy link
Member

Choose a reason for hiding this comment

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

minimal: rather than the 2 using in 2 lines, maybe use the brackets as well? (super minimal)

Copy link
Member Author

Choose a reason for hiding this comment

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

I was using this patter as it's the "new" one instead of the tradicional with brackets... isn't this correct?

Ellerbach
Ellerbach reviewed Apr 4, 2025
View reviewed changes
MetadataProcessor.Tests/TestNFApp/Program.cs
dummyMirror1 = anotherClass.DummyProperty;
_ = anotherClass.DummyProperty;

Console.WriteLine($"Accessed property on class: {dummyMirror1}");
Copy link
Member

Choose a reason for hiding this comment

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

same line right after

Ellerbach
Ellerbach reviewed Apr 4, 2025
View reviewed changes
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.

couple of comments, overall looks great! I did revie the native part on the nf-interpreter!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Ellerbach Ellerbach Ellerbach left review comments

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

At least 1 approving review is required to merge this pull request.

Assignees

@josesimoes josesimoes

Labels
Breaking-Change Status: in progress Type: dependencies Type: enhancement New feature or request Type: Unit Tests ⚠️ DO NOT MERGE ⚠️
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@josesimoes @Ellerbach @nfbot @MateuszKlatecki