// Copyright 2013 the V8 project authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef V8_COMPILER_JS_OPERATOR_H_
#define V8_COMPILER_JS_OPERATOR_H_

#include "src/compiler/linkage.h"
#include "src/compiler/opcodes.h"
#include "src/compiler/operator.h"
#include "src/unique.h"
#include "src/zone.h"

namespace v8 {
namespace internal {
namespace compiler {

// Defines the location of a context slot relative to a specific scope. This is
// used as a parameter by JSLoadContext and JSStoreContext operators and allows
// accessing a context-allocated variable without keeping track of the scope.
class ContextAccess {
 public:
  ContextAccess(int depth, int index, bool immutable)
      : immutable_(immutable), depth_(depth), index_(index) {
    DCHECK(0 <= depth && depth <= kMaxUInt16);
    DCHECK(0 <= index && static_cast<uint32_t>(index) <= kMaxUInt32);
  }
  int depth() const { return depth_; }
  int index() const { return index_; }
  bool immutable() const { return immutable_; }

 private:
  // For space reasons, we keep this tightly packed, otherwise we could just use
  // a simple int/int/bool POD.
  const bool immutable_;
  const uint16_t depth_;
  const uint32_t index_;
};

// Defines the property being loaded from an object by a named load. This is
// used as a parameter by JSLoadNamed operators.
struct LoadNamedParameters {
  Unique<Name> name;
  ContextualMode contextual_mode;
};

// Defines the arity and the call flags for a JavaScript function call. This is
// used as a parameter by JSCall operators.
struct CallParameters {
  int arity;
  CallFunctionFlags flags;
};

// Defines the property being stored to an object by a named store. This is
// used as a parameter by JSStoreNamed operators.
struct StoreNamedParameters {
  StrictMode strict_mode;
  Unique<Name> name;
};

// Interface for building JavaScript-level operators, e.g. directly from the
// AST. Most operators have no parameters, thus can be globally shared for all
// graphs.
class JSOperatorBuilder {
 public:
  explicit JSOperatorBuilder(Zone* zone) : zone_(zone) {}

#define SIMPLE(name, properties, inputs, outputs) \
  return new (zone_)                              \
      SimpleOperator(IrOpcode::k##name, properties, inputs, outputs, #name);

#define NOPROPS(name, inputs, outputs) \
  SIMPLE(name, Operator::kNoProperties, inputs, outputs)

#define OP1(name, ptype, pname, properties, inputs, outputs)                 \
  return new (zone_) Operator1<ptype>(IrOpcode::k##name, properties, inputs, \
                                      outputs, #name, pname)

#define BINOP(name) NOPROPS(name, 2, 1)
#define UNOP(name) NOPROPS(name, 1, 1)

#define PURE_BINOP(name) SIMPLE(name, Operator::kPure, 2, 1)

  const Operator* Equal() { BINOP(JSEqual); }
  const Operator* NotEqual() { BINOP(JSNotEqual); }
  const Operator* StrictEqual() { PURE_BINOP(JSStrictEqual); }
  const Operator* StrictNotEqual() { PURE_BINOP(JSStrictNotEqual); }
  const Operator* LessThan() { BINOP(JSLessThan); }
  const Operator* GreaterThan() { BINOP(JSGreaterThan); }
  const Operator* LessThanOrEqual() { BINOP(JSLessThanOrEqual); }
  const Operator* GreaterThanOrEqual() { BINOP(JSGreaterThanOrEqual); }
  const Operator* BitwiseOr() { BINOP(JSBitwiseOr); }
  const Operator* BitwiseXor() { BINOP(JSBitwiseXor); }
  const Operator* BitwiseAnd() { BINOP(JSBitwiseAnd); }
  const Operator* ShiftLeft() { BINOP(JSShiftLeft); }
  const Operator* ShiftRight() { BINOP(JSShiftRight); }
  const Operator* ShiftRightLogical() { BINOP(JSShiftRightLogical); }
  const Operator* Add() { BINOP(JSAdd); }
  const Operator* Subtract() { BINOP(JSSubtract); }
  const Operator* Multiply() { BINOP(JSMultiply); }
  const Operator* Divide() { BINOP(JSDivide); }
  const Operator* Modulus() { BINOP(JSModulus); }

  const Operator* UnaryNot() { UNOP(JSUnaryNot); }
  const Operator* ToBoolean() { UNOP(JSToBoolean); }
  const Operator* ToNumber() { UNOP(JSToNumber); }
  const Operator* ToString() { UNOP(JSToString); }
  const Operator* ToName() { UNOP(JSToName); }
  const Operator* ToObject() { UNOP(JSToObject); }
  const Operator* Yield() { UNOP(JSYield); }

  const Operator* Create() { SIMPLE(JSCreate, Operator::kEliminatable, 0, 1); }

  const Operator* Call(int arguments, CallFunctionFlags flags) {
    CallParameters parameters = {arguments, flags};
    OP1(JSCallFunction, CallParameters, parameters, Operator::kNoProperties,
        arguments, 1);
  }

  const Operator* CallNew(int arguments) {
    return new (zone_)
        Operator1<int>(IrOpcode::kJSCallConstruct, Operator::kNoProperties,
                       arguments, 1, "JSCallConstruct", arguments);
  }

  const Operator* LoadProperty() { BINOP(JSLoadProperty); }
  const Operator* LoadNamed(Unique<Name> name,
                            ContextualMode contextual_mode = NOT_CONTEXTUAL) {
    LoadNamedParameters parameters = {name, contextual_mode};
    OP1(JSLoadNamed, LoadNamedParameters, parameters, Operator::kNoProperties,
        1, 1);
  }

  const Operator* StoreProperty(StrictMode strict_mode) {
    OP1(JSStoreProperty, StrictMode, strict_mode, Operator::kNoProperties, 3,
        0);
  }

  const Operator* StoreNamed(StrictMode strict_mode, Unique<Name> name) {
    StoreNamedParameters parameters = {strict_mode, name};
    OP1(JSStoreNamed, StoreNamedParameters, parameters, Operator::kNoProperties,
        2, 0);
  }

  const Operator* DeleteProperty(StrictMode strict_mode) {
    OP1(JSDeleteProperty, StrictMode, strict_mode, Operator::kNoProperties, 2,
        1);
  }

  const Operator* HasProperty() { NOPROPS(JSHasProperty, 2, 1); }

  const Operator* LoadContext(uint16_t depth, uint32_t index, bool immutable) {
    ContextAccess access(depth, index, immutable);
    OP1(JSLoadContext, ContextAccess, access,
        Operator::kEliminatable | Operator::kNoWrite, 1, 1);
  }
  const Operator* StoreContext(uint16_t depth, uint32_t index) {
    ContextAccess access(depth, index, false);
    OP1(JSStoreContext, ContextAccess, access, Operator::kNoProperties, 2, 0);
  }

  const Operator* TypeOf() { SIMPLE(JSTypeOf, Operator::kPure, 1, 1); }
  const Operator* InstanceOf() { NOPROPS(JSInstanceOf, 2, 1); }
  const Operator* Debugger() { NOPROPS(JSDebugger, 0, 0); }

  // TODO(titzer): nail down the static parts of each of these context flavors.
  const Operator* CreateFunctionContext() {
    NOPROPS(JSCreateFunctionContext, 1, 1);
  }
  const Operator* CreateCatchContext(Unique<String> name) {
    OP1(JSCreateCatchContext, Unique<String>, name, Operator::kNoProperties, 1,
        1);
  }
  const Operator* CreateWithContext() { NOPROPS(JSCreateWithContext, 2, 1); }
  const Operator* CreateBlockContext() { NOPROPS(JSCreateBlockContext, 2, 1); }
  const Operator* CreateModuleContext() {
    NOPROPS(JSCreateModuleContext, 2, 1);
  }
  const Operator* CreateGlobalContext() {
    NOPROPS(JSCreateGlobalContext, 2, 1);
  }

  const Operator* Runtime(Runtime::FunctionId function, int arguments) {
    const Runtime::Function* f = Runtime::FunctionForId(function);
    DCHECK(f->nargs == -1 || f->nargs == arguments);
    OP1(JSCallRuntime, Runtime::FunctionId, function, Operator::kNoProperties,
        arguments, f->result_size);
  }

#undef SIMPLE
#undef NOPROPS
#undef OP1
#undef BINOP
#undef UNOP

 private:
  Zone* zone_;
};

// Specialization for static parameters of type {ContextAccess}.
template <>
struct StaticParameterTraits<ContextAccess> {
  static OStream& PrintTo(OStream& os, ContextAccess val) {  // NOLINT
    return os << val.depth() << "," << val.index()
              << (val.immutable() ? ",imm" : "");
  }
  static int HashCode(ContextAccess val) {
    return (val.depth() << 16) | (val.index() & 0xffff);
  }
  static bool Equals(ContextAccess a, ContextAccess b) {
    return a.immutable() == b.immutable() && a.depth() == b.depth() &&
           a.index() == b.index();
  }
};

// Specialization for static parameters of type {Runtime::FunctionId}.
template <>
struct StaticParameterTraits<Runtime::FunctionId> {
  static OStream& PrintTo(OStream& os, Runtime::FunctionId val) {  // NOLINT
    const Runtime::Function* f = Runtime::FunctionForId(val);
    return os << (f->name ? f->name : "?Runtime?");
  }
  static int HashCode(Runtime::FunctionId val) { return static_cast<int>(val); }
  static bool Equals(Runtime::FunctionId a, Runtime::FunctionId b) {
    return a == b;
  }
};

}  // namespace compiler
}  // namespace internal
}  // namespace v8

#endif  // V8_COMPILER_JS_OPERATOR_H_