src/OSspecific/POSIX/signals/sigFpe.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 OpenCFD Ltd.
   6      \\/     M anipulation  |
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of OpenFOAM.
  10
  11     OpenFOAM 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 2 of the License, or (at your
  14     option) any later version.
  15
  16     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
  17     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  18     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  19     for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with OpenFOAM; if not, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::sigFpe
  27
  28 Description
  29     Set up trapping for floating point exceptions (signal FPE).
  30
  31     Controlled by two env vars:
  32     @param FOAM_SIGFPE \n
  33         exception trapping
  34     @param FOAM_SETNAN \n
  35         initialization of all malloced memory to NaN. If FOAM_SIGFPE
  36         also set, this will cause usage of uninitialized scalars to trigger
  37         an abort.
  38
  39 SourceFiles
  40     sigFpe.C
  41
  42 \*---------------------------------------------------------------------------*/
  43
  44 #ifndef sigFpe_H
  45 #define sigFpe_H
  46
  47 #include "OSspecific.H"
  48 #include <signal.h>
  49
  50 #if defined(linux) || defined(linuxAMD64) || defined(linuxIA64)
  51 #    define LINUX
  52 #endif
  53
  54 #if defined(LINUX) && defined(__GNUC__)
  55 #    define LINUX_GNUC
  56 #endif
  57
  58 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  59
  60 namespace Foam
  61 {
  62
  63 /*---------------------------------------------------------------------------*\
  64                            Class sigFpe Declaration
  65 \*---------------------------------------------------------------------------*/
  66
  67 class sigFpe
  68 {
  69     // Private data
  70
  71         //- Saved old signal trapping setting
  72         static struct sigaction oldAction_;
  73
  74 #       ifdef LINUX
  75
  76             //- Saved old malloc
  77             static void *(*old_malloc_hook)(size_t, const void *);
  78
  79             //- nan malloc function. From malloc_hook manpage.
  80             static void* my_malloc_hook(size_t size, const void *caller);
  81
  82 #       endif
  83
  84
  85     // Static data members
  86
  87 #   ifdef LINUX_GNUC
  88
  89         //- Handler for caught signals
  90         static void sigFpeHandler(int);
  91
  92 #   endif
  93
  94
  95 public:
  96
  97
  98     // Constructors
  99
 100         sigFpe();
 101
 102
 103     // Destructor
 104
 105         ~sigFpe();
 106
 107
 108     // Member functions
 109
 110         void set(const bool verbose);
 111 };
 112
 113
 114 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 115
 116 } // End namespace Foam
 117
 118 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 119
 120 #endif
 121
 122 // ************************************************************************* //