/*
 * Copyright (c) 2012, 2025, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 *
 */

#ifndef SHARE_OPTO_PHASETYPE_HPP
#define SHARE_OPTO_PHASETYPE_HPP

#include "utilities/bitMap.inline.hpp"
#include "utilities/stringUtils.hpp"

#define COMPILER_PHASES(flags) \
  flags(BEFORE_STRINGOPTS,              "Before StringOpts") \
  flags(AFTER_STRINGOPTS,               "After StringOpts") \
  flags(BEFORE_REMOVEUSELESS,           "Before RemoveUseless") \
  flags(AFTER_PARSING,                  "After Parsing") \
  flags(BEFORE_ITER_GVN,                "Before Iter GVN") \
  flags(ITER_GVN1,                      "Iter GVN 1") \
  flags(AFTER_ITER_GVN_STEP,            "After Iter GVN Step") \
  flags(AFTER_ITER_GVN,                 "After Iter GVN") \
  flags(INCREMENTAL_INLINE_STEP,        "Incremental Inline Step") \
  flags(INCREMENTAL_INLINE_CLEANUP,     "Incremental Inline Cleanup") \
  flags(INCREMENTAL_INLINE,             "Incremental Inline") \
  flags(INCREMENTAL_BOXING_INLINE,      "Incremental Boxing Inline") \
  flags(EXPAND_VUNBOX,                  "Expand VectorUnbox") \
  flags(SCALARIZE_VBOX,                 "Scalarize VectorBox") \
  flags(INLINE_VECTOR_REBOX,            "Inline Vector Rebox Calls") \
  flags(EXPAND_VBOX,                    "Expand VectorBox") \
  flags(ELIMINATE_VBOX_ALLOC,           "Eliminate VectorBoxAllocate") \
  flags(ITER_GVN_BEFORE_EA,             "Iter GVN before EA") \
  flags(ITER_GVN_AFTER_VECTOR,          "Iter GVN after Vector Box Elimination") \
  flags(BEFORE_LOOP_OPTS,               "Before Loop Optimizations") \
  flags(PHASEIDEAL_BEFORE_EA,           "PhaseIdealLoop before EA") \
  flags(EA_AFTER_INITIAL_CONGRAPH,          "EA: 1. Intial Connection Graph") \
  flags(EA_CONNECTION_GRAPH_PROPAGATE_ITER, "EA: 2. Connection Graph Propagate Iter") \
  flags(EA_COMPLETE_CONNECTION_GRAPH_ITER,  "EA: 2. Complete Connection Graph Iter") \
  flags(EA_AFTER_COMPLETE_CONGRAPH,         "EA: 2. Complete Connection Graph") \
  flags(EA_ADJUST_SCALAR_REPLACEABLE_ITER,  "EA: 3. Adjust scalar_replaceable State Iter") \
  flags(EA_PROPAGATE_NSR_ITER,              "EA: 3. Propagate NSR Iter") \
  flags(EA_AFTER_PROPAGATE_NSR,             "EA: 3. Propagate NSR") \
  flags(EA_AFTER_GRAPH_OPTIMIZATION,        "EA: 4. After Graph Optimization") \
  flags(EA_AFTER_SPLIT_UNIQUE_TYPES_1,      "EA: 5. After split_unique_types Phase 1") \
  flags(EA_AFTER_SPLIT_UNIQUE_TYPES_3,      "EA: 5. After split_unique_types Phase 3") \
  flags(EA_AFTER_SPLIT_UNIQUE_TYPES_4,      "EA: 5. After split_unique_types Phase 4") \
  flags(EA_AFTER_SPLIT_UNIQUE_TYPES,        "EA: 5. After split_unique_types") \
  flags(EA_AFTER_REDUCE_PHI_ON_SAFEPOINTS,  "EA: 6. After reduce_phi_on_safepoints") \
  flags(EA_BEFORE_PHI_REDUCTION,            "EA: 5. Before Phi Reduction") \
  flags(EA_AFTER_PHI_CASTPP_REDUCTION,      "EA: 5. Phi -> CastPP Reduction") \
  flags(EA_AFTER_PHI_ADDP_REDUCTION,        "EA: 5. Phi -> AddP Reduction") \
  flags(EA_AFTER_PHI_CMP_REDUCTION,         "EA: 5. Phi -> Cmp Reduction") \
  flags(AFTER_EA,                       "After Escape Analysis") \
  flags(ITER_GVN_AFTER_EA,              "Iter GVN after EA") \
  flags(BEFORE_BEAUTIFY_LOOPS,          "Before Beautify Loops") \
  flags(AFTER_BEAUTIFY_LOOPS,           "After Beautify Loops") \
  flags(BEFORE_CLOOPS,                  "Before CountedLoop") \
  flags(AFTER_CLOOPS,                   "After CountedLoop") \
  flags(BEFORE_SPLIT_IF,                "Before Split-If") \
  flags(AFTER_SPLIT_IF,                 "After Split-If") \
  flags(BEFORE_LOOP_PREDICATION_IC,     "Before Loop Predication IC") \
  flags(AFTER_LOOP_PREDICATION_IC,      "After Loop Predication IC") \
  flags(BEFORE_LOOP_PREDICATION_RC,     "Before Loop Predication RC") \
  flags(AFTER_LOOP_PREDICATION_RC,      "After Loop Predication RC") \
  flags(BEFORE_PARTIAL_PEELING,         "Before Partial Peeling") \
  flags(AFTER_PARTIAL_PEELING,          "After Partial Peeling") \
  flags(BEFORE_LOOP_PEELING,            "Before Loop Peeling") \
  flags(AFTER_LOOP_PEELING,             "After Loop Peeling") \
  flags(BEFORE_LOOP_UNSWITCHING,        "Before Loop Unswitching") \
  flags(AFTER_LOOP_UNSWITCHING,         "After Loop Unswitching") \
  flags(BEFORE_LOOP_MULTIVERSIONING,    "Before Loop Multiversioning") \
  flags(AFTER_LOOP_MULTIVERSIONING,     "After Loop Multiversioning") \
  flags(BEFORE_RANGE_CHECK_ELIMINATION, "Before Range Check Elimination") \
  flags(AFTER_RANGE_CHECK_ELIMINATION,  "After Range Check Elimination") \
  flags(ITER_GVN_AFTER_ELIMINATION,     "Iter GVN after Eliminating Allocations and Locks") \
  flags(BEFORE_PRE_MAIN_POST,           "Before Pre/Main/Post Loops") \
  flags(AFTER_PRE_MAIN_POST,            "After Pre/Main/Post Loops") \
  flags(BEFORE_POST_LOOP,               "Before Post Loop") \
  flags(AFTER_POST_LOOP,                "After Post Loop") \
  flags(BEFORE_REMOVE_EMPTY_LOOP,       "Before Remove Empty Loop") \
  flags(AFTER_REMOVE_EMPTY_LOOP,        "After Remove Empty Loop") \
  flags(BEFORE_ONE_ITERATION_LOOP,      "Before Replace One-Iteration Loop") \
  flags(AFTER_ONE_ITERATION_LOOP,       "After Replace One-Iteration Loop") \
  flags(BEFORE_DUPLICATE_LOOP_BACKEDGE, "Before Duplicate Loop Backedge") \
  flags(AFTER_DUPLICATE_LOOP_BACKEDGE,  "After Duplicate Loop Backedge") \
  flags(BEFORE_LOOP_UNROLLING,          "Before Loop Unrolling") \
  flags(AFTER_LOOP_UNROLLING,           "After Loop Unrolling") \
  flags(PHASEIDEALLOOP1,                "PhaseIdealLoop 1") \
  flags(PHASEIDEALLOOP2,                "PhaseIdealLoop 2") \
  flags(PHASEIDEALLOOP3,                "PhaseIdealLoop 3") \
  flags(AUTO_VECTORIZATION1_BEFORE_APPLY,                     "AutoVectorization 1, before Apply") \
  flags(AUTO_VECTORIZATION3_AFTER_ADJUST_LIMIT,               "AutoVectorization 2, after Adjusting Pre-loop Limit") \
  flags(AUTO_VECTORIZATION4_AFTER_SPECULATIVE_RUNTIME_CHECKS, "AutoVectorization 3, after Adding Speculative Runtime Checks") \
  flags(AUTO_VECTORIZATION5_AFTER_APPLY,                      "AutoVectorization 4, after Apply") \
  flags(BEFORE_CCP1,                    "Before PhaseCCP 1") \
  flags(CCP1,                           "PhaseCCP 1") \
  flags(ITER_GVN2,                      "Iter GVN 2") \
  flags(PHASEIDEALLOOP_ITERATIONS,      "PhaseIdealLoop iterations") \
  flags(AFTER_LOOP_OPTS,                "After Loop Optimizations") \
  flags(AFTER_MERGE_STORES,             "After Merge Stores") \
  flags(AFTER_MACRO_ELIMINATION_STEP,   "After Macro Elimination Step") \
  flags(AFTER_MACRO_ELIMINATION,        "After Macro Elimination") \
  flags(BEFORE_MACRO_EXPANSION ,        "Before Macro Expansion") \
  flags(AFTER_MACRO_EXPANSION_STEP,     "After Macro Expansion Step") \
  flags(AFTER_MACRO_EXPANSION,          "After Macro Expansion") \
  flags(BARRIER_EXPANSION,              "Barrier Expand") \
  flags(OPTIMIZE_FINISHED,              "Optimize Finished") \
  flags(BEFORE_MATCHING,                "Before Matching") \
  flags(MATCHING,                       "After Matching") \
  flags(GLOBAL_CODE_MOTION,             "Global Code Motion") \
  flags(INITIAL_LIVENESS,               "Initial Liveness") \
  flags(LIVE_RANGE_STRETCHING,          "Live Range Stretching") \
  flags(AGGRESSIVE_COALESCING,          "Aggressive Coalescing") \
  flags(INITIAL_SPILLING,               "Initial Spilling") \
  flags(CONSERVATIVE_COALESCING,        "Conservative Coalescing") \
  flags(ITERATIVE_SPILLING,             "Iterative Spilling") \
  flags(AFTER_ITERATIVE_SPILLING,       "After Iterative Spilling") \
  flags(POST_ALLOCATION_COPY_REMOVAL,   "Post-allocation Copy Removal") \
  flags(MERGE_MULTI_DEFS,               "Merge Multiple Definitions") \
  flags(FIX_UP_SPILLS,                  "Fix up Spills") \
  flags(REGISTER_ALLOCATION,            "Register Allocation") \
  flags(BLOCK_ORDERING,                 "Block Ordering") \
  flags(PEEPHOLE,                       "Peephole") \
  flags(POSTALLOC_EXPAND,               "Post-allocation Expand") \
  flags(MACH_ANALYSIS,                  "After Mach Analysis") \
  flags(FINAL_CODE,                     "Final Code") \
  flags(END,                            "End") \
  flags(FAILURE,                        "Failure") \
  flags(ALL,                            "All") \
  flags(DEBUG,                          "Debug")

