Auto-deployed update of 'docs/' for 'refs/heads/next'

docs/next/_sources/capis/xnvme_queue.rst.txt

@@ -68,6 +68,14 @@ xnvme_queue_get_cmd_ctx
 .. doxygenfunction:: xnvme_queue_get_cmd_ctx
 
 
+.. _sec-c-api-xnvme_queue-func-xnvme_queue_get_completion_fd:
+
+xnvme_queue_get_completion_fd
+-----------------------------
+
+.. doxygenfunction:: xnvme_queue_get_completion_fd
+
+
 .. _sec-c-api-xnvme_queue-func-xnvme_queue_get_outstanding:
 
 xnvme_queue_get_outstanding

docs/next/capis/xnvme_queue.html

@@ -77,6 +77,7 @@
 <li class="toctree-l4"><a class="reference internal" href="#xnvme-queue-drain">xnvme_queue_drain</a></li>
 <li class="toctree-l4"><a class="reference internal" href="#xnvme-queue-get-capacity">xnvme_queue_get_capacity</a></li>
 <li class="toctree-l4"><a class="reference internal" href="#xnvme-queue-get-cmd-ctx">xnvme_queue_get_cmd_ctx</a></li>
+<li class="toctree-l4"><a class="reference internal" href="#xnvme-queue-get-completion-fd">xnvme_queue_get_completion_fd</a></li>
 <li class="toctree-l4"><a class="reference internal" href="#xnvme-queue-get-outstanding">xnvme_queue_get_outstanding</a></li>
 <li class="toctree-l4"><a class="reference internal" href="#xnvme-queue-init">xnvme_queue_init</a></li>
 <li class="toctree-l4"><a class="reference internal" href="#xnvme-queue-poke">xnvme_queue_poke</a></li>
@@ -286,6 +287,17 @@
 <span class="cm"> */</span>
 <span class="kt">int</span>
 <span class="nf">xnvme_queue_set_cb</span><span class="p">(</span><span class="k">struct</span><span class="w"> </span><span class="nc">xnvme_queue</span><span class="w"> </span><span class="o">*</span><span class="n">queue</span><span class="p">,</span><span class="w"> </span><span class="n">xnvme_queue_cb</span><span class="w"> </span><span class="n">cb</span><span class="p">,</span><span class="w"> </span><span class="kt">void</span><span class="w"> </span><span class="o">*</span><span class="n">cb_arg</span><span class="p">);</span>
+
+<span class="cm">/**</span>
+<span class="cm"> * Get the completion event fd on the given ::xnvme_queue</span>
+<span class="cm"> *</span>
+<span class="cm"> * @param queue Pointer to the ::xnvme_queue to query for outstanding commands</span>
+<span class="cm"> *</span>
+<span class="cm"> * @return On success, an eventfd() file descriptor is returned. On error, negative `errno`</span>
+<span class="cm"> * is returned.</span>
+<span class="cm"> */</span>
+<span class="kt">int</span>
+<span class="nf">xnvme_queue_get_completion_fd</span><span class="p">(</span><span class="k">struct</span><span class="w"> </span><span class="nc">xnvme_queue</span><span class="w"> </span><span class="o">*</span><span class="n">queue</span><span class="p">);</span>
 </pre></div>
 </div>
 </section>
@@ -384,6 +396,25 @@
 </dl>
 </dd></dl>
 
+</section>
+<section id="xnvme-queue-get-completion-fd">
+<span id="sec-c-api-xnvme-queue-func-xnvme-queue-get-completion-fd"></span><h3>xnvme_queue_get_completion_fd<a class="headerlink" href="#xnvme-queue-get-completion-fd" title="Link to this heading"></a></h3>
+<dl class="c function">
+<dt class="sig sig-object c" id="c.xnvme_queue_get_completion_fd">
+<span class="target" id="libxnvme__queue_8h_1abf6981a59d8d103a8351ad83d0b3a5b5"></span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">xnvme_queue_get_completion_fd</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="n"><span class="pre">xnvme_queue</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">queue</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.xnvme_queue_get_completion_fd" title="Link to this definition"></a><br /></dt>
+<dd><p>Get the completion event fd on the given xnvme_queue. </p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>queue</strong> – Pointer to the xnvme_queue to query for outstanding commands</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>On success, an eventfd() file descriptor is returned. On error, negative <code class="docutils literal notranslate"><span class="pre">errno</span></code> is returned. </p>
+</dd>
+</dl>
+</dd></dl>
+
 </section>
 <section id="xnvme-queue-get-outstanding">
 <span id="sec-c-api-xnvme-queue-func-xnvme-queue-get-outstanding"></span><h3>xnvme_queue_get_outstanding<a class="headerlink" href="#xnvme-queue-get-outstanding" title="Link to this heading"></a></h3>

docs/next/genindex.html

@@ -1101,6 +1101,8 @@ <h2 id="X">X</h2>
       <li><a href="capis/xnvme_queue.html#c.xnvme_queue_get_capacity">xnvme_queue_get_capacity (C function)</a>
 </li>
       <li><a href="capis/xnvme_queue.html#c.xnvme_queue_get_cmd_ctx">xnvme_queue_get_cmd_ctx (C function)</a>
+</li>
+      <li><a href="capis/xnvme_queue.html#c.xnvme_queue_get_completion_fd">xnvme_queue_get_completion_fd (C function)</a>
 </li>
       <li><a href="capis/xnvme_queue.html#c.xnvme_queue_get_outstanding">xnvme_queue_get_outstanding (C function)</a>
 </li>
@@ -1531,11 +1533,11 @@ <h2 id="X">X</h2>
       <li><a href="capis/xnvme_spec.html#c.xnvme_spec_fdp_conf_desc.rsvd28">xnvme_spec_fdp_conf_desc.rsvd28 (C var)</a>
 </li>
       <li><a href="capis/xnvme_spec.html#c.xnvme_spec_fdp_conf_desc.ruh_desc">xnvme_spec_fdp_conf_desc.ruh_desc (C var)</a>
-</li>
-      <li><a href="capis/xnvme_spec.html#c.xnvme_spec_fdp_conf_desc.runs">xnvme_spec_fdp_conf_desc.runs (C var)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="capis/xnvme_spec.html#c.xnvme_spec_fdp_conf_desc.runs">xnvme_spec_fdp_conf_desc.runs (C var)</a>
+</li>
       <li><a href="capis/xnvme_spec.html#c.xnvme_spec_fdp_conf_desc.vss">xnvme_spec_fdp_conf_desc.vss (C var)</a>
 </li>
       <li><a href="capis/xnvme_spec.html#c.xnvme_spec_fdp_event">xnvme_spec_fdp_event (C struct)</a>

docs/next/getting_started/index.html

@@ -2364,7 +2364,7 @@ <h4>Async I/O via <code class="docutils literal notranslate"><span class="pre">l
 <span class="w">  </span>naddrs:<span class="w"> </span><span class="m">1</span>
 <span class="w">  </span>nbytes:<span class="w"> </span><span class="m">4096</span>
 <span class="w">  </span>attr:<span class="w"> </span><span class="o">{</span><span class="w"> </span>is_zones:<span class="w"> </span><span class="m">0</span>,<span class="w"> </span>is_valid:<span class="w"> </span><span class="m">1</span><span class="o">}</span>
-wall-clock:<span class="w"> </span><span class="o">{</span>elapsed:<span class="w"> </span><span class="m">0</span>.0003,<span class="w"> </span>mib:<span class="w"> </span><span class="m">0</span>.00,<span class="w"> </span>mib_sec:<span class="w"> </span><span class="m">13</span>.37<span class="o">}</span>
+wall-clock:<span class="w"> </span><span class="o">{</span>elapsed:<span class="w"> </span><span class="m">0</span>.0002,<span class="w"> </span>mib:<span class="w"> </span><span class="m">0</span>.00,<span class="w"> </span>mib_sec:<span class="w"> </span><span class="m">22</span>.51<span class="o">}</span>
 <span class="c1"># cb_args: {submitted: 1, completed: 1, ecount: 0}</span>
 </pre></div>
 </div>
@@ -2397,7 +2397,7 @@ <h4>Async. I/O via <code class="docutils literal notranslate"><span class="pre">
 <span class="w">  </span>naddrs:<span class="w"> </span><span class="m">1</span>
 <span class="w">  </span>nbytes:<span class="w"> </span><span class="m">4096</span>
 <span class="w">  </span>attr:<span class="w"> </span><span class="o">{</span><span class="w"> </span>is_zones:<span class="w"> </span><span class="m">0</span>,<span class="w"> </span>is_valid:<span class="w"> </span><span class="m">1</span><span class="o">}</span>
-wall-clock:<span class="w"> </span><span class="o">{</span>elapsed:<span class="w"> </span><span class="m">0</span>.0003,<span class="w"> </span>mib:<span class="w"> </span><span class="m">0</span>.00,<span class="w"> </span>mib_sec:<span class="w"> </span><span class="m">11</span>.47<span class="o">}</span>
+wall-clock:<span class="w"> </span><span class="o">{</span>elapsed:<span class="w"> </span><span class="m">0</span>.0003,<span class="w"> </span>mib:<span class="w"> </span><span class="m">0</span>.00,<span class="w"> </span>mib_sec:<span class="w"> </span><span class="m">14</span>.00<span class="o">}</span>
 <span class="c1"># cb_args: {submitted: 1, completed: 1, ecount: 0}</span>
 </pre></div>
 </div>
@@ -2448,7 +2448,7 @@ <h4>Async. I/O via <code class="docutils literal notranslate"><span class="pre">
 </pre></div>
 </div>
 <p>Should output:</p>
-<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="o">[</span><span class="w">    </span><span class="m">0</span>.111963<span class="o">]</span><span class="w"> </span>DMAR:<span class="w"> </span>IOMMU<span class="w"> </span>enabled
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="o">[</span><span class="w">    </span><span class="m">0</span>.253791<span class="o">]</span><span class="w"> </span>DMAR:<span class="w"> </span>IOMMU<span class="w"> </span>enabled
 </pre></div>
 </div>
 <p>And this command:</p>