docs/ExceptionHandling.html

   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>
   6   <link rel="stylesheet" href="llvm.css" type="text/css">
   7 </head>
   8 <body>
   9
  10 <div class="doc_title">Exception Handling in LLVM</div>
  11
  12 <table class="layout" style="width:100%">
  13   <tr class="layout">
  14     <td class="left">
  15 <ul>
  16   <li><a href="#introduction">Introduction</a>
  17   <ol>
  18     <li><a href="#itanium">Itanium ABI Zero-cost Exception Handling</a></li>
  19     <li><a href="#overview">Overview</a></li>
  20   </ol></li>
  21   <li><a href="#codegen">LLVM Code Generation</a>
  22   <ol>
  23     <li><a href="#throw">Throw</a></li>
  24     <li><a href="#try_catch">Try/Catch</a></li>
  25     <li><a href="#cleanups">Cleanups</a></li>
  26     <li><a href="#throw_filters">Throw Filters</a></li>
  27     <li><a href="#restrictions">Restrictions</a></li>
  28   </ol></li>
  29   <li><a href="#format_common_intrinsics">Exception Handling Intrinsics</a>
  30   <ol>
  31         <li><a href="#llvm_eh_exception"><tt>llvm.eh.exception</tt></a></li>
  32         <li><a href="#llvm_eh_selector"><tt>llvm.eh.selector</tt></a></li>
  33         <li><a href="#llvm_eh_typeid_for"><tt>llvm.eh.typeid.for</tt></a></li>
  34   </ol></li>
  35   <li><a href="#asm">Asm Table Formats</a>
  36   <ol>
  37     <li><a href="#unwind_tables">Exception Handling Frame</a></li>
  38     <li><a href="#exception_tables">Exception Tables</a></li>
  39   </ol></li>
  40   <li><a href="#todo">ToDo</a></li>
  41 </ul>
  42 </td>
  43 </tr></table>
  44
  45 <div class="doc_author">
  46   <p>Written by <a href="mailto:jlaskey@mac.com">Jim Laskey</a></p>
  47 </div>
  48
  49
  50 <!-- *********************************************************************** -->
  51 <div class="doc_section"><a name="introduction">Introduction</a></div>
  52 <!-- *********************************************************************** -->
  53
  54 <div class="doc_text">
  55
  56 <p>This document is the central repository for all information pertaining to
  57 exception handling in LLVM.  It describes the format that LLVM exception
  58 handling information takes, which is useful for those interested in creating
  59 front-ends or dealing directly with the information.  Further, this document
  60 provides specific examples of what exception handling information is used for
  61 C/C++.</p>
  62
  63 </div>
  64
  65 <!-- ======================================================================= -->
  66 <div class="doc_subsection">
  67   <a name="itanium">Itanium ABI Zero-cost Exception Handling</a>
  68 </div>
  69
  70 <div class="doc_text">
  71
  72 <p>Exception handling for most programming languages is designed to recover from
  73 conditions that rarely occur during general use of an application.  To that end,
  74 exception handling should not interfere with the main flow of an
  75 application&apos;s algorithm by performing checkpointing tasks such as saving
  76 the current pc or register state.</p>
  77
  78 <p>The Itanium ABI Exception Handling Specification defines a methodology for
  79 providing outlying data in the form of exception tables without inlining
  80 speculative exception handling code in the flow of an application&apos;s main
  81 algorithm.  Thus, the specification is said to add "zero-cost" to the normal
  82 execution of an application.</p>
  83
  84 <p>A more complete description of the Itanium ABI exception handling runtime
  85 support of can be found at <a
  86 href="http://www.codesourcery.com/cxx-abi/abi-eh.html">Itanium C++ ABI:
  87 Exception Handling.</a>  A description of the exception frame format can be
  88 found at <a
  89 href="http://refspecs.freestandards.org/LSB_3.0.0/LSB-Core-generic/LSB-
  90 Core-generic/ehframechpt.html">Exception Frames</a>, with details of the Dwarf
  91 specification at <a href="http://www.eagercon.com/dwarf/dwarf3std.htm">Dwarf 3
  92 Standard.</a> A description for the C++ exception table formats can be found at
  93 <a href="http://www.codesourcery.com/cxx-abi/exceptions.pdf">Exception Handling
  94 Tables.</a></p>
  95
  96 </div>
  97
  98 <!-- ======================================================================= -->
  99 <div class="doc_subsection">
 100   <a name="overview">Overview</a>
 101 </div>
 102
 103 <div class="doc_text">
 104
 105 <p>When an exception is thrown in llvm code, the runtime does a best effort to
 106 find a handler suited to process the circumstance.</p>
 107
 108 <p>The runtime first attempts to find an <i>exception frame</i> corresponding to
 109 the function where the exception was thrown.  If the programming language (ex.
 110 C++) supports exception handling, the exception frame contains a reference to an
 111 exception table describing how to process the exception.  If the language (ex.
 112 C) does not support exception handling or if the exception needs to be forwarded
 113 to a prior activation, the exception frame contains information about how to
 114 unwind the current activation and restore the state of the prior activation.
 115 This process is repeated until the exception is handled.  If the exception is
 116 not handled and no activations remain, then the application is terminated with
 117 an appropriate error message.</p>
 118
 119 <p>Since different programming languages have different behaviors when handling
 120 exceptions, the exception handling ABI provides a mechanism for supplying
 121 <i>personalities.</i> An exception handling personality is defined by way of a
 122 <i>personality function</i> (ex. for C++ <tt>__gxx_personality_v0</tt>) which
 123 receives the context of the exception, an <i>exception structure</i> containing
 124 the exception object type and value, and a reference to the exception table for
 125 the current function.  The personality function for the current compile unit is
 126 specified in a <i>common exception frame</i>.</p>
 127
 128 <p>The organization of an exception table is language dependent.  For C++, an
 129 exception table is organized as a series of code ranges defining what to do if
 130 an exception occurs in that range.  Typically, the information associated with a
 131 range defines which types of exception objects (using C++ <i>type info</i>) that
 132 are handled in that range, and an associated action that should take place.
 133 Actions typically pass control to a <i>landing pad</i>.</p>
 134
 135 <p>A landing pad corresponds to the code found in the catch portion of a
 136 try/catch sequence.  When execution resumes at a landing pad, it receives the
 137 exception structure and a selector corresponding to the <i>type</i> of exception
 138 thrown.  The selector is then used to determine which catch should actually
 139 process the exception.</p>
 140
 141 </div>
 142
 143 <!-- ======================================================================= -->
 144 <div class="doc_section">
 145   <a name="codegen">LLVM Code Generation</a>
 146 </div>
 147
 148 <div class="doc_text">
 149
 150 <p>At the time of this writing, only C++ exception handling support is available
 151 in LLVM.  So the remainder of this document will be somewhat C++-centric.</p>
 152
 153 <p>From the C++ developers perspective, exceptions are defined in terms of the
 154 <tt>throw</tt> and <tt>try/catch</tt> statements.  In this section we will
 155 describe the implementation of llvm exception handling in terms of C++
 156 examples.</p>
 157
 158 </div>
 159
 160 <!-- ======================================================================= -->
 161 <div class="doc_subsection">
 162   <a name="throw">Throw</a>
 163 </div>
 164
 165 <div class="doc_text">
 166
 167 <p>Languages that support exception handling typically provide a <tt>throw</tt>
 168 operation to initiate the exception process.  Internally, a throw operation
 169 breaks down into two steps.  First, a request is made to allocate exception
 170 space for an exception structure.  This structure needs to survive beyond the
 171 current activation.  This structure will contain the type and value of the
 172 object being thrown.  Second, a call is made to the runtime to raise the
 173 exception, passing the exception structure as an argument.</p>
 174
 175 <p>In C++, the allocation of the exception structure is done by the
 176 <tt>__cxa_allocate_exception</tt> runtime function.  The exception raising is
 177 handled by <tt>__cxa_throw</tt>.  The type of the exception is represented using
 178 a C++ RTTI type info structure.</p>
 179
 180 </div>
 181
 182 <!-- ======================================================================= -->
 183 <div class="doc_subsection">
 184   <a name="try_catch">Try/Catch</a>
 185 </div>
 186
 187 <div class="doc_text">
 188
 189 <p>A call within the scope of a try statement can potentially raise an exception.
 190 In those circumstances, the LLVM C++ front-end replaces the call with an
 191 <tt>invoke</tt> instruction.  Unlike a call, the invoke has two potential
 192 continuation points; where to continue when the call succeeds as per normal, and
 193 where to continue if the call raises an exception, either by a throw or the
 194 unwinding of a throw.</p>
 195
 196 <p>The term used to define a the place where an invoke continues after an
 197 exception is called a <i>landing pad</i>.  LLVM landing pads are conceptually
 198 alternative function entry points where a exception structure reference and a type
 199 info index are passed in as arguments.  The landing pad saves the exception
 200 structure reference and then proceeds to select the catch block that corresponds
 201 to the type info of the exception object.</p>
 202
 203 <p>Two llvm intrinsic functions are used convey information about the landing
 204 pad to the back end.</p>
 205
 206 <p><a href="#llvm_eh_exception"><tt>llvm.eh.exception</tt></a> takes no
 207 arguments and returns the exception structure reference.  The backend replaces
 208 this intrinsic with the code that accesses the first argument of a call.  The
 209 LLVM C++ front end generates code to save this value in an alloca location for
 210 further use in the landing pad and catch code.</p>
 211
 212 <p><a href="#llvm_eh_selector"><tt>llvm.eh.selector</tt></a> takes a minimum of
 213 three arguments.  The first argument is the reference to the exception
 214 structure. The second argument is a reference to the personality function to be
 215 used for this try catch sequence. Each of the remaining arguments is either a
 216 reference to the type info for a catch statement,
 217 a <a href="#throw_filters">filter</a> expression,
 218 or the number zero representing a <a href="#cleanups">cleanup</a>.
 219 The exception is tested against the arguments sequentially from first to last.
 220 The result of the <a href="#llvm_eh_selector"><tt>llvm.eh.selector</tt></a> is a
 221 positive number if the exception matched a type info, a negative number if it matched
 222 a filter, and zero if it matched a cleanup.  If nothing is matched, the behaviour of
 223 the program is <a href="#restrictions">undefined</a>.
 224 The LLVM C++ front end generates code to save the selector value in an alloca
 225 location for further use in the landing pad and catch code.
 226 If a type info matched then the selector value is the index of the type info in
 227 the exception table, which can be obtained using the
 228 <a href="#llvm_eh_typeid_for"><tt>llvm.eh.typeid.for</tt></a> intrinsic.</p>
 229
 230 <p>Once the landing pad has the type info selector, the code branches to the
 231 code for the first catch.  The catch then checks the value of the type info
 232 selector against the index of type info for that catch.  Since the type info
 233 index is not known until all the type info have been gathered in the backend,
 234 the catch code will call the <a
 235 href="#llvm_eh_typeid_for"><tt>llvm.eh.typeid.for</tt></a> intrinsic to
 236 determine the index for a given type info.  If the catch fails to match the
 237 selector then control is passed on to the next catch. Note: Since the landing
 238 pad will not be used if there is no match in the list of type info on the call
 239 to <a href="#llvm_eh_selector"><tt>llvm.eh.selector</tt></a>, then neither the
 240 last catch nor <i>catch all</i> need to perform the the check against the
 241 selector.</p>
 242
 243 <p>Finally, the entry and exit of catch code is bracketed with calls to
 244 <tt>__cxa_begin_catch</tt> and <tt>__cxa_end_catch</tt>.
 245 <tt>__cxa_begin_catch</tt> takes a exception structure reference as an argument
 246 and returns the value of the exception object.</tt>  <tt>__cxa_end_catch</tt>
 247 takes a exception structure reference as an argument. This function clears the
 248 exception from the exception space.  Note: a rethrow from within the catch may
 249 replace this call with a <tt>__cxa_rethrow</tt>.</p>
 250
 251 </div>
 252
 253 <!-- ======================================================================= -->
 254 <div class="doc_subsection">
 255   <a name="cleanups">Cleanups</a>
 256 </div>
 257
 258 <div class="doc_text">
 259
 260 <p>To handle destructors and cleanups in try code, control may not run directly
 261 from a landing pad to the first catch.  Control may actually flow from the
 262 landing pad to clean up code and then to the first catch.  Since the required
 263 clean up for each invoke in a try may be different (ex., intervening
 264 constructor), there may be several landing pads for a given try.  If cleanups
 265 need to be run, the number zero should be passed as the last
 266 <a href="#llvm_eh_selector"><tt>llvm.eh.selector</tt></a> argument.
 267 However for C++ a <tt>null i8*</tt> <a href="#restrictions">must</a> be passed
 268 instead.
 269 </p>
 270
 271 </div>
 272
 273 <!-- ======================================================================= -->
 274 <div class="doc_subsection">
 275   <a name="throw_filters">Throw Filters</a>
 276 </div>
 277
 278 <div class="doc_text">
 279
 280 <p>C++ allows the specification of which exception types that can be thrown from
 281 a function.  To represent this a top level landing pad may exist to filter out
 282 invalid types.  To express this in LLVM code the landing pad will call <a
 283 href="#llvm_eh_selector"><tt>llvm.eh.selector</tt></a>.  The arguments are the
 284 length of the filter expression (the number of type infos plus one), followed by
 285 the type infos themselves.
 286 <a href="#llvm_eh_selector"><tt>llvm.eh.selector</tt></a> will return a negative
 287 value if the exception does not match any of the type infos.  If no match is
 288 found then a call to <tt>__cxa_call_unexpected</tt> should be made, otherwise
 289 <tt>_Unwind_Resume</tt>.  Each of these functions require a reference to the
 290 exception structure.</p>
 291
 292 </div>
 293
 294 <!-- ======================================================================= -->
 295 <div class="doc_subsection">
 296   <a name="restrictions">Restrictions</a>
 297 </div>
 298
 299 <div class="doc_text">
 300
 301 <p>The semantics of the invoke instruction require that any exception that
 302 unwinds through an invoke call should result in a branch to the invoke's unwind
 303 label.  However such a branch will only happen if the
 304 <a href="#llvm_eh_selector"><tt>llvm.eh.selector</tt></a> matches.
 305 Thus in order to ensure correct operation, the front-end must only generate
 306 <a href="#llvm_eh_selector"><tt>llvm.eh.selector</tt></a> calls that are
 307 guaranteed to always match whatever exception unwinds through the invoke.
 308 For most languages it is enough to pass zero, indicating the presence of
 309 a <a href="#cleanups">cleanup</a>, as the last
 310 <a href="#llvm_eh_selector"><tt>llvm.eh.selector</tt></a> argument.
 311 However for C++ this is not sufficient, because the C++ personality function
 312 will terminate the program if it detects that unwinding the exception only
 313 results in matches with cleanups.  For C++ a <tt>null i8*</tt> should
 314 be passed as the last
 315 <a href="#llvm_eh_selector"><tt>llvm.eh.selector</tt></a> argument instead.
 316 This is interpreted as a catch-all by the C++ personality function, and will
 317 always match.
 318 </p>
 319
 320 </div>
 321
 322 <!-- ======================================================================= -->
 323 <div class="doc_section">
 324   <a name="format_common_intrinsics">Exception Handling Intrinsics</a>
 325 </div>
 326
 327 <div class="doc_text">
 328
 329 <p>LLVM uses several intrinsic functions (name prefixed with "llvm.eh") to
 330 provide exception handling information at various points in generated code.</p>
 331
 332 </div>
 333
 334 <!-- ======================================================================= -->
 335 <div class="doc_subsubsection">
 336   <a name="llvm_eh_exception">llvm.eh.exception</a>
 337 </div>
 338
 339 <div class="doc_text">
 340 <pre>
 341   i8* %<a href="#llvm_eh_exception">llvm.eh.exception</a>( )
 342 </pre>
 343
 344 <p>This intrinsic indicates that the exception structure is available at this
 345 point in the code.  The backend will replace this intrinsic with code to fetch
 346 the first argument of a call.  The effect is that the intrinsic result is the
 347 exception structure reference.</p>
 348
 349 </div>
 350
 351 <!-- ======================================================================= -->
 352 <div class="doc_subsubsection">
 353   <a name="llvm_eh_selector">llvm.eh.selector</a>
 354 </div>
 355
 356 <div class="doc_text">
 357 <pre>
 358   i32 %<a href="#llvm_eh_selector">llvm.eh.selector.i32</a>(i8*, i8*, i8*, ...)
 359   i64 %<a href="#llvm_eh_selector">llvm.eh.selector.i64</a>(i8*, i8*, i8*, ...)
 360 </pre>
 361
 362 <p>This intrinsic indicates that the exception selector is available at this
 363 point in the code.  The backend will replace this intrinsic with code to fetch
 364 the second argument of a call.  The effect is that the intrinsic result is the
 365 exception selector.</p>
 366
 367 <p><a href="#llvm_eh_selector"><tt>llvm.eh.selector</tt></a> takes a minimum of
 368 three arguments.  The first argument is the reference to the exception
 369 structure. The second argument is a reference to the personality function to be
 370 used for this try catch sequence. Each of the remaining arguments is either a
 371 reference to the type info for a catch statement,
 372 a <a href="#throw_filters">filter</a> expression,
 373 or the number zero representing a <a href="#cleanups">cleanup</a>.
 374 The exception is tested against the arguments sequentially from first to last.
 375 The result of the <a href="#llvm_eh_selector"><tt>llvm.eh.selector</tt></a> is a
 376 positive number if the exception matched a type info, a negative number if it matched
 377 a filter, and zero if it matched a cleanup.  If nothing is matched, the behaviour of
 378 the program is <a href="#restrictions">undefined</a>.
 379 If a type info matched then the selector value is the index of the type info in
 380 the exception table, which can be obtained using the
 381 <a href="#llvm_eh_typeid_for"><tt>llvm.eh.typeid.for</tt></a> intrinsic.</p>
 382
 383 </div>
 384
 385 <!-- ======================================================================= -->
 386 <div class="doc_subsubsection">
 387   <a name="llvm_eh_typeid_for">llvm.eh.typeid.for</a>
 388 </div>
 389
 390 <div class="doc_text">
 391 <pre>
 392   i32 %<a href="#llvm_eh_typeid_for">llvm.eh.typeid.for.i32</a>(i8*)
 393   i64 %<a href="#llvm_eh_typeid_for">llvm.eh.typeid.for.i64</a>(i8*)
 394 </pre>
 395
 396 <p>This intrinsic returns the type info index in the exception table of the
 397 current function.  This value can be used to compare against the result of <a
 398 href="#llvm_eh_selector"><tt>llvm.eh.selector</tt></a>.  The single argument is
 399 a reference to a type info.</p>
 400
 401 </div>
 402
 403 <!-- ======================================================================= -->
 404 <div class="doc_section">
 405   <a name="asm">Asm Table Formats</a>
 406 </div>
 407
 408 <div class="doc_text">
 409
 410 <p>There are two tables that are used by the exception handling runtime to
 411 determine which actions should take place when an exception is thrown.</p>
 412
 413 </div>
 414
 415 <!-- ======================================================================= -->
 416 <div class="doc_subsection">
 417   <a name="unwind_tables">Exception Handling Frame</a>
 418 </div>
 419
 420 <div class="doc_text">
 421
 422 <p>An exception handling frame <tt>eh_frame</tt> is very similar to the unwind
 423 frame used by dwarf debug info.  The frame contains all the information
 424 necessary to tear down the current frame and restore the state of the prior
 425 frame.  There is an exception handling frame for each function in a compile
 426 unit, plus a common exception handling frame that defines information common to
 427 all functions in the unit.</p>
 428
 429 <p>Todo - Table details here.</p>
 430
 431 </div>
 432
 433 <!-- ======================================================================= -->
 434 <div class="doc_subsection">
 435   <a name="exception_tables">Exception Tables</a>
 436 </div>
 437
 438 <div class="doc_text">
 439
 440 <p>An exception table contains information about what actions to take when an
 441 exception is thrown in a particular part of a function&apos;s code.  There is
 442 one exception table per function except leaf routines and functions that have
 443 only calls to non-throwing functions will not need an exception table.</p>
 444
 445 <p>Todo - Table details here.</p>
 446
 447 </div>
 448
 449 <!-- ======================================================================= -->
 450 <div class="doc_section">
 451   <a name="todo">ToDo</a>
 452 </div>
 453
 454 <div class="doc_text">
 455
 456 <ol>
 457
 458 <li><p>Testing/Testing/Testing.</li></p>
 459
 460 </ol>
 461
 462 </div>
 463
 464 <!-- *********************************************************************** -->
 465
 466 <hr>
 467 <address>
 468   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
 469   src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
 470   <a href="http://validator.w3.org/check/referer"><img
 471   src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a>
 472
 473   <a href="mailto:sabre@nondot.org">Chris Lattner</a><br>
 474   <a href="http://llvm.org">LLVM Compiler Infrastructure</a><br>
 475   Last modified: $Date$
 476 </address>
 477
 478 </body>
 479 </html>