#define table_entry(name, description) PHASE_##name,
enum CompilerPhaseType {
  COMPILER_PHASES(table_entry)
  PHASE_NUM_TYPES,
  PHASE_NONE
};
#undef table_entry

class CompilerPhaseTypeHelper {
 private:
  static const char* const _phase_descriptions[];
  static const char* const _phase_names[];

 public:
  static const char* to_name(CompilerPhaseType cpt) {
    return _phase_names[cpt];
  }
  static const char* to_description(CompilerPhaseType cpt) {
    return _phase_descriptions[cpt];
  }

  static CompilerPhaseType find_phase(const char* str);
};

class PhaseNameValidator {
 private:
  CHeapBitMap _phase_name_set;
  bool _valid;
  char* _bad;

 public:
  PhaseNameValidator(ccstrlist option) :
    _phase_name_set(PHASE_NUM_TYPES, mtCompiler),
    _valid(true),
    _bad(nullptr)
  {
    for (StringUtils::CommaSeparatedStringIterator iter(option); *iter != nullptr && _valid; ++iter) {

      CompilerPhaseType cpt = CompilerPhaseTypeHelper::find_phase(*iter);
      if (PHASE_NONE == cpt) {
        const size_t len = MIN2<size_t>(strlen(*iter), 63) + 1;  // cap len to a value we know is enough for all phase descriptions
        _bad = NEW_C_HEAP_ARRAY(char, len, mtCompiler);
        // strncpy always writes len characters. If the source string is shorter, the function fills the remaining bytes with nulls.
        strncpy(_bad, *iter, len);
        _valid = false;
      } else if (PHASE_ALL == cpt) {
        _phase_name_set.set_range(0, PHASE_NUM_TYPES);
      } else {
        assert(cpt < PHASE_NUM_TYPES, "out of bounds");
        _phase_name_set.set_bit(cpt);
      }
    }
  }

  ~PhaseNameValidator() {
    if (_bad != nullptr) {
      FREE_C_HEAP_ARRAY(char, _bad);
    }
  }

  const BitMap& phase_name_set() const {
    assert(is_valid(), "Use of invalid phase name set");
    return _phase_name_set;
  }

  bool is_valid() const {
    return _valid;
  }

  const char* what() const {
    return _bad;
  }
};

#endif // SHARE_OPTO_PHASETYPE_HPP