Merge pull request #2709 from dotnet/arobins/func1331

Add readme and some fixes.

Author: janvorli

README.md

@@ -1,74 +1,45 @@
-# .NET Runtime
+# CoreCLR Interpreter
 
-[![Build Status](https://dev.azure.com/dnceng-public/public/_apis/build/status/dotnet/runtime/runtime?branchName=main)](https://dev.azure.com/dnceng-public/public/_build/latest?definitionId=129&branchName=main)
-[![Help Wanted](https://img.shields.io/github/issues/dotnet/runtime/help%20wanted?style=flat-square&color=%232EA043&label=help%20wanted)](https://github.com/dotnet/runtime/labels/help%20wanted)
-[![Good First Issue](https://img.shields.io/github/issues/dotnet/runtime/good%20first%20issue?style=flat-square&color=%232EA043&label=good%20first%20issue)](https://github.com/dotnet/runtime/labels/good%20first%20issue)
-[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/dotnet/runtime)
-[![Discord](https://img.shields.io/discord/732297728826277939?style=flat-square&label=Discord&logo=discord&logoColor=white&color=7289DA)](https://aka.ms/dotnet-discord)
+See official dotnet/runtime [README.md](https://github.com/dotnet/runtime/blob/main/README.md).
 
-* [What is .NET?](#what-is-net)
-* [How can I contribute?](#how-can-i-contribute)
-* [Reporting security issues and security bugs](#reporting-security-issues-and-security-bugs)
-* [Filing issues](#filing-issues)
-* [Useful Links](#useful-links)
-* [.NET Foundation](#net-foundation)
-* [License](#license)
+## Build
 
-This repo contains the code to build the .NET runtime, libraries and shared host (`dotnet`) installers for
-all supported platforms, as well as the sources to .NET runtime and libraries.
+Pass the following flags to the `build.cmd` or `build.sh` file depending on the target platform:
 
-## What is .NET?
+> `-s clr+libs+clr.hosts -lc Release -rc Debug`
 
-Official Starting Page: <https://dotnet.microsoft.com>
+Construct the `CORE_ROOT` environment, including the `corerun` testing binary:
 
-* [How to use .NET](https://learn.microsoft.com/dotnet/core/get-started) (with VS, VS Code, command-line CLI)
-  * [Install official releases](https://dotnet.microsoft.com/download)
-  * [Documentation](https://learn.microsoft.com/dotnet/core) (Get Started, Tutorials, Porting from .NET Framework, API reference, ...)
-    * [Deploying apps](https://learn.microsoft.com/dotnet/core/deploying)
-* [Support](https://github.com/dotnet/core/blob/main/support.md) (Releases, OS Versions, ...)
-* [Roadmap](https://github.com/dotnet/core/blob/main/roadmap.md)
+Windows:
 
-## How can I contribute?
+> `src\tests\build.cmd x64 Debug CoreCLR GenerateLayoutOnly /p:LibrariesConfiguration=Release`
 
-We welcome contributions! Many people all over the world have helped make this project better.
+Linux/macOS:
 
-* [Contributing](CONTRIBUTING.md) explains what kinds of contributions we welcome
-* [Workflow Instructions](docs/workflow/README.md) explains how to build and test
-* [Dogfooding .NET](docs/project/dogfooding.md) explains how to get nightly builds of the runtime and its libraries to test them in your own projects.
+> `./src/tests/build.sh arm64 Debug CoreCLR GenerateLayoutOnly -p:LibrariesConfiguration=Release`
 
-## Reporting security issues and security bugs
+## Running
 
-Security issues and bugs should be reported privately, via email, to the Microsoft Security Response Center (MSRC) <secure@microsoft.com>. You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Further information, including the MSRC PGP key, can be found in the [Security TechCenter](https://www.microsoft.com/msrc/faqs-report-an-issue). You can also find these instructions in this repo's [Security doc](SECURITY.md).
+The `corerun` binary accepts a `dotenv` file format. The following environment variables are recommended to run the interpreter.
 
-Also see info about related [Microsoft .NET Bounty Program](https://www.microsoft.com/msrc/bounty-dot-net-core).
+The following environment variables can be pasted into a file and passed to the `corerun` binary using the `-e` flag.
 
-## Filing issues
+```
+DOTNET_TieredCompilation=0
+DOTNET_ReadyToRun=0
+DOTNET_InterpreterDoLoopMethods=1
+DOTNET_InterpreterFallback=0
+DOTNET_ForceInterpreter=1
+DOTNET_InterpreterUseCaching=0
+DOTNET_InterpreterHWIntrinsicsIsSupportedFalse=1
+```
 
-This repo should contain issues that are tied to the runtime, the class libraries and frameworks, the installation of the `dotnet` binary (sometimes known as the `muxer`) and the installation of the .NET runtime and libraries.
+The following are helpful in debugging hangs and the "current state" of the interpreter.
 
-For other issues, please file them to their appropriate sibling repos. We have links to many of them on [our new issue page](https://github.com/dotnet/runtime/issues/new/choose).
+```
+DOTNET_TraceInterpreterEntries=1
+DOTNET_TraceInterpreterIL=1
+```
 
-## Useful Links
-
-* [.NET source index](https://source.dot.net) / [.NET Framework source index](https://referencesource.microsoft.com)
-* [API Reference docs](https://learn.microsoft.com/dotnet/api)
-* [.NET API Catalog](https://apisof.net) (incl. APIs from daily builds and API usage info)
-* [API docs writing guidelines](https://github.com/dotnet/dotnet-api-docs/wiki) - useful when writing /// comments
-* [.NET Discord Server](https://aka.ms/dotnet-discord) - a place to discuss the development of .NET and its ecosystem
-
-## .NET Foundation
-
-.NET Runtime is a [.NET Foundation](https://www.dotnetfoundation.org/projects) project.
-
-There are many .NET related projects on GitHub.
-
-* [.NET home repo](https://github.com/Microsoft/dotnet) - links to 100s of .NET projects, from Microsoft and the community.
-* [ASP.NET Core home](https://learn.microsoft.com/aspnet/core) - the best place to start learning about ASP.NET Core.
-
-This project has adopted the code of conduct defined by the [Contributor Covenant](https://contributor-covenant.org) to clarify expected behavior in our community. For more information, see the [.NET Foundation Code of Conduct](https://www.dotnetfoundation.org/code-of-conduct).
-
-General .NET OSS discussions: [.NET Foundation Discussions](https://github.com/dotnet-foundation/Home/discussions)
-
-## License
-
-.NET (including the runtime repo) is licensed under the [MIT](LICENSE.TXT) license.
+Many verification steps assume the following is disabled.
+`DOTNET_InterpreterLooseRules=0`

src/coreclr/clrfeatures.cmake

@@ -17,7 +17,7 @@ if(NOT DEFINED FEATURE_DBGIPC)
 endif(NOT DEFINED FEATURE_DBGIPC)
 
 if(NOT DEFINED FEATURE_INTERPRETER)
-  set(FEATURE_INTERPRETER 0)
+  set(FEATURE_INTERPRETER 1)
 endif(NOT DEFINED FEATURE_INTERPRETER)
 
 if(NOT DEFINED FEATURE_STANDALONE_GC)

src/coreclr/vm/interpreter.cpp

@@ -753,12 +753,12 @@ CorJitResult Interpreter::GenerateInterpreterStub(CEEInfo* comp,
     {
         const char* clsName;
         const char* methName = getMethodName(comp, info->ftn, &clsName);
-        if (   !s_InterpretMeths.contains(methName, clsName, info->args.pSig)
-            || s_InterpretMethsExclude.contains(methName, clsName, info->args.pSig))
-        {
-            TRACE_SKIPPED(clsName, methName, "not in set of methods to interpret");
-            return CORJIT_SKIPPED;
-        }
+        // if (   !s_InterpretMeths.contains(methName, clsName, info->args.pSig)
+        //     || s_InterpretMethsExclude.contains(methName, clsName, info->args.pSig))
+        // {
+        //     TRACE_SKIPPED(clsName, methName, "not in set of methods to interpret");
+        //     return CORJIT_SKIPPED;
+        // }
 
         unsigned methHash = comp->getMethodHash(info->ftn);
         if (   methHash < s_InterpretMethHashMin.val(CLRConfig::INTERNAL_InterpreterMethHashMin)
@@ -9304,16 +9304,18 @@ void Interpreter::DoCallWork(bool virtualCall, void* thisArg, CORINFO_RESOLVED_T
             const char* className = NULL;
             const char* methodName = getMethodName(&m_interpCeeInfo, (CORINFO_METHOD_HANDLE)methToCall, &className, &namespaceName);
             if (
-                (strcmp(namespaceName, "System.Runtime.Intrinsics") == 0 ||
+                (strcmp(namespaceName, "System.Runtime.Intrinsics") == 0
 #if defined(TARGET_X86) || defined(TARGET_AMD64)
-                strcmp(namespaceName, "System.Runtime.Intrinsics.X86") == 0
+                    || strcmp(namespaceName, "System.Runtime.Intrinsics.X86") == 0
 #elif defined(TARGET_ARM64)
-                strcmp(namespaceName, "System.Runtime.Intrinsics.Arm") == 0
-#else
-                0
+                    || strcmp(namespaceName, "System.Runtime.Intrinsics.Arm") == 0
 #endif
-                ) &&
-                strcmp(methodName, "get_IsSupported") == 0
+                    || (strcmp(namespaceName, "") == 0
+                        && (strcmp(className, "V512") == 0
+                            || strcmp(className, "VL") == 0
+                            || strcmp(className, "X64") == 0))
+                )
+                && strcmp(methodName, "get_IsSupported") == 0
             )
             {
                 GCX_COOP();
@@ -10533,21 +10535,15 @@ void Interpreter::CallI()
             {
                 pMD = CoreLibBinder::GetMethod(METHOD__INTERLOCKED__COMPARE_EXCHANGE_OBJECT);  // A random static method.
             }
+
             MethodDescCallSite mdcs(pMD, &mSig, ftnPtr);
-#if 0
+
             // If the current method being interpreted is an IL stub, we're calling native code, so
             // change the GC mode.  (We'll only do this at the call if the calling convention turns out
             // to be a managed calling convention.)
             MethodDesc* pStubContextMD = reinterpret_cast<MethodDesc*>(m_stubContext);
             bool transitionToPreemptive = (pStubContextMD != NULL && !pStubContextMD->IsIL());
             mdcs.CallTargetWorker(args, &retVal, sizeof(retVal), transitionToPreemptive);
-#else
-            // TODO The code above triggers assertion at threads.cpp:6861:
-            //     _ASSERTE(thread->PreemptiveGCDisabled());  // Should have been in managed code
-            // The workaround will likely break more things than what it is fixing:
-            // just do not make transition to preemptive GC for now.
-            mdcs.CallTargetWorker(args, &retVal, sizeof(retVal));
-#endif
         }
         // retVal is now vulnerable.
         GCX_FORBID();