| <!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/perf.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">perf.hpp</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="perf_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 __PERF_HPP__</span></div> |
| <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor"></span><span class="preprocessor">#define __PERF_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="preprocessor">#include <unistd.h></span></div> |
| <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div> |
| <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include <set></span></div> |
| <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <string></span></div> |
| <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div> |
| <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <<a class="code" href="future_8hpp.html">process/future.hpp</a>></span></div> |
| <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div> |
| <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <<a class="code" href="duration_8hpp.html">stout/duration.hpp</a>></span></div> |
| <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include <<a class="code" href="hashmap_8hpp.html">stout/hashmap.hpp</a>></span></div> |
| <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include <<a class="code" href="3rdparty_2stout_2include_2stout_2version_8hpp.html">stout/version.hpp</a>></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="comment">// For PerfStatistics protobuf.</span></div> |
| <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include "<a class="code" href="include_2mesos_2mesos_8hpp.html">mesos/mesos.hpp</a>"</span></div> |
| <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div> |
| <div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="namespaceperf.html"> 34</a></span> <span class="keyword">namespace </span>perf {</div> |
| <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div> |
| <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">// Sample the perf events for process(es) in the perf_event cgroups</span></div> |
| <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment">// for duration. The returned hashmap is keyed by cgroup.</span></div> |
| <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment">// NOTE: cgroups should be relative to the perf_event subsystem mount,</span></div> |
| <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment">// e.g., mesos/test for /sys/fs/cgroup/perf_event/mesos/test.</span></div> |
| <div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <a class="code" href="classprocess_1_1Future.html">process::Future<hashmap<std::string, mesos::PerfStatistics></a>> <a class="code" href="namespaceperf.html#a1da325bd0688dc480ff4d5159d620310">sample</a>(</div> |
| <div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keyword">const</span> std::set<std::string>& events,</div> |
| <div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keyword">const</span> std::set<std::string>& cgroups,</div> |
| <div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keyword">const</span> <a class="code" href="classDuration.html">Duration</a>& duration);</div> |
| <div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div> |
| <div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div> |
| <div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment">// Validate a set of events are accepted by `perf stat`.</span></div> |
| <div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="keywordtype">bool</span> <a class="code" href="namespaceperf.html#ad4bda81f92db3821306ec856dfca9a77">valid</a>(<span class="keyword">const</span> std::set<std::string>& events);</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> <span class="comment">// Returns whether perf is supported on this host. Returns false if</span></div> |
| <div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment">// the kernel is too old (requires >= 2.6.39).</span></div> |
| <div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="keywordtype">bool</span> <a class="code" href="namespaceperf.html#a305765234cd6747318f894ea1a5c0aef">supported</a>();</div> |
| <div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div> |
| <div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div> |
| <div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment">// Note: The parse function is exposed to allow testing of the</span></div> |
| <div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment">// multiple supported perf stat output formats.</span></div> |
| <div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <a class="code" href="classTry.html">Try<hashmap<std::string, mesos::PerfStatistics></a>> <a class="code" href="namespaceperf.html#a38f6b8b99bfe38c10b9ceb1d5d3d2002">parse</a>(</div> |
| <div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keyword">const</span> std::string& output,</div> |
| <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keyword">const</span> <a class="code" href="structVersion.html">Version</a>& <a class="code" href="namespacemesos_1_1internal.html#a4311a7bd3d79fd1225d08444f8ff758a">version</a>);</div> |
| <div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div> |
| <div class="line"><a name="l00061"></a><span class="lineno"> 61</span> } <span class="comment">// namespace perf {</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="preprocessor">#endif // __PERF_HPP__</span></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="include_2mesos_2mesos_8hpp_html"><div class="ttname"><a href="include_2mesos_2mesos_8hpp.html">mesos.hpp</a></div></div> |
| <div class="ttc" id="namespacemesos_1_1internal_html_a4311a7bd3d79fd1225d08444f8ff758a"><div class="ttname"><a href="namespacemesos_1_1internal.html#a4311a7bd3d79fd1225d08444f8ff758a">mesos::internal::version</a></div><div class="ttdeci">JSON::Object version()</div><div class="ttdef"><b>Definition:</b> version.hpp:32</div></div> |
| <div class="ttc" id="classDuration_html"><div class="ttname"><a href="classDuration.html">Duration</a></div><div class="ttdef"><b>Definition:</b> duration.hpp:32</div></div> |
| <div class="ttc" id="namespaceperf_html_ad4bda81f92db3821306ec856dfca9a77"><div class="ttname"><a href="namespaceperf.html#ad4bda81f92db3821306ec856dfca9a77">perf::valid</a></div><div class="ttdeci">bool valid(const std::set< std::string > &events)</div></div> |
| <div class="ttc" id="3rdparty_2stout_2include_2stout_2version_8hpp_html"><div class="ttname"><a href="3rdparty_2stout_2include_2stout_2version_8hpp.html">version.hpp</a></div></div> |
| <div class="ttc" id="namespaceperf_html_a38f6b8b99bfe38c10b9ceb1d5d3d2002"><div class="ttname"><a href="namespaceperf.html#a38f6b8b99bfe38c10b9ceb1d5d3d2002">perf::parse</a></div><div class="ttdeci">Try< hashmap< std::string, mesos::PerfStatistics > > parse(const std::string &output, const Version &version)</div></div> |
| <div class="ttc" id="duration_8hpp_html"><div class="ttname"><a href="duration_8hpp.html">duration.hpp</a></div></div> |
| <div class="ttc" id="namespaceperf_html_a305765234cd6747318f894ea1a5c0aef"><div class="ttname"><a href="namespaceperf.html#a305765234cd6747318f894ea1a5c0aef">perf::supported</a></div><div class="ttdeci">bool supported()</div></div> |
| <div class="ttc" id="namespaceperf_html_a1da325bd0688dc480ff4d5159d620310"><div class="ttname"><a href="namespaceperf.html#a1da325bd0688dc480ff4d5159d620310">perf::sample</a></div><div class="ttdeci">process::Future< hashmap< std::string, mesos::PerfStatistics > > sample(const std::set< std::string > &events, const std::set< std::string > &cgroups, const Duration &duration)</div></div> |
| <div class="ttc" id="future_8hpp_html"><div class="ttname"><a href="future_8hpp.html">future.hpp</a></div></div> |
| <div class="ttc" id="structVersion_html"><div class="ttname"><a href="structVersion.html">Version</a></div><div class="ttdef"><b>Definition:</b> version.hpp:37</div></div> |
| <div class="ttc" id="hashmap_8hpp_html"><div class="ttname"><a href="hashmap_8hpp.html">hashmap.hpp</a></div></div> |
| <div class="ttc" id="classprocess_1_1Future_html"><div class="ttname"><a href="classprocess_1_1Future.html">process::Future</a></div><div class="ttdef"><b>Definition:</b> future.hpp:56</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> |
