/*
 * 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_C2BARRIERSETCODEGEN_HPP
#define SHARE_VM_GC_SHARED_C2BARRIERSETCODEGEN_HPP

enum C2Decorator {
  C2_EMPTY_DECORATOR     = UCONST64(0),
  C2_ACCESS_ON_HEAP      = UCONST64(1) << 0,
  C2_ACCESS_ON_ARRAY     = UCONST64(1) << 1,
  C2_ACCESS_ON_WEAK      = UCONST64(1) << 2,
  C2_ACCESS_ON_ANONYMOUS = UCONST64(1) << 3,
  C2_MISMATCHED          = UCONST64(1) << 4,
  C2_ACCESS_UNALIGNED    = UCONST64(1) << 5,
  C2_IS_FIELD            = UCONST64(1) << 6,
  C2_MO_VOLATILE         = UCONST64(1) << 7,
  C2_MO_RELAXED          = UCONST64(1) << 8,
  C2_MO_RELEASE          = UCONST64(1) << 9,
  C2_MO_ACQUIRE          = UCONST64(1) << 10,
  C2_MO_OPAQUE           = UCONST64(1) << 11,
  C2_ACCESS_ATOMIC       = UCONST64(1) << 12,
  C2_WEAK_CAS            = UCONST64(1) << 13,
  C2_ACCESS_FREE_CONTROL = UCONST64(1) << 14
};

typedef uint64_t C2DecoratorSet;

class GraphKit;
class IdealKit;
class Node;
class Type;
class TypePtr;
class PhaseMacroExpand;

class C2BarrierSetCodeGen: public CHeapObj<mtGC> {
protected:
  virtual Node* store_at_resolved(GraphKit* kit, Node* obj, Node* adr, const TypePtr* adr_type, Node* val, const Type* val_type, BasicType bt, C2DecoratorSet decorators);
  virtual Node* load_at_resolved(GraphKit* kit, Node* obj, Node* adr, const TypePtr* adr_type, const Type* val_type, BasicType bt, C2DecoratorSet decorators);

  virtual Node* cas_val_at_resolved(GraphKit* kit, Node* obj, Node* adr, const TypePtr* adr_type, int alias_idx, Node* expected_val, Node* new_val, const Type* value_type, Node* mem, Node*& load_store, BasicType bt, C2DecoratorSet decorators);
  virtual Node* cas_bool_at_resolved(GraphKit* kit, Node* obj, Node* adr, const TypePtr* adr_type, int alias_idx, Node* expected_val, Node* new_val, const Type* value_type, Node* mem, BasicType bt, C2DecoratorSet decorators);
  virtual Node* swap_at_resolved(GraphKit* kit, Node* obj, Node* adr, const TypePtr* adr_type, int alias_idx, Node* new_val, const Type* value_type, Node* mem, Node*& load_store, BasicType bt, C2DecoratorSet decorators);
  virtual Node* fetch_and_add_at_resolved(GraphKit* kit, Node* obj, Node* adr, const TypePtr* adr_type, int alias_idx, Node* new_val, const Type* value_type, Node* mem, BasicType bt, C2DecoratorSet decorators);

  virtual C2DecoratorSet fixup_decorators(C2DecoratorSet decorators);

public:
  virtual Node* store_at(GraphKit* kit, Node* obj, Node* adr, const TypePtr* adr_type, Node* val, const Type* val_type, BasicType bt, C2DecoratorSet decorators);
  virtual Node* load_at(GraphKit* kit, Node* obj, Node* adr, const TypePtr* adr_type, const Type* val_type, BasicType bt, C2DecoratorSet decorators);

  virtual Node* cas_val_at(GraphKit* kit, Node* obj, Node* adr, const TypePtr* adr_type, int alias_idx, Node* expected_val, Node* new_val, const Type* value_type, BasicType bt, C2DecoratorSet decorators);
  virtual Node* cas_bool_at(GraphKit* kit, Node* obj, Node* adr, const TypePtr* adr_type, int alias_idx, Node* expected_val, Node* new_val, const Type* value_type, BasicType bt, C2DecoratorSet decorators);
  virtual Node* swap_at(GraphKit* kit, Node* obj, Node* adr, const TypePtr* adr_type, int alias_idx, Node* new_val, const Type* value_type, BasicType bt, C2DecoratorSet decorators);
  virtual Node* fetch_and_add_at(GraphKit* kit, Node* obj, Node* adr, const TypePtr* adr_type, int alias_idx, Node* new_val, const Type* value_type, BasicType bt, C2DecoratorSet decorators);

  virtual void clone(GraphKit* kit, Node* src, Node* dst, Node* size, bool is_array);

  virtual bool is_gc_barrier_node(Node* node) { return false; }
  virtual void eliminate_gc_barrier(PhaseMacroExpand* macro, Node* node) { }
  virtual bool array_copy_requires_gc_barriers(BasicType type) { return false; }
};

#endif // SHARE_VM_GC_SHARED_C2BARRIERSETCODEGEN_HPP