1 /*
   2  * Copyright (c) 2012, 2016, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.
   8  *
   9  * This code is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12  * version 2 for more details (a copy is included in the LICENSE file that
  13  * accompanied this code).
  14  *
  15  * You should have received a copy of the GNU General Public License version
  16  * 2 along with this work; if not, write to the Free Software Foundation,
  17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  18  *
  19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  20  * or visit www.oracle.com if you need additional information or have any
  21  * questions.
  22  */
  23 package org.graalvm.compiler.hotspot.amd64;
  24 
  25 import static jdk.vm.ci.common.InitTimer.timer;
  26 import static org.graalvm.compiler.hotspot.HotSpotBackend.Options.GraalArithmeticStubs;
  27 import java.util.ArrayList;
  28 import java.util.List;
  29 
  30 import org.graalvm.compiler.api.replacements.SnippetReflectionProvider;
  31 import org.graalvm.compiler.bytecode.BytecodeProvider;
  32 import org.graalvm.compiler.core.common.spi.ConstantFieldProvider;
  33 import org.graalvm.compiler.hotspot.GraalHotSpotVMConfig;
  34 import org.graalvm.compiler.hotspot.HotSpotBackend;
  35 import org.graalvm.compiler.hotspot.HotSpotBackendFactory;
  36 import org.graalvm.compiler.hotspot.HotSpotGraalRuntimeProvider;
  37 import org.graalvm.compiler.hotspot.HotSpotReplacementsImpl;
  38 import org.graalvm.compiler.hotspot.meta.HotSpotForeignCallsProvider;
  39 import org.graalvm.compiler.hotspot.meta.HotSpotGraalConstantFieldProvider;
  40 import org.graalvm.compiler.hotspot.meta.HotSpotGraphBuilderPlugins;
  41 import org.graalvm.compiler.hotspot.meta.HotSpotHostForeignCallsProvider;
  42 import org.graalvm.compiler.hotspot.meta.HotSpotLoweringProvider;
  43 import org.graalvm.compiler.hotspot.meta.HotSpotProviders;
  44 import org.graalvm.compiler.hotspot.meta.HotSpotRegisters;
  45 import org.graalvm.compiler.hotspot.meta.HotSpotRegistersProvider;
  46 import org.graalvm.compiler.hotspot.meta.HotSpotSnippetReflectionProvider;
  47 import org.graalvm.compiler.hotspot.meta.HotSpotStampProvider;
  48 import org.graalvm.compiler.hotspot.meta.HotSpotSuitesProvider;
  49 import org.graalvm.compiler.hotspot.nodes.HotSpotNodeCostProvider;
  50 import org.graalvm.compiler.hotspot.word.HotSpotWordTypes;
  51 import org.graalvm.compiler.nodes.graphbuilderconf.GraphBuilderConfiguration.Plugins;
  52 import org.graalvm.compiler.nodes.spi.NodeCostProvider;
  53 import org.graalvm.compiler.nodes.spi.Replacements;
  54 import org.graalvm.compiler.options.OptionValues;
  55 import org.graalvm.compiler.phases.tiers.CompilerConfiguration;
  56 import org.graalvm.compiler.phases.util.Providers;
  57 import org.graalvm.compiler.replacements.amd64.AMD64GraphBuilderPlugins;
  58 import org.graalvm.compiler.replacements.classfile.ClassfileBytecodeProvider;
  59 import org.graalvm.compiler.serviceprovider.ServiceProvider;
  60 import org.graalvm.compiler.word.WordTypes;
  61 
  62 import jdk.vm.ci.amd64.AMD64;
  63 import jdk.vm.ci.code.Architecture;
  64 import jdk.vm.ci.code.Register;
  65 import jdk.vm.ci.code.RegisterConfig;
  66 import jdk.vm.ci.code.TargetDescription;
  67 import jdk.vm.ci.common.InitTimer;
  68 import jdk.vm.ci.hotspot.HotSpotCodeCacheProvider;
  69 import jdk.vm.ci.hotspot.HotSpotConstantReflectionProvider;
  70 import jdk.vm.ci.hotspot.HotSpotJVMCIRuntimeProvider;
  71 import jdk.vm.ci.hotspot.HotSpotMetaAccessProvider;
  72 import jdk.vm.ci.meta.Value;
  73 import jdk.vm.ci.runtime.JVMCIBackend;
  74 
  75 @ServiceProvider(HotSpotBackendFactory.class)
  76 public class AMD64HotSpotBackendFactory implements HotSpotBackendFactory {
  77 
  78     @Override
  79     public String getName() {
  80         return "core";
  81     }
  82 
  83     @Override
  84     public Class<? extends Architecture> getArchitecture() {
  85         return AMD64.class;
  86     }
  87 
  88     @Override
  89     @SuppressWarnings("try")
  90     public HotSpotBackend createBackend(HotSpotGraalRuntimeProvider graalRuntime, CompilerConfiguration compilerConfiguration, HotSpotJVMCIRuntimeProvider jvmciRuntime, HotSpotBackend host) {
  91         assert host == null;
  92 
  93         OptionValues options = graalRuntime.getOptions();
  94         JVMCIBackend jvmci = jvmciRuntime.getHostJVMCIBackend();
  95         GraalHotSpotVMConfig config = graalRuntime.getVMConfig();
  96         HotSpotProviders providers;
  97         HotSpotRegistersProvider registers;
  98         HotSpotCodeCacheProvider codeCache = (HotSpotCodeCacheProvider) jvmci.getCodeCache();
  99         TargetDescription target = codeCache.getTarget();
 100         HotSpotHostForeignCallsProvider foreignCalls;
 101         Value[] nativeABICallerSaveRegisters;
 102         HotSpotMetaAccessProvider metaAccess = (HotSpotMetaAccessProvider) jvmci.getMetaAccess();
 103         HotSpotConstantReflectionProvider constantReflection = (HotSpotConstantReflectionProvider) jvmci.getConstantReflection();
 104         ConstantFieldProvider constantFieldProvider = new HotSpotGraalConstantFieldProvider(config, metaAccess);
 105         HotSpotLoweringProvider lowerer;
 106         HotSpotSnippetReflectionProvider snippetReflection;
 107         HotSpotReplacementsImpl replacements;
 108         HotSpotSuitesProvider suites;
 109         HotSpotWordTypes wordTypes;
 110         Plugins plugins;
 111         NodeCostProvider nodeCostProvider;
 112         BytecodeProvider bytecodeProvider;
 113         try (InitTimer t = timer("create providers")) {
 114             try (InitTimer rt = timer("create HotSpotRegisters provider")) {
 115                 registers = createRegisters();
 116             }
 117             try (InitTimer rt = timer("create NativeABICallerSaveRegisters")) {
 118                 nativeABICallerSaveRegisters = createNativeABICallerSaveRegisters(config, codeCache.getRegisterConfig());
 119             }
 120             try (InitTimer rt = timer("create WordTypes")) {
 121                 wordTypes = new HotSpotWordTypes(metaAccess, target.wordJavaKind);
 122             }
 123             try (InitTimer rt = timer("create ForeignCalls provider")) {
 124                 foreignCalls = createForeignCalls(jvmciRuntime, graalRuntime, metaAccess, codeCache, wordTypes, nativeABICallerSaveRegisters);
 125             }
 126             try (InitTimer rt = timer("create Lowerer provider")) {
 127                 lowerer = createLowerer(graalRuntime, metaAccess, foreignCalls, registers, constantReflection, target);
 128             }
 129             try (InitTimer rt = timer("create NodeCost provider")) {
 130                 nodeCostProvider = createNodeCostProvider(target);
 131             }
 132             HotSpotStampProvider stampProvider = new HotSpotStampProvider();
 133             Providers p = new Providers(metaAccess, codeCache, constantReflection, constantFieldProvider, foreignCalls, lowerer, null, stampProvider, nodeCostProvider);
 134 
 135             try (InitTimer rt = timer("create SnippetReflection provider")) {
 136                 snippetReflection = createSnippetReflection(graalRuntime, constantReflection, wordTypes);
 137             }
 138             try (InitTimer rt = timer("create Bytecode provider")) {
 139                 bytecodeProvider = new ClassfileBytecodeProvider(metaAccess, snippetReflection);
 140             }
 141             try (InitTimer rt = timer("create Replacements provider")) {
 142                 replacements = createReplacements(options, p, snippetReflection, bytecodeProvider);
 143             }
 144             try (InitTimer rt = timer("create GraphBuilderPhase plugins")) {
 145                 plugins = createGraphBuilderPlugins(config, options, target, constantReflection, foreignCalls, metaAccess, snippetReflection, replacements, wordTypes, stampProvider);
 146                 replacements.setGraphBuilderPlugins(plugins);
 147             }
 148             try (InitTimer rt = timer("create Suites provider")) {
 149                 suites = createSuites(config, graalRuntime, compilerConfiguration, plugins, registers, replacements, options);
 150             }
 151             providers = new HotSpotProviders(metaAccess, codeCache, constantReflection, constantFieldProvider, foreignCalls, lowerer, replacements, nodeCostProvider, suites, registers,
 152                             snippetReflection, wordTypes,
 153                             plugins);
 154         }
 155         try (InitTimer rt = timer("instantiate backend")) {
 156             return createBackend(config, graalRuntime, providers);
 157         }
 158     }
 159 
 160     protected Plugins createGraphBuilderPlugins(GraalHotSpotVMConfig config, OptionValues options, TargetDescription target, HotSpotConstantReflectionProvider constantReflection,
 161                     HotSpotHostForeignCallsProvider foreignCalls,
 162                     HotSpotMetaAccessProvider metaAccess, HotSpotSnippetReflectionProvider snippetReflection, HotSpotReplacementsImpl replacements, HotSpotWordTypes wordTypes,
 163                     HotSpotStampProvider stampProvider) {
 164         Plugins plugins = HotSpotGraphBuilderPlugins.create(config, wordTypes, metaAccess, constantReflection, snippetReflection, foreignCalls, stampProvider, replacements);
 165         AMD64GraphBuilderPlugins.register(plugins, replacements.getReplacementBytecodeProvider(), (AMD64) target.arch, GraalArithmeticStubs.getValue(options));
 166         return plugins;
 167     }
 168 
 169     protected AMD64HotSpotBackend createBackend(GraalHotSpotVMConfig config, HotSpotGraalRuntimeProvider runtime, HotSpotProviders providers) {
 170         return new AMD64HotSpotBackend(config, runtime, providers);
 171     }
 172 
 173     protected HotSpotRegistersProvider createRegisters() {
 174         return new HotSpotRegisters(AMD64.r15, AMD64.r12, AMD64.rsp);
 175     }
 176 
 177     protected HotSpotReplacementsImpl createReplacements(OptionValues options, Providers p, SnippetReflectionProvider snippetReflection, BytecodeProvider bytecodeProvider) {
 178         return new HotSpotReplacementsImpl(options, p, snippetReflection, bytecodeProvider, p.getCodeCache().getTarget());
 179     }
 180 
 181     protected AMD64HotSpotForeignCallsProvider createForeignCalls(HotSpotJVMCIRuntimeProvider jvmciRuntime, HotSpotGraalRuntimeProvider runtime, HotSpotMetaAccessProvider metaAccess,
 182                     HotSpotCodeCacheProvider codeCache, WordTypes wordTypes, Value[] nativeABICallerSaveRegisters) {
 183         return new AMD64HotSpotForeignCallsProvider(jvmciRuntime, runtime, metaAccess, codeCache, wordTypes, nativeABICallerSaveRegisters);
 184     }
 185 
 186     /**
 187      * @param replacements
 188      */
 189     protected HotSpotSuitesProvider createSuites(GraalHotSpotVMConfig config, HotSpotGraalRuntimeProvider runtime, CompilerConfiguration compilerConfiguration, Plugins plugins,
 190                     HotSpotRegistersProvider registers, Replacements replacements, OptionValues options) {
 191         return new HotSpotSuitesProvider(new AMD64HotSpotSuitesProvider(compilerConfiguration, plugins), config, runtime,
 192                         new AMD64HotSpotAddressLowering(config, registers.getHeapBaseRegister(), options));
 193     }
 194 
 195     protected HotSpotSnippetReflectionProvider createSnippetReflection(HotSpotGraalRuntimeProvider runtime, HotSpotConstantReflectionProvider constantReflection, WordTypes wordTypes) {
 196         return new HotSpotSnippetReflectionProvider(runtime, constantReflection, wordTypes);
 197     }
 198 
 199     protected HotSpotLoweringProvider createLowerer(HotSpotGraalRuntimeProvider runtime, HotSpotMetaAccessProvider metaAccess, HotSpotForeignCallsProvider foreignCalls,
 200                     HotSpotRegistersProvider registers, HotSpotConstantReflectionProvider constantReflection, TargetDescription target) {
 201         return new AMD64HotSpotLoweringProvider(runtime, metaAccess, foreignCalls, registers, constantReflection, target);
 202     }
 203 
 204     protected HotSpotNodeCostProvider createNodeCostProvider(TargetDescription target) {
 205         return new AMD64HotSpotNodeCostProvider(target);
 206     }
 207 
 208     protected Value[] createNativeABICallerSaveRegisters(GraalHotSpotVMConfig config, RegisterConfig regConfig) {
 209         List<Register> callerSave = new ArrayList<>(regConfig.getAllocatableRegisters().asList());
 210         if (config.windowsOs) {
 211             // http://msdn.microsoft.com/en-us/library/9z1stfyw.aspx
 212             callerSave.remove(AMD64.rdi);
 213             callerSave.remove(AMD64.rsi);
 214             callerSave.remove(AMD64.rbx);
 215             callerSave.remove(AMD64.rbp);
 216             callerSave.remove(AMD64.rsp);
 217             callerSave.remove(AMD64.r12);
 218             callerSave.remove(AMD64.r13);
 219             callerSave.remove(AMD64.r14);
 220             callerSave.remove(AMD64.r15);
 221             callerSave.remove(AMD64.xmm6);
 222             callerSave.remove(AMD64.xmm7);
 223             callerSave.remove(AMD64.xmm8);
 224             callerSave.remove(AMD64.xmm9);
 225             callerSave.remove(AMD64.xmm10);
 226             callerSave.remove(AMD64.xmm11);
 227             callerSave.remove(AMD64.xmm12);
 228             callerSave.remove(AMD64.xmm13);
 229             callerSave.remove(AMD64.xmm14);
 230             callerSave.remove(AMD64.xmm15);
 231         } else {
 232             /*
 233              * System V Application Binary Interface, AMD64 Architecture Processor Supplement
 234              *
 235              * Draft Version 0.96
 236              *
 237              * http://www.uclibc.org/docs/psABI-x86_64.pdf
 238              *
 239              * 3.2.1
 240              *
 241              * ...
 242              *
 243              * This subsection discusses usage of each register. Registers %rbp, %rbx and %r12
 244              * through %r15 "belong" to the calling function and the called function is required to
 245              * preserve their values. In other words, a called function must preserve these
 246              * registers' values for its caller. Remaining registers "belong" to the called
 247              * function. If a calling function wants to preserve such a register value across a
 248              * function call, it must save the value in its local stack frame.
 249              */
 250             callerSave.remove(AMD64.rbp);
 251             callerSave.remove(AMD64.rbx);
 252             callerSave.remove(AMD64.r12);
 253             callerSave.remove(AMD64.r13);
 254             callerSave.remove(AMD64.r14);
 255             callerSave.remove(AMD64.r15);
 256         }
 257         Value[] nativeABICallerSaveRegisters = new Value[callerSave.size()];
 258         for (int i = 0; i < callerSave.size(); i++) {
 259             nativeABICallerSaveRegisters[i] = callerSave.get(i).asValue();
 260         }
 261         return nativeABICallerSaveRegisters;
 262     }
 263 
 264     @Override
 265     public String toString() {
 266         return "AMD64";
 267     }
 268 }