blob: 0261c347b7d4b7ac06ef49540e8fb029c121a3a2 [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/common/status_utils.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_fdedb0aba14d44ce9d99bc100e026e6a.html">common</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">status_utils.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="status__utils_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 to the Apache Software Foundation (ASF) under one</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">// or more contributor license agreements. See the NOTICE file</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">// distributed with this work for additional information</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">// regarding copyright ownership. The ASF licenses this file</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment">// to you under the Apache License, Version 2.0 (the</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">// &quot;License&quot;); you may not use this file except in compliance</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment">// with the License. You may obtain a copy of the License at</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">// Unless required by applicable law or agreed to in writing, software</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</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="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment">// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment">// See the License for the specific language governing permissions and</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment">// limitations under the License.</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#ifndef __STATUS_UTILS_HPP__</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define __STATUS_UTILS_HPP__</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="option_8hpp.html">stout/option.hpp</a>&gt;</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="stringify_8hpp.html">stout/stringify.hpp</a>&gt;</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="comment">// Return whether the wait(2) status was a successful process exit.</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="status__utils_8hpp.html#a9e2998a6c0ec36d796adcec49131a5db"> 26</a></span>&#160;<span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="status__utils_8hpp.html#a9e2998a6c0ec36d796adcec49131a5db">WSUCCEEDED</a>(<span class="keywordtype">int</span> <a class="code" href="namespaceproc.html#a34396c6140a28f583dc13fee3c3c35d4">status</a>)</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;{</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; <span class="keywordflow">return</span> <a class="code" href="3rdparty_2stout_2include_2stout_2windows_8hpp.html#af9a4ddf9eee6c4a3bc9be070d59b7ccf">WIFEXITED</a>(status) &amp;&amp; <a class="code" href="3rdparty_2stout_2include_2stout_2windows_8hpp.html#ae0c8840076dd63d5e2367fff4f7f46f3">WEXITSTATUS</a>(status) == 0;</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;}</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;</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"><a class="line" href="status__utils_8hpp.html#aec7297ea295ff53f48cc0f25ce4a63f9"> 32</a></span>&#160;<span class="keyword">inline</span> std::string <a class="code" href="status__utils_8hpp.html#aec7297ea295ff53f48cc0f25ce4a63f9">WSTRINGIFY</a>(<span class="keywordtype">int</span> <a class="code" href="namespaceproc.html#a34396c6140a28f583dc13fee3c3c35d4">status</a>)</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;<span class="preprocessor">#ifdef __WINDOWS__</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="preprocessor"></span> <span class="comment">// On Windows the exit codes are not standardized. The behaviour should</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="comment">// be defined to improve the diagnostic based on logs.</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="comment">// TODO(dpravat): MESOS-5417 tracks this improvement.</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; LOG(WARNING) &lt;&lt; <span class="stringliteral">&quot;`WSTRINGIFY` has been called, but it is not implemented.&quot;</span>;</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="keywordflow">return</span> <span class="stringliteral">&quot;&quot;</span>;</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="preprocessor">#else</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="preprocessor"></span> std::string message;</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keywordflow">if</span> (<a class="code" href="3rdparty_2stout_2include_2stout_2windows_8hpp.html#af9a4ddf9eee6c4a3bc9be070d59b7ccf">WIFEXITED</a>(status)) {</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; message += <span class="stringliteral">&quot;exited with status &quot;</span>;</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; message += <a class="code" href="namespacens.html#a28116b46e6543597a11733424cd1aa20">stringify</a>(<a class="code" href="3rdparty_2stout_2include_2stout_2windows_8hpp.html#ae0c8840076dd63d5e2367fff4f7f46f3">WEXITSTATUS</a>(status));</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (<a class="code" href="3rdparty_2stout_2include_2stout_2windows_8hpp.html#a6953e62fd0dec274a397678d31c344b4">WIFSIGNALED</a>(status)) {</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; message += <span class="stringliteral">&quot;terminated with signal &quot;</span>;</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; message += <a class="code" href="3rdparty_2stout_2include_2stout_2windows_8hpp.html#a3858fc90369448097210e69437ca7c66">strsignal</a>(<a class="code" href="3rdparty_2stout_2include_2stout_2windows_8hpp.html#aeba4d421572a9d681c73c347f24ad348">WTERMSIG</a>(status));</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keywordflow">if</span> (<a class="code" href="3rdparty_2stout_2include_2stout_2windows_8hpp.html#a6db11dadebdde2109e82adc8e02befc9">WCOREDUMP</a>(status)) {</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; message += <span class="stringliteral">&quot; (core dumped)&quot;</span>;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; }</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (<a class="code" href="3rdparty_2stout_2include_2stout_2windows_8hpp.html#ae2b610235f988f4f3109f02a2f395727">WIFSTOPPED</a>(status)) {</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; message += <span class="stringliteral">&quot;stopped on signal &quot;</span>;</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; message += <a class="code" href="3rdparty_2stout_2include_2stout_2windows_8hpp.html#a3858fc90369448097210e69437ca7c66">strsignal</a>(<a class="code" href="3rdparty_2stout_2include_2stout_2windows_8hpp.html#a2c6d84ce222454bb6387fc20d930f5b7">WSTOPSIG</a>(status));</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; } <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; message += <span class="stringliteral">&quot;wait status &quot;</span>;</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; message += <a class="code" href="namespacens.html#a28116b46e6543597a11733424cd1aa20">stringify</a>(status);</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; <span class="keywordflow">return</span> message;</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;<span class="preprocessor">#endif // __WINDOWS__</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;<span class="preprocessor"></span>}</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;<span class="preprocessor">#endif // __STATUS_UTILS_HPP__</span></div>
<div class="ttc" id="3rdparty_2stout_2include_2stout_2windows_8hpp_html_a3858fc90369448097210e69437ca7c66"><div class="ttname"><a href="3rdparty_2stout_2include_2stout_2windows_8hpp.html#a3858fc90369448097210e69437ca7c66">strsignal</a></div><div class="ttdeci">const char * strsignal(int signum)</div><div class="ttdef"><b>Definition:</b> windows.hpp:407</div></div>
<div class="ttc" id="namespaceproc_html_a34396c6140a28f583dc13fee3c3c35d4"><div class="ttname"><a href="namespaceproc.html#a34396c6140a28f583dc13fee3c3c35d4">proc::status</a></div><div class="ttdeci">Result&lt; ProcessStatus &gt; status(pid_t pid)</div><div class="ttdef"><b>Definition:</b> proc.hpp:166</div></div>
<div class="ttc" id="3rdparty_2stout_2include_2stout_2windows_8hpp_html_a2c6d84ce222454bb6387fc20d930f5b7"><div class="ttname"><a href="3rdparty_2stout_2include_2stout_2windows_8hpp.html#a2c6d84ce222454bb6387fc20d930f5b7">WSTOPSIG</a></div><div class="ttdeci">#define WSTOPSIG(x)</div><div class="ttdef"><b>Definition:</b> windows.hpp:449</div></div>
<div class="ttc" id="3rdparty_2stout_2include_2stout_2windows_8hpp_html_a6953e62fd0dec274a397678d31c344b4"><div class="ttname"><a href="3rdparty_2stout_2include_2stout_2windows_8hpp.html#a6953e62fd0dec274a397678d31c344b4">WIFSIGNALED</a></div><div class="ttdeci">#define WIFSIGNALED(x)</div><div class="ttdef"><b>Definition:</b> windows.hpp:428</div></div>
<div class="ttc" id="3rdparty_2stout_2include_2stout_2windows_8hpp_html_ae2b610235f988f4f3109f02a2f395727"><div class="ttname"><a href="3rdparty_2stout_2include_2stout_2windows_8hpp.html#ae2b610235f988f4f3109f02a2f395727">WIFSTOPPED</a></div><div class="ttdeci">#define WIFSTOPPED(x)</div><div class="ttdef"><b>Definition:</b> windows.hpp:444</div></div>
<div class="ttc" id="option_8hpp_html"><div class="ttname"><a href="option_8hpp.html">option.hpp</a></div></div>
<div class="ttc" id="3rdparty_2stout_2include_2stout_2windows_8hpp_html_ae0c8840076dd63d5e2367fff4f7f46f3"><div class="ttname"><a href="3rdparty_2stout_2include_2stout_2windows_8hpp.html#ae0c8840076dd63d5e2367fff4f7f46f3">WEXITSTATUS</a></div><div class="ttdeci">#define WEXITSTATUS(x)</div><div class="ttdef"><b>Definition:</b> windows.hpp:424</div></div>
<div class="ttc" id="3rdparty_2stout_2include_2stout_2windows_8hpp_html_af9a4ddf9eee6c4a3bc9be070d59b7ccf"><div class="ttname"><a href="3rdparty_2stout_2include_2stout_2windows_8hpp.html#af9a4ddf9eee6c4a3bc9be070d59b7ccf">WIFEXITED</a></div><div class="ttdeci">#define WIFEXITED(x)</div><div class="ttdef"><b>Definition:</b> windows.hpp:419</div></div>
<div class="ttc" id="stringify_8hpp_html"><div class="ttname"><a href="stringify_8hpp.html">stringify.hpp</a></div></div>
<div class="ttc" id="status__utils_8hpp_html_a9e2998a6c0ec36d796adcec49131a5db"><div class="ttname"><a href="status__utils_8hpp.html#a9e2998a6c0ec36d796adcec49131a5db">WSUCCEEDED</a></div><div class="ttdeci">bool WSUCCEEDED(int status)</div><div class="ttdef"><b>Definition:</b> status_utils.hpp:26</div></div>
<div class="ttc" id="3rdparty_2stout_2include_2stout_2windows_8hpp_html_a6db11dadebdde2109e82adc8e02befc9"><div class="ttname"><a href="3rdparty_2stout_2include_2stout_2windows_8hpp.html#a6db11dadebdde2109e82adc8e02befc9">WCOREDUMP</a></div><div class="ttdeci">#define WCOREDUMP(x)</div><div class="ttdef"><b>Definition:</b> windows.hpp:439</div></div>
<div class="ttc" id="3rdparty_2stout_2include_2stout_2windows_8hpp_html_aeba4d421572a9d681c73c347f24ad348"><div class="ttname"><a href="3rdparty_2stout_2include_2stout_2windows_8hpp.html#aeba4d421572a9d681c73c347f24ad348">WTERMSIG</a></div><div class="ttdeci">#define WTERMSIG(x)</div><div class="ttdef"><b>Definition:</b> windows.hpp:434</div></div>
<div class="ttc" id="status__utils_8hpp_html_aec7297ea295ff53f48cc0f25ce4a63f9"><div class="ttname"><a href="status__utils_8hpp.html#aec7297ea295ff53f48cc0f25ce4a63f9">WSTRINGIFY</a></div><div class="ttdeci">std::string WSTRINGIFY(int status)</div><div class="ttdef"><b>Definition:</b> status_utils.hpp:32</div></div>
<div class="ttc" id="namespacens_html_a28116b46e6543597a11733424cd1aa20"><div class="ttname"><a href="namespacens.html#a28116b46e6543597a11733424cd1aa20">ns::stringify</a></div><div class="ttdeci">std::string stringify(int flags)</div><div class="ttdef"><b>Definition:</b> ns.hpp:688</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>