sigSegv.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation
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
13  the Free Software Foundation, either version 3 of the License, or
14  (at your 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, see <http://www.gnu.org/licenses/>.
23 
24 Class
25  Foam::sigSegv
26 
27 Description
28  Signal handler for SEGV interupt.
29 
30  The standard interupt handler is overridden to ensure that the
31  runningJob file is removed.
32  Can be used either directly through the static member functions or
33  through the scope of the object (constructor sets trapping; destructor
34  restores original).
35 
36 See Also
37  Foam::JobInfo
38 
39 SourceFiles
40  sigSegv.C
41 
42 \*---------------------------------------------------------------------------*/
43 
44 #ifndef sigSegv_H
45 #define sigSegv_H
46 
47 #include <signal.h>
48 
49 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
50 
51 namespace Foam
52 {
53 
54 /*---------------------------------------------------------------------------*\
55  Class sigSegv Declaration
56 \*---------------------------------------------------------------------------*/
57 
58 class sigSegv
59 {
60  // Private data
61 
62  //- Saved old signal trapping setting
63  static struct sigaction oldAction_;
64 
65  //- Flag to indicate signal trapping is enabled
66  static bool sigActive_;
67 
68 
69  // Private Member Functions
70 
71  //- Handler for caught signals
72  static void sigHandler(int);
73 
74 
75 public:
76 
77  // Constructors
78 
79  //- Construct null
80  sigSegv();
81 
82 
83  //- Destructor
84  ~sigSegv();
85 
86 
87  // Member functions
88 
89  //- Activate SIGSEGV signal handler
90  static void set(const bool verbose);
91 
92  //- Deactivate SIGSEGV signal handler
93  static void unset(const bool verbose);
94 };
95 
96 
97 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
98 
99 } // End namespace Foam
100 
101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
102 
103 #endif
104 
105 // ************************************************************************* //
Foam::sigSegv
Signal handler for SEGV interupt.
Definition: sigSegv.H:57
Foam::sigSegv::unset
static void unset(const bool verbose)
Deactivate SIGSEGV signal handler.
Definition: sigSegv.C:97
Foam::sigSegv::set
static void set(const bool verbose)
Activate SIGSEGV signal handler.
Definition: sigSegv.C:78
Foam::sigSegv::sigSegv
sigSegv()
Construct null.
Definition: sigSegv.C:62
Foam::sigSegv::oldAction_
static struct sigaction oldAction_
Saved old signal trapping setting.
Definition: sigSegv.H:62
Foam::sigSegv::sigActive_
static bool sigActive_
Flag to indicate signal trapping is enabled.
Definition: sigSegv.H:65
Foam
Namespace for OpenFOAM.
Definition: combustionModel.C:30
Foam::sigSegv::sigHandler
static void sigHandler(int)
Handler for caught signals.
Definition: sigSegv.C:40
Foam::sigSegv::~sigSegv
~sigSegv()
Destructor.
Definition: sigSegv.C:70