1 /*
   2  * Copyright (c) 2011, 2019, 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 
  24 
  25 package org.graalvm.compiler.nodes.spi;
  26 
  27 import org.graalvm.compiler.graph.Node;
  28 import org.graalvm.compiler.nodes.ValueNode;
  29 import org.graalvm.compiler.nodes.memory.address.AddressNode;
  30 
  31 import jdk.vm.ci.meta.JavaKind;
  32 
  33 /**
  34  * Provides a capability for replacing a higher node with one or more lower level nodes.
  35  */
  36 public interface LoweringProvider {
  37 
  38     void lower(Node n, LoweringTool tool);
  39 
  40     /**
  41      * Reconstructs the array index from an address node that was created as a lowering of an
  42      * indexed access to an array.
  43      *
  44      * @param elementKind the {@link JavaKind} of the array elements
  45      * @param address an {@link AddressNode} pointing to an element in an array
  46      * @return a node that gives the index of the element
  47      */
  48     ValueNode reconstructArrayIndex(JavaKind elementKind, AddressNode address);
  49 
  50     /**
  51      * Indicates the smallest width for comparing an integer value on the target platform.
  52      */
  53     default Integer smallestCompareWidth() {
  54         // most platforms only support 32 and 64 bit compares
  55         return 32;
  56     }
  57 
  58     /**
  59      * Indicates whether the target platform supports bulk zeroing instruction.
  60      */
  61     default boolean supportBulkZeroing() {
  62         return false;
  63     }
  64 }