Generalizing Intrinsics support (#52)

* Fixed bug causing Appending Module flags to fail
* Restored Entrypoint names on overloaded P/Invokes
* Added tests to validate appending ModuleFLags operate correctly.

* * Updated intrinsic method support to use new generalized implementation that allows for all LLVM intrinsic functions in a consistent fashion.
* Added *.WithOverflow intrinsics generators to InstructionBuilder to allow operations with overflow checking

Author: smaillet

Samples/CodeGenWithDebugInfo/Program.cs

@@ -348,8 +348,7 @@ private static void CreateCopyFunctionBody( BitcodeModule module
             var srcPtr = instBuilder.BitCast( copyFunc.Parameters[ 0 ], module.Context.Int8Type.CreatePointerType( ) );
 
             uint pointerSize = module.Layout.IntPtrType( module.Context ).IntegerBitWidth;
-            instBuilder.MemCpy( module
-                              , dstPtr
+            instBuilder.MemCpy( dstPtr
                               , srcPtr
                               , module.Context.CreateConstant( pointerSize, module.Layout.ByteSizeOf( foo ), false )
                               , ( int )module.Layout.AbiAlignmentOf( foo )
@@ -388,8 +387,7 @@ private static void CreateDoCopyFunctionBody( BitcodeModule module
                 var bitCastDst = instBuilder.BitCast( dstAddr, bytePtrType );
                 var bitCastSrc = instBuilder.BitCast( bar, bytePtrType );
 
-                instBuilder.MemCpy( module
-                                  , bitCastDst
+                instBuilder.MemCpy( bitCastDst
                                   , bitCastSrc
                                   , module.Context.CreateConstant( module.Layout.ByteSizeOf( foo ) )
                                   , ( int )module.Layout.CallFrameAlignmentOf( foo )

docfx/templates/Ubiquity/partials/class.header.tmpl.partial

@@ -1,4 +1,4 @@
-<h1 id="{{id}}" data-uid="{{uid}}" class="text-break">{{>partials/title}}</h1>
+<h1 id="{{id}}" data-uid="{{uid}}">{{>partials/title}}</h1>
 <div class="markdown level0 summary">{{{summary}}}</div>
 <div class="markdown level0 conceptual">{{{conceptual}}}</div>
 

docfx/templates/Ubiquity/partials/namespace.tmpl.partial

@@ -1,4 +1,4 @@
-<h1 id="{{id}}" data-uid="{{uid}}" class="text-break">{{>partials/title}}</h1>
+<h1 id="{{id}}" data-uid="{{uid}}">{{>partials/title}}</h1>
 <div class="markdown level0 summary">{{{summary}}}</div>
 <div class="markdown level0 conceptual">{{{conceptual}}}</div>
 <div class="markdown level0 remarks">{{{remarks}}}</div>

src/LibLLVM/EXPORTS.DEF

@@ -86,6 +86,9 @@ LLVMFunctionAppendBasicBlock
 LLVMValueAsMetadataGetValue
 LLVMExecutionEngineClearGlobalMappingsFromModule
 LLVMContextCreateBasicBlock
+LLVMIntrinsicGetDeclaration
+LLVMIsIntrinsicOverloaded
+LLVMLookupInstrinsicId
 LLVMAttributeToString
 
 LLVMCreateValueCache

src/LibLLVM/IRBindings.cpp

@@ -180,4 +180,20 @@ extern "C"
                                        )
                    );
     }
+
+    LLVMValueRef /*Function*/ LLVMIntrinsicGetDeclaration( LLVMModuleRef m, unsigned id, LLVMTypeRef* argTypes, unsigned count )
+    {
+        ArrayRef<Type*> Tys( unwrap( argTypes ), count );
+        return wrap( Intrinsic::getDeclaration( unwrap( m ), static_cast< Intrinsic::ID >( id ), Tys ) );
+    }
+
+    LLVMBool LLVMIsIntrinsicOverloaded( unsigned id )
+    {
+        return Intrinsic::isOverloaded( static_cast< Intrinsic::ID >( id ) );
+    }
+
+    unsigned LLVMLookupInstrinsicId( char const* name )
+    {
+        return Function::lookupIntrinsicID( name );
+    }
 }

src/LibLLVM/IRBindings.h

@@ -67,6 +67,11 @@ extern "C" {
     LLVMMetadataRef LLVMDIGlobalVarExpGetVariable( LLVMMetadataRef /*DIGlobalVariableExpression*/ metadataHandle );
     void LLVMExecutionEngineClearGlobalMappingsFromModule( LLVMExecutionEngineRef ee, LLVMModuleRef m );
     LLVMBasicBlockRef LLVMContextCreateBasicBlock( LLVMContextRef context, char const* name, LLVMValueRef /*Function*/ function, LLVMBasicBlockRef insertBefore );
+    
+    LLVMValueRef /*Function*/ LLVMIntrinsicGetDeclaration( LLVMModuleRef m, unsigned id, LLVMTypeRef* argTypes, unsigned count );
+    LLVMBool LLVMIsIntrinsicOverloaded( unsigned id );
+    unsigned LLVMLookupInstrinsicId( char const* name );
+
 #ifdef __cplusplus
 }
 #endif

src/Llvm.NET/BitcodeModule.cs

@@ -11,6 +11,7 @@
 using System.Runtime.InteropServices;
 using JetBrains.Annotations;
 using Llvm.NET.DebugInfo;
+using Llvm.NET.Instructions;
 using Llvm.NET.Native;
 using Llvm.NET.Types;
 using Llvm.NET.Values;
@@ -777,6 +778,40 @@ public Function CreateFunction( string name
             return CreateFunction( name, isVarArg, returnType, ( IEnumerable<IDebugType<ITypeRef, DIType>> )argumentTypes );
         }
 
+        /// <summary>Gets a declaration for an LLVM intrinsic function</summary>
+        /// <param name="name">Name of the intrinsic</param>
+        /// <param name="args">Args for the intrinsic</param>
+        /// <returns>Function declaration</returns>
+        public Function GetIntrinsicDeclaration( string name, params ITypeRef[ ] args )
+        {
+            uint id = Intrinsic.LookupId( name );
+            return GetIntrinsicDeclaration( id, args );
+        }
+
+        /// <summary>Gets a declaration for an LLVM intrinsic function</summary>
+        /// <param name="id">id of the intrinsic</param>
+        /// <param name="args">Args for the intrinsic</param>
+        /// <returns>Function declaration</returns>
+        public Function GetIntrinsicDeclaration( UInt32 id, params ITypeRef[] args)
+        {
+            if( !LLVMIsIntrinsicOverloaded( id ) && args.Length > 0 )
+            {
+                throw new ArgumentException( $"intrinsic {id} is not overloaded and therefore does not require type arguments" );
+            }
+
+            LLVMTypeRef[ ] llvmArgs = args.Select( a => a.GetTypeRef( ) ).ToArray( );
+
+            // have to pass a valid addressable object to native interop
+            // so allocate space for a single value but tell LLVM the length is 0
+            uint argCount = (uint)llvmArgs.Length;
+            if( llvmArgs.Length == 0 )
+            {
+                llvmArgs = new LLVMTypeRef[ 1 ];
+            }
+
+            return (Function) Value.FromHandle(LLVMIntrinsicGetDeclaration( ModuleHandle, id, out llvmArgs[ 0 ], argCount ));
+        }
+
         /// <summary>Clones the current module</summary>
         /// <returns>Cloned module</returns>
         public BitcodeModule Clone( )
@@ -953,7 +988,7 @@ private void ThrowIfDisposed( )
         // deal with C++ references. While that is manageable as
         // a getter, it is problematic as a setter since there isn't
         // any sort of ownership transfer and the ownership is a bit
-        // mirky, especially with a managed projection. Thus, the LLVM-C
+        // murky, especially with a managed projection. Thus, the LLVM-C
         // API sticks to the string form of the layout.
         private DataLayout CachedLayout;
 
@@ -984,5 +1019,12 @@ private static Context GetContextFor( LLVMModuleRef handle )
 
         [DllImport( LibraryPath, CallingConvention = System.Runtime.InteropServices.CallingConvention.Cdecl )]
         private static extern LLVMNamedMDNodeRef LLVMModuleGetNextNamedMD( LLVMNamedMDNodeRef nodeRef );
+
+        [DllImport( LibraryPath, CallingConvention = System.Runtime.InteropServices.CallingConvention.Cdecl )]
+        private static extern LLVMValueRef /*Function*/ LLVMIntrinsicGetDeclaration( LLVMModuleRef m, UInt32 id, out LLVMTypeRef paramTypes, uint paramCount );
+
+        [DllImport( LibraryPath, CallingConvention = System.Runtime.InteropServices.CallingConvention.Cdecl )]
+        [return:MarshalAs(UnmanagedType.Bool)]
+        private static extern bool LLVMIsIntrinsicOverloaded( UInt32 id );
     }
 }