| <!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/linux/sched.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 Page</span></a></li> |
| <li><a href="pages.html"><span>Related 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 List</span></a></li> |
| <li><a href="globals.html"><span>File 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_a18918b93668b435612395bbc2e8b82b.html">linux</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"> |
| <div class="title">sched.hpp</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="sched_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> <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> <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> <span class="comment">// distributed with this work for additional information</span></div> |
| <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <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> <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> <span class="comment">// "License"); you may not use this file except in compliance</span></div> |
| <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <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> <span class="comment">//</span></div> |
| <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <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> <span class="comment">//</span></div> |
| <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <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> <span class="comment">// distributed under the License is distributed on an "AS IS" BASIS,</span></div> |
| <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <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> <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> <span class="comment">// limitations under the License.</span></div> |
| <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div> |
| <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#ifndef __LINUX_SCHED_HPP__</span></div> |
| <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor"></span><span class="preprocessor">#define __LINUX_SCHED_HPP__</span></div> |
| <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor"></span></div> |
| <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">// This file contains Linux-only OS utilities.</span></div> |
| <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#ifndef __linux__</span></div> |
| <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor"></span><span class="preprocessor">#error "linux/sched.hpp is only available on Linux systems."</span></div> |
| <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor"></span><span class="preprocessor">#endif</span></div> |
| <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor"></span></div> |
| <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <sched.h></span></div> |
| <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">// Some old distributions, e.g., Redhat 5.5, do not correctly include</span></div> |
| <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment">// linux/sched.h.</span></div> |
| <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include <linux/sched.h></span></div> |
| <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div> |
| <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div> |
| <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include <sys/types.h></span></div> |
| <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div> |
| <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#include <<a class="code" href="error_8hpp.html">stout/error.hpp</a>></span></div> |
| <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#include <<a class="code" href="none_8hpp.html">stout/none.hpp</a>></span></div> |
| <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#include <<a class="code" href="nothing_8hpp.html">stout/nothing.hpp</a>></span></div> |
| <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor">#include <<a class="code" href="option_8hpp.html">stout/option.hpp</a>></span></div> |
| <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor">#include <<a class="code" href="try_8hpp.html">stout/try.hpp</a>></span></div> |
| <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div> |
| <div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="namespacesched.html"> 39</a></span> <span class="keyword">namespace </span>sched {</div> |
| <div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div> |
| <div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="namespacesched.html#a51639e5b9ba17424593e5b263f867a0d"> 41</a></span> <span class="keyword">enum</span> <a class="code" href="namespacesched.html#a51639e5b9ba17424593e5b263f867a0d">Policy</a></div> |
| <div class="line"><a name="l00042"></a><span class="lineno"> 42</span> {</div> |
| <div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="namespacesched.html#a51639e5b9ba17424593e5b263f867a0da0249cd4af5697d05fc0ae0e9e8cb602c"> 43</a></span>  <a class="code" href="namespacesched.html#a51639e5b9ba17424593e5b263f867a0da0249cd4af5697d05fc0ae0e9e8cb602c">OTHER</a> = SCHED_OTHER, <span class="comment">// Default policy.</span></div> |
| <div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="namespacesched.html#a51639e5b9ba17424593e5b263f867a0da259f4bfe6bb04733cdf9650637eed85d"> 44</a></span>  <a class="code" href="namespacesched.html#a51639e5b9ba17424593e5b263f867a0da259f4bfe6bb04733cdf9650637eed85d">BATCH</a> = SCHED_BATCH, <span class="comment">// Non-interactive, CPU intensive.</span></div> |
| <div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="namespacesched.html#a51639e5b9ba17424593e5b263f867a0daebaee7d1ec50f96b6ab8f531f92cf56e"> 45</a></span>  <a class="code" href="namespacesched.html#a51639e5b9ba17424593e5b263f867a0daebaee7d1ec50f96b6ab8f531f92cf56e">IDLE</a> = SCHED_IDLE, <span class="comment">// Very low priority.</span></div> |
| <div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="namespacesched.html#a51639e5b9ba17424593e5b263f867a0da3b0554820cb08d52616cdfde896067d4"> 46</a></span>  <a class="code" href="namespacesched.html#a51639e5b9ba17424593e5b263f867a0da3b0554820cb08d52616cdfde896067d4">FIFO</a> = SCHED_FIFO, <span class="comment">// Realtime.</span></div> |
| <div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="namespacesched.html#a51639e5b9ba17424593e5b263f867a0da8964a9f6005e1a993ae167a3258feea5"> 47</a></span>  <a class="code" href="namespacesched.html#a51639e5b9ba17424593e5b263f867a0da8964a9f6005e1a993ae167a3258feea5">RR</a> = SCHED_RR <span class="comment">// Realtime, round-robin.</span></div> |
| <div class="line"><a name="l00048"></a><span class="lineno"> 48</span> };</div> |
| <div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div> |
| <div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div> |
| <div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="namespacesched_1_1policy.html"> 51</a></span> <span class="keyword">namespace </span>policy {</div> |
| <div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div> |
| <div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment">// Return the current scheduling policy for the specified pid, or for</span></div> |
| <div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment">// the caller if pid is None() or zero.</span></div> |
| <div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="namespacesched_1_1policy.html#aa37ce2066e3741ef2a9a8a29be5cc0dc"> 55</a></span> <span class="keyword">inline</span> <a class="code" href="classTry.html">Try<Policy></a> <span class="keyword">get</span>(<span class="keyword">const</span> <a class="code" href="classOption.html">Option<pid_t></a>& pid = <a class="code" href="structNone.html">None</a>())</div> |
| <div class="line"><a name="l00056"></a><span class="lineno"> 56</span> {</div> |
| <div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keywordtype">int</span> <a class="code" href="namespaceproc.html#a34396c6140a28f583dc13fee3c3c35d4">status</a> = sched_getscheduler(pid.isSome() ? pid.get() : 0);</div> |
| <div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div> |
| <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keywordflow">if</span> (status == -1) {</div> |
| <div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keywordflow">return</span> <a class="code" href="classErrnoError.html">ErrnoError</a>(<span class="stringliteral">"Failed to get scheduler policy"</span>);</div> |
| <div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  }</div> |
| <div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div> |
| <div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keywordflow">return</span> <span class="keyword">static_cast<</span><a class="code" href="namespacesched.html#a51639e5b9ba17424593e5b263f867a0d">Policy</a><span class="keyword">></span>(<a class="code" href="namespaceproc.html#a34396c6140a28f583dc13fee3c3c35d4">status</a>);</div> |
| <div class="line"><a name="l00064"></a><span class="lineno"> 64</span> }</div> |
| <div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div> |
| <div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div> |
| <div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment">// Set the scheduling policy for the specified pid, or for the caller</span></div> |
| <div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment">// if pid is None() or zero. Only realtime scheduling policies (FIFO</span></div> |
| <div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment">// and RR) accept a priority (within a range, see</span></div> |
| <div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment">// sched_setscheduler(2)).</span></div> |
| <div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment">// TODO(idownes): Add wrappers around sched_get_priority_{min,max}.</span></div> |
| <div class="line"><a name="l00072"></a><span class="lineno"><a class="line" href="namespacesched_1_1policy.html#a96002502928baa764f913e8bce175b32"> 72</a></span> <span class="keyword">inline</span> <a class="code" href="classTry.html">Try<Nothing></a> <a class="code" href="namespacesched_1_1policy.html#a96002502928baa764f913e8bce175b32">set</a>(</div> |
| <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <a class="code" href="namespacesched.html#a51639e5b9ba17424593e5b263f867a0d">Policy</a> policy,</div> |
| <div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keyword">const</span> <a class="code" href="classOption.html">Option<pid_t></a>& pid = <a class="code" href="structNone.html">None</a>(),</div> |
| <div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keywordtype">int</span> priority = 0)</div> |
| <div class="line"><a name="l00076"></a><span class="lineno"> 76</span> {</div> |
| <div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keywordflow">if</span> ((policy == <a class="code" href="namespacesched.html#a51639e5b9ba17424593e5b263f867a0da0249cd4af5697d05fc0ae0e9e8cb602c">OTHER</a> || policy == <a class="code" href="namespacesched.html#a51639e5b9ba17424593e5b263f867a0da259f4bfe6bb04733cdf9650637eed85d">BATCH</a> || policy == <a class="code" href="namespacesched.html#a51639e5b9ba17424593e5b263f867a0daebaee7d1ec50f96b6ab8f531f92cf56e">IDLE</a>) &&</div> |
| <div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  priority != 0) {</div> |
| <div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keywordflow">return</span> <a class="code" href="classError.html">Error</a>(<span class="stringliteral">"Non-real-time scheduling policies only support priority = 0"</span>);</div> |
| <div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  }</div> |
| <div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div> |
| <div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  sched_param param;</div> |
| <div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  param.sched_priority = priority;</div> |
| <div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div> |
| <div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keywordflow">if</span> (sched_setscheduler(pid.isSome() ? pid.get() : 0, policy, &param) == -1) {</div> |
| <div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keywordflow">return</span> <a class="code" href="classErrnoError.html">ErrnoError</a>(<span class="stringliteral">"Failed to set scheduler policy"</span>);</div> |
| <div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  }</div> |
| <div class="line"><a name="l00088"></a><span class="lineno"> 88</span> </div> |
| <div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keywordflow">return</span> <a class="code" href="structNothing.html">Nothing</a>();</div> |
| <div class="line"><a name="l00090"></a><span class="lineno"> 90</span> }</div> |
| <div class="line"><a name="l00091"></a><span class="lineno"> 91</span> </div> |
| <div class="line"><a name="l00092"></a><span class="lineno"> 92</span> } <span class="comment">// namespace policy {</span></div> |
| <div class="line"><a name="l00093"></a><span class="lineno"> 93</span> } <span class="comment">// namespace sched {</span></div> |
| <div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div> |
| <div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="preprocessor">#endif // __LINUX_SCHED_HPP__</span></div> |
| <div class="ttc" id="namespacesched_html_a51639e5b9ba17424593e5b263f867a0da3b0554820cb08d52616cdfde896067d4"><div class="ttname"><a href="namespacesched.html#a51639e5b9ba17424593e5b263f867a0da3b0554820cb08d52616cdfde896067d4">sched::FIFO</a></div><div class="ttdef"><b>Definition:</b> sched.hpp:46</div></div> |
| <div class="ttc" id="structNothing_html"><div class="ttname"><a href="structNothing.html">Nothing</a></div><div class="ttdef"><b>Definition:</b> nothing.hpp:16</div></div> |
| <div class="ttc" id="classError_html"><div class="ttname"><a href="classError.html">Error</a></div><div class="ttdef"><b>Definition:</b> errorbase.hpp:35</div></div> |
| <div class="ttc" id="classOption_html"><div class="ttname"><a href="classOption.html">Option< pid_t ></a></div></div> |
| <div class="ttc" id="classTry_html"><div class="ttname"><a href="classTry.html">Try</a></div><div class="ttdef"><b>Definition:</b> try.hpp:34</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< ProcessStatus > status(pid_t pid)</div><div class="ttdef"><b>Definition:</b> proc.hpp:166</div></div> |
| <div class="ttc" id="none_8hpp_html"><div class="ttname"><a href="none_8hpp.html">none.hpp</a></div></div> |
| <div class="ttc" id="classErrnoError_html"><div class="ttname"><a href="classErrnoError.html">ErrnoError</a></div><div class="ttdef"><b>Definition:</b> errorbase.hpp:44</div></div> |
| <div class="ttc" id="namespacesched_html_a51639e5b9ba17424593e5b263f867a0d"><div class="ttname"><a href="namespacesched.html#a51639e5b9ba17424593e5b263f867a0d">sched::Policy</a></div><div class="ttdeci">Policy</div><div class="ttdef"><b>Definition:</b> sched.hpp:41</div></div> |
| <div class="ttc" id="namespacesched_html_a51639e5b9ba17424593e5b263f867a0daebaee7d1ec50f96b6ab8f531f92cf56e"><div class="ttname"><a href="namespacesched.html#a51639e5b9ba17424593e5b263f867a0daebaee7d1ec50f96b6ab8f531f92cf56e">sched::IDLE</a></div><div class="ttdef"><b>Definition:</b> sched.hpp:45</div></div> |
| <div class="ttc" id="nothing_8hpp_html"><div class="ttname"><a href="nothing_8hpp.html">nothing.hpp</a></div></div> |
| <div class="ttc" id="namespacesched_html_a51639e5b9ba17424593e5b263f867a0da8964a9f6005e1a993ae167a3258feea5"><div class="ttname"><a href="namespacesched.html#a51639e5b9ba17424593e5b263f867a0da8964a9f6005e1a993ae167a3258feea5">sched::RR</a></div><div class="ttdef"><b>Definition:</b> sched.hpp:47</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="namespacesched_html_a51639e5b9ba17424593e5b263f867a0da0249cd4af5697d05fc0ae0e9e8cb602c"><div class="ttname"><a href="namespacesched.html#a51639e5b9ba17424593e5b263f867a0da0249cd4af5697d05fc0ae0e9e8cb602c">sched::OTHER</a></div><div class="ttdef"><b>Definition:</b> sched.hpp:43</div></div> |
| <div class="ttc" id="namespacesched_html_a51639e5b9ba17424593e5b263f867a0da259f4bfe6bb04733cdf9650637eed85d"><div class="ttname"><a href="namespacesched.html#a51639e5b9ba17424593e5b263f867a0da259f4bfe6bb04733cdf9650637eed85d">sched::BATCH</a></div><div class="ttdef"><b>Definition:</b> sched.hpp:44</div></div> |
| <div class="ttc" id="error_8hpp_html"><div class="ttname"><a href="error_8hpp.html">error.hpp</a></div></div> |
| <div class="ttc" id="structNone_html"><div class="ttname"><a href="structNone.html">None</a></div><div class="ttdef"><b>Definition:</b> none.hpp:27</div></div> |
| <div class="ttc" id="try_8hpp_html"><div class="ttname"><a href="try_8hpp.html">try.hpp</a></div></div> |
| <div class="ttc" id="namespacesched_1_1policy_html_a96002502928baa764f913e8bce175b32"><div class="ttname"><a href="namespacesched_1_1policy.html#a96002502928baa764f913e8bce175b32">sched::policy::set</a></div><div class="ttdeci">Try< Nothing > set(Policy policy, const Option< pid_t > &pid=None(), int priority=0)</div><div class="ttdef"><b>Definition:</b> sched.hpp:72</div></div> |
| </div><!-- fragment --></div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.5 |
| </small></address> |
| </body> |
| </html> |