Baoding-FenShuaJiang
/
Green_GoodERP18_FSJ_Standard
Наблюдаван 1
Харесван 0
Уики 捐赠
gooderp18绿色标准版
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Клон: master
Клонове Маркери
${ item.name }
Create branch ${ searchTerm }
от 'master'
${ noResults }
Green_GoodERP18_FSJ_Standard/python/Doc/html/c-api/perfmaps.html

361 lines
19KB
Директен файл Постоянна връзка Blame История 

  1. <!DOCTYPE html>

  2. 

  3. <html lang="en" data-content_root="../">

  4.   <head>

  5.     <meta charset="utf-8" />

  6.     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

  7. <meta property="og:title" content="Support for Perf Maps" />

  8. <meta property="og:type" content="website" />

  9. <meta property="og:url" content="https://docs.python.org/3/c-api/perfmaps.html" />

  10. <meta property="og:site_name" content="Python documentation" />

  11. <meta property="og:description" content="On supported platforms (as of this writing, only Linux), the runtime can take advantage of perf map files to make Python functions visible to an external profiling tool (such as perf). A running pr..." />

  12. <meta property="og:image" content="https://docs.python.org/3/_static/og-image.png" />

  13. <meta property="og:image:alt" content="Python documentation" />

  14. <meta name="description" content="On supported platforms (as of this writing, only Linux), the runtime can take advantage of perf map files to make Python functions visible to an external profiling tool (such as perf). A running pr..." />

  15. <meta property="og:image:width" content="200" />

  16. <meta property="og:image:height" content="200" />

  17. <meta name="theme-color" content="#3776ab" />

  18. 

  19.     <title>Support for Perf Maps &#8212; Python 3.12.3 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">

  20.     

  21.     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />

  22.     <link rel="stylesheet" type="text/css" href="../_static/pydoctheme.css?v=bb723527" />

  23.     <link id="pygments_dark_css" media="(prefers-color-scheme: dark)" rel="stylesheet" type="text/css" href="../_static/pygments_dark.css?v=b20cc3f5" />

  24.     

  25.     <script src="../_static/documentation_options.js?v=2c828074"></script>

  26.     <script src="../_static/doctools.js?v=888ff710"></script>

  27.     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>

  28.     

  29.     <script src="../_static/sidebar.js"></script>

  30.     

  31.     <link rel="search" type="application/opensearchdescription+xml"

  32.           title="Search within Python 3.12.3 documentation"

  33.           href="../_static/opensearch.xml"/>

  34.     <link rel="author" title="About these documents" href="../about.html" />

  35.     <link rel="index" title="Index" href="../genindex.html" />

  36.     <link rel="search" title="Search" href="../search.html" />

  37.     <link rel="copyright" title="Copyright" href="../copyright.html" />

  38.     <link rel="next" title="Abstract Objects Layer" href="abstract.html" />

  39.     <link rel="prev" title="Codec registry and support functions" href="codec.html" />

  40.     <link rel="canonical" href="https://docs.python.org/3/c-api/perfmaps.html" />

  41.     

  42.       

  43.     

  44. 

  45.     

  46.     <style>

  47.       @media only screen {

  48.         table.full-width-table {

  49.             width: 100%;

  50.         }

  51.       }

  52.     </style>

  53. <link rel="stylesheet" href="../_static/pydoctheme_dark.css" media="(prefers-color-scheme: dark)" id="pydoctheme_dark_css">

  54.     <link rel="shortcut icon" type="image/png" href="../_static/py.svg" />

  55.             <script type="text/javascript" src="../_static/copybutton.js"></script>

  56.             <script type="text/javascript" src="../_static/menu.js"></script>

  57.             <script type="text/javascript" src="../_static/search-focus.js"></script>

  58.             <script type="text/javascript" src="../_static/themetoggle.js"></script> 

  59. 

  60.   </head>

  61. <body>

  62. <div class="mobile-nav">

  63.     <input type="checkbox" id="menuToggler" class="toggler__input" aria-controls="navigation"

  64.            aria-pressed="false" aria-expanded="false" role="button" aria-label="Menu" />

  65.     <nav class="nav-content" role="navigation">

  66.         <label for="menuToggler" class="toggler__label">

  67.             <span></span>

  68.         </label>

  69.         <span class="nav-items-wrapper">

  70.             <a href="https://www.python.org/" class="nav-logo">

  71.                 <img src="../_static/py.svg" alt="Python logo"/>

  72.             </a>

  73.             <span class="version_switcher_placeholder"></span>

  74.             <form role="search" class="search" action="../search.html" method="get">

  75.                 <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" class="search-icon">

  76.                     <path fill-rule="nonzero" fill="currentColor" d="M15.5 14h-.79l-.28-.27a6.5 6.5 0 001.48-5.34c-.47-2.78-2.79-5-5.59-5.34a6.505 6.505 0 00-7.27 7.27c.34 2.8 2.56 5.12 5.34 5.59a6.5 6.5 0 005.34-1.48l.27.28v.79l4.25 4.25c.41.41 1.08.41 1.49 0 .41-.41.41-1.08 0-1.49L15.5 14zm-6 0C7.01 14 5 11.99 5 9.5S7.01 5 9.5 5 14 7.01 14 9.5 11.99 14 9.5 14z"></path>

  77.                 </svg>

  78.                 <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" />

  79.                 <input type="submit" value="Go"/>

  80.             </form>

  81.         </span>

  82.     </nav>

  83.     <div class="menu-wrapper">

  84.         <nav class="menu" role="navigation" aria-label="main navigation">

  85.             <div class="language_switcher_placeholder"></div>

  86.             

  87. <label class="theme-selector-label">

  88.     Theme

  89.     <select class="theme-selector" oninput="activateTheme(this.value)">

  90.         <option value="auto" selected>Auto</option>

  91.         <option value="light">Light</option>

  92.         <option value="dark">Dark</option>

  93.     </select>

  94. </label>

  95.   <div>

  96.     <h4>Previous topic</h4>

  97.     <p class="topless"><a href="codec.html"

  98.                           title="previous chapter">Codec registry and support functions</a></p>

  99.   </div>

  100.   <div>

  101.     <h4>Next topic</h4>

  102.     <p class="topless"><a href="abstract.html"

  103.                           title="next chapter">Abstract Objects Layer</a></p>

  104.   </div>

  105.   <div role="note" aria-label="source link">

  106.     <h3>This Page</h3>

  107.     <ul class="this-page-menu">

  108.       <li><a href="../bugs.html">Report a Bug</a></li>

  109.       <li>

  110.         <a href="https://github.com/python/cpython/blob/main/Doc/c-api/perfmaps.rst"

  111.             rel="nofollow">Show Source

  112.         </a>

  113.       </li>

  114.     </ul>

  115.   </div>

  116.         </nav>

  117.     </div>

  118. </div>

  119. 

  120.   

  121.     <div class="related" role="navigation" aria-label="related navigation">

  122.       <h3>Navigation</h3>

  123.       <ul>

  124.         <li class="right" style="margin-right: 10px">

  125.           <a href="../genindex.html" title="General Index"

  126.              accesskey="I">index</a></li>

  127.         <li class="right" >

  128.           <a href="../py-modindex.html" title="Python Module Index"

  129.              >modules</a> |</li>

  130.         <li class="right" >

  131.           <a href="abstract.html" title="Abstract Objects Layer"

  132.              accesskey="N">next</a> |</li>

  133.         <li class="right" >

  134.           <a href="codec.html" title="Codec registry and support functions"

  135.              accesskey="P">previous</a> |</li>

  136. 

  137.           <li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"/></li>

  138.           <li><a href="https://www.python.org/">Python</a> &#187;</li>

  139.           <li class="switchers">

  140.             <div class="language_switcher_placeholder"></div>

  141.             <div class="version_switcher_placeholder"></div>

  142.           </li>

  143.           <li>

  144.               

  145.           </li>

  146.     <li id="cpython-language-and-version">

  147.       <a href="../index.html">3.12.3 Documentation</a> &#187;

  148.     </li>

  149. 

  150.           <li class="nav-item nav-item-1"><a href="index.html" >Python/C API Reference Manual</a> &#187;</li>

  151.           <li class="nav-item nav-item-2"><a href="utilities.html" accesskey="U">Utilities</a> &#187;</li>

  152.         <li class="nav-item nav-item-this"><a href="">Support for Perf Maps</a></li>

  153.                 <li class="right">

  154.                     

  155. 

  156.     <div class="inline-search" role="search">

  157.         <form class="inline-search" action="../search.html" method="get">

  158.           <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box" />

  159.           <input type="submit" value="Go" />

  160.         </form>

  161.     </div>

  162.                      |

  163.                 </li>

  164.             <li class="right">

  165. <label class="theme-selector-label">

  166.     Theme

  167.     <select class="theme-selector" oninput="activateTheme(this.value)">

  168.         <option value="auto" selected>Auto</option>

  169.         <option value="light">Light</option>

  170.         <option value="dark">Dark</option>

  171.     </select>

  172. </label> |</li>

  173.             

  174.       </ul>

  175.     </div>    

  176. 

  177.     <div class="document">

  178.       <div class="documentwrapper">

  179.         <div class="bodywrapper">

  180.           <div class="body" role="main">

  181.             

  182.   <section id="support-for-perf-maps">

  183. <span id="perfmaps"></span><h1>Support for Perf Maps<a class="headerlink" href="#support-for-perf-maps" title="Link to this heading">¶</a></h1>

  184. <p>On supported platforms (as of this writing, only Linux), the runtime can take

  185. advantage of <em>perf map files</em> to make Python functions visible to an external

  186. profiling tool (such as <a class="reference external" href="https://perf.wiki.kernel.org/index.php/Main_Page">perf</a>).

  187. A running process may create a file in the <code class="docutils literal notranslate"><span class="pre">/tmp</span></code> directory, which contains entries

  188. that can map a section of executable code to a name. This interface is described in the

  189. <a class="reference external" href="https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/tools/perf/Documentation/jit-interface.txt">documentation of the Linux Perf tool</a>.</p>

  190. <p>In Python, these helper APIs can be used by libraries and features that rely

  191. on generating machine code on the fly.</p>

  192. <p>Note that holding the Global Interpreter Lock (GIL) is not required for these APIs.</p>

  193. <dl class="c function">

  194. <dt class="sig sig-object c" id="c.PyUnstable_PerfMapState_Init">

  195. <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PyUnstable_PerfMapState_Init</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">void</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyUnstable_PerfMapState_Init" title="Link to this definition">¶</a><br /></dt>

  196. <dd><div class="unstable-c-api warning admonition">

  197. <em>This is <a class="reference internal" href="stable.html#unstable-c-api"><span class="std std-ref">Unstable API</span></a>. It may change without warning in minor releases.</em></div>

  198. <p>Open the <code class="docutils literal notranslate"><span class="pre">/tmp/perf-$pid.map</span></code> file, unless it’s already opened, and create

  199. a lock to ensure thread-safe writes to the file (provided the writes are

  200. done through <a class="reference internal" href="#c.PyUnstable_WritePerfMapEntry" title="PyUnstable_WritePerfMapEntry"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyUnstable_WritePerfMapEntry()</span></code></a>). Normally, there’s no need

  201. to call this explicitly; just use <a class="reference internal" href="#c.PyUnstable_WritePerfMapEntry" title="PyUnstable_WritePerfMapEntry"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyUnstable_WritePerfMapEntry()</span></code></a>

  202. and it will initialize the state on first call.</p>

  203. <p>Returns <code class="docutils literal notranslate"><span class="pre">0</span></code> on success, <code class="docutils literal notranslate"><span class="pre">-1</span></code> on failure to create/open the perf map file,

  204. or <code class="docutils literal notranslate"><span class="pre">-2</span></code> on failure to create a lock. Check <code class="docutils literal notranslate"><span class="pre">errno</span></code> for more information

  205. about the cause of a failure.</p>

  206. </dd></dl>

  207. 

  208. <dl class="c function">

  209. <dt class="sig sig-object c" id="c.PyUnstable_WritePerfMapEntry">

  210. <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PyUnstable_WritePerfMapEntry</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">code_addr</span></span>, <span class="kt"><span class="pre">unsigned</span></span><span class="w"> </span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">code_size</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">entry_name</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyUnstable_WritePerfMapEntry" title="Link to this definition">¶</a><br /></dt>

  211. <dd><div class="unstable-c-api warning admonition">

  212. <em>This is <a class="reference internal" href="stable.html#unstable-c-api"><span class="std std-ref">Unstable API</span></a>. It may change without warning in minor releases.</em></div>

  213. <p>Write one single entry to the <code class="docutils literal notranslate"><span class="pre">/tmp/perf-$pid.map</span></code> file. This function is

  214. thread safe. Here is what an example entry looks like:</p>

  215. <div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="cp"># address      size  name</span>

  216. <span class="mf">7f3529f</span><span class="n">cf759</span><span class="w"> </span><span class="n">b</span><span class="w">     </span><span class="n">py</span><span class="o">::</span><span class="n">bar</span><span class="o">:/</span><span class="n">run</span><span class="o">/</span><span class="n">t</span><span class="p">.</span><span class="n">py</span>

  217. </pre></div>

  218. </div>

  219. <p>Will call <a class="reference internal" href="#c.PyUnstable_PerfMapState_Init" title="PyUnstable_PerfMapState_Init"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyUnstable_PerfMapState_Init()</span></code></a> before writing the entry, if

  220. the perf map file is not already opened. Returns <code class="docutils literal notranslate"><span class="pre">0</span></code> on success, or the

  221. same error codes as <a class="reference internal" href="#c.PyUnstable_PerfMapState_Init" title="PyUnstable_PerfMapState_Init"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyUnstable_PerfMapState_Init()</span></code></a> on failure.</p>

  222. </dd></dl>

  223. 

  224. <dl class="c function">

  225. <dt class="sig sig-object c" id="c.PyUnstable_PerfMapState_Fini">

  226. <span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PyUnstable_PerfMapState_Fini</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">void</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyUnstable_PerfMapState_Fini" title="Link to this definition">¶</a><br /></dt>

  227. <dd><div class="unstable-c-api warning admonition">

  228. <em>This is <a class="reference internal" href="stable.html#unstable-c-api"><span class="std std-ref">Unstable API</span></a>. It may change without warning in minor releases.</em></div>

  229. <p>Close the perf map file opened by <a class="reference internal" href="#c.PyUnstable_PerfMapState_Init" title="PyUnstable_PerfMapState_Init"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyUnstable_PerfMapState_Init()</span></code></a>.

  230. This is called by the runtime itself during interpreter shut-down. In

  231. general, there shouldn’t be a reason to explicitly call this, except to

  232. handle specific scenarios such as forking.</p>

  233. </dd></dl>

  234. 

  235. </section>

  236. 

  237. 

  238.             <div class="clearer"></div>

  239.           </div>

  240.         </div>

  241.       </div>

  242.       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">

  243.         <div class="sphinxsidebarwrapper">

  244.   <div>

  245.     <h4>Previous topic</h4>

  246.     <p class="topless"><a href="codec.html"

  247.                           title="previous chapter">Codec registry and support functions</a></p>

  248.   </div>

  249.   <div>

  250.     <h4>Next topic</h4>

  251.     <p class="topless"><a href="abstract.html"

  252.                           title="next chapter">Abstract Objects Layer</a></p>

  253.   </div>

  254.   <div role="note" aria-label="source link">

  255.     <h3>This Page</h3>

  256.     <ul class="this-page-menu">

  257.       <li><a href="../bugs.html">Report a Bug</a></li>

  258.       <li>

  259.         <a href="https://github.com/python/cpython/blob/main/Doc/c-api/perfmaps.rst"

  260.             rel="nofollow">Show Source

  261.         </a>

  262.       </li>

  263.     </ul>

  264.   </div>

  265.         </div>

  266. <div id="sidebarbutton" title="Collapse sidebar">

  267. <span>«</span>

  268. </div>

  269. 

  270.       </div>

  271.       <div class="clearer"></div>

  272.     </div>  

  273.     <div class="related" role="navigation" aria-label="related navigation">

  274.       <h3>Navigation</h3>

  275.       <ul>

  276.         <li class="right" style="margin-right: 10px">

  277.           <a href="../genindex.html" title="General Index"

  278.              >index</a></li>

  279.         <li class="right" >

  280.           <a href="../py-modindex.html" title="Python Module Index"

  281.              >modules</a> |</li>

  282.         <li class="right" >

  283.           <a href="abstract.html" title="Abstract Objects Layer"

  284.              >next</a> |</li>

  285.         <li class="right" >

  286.           <a href="codec.html" title="Codec registry and support functions"

  287.              >previous</a> |</li>

  288. 

  289.           <li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"/></li>

  290.           <li><a href="https://www.python.org/">Python</a> &#187;</li>

  291.           <li class="switchers">

  292.             <div class="language_switcher_placeholder"></div>

  293.             <div class="version_switcher_placeholder"></div>

  294.           </li>

  295.           <li>

  296.               

  297.           </li>

  298.     <li id="cpython-language-and-version">

  299.       <a href="../index.html">3.12.3 Documentation</a> &#187;

  300.     </li>

  301. 

  302.           <li class="nav-item nav-item-1"><a href="index.html" >Python/C API Reference Manual</a> &#187;</li>

  303.           <li class="nav-item nav-item-2"><a href="utilities.html" >Utilities</a> &#187;</li>

  304.         <li class="nav-item nav-item-this"><a href="">Support for Perf Maps</a></li>

  305.                 <li class="right">

  306.                     

  307. 

  308.     <div class="inline-search" role="search">

  309.         <form class="inline-search" action="../search.html" method="get">

  310.           <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box" />

  311.           <input type="submit" value="Go" />

  312.         </form>

  313.     </div>

  314.                      |

  315.                 </li>

  316.             <li class="right">

  317. <label class="theme-selector-label">

  318.     Theme

  319.     <select class="theme-selector" oninput="activateTheme(this.value)">

  320.         <option value="auto" selected>Auto</option>

  321.         <option value="light">Light</option>

  322.         <option value="dark">Dark</option>

  323.     </select>

  324. </label> |</li>

  325.             

  326.       </ul>

  327.     </div>  

  328.     <div class="footer">

  329.     &copy; 

  330.       <a href="../copyright.html">

  331.     

  332.     Copyright

  333.     

  334.       </a>

  335.      2001-2024, Python Software Foundation.

  336.     <br />

  337.     This page is licensed under the Python Software Foundation License Version 2.

  338.     <br />

  339.     Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.

  340.     <br />

  341.     

  342.       See <a href="/license.html">History and License</a> for more information.<br />

  343.     

  344.     

  345.     <br />

  346. 

  347.     The Python Software Foundation is a non-profit corporation.

  348. <a href="https://www.python.org/psf/donations/">Please donate.</a>

  349. <br />

  350.     <br />

  351.       Last updated on Apr 09, 2024 (13:47 UTC).

  352.     

  353.       <a href="/bugs.html">Found a bug</a>?

  354.     

  355.     <br />

  356. 

  357.     Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.

  358.     </div>

  359. 

  360.   </body>

  361. </html>
上海开阖软件有限公司 沪ICP备12045867号-1