blob: 2ceae5b6e99419a9d6b5f214f667b04a8b249192 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>Apache Mesos: src/slave/posix_signalhandler.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Apache Mesos
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
<li><a href="globals.html"><span>File&#160;Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_80f0d4a0945c74dfa611dba2ec326a39.html">slave</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">posix_signalhandler.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="posix__signalhandler_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">// you may not use this file except in compliance with the License.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">// You may obtain a copy of the License at</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment">// Unless required by applicable law or agreed to in writing, software</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment">// distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment">// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">// See the License for the specific language governing permissions and</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">// limitations under the License.</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;</div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#ifndef __POSIX_SIGNALHANDLER_HPP__</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define __POSIX_SIGNALHANDLER_HPP__</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#include &lt;functional&gt;</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;</div>
<div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="namespaceos.html"> 18</a></span>&#160;<span class="keyword">namespace </span>os {</div>
<div class="line"><a name="l00019"></a><span class="lineno"><a class="line" href="namespaceos_1_1internal.html"> 19</a></span>&#160;<span class="keyword">namespace </span>internal {</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="comment">// Not using extern as this is used only by the executable. The signal</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="comment">// handler should be configured once. Configuring it multiple times will</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="comment">// overwrite any previous handlers. Configuring from multiple threads</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="comment">// simultaneously has undefined behavior.</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="namespaceos_1_1internal.html#a8a4fd52c7aded7da798865160257ce2a"> 25</a></span>&#160;std::function&lt;void(int, int)&gt;* <a class="code" href="namespaceos_1_1internal.html#a8a4fd52c7aded7da798865160257ce2a">signaledWrapper</a> = <span class="keyword">nullptr</span>;</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;</div>
<div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="namespaceos_1_1internal.html#a8c0f383d0ce4a337b2076fab2df49221"> 27</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="namespaceos_1_1internal.html#a8c0f383d0ce4a337b2076fab2df49221">signalHandler</a>(<span class="keywordtype">int</span> sig, siginfo_t* siginfo, <span class="keywordtype">void</span>* <a class="code" href="namespaceprocess_1_1network_1_1openssl.html#a9ea7f1e144d9731d6fb4e4a0d80a7c56">context</a>)</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;{</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <span class="keywordflow">if</span> (<a class="code" href="namespaceos_1_1internal.html#a8a4fd52c7aded7da798865160257ce2a">signaledWrapper</a> != <span class="keyword">nullptr</span>) {</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; (*signaledWrapper)(sig, siginfo-&gt;si_uid);</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; }</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;}</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;</div>
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="namespaceos_1_1internal.html#ac78f0d9629865e098d6eebdf645e8e71"> 35</a></span>&#160;<span class="keywordtype">int</span> <a class="code" href="namespaceos_1_1internal.html#ac78f0d9629865e098d6eebdf645e8e71">configureSignal</a>(<span class="keyword">const</span> std::function&lt;<span class="keywordtype">void</span>(<span class="keywordtype">int</span>, <span class="keywordtype">int</span>)&gt;* signal)</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;{</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="comment">// NOTE: We only expect this function to be called called multiple</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="comment">// times inside tests and `mesos-local`.</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="keywordflow">if</span> (<a class="code" href="namespaceos_1_1internal.html#a8a4fd52c7aded7da798865160257ce2a">signaledWrapper</a> != <span class="keyword">nullptr</span>) {</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="keyword">delete</span> <a class="code" href="namespaceos_1_1internal.html#a8a4fd52c7aded7da798865160257ce2a">signaledWrapper</a>;</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; }</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keyword">struct </span>sigaction action;</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; memset(&amp;action, 0, <span class="keyword">sizeof</span>(<span class="keyword">struct</span> sigaction));</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <a class="code" href="namespaceos_1_1internal.html#a8a4fd52c7aded7da798865160257ce2a">signaledWrapper</a> = <span class="keyword">new</span> std::function&lt;void(int, int)&gt;(*signal);</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="comment">// Do not block additional signals while in the handler.</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; sigemptyset(&amp;action.sa_mask);</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="comment">// The SA_SIGINFO flag tells `sigaction()` to use</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="comment">// the sa_sigaction field, not sa_handler.</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; action.sa_flags = SA_SIGINFO;</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; action.sa_sigaction = <a class="code" href="namespaceos_1_1internal.html#a8c0f383d0ce4a337b2076fab2df49221">signalHandler</a>;</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="keywordflow">return</span> sigaction(<a class="code" href="windows__ctrlhandler_8hpp.html#a944a8250e34bfd7991123abd3436d8c0">SIGUSR1</a>, &amp;action, <span class="keyword">nullptr</span>);</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;}</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;} <span class="comment">// namespace internal {</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;} <span class="comment">// namespace os {</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;<span class="preprocessor">#endif // __POSIX_SIGNALHANDLER_HPP__</span></div>
<div class="ttc" id="namespaceprocess_1_1network_1_1openssl_html_a9ea7f1e144d9731d6fb4e4a0d80a7c56"><div class="ttname"><a href="namespaceprocess_1_1network_1_1openssl.html#a9ea7f1e144d9731d6fb4e4a0d80a7c56">process::network::openssl::context</a></div><div class="ttdeci">SSL_CTX * context()</div></div>
<div class="ttc" id="windows__ctrlhandler_8hpp_html_a944a8250e34bfd7991123abd3436d8c0"><div class="ttname"><a href="windows__ctrlhandler_8hpp.html#a944a8250e34bfd7991123abd3436d8c0">SIGUSR1</a></div><div class="ttdeci">#define SIGUSR1</div><div class="ttdef"><b>Definition:</b> windows_ctrlhandler.hpp:21</div></div>
<div class="ttc" id="namespaceos_1_1internal_html_a8a4fd52c7aded7da798865160257ce2a"><div class="ttname"><a href="namespaceos_1_1internal.html#a8a4fd52c7aded7da798865160257ce2a">os::internal::signaledWrapper</a></div><div class="ttdeci">std::function&lt; void(int, int)&gt; * signaledWrapper</div><div class="ttdef"><b>Definition:</b> posix_signalhandler.hpp:25</div></div>
<div class="ttc" id="namespaceos_1_1internal_html_a8c0f383d0ce4a337b2076fab2df49221"><div class="ttname"><a href="namespaceos_1_1internal.html#a8c0f383d0ce4a337b2076fab2df49221">os::internal::signalHandler</a></div><div class="ttdeci">void signalHandler(int sig, siginfo_t *siginfo, void *context)</div><div class="ttdef"><b>Definition:</b> posix_signalhandler.hpp:27</div></div>
<div class="ttc" id="namespaceos_1_1internal_html_ac78f0d9629865e098d6eebdf645e8e71"><div class="ttname"><a href="namespaceos_1_1internal.html#ac78f0d9629865e098d6eebdf645e8e71">os::internal::configureSignal</a></div><div class="ttdeci">int configureSignal(const std::function&lt; void(int, int)&gt; *signal)</div><div class="ttdef"><b>Definition:</b> posix_signalhandler.hpp:35</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>