blob: b12e943eb35d831f45b7bb3a15950552d21b088b [file] [log] [blame]
Gordon Henriksen5eca0752008-08-17 18:44:35 +00001//===-- ShadowStackGC.cpp - GC support for uncooperative targets ----------===//
Gordon Henriksen8fa89292008-01-07 01:30:53 +00002//
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 implements lowering for the llvm.gc* intrinsics for targets that do
11// not natively support them (which includes the C backend). Note that the code
Gordon Henriksen5eca0752008-08-17 18:44:35 +000012// generated is not quite as efficient as algorithms which generate stack maps
Gordon Henriksen8fa89292008-01-07 01:30:53 +000013// to identify roots.
14//
15// This pass implements the code transformation described in this paper:
16// "Accurate Garbage Collection in an Uncooperative Environment"
17// Fergus Henderson, ISMM, 2002
18//
19// In runtime/GC/SemiSpace.cpp is a prototype runtime which is compatible with
Gordon Henriksen5eca0752008-08-17 18:44:35 +000020// ShadowStackGC.
Gordon Henriksen8fa89292008-01-07 01:30:53 +000021//
22// In order to support this particular transformation, all stack roots are
23// coallocated in the stack. This allows a fully target-independent stack map
24// while introducing only minor runtime overhead.
25//
26//===----------------------------------------------------------------------===//
27
Chandler Carruthd04a8d42012-12-03 16:50:05 +000028#include "llvm/CodeGen/GCs.h"
29#include "llvm/ADT/StringExtras.h"
30#include "llvm/CodeGen/GCStrategy.h"
Stephen Hines36b56882014-04-23 16:57:46 -070031#include "llvm/IR/CallSite.h"
Chandler Carruth0b8c9a82013-01-02 11:36:10 +000032#include "llvm/IR/IRBuilder.h"
33#include "llvm/IR/IntrinsicInst.h"
34#include "llvm/IR/Module.h"
Gordon Henriksen8fa89292008-01-07 01:30:53 +000035
36using namespace llvm;
37
Stephen Hinesdce4a402014-05-29 02:49:00 -070038#define DEBUG_TYPE "shadowstackgc"
39
Gordon Henriksen8fa89292008-01-07 01:30:53 +000040namespace {
Stephen Hinesebe69fe2015-03-23 12:10:34 -070041class ShadowStackGC : public GCStrategy {
42public:
43 ShadowStackGC();
44};
Dan Gohman844731a2008-05-13 00:00:25 +000045}
Mikhail Glushenkov5c1799b2009-01-16 06:53:46 +000046
Gordon Henriksen5eca0752008-08-17 18:44:35 +000047static GCRegistry::Add<ShadowStackGC>
Stephen Hinesebe69fe2015-03-23 12:10:34 -070048 X("shadow-stack", "Very portable GC for uncooperative code generators");
Mikhail Glushenkov5c1799b2009-01-16 06:53:46 +000049
Stephen Hinesebe69fe2015-03-23 12:10:34 -070050void llvm::linkShadowStackGC() {}
Mikhail Glushenkov5c1799b2009-01-16 06:53:46 +000051
Stephen Hinesebe69fe2015-03-23 12:10:34 -070052ShadowStackGC::ShadowStackGC() {
Gordon Henriksen8fa89292008-01-07 01:30:53 +000053 InitRoots = true;
54 CustomRoots = true;
55}