1 //===-- AVRMCCodeEmitter.h - Convert AVR Code to Machine Code -------------===//
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 // This file defines the AVRMCCodeEmitter class.
11 //
12 //===----------------------------------------------------------------------===//
13 //
14 
15 #ifndef LLVM_AVR_CODE_EMITTER_H
16 #define LLVM_AVR_CODE_EMITTER_H
17 
18 #include "AVRFixupKinds.h"
19 
20 #include "llvm/MC/MCCodeEmitter.h"
21 #include "llvm/Support/DataTypes.h"
22 
23 #define GET_INSTRINFO_OPERAND_TYPES_ENUM
24 #include "AVRGenInstrInfo.inc"
25 
26 namespace llvm {
27 
28 class MCContext;
29 class MCExpr;
30 class MCFixup;
31 class MCInst;
32 class MCInstrInfo;
33 class MCOperand;
34 class MCSubtargetInfo;
35 class raw_ostream;
36 
37 /// Writes AVR machine code to a stream.
38 class AVRMCCodeEmitter : public MCCodeEmitter {
39 public:
40   AVRMCCodeEmitter(const MCInstrInfo &MCII, MCContext &Ctx)
41       : MCII(MCII), Ctx(Ctx) {}
42 
43 private:
44   /// Finishes up encoding an LD/ST instruction.
45   /// The purpose of this function is to set an bit in the instruction
46   /// which follows no logical pattern. See the implementation for details.
47   unsigned loadStorePostEncoder(const MCInst &MI, unsigned EncodedValue,
48                                 const MCSubtargetInfo &STI) const;
49 
50   /// Gets the encoding for a conditional branch target.
51   template <AVR::Fixups Fixup>
52   unsigned encodeRelCondBrTarget(const MCInst &MI, unsigned OpNo,
53                                  SmallVectorImpl<MCFixup> &Fixups,
54                                  const MCSubtargetInfo &STI) const;
55 
56   /// Encodes the `PTRREGS` operand to a load or store instruction.
57   unsigned encodeLDSTPtrReg(const MCInst &MI, unsigned OpNo,
58                             SmallVectorImpl<MCFixup> &Fixups,
59                             const MCSubtargetInfo &STI) const;
60 
61   /// Encodes a `register+immediate` operand for `LDD`/`STD`.
62   unsigned encodeMemri(const MCInst &MI, unsigned OpNo,
63                        SmallVectorImpl<MCFixup> &Fixups,
64                        const MCSubtargetInfo &STI) const;
65 
66   /// Takes the compliment of a number (~0 - val).
67   unsigned encodeComplement(const MCInst &MI, unsigned OpNo,
68                             SmallVectorImpl<MCFixup> &Fixups,
69                             const MCSubtargetInfo &STI) const;
70 
71   /// Encodes an immediate value with a given fixup.
72   template <AVR::Fixups Fixup>
73   unsigned encodeImm(const MCInst &MI, unsigned OpNo,
74                      SmallVectorImpl<MCFixup> &Fixups,
75                      const MCSubtargetInfo &STI) const;
76 
77   /// Gets the encoding of the target for the `CALL k` instruction.
78   unsigned encodeCallTarget(const MCInst &MI, unsigned OpNo,
79                             SmallVectorImpl<MCFixup> &Fixups,
80                             const MCSubtargetInfo &STI) const;
81 
82   /// TableGen'ed function to get the binary encoding for an instruction.
83   uint64_t getBinaryCodeForInstr(const MCInst &MI,
84                                  SmallVectorImpl<MCFixup> &Fixups,
85                                  const MCSubtargetInfo &STI) const;
86 
87   unsigned getExprOpValue(const MCExpr *Expr, SmallVectorImpl<MCFixup> &Fixups,
88                           const MCSubtargetInfo &STI) const;
89 
90   /// Returns the binary encoding of operand.
91   ///
92   /// If the machine operand requires relocation, the relocation is recorded
93   /// and zero is returned.
94   unsigned getMachineOpValue(const MCInst &MI, const MCOperand &MO,
95                              SmallVectorImpl<MCFixup> &Fixups,
96                              const MCSubtargetInfo &STI) const;
97 
98   void emitInstruction(uint64_t Val, unsigned Size, const MCSubtargetInfo &STI,
99                        raw_ostream &OS) const;
100 
101   void encodeInstruction(const MCInst &MI, raw_ostream &OS,
102                          SmallVectorImpl<MCFixup> &Fixups,
103                          const MCSubtargetInfo &STI) const override;
104 
105   AVRMCCodeEmitter(const AVRMCCodeEmitter &) = delete;
106   void operator=(const AVRMCCodeEmitter &) = delete;
107 
108   const MCInstrInfo &MCII;
109   MCContext &Ctx;
110 };
111 
112 } // end namespace of llvm.
113 
114 #endif // LLVM_AVR_CODE_EMITTER_H
115 
116