1 //===- MCSymbolWasm.h -  ----------------------------------------*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 #ifndef LLVM_MC_MCSYMBOLWASM_H
9 #define LLVM_MC_MCSYMBOLWASM_H
10 
11 #include "llvm/BinaryFormat/Wasm.h"
12 #include "llvm/MC/MCSymbol.h"
13 
14 namespace llvm {
15 
16 class MCSymbolWasm : public MCSymbol {
17   wasm::WasmSymbolType Type = wasm::WASM_SYMBOL_TYPE_DATA;
18   bool IsWeak = false;
19   bool IsHidden = false;
20   bool IsComdat = false;
21   mutable bool IsUsedInInitArray = false;
22   mutable bool IsUsedInGOT = false;
23   Optional<StringRef> ImportModule;
24   Optional<StringRef> ImportName;
25   Optional<StringRef> ExportName;
26   wasm::WasmSignature *Signature = nullptr;
27   Optional<wasm::WasmGlobalType> GlobalType;
28   Optional<wasm::WasmEventType> EventType;
29 
30   /// An expression describing how to calculate the size of a symbol. If a
31   /// symbol has no size this field will be NULL.
32   const MCExpr *SymbolSize = nullptr;
33 
34 public:
MCSymbolWasm(const StringMapEntry<bool> * Name,bool isTemporary)35   MCSymbolWasm(const StringMapEntry<bool> *Name, bool isTemporary)
36       : MCSymbol(SymbolKindWasm, Name, isTemporary) {}
classof(const MCSymbol * S)37   static bool classof(const MCSymbol *S) { return S->isWasm(); }
38 
getSize()39   const MCExpr *getSize() const { return SymbolSize; }
setSize(const MCExpr * SS)40   void setSize(const MCExpr *SS) { SymbolSize = SS; }
41 
isFunction()42   bool isFunction() const { return Type == wasm::WASM_SYMBOL_TYPE_FUNCTION; }
isData()43   bool isData() const { return Type == wasm::WASM_SYMBOL_TYPE_DATA; }
isGlobal()44   bool isGlobal() const { return Type == wasm::WASM_SYMBOL_TYPE_GLOBAL; }
isSection()45   bool isSection() const { return Type == wasm::WASM_SYMBOL_TYPE_SECTION; }
isEvent()46   bool isEvent() const { return Type == wasm::WASM_SYMBOL_TYPE_EVENT; }
getType()47   wasm::WasmSymbolType getType() const { return Type; }
setType(wasm::WasmSymbolType type)48   void setType(wasm::WasmSymbolType type) { Type = type; }
49 
isExported()50   bool isExported() const {
51     return getFlags() & wasm::WASM_SYMBOL_EXPORTED;
52   }
setExported()53   void setExported() const {
54     modifyFlags(wasm::WASM_SYMBOL_EXPORTED, wasm::WASM_SYMBOL_EXPORTED);
55   }
56 
isNoStrip()57   bool isNoStrip() const {
58     return getFlags() & wasm::WASM_SYMBOL_NO_STRIP;
59   }
setNoStrip()60   void setNoStrip() const {
61     modifyFlags(wasm::WASM_SYMBOL_NO_STRIP, wasm::WASM_SYMBOL_NO_STRIP);
62   }
63 
isWeak()64   bool isWeak() const { return IsWeak; }
setWeak(bool isWeak)65   void setWeak(bool isWeak) { IsWeak = isWeak; }
66 
isHidden()67   bool isHidden() const { return IsHidden; }
setHidden(bool isHidden)68   void setHidden(bool isHidden) { IsHidden = isHidden; }
69 
isComdat()70   bool isComdat() const { return IsComdat; }
setComdat(bool isComdat)71   void setComdat(bool isComdat) { IsComdat = isComdat; }
72 
hasImportModule()73   bool hasImportModule() const { return ImportModule.hasValue(); }
getImportModule()74   StringRef getImportModule() const {
75     if (ImportModule.hasValue())
76       return ImportModule.getValue();
77     // Use a default module name of "env" for now, for compatibility with
78     // existing tools.
79     // TODO(sbc): Find a way to specify a default value in the object format
80     // without picking a hardcoded value like this.
81     return "env";
82   }
setImportModule(StringRef Name)83   void setImportModule(StringRef Name) { ImportModule = Name; }
84 
hasImportName()85   bool hasImportName() const { return ImportName.hasValue(); }
getImportName()86   StringRef getImportName() const {
87     if (ImportName.hasValue())
88       return ImportName.getValue();
89     return getName();
90   }
setImportName(StringRef Name)91   void setImportName(StringRef Name) { ImportName = Name; }
92 
hasExportName()93   bool hasExportName() const { return ExportName.hasValue(); }
getExportName()94   StringRef getExportName() const { return ExportName.getValue(); }
setExportName(StringRef Name)95   void setExportName(StringRef Name) { ExportName = Name; }
96 
setUsedInGOT()97   void setUsedInGOT() const { IsUsedInGOT = true; }
isUsedInGOT()98   bool isUsedInGOT() const { return IsUsedInGOT; }
99 
setUsedInInitArray()100   void setUsedInInitArray() const { IsUsedInInitArray = true; }
isUsedInInitArray()101   bool isUsedInInitArray() const { return IsUsedInInitArray; }
102 
getSignature()103   const wasm::WasmSignature *getSignature() const { return Signature; }
setSignature(wasm::WasmSignature * Sig)104   void setSignature(wasm::WasmSignature *Sig) { Signature = Sig; }
105 
getGlobalType()106   const wasm::WasmGlobalType &getGlobalType() const {
107     assert(GlobalType.hasValue());
108     return GlobalType.getValue();
109   }
setGlobalType(wasm::WasmGlobalType GT)110   void setGlobalType(wasm::WasmGlobalType GT) { GlobalType = GT; }
111 
getEventType()112   const wasm::WasmEventType &getEventType() const {
113     assert(EventType.hasValue());
114     return EventType.getValue();
115   }
setEventType(wasm::WasmEventType ET)116   void setEventType(wasm::WasmEventType ET) { EventType = ET; }
117 };
118 
119 } // end namespace llvm
120 
121 #endif // LLVM_MC_MCSYMBOLWASM_H
122