2008-08-17 18:44:35 +00:00
|
|
|
//===-- OcamlGCPrinter.cpp - Ocaml frametable emitter ---------------------===//
|
2008-01-07 02:31:11 +00:00
|
|
|
//
|
|
|
|
// The LLVM Compiler Infrastructure
|
|
|
|
//
|
|
|
|
// This file is distributed under the University of Illinois Open Source
|
|
|
|
// License. See LICENSE.TXT for details.
|
|
|
|
//
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
//
|
2008-08-17 18:44:35 +00:00
|
|
|
// This file implements printing the assembly code for an Ocaml frametable.
|
2008-01-07 02:31:11 +00:00
|
|
|
//
|
|
|
|
//===----------------------------------------------------------------------===//
|
2009-01-16 06:53:46 +00:00
|
|
|
|
2008-08-17 12:56:54 +00:00
|
|
|
#include "llvm/CodeGen/GCs.h"
|
2008-01-07 02:31:11 +00:00
|
|
|
#include "llvm/CodeGen/AsmPrinter.h"
|
2008-08-17 18:44:35 +00:00
|
|
|
#include "llvm/CodeGen/GCMetadataPrinter.h"
|
2008-01-07 02:31:11 +00:00
|
|
|
#include "llvm/Module.h"
|
2009-08-22 20:48:53 +00:00
|
|
|
#include "llvm/MC/MCAsmInfo.h"
|
2010-04-04 07:39:04 +00:00
|
|
|
#include "llvm/MC/MCContext.h"
|
2010-03-14 07:36:49 +00:00
|
|
|
#include "llvm/MC/MCSymbol.h"
|
|
|
|
#include "llvm/MC/MCStreamer.h"
|
2010-04-04 07:39:04 +00:00
|
|
|
#include "llvm/Target/Mangler.h"
|
2008-01-07 02:31:11 +00:00
|
|
|
#include "llvm/Target/TargetData.h"
|
2009-07-28 03:13:23 +00:00
|
|
|
#include "llvm/Target/TargetLoweringObjectFile.h"
|
2008-01-07 02:31:11 +00:00
|
|
|
#include "llvm/Target/TargetMachine.h"
|
2010-04-04 07:39:04 +00:00
|
|
|
#include "llvm/ADT/SmallString.h"
|
2009-08-19 05:49:37 +00:00
|
|
|
#include "llvm/Support/ErrorHandling.h"
|
2010-01-22 22:09:00 +00:00
|
|
|
#include "llvm/Support/FormattedStream.h"
|
2008-01-07 02:31:11 +00:00
|
|
|
using namespace llvm;
|
|
|
|
|
|
|
|
namespace {
|
|
|
|
|
2009-10-25 06:33:48 +00:00
|
|
|
class OcamlGCMetadataPrinter : public GCMetadataPrinter {
|
2008-08-17 12:08:44 +00:00
|
|
|
public:
|
2010-04-04 07:39:04 +00:00
|
|
|
void beginAssembly(AsmPrinter &AP);
|
|
|
|
void finishAssembly(AsmPrinter &AP);
|
2008-01-07 02:31:11 +00:00
|
|
|
};
|
2009-01-16 06:53:46 +00:00
|
|
|
|
2008-01-07 02:31:11 +00:00
|
|
|
}
|
|
|
|
|
2008-08-17 12:08:44 +00:00
|
|
|
static GCMetadataPrinterRegistry::Add<OcamlGCMetadataPrinter>
|
|
|
|
Y("ocaml", "ocaml 3.10-compatible collector");
|
|
|
|
|
2008-08-17 18:44:35 +00:00
|
|
|
void llvm::linkOcamlGCPrinter() { }
|
2008-01-07 02:31:11 +00:00
|
|
|
|
2010-04-04 07:39:04 +00:00
|
|
|
static void EmitCamlGlobal(const Module &M, AsmPrinter &AP, const char *Id) {
|
2008-01-07 02:31:11 +00:00
|
|
|
const std::string &MId = M.getModuleIdentifier();
|
2009-01-16 06:53:46 +00:00
|
|
|
|
2010-04-04 07:39:04 +00:00
|
|
|
std::string SymName;
|
|
|
|
SymName += "caml";
|
|
|
|
size_t Letter = SymName.size();
|
|
|
|
SymName.append(MId.begin(), std::find(MId.begin(), MId.end(), '.'));
|
|
|
|
SymName += "__";
|
|
|
|
SymName += Id;
|
|
|
|
|
2008-01-07 02:31:11 +00:00
|
|
|
// Capitalize the first letter of the module name.
|
2010-04-04 07:39:04 +00:00
|
|
|
SymName[Letter] = toupper(SymName[Letter]);
|
|
|
|
|
|
|
|
SmallString<128> TmpStr;
|
|
|
|
AP.Mang->getNameWithPrefix(TmpStr, SymName);
|
|
|
|
|
|
|
|
MCSymbol *Sym = AP.OutContext.GetOrCreateSymbol(TmpStr);
|
|
|
|
|
|
|
|
AP.OutStreamer.EmitSymbolAttribute(Sym, MCSA_Global);
|
|
|
|
AP.OutStreamer.EmitLabel(Sym);
|
2008-01-07 02:31:11 +00:00
|
|
|
}
|
|
|
|
|
2010-04-04 07:39:04 +00:00
|
|
|
void OcamlGCMetadataPrinter::beginAssembly(AsmPrinter &AP) {
|
2009-08-19 05:49:37 +00:00
|
|
|
AP.OutStreamer.SwitchSection(AP.getObjFileLowering().getTextSection());
|
2010-04-04 07:39:04 +00:00
|
|
|
EmitCamlGlobal(getModule(), AP, "code_begin");
|
2009-01-16 06:53:46 +00:00
|
|
|
|
2009-08-19 05:49:37 +00:00
|
|
|
AP.OutStreamer.SwitchSection(AP.getObjFileLowering().getDataSection());
|
2010-04-04 07:39:04 +00:00
|
|
|
EmitCamlGlobal(getModule(), AP, "data_begin");
|
2008-01-07 02:31:11 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/// emitAssembly - Print the frametable. The ocaml frametable format is thus:
|
2009-01-16 06:53:46 +00:00
|
|
|
///
|
2008-01-07 02:31:11 +00:00
|
|
|
/// extern "C" struct align(sizeof(intptr_t)) {
|
|
|
|
/// uint16_t NumDescriptors;
|
|
|
|
/// struct align(sizeof(intptr_t)) {
|
|
|
|
/// void *ReturnAddress;
|
|
|
|
/// uint16_t FrameSize;
|
|
|
|
/// uint16_t NumLiveOffsets;
|
|
|
|
/// uint16_t LiveOffsets[NumLiveOffsets];
|
|
|
|
/// } Descriptors[NumDescriptors];
|
|
|
|
/// } caml${module}__frametable;
|
2009-01-16 06:53:46 +00:00
|
|
|
///
|
2008-01-07 02:31:11 +00:00
|
|
|
/// Note that this precludes programs from stack frames larger than 64K
|
|
|
|
/// (FrameSize and LiveOffsets would overflow). FrameTablePrinter will abort if
|
2008-08-17 18:44:35 +00:00
|
|
|
/// either condition is detected in a function which uses the GC.
|
2009-01-16 06:53:46 +00:00
|
|
|
///
|
2010-04-04 07:39:04 +00:00
|
|
|
void OcamlGCMetadataPrinter::finishAssembly(AsmPrinter &AP) {
|
|
|
|
unsigned IntPtrSize = AP.TM.getTargetData()->getPointerSize();
|
2008-01-07 02:31:11 +00:00
|
|
|
|
2009-08-19 05:49:37 +00:00
|
|
|
AP.OutStreamer.SwitchSection(AP.getObjFileLowering().getTextSection());
|
2010-04-04 07:39:04 +00:00
|
|
|
EmitCamlGlobal(getModule(), AP, "code_end");
|
2009-01-16 06:53:46 +00:00
|
|
|
|
2009-08-19 05:49:37 +00:00
|
|
|
AP.OutStreamer.SwitchSection(AP.getObjFileLowering().getDataSection());
|
2010-04-04 07:39:04 +00:00
|
|
|
EmitCamlGlobal(getModule(), AP, "data_end");
|
2009-01-16 06:53:46 +00:00
|
|
|
|
2010-04-04 07:39:04 +00:00
|
|
|
// FIXME: Why does ocaml emit this??
|
|
|
|
AP.OutStreamer.EmitIntValue(0, IntPtrSize, 0);
|
2009-01-16 06:53:46 +00:00
|
|
|
|
2009-08-19 05:49:37 +00:00
|
|
|
AP.OutStreamer.SwitchSection(AP.getObjFileLowering().getDataSection());
|
2010-04-04 07:39:04 +00:00
|
|
|
EmitCamlGlobal(getModule(), AP, "frametable");
|
2009-01-16 06:53:46 +00:00
|
|
|
|
2010-05-24 12:24:11 +00:00
|
|
|
int NumDescriptors = 0;
|
|
|
|
for (iterator I = begin(), IE = end(); I != IE; ++I) {
|
|
|
|
GCFunctionInfo &FI = **I;
|
|
|
|
for (GCFunctionInfo::iterator J = FI.begin(), JE = FI.end(); J != JE; ++J) {
|
|
|
|
NumDescriptors++;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
if (NumDescriptors >= 1<<16) {
|
|
|
|
// Very rude!
|
|
|
|
report_fatal_error(" Too much descriptor for ocaml GC");
|
|
|
|
}
|
|
|
|
AP.EmitInt16(NumDescriptors);
|
|
|
|
AP.EmitAlignment(IntPtrSize == 4 ? 2 : 3);
|
|
|
|
|
2008-08-17 18:44:35 +00:00
|
|
|
for (iterator I = begin(), IE = end(); I != IE; ++I) {
|
|
|
|
GCFunctionInfo &FI = **I;
|
2009-01-16 06:53:46 +00:00
|
|
|
|
2008-08-17 18:44:35 +00:00
|
|
|
uint64_t FrameSize = FI.getFrameSize();
|
|
|
|
if (FrameSize >= 1<<16) {
|
2010-04-08 10:44:28 +00:00
|
|
|
// Very rude!
|
|
|
|
report_fatal_error("Function '" + FI.getFunction().getName() +
|
|
|
|
"' is too large for the ocaml GC! "
|
|
|
|
"Frame size " + Twine(FrameSize) + ">= 65536.\n"
|
|
|
|
"(" + Twine(uintptr_t(&FI)) + ")");
|
2008-08-17 18:44:35 +00:00
|
|
|
}
|
2009-01-16 06:53:46 +00:00
|
|
|
|
2010-04-04 07:39:04 +00:00
|
|
|
AP.OutStreamer.AddComment("live roots for " +
|
|
|
|
Twine(FI.getFunction().getName()));
|
|
|
|
AP.OutStreamer.AddBlankLine();
|
2009-01-16 06:53:46 +00:00
|
|
|
|
2008-08-17 18:44:35 +00:00
|
|
|
for (GCFunctionInfo::iterator J = FI.begin(), JE = FI.end(); J != JE; ++J) {
|
|
|
|
size_t LiveCount = FI.live_size(J);
|
2008-08-09 03:48:46 +00:00
|
|
|
if (LiveCount >= 1<<16) {
|
2010-04-08 10:44:28 +00:00
|
|
|
// Very rude!
|
|
|
|
report_fatal_error("Function '" + FI.getFunction().getName() +
|
|
|
|
"' is too large for the ocaml GC! "
|
|
|
|
"Live root count "+Twine(LiveCount)+" >= 65536.");
|
2008-01-07 02:31:11 +00:00
|
|
|
}
|
2009-01-16 06:53:46 +00:00
|
|
|
|
2010-04-04 07:39:04 +00:00
|
|
|
AP.OutStreamer.EmitSymbolValue(J->Label, IntPtrSize, 0);
|
2008-01-07 02:31:11 +00:00
|
|
|
AP.EmitInt16(FrameSize);
|
|
|
|
AP.EmitInt16(LiveCount);
|
2009-01-16 06:53:46 +00:00
|
|
|
|
2008-08-17 18:44:35 +00:00
|
|
|
for (GCFunctionInfo::live_iterator K = FI.live_begin(J),
|
|
|
|
KE = FI.live_end(J); K != KE; ++K) {
|
2010-05-24 12:24:11 +00:00
|
|
|
if (K->StackOffset >= 1<<16) {
|
|
|
|
// Very rude!
|
|
|
|
report_fatal_error(
|
|
|
|
"GC root stack offset is outside of fixed stack frame and out "
|
|
|
|
"of range for ocaml GC!");
|
|
|
|
}
|
|
|
|
AP.EmitInt16(K->StackOffset);
|
2008-01-07 02:31:11 +00:00
|
|
|
}
|
2009-01-16 06:53:46 +00:00
|
|
|
|
2010-04-04 07:39:04 +00:00
|
|
|
AP.EmitAlignment(IntPtrSize == 4 ? 2 : 3);
|
2008-01-07 02:31:11 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|