sigInt.C
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-2015 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 \*---------------------------------------------------------------------------*/
25 
26 #include "sigInt.H"
27 #include "error.H"
28 #include "JobInfo.H"
29 #include "IOstreams.H"
30 
31 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
32 
33 struct sigaction Foam::sigInt::oldAction_;
34 
35 bool Foam::sigInt::sigActive_ = false;
36 
37 
38 // * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
39 
41 {
42  // Reset old handling
43  if (sigaction(SIGINT, &oldAction_, NULL) < 0)
44  {
46  << "Cannot reset SIGINT trapping"
47  << abort(FatalError);
48  }
49 
50  // Update jobInfo file
52 
53  // Throw signal (to old handler)
54  raise(SIGINT);
55 }
56 
57 
58 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
59 
61 {
62  set(false);
63 }
64 
65 
66 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
67 
69 {
70  unset(false);
71 }
72 
73 
74 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
75 
76 void Foam::sigInt::set(const bool)
77 {
78  if (!sigActive_)
79  {
80  struct sigaction newAction;
81  newAction.sa_handler = sigHandler;
82  newAction.sa_flags = SA_NODEFER;
83  sigemptyset(&newAction.sa_mask);
84  if (sigaction(SIGINT, &newAction, &oldAction_) < 0)
85  {
87  << "Cannot call sigInt::set() more than once"
88  << abort(FatalError);
89  }
90  sigActive_ = true;
91  }
92 }
93 
94 
95 void Foam::sigInt::unset(const bool)
96 {
97  if (sigActive_)
98  {
99  if (sigaction(SIGINT, &oldAction_, NULL) < 0)
100  {
102  << "Cannot set SIGINT trapping"
103  << abort(FatalError);
104  }
105  sigActive_ = false;
106  }
107 }
108 
109 
110 // ************************************************************************* //
Foam::sigInt::sigActive_
static bool sigActive_
Flag to indicate signal trapping is enabled.
Definition: sigInt.H:66
IOstreams.H
Useful combination of include files which define Sin, Sout and Serr and the use of IO streams general...
sigInt.H
Foam::sigInt::sigHandler
static void sigHandler(int)
Definition: sigInt.C:40
Foam::sigInt::set
static void set(const bool verbose)
Activate SIGINT signal handler.
Definition: sigInt.C:76
error.H
Foam::sigInt::sigInt
sigInt()
Construct null.
Definition: sigInt.C:60
Foam::FatalError
error FatalError
Foam::sigInt::~sigInt
~sigInt()
Destructor.
Definition: sigInt.C:68
Foam
Namespace for OpenFOAM.
Definition: combustionModel.C:30
Foam::abort
errorManip< error > abort(error &err)
Definition: errorManip.H:131
Foam::jobInfo
JobInfo jobInfo
Definition: JobInfo.C:35
FatalErrorInFunction
#define FatalErrorInFunction
Report an error message using Foam::FatalError.
Definition: error.H:318
JobInfo.H
Foam::sigInt::unset
static void unset(const bool verbose)
Deactivate SIGINT signal handler.
Definition: sigInt.C:95
Foam::JobInfo::signalEnd
void signalEnd() const
Definition: JobInfo.C:176