Merge pull request #1443 from IntelPython/improve/function_arg_mangling

Add the mangled_args property to kernel_api types. 72a3167

dev/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: fd05f27b09982a018355b52b5e35eb29
+config: 71854506d2908971ad0730101f421e8e
 tags: 645f666f9bcd5a90fca523b33c5a78b7

dev/_sources/autoapi/numba_dpex/core/debuginfo/index.rst.txt

@@ -0,0 +1,79 @@
+
+
+:orphan:
+
+numba_dpex.core.debuginfo
+=========================
+
+.. py:module:: numba_dpex.core.debuginfo
+
+.. autoapi-nested-parse::
+
+   Implements a custom debug metadata generator class for numba-dpex kernels.
+
+
+
+
+
+Overview
+--------
+.. list-table:: Classes
+   :header-rows: 0
+   :widths: auto
+   :class: summarytable
+
+   * - :py:obj:`DIBuilder <numba_dpex.core.debuginfo.DIBuilder>`
+     - Overrides Numba's default DIBuilder with numba-dpex-specific customizations.
+
+
+
+
+Classes
+-------
+
+.. py:class:: DIBuilder(module, filepath, cgctx, directives_only)
+
+   Bases: :py:obj:`numba.core.debuginfo.DIBuilder`
+
+   Overrides Numba's default DIBuilder with numba-dpex-specific customizations.
+
+
+   .. rubric:: Overview
+
+
+   .. list-table:: Methods
+      :header-rows: 0
+      :widths: auto
+      :class: summarytable
+
+      * - :py:obj:`mark_subprogram <numba_dpex.core.debuginfo.DIBuilder.mark_subprogram>`\ (function, qualname, argnames, argtypes, line)
+        - Sets DW_AT_name and DW_AT_linkagename tags for a kernel decorated function.
+
+
+   .. rubric:: Members
+
+   .. py:method:: mark_subprogram(function, qualname, argnames, argtypes, line)
+
+      Sets DW_AT_name and DW_AT_linkagename tags for a kernel decorated function.
+
+      Numba generates a unique name for every function it compiles, but in
+      upstream Numba the unique name is not used as the "qualified" name of
+      the function. The behavior leads to a bug discovered in Numba-dpex when
+      a compiled function uses closure variables.
+      Refer (https://github.com/IntelPython/numba-dpex/issues/898).
+      To resolve the issue numba-dpex uses the unique_name as the qualified
+      name. Refer to
+      :class:`numba_dpex.core.passes.passes.QualNameDisambiguationLowering`.
+      However, doing so breaks setting GDB breakpoints based on function
+      name as the function name is no longer what is in the source, but what
+      is the unique name generated by Numba. To fix it, numba-dpex uses a
+      modified DISubprogram metadata generator. The name (DW_AT_name) tag is
+      set to the base function name, discarding the unique qualifier and
+      linkagename is set to an empty string.
+
+
+
+
+
+
+

dev/_static/documentation_options.js

@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: '0.23.0rc1+23.g675cb7923',
+    VERSION: '0.23.0rc1+27.g72a3167f2',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

dev/autoapi/index.html

@@ -15,7 +15,7 @@
     <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="numba_dpex.kernel_api" href="numba_dpex/kernel_api/index.html" /><link rel="prev" title="Common issues and tips" href="../user_guide/debugging/common_issues.html" />
 
     <!-- Generated with Sphinx 7.3.7 and Furo 2024.04.27 -->
-        <title>API Reference - numba-dpex 0.23.0rc1+23.g675cb7923 documentation</title>
+        <title>API Reference - numba-dpex 0.23.0rc1+27.g72a3167f2 documentation</title>
       <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" />
     <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=437aa6ec" />
     <link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=fd3f3429" />
@@ -136,7 +136,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="../index.html"><div class="brand">numba-dpex 0.23.0rc1+23.g675cb7923 documentation</div></a>
+      <a href="../index.html"><div class="brand">numba-dpex 0.23.0rc1+27.g72a3167f2 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -159,7 +159,7 @@
       <div class="sidebar-sticky"><a class="sidebar-brand" href="../index.html">
 
 
-  <span class="sidebar-brand-text">numba-dpex 0.23.0rc1+23.g675cb7923 documentation</span>
+  <span class="sidebar-brand-text">numba-dpex 0.23.0rc1+27.g72a3167f2 documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="../search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
@@ -313,7 +313,7 @@ <h1>API Reference<a class="headerlink" href="#api-reference" title="Link to this
 
     </aside>
   </div>
-</div><script src="../_static/documentation_options.js?v=6c320df7"></script>
+</div><script src="../_static/documentation_options.js?v=58617a3d"></script>
     <script src="../_static/doctools.js?v=9a2dae69"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/scripts/furo.js?v=4e2eecee"></script>

dev/autoapi/numba_dpex/core/boxing/index.html

@@ -15,7 +15,7 @@
     <link rel="index" title="Index" href="../../../../genindex.html" /><link rel="search" title="Search" href="../../../../search.html" />
 
     <!-- Generated with Sphinx 7.3.7 and Furo 2024.04.27 -->
-        <title>numba_dpex.core.boxing - numba-dpex 0.23.0rc1+23.g675cb7923 documentation</title>
+        <title>numba_dpex.core.boxing - numba-dpex 0.23.0rc1+27.g72a3167f2 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css?v=a746c00c" />
     <link rel="stylesheet" type="text/css" href="../../../../_static/styles/furo.css?v=437aa6ec" />
     <link rel="stylesheet" type="text/css" href="../../../../_static/graphviz.css?v=fd3f3429" />
@@ -136,7 +136,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="../../../../index.html"><div class="brand">numba-dpex 0.23.0rc1+23.g675cb7923 documentation</div></a>
+      <a href="../../../../index.html"><div class="brand">numba-dpex 0.23.0rc1+27.g72a3167f2 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -159,7 +159,7 @@
       <div class="sidebar-sticky"><a class="sidebar-brand" href="../../../../index.html">
 
 
-  <span class="sidebar-brand-text">numba-dpex 0.23.0rc1+23.g675cb7923 documentation</span>
+  <span class="sidebar-brand-text">numba-dpex 0.23.0rc1+27.g72a3167f2 documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="../../../../search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
@@ -767,7 +767,7 @@ <h2>Functions<a class="headerlink" href="#functions" title="Link to this heading
 
     </aside>
   </div>
-</div><script src="../../../../_static/documentation_options.js?v=6c320df7"></script>
+</div><script src="../../../../_static/documentation_options.js?v=58617a3d"></script>
     <script src="../../../../_static/doctools.js?v=9a2dae69"></script>
     <script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../../_static/scripts/furo.js?v=4e2eecee"></script>

dev/autoapi/numba_dpex/core/boxing/ranges/index.html

@@ -15,7 +15,7 @@
     <link rel="index" title="Index" href="../../../../../genindex.html" /><link rel="search" title="Search" href="../../../../../search.html" />
 
     <!-- Generated with Sphinx 7.3.7 and Furo 2024.04.27 -->
-        <title>numba_dpex.core.boxing.ranges - numba-dpex 0.23.0rc1+23.g675cb7923 documentation</title>
+        <title>numba_dpex.core.boxing.ranges - numba-dpex 0.23.0rc1+27.g72a3167f2 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../../../_static/pygments.css?v=a746c00c" />
     <link rel="stylesheet" type="text/css" href="../../../../../_static/styles/furo.css?v=437aa6ec" />
     <link rel="stylesheet" type="text/css" href="../../../../../_static/graphviz.css?v=fd3f3429" />
@@ -136,7 +136,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="../../../../../index.html"><div class="brand">numba-dpex 0.23.0rc1+23.g675cb7923 documentation</div></a>
+      <a href="../../../../../index.html"><div class="brand">numba-dpex 0.23.0rc1+27.g72a3167f2 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -159,7 +159,7 @@
       <div class="sidebar-sticky"><a class="sidebar-brand" href="../../../../../index.html">
 
 
-  <span class="sidebar-brand-text">numba-dpex 0.23.0rc1+23.g675cb7923 documentation</span>
+  <span class="sidebar-brand-text">numba-dpex 0.23.0rc1+27.g72a3167f2 documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="../../../../../search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
@@ -358,7 +358,7 @@ <h2>Functions<a class="headerlink" href="#functions" title="Link to this heading
 
     </aside>
   </div>
-</div><script src="../../../../../_static/documentation_options.js?v=6c320df7"></script>
+</div><script src="../../../../../_static/documentation_options.js?v=58617a3d"></script>
     <script src="../../../../../_static/doctools.js?v=9a2dae69"></script>
     <script src="../../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../../../_static/scripts/furo.js?v=4e2eecee"></script>

dev/autoapi/numba_dpex/core/boxing/usm_ndarray/index.html

@@ -15,7 +15,7 @@
     <link rel="index" title="Index" href="../../../../../genindex.html" /><link rel="search" title="Search" href="../../../../../search.html" />
 
     <!-- Generated with Sphinx 7.3.7 and Furo 2024.04.27 -->
-        <title>numba_dpex.core.boxing.usm_ndarray - numba-dpex 0.23.0rc1+23.g675cb7923 documentation</title>
+        <title>numba_dpex.core.boxing.usm_ndarray - numba-dpex 0.23.0rc1+27.g72a3167f2 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../../../_static/pygments.css?v=a746c00c" />
     <link rel="stylesheet" type="text/css" href="../../../../../_static/styles/furo.css?v=437aa6ec" />
     <link rel="stylesheet" type="text/css" href="../../../../../_static/graphviz.css?v=fd3f3429" />
@@ -136,7 +136,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="../../../../../index.html"><div class="brand">numba-dpex 0.23.0rc1+23.g675cb7923 documentation</div></a>
+      <a href="../../../../../index.html"><div class="brand">numba-dpex 0.23.0rc1+27.g72a3167f2 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -159,7 +159,7 @@
       <div class="sidebar-sticky"><a class="sidebar-brand" href="../../../../../index.html">
 
 
-  <span class="sidebar-brand-text">numba-dpex 0.23.0rc1+23.g675cb7923 documentation</span>
+  <span class="sidebar-brand-text">numba-dpex 0.23.0rc1+27.g72a3167f2 documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="../../../../../search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
@@ -365,7 +365,7 @@ <h2>Functions<a class="headerlink" href="#functions" title="Link to this heading
 
     </aside>
   </div>
-</div><script src="../../../../../_static/documentation_options.js?v=6c320df7"></script>
+</div><script src="../../../../../_static/documentation_options.js?v=58617a3d"></script>
     <script src="../../../../../_static/doctools.js?v=9a2dae69"></script>
     <script src="../../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../../../_static/scripts/furo.js?v=4e2eecee"></script>

dev/autoapi/numba_dpex/core/config/index.html

@@ -15,7 +15,7 @@
     <link rel="index" title="Index" href="../../../../genindex.html" /><link rel="search" title="Search" href="../../../../search.html" />
 
     <!-- Generated with Sphinx 7.3.7 and Furo 2024.04.27 -->
-        <title>numba_dpex.core.config - numba-dpex 0.23.0rc1+23.g675cb7923 documentation</title>
+        <title>numba_dpex.core.config - numba-dpex 0.23.0rc1+27.g72a3167f2 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css?v=a746c00c" />
     <link rel="stylesheet" type="text/css" href="../../../../_static/styles/furo.css?v=437aa6ec" />
     <link rel="stylesheet" type="text/css" href="../../../../_static/graphviz.css?v=fd3f3429" />
@@ -136,7 +136,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="../../../../index.html"><div class="brand">numba-dpex 0.23.0rc1+23.g675cb7923 documentation</div></a>
+      <a href="../../../../index.html"><div class="brand">numba-dpex 0.23.0rc1+27.g72a3167f2 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -159,7 +159,7 @@
       <div class="sidebar-sticky"><a class="sidebar-brand" href="../../../../index.html">
 
 
-  <span class="sidebar-brand-text">numba-dpex 0.23.0rc1+23.g675cb7923 documentation</span>
+  <span class="sidebar-brand-text">numba-dpex 0.23.0rc1+27.g72a3167f2 documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="../../../../search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
@@ -400,7 +400,7 @@ <h2>Attributes<a class="headerlink" href="#attributes" title="Link to this headi
 
     </aside>
   </div>
-</div><script src="../../../../_static/documentation_options.js?v=6c320df7"></script>
+</div><script src="../../../../_static/documentation_options.js?v=58617a3d"></script>
     <script src="../../../../_static/doctools.js?v=9a2dae69"></script>
     <script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../../_static/scripts/furo.js?v=4e2eecee"></script>

dev/autoapi/numba_dpex/core/datamodel/index.html

@@ -15,7 +15,7 @@
     <link rel="index" title="Index" href="../../../../genindex.html" /><link rel="search" title="Search" href="../../../../search.html" />
 
     <!-- Generated with Sphinx 7.3.7 and Furo 2024.04.27 -->
-        <title>numba_dpex.core.datamodel - numba-dpex 0.23.0rc1+23.g675cb7923 documentation</title>
+        <title>numba_dpex.core.datamodel - numba-dpex 0.23.0rc1+27.g72a3167f2 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css?v=a746c00c" />
     <link rel="stylesheet" type="text/css" href="../../../../_static/styles/furo.css?v=437aa6ec" />
     <link rel="stylesheet" type="text/css" href="../../../../_static/graphviz.css?v=fd3f3429" />
@@ -136,7 +136,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="../../../../index.html"><div class="brand">numba-dpex 0.23.0rc1+23.g675cb7923 documentation</div></a>
+      <a href="../../../../index.html"><div class="brand">numba-dpex 0.23.0rc1+27.g72a3167f2 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -159,7 +159,7 @@
       <div class="sidebar-sticky"><a class="sidebar-brand" href="../../../../index.html">
 
 
-  <span class="sidebar-brand-text">numba-dpex 0.23.0rc1+23.g675cb7923 documentation</span>
+  <span class="sidebar-brand-text">numba-dpex 0.23.0rc1+27.g72a3167f2 documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="../../../../search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
@@ -281,7 +281,7 @@
 
     </aside>
   </div>
-</div><script src="../../../../_static/documentation_options.js?v=6c320df7"></script>
+</div><script src="../../../../_static/documentation_options.js?v=58617a3d"></script>
     <script src="../../../../_static/doctools.js?v=9a2dae69"></script>
     <script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../../_static/scripts/furo.js?v=4e2eecee"></script>

dev/autoapi/numba_dpex/core/datamodel/models/index.html

@@ -15,7 +15,7 @@
     <link rel="index" title="Index" href="../../../../../genindex.html" /><link rel="search" title="Search" href="../../../../../search.html" />
 
     <!-- Generated with Sphinx 7.3.7 and Furo 2024.04.27 -->
-        <title>numba_dpex.core.datamodel.models - numba-dpex 0.23.0rc1+23.g675cb7923 documentation</title>
+        <title>numba_dpex.core.datamodel.models - numba-dpex 0.23.0rc1+27.g72a3167f2 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../../../_static/pygments.css?v=a746c00c" />
     <link rel="stylesheet" type="text/css" href="../../../../../_static/styles/furo.css?v=437aa6ec" />
     <link rel="stylesheet" type="text/css" href="../../../../../_static/graphviz.css?v=fd3f3429" />
@@ -136,7 +136,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="../../../../../index.html"><div class="brand">numba-dpex 0.23.0rc1+23.g675cb7923 documentation</div></a>
+      <a href="../../../../../index.html"><div class="brand">numba-dpex 0.23.0rc1+27.g72a3167f2 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -159,7 +159,7 @@
       <div class="sidebar-sticky"><a class="sidebar-brand" href="../../../../../index.html">
 
 
-  <span class="sidebar-brand-text">numba-dpex 0.23.0rc1+23.g675cb7923 documentation</span>
+  <span class="sidebar-brand-text">numba-dpex 0.23.0rc1+27.g72a3167f2 documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="../../../../../search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
@@ -558,7 +558,7 @@ <h2>Attributes<a class="headerlink" href="#attributes" title="Link to this headi
 
     </aside>
   </div>
-</div><script src="../../../../../_static/documentation_options.js?v=6c320df7"></script>
+</div><script src="../../../../../_static/documentation_options.js?v=58617a3d"></script>
     <script src="../../../../../_static/doctools.js?v=9a2dae69"></script>
     <script src="../../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../../../_static/scripts/furo.js?v=4e2eecee"></script>