sigFpe.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
    \\  /    A nd           | Copyright (C) 2011-2015 OpenFOAM Foundation
     \\/     M anipulation  |
-------------------------------------------------------------------------------
License
    This file is part of OpenFOAM.
 
    OpenFOAM is free software: you can redistribute it and/or modify it
    under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
 
    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    for more details.
 
    You should have received a copy of the GNU General Public License
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
Class
    Foam::sigFpe
 
Description
    Set up trapping for floating point exceptions (signal FPE).
 
    Controlled by two env vars:
    \param FOAM_SIGFPE \n
        exception trapping
    \param FOAM_SETNAN \n
        initialization of all malloced memory to NaN. If FOAM_SIGFPE
        also set, this will cause usage of uninitialized scalars to trigger
        an abort.
 
    Can be used either directly through the static member functions or
    through the scope of the object (constructor sets trapping; destructor
    restores original).
 
SourceFiles
    sigFpe.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef sigFpe_H
#define sigFpe_H
 
#include <signal.h>
 
#if defined(linux) || defined(linux64) || defined(linuxIA64) || \
    defined(linuxARM7) || defined(linuxPPC64) || defined(linuxPPC64le)
    #define LINUX
#endif
 
#if defined(LINUX) && defined(__GNUC__)
    #define LINUX_GNUC
#endif
 
#include "UList.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
                           Class sigFpe Declaration
\*---------------------------------------------------------------------------*/
 
class sigFpe
{
    // Private data
 
        //- Saved old signal trapping setting
        static struct sigaction oldAction_;
 
        //- Flag to indicate floating point trapping is enabled
        static bool sigFpeActive_;
 
 
    // Static data members
 
        #ifdef LINUX_GNUC
        //- Handler for caught signals
        static void sigHandler(int);
        #endif
 
 
public:
 
 
    // Constructors
 
        //- Construct null
        sigFpe();
 
 
    //- Destructor
    ~sigFpe();
 
 
    // Member functions
 
        //- Activate SIGFPE signal handler when FOAM_SIGFPE is %set
        //  Fill memory with NaN when FOAM_SETNAN is %set
        static void set(const bool verbose);
 
        //- Deactivate SIGFPE signal handler and NaN memory initialisation
        static void unset(const bool verbose);
 
        //- Flag to indicate mallocNan is enabled
        static bool mallocNanActive_;
 
        #ifdef LINUX
        //- Malloc function which initializes to NaN
        static void* mallocNan(size_t size);
        #endif
 
        //- Fill block of data with NaN
        static void fillNan(UList<scalar>&);
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //