blob: f28c00faee18fa5422f3be5a1b1f05beec430d46 [file] [log] [blame]
//===-- llvm/CodeGen/AsmPrinter.h - AsmPrinter Framework --------*- C++ -*-===//
// The LLVM Compiler Infrastructure
// This file was developed by the LLVM research group and is distributed under
// the University of Illinois Open Source License. See LICENSE.TXT for details.
// This class is intended to be used as a base class for target-specific
// asmwriters. This class primarily takes care of printing global constants,
// which are printed in a very similar way across all targets.
#include "llvm/CodeGen/MachineFunctionPass.h"
#include "llvm/Support/DataTypes.h"
namespace llvm {
class Constant;
class Mangler;
class AsmPrinter : public MachineFunctionPass {
/// Output stream on which we're printing assembly code.
std::ostream &O;
/// Target machine description.
TargetMachine &TM;
/// Name-mangler for global names.
Mangler *Mang;
/// Cache of mangled name for current function. This is recalculated at the
/// beginning of each call to runOnMachineFunction().
std::string CurrentFnName;
// Properties to be set by the derived class ctor, used to configure the
// asmwriter.
/// CommentString - This indicates the comment character used by the
/// assembler.
const char *CommentString; // Defaults to "#"
/// GlobalPrefix - If this is set to a non-empty string, it is prepended
/// onto all global symbols. This is often used for "_" or ".".
const char *GlobalPrefix; // Defaults to ""
/// GlobalVarAddrPrefix/Suffix - If these are nonempty, these strings
/// will enclose any GlobalVariable (that isn't a function)
const char *GlobalVarAddrPrefix; // Defaults to ""
const char *GlobalVarAddrSuffix; // Defaults to ""
/// FunctionAddrPrefix/Suffix - If these are nonempty, these strings
/// will enclose any GlobalVariable that points to a function.
/// For example, this is used by the IA64 backend to materialize
/// function descriptors, by decorating the ".data8" object with the
/// @fptr( ) link-relocation operator.
const char *FunctionAddrPrefix; // Defaults to ""
const char *FunctionAddrSuffix; // Defaults to ""
/// ZeroDirective - this should be set to the directive used to get some
/// number of zero bytes emitted to the current section. Common cases are
/// "\\t" and "\\t". If this is set to null, the
/// Data*bitsDirective's will be used to emit zero bytes.
const char *ZeroDirective; // Defaults to "\\t"
/// AsciiDirective - This directive allows emission of an ascii string with
/// the standard C escape characters embedded into it.
const char *AsciiDirective;
/// DataDirectives - These directives are used to output some unit of
/// integer data to the current section. If a data directive is set to
/// null, smaller data directives will be used to emit the large sizes.
const char *Data8bitsDirective; // Defaults to "\t.byte\t"
const char *Data16bitsDirective; // Defaults to "\t.short\t"
const char *Data32bitsDirective; // Defaults to "\t.long\t"
const char *Data64bitsDirective; // Defaults to "\t.quad\t"
/// AlignDirective - The directive used to emit round up to an alignment
/// boundary.
const char *AlignDirective; // Defaults to "\t.align\t"
/// AlignmentIsInBytes - If this is true (the default) then the asmprinter
/// emits ".align N" directives, where N is the number of bytes to align to.
/// Otherwise, it emits ".align log2(N)", e.g. 3 to align to an 8 byte
/// boundary.
bool AlignmentIsInBytes; // Defaults to true
AsmPrinter(std::ostream &o, TargetMachine &tm)
: O(o), TM(tm),
AlignmentIsInBytes(true) {
/// doInitialization - Set up the AsmPrinter when we are working on a new
/// module. If your pass overrides this, it must make sure to explicitly
/// call this implementation.
bool doInitialization(Module &M);
/// doFinalization - Shut down the asmprinter. If you override this in your
/// pass, you must make sure to call it explicitly.
bool doFinalization(Module &M);
/// setupMachineFunction - This should be called when a new MachineFunction
/// is being processed from runOnMachineFunction.
void setupMachineFunction(MachineFunction &MF);
/// emitAlignment - Emit an alignment directive to the specified power of
/// two boundary. For example, if you pass in 3 here, you will get an 8
/// byte alignment.
void emitAlignment(unsigned NumBits) const;
/// emitZeros - Emit a block of zeros.
void emitZeros(uint64_t NumZeros) const;
/// emitConstantValueOnly - Print out the specified constant, without a
/// storage class. Only constants of first-class type are allowed here.
void emitConstantValueOnly(const Constant *CV);
/// emitGlobalConstant - Print a general LLVM constant to the .s file.
void emitGlobalConstant(const Constant* CV);