1 //===- llvm/MC/MCCodeEmitter.h - Instruction Encoding -----------*- 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 9 #ifndef LLVM_MC_MCCODEEMITTER_H 10 #define LLVM_MC_MCCODEEMITTER_H 11 12 namespace llvm { 13 14 class MCFixup; 15 class MCInst; 16 class MCSubtargetInfo; 17 class raw_ostream; 18 template<typename T> class SmallVectorImpl; 19 20 /// MCCodeEmitter - Generic instruction encoding interface. 21 class MCCodeEmitter { 22 protected: // Can only create subclasses. 23 MCCodeEmitter(); 24 25 public: 26 MCCodeEmitter(const MCCodeEmitter &) = delete; 27 MCCodeEmitter &operator=(const MCCodeEmitter &) = delete; 28 virtual ~MCCodeEmitter(); 29 30 /// Lifetime management reset()31 virtual void reset() {} 32 33 /// Emit the prefixes of given instruction on the output stream. 34 /// 35 /// \param Inst a single low-level machine instruction. 36 /// \param OS output stream. emitPrefix(const MCInst & Inst,raw_ostream & OS,const MCSubtargetInfo & STI)37 virtual void emitPrefix(const MCInst &Inst, raw_ostream &OS, 38 const MCSubtargetInfo &STI) const {} 39 /// EncodeInstruction - Encode the given \p Inst to bytes on the output 40 /// stream \p OS. 41 virtual void encodeInstruction(const MCInst &Inst, raw_ostream &OS, 42 SmallVectorImpl<MCFixup> &Fixups, 43 const MCSubtargetInfo &STI) const = 0; 44 }; 45 46 } // end namespace llvm 47 48 #endif // LLVM_MC_MCCODEEMITTER_H 49