compiler/clib/__arosc_startup.c

   1 /*
   2     Copyright © 2009-2012, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     Desc: arosc library - support code for entering and leaving a program
   6     Lang: english
   7 */
   8 #include <dos/stdio.h>
   9 #include <exec/alerts.h>
  10 #include <proto/exec.h>
  11 #include <proto/dos.h>
  12
  13 #include <assert.h>
  14 #include <setjmp.h>
  15
  16 #define DEBUG 0
  17 #include <aros/debug.h>
  18
  19 #include "__arosc_privdata.h"
  20 #include "__exitfunc.h"
  21
  22 /*****************************************************************************
  23
  24     NAME */
  25         void __arosc_program_startup(
  26
  27 /*  SYNOPSIS */
  28         jmp_buf exitjmp,
  29         int *errorptr)
  30
  31 /*  FUNCTION
  32         This is called during program startup and before calling main.
  33         This is to allow arosc.library to do some initialization that couldn't
  34         be done when opening the library.
  35
  36     INPUTS
  37         exitjmp - jmp_buf to jump to to exit the program
  38         errorptr - pointer to store return value of program
  39
  40     RESULT
  41         -
  42
  43     NOTES
  44         This function is normally called by the startup code so one
  45         should not need to do it oneself.
  46
  47     EXAMPLE
  48
  49     BUGS
  50
  51     SEE ALSO
  52
  53     INTERNALS
  54
  55 ******************************************************************************/
  56 {
  57     struct aroscbase *aroscbase = __aros_getbase_aroscbase();
  58     struct Process *me = (struct Process *)FindTask(NULL);
  59
  60     D(bug("[__arosc_program_startup] aroscbase 0x%p\n", aroscbase));
  61
  62     aroscbase->acb_startup_error_ptr = errorptr;
  63     *aroscbase->acb_exit_jmp_buf = *exitjmp;
  64
  65     /* A some C error IO routines evidently rely on this, and
  66      * should be fixed!
  67      */
  68     if (me->pr_Task.tc_Node.ln_Type == NT_PROCESS &&
  69         me->pr_CES != BNULL)
  70     {
  71         SetVBuf(me->pr_CES, NULL, BUF_NONE, -1);
  72     }
  73 }
  74
  75 /*****************************************************************************
  76
  77     NAME */
  78         void __arosc_program_end(
  79
  80 /*  SYNOPSIS */
  81         void)
  82
  83 /*  FUNCTION
  84         This function is to be called when main() has returned or after
  85         program has exited. This allows to arosc.library to do some
  86         cleanup that can't be done during closing of the library.
  87
  88     INPUTS
  89         -
  90
  91     RESULT
  92         -
  93
  94     NOTES
  95         This function is normally called by the startup code so one
  96         should not need to do it oneself.
  97
  98     EXAMPLE
  99
 100     BUGS
 101
 102     SEE ALSO
 103
 104     INTERNALS
 105
 106
 107 ******************************************************************************/
 108 {
 109     struct aroscbase *aroscbase = __aros_getbase_aroscbase();
 110     D(bug("[__arosc_program_end]\n"));
 111
 112     if (!(aroscbase->acb_flags & ABNORMAL_EXIT))
 113         __callexitfuncs();
 114 }
 115
 116 /*****************************************************************************
 117
 118     NAME */
 119         int *__arosc_set_errorptr(
 120
 121 /*  SYNOPSIS */
 122         int *errorptr)
 123
 124 /*  FUNCTION
 125         This function sets the pointer to store error return value for
 126         program exit.
 127
 128     INPUTS
 129         errorptr - new pointer to return value
 130
 131     RESULT
 132         old pointer to return value
 133
 134     NOTES
 135
 136     EXAMPLE
 137
 138     BUGS
 139
 140     SEE ALSO
 141
 142     INTERNALS
 143
 144 ******************************************************************************/
 145 {
 146     struct aroscbase *aroscbase = __aros_getbase_aroscbase();
 147     int *old = aroscbase->acb_startup_error_ptr;
 148
 149     aroscbase->acb_startup_error_ptr = errorptr;
 150
 151     return old;
 152 }
 153
 154 /*****************************************************************************
 155
 156     NAME */
 157         int *__arosc_get_errorptr(
 158
 159 /*  SYNOPSIS */
 160         void)
 161
 162 /*  FUNCTION
 163         This function gets the pointer to store error return value for
 164         program exit.
 165
 166     INPUTS
 167         -
 168
 169     RESULT
 170         pointer to return value
 171
 172     NOTES
 173
 174     EXAMPLE
 175
 176     BUGS
 177
 178     SEE ALSO
 179
 180     INTERNALS
 181
 182 ******************************************************************************/
 183 {
 184     struct aroscbase *aroscbase = __aros_getbase_aroscbase();
 185     return aroscbase->acb_startup_error_ptr;
 186 }
 187
 188 /*****************************************************************************
 189
 190     NAME */
 191          void __arosc_set_exitjmp(
 192
 193 /*  SYNOPSIS */
 194         jmp_buf exitjmp,
 195         jmp_buf previousjmp)
 196
 197 /*  FUNCTION
 198         This function set the jmp_buf to use for directly exiting current
 199         program.
 200
 201     INPUTS
 202         exitjmp - new jmp_buf for exiting
 203
 204     RESULT
 205         previous jmp_buf for exiting
 206
 207     NOTES
 208
 209     EXAMPLE
 210
 211     BUGS
 212
 213     SEE ALSO
 214
 215     INTERNALS
 216
 217 ******************************************************************************/
 218 {
 219     struct aroscbase *aroscbase = __aros_getbase_aroscbase();
 220
 221     *previousjmp = *aroscbase->acb_exit_jmp_buf;
 222     *aroscbase->acb_exit_jmp_buf = *exitjmp;
 223 }
 224
 225 /*****************************************************************************
 226
 227     NAME */
 228         void __arosc_jmp2exit(
 229
 230 /*  SYNOPSIS */
 231         int normal,
 232         int retcode)
 233
 234 /*  FUNCTION
 235         This function directly jumps to the exit of a program.
 236
 237     INPUTS
 238         normal - Indicates if exit is normal or not. When it is abnormal no
 239                  atexit functions will be called.
 240         retcode - the return code for the program.
 241
 242     RESULT
 243         -
 244
 245     NOTES
 246         In normal operation this function does not return.
 247         If this function returns it means that this function was called in a
 248         context where jmp_buf for exit was not initialized. Likely cause is
 249         a module that opened arosstdc.library.
 250         Be sure to capture this situation.
 251
 252     EXAMPLE
 253
 254     BUGS
 255
 256     SEE ALSO
 257
 258     INTERNALS
 259
 260 ******************************************************************************/
 261 {
 262     struct aroscbase *aroscbase = __aros_getbase_aroscbase();
 263
 264     /* No __arosc_progam_startup() called; Alert()
 265     */
 266     if (aroscbase->acb_startup_error_ptr == NULL)
 267     {
 268         kprintf("[__arosc_jmp2exit] Trying to exit without proper initialization\n");
 269         Alert(AT_DeadEnd | AG_BadParm);
 270     }
 271
 272     if (!normal)
 273         aroscbase->acb_flags |= ABNORMAL_EXIT;
 274
 275     *aroscbase->acb_startup_error_ptr = retcode;
 276
 277     longjmp(aroscbase->acb_exit_jmp_buf, 1);
 278
 279     assert(0); /* Not reached */
 280 }