QIR Command Line Tool - Automatically Use Required Resources

src/Qir/Execution/QirCommandLineTool/Program.cs

@@ -43,9 +43,7 @@ private static Command CreateBuildCommand()
             var buildCommand = new Command("build", "(default) Build the executables from a QIR DLL.")
             {
                 Handler = CommandHandler.Create((BuildOptions settings) =>
-                {
-                    return QirTools.BuildFromQSharpDll(settings.QSharpDll, settings.LibraryDirectories, settings.IncludeDirectories, settings.ExecutablesDirectory);
-                })
+                    QirTools.BuildFromQSharpDll(settings.QSharpDll, settings.LibraryDirectories, settings.IncludeDirectories, settings.ExecutablesDirectory))
             };
             buildCommand.TreatUnmatchedTokensAsErrors = true;
 

src/Qir/Execution/QirCommandLineTool/QirCommandLineTool.csproj

@@ -1,15 +1,14 @@
-<Project Sdk="Microsoft.NET.Sdk">
-
+<Project Sdk="Microsoft.NET.Sdk">
+    
   <PropertyGroup>
     <OutputType>Exe</OutputType>
     <TargetFramework>netcoreapp3.1</TargetFramework>
     <PackAsTool>true</PackAsTool>
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="System.CommandLine" Version="2.0.0-beta1.20213.1" />
-    <ProjectReference Include="..\..\..\Simulation\Simulators\Microsoft.Quantum.Simulators.csproj" />
-    <ProjectReference Include="..\Tools\Microsoft.Quantum.Qir.Tools.csproj" />
+    <PackageReference Include="System.CommandLine" Version="2.0.0-beta1.20213.1"/>
+    <ProjectReference Include="..\Tools\Microsoft.Quantum.Qir.Tools.csproj"/>
   </ItemGroup>
 
 </Project>

src/Qir/Execution/Tests.Microsoft.Quantum.Qir.Tools/QirExecutableTests.cs

@@ -4,6 +4,7 @@
 using System;
 using System.Collections.Generic;
 using System.IO;
+using System.Linq;
 using System.Threading.Tasks;
 using Microsoft.Quantum.Qir.Serialization;
 using Microsoft.Quantum.Qir.Tools.Driver;
@@ -27,6 +28,8 @@ public class QirExecutableTests : IDisposable
         private readonly FileInfo executableFile;
         private readonly byte[] qirBytecode = { 1, 2, 3, 4, 5 };
         private readonly IList<string> linkLibraries;
+        private readonly IList<DirectoryInfo> headerDirectories;
+        private readonly IList<DirectoryInfo> libraryDirectories;
 
         public QirExecutableTests()
         {
@@ -46,9 +49,13 @@ public QirExecutableTests()
             runnerMock = new Mock<IQuantumExecutableRunner>();
             qirExecutable = new Mock<QirExecutable>(executableFile, qirBytecode, Mock.Of<ILogger>(), driverGeneratorMock.Object, executableGeneratorMock.Object, runnerMock.Object) { CallBase = true };
             linkLibraries = new List<string> { "lib1", "lib2" };
+            headerDirectories = new List<DirectoryInfo>();
+            libraryDirectories = new List<DirectoryInfo>();
             qirExecutable.SetupGet(obj => obj.LinkLibraries).Returns(linkLibraries);
             qirExecutable.SetupGet(obj => obj.SourceDirectoryPath).Returns(sourceDirectory.FullName);
             qirExecutable.SetupGet(obj => obj.DriverFileExtension).Returns(".cpp");
+            qirExecutable.SetupGet(obj => obj.HeaderDirectories).Returns(headerDirectories);
+            qirExecutable.SetupGet(obj => obj.LibraryDirectories).Returns(libraryDirectories);
         }
 
         public void Dispose()

src/Qir/Execution/Tools/Executable/QirExecutable.cs

@@ -3,6 +3,7 @@
 
 using System.Collections.Generic;
 using System.IO;
+using System.Linq;
 using System.Threading.Tasks;
 using Microsoft.Quantum.Qir.Serialization;
 using Microsoft.Quantum.Qir.Tools.Driver;
@@ -20,6 +21,9 @@ public abstract class QirExecutable : IQirExecutable
 
         public virtual string SourceDirectoryPath => "src";
         public abstract string DriverFileExtension { get; }
+        public abstract IList<string> LinkLibraries { get; }
+        public abstract IList<DirectoryInfo> HeaderDirectories { get; }
+        public abstract IList<DirectoryInfo> LibraryDirectories { get; }
 
         protected FileInfo ExecutableFile { get; }
 
@@ -76,16 +80,13 @@ public async Task BuildAsync(EntryPointOperation entryPoint, IList<DirectoryInfo
                 await bytecodeFileStream.WriteAsync(qirBytecode);
             }
             logger.LogInfo($"Created bytecode file at {bytecodeFile.FullName}.");
-
-            await executableGenerator.GenerateExecutableAsync(ExecutableFile, sourceDirectory, libraryDirectories, includeDirectories, LinkLibraries);
+            await executableGenerator.GenerateExecutableAsync(ExecutableFile, sourceDirectory, libraryDirectories.Concat(this.LibraryDirectories).ToList(), includeDirectories.Concat(this.HeaderDirectories).ToList(), LinkLibraries);
         }
 
         public async Task RunAsync(ExecutionInformation executionInformation, Stream output)
         {
             var stringArguments = driverGenerator.GetCommandLineArguments(executionInformation);
             await runner.RunExecutableAsync(ExecutableFile, output, stringArguments);
         }
-
-        public abstract IList<string> LinkLibraries { get; }
     }
 }

src/Qir/Execution/Tools/Executable/QirExecutableGenerator.cs

@@ -1,6 +1,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
+using System;
 using System.Collections.Generic;
 using System.IO;
 using System.Linq;
@@ -32,13 +33,40 @@ await Task.Run(async () =>
                 // Copy all library contents to bin.
                 logger?.LogInfo("Copying library directories into the executable's folder.");
 
+                if (!sourceDirectory.Exists)
+                {
+                    logger?.LogWarning($"Cannot find source directory: {sourceDirectory.FullName}");
+                }
+
+                var libDirs = new List<string>();
                 foreach (var dir in libraryDirectories)
                 {
-                    CopyDirectoryContents(dir, binDirectory);
+                    if (!dir.Exists)
+                    {
+                        logger?.LogWarning($"Cannot find given directory: {dir.FullName}");
+                    }
+                    else
+                    {
+                        CopyDirectoryContents(dir, binDirectory);
+                        libDirs.Add(dir.FullName);
+                    }
+                }
+
+                var includeDirs = new List<string>();
+                foreach (var dir in includeDirectories)
+                {
+                    if (!dir.Exists)
+                    {
+                        logger?.LogWarning($"Could not find given directory: {dir.FullName}");
+                    }
+                    else
+                    {
+                        includeDirs.Add(dir.FullName);
+                    }
                 }
 
                 var inputFiles = sourceDirectory.GetFiles().Select(fileInfo => fileInfo.FullName).ToArray();
-                await clangClient.CreateExecutableAsync(inputFiles, linkLibraries.ToArray(), libraryDirectories.Select(dir => dir.FullName).ToArray(), includeDirectories.Select(dir => dir.FullName).ToArray(), executableFile.FullName);
+                await clangClient.CreateExecutableAsync(inputFiles, linkLibraries.ToArray(), libDirs.ToArray(), includeDirs.ToArray(), executableFile.FullName);
             });
         }
 

src/Qir/Execution/Tools/Executable/QirFullStateExecutable.cs

@@ -1,8 +1,11 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
+using System;
 using System.Collections.Generic;
 using System.IO;
+using System.Reflection;
+using System.Runtime.InteropServices;
 using Microsoft.Quantum.Qir.Tools.Driver;
 using Microsoft.Quantum.Qir.Utility;
 
@@ -13,20 +16,40 @@ namespace Microsoft.Quantum.Qir.Tools.Executable
     /// </summary>
     public class QirFullStateExecutable : QirExecutable
     {
+        public override string DriverFileExtension => "cpp";
+
+        public override IList<string> LinkLibraries => new List<string> {
+                "Microsoft.Quantum.Qir.Runtime",
+                "Microsoft.Quantum.Qir.QSharp.Foundation",
+                "Microsoft.Quantum.Qir.QSharp.Core"
+            };
+
+        public override IList<DirectoryInfo> HeaderDirectories { get; } = new List<DirectoryInfo>();
+
+        public override IList<DirectoryInfo> LibraryDirectories { get; } = new List<DirectoryInfo>();
+
         public QirFullStateExecutable(FileInfo executableFile, byte[] qirBytecode, ILogger logger = null)
             : base(executableFile,
                   qirBytecode,
                   new QirFullStateDriverGenerator(),
                   logger)
         {
-        }
+            var thisModulePath = Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location);
+            if (string.IsNullOrWhiteSpace(thisModulePath))
+            {
+                throw new InvalidOperationException("Could not get a path for the current assembly location.");
+            }
+            HeaderDirectories.Add(new DirectoryInfo(Path.Combine(thisModulePath, "runtimes", "any", "native", "include")));
+            HeaderDirectories.Add(new DirectoryInfo(Path.Combine(thisModulePath, "Externals", "CLI11")));
 
-        public override IList<string> LinkLibraries => new List<string> {
-                "Microsoft.Quantum.Qir.Runtime",
-                "Microsoft.Quantum.Qir.QSharp.Foundation",
-                "Microsoft.Quantum.Qir.QSharp.Core"
-            };
+            var osID = RuntimeInformation.IsOSPlatform(OSPlatform.Windows) ? "win-x64"
+                : RuntimeInformation.IsOSPlatform(OSPlatform.Linux) ? "linux-x64"
+                : RuntimeInformation.IsOSPlatform(OSPlatform.OSX) ? "osx-x64"
+                : throw new ArgumentException("Unsupported operating system architecture.");
 
-        public override string DriverFileExtension => "cpp";
+            LibraryDirectories.Add(new DirectoryInfo(Path.Combine(thisModulePath, "runtimes", osID, "native")));
+            LibraryDirectories.Add(new DirectoryInfo(Path.Combine(thisModulePath, "Libraries", osID)));
+            LibraryDirectories.Add(new DirectoryInfo(Path.Combine(thisModulePath, "Libraries")));
+        }
     }
 }

src/Qir/Execution/Tools/Microsoft.Quantum.Qir.Tools.csproj

@@ -1,5 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
+  <Import Project="..\..\..\Simulation\Common\Simulators.Dev.props" />
+
   <PropertyGroup>
     <TargetFramework>netstandard2.1</TargetFramework>
     <PlatformTarget>x64</PlatformTarget>
@@ -50,4 +52,43 @@
     </Compile>
   </ItemGroup>
 
+  <ItemGroup>
+    <None Include="..\..\..\Qir\drops\bin\**\*">
+      <Link>runtimes\%(RecursiveDir)%(FileName)%(Extension)</Link>
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+      <Visible>false</Visible>
+    </None>
+    <None Include="..\..\..\Qir\drops\include\**\*">
+      <Link>runtimes\any\native\include\%(RecursiveDir)%(FileName)%(Extension)</Link>
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+      <Visible>false</Visible>
+    </None>
+  </ItemGroup>
+
+  <ItemGroup>
+    <None Include="$(QSimDll)">
+      <Link>Libraries\%(FileName)%(Extension)</Link>
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+      <Visible>false</Visible>
+    </None>
+  </ItemGroup>
+
+  <ItemGroup>
+    <None Include="..\..\..\Simulation\Native\win10\**\*">
+      <Link>Libraries\win-x64\%(RecursiveDir)%(FileName)%(Extension)</Link>
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+      <Visible>false</Visible>
+    </None>
+    <None Include="..\..\..\Simulation\Native\osx\**\*">
+      <Link>Libraries\osx-x64\%(RecursiveDir)%(FileName)%(Extension)</Link>
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+      <Visible>false</Visible>
+    </None>
+    <None Include="..\..\..\Simulation\Native\linux\**\*">
+      <Link>Libraries\linux-x64\%(RecursiveDir)%(FileName)%(Extension)</Link>
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+      <Visible>false</Visible>
+    </None>
+  </ItemGroup>
+
 </Project>

src/Qir/Execution/Tools/Utility/ILogger.cs

@@ -17,6 +17,12 @@ public interface ILogger
         /// <param name="message">Message to log.</param>
         void LogInfo(string message);
 
+        /// <summary>
+        /// Logs a message at the "warning" level.
+        /// </summary>
+        /// <param name="message">Message to log.</param>
+        void LogWarning(string message);
+
         /// <summary>
         /// Logs a message at the "error" level.
         /// </summary>

src/Qir/Execution/Tools/Utility/Logger.cs

@@ -20,13 +20,19 @@ public Logger(IClock clock)
         // ...{exception type}: {exception message}{Environment.NewLine}{stack trace}.
         private const string ExceptionMessageFormat = "Exception encountered: {0}: {1}{2}{3}";
         private const string InfoLevel = "INFO";
+        private const string WarningLevel = "WARNING";
         private const string ErrorLevel = "ERROR";
 
         public void LogInfo(string message)
         {
             Console.WriteLine(LogFormat, clock.Now, InfoLevel, message);
         }
 
+        public void LogWarning(string message)
+        {
+            Console.WriteLine(LogFormat, clock.Now, WarningLevel, message);
+        }
+
         public void LogError(string message)
         {
             Console.WriteLine(LogFormat, clock.Now, ErrorLevel, message);