gcse.c (do_local_cprop): Do not extend lifetimes of registers set by do_local_cprop.
[official-gcc.git] / gcc / crtstuff.c
blob041c810f6f453d197e6d764e14619ac78f8eae9f
1 /* Specialized bits of code needed to support construction and
2 destruction of file-scope objects in C++ code.
3 Copyright (C) 1991, 1994, 1995, 1996, 1997, 1998,
4 1999, 2000, 2001, 2002 Free Software Foundation, Inc.
5 Contributed by Ron Guilmette (rfg@monkeys.com).
7 This file is part of GCC.
9 GCC is free software; you can redistribute it and/or modify it under
10 the terms of the GNU General Public License as published by the Free
11 Software Foundation; either version 2, or (at your option) any later
12 version.
14 In addition to the permissions in the GNU General Public License, the
15 Free Software Foundation gives you unlimited permission to link the
16 compiled version of this file into combinations with other programs,
17 and to distribute those combinations without any restriction coming
18 from the use of this file. (The General Public License restrictions
19 do apply in other respects; for example, they cover modification of
20 the file, and distribution when not linked into a combine
21 executable.)
23 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
24 WARRANTY; without even the implied warranty of MERCHANTABILITY or
25 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
26 for more details.
28 You should have received a copy of the GNU General Public License
29 along with GCC; see the file COPYING. If not, write to the Free
30 Software Foundation, 59 Temple Place - Suite 330, Boston, MA
31 02111-1307, USA. */
33 /* This file is a bit like libgcc2.c in that it is compiled
34 multiple times and yields multiple .o files.
36 This file is useful on target machines where the object file format
37 supports multiple "user-defined" sections (e.g. COFF, ELF, ROSE). On
38 such systems, this file allows us to avoid running collect (or any
39 other such slow and painful kludge). Additionally, if the target
40 system supports a .init section, this file allows us to support the
41 linking of C++ code with a non-C++ main program.
43 Note that if INIT_SECTION_ASM_OP is defined in the tm.h file, then
44 this file *will* make use of the .init section. If that symbol is
45 not defined however, then the .init section will not be used.
47 Currently, only ELF and COFF are supported. It is likely however that
48 ROSE could also be supported, if someone was willing to do the work to
49 make whatever (small?) adaptations are needed. (Some work may be
50 needed on the ROSE assembler and linker also.)
52 This file must be compiled with gcc. */
54 /* It is incorrect to include config.h here, because this file is being
55 compiled for the target, and hence definitions concerning only the host
56 do not apply. */
58 /* We include auto-host.h here to get HAVE_GAS_HIDDEN. This is
59 supposedly valid even though this is a "target" file. */
60 #include "auto-host.h"
61 #include "tconfig.h"
62 #include "tsystem.h"
63 #include "unwind-dw2-fde.h"
65 #ifndef FORCE_CODE_SECTION_ALIGN
66 # define FORCE_CODE_SECTION_ALIGN
67 #endif
69 #ifndef CRT_CALL_STATIC_FUNCTION
70 # define CRT_CALL_STATIC_FUNCTION(SECTION_OP, FUNC) \
71 static void __attribute__((__used__)) \
72 call_ ## FUNC (void) \
73 { \
74 asm (SECTION_OP); \
75 FUNC (); \
76 FORCE_CODE_SECTION_ALIGN \
77 asm (TEXT_SECTION_ASM_OP); \
79 #endif
81 #if defined(OBJECT_FORMAT_ELF) && defined(HAVE_LD_EH_FRAME_HDR) \
82 && !defined(inhibit_libc) && !defined(CRTSTUFFT_O) \
83 && defined(__GLIBC__) && __GLIBC__ >= 2
84 #include <link.h>
85 # if (__GLIBC__ > 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ > 2) \
86 || (__GLIBC__ == 2 && __GLIBC_MINOR__ == 2 && defined(DT_CONFIG)))
87 # define USE_PT_GNU_EH_FRAME
88 # endif
89 #endif
90 #if defined(EH_FRAME_SECTION_NAME) && !defined(USE_PT_GNU_EH_FRAME)
91 # define USE_EH_FRAME_REGISTRY
92 #endif
94 /* We do not want to add the weak attribute to the declarations of these
95 routines in unwind-dw2-fde.h because that will cause the definition of
96 these symbols to be weak as well.
98 This exposes a core issue, how to handle creating weak references vs
99 how to create weak definitions. Either we have to have the definition
100 of TARGET_WEAK_ATTRIBUTE be conditional in the shared header files or
101 have a second declaration if we want a function's references to be weak,
102 but not its definition.
104 Making TARGET_WEAK_ATTRIBUTE conditional seems like a good solution until
105 one thinks about scaling to larger problems -- ie, the condition under
106 which TARGET_WEAK_ATTRIBUTE is active will eventually get far too
107 complicated.
109 So, we take an approach similar to #pragma weak -- we have a second
110 declaration for functions that we want to have weak references.
112 Neither way is particularly good. */
114 /* References to __register_frame_info and __deregister_frame_info should
115 be weak in this file if at all possible. */
116 extern void __register_frame_info (void *, struct object *)
117 TARGET_ATTRIBUTE_WEAK;
118 extern void __register_frame_info_bases (void *, struct object *,
119 void *, void *)
120 TARGET_ATTRIBUTE_WEAK;
121 extern void *__deregister_frame_info (void *)
122 TARGET_ATTRIBUTE_WEAK;
123 extern void *__deregister_frame_info_bases (void *)
124 TARGET_ATTRIBUTE_WEAK;
126 /* Likewise for _Jv_RegisterClasses. */
127 extern void _Jv_RegisterClasses (void *) TARGET_ATTRIBUTE_WEAK;
129 #ifndef OBJECT_FORMAT_MACHO
131 #ifdef OBJECT_FORMAT_ELF
133 /* Declare a pointer to void function type. */
134 typedef void (*func_ptr) (void);
135 #define STATIC static
137 #else /* OBJECT_FORMAT_ELF */
139 #include "gbl-ctors.h"
141 #define STATIC
143 #endif /* OBJECT_FORMAT_ELF */
145 #ifdef CRT_BEGIN
147 /* NOTE: In order to be able to support SVR4 shared libraries, we arrange
148 to have one set of symbols { __CTOR_LIST__, __DTOR_LIST__, __CTOR_END__,
149 __DTOR_END__ } per root executable and also one set of these symbols
150 per shared library. So in any given whole process image, we may have
151 multiple definitions of each of these symbols. In order to prevent
152 these definitions from conflicting with one another, and in order to
153 ensure that the proper lists are used for the initialization/finalization
154 of each individual shared library (respectively), we give these symbols
155 only internal (i.e. `static') linkage, and we also make it a point to
156 refer to only the __CTOR_END__ symbol in crtend.o and the __DTOR_LIST__
157 symbol in crtbegin.o, where they are defined. */
159 /* The -1 is a flag to __do_global_[cd]tors indicating that this table
160 does not start with a count of elements. */
161 #ifdef CTOR_LIST_BEGIN
162 CTOR_LIST_BEGIN;
163 #elif defined(CTORS_SECTION_ASM_OP)
164 /* Hack: force cc1 to switch to .data section early, so that assembling
165 __CTOR_LIST__ does not undo our behind-the-back change to .ctors. */
166 static func_ptr force_to_data[1] __attribute__ ((__unused__)) = { };
167 asm (CTORS_SECTION_ASM_OP);
168 STATIC func_ptr __CTOR_LIST__[1]
169 __attribute__ ((__unused__, aligned(sizeof(func_ptr))))
170 = { (func_ptr) (-1) };
171 #else
172 STATIC func_ptr __CTOR_LIST__[1]
173 __attribute__ ((__unused__, section(".ctors"), aligned(sizeof(func_ptr))))
174 = { (func_ptr) (-1) };
175 #endif /* __CTOR_LIST__ alternatives */
177 #ifdef DTOR_LIST_BEGIN
178 DTOR_LIST_BEGIN;
179 #elif defined(DTORS_SECTION_ASM_OP)
180 asm (DTORS_SECTION_ASM_OP);
181 STATIC func_ptr __DTOR_LIST__[1]
182 __attribute__ ((aligned(sizeof(func_ptr))))
183 = { (func_ptr) (-1) };
184 #else
185 STATIC func_ptr __DTOR_LIST__[1]
186 __attribute__((section(".dtors"), aligned(sizeof(func_ptr))))
187 = { (func_ptr) (-1) };
188 #endif /* __DTOR_LIST__ alternatives */
190 #ifdef USE_EH_FRAME_REGISTRY
191 /* Stick a label at the beginning of the frame unwind info so we can register
192 and deregister it with the exception handling library code. */
193 STATIC char __EH_FRAME_BEGIN__[]
194 __attribute__((section(EH_FRAME_SECTION_NAME), aligned(4)))
195 = { };
196 #endif /* USE_EH_FRAME_REGISTRY */
198 #ifdef JCR_SECTION_NAME
199 /* Stick a label at the beginning of the java class registration info
200 so we can register them properly. */
201 STATIC void *__JCR_LIST__[]
202 __attribute__ ((unused, section(JCR_SECTION_NAME), aligned(sizeof(void*))))
203 = { };
204 #endif /* JCR_SECTION_NAME */
206 #ifdef INIT_SECTION_ASM_OP
208 #ifdef OBJECT_FORMAT_ELF
210 /* Declare the __dso_handle variable. It should have a unique value
211 in every shared-object; in a main program its value is zero. The
212 object should in any case be protected. This means the instance
213 in one DSO or the main program is not used in another object. The
214 dynamic linker takes care of this. */
216 #ifdef HAVE_GAS_HIDDEN
217 extern void *__dso_handle __attribute__ ((__visibility__ ("hidden")));
218 #endif
219 #ifdef CRTSTUFFS_O
220 void *__dso_handle = &__dso_handle;
221 #else
222 void *__dso_handle = 0;
223 #endif
225 /* The __cxa_finalize function may not be available so we use only a
226 weak declaration. */
227 extern void __cxa_finalize (void *) TARGET_ATTRIBUTE_WEAK;
229 /* Run all the global destructors on exit from the program. */
231 /* Some systems place the number of pointers in the first word of the
232 table. On SVR4 however, that word is -1. In all cases, the table is
233 null-terminated. On SVR4, we start from the beginning of the list and
234 invoke each per-compilation-unit destructor routine in order
235 until we find that null.
237 Note that this function MUST be static. There will be one of these
238 functions in each root executable and one in each shared library, but
239 although they all have the same code, each one is unique in that it
240 refers to one particular associated `__DTOR_LIST__' which belongs to the
241 same particular root executable or shared library file.
243 On some systems, this routine is run more than once from the .fini,
244 when exit is called recursively, so we arrange to remember where in
245 the list we left off processing, and we resume at that point,
246 should we be re-invoked. */
248 static void __attribute__((used))
249 __do_global_dtors_aux (void)
251 static func_ptr *p = __DTOR_LIST__ + 1;
252 static _Bool completed;
253 func_ptr f;
255 if (__builtin_expect (completed, 0))
256 return;
258 #ifdef CRTSTUFFS_O
259 if (__cxa_finalize)
260 __cxa_finalize (__dso_handle);
261 #endif
263 while ((f = *p))
265 p++;
266 f ();
269 #ifdef USE_EH_FRAME_REGISTRY
270 #if defined(CRT_GET_RFIB_TEXT) || defined(CRT_GET_RFIB_DATA)
271 /* If we used the new __register_frame_info_bases interface,
272 make sure that we deregister from the same place. */
273 if (__deregister_frame_info_bases)
274 __deregister_frame_info_bases (__EH_FRAME_BEGIN__);
275 #else
276 if (__deregister_frame_info)
277 __deregister_frame_info (__EH_FRAME_BEGIN__);
278 #endif
279 #endif
281 completed = 1;
284 /* Stick a call to __do_global_dtors_aux into the .fini section. */
285 CRT_CALL_STATIC_FUNCTION (FINI_SECTION_ASM_OP, __do_global_dtors_aux)
287 #if defined(USE_EH_FRAME_REGISTRY) || defined(JCR_SECTION_NAME)
288 /* Stick a call to __register_frame_info into the .init section. For some
289 reason calls with no arguments work more reliably in .init, so stick the
290 call in another function. */
292 static void __attribute__((used))
293 frame_dummy (void)
295 #ifdef USE_EH_FRAME_REGISTRY
296 static struct object object;
297 #if defined(CRT_GET_RFIB_TEXT) || defined(CRT_GET_RFIB_DATA)
298 void *tbase, *dbase;
299 #ifdef CRT_GET_RFIB_TEXT
300 CRT_GET_RFIB_TEXT (tbase);
301 #else
302 tbase = 0;
303 #endif
304 #ifdef CRT_GET_RFIB_DATA
305 CRT_GET_RFIB_DATA (dbase);
306 #else
307 dbase = 0;
308 #endif
309 if (__register_frame_info_bases)
310 __register_frame_info_bases (__EH_FRAME_BEGIN__, &object, tbase, dbase);
311 #else
312 if (__register_frame_info)
313 __register_frame_info (__EH_FRAME_BEGIN__, &object);
314 #endif
315 #endif /* USE_EH_FRAME_REGISTRY */
316 #ifdef JCR_SECTION_NAME
317 if (__JCR_LIST__[0] && _Jv_RegisterClasses)
318 _Jv_RegisterClasses (__JCR_LIST__);
319 #endif /* JCR_SECTION_NAME */
322 CRT_CALL_STATIC_FUNCTION (INIT_SECTION_ASM_OP, frame_dummy)
323 #endif /* USE_EH_FRAME_REGISTRY || JCR_SECTION_NAME */
325 #else /* OBJECT_FORMAT_ELF */
327 /* The function __do_global_ctors_aux is compiled twice (once in crtbegin.o
328 and once in crtend.o). It must be declared static to avoid a link
329 error. Here, we define __do_global_ctors as an externally callable
330 function. It is externally callable so that __main can invoke it when
331 INVOKE__main is defined. This has the additional effect of forcing cc1
332 to switch to the .text section. */
334 static void __do_global_ctors_aux (void);
335 void
336 __do_global_ctors (void)
338 #ifdef INVOKE__main
339 /* If __main won't actually call __do_global_ctors then it doesn't matter
340 what's inside the function. The inside of __do_global_ctors_aux is
341 called automatically in that case. And the Alliant fx2800 linker
342 crashes on this reference. So prevent the crash. */
343 __do_global_ctors_aux ();
344 #endif
347 asm (INIT_SECTION_ASM_OP); /* cc1 doesn't know that we are switching! */
349 /* On some svr4 systems, the initial .init section preamble code provided in
350 crti.o may do something, such as bump the stack, which we have to
351 undo before we reach the function prologue code for __do_global_ctors
352 (directly below). For such systems, define the macro INIT_SECTION_PREAMBLE
353 to expand into the code needed to undo the actions of the crti.o file. */
355 #ifdef INIT_SECTION_PREAMBLE
356 INIT_SECTION_PREAMBLE;
357 #endif
359 /* A routine to invoke all of the global constructors upon entry to the
360 program. We put this into the .init section (for systems that have
361 such a thing) so that we can properly perform the construction of
362 file-scope static-storage C++ objects within shared libraries. */
364 static void __attribute__((used))
365 __do_global_ctors_aux (void) /* prologue goes in .init section */
367 FORCE_CODE_SECTION_ALIGN /* explicit align before switch to .text */
368 asm (TEXT_SECTION_ASM_OP); /* don't put epilogue and body in .init */
369 DO_GLOBAL_CTORS_BODY;
370 atexit (__do_global_dtors);
373 #endif /* OBJECT_FORMAT_ELF */
375 #elif defined(HAS_INIT_SECTION) /* ! INIT_SECTION_ASM_OP */
377 /* This case is used by the Irix 6 port, which supports named sections but
378 not an SVR4-style .fini section. __do_global_dtors can be non-static
379 in this case because we protect it with -hidden_symbol. */
381 void
382 __do_global_dtors (void)
384 func_ptr *p, f;
385 for (p = __DTOR_LIST__ + 1; (f = *p); p++)
386 f ();
388 #ifdef USE_EH_FRAME_REGISTRY
389 if (__deregister_frame_info)
390 __deregister_frame_info (__EH_FRAME_BEGIN__);
391 #endif
394 #if defined(USE_EH_FRAME_REGISTRY) || defined(JCR_SECTION_NAME)
395 /* A helper function for __do_global_ctors, which is in crtend.o. Here
396 in crtbegin.o, we can reference a couple of symbols not visible there.
397 Plus, since we're before libgcc.a, we have no problems referencing
398 functions from there. */
399 void
400 __do_global_ctors_1(void)
402 #ifdef USE_EH_FRAME_REGISTRY
403 static struct object object;
404 if (__register_frame_info)
405 __register_frame_info (__EH_FRAME_BEGIN__, &object);
406 #endif
407 #ifdef JCR_SECTION_NAME
408 if (__JCR_LIST__[0] && _Jv_RegisterClasses)
409 _Jv_RegisterClasses (__JCR_LIST__);
410 #endif
412 #endif /* USE_EH_FRAME_REGISTRY || JCR_SECTION_NAME */
414 #else /* ! INIT_SECTION_ASM_OP && ! HAS_INIT_SECTION */
415 #error "What are you doing with crtstuff.c, then?"
416 #endif
418 #elif defined(CRT_END) /* ! CRT_BEGIN */
420 /* Put a word containing zero at the end of each of our two lists of function
421 addresses. Note that the words defined here go into the .ctors and .dtors
422 sections of the crtend.o file, and since that file is always linked in
423 last, these words naturally end up at the very ends of the two lists
424 contained in these two sections. */
426 #ifdef CTOR_LIST_END
427 CTOR_LIST_END;
428 #elif defined(CTORS_SECTION_ASM_OP)
429 /* Hack: force cc1 to switch to .data section early, so that assembling
430 __CTOR_LIST__ does not undo our behind-the-back change to .ctors. */
431 static func_ptr force_to_data[1] __attribute__ ((__unused__)) = { };
432 asm (CTORS_SECTION_ASM_OP);
433 STATIC func_ptr __CTOR_END__[1]
434 __attribute__((aligned(sizeof(func_ptr))))
435 = { (func_ptr) 0 };
436 #else
437 STATIC func_ptr __CTOR_END__[1]
438 __attribute__((section(".ctors"), aligned(sizeof(func_ptr))))
439 = { (func_ptr) 0 };
440 #endif
442 #ifdef DTOR_LIST_END
443 DTOR_LIST_END;
444 #elif defined(DTORS_SECTION_ASM_OP)
445 asm (DTORS_SECTION_ASM_OP);
446 STATIC func_ptr __DTOR_END__[1]
447 __attribute__ ((unused, aligned(sizeof(func_ptr))))
448 = { (func_ptr) 0 };
449 #else
450 STATIC func_ptr __DTOR_END__[1]
451 __attribute__((unused, section(".dtors"), aligned(sizeof(func_ptr))))
452 = { (func_ptr) 0 };
453 #endif
455 #ifdef EH_FRAME_SECTION_NAME
456 /* Terminate the frame unwind info section with a 4byte 0 as a sentinel;
457 this would be the 'length' field in a real FDE. */
458 STATIC int __FRAME_END__[]
459 __attribute__ ((unused, mode(SI), section(EH_FRAME_SECTION_NAME),
460 aligned(4)))
461 = { 0 };
462 #endif /* EH_FRAME_SECTION_NAME */
464 #ifdef JCR_SECTION_NAME
465 /* Null terminate the .jcr section array. */
466 STATIC void *__JCR_END__[1]
467 __attribute__ ((unused, section(JCR_SECTION_NAME),
468 aligned(sizeof(void *))))
469 = { 0 };
470 #endif /* JCR_SECTION_NAME */
472 #ifdef INIT_SECTION_ASM_OP
474 #ifdef OBJECT_FORMAT_ELF
475 static void __attribute__((used))
476 __do_global_ctors_aux (void)
478 func_ptr *p;
479 for (p = __CTOR_END__ - 1; *p != (func_ptr) -1; p--)
480 (*p) ();
483 /* Stick a call to __do_global_ctors_aux into the .init section. */
484 CRT_CALL_STATIC_FUNCTION (INIT_SECTION_ASM_OP, __do_global_ctors_aux)
485 #else /* OBJECT_FORMAT_ELF */
487 /* Stick the real initialization code, followed by a normal sort of
488 function epilogue at the very end of the .init section for this
489 entire root executable file or for this entire shared library file.
491 Note that we use some tricks here to get *just* the body and just
492 a function epilogue (but no function prologue) into the .init
493 section of the crtend.o file. Specifically, we switch to the .text
494 section, start to define a function, and then we switch to the .init
495 section just before the body code.
497 Earlier on, we put the corresponding function prologue into the .init
498 section of the crtbegin.o file (which will be linked in first).
500 Note that we want to invoke all constructors for C++ file-scope static-
501 storage objects AFTER any other possible initialization actions which
502 may be performed by the code in the .init section contributions made by
503 other libraries, etc. That's because those other initializations may
504 include setup operations for very primitive things (e.g. initializing
505 the state of the floating-point coprocessor, etc.) which should be done
506 before we start to execute any of the user's code. */
508 static void
509 __do_global_ctors_aux (void) /* prologue goes in .text section */
511 asm (INIT_SECTION_ASM_OP);
512 DO_GLOBAL_CTORS_BODY;
513 atexit (__do_global_dtors);
514 } /* epilogue and body go in .init section */
516 FORCE_CODE_SECTION_ALIGN
517 asm (TEXT_SECTION_ASM_OP);
519 #endif /* OBJECT_FORMAT_ELF */
521 #elif defined(HAS_INIT_SECTION) /* ! INIT_SECTION_ASM_OP */
523 /* This case is used by the Irix 6 port, which supports named sections but
524 not an SVR4-style .init section. __do_global_ctors can be non-static
525 in this case because we protect it with -hidden_symbol. */
526 extern void __do_global_ctors_1(void);
527 void
528 __do_global_ctors (void)
530 func_ptr *p;
531 #if defined(USE_EH_FRAME_REGISTRY) || defined(JCR_SECTION_NAME)
532 __do_global_ctors_1();
533 #endif
534 for (p = __CTOR_END__ - 1; *p != (func_ptr) -1; p--)
535 (*p) ();
538 #else /* ! INIT_SECTION_ASM_OP && ! HAS_INIT_SECTION */
539 #error "What are you doing with crtstuff.c, then?"
540 #endif
542 #else /* ! CRT_BEGIN && ! CRT_END */
543 #error "One of CRT_BEGIN or CRT_END must be defined."
544 #endif
546 #else /* OBJECT_FORMAT_MACHO */
548 /* For Mach-O format executables, we assume that the system's runtime is
549 smart enough to handle constructors and destructors, but doesn't have
550 an init section (if it can't even handle constructors/destructors
551 you should be using INVOKE__main, not crtstuff). All we need to do
552 is install/deinstall the frame information for exceptions. We do this
553 by putting a constructor in crtbegin.o and a destructor in crtend.o.
555 crtend.o also puts in the terminating zero in the frame information
556 segment. */
558 /* The crtstuff for other object formats use the symbol __EH_FRAME_BEGIN__
559 to figure out the start of the exception frame, but here we use
560 getsectbynamefromheader to find this value. Either method would work,
561 but this method avoids creating any global symbols, which seems
562 cleaner. */
564 #include <mach-o/ldsyms.h>
565 extern const struct section *
566 getsectbynamefromheader (const struct mach_header *,
567 const char *, const char *);
569 #ifdef CRT_BEGIN
571 static void __reg_frame_ctor (void) __attribute__ ((constructor));
573 static void
574 __reg_frame_ctor (void)
576 static struct object object;
577 const struct section *eh_frame;
579 eh_frame = getsectbynamefromheader (&_mh_execute_header,
580 "__TEXT", "__eh_frame");
581 __register_frame_info ((void *) eh_frame->addr, &object);
584 #elif defined(CRT_END)
586 static void __dereg_frame_dtor (void) __attribute__ ((destructor));
588 static void
589 __dereg_frame_dtor (void)
591 const struct section *eh_frame;
593 eh_frame = getsectbynamefromheader (&_mh_execute_header,
594 "__TEXT", "__eh_frame");
595 __deregister_frame_info ((void *) eh_frame->addr);
598 /* Terminate the frame section with a final zero. */
599 STATIC int __FRAME_END__[]
600 __attribute__ ((unused, mode(SI), section(EH_FRAME_SECTION_NAME),
601 aligned(4)))
602 = { 0 };
604 #else /* ! CRT_BEGIN && ! CRT_END */
605 #error "One of CRT_BEGIN or CRT_END must be defined."
606 #endif
608 #endif /* OBJECT_FORMAT_MACHO */