JProfilingValue.hpp

/*******************************************************************************
 * Copyright IBM Corp. and others 2017
 *
 * This program and the accompanying materials are made available under
 * the terms of the Eclipse Public License 2.0 which accompanies this
 * distribution and is available at https://www.eclipse.org/legal/epl-2.0/
 * or the Apache License, Version 2.0 which accompanies this distribution and
 * is available at https://www.apache.org/licenses/LICENSE-2.0.
 *
 * This Source Code may also be made available under the following
 * Secondary Licenses when the conditions for such availability set
 * forth in the Eclipse Public License, v. 2.0 are satisfied: GNU
 * General Public License, version 2 with the GNU Classpath
 * Exception [1] and GNU General Public License, version 2 with the
 * OpenJDK Assembly Exception [2].
 *
 * [1] https://www.gnu.org/software/classpath/license.html
 * [2] https://openjdk.org/legal/assembly-exception.html
 *
 * SPDX-License-Identifier: EPL-2.0 OR Apache-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0 OR GPL-2.0-only WITH OpenJDK-assembly-exception-1.0
 *******************************************************************************/
#ifndef JPROFILINGVALUE_INCL
#define JPROFILINGVALUE_INCL

#include <stdint.h>
#include "optimizer/Optimization.hpp"
#include "optimizer/OptimizationManager.hpp"
#include "infra/Checklist.hpp"                // fir NodeChecklist

#include "runtime/J9ValueProfiler.hpp"

class TR_JProfilingValue : public TR::Optimization
   {
   public:

   TR_JProfilingValue(TR::OptimizationManager *manager)
      : TR::Optimization(manager)
      {}
   static TR::Optimization *create(TR::OptimizationManager *manager)
      {
      return new (manager->allocator()) TR_JProfilingValue(manager);
      }

   virtual int32_t perform();
   virtual const char *optDetailString() const throw();

   /**
    * Identify place holder calls to jProfileValueSymbol and jProfileValueWithNullCHKSymbol, lowering them
    * into the fast, slow and helper paths.
    */
   void lowerCalls();
   /**
    * Clean up duplicate profiling candidates and add profiling placeholder calls
    * for profiling target of virtual call dispatch and instanceOf/checkCast.
    */
   void cleanUpAndAddProfilingCandidates();
   /**
    * Examines node to identify profiling candidate and add place holder calls for profiling it.
    * This routine checks node and it's children for mainly two type of nodes.
    * 1. Virtual Call
    * 2. instanceOf/checkcast/checkcastAndNULLCHK
    * In these case, it adds placeholder call to profiler the VFT Pointer.
    *
    * @param node to examine for profiling candidate
    * @param cursor A TreeTop Pointer containing the node
    * @param alreadyProfiledValues A BitVector containing information about already profiled nodes in Extended Basic Blocks
    * @param checklist A Node checklist to make sure while recursively examining node, we do not examine node multiple times.
    */
   void performOnNode(TR::Node *node, TR::TreeTop *cursor, TR_BitVector *alreadyProfiledValues, TR::NodeChecklist *checklist);

   static bool addProfilingTrees(
      TR::Compilation *comp,
      TR::TreeTop *insertionPoint,
      TR::Node *value,
      TR_AbstractHashTableProfilerInfo *table,
      bool addNullCheck = false,
      bool extendBlocks = true,
      bool trace = false);

   private:
   static TR::Node *computeHash(TR::Compilation *comp, TR_AbstractHashTableProfilerInfo *table, TR::Node *value, TR::Node *baseAddr);

   // Helpers for inserting the profiling trees
   static void replaceNode(TR::Node* check, TR::Node* origNode, TR::Node *newNode, TR::NodeChecklist &checklist);
   static void replaceNode(TR::Compilation *comp, TR::TreeTop *blockStart, TR::TreeTop *replaceStart,
      TR::Node *origNode, TR::Node *newNode);

   static void setProfilingCode(TR::Node *node, TR::NodeChecklist &checklist);

   static TR::Node *loadValue(TR::Compilation *comp, TR::DataType dataType, TR::Node *base, TR::Node *index = NULL,
      TR::Node *offset = NULL);
   static TR::Node *storeNode(TR::Compilation *comp, TR::Node *value, TR::SymbolReference* &symRef);
   static TR::Node *createHelperCall(TR::Compilation *comp, TR::Node *value, TR::Node *table);
   static TR::Node *incrementMemory(TR::Compilation *comp, TR::DataType counterType, TR::Node *address);
   static TR::Node *copyGlRegDeps(TR::Compilation *comp, TR::Node *origGlRegDeps);
   static TR::Node *effectiveAddress(TR::DataType dataType, TR::Node *base, TR::Node *index = NULL, TR::Node *offset = NULL);
   static TR::Node *systemConst(TR::Compilation *comp, TR::Node *example, uint64_t value);
   static TR::Node *convertType(TR::Node *index, TR::DataType dataType, bool zeroExtend = true);
   };

#endif