/*
 * Copyright (c) 2017, 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_VM_GC_SHARED_C1BARRIERSETCODEGEN_HPP
#define SHARE_VM_GC_SHARED_C1BARRIERSETCODEGEN_HPP

#include "c1/c1_Decorators.hpp"
#include "c1/c1_LIRGenerator.hpp"
#include "c1/c1_Instruction.hpp"
#include "c1/c1_LIR.hpp"

class LIRGenerator;
class LIRItem;

class C1BarrierSetCodeGen: public CHeapObj<mtGC> {
protected:
  virtual LIR_Opr resolve_address(LIRGenerator* lir_generator, C1DecoratorSet decorators, BasicType type,
                                  LIRItem& base, LIR_Opr offset, bool resolve_in_register);

  virtual void generate_referent_check(LIRGenerator* lir_generator, LIRItem& base, LIR_Opr offset, LabelObj* cont);

  // Accesses with resolved address
  virtual void store_at_resolved(LIRGenerator* lir_generator, C1DecoratorSet decorators, BasicType type,
                                 LIR_Opr addr, LIRItem& base, LIR_Opr offset, LIR_Opr value,
                                 CodeEmitInfo* patch_info, CodeEmitInfo* store_emit_info);

  virtual LIR_Opr load_at_resolved(LIRGenerator* lir_generator, C1DecoratorSet decorators, BasicType type,
                                   LIR_Opr addr, LIRItem& base, LIR_Opr offset,
                                   CodeEmitInfo* patch_info, CodeEmitInfo* load_emit_info);

  virtual LIR_Opr cas_at_resolved(LIRGenerator* lir_generator, C1DecoratorSet decorators, BasicType type,
                                  LIR_Opr addr, LIRItem& base, LIRItem& offset, LIRItem& cmp_value, LIRItem& new_value);

  virtual LIR_Opr swap_at_resolved(LIRGenerator* lir_generator, C1DecoratorSet decorators, BasicType type,
                                   LIR_Opr addr, LIRItem& base, LIRItem& offset, LIRItem& value);

  virtual LIR_Opr add_at_resolved(LIRGenerator* lir_generator, C1DecoratorSet decorators, BasicType type,
                                  LIR_Opr addr, LIRItem& base, LIRItem& offset, LIRItem& value);

public:
  virtual void store_at(LIRGenerator* lir_generator, C1DecoratorSet decorators, BasicType type,
                        LIRItem& base, LIR_Opr offset, LIR_Opr value,
                        CodeEmitInfo* patch_info, CodeEmitInfo* store_emit_info);

  virtual LIR_Opr load_at(LIRGenerator* lir_generator, C1DecoratorSet decorators, BasicType type,
                          LIRItem& base, LIR_Opr offset,
                          CodeEmitInfo* patch_info, CodeEmitInfo* load_emit_info);

  virtual LIR_Opr cas_at(LIRGenerator* lir_generator, C1DecoratorSet decorators, BasicType type,
                         LIRItem& base, LIRItem& offset, LIRItem& cmp_value, LIRItem& new_value);

  virtual LIR_Opr swap_at(LIRGenerator* lir_generator, C1DecoratorSet decorators, BasicType type,
                          LIRItem& base, LIRItem& offset, LIRItem& value);

  virtual LIR_Opr add_at(LIRGenerator* lir_generator, C1DecoratorSet decorators, BasicType type,
                         LIRItem& base, LIRItem& offset, LIRItem& value);

  virtual void generate_c1_runtime_stubs(BufferBlob* buffer_blob) {}
};

#endif // SHARE_VM_GC_SHARED_C1BARRIERSETCODEGEN_HPP