//= LoongArchMCExpr.h - LoongArch specific MC expression classes -*- C++ -*-==//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
//
// This file describes LoongArch-specific MCExprs, used for modifiers like
// "%pc_hi20" or "%pc_lo12" etc.
//
//===----------------------------------------------------------------------===//

#ifndef LLVM_LIB_TARGET_LOONGARCH_MCTARGETDESC_LOONGARCHMCEXPR_H
#define LLVM_LIB_TARGET_LOONGARCH_MCTARGETDESC_LOONGARCHMCEXPR_H

#include "llvm/MC/MCExpr.h"

namespace llvm {

class StringRef;

class LoongArchMCExpr : public MCTargetExpr {
public:
  enum VariantKind {
    VK_LoongArch_None,
    VK_LoongArch_CALL,
    VK_LoongArch_CALL_PLT,
    VK_LoongArch_B16,
    VK_LoongArch_B21,
    VK_LoongArch_B26,
    VK_LoongArch_ABS_HI20,
    VK_LoongArch_ABS_LO12,
    VK_LoongArch_ABS64_LO20,
    VK_LoongArch_ABS64_HI12,
    VK_LoongArch_PCALA_HI20,
    VK_LoongArch_PCALA_LO12,
    VK_LoongArch_PCALA64_LO20,
    VK_LoongArch_PCALA64_HI12,
    VK_LoongArch_GOT_PC_HI20,
    VK_LoongArch_GOT_PC_LO12,
    VK_LoongArch_GOT64_PC_LO20,
    VK_LoongArch_GOT64_PC_HI12,
    VK_LoongArch_GOT_HI20,
    VK_LoongArch_GOT_LO12,
    VK_LoongArch_GOT64_LO20,
    VK_LoongArch_GOT64_HI12,
    VK_LoongArch_TLS_LE_HI20,
    VK_LoongArch_TLS_LE_LO12,
    VK_LoongArch_TLS_LE64_LO20,
    VK_LoongArch_TLS_LE64_HI12,
    VK_LoongArch_TLS_IE_PC_HI20,
    VK_LoongArch_TLS_IE_PC_LO12,
    VK_LoongArch_TLS_IE64_PC_LO20,
    VK_LoongArch_TLS_IE64_PC_HI12,
    VK_LoongArch_TLS_IE_HI20,
    VK_LoongArch_TLS_IE_LO12,
    VK_LoongArch_TLS_IE64_LO20,
    VK_LoongArch_TLS_IE64_HI12,
    VK_LoongArch_TLS_LD_PC_HI20,
    VK_LoongArch_TLS_LD_HI20,
    VK_LoongArch_TLS_GD_PC_HI20,
    VK_LoongArch_TLS_GD_HI20,
    VK_LoongArch_CALL36,
    VK_LoongArch_TLS_DESC_PC_HI20,
    VK_LoongArch_TLS_DESC_PC_LO12,
    VK_LoongArch_TLS_DESC64_PC_LO20,
    VK_LoongArch_TLS_DESC64_PC_HI12,
    VK_LoongArch_TLS_DESC_HI20,
    VK_LoongArch_TLS_DESC_LO12,
    VK_LoongArch_TLS_DESC64_LO20,
    VK_LoongArch_TLS_DESC64_HI12,
    VK_LoongArch_TLS_DESC_LD,
    VK_LoongArch_TLS_DESC_CALL,
    VK_LoongArch_TLS_LE_HI20_R,
    VK_LoongArch_TLS_LE_ADD_R,
    VK_LoongArch_TLS_LE_LO12_R,
    VK_LoongArch_PCREL20_S2,
    VK_LoongArch_TLS_LD_PCREL20_S2,
    VK_LoongArch_TLS_GD_PCREL20_S2,
    VK_LoongArch_TLS_DESC_PCREL20_S2,
    VK_LoongArch_Invalid // Must be the last item.
  };

private:
  const MCExpr *Expr;
  const VariantKind Kind;
  const bool RelaxHint;

  explicit LoongArchMCExpr(const MCExpr *Expr, VariantKind Kind, bool Hint)
      : Expr(Expr), Kind(Kind), RelaxHint(Hint) {}

public:
  static const LoongArchMCExpr *create(const MCExpr *Expr, VariantKind Kind,
                                       MCContext &Ctx, bool Hint = false);

  VariantKind getKind() const { return Kind; }
  const MCExpr *getSubExpr() const { return Expr; }
  bool getRelaxHint() const { return RelaxHint; }

  void printImpl(raw_ostream &OS, const MCAsmInfo *MAI) const override;
  bool evaluateAsRelocatableImpl(MCValue &Res, const MCAssembler *Asm,
                                 const MCFixup *Fixup) const override;
  void visitUsedExpr(MCStreamer &Streamer) const override;
  MCFragment *findAssociatedFragment() const override {
    return getSubExpr()->findAssociatedFragment();
  }

  void fixELFSymbolsInTLSFixups(MCAssembler &Asm) const override;

  static bool classof(const MCExpr *E) {
    return E->getKind() == MCExpr::Target;
  }

  static StringRef getVariantKindName(VariantKind Kind);
  static VariantKind getVariantKindForName(StringRef name);
};

} // end namespace llvm

#endif