Add native library sample (#6645)

* fix nit in StaticLibrary test (#4987)
* add README documentation on building native libraries (#4987)
* Move documentation for building native libraries to samples
* Fix static library build
* Add sources for NativeLibrary sample

Documentation/how-to-build-and-run-ilcompiler-in-console-shell-prompt.md

@@ -75,7 +75,7 @@ From the shell/command prompt, issue the following commands to generate the nati
 
 For CoreRT debug build on Windows, add an extra `/p:AdditionalCppCompilerFlags=/MTd` argument.
 
-## Disabling Native Compilation 
+## Disabling Native Compilation ##
 
 Native compilation can be disabled during publishing by adding an extra `/p:NativeCompilationDuringPublish=false` argument.
 

README.md

@@ -3,7 +3,7 @@ This repo contains the .NET Core runtime optimized for ahead of time compilation
 
 ## Try Our Samples
 
-If you would like to give CoreRT a try, we publish daily snapshots of CoreRT to MyGet. Using CoreRT is as simple as adding a new package reference to your .NET Core project and publishing it. Check out one of our samples: a "[Hello World](samples/HelloWorld)" console app, a simple [ASP.NET Core](samples/WebApi/) app, or a [MonoGame](samples/MonoGame/) game. The `README.md` file in each sample's directory will guide you through the process step by step.
+If you would like to give CoreRT a try, we publish daily snapshots of CoreRT to MyGet. Using CoreRT is as simple as adding a new package reference to your .NET Core project and publishing it. Check out one of our samples: a "[Hello World](samples/HelloWorld)" console app, a simple [ASP.NET Core](samples/WebApi/) app, a [MonoGame](samples/MonoGame/) game or a [native library](samples/NativeLibrary). The `README.md` file in each sample's directory will guide you through the process step by step.
 
 ## Platform Support
 

samples/NativeLibrary/Class1.cs

@@ -0,0 +1,18 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for more information.
+
+using System;
+using System.Runtime.InteropServices;
+
+namespace NativeLibrary
+{
+    public class Class1
+    {
+        [NativeCallable(EntryPoint = "add", CallingConvention = CallingConvention.StdCall)]
+        public static int Add(int a, int b)
+        {
+            return a + b;
+        }
+    }
+}

samples/NativeLibrary/NativeCallable.cs

@@ -0,0 +1,14 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for more information.
+
+namespace System.Runtime.InteropServices
+{
+    [AttributeUsage(AttributeTargets.Method)]
+    public sealed class NativeCallableAttribute : Attribute
+    {
+        public string EntryPoint;
+        public CallingConvention CallingConvention;
+        public NativeCallableAttribute() { }
+    }
+}

samples/NativeLibrary/NativeLibrary.csproj

@@ -0,0 +1,11 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFramework>netstandard2.0</TargetFramework>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Microsoft.DotNet.ILCompiler" Version="1.0.0-alpha-*" />
+  </ItemGroup>
+
+</Project>

samples/NativeLibrary/README.md

@@ -0,0 +1,54 @@
+# Building Native Libraries with CoreRT
+
+This document will guide you through building native libraries that can be consumed by other programming languages with CoreRT. CoreRT can build static libraries that can be linked at compile time or shared libraries that are required at runtime.
+
+## Create .NET Core Class Library project with CoreRT support
+
+Create a .NET Core class library project using `dotnet new console -o NativeLibrary` and follow the [Hello world](../HelloWorld/README.md) sample instruction to add CoreRT support to it. 
+
+## Building static libraries
+
+```bash
+> dotnet publish /p:NativeLib=Static -r <RID> -c <Configuration>
+```
+
+where `<Configuration>` is your project configuration (such as Debug or Release) and `<RID>` is the runtime identifier (one of win-x64, linux-x64, osx-x64). For example, if you want to publish a release configuration of your library for a 64-bit version of Windows the command would look like:
+
+```bash 
+> dotnet publish /p:NativeLib=Static -r win-x64 -c release
+```
+
+The above command will drop a static library (Windows `.lib`, OSX/Linux `.a`) in `./bin/[configuration]/netstandard2.0/[RID]/publish/` folder and will have the same name as the folder in which your source file is present.
+
+## Building shared libraries
+
+```bash
+> dotnet publish /p:NativeLib=Shared -r <RID> -c <Configuration>
+```
+
+The above command will drop a shared library (Windows `.dll`, OSX `.dylib`, Linux `.so`) in `./bin/[configuration]/netstandard2.0/[RID]/publish/` folder and will have the same name as the folder in which your source file is present. Building shared libraries on Linux is currently non-functional, see [#4988](https://github.com/dotnet/corert/issues/4988).
+
+## Exporting methods
+
+For a C# method in the native library to be consumable by external programs, it has to be explicitly exported using the `[NativeCallable]` attribute. First define the `NativeCallable` class in your project, see [here](https://github.com/dotnet/corert/blob/master/tests/src/Simple/SharedLibrary/NativeCallable.cs). The local definition of the `NativeCallable` is a temporary workaround that will go away once the attribute is added to the official .NET Core public surface.
+
+Next, apply the attribute to the method, specifying the `EntryPoint` and `CallingConvention` properties:
+
+```csharp
+[NativeCallable(EntryPoint = "add", CallingConvention = CallingConvention.StdCall)]
+public static int Add(int a, int b)
+{
+    return a + b;
+}
+```
+
+After the native library library is built, the above C# `Add` method will be exported as a native `add` function to consumers of the library. Here are some limitations to consider when deciding what managed method to export:
+
+* Exported methods have to be static.
+* Exported methods can only naturally accept or return primitives or value types (i.e structs), they have to marshal all reference type arguments.
+* Exported methods cannot be called from regular managed C# code, an exception will be thrown.
+* Exported methods cannot use regular C# exception handling, they should return error codes instead.
+
+## References
+
+Real-world example of using CoreRT and Rust: https://medium.com/@chyyran/calling-c-natively-from-rust-1f92c506289d

src/BuildIntegration/Microsoft.NETCore.Native.Publish.targets

@@ -77,7 +77,7 @@
 
   </Target>
 
-  <Target Name="CopyNativePdb" Condition="'$(DebugType)' != 'None' and '$(TargetOS)' == 'Windows_NT'" AfterTargets="Publish">
+  <Target Name="CopyNativePdb" Condition="'$(DebugType)' != 'None' and '$(TargetOS)' == 'Windows_NT' and $(NativeLib) != 'Static'" AfterTargets="Publish">
     <!-- dotnet CLI produces managed debug symbols - substitute with those we generated during native compilation -->
     <Delete Files="$(PublishDir)\$(TargetName).pdb"/>    
     <Copy SourceFiles="$(NativeOutputPath)$(TargetName).pdb" DestinationFolder="$(PublishDir)" />  

tests/src/Simple/StaticLibrary/StaticLibrary.csproj

@@ -44,8 +44,8 @@
     </ItemGroup>
 
     <Exec Command="$(CppCompiler) @(NativeRunnerCompilerArg, ' ') $(NativeBinary) @(NativeRunnerLinkerArg, ' ')" Condition="'$(OS)' != 'Windows_NT'" />
-    <WriteLinesToFile File="$(NativeIntermediateOutputPath)SharedLibrary.cl.rsp" Lines="@(NativeRunnerCompilerArg)" Overwrite="true"  Condition="'$(OS)' == 'Windows_NT'"/>
-    <Exec Command="$(CppCompiler) @&quot;$(NativeIntermediateOutputPath)SharedLibrary.cl.rsp&quot;" Condition="'$(OS)' == 'Windows_NT'" />
+    <WriteLinesToFile File="$(NativeIntermediateOutputPath)StaticLibrary.cl.rsp" Lines="@(NativeRunnerCompilerArg)" Overwrite="true"  Condition="'$(OS)' == 'Windows_NT'"/>
+    <Exec Command="$(CppCompiler) @&quot;$(NativeIntermediateOutputPath)StaticLibrary.cl.rsp&quot;" Condition="'$(OS)' == 'Windows_NT'" />
   </Target>
 
   <Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory), SimpleTest.targets))\SimpleTest.targets" />