2007-03-14 20:29:42 +01:00
|
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
|
|
|
|
|
"http://www.w3.org/TR/html4/strict.dtd">
|
|
|
|
|
<html>
|
|
|
|
|
<head>
|
|
|
|
|
<title>Exception Handling in LLVM</title>
|
2009-08-15 10:56:09 +02:00
|
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
|
|
|
<meta name="description"
|
|
|
|
|
content="Exception Handling in LLVM.">
|
2007-03-14 20:29:42 +01:00
|
|
|
<link rel="stylesheet" href="llvm.css" type="text/css">
|
|
|
|
|
</head>
|
2009-08-15 10:56:09 +02:00
|
|
|
|
2007-03-14 20:29:42 +01:00
|
|
|
<body>
|
|
|
|
|
|
|
|
|
|
<div class="doc_title">Exception Handling in LLVM</div>
|
|
|
|
|
|
|
|
|
|
<table class="layout" style="width:100%">
|
|
|
|
|
<tr class="layout">
|
|
|
|
|
<td class="left">
|
|
|
|
|
<ul>
|
|
|
|
|
<li><a href="#introduction">Introduction</a>
|
|
|
|
|
<ol>
|
|
|
|
|
<li><a href="#itanium">Itanium ABI Zero-cost Exception Handling</a></li>
|
|
|
|
|
<li><a href="#overview">Overview</a></li>
|
|
|
|
|
</ol></li>
|
|
|
|
|
<li><a href="#codegen">LLVM Code Generation</a>
|
|
|
|
|
<ol>
|
|
|
|
|
<li><a href="#throw">Throw</a></li>
|
|
|
|
|
<li><a href="#try_catch">Try/Catch</a></li>
|
There is an impedance matching problem between LLVM and
gcc exception handling: if an exception unwinds through
an invoke, then execution must branch to the invoke's
unwind target. We previously tried to enforce this by
appending a cleanup action to every selector, however
this does not always work correctly due to an optimization
in the C++ unwinding runtime: if only cleanups would be
run while unwinding an exception, then the program just
terminates without actually executing the cleanups, as
invoke semantics would require. I was hoping this
wouldn't be a problem, but in fact it turns out to be the
cause of all the remaining failures in the LLVM testsuite
(these also fail with -enable-correct-eh-support, so turning
on -enable-eh didn't make things worse!). Instead we need
to append a full-blown catch-all to the end of each
selector. The correct way of doing this depends on the
personality function, i.e. it is language dependent, so
can only be done by gcc. Thus this patch which generalizes
the eh.selector intrinsic so that it can handle all possible
kinds of action table entries (before it didn't accomodate
cleanups): now 0 indicates a cleanup, and filters have to be
specified using the number of type infos plus one rather than
the number of type infos. Related gcc patches will cause
Ada to pass a cleanup (0) to force the selector to always
fire, while C++ will use a C++ catch-all (null).
llvm-svn: 41484
2007-08-27 17:47:50 +02:00
|
|
|
<li><a href="#cleanups">Cleanups</a></li>
|
2007-03-14 20:29:42 +01:00
|
|
|
<li><a href="#throw_filters">Throw Filters</a></li>
|
There is an impedance matching problem between LLVM and
gcc exception handling: if an exception unwinds through
an invoke, then execution must branch to the invoke's
unwind target. We previously tried to enforce this by
appending a cleanup action to every selector, however
this does not always work correctly due to an optimization
in the C++ unwinding runtime: if only cleanups would be
run while unwinding an exception, then the program just
terminates without actually executing the cleanups, as
invoke semantics would require. I was hoping this
wouldn't be a problem, but in fact it turns out to be the
cause of all the remaining failures in the LLVM testsuite
(these also fail with -enable-correct-eh-support, so turning
on -enable-eh didn't make things worse!). Instead we need
to append a full-blown catch-all to the end of each
selector. The correct way of doing this depends on the
personality function, i.e. it is language dependent, so
can only be done by gcc. Thus this patch which generalizes
the eh.selector intrinsic so that it can handle all possible
kinds of action table entries (before it didn't accomodate
cleanups): now 0 indicates a cleanup, and filters have to be
specified using the number of type infos plus one rather than
the number of type infos. Related gcc patches will cause
Ada to pass a cleanup (0) to force the selector to always
fire, while C++ will use a C++ catch-all (null).
llvm-svn: 41484
2007-08-27 17:47:50 +02:00
|
|
|
<li><a href="#restrictions">Restrictions</a></li>
|
2007-03-14 20:29:42 +01:00
|
|
|
</ol></li>
|
2007-03-30 14:22:09 +02:00
|
|
|
<li><a href="#format_common_intrinsics">Exception Handling Intrinsics</a>
|
2007-03-14 20:29:42 +01:00
|
|
|
<ol>
|
|
|
|
|
<li><a href="#llvm_eh_exception"><tt>llvm.eh.exception</tt></a></li>
|
|
|
|
|
<li><a href="#llvm_eh_selector"><tt>llvm.eh.selector</tt></a></li>
|
|
|
|
|
<li><a href="#llvm_eh_typeid_for"><tt>llvm.eh.typeid.for</tt></a></li>
|
2009-05-14 02:46:35 +02:00
|
|
|
<li><a href="#llvm_eh_sjlj_setjmp"><tt>llvm.eh.sjlj.setjmp</tt></a></li>
|
|
|
|
|
<li><a href="#llvm_eh_sjlj_longjmp"><tt>llvm.eh.sjlj.longjmp</tt></a></li>
|
2009-08-11 02:09:57 +02:00
|
|
|
<li><a href="#llvm_eh_sjlj_lsda"><tt>llvm.eh.sjlj.lsda</tt></a></li>
|
|
|
|
|
<li><a href="#llvm_eh_sjlj_callsite"><tt>llvm.eh.sjlj.callsite</tt></a></li>
|
2007-03-14 20:29:42 +01:00
|
|
|
</ol></li>
|
|
|
|
|
<li><a href="#asm">Asm Table Formats</a>
|
|
|
|
|
<ol>
|
|
|
|
|
<li><a href="#unwind_tables">Exception Handling Frame</a></li>
|
|
|
|
|
<li><a href="#exception_tables">Exception Tables</a></li>
|
|
|
|
|
</ol></li>
|
|
|
|
|
<li><a href="#todo">ToDo</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</td>
|
|
|
|
|
</tr></table>
|
|
|
|
|
|
|
|
|
|
<div class="doc_author">
|
|
|
|
|
<p>Written by <a href="mailto:jlaskey@mac.com">Jim Laskey</a></p>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- *********************************************************************** -->
|
|
|
|
|
<div class="doc_section"><a name="introduction">Introduction</a></div>
|
|
|
|
|
<!-- *********************************************************************** -->
|
|
|
|
|
|
|
|
|
|
<div class="doc_text">
|
|
|
|
|
|
|
|
|
|
<p>This document is the central repository for all information pertaining to
|
2009-08-15 10:56:09 +02:00
|
|
|
exception handling in LLVM. It describes the format that LLVM exception
|
|
|
|
|
handling information takes, which is useful for those interested in creating
|
|
|
|
|
front-ends or dealing directly with the information. Further, this document
|
|
|
|
|
provides specific examples of what exception handling information is used for
|
|
|
|
|
in C/C++.</p>
|
2007-03-14 20:29:42 +01:00
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<!-- ======================================================================= -->
|
|
|
|
|
<div class="doc_subsection">
|
|
|
|
|
<a name="itanium">Itanium ABI Zero-cost Exception Handling</a>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="doc_text">
|
|
|
|
|
|
|
|
|
|
<p>Exception handling for most programming languages is designed to recover from
|
2009-08-15 10:56:09 +02:00
|
|
|
conditions that rarely occur during general use of an application. To that
|
|
|
|
|
end, exception handling should not interfere with the main flow of an
|
|
|
|
|
application's algorithm by performing checkpointing tasks, such as saving the
|
|
|
|
|
current pc or register state.</p>
|
2007-03-14 20:29:42 +01:00
|
|
|
|
|
|
|
|
<p>The Itanium ABI Exception Handling Specification defines a methodology for
|
2009-08-15 10:56:09 +02:00
|
|
|
providing outlying data in the form of exception tables without inlining
|
|
|
|
|
speculative exception handling code in the flow of an application's main
|
|
|
|
|
algorithm. Thus, the specification is said to add "zero-cost" to the normal
|
|
|
|
|
execution of an application.</p>
|
2007-03-14 20:29:42 +01:00
|
|
|
|
|
|
|
|
<p>A more complete description of the Itanium ABI exception handling runtime
|
2009-08-15 10:56:09 +02:00
|
|
|
support of can be found at
|
|
|
|
|
<a href="http://www.codesourcery.com/cxx-abi/abi-eh.html">Itanium C++ ABI:
|
|
|
|
|
Exception Handling</a>. A description of the exception frame format can be
|
|
|
|
|
found at
|
|
|
|
|
<a href="http://refspecs.freestandards.org/LSB_3.0.0/LSB-Core-generic/LSB-Core-generic/ehframechpt.html">Exception
|
|
|
|
|
Frames</a>, with details of the DWARF 3 specification at
|
|
|
|
|
<a href="http://www.eagercon.com/dwarf/dwarf3std.htm">DWARF 3 Standard</a>.
|
|
|
|
|
A description for the C++ exception table formats can be found at
|
|
|
|
|
<a href="http://www.codesourcery.com/cxx-abi/exceptions.pdf">Exception Handling
|
|
|
|
|
Tables</a>.</p>
|
2007-03-14 20:29:42 +01:00
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<!-- ======================================================================= -->
|
|
|
|
|
<div class="doc_subsection">
|
|
|
|
|
<a name="overview">Overview</a>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="doc_text">
|
|
|
|
|
|
2009-08-15 10:56:09 +02:00
|
|
|
<p>When an exception is thrown in LLVM code, the runtime does its best to find a
|
|
|
|
|
handler suited to processing the circumstance.</p>
|
2007-03-14 20:29:42 +01:00
|
|
|
|
|
|
|
|
<p>The runtime first attempts to find an <i>exception frame</i> corresponding to
|
2009-08-15 10:56:09 +02:00
|
|
|
the function where the exception was thrown. If the programming language
|
|
|
|
|
(e.g. C++) supports exception handling, the exception frame contains a
|
|
|
|
|
reference to an exception table describing how to process the exception. If
|
|
|
|
|
the language (e.g. C) does not support exception handling, or if the
|
|
|
|
|
exception needs to be forwarded to a prior activation, the exception frame
|
|
|
|
|
contains information about how to unwind the current activation and restore
|
|
|
|
|
the state of the prior activation. This process is repeated until the
|
|
|
|
|
exception is handled. If the exception is not handled and no activations
|
|
|
|
|
remain, then the application is terminated with an appropriate error
|
|
|
|
|
message.</p>
|
|
|
|
|
|
|
|
|
|
<p>Because different programming languages have different behaviors when
|
|
|
|
|
handling exceptions, the exception handling ABI provides a mechanism for
|
|
|
|
|
supplying <i>personalities.</i> An exception handling personality is defined
|
|
|
|
|
by way of a <i>personality function</i> (e.g. <tt>__gxx_personality_v0</tt>
|
|
|
|
|
in C++), which receives the context of the exception, an <i>exception
|
|
|
|
|
structure</i> containing the exception object type and value, and a reference
|
|
|
|
|
to the exception table for the current function. The personality function
|
|
|
|
|
for the current compile unit is specified in a <i>common exception
|
|
|
|
|
frame</i>.</p>
|
2007-03-14 20:29:42 +01:00
|
|
|
|
|
|
|
|
<p>The organization of an exception table is language dependent. For C++, an
|
2009-08-15 10:56:09 +02:00
|
|
|
exception table is organized as a series of code ranges defining what to do
|
|
|
|
|
if an exception occurs in that range. Typically, the information associated
|
|
|
|
|
with a range defines which types of exception objects (using C++ <i>type
|
|
|
|
|
info</i>) that are handled in that range, and an associated action that
|
|
|
|
|
should take place. Actions typically pass control to a <i>landing
|
|
|
|
|
pad</i>.</p>
|
2007-03-14 20:29:42 +01:00
|
|
|
|
2009-08-15 10:56:09 +02:00
|
|
|
<p>A landing pad corresponds to the code found in the <i>catch</i> portion of
|
|
|
|
|
a <i>try</i>/<i>catch</i> sequence. When execution resumes at a landing
|
|
|
|
|
pad, it receives the exception structure and a selector corresponding to
|
|
|
|
|
the <i>type</i> of exception thrown. The selector is then used to determine
|
|
|
|
|
which <i>catch</i> should actually process the exception.</p>
|
2007-03-14 20:29:42 +01:00
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<!-- ======================================================================= -->
|
|
|
|
|
<div class="doc_section">
|
|
|
|
|
<a name="codegen">LLVM Code Generation</a>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="doc_text">
|
|
|
|
|
|
|
|
|
|
<p>At the time of this writing, only C++ exception handling support is available
|
2009-08-15 10:56:09 +02:00
|
|
|
in LLVM. So the remainder of this document will be somewhat C++-centric.</p>
|
2007-03-14 20:29:42 +01:00
|
|
|
|
|
|
|
|
<p>From the C++ developers perspective, exceptions are defined in terms of the
|
2009-08-15 10:56:09 +02:00
|
|
|
<tt>throw</tt> and <tt>try</tt>/<tt>catch</tt> statements. In this section
|
|
|
|
|
we will describe the implementation of LLVM exception handling in terms of
|
|
|
|
|
C++ examples.</p>
|
2007-03-14 20:29:42 +01:00
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<!-- ======================================================================= -->
|
|
|
|
|
<div class="doc_subsection">
|
|
|
|
|
<a name="throw">Throw</a>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="doc_text">
|
|
|
|
|
|
|
|
|
|
<p>Languages that support exception handling typically provide a <tt>throw</tt>
|
2009-08-15 10:56:09 +02:00
|
|
|
operation to initiate the exception process. Internally, a throw operation
|
|
|
|
|
breaks down into two steps. First, a request is made to allocate exception
|
|
|
|
|
space for an exception structure. This structure needs to survive beyond the
|
|
|
|
|
current activation. This structure will contain the type and value of the
|
|
|
|
|
object being thrown. Second, a call is made to the runtime to raise the
|
|
|
|
|
exception, passing the exception structure as an argument.</p>
|
2007-03-14 20:29:42 +01:00
|
|
|
|
2009-08-15 10:56:09 +02:00
|
|
|
<p>In C++, the allocation of the exception structure is done by
|
|
|
|
|
the <tt>__cxa_allocate_exception</tt> runtime function. The exception
|
|
|
|
|
raising is handled by <tt>__cxa_throw</tt>. The type of the exception is
|
|
|
|
|
represented using a C++ RTTI structure.</p>
|
2007-03-14 20:29:42 +01:00
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<!-- ======================================================================= -->
|
|
|
|
|
<div class="doc_subsection">
|
|
|
|
|
<a name="try_catch">Try/Catch</a>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="doc_text">
|
|
|
|
|
|
2009-08-15 10:56:09 +02:00
|
|
|
<p>A call within the scope of a <i>try</i> statement can potentially raise an
|
|
|
|
|
exception. In those circumstances, the LLVM C++ front-end replaces the call
|
|
|
|
|
with an <tt>invoke</tt> instruction. Unlike a call, the <tt>invoke</tt> has
|
|
|
|
|
two potential continuation points: where to continue when the call succeeds
|
|
|
|
|
as per normal; and where to continue if the call raises an exception, either
|
|
|
|
|
by a throw or the unwinding of a throw.</p>
|
2007-03-14 20:29:42 +01:00
|
|
|
|
2009-08-15 10:56:09 +02:00
|
|
|
<p>The term used to define a the place where an <tt>invoke</tt> continues after
|
|
|
|
|
an exception is called a <i>landing pad</i>. LLVM landing pads are
|
|
|
|
|
conceptually alternative function entry points where an exception structure
|
|
|
|
|
reference and a type info index are passed in as arguments. The landing pad
|
|
|
|
|
saves the exception structure reference and then proceeds to select the catch
|
|
|
|
|
block that corresponds to the type info of the exception object.</p>
|
2007-03-14 20:29:42 +01:00
|
|
|
|
2009-08-15 10:56:09 +02:00
|
|
|
<p>Two LLVM intrinsic functions are used to convey information about the landing
|
|
|
|
|
pad to the back end.</p>
|
2007-03-14 20:29:42 +01:00
|
|
|
|
2009-08-15 10:56:09 +02:00
|
|
|
<ol>
|
|
|
|
|
<li><a href="#llvm_eh_exception"><tt>llvm.eh.exception</tt></a> takes no
|
|
|
|
|
arguments and returns a pointer to the exception structure. This only
|
|
|
|
|
returns a sensible value if called after an <tt>invoke</tt> has branched
|
|
|
|
|
to a landing pad. Due to code generation limitations, it must currently
|
|
|
|
|
be called in the landing pad itself.</li>
|
|
|
|
|
|
|
|
|
|
<li><a href="#llvm_eh_selector"><tt>llvm.eh.selector</tt></a> takes a minimum
|
|
|
|
|
of three arguments. The first argument is the reference to the exception
|
|
|
|
|
structure. The second argument is a reference to the personality function
|
|
|
|
|
to be used for this <tt>try</tt>/<tt>catch</tt> sequence. Each of the
|
|
|
|
|
remaining arguments is either a reference to the type info for
|
|
|
|
|
a <tt>catch</tt> statement, a <a href="#throw_filters">filter</a>
|
|
|
|
|
expression, or the number zero (<tt>0</tt>) representing
|
|
|
|
|
a <a href="#cleanups">cleanup</a>. The exception is tested against the
|
|
|
|
|
arguments sequentially from first to last. The result of
|
|
|
|
|
the <a href="#llvm_eh_selector"><tt>llvm.eh.selector</tt></a> is a
|
|
|
|
|
positive number if the exception matched a type info, a negative number if
|
|
|
|
|
it matched a filter, and zero if it matched a cleanup. If nothing is
|
|
|
|
|
matched, the behaviour of the program
|
|
|
|
|
is <a href="#restrictions">undefined</a>. This only returns a sensible
|
|
|
|
|
value if called after an <tt>invoke</tt> has branched to a landing pad.
|
|
|
|
|
Due to codegen limitations, it must currently be called in the landing pad
|
|
|
|
|
itself. If a type info matched, then the selector value is the index of
|
|
|
|
|
the type info in the exception table, which can be obtained using the
|
|
|
|
|
<a href="#llvm_eh_typeid_for"><tt>llvm.eh.typeid.for</tt></a>
|
|
|
|
|
intrinsic.</li>
|
|
|
|
|
</ol>
|
2007-03-14 20:29:42 +01:00
|
|
|
|
|
|
|
|
<p>Once the landing pad has the type info selector, the code branches to the
|
2009-08-15 10:56:09 +02:00
|
|
|
code for the first catch. The catch then checks the value of the type info
|
|
|
|
|
selector against the index of type info for that catch. Since the type info
|
|
|
|
|
index is not known until all the type info have been gathered in the backend,
|
|
|
|
|
the catch code will call the
|
|
|
|
|
<a href="#llvm_eh_typeid_for"><tt>llvm.eh.typeid.for</tt></a> intrinsic
|
|
|
|
|
to determine the index for a given type info. If the catch fails to match
|
|
|
|
|
the selector then control is passed on to the next catch. Note: Since the
|
|
|
|
|
landing pad will not be used if there is no match in the list of type info on
|
|
|
|
|
the call to <a href="#llvm_eh_selector"><tt>llvm.eh.selector</tt></a>, then
|
|
|
|
|
neither the last catch nor <i>catch all</i> need to perform the check
|
|
|
|
|
against the selector.</p>
|
|
|
|
|
|
|
|
|
|
<p>Finally, the entry and exit of catch code is bracketed with calls
|
|
|
|
|
to <tt>__cxa_begin_catch</tt> and <tt>__cxa_end_catch</tt>.</p>
|
|
|
|
|
|
|
|
|
|
<ul>
|
|
|
|
|
<li><tt>__cxa_begin_catch</tt> takes a exception structure reference as an
|
|
|
|
|
argument and returns the value of the exception object.</li>
|
|
|
|
|
|
|
|
|
|
<li><tt>__cxa_end_catch</tt> takes a exception structure reference as an
|
|
|
|
|
argument. This function clears the exception from the exception space.
|
|
|
|
|
Note: a rethrow from within the catch may replace this call with
|
|
|
|
|
a <tt>__cxa_rethrow</tt>.</li>
|
|
|
|
|
</ul>
|
2007-03-14 20:29:42 +01:00
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<!-- ======================================================================= -->
|
|
|
|
|
<div class="doc_subsection">
|
There is an impedance matching problem between LLVM and
gcc exception handling: if an exception unwinds through
an invoke, then execution must branch to the invoke's
unwind target. We previously tried to enforce this by
appending a cleanup action to every selector, however
this does not always work correctly due to an optimization
in the C++ unwinding runtime: if only cleanups would be
run while unwinding an exception, then the program just
terminates without actually executing the cleanups, as
invoke semantics would require. I was hoping this
wouldn't be a problem, but in fact it turns out to be the
cause of all the remaining failures in the LLVM testsuite
(these also fail with -enable-correct-eh-support, so turning
on -enable-eh didn't make things worse!). Instead we need
to append a full-blown catch-all to the end of each
selector. The correct way of doing this depends on the
personality function, i.e. it is language dependent, so
can only be done by gcc. Thus this patch which generalizes
the eh.selector intrinsic so that it can handle all possible
kinds of action table entries (before it didn't accomodate
cleanups): now 0 indicates a cleanup, and filters have to be
specified using the number of type infos plus one rather than
the number of type infos. Related gcc patches will cause
Ada to pass a cleanup (0) to force the selector to always
fire, while C++ will use a C++ catch-all (null).
llvm-svn: 41484
2007-08-27 17:47:50 +02:00
|
|
|
<a name="cleanups">Cleanups</a>
|
2007-03-14 20:29:42 +01:00
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="doc_text">
|
|
|
|
|
|
2009-08-15 10:56:09 +02:00
|
|
|
<p>To handle destructors and cleanups in <tt>try</tt> code, control may not run
|
|
|
|
|
directly from a landing pad to the first catch. Control may actually flow
|
|
|
|
|
from the landing pad to clean up code and then to the first catch. Since the
|
|
|
|
|
required clean up for each <tt>invoke</tt> in a <tt>try</tt> may be different
|
|
|
|
|
(e.g. intervening constructor), there may be several landing pads for a given
|
|
|
|
|
try. If cleanups need to be run, the number zero should be passed as the
|
|
|
|
|
last <a href="#llvm_eh_selector"><tt>llvm.eh.selector</tt></a> argument.
|
|
|
|
|
However for C++ a <tt>null i8*</tt> <b><a href="#restrictions">must</a></b>
|
|
|
|
|
be passed instead.</p>
|
2007-03-14 20:29:42 +01:00
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<!-- ======================================================================= -->
|
|
|
|
|
<div class="doc_subsection">
|
|
|
|
|
<a name="throw_filters">Throw Filters</a>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="doc_text">
|
|
|
|
|
|
2009-08-15 10:56:09 +02:00
|
|
|
<p>C++ allows the specification of which exception types can be thrown from a
|
|
|
|
|
function. To represent this a top level landing pad may exist to filter out
|
|
|
|
|
invalid types. To express this in LLVM code the landing pad will
|
|
|
|
|
call <a href="#llvm_eh_selector"><tt>llvm.eh.selector</tt></a>. The
|
|
|
|
|
arguments are a reference to the exception structure, a reference to the
|
|
|
|
|
personality function, the length of the filter expression (the number of type
|
|
|
|
|
infos plus one), followed by the type infos themselves.
|
|
|
|
|
<a href="#llvm_eh_selector"><tt>llvm.eh.selector</tt></a> will return a
|
|
|
|
|
negative value if the exception does not match any of the type infos. If no
|
|
|
|
|
match is found then a call to <tt>__cxa_call_unexpected</tt> should be made,
|
|
|
|
|
otherwise <tt>_Unwind_Resume</tt>. Each of these functions requires a
|
|
|
|
|
reference to the exception structure. Note that the most general form of an
|
|
|
|
|
<a href="#llvm_eh_selector"><tt>llvm.eh.selector</tt></a> call can contain
|
|
|
|
|
any number of type infos, filter expressions and cleanups (though having more
|
|
|
|
|
than one cleanup is pointless). The LLVM C++ front-end can generate such
|
|
|
|
|
<a href="#llvm_eh_selector"><tt>llvm.eh.selector</tt></a> calls due to
|
|
|
|
|
inlining creating nested exception handling scopes.</p>
|
2007-03-14 20:29:42 +01:00
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
There is an impedance matching problem between LLVM and
gcc exception handling: if an exception unwinds through
an invoke, then execution must branch to the invoke's
unwind target. We previously tried to enforce this by
appending a cleanup action to every selector, however
this does not always work correctly due to an optimization
in the C++ unwinding runtime: if only cleanups would be
run while unwinding an exception, then the program just
terminates without actually executing the cleanups, as
invoke semantics would require. I was hoping this
wouldn't be a problem, but in fact it turns out to be the
cause of all the remaining failures in the LLVM testsuite
(these also fail with -enable-correct-eh-support, so turning
on -enable-eh didn't make things worse!). Instead we need
to append a full-blown catch-all to the end of each
selector. The correct way of doing this depends on the
personality function, i.e. it is language dependent, so
can only be done by gcc. Thus this patch which generalizes
the eh.selector intrinsic so that it can handle all possible
kinds of action table entries (before it didn't accomodate
cleanups): now 0 indicates a cleanup, and filters have to be
specified using the number of type infos plus one rather than
the number of type infos. Related gcc patches will cause
Ada to pass a cleanup (0) to force the selector to always
fire, while C++ will use a C++ catch-all (null).
llvm-svn: 41484
2007-08-27 17:47:50 +02:00
|
|
|
<!-- ======================================================================= -->
|
|
|
|
|
<div class="doc_subsection">
|
|
|
|
|
<a name="restrictions">Restrictions</a>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="doc_text">
|
|
|
|
|
|
|
|
|
|
<p>The semantics of the invoke instruction require that any exception that
|
2009-08-15 10:56:09 +02:00
|
|
|
unwinds through an invoke call should result in a branch to the invoke's
|
|
|
|
|
unwind label. However such a branch will only happen if the
|
|
|
|
|
<a href="#llvm_eh_selector"><tt>llvm.eh.selector</tt></a> matches. Thus in
|
|
|
|
|
order to ensure correct operation, the front-end must only generate
|
|
|
|
|
<a href="#llvm_eh_selector"><tt>llvm.eh.selector</tt></a> calls that are
|
|
|
|
|
guaranteed to always match whatever exception unwinds through the invoke.
|
|
|
|
|
For most languages it is enough to pass zero, indicating the presence of
|
|
|
|
|
a <a href="#cleanups">cleanup</a>, as the
|
|
|
|
|
last <a href="#llvm_eh_selector"><tt>llvm.eh.selector</tt></a> argument.
|
|
|
|
|
However for C++ this is not sufficient, because the C++ personality function
|
|
|
|
|
will terminate the program if it detects that unwinding the exception only
|
|
|
|
|
results in matches with cleanups. For C++ a <tt>null i8*</tt> should be
|
|
|
|
|
passed as the last <a href="#llvm_eh_selector"><tt>llvm.eh.selector</tt></a>
|
|
|
|
|
argument instead. This is interpreted as a catch-all by the C++ personality
|
|
|
|
|
function, and will always match.</p>
|
There is an impedance matching problem between LLVM and
gcc exception handling: if an exception unwinds through
an invoke, then execution must branch to the invoke's
unwind target. We previously tried to enforce this by
appending a cleanup action to every selector, however
this does not always work correctly due to an optimization
in the C++ unwinding runtime: if only cleanups would be
run while unwinding an exception, then the program just
terminates without actually executing the cleanups, as
invoke semantics would require. I was hoping this
wouldn't be a problem, but in fact it turns out to be the
cause of all the remaining failures in the LLVM testsuite
(these also fail with -enable-correct-eh-support, so turning
on -enable-eh didn't make things worse!). Instead we need
to append a full-blown catch-all to the end of each
selector. The correct way of doing this depends on the
personality function, i.e. it is language dependent, so
can only be done by gcc. Thus this patch which generalizes
the eh.selector intrinsic so that it can handle all possible
kinds of action table entries (before it didn't accomodate
cleanups): now 0 indicates a cleanup, and filters have to be
specified using the number of type infos plus one rather than
the number of type infos. Related gcc patches will cause
Ada to pass a cleanup (0) to force the selector to always
fire, while C++ will use a C++ catch-all (null).
llvm-svn: 41484
2007-08-27 17:47:50 +02:00
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
2007-03-14 20:29:42 +01:00
|
|
|
<!-- ======================================================================= -->
|
|
|
|
|
<div class="doc_section">
|
2007-03-30 14:22:09 +02:00
|
|
|
<a name="format_common_intrinsics">Exception Handling Intrinsics</a>
|
2007-03-14 20:29:42 +01:00
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="doc_text">
|
|
|
|
|
|
|
|
|
|
<p>LLVM uses several intrinsic functions (name prefixed with "llvm.eh") to
|
2009-08-15 10:56:09 +02:00
|
|
|
provide exception handling information at various points in generated
|
|
|
|
|
code.</p>
|
2007-03-14 20:29:42 +01:00
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<!-- ======================================================================= -->
|
|
|
|
|
<div class="doc_subsubsection">
|
|
|
|
|
<a name="llvm_eh_exception">llvm.eh.exception</a>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="doc_text">
|
2009-08-15 22:07:42 +02:00
|
|
|
|
2007-03-14 20:29:42 +01:00
|
|
|
<pre>
|
2009-08-15 22:07:42 +02:00
|
|
|
i8* %<a href="#llvm_eh_exception">llvm.eh.exception</a>( )
|
2007-03-14 20:29:42 +01:00
|
|
|
</pre>
|
|
|
|
|
|
2008-12-29 16:27:32 +01:00
|
|
|
<p>This intrinsic returns a pointer to the exception structure.</p>
|
2007-03-14 20:29:42 +01:00
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<!-- ======================================================================= -->
|
|
|
|
|
<div class="doc_subsubsection">
|
|
|
|
|
<a name="llvm_eh_selector">llvm.eh.selector</a>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="doc_text">
|
2009-08-15 22:07:42 +02:00
|
|
|
|
2007-03-14 20:29:42 +01:00
|
|
|
<pre>
|
2009-08-15 22:07:42 +02:00
|
|
|
i32 %<a href="#llvm_eh_selector">llvm.eh.selector.i32</a>(i8*, i8*, i8*, ...)
|
|
|
|
|
i64 %<a href="#llvm_eh_selector">llvm.eh.selector.i64</a>(i8*, i8*, i8*, ...)
|
2007-03-14 20:29:42 +01:00
|
|
|
</pre>
|
|
|
|
|
|
2008-12-29 16:27:32 +01:00
|
|
|
<p>This intrinsic is used to compare the exception with the given type infos,
|
2009-08-15 10:56:09 +02:00
|
|
|
filters and cleanups.</p>
|
2007-03-14 20:29:42 +01:00
|
|
|
|
|
|
|
|
<p><a href="#llvm_eh_selector"><tt>llvm.eh.selector</tt></a> takes a minimum of
|
2009-08-15 10:56:09 +02:00
|
|
|
three arguments. The first argument is the reference to the exception
|
|
|
|
|
structure. The second argument is a reference to the personality function to
|
|
|
|
|
be used for this try catch sequence. Each of the remaining arguments is
|
|
|
|
|
either a reference to the type info for a catch statement,
|
|
|
|
|
a <a href="#throw_filters">filter</a> expression, or the number zero
|
|
|
|
|
representing a <a href="#cleanups">cleanup</a>. The exception is tested
|
|
|
|
|
against the arguments sequentially from first to last. The result of
|
|
|
|
|
the <a href="#llvm_eh_selector"><tt>llvm.eh.selector</tt></a> is a positive
|
|
|
|
|
number if the exception matched a type info, a negative number if it matched
|
|
|
|
|
a filter, and zero if it matched a cleanup. If nothing is matched, the
|
|
|
|
|
behaviour of the program is <a href="#restrictions">undefined</a>. If a type
|
|
|
|
|
info matched then the selector value is the index of the type info in the
|
|
|
|
|
exception table, which can be obtained using the
|
|
|
|
|
<a href="#llvm_eh_typeid_for"><tt>llvm.eh.typeid.for</tt></a> intrinsic.</p>
|
2007-03-14 20:29:42 +01:00
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<!-- ======================================================================= -->
|
|
|
|
|
<div class="doc_subsubsection">
|
|
|
|
|
<a name="llvm_eh_typeid_for">llvm.eh.typeid.for</a>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="doc_text">
|
|
|
|
|
<pre>
|
2009-08-15 10:56:09 +02:00
|
|
|
i32 %<a href="#llvm_eh_typeid_for">llvm.eh.typeid.for.i32</a>(i8*)
|
|
|
|
|
i64 %<a href="#llvm_eh_typeid_for">llvm.eh.typeid.for.i64</a>(i8*)
|
2007-03-14 20:29:42 +01:00
|
|
|
</pre>
|
2009-08-15 10:56:09 +02:00
|
|
|
</div>
|
2007-03-14 20:29:42 +01:00
|
|
|
|
|
|
|
|
<p>This intrinsic returns the type info index in the exception table of the
|
2009-08-15 10:56:09 +02:00
|
|
|
current function. This value can be used to compare against the result
|
|
|
|
|
of <a href="#llvm_eh_selector"><tt>llvm.eh.selector</tt></a>. The single
|
|
|
|
|
argument is a reference to a type info.</p>
|
2007-03-14 20:29:42 +01:00
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
2009-05-14 02:46:35 +02:00
|
|
|
<!-- ======================================================================= -->
|
|
|
|
|
<div class="doc_subsubsection">
|
|
|
|
|
<a name="llvm_eh_sjlj_setjmp">llvm.eh.sjlj.setjmp</a>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="doc_text">
|
2009-08-15 22:07:42 +02:00
|
|
|
|
2009-05-14 02:46:35 +02:00
|
|
|
<pre>
|
2009-08-15 22:07:42 +02:00
|
|
|
i32 %<a href="#llvm_eh_sjlj_setjmp">llvm.eh.sjlj.setjmp</a>(i8*)
|
2009-05-14 02:46:35 +02:00
|
|
|
</pre>
|
|
|
|
|
|
2009-08-15 10:56:09 +02:00
|
|
|
<p>The SJLJ exception handling uses this intrinsic to force register saving for
|
|
|
|
|
the current function and to store the address of the following instruction
|
|
|
|
|
for use as a destination address by <a href="#llvm_eh_sjlj_longjmp">
|
|
|
|
|
<tt>llvm.eh.sjlj.longjmp</tt></a>. The buffer format and the overall
|
|
|
|
|
functioning of this intrinsic is compatible with the GCC
|
|
|
|
|
<tt>__builtin_setjmp</tt> implementation, allowing code built with the
|
|
|
|
|
two compilers to interoperate.</p>
|
2009-05-14 02:46:35 +02:00
|
|
|
|
2009-08-15 10:56:09 +02:00
|
|
|
<p>The single parameter is a pointer to a five word buffer in which the calling
|
|
|
|
|
context is saved. The front end places the frame pointer in the first word,
|
|
|
|
|
and the target implementation of this intrinsic should place the destination
|
|
|
|
|
address for a
|
|
|
|
|
<a href="#llvm_eh_sjlj_longjmp"><tt>llvm.eh.sjlj.longjmp</tt></a> in the
|
|
|
|
|
second word. The following three words are available for use in a
|
|
|
|
|
target-specific manner.</p>
|
2009-05-14 02:46:35 +02:00
|
|
|
|
2009-08-05 17:42:44 +02:00
|
|
|
</div>
|
|
|
|
|
|
2009-08-11 02:09:57 +02:00
|
|
|
<!-- ======================================================================= -->
|
|
|
|
|
<div class="doc_subsubsection">
|
|
|
|
|
<a name="llvm_eh_sjlj_lsda">llvm.eh.sjlj.lsda</a>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="doc_text">
|
2009-08-15 22:07:42 +02:00
|
|
|
|
2009-08-11 02:09:57 +02:00
|
|
|
<pre>
|
2009-08-15 22:07:42 +02:00
|
|
|
i8* %<a href="#llvm_eh_sjlj_lsda">llvm.eh.sjlj.lsda</a>( )
|
2009-08-11 02:09:57 +02:00
|
|
|
</pre>
|
|
|
|
|
|
|
|
|
|
<p>Used for SJLJ based exception handling, the <a href="#llvm_eh_sjlj_lsda">
|
2009-08-15 10:56:09 +02:00
|
|
|
<tt>llvm.eh.sjlj.lsda</tt></a> intrinsic returns the address of the Language
|
|
|
|
|
Specific Data Area (LSDA) for the current function. The SJLJ front-end code
|
|
|
|
|
stores this address in the exception handling function context for use by the
|
|
|
|
|
runtime.</p>
|
2009-08-11 02:09:57 +02:00
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<!-- ======================================================================= -->
|
|
|
|
|
<div class="doc_subsubsection">
|
|
|
|
|
<a name="llvm_eh_sjlj_callsite">llvm.eh.sjlj.callsite</a>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="doc_text">
|
2009-08-15 22:07:42 +02:00
|
|
|
|
2009-08-11 02:09:57 +02:00
|
|
|
<pre>
|
2009-08-15 22:07:42 +02:00
|
|
|
void %<a href="#llvm_eh_sjlj_callsite">llvm.eh.sjlj.callsite</a>(i32)
|
2009-08-11 02:09:57 +02:00
|
|
|
</pre>
|
|
|
|
|
|
2009-08-15 10:56:09 +02:00
|
|
|
<p>The SJLJ front-end allocates call site indices for invoke instrucitons.
|
|
|
|
|
These values are passed to the back-end via the
|
|
|
|
|
<a href="#llvm_eh_sjlj_callsite"><tt>llvm.eh.sjlj.callsite</tt></a>
|
|
|
|
|
intrinsic, where they are used to build the LSDA call-site table.</p>
|
2009-08-11 02:09:57 +02:00
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
2007-03-14 20:29:42 +01:00
|
|
|
<!-- ======================================================================= -->
|
|
|
|
|
<div class="doc_section">
|
|
|
|
|
<a name="asm">Asm Table Formats</a>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="doc_text">
|
|
|
|
|
|
|
|
|
|
<p>There are two tables that are used by the exception handling runtime to
|
2009-08-15 10:56:09 +02:00
|
|
|
determine which actions should take place when an exception is thrown.</p>
|
2007-03-14 20:29:42 +01:00
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<!-- ======================================================================= -->
|
|
|
|
|
<div class="doc_subsection">
|
|
|
|
|
<a name="unwind_tables">Exception Handling Frame</a>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="doc_text">
|
|
|
|
|
|
|
|
|
|
<p>An exception handling frame <tt>eh_frame</tt> is very similar to the unwind
|
2009-08-15 10:56:09 +02:00
|
|
|
frame used by dwarf debug info. The frame contains all the information
|
|
|
|
|
necessary to tear down the current frame and restore the state of the prior
|
|
|
|
|
frame. There is an exception handling frame for each function in a compile
|
|
|
|
|
unit, plus a common exception handling frame that defines information common
|
|
|
|
|
to all functions in the unit.</p>
|
2007-03-14 20:29:42 +01:00
|
|
|
|
|
|
|
|
<p>Todo - Table details here.</p>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<!-- ======================================================================= -->
|
|
|
|
|
<div class="doc_subsection">
|
|
|
|
|
<a name="exception_tables">Exception Tables</a>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="doc_text">
|
|
|
|
|
|
|
|
|
|
<p>An exception table contains information about what actions to take when an
|
2009-08-15 10:56:09 +02:00
|
|
|
exception is thrown in a particular part of a function's code. There is one
|
|
|
|
|
exception table per function except leaf routines and functions that have
|
|
|
|
|
only calls to non-throwing functions will not need an exception table.</p>
|
2007-03-14 20:29:42 +01:00
|
|
|
|
|
|
|
|
<p>Todo - Table details here.</p>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<!-- ======================================================================= -->
|
|
|
|
|
<div class="doc_section">
|
|
|
|
|
<a name="todo">ToDo</a>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="doc_text">
|
|
|
|
|
|
|
|
|
|
<ol>
|
|
|
|
|
|
2009-08-15 10:56:09 +02:00
|
|
|
<li>Testing/Testing/Testing.</li>
|
2007-03-14 20:29:42 +01:00
|
|
|
|
|
|
|
|
</ol>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<!-- *********************************************************************** -->
|
|
|
|
|
|
|
|
|
|
<hr>
|
|
|
|
|
<address>
|
|
|
|
|
<a href="http://jigsaw.w3.org/css-validator/check/referer"><img
|
2008-12-11 18:34:48 +01:00
|
|
|
src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
|
2007-03-14 20:29:42 +01:00
|
|
|
<a href="http://validator.w3.org/check/referer"><img
|
2008-12-11 18:34:48 +01:00
|
|
|
src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
|
2007-03-14 20:29:42 +01:00
|
|
|
|
|
|
|
|
<a href="mailto:sabre@nondot.org">Chris Lattner</a><br>
|
|
|
|
|
<a href="http://llvm.org">LLVM Compiler Infrastructure</a><br>
|
|
|
|
|
Last modified: $Date$
|
|
|
|
|
</address>
|
|
|
|
|
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
