Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" |
| 2 | "http://www.w3.org/TR/html4/strict.dtd"> |
| 3 | <html> |
| 4 | <head> |
| 5 | <title>Exception Handling in LLVM</title> |
Bill Wendling | c4f661e | 2009-08-15 08:56:09 +0000 | [diff] [blame] | 6 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> |
Eric Christopher | 61f6978 | 2009-09-09 01:44:53 +0000 | [diff] [blame] | 7 | <meta name="description" |
Bill Wendling | c4f661e | 2009-08-15 08:56:09 +0000 | [diff] [blame] | 8 | content="Exception Handling in LLVM."> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 9 | <link rel="stylesheet" href="llvm.css" type="text/css"> |
| 10 | </head> |
Bill Wendling | c4f661e | 2009-08-15 08:56:09 +0000 | [diff] [blame] | 11 | |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 12 | <body> |
| 13 | |
NAKAMURA Takumi | 05d0265 | 2011-04-18 23:59:50 +0000 | [diff] [blame] | 14 | <h1>Exception Handling in LLVM</h1> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 15 | |
| 16 | <table class="layout" style="width:100%"> |
| 17 | <tr class="layout"> |
| 18 | <td class="left"> |
| 19 | <ul> |
| 20 | <li><a href="#introduction">Introduction</a> |
| 21 | <ol> |
| 22 | <li><a href="#itanium">Itanium ABI Zero-cost Exception Handling</a></li> |
Jim Grosbach | 00484d1 | 2009-08-22 01:42:39 +0000 | [diff] [blame] | 23 | <li><a href="#sjlj">Setjmp/Longjmp Exception Handling</a></li> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 24 | <li><a href="#overview">Overview</a></li> |
| 25 | </ol></li> |
| 26 | <li><a href="#codegen">LLVM Code Generation</a> |
| 27 | <ol> |
| 28 | <li><a href="#throw">Throw</a></li> |
| 29 | <li><a href="#try_catch">Try/Catch</a></li> |
Duncan Sands | 6590b04 | 2007-08-27 15:47:50 +0000 | [diff] [blame] | 30 | <li><a href="#cleanups">Cleanups</a></li> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 31 | <li><a href="#throw_filters">Throw Filters</a></li> |
Duncan Sands | 6590b04 | 2007-08-27 15:47:50 +0000 | [diff] [blame] | 32 | <li><a href="#restrictions">Restrictions</a></li> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 33 | </ol></li> |
Duncan Sands | 8036ca4 | 2007-03-30 12:22:09 +0000 | [diff] [blame] | 34 | <li><a href="#format_common_intrinsics">Exception Handling Intrinsics</a> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 35 | <ol> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 36 | <li><a href="#llvm_eh_typeid_for"><tt>llvm.eh.typeid.for</tt></a></li> |
Jim Grosbach | f957012 | 2009-05-14 00:46:35 +0000 | [diff] [blame] | 37 | <li><a href="#llvm_eh_sjlj_setjmp"><tt>llvm.eh.sjlj.setjmp</tt></a></li> |
| 38 | <li><a href="#llvm_eh_sjlj_longjmp"><tt>llvm.eh.sjlj.longjmp</tt></a></li> |
Jim Grosbach | 1b747ad | 2009-08-11 00:09:57 +0000 | [diff] [blame] | 39 | <li><a href="#llvm_eh_sjlj_lsda"><tt>llvm.eh.sjlj.lsda</tt></a></li> |
Jim Grosbach | ca752c9 | 2010-01-28 01:45:32 +0000 | [diff] [blame] | 40 | <li><a href="#llvm_eh_sjlj_callsite"><tt>llvm.eh.sjlj.callsite</tt></a></li> |
Jim Grosbach | e4ad387 | 2010-10-19 23:27:08 +0000 | [diff] [blame] | 41 | <li><a href="#llvm_eh_sjlj_dispatchsetup"><tt>llvm.eh.sjlj.dispatchsetup</tt></a></li> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 42 | </ol></li> |
| 43 | <li><a href="#asm">Asm Table Formats</a> |
| 44 | <ol> |
| 45 | <li><a href="#unwind_tables">Exception Handling Frame</a></li> |
| 46 | <li><a href="#exception_tables">Exception Tables</a></li> |
| 47 | </ol></li> |
| 48 | <li><a href="#todo">ToDo</a></li> |
| 49 | </ul> |
| 50 | </td> |
| 51 | </tr></table> |
| 52 | |
| 53 | <div class="doc_author"> |
| 54 | <p>Written by <a href="mailto:jlaskey@mac.com">Jim Laskey</a></p> |
| 55 | </div> |
| 56 | |
| 57 | |
| 58 | <!-- *********************************************************************** --> |
NAKAMURA Takumi | 05d0265 | 2011-04-18 23:59:50 +0000 | [diff] [blame] | 59 | <h2><a name="introduction">Introduction</a></h2> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 60 | <!-- *********************************************************************** --> |
| 61 | |
NAKAMURA Takumi | f5af6ad | 2011-04-23 00:30:22 +0000 | [diff] [blame] | 62 | <div> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 63 | |
| 64 | <p>This document is the central repository for all information pertaining to |
Bill Wendling | c4f661e | 2009-08-15 08:56:09 +0000 | [diff] [blame] | 65 | exception handling in LLVM. It describes the format that LLVM exception |
| 66 | handling information takes, which is useful for those interested in creating |
| 67 | front-ends or dealing directly with the information. Further, this document |
| 68 | provides specific examples of what exception handling information is used for |
Bill Wendling | 2a6b073 | 2011-09-26 21:06:33 +0000 | [diff] [blame^] | 69 | in C and C++.</p> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 70 | |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 71 | <!-- ======================================================================= --> |
NAKAMURA Takumi | 05d0265 | 2011-04-18 23:59:50 +0000 | [diff] [blame] | 72 | <h3> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 73 | <a name="itanium">Itanium ABI Zero-cost Exception Handling</a> |
NAKAMURA Takumi | 05d0265 | 2011-04-18 23:59:50 +0000 | [diff] [blame] | 74 | </h3> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 75 | |
NAKAMURA Takumi | f5af6ad | 2011-04-23 00:30:22 +0000 | [diff] [blame] | 76 | <div> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 77 | |
| 78 | <p>Exception handling for most programming languages is designed to recover from |
Bill Wendling | c4f661e | 2009-08-15 08:56:09 +0000 | [diff] [blame] | 79 | conditions that rarely occur during general use of an application. To that |
| 80 | end, exception handling should not interfere with the main flow of an |
| 81 | application's algorithm by performing checkpointing tasks, such as saving the |
| 82 | current pc or register state.</p> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 83 | |
| 84 | <p>The Itanium ABI Exception Handling Specification defines a methodology for |
Bill Wendling | c4f661e | 2009-08-15 08:56:09 +0000 | [diff] [blame] | 85 | providing outlying data in the form of exception tables without inlining |
| 86 | speculative exception handling code in the flow of an application's main |
| 87 | algorithm. Thus, the specification is said to add "zero-cost" to the normal |
| 88 | execution of an application.</p> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 89 | |
| 90 | <p>A more complete description of the Itanium ABI exception handling runtime |
Bill Wendling | c4f661e | 2009-08-15 08:56:09 +0000 | [diff] [blame] | 91 | support of can be found at |
| 92 | <a href="http://www.codesourcery.com/cxx-abi/abi-eh.html">Itanium C++ ABI: |
| 93 | Exception Handling</a>. A description of the exception frame format can be |
| 94 | found at |
| 95 | <a href="http://refspecs.freestandards.org/LSB_3.0.0/LSB-Core-generic/LSB-Core-generic/ehframechpt.html">Exception |
Bill Wendling | 4a065dd | 2011-09-20 01:08:53 +0000 | [diff] [blame] | 96 | Frames</a>, with details of the DWARF 4 specification at |
| 97 | <a href="http://dwarfstd.org/Dwarf4Std.php">DWARF 4 Standard</a>. |
Bill Wendling | c4f661e | 2009-08-15 08:56:09 +0000 | [diff] [blame] | 98 | A description for the C++ exception table formats can be found at |
| 99 | <a href="http://www.codesourcery.com/cxx-abi/exceptions.pdf">Exception Handling |
| 100 | Tables</a>.</p> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 101 | |
| 102 | </div> |
| 103 | |
| 104 | <!-- ======================================================================= --> |
NAKAMURA Takumi | 05d0265 | 2011-04-18 23:59:50 +0000 | [diff] [blame] | 105 | <h3> |
Jim Grosbach | 00484d1 | 2009-08-22 01:42:39 +0000 | [diff] [blame] | 106 | <a name="sjlj">Setjmp/Longjmp Exception Handling</a> |
NAKAMURA Takumi | 05d0265 | 2011-04-18 23:59:50 +0000 | [diff] [blame] | 107 | </h3> |
Jim Grosbach | 00484d1 | 2009-08-22 01:42:39 +0000 | [diff] [blame] | 108 | |
NAKAMURA Takumi | f5af6ad | 2011-04-23 00:30:22 +0000 | [diff] [blame] | 109 | <div> |
Jim Grosbach | 00484d1 | 2009-08-22 01:42:39 +0000 | [diff] [blame] | 110 | |
| 111 | <p>Setjmp/Longjmp (SJLJ) based exception handling uses LLVM intrinsics |
| 112 | <a href="#llvm_eh_sjlj_setjmp"><tt>llvm.eh.sjlj.setjmp</tt></a> and |
| 113 | <a href="#llvm_eh_sjlj_longjmp"><tt>llvm.eh.sjlj.longjmp</tt></a> to |
| 114 | handle control flow for exception handling.</p> |
| 115 | |
Bill Wendling | 4a065dd | 2011-09-20 01:08:53 +0000 | [diff] [blame] | 116 | <p>For each function which does exception processing — be |
| 117 | it <tt>try</tt>/<tt>catch</tt> blocks or cleanups — that function |
| 118 | registers itself on a global frame list. When exceptions are unwinding, the |
| 119 | runtime uses this list to identify which functions need processing.<p> |
Jim Grosbach | 00484d1 | 2009-08-22 01:42:39 +0000 | [diff] [blame] | 120 | |
| 121 | <p>Landing pad selection is encoded in the call site entry of the function |
| 122 | context. The runtime returns to the function via |
| 123 | <a href="#llvm_eh_sjlj_longjmp"><tt>llvm.eh.sjlj.longjmp</tt></a>, where |
| 124 | a switch table transfers control to the appropriate landing pad based on |
| 125 | the index stored in the function context.</p> |
| 126 | |
| 127 | <p>In contrast to DWARF exception handling, which encodes exception regions |
| 128 | and frame information in out-of-line tables, SJLJ exception handling |
| 129 | builds and removes the unwind frame context at runtime. This results in |
| 130 | faster exception handling at the expense of slower execution when no |
| 131 | exceptions are thrown. As exceptions are, by their nature, intended for |
| 132 | uncommon code paths, DWARF exception handling is generally preferred to |
| 133 | SJLJ.</p> |
Bill Wendling | 4a065dd | 2011-09-20 01:08:53 +0000 | [diff] [blame] | 134 | |
Jim Grosbach | 00484d1 | 2009-08-22 01:42:39 +0000 | [diff] [blame] | 135 | </div> |
| 136 | |
| 137 | <!-- ======================================================================= --> |
NAKAMURA Takumi | 05d0265 | 2011-04-18 23:59:50 +0000 | [diff] [blame] | 138 | <h3> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 139 | <a name="overview">Overview</a> |
NAKAMURA Takumi | 05d0265 | 2011-04-18 23:59:50 +0000 | [diff] [blame] | 140 | </h3> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 141 | |
NAKAMURA Takumi | f5af6ad | 2011-04-23 00:30:22 +0000 | [diff] [blame] | 142 | <div> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 143 | |
Bill Wendling | c4f661e | 2009-08-15 08:56:09 +0000 | [diff] [blame] | 144 | <p>When an exception is thrown in LLVM code, the runtime does its best to find a |
| 145 | handler suited to processing the circumstance.</p> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 146 | |
| 147 | <p>The runtime first attempts to find an <i>exception frame</i> corresponding to |
Bill Wendling | c4f661e | 2009-08-15 08:56:09 +0000 | [diff] [blame] | 148 | the function where the exception was thrown. If the programming language |
Bill Wendling | 2a6b073 | 2011-09-26 21:06:33 +0000 | [diff] [blame^] | 149 | supports exception handling (e.g. C++), the exception frame contains a |
Bill Wendling | c4f661e | 2009-08-15 08:56:09 +0000 | [diff] [blame] | 150 | reference to an exception table describing how to process the exception. If |
Bill Wendling | 2a6b073 | 2011-09-26 21:06:33 +0000 | [diff] [blame^] | 151 | the language does not support exception handling (e.g. C), or if the |
Bill Wendling | c4f661e | 2009-08-15 08:56:09 +0000 | [diff] [blame] | 152 | exception needs to be forwarded to a prior activation, the exception frame |
| 153 | contains information about how to unwind the current activation and restore |
| 154 | the state of the prior activation. This process is repeated until the |
Bill Wendling | 2a6b073 | 2011-09-26 21:06:33 +0000 | [diff] [blame^] | 155 | exception is handled. If the exception is not handled and no activations |
Bill Wendling | c4f661e | 2009-08-15 08:56:09 +0000 | [diff] [blame] | 156 | remain, then the application is terminated with an appropriate error |
| 157 | message.</p> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 158 | |
Bill Wendling | c4f661e | 2009-08-15 08:56:09 +0000 | [diff] [blame] | 159 | <p>Because different programming languages have different behaviors when |
| 160 | handling exceptions, the exception handling ABI provides a mechanism for |
Bill Wendling | 2a6b073 | 2011-09-26 21:06:33 +0000 | [diff] [blame^] | 161 | supplying <i>personalities</i>. An exception handling personality is defined |
Bill Wendling | c4f661e | 2009-08-15 08:56:09 +0000 | [diff] [blame] | 162 | by way of a <i>personality function</i> (e.g. <tt>__gxx_personality_v0</tt> |
| 163 | in C++), which receives the context of the exception, an <i>exception |
| 164 | structure</i> containing the exception object type and value, and a reference |
| 165 | to the exception table for the current function. The personality function |
| 166 | for the current compile unit is specified in a <i>common exception |
| 167 | frame</i>.</p> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 168 | |
Bill Wendling | 2a6b073 | 2011-09-26 21:06:33 +0000 | [diff] [blame^] | 169 | <p>The organization of an exception table is language dependent. For C++, an |
Bill Wendling | c4f661e | 2009-08-15 08:56:09 +0000 | [diff] [blame] | 170 | exception table is organized as a series of code ranges defining what to do |
Bill Wendling | 2a6b073 | 2011-09-26 21:06:33 +0000 | [diff] [blame^] | 171 | if an exception occurs in that range. Typically, the information associated |
Bill Wendling | c4f661e | 2009-08-15 08:56:09 +0000 | [diff] [blame] | 172 | with a range defines which types of exception objects (using C++ <i>type |
| 173 | info</i>) that are handled in that range, and an associated action that |
Bill Wendling | 2a6b073 | 2011-09-26 21:06:33 +0000 | [diff] [blame^] | 174 | should take place. Actions typically pass control to a <i>landing |
Bill Wendling | c4f661e | 2009-08-15 08:56:09 +0000 | [diff] [blame] | 175 | pad</i>.</p> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 176 | |
Bill Wendling | 2a6b073 | 2011-09-26 21:06:33 +0000 | [diff] [blame^] | 177 | <p>A landing pad corresponds roughly to the code found in the <tt>catch</tt> |
| 178 | portion of a <tt>try</tt>/<tt>catch</tt> sequence. When execution resumes at |
| 179 | a landing pad, it receives an <i>exception structure</i> and a |
| 180 | <i>selector value</i> corresponding to the <i>type</i> of exception |
| 181 | thrown. The selector is then used to determine which <i>catch</i> should |
| 182 | actually process the exception.</p> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 183 | |
| 184 | </div> |
| 185 | |
NAKAMURA Takumi | f5af6ad | 2011-04-23 00:30:22 +0000 | [diff] [blame] | 186 | </div> |
| 187 | |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 188 | <!-- ======================================================================= --> |
NAKAMURA Takumi | 05d0265 | 2011-04-18 23:59:50 +0000 | [diff] [blame] | 189 | <h2> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 190 | <a name="codegen">LLVM Code Generation</a> |
NAKAMURA Takumi | 05d0265 | 2011-04-18 23:59:50 +0000 | [diff] [blame] | 191 | </h2> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 192 | |
NAKAMURA Takumi | f5af6ad | 2011-04-23 00:30:22 +0000 | [diff] [blame] | 193 | <div> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 194 | |
Bill Wendling | 2a6b073 | 2011-09-26 21:06:33 +0000 | [diff] [blame^] | 195 | <p>From a C++ developer's perspective, exceptions are defined in terms of the |
Bill Wendling | 4a065dd | 2011-09-20 01:08:53 +0000 | [diff] [blame] | 196 | <tt>throw</tt> and <tt>try</tt>/<tt>catch</tt> statements. In this section |
Bill Wendling | c4f661e | 2009-08-15 08:56:09 +0000 | [diff] [blame] | 197 | we will describe the implementation of LLVM exception handling in terms of |
| 198 | C++ examples.</p> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 199 | |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 200 | <!-- ======================================================================= --> |
NAKAMURA Takumi | 05d0265 | 2011-04-18 23:59:50 +0000 | [diff] [blame] | 201 | <h3> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 202 | <a name="throw">Throw</a> |
NAKAMURA Takumi | 05d0265 | 2011-04-18 23:59:50 +0000 | [diff] [blame] | 203 | </h3> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 204 | |
NAKAMURA Takumi | f5af6ad | 2011-04-23 00:30:22 +0000 | [diff] [blame] | 205 | <div> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 206 | |
| 207 | <p>Languages that support exception handling typically provide a <tt>throw</tt> |
Bill Wendling | 2a6b073 | 2011-09-26 21:06:33 +0000 | [diff] [blame^] | 208 | operation to initiate the exception process. Internally, a <tt>throw</tt> |
| 209 | operation breaks down into two steps.</p> |
| 210 | |
Bill Wendling | 4a065dd | 2011-09-20 01:08:53 +0000 | [diff] [blame] | 211 | <ol> |
| 212 | <li>A request is made to allocate exception space for an exception structure. |
| 213 | This structure needs to survive beyond the current activation. This |
| 214 | structure will contain the type and value of the object being thrown.</li> |
Bill Wendling | 2a6b073 | 2011-09-26 21:06:33 +0000 | [diff] [blame^] | 215 | |
Bill Wendling | 4a065dd | 2011-09-20 01:08:53 +0000 | [diff] [blame] | 216 | <li>A call is made to the runtime to raise the exception, passing the |
| 217 | exception structure as an argument.</li> |
| 218 | </ol> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 219 | |
Bill Wendling | 2a6b073 | 2011-09-26 21:06:33 +0000 | [diff] [blame^] | 220 | <p>In C++, the allocation of the exception structure is done by the |
Bill Wendling | 4a065dd | 2011-09-20 01:08:53 +0000 | [diff] [blame] | 221 | <tt>__cxa_allocate_exception</tt> runtime function. The exception raising is |
| 222 | handled by <tt>__cxa_throw</tt>. The type of the exception is represented |
| 223 | using a C++ RTTI structure.</p> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 224 | |
| 225 | </div> |
| 226 | |
| 227 | <!-- ======================================================================= --> |
NAKAMURA Takumi | 05d0265 | 2011-04-18 23:59:50 +0000 | [diff] [blame] | 228 | <h3> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 229 | <a name="try_catch">Try/Catch</a> |
NAKAMURA Takumi | 05d0265 | 2011-04-18 23:59:50 +0000 | [diff] [blame] | 230 | </h3> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 231 | |
NAKAMURA Takumi | f5af6ad | 2011-04-23 00:30:22 +0000 | [diff] [blame] | 232 | <div> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 233 | |
Bill Wendling | c4f661e | 2009-08-15 08:56:09 +0000 | [diff] [blame] | 234 | <p>A call within the scope of a <i>try</i> statement can potentially raise an |
Bill Wendling | 2a6b073 | 2011-09-26 21:06:33 +0000 | [diff] [blame^] | 235 | exception. In those circumstances, the LLVM C++ front-end replaces the call |
| 236 | with an <tt>invoke</tt> instruction. Unlike a call, the <tt>invoke</tt> has |
| 237 | two potential continuation points:</p> |
| 238 | |
| 239 | <ol> |
| 240 | <li>where to continue when the call succeeds as per normal, and</li> |
| 241 | |
| 242 | <li>where to continue if the call raises an exception, either by a throw or |
| 243 | the unwinding of a throw</li> |
| 244 | </ol> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 245 | |
Bill Wendling | c4f661e | 2009-08-15 08:56:09 +0000 | [diff] [blame] | 246 | <p>The term used to define a the place where an <tt>invoke</tt> continues after |
Bill Wendling | 2a6b073 | 2011-09-26 21:06:33 +0000 | [diff] [blame^] | 247 | an exception is called a <i>landing pad</i>. LLVM landing pads are |
Bill Wendling | c4f661e | 2009-08-15 08:56:09 +0000 | [diff] [blame] | 248 | conceptually alternative function entry points where an exception structure |
Bill Wendling | 2a6b073 | 2011-09-26 21:06:33 +0000 | [diff] [blame^] | 249 | reference and a type info index are passed in as arguments. The landing pad |
Bill Wendling | c4f661e | 2009-08-15 08:56:09 +0000 | [diff] [blame] | 250 | saves the exception structure reference and then proceeds to select the catch |
| 251 | block that corresponds to the type info of the exception object.</p> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 252 | |
Bill Wendling | 4a065dd | 2011-09-20 01:08:53 +0000 | [diff] [blame] | 253 | <p>The LLVM <a href="LangRef.html#i_landingpad"><tt>landingpad</tt> |
| 254 | instruction</a> is used to convey information about the landing pad to the |
| 255 | back end. For C++, the <tt>landingpad</tt> instruction returns a pointer and |
Bill Wendling | 2a6b073 | 2011-09-26 21:06:33 +0000 | [diff] [blame^] | 256 | integer pair corresponding to the pointer to the <i>exception structure</i> |
| 257 | and the <i>selector value</i> respectively.</p> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 258 | |
Bill Wendling | 4a065dd | 2011-09-20 01:08:53 +0000 | [diff] [blame] | 259 | <p>The <tt>landingpad</tt> instruction takes a reference to the personality |
| 260 | function to be used for this <tt>try</tt>/<tt>catch</tt> sequence. The |
Bill Wendling | 2a6b073 | 2011-09-26 21:06:33 +0000 | [diff] [blame^] | 261 | remainder of the instruction is a list of <i>cleanup</i>, <i>catch</i>, |
| 262 | and <i>filter</i> clauses. The exception is tested against the clauses |
| 263 | sequentially from first to last. The selector value is a positive number if |
| 264 | the exception matched a type info, a negative number if it matched a filter, |
| 265 | and zero if it matched a cleanup. If nothing is matched, the behavior of the |
| 266 | program is <a href="#restrictions">undefined</a>. If a type info matched, |
| 267 | then the selector value is the index of the type info in the exception table, |
| 268 | which can be obtained using the |
Bill Wendling | 4a065dd | 2011-09-20 01:08:53 +0000 | [diff] [blame] | 269 | <a href="#llvm_eh_typeid_for"><tt>llvm.eh.typeid.for</tt></a> intrinsic.</p> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 270 | |
| 271 | <p>Once the landing pad has the type info selector, the code branches to the |
Bill Wendling | 4a065dd | 2011-09-20 01:08:53 +0000 | [diff] [blame] | 272 | code for the first catch. The catch then checks the value of the type info |
Bill Wendling | c4f661e | 2009-08-15 08:56:09 +0000 | [diff] [blame] | 273 | selector against the index of type info for that catch. Since the type info |
Bill Wendling | 2a6b073 | 2011-09-26 21:06:33 +0000 | [diff] [blame^] | 274 | index is not known until all the type infos have been gathered in the |
| 275 | backend, the catch code must call the |
Bill Wendling | 4a065dd | 2011-09-20 01:08:53 +0000 | [diff] [blame] | 276 | <a href="#llvm_eh_typeid_for"><tt>llvm.eh.typeid.for</tt></a> intrinsic to |
| 277 | determine the index for a given type info. If the catch fails to match the |
Bill Wendling | 2a6b073 | 2011-09-26 21:06:33 +0000 | [diff] [blame^] | 278 | selector then control is passed on to the next catch.</p> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 279 | |
Bill Wendling | 2a6b073 | 2011-09-26 21:06:33 +0000 | [diff] [blame^] | 280 | <p><b>Note:</b> Since the landing pad will not be used if there is no match in |
| 281 | the list of type info on the call to the <tt>landingpad</tt> instruction, |
| 282 | then neither the last catch nor <i>catch all</i> need to perform the check |
| 283 | against the selector.</p> |
| 284 | |
| 285 | <p>Finally, the entry and exit of catch code is bracketed with calls to |
| 286 | <tt>__cxa_begin_catch</tt> and <tt>__cxa_end_catch</tt>.</p> |
Bill Wendling | c4f661e | 2009-08-15 08:56:09 +0000 | [diff] [blame] | 287 | |
| 288 | <ul> |
Bill Wendling | 2a6b073 | 2011-09-26 21:06:33 +0000 | [diff] [blame^] | 289 | <li><tt>__cxa_begin_catch</tt> takes an exception structure reference as an |
Bill Wendling | c4f661e | 2009-08-15 08:56:09 +0000 | [diff] [blame] | 290 | argument and returns the value of the exception object.</li> |
| 291 | |
Bill Wendling | 169e1b0 | 2009-09-10 22:14:16 +0000 | [diff] [blame] | 292 | <li><tt>__cxa_end_catch</tt> takes no arguments. This function:<br><br> |
| 293 | <ol> |
Bill Wendling | 808b9ce | 2009-09-10 22:12:50 +0000 | [diff] [blame] | 294 | <li>Locates the most recently caught exception and decrements its handler |
| 295 | count,</li> |
Bill Wendling | 2a6b073 | 2011-09-26 21:06:33 +0000 | [diff] [blame^] | 296 | <li>Removes the exception from the <i>caught</i> stack if the handler |
| 297 | count goes to zero, and</li> |
| 298 | <li>Destroys the exception if the handler count goes to zero and the |
Bill Wendling | 808b9ce | 2009-09-10 22:12:50 +0000 | [diff] [blame] | 299 | exception was not re-thrown by throw.</li> |
Bill Wendling | 169e1b0 | 2009-09-10 22:14:16 +0000 | [diff] [blame] | 300 | </ol> |
Bill Wendling | 2a6b073 | 2011-09-26 21:06:33 +0000 | [diff] [blame^] | 301 | <p><b>Note:</b> a rethrow from within the catch may replace this call with |
Bill Wendling | 808b9ce | 2009-09-10 22:12:50 +0000 | [diff] [blame] | 302 | a <tt>__cxa_rethrow</tt>.</p></li> |
Bill Wendling | c4f661e | 2009-08-15 08:56:09 +0000 | [diff] [blame] | 303 | </ul> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 304 | |
| 305 | </div> |
| 306 | |
| 307 | <!-- ======================================================================= --> |
NAKAMURA Takumi | 05d0265 | 2011-04-18 23:59:50 +0000 | [diff] [blame] | 308 | <h3> |
Duncan Sands | 6590b04 | 2007-08-27 15:47:50 +0000 | [diff] [blame] | 309 | <a name="cleanups">Cleanups</a> |
NAKAMURA Takumi | 05d0265 | 2011-04-18 23:59:50 +0000 | [diff] [blame] | 310 | </h3> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 311 | |
NAKAMURA Takumi | f5af6ad | 2011-04-23 00:30:22 +0000 | [diff] [blame] | 312 | <div> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 313 | |
Bill Wendling | 4a065dd | 2011-09-20 01:08:53 +0000 | [diff] [blame] | 314 | <p>A cleanup is extra code which needs to be run as part of unwinding a scope. |
Bill Wendling | 2a6b073 | 2011-09-26 21:06:33 +0000 | [diff] [blame^] | 315 | C++ destructors are a typical example, but other languages and language |
| 316 | extensions provide a variety of different kinds of cleanups. In general, a |
Bill Wendling | 4a065dd | 2011-09-20 01:08:53 +0000 | [diff] [blame] | 317 | landing pad may need to run arbitrary amounts of cleanup code before actually |
Bill Wendling | 2a6b073 | 2011-09-26 21:06:33 +0000 | [diff] [blame^] | 318 | entering a catch block. To indicate the presence of cleanups, a |
Bill Wendling | 4a065dd | 2011-09-20 01:08:53 +0000 | [diff] [blame] | 319 | <a href="LangRef.html#i_landingpad"><tt>landingpad</tt> instruction</a> |
| 320 | should have a <i>cleanup</i> clause. Otherwise, the unwinder will not stop at |
| 321 | the landing pad if there are no catches or filters that require it to.</p> |
John McCall | d7c1086 | 2011-05-28 07:45:59 +0000 | [diff] [blame] | 322 | |
Bill Wendling | 2a6b073 | 2011-09-26 21:06:33 +0000 | [diff] [blame^] | 323 | <p><b>Note:</b> Do not allow a new exception to propagate out of the execution |
| 324 | of a cleanup. This can corrupt the internal state of the unwinder. |
| 325 | Different languages describe different high-level semantics for these |
| 326 | situations: for example, C++ requires that the process be terminated, whereas |
| 327 | Ada cancels both exceptions and throws a third.</p> |
John McCall | d7c1086 | 2011-05-28 07:45:59 +0000 | [diff] [blame] | 328 | |
Bill Wendling | 2a6b073 | 2011-09-26 21:06:33 +0000 | [diff] [blame^] | 329 | <p>When all cleanups are finished, if the exception is not handled by the |
| 330 | current function, resume unwinding by calling the |
Bill Wendling | 4a065dd | 2011-09-20 01:08:53 +0000 | [diff] [blame] | 331 | <a href="LangRef.html#i_resume"><tt>resume</tt> instruction</a>, passing in |
Bill Wendling | 2a6b073 | 2011-09-26 21:06:33 +0000 | [diff] [blame^] | 332 | the result of the <tt>landingpad</tt> instruction for the original landing |
Bill Wendling | 4a065dd | 2011-09-20 01:08:53 +0000 | [diff] [blame] | 333 | pad.</p> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 334 | |
| 335 | </div> |
| 336 | |
| 337 | <!-- ======================================================================= --> |
NAKAMURA Takumi | 05d0265 | 2011-04-18 23:59:50 +0000 | [diff] [blame] | 338 | <h3> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 339 | <a name="throw_filters">Throw Filters</a> |
NAKAMURA Takumi | 05d0265 | 2011-04-18 23:59:50 +0000 | [diff] [blame] | 340 | </h3> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 341 | |
NAKAMURA Takumi | f5af6ad | 2011-04-23 00:30:22 +0000 | [diff] [blame] | 342 | <div> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 343 | |
Bill Wendling | 2a6b073 | 2011-09-26 21:06:33 +0000 | [diff] [blame^] | 344 | <p>C++ allows the specification of which exception types may be thrown from a |
| 345 | function. To represent this, a top level landing pad may exist to filter out |
| 346 | invalid types. To express this in LLVM code the |
Bill Wendling | 4a065dd | 2011-09-20 01:08:53 +0000 | [diff] [blame] | 347 | <a href="LangRef.html#i_landingpad"><tt>landingpad</tt> instruction</a> will |
| 348 | have a filter clause. The clause consists of an array of type infos. |
| 349 | <tt>landingpad</tt> will return a negative value if the exception does not |
| 350 | match any of the type infos. If no match is found then a call |
| 351 | to <tt>__cxa_call_unexpected</tt> should be made, otherwise |
| 352 | <tt>_Unwind_Resume</tt>. Each of these functions requires a reference to the |
| 353 | exception structure. Note that the most general form of a |
| 354 | <a href="LangRef.html#i_landingpad"><tt>landingpad</tt> instruction</a> can |
| 355 | have any number of catch, cleanup, and filter clauses (though having more |
| 356 | than one cleanup is pointless). The LLVM C++ front-end can generate such |
| 357 | <a href="LangRef.html#i_landingpad"><tt>landingpad</tt> instructions</a> due |
| 358 | to inlining creating nested exception handling scopes.</p> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 359 | |
| 360 | </div> |
| 361 | |
| 362 | <!-- ======================================================================= --> |
NAKAMURA Takumi | 05d0265 | 2011-04-18 23:59:50 +0000 | [diff] [blame] | 363 | <h3> |
Duncan Sands | 6590b04 | 2007-08-27 15:47:50 +0000 | [diff] [blame] | 364 | <a name="restrictions">Restrictions</a> |
NAKAMURA Takumi | 05d0265 | 2011-04-18 23:59:50 +0000 | [diff] [blame] | 365 | </h3> |
Duncan Sands | 6590b04 | 2007-08-27 15:47:50 +0000 | [diff] [blame] | 366 | |
NAKAMURA Takumi | f5af6ad | 2011-04-23 00:30:22 +0000 | [diff] [blame] | 367 | <div> |
Duncan Sands | 6590b04 | 2007-08-27 15:47:50 +0000 | [diff] [blame] | 368 | |
Bill Wendling | 4a065dd | 2011-09-20 01:08:53 +0000 | [diff] [blame] | 369 | <p>The unwinder delegates the decision of whether to stop in a call frame to |
Bill Wendling | 2a6b073 | 2011-09-26 21:06:33 +0000 | [diff] [blame^] | 370 | that call frame's language-specific personality function. Not all personality |
| 371 | functions guarantee that they will stop to perform cleanups. For example, the |
| 372 | GNU C++ personality function doesn't do so unless the exception is actually |
| 373 | caught somewhere further up the stack. When using this personality to |
| 374 | implement EH for a language that guarantees that cleanups will always be run |
| 375 | (e.g. Ada), be sure to indicate a catch-all in the |
Bill Wendling | 4a065dd | 2011-09-20 01:08:53 +0000 | [diff] [blame] | 376 | <a href="LangRef.html#i_landingpad"><tt>landingpad</tt> instruction</a> |
John McCall | d7c1086 | 2011-05-28 07:45:59 +0000 | [diff] [blame] | 377 | rather than just cleanups.</p> |
| 378 | |
Bill Wendling | 4a065dd | 2011-09-20 01:08:53 +0000 | [diff] [blame] | 379 | <p>In order for inlining to behave correctly, landing pads must be prepared to |
Bill Wendling | 2a6b073 | 2011-09-26 21:06:33 +0000 | [diff] [blame^] | 380 | handle selector results that they did not originally advertise. Suppose that |
Bill Wendling | 4a065dd | 2011-09-20 01:08:53 +0000 | [diff] [blame] | 381 | a function catches exceptions of type <tt>A</tt>, and it's inlined into a |
Bill Wendling | 2a6b073 | 2011-09-26 21:06:33 +0000 | [diff] [blame^] | 382 | function that catches exceptions of type <tt>B</tt>. The inliner will update |
Bill Wendling | 4a065dd | 2011-09-20 01:08:53 +0000 | [diff] [blame] | 383 | the <tt>landingpad</tt> instruction for the inlined landing pad to include |
Bill Wendling | 2a6b073 | 2011-09-26 21:06:33 +0000 | [diff] [blame^] | 384 | the fact that <tt>B</tt> is also caught. If that landing pad assumes that it |
| 385 | will only be entered to catch an <tt>A</tt>, it's in for a rude awakening. |
Bill Wendling | 4a065dd | 2011-09-20 01:08:53 +0000 | [diff] [blame] | 386 | Consequently, landing pads must test for the selector results they understand |
| 387 | and then resume exception propagation with the |
| 388 | <a href="LangRef.html#i_resume"><tt>resume</tt> instruction</a> if none of |
| 389 | the conditions match.</p> |
Duncan Sands | 6590b04 | 2007-08-27 15:47:50 +0000 | [diff] [blame] | 390 | |
| 391 | </div> |
| 392 | |
NAKAMURA Takumi | f5af6ad | 2011-04-23 00:30:22 +0000 | [diff] [blame] | 393 | </div> |
| 394 | |
Duncan Sands | 6590b04 | 2007-08-27 15:47:50 +0000 | [diff] [blame] | 395 | <!-- ======================================================================= --> |
NAKAMURA Takumi | 05d0265 | 2011-04-18 23:59:50 +0000 | [diff] [blame] | 396 | <h2> |
Duncan Sands | 8036ca4 | 2007-03-30 12:22:09 +0000 | [diff] [blame] | 397 | <a name="format_common_intrinsics">Exception Handling Intrinsics</a> |
NAKAMURA Takumi | 05d0265 | 2011-04-18 23:59:50 +0000 | [diff] [blame] | 398 | </h2> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 399 | |
NAKAMURA Takumi | f5af6ad | 2011-04-23 00:30:22 +0000 | [diff] [blame] | 400 | <div> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 401 | |
Bill Wendling | 4a065dd | 2011-09-20 01:08:53 +0000 | [diff] [blame] | 402 | <p>In addition to the |
| 403 | <a href="LangRef.html#i_landingpad"><tt>landingpad</tt></a> and |
| 404 | <a href="LangRef.html#i_resume"><tt>resume</tt></a> instructions, LLVM uses |
Bill Wendling | 2a6b073 | 2011-09-26 21:06:33 +0000 | [diff] [blame^] | 405 | several intrinsic functions (name prefixed with <i><tt>llvm.eh</tt></i>) to |
Bill Wendling | c4f661e | 2009-08-15 08:56:09 +0000 | [diff] [blame] | 406 | provide exception handling information at various points in generated |
| 407 | code.</p> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 408 | |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 409 | <!-- ======================================================================= --> |
NAKAMURA Takumi | 05d0265 | 2011-04-18 23:59:50 +0000 | [diff] [blame] | 410 | <h4> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 411 | <a name="llvm_eh_typeid_for">llvm.eh.typeid.for</a> |
NAKAMURA Takumi | 05d0265 | 2011-04-18 23:59:50 +0000 | [diff] [blame] | 412 | </h4> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 413 | |
NAKAMURA Takumi | f5af6ad | 2011-04-23 00:30:22 +0000 | [diff] [blame] | 414 | <div> |
Bill Wendling | bf230bf | 2009-08-15 20:08:04 +0000 | [diff] [blame] | 415 | |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 416 | <pre> |
Bill Wendling | 2a6b073 | 2011-09-26 21:06:33 +0000 | [diff] [blame^] | 417 | i32 @llvm.eh.typeid.for(i8* %type_info) |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 418 | </pre> |
| 419 | |
| 420 | <p>This intrinsic returns the type info index in the exception table of the |
Bill Wendling | c4f661e | 2009-08-15 08:56:09 +0000 | [diff] [blame] | 421 | current function. This value can be used to compare against the result |
Bill Wendling | 3c05196 | 2011-09-20 01:14:54 +0000 | [diff] [blame] | 422 | of <a href="LangRef.html#i_landingpad"><tt>landingpad</tt> instruction</a>. |
| 423 | The single argument is a reference to a type info.</p> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 424 | |
| 425 | </div> |
| 426 | |
| 427 | <!-- ======================================================================= --> |
NAKAMURA Takumi | 05d0265 | 2011-04-18 23:59:50 +0000 | [diff] [blame] | 428 | <h4> |
Jim Grosbach | f957012 | 2009-05-14 00:46:35 +0000 | [diff] [blame] | 429 | <a name="llvm_eh_sjlj_setjmp">llvm.eh.sjlj.setjmp</a> |
NAKAMURA Takumi | 05d0265 | 2011-04-18 23:59:50 +0000 | [diff] [blame] | 430 | </h4> |
Jim Grosbach | f957012 | 2009-05-14 00:46:35 +0000 | [diff] [blame] | 431 | |
NAKAMURA Takumi | f5af6ad | 2011-04-23 00:30:22 +0000 | [diff] [blame] | 432 | <div> |
Bill Wendling | 3cf4ffd | 2009-08-15 20:07:42 +0000 | [diff] [blame] | 433 | |
Jim Grosbach | f957012 | 2009-05-14 00:46:35 +0000 | [diff] [blame] | 434 | <pre> |
Bill Wendling | 2a6b073 | 2011-09-26 21:06:33 +0000 | [diff] [blame^] | 435 | i32 @llvm.eh.sjlj.setjmp(i8* %setjmp_buf) |
Jim Grosbach | f957012 | 2009-05-14 00:46:35 +0000 | [diff] [blame] | 436 | </pre> |
| 437 | |
Bill Wendling | 2a6b073 | 2011-09-26 21:06:33 +0000 | [diff] [blame^] | 438 | <p>For SJLJ based exception handling, this intrinsic forces register saving for |
| 439 | the current function and stores the address of the following instruction for |
| 440 | use as a destination address |
| 441 | by <a href="#llvm_eh_sjlj_longjmp"><tt>llvm.eh.sjlj.longjmp</tt></a>. The |
| 442 | buffer format and the overall functioning of this intrinsic is compatible |
| 443 | with the GCC <tt>__builtin_setjmp</tt> implementation allowing code built |
| 444 | with the clang and GCC to interoperate.</p> |
Jim Grosbach | f957012 | 2009-05-14 00:46:35 +0000 | [diff] [blame] | 445 | |
Bill Wendling | c4f661e | 2009-08-15 08:56:09 +0000 | [diff] [blame] | 446 | <p>The single parameter is a pointer to a five word buffer in which the calling |
| 447 | context is saved. The front end places the frame pointer in the first word, |
| 448 | and the target implementation of this intrinsic should place the destination |
| 449 | address for a |
| 450 | <a href="#llvm_eh_sjlj_longjmp"><tt>llvm.eh.sjlj.longjmp</tt></a> in the |
| 451 | second word. The following three words are available for use in a |
| 452 | target-specific manner.</p> |
Jim Grosbach | f957012 | 2009-05-14 00:46:35 +0000 | [diff] [blame] | 453 | |
Benjamin Kramer | e15192b | 2009-08-05 15:42:44 +0000 | [diff] [blame] | 454 | </div> |
| 455 | |
Jim Grosbach | f957012 | 2009-05-14 00:46:35 +0000 | [diff] [blame] | 456 | <!-- ======================================================================= --> |
NAKAMURA Takumi | 05d0265 | 2011-04-18 23:59:50 +0000 | [diff] [blame] | 457 | <h4> |
Jim Grosbach | 90346e2 | 2010-05-26 16:21:41 +0000 | [diff] [blame] | 458 | <a name="llvm_eh_sjlj_longjmp">llvm.eh.sjlj.longjmp</a> |
NAKAMURA Takumi | 05d0265 | 2011-04-18 23:59:50 +0000 | [diff] [blame] | 459 | </h4> |
Jim Grosbach | 90346e2 | 2010-05-26 16:21:41 +0000 | [diff] [blame] | 460 | |
NAKAMURA Takumi | f5af6ad | 2011-04-23 00:30:22 +0000 | [diff] [blame] | 461 | <div> |
Jim Grosbach | 90346e2 | 2010-05-26 16:21:41 +0000 | [diff] [blame] | 462 | |
| 463 | <pre> |
Bill Wendling | 2a6b073 | 2011-09-26 21:06:33 +0000 | [diff] [blame^] | 464 | void @llvm.eh.sjlj.longjmp(i8* %setjmp_buf) |
Jim Grosbach | 90346e2 | 2010-05-26 16:21:41 +0000 | [diff] [blame] | 465 | </pre> |
| 466 | |
Bill Wendling | 2a6b073 | 2011-09-26 21:06:33 +0000 | [diff] [blame^] | 467 | <p>For SJLJ based exception handling, the <tt>llvm.eh.sjlj.longjmp</tt> |
| 468 | intrinsic is used to implement <tt>__builtin_longjmp()</tt>. The single |
| 469 | parameter is a pointer to a buffer populated |
| 470 | by <a href="#llvm_eh_sjlj_setjmp"><tt>llvm.eh.sjlj.setjmp</tt></a>. The frame |
| 471 | pointer and stack pointer are restored from the buffer, then control is |
| 472 | transferred to the destination address.</p> |
Jim Grosbach | 90346e2 | 2010-05-26 16:21:41 +0000 | [diff] [blame] | 473 | |
| 474 | </div> |
| 475 | <!-- ======================================================================= --> |
NAKAMURA Takumi | 05d0265 | 2011-04-18 23:59:50 +0000 | [diff] [blame] | 476 | <h4> |
Jim Grosbach | 1b747ad | 2009-08-11 00:09:57 +0000 | [diff] [blame] | 477 | <a name="llvm_eh_sjlj_lsda">llvm.eh.sjlj.lsda</a> |
NAKAMURA Takumi | 05d0265 | 2011-04-18 23:59:50 +0000 | [diff] [blame] | 478 | </h4> |
Jim Grosbach | 1b747ad | 2009-08-11 00:09:57 +0000 | [diff] [blame] | 479 | |
NAKAMURA Takumi | f5af6ad | 2011-04-23 00:30:22 +0000 | [diff] [blame] | 480 | <div> |
Bill Wendling | 3cf4ffd | 2009-08-15 20:07:42 +0000 | [diff] [blame] | 481 | |
Jim Grosbach | 1b747ad | 2009-08-11 00:09:57 +0000 | [diff] [blame] | 482 | <pre> |
Bill Wendling | 2a6b073 | 2011-09-26 21:06:33 +0000 | [diff] [blame^] | 483 | i8* @llvm.eh.sjlj.lsda() |
Jim Grosbach | 1b747ad | 2009-08-11 00:09:57 +0000 | [diff] [blame] | 484 | </pre> |
| 485 | |
Bill Wendling | 2a6b073 | 2011-09-26 21:06:33 +0000 | [diff] [blame^] | 486 | <p>For SJLJ based exception handling, the <tt>llvm.eh.sjlj.lsda</tt> intrinsic |
| 487 | returns the address of the Language Specific Data Area (LSDA) for the current |
| 488 | function. The SJLJ front-end code stores this address in the exception |
| 489 | handling function context for use by the runtime.</p> |
Jim Grosbach | 1b747ad | 2009-08-11 00:09:57 +0000 | [diff] [blame] | 490 | |
| 491 | </div> |
| 492 | |
| 493 | <!-- ======================================================================= --> |
NAKAMURA Takumi | 05d0265 | 2011-04-18 23:59:50 +0000 | [diff] [blame] | 494 | <h4> |
Jim Grosbach | ca752c9 | 2010-01-28 01:45:32 +0000 | [diff] [blame] | 495 | <a name="llvm_eh_sjlj_callsite">llvm.eh.sjlj.callsite</a> |
NAKAMURA Takumi | 05d0265 | 2011-04-18 23:59:50 +0000 | [diff] [blame] | 496 | </h4> |
Jim Grosbach | ca752c9 | 2010-01-28 01:45:32 +0000 | [diff] [blame] | 497 | |
NAKAMURA Takumi | f5af6ad | 2011-04-23 00:30:22 +0000 | [diff] [blame] | 498 | <div> |
Jim Grosbach | ca752c9 | 2010-01-28 01:45:32 +0000 | [diff] [blame] | 499 | |
| 500 | <pre> |
Bill Wendling | 2a6b073 | 2011-09-26 21:06:33 +0000 | [diff] [blame^] | 501 | void @llvm.eh.sjlj.callsite(i32 %call_site_num) |
Jim Grosbach | ca752c9 | 2010-01-28 01:45:32 +0000 | [diff] [blame] | 502 | </pre> |
| 503 | |
Bill Wendling | 2a6b073 | 2011-09-26 21:06:33 +0000 | [diff] [blame^] | 504 | <p>For SJLJ based exception handling, the <tt>llvm.eh.sjlj.callsite</tt> |
| 505 | intrinsic identifies the callsite value associated with the |
| 506 | following <tt>invoke</tt> instruction. This is used to ensure that landing |
| 507 | pad entries in the LSDA are generated in matching order.</p> |
Jim Grosbach | ca752c9 | 2010-01-28 01:45:32 +0000 | [diff] [blame] | 508 | |
| 509 | </div> |
| 510 | |
| 511 | <!-- ======================================================================= --> |
NAKAMURA Takumi | 05d0265 | 2011-04-18 23:59:50 +0000 | [diff] [blame] | 512 | <h4> |
Jim Grosbach | e4ad387 | 2010-10-19 23:27:08 +0000 | [diff] [blame] | 513 | <a name="llvm_eh_sjlj_dispatchsetup">llvm.eh.sjlj.dispatchsetup</a> |
NAKAMURA Takumi | 05d0265 | 2011-04-18 23:59:50 +0000 | [diff] [blame] | 514 | </h4> |
Jim Grosbach | e4ad387 | 2010-10-19 23:27:08 +0000 | [diff] [blame] | 515 | |
NAKAMURA Takumi | f5af6ad | 2011-04-23 00:30:22 +0000 | [diff] [blame] | 516 | <div> |
Jim Grosbach | e4ad387 | 2010-10-19 23:27:08 +0000 | [diff] [blame] | 517 | |
| 518 | <pre> |
Bill Wendling | 2a6b073 | 2011-09-26 21:06:33 +0000 | [diff] [blame^] | 519 | void @llvm.eh.sjlj.dispatchsetup(i32 %dispatch_value) |
Jim Grosbach | e4ad387 | 2010-10-19 23:27:08 +0000 | [diff] [blame] | 520 | </pre> |
| 521 | |
Bill Wendling | 2a6b073 | 2011-09-26 21:06:33 +0000 | [diff] [blame^] | 522 | <p>For SJLJ based exception handling, the <tt>llvm.eh.sjlj.dispatchsetup</tt> |
| 523 | intrinsic is used by targets to do any unwind edge setup they need. By |
| 524 | default, no action is taken.</p> |
Jim Grosbach | e4ad387 | 2010-10-19 23:27:08 +0000 | [diff] [blame] | 525 | |
| 526 | </div> |
| 527 | |
NAKAMURA Takumi | f5af6ad | 2011-04-23 00:30:22 +0000 | [diff] [blame] | 528 | </div> |
| 529 | |
Jim Grosbach | e4ad387 | 2010-10-19 23:27:08 +0000 | [diff] [blame] | 530 | <!-- ======================================================================= --> |
NAKAMURA Takumi | 05d0265 | 2011-04-18 23:59:50 +0000 | [diff] [blame] | 531 | <h2> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 532 | <a name="asm">Asm Table Formats</a> |
NAKAMURA Takumi | 05d0265 | 2011-04-18 23:59:50 +0000 | [diff] [blame] | 533 | </h2> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 534 | |
NAKAMURA Takumi | f5af6ad | 2011-04-23 00:30:22 +0000 | [diff] [blame] | 535 | <div> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 536 | |
| 537 | <p>There are two tables that are used by the exception handling runtime to |
Bill Wendling | 2a6b073 | 2011-09-26 21:06:33 +0000 | [diff] [blame^] | 538 | determine which actions should be taken when an exception is thrown.</p> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 539 | |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 540 | <!-- ======================================================================= --> |
NAKAMURA Takumi | 05d0265 | 2011-04-18 23:59:50 +0000 | [diff] [blame] | 541 | <h3> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 542 | <a name="unwind_tables">Exception Handling Frame</a> |
NAKAMURA Takumi | 05d0265 | 2011-04-18 23:59:50 +0000 | [diff] [blame] | 543 | </h3> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 544 | |
NAKAMURA Takumi | f5af6ad | 2011-04-23 00:30:22 +0000 | [diff] [blame] | 545 | <div> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 546 | |
| 547 | <p>An exception handling frame <tt>eh_frame</tt> is very similar to the unwind |
Bill Wendling | 2a6b073 | 2011-09-26 21:06:33 +0000 | [diff] [blame^] | 548 | frame used by DWARF debug info. The frame contains all the information |
Bill Wendling | c4f661e | 2009-08-15 08:56:09 +0000 | [diff] [blame] | 549 | necessary to tear down the current frame and restore the state of the prior |
Bill Wendling | 2a6b073 | 2011-09-26 21:06:33 +0000 | [diff] [blame^] | 550 | frame. There is an exception handling frame for each function in a compile |
Bill Wendling | c4f661e | 2009-08-15 08:56:09 +0000 | [diff] [blame] | 551 | unit, plus a common exception handling frame that defines information common |
| 552 | to all functions in the unit.</p> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 553 | |
Bill Wendling | 2a6b073 | 2011-09-26 21:06:33 +0000 | [diff] [blame^] | 554 | <!-- Todo - Table details here. --> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 555 | |
| 556 | </div> |
| 557 | |
| 558 | <!-- ======================================================================= --> |
NAKAMURA Takumi | 05d0265 | 2011-04-18 23:59:50 +0000 | [diff] [blame] | 559 | <h3> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 560 | <a name="exception_tables">Exception Tables</a> |
NAKAMURA Takumi | 05d0265 | 2011-04-18 23:59:50 +0000 | [diff] [blame] | 561 | </h3> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 562 | |
NAKAMURA Takumi | f5af6ad | 2011-04-23 00:30:22 +0000 | [diff] [blame] | 563 | <div> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 564 | |
| 565 | <p>An exception table contains information about what actions to take when an |
Bill Wendling | 2a6b073 | 2011-09-26 21:06:33 +0000 | [diff] [blame^] | 566 | exception is thrown in a particular part of a function's code. There is one |
| 567 | exception table per function, except leaf functions and functions that have |
| 568 | calls only to non-throwing functions. They do not need an exception |
| 569 | table.</p> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 570 | |
Bill Wendling | 2a6b073 | 2011-09-26 21:06:33 +0000 | [diff] [blame^] | 571 | <!-- Todo - Table details here. --> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 572 | |
| 573 | </div> |
| 574 | |
NAKAMURA Takumi | f5af6ad | 2011-04-23 00:30:22 +0000 | [diff] [blame] | 575 | </div> |
| 576 | |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 577 | <!-- *********************************************************************** --> |
| 578 | |
| 579 | <hr> |
| 580 | <address> |
| 581 | <a href="http://jigsaw.w3.org/css-validator/check/referer"><img |
Misha Brukman | 4440870 | 2008-12-11 17:34:48 +0000 | [diff] [blame] | 582 | src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 583 | <a href="http://validator.w3.org/check/referer"><img |
Misha Brukman | 4440870 | 2008-12-11 17:34:48 +0000 | [diff] [blame] | 584 | src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 585 | |
| 586 | <a href="mailto:sabre@nondot.org">Chris Lattner</a><br> |
NAKAMURA Takumi | b9a3363 | 2011-04-09 02:13:37 +0000 | [diff] [blame] | 587 | <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br> |
Jim Laskey | d0d39b6 | 2007-03-14 19:29:42 +0000 | [diff] [blame] | 588 | Last modified: $Date$ |
| 589 | </address> |
| 590 | |
| 591 | </body> |
| 592 | </html> |