10e664016466b3c9118a830d334956ead0fa164f
[oota-llvm.git] / include / llvm / MC / MCExpr.h
1 //===- MCExpr.h - Assembly Level Expressions --------------------*- C++ -*-===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9
10 #ifndef LLVM_MC_MCEXPR_H
11 #define LLVM_MC_MCEXPR_H
12
13 #include "llvm/ADT/DenseMap.h"
14 #include "llvm/Support/Casting.h"
15 #include "llvm/Support/DataTypes.h"
16
17 namespace llvm {
18 class MCAsmInfo;
19 class MCAsmLayout;
20 class MCAssembler;
21 class MCContext;
22 class MCFixup;
23 class MCSection;
24 class MCSectionData;
25 class MCStreamer;
26 class MCSymbol;
27 class MCValue;
28 class raw_ostream;
29 class StringRef;
30 typedef DenseMap<const MCSectionData*, uint64_t> SectionAddrMap;
31
32 /// \brief Base class for the full range of assembler expressions which are
33 /// needed for parsing.
34 class MCExpr {
35 public:
36   enum ExprKind {
37     Binary,    ///< Binary expressions.
38     Constant,  ///< Constant expressions.
39     SymbolRef, ///< References to labels and assigned expressions.
40     Unary,     ///< Unary expressions.
41     Target     ///< Target specific expression.
42   };
43
44 private:
45   ExprKind Kind;
46
47   MCExpr(const MCExpr&) = delete;
48   void operator=(const MCExpr&) = delete;
49
50   bool EvaluateAsAbsolute(int64_t &Res, const MCAssembler *Asm,
51                           const MCAsmLayout *Layout,
52                           const SectionAddrMap *Addrs) const;
53
54   bool evaluateAsAbsolute(int64_t &Res, const MCAssembler *Asm,
55                           const MCAsmLayout *Layout,
56                           const SectionAddrMap *Addrs, bool InSet) const;
57
58 protected:
59   explicit MCExpr(ExprKind Kind) : Kind(Kind) {}
60
61   bool EvaluateAsRelocatableImpl(MCValue &Res, const MCAssembler *Asm,
62                                  const MCAsmLayout *Layout,
63                                  const MCFixup *Fixup,
64                                  const SectionAddrMap *Addrs, bool InSet) const;
65
66 public:
67   /// \name Accessors
68   /// @{
69
70   ExprKind getKind() const { return Kind; }
71
72   /// @}
73   /// \name Utility Methods
74   /// @{
75
76   void print(raw_ostream &OS) const;
77   void dump() const;
78
79   /// @}
80   /// \name Expression Evaluation
81   /// @{
82
83   /// \brief Try to evaluate the expression to an absolute value.
84   ///
85   /// \param Res - The absolute value, if evaluation succeeds.
86   /// \param Layout - The assembler layout object to use for evaluating symbol
87   /// values. If not given, then only non-symbolic expressions will be
88   /// evaluated.
89   /// \return - True on success.
90   bool EvaluateAsAbsolute(int64_t &Res, const MCAsmLayout &Layout,
91                           const SectionAddrMap &Addrs) const;
92   bool EvaluateAsAbsolute(int64_t &Res) const;
93   bool EvaluateAsAbsolute(int64_t &Res, const MCAssembler &Asm) const;
94   bool EvaluateAsAbsolute(int64_t &Res, const MCAsmLayout &Layout) const;
95
96   bool evaluateKnownAbsolute(int64_t &Res, const MCAsmLayout &Layout) const;
97
98   /// \brief Try to evaluate the expression to a relocatable value, i.e. an
99   /// expression of the fixed form (a - b + constant).
100   ///
101   /// \param Res - The relocatable value, if evaluation succeeds.
102   /// \param Layout - The assembler layout object to use for evaluating values.
103   /// \param Fixup - The Fixup object if available.
104   /// \return - True on success.
105   bool EvaluateAsRelocatable(MCValue &Res, const MCAsmLayout *Layout,
106                              const MCFixup *Fixup) const;
107
108   /// \brief Try to evaluate the expression to the form (a - b + constant) where
109   /// neither a nor b are variables.
110   ///
111   /// This is a more aggressive variant of EvaluateAsRelocatable. The intended
112   /// use is for when relocations are not available, like the .size directive.
113   bool evaluateAsValue(MCValue &Res, const MCAsmLayout &Layout) const;
114
115   /// \brief Find the "associated section" for this expression, which is
116   /// currently defined as the absolute section for constants, or
117   /// otherwise the section associated with the first defined symbol in the
118   /// expression.
119   const MCSection *FindAssociatedSection() const;
120
121   /// @}
122 };
123
124 inline raw_ostream &operator<<(raw_ostream &OS, const MCExpr &E) {
125   E.print(OS);
126   return OS;
127 }
128
129 //// \brief  Represent a constant integer expression.
130 class MCConstantExpr : public MCExpr {
131   int64_t Value;
132
133   explicit MCConstantExpr(int64_t Value)
134       : MCExpr(MCExpr::Constant), Value(Value) {}
135
136 public:
137   /// \name Construction
138   /// @{
139
140   static const MCConstantExpr *Create(int64_t Value, MCContext &Ctx);
141
142   /// @}
143   /// \name Accessors
144   /// @{
145
146   int64_t getValue() const { return Value; }
147
148   /// @}
149
150   static bool classof(const MCExpr *E) {
151     return E->getKind() == MCExpr::Constant;
152   }
153 };
154
155 /// \brief  Represent a reference to a symbol from inside an expression.
156 ///
157 /// A symbol reference in an expression may be a use of a label, a use of an
158 /// assembler variable (defined constant), or constitute an implicit definition
159 /// of the symbol as external.
160 class MCSymbolRefExpr : public MCExpr {
161 public:
162   enum VariantKind : uint16_t {
163     VK_None,
164     VK_Invalid,
165
166     VK_GOT,
167     VK_GOTOFF,
168     VK_GOTPCREL,
169     VK_GOTTPOFF,
170     VK_INDNTPOFF,
171     VK_NTPOFF,
172     VK_GOTNTPOFF,
173     VK_PLT,
174     VK_TLSGD,
175     VK_TLSLD,
176     VK_TLSLDM,
177     VK_TPOFF,
178     VK_DTPOFF,
179     VK_TLVP,      // Mach-O thread local variable relocations
180     VK_TLVPPAGE,
181     VK_TLVPPAGEOFF,
182     VK_PAGE,
183     VK_PAGEOFF,
184     VK_GOTPAGE,
185     VK_GOTPAGEOFF,
186     VK_SECREL,
187     VK_SIZE,      // symbol@SIZE
188     VK_WEAKREF,   // The link between the symbols in .weakref foo, bar
189
190     VK_ARM_NONE,
191     VK_ARM_TARGET1,
192     VK_ARM_TARGET2,
193     VK_ARM_PREL31,
194     VK_ARM_SBREL,          // symbol(sbrel)
195     VK_ARM_TLSLDO,         // symbol(tlsldo)
196     VK_ARM_TLSCALL,        // symbol(tlscall)
197     VK_ARM_TLSDESC,        // symbol(tlsdesc)
198     VK_ARM_TLSDESCSEQ,
199
200     VK_PPC_LO,             // symbol@l
201     VK_PPC_HI,             // symbol@h
202     VK_PPC_HA,             // symbol@ha
203     VK_PPC_HIGHER,         // symbol@higher
204     VK_PPC_HIGHERA,        // symbol@highera
205     VK_PPC_HIGHEST,        // symbol@highest
206     VK_PPC_HIGHESTA,       // symbol@highesta
207     VK_PPC_GOT_LO,         // symbol@got@l
208     VK_PPC_GOT_HI,         // symbol@got@h
209     VK_PPC_GOT_HA,         // symbol@got@ha
210     VK_PPC_TOCBASE,        // symbol@tocbase
211     VK_PPC_TOC,            // symbol@toc
212     VK_PPC_TOC_LO,         // symbol@toc@l
213     VK_PPC_TOC_HI,         // symbol@toc@h
214     VK_PPC_TOC_HA,         // symbol@toc@ha
215     VK_PPC_DTPMOD,         // symbol@dtpmod
216     VK_PPC_TPREL,          // symbol@tprel
217     VK_PPC_TPREL_LO,       // symbol@tprel@l
218     VK_PPC_TPREL_HI,       // symbol@tprel@h
219     VK_PPC_TPREL_HA,       // symbol@tprel@ha
220     VK_PPC_TPREL_HIGHER,   // symbol@tprel@higher
221     VK_PPC_TPREL_HIGHERA,  // symbol@tprel@highera
222     VK_PPC_TPREL_HIGHEST,  // symbol@tprel@highest
223     VK_PPC_TPREL_HIGHESTA, // symbol@tprel@highesta
224     VK_PPC_DTPREL,         // symbol@dtprel
225     VK_PPC_DTPREL_LO,      // symbol@dtprel@l
226     VK_PPC_DTPREL_HI,      // symbol@dtprel@h
227     VK_PPC_DTPREL_HA,      // symbol@dtprel@ha
228     VK_PPC_DTPREL_HIGHER,  // symbol@dtprel@higher
229     VK_PPC_DTPREL_HIGHERA, // symbol@dtprel@highera
230     VK_PPC_DTPREL_HIGHEST, // symbol@dtprel@highest
231     VK_PPC_DTPREL_HIGHESTA,// symbol@dtprel@highesta
232     VK_PPC_GOT_TPREL,      // symbol@got@tprel
233     VK_PPC_GOT_TPREL_LO,   // symbol@got@tprel@l
234     VK_PPC_GOT_TPREL_HI,   // symbol@got@tprel@h
235     VK_PPC_GOT_TPREL_HA,   // symbol@got@tprel@ha
236     VK_PPC_GOT_DTPREL,     // symbol@got@dtprel
237     VK_PPC_GOT_DTPREL_LO,  // symbol@got@dtprel@l
238     VK_PPC_GOT_DTPREL_HI,  // symbol@got@dtprel@h
239     VK_PPC_GOT_DTPREL_HA,  // symbol@got@dtprel@ha
240     VK_PPC_TLS,            // symbol@tls
241     VK_PPC_GOT_TLSGD,      // symbol@got@tlsgd
242     VK_PPC_GOT_TLSGD_LO,   // symbol@got@tlsgd@l
243     VK_PPC_GOT_TLSGD_HI,   // symbol@got@tlsgd@h
244     VK_PPC_GOT_TLSGD_HA,   // symbol@got@tlsgd@ha
245     VK_PPC_TLSGD,          // symbol@tlsgd
246     VK_PPC_GOT_TLSLD,      // symbol@got@tlsld
247     VK_PPC_GOT_TLSLD_LO,   // symbol@got@tlsld@l
248     VK_PPC_GOT_TLSLD_HI,   // symbol@got@tlsld@h
249     VK_PPC_GOT_TLSLD_HA,   // symbol@got@tlsld@ha
250     VK_PPC_TLSLD,          // symbol@tlsld
251     VK_PPC_LOCAL,          // symbol@local
252
253     VK_Mips_GPREL,
254     VK_Mips_GOT_CALL,
255     VK_Mips_GOT16,
256     VK_Mips_GOT,
257     VK_Mips_ABS_HI,
258     VK_Mips_ABS_LO,
259     VK_Mips_TLSGD,
260     VK_Mips_TLSLDM,
261     VK_Mips_DTPREL_HI,
262     VK_Mips_DTPREL_LO,
263     VK_Mips_GOTTPREL,
264     VK_Mips_TPREL_HI,
265     VK_Mips_TPREL_LO,
266     VK_Mips_GPOFF_HI,
267     VK_Mips_GPOFF_LO,
268     VK_Mips_GOT_DISP,
269     VK_Mips_GOT_PAGE,
270     VK_Mips_GOT_OFST,
271     VK_Mips_HIGHER,
272     VK_Mips_HIGHEST,
273     VK_Mips_GOT_HI16,
274     VK_Mips_GOT_LO16,
275     VK_Mips_CALL_HI16,
276     VK_Mips_CALL_LO16,
277     VK_Mips_PCREL_HI16,
278     VK_Mips_PCREL_LO16,
279
280     VK_COFF_IMGREL32, // symbol@imgrel (image-relative)
281
282     VK_Hexagon_PCREL,
283     VK_Hexagon_LO16,
284     VK_Hexagon_HI16,
285     VK_Hexagon_GPREL,
286     VK_Hexagon_GD_GOT,
287     VK_Hexagon_LD_GOT,
288     VK_Hexagon_GD_PLT,
289     VK_Hexagon_LD_PLT,
290     VK_Hexagon_IE,
291     VK_Hexagon_IE_GOT,
292     VK_TPREL,
293     VK_DTPREL
294   };
295
296 private:
297   /// The symbol reference modifier.
298   const VariantKind Kind;
299
300   /// Specifies how the variant kind should be printed.
301   const unsigned UseParensForSymbolVariant : 1;
302
303   // FIXME: Remove this bit.
304   const unsigned HasSubsectionsViaSymbols : 1;
305
306   /// The symbol being referenced.
307   const MCSymbol *Symbol;
308
309   explicit MCSymbolRefExpr(const MCSymbol *Symbol, VariantKind Kind,
310                            const MCAsmInfo *MAI);
311
312 public:
313   /// \name Construction
314   /// @{
315
316   static const MCSymbolRefExpr *Create(const MCSymbol *Symbol, MCContext &Ctx) {
317     return MCSymbolRefExpr::Create(Symbol, VK_None, Ctx);
318   }
319
320   static const MCSymbolRefExpr *Create(const MCSymbol *Symbol, VariantKind Kind,
321                                        MCContext &Ctx);
322   static const MCSymbolRefExpr *Create(StringRef Name, VariantKind Kind,
323                                        MCContext &Ctx);
324
325   /// @}
326   /// \name Accessors
327   /// @{
328
329   const MCSymbol &getSymbol() const { return *Symbol; }
330
331   VariantKind getKind() const { return Kind; }
332
333   void printVariantKind(raw_ostream &OS) const;
334
335   bool hasSubsectionsViaSymbols() const { return HasSubsectionsViaSymbols; }
336
337   /// @}
338   /// \name Static Utility Functions
339   /// @{
340
341   static StringRef getVariantKindName(VariantKind Kind);
342
343   static VariantKind getVariantKindForName(StringRef Name);
344
345   /// @}
346
347   static bool classof(const MCExpr *E) {
348     return E->getKind() == MCExpr::SymbolRef;
349   }
350 };
351
352 /// \brief Unary assembler expressions.
353 class MCUnaryExpr : public MCExpr {
354 public:
355   enum Opcode {
356     LNot,  ///< Logical negation.
357     Minus, ///< Unary minus.
358     Not,   ///< Bitwise negation.
359     Plus   ///< Unary plus.
360   };
361
362 private:
363   Opcode Op;
364   const MCExpr *Expr;
365
366   MCUnaryExpr(Opcode Op, const MCExpr *Expr)
367       : MCExpr(MCExpr::Unary), Op(Op), Expr(Expr) {}
368
369 public:
370   /// \name Construction
371   /// @{
372
373   static const MCUnaryExpr *Create(Opcode Op, const MCExpr *Expr,
374                                    MCContext &Ctx);
375   static const MCUnaryExpr *CreateLNot(const MCExpr *Expr, MCContext &Ctx) {
376     return Create(LNot, Expr, Ctx);
377   }
378   static const MCUnaryExpr *CreateMinus(const MCExpr *Expr, MCContext &Ctx) {
379     return Create(Minus, Expr, Ctx);
380   }
381   static const MCUnaryExpr *CreateNot(const MCExpr *Expr, MCContext &Ctx) {
382     return Create(Not, Expr, Ctx);
383   }
384   static const MCUnaryExpr *CreatePlus(const MCExpr *Expr, MCContext &Ctx) {
385     return Create(Plus, Expr, Ctx);
386   }
387
388   /// @}
389   /// \name Accessors
390   /// @{
391
392   /// \brief Get the kind of this unary expression.
393   Opcode getOpcode() const { return Op; }
394
395   /// \brief Get the child of this unary expression.
396   const MCExpr *getSubExpr() const { return Expr; }
397
398   /// @}
399
400   static bool classof(const MCExpr *E) {
401     return E->getKind() == MCExpr::Unary;
402   }
403 };
404
405 /// \brief Binary assembler expressions.
406 class MCBinaryExpr : public MCExpr {
407 public:
408   enum Opcode {
409     Add,  ///< Addition.
410     And,  ///< Bitwise and.
411     Div,  ///< Signed division.
412     EQ,   ///< Equality comparison.
413     GT,   ///< Signed greater than comparison (result is either 0 or some
414           ///< target-specific non-zero value)
415     GTE,  ///< Signed greater than or equal comparison (result is either 0 or
416           ///< some target-specific non-zero value).
417     LAnd, ///< Logical and.
418     LOr,  ///< Logical or.
419     LT,   ///< Signed less than comparison (result is either 0 or
420           ///< some target-specific non-zero value).
421     LTE,  ///< Signed less than or equal comparison (result is either 0 or
422           ///< some target-specific non-zero value).
423     Mod,  ///< Signed remainder.
424     Mul,  ///< Multiplication.
425     NE,   ///< Inequality comparison.
426     Or,   ///< Bitwise or.
427     Shl,  ///< Shift left.
428     AShr, ///< Arithmetic shift right.
429     LShr, ///< Logical shift right.
430     Sub,  ///< Subtraction.
431     Xor   ///< Bitwise exclusive or.
432   };
433
434 private:
435   Opcode Op;
436   const MCExpr *LHS, *RHS;
437
438   MCBinaryExpr(Opcode Op, const MCExpr *LHS, const MCExpr *RHS)
439       : MCExpr(MCExpr::Binary), Op(Op), LHS(LHS), RHS(RHS) {}
440
441 public:
442   /// \name Construction
443   /// @{
444
445   static const MCBinaryExpr *Create(Opcode Op, const MCExpr *LHS,
446                                     const MCExpr *RHS, MCContext &Ctx);
447   static const MCBinaryExpr *CreateAdd(const MCExpr *LHS, const MCExpr *RHS,
448                                        MCContext &Ctx) {
449     return Create(Add, LHS, RHS, Ctx);
450   }
451   static const MCBinaryExpr *CreateAnd(const MCExpr *LHS, const MCExpr *RHS,
452                                        MCContext &Ctx) {
453     return Create(And, LHS, RHS, Ctx);
454   }
455   static const MCBinaryExpr *CreateDiv(const MCExpr *LHS, const MCExpr *RHS,
456                                        MCContext &Ctx) {
457     return Create(Div, LHS, RHS, Ctx);
458   }
459   static const MCBinaryExpr *CreateEQ(const MCExpr *LHS, const MCExpr *RHS,
460                                       MCContext &Ctx) {
461     return Create(EQ, LHS, RHS, Ctx);
462   }
463   static const MCBinaryExpr *CreateGT(const MCExpr *LHS, const MCExpr *RHS,
464                                       MCContext &Ctx) {
465     return Create(GT, LHS, RHS, Ctx);
466   }
467   static const MCBinaryExpr *CreateGTE(const MCExpr *LHS, const MCExpr *RHS,
468                                        MCContext &Ctx) {
469     return Create(GTE, LHS, RHS, Ctx);
470   }
471   static const MCBinaryExpr *CreateLAnd(const MCExpr *LHS, const MCExpr *RHS,
472                                         MCContext &Ctx) {
473     return Create(LAnd, LHS, RHS, Ctx);
474   }
475   static const MCBinaryExpr *CreateLOr(const MCExpr *LHS, const MCExpr *RHS,
476                                        MCContext &Ctx) {
477     return Create(LOr, LHS, RHS, Ctx);
478   }
479   static const MCBinaryExpr *CreateLT(const MCExpr *LHS, const MCExpr *RHS,
480                                       MCContext &Ctx) {
481     return Create(LT, LHS, RHS, Ctx);
482   }
483   static const MCBinaryExpr *CreateLTE(const MCExpr *LHS, const MCExpr *RHS,
484                                        MCContext &Ctx) {
485     return Create(LTE, LHS, RHS, Ctx);
486   }
487   static const MCBinaryExpr *CreateMod(const MCExpr *LHS, const MCExpr *RHS,
488                                        MCContext &Ctx) {
489     return Create(Mod, LHS, RHS, Ctx);
490   }
491   static const MCBinaryExpr *CreateMul(const MCExpr *LHS, const MCExpr *RHS,
492                                        MCContext &Ctx) {
493     return Create(Mul, LHS, RHS, Ctx);
494   }
495   static const MCBinaryExpr *CreateNE(const MCExpr *LHS, const MCExpr *RHS,
496                                       MCContext &Ctx) {
497     return Create(NE, LHS, RHS, Ctx);
498   }
499   static const MCBinaryExpr *CreateOr(const MCExpr *LHS, const MCExpr *RHS,
500                                       MCContext &Ctx) {
501     return Create(Or, LHS, RHS, Ctx);
502   }
503   static const MCBinaryExpr *CreateShl(const MCExpr *LHS, const MCExpr *RHS,
504                                        MCContext &Ctx) {
505     return Create(Shl, LHS, RHS, Ctx);
506   }
507   static const MCBinaryExpr *CreateAShr(const MCExpr *LHS, const MCExpr *RHS,
508                                        MCContext &Ctx) {
509     return Create(AShr, LHS, RHS, Ctx);
510   }
511   static const MCBinaryExpr *CreateLShr(const MCExpr *LHS, const MCExpr *RHS,
512                                        MCContext &Ctx) {
513     return Create(LShr, LHS, RHS, Ctx);
514   }
515   static const MCBinaryExpr *CreateSub(const MCExpr *LHS, const MCExpr *RHS,
516                                        MCContext &Ctx) {
517     return Create(Sub, LHS, RHS, Ctx);
518   }
519   static const MCBinaryExpr *CreateXor(const MCExpr *LHS, const MCExpr *RHS,
520                                        MCContext &Ctx) {
521     return Create(Xor, LHS, RHS, Ctx);
522   }
523
524   /// @}
525   /// \name Accessors
526   /// @{
527
528   /// \brief Get the kind of this binary expression.
529   Opcode getOpcode() const { return Op; }
530
531   /// \brief Get the left-hand side expression of the binary operator.
532   const MCExpr *getLHS() const { return LHS; }
533
534   /// \brief Get the right-hand side expression of the binary operator.
535   const MCExpr *getRHS() const { return RHS; }
536
537   /// @}
538
539   static bool classof(const MCExpr *E) {
540     return E->getKind() == MCExpr::Binary;
541   }
542 };
543
544 /// \brief This is an extension point for target-specific MCExpr subclasses to
545 /// implement.
546 ///
547 /// NOTE: All subclasses are required to have trivial destructors because
548 /// MCExprs are bump pointer allocated and not destructed.
549 class MCTargetExpr : public MCExpr {
550   virtual void anchor();
551 protected:
552   MCTargetExpr() : MCExpr(Target) {}
553   virtual ~MCTargetExpr() {}
554 public:
555
556   virtual void PrintImpl(raw_ostream &OS) const = 0;
557   virtual bool EvaluateAsRelocatableImpl(MCValue &Res,
558                                          const MCAsmLayout *Layout,
559                                          const MCFixup *Fixup) const = 0;
560   virtual void visitUsedExpr(MCStreamer& Streamer) const = 0;
561   virtual const MCSection *FindAssociatedSection() const = 0;
562
563   virtual void fixELFSymbolsInTLSFixups(MCAssembler &) const = 0;
564
565   static bool classof(const MCExpr *E) {
566     return E->getKind() == MCExpr::Target;
567   }
568 };
569
570 } // end namespace llvm
571
572 #endif