[GR-14706] Sulong: check target triple of bitcode modules.

PullRequest: graal/8385

Author: zapster

sulong/CHANGELOG.md

@@ -1,3 +1,11 @@
+# Version 21.1.0
+
+New features:
+
+* Added a sanity check to verify that loaded bitcode files have been compiled correctly.
+  If not, a _mismatching target triple_ error is reported. To make this error non-fatal,
+  set `--llvm.verifyBitcode=false`. To silence the message, set `--log.llvm.BitcodeVerifier.level=OFF`.
+
 # Version 21.0.0
 
 Fixes:

sulong/mx.sulong/mx_sulong.py

@@ -256,7 +256,7 @@ def extract_bitcode(args=None, out=None):
     return mx.run_java(mx.get_runtime_jvm_args(["com.oracle.truffle.llvm.tools"]) + ["com.oracle.truffle.llvm.tools.ExtractBitcode"] + args, out=out)
 
 
-@mx.command(_suite.name, "lli-dis")
+@mx.command(_suite.name, "llvm-dis")
 def llvm_dis(args=None, out=None):
     """Disassemble (embedded) LLVM bitcode to LLVM assembly"""
     parser = ArgumentParser(prog='mx llvm-dis', description='Disassemble (embedded) LLVM bitcode to LLVM assembly.')

sulong/mx.sulong/suite.py

@@ -777,6 +777,7 @@
       ],
       "buildDependencies" : [
         "SULONG_HOME",
+        "LINUX_AMD64_SUPPORT",
       ],
       "testProject" : True,
       "defaultBuild" : False,
@@ -863,6 +864,9 @@
       "dependencies" : [
         "SULONG_TEST",
       ],
+      "buildDependencies" : [
+        "LINUX_AMD64_SUPPORT",
+      ],
       "testProject" : True,
       "defaultBuild" : False,
     },
@@ -886,6 +890,9 @@
       "dependencies" : [
         "SULONG_TEST",
       ],
+      "buildDependencies" : [
+        "LINUX_AMD64_SUPPORT",
+      ],
       "testProject" : True,
       "defaultBuild" : False,
     },
@@ -903,6 +910,9 @@
       "dependencies" : [
         "SULONG_TEST",
       ],
+      "buildDependencies" : [
+        "LINUX_AMD64_SUPPORT",
+      ],
       "testProject" : True,
       "defaultBuild" : False,
     },
@@ -922,7 +932,6 @@
         "SULONG_TEST",
       ],
       "buildDependencies" : [
-        # "AMD64_SUPPORT" currently not working on darwin GR-21946,
         "LINUX_AMD64_SUPPORT",
       ],
       "testProject" : True,

sulong/projects/com.oracle.truffle.llvm.parser/src/com/oracle/truffle/llvm/parser/LLVMParser.java

@@ -38,6 +38,7 @@
 import com.oracle.truffle.llvm.parser.model.symbols.constants.CastConstant;
 import com.oracle.truffle.llvm.parser.model.symbols.globals.GlobalAlias;
 import com.oracle.truffle.llvm.parser.model.symbols.globals.GlobalVariable;
+import com.oracle.truffle.llvm.parser.model.target.TargetTriple;
 import com.oracle.truffle.llvm.runtime.LLVMAlias;
 import com.oracle.truffle.llvm.runtime.LLVMFunction;
 import com.oracle.truffle.llvm.runtime.LLVMFunctionCode.Function;
@@ -71,7 +72,7 @@ public LLVMParserResult parse(ModelModule module, DataLayout targetDataLayout) {
         defineFunctions(module, definedFunctions, externalFunctions, targetDataLayout);
         defineAliases(module.getAliases());
 
-        return new LLVMParserResult(runtime, definedFunctions, externalFunctions, definedGlobals, externalGlobals, targetDataLayout);
+        return new LLVMParserResult(runtime, definedFunctions, externalFunctions, definedGlobals, externalGlobals, targetDataLayout, module.getTargetInformation(TargetTriple.class));
     }
 
     private void defineGlobals(List<GlobalVariable> globals, List<GlobalVariable> definedGlobals, List<GlobalVariable> externalGlobals) {

sulong/projects/com.oracle.truffle.llvm.parser/src/com/oracle/truffle/llvm/parser/LLVMParserResult.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2019, 2020, Oracle and/or its affiliates.
+ * Copyright (c) 2019, 2021, Oracle and/or its affiliates.
  *
  * All rights reserved.
  *
@@ -31,6 +31,7 @@
 
 import com.oracle.truffle.llvm.parser.model.functions.FunctionSymbol;
 import com.oracle.truffle.llvm.parser.model.symbols.globals.GlobalVariable;
+import com.oracle.truffle.llvm.parser.model.target.TargetTriple;
 import com.oracle.truffle.llvm.runtime.datalayout.DataLayout;
 
 import java.util.List;
@@ -44,19 +45,22 @@ public final class LLVMParserResult {
     private final List<GlobalVariable> externalGlobals;
     private final DataLayout dataLayout;
     private final int symbolTableSize;
+    private final TargetTriple targetTriple;
 
     LLVMParserResult(LLVMParserRuntime runtime,
                     List<FunctionSymbol> definedFunctions,
                     List<FunctionSymbol> externalFunctions,
                     List<GlobalVariable> definedGlobals,
                     List<GlobalVariable> externalGlobals,
-                    DataLayout dataLayout) {
+                    DataLayout dataLayout,
+                    TargetTriple targetTriple) {
         this.runtime = runtime;
         this.definedFunctions = definedFunctions;
         this.externalFunctions = externalFunctions;
         this.definedGlobals = definedGlobals;
         this.externalGlobals = externalGlobals;
         this.dataLayout = dataLayout;
+        this.targetTriple = targetTriple;
         this.symbolTableSize = definedFunctions.size() + externalFunctions.size() + definedGlobals.size() + externalGlobals.size();
     }
 
@@ -92,4 +96,8 @@ public String toString() {
     public int getSymbolTableSize() {
         return symbolTableSize;
     }
+
+    public TargetTriple getTargetTriple() {
+        return targetTriple;
+    }
 }

sulong/projects/com.oracle.truffle.llvm.parser/src/com/oracle/truffle/llvm/parser/model/ModelModule.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2016, 2020, Oracle and/or its affiliates.
+ * Copyright (c) 2016, 2021, Oracle and/or its affiliates.
  *
  * All rights reserved.
  *
@@ -153,4 +153,13 @@ public void addSourceFileReference(LLVMSourceFileReference sourceFile) {
     public ArrayList<LLVMSourceFileReference> getSourceFileReferences() {
         return sourceFiles;
     }
+
+    public <TI extends TargetInformation> TI getTargetInformation(Class<TI> targetInfoClazz) {
+        for (TargetInformation info : targetInfo) {
+            if (targetInfoClazz.isInstance(info)) {
+                return targetInfoClazz.cast(info);
+            }
+        }
+        return null;
+    }
 }

sulong/projects/com.oracle.truffle.llvm.parser/src/com/oracle/truffle/llvm/parser/model/target/TargetTriple.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2016, 2018, Oracle and/or its affiliates.
+ * Copyright (c) 2016, 2021, Oracle and/or its affiliates.
  *
  * All rights reserved.
  *
@@ -37,7 +37,8 @@ public TargetTriple(String triple) {
         this.triple = triple;
     }
 
-    public String getTriple() {
+    @Override
+    public String toString() {
         return triple;
     }
 }

sulong/projects/com.oracle.truffle.llvm.runtime/src/com/oracle/truffle/llvm/runtime/LLVMContext.java

@@ -59,7 +59,6 @@
 import com.oracle.truffle.api.source.Source;
 import com.oracle.truffle.llvm.api.Toolchain;
 import com.oracle.truffle.llvm.runtime.LLVMArgumentBuffer.LLVMArgumentArray;
-import com.oracle.truffle.llvm.runtime.datalayout.DataLayout;
 import com.oracle.truffle.llvm.runtime.debug.LLVMSourceContext;
 import com.oracle.truffle.llvm.runtime.except.LLVMIllegalSymbolIndexException;
 import com.oracle.truffle.llvm.runtime.except.LLVMLinkerException;
@@ -151,8 +150,6 @@ public final class LLVMContext {
     protected boolean initialized;
     protected boolean cleanupNecessary;
     private boolean initializeContextCalled;
-    private DataLayout libsulongDatalayout;
-    private Boolean datalayoutInitialised;
     private final LLVMLanguage language;
 
     private LLVMTracerInstrument tracer;    // effectively final after initialization
@@ -176,8 +173,6 @@ synchronized LLVMFunctionDescriptor create(LLVMFunction functionDetail, LLVMFunc
     @SuppressWarnings({"unchecked", "rawtypes"})
     LLVMContext(LLVMLanguage language, Env env, Toolchain toolchain) {
         this.language = language;
-        this.libsulongDatalayout = null;
-        this.datalayoutInitialised = false;
         this.env = env;
         this.initialized = false;
         this.cleanupNecessary = false;
@@ -205,7 +200,7 @@ synchronized LLVMFunctionDescriptor create(LLVMFunction functionDetail, LLVMFunc
 
         addLibraryPaths(SulongEngineOption.getPolyglotOptionSearchPaths(env));
 
-        pThreadContext = new LLVMPThreadContext(getEnv(), getLanguage(), getLibsulongDataLayout());
+        pThreadContext = new LLVMPThreadContext(getEnv(), getLanguage(), language.getDefaultDataLayout());
 
         symbolAssumptions = new Assumption[10][];
         // These two fields contain the same value, but have different CompilationFinal annotations:
@@ -420,20 +415,6 @@ private static LLVMManagedPointer toManagedPointer(Object value) {
         return LLVMManagedPointer.create(value);
     }
 
-    public void addLibsulongDataLayout(DataLayout datalayout) {
-        // Libsulong datalayout can only be set once.
-        if (!datalayoutInitialised) {
-            this.libsulongDatalayout = datalayout;
-            datalayoutInitialised = true;
-        } else {
-            throw new NullPointerException("The default datalayout cannot be overrwitten");
-        }
-    }
-
-    public DataLayout getLibsulongDataLayout() {
-        return libsulongDatalayout;
-    }
-
     void finalizeContext(LLVMFunction sulongDisposeContext) {
         // join all created pthread - threads
         pThreadContext.joinAllThreads();
@@ -565,6 +546,10 @@ public boolean isInternalLibraryFile(TruffleFile file) {
         return file.normalize().startsWith(internalLibraryPathFile);
     }
 
+    public boolean isInternalLibraryPath(Path path) {
+        return path.normalize().startsWith(internalLibraryPath);
+    }
+
     public TruffleFile getOrAddTruffleFile(TruffleFile file) {
         synchronized (truffleFilesLock) {
             int index = truffleFiles.indexOf(file);

sulong/projects/com.oracle.truffle.llvm.runtime/src/com/oracle/truffle/llvm/runtime/LLVMLanguage.java

@@ -51,6 +51,7 @@
 import com.oracle.truffle.llvm.runtime.config.Configuration;
 import com.oracle.truffle.llvm.runtime.config.Configurations;
 import com.oracle.truffle.llvm.runtime.config.LLVMCapability;
+import com.oracle.truffle.llvm.runtime.datalayout.DataLayout;
 import com.oracle.truffle.llvm.runtime.debug.LLDBSupport;
 import com.oracle.truffle.llvm.runtime.debug.debugexpr.nodes.DebugExprExecutableNode;
 import com.oracle.truffle.llvm.runtime.debug.debugexpr.parser.DebugExprException;
@@ -62,6 +63,7 @@
 import com.oracle.truffle.llvm.runtime.memory.LLVMMemoryOpNode;
 import com.oracle.truffle.llvm.runtime.nodes.api.LLVMStatementNode;
 import com.oracle.truffle.llvm.runtime.pointer.LLVMPointer;
+import com.oracle.truffle.llvm.runtime.target.TargetTriple;
 import com.oracle.truffle.llvm.toolchain.config.LLVMConfig;
 import org.graalvm.collections.EconomicMap;
 import org.graalvm.options.OptionDescriptors;
@@ -144,6 +146,9 @@ private <U extends ContextExtension> ContextExtensionKey<U> cast(Class<U> target
 
     private final ConcurrentHashMap<Class<?>, RootCallTarget> cachedCallTargets = new ConcurrentHashMap<>();
 
+    private DataLayout defaultDataLayout;
+    private TargetTriple defaultTargetTriple;
+
     @CompilationFinal private LLVMFunctionCode sulongInitContextCode;
     @CompilationFinal private LLVMFunction sulongDisposeContext;
     @CompilationFinal private LLVMFunctionCode startFunctionCode;
@@ -442,6 +447,29 @@ public CallTarget getFreeGlobalBlocks() {
         return freeGlobalBlocks;
     }
 
+    public synchronized void setDefaultBitcode(DataLayout datalayout, TargetTriple targetTriple) {
+        // Libsulong datalayout can only be set once.
+        if (defaultDataLayout == null) {
+            this.defaultDataLayout = datalayout;
+        } else {
+            throw new NullPointerException("The default datalayout cannot be overwritten");
+        }
+        // Libsulong targettriple can only be set once.
+        if (defaultTargetTriple == null) {
+            this.defaultTargetTriple = targetTriple;
+        } else {
+            throw new NullPointerException("The default targetTriple cannot be overwritten");
+        }
+    }
+
+    public DataLayout getDefaultDataLayout() {
+        return defaultDataLayout;
+    }
+
+    public TargetTriple getDefaultTargetTriple() {
+        return defaultTargetTriple;
+    }
+
     public AtomicInteger getRawRunnerID() {
         return nextID;
     }

sulong/projects/com.oracle.truffle.llvm.runtime/src/com/oracle/truffle/llvm/runtime/debug/debugexpr/nodes/DebugExprSizeofNode.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2019, 2020, Oracle and/or its affiliates.
+ * Copyright (c) 2019, 2021, Oracle and/or its affiliates.
  *
  * All rights reserved.
  *
@@ -43,7 +43,7 @@ public abstract class DebugExprSizeofNode extends LLVMExpressionNode {
     private final long typeSize;
 
     public static DebugExprSizeofNode create(DebugExprType type) throws TypeOverflowException {
-        DataLayout datalayout = LLVMLanguage.getContext().getLibsulongDataLayout();
+        DataLayout datalayout = LLVMLanguage.getLanguage().getDefaultDataLayout();
         return DebugExprSizeofNodeGen.create(type.getLLVMRuntimeType().getSize(datalayout));
     }