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, 1995, 1996 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
  56 /* Provide default definitions for the pseudo-ops used to switch to the
  57    .ctors and .dtors sections.
  58
  59    Note that we want to give these sections the SHF_WRITE attribute
  60    because these sections will actually contain data (i.e. tables of
  61    addresses of functions in the current root executable or shared library
  62    file) and, in the case of a shared library, the relocatable addresses
  63    will have to be properly resolved/relocated (and then written into) by
  64    the dynamic linker when it actually attaches the given shared library
  65    to the executing process.  (Note that on SVR4, you may wish to use the
  66    `-z text' option to the ELF linker, when building a shared library, as
  67    an additional check that you are doing everything right.  But if you do
  68    use the `-z text' option when building a shared library, you will get
  69    errors unless the .ctors and .dtors sections are marked as writable
  70    via the SHF_WRITE attribute.)  */
  71
  72 #ifndef CTORS_SECTION_ASM_OP
  73 #define CTORS_SECTION_ASM_OP    ".section\t.ctors,\"aw\""
  74 #endif
  75 #ifndef DTORS_SECTION_ASM_OP
  76 #define DTORS_SECTION_ASM_OP    ".section\t.dtors,\"aw\""
  77 #endif
  78
  79 #ifdef OBJECT_FORMAT_ELF
  80
  81 /*  Declare a pointer to void function type.  */
  82 typedef void (*func_ptr) (void);
  83 #define STATIC static
  84
  85 #else  /* OBJECT_FORMAT_ELF */
  86
  87 #include "gbl-ctors.h"
  88
  89 #ifndef ON_EXIT
  90 #define ON_EXIT(a, b)
  91 #endif
  92 #define STATIC
  93
  94 #endif /* OBJECT_FORMAT_ELF */
  95
  96 #ifdef CRT_BEGIN
  97
  98 #ifdef INIT_SECTION_ASM_OP
  99
 100 #ifdef OBJECT_FORMAT_ELF
 101
 102 /* Run all the global destructors on exit from the program.  */
 103
 104 /* Some systems place the number of pointers in the first word of the
 105    table.  On SVR4 however, that word is -1.  In all cases, the table is
 106    null-terminated.  On SVR4, we start from the beginning of the list and
 107    invoke each per-compilation-unit destructor routine in order
 108    until we find that null.
 109
 110    Note that this function MUST be static.  There will be one of these
 111    functions in each root executable and one in each shared library, but
 112    although they all have the same code, each one is unique in that it
 113    refers to one particular associated `__DTOR_LIST__' which belongs to the
 114    same particular root executable or shared library file.
 115
 116    On some systems, this routine is run more than once from the .fini,
 117    when exit is called recursively, so we arrange to remember where in
 118    the list we left off processing, and we resume at that point,
 119    should we be re-invoked.  */
 120
 121 static func_ptr __DTOR_LIST__[];
 122 static void
 123 __do_global_dtors_aux ()
 124 {
 125   static func_ptr *p = __DTOR_LIST__ + 1;
 126   while (*p)
 127     {
 128       p++;
 129       (*(p-1)) ();
 130     }
 131 }
 132
 133 /* Stick a call to __do_global_dtors_aux into the .fini section.  */
 134
 135 static void
 136 fini_dummy ()
 137 {
 138   asm (FINI_SECTION_ASM_OP);
 139   __do_global_dtors_aux ();
 140 #ifdef FORCE_FINI_SECTION_ALIGN
 141   FORCE_FINI_SECTION_ALIGN;
 142 #endif
 143   asm (TEXT_SECTION_ASM_OP);
 144 }
 145
 146 #else  /* OBJECT_FORMAT_ELF */
 147
 148 /* The function __do_global_ctors_aux is compiled twice (once in crtbegin.o
 149    and once in crtend.o).  It must be declared static to avoid a link
 150    error.  Here, we define __do_global_ctors as an externally callable
 151    function.  It is externally callable so that __main can invoke it when
 152    INVOKE__main is defined.  This has the additional effect of forcing cc1
 153    to switch to the .text section.  */
 154
 155 static void __do_global_ctors_aux ();
 156 void __do_global_ctors ()
 157 {
 158 #ifdef INVOKE__main  /* If __main won't actually call __do_global_ctors
 159                         then it doesn't matter what's inside the function.
 160                         The inside of __do_global_ctors_aux is called
 161                         automatically in that case.
 162                         And the Alliant fx2800 linker crashes
 163                         on this reference.  So prevent the crash.  */
 164   __do_global_ctors_aux ();
 165 #endif
 166 }
 167
 168 asm (INIT_SECTION_ASM_OP);      /* cc1 doesn't know that we are switching! */
 169
 170 /* On some svr4 systems, the initial .init section preamble code provided in
 171    crti.o may do something, such as bump the stack, which we have to
 172    undo before we reach the function prologue code for __do_global_ctors
 173    (directly below).  For such systems, define the macro INIT_SECTION_PREAMBLE
 174    to expand into the code needed to undo the actions of the crti.o file.  */
 175
 176 #ifdef INIT_SECTION_PREAMBLE
 177   INIT_SECTION_PREAMBLE;
 178 #endif
 179
 180 /* A routine to invoke all of the global constructors upon entry to the
 181    program.  We put this into the .init section (for systems that have
 182    such a thing) so that we can properly perform the construction of
 183    file-scope static-storage C++ objects within shared libraries.   */
 184
 185 static void
 186 __do_global_ctors_aux ()        /* prologue goes in .init section */
 187 {
 188 #ifdef FORCE_INIT_SECTION_ALIGN
 189   FORCE_INIT_SECTION_ALIGN;     /* Explicit align before switch to .text */
 190 #endif
 191   asm (TEXT_SECTION_ASM_OP);    /* don't put epilogue and body in .init */
 192   DO_GLOBAL_CTORS_BODY;
 193   ON_EXIT (__do_global_dtors, 0);
 194 }
 195
 196 #endif /* OBJECT_FORMAT_ELF */
 197
 198 #else /* defined(INIT_SECTION_ASM_OP) */
 199
 200 #ifdef HAS_INIT_SECTION
 201 /* This case is used by the Irix 6 port, which supports named sections but
 202    not an SVR4-style .fini section.  __do_global_dtors can be non-static
 203    in this case because the -fini switch to ld binds strongly.  */
 204 static func_ptr __DTOR_LIST__[];
 205 void
 206 __do_global_dtors ()
 207 {
 208   func_ptr *p;
 209   for (p = __DTOR_LIST__ + 1; *p; p++)
 210     (*p) ();
 211 }
 212 #endif
 213
 214 #endif /* defined(INIT_SECTION_ASM_OP) */
 215
 216 /* Force cc1 to switch to .data section.  */
 217 static func_ptr force_to_data[0] = { };
 218
 219 /* NOTE:  In order to be able to support SVR4 shared libraries, we arrange
 220    to have one set of symbols { __CTOR_LIST__, __DTOR_LIST__, __CTOR_END__,
 221    __DTOR_END__ } per root executable and also one set of these symbols
 222    per shared library.  So in any given whole process image, we may have
 223    multiple definitions of each of these symbols.  In order to prevent
 224    these definitions from conflicting with one another, and in order to
 225    ensure that the proper lists are used for the initialization/finalization
 226    of each individual shared library (respectively), we give these symbols
 227    only internal (i.e. `static') linkage, and we also make it a point to
 228    refer to only the __CTOR_END__ symbol in crtend.o and the __DTOR_LIST__
 229    symbol in crtbegin.o, where they are defined.  */
 230
 231 /* The -1 is a flag to __do_global_[cd]tors
 232    indicating that this table does not start with a count of elements.  */
 233 #ifdef CTOR_LIST_BEGIN
 234 CTOR_LIST_BEGIN;
 235 #else
 236 asm (CTORS_SECTION_ASM_OP);     /* cc1 doesn't know that we are switching! */
 237 STATIC func_ptr __CTOR_LIST__[1] = { (func_ptr) (-1) };
 238 #endif
 239
 240 #ifdef DTOR_LIST_BEGIN
 241 DTOR_LIST_BEGIN;
 242 #else
 243 asm (DTORS_SECTION_ASM_OP);     /* cc1 doesn't know that we are switching! */
 244 STATIC func_ptr __DTOR_LIST__[1] = { (func_ptr) (-1) };
 245 #endif
 246
 247 #endif /* defined(CRT_BEGIN) */
 248
 249 #ifdef CRT_END
 250
 251 #ifdef INIT_SECTION_ASM_OP
 252
 253 #ifdef OBJECT_FORMAT_ELF
 254
 255 static func_ptr __CTOR_END__[];
 256 static void
 257 __do_global_ctors_aux ()
 258 {
 259   func_ptr *p;
 260   for (p = __CTOR_END__ - 1; *p != (func_ptr) -1; p--)
 261     (*p) ();
 262 }
 263
 264 /* Stick a call to __do_global_ctors_aux into the .init section.  */
 265
 266 static void
 267 init_dummy ()
 268 {
 269   asm (INIT_SECTION_ASM_OP);
 270   __do_global_ctors_aux ();
 271 #ifdef FORCE_INIT_SECTION_ALIGN
 272   FORCE_INIT_SECTION_ALIGN;
 273 #endif
 274   asm (TEXT_SECTION_ASM_OP);
 275
 276 /* This is a kludge. The i386 Linux dynamic linker needs ___brk_addr,
 277    __environ and atexit (). We have to make sure they are in the .dynsym
 278    section. We accomplish it by making a dummy call here. This
 279    code is never reached.  */
 280
 281 #if defined(__linux__) && defined(__PIC__) && defined(__i386__)
 282   {
 283     extern void *___brk_addr;
 284     extern char **__environ;
 285
 286     ___brk_addr = __environ;
 287     atexit ();
 288   }
 289 #endif
 290 }
 291
 292 #else  /* OBJECT_FORMAT_ELF */
 293
 294 /* Stick the real initialization code, followed by a normal sort of
 295    function epilogue at the very end of the .init section for this
 296    entire root executable file or for this entire shared library file.
 297
 298    Note that we use some tricks here to get *just* the body and just
 299    a function epilogue (but no function prologue) into the .init
 300    section of the crtend.o file.  Specifically, we switch to the .text
 301    section, start to define a function, and then we switch to the .init
 302    section just before the body code.
 303
 304    Earlier on, we put the corresponding function prologue into the .init
 305    section of the crtbegin.o file (which will be linked in first).
 306
 307    Note that we want to invoke all constructors for C++ file-scope static-
 308    storage objects AFTER any other possible initialization actions which
 309    may be performed by the code in the .init section contributions made by
 310    other libraries, etc.  That's because those other initializations may
 311    include setup operations for very primitive things (e.g. initializing
 312    the state of the floating-point coprocessor, etc.) which should be done
 313    before we start to execute any of the user's code.  */
 314
 315 static void
 316 __do_global_ctors_aux ()        /* prologue goes in .text section */
 317 {
 318   asm (INIT_SECTION_ASM_OP);
 319   DO_GLOBAL_CTORS_BODY;
 320   ON_EXIT (__do_global_dtors, 0);
 321 }                               /* epilogue and body go in .init section */
 322
 323 #endif /* OBJECT_FORMAT_ELF */
 324
 325 #else /* defined(INIT_SECTION_ASM_OP) */
 326
 327 #ifdef HAS_INIT_SECTION
 328 /* This case is used by the Irix 6 port, which supports named sections but
 329    not an SVR4-style .init section.  __do_global_ctors can be non-static
 330    in this case because the -init switch to ld binds strongly.  */
 331 static func_ptr __CTOR_END__[];
 332 void
 333 __do_global_ctors ()
 334 {
 335   func_ptr *p;
 336   for (p = __CTOR_END__ - 1; *p != (func_ptr) -1; p--)
 337     (*p) ();
 338 }
 339 #endif
 340
 341 #endif /* defined(INIT_SECTION_ASM_OP) */
 342
 343 /* Force cc1 to switch to .data section.  */
 344 static func_ptr force_to_data[0] = { };
 345
 346 /* Put a word containing zero at the end of each of our two lists of function
 347    addresses.  Note that the words defined here go into the .ctors and .dtors
 348    sections of the crtend.o file, and since that file is always linked in
 349    last, these words naturally end up at the very ends of the two lists
 350    contained in these two sections.  */
 351
 352 #ifdef CTOR_LIST_END
 353 CTOR_LIST_END;
 354 #else
 355 asm (CTORS_SECTION_ASM_OP);     /* cc1 doesn't know that we are switching! */
 356 STATIC func_ptr __CTOR_END__[1] = { (func_ptr) 0 };
 357 #endif
 358
 359 #ifdef DTOR_LIST_END
 360 DTOR_LIST_END;
 361 #else
 362 asm (DTORS_SECTION_ASM_OP);     /* cc1 doesn't know that we are switching! */
 363 STATIC func_ptr __DTOR_END__[1] = { (func_ptr) 0 };
 364 #endif
 365
 366 #endif /* defined(CRT_END) */