10 lines
19 KiB
HTML
10 lines
19 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Profiling · The Julia Language</title><script>(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
||
|
||
ga('create', 'UA-28835595-6', 'auto');
|
||
ga('send', 'pageview');
|
||
</script><link href="https://cdnjs.cloudflare.com/ajax/libs/normalize/4.2.0/normalize.min.css" rel="stylesheet" type="text/css"/><link href="https://fonts.googleapis.com/css?family=Lato|Roboto+Mono" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.6.3/css/font-awesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.2.0/require.min.js" data-main="../assets/documenter.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link href="../assets/documenter.css" rel="stylesheet" type="text/css"/><link href="../assets/julia-manual.css" rel="stylesheet" type="text/css"/></head><body><nav class="toc"><a href="../index.html"><img class="logo" src="../assets/logo.png" alt="The Julia Language logo"/></a><h1>The Julia Language</h1><select id="version-selector" onChange="window.location.href=this.value" style="visibility: hidden"></select><form class="search" id="search-form" action="../search.html"><input id="search-query" name="q" type="text" placeholder="Search docs"/></form><ul><li><a class="toctext" href="../index.html">Home</a></li><li><span class="toctext">Manual</span><ul><li><a class="toctext" href="../manual/introduction.html">Introduction</a></li><li><a class="toctext" href="../manual/getting-started.html">Getting Started</a></li><li><a class="toctext" href="../manual/variables.html">Variables</a></li><li><a class="toctext" href="../manual/integers-and-floating-point-numbers.html">Integers and Floating-Point Numbers</a></li><li><a class="toctext" href="../manual/mathematical-operations.html">Mathematical Operations and Elementary Functions</a></li><li><a class="toctext" href="../manual/complex-and-rational-numbers.html">Complex and Rational Numbers</a></li><li><a class="toctext" href="../manual/strings.html">Strings</a></li><li><a class="toctext" href="../manual/functions.html">Functions</a></li><li><a class="toctext" href="../manual/control-flow.html">Control Flow</a></li><li><a class="toctext" href="../manual/variables-and-scoping.html">Scope of Variables</a></li><li><a class="toctext" href="../manual/types.html">Types</a></li><li><a class="toctext" href="../manual/methods.html">Methods</a></li><li><a class="toctext" href="../manual/constructors.html">Constructors</a></li><li><a class="toctext" href="../manual/conversion-and-promotion.html">Conversion and Promotion</a></li><li><a class="toctext" href="../manual/interfaces.html">Interfaces</a></li><li><a class="toctext" href="../manual/modules.html">Modules</a></li><li><a class="toctext" href="../manual/documentation.html">Documentation</a></li><li><a class="toctext" href="../manual/metaprogramming.html">Metaprogramming</a></li><li><a class="toctext" href="../manual/arrays.html">Multi-dimensional Arrays</a></li><li><a class="toctext" href="../manual/linear-algebra.html">Linear algebra</a></li><li><a class="toctext" href="../manual/networking-and-streams.html">Networking and Streams</a></li><li><a class="toctext" href="../manual/parallel-computing.html">Parallel Computing</a></li><li><a class="toctext" href="../manual/dates.html">Date and DateTime</a></li><li><a class="toctext" href="../manual/interacting-with-julia.html">Interacting With Julia</a></li><li><a class="toctext" href="../manual/running-external-programs.html">Running External Programs</a></li><li><a class="toctext" href="../manual/calling-c-and-fortran-code.html">Calling C and Fortran Code</a></li><li><a class="toctext" href="../manual/handling-operating-system-variation.html">Handling Operating System Variation</a></li><li><a class="toctext" href="../manual/environment-variables.html">Environment Variables</a></li><li><a class="toctext" href="../manual/embedding.html">Embedding Julia</a></li><li><a class="toctext" href="../manual/packages.html">Packages</a></li><li><a class="toctext" href="../manual/profile.html">Profiling</a></li><li><a class="toctext" href="../manual/stacktraces.html">Stack Traces</a></li><li><a class="toctext" href="../manual/performance-tips.html">Performance Tips</a></li><li><a class="toctext" href="../manual/workflow-tips.html">Workflow Tips</a></li><li><a class="toctext" href="../manual/style-guide.html">Style Guide</a></li><li><a class="toctext" href="../manual/faq.html">Frequently Asked Questions</a></li><li><a class="toctext" href="../manual/noteworthy-differences.html">Noteworthy Differences from other Languages</a></li><li><a class="toctext" href="../manual/unicode-input.html">Unicode Input</a></li></ul></li><li><span class="toctext">Standard Library</span><ul><li><a class="toctext" href="base.html">Essentials</a></li><li><a class="toctext" href="collections.html">Collections and Data Structures</a></li><li><a class="toctext" href="math.html">Mathematics</a></li><li><a class="toctext" href="numbers.html">Numbers</a></li><li><a class="toctext" href="strings.html">Strings</a></li><li><a class="toctext" href="arrays.html">Arrays</a></li><li><a class="toctext" href="parallel.html">Tasks and Parallel Computing</a></li><li><a class="toctext" href="linalg.html">Linear Algebra</a></li><li><a class="toctext" href="constants.html">Constants</a></li><li><a class="toctext" href="file.html">Filesystem</a></li><li><a class="toctext" href="io-network.html">I/O and Network</a></li><li><a class="toctext" href="punctuation.html">Punctuation</a></li><li><a class="toctext" href="sort.html">Sorting and Related Functions</a></li><li><a class="toctext" href="pkg.html">Package Manager Functions</a></li><li><a class="toctext" href="dates.html">Dates and Time</a></li><li><a class="toctext" href="iterators.html">Iteration utilities</a></li><li><a class="toctext" href="test.html">Unit Testing</a></li><li><a class="toctext" href="c.html">C Interface</a></li><li><a class="toctext" href="libc.html">C Standard Library</a></li><li><a class="toctext" href="libdl.html">Dynamic Linker</a></li><li class="current"><a class="toctext" href="profile.html">Profiling</a><ul class="internal"></ul></li><li><a class="toctext" href="stacktraces.html">StackTraces</a></li><li><a class="toctext" href="simd-types.html">SIMD Support</a></li></ul></li><li><span class="toctext">Developer Documentation</span><ul><li><a class="toctext" href="../devdocs/reflection.html">Reflection and introspection</a></li><li><span class="toctext">Documentation of Julia's Internals</span><ul><li><a class="toctext" href="../devdocs/init.html">Initialization of the Julia runtime</a></li><li><a class="toctext" href="../devdocs/ast.html">Julia ASTs</a></li><li><a class="toctext" href="../devdocs/types.html">More about types</a></li><li><a class="toctext" href="../devdocs/object.html">Memory layout of Julia Objects</a></li><li><a class="toctext" href="../devdocs/eval.html">Eval of Julia code</a></li><li><a class="toctext" href="../devdocs/callconv.html">Calling Conventions</a></li><li><a class="toctext" href="../devdocs/compiler.html">High-level Overview of the Native-Code Generation Process</a></li><li><a class="toctext" href="../devdocs/functions.html">Julia Functions</a></li><li><a class="toctext" href="../devdocs/cartesian.html">Base.Cartesian</a></li><li><a class="toctext" href="../devdocs/meta.html">Talking to the compiler (the <code>:meta</code> mechanism)</a></li><li><a class="toctext" href="../devdocs/subarrays.html">SubArrays</a></li><li><a class="toctext" href="../devdocs/sysimg.html">System Image Building</a></li><li><a class="toctext" href="../devdocs/llvm.html">Working with LLVM</a></li><li><a class="toctext" href="../devdocs/stdio.html">printf() and stdio in the Julia runtime</a></li><li><a class="toctext" href="../devdocs/boundscheck.html">Bounds checking</a></li><li><a class="toctext" href="../devdocs/locks.html">Proper maintenance and care of multi-threading locks</a></li><li><a class="toctext" href="../devdocs/offset-arrays.html">Arrays with custom indices</a></li><li><a class="toctext" href="../devdocs/libgit2.html">Base.LibGit2</a></li><li><a class="toctext" href="../devdocs/require.html">Module loading</a></li></ul></li><li><span class="toctext">Developing/debugging Julia's C code</span><ul><li><a class="toctext" href="../devdocs/backtraces.html">Reporting and analyzing crashes (segfaults)</a></li><li><a class="toctext" href="../devdocs/debuggingtips.html">gdb debugging tips</a></li><li><a class="toctext" href="../devdocs/valgrind.html">Using Valgrind with Julia</a></li><li><a class="toctext" href="../devdocs/sanitizers.html">Sanitizer support</a></li></ul></li></ul></li></ul></nav><article id="docs"><header><nav><ul><li>Standard Library</li><li><a href="profile.html">Profiling</a></li></ul><a class="edit-page" href="https://github.com/JuliaLang/julia/blob/master/doc/src/stdlib/profile.md"><span class="fa"></span> Edit on GitHub</a></nav><hr/><div id="topbar"><span>Profiling</span><a class="fa fa-bars" href="#"></a></div></header><h1><a class="nav-anchor" id="lib-profiling-1" href="#lib-profiling-1">Profiling</a></h1><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="Base.Profile.@profile" href="#Base.Profile.@profile"><code>Base.Profile.@profile</code></a> — <span class="docstring-category">Macro</span>.</div><div><pre><code class="language-none">@profile</code></pre><p><code>@profile <expression></code> runs your expression while taking periodic backtraces. These are appended to an internal buffer of backtraces.</p></div><a class="source-link" target="_blank" href="https://github.com/JuliaLang/julia/blob/d55cadc350d426a95fd967121ba77494d08364c8/base/profile.jl#L10-L15">source</a></section><p>The methods in <code>Base.Profile</code> are not exported and need to be called e.g. as <code>Profile.print()</code>.</p><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="Base.Profile.clear" href="#Base.Profile.clear"><code>Base.Profile.clear</code></a> — <span class="docstring-category">Function</span>.</div><div><pre><code class="language-none">clear()</code></pre><p>Clear any existing backtraces from the internal buffer.</p></div><a class="source-link" target="_blank" href="https://github.com/JuliaLang/julia/blob/d55cadc350d426a95fd967121ba77494d08364c8/base/profile.jl#L69-L73">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="Base.Profile.print" href="#Base.Profile.print"><code>Base.Profile.print</code></a> — <span class="docstring-category">Function</span>.</div><div><pre><code class="language-none">print([io::IO = STDOUT,] [data::Vector]; kwargs...)</code></pre><p>Prints profiling results to <code>io</code> (by default, <code>STDOUT</code>). If you do not supply a <code>data</code> vector, the internal buffer of accumulated backtraces will be used.</p><p>The keyword arguments can be any combination of:</p><ul><li><p><code>format</code> – Determines whether backtraces are printed with (default, <code>:tree</code>) or without (<code>:flat</code>) indentation indicating tree structure.</p></li><li><p><code>C</code> – If <code>true</code>, backtraces from C and Fortran code are shown (normally they are excluded).</p></li><li><p><code>combine</code> – If <code>true</code> (default), instruction pointers are merged that correspond to the same line of code.</p></li><li><p><code>maxdepth</code> – Limits the depth higher than <code>maxdepth</code> in the <code>:tree</code> format.</p></li><li><p><code>sortedby</code> – Controls the order in <code>:flat</code> format. <code>:filefuncline</code> (default) sorts by the source line, whereas <code>:count</code> sorts in order of number of collected samples.</p></li><li><p><code>noisefloor</code> – Limits frames that exceed the heuristic noise floor of the sample (only applies to format <code>:tree</code>). A suggested value to try for this is 2.0 (the default is 0). This parameter hides samples for which <code>n <= noisefloor * √N</code>, where <code>n</code> is the number of samples on this line, and <code>N</code> is the number of samples for the callee.</p></li><li><p><code>mincount</code> – Limits the printout to only those lines with at least <code>mincount</code> occurrences.</p></li></ul></div><a class="source-link" target="_blank" href="https://github.com/JuliaLang/julia/blob/d55cadc350d426a95fd967121ba77494d08364c8/base/profile.jl#L97-L123">source</a><div><pre><code class="language-none">print([io::IO = STDOUT,] data::Vector, lidict::LineInfoDict; kwargs...)</code></pre><p>Prints profiling results to <code>io</code>. This variant is used to examine results exported by a previous call to <a href="profile.html#Base.Profile.retrieve"><code>retrieve</code></a>. Supply the vector <code>data</code> of backtraces and a dictionary <code>lidict</code> of line information.</p><p>See <code>Profile.print([io], data)</code> for an explanation of the valid keyword arguments.</p></div><a class="source-link" target="_blank" href="https://github.com/JuliaLang/julia/blob/d55cadc350d426a95fd967121ba77494d08364c8/base/profile.jl#L152-L160">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="Base.Profile.init" href="#Base.Profile.init"><code>Base.Profile.init</code></a> — <span class="docstring-category">Function</span>.</div><div><pre><code class="language-none">init(; n::Integer, delay::Float64)</code></pre><p>Configure the <code>delay</code> between backtraces (measured in seconds), and the number <code>n</code> of instruction pointers that may be stored. Each instruction pointer corresponds to a single line of code; backtraces generally consist of a long list of instruction pointers. Default settings can be obtained by calling this function with no arguments, and each can be set independently using keywords or in the order <code>(n, delay)</code>.</p></div><a class="source-link" target="_blank" href="https://github.com/JuliaLang/julia/blob/d55cadc350d426a95fd967121ba77494d08364c8/base/profile.jl#L34-L42">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="Base.Profile.fetch" href="#Base.Profile.fetch"><code>Base.Profile.fetch</code></a> — <span class="docstring-category">Function</span>.</div><div><pre><code class="language-none">fetch() -> data</code></pre><p>Returns a reference to the internal buffer of backtraces. Note that subsequent operations, like <a href="profile.html#Base.Profile.clear"><code>clear</code></a>, can affect <code>data</code> unless you first make a copy. Note that the values in <code>data</code> have meaning only on this machine in the current session, because it depends on the exact memory addresses used in JIT-compiling. This function is primarily for internal use; <a href="profile.html#Base.Profile.retrieve"><code>retrieve</code></a> may be a better choice for most users.</p></div><a class="source-link" target="_blank" href="https://github.com/JuliaLang/julia/blob/d55cadc350d426a95fd967121ba77494d08364c8/base/profile.jl#L292-L300">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="Base.Profile.retrieve" href="#Base.Profile.retrieve"><code>Base.Profile.retrieve</code></a> — <span class="docstring-category">Function</span>.</div><div><pre><code class="language-none">retrieve() -> data, lidict</code></pre><p>"Exports" profiling results in a portable format, returning the set of all backtraces (<code>data</code>) and a dictionary that maps the (session-specific) instruction pointers in <code>data</code> to <code>LineInfo</code> values that store the file name, function name, and line number. This function allows you to save profiling results for future analysis.</p></div><a class="source-link" target="_blank" href="https://github.com/JuliaLang/julia/blob/d55cadc350d426a95fd967121ba77494d08364c8/base/profile.jl#L164-L171">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="Base.Profile.callers" href="#Base.Profile.callers"><code>Base.Profile.callers</code></a> — <span class="docstring-category">Function</span>.</div><div><pre><code class="language-none">callers(funcname, [data, lidict], [filename=<filename>], [linerange=<start:stop>]) -> Vector{Tuple{count, lineinfo}}</code></pre><p>Given a previous profiling run, determine who called a particular function. Supplying the filename (and optionally, range of line numbers over which the function is defined) allows you to disambiguate an overloaded method. The returned value is a vector containing a count of the number of calls and line information about the caller. One can optionally supply backtrace <code>data</code> obtained from <a href="profile.html#Base.Profile.retrieve"><code>retrieve</code></a>; otherwise, the current internal profile buffer is used.</p></div><a class="source-link" target="_blank" href="https://github.com/JuliaLang/julia/blob/d55cadc350d426a95fd967121ba77494d08364c8/base/profile.jl#L226-L235">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="Base.Profile.clear_malloc_data" href="#Base.Profile.clear_malloc_data"><code>Base.Profile.clear_malloc_data</code></a> — <span class="docstring-category">Function</span>.</div><div><pre><code class="language-none">clear_malloc_data()</code></pre><p>Clears any stored memory allocation data when running julia with <code>--track-allocation</code>. Execute the command(s) you want to test (to force JIT-compilation), then call <a href="profile.html#Base.Profile.clear_malloc_data"><code>clear_malloc_data</code></a>. Then execute your command(s) again, quit Julia, and examine the resulting <code>*.mem</code> files.</p></div><a class="source-link" target="_blank" href="https://github.com/JuliaLang/julia/blob/d55cadc350d426a95fd967121ba77494d08364c8/base/profile.jl#L262-L269">source</a></section><footer><hr/><a class="previous" href="libdl.html"><span class="direction">Previous</span><span class="title">Dynamic Linker</span></a><a class="next" href="stacktraces.html"><span class="direction">Next</span><span class="title">StackTraces</span></a></footer></article></body></html>
|