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

Update tools to the latest version of System.Reflection.Metadata #101541

Closed
adamsitnik opened this issue Apr 25, 2024 · 0 comments · Fixed by #101910
Closed

Update tools to the latest version of System.Reflection.Metadata #101541

adamsitnik opened this issue Apr 25, 2024 · 0 comments · Fixed by #101910
Assignees
@adamsitnik
Labels
area-Tools-ILVerification Issues related to ilverify tool and IL verification in general
Milestone
9.0.0

Comments

@adamsitnik
Copy link
Member

When the SDK version is updated to latest, we are going to need to make some changes to the tools, so they stop referencing the new APIs via links and simply consume latest version of System.Reflection.Metadata package.

Here is the list of things that it will requires

  1. Remove links to files from ILVerification.projitems:

    runtime/src/coreclr/tools/ILVerification/ILVerification.projitems

    Lines 69 to 98 in 127844c

    <Compile Include="$(LibrariesProjectRoot)\Common\src\System\HexConverter.cs">
    <Link>Utilities\HexConverter.cs</Link>
    </Compile>
    <Compile Include="$(LibrariesProjectRoot)\Common\src\System\Reflection\AssemblyNameFormatter.cs">
    <Link>Utilities\AssemblyNameFormatter.cs</Link>
    </Compile>
    <Compile Include="$(LibrariesProjectRoot)\Common\src\System\Reflection\AssemblyNameParser.cs">
    <Link>Utilities\AssemblyNameParser.cs</Link>
    </Compile>
    <Compile Include="$(LibrariesProjectRoot)\Common\src\System\Reflection\Metadata\AssemblyNameInfo.cs">
    <Link>Utilities\Metadata\AssemblyNameInfo.cs</Link>
    </Compile>
    <Compile Include="$(LibrariesProjectRoot)\Common\src\System\Reflection\Metadata\TypeName.cs">
    <Link>Utilities\TypeName.cs</Link>
    </Compile>
    <Compile Include="$(LibrariesProjectRoot)\Common\src\System\Reflection\Metadata\TypeNameParserOptions.cs">
    <Link>Utilities\TypeNameParserOptions.cs</Link>
    </Compile>
    <Compile Include="$(LibrariesProjectRoot)\Common\src\System\Reflection\Metadata\TypeNameParser.cs">
    <Link>Utilities\TypeNameParser.cs</Link>
    </Compile>
    <Compile Include="$(LibrariesProjectRoot)\Common\src\System\Reflection\Metadata\TypeNameParserHelpers.cs">
    <Link>Utilities\TypeNameParserHelpers.cs</Link>
    </Compile>
    <Compile Include="$(CoreLibSharedDir)System\Diagnostics\CodeAnalysis\UnconditionalSuppressMessageAttribute.cs" Condition="'$(TargetFrameworkIdentifier)' != '.NETCoreApp'">
    <Link>System\Diagnostics\CodeAnalysis\UnconditionalSuppressMessageAttribute.cs</Link>
    </Compile>
    <Compile Include="$(CoreLibSharedDir)System\Diagnostics\CodeAnalysis\NullableAttributes.cs" Condition="'$(TargetFrameworkIdentifier)' != '.NETCoreApp'">
    <Link>System\Diagnostics\CodeAnalysis\NullableAttributes.cs</Link>
    </Compile>

    runtime/src/coreclr/tools/ILVerification/ILVerification.projitems

    Lines 105 to 107 in 127844c

    <Compile Include="$(LibrariesProjectRoot)\Common\src\System\Text\ValueStringBuilder.AppendSpanFormattable.cs" Condition="'$(TargetFrameworkIdentifier)' == '.NETCoreApp'">
    <Link>Utilities\ValueStringBuilder.AppendSpanFormattable.cs</Link>
    </Compile>
  2. And from ILCompiler.TypeSystem.csproj:

    runtime/src/coreclr/tools/aot/ILCompiler.TypeSystem/ILCompiler.TypeSystem.csproj

    Lines 201 to 224 in 127844c

    <Compile Include="$(LibrariesProjectRoot)\Common\src\System\HexConverter.cs">
    <Link>Utilities\HexConverter.cs</Link>
    </Compile>
    <Compile Include="$(LibrariesProjectRoot)\Common\src\System\Reflection\AssemblyNameFormatter.cs">
    <Link>Utilities\AssemblyNameFormatter.cs</Link>
    </Compile>
    <Compile Include="$(LibrariesProjectRoot)\Common\src\System\Reflection\AssemblyNameParser.cs">
    <Link>Utilities\AssemblyNameParser.cs</Link>
    </Compile>
    <Compile Include="$(LibrariesProjectRoot)\Common\src\System\Reflection\Metadata\AssemblyNameInfo.cs">
    <Link>Utilities\AssemblyNameInfo.cs</Link>
    </Compile>
    <Compile Include="$(LibrariesProjectRoot)\Common\src\System\Reflection\Metadata\TypeName.cs">
    <Link>Utilities\TypeName.cs</Link>
    </Compile>
    <Compile Include="$(LibrariesProjectRoot)\Common\src\System\Reflection\Metadata\TypeNameParser.cs">
    <Link>Utilities\TypeNameParser.cs</Link>
    </Compile>
    <Compile Include="$(LibrariesProjectRoot)\Common\src\System\Reflection\Metadata\TypeNameParserHelpers.cs">
    <Link>Utilities\TypeNameParserHelpers.cs</Link>
    </Compile>
    <Compile Include="$(LibrariesProjectRoot)\Common\src\System\Reflection\Metadata\TypeNameParserOptions.cs">
    <Link>Utilities\TypeNameParserOptions.cs</Link>
    </Compile>

    runtime/src/coreclr/tools/aot/ILCompiler.TypeSystem/ILCompiler.TypeSystem.csproj

    Lines 231 to 233 in 127844c

    <Compile Include="$(LibrariesProjectRoot)\Common\src\System\Text\ValueStringBuilder.AppendSpanFormattable.cs">
    <Link>Utilities\ValueStringBuilder.AppendSpanFormattable.cs</Link>
    </Compile>
  3. Move all the files from src/libraries/Common/src/System/Reflection/Metadata/*.cs to src/libraries/System.Reflection.Metadata/src/System/Reflection/Metadata/
  4. Remove #nullable enable from following files:

    runtime/src/libraries/Common/src/System/Reflection/AssemblyNameFormatter.cs

    Line 9 in 127844c

    #nullable enable

    runtime/src/libraries/Common/src/System/Reflection/AssemblyNameParser.cs

    Line 11 in 127844c

    #nullable enable

    runtime/src/libraries/Common/src/System/Reflection/Metadata/AssemblyNameInfo.cs

    Line 4 in 127844c

    #nullable enable

    runtime/src/libraries/Common/src/System/Reflection/Metadata/TypeName.cs

    Line 4 in 127844c

    #nullable enable

    runtime/src/libraries/Common/src/System/Reflection/Metadata/TypeNameParser.cs

    Line 13 in 127844c

    #nullable enable

    runtime/src/libraries/Common/src/System/Reflection/Metadata/TypeNameParserHelpers.cs

    Line 10 in 127844c

    #nullable enable

    runtime/src/libraries/Common/src/System/Text/ValueStringBuilder.AppendSpanFormattable.cs

    Line 4 in d0dffe1

    #nullable enable

    runtime/src/libraries/System.Private.CoreLib/src/System/Diagnostics/CodeAnalysis/UnconditionalSuppressMessageAttribute.cs

    Line 4 in d0dffe1

    #nullable enable
  5. Change the #if to public for SYSTEM_REFLECTION_METADATA, otherwise internal (https://github.com/dotnet/runtime/pull/100094/files#r1577334880)

    runtime/src/libraries/Common/src/System/Reflection/Metadata/AssemblyNameInfo.cs

    Lines 24 to 28 in 127844c

    #if SYSTEM_PRIVATE_CORELIB
    internal
    #else
    public
    #endif

    runtime/src/libraries/Common/src/System/Reflection/Metadata/TypeName.cs

    Lines 19 to 23 in 127844c

    #if SYSTEM_PRIVATE_CORELIB
    internal
    #else
    public
    #endif

    runtime/src/libraries/Common/src/System/Reflection/Metadata/TypeNameParserOptions.cs

    Lines 6 to 10 in d0dffe1

    #if SYSTEM_PRIVATE_CORELIB
    internal
    #else
    public
    #endif
  6. Remove #pragma warning disable RS003

    runtime/src/libraries/Common/src/System/Reflection/Metadata/AssemblyNameInfo.cs

    Line 159 in 127844c

    #pragma warning disable RS0030 // TypeSystem does not allow System.Linq, but we need to use System.Linq.ImmutableArrayExtensions.ToArray
  7. Simpify throw helpers by removing unused #if/else/elif blocks:

    runtime/src/libraries/Common/src/System/Reflection/Metadata/AssemblyNameInfo.cs

    Lines 187 to 189 in 127844c

    #else // tools that reference this file as a link
    : throw new ArgumentException("The given assembly name was invalid.", nameof(assemblyName));
    #endif

    runtime/src/libraries/Common/src/System/Reflection/Metadata/TypeNameParserHelpers.cs

    Lines 347 to 349 in 127844c

    #else // tools that reference this file as a link
    new ArgumentException();
    #endif

    runtime/src/libraries/Common/src/System/Reflection/Metadata/TypeNameParserHelpers.cs

    Lines 355 to 357 in 127844c

    #else // tools that reference this file as a link
    new InvalidOperationException();
    #endif

    runtime/src/libraries/Common/src/System/Reflection/Metadata/TypeNameParserHelpers.cs

    Lines 379 to 381 in 127844c

    #else // tools that reference this file as a link
    new InvalidOperationException();
    #endif
  8. Update comments (remove the tools mentions):

    runtime/src/libraries/Common/src/System/Reflection/Metadata/TypeNameParserHelpers.cs

    Line 337 in 127844c

    #else // corelib and tools that reference this file as a link

    runtime/src/libraries/Common/src/System/Reflection/Metadata/TypeNameParserHelpers.cs

    Line 363 in 127844c

    #else // corelib and tools that reference this file as a link

    runtime/src/libraries/Common/src/System/Reflection/Metadata/TypeNameParserHelpers.cs

    Line 371 in 127844c

    #else // corelib and tools that reference this file as a link

cc @jkotas
@adamsitnik adamsitnik added the area-Tools-ILVerification Issues related to ilverify tool and IL verification in general label Apr 25, 2024
@adamsitnik adamsitnik added this to the 9.0.0 milestone Apr 25, 2024
@adamsitnik adamsitnik self-assigned this Apr 25, 2024
@adamsitnik adamsitnik mentioned this issue Apr 25, 2024
Merged
jkotas added a commit to jkotas/runtime that referenced this issue Apr 28, 2024
@jkotas
Change S.R.M.TypeName to be visible from System.Reflection.Metadata only
1659a7a 
Contributes to dotnet#101541

Fixes dotnet#101628
@jkotas jkotas mentioned this issue Apr 28, 2024
Merged
jkotas added a commit to jkotas/runtime that referenced this issue Apr 28, 2024
@jkotas
Change S.R.M.TypeName to be visible from System.Reflection.Metadata only
cf51ee1 
Contributes to dotnet#101541

Fixes dotnet#101628
jkotas added a commit to jkotas/runtime that referenced this issue Apr 28, 2024
@jkotas
Change S.R.M.TypeName to be consumed from System.Reflection.Metadata …
25eae15 
…package

Contributes to dotnet#101541

Fixes dotnet#101628

Better unreachable code elimination in CoreLib
jkotas added a commit to jkotas/runtime that referenced this issue Apr 28, 2024
@jkotas
Change S.R.M.TypeName to be consumed from System.Reflection.Metadata …
5c6a76d 
…package

Contributes to dotnet#101541

Fixes dotnet#101628

Better unreachable code elimination in CoreLib
jkotas added a commit to jkotas/runtime that referenced this issue Apr 29, 2024
@jkotas
Change S.R.M.TypeName to be consumed from System.Reflection.Metadata …
70524b5 
…package

Contributes to dotnet#101541

Fixes dotnet#101628

Better unreachable code elimination in CoreLib
jkotas added a commit that referenced this issue Apr 29, 2024
@jkotas
Change S.R.M.TypeName to be consumed from System.Reflection.Metadata …
7745b5e 
…package (#101666)

Contributes to #101541

Fixes #101628
matouskozak pushed a commit to matouskozak/runtime that referenced this issue Apr 30, 2024
@jkotas @matouskozak
Change S.R.M.TypeName to be consumed from System.Reflection.Metadata …
f6a5bd5 
…package (dotnet#101666)

Contributes to dotnet#101541

Fixes dotnet#101628
@adamsitnik adamsitnik mentioned this issue May 6, 2024
Merged
michaelgsharp pushed a commit to michaelgsharp/runtime that referenced this issue May 9, 2024
@jkotas @michaelgsharp
Change S.R.M.TypeName to be consumed from System.Reflection.Metadata …
a95770a 
…package (dotnet#101666)

Contributes to dotnet#101541

Fixes dotnet#101628
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@adamsitnik adamsitnik

Labels
area-Tools-ILVerification Issues related to ilverify tool and IL verification in general
Projects
None yet
Milestone
9.0.0
Development

Successfully merging a pull request may close this issue.

Finish the TypeName cleanup adamsitnik/runtime
1 participant
@adamsitnik