dotnet/runtime

Simplify JIT-EE interface modification

Open

#76,184 opened on Sep 26, 2022

View on GitHub
 (3 comments) (0 reactions) (0 assignees)C# (5,445 forks)batch import
area-CodeGen-coreclrhelp wanted

Repository metrics

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

Description

Despite the fact it was partially automated in the past it's still quite exhausting to add new APIs, I propose to address at least these issues:

  • Autogenerate corinfo.h (e.g. introduce corinfo_generated.h) part from ThunkInput.txt - we can move comments to ThunkInput.txt
  • Autogenerate superpmi-shim-simple\icorjitinfo.cpp
  • Autogenerate superpmi-shim-collector\icorjitinfo.cpp
  • Append _generated.h to all auto-generated files (currently there are still like 5 or 6 auto-generated files without them - it helps to ignore them when adding a new API) - https://github.com/dotnet/runtime/pull/77083
  • gen.bat emits two new-lines in the end of CorInfoBase.cs breaking compilation - https://github.com/dotnet/runtime/pull/77083
  • Ensure gen.bat is no-op on unchanged codebase on CI

category:cq theme:jit-ee-interface skill-level:beginner cost:small impact:small

Contributor guide

Research direction
Analyze the gen.bat script and ThunkInput.txt to understand the current manual process of adding new APIs, then design automated generation for the listed files.
Tech stack
csharp
Domain
backendbuild system
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
C#Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75