src/OSspecific/POSIX/signals/sigFpe.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend is free software: you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by the
  13     Free Software Foundation, either version 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::sigFpe
  26
  27 Description
  28     Set up trapping for floating point exceptions (signal FPE).
  29
  30     Controlled by two env vars:
  31     @param FOAM_SIGFPE \n
  32         exception trapping
  33     @param FOAM_SETNAN \n
  34         initialization of all malloced memory to NaN. If FOAM_SIGFPE
  35         also set, this will cause usage of uninitialized scalars to trigger
  36         an abort.
  37
  38 SourceFiles
  39     sigFpe.C
  40
  41 \*---------------------------------------------------------------------------*/
  42
  43 #ifndef sigFpe_H
  44 #define sigFpe_H
  45
  46 #include "OSspecific.H"
  47 #include <signal.h>
  48
  49 #if defined(linux) || defined(linuxAMD64) || defined(linuxIA64) || defined(linuxARM7)
  50 #    define LINUX
  51 #endif
  52
  53 #if defined(LINUX) && defined(__GNUC__)
  54 #    define LINUX_GNUC
  55 #endif
  56
  57 #ifdef __APPLE__
  58 #include <malloc/malloc.h>
  59
  60 // these are defined by the mach-headers and would break compilation of Switch.H
  61 #undef TRUE
  62 #undef FALSE
  63
  64 #endif
  65
  66 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  67
  68 namespace Foam
  69 {
  70
  71 /*---------------------------------------------------------------------------*\
  72                            Class sigFpe Declaration
  73 \*---------------------------------------------------------------------------*/
  74
  75 class sigFpe
  76 {
  77     // Private data
  78
  79         //- Saved old signal trapping setting
  80         static struct sigaction oldAction_;
  81
  82 #       ifdef LINUX
  83
  84             //- Saved old malloc
  85             static void *(*old_malloc_hook)(size_t, const void *);
  86
  87             //- nan malloc function. From malloc_hook manpage.
  88             static void* my_malloc_hook(size_t size, const void *caller);
  89
  90 #elif defined (__APPLE__)
  91
  92     //- pointer to the original malloc that is overrided
  93     static void *(*system_malloc_)(malloc_zone_t *zone, size_t size);
  94
  95     //- the overriding handler
  96     static void* nan_malloc_(malloc_zone_t *zone, size_t size);
  97
  98 #       endif
  99
 100
 101     // Static data members
 102
 103 #   if defined(LINUX_GNUC) || defined(__APPLE__)
 104
 105         //- Handler for caught signals
 106         static void sigFpeHandler(int);
 107
 108 #   endif
 109
 110
 111 public:
 112
 113
 114     // Constructors
 115
 116         sigFpe();
 117
 118
 119     // Destructor
 120
 121         ~sigFpe();
 122
 123
 124     // Member functions
 125
 126         void set(const bool verbose);
 127 };
 128
 129
 130 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 131
 132 } // End namespace Foam
 133
 134 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 135
 136 #endif
 137
 138 // ************************************************************************* //