FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

sigFpeImpl.H

Go to the documentation of this file.
00001 /*---------------------------------------------------------------------------*\
00002   =========                 |
00003   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
00004    \\    /   O peration     |
00005     \\  /    A nd           | Copyright (C) 1991-2010 OpenCFD Ltd.
00006      \\/     M anipulation  |
00007 -------------------------------------------------------------------------------
00008 License
00009     This file is part of OpenFOAM.
00010 
00011     OpenFOAM is free software: you can redistribute it and/or modify it
00012     under the terms of the GNU General Public License as published by
00013     the Free Software Foundation, either version 3 of the License, or
00014     (at your option) any later version.
00015 
00016     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
00017     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
00019     for more details.
00020 
00021     You should have received a copy of the GNU General Public License
00022     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
00023 
00024 Class
00025     Foam::sigFpeImpl
00026 
00027 Description
00028     Set up trapping for floating point exceptions (signal FPE).
00029 
00030     Controlled by two env vars:
00031     @param FOAM_SIGFPE \n
00032         exception trapping
00033     @param FOAM_SETNAN \n
00034         initialization of all malloced memory to NaN. If FOAM_SIGFPE
00035         also set, this will cause usage of uninitialized scalars to trigger
00036         an abort.
00037 
00038     This is the platform specific opaque implementation for class sigFpe.
00039 
00040 SourceFiles
00041     sigFpeImpl.C
00042 
00043 \*---------------------------------------------------------------------------*/
00044 
00045 #ifndef sigFpeImpl_H
00046 #define sigFpeImpl_H
00047 
00048 #include <OpenFOAM/OSspecific.H>
00049 #include "FOAMConfig.h"
00050 #include <signal.h>
00051 
00052 #if (defined(FOAM_HAVE_FENV_H) && defined(FOAM_HAVE_FEENABLEEXCEPT)) || \
00053     (defined(FOAM_HAVE_SIGFPE_H) && defined(FOAM_HAVE_HANDLE_SIGFPES))
00054 #    define FOAM_USE_FPE_HANDLING
00055 #endif
00056 
00057 #if defined(FOAM_HAVE_MALLOC_HOOK) && defined(FOAM_USE_FPE_HANDLING)
00058 #    define FOAM_USE_MALLOC_HOOK
00059 #endif
00060 
00061 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00062 
00063 namespace Foam
00064 {
00065 
00066 /*---------------------------------------------------------------------------*\
00067                            Class sigFpeImpl Declaration
00068 \*---------------------------------------------------------------------------*/
00069 
00070 class sigFpeImpl
00071 {
00072     // Private data
00073 
00074         //- Saved old signal trapping setting
00075         static struct sigaction oldAction_;
00076 
00077 #       ifdef FOAM_USE_MALLOC_HOOK
00078 
00079             //- Saved old malloc
00080             static void *(*old_malloc_hook)(size_t, const void *);
00081 
00082             //- nan malloc function. From malloc_hook manpage.
00083             static void* my_malloc_hook(size_t size, const void *caller);
00084 
00085 #       endif
00086 
00087 
00088     // Static data members
00089 
00090 #   ifdef FOAM_USE_FPE_HANDLING
00091 
00092         //- Handler for caught signals
00093         static void sigFpeHandler(int);
00094 
00095 #   endif
00096 
00097 
00098 public:
00099 
00100 
00101     // Constructors
00102 
00103         sigFpeImpl();
00104 
00105 
00106     // Destructor
00107 
00108         ~sigFpeImpl();
00109 
00110 
00111     // Member functions
00112 
00113         void set(const bool verbose);
00114 };
00115 
00116 
00117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00118 
00119 } // End namespace Foam
00120 
00121 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00122 
00123 #endif
00124 
00125 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines