dotnet/runtime

[ILVerify]Add '--tokens' switch

Open

#37,395 opened on Dec 18, 2018

View on GitHub
 (0 comments) (0 reactions) (0 assignees)C# (5,445 forks)batch import
Priority:3area-Tools-ILVerificationhelp wanted

Repository metrics

Stars
 (17,886 stars)
PR merge metrics
 (Avg merge 12d 11h) (661 merged PRs in 30d)

Description

Today when ILVerify found issue we report tokens/offsets value for type system item for IL methods i.e.

[IL]: Error: [C:\git\corert\bin\Windows_NT.x64.Debug\ILVerification.Tests\Tests\BranchingTests.dll : BranchingTestsType::Branching.FromTryIntoFinally_Invalid_BranchOutOfTry.BranchIntoHandler()][offset 0x00000004] Branch out of try block.

We added some new type check and we decided to not report token value for it because they are not useful for regular use i.e.

[MD]: Error: Interface implementation has a duplicate. Class '[InterfaceImplementation]InterfaceImplHasDuplicate_InvalidType_InterfaceImplHasDuplicate' Interface: '[InterfaceDefinition]Interface'

However there are some scenario where tokens are useful, for instance on obfuscated code. We should refactor code to have token values only if a user pass '--tokens' switch to command line. Reference https://github.com/dotnet/corert/pull/6687#discussion_r241916514

Task list:

Extra: cleanup code https://github.com/dotnet/corert/pull/6758#discussion_r248405930

Contributor guide

Research direction
Examine existing command line switches in ILVerify (e.g., reference PR #6730). Add a ' tokens' option to the command line parser. Then include metadata tokens in error messages conditionally based on the switch, moving the error message logic from the driver to the IL importer as specified in the task list.
Tech stack
csharp
Domain
cli
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Command line parsingC#
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70