adam/metasploit-gs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
gh-pages
metasploit-gs/api/Metasploit/Framework/Profiler.html
T
jenkins-metasploit c3f5bd3de2 Reboot gh-pages
2026-05-08 17:08:43 +00:00

374 lines
12 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: Metasploit::Framework::Profiler
&mdash; Documentation by YARD 0.9.37
</title>
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Metasploit::Framework::Profiler";
relpath = '../../';
</script>
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (P)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Framework.html" title="Metasploit::Framework (module)">Framework</a></span></span>
&raquo;
<span class="title">Profiler</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: Metasploit::Framework::Profiler
</h1>
<div class="box_info">
<dl>
<dt>Defined in:</dt>
<dd>lib/metasploit/framework/profiler.rb</dd>
</dl>
</div>
<h2>
Class Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#record_cpu-class_method" title="record_cpu (class method)">.<strong>record_cpu</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#record_memory-class_method" title="record_memory (class method)">.<strong>record_memory</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#start-class_method" title="start (class method)">.<strong>start</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="record_cpu-class_method">
.<strong>record_cpu</strong> &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
42
43
44
45
46
47
48
49
50
51
52
53</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/profiler.rb', line 42</span>
<span class='kw'>def</span> <span class='id identifier rubyid_record_cpu'>record_cpu</span>
<span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ruby-prof</span><span class='tstring_end'>&#39;</span></span>
<span class='id identifier rubyid_results_path'>results_path</span> <span class='op'>=</span> <span class='id identifier rubyid_tmp_cpu_results_path'>tmp_cpu_results_path</span>
<span class='id identifier rubyid_profile'>profile</span> <span class='op'>=</span> <span class='const'>RubyProf</span><span class='op'>::</span><span class='const'>Profile</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
<span class='id identifier rubyid_profile'>profile</span><span class='period'>.</span><span class='id identifier rubyid_start'>start</span>
<span class='kw'>yield</span>
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='id identifier rubyid_profile'>profile</span><span class='period'>.</span><span class='id identifier rubyid_stop'>stop</span>
<span class='id identifier rubyid_save_cpu_result'>save_cpu_result</span><span class='lparen'>(</span><span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> <span class='label'>path:</span> <span class='id identifier rubyid_results_path'>results_path</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="record_memory-class_method">
.<strong>record_memory</strong> &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
55
56
57
58
59
60
61
62
63
64
65
66
67
68</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/profiler.rb', line 55</span>
<span class='kw'>def</span> <span class='id identifier rubyid_record_memory'>record_memory</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Cannot mix global memory recording and localised memory recording</span><span class='tstring_end'>&#39;</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_record_global_memory?'>record_global_memory?</span>
<span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>memory_profiler</span><span class='tstring_end'>&#39;</span></span>
<span class='id identifier rubyid_results_path'>results_path</span> <span class='op'>=</span> <span class='id identifier rubyid_tmp_memory_results_path'>tmp_memory_results_path</span>
<span class='id identifier rubyid_profile'>profile</span> <span class='op'>=</span> <span class='const'>MemoryProfiler</span>
<span class='id identifier rubyid_profile'>profile</span><span class='period'>.</span><span class='id identifier rubyid_start'>start</span>
<span class='kw'>yield</span>
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='id identifier rubyid_profile'>profile</span><span class='period'>.</span><span class='id identifier rubyid_stop'>stop</span>
<span class='id identifier rubyid_save_memory_result'>save_memory_result</span><span class='lparen'>(</span><span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> <span class='label'>path:</span> <span class='id identifier rubyid_results_path'>results_path</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="start-class_method">
.<strong>start</strong> &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/profiler.rb', line 10</span>
<span class='kw'>def</span> <span class='id identifier rubyid_start'>start</span>
<span class='kw'>return</span> <span class='kw'>unless</span> <span class='id identifier rubyid_record_global_cpu?'>record_global_cpu?</span> <span class='op'>||</span> <span class='id identifier rubyid_record_global_memory?'>record_global_memory?</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Cannot profile memory and cpu at the same time</span><span class='tstring_end'>&#39;</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_record_global_cpu?'>record_global_cpu?</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_record_global_memory?'>record_global_memory?</span>
<span class='kw'>if</span> <span class='id identifier rubyid_record_global_cpu?'>record_global_cpu?</span>
<span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ruby-prof</span><span class='tstring_end'>&#39;</span></span>
<span class='id identifier rubyid_results_path'>results_path</span> <span class='op'>=</span> <span class='id identifier rubyid_tmp_cpu_results_path'>tmp_cpu_results_path</span>
<span class='id identifier rubyid_profile'>profile</span> <span class='op'>=</span> <span class='const'>RubyProf</span><span class='op'>::</span><span class='const'>Profile</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
<span class='id identifier rubyid_profile'>profile</span><span class='period'>.</span><span class='id identifier rubyid_start'>start</span>
<span class='id identifier rubyid_at_exit'>at_exit</span> <span class='kw'>do</span>
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='id identifier rubyid_profile'>profile</span><span class='period'>.</span><span class='id identifier rubyid_stop'>stop</span>
<span class='id identifier rubyid_save_cpu_result'>save_cpu_result</span><span class='lparen'>(</span><span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> <span class='label'>path:</span> <span class='id identifier rubyid_results_path'>results_path</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>if</span> <span class='id identifier rubyid_record_global_memory?'>record_global_memory?</span>
<span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>memory_profiler</span><span class='tstring_end'>&#39;</span></span>
<span class='id identifier rubyid_results_path'>results_path</span> <span class='op'>=</span> <span class='id identifier rubyid_tmp_memory_results_path'>tmp_memory_results_path</span>
<span class='id identifier rubyid_profile'>profile</span> <span class='op'>=</span> <span class='const'>MemoryProfiler</span>
<span class='id identifier rubyid_profile'>profile</span><span class='period'>.</span><span class='id identifier rubyid_start'>start</span>
<span class='id identifier rubyid_at_exit'>at_exit</span> <span class='kw'>do</span>
<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Generating memory dump </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_results_path'>results_path</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='id identifier rubyid_profile'>profile</span><span class='period'>.</span><span class='id identifier rubyid_stop'>stop</span>
<span class='id identifier rubyid_save_memory_result'>save_memory_result</span><span class='lparen'>(</span><span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> <span class='label'>path:</span> <span class='id identifier rubyid_results_path'>results_path</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Fri May 8 17:02:52 2026 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.37 (ruby-3.1.5).
</div>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink