[4706098c] | 1 | \chapter{Exception Features}
|
---|
| 2 |
|
---|
| 3 | This chapter covers the design and user interface of the \CFA
|
---|
[4260566] | 4 | exception-handling mechanism (EHM). % or exception system.
|
---|
| 5 |
|
---|
[f6106a6] | 6 | We will begin with an overview of EHMs in general. It is not a strict
|
---|
| 7 | definition of all EHMs nor an exaustive list of all possible features.
|
---|
| 8 | However it does cover the most common structure and features found in them.
|
---|
| 9 |
|
---|
[4260566] | 10 | % We should cover what is an exception handling mechanism and what is an
|
---|
| 11 | % exception before this. Probably in the introduction. Some of this could
|
---|
| 12 | % move there.
|
---|
| 13 | \paragraph{Raise / Handle}
|
---|
| 14 | An exception operation has two main parts: raise and handle.
|
---|
| 15 | These terms are sometimes also known as throw and catch but this work uses
|
---|
| 16 | throw/catch as a particular kind of raise/handle.
|
---|
[f6106a6] | 17 | These are the two parts that the user will write themselves and may
|
---|
| 18 | be the only two pieces of the EHM that have any syntax in the language.
|
---|
[4260566] | 19 |
|
---|
| 20 | \subparagraph{Raise}
|
---|
[f6106a6] | 21 | The raise is the starting point for exception handling. It marks the beginning
|
---|
[df24d37] | 22 | of exception handling by raising an excepion, which passes it to
|
---|
[f6106a6] | 23 | the EHM.
|
---|
[4260566] | 24 |
|
---|
[f6106a6] | 25 | Some well known examples include the @throw@ statements of \Cpp and Java and
|
---|
| 26 | the \codePy{raise} statement from Python. In real systems a raise may preform
|
---|
| 27 | some other work (such as memory management) but for the purposes of this
|
---|
| 28 | overview that can be ignored.
|
---|
[4260566] | 29 |
|
---|
| 30 | \subparagraph{Handle}
|
---|
[f6106a6] | 31 | The purpose of most exception operations is to run some user code to handle
|
---|
| 32 | that exception. This code is given, with some other information, in a handler.
|
---|
| 33 |
|
---|
| 34 | A handler has three common features: the previously mentioned user code, a
|
---|
| 35 | region of code they cover and an exception label/condition that matches
|
---|
| 36 | certain exceptions.
|
---|
| 37 | Only raises inside the covered region and raising exceptions that match the
|
---|
| 38 | label can be handled by a given handler.
|
---|
| 39 | Different EHMs will have different rules to pick a handler
|
---|
[de47a9d] | 40 | if multipe handlers could be used such as ``best match" or ``first found".
|
---|
[4260566] | 41 |
|
---|
[f6106a6] | 42 | The @try@ statements of \Cpp, Java and Python are common examples. All three
|
---|
| 43 | also show another common feature of handlers, they are grouped by the covered
|
---|
| 44 | region.
|
---|
| 45 |
|
---|
[4260566] | 46 | \paragraph{Propagation}
|
---|
[de47a9d] | 47 | After an exception is raised comes what is usually the biggest step for the
|
---|
[f6106a6] | 48 | EHM: finding and setting up the handler. The propogation from raise to
|
---|
| 49 | handler can be broken up into three different tasks: searching for a handler,
|
---|
| 50 | matching against the handler and installing the handler.
|
---|
[de47a9d] | 51 |
|
---|
[f6106a6] | 52 | \subparagraph{Searching}
|
---|
| 53 | The EHM begins by searching for handlers that might be used to handle
|
---|
[de47a9d] | 54 | the exception. Searching is usually independent of the exception that was
|
---|
[f6106a6] | 55 | thrown as it looks for handlers that have the raise site in their covered
|
---|
| 56 | region.
|
---|
| 57 | This includes handlers in the current function, as well as any in callers
|
---|
| 58 | on the stack that have the function call in their covered region.
|
---|
| 59 |
|
---|
| 60 | \subparagraph{Matching}
|
---|
| 61 | Each handler found has to be matched with the raised exception. The exception
|
---|
| 62 | label defines a condition that be use used with exception and decides if
|
---|
| 63 | there is a match or not.
|
---|
| 64 |
|
---|
| 65 | In languages where the first match is used this step is intertwined with
|
---|
| 66 | searching, a match check is preformed immediately after the search finds
|
---|
[4260566] | 67 | a possible handler.
|
---|
| 68 |
|
---|
[f6106a6] | 69 | \subparagraph{Installing}
|
---|
| 70 | After a handler is chosen it must be made ready to run.
|
---|
| 71 | The implementation can vary widely to fit with the rest of the
|
---|
[de47a9d] | 72 | design of the EHM. The installation step might be trivial or it could be
|
---|
[4260566] | 73 | the most expensive step in handling an exception. The latter tends to be the
|
---|
| 74 | case when stack unwinding is involved.
|
---|
[de47a9d] | 75 |
|
---|
[f6106a6] | 76 | If a matching handler is not guarantied to be found the EHM will need a
|
---|
| 77 | different course of action here in the cases where no handler matches.
|
---|
| 78 | This is only required with unchecked exceptions as checked exceptions
|
---|
| 79 | (such as in Java) can make than guaranty.
|
---|
| 80 | This different action can also be installing a handler but it is usually an
|
---|
| 81 | implicat and much more general one.
|
---|
[4260566] | 82 |
|
---|
| 83 | \subparagraph{Hierarchy}
|
---|
[f6106a6] | 84 | A common way to organize exceptions is in a hierarchical structure.
|
---|
| 85 | This is especially true in object-orientated languages where the
|
---|
[4260566] | 86 | exception hierarchy is a natural extension of the object hierarchy.
|
---|
| 87 |
|
---|
| 88 | Consider the following hierarchy of exceptions:
|
---|
[4706098c] | 89 | \begin{center}
|
---|
[6a8208cb] | 90 | \input{exception-hierarchy}
|
---|
[4706098c] | 91 | \end{center}
|
---|
[de47a9d] | 92 |
|
---|
[4260566] | 93 | A handler labelled with any given exception can handle exceptions of that
|
---|
| 94 | type or any child type of that exception. The root of the exception hierarchy
|
---|
[f6106a6] | 95 | (here \codeC{exception}) acts as a catch-all, leaf types catch single types
|
---|
[4260566] | 96 | and the exceptions in the middle can be used to catch different groups of
|
---|
| 97 | related exceptions.
|
---|
| 98 |
|
---|
| 99 | This system has some notable advantages, such as multiple levels of grouping,
|
---|
[de47a9d] | 100 | the ability for libraries to add new exception types and the isolation
|
---|
[f6106a6] | 101 | between different sub-hierarchies.
|
---|
| 102 | This design is used in \CFA even though it is not a object-orientated
|
---|
[a6c45c6] | 103 | language; so different tools are used to create the hierarchy.
|
---|
[4260566] | 104 |
|
---|
| 105 | % Could I cite the rational for the Python IO exception rework?
|
---|
| 106 |
|
---|
| 107 | \paragraph{Completion}
|
---|
[de47a9d] | 108 | After the handler has finished the entire exception operation has to complete
|
---|
[f6106a6] | 109 | and continue executing somewhere else. This step is usually simple,
|
---|
| 110 | both logically and in its implementation, as the installation of the handler
|
---|
| 111 | is usually set up to do most of the work.
|
---|
[de47a9d] | 112 |
|
---|
[f6106a6] | 113 | The EHM can return control to many different places,
|
---|
| 114 | the most common are after the handler definition and after the raise.
|
---|
[4260566] | 115 |
|
---|
| 116 | \paragraph{Communication}
|
---|
[f6106a6] | 117 | For effective exception handling, additional information is usually passed
|
---|
| 118 | from the raise to the handler.
|
---|
| 119 | So far only communication of the exceptions' identity has been covered.
|
---|
| 120 | A common method is putting fields into the exception instance and giving the
|
---|
| 121 | handler access to them.
|
---|
[4260566] | 122 |
|
---|
| 123 | \section{Virtuals}
|
---|
[f6106a6] | 124 | Virtual types and casts are not part of \CFA's EHM nor are they required for
|
---|
[a6c45c6] | 125 | any EHM.
|
---|
| 126 | However the \CFA uses a hierarchy built with the virtual system as the basis
|
---|
| 127 | for exceptions and exception matching.
|
---|
| 128 |
|
---|
| 129 | The virtual system would have ideally been part of \CFA before the work
|
---|
| 130 | on exception handling began, but unfortunately it was not.
|
---|
| 131 | Because of this only the features and framework needed for the EHM were
|
---|
| 132 | designed and implemented. Other features were considered to ensure that
|
---|
| 133 | the structure could accomidate other desirable features but they were not
|
---|
| 134 | implemented.
|
---|
| 135 | The rest of this section will only discuss the finalized portion of the
|
---|
| 136 | virtual system.
|
---|
[4260566] | 137 |
|
---|
| 138 | The virtual system supports multiple ``trees" of types. Each tree is
|
---|
| 139 | a simple hierarchy with a single root type. Each type in a tree has exactly
|
---|
[f6106a6] | 140 | one parent -- except for the root type which has zero parents -- and any
|
---|
[4260566] | 141 | number of children.
|
---|
| 142 | Any type that belongs to any of these trees is called a virtual type.
|
---|
| 143 |
|
---|
| 144 | % A type's ancestors are its parent and its parent's ancestors.
|
---|
| 145 | % The root type has no ancestors.
|
---|
[de47a9d] | 146 | % A type's decendents are its children and its children's decendents.
|
---|
[4260566] | 147 |
|
---|
[de47a9d] | 148 | Every virtual type also has a list of virtual members. Children inherit
|
---|
| 149 | their parent's list of virtual members but may add new members to it.
|
---|
[f6106a6] | 150 | It is important to note that these are virtual members, not virtual methods
|
---|
| 151 | of object-orientated programming, and can be of any type.
|
---|
| 152 | However, since \CFA has function pointers and they are allowed, virtual
|
---|
| 153 | members can be used to mimic virtual methods.
|
---|
[4260566] | 154 |
|
---|
[f6106a6] | 155 | Each virtual type has a unique id.
|
---|
| 156 | This unique id and all the virtual members are combined
|
---|
[de47a9d] | 157 | into a virtual table type. Each virtual type has a pointer to a virtual table
|
---|
[4260566] | 158 | as a hidden field.
|
---|
| 159 |
|
---|
[f6106a6] | 160 | Up until this point the virtual system is similar to ones found in
|
---|
| 161 | object-orientated languages but this where \CFA diverges. Objects encapsulate a
|
---|
[08e75215] | 162 | single set of behaviours in each type, universally across the entire program,
|
---|
[de47a9d] | 163 | and indeed all programs that use that type definition. In this sense the
|
---|
[08e75215] | 164 | types are ``closed" and cannot be altered.
|
---|
[de47a9d] | 165 |
|
---|
[f6106a6] | 166 | In \CFA types do not encapsulate any behaviour. Traits are local and
|
---|
[de47a9d] | 167 | types can begin to statify a trait, stop satifying a trait or satify the same
|
---|
[f6106a6] | 168 | trait in a different way at any lexical location in the program.
|
---|
| 169 | In this sense they are ``open" as they can change at any time. This means it
|
---|
| 170 | is implossible to pick a single set of functions that repersent the type's
|
---|
| 171 | implementation across the program.
|
---|
| 172 |
|
---|
| 173 | \CFA side-steps this issue by not having a single virtual table for each
|
---|
| 174 | type. A user can define virtual tables which are filled in at their
|
---|
| 175 | declaration and given a name. Anywhere that name is visible, even if it was
|
---|
| 176 | defined locally inside a function (although that means it will not have a
|
---|
| 177 | static lifetime), it can be used.
|
---|
| 178 | Specifically, a virtual type is ``bound" to a virtual table which
|
---|
[08e75215] | 179 | sets the virtual members for that object. The virtual members can be accessed
|
---|
| 180 | through the object.
|
---|
[4706098c] | 181 |
|
---|
| 182 | While much of the virtual infrastructure is created, it is currently only used
|
---|
| 183 | internally for exception handling. The only user-level feature is the virtual
|
---|
[a6c45c6] | 184 | cast, which is the same as the \Cpp \codeCpp{dynamic_cast}.
|
---|
[7eb6eb5] | 185 | \label{p:VirtualCast}
|
---|
[4706098c] | 186 | \begin{cfa}
|
---|
[4a36b344] | 187 | (virtual TYPE)EXPRESSION
|
---|
[4706098c] | 188 | \end{cfa}
|
---|
[29c9b23] | 189 | Note, the syntax and semantics matches a C-cast, rather than the function-like
|
---|
| 190 | \Cpp syntax for special casts. Both the type of @EXPRESSION@ and @TYPE@ must be
|
---|
| 191 | a pointer to a virtual type.
|
---|
[de47a9d] | 192 | The cast dynamically checks if the @EXPRESSION@ type is the same or a sub-type
|
---|
[29c9b23] | 193 | of @TYPE@, and if true, returns a pointer to the
|
---|
[4706098c] | 194 | @EXPRESSION@ object, otherwise it returns @0p@ (null pointer).
|
---|
| 195 |
|
---|
| 196 | \section{Exception}
|
---|
[4a36b344] | 197 | % Leaving until later, hopefully it can talk about actual syntax instead
|
---|
| 198 | % of my many strange macros. Syntax aside I will also have to talk about the
|
---|
| 199 | % features all exceptions support.
|
---|
| 200 |
|
---|
[4706098c] | 201 | Exceptions are defined by the trait system; there are a series of traits, and
|
---|
[1c1c180] | 202 | if a type satisfies them, then it can be used as an exception. The following
|
---|
[4706098c] | 203 | is the base trait all exceptions need to match.
|
---|
| 204 | \begin{cfa}
|
---|
| 205 | trait is_exception(exceptT &, virtualT &) {
|
---|
[a6c45c6] | 206 | // Numerous imaginary assertions.
|
---|
[02b73ea] | 207 | };
|
---|
[4706098c] | 208 | \end{cfa}
|
---|
[29c9b23] | 209 | The trait is defined over two types, the exception type and the virtual table
|
---|
[a6c45c6] | 210 | type. Each exception type should have but a single virtual table type.
|
---|
| 211 | Now there are no actual assertions in this trait because the trait system
|
---|
| 212 | actually can't express them (adding such assertions would be part of
|
---|
| 213 | completing the virtual system). The imaginary assertions would probably come
|
---|
| 214 | from a trait defined by the virtual system, and state that the exception type
|
---|
| 215 | is a virtual type, is a decendent of @exception_t@ (the base exception type)
|
---|
| 216 | and note its virtual table type.
|
---|
[29c9b23] | 217 |
|
---|
| 218 | % I did have a note about how it is the programmer's responsibility to make
|
---|
| 219 | % sure the function is implemented correctly. But this is true of every
|
---|
[de47a9d] | 220 | % similar system I know of (except Agda's I guess) so I took it out.
|
---|
| 221 |
|
---|
[f6106a6] | 222 | There are two more traits for exceptions defined as follows:
|
---|
[4706098c] | 223 | \begin{cfa}
|
---|
[02b73ea] | 224 | trait is_termination_exception(
|
---|
[4706098c] | 225 | exceptT &, virtualT & | is_exception(exceptT, virtualT)) {
|
---|
[29c9b23] | 226 | void defaultTerminationHandler(exceptT &);
|
---|
[02b73ea] | 227 | };
|
---|
| 228 |
|
---|
| 229 | trait is_resumption_exception(
|
---|
[4706098c] | 230 | exceptT &, virtualT & | is_exception(exceptT, virtualT)) {
|
---|
[29c9b23] | 231 | void defaultResumptionHandler(exceptT &);
|
---|
[02b73ea] | 232 | };
|
---|
[4706098c] | 233 | \end{cfa}
|
---|
[f6106a6] | 234 | Both traits ensure a pair of types are an exception type and its virtual table
|
---|
| 235 | and defines one of the two default handlers. The default handlers are used
|
---|
[df24d37] | 236 | as fallbacks and are discussed in detail in \vref{s:ExceptionHandling}.
|
---|
[de47a9d] | 237 |
|
---|
[f6106a6] | 238 | However, all three of these traits can be tricky to use directly.
|
---|
| 239 | While there is a bit of repetition required,
|
---|
[de47a9d] | 240 | the largest issue is that the virtual table type is mangled and not in a user
|
---|
[f6106a6] | 241 | facing way. So these three macros are provided to wrap these traits to
|
---|
| 242 | simplify referring to the names:
|
---|
[29c9b23] | 243 | @IS_EXCEPTION@, @IS_TERMINATION_EXCEPTION@ and @IS_RESUMPTION_EXCEPTION@.
|
---|
[1830a86] | 244 |
|
---|
[f6106a6] | 245 | All three take one or two arguments. The first argument is the name of the
|
---|
| 246 | exception type. The macro passes its unmangled and mangled form to the trait.
|
---|
[1830a86] | 247 | The second (optional) argument is a parenthesized list of polymorphic
|
---|
[f6106a6] | 248 | arguments. This argument is only used with polymorphic exceptions and the
|
---|
| 249 | list is be passed to both types.
|
---|
| 250 | In the current set-up, the two types always have the same polymorphic
|
---|
| 251 | arguments so these macros can be used without losing flexibility.
|
---|
[29c9b23] | 252 |
|
---|
| 253 | For example consider a function that is polymorphic over types that have a
|
---|
| 254 | defined arithmetic exception:
|
---|
| 255 | \begin{cfa}
|
---|
[de47a9d] | 256 | forall(Num | IS_EXCEPTION(Arithmetic, (Num)))
|
---|
[29c9b23] | 257 | void some_math_function(Num & left, Num & right);
|
---|
| 258 | \end{cfa}
|
---|
[4706098c] | 259 |
|
---|
[1830a86] | 260 | \section{Exception Handling}
|
---|
[f6106a6] | 261 | \label{s:ExceptionHandling}
|
---|
| 262 | \CFA provides two kinds of exception handling: termination and resumption.
|
---|
| 263 | These twin operations are the core of \CFA's exception handling mechanism.
|
---|
[de47a9d] | 264 | This section will cover the general patterns shared by the two operations and
|
---|
| 265 | then go on to cover the details each individual operation.
|
---|
| 266 |
|
---|
[f6106a6] | 267 | Both operations follow the same set of steps.
|
---|
| 268 | Both start with the user preforming a raise on an exception.
|
---|
| 269 | Then the exception propogates up the stack.
|
---|
| 270 | If a handler is found the exception is caught and the handler is run.
|
---|
| 271 | After that control returns to normal execution.
|
---|
[de47a9d] | 272 | If the search fails a default handler is run and then control
|
---|
[f6106a6] | 273 | returns to normal execution after the raise.
|
---|
| 274 |
|
---|
| 275 | This general description covers what the two kinds have in common.
|
---|
| 276 | Differences include how propogation is preformed, where exception continues
|
---|
| 277 | after an exception is caught and handled and which default handler is run.
|
---|
[1830a86] | 278 |
|
---|
[4706098c] | 279 | \subsection{Termination}
|
---|
| 280 | \label{s:Termination}
|
---|
[f6106a6] | 281 | Termination handling is the familiar kind and used in most programming
|
---|
[1830a86] | 282 | languages with exception handling.
|
---|
[f6106a6] | 283 | It is dynamic, non-local goto. If the raised exception is matched and
|
---|
| 284 | handled the stack is unwound and control will (usually) continue the function
|
---|
| 285 | on the call stack that defined the handler.
|
---|
| 286 | Termination is commonly used when an error has occurred and recovery is
|
---|
| 287 | impossible locally.
|
---|
[1830a86] | 288 |
|
---|
| 289 | % (usually) Control can continue in the current function but then a different
|
---|
| 290 | % control flow construct should be used.
|
---|
[4706098c] | 291 |
|
---|
[f6106a6] | 292 | A termination raise is started with the @throw@ statement:
|
---|
[4706098c] | 293 | \begin{cfa}
|
---|
[4a36b344] | 294 | throw EXPRESSION;
|
---|
[4706098c] | 295 | \end{cfa}
|
---|
[29c9b23] | 296 | The expression must return a reference to a termination exception, where the
|
---|
[f6106a6] | 297 | termination exception is any type that satisfies the trait
|
---|
| 298 | @is_termination_exception@ at the call site.
|
---|
| 299 | Through \CFA's trait system the trait functions are implicity passed into the
|
---|
| 300 | throw code and the EHM.
|
---|
| 301 | A new @defaultTerminationHandler@ can be defined in any scope to
|
---|
[de47a9d] | 302 | change the throw's behavior (see below).
|
---|
| 303 |
|
---|
[f6106a6] | 304 | The throw will copy the provided exception into managed memory to ensure
|
---|
| 305 | the exception is not destroyed if the stack is unwound.
|
---|
| 306 | It is the user's responsibility to ensure the original exception is cleaned
|
---|
| 307 | up wheither the stack is unwound or not. Allocating it on the stack is
|
---|
| 308 | usually sufficient.
|
---|
[de47a9d] | 309 |
|
---|
[f6106a6] | 310 | Then propogation starts with the search. \CFA uses a ``first match" rule so
|
---|
| 311 | matching is preformed with the copied exception as the search continues.
|
---|
| 312 | It starts from the throwing function and proceeds to the base of the stack,
|
---|
[1830a86] | 313 | from callee to caller.
|
---|
[de47a9d] | 314 | At each stack frame, a check is made for resumption handlers defined by the
|
---|
[1830a86] | 315 | @catch@ clauses of a @try@ statement.
|
---|
[4706098c] | 316 | \begin{cfa}
|
---|
[4a36b344] | 317 | try {
|
---|
[4706098c] | 318 | GUARDED_BLOCK
|
---|
[f6106a6] | 319 | } catch (EXCEPTION_TYPE$\(_1\)$ * [NAME$\(_1\)$]) {
|
---|
[4706098c] | 320 | HANDLER_BLOCK$\(_1\)$
|
---|
[f6106a6] | 321 | } catch (EXCEPTION_TYPE$\(_2\)$ * [NAME$\(_2\)$]) {
|
---|
[4706098c] | 322 | HANDLER_BLOCK$\(_2\)$
|
---|
[4a36b344] | 323 | }
|
---|
[4706098c] | 324 | \end{cfa}
|
---|
[f6106a6] | 325 | When viewed on its own, a try statement will simply execute the statements
|
---|
| 326 | in @GUARDED_BLOCK@ and when those are finished the try statement finishes.
|
---|
[de47a9d] | 327 |
|
---|
| 328 | However, while the guarded statements are being executed, including any
|
---|
[f6106a6] | 329 | invoked functions, all the handlers in the statement are now on the search
|
---|
| 330 | path. If a termination exception is thrown and not handled further up the
|
---|
| 331 | stack they will be matched against the exception.
|
---|
| 332 |
|
---|
| 333 | Exception matching checks the handler in each catch clause in the order
|
---|
| 334 | they appear, top to bottom. If the representation of the thrown exception type
|
---|
| 335 | is the same or a descendant of @EXCEPTION_TYPE@$_i$ then @NAME@$_i$
|
---|
| 336 | (if provided) is
|
---|
[29c9b23] | 337 | bound to a pointer to the exception and the statements in @HANDLER_BLOCK@$_i$
|
---|
| 338 | are executed. If control reaches the end of the handler, the exception is
|
---|
[de47a9d] | 339 | freed and control continues after the try statement.
|
---|
[4706098c] | 340 |
|
---|
[f6106a6] | 341 | If no termination handler is found during the search then the default handler
|
---|
| 342 | (@defaultTerminationHandler@) is run.
|
---|
[de47a9d] | 343 | Through \CFA's trait system the best match at the throw sight will be used.
|
---|
| 344 | This function is run and is passed the copied exception. After the default
|
---|
| 345 | handler is run control continues after the throw statement.
|
---|
[1830a86] | 346 |
|
---|
[f6106a6] | 347 | There is a global @defaultTerminationHandler@ that is polymorphic over all
|
---|
| 348 | exception types. Since it is so general a more specific handler can be
|
---|
| 349 | defined and will be used for those types, effectively overriding the handler
|
---|
| 350 | for particular exception type.
|
---|
| 351 | The global default termination handler performs a cancellation
|
---|
[df24d37] | 352 | (see \vref{s:Cancellation}) on the current stack with the copied exception.
|
---|
[4706098c] | 353 |
|
---|
| 354 | \subsection{Resumption}
|
---|
| 355 | \label{s:Resumption}
|
---|
| 356 |
|
---|
[f6106a6] | 357 | Resumption exception handling is less common than termination but is
|
---|
| 358 | just as old~\cite{Goodenough75} and is simpler in many ways.
|
---|
| 359 | It is a dynamic, non-local function call. If the raised exception is
|
---|
| 360 | matched a closure will be taken from up the stack and executed,
|
---|
| 361 | after which the raising function will continue executing.
|
---|
[de47a9d] | 362 | These are most often used when an error occurred and if the error is repaired
|
---|
| 363 | then the function can continue.
|
---|
[8483c39a] | 364 |
|
---|
[4706098c] | 365 | A resumption raise is started with the @throwResume@ statement:
|
---|
| 366 | \begin{cfa}
|
---|
[4a36b344] | 367 | throwResume EXPRESSION;
|
---|
[4706098c] | 368 | \end{cfa}
|
---|
[f6106a6] | 369 | It works much the same way as the termination throw.
|
---|
| 370 | The expression must return a reference to a resumption exception,
|
---|
| 371 | where the resumption exception is any type that satisfies the trait
|
---|
| 372 | @is_resumption_exception@ at the call site.
|
---|
| 373 | The assertions from this trait are available to
|
---|
[1830a86] | 374 | the exception system while handling the exception.
|
---|
[29c9b23] | 375 |
|
---|
[f6106a6] | 376 | At run-time, no exception copy is made.
|
---|
| 377 | As the stack is not unwound the exception and
|
---|
[de47a9d] | 378 | any values on the stack will remain in scope while the resumption is handled.
|
---|
[4706098c] | 379 |
|
---|
[f6106a6] | 380 | The EHM then begins propogation. The search starts from the raise in the
|
---|
| 381 | resuming function and proceeds to the base of the stack, from callee to caller.
|
---|
[1830a86] | 382 | At each stack frame, a check is made for resumption handlers defined by the
|
---|
| 383 | @catchResume@ clauses of a @try@ statement.
|
---|
[4706098c] | 384 | \begin{cfa}
|
---|
[4a36b344] | 385 | try {
|
---|
[4706098c] | 386 | GUARDED_BLOCK
|
---|
[f6106a6] | 387 | } catchResume (EXCEPTION_TYPE$\(_1\)$ * [NAME$\(_1\)$]) {
|
---|
[4706098c] | 388 | HANDLER_BLOCK$\(_1\)$
|
---|
[f6106a6] | 389 | } catchResume (EXCEPTION_TYPE$\(_2\)$ * [NAME$\(_2\)$]) {
|
---|
[4706098c] | 390 | HANDLER_BLOCK$\(_2\)$
|
---|
[4a36b344] | 391 | }
|
---|
[4706098c] | 392 | \end{cfa}
|
---|
[f6106a6] | 393 | % I wonder if there would be some good central place for this.
|
---|
| 394 | Note that termination handlers and resumption handlers may be used together
|
---|
| 395 | in a single try statement, intermixing @catch@ and @catchResume@ freely.
|
---|
| 396 | Each type of handler will only interact with exceptions from the matching
|
---|
| 397 | type of raise.
|
---|
| 398 | When a try statement is executed it simply executes the statements in the
|
---|
| 399 | @GUARDED_BLOCK@ and then finishes.
|
---|
| 400 |
|
---|
| 401 | However, while the guarded statements are being executed, including any
|
---|
| 402 | invoked functions, all the handlers in the statement are now on the search
|
---|
| 403 | path. If a resumption exception is reported and not handled further up the
|
---|
| 404 | stack they will be matched against the exception.
|
---|
| 405 |
|
---|
| 406 | Exception matching checks the handler in each catch clause in the order
|
---|
| 407 | they appear, top to bottom. If the representation of the thrown exception type
|
---|
| 408 | is the same or a descendant of @EXCEPTION_TYPE@$_i$ then @NAME@$_i$
|
---|
| 409 | (if provided) is bound to a pointer to the exception and the statements in
|
---|
| 410 | @HANDLER_BLOCK@$_i$ are executed.
|
---|
| 411 | If control reaches the end of the handler, execution continues after the
|
---|
| 412 | the raise statement that raised the handled exception.
|
---|
[de47a9d] | 413 |
|
---|
| 414 | Like termination, if no resumption handler is found, the default handler
|
---|
| 415 | visible at the throw statement is called. It will use the best match at the
|
---|
| 416 | call sight according to \CFA's overloading rules. The default handler is
|
---|
| 417 | passed the exception given to the throw. When the default handler finishes
|
---|
[f6106a6] | 418 | execution continues after the raise statement.
|
---|
[de47a9d] | 419 |
|
---|
| 420 | There is a global @defaultResumptionHandler@ is polymorphic over all
|
---|
| 421 | termination exceptions and preforms a termination throw on the exception.
|
---|
[f6106a6] | 422 | The @defaultTerminationHandler@ for that raise is matched at the original
|
---|
| 423 | raise statement (the resumption @throwResume@) and it can be customized by
|
---|
[1830a86] | 424 | introducing a new or better match as well.
|
---|
| 425 |
|
---|
[f6106a6] | 426 | \subsubsection{Resumption Marking}
|
---|
[df24d37] | 427 | \label{s:ResumptionMarking}
|
---|
[1830a86] | 428 | A key difference between resumption and termination is that resumption does
|
---|
[de47a9d] | 429 | not unwind the stack. A side effect that is that when a handler is matched
|
---|
| 430 | and run it's try block (the guarded statements) and every try statement
|
---|
[1830a86] | 431 | searched before it are still on the stack. This can lead to the recursive
|
---|
| 432 | resumption problem.
|
---|
| 433 |
|
---|
| 434 | The recursive resumption problem is any situation where a resumption handler
|
---|
| 435 | ends up being called while it is running.
|
---|
| 436 | Consider a trivial case:
|
---|
| 437 | \begin{cfa}
|
---|
| 438 | try {
|
---|
| 439 | throwResume (E &){};
|
---|
| 440 | } catchResume(E *) {
|
---|
| 441 | throwResume (E &){};
|
---|
| 442 | }
|
---|
| 443 | \end{cfa}
|
---|
[de47a9d] | 444 | When this code is executed the guarded @throwResume@ will throw, start a
|
---|
| 445 | search and match the handler in the @catchResume@ clause. This will be
|
---|
| 446 | call and placed on the stack on top of the try-block. The second throw then
|
---|
| 447 | throws and will search the same try block and put call another instance of the
|
---|
[1830a86] | 448 | same handler leading to an infinite loop.
|
---|
| 449 |
|
---|
[de47a9d] | 450 | This situation is trivial and easy to avoid, but much more complex cycles
|
---|
[1830a86] | 451 | can form with multiple handlers and different exception types.
|
---|
| 452 |
|
---|
[f6106a6] | 453 | To prevent all of these cases we mark try statements on the stack.
|
---|
| 454 | A try statement is marked when a match check is preformed with it and an
|
---|
| 455 | exception. The statement will be unmarked when the handling of that exception
|
---|
| 456 | is completed or the search completes without finding a handler.
|
---|
| 457 | While a try statement is marked its handlers are never matched, effectify
|
---|
| 458 | skipping over it to the next try statement.
|
---|
[4a36b344] | 459 |
|
---|
[6a8208cb] | 460 | \begin{center}
|
---|
| 461 | \input{stack-marking}
|
---|
| 462 | \end{center}
|
---|
[de47a9d] | 463 |
|
---|
[f6106a6] | 464 | These rules mirror what happens with termination.
|
---|
| 465 | When a termination throw happens in a handler the search will not look at
|
---|
| 466 | any handlers from the original throw to the original catch because that
|
---|
| 467 | part of the stack has been unwound.
|
---|
| 468 | A resumption raise in the same situation wants to search the entire stack,
|
---|
| 469 | but it will not try to match the exception with try statements in the section
|
---|
| 470 | that would have been unwound as they are marked.
|
---|
[4706098c] | 471 |
|
---|
[f6106a6] | 472 | The symmetry between resumption termination is why this pattern was picked.
|
---|
| 473 | Other patterns, such as marking just the handlers that caught, also work but
|
---|
[a6c45c6] | 474 | lack the symmetry means there are more rules to remember.
|
---|
[4706098c] | 475 |
|
---|
| 476 | \section{Conditional Catch}
|
---|
[de47a9d] | 477 | Both termination and resumption handler clauses can be given an additional
|
---|
| 478 | condition to further control which exceptions they handle:
|
---|
[4706098c] | 479 | \begin{cfa}
|
---|
[f6106a6] | 480 | catch (EXCEPTION_TYPE * [NAME] ; CONDITION)
|
---|
[4706098c] | 481 | \end{cfa}
|
---|
| 482 | First, the same semantics is used to match the exception type. Second, if the
|
---|
| 483 | exception matches, @CONDITION@ is executed. The condition expression may
|
---|
[de47a9d] | 484 | reference all names in scope at the beginning of the try block and @NAME@
|
---|
[1c1c180] | 485 | introduced in the handler clause. If the condition is true, then the handler
|
---|
[1830a86] | 486 | matches. Otherwise, the exception search continues as if the exception type
|
---|
| 487 | did not match.
|
---|
[f6106a6] | 488 |
|
---|
| 489 | The condition matching allows finer matching by allowing the match to check
|
---|
| 490 | more kinds of information than just the exception type.
|
---|
[4706098c] | 491 | \begin{cfa}
|
---|
| 492 | try {
|
---|
[f6106a6] | 493 | handle1 = open( f1, ... );
|
---|
| 494 | handle2 = open( f2, ... );
|
---|
| 495 | handle3 = open( f3, ... );
|
---|
[4706098c] | 496 | ...
|
---|
[de47a9d] | 497 | } catch( IOFailure * f ; fd( f ) == f1 ) {
|
---|
[f6106a6] | 498 | // Only handle IO failure for f1.
|
---|
| 499 | } catch( IOFailure * f ; fd( f ) == f3 ) {
|
---|
| 500 | // Only handle IO failure for f3.
|
---|
[4706098c] | 501 | }
|
---|
[f6106a6] | 502 | // Can't handle a failure relating to f2 here.
|
---|
[4706098c] | 503 | \end{cfa}
|
---|
[f6106a6] | 504 | In this example the file that experianced the IO error is used to decide
|
---|
| 505 | which handler should be run, if any at all.
|
---|
| 506 |
|
---|
| 507 | \begin{comment}
|
---|
| 508 | % I know I actually haven't got rid of them yet, but I'm going to try
|
---|
| 509 | % to write it as if I had and see if that makes sense:
|
---|
| 510 | \section{Reraising}
|
---|
| 511 | \label{s:Reraising}
|
---|
[4706098c] | 512 | Within the handler block or functions called from the handler block, it is
|
---|
| 513 | possible to reraise the most recently caught exception with @throw@ or
|
---|
[1830a86] | 514 | @throwResume@, respectively.
|
---|
[4706098c] | 515 | \begin{cfa}
|
---|
[29c9b23] | 516 | try {
|
---|
| 517 | ...
|
---|
| 518 | } catch( ... ) {
|
---|
[1830a86] | 519 | ... throw;
|
---|
[4706098c] | 520 | } catchResume( ... ) {
|
---|
[1830a86] | 521 | ... throwResume;
|
---|
[4706098c] | 522 | }
|
---|
| 523 | \end{cfa}
|
---|
| 524 | The only difference between a raise and a reraise is that reraise does not
|
---|
| 525 | create a new exception; instead it continues using the current exception, \ie
|
---|
| 526 | no allocation and copy. However the default handler is still set to the one
|
---|
| 527 | visible at the raise point, and hence, for termination could refer to data that
|
---|
| 528 | is part of an unwound stack frame. To prevent this problem, a new default
|
---|
| 529 | handler is generated that does a program-level abort.
|
---|
[f6106a6] | 530 | \end{comment}
|
---|
| 531 |
|
---|
| 532 | \subsection{Comparison with Reraising}
|
---|
| 533 | A more popular way to allow handlers to match in more detail is to reraise
|
---|
| 534 | the exception after it has been caught if it could not be handled here.
|
---|
| 535 | On the surface these two features seem interchangable.
|
---|
| 536 |
|
---|
| 537 | If we used @throw;@ to start a termination reraise then these two statements
|
---|
| 538 | would have the same behaviour:
|
---|
| 539 | \begin{cfa}
|
---|
| 540 | try {
|
---|
| 541 | do_work_may_throw();
|
---|
| 542 | } catch(exception_t * exc ; can_handle(exc)) {
|
---|
| 543 | handle(exc);
|
---|
| 544 | }
|
---|
| 545 | \end{cfa}
|
---|
| 546 |
|
---|
| 547 | \begin{cfa}
|
---|
| 548 | try {
|
---|
| 549 | do_work_may_throw();
|
---|
| 550 | } catch(exception_t * exc) {
|
---|
| 551 | if (can_handle(exc)) {
|
---|
| 552 | handle(exc);
|
---|
| 553 | } else {
|
---|
| 554 | throw;
|
---|
| 555 | }
|
---|
| 556 | }
|
---|
| 557 | \end{cfa}
|
---|
| 558 | If there are further handlers after this handler only the first version will
|
---|
[a6c45c6] | 559 | check them. If multiple handlers on a single try block that could handle the
|
---|
| 560 | same exception the translations get more complex but they are equivilantly
|
---|
[f6106a6] | 561 | powerful.
|
---|
| 562 |
|
---|
| 563 | Until stack unwinding comes into the picture. In termination handling, a
|
---|
| 564 | conditional catch happens before the stack is unwound, but a reraise happens
|
---|
| 565 | afterwards. Normally this might only cause you to loose some debug
|
---|
| 566 | information you could get from a stack trace (and that can be side stepped
|
---|
| 567 | entirely by collecting information during the unwind). But for \CFA there is
|
---|
| 568 | another issue, if the exception isn't handled the default handler should be
|
---|
| 569 | run at the site of the original raise.
|
---|
| 570 |
|
---|
| 571 | There are two problems with this: the site of the original raise doesn't
|
---|
| 572 | exist anymore and the default handler might not exist anymore. The site will
|
---|
| 573 | always be removed as part of the unwinding, often with the entirety of the
|
---|
| 574 | function it was in. The default handler could be a stack allocated nested
|
---|
| 575 | function removed during the unwind.
|
---|
| 576 |
|
---|
| 577 | This means actually trying to pretend the catch didn't happening, continuing
|
---|
| 578 | the original raise instead of starting a new one, is infeasible.
|
---|
| 579 | That is the expected behaviour for most languages and we can't replicate
|
---|
| 580 | that behaviour.
|
---|
[4a36b344] | 581 |
|
---|
| 582 | \section{Finally Clauses}
|
---|
[f6106a6] | 583 | \label{s:FinallyClauses}
|
---|
[de47a9d] | 584 | Finally clauses are used to preform unconditional clean-up when leaving a
|
---|
[f6106a6] | 585 | scope and are placed at the end of a try statement after any handler clauses:
|
---|
[4706098c] | 586 | \begin{cfa}
|
---|
[4a36b344] | 587 | try {
|
---|
[4706098c] | 588 | GUARDED_BLOCK
|
---|
[29c9b23] | 589 | } ... // any number or kind of handler clauses
|
---|
| 590 | ... finally {
|
---|
[4706098c] | 591 | FINALLY_BLOCK
|
---|
[4a36b344] | 592 | }
|
---|
[4706098c] | 593 | \end{cfa}
|
---|
[29c9b23] | 594 | The @FINALLY_BLOCK@ is executed when the try statement is removed from the
|
---|
[1830a86] | 595 | stack, including when the @GUARDED_BLOCK@ finishes, any termination handler
|
---|
[de47a9d] | 596 | finishes or during an unwind.
|
---|
[29c9b23] | 597 | The only time the block is not executed is if the program is exited before
|
---|
[1830a86] | 598 | the stack is unwound.
|
---|
[4706098c] | 599 |
|
---|
| 600 | Execution of the finally block should always finish, meaning control runs off
|
---|
[f6106a6] | 601 | the end of the block. This requirement ensures control always continues as if
|
---|
| 602 | the finally clause is not present, \ie finally is for cleanup not changing
|
---|
| 603 | control flow.
|
---|
| 604 | Because of this requirement, local control flow out of the finally block
|
---|
[1c1c180] | 605 | is forbidden. The compiler precludes any @break@, @continue@, @fallthru@ or
|
---|
[4706098c] | 606 | @return@ that causes control to leave the finally block. Other ways to leave
|
---|
| 607 | the finally block, such as a long jump or termination are much harder to check,
|
---|
[f6106a6] | 608 | and at best requiring additional run-time overhead, and so are only
|
---|
[1830a86] | 609 | discouraged.
|
---|
| 610 |
|
---|
[f6106a6] | 611 | Not all languages with unwinding have finally clauses. Notably \Cpp does
|
---|
[de47a9d] | 612 | without it as descructors serve a similar role. Although destructors and
|
---|
| 613 | finally clauses can be used in many of the same areas they have their own
|
---|
[1830a86] | 614 | use cases like top-level functions and lambda functions with closures.
|
---|
| 615 | Destructors take a bit more work to set up but are much easier to reuse while
|
---|
[f6106a6] | 616 | finally clauses are good for one-off uses and
|
---|
| 617 | can easily include local information.
|
---|
[4a36b344] | 618 |
|
---|
| 619 | \section{Cancellation}
|
---|
[f6106a6] | 620 | \label{s:Cancellation}
|
---|
[de47a9d] | 621 | Cancellation is a stack-level abort, which can be thought of as as an
|
---|
[f6106a6] | 622 | uncatchable termination. It unwinds the entire current stack, and if
|
---|
[de47a9d] | 623 | possible forwards the cancellation exception to a different stack.
|
---|
[4706098c] | 624 |
|
---|
[29c9b23] | 625 | Cancellation is not an exception operation like termination or resumption.
|
---|
[4706098c] | 626 | There is no special statement for starting a cancellation; instead the standard
|
---|
[1c1c180] | 627 | library function @cancel_stack@ is called passing an exception. Unlike a
|
---|
[f6106a6] | 628 | raise, this exception is not used in matching only to pass information about
|
---|
[4706098c] | 629 | the cause of the cancellation.
|
---|
[f6106a6] | 630 | (This also means matching cannot fail so there is no default handler.)
|
---|
[4706098c] | 631 |
|
---|
[f6106a6] | 632 | After @cancel_stack@ is called the exception is copied into the EHM's memory
|
---|
| 633 | and the current stack is
|
---|
[1830a86] | 634 | unwound. After that it depends one which stack is being cancelled.
|
---|
[a6c45c6] | 635 |
|
---|
| 636 | \paragraph{Main Stack}
|
---|
[4706098c] | 637 | The main stack is the one used by the program main at the start of execution,
|
---|
[f6106a6] | 638 | and is the only stack in a sequential program.
|
---|
| 639 | After the main stack is unwound there is a program-level abort.
|
---|
| 640 |
|
---|
| 641 | There are two reasons for this. The first is that it obviously had to do this
|
---|
| 642 | in a sequential program as there is nothing else to notify and the simplicity
|
---|
| 643 | of keeping the same behaviour in sequential and concurrent programs is good.
|
---|
| 644 | Also, even in concurrent programs there is no stack that an innate connection
|
---|
| 645 | to, so it would have be explicitly managed.
|
---|
[4706098c] | 646 |
|
---|
[a6c45c6] | 647 | \paragraph{Thread Stack}
|
---|
[f6106a6] | 648 | A thread stack is created for a \CFA @thread@ object or object that satisfies
|
---|
| 649 | the @is_thread@ trait.
|
---|
| 650 | After a thread stack is unwound there exception is stored until another
|
---|
| 651 | thread attempts to join with it. Then the exception @ThreadCancelled@,
|
---|
| 652 | which stores a reference to the thread and to the exception passed to the
|
---|
| 653 | cancellation, is reported from the join.
|
---|
| 654 | There is one difference between an explicit join (with the @join@ function)
|
---|
| 655 | and an implicit join (from a destructor call). The explicit join takes the
|
---|
| 656 | default handler (@defaultResumptionHandler@) from its calling context while
|
---|
| 657 | the implicit join provides its own which does a program abort if the
|
---|
| 658 | @ThreadCancelled@ exception cannot be handled.
|
---|
| 659 |
|
---|
| 660 | Communication is done at join because a thread only has to have to points of
|
---|
| 661 | communication with other threads: start and join.
|
---|
| 662 | Since a thread must be running to perform a cancellation (and cannot be
|
---|
| 663 | cancelled from another stack), the cancellation must be after start and
|
---|
| 664 | before the join. So join is the one that we will use.
|
---|
| 665 |
|
---|
| 666 | % TODO: Find somewhere to discuss unwind collisions.
|
---|
| 667 | The difference between the explicit and implicit join is for safety and
|
---|
| 668 | debugging. It helps prevent unwinding collisions by avoiding throwing from
|
---|
| 669 | a destructor and prevents cascading the error across multiple threads if
|
---|
| 670 | the user is not equipped to deal with it.
|
---|
| 671 | Also you can always add an explicit join if that is the desired behaviour.
|
---|
| 672 |
|
---|
[a6c45c6] | 673 | \paragraph{Coroutine Stack}
|
---|
[f6106a6] | 674 | A coroutine stack is created for a @coroutine@ object or object that
|
---|
| 675 | satisfies the @is_coroutine@ trait.
|
---|
| 676 | After a coroutine stack is unwound control returns to the resume function
|
---|
| 677 | that most recently resumed it. The resume statement reports a
|
---|
| 678 | @CoroutineCancelled@ exception, which contains a references to the cancelled
|
---|
| 679 | coroutine and the exception used to cancel it.
|
---|
| 680 | The resume function also takes the @defaultResumptionHandler@ from the
|
---|
| 681 | caller's context and passes it to the internal report.
|
---|
| 682 |
|
---|
| 683 | A coroutine knows of two other coroutines, its starter and its last resumer.
|
---|
| 684 | The starter has a much more distant connection while the last resumer just
|
---|
| 685 | (in terms of coroutine state) called resume on this coroutine, so the message
|
---|
| 686 | is passed to the latter.
|
---|