src/exit.c

   1 /*
   2 Copyright (C) 2001-2007, The Perl Foundation.
   3 $Id$
   4
   5 =head1 NAME
   6
   7 src/exit.c - Exit Handling
   8
   9 =head1 DESCRIPTION
  10
  11 Parrot's version of C<exit()>, C<on_exit()>, and friends.
  12
  13 C<Parrot_on_exit()> allows you register exit handlers which will be
  14 called by C<Parrot_exit()> when the interpreter exits.
  15
  16 =head2 Functions
  17
  18 =over 4
  19
  20 =cut
  21
  22 */
  23
  24 #include <stdlib.h>
  25 #include "parrot/parrot.h"
  26
  27 /* HEADERIZER HFILE: include/parrot/exit.h */
  28
  29 /*
  30
  31 =item C<void Parrot_on_exit>
  32
  33 Register the specified function to be called on exit.
  34
  35 =cut
  36
  37 */
  38
  39 PARROT_API
  40 void
  41 Parrot_on_exit(PARROT_INTERP, NOTNULL(exit_handler_f function), ARGIN_NULLOK(void *arg))
  42 {
  43     /* RT#46403  we might want locking around the list access.   I'm sure this
  44      * will be the least of the threading issues. */
  45
  46     handler_node_t * const new_node = mem_allocate_typed(handler_node_t);
  47
  48     new_node->function        = function;
  49     new_node->arg             = arg;
  50     new_node->next            = interp->exit_handler_list;
  51     interp->exit_handler_list = new_node;
  52 }
  53
  54 /*
  55
  56 =item C<void Parrot_exit>
  57
  58 Exit, calling any registered exit handlers.
  59
  60 =cut
  61
  62 */
  63
  64 PARROT_API
  65 PARROT_DOES_NOT_RETURN
  66 void
  67 Parrot_exit(PARROT_INTERP, int status)
  68 {
  69     /* call all the exit handlers */
  70     /* we are well "below" the runloop now, where lo_var_ptr
  71      * is set usually - exit handlers may run some resource-hungry
  72      * stuff like printing profile stats - a DOD run would kill
  73      * resources - RT#46405 reset stacktop or better disable GC
  74      */
  75     /*
  76      * we don't allow new exit_handlers being installed inside exit handlers
  77      * - do we?
  78      * and: interp->exit_handler_list is gone, after the last exit handler
  79      *      (Parrot_really_destroy) has run
  80      */
  81     handler_node_t *node = interp->exit_handler_list;
  82
  83     Parrot_block_GC_mark(interp);
  84     Parrot_block_GC_sweep(interp);
  85
  86     while (node) {
  87         handler_node_t * const next = node->next;
  88
  89         (node->function)(interp, status, node->arg);
  90         mem_sys_free(node);
  91         node = next;
  92     }
  93
  94     exit(status);
  95 }
  96
  97 /*
  98
  99 =back
 100
 101 =head1 SEE ALSO
 102
 103 F<include/parrot/exit.h> and F<t/src/exit.t>.
 104
 105 =head1 HISTORY
 106
 107 Initial version by Josh Wilmes.
 108
 109 =cut
 110
 111 */
 112
 113
 114 /*
 115  * Local variables:
 116  *   c-file-style: "parrot"
 117  * End:
 118  * vim: expandtab shiftwidth=4:
 119  */