sigInt.C
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2018 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 
36 // * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
37 
38 void Foam::sigInt::sigHandler(int)
39 {
40  // Reset old handling
41  if (sigaction(SIGINT, &oldAction_, nullptr) < 0)
42  {
44  << "Cannot reset SIGINT trapping"
45  << abort(FatalError);
46  }
47 
48  // Update jobInfo file
50 
51  // Throw signal (to old handler)
52  raise(SIGINT);
53 }
54 
55 
56 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
57 
59 {
60  oldAction_.sa_handler = nullptr;
61 }
62 
63 
64 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
65 
67 {
68  // Reset old handling
69  if (sigaction(SIGINT, &oldAction_, nullptr) < 0)
70  {
72  << "Cannot reset SIGINT trapping"
73  << abort(FatalError);
74  }
75 }
76 
77 
78 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
79 
80 void Foam::sigInt::set(const bool)
81 {
82  if (oldAction_.sa_handler)
83  {
85  << "Cannot call sigInt::set() more than once"
86  << abort(FatalError);
87  }
88 
89  struct sigaction newAction;
90  newAction.sa_handler = sigHandler;
91  newAction.sa_flags = SA_NODEFER;
92  sigemptyset(&newAction.sa_mask);
93  if (sigaction(SIGINT, &newAction, &oldAction_) < 0)
94  {
96  << "Cannot set SIGINT trapping"
97  << abort(FatalError);
98  }
99 }
100 
101 
102 // ************************************************************************* //
error FatalError
#define FatalErrorInFunction
Report an error message using Foam::FatalError.
Definition: error.H:319
void signalEnd() const
Definition: jobInfo.C:210
jobInfo jobInfo_
Definition: jobInfo.C:44
Useful combination of include files which define Sin, Sout and Serr and the use of IO streams general...
errorManip< error > abort(error &err)
Definition: errorManip.H:131
sigInt()
Construct null.
Definition: sigInt.C:58
void set(const bool verbose)
Activate SIGINT signal handler.
Definition: sigInt.C:80
~sigInt()
Destructor.
Definition: sigInt.C:66
Namespace for OpenFOAM.