gcc/crtstuff.c

   1 /* Specialized bits of code needed to support construction and
   2    destruction of file-scope objects in C++ code.
   3    Copyright (C) 1991, 1994-1999 Free Software Foundation, Inc.
   4    Contributed by Ron Guilmette (rfg@monkeys.com).
   5
   6 This file is part of GNU CC.
   7
   8 GNU CC is free software; you can redistribute it and/or modify
   9 it under the terms of the GNU General Public License as published by
  10 the Free Software Foundation; either version 2, or (at your option)
  11 any later version.
  12
  13 GNU CC is distributed in the hope that it will be useful,
  14 but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 GNU General Public License for more details.
  17
  18 You should have received a copy of the GNU General Public License
  19 along with GNU CC; see the file COPYING.  If not, write to
  20 the Free Software Foundation, 59 Temple Place - Suite 330,
  21 Boston, MA 02111-1307, USA.  */
  22
  23 /* As a special exception, if you link this library with files
  24    compiled with GCC to produce an executable, this does not cause
  25    the resulting executable to be covered by the GNU General Public License.
  26    This exception does not however invalidate any other reasons why
  27    the executable file might be covered by the GNU General Public License.  */
  28
  29 /* This file is a bit like libgcc1.c/libgcc2.c in that it is compiled
  30    multiple times and yields multiple .o files.
  31
  32    This file is useful on target machines where the object file format
  33    supports multiple "user-defined" sections (e.g. COFF, ELF, ROSE).  On
  34    such systems, this file allows us to avoid running collect (or any
  35    other such slow and painful kludge).  Additionally, if the target
  36    system supports a .init section, this file allows us to support the
  37    linking of C++ code with a non-C++ main program.
  38
  39    Note that if INIT_SECTION_ASM_OP is defined in the tm.h file, then
  40    this file *will* make use of the .init section.  If that symbol is
  41    not defined however, then the .init section will not be used.
  42
  43    Currently, only ELF and COFF are supported.  It is likely however that
  44    ROSE could also be supported, if someone was willing to do the work to
  45    make whatever (small?) adaptations are needed.  (Some work may be
  46    needed on the ROSE assembler and linker also.)
  47
  48    This file must be compiled with gcc.  */
  49
  50 /* It is incorrect to include config.h here, because this file is being
  51    compiled for the target, and hence definitions concerning only the host
  52    do not apply.  */
  53
  54 #include "tm.h"
  55 #include "defaults.h"
  56 #include <stddef.h>
  57 #include "frame.h"
  58
  59 /* We do not want to add the weak attribute to the declarations of these
  60    routines in frame.h because that will cause the definition of these
  61    symbols to be weak as well.
  62
  63    This exposes a core issue, how to handle creating weak references vs
  64    how to create weak definitions.  Either we have to have the definition
  65    of TARGET_WEAK_ATTRIBUTE be conditional in the shared header files or
  66    have a second declaration if we want a function's references to be weak,
  67    but not its definition.
  68
  69    Making TARGET_WEAK_ATTRIBUTE conditional seems like a good solution until
  70    one thinks about scaling to larger problems -- ie, the condition under
  71    which TARGET_WEAK_ATTRIBUTE is active will eventually get far too
  72    complicated.
  73
  74    So, we take an approach similar to #pragma weak -- we have a second
  75    declaration for functions that we want to have weak references.
  76
  77    Neither way is particularly good.  */
  78
  79 /* References to __register_frame_info and __deregister_frame_info should
  80    be weak in this file if at all possible.  */
  81 extern void __register_frame_info (void *, struct object *)
  82                                   TARGET_ATTRIBUTE_WEAK;
  83
  84 extern void *__deregister_frame_info (void *)
  85                                      TARGET_ATTRIBUTE_WEAK;
  86
  87 #ifndef OBJECT_FORMAT_MACHO
  88
  89 /* Provide default definitions for the pseudo-ops used to switch to the
  90    .ctors and .dtors sections.
  91
  92    Note that we want to give these sections the SHF_WRITE attribute
  93    because these sections will actually contain data (i.e. tables of
  94    addresses of functions in the current root executable or shared library
  95    file) and, in the case of a shared library, the relocatable addresses
  96    will have to be properly resolved/relocated (and then written into) by
  97    the dynamic linker when it actually attaches the given shared library
  98    to the executing process.  (Note that on SVR4, you may wish to use the
  99    `-z text' option to the ELF linker, when building a shared library, as
 100    an additional check that you are doing everything right.  But if you do
 101    use the `-z text' option when building a shared library, you will get
 102    errors unless the .ctors and .dtors sections are marked as writable
 103    via the SHF_WRITE attribute.)  */
 104
 105 #ifndef CTORS_SECTION_ASM_OP
 106 #define CTORS_SECTION_ASM_OP    ".section\t.ctors,\"aw\""
 107 #endif
 108 #ifndef DTORS_SECTION_ASM_OP
 109 #define DTORS_SECTION_ASM_OP    ".section\t.dtors,\"aw\""
 110 #endif
 111
 112 #ifdef OBJECT_FORMAT_ELF
 113
 114 /*  Declare a pointer to void function type.  */
 115 typedef void (*func_ptr) (void);
 116 #define STATIC static
 117
 118 #else  /* OBJECT_FORMAT_ELF */
 119
 120 #include "gbl-ctors.h"
 121
 122 #define STATIC
 123
 124 #endif /* OBJECT_FORMAT_ELF */
 125
 126 #ifdef CRT_BEGIN
 127
 128 #ifdef INIT_SECTION_ASM_OP
 129
 130 #ifdef OBJECT_FORMAT_ELF
 131
 132 /* Declare the __dso_handle variable.  It should have a unique value
 133    in every shared-object; in a main program its value is zero.  */
 134
 135 #ifdef CRTSTUFFS_O
 136 void *__dso_handle = &__dso_handle;
 137 #else
 138 void *__dso_handle = 0;
 139 #endif
 140
 141 /* The __cxa_finalize function may not be available so we use only a
 142    weak declaration.  */
 143 extern void __cxa_finalize (void *) TARGET_ATTRIBUTE_WEAK;
 144
 145 /* Run all the global destructors on exit from the program.  */
 146
 147 /* Some systems place the number of pointers in the first word of the
 148    table.  On SVR4 however, that word is -1.  In all cases, the table is
 149    null-terminated.  On SVR4, we start from the beginning of the list and
 150    invoke each per-compilation-unit destructor routine in order
 151    until we find that null.
 152
 153    Note that this function MUST be static.  There will be one of these
 154    functions in each root executable and one in each shared library, but
 155    although they all have the same code, each one is unique in that it
 156    refers to one particular associated `__DTOR_LIST__' which belongs to the
 157    same particular root executable or shared library file.
 158
 159    On some systems, this routine is run more than once from the .fini,
 160    when exit is called recursively, so we arrange to remember where in
 161    the list we left off processing, and we resume at that point,
 162    should we be re-invoked.  */
 163
 164 static char __EH_FRAME_BEGIN__[];
 165 static func_ptr __DTOR_LIST__[];
 166 static void
 167 __do_global_dtors_aux (void)
 168 {
 169   static func_ptr *p = __DTOR_LIST__ + 1;
 170   static int completed = 0;
 171
 172   if (completed)
 173     return;
 174
 175   if (__dso_handle && __cxa_finalize)
 176     __cxa_finalize (__dso_handle);
 177
 178   while (*p)
 179     {
 180       p++;
 181       (*(p-1)) ();
 182     }
 183
 184 #ifdef EH_FRAME_SECTION_ASM_OP
 185   if (__deregister_frame_info)
 186     __deregister_frame_info (__EH_FRAME_BEGIN__);
 187 #endif
 188   completed = 1;
 189 }
 190
 191
 192 /* Stick a call to __do_global_dtors_aux into the .fini section.  */
 193
 194 static void __attribute__ ((__unused__))
 195 fini_dummy (void)
 196 {
 197   asm (FINI_SECTION_ASM_OP);
 198   __do_global_dtors_aux ();
 199 #ifdef FORCE_FINI_SECTION_ALIGN
 200   FORCE_FINI_SECTION_ALIGN;
 201 #endif
 202   asm (TEXT_SECTION_ASM_OP);
 203 }
 204
 205 #ifdef EH_FRAME_SECTION_ASM_OP
 206 /* Stick a call to __register_frame_info into the .init section.  For some
 207    reason calls with no arguments work more reliably in .init, so stick the
 208    call in another function.  */
 209
 210 static void
 211 frame_dummy (void)
 212 {
 213   static struct object object;
 214   if (__register_frame_info)
 215     __register_frame_info (__EH_FRAME_BEGIN__, &object);
 216 }
 217
 218 static void __attribute__ ((__unused__))
 219 init_dummy (void)
 220 {
 221   asm (INIT_SECTION_ASM_OP);
 222   frame_dummy ();
 223 #ifdef FORCE_INIT_SECTION_ALIGN
 224   FORCE_INIT_SECTION_ALIGN;
 225 #endif
 226   asm (TEXT_SECTION_ASM_OP);
 227 }
 228 #endif /* EH_FRAME_SECTION_ASM_OP */
 229
 230 #else  /* OBJECT_FORMAT_ELF */
 231
 232 /* The function __do_global_ctors_aux is compiled twice (once in crtbegin.o
 233    and once in crtend.o).  It must be declared static to avoid a link
 234    error.  Here, we define __do_global_ctors as an externally callable
 235    function.  It is externally callable so that __main can invoke it when
 236    INVOKE__main is defined.  This has the additional effect of forcing cc1
 237    to switch to the .text section.  */
 238
 239 static void __do_global_ctors_aux ();
 240 void
 241 __do_global_ctors (void)
 242 {
 243 #ifdef INVOKE__main  /* If __main won't actually call __do_global_ctors
 244                         then it doesn't matter what's inside the function.
 245                         The inside of __do_global_ctors_aux is called
 246                         automatically in that case.
 247                         And the Alliant fx2800 linker crashes
 248                         on this reference.  So prevent the crash.  */
 249   __do_global_ctors_aux ();
 250 #endif
 251 }
 252
 253 asm (INIT_SECTION_ASM_OP);      /* cc1 doesn't know that we are switching! */
 254
 255 /* On some svr4 systems, the initial .init section preamble code provided in
 256    crti.o may do something, such as bump the stack, which we have to
 257    undo before we reach the function prologue code for __do_global_ctors
 258    (directly below).  For such systems, define the macro INIT_SECTION_PREAMBLE
 259    to expand into the code needed to undo the actions of the crti.o file.  */
 260
 261 #ifdef INIT_SECTION_PREAMBLE
 262   INIT_SECTION_PREAMBLE;
 263 #endif
 264
 265 /* A routine to invoke all of the global constructors upon entry to the
 266    program.  We put this into the .init section (for systems that have
 267    such a thing) so that we can properly perform the construction of
 268    file-scope static-storage C++ objects within shared libraries.   */
 269
 270 static void
 271 __do_global_ctors_aux (void)    /* prologue goes in .init section */
 272 {
 273 #ifdef FORCE_INIT_SECTION_ALIGN
 274   FORCE_INIT_SECTION_ALIGN;     /* Explicit align before switch to .text */
 275 #endif
 276   asm (TEXT_SECTION_ASM_OP);    /* don't put epilogue and body in .init */
 277   DO_GLOBAL_CTORS_BODY;
 278   atexit (__do_global_dtors);
 279 }
 280
 281 #endif /* OBJECT_FORMAT_ELF */
 282
 283 #else /* defined(INIT_SECTION_ASM_OP) */
 284
 285 #ifdef HAS_INIT_SECTION
 286 /* This case is used by the Irix 6 port, which supports named sections but
 287    not an SVR4-style .fini section.  __do_global_dtors can be non-static
 288    in this case because we protect it with -hidden_symbol.  */
 289
 290 static char __EH_FRAME_BEGIN__[];
 291 static func_ptr __DTOR_LIST__[];
 292 void
 293 __do_global_dtors (void)
 294 {
 295   func_ptr *p;
 296   for (p = __DTOR_LIST__ + 1; *p; p++)
 297     (*p) ();
 298
 299 #ifdef EH_FRAME_SECTION_ASM_OP
 300   if (__deregister_frame_info)
 301     __deregister_frame_info (__EH_FRAME_BEGIN__);
 302 #endif
 303 }
 304
 305 #ifdef EH_FRAME_SECTION_ASM_OP
 306 /* Define a function here to call __register_frame.  crtend.o is linked in
 307    after libgcc.a, and hence can't call libgcc.a functions directly.  That
 308    can lead to unresolved function references.  */
 309 void
 310 __frame_dummy (void)
 311 {
 312   static struct object object;
 313   if (__register_frame_info)
 314     __register_frame_info (__EH_FRAME_BEGIN__, &object);
 315 }
 316 #endif
 317 #endif
 318
 319 #endif /* defined(INIT_SECTION_ASM_OP) */
 320
 321 /* Force cc1 to switch to .data section.  */
 322 static func_ptr force_to_data[0] __attribute__ ((__unused__)) = { };
 323
 324 /* NOTE:  In order to be able to support SVR4 shared libraries, we arrange
 325    to have one set of symbols { __CTOR_LIST__, __DTOR_LIST__, __CTOR_END__,
 326    __DTOR_END__ } per root executable and also one set of these symbols
 327    per shared library.  So in any given whole process image, we may have
 328    multiple definitions of each of these symbols.  In order to prevent
 329    these definitions from conflicting with one another, and in order to
 330    ensure that the proper lists are used for the initialization/finalization
 331    of each individual shared library (respectively), we give these symbols
 332    only internal (i.e. `static') linkage, and we also make it a point to
 333    refer to only the __CTOR_END__ symbol in crtend.o and the __DTOR_LIST__
 334    symbol in crtbegin.o, where they are defined.  */
 335
 336 /* The -1 is a flag to __do_global_[cd]tors
 337    indicating that this table does not start with a count of elements.  */
 338 #ifdef CTOR_LIST_BEGIN
 339 CTOR_LIST_BEGIN;
 340 #else
 341 asm (CTORS_SECTION_ASM_OP);     /* cc1 doesn't know that we are switching! */
 342 STATIC func_ptr __CTOR_LIST__[1] __attribute__ ((__unused__))
 343   = { (func_ptr) (-1) };
 344 #endif
 345
 346 #ifdef DTOR_LIST_BEGIN
 347 DTOR_LIST_BEGIN;
 348 #else
 349 asm (DTORS_SECTION_ASM_OP);     /* cc1 doesn't know that we are switching! */
 350 STATIC func_ptr __DTOR_LIST__[1] = { (func_ptr) (-1) };
 351 #endif
 352
 353 #ifdef EH_FRAME_SECTION_ASM_OP
 354 /* Stick a label at the beginning of the frame unwind info so we can register
 355    and deregister it with the exception handling library code.  */
 356
 357 asm (EH_FRAME_SECTION_ASM_OP);
 358 #ifdef INIT_SECTION_ASM_OP
 359 STATIC
 360 #endif
 361 char __EH_FRAME_BEGIN__[] = { };
 362 #endif /* EH_FRAME_SECTION_ASM_OP */
 363
 364 #endif /* defined(CRT_BEGIN) */
 365
 366 #ifdef CRT_END
 367
 368 #ifdef INIT_SECTION_ASM_OP
 369
 370 #ifdef OBJECT_FORMAT_ELF
 371
 372 static func_ptr __CTOR_END__[];
 373 static void
 374 __do_global_ctors_aux (void)
 375 {
 376   func_ptr *p;
 377   for (p = __CTOR_END__ - 1; *p != (func_ptr) -1; p--)
 378     (*p) ();
 379 }
 380
 381 /* Stick a call to __do_global_ctors_aux into the .init section.  */
 382
 383 static void __attribute__ ((__unused__))
 384 init_dummy (void)
 385 {
 386   asm (INIT_SECTION_ASM_OP);
 387   __do_global_ctors_aux ();
 388 #ifdef FORCE_INIT_SECTION_ALIGN
 389   FORCE_INIT_SECTION_ALIGN;
 390 #endif
 391   asm (TEXT_SECTION_ASM_OP);
 392
 393 /* This is a kludge. The i386 GNU/Linux dynamic linker needs ___brk_addr,
 394    __environ and atexit (). We have to make sure they are in the .dynsym
 395    section. We accomplish it by making a dummy call here. This
 396    code is never reached.  */
 397
 398 #if defined(__linux__) && defined(__PIC__) && defined(__i386__)
 399   {
 400     extern void *___brk_addr;
 401     extern char **__environ;
 402
 403     ___brk_addr = __environ;
 404     atexit ();
 405   }
 406 #endif
 407 }
 408
 409 #else  /* OBJECT_FORMAT_ELF */
 410
 411 /* Stick the real initialization code, followed by a normal sort of
 412    function epilogue at the very end of the .init section for this
 413    entire root executable file or for this entire shared library file.
 414
 415    Note that we use some tricks here to get *just* the body and just
 416    a function epilogue (but no function prologue) into the .init
 417    section of the crtend.o file.  Specifically, we switch to the .text
 418    section, start to define a function, and then we switch to the .init
 419    section just before the body code.
 420
 421    Earlier on, we put the corresponding function prologue into the .init
 422    section of the crtbegin.o file (which will be linked in first).
 423
 424    Note that we want to invoke all constructors for C++ file-scope static-
 425    storage objects AFTER any other possible initialization actions which
 426    may be performed by the code in the .init section contributions made by
 427    other libraries, etc.  That's because those other initializations may
 428    include setup operations for very primitive things (e.g. initializing
 429    the state of the floating-point coprocessor, etc.) which should be done
 430    before we start to execute any of the user's code.  */
 431
 432 static void
 433 __do_global_ctors_aux (void)    /* prologue goes in .text section */
 434 {
 435   asm (INIT_SECTION_ASM_OP);
 436   DO_GLOBAL_CTORS_BODY;
 437   atexit (__do_global_dtors);
 438 }                               /* epilogue and body go in .init section */
 439
 440 #ifdef FORCE_INIT_SECTION_ALIGN
 441 FORCE_INIT_SECTION_ALIGN;
 442 #endif
 443
 444 asm (TEXT_SECTION_ASM_OP);
 445
 446 #endif /* OBJECT_FORMAT_ELF */
 447
 448 #else /* defined(INIT_SECTION_ASM_OP) */
 449
 450 #ifdef HAS_INIT_SECTION
 451 /* This case is used by the Irix 6 port, which supports named sections but
 452    not an SVR4-style .init section.  __do_global_ctors can be non-static
 453    in this case because we protect it with -hidden_symbol.  */
 454 static func_ptr __CTOR_END__[];
 455 #ifdef EH_FRAME_SECTION_ASM_OP
 456 extern void __frame_dummy (void);
 457 #endif
 458 void
 459 __do_global_ctors (void)
 460 {
 461   func_ptr *p;
 462 #ifdef EH_FRAME_SECTION_ASM_OP
 463   __frame_dummy ();
 464 #endif
 465   for (p = __CTOR_END__ - 1; *p != (func_ptr) -1; p--)
 466     (*p) ();
 467 }
 468 #endif
 469
 470 #endif /* defined(INIT_SECTION_ASM_OP) */
 471
 472 /* Force cc1 to switch to .data section.  */
 473 static func_ptr force_to_data[0] __attribute__ ((__unused__)) = { };
 474
 475 /* Put a word containing zero at the end of each of our two lists of function
 476    addresses.  Note that the words defined here go into the .ctors and .dtors
 477    sections of the crtend.o file, and since that file is always linked in
 478    last, these words naturally end up at the very ends of the two lists
 479    contained in these two sections.  */
 480
 481 #ifdef CTOR_LIST_END
 482 CTOR_LIST_END;
 483 #else
 484 asm (CTORS_SECTION_ASM_OP);     /* cc1 doesn't know that we are switching! */
 485 STATIC func_ptr __CTOR_END__[1] = { (func_ptr) 0 };
 486 #endif
 487
 488 #ifdef DTOR_LIST_END
 489 DTOR_LIST_END;
 490 #else
 491 asm (DTORS_SECTION_ASM_OP);     /* cc1 doesn't know that we are switching! */
 492 STATIC func_ptr __DTOR_END__[1] __attribute__ ((__unused__))
 493   = { (func_ptr) 0 };
 494 #endif
 495
 496 #ifdef EH_FRAME_SECTION_ASM_OP
 497 /* Terminate the frame unwind info section with a 4byte 0 as a sentinel;
 498    this would be the 'length' field in a real FDE.  */
 499
 500 typedef unsigned int ui32 __attribute__ ((mode (SI)));
 501 asm (EH_FRAME_SECTION_ASM_OP);
 502 STATIC ui32 __FRAME_END__[] __attribute__ ((__unused__)) = { 0 };
 503 #endif /* EH_FRAME_SECTION */
 504
 505 #endif /* defined(CRT_END) */
 506
 507 #else  /* OBJECT_FORMAT_MACHO */
 508
 509 /* For Mach-O format executables, we assume that the system's runtime is
 510    smart enough to handle constructors and destructors, but doesn't have
 511    an init section (if it can't even handle constructors/destructors
 512    you should be using INVOKE__main, not crtstuff). All we need to do
 513    is install/deinstall the frame information for exceptions. We do this
 514    by putting a constructor in crtbegin.o and a destructor in crtend.o.
 515
 516    crtend.o also puts in the terminating zero in the frame information
 517    segment. */
 518
 519 /* The crtstuff for other object formats use the symbol __EH_FRAME_BEGIN__
 520    to figure out the start of the exception frame, but here we use
 521    getsectbynamefromheader to find this value. Either method would work,
 522    but this method avoids creating any global symbols, which seems
 523    cleaner. */
 524
 525 #include <mach-o/ldsyms.h>
 526 extern const struct section *
 527   getsectbynamefromheader (const struct mach_header *,
 528                            const char *, const char *);
 529
 530 #ifdef CRT_BEGIN
 531
 532 static void __reg_frame_ctor () __attribute__ ((constructor));
 533
 534 static void
 535 __reg_frame_ctor (void)
 536 {
 537   static struct object object;
 538   const struct section *eh_frame;
 539
 540   eh_frame = getsectbynamefromheader (&_mh_execute_header,
 541                                       "__TEXT", "__eh_frame");
 542   __register_frame_info ((void *) eh_frame->addr, &object);
 543 }
 544
 545 #endif /* CRT_BEGIN */
 546
 547 #ifdef CRT_END
 548
 549 static void __dereg_frame_dtor () __attribute__ ((destructor));
 550
 551 static
 552 void
 553 __dereg_frame_dtor (void)
 554 {
 555   const struct section *eh_frame;
 556
 557   eh_frame = getsectbynamefromheader (&_mh_execute_header,
 558                                       "__TEXT", "__eh_frame");
 559   __deregister_frame_info ((void *) eh_frame->addr);
 560 }
 561
 562 /* Terminate the frame section with a final zero. */
 563
 564 /* Force cc1 to switch to .data section.  */
 565 static void * force_to_data[0] __attribute__ ((__unused__)) = { };
 566
 567 typedef unsigned int ui32 __attribute__ ((mode (SI)));
 568 asm (EH_FRAME_SECTION_ASM_OP);
 569 static ui32 __FRAME_END__[] __attribute__ ((__unused__)) = { 0 };
 570
 571 #endif /* CRT_END */
 572
 573 #endif /* OBJECT_FORMAT_MACHO */
 574