Call fatal_insn_not_found instead of abort
[official-gcc.git] / gcc / except.c
blob3ed0c915eb629b70d877bbab9f47ab1346400adb
1 /* Implements exception handling.
2 Copyright (C) 1989, 92-97, 1998 Free Software Foundation, Inc.
3 Contributed by Mike Stump <mrs@cygnus.com>.
5 This file is part of GNU CC.
7 GNU CC is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
10 any later version.
12 GNU CC is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU CC; see the file COPYING. If not, write to
19 the Free Software Foundation, 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
23 /* An exception is an event that can be signaled from within a
24 function. This event can then be "caught" or "trapped" by the
25 callers of this function. This potentially allows program flow to
26 be transferred to any arbitrary code associated with a function call
27 several levels up the stack.
29 The intended use for this mechanism is for signaling "exceptional
30 events" in an out-of-band fashion, hence its name. The C++ language
31 (and many other OO-styled or functional languages) practically
32 requires such a mechanism, as otherwise it becomes very difficult
33 or even impossible to signal failure conditions in complex
34 situations. The traditional C++ example is when an error occurs in
35 the process of constructing an object; without such a mechanism, it
36 is impossible to signal that the error occurs without adding global
37 state variables and error checks around every object construction.
39 The act of causing this event to occur is referred to as "throwing
40 an exception". (Alternate terms include "raising an exception" or
41 "signaling an exception".) The term "throw" is used because control
42 is returned to the callers of the function that is signaling the
43 exception, and thus there is the concept of "throwing" the
44 exception up the call stack.
46 There are two major codegen options for exception handling. The
47 flag -fsjlj-exceptions can be used to select the setjmp/longjmp
48 approach, which is the default. -fno-sjlj-exceptions can be used to
49 get the PC range table approach. While this is a compile time
50 flag, an entire application must be compiled with the same codegen
51 option. The first is a PC range table approach, the second is a
52 setjmp/longjmp based scheme. We will first discuss the PC range
53 table approach, after that, we will discuss the setjmp/longjmp
54 based approach.
56 It is appropriate to speak of the "context of a throw". This
57 context refers to the address where the exception is thrown from,
58 and is used to determine which exception region will handle the
59 exception.
61 Regions of code within a function can be marked such that if it
62 contains the context of a throw, control will be passed to a
63 designated "exception handler". These areas are known as "exception
64 regions". Exception regions cannot overlap, but they can be nested
65 to any arbitrary depth. Also, exception regions cannot cross
66 function boundaries.
68 Exception handlers can either be specified by the user (which we
69 will call a "user-defined handler") or generated by the compiler
70 (which we will designate as a "cleanup"). Cleanups are used to
71 perform tasks such as destruction of objects allocated on the
72 stack.
74 In the current implementation, cleanups are handled by allocating an
75 exception region for the area that the cleanup is designated for,
76 and the handler for the region performs the cleanup and then
77 rethrows the exception to the outer exception region. From the
78 standpoint of the current implementation, there is little
79 distinction made between a cleanup and a user-defined handler, and
80 the phrase "exception handler" can be used to refer to either one
81 equally well. (The section "Future Directions" below discusses how
82 this will change).
84 Each object file that is compiled with exception handling contains
85 a static array of exception handlers named __EXCEPTION_TABLE__.
86 Each entry contains the starting and ending addresses of the
87 exception region, and the address of the handler designated for
88 that region.
90 If the target does not use the DWARF 2 frame unwind information, at
91 program startup each object file invokes a function named
92 __register_exceptions with the address of its local
93 __EXCEPTION_TABLE__. __register_exceptions is defined in libgcc2.c, and
94 is responsible for recording all of the exception regions into one list
95 (which is kept in a static variable named exception_table_list).
97 On targets that support crtstuff.c, the unwind information
98 is stored in a section named .eh_frame and the information for the
99 entire shared object or program is registered with a call to
100 __register_frame_info. On other targets, the information for each
101 translation unit is registered from the file generated by collect2.
102 __register_frame_info is defined in frame.c, and is responsible for
103 recording all of the unwind regions into one list (which is kept in a
104 static variable named unwind_table_list).
106 The function __throw is actually responsible for doing the
107 throw. On machines that have unwind info support, __throw is generated
108 by code in libgcc2.c, otherwise __throw is generated on a
109 per-object-file basis for each source file compiled with
110 -fexceptions by the C++ frontend. Before __throw is invoked,
111 the current context of the throw needs to be placed in the global
112 variable __eh_pc.
114 __throw attempts to find the appropriate exception handler for the
115 PC value stored in __eh_pc by calling __find_first_exception_table_match
116 (which is defined in libgcc2.c). If __find_first_exception_table_match
117 finds a relevant handler, __throw transfers control directly to it.
119 If a handler for the context being thrown from can't be found, __throw
120 walks (see Walking the stack below) the stack up the dynamic call chain to
121 continue searching for an appropriate exception handler based upon the
122 caller of the function it last sought a exception handler for. It stops
123 then either an exception handler is found, or when the top of the
124 call chain is reached.
126 If no handler is found, an external library function named
127 __terminate is called. If a handler is found, then we restart
128 our search for a handler at the end of the call chain, and repeat
129 the search process, but instead of just walking up the call chain,
130 we unwind the call chain as we walk up it.
132 Internal implementation details:
134 To associate a user-defined handler with a block of statements, the
135 function expand_start_try_stmts is used to mark the start of the
136 block of statements with which the handler is to be associated
137 (which is known as a "try block"). All statements that appear
138 afterwards will be associated with the try block.
140 A call to expand_start_all_catch marks the end of the try block,
141 and also marks the start of the "catch block" (the user-defined
142 handler) associated with the try block.
144 This user-defined handler will be invoked for *every* exception
145 thrown with the context of the try block. It is up to the handler
146 to decide whether or not it wishes to handle any given exception,
147 as there is currently no mechanism in this implementation for doing
148 this. (There are plans for conditionally processing an exception
149 based on its "type", which will provide a language-independent
150 mechanism).
152 If the handler chooses not to process the exception (perhaps by
153 looking at an "exception type" or some other additional data
154 supplied with the exception), it can fall through to the end of the
155 handler. expand_end_all_catch and expand_leftover_cleanups
156 add additional code to the end of each handler to take care of
157 rethrowing to the outer exception handler.
159 The handler also has the option to continue with "normal flow of
160 code", or in other words to resume executing at the statement
161 immediately after the end of the exception region. The variable
162 caught_return_label_stack contains a stack of labels, and jumping
163 to the topmost entry's label via expand_goto will resume normal
164 flow to the statement immediately after the end of the exception
165 region. If the handler falls through to the end, the exception will
166 be rethrown to the outer exception region.
168 The instructions for the catch block are kept as a separate
169 sequence, and will be emitted at the end of the function along with
170 the handlers specified via expand_eh_region_end. The end of the
171 catch block is marked with expand_end_all_catch.
173 Any data associated with the exception must currently be handled by
174 some external mechanism maintained in the frontend. For example,
175 the C++ exception mechanism passes an arbitrary value along with
176 the exception, and this is handled in the C++ frontend by using a
177 global variable to hold the value. (This will be changing in the
178 future.)
180 The mechanism in C++ for handling data associated with the
181 exception is clearly not thread-safe. For a thread-based
182 environment, another mechanism must be used (possibly using a
183 per-thread allocation mechanism if the size of the area that needs
184 to be allocated isn't known at compile time.)
186 Internally-generated exception regions (cleanups) are marked by
187 calling expand_eh_region_start to mark the start of the region,
188 and expand_eh_region_end (handler) is used to both designate the
189 end of the region and to associate a specified handler/cleanup with
190 the region. The rtl code in HANDLER will be invoked whenever an
191 exception occurs in the region between the calls to
192 expand_eh_region_start and expand_eh_region_end. After HANDLER is
193 executed, additional code is emitted to handle rethrowing the
194 exception to the outer exception handler. The code for HANDLER will
195 be emitted at the end of the function.
197 TARGET_EXPRs can also be used to designate exception regions. A
198 TARGET_EXPR gives an unwind-protect style interface commonly used
199 in functional languages such as LISP. The associated expression is
200 evaluated, and whether or not it (or any of the functions that it
201 calls) throws an exception, the protect expression is always
202 invoked. This implementation takes care of the details of
203 associating an exception table entry with the expression and
204 generating the necessary code (it actually emits the protect
205 expression twice, once for normal flow and once for the exception
206 case). As for the other handlers, the code for the exception case
207 will be emitted at the end of the function.
209 Cleanups can also be specified by using add_partial_entry (handler)
210 and end_protect_partials. add_partial_entry creates the start of
211 a new exception region; HANDLER will be invoked if an exception is
212 thrown with the context of the region between the calls to
213 add_partial_entry and end_protect_partials. end_protect_partials is
214 used to mark the end of these regions. add_partial_entry can be
215 called as many times as needed before calling end_protect_partials.
216 However, end_protect_partials should only be invoked once for each
217 group of calls to add_partial_entry as the entries are queued
218 and all of the outstanding entries are processed simultaneously
219 when end_protect_partials is invoked. Similarly to the other
220 handlers, the code for HANDLER will be emitted at the end of the
221 function.
223 The generated RTL for an exception region includes
224 NOTE_INSN_EH_REGION_BEG and NOTE_INSN_EH_REGION_END notes that mark
225 the start and end of the exception region. A unique label is also
226 generated at the start of the exception region, which is available
227 by looking at the ehstack variable. The topmost entry corresponds
228 to the current region.
230 In the current implementation, an exception can only be thrown from
231 a function call (since the mechanism used to actually throw an
232 exception involves calling __throw). If an exception region is
233 created but no function calls occur within that region, the region
234 can be safely optimized away (along with its exception handlers)
235 since no exceptions can ever be caught in that region. This
236 optimization is performed unless -fasynchronous-exceptions is
237 given. If the user wishes to throw from a signal handler, or other
238 asynchronous place, -fasynchronous-exceptions should be used when
239 compiling for maximally correct code, at the cost of additional
240 exception regions. Using -fasynchronous-exceptions only produces
241 code that is reasonably safe in such situations, but a correct
242 program cannot rely upon this working. It can be used in failsafe
243 code, where trying to continue on, and proceeding with potentially
244 incorrect results is better than halting the program.
247 Walking the stack:
249 The stack is walked by starting with a pointer to the current
250 frame, and finding the pointer to the callers frame. The unwind info
251 tells __throw how to find it.
253 Unwinding the stack:
255 When we use the term unwinding the stack, we mean undoing the
256 effects of the function prologue in a controlled fashion so that we
257 still have the flow of control. Otherwise, we could just return
258 (jump to the normal end of function epilogue).
260 This is done in __throw in libgcc2.c when we know that a handler exists
261 in a frame higher up the call stack than its immediate caller.
263 To unwind, we find the unwind data associated with the frame, if any.
264 If we don't find any, we call the library routine __terminate. If we do
265 find it, we use the information to copy the saved register values from
266 that frame into the register save area in the frame for __throw, return
267 into a stub which updates the stack pointer, and jump to the handler.
268 The normal function epilogue for __throw handles restoring the saved
269 values into registers.
271 When unwinding, we use this method if we know it will
272 work (if DWARF2_UNWIND_INFO is defined). Otherwise, we know that
273 an inline unwinder will have been emitted for any function that
274 __unwind_function cannot unwind. The inline unwinder appears as a
275 normal exception handler for the entire function, for any function
276 that we know cannot be unwound by __unwind_function. We inform the
277 compiler of whether a function can be unwound with
278 __unwind_function by having DOESNT_NEED_UNWINDER evaluate to true
279 when the unwinder isn't needed. __unwind_function is used as an
280 action of last resort. If no other method can be used for
281 unwinding, __unwind_function is used. If it cannot unwind, it
282 should call __terminate.
284 By default, if the target-specific backend doesn't supply a definition
285 for __unwind_function and doesn't support DWARF2_UNWIND_INFO, inlined
286 unwinders will be used instead. The main tradeoff here is in text space
287 utilization. Obviously, if inline unwinders have to be generated
288 repeatedly, this uses much more space than if a single routine is used.
290 However, it is simply not possible on some platforms to write a
291 generalized routine for doing stack unwinding without having some
292 form of additional data associated with each function. The current
293 implementation can encode this data in the form of additional
294 machine instructions or as static data in tabular form. The later
295 is called the unwind data.
297 The backend macro DOESNT_NEED_UNWINDER is used to conditionalize whether
298 or not per-function unwinders are needed. If DOESNT_NEED_UNWINDER is
299 defined and has a non-zero value, a per-function unwinder is not emitted
300 for the current function. If the static unwind data is supported, then
301 a per-function unwinder is not emitted.
303 On some platforms it is possible that neither __unwind_function
304 nor inlined unwinders are available. For these platforms it is not
305 possible to throw through a function call, and abort will be
306 invoked instead of performing the throw.
308 The reason the unwind data may be needed is that on some platforms
309 the order and types of data stored on the stack can vary depending
310 on the type of function, its arguments and returned values, and the
311 compilation options used (optimization versus non-optimization,
312 -fomit-frame-pointer, processor variations, etc).
314 Unfortunately, this also means that throwing through functions that
315 aren't compiled with exception handling support will still not be
316 possible on some platforms. This problem is currently being
317 investigated, but no solutions have been found that do not imply
318 some unacceptable performance penalties.
320 Future directions:
322 Currently __throw makes no differentiation between cleanups and
323 user-defined exception regions. While this makes the implementation
324 simple, it also implies that it is impossible to determine if a
325 user-defined exception handler exists for a given exception without
326 completely unwinding the stack in the process. This is undesirable
327 from the standpoint of debugging, as ideally it would be possible
328 to trap unhandled exceptions in the debugger before the process of
329 unwinding has even started.
331 This problem can be solved by marking user-defined handlers in a
332 special way (probably by adding additional bits to exception_table_list).
333 A two-pass scheme could then be used by __throw to iterate
334 through the table. The first pass would search for a relevant
335 user-defined handler for the current context of the throw, and if
336 one is found, the second pass would then invoke all needed cleanups
337 before jumping to the user-defined handler.
339 Many languages (including C++ and Ada) make execution of a
340 user-defined handler conditional on the "type" of the exception
341 thrown. (The type of the exception is actually the type of the data
342 that is thrown with the exception.) It will thus be necessary for
343 __throw to be able to determine if a given user-defined
344 exception handler will actually be executed, given the type of
345 exception.
347 One scheme is to add additional information to exception_table_list
348 as to the types of exceptions accepted by each handler. __throw
349 can do the type comparisons and then determine if the handler is
350 actually going to be executed.
352 There is currently no significant level of debugging support
353 available, other than to place a breakpoint on __throw. While
354 this is sufficient in most cases, it would be helpful to be able to
355 know where a given exception was going to be thrown to before it is
356 actually thrown, and to be able to choose between stopping before
357 every exception region (including cleanups), or just user-defined
358 exception regions. This should be possible to do in the two-pass
359 scheme by adding additional labels to __throw for appropriate
360 breakpoints, and additional debugger commands could be added to
361 query various state variables to determine what actions are to be
362 performed next.
364 Another major problem that is being worked on is the issue with stack
365 unwinding on various platforms. Currently the only platforms that have
366 support for the generation of a generic unwinder are the SPARC and MIPS.
367 All other ports require per-function unwinders, which produce large
368 amounts of code bloat.
370 For setjmp/longjmp based exception handling, some of the details
371 are as above, but there are some additional details. This section
372 discusses the details.
374 We don't use NOTE_INSN_EH_REGION_{BEG,END} pairs. We don't
375 optimize EH regions yet. We don't have to worry about machine
376 specific issues with unwinding the stack, as we rely upon longjmp
377 for all the machine specific details. There is no variable context
378 of a throw, just the one implied by the dynamic handler stack
379 pointed to by the dynamic handler chain. There is no exception
380 table, and no calls to __register_exceptions. __sjthrow is used
381 instead of __throw, and it works by using the dynamic handler
382 chain, and longjmp. -fasynchronous-exceptions has no effect, as
383 the elimination of trivial exception regions is not yet performed.
385 A frontend can set protect_cleanup_actions_with_terminate when all
386 the cleanup actions should be protected with an EH region that
387 calls terminate when an unhandled exception is throw. C++ does
388 this, Ada does not. */
391 #include "config.h"
392 #include "defaults.h"
393 #include "eh-common.h"
394 #include "system.h"
395 #include "rtl.h"
396 #include "tree.h"
397 #include "flags.h"
398 #include "except.h"
399 #include "function.h"
400 #include "insn-flags.h"
401 #include "expr.h"
402 #include "insn-codes.h"
403 #include "regs.h"
404 #include "hard-reg-set.h"
405 #include "insn-config.h"
406 #include "recog.h"
407 #include "output.h"
408 #include "toplev.h"
410 /* One to use setjmp/longjmp method of generating code for exception
411 handling. */
413 int exceptions_via_longjmp = 2;
415 /* One to enable asynchronous exception support. */
417 int asynchronous_exceptions = 0;
419 /* One to protect cleanup actions with a handler that calls
420 __terminate, zero otherwise. */
422 int protect_cleanup_actions_with_terminate;
424 /* A list of labels used for exception handlers. Created by
425 find_exception_handler_labels for the optimization passes. */
427 rtx exception_handler_labels;
429 /* The EH context. Nonzero if the function has already
430 fetched a pointer to the EH context for exception handling. */
432 rtx current_function_ehc;
434 /* A stack used for keeping track of the currently active exception
435 handling region. As each exception region is started, an entry
436 describing the region is pushed onto this stack. The current
437 region can be found by looking at the top of the stack, and as we
438 exit regions, the corresponding entries are popped.
440 Entries cannot overlap; they can be nested. So there is only one
441 entry at most that corresponds to the current instruction, and that
442 is the entry on the top of the stack. */
444 static struct eh_stack ehstack;
447 /* This stack is used to represent what the current eh region is
448 for the catch blocks beings processed */
450 static struct eh_stack catchstack;
452 /* A queue used for tracking which exception regions have closed but
453 whose handlers have not yet been expanded. Regions are emitted in
454 groups in an attempt to improve paging performance.
456 As we exit a region, we enqueue a new entry. The entries are then
457 dequeued during expand_leftover_cleanups and expand_start_all_catch,
459 We should redo things so that we either take RTL for the handler,
460 or we expand the handler expressed as a tree immediately at region
461 end time. */
463 static struct eh_queue ehqueue;
465 /* Insns for all of the exception handlers for the current function.
466 They are currently emitted by the frontend code. */
468 rtx catch_clauses;
470 /* A TREE_CHAINed list of handlers for regions that are not yet
471 closed. The TREE_VALUE of each entry contains the handler for the
472 corresponding entry on the ehstack. */
474 static tree protect_list;
476 /* Stacks to keep track of various labels. */
478 /* Keeps track of the label to resume to should one want to resume
479 normal control flow out of a handler (instead of, say, returning to
480 the caller of the current function or exiting the program). */
482 struct label_node *caught_return_label_stack = NULL;
484 /* Keeps track of the label used as the context of a throw to rethrow an
485 exception to the outer exception region. */
487 struct label_node *outer_context_label_stack = NULL;
489 /* A random data area for the front end's own use. */
491 struct label_node *false_label_stack = NULL;
493 static void push_eh_entry PROTO((struct eh_stack *));
494 static struct eh_entry * pop_eh_entry PROTO((struct eh_stack *));
495 static void enqueue_eh_entry PROTO((struct eh_queue *, struct eh_entry *));
496 static struct eh_entry * dequeue_eh_entry PROTO((struct eh_queue *));
497 static rtx call_get_eh_context PROTO((void));
498 static void start_dynamic_cleanup PROTO((tree, tree));
499 static void start_dynamic_handler PROTO((void));
500 static void expand_rethrow PROTO((rtx));
501 static void output_exception_table_entry PROTO((FILE *, int));
502 static int can_throw PROTO((rtx));
503 static rtx scan_region PROTO((rtx, int, int *));
504 static void eh_regs PROTO((rtx *, rtx *, int));
505 static void set_insn_eh_region PROTO((rtx *, int));
506 #ifdef DONT_USE_BUILTIN_SETJMP
507 static void jumpif_rtx PROTO((rtx, rtx));
508 #endif
511 rtx expand_builtin_return_addr PROTO((enum built_in_function, int, rtx));
513 /* Various support routines to manipulate the various data structures
514 used by the exception handling code. */
516 /* Push a label entry onto the given STACK. */
518 void
519 push_label_entry (stack, rlabel, tlabel)
520 struct label_node **stack;
521 rtx rlabel;
522 tree tlabel;
524 struct label_node *newnode
525 = (struct label_node *) xmalloc (sizeof (struct label_node));
527 if (rlabel)
528 newnode->u.rlabel = rlabel;
529 else
530 newnode->u.tlabel = tlabel;
531 newnode->chain = *stack;
532 *stack = newnode;
535 /* Pop a label entry from the given STACK. */
538 pop_label_entry (stack)
539 struct label_node **stack;
541 rtx label;
542 struct label_node *tempnode;
544 if (! *stack)
545 return NULL_RTX;
547 tempnode = *stack;
548 label = tempnode->u.rlabel;
549 *stack = (*stack)->chain;
550 free (tempnode);
552 return label;
555 /* Return the top element of the given STACK. */
557 tree
558 top_label_entry (stack)
559 struct label_node **stack;
561 if (! *stack)
562 return NULL_TREE;
564 return (*stack)->u.tlabel;
567 /* get an exception label. These must be on the permanent obstack */
570 gen_exception_label ()
572 rtx lab;
574 push_obstacks_nochange ();
575 end_temporary_allocation ();
576 lab = gen_label_rtx ();
577 pop_obstacks ();
578 return lab;
581 /* Push a new eh_node entry onto STACK. */
583 static void
584 push_eh_entry (stack)
585 struct eh_stack *stack;
587 struct eh_node *node = (struct eh_node *) xmalloc (sizeof (struct eh_node));
588 struct eh_entry *entry = (struct eh_entry *) xmalloc (sizeof (struct eh_entry));
590 entry->outer_context = gen_label_rtx ();
591 entry->finalization = NULL_TREE;
592 entry->label_used = 0;
593 entry->exception_handler_label = gen_exception_label ();
595 node->entry = entry;
596 node->chain = stack->top;
597 stack->top = node;
600 /* push an existing entry onto a stack. */
601 static void
602 push_entry (stack, entry)
603 struct eh_stack *stack;
604 struct eh_entry *entry;
606 struct eh_node *node = (struct eh_node *) xmalloc (sizeof (struct eh_node));
607 node->entry = entry;
608 node->chain = stack->top;
609 stack->top = node;
612 /* Pop an entry from the given STACK. */
614 static struct eh_entry *
615 pop_eh_entry (stack)
616 struct eh_stack *stack;
618 struct eh_node *tempnode;
619 struct eh_entry *tempentry;
621 tempnode = stack->top;
622 tempentry = tempnode->entry;
623 stack->top = stack->top->chain;
624 free (tempnode);
626 return tempentry;
629 /* Enqueue an ENTRY onto the given QUEUE. */
631 static void
632 enqueue_eh_entry (queue, entry)
633 struct eh_queue *queue;
634 struct eh_entry *entry;
636 struct eh_node *node = (struct eh_node *) xmalloc (sizeof (struct eh_node));
638 node->entry = entry;
639 node->chain = NULL;
641 if (queue->head == NULL)
643 queue->head = node;
645 else
647 queue->tail->chain = node;
649 queue->tail = node;
652 /* Dequeue an entry from the given QUEUE. */
654 static struct eh_entry *
655 dequeue_eh_entry (queue)
656 struct eh_queue *queue;
658 struct eh_node *tempnode;
659 struct eh_entry *tempentry;
661 if (queue->head == NULL)
662 return NULL;
664 tempnode = queue->head;
665 queue->head = queue->head->chain;
667 tempentry = tempnode->entry;
668 free (tempnode);
670 return tempentry;
673 static void
674 receive_exception_label (handler_label)
675 rtx handler_label;
677 emit_label (handler_label);
679 #ifdef HAVE_exception_receiver
680 if (! exceptions_via_longjmp)
681 if (HAVE_exception_receiver)
682 emit_insn (gen_exception_receiver ());
683 #endif
685 #ifdef HAVE_nonlocal_goto_receiver
686 if (! exceptions_via_longjmp)
687 if (HAVE_nonlocal_goto_receiver)
688 emit_insn (gen_nonlocal_goto_receiver ());
689 #endif
693 struct func_eh_entry
695 int range_number; /* EH region number from EH NOTE insn's */
696 struct handler_info *handlers;
700 /* table of function eh regions */
701 static struct func_eh_entry *function_eh_regions = NULL;
702 static int num_func_eh_entries = 0;
703 static int current_func_eh_entry = 0;
705 #define SIZE_FUNC_EH(X) (sizeof (struct func_eh_entry) * X)
707 /* Add a new eh_entry for this function, and base it off of the information
708 in the EH_ENTRY parameter. A NULL parameter is invalid. The number
709 returned is an number which uniquely identifies this exception range. */
711 int
712 new_eh_region_entry (note_eh_region)
713 int note_eh_region;
715 if (current_func_eh_entry == num_func_eh_entries)
717 if (num_func_eh_entries == 0)
719 function_eh_regions =
720 (struct func_eh_entry *) malloc (SIZE_FUNC_EH (50));
721 num_func_eh_entries = 50;
723 else
725 num_func_eh_entries = num_func_eh_entries * 3 / 2;
726 function_eh_regions = (struct func_eh_entry *)
727 realloc (function_eh_regions, SIZE_FUNC_EH (num_func_eh_entries));
730 function_eh_regions[current_func_eh_entry].range_number = note_eh_region;
731 function_eh_regions[current_func_eh_entry].handlers = NULL;
733 return current_func_eh_entry++;
736 /* Add new handler information to an exception range. The first parameter
737 specifies the range number (returned from new_eh_entry()). The second
738 parameter specifies the handler. By default the handler is inserted at
739 the end of the list. A handler list may contain only ONE NULL_TREE
740 typeinfo entry. Regardless where it is positioned, a NULL_TREE entry
741 is always output as the LAST handler in the exception table for a region. */
743 void
744 add_new_handler (region, newhandler)
745 int region;
746 struct handler_info *newhandler;
748 struct handler_info *last;
750 newhandler->next = NULL;
751 last = function_eh_regions[region].handlers;
752 if (last == NULL)
753 function_eh_regions[region].handlers = newhandler;
754 else
756 for ( ; last->next != NULL; last = last->next)
758 last->next = newhandler;
762 /* Remove a handler label. The handler label is being deleted, so all
763 regions which reference this handler should have it removed from their
764 list of possible handlers. Any region which has the final handler
765 removed can be deleted. */
767 void remove_handler (removing_label)
768 rtx removing_label;
770 struct handler_info *handler, *last;
771 int x;
772 for (x = 0 ; x < current_func_eh_entry; ++x)
774 last = NULL;
775 handler = function_eh_regions[x].handlers;
776 for ( ; handler; last = handler, handler = handler->next)
777 if (handler->handler_label == removing_label)
779 if (last)
781 last->next = handler->next;
782 handler = last;
784 else
785 function_eh_regions[x].handlers = handler->next;
790 /* This function will return a malloc'd pointer to an array of
791 void pointer representing the runtime match values that
792 currently exist in all regions. */
794 int
795 find_all_handler_type_matches (array)
796 void ***array;
798 struct handler_info *handler, *last;
799 int x,y;
800 void *val;
801 void **ptr;
802 int max_ptr;
803 int n_ptr = 0;
805 *array = NULL;
807 if (!doing_eh (0) || ! flag_new_exceptions)
808 return 0;
810 max_ptr = 100;
811 ptr = (void **)malloc (max_ptr * sizeof (void *));
813 if (ptr == NULL)
814 return 0;
816 for (x = 0 ; x < current_func_eh_entry; x++)
818 last = NULL;
819 handler = function_eh_regions[x].handlers;
820 for ( ; handler; last = handler, handler = handler->next)
822 val = handler->type_info;
823 if (val != NULL && val != CATCH_ALL_TYPE)
825 /* See if this match value has already been found. */
826 for (y = 0; y < n_ptr; y++)
827 if (ptr[y] == val)
828 break;
830 /* If we break early, we already found this value. */
831 if (y < n_ptr)
832 continue;
834 /* Do we need to allocate more space? */
835 if (n_ptr >= max_ptr)
837 max_ptr += max_ptr / 2;
838 ptr = (void **)realloc (ptr, max_ptr * sizeof (void *));
839 if (ptr == NULL)
840 return 0;
842 ptr[n_ptr] = val;
843 n_ptr++;
847 *array = ptr;
848 return n_ptr;
851 /* Create a new handler structure initialized with the handler label and
852 typeinfo fields passed in. */
854 struct handler_info *
855 get_new_handler (handler, typeinfo)
856 rtx handler;
857 void *typeinfo;
859 struct handler_info* ptr;
860 ptr = (struct handler_info *) malloc (sizeof (struct handler_info));
861 ptr->handler_label = handler;
862 ptr->type_info = typeinfo;
863 ptr->next = NULL;
865 return ptr;
870 /* Find the index in function_eh_regions associated with a NOTE region. If
871 the region cannot be found, a -1 is returned. This should never happen! */
873 int
874 find_func_region (insn_region)
875 int insn_region;
877 int x;
878 for (x = 0; x < current_func_eh_entry; x++)
879 if (function_eh_regions[x].range_number == insn_region)
880 return x;
882 return -1;
885 /* Get a pointer to the first handler in an exception region's list. */
887 struct handler_info *
888 get_first_handler (region)
889 int region;
891 return function_eh_regions[find_func_region (region)].handlers;
894 /* Clean out the function_eh_region table and free all memory */
896 static void
897 clear_function_eh_region ()
899 int x;
900 struct handler_info *ptr, *next;
901 for (x = 0; x < current_func_eh_entry; x++)
902 for (ptr = function_eh_regions[x].handlers; ptr != NULL; ptr = next)
904 next = ptr->next;
905 free (ptr);
907 free (function_eh_regions);
908 num_func_eh_entries = 0;
909 current_func_eh_entry = 0;
912 /* Make a duplicate of an exception region by copying all the handlers
913 for an exception region. Return the new handler index. */
915 int
916 duplicate_handlers (old_note_eh_region, new_note_eh_region)
917 int old_note_eh_region, new_note_eh_region;
919 struct handler_info *ptr, *new_ptr;
920 int new_region, region;
922 region = find_func_region (old_note_eh_region);
923 if (region == -1)
924 error ("Cannot duplicate non-existant exception region.");
926 if (find_func_region (new_note_eh_region) != -1)
927 error ("Cannot duplicate EH region because new note region already exists");
929 new_region = new_eh_region_entry (new_note_eh_region);
930 ptr = function_eh_regions[region].handlers;
932 for ( ; ptr; ptr = ptr->next)
934 new_ptr = get_new_handler (ptr->handler_label, ptr->type_info);
935 add_new_handler (new_region, new_ptr);
938 return new_region;
942 /* Routine to see if exception handling is turned on.
943 DO_WARN is non-zero if we want to inform the user that exception
944 handling is turned off.
946 This is used to ensure that -fexceptions has been specified if the
947 compiler tries to use any exception-specific functions. */
950 doing_eh (do_warn)
951 int do_warn;
953 if (! flag_exceptions)
955 static int warned = 0;
956 if (! warned && do_warn)
958 error ("exception handling disabled, use -fexceptions to enable");
959 warned = 1;
961 return 0;
963 return 1;
966 /* Given a return address in ADDR, determine the address we should use
967 to find the corresponding EH region. */
970 eh_outer_context (addr)
971 rtx addr;
973 /* First mask out any unwanted bits. */
974 #ifdef MASK_RETURN_ADDR
975 expand_and (addr, MASK_RETURN_ADDR, addr);
976 #endif
978 /* Then adjust to find the real return address. */
979 #if defined (RETURN_ADDR_OFFSET)
980 addr = plus_constant (addr, RETURN_ADDR_OFFSET);
981 #endif
983 return addr;
986 /* Start a new exception region for a region of code that has a
987 cleanup action and push the HANDLER for the region onto
988 protect_list. All of the regions created with add_partial_entry
989 will be ended when end_protect_partials is invoked. */
991 void
992 add_partial_entry (handler)
993 tree handler;
995 expand_eh_region_start ();
997 /* Make sure the entry is on the correct obstack. */
998 push_obstacks_nochange ();
999 resume_temporary_allocation ();
1001 /* Because this is a cleanup action, we may have to protect the handler
1002 with __terminate. */
1003 handler = protect_with_terminate (handler);
1005 protect_list = tree_cons (NULL_TREE, handler, protect_list);
1006 pop_obstacks ();
1009 /* Emit code to get EH context to current function. */
1011 static rtx
1012 call_get_eh_context ()
1014 static tree fn;
1015 tree expr;
1017 if (fn == NULL_TREE)
1019 tree fntype;
1020 fn = get_identifier ("__get_eh_context");
1021 push_obstacks_nochange ();
1022 end_temporary_allocation ();
1023 fntype = build_pointer_type (build_pointer_type
1024 (build_pointer_type (void_type_node)));
1025 fntype = build_function_type (fntype, NULL_TREE);
1026 fn = build_decl (FUNCTION_DECL, fn, fntype);
1027 DECL_EXTERNAL (fn) = 1;
1028 TREE_PUBLIC (fn) = 1;
1029 DECL_ARTIFICIAL (fn) = 1;
1030 TREE_READONLY (fn) = 1;
1031 make_decl_rtl (fn, NULL_PTR, 1);
1032 assemble_external (fn);
1033 pop_obstacks ();
1036 expr = build1 (ADDR_EXPR, build_pointer_type (TREE_TYPE (fn)), fn);
1037 expr = build (CALL_EXPR, TREE_TYPE (TREE_TYPE (fn)),
1038 expr, NULL_TREE, NULL_TREE);
1039 TREE_SIDE_EFFECTS (expr) = 1;
1041 return copy_to_reg (expand_expr (expr, NULL_RTX, VOIDmode, 0));
1044 /* Get a reference to the EH context.
1045 We will only generate a register for the current function EH context here,
1046 and emit a USE insn to mark that this is a EH context register.
1048 Later, emit_eh_context will emit needed call to __get_eh_context
1049 in libgcc2, and copy the value to the register we have generated. */
1052 get_eh_context ()
1054 if (current_function_ehc == 0)
1056 rtx insn;
1058 current_function_ehc = gen_reg_rtx (Pmode);
1060 insn = gen_rtx_USE (GET_MODE (current_function_ehc),
1061 current_function_ehc);
1062 insn = emit_insn_before (insn, get_first_nonparm_insn ());
1064 REG_NOTES (insn)
1065 = gen_rtx_EXPR_LIST (REG_EH_CONTEXT, current_function_ehc,
1066 REG_NOTES (insn));
1068 return current_function_ehc;
1071 /* Get a reference to the dynamic handler chain. It points to the
1072 pointer to the next element in the dynamic handler chain. It ends
1073 when there are no more elements in the dynamic handler chain, when
1074 the value is &top_elt from libgcc2.c. Immediately after the
1075 pointer, is an area suitable for setjmp/longjmp when
1076 DONT_USE_BUILTIN_SETJMP is defined, and an area suitable for
1077 __builtin_setjmp/__builtin_longjmp when DONT_USE_BUILTIN_SETJMP
1078 isn't defined. */
1081 get_dynamic_handler_chain ()
1083 rtx ehc, dhc, result;
1085 ehc = get_eh_context ();
1087 /* This is the offset of dynamic_handler_chain in the eh_context struct
1088 declared in eh-common.h. If its location is change, change this offset */
1089 dhc = plus_constant (ehc, POINTER_SIZE / BITS_PER_UNIT);
1091 result = copy_to_reg (dhc);
1093 /* We don't want a copy of the dcc, but rather, the single dcc. */
1094 return gen_rtx_MEM (Pmode, result);
1097 /* Get a reference to the dynamic cleanup chain. It points to the
1098 pointer to the next element in the dynamic cleanup chain.
1099 Immediately after the pointer, are two Pmode variables, one for a
1100 pointer to a function that performs the cleanup action, and the
1101 second, the argument to pass to that function. */
1104 get_dynamic_cleanup_chain ()
1106 rtx dhc, dcc, result;
1108 dhc = get_dynamic_handler_chain ();
1109 dcc = plus_constant (dhc, POINTER_SIZE / BITS_PER_UNIT);
1111 result = copy_to_reg (dcc);
1113 /* We don't want a copy of the dcc, but rather, the single dcc. */
1114 return gen_rtx_MEM (Pmode, result);
1117 #ifdef DONT_USE_BUILTIN_SETJMP
1118 /* Generate code to evaluate X and jump to LABEL if the value is nonzero.
1119 LABEL is an rtx of code CODE_LABEL, in this function. */
1121 static void
1122 jumpif_rtx (x, label)
1123 rtx x;
1124 rtx label;
1126 jumpif (make_tree (type_for_mode (GET_MODE (x), 0), x), label);
1128 #endif
1130 /* Start a dynamic cleanup on the EH runtime dynamic cleanup stack.
1131 We just need to create an element for the cleanup list, and push it
1132 into the chain.
1134 A dynamic cleanup is a cleanup action implied by the presence of an
1135 element on the EH runtime dynamic cleanup stack that is to be
1136 performed when an exception is thrown. The cleanup action is
1137 performed by __sjthrow when an exception is thrown. Only certain
1138 actions can be optimized into dynamic cleanup actions. For the
1139 restrictions on what actions can be performed using this routine,
1140 see expand_eh_region_start_tree. */
1142 static void
1143 start_dynamic_cleanup (func, arg)
1144 tree func;
1145 tree arg;
1147 rtx dcc;
1148 rtx new_func, new_arg;
1149 rtx x, buf;
1150 int size;
1152 /* We allocate enough room for a pointer to the function, and
1153 one argument. */
1154 size = 2;
1156 /* XXX, FIXME: The stack space allocated this way is too long lived,
1157 but there is no allocation routine that allocates at the level of
1158 the last binding contour. */
1159 buf = assign_stack_local (BLKmode,
1160 GET_MODE_SIZE (Pmode)*(size+1),
1163 buf = change_address (buf, Pmode, NULL_RTX);
1165 /* Store dcc into the first word of the newly allocated buffer. */
1167 dcc = get_dynamic_cleanup_chain ();
1168 emit_move_insn (buf, dcc);
1170 /* Store func and arg into the cleanup list element. */
1172 new_func = gen_rtx_MEM (Pmode, plus_constant (XEXP (buf, 0),
1173 GET_MODE_SIZE (Pmode)));
1174 new_arg = gen_rtx_MEM (Pmode, plus_constant (XEXP (buf, 0),
1175 GET_MODE_SIZE (Pmode)*2));
1176 x = expand_expr (func, new_func, Pmode, 0);
1177 if (x != new_func)
1178 emit_move_insn (new_func, x);
1180 x = expand_expr (arg, new_arg, Pmode, 0);
1181 if (x != new_arg)
1182 emit_move_insn (new_arg, x);
1184 /* Update the cleanup chain. */
1186 emit_move_insn (dcc, XEXP (buf, 0));
1189 /* Emit RTL to start a dynamic handler on the EH runtime dynamic
1190 handler stack. This should only be used by expand_eh_region_start
1191 or expand_eh_region_start_tree. */
1193 static void
1194 start_dynamic_handler ()
1196 rtx dhc, dcc;
1197 rtx x, arg, buf;
1198 int size;
1200 #ifndef DONT_USE_BUILTIN_SETJMP
1201 /* The number of Pmode words for the setjmp buffer, when using the
1202 builtin setjmp/longjmp, see expand_builtin, case
1203 BUILT_IN_LONGJMP. */
1204 size = 5;
1205 #else
1206 #ifdef JMP_BUF_SIZE
1207 size = JMP_BUF_SIZE;
1208 #else
1209 /* Should be large enough for most systems, if it is not,
1210 JMP_BUF_SIZE should be defined with the proper value. It will
1211 also tend to be larger than necessary for most systems, a more
1212 optimal port will define JMP_BUF_SIZE. */
1213 size = FIRST_PSEUDO_REGISTER+2;
1214 #endif
1215 #endif
1216 /* XXX, FIXME: The stack space allocated this way is too long lived,
1217 but there is no allocation routine that allocates at the level of
1218 the last binding contour. */
1219 arg = assign_stack_local (BLKmode,
1220 GET_MODE_SIZE (Pmode)*(size+1),
1223 arg = change_address (arg, Pmode, NULL_RTX);
1225 /* Store dhc into the first word of the newly allocated buffer. */
1227 dhc = get_dynamic_handler_chain ();
1228 dcc = gen_rtx_MEM (Pmode, plus_constant (XEXP (arg, 0),
1229 GET_MODE_SIZE (Pmode)));
1230 emit_move_insn (arg, dhc);
1232 /* Zero out the start of the cleanup chain. */
1233 emit_move_insn (dcc, const0_rtx);
1235 /* The jmpbuf starts two words into the area allocated. */
1236 buf = plus_constant (XEXP (arg, 0), GET_MODE_SIZE (Pmode)*2);
1238 #ifdef DONT_USE_BUILTIN_SETJMP
1239 x = emit_library_call_value (setjmp_libfunc, NULL_RTX, 1, SImode, 1,
1240 buf, Pmode);
1241 /* If we come back here for a catch, transfer control to the handler. */
1242 jumpif_rtx (x, ehstack.top->entry->exception_handler_label);
1243 #else
1245 /* A label to continue execution for the no exception case. */
1246 rtx noex = gen_label_rtx();
1247 x = expand_builtin_setjmp (buf, NULL_RTX, noex,
1248 ehstack.top->entry->exception_handler_label);
1249 emit_label (noex);
1251 #endif
1253 /* We are committed to this, so update the handler chain. */
1255 emit_move_insn (dhc, XEXP (arg, 0));
1258 /* Start an exception handling region for the given cleanup action.
1259 All instructions emitted after this point are considered to be part
1260 of the region until expand_eh_region_end is invoked. CLEANUP is
1261 the cleanup action to perform. The return value is true if the
1262 exception region was optimized away. If that case,
1263 expand_eh_region_end does not need to be called for this cleanup,
1264 nor should it be.
1266 This routine notices one particular common case in C++ code
1267 generation, and optimizes it so as to not need the exception
1268 region. It works by creating a dynamic cleanup action, instead of
1269 a using an exception region. */
1272 expand_eh_region_start_tree (decl, cleanup)
1273 tree decl;
1274 tree cleanup;
1276 /* This is the old code. */
1277 if (! doing_eh (0))
1278 return 0;
1280 /* The optimization only applies to actions protected with
1281 terminate, and only applies if we are using the setjmp/longjmp
1282 codegen method. */
1283 if (exceptions_via_longjmp
1284 && protect_cleanup_actions_with_terminate)
1286 tree func, arg;
1287 tree args;
1289 /* Ignore any UNSAVE_EXPR. */
1290 if (TREE_CODE (cleanup) == UNSAVE_EXPR)
1291 cleanup = TREE_OPERAND (cleanup, 0);
1293 /* Further, it only applies if the action is a call, if there
1294 are 2 arguments, and if the second argument is 2. */
1296 if (TREE_CODE (cleanup) == CALL_EXPR
1297 && (args = TREE_OPERAND (cleanup, 1))
1298 && (func = TREE_OPERAND (cleanup, 0))
1299 && (arg = TREE_VALUE (args))
1300 && (args = TREE_CHAIN (args))
1302 /* is the second argument 2? */
1303 && TREE_CODE (TREE_VALUE (args)) == INTEGER_CST
1304 && TREE_INT_CST_LOW (TREE_VALUE (args)) == 2
1305 && TREE_INT_CST_HIGH (TREE_VALUE (args)) == 0
1307 /* Make sure there are no other arguments. */
1308 && TREE_CHAIN (args) == NULL_TREE)
1310 /* Arrange for returns and gotos to pop the entry we make on the
1311 dynamic cleanup stack. */
1312 expand_dcc_cleanup (decl);
1313 start_dynamic_cleanup (func, arg);
1314 return 1;
1318 expand_eh_region_start_for_decl (decl);
1319 ehstack.top->entry->finalization = cleanup;
1321 return 0;
1324 /* Just like expand_eh_region_start, except if a cleanup action is
1325 entered on the cleanup chain, the TREE_PURPOSE of the element put
1326 on the chain is DECL. DECL should be the associated VAR_DECL, if
1327 any, otherwise it should be NULL_TREE. */
1329 void
1330 expand_eh_region_start_for_decl (decl)
1331 tree decl;
1333 rtx note;
1335 /* This is the old code. */
1336 if (! doing_eh (0))
1337 return;
1339 if (exceptions_via_longjmp)
1341 /* We need a new block to record the start and end of the
1342 dynamic handler chain. We could always do this, but we
1343 really want to permit jumping into such a block, and we want
1344 to avoid any errors or performance impact in the SJ EH code
1345 for now. */
1346 expand_start_bindings (0);
1348 /* But we don't need or want a new temporary level. */
1349 pop_temp_slots ();
1351 /* Mark this block as created by expand_eh_region_start. This
1352 is so that we can pop the block with expand_end_bindings
1353 automatically. */
1354 mark_block_as_eh_region ();
1356 /* Arrange for returns and gotos to pop the entry we make on the
1357 dynamic handler stack. */
1358 expand_dhc_cleanup (decl);
1361 push_eh_entry (&ehstack);
1362 note = emit_note (NULL_PTR, NOTE_INSN_EH_REGION_BEG);
1363 NOTE_BLOCK_NUMBER (note)
1364 = CODE_LABEL_NUMBER (ehstack.top->entry->exception_handler_label);
1365 if (exceptions_via_longjmp)
1366 start_dynamic_handler ();
1369 /* Start an exception handling region. All instructions emitted after
1370 this point are considered to be part of the region until
1371 expand_eh_region_end is invoked. */
1373 void
1374 expand_eh_region_start ()
1376 expand_eh_region_start_for_decl (NULL_TREE);
1379 /* End an exception handling region. The information about the region
1380 is found on the top of ehstack.
1382 HANDLER is either the cleanup for the exception region, or if we're
1383 marking the end of a try block, HANDLER is integer_zero_node.
1385 HANDLER will be transformed to rtl when expand_leftover_cleanups
1386 is invoked. */
1388 void
1389 expand_eh_region_end (handler)
1390 tree handler;
1392 struct eh_entry *entry;
1393 rtx note;
1395 if (! doing_eh (0))
1396 return;
1398 entry = pop_eh_entry (&ehstack);
1400 note = emit_note (NULL_PTR, NOTE_INSN_EH_REGION_END);
1401 NOTE_BLOCK_NUMBER (note)
1402 = CODE_LABEL_NUMBER (entry->exception_handler_label);
1403 if (exceptions_via_longjmp == 0
1404 /* We share outer_context between regions; only emit it once. */
1405 && INSN_UID (entry->outer_context) == 0)
1407 rtx label;
1409 label = gen_label_rtx ();
1410 emit_jump (label);
1412 /* Emit a label marking the end of this exception region that
1413 is used for rethrowing into the outer context. */
1414 emit_label (entry->outer_context);
1415 expand_internal_throw ();
1417 emit_label (label);
1420 entry->finalization = handler;
1422 /* create region entry in final exception table */
1423 new_eh_region_entry (NOTE_BLOCK_NUMBER (note));
1425 enqueue_eh_entry (&ehqueue, entry);
1427 /* If we have already started ending the bindings, don't recurse.
1428 This only happens when exceptions_via_longjmp is true. */
1429 if (is_eh_region ())
1431 /* Because we don't need or want a new temporary level and
1432 because we didn't create one in expand_eh_region_start,
1433 create a fake one now to avoid removing one in
1434 expand_end_bindings. */
1435 push_temp_slots ();
1437 mark_block_as_not_eh_region ();
1439 /* Maybe do this to prevent jumping in and so on... */
1440 expand_end_bindings (NULL_TREE, 0, 0);
1444 /* End the EH region for a goto fixup. We only need them in the region-based
1445 EH scheme. */
1447 void
1448 expand_fixup_region_start ()
1450 if (! doing_eh (0) || exceptions_via_longjmp)
1451 return;
1453 expand_eh_region_start ();
1456 /* End the EH region for a goto fixup. CLEANUP is the cleanup we just
1457 expanded; to avoid running it twice if it throws, we look through the
1458 ehqueue for a matching region and rethrow from its outer_context. */
1460 void
1461 expand_fixup_region_end (cleanup)
1462 tree cleanup;
1464 struct eh_node *node;
1466 if (! doing_eh (0) || exceptions_via_longjmp)
1467 return;
1469 for (node = ehstack.top; node && node->entry->finalization != cleanup; )
1470 node = node->chain;
1471 if (node == 0)
1472 for (node = ehqueue.head; node && node->entry->finalization != cleanup; )
1473 node = node->chain;
1474 if (node == 0)
1475 abort ();
1477 ehstack.top->entry->outer_context = node->entry->outer_context;
1479 /* Just rethrow. size_zero_node is just a NOP. */
1480 expand_eh_region_end (size_zero_node);
1483 /* If we are using the setjmp/longjmp EH codegen method, we emit a
1484 call to __sjthrow.
1486 Otherwise, we emit a call to __throw and note that we threw
1487 something, so we know we need to generate the necessary code for
1488 __throw.
1490 Before invoking throw, the __eh_pc variable must have been set up
1491 to contain the PC being thrown from. This address is used by
1492 __throw to determine which exception region (if any) is
1493 responsible for handling the exception. */
1495 void
1496 emit_throw ()
1498 if (exceptions_via_longjmp)
1500 emit_library_call (sjthrow_libfunc, 0, VOIDmode, 0);
1502 else
1504 #ifdef JUMP_TO_THROW
1505 emit_indirect_jump (throw_libfunc);
1506 #else
1507 emit_library_call (throw_libfunc, 0, VOIDmode, 0);
1508 #endif
1510 emit_barrier ();
1513 /* Throw the current exception. If appropriate, this is done by jumping
1514 to the next handler. */
1516 void
1517 expand_internal_throw ()
1519 emit_throw ();
1522 /* Called from expand_exception_blocks and expand_end_catch_block to
1523 emit any pending handlers/cleanups queued from expand_eh_region_end. */
1525 void
1526 expand_leftover_cleanups ()
1528 struct eh_entry *entry;
1530 while ((entry = dequeue_eh_entry (&ehqueue)) != 0)
1532 rtx prev;
1534 /* A leftover try block. Shouldn't be one here. */
1535 if (entry->finalization == integer_zero_node)
1536 abort ();
1538 /* Output the label for the start of the exception handler. */
1540 receive_exception_label (entry->exception_handler_label);
1542 /* register a handler for this cleanup region */
1543 add_new_handler (
1544 find_func_region (CODE_LABEL_NUMBER (entry->exception_handler_label)),
1545 get_new_handler (entry->exception_handler_label, NULL));
1547 /* And now generate the insns for the handler. */
1548 expand_expr (entry->finalization, const0_rtx, VOIDmode, 0);
1550 prev = get_last_insn ();
1551 if (prev == NULL || GET_CODE (prev) != BARRIER)
1552 /* Emit code to throw to the outer context if we fall off
1553 the end of the handler. */
1554 expand_rethrow (entry->outer_context);
1556 do_pending_stack_adjust ();
1557 free (entry);
1561 /* Called at the start of a block of try statements. */
1562 void
1563 expand_start_try_stmts ()
1565 if (! doing_eh (1))
1566 return;
1568 expand_eh_region_start ();
1571 /* Called to begin a catch clause. The parameter is the object which
1572 will be passed to the runtime type check routine. */
1573 void
1574 start_catch_handler (rtime)
1575 tree rtime;
1577 rtx handler_label;
1578 int insn_region_num;
1579 int eh_region_entry;
1581 if (! doing_eh (1))
1582 return;
1584 handler_label = catchstack.top->entry->exception_handler_label;
1585 insn_region_num = CODE_LABEL_NUMBER (handler_label);
1586 eh_region_entry = find_func_region (insn_region_num);
1588 /* If we've already issued this label, pick a new one */
1589 if (catchstack.top->entry->label_used)
1590 handler_label = gen_exception_label ();
1591 else
1592 catchstack.top->entry->label_used = 1;
1594 receive_exception_label (handler_label);
1596 add_new_handler (eh_region_entry, get_new_handler (handler_label, rtime));
1599 /* Generate RTL for the start of a group of catch clauses.
1601 It is responsible for starting a new instruction sequence for the
1602 instructions in the catch block, and expanding the handlers for the
1603 internally-generated exception regions nested within the try block
1604 corresponding to this catch block. */
1606 void
1607 expand_start_all_catch ()
1609 struct eh_entry *entry;
1610 tree label;
1611 rtx outer_context;
1613 if (! doing_eh (1))
1614 return;
1616 outer_context = ehstack.top->entry->outer_context;
1618 /* End the try block. */
1619 expand_eh_region_end (integer_zero_node);
1621 emit_line_note (input_filename, lineno);
1622 label = build_decl (LABEL_DECL, NULL_TREE, NULL_TREE);
1624 /* The label for the exception handling block that we will save.
1625 This is Lresume in the documentation. */
1626 expand_label (label);
1628 /* Push the label that points to where normal flow is resumed onto
1629 the top of the label stack. */
1630 push_label_entry (&caught_return_label_stack, NULL_RTX, label);
1632 /* Start a new sequence for all the catch blocks. We will add this
1633 to the global sequence catch_clauses when we have completed all
1634 the handlers in this handler-seq. */
1635 start_sequence ();
1637 entry = dequeue_eh_entry (&ehqueue);
1638 for ( ; entry->finalization != integer_zero_node;
1639 entry = dequeue_eh_entry (&ehqueue))
1641 rtx prev;
1643 /* Emit the label for the cleanup handler for this region, and
1644 expand the code for the handler.
1646 Note that a catch region is handled as a side-effect here;
1647 for a try block, entry->finalization will contain
1648 integer_zero_node, so no code will be generated in the
1649 expand_expr call below. But, the label for the handler will
1650 still be emitted, so any code emitted after this point will
1651 end up being the handler. */
1653 receive_exception_label (entry->exception_handler_label);
1655 /* register a handler for this cleanup region */
1656 add_new_handler (
1657 find_func_region (CODE_LABEL_NUMBER (entry->exception_handler_label)),
1658 get_new_handler (entry->exception_handler_label, NULL));
1660 /* And now generate the insns for the cleanup handler. */
1661 expand_expr (entry->finalization, const0_rtx, VOIDmode, 0);
1663 prev = get_last_insn ();
1664 if (prev == NULL || GET_CODE (prev) != BARRIER)
1665 /* Code to throw out to outer context when we fall off end
1666 of the handler. We can't do this here for catch blocks,
1667 so it's done in expand_end_all_catch instead. */
1668 expand_rethrow (entry->outer_context);
1670 do_pending_stack_adjust ();
1671 free (entry);
1674 /* At this point, all the cleanups are done, and the ehqueue now has
1675 the current exception region at its head. We dequeue it, and put it
1676 on the catch stack. */
1678 push_entry (&catchstack, entry);
1680 /* If we are not doing setjmp/longjmp EH, because we are reordered
1681 out of line, we arrange to rethrow in the outer context. We need to
1682 do this because we are not physically within the region, if any, that
1683 logically contains this catch block. */
1684 if (! exceptions_via_longjmp)
1686 expand_eh_region_start ();
1687 ehstack.top->entry->outer_context = outer_context;
1690 /* We also have to start the handler if we aren't using the new model. */
1691 if (! flag_new_exceptions)
1692 start_catch_handler (NULL);
1695 /* Finish up the catch block. At this point all the insns for the
1696 catch clauses have already been generated, so we only have to add
1697 them to the catch_clauses list. We also want to make sure that if
1698 we fall off the end of the catch clauses that we rethrow to the
1699 outer EH region. */
1701 void
1702 expand_end_all_catch ()
1704 rtx new_catch_clause, outer_context = NULL_RTX;
1705 struct eh_entry *entry;
1707 if (! doing_eh (1))
1708 return;
1710 /* Dequeue the current catch clause region. */
1711 entry = pop_eh_entry (&catchstack);
1712 free (entry);
1714 if (! exceptions_via_longjmp)
1716 outer_context = ehstack.top->entry->outer_context;
1718 /* Finish the rethrow region. size_zero_node is just a NOP. */
1719 expand_eh_region_end (size_zero_node);
1722 /* Code to throw out to outer context, if we fall off end of catch
1723 handlers. This is rethrow (Lresume, same id, same obj) in the
1724 documentation. We use Lresume because we know that it will throw
1725 to the correct context.
1727 In other words, if the catch handler doesn't exit or return, we
1728 do a "throw" (using the address of Lresume as the point being
1729 thrown from) so that the outer EH region can then try to process
1730 the exception. */
1731 expand_rethrow (outer_context);
1733 /* Now we have the complete catch sequence. */
1734 new_catch_clause = get_insns ();
1735 end_sequence ();
1737 /* This level of catch blocks is done, so set up the successful
1738 catch jump label for the next layer of catch blocks. */
1739 pop_label_entry (&caught_return_label_stack);
1740 pop_label_entry (&outer_context_label_stack);
1742 /* Add the new sequence of catches to the main one for this function. */
1743 push_to_sequence (catch_clauses);
1744 emit_insns (new_catch_clause);
1745 catch_clauses = get_insns ();
1746 end_sequence ();
1748 /* Here we fall through into the continuation code. */
1751 /* Rethrow from the outer context LABEL. */
1753 static void
1754 expand_rethrow (label)
1755 rtx label;
1757 if (exceptions_via_longjmp)
1758 emit_throw ();
1759 else
1760 emit_jump (label);
1763 /* End all the pending exception regions on protect_list. The handlers
1764 will be emitted when expand_leftover_cleanups is invoked. */
1766 void
1767 end_protect_partials ()
1769 while (protect_list)
1771 expand_eh_region_end (TREE_VALUE (protect_list));
1772 protect_list = TREE_CHAIN (protect_list);
1776 /* Arrange for __terminate to be called if there is an unhandled throw
1777 from within E. */
1779 tree
1780 protect_with_terminate (e)
1781 tree e;
1783 /* We only need to do this when using setjmp/longjmp EH and the
1784 language requires it, as otherwise we protect all of the handlers
1785 at once, if we need to. */
1786 if (exceptions_via_longjmp && protect_cleanup_actions_with_terminate)
1788 tree handler, result;
1790 /* All cleanups must be on the function_obstack. */
1791 push_obstacks_nochange ();
1792 resume_temporary_allocation ();
1794 handler = make_node (RTL_EXPR);
1795 TREE_TYPE (handler) = void_type_node;
1796 RTL_EXPR_RTL (handler) = const0_rtx;
1797 TREE_SIDE_EFFECTS (handler) = 1;
1798 start_sequence_for_rtl_expr (handler);
1800 emit_library_call (terminate_libfunc, 0, VOIDmode, 0);
1801 emit_barrier ();
1803 RTL_EXPR_SEQUENCE (handler) = get_insns ();
1804 end_sequence ();
1806 result = build (TRY_CATCH_EXPR, TREE_TYPE (e), e, handler);
1807 TREE_SIDE_EFFECTS (result) = TREE_SIDE_EFFECTS (e);
1808 TREE_THIS_VOLATILE (result) = TREE_THIS_VOLATILE (e);
1809 TREE_READONLY (result) = TREE_READONLY (e);
1811 pop_obstacks ();
1813 e = result;
1816 return e;
1819 /* The exception table that we build that is used for looking up and
1820 dispatching exceptions, the current number of entries, and its
1821 maximum size before we have to extend it.
1823 The number in eh_table is the code label number of the exception
1824 handler for the region. This is added by add_eh_table_entry and
1825 used by output_exception_table_entry. */
1827 static int *eh_table = NULL;
1828 static int eh_table_size = 0;
1829 static int eh_table_max_size = 0;
1831 /* Note the need for an exception table entry for region N. If we
1832 don't need to output an explicit exception table, avoid all of the
1833 extra work.
1835 Called from final_scan_insn when a NOTE_INSN_EH_REGION_BEG is seen.
1836 (Or NOTE_INSN_EH_REGION_END sometimes)
1837 N is the NOTE_BLOCK_NUMBER of the note, which comes from the code
1838 label number of the exception handler for the region. */
1840 void
1841 add_eh_table_entry (n)
1842 int n;
1844 #ifndef OMIT_EH_TABLE
1845 if (eh_table_size >= eh_table_max_size)
1847 if (eh_table)
1849 eh_table_max_size += eh_table_max_size>>1;
1851 if (eh_table_max_size < 0)
1852 abort ();
1854 eh_table = (int *) xrealloc (eh_table,
1855 eh_table_max_size * sizeof (int));
1857 else
1859 eh_table_max_size = 252;
1860 eh_table = (int *) xmalloc (eh_table_max_size * sizeof (int));
1863 eh_table[eh_table_size++] = n;
1864 #endif
1867 /* Return a non-zero value if we need to output an exception table.
1869 On some platforms, we don't have to output a table explicitly.
1870 This routine doesn't mean we don't have one. */
1873 exception_table_p ()
1875 if (eh_table)
1876 return 1;
1878 return 0;
1881 /* Output the entry of the exception table corresponding to the
1882 exception region numbered N to file FILE.
1884 N is the code label number corresponding to the handler of the
1885 region. */
1887 static void
1888 output_exception_table_entry (file, n)
1889 FILE *file;
1890 int n;
1892 char buf[256];
1893 rtx sym;
1894 struct handler_info *handler;
1896 handler = get_first_handler (n);
1898 for ( ; handler != NULL; handler = handler->next)
1900 ASM_GENERATE_INTERNAL_LABEL (buf, "LEHB", n);
1901 sym = gen_rtx_SYMBOL_REF (Pmode, buf);
1902 assemble_integer (sym, POINTER_SIZE / BITS_PER_UNIT, 1);
1904 ASM_GENERATE_INTERNAL_LABEL (buf, "LEHE", n);
1905 sym = gen_rtx_SYMBOL_REF (Pmode, buf);
1906 assemble_integer (sym, POINTER_SIZE / BITS_PER_UNIT, 1);
1908 assemble_integer (handler->handler_label,
1909 POINTER_SIZE / BITS_PER_UNIT, 1);
1911 if (flag_new_exceptions)
1913 if (handler->type_info == NULL)
1914 assemble_integer (const0_rtx, POINTER_SIZE / BITS_PER_UNIT, 1);
1915 else
1916 if (handler->type_info == CATCH_ALL_TYPE)
1917 assemble_integer (GEN_INT (CATCH_ALL_TYPE),
1918 POINTER_SIZE / BITS_PER_UNIT, 1);
1919 else
1920 output_constant ((tree)(handler->type_info),
1921 POINTER_SIZE / BITS_PER_UNIT);
1923 putc ('\n', file); /* blank line */
1927 /* Output the exception table if we have and need one. */
1929 static short language_code = 0;
1930 static short version_code = 0;
1932 /* This routine will set the language code for exceptions. */
1933 void set_exception_lang_code (code)
1934 short code;
1936 language_code = code;
1939 /* This routine will set the language version code for exceptions. */
1940 void set_exception_version_code (code)
1941 short code;
1943 version_code = code;
1947 void
1948 output_exception_table ()
1950 int i;
1951 extern FILE *asm_out_file;
1953 if (! doing_eh (0) || ! eh_table)
1954 return;
1956 exception_section ();
1958 /* Beginning marker for table. */
1959 assemble_align (GET_MODE_ALIGNMENT (ptr_mode));
1960 assemble_label ("__EXCEPTION_TABLE__");
1962 if (flag_new_exceptions)
1964 assemble_integer (GEN_INT (NEW_EH_RUNTIME),
1965 POINTER_SIZE / BITS_PER_UNIT, 1);
1966 assemble_integer (GEN_INT (language_code), 2 , 1);
1967 assemble_integer (GEN_INT (version_code), 2 , 1);
1969 /* Add enough padding to make sure table aligns on a pointer boundry. */
1970 i = GET_MODE_ALIGNMENT (ptr_mode) / BITS_PER_UNIT - 4;
1971 for ( ; i < 0; i = i + GET_MODE_ALIGNMENT (ptr_mode) / BITS_PER_UNIT)
1973 if (i != 0)
1974 assemble_integer (const0_rtx, i , 1);
1977 for (i = 0; i < eh_table_size; ++i)
1978 output_exception_table_entry (asm_out_file, eh_table[i]);
1980 free (eh_table);
1981 clear_function_eh_region ();
1983 /* Ending marker for table. */
1984 assemble_integer (constm1_rtx, POINTER_SIZE / BITS_PER_UNIT, 1);
1986 /* for binary compatability, the old __throw checked the second
1987 position for a -1, so we should output at least 2 -1's */
1988 if (! flag_new_exceptions)
1989 assemble_integer (constm1_rtx, POINTER_SIZE / BITS_PER_UNIT, 1);
1991 putc ('\n', asm_out_file); /* blank line */
1994 /* Emit code to get EH context.
1996 We have to scan thru the code to find possible EH context registers.
1997 Inlined functions may use it too, and thus we'll have to be able
1998 to change them too.
2000 This is done only if using exceptions_via_longjmp. */
2002 void
2003 emit_eh_context ()
2005 rtx insn;
2006 rtx ehc = 0;
2008 if (! doing_eh (0))
2009 return;
2011 for (insn = get_insns (); insn; insn = NEXT_INSN (insn))
2012 if (GET_CODE (insn) == INSN
2013 && GET_CODE (PATTERN (insn)) == USE)
2015 rtx reg = find_reg_note (insn, REG_EH_CONTEXT, 0);
2016 if (reg)
2018 rtx insns;
2020 start_sequence ();
2022 /* If this is the first use insn, emit the call here. This
2023 will always be at the top of our function, because if
2024 expand_inline_function notices a REG_EH_CONTEXT note, it
2025 adds a use insn to this function as well. */
2026 if (ehc == 0)
2027 ehc = call_get_eh_context ();
2029 emit_move_insn (XEXP (reg, 0), ehc);
2030 insns = get_insns ();
2031 end_sequence ();
2033 emit_insns_before (insns, insn);
2038 /* Scan the current insns and build a list of handler labels. The
2039 resulting list is placed in the global variable exception_handler_labels.
2041 It is called after the last exception handling region is added to
2042 the current function (when the rtl is almost all built for the
2043 current function) and before the jump optimization pass. */
2045 void
2046 find_exception_handler_labels ()
2048 rtx insn;
2050 exception_handler_labels = NULL_RTX;
2052 /* If we aren't doing exception handling, there isn't much to check. */
2053 if (! doing_eh (0))
2054 return;
2056 /* For each start of a region, add its label to the list. */
2058 for (insn = get_insns (); insn; insn = NEXT_INSN (insn))
2060 struct handler_info* ptr;
2061 if (GET_CODE (insn) == NOTE
2062 && NOTE_LINE_NUMBER (insn) == NOTE_INSN_EH_REGION_BEG)
2064 ptr = get_first_handler (NOTE_BLOCK_NUMBER (insn));
2065 for ( ; ptr; ptr = ptr->next)
2067 /* make sure label isn't in the list already */
2068 rtx x;
2069 for (x = exception_handler_labels; x; x = XEXP (x, 1))
2070 if (XEXP (x, 0) == ptr->handler_label)
2071 break;
2072 if (! x)
2073 exception_handler_labels = gen_rtx_EXPR_LIST (VOIDmode,
2074 ptr->handler_label, exception_handler_labels);
2080 /* Return a value of 1 if the parameter label number is an exception handler
2081 label. Return 0 otherwise. */
2084 is_exception_handler_label (lab)
2085 int lab;
2087 rtx x;
2088 for (x = exception_handler_labels ; x ; x = XEXP (x, 1))
2089 if (lab == CODE_LABEL_NUMBER (XEXP (x, 0)))
2090 return 1;
2091 return 0;
2094 /* Perform sanity checking on the exception_handler_labels list.
2096 Can be called after find_exception_handler_labels is called to
2097 build the list of exception handlers for the current function and
2098 before we finish processing the current function. */
2100 void
2101 check_exception_handler_labels ()
2103 rtx insn, insn2;
2105 /* If we aren't doing exception handling, there isn't much to check. */
2106 if (! doing_eh (0))
2107 return;
2109 /* Make sure there is no more than 1 copy of a label */
2110 for (insn = exception_handler_labels; insn; insn = XEXP (insn, 1))
2112 int count = 0;
2113 for (insn2 = exception_handler_labels; insn2; insn2 = XEXP (insn2, 1))
2114 if (XEXP (insn, 0) == XEXP (insn2, 0))
2115 count++;
2116 if (count != 1)
2117 warning ("Counted %d copies of EH region %d in list.\n", count,
2118 CODE_LABEL_NUMBER (insn));
2123 /* This group of functions initializes the exception handling data
2124 structures at the start of the compilation, initializes the data
2125 structures at the start of a function, and saves and restores the
2126 exception handling data structures for the start/end of a nested
2127 function. */
2129 /* Toplevel initialization for EH things. */
2131 void
2132 init_eh ()
2136 /* Initialize the per-function EH information. */
2138 void
2139 init_eh_for_function ()
2141 ehstack.top = 0;
2142 catchstack.top = 0;
2143 ehqueue.head = ehqueue.tail = 0;
2144 catch_clauses = NULL_RTX;
2145 false_label_stack = 0;
2146 caught_return_label_stack = 0;
2147 protect_list = NULL_TREE;
2148 current_function_ehc = NULL_RTX;
2151 /* Save some of the per-function EH info into the save area denoted by
2154 This is currently called from save_stmt_status. */
2156 void
2157 save_eh_status (p)
2158 struct function *p;
2160 if (p == NULL)
2161 abort ();
2163 p->ehstack = ehstack;
2164 p->catchstack = catchstack;
2165 p->ehqueue = ehqueue;
2166 p->catch_clauses = catch_clauses;
2167 p->false_label_stack = false_label_stack;
2168 p->caught_return_label_stack = caught_return_label_stack;
2169 p->protect_list = protect_list;
2170 p->ehc = current_function_ehc;
2172 init_eh_for_function ();
2175 /* Restore the per-function EH info saved into the area denoted by P.
2177 This is currently called from restore_stmt_status. */
2179 void
2180 restore_eh_status (p)
2181 struct function *p;
2183 if (p == NULL)
2184 abort ();
2186 protect_list = p->protect_list;
2187 caught_return_label_stack = p->caught_return_label_stack;
2188 false_label_stack = p->false_label_stack;
2189 catch_clauses = p->catch_clauses;
2190 ehqueue = p->ehqueue;
2191 ehstack = p->ehstack;
2192 catchstack = p->catchstack;
2193 current_function_ehc = p->ehc;
2196 /* This section is for the exception handling specific optimization
2197 pass. First are the internal routines, and then the main
2198 optimization pass. */
2200 /* Determine if the given INSN can throw an exception. */
2202 static int
2203 can_throw (insn)
2204 rtx insn;
2206 /* Calls can always potentially throw exceptions. */
2207 if (GET_CODE (insn) == CALL_INSN)
2208 return 1;
2210 if (asynchronous_exceptions)
2212 /* If we wanted asynchronous exceptions, then everything but NOTEs
2213 and CODE_LABELs could throw. */
2214 if (GET_CODE (insn) != NOTE && GET_CODE (insn) != CODE_LABEL)
2215 return 1;
2218 return 0;
2221 /* Scan a exception region looking for the matching end and then
2222 remove it if possible. INSN is the start of the region, N is the
2223 region number, and DELETE_OUTER is to note if anything in this
2224 region can throw.
2226 Regions are removed if they cannot possibly catch an exception.
2227 This is determined by invoking can_throw on each insn within the
2228 region; if can_throw returns true for any of the instructions, the
2229 region can catch an exception, since there is an insn within the
2230 region that is capable of throwing an exception.
2232 Returns the NOTE_INSN_EH_REGION_END corresponding to this region, or
2233 calls abort if it can't find one.
2235 Can abort if INSN is not a NOTE_INSN_EH_REGION_BEGIN, or if N doesn't
2236 correspond to the region number, or if DELETE_OUTER is NULL. */
2238 static rtx
2239 scan_region (insn, n, delete_outer)
2240 rtx insn;
2241 int n;
2242 int *delete_outer;
2244 rtx start = insn;
2246 /* Assume we can delete the region. */
2247 int delete = 1;
2249 if (insn == NULL_RTX
2250 || GET_CODE (insn) != NOTE
2251 || NOTE_LINE_NUMBER (insn) != NOTE_INSN_EH_REGION_BEG
2252 || NOTE_BLOCK_NUMBER (insn) != n
2253 || delete_outer == NULL)
2254 abort ();
2256 insn = NEXT_INSN (insn);
2258 /* Look for the matching end. */
2259 while (! (GET_CODE (insn) == NOTE
2260 && NOTE_LINE_NUMBER (insn) == NOTE_INSN_EH_REGION_END))
2262 /* If anything can throw, we can't remove the region. */
2263 if (delete && can_throw (insn))
2265 delete = 0;
2268 /* Watch out for and handle nested regions. */
2269 if (GET_CODE (insn) == NOTE
2270 && NOTE_LINE_NUMBER (insn) == NOTE_INSN_EH_REGION_BEG)
2272 insn = scan_region (insn, NOTE_BLOCK_NUMBER (insn), &delete);
2275 insn = NEXT_INSN (insn);
2278 /* The _BEG/_END NOTEs must match and nest. */
2279 if (NOTE_BLOCK_NUMBER (insn) != n)
2280 abort ();
2282 /* If anything in this exception region can throw, we can throw. */
2283 if (! delete)
2284 *delete_outer = 0;
2285 else
2287 /* Delete the start and end of the region. */
2288 delete_insn (start);
2289 delete_insn (insn);
2291 /* We no longer removed labels here, since flow will now remove any
2292 handler which cannot be called any more. */
2294 #if 0
2295 /* Only do this part if we have built the exception handler
2296 labels. */
2297 if (exception_handler_labels)
2299 rtx x, *prev = &exception_handler_labels;
2301 /* Find it in the list of handlers. */
2302 for (x = exception_handler_labels; x; x = XEXP (x, 1))
2304 rtx label = XEXP (x, 0);
2305 if (CODE_LABEL_NUMBER (label) == n)
2307 /* If we are the last reference to the handler,
2308 delete it. */
2309 if (--LABEL_NUSES (label) == 0)
2310 delete_insn (label);
2312 if (optimize)
2314 /* Remove it from the list of exception handler
2315 labels, if we are optimizing. If we are not, then
2316 leave it in the list, as we are not really going to
2317 remove the region. */
2318 *prev = XEXP (x, 1);
2319 XEXP (x, 1) = 0;
2320 XEXP (x, 0) = 0;
2323 break;
2325 prev = &XEXP (x, 1);
2328 #endif
2330 return insn;
2333 /* Perform various interesting optimizations for exception handling
2334 code.
2336 We look for empty exception regions and make them go (away). The
2337 jump optimization code will remove the handler if nothing else uses
2338 it. */
2340 void
2341 exception_optimize ()
2343 rtx insn;
2344 int n;
2346 /* Remove empty regions. */
2347 for (insn = get_insns (); insn; insn = NEXT_INSN (insn))
2349 if (GET_CODE (insn) == NOTE
2350 && NOTE_LINE_NUMBER (insn) == NOTE_INSN_EH_REGION_BEG)
2352 /* Since scan_region will return the NOTE_INSN_EH_REGION_END
2353 insn, we will indirectly skip through all the insns
2354 inbetween. We are also guaranteed that the value of insn
2355 returned will be valid, as otherwise scan_region won't
2356 return. */
2357 insn = scan_region (insn, NOTE_BLOCK_NUMBER (insn), &n);
2362 /* Various hooks for the DWARF 2 __throw routine. */
2364 /* Do any necessary initialization to access arbitrary stack frames.
2365 On the SPARC, this means flushing the register windows. */
2367 void
2368 expand_builtin_unwind_init ()
2370 /* Set this so all the registers get saved in our frame; we need to be
2371 able to copy the saved values for any registers from frames we unwind. */
2372 current_function_has_nonlocal_label = 1;
2374 #ifdef SETUP_FRAME_ADDRESSES
2375 SETUP_FRAME_ADDRESSES ();
2376 #endif
2379 /* Given a value extracted from the return address register or stack slot,
2380 return the actual address encoded in that value. */
2383 expand_builtin_extract_return_addr (addr_tree)
2384 tree addr_tree;
2386 rtx addr = expand_expr (addr_tree, NULL_RTX, Pmode, 0);
2387 return eh_outer_context (addr);
2390 /* Given an actual address in addr_tree, do any necessary encoding
2391 and return the value to be stored in the return address register or
2392 stack slot so the epilogue will return to that address. */
2395 expand_builtin_frob_return_addr (addr_tree)
2396 tree addr_tree;
2398 rtx addr = expand_expr (addr_tree, NULL_RTX, Pmode, 0);
2399 #ifdef RETURN_ADDR_OFFSET
2400 addr = plus_constant (addr, -RETURN_ADDR_OFFSET);
2401 #endif
2402 return addr;
2405 /* Given an actual address in addr_tree, set the return address register up
2406 so the epilogue will return to that address. If the return address is
2407 not in a register, do nothing. */
2409 void
2410 expand_builtin_set_return_addr_reg (addr_tree)
2411 tree addr_tree;
2413 rtx tmp;
2414 rtx ra = expand_builtin_return_addr (BUILT_IN_RETURN_ADDRESS,
2415 0, hard_frame_pointer_rtx);
2417 if (GET_CODE (ra) != REG || REGNO (ra) >= FIRST_PSEUDO_REGISTER)
2418 return;
2420 tmp = force_operand (expand_builtin_frob_return_addr (addr_tree), ra);
2421 if (tmp != ra)
2422 emit_move_insn (ra, tmp);
2425 /* Choose two registers for communication between the main body of
2426 __throw and the stub for adjusting the stack pointer. The first register
2427 is used to pass the address of the exception handler; the second register
2428 is used to pass the stack pointer offset.
2430 For register 1 we use the return value register for a void *.
2431 For register 2 we use the static chain register if it exists and is
2432 different from register 1, otherwise some arbitrary call-clobbered
2433 register. */
2435 static void
2436 eh_regs (r1, r2, outgoing)
2437 rtx *r1, *r2;
2438 int outgoing;
2440 rtx reg1, reg2;
2442 #ifdef FUNCTION_OUTGOING_VALUE
2443 if (outgoing)
2444 reg1 = FUNCTION_OUTGOING_VALUE (build_pointer_type (void_type_node),
2445 current_function_decl);
2446 else
2447 #endif
2448 reg1 = FUNCTION_VALUE (build_pointer_type (void_type_node),
2449 current_function_decl);
2451 #ifdef STATIC_CHAIN_REGNUM
2452 if (outgoing)
2453 reg2 = static_chain_incoming_rtx;
2454 else
2455 reg2 = static_chain_rtx;
2456 if (REGNO (reg2) == REGNO (reg1))
2457 #endif /* STATIC_CHAIN_REGNUM */
2458 reg2 = NULL_RTX;
2460 if (reg2 == NULL_RTX)
2462 int i;
2463 for (i = 0; i < FIRST_PSEUDO_REGISTER; ++i)
2464 if (call_used_regs[i] && ! fixed_regs[i] && i != REGNO (reg1))
2466 reg2 = gen_rtx_REG (Pmode, i);
2467 break;
2470 if (reg2 == NULL_RTX)
2471 abort ();
2474 *r1 = reg1;
2475 *r2 = reg2;
2479 /* Retrieve the register which contains the pointer to the eh_context
2480 structure set the __throw. */
2482 rtx
2483 get_reg_for_handler ()
2485 rtx reg1;
2486 reg1 = FUNCTION_VALUE (build_pointer_type (void_type_node),
2487 current_function_decl);
2488 return reg1;
2492 /* Emit inside of __throw a stub which adjusts the stack pointer and jumps
2493 to the exception handler. __throw will set up the necessary values
2494 and then return to the stub. */
2497 expand_builtin_eh_stub_old ()
2499 rtx stub_start = gen_label_rtx ();
2500 rtx after_stub = gen_label_rtx ();
2501 rtx handler, offset;
2503 emit_jump (after_stub);
2504 emit_label (stub_start);
2506 eh_regs (&handler, &offset, 0);
2508 adjust_stack (offset);
2509 emit_indirect_jump (handler);
2510 emit_label (after_stub);
2511 return gen_rtx_LABEL_REF (Pmode, stub_start);
2515 expand_builtin_eh_stub ()
2517 rtx stub_start = gen_label_rtx ();
2518 rtx after_stub = gen_label_rtx ();
2519 rtx handler, offset;
2520 rtx temp;
2522 emit_jump (after_stub);
2523 emit_label (stub_start);
2525 eh_regs (&handler, &offset, 0);
2527 adjust_stack (offset);
2529 /* Handler is in fact a pointer to the _eh_context structure, we need
2530 to pick out the handler field (first element), and jump to there,
2531 leaving the pointer to _eh_conext in the same hardware register. */
2533 temp = gen_rtx_MEM (Pmode, handler);
2534 MEM_IN_STRUCT_P (temp) = 1;
2535 RTX_UNCHANGING_P (temp) = 1;
2536 emit_move_insn (offset, temp);
2537 emit_insn (gen_rtx_USE (Pmode, handler));
2539 emit_indirect_jump (offset);
2541 emit_label (after_stub);
2542 return gen_rtx_LABEL_REF (Pmode, stub_start);
2545 /* Set up the registers for passing the handler address and stack offset
2546 to the stub above. */
2548 void
2549 expand_builtin_set_eh_regs (handler, offset)
2550 tree handler, offset;
2552 rtx reg1, reg2;
2554 eh_regs (&reg1, &reg2, 1);
2556 store_expr (offset, reg2, 0);
2557 store_expr (handler, reg1, 0);
2559 /* These will be used by the stub. */
2560 emit_insn (gen_rtx_USE (VOIDmode, reg1));
2561 emit_insn (gen_rtx_USE (VOIDmode, reg2));
2566 /* This contains the code required to verify whether arbitrary instructions
2567 are in the same exception region. */
2569 static int *insn_eh_region = (int *)0;
2570 static int maximum_uid;
2572 static void
2573 set_insn_eh_region (first, region_num)
2574 rtx *first;
2575 int region_num;
2577 rtx insn;
2578 int rnum;
2580 for (insn = *first; insn; insn = NEXT_INSN (insn))
2582 if ((GET_CODE (insn) == NOTE) &&
2583 (NOTE_LINE_NUMBER (insn) == NOTE_INSN_EH_REGION_BEG))
2585 rnum = NOTE_BLOCK_NUMBER (insn);
2586 insn_eh_region[INSN_UID (insn)] = rnum;
2587 insn = NEXT_INSN (insn);
2588 set_insn_eh_region (&insn, rnum);
2589 /* Upon return, insn points to the EH_REGION_END of nested region */
2590 continue;
2592 insn_eh_region[INSN_UID (insn)] = region_num;
2593 if ((GET_CODE (insn) == NOTE) &&
2594 (NOTE_LINE_NUMBER (insn) == NOTE_INSN_EH_REGION_END))
2595 break;
2597 *first = insn;
2600 /* Free the insn table, an make sure it cannot be used again. */
2602 void
2603 free_insn_eh_region ()
2605 if (!doing_eh (0))
2606 return;
2608 if (insn_eh_region)
2610 free (insn_eh_region);
2611 insn_eh_region = (int *)0;
2615 /* Initialize the table. max_uid must be calculated and handed into
2616 this routine. If it is unavailable, passing a value of 0 will
2617 cause this routine to calculate it as well. */
2619 void
2620 init_insn_eh_region (first, max_uid)
2621 rtx first;
2622 int max_uid;
2624 rtx insn;
2626 if (!doing_eh (0))
2627 return;
2629 if (insn_eh_region)
2630 free_insn_eh_region();
2632 if (max_uid == 0)
2633 for (insn = first; insn; insn = NEXT_INSN (insn))
2634 if (INSN_UID (insn) > max_uid) /* find largest UID */
2635 max_uid = INSN_UID (insn);
2637 maximum_uid = max_uid;
2638 insn_eh_region = (int *) malloc ((max_uid + 1) * sizeof (int));
2639 insn = first;
2640 set_insn_eh_region (&insn, 0);
2644 /* Check whether 2 instructions are within the same region. */
2646 int
2647 in_same_eh_region (insn1, insn2)
2648 rtx insn1, insn2;
2650 int ret, uid1, uid2;
2652 /* If no exceptions, instructions are always in same region. */
2653 if (!doing_eh (0))
2654 return 1;
2656 /* If the table isn't allocated, assume the worst. */
2657 if (!insn_eh_region)
2658 return 0;
2660 uid1 = INSN_UID (insn1);
2661 uid2 = INSN_UID (insn2);
2663 /* if instructions have been allocated beyond the end, either
2664 the table is out of date, or this is a late addition, or
2665 something... Assume the worst. */
2666 if (uid1 > maximum_uid || uid2 > maximum_uid)
2667 return 0;
2669 ret = (insn_eh_region[uid1] == insn_eh_region[uid2]);
2670 return ret;