doc: update to 716ad0e389c321e6c74225b8f9ef830c195f86f7

Change-Id: If77457a09e4cd1ce2621099032c5587acfc60408
Signed-off-by: SPDK Nightly Cron Job <[email protected]>

Author: SPDK Nightly Cron Job

_doc_version.txt

@@ -1 +1 @@
-120c4f3c05a7dae7000dd70134fb8af21bb56336
+716ad0e389c321e6c74225b8f9ef830c195f86f7

doc/bdev_8h.html

@@ -307,6 +307,12 @@
 <tr class="memitem:a9d37ad1d4da0bcb51ada76dbe4f4ce15"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="bdev_8h.html#a9d37ad1d4da0bcb51ada76dbe4f4ce15">spdk_bdev_set_qd_sampling_period</a> (struct <a class="el" href="structspdk__bdev.html">spdk_bdev</a> *bdev, uint64_t period)</td></tr>
 <tr class="memdesc:a9d37ad1d4da0bcb51ada76dbe4f4ce15"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable or disable queue depth sampling for this bdev.  <a href="#a9d37ad1d4da0bcb51ada76dbe4f4ce15">More...</a><br /></td></tr>
 <tr class="separator:a9d37ad1d4da0bcb51ada76dbe4f4ce15"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a8a082eb89d57860b2e57ebf7f5b3caa2"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="bdev_8h.html#a8a082eb89d57860b2e57ebf7f5b3caa2">spdk_bdev_get_io_time</a> (const struct <a class="el" href="structspdk__bdev.html">spdk_bdev</a> *bdev)</td></tr>
+<tr class="memdesc:a8a082eb89d57860b2e57ebf7f5b3caa2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the time spent processing IO for this device.  <a href="#a8a082eb89d57860b2e57ebf7f5b3caa2">More...</a><br /></td></tr>
+<tr class="separator:a8a082eb89d57860b2e57ebf7f5b3caa2"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a526ab43ba037b8637a23e9d42289884e"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="bdev_8h.html#a526ab43ba037b8637a23e9d42289884e">spdk_bdev_get_weighted_io_time</a> (const struct <a class="el" href="structspdk__bdev.html">spdk_bdev</a> *bdev)</td></tr>
+<tr class="memdesc:a526ab43ba037b8637a23e9d42289884e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the weighted IO processing time for this bdev.  <a href="#a526ab43ba037b8637a23e9d42289884e">More...</a><br /></td></tr>
+<tr class="separator:a526ab43ba037b8637a23e9d42289884e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:ab5bb9e746b030d7c4c89cbcf60076c7e"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structspdk__io__channel.html">spdk_io_channel</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="bdev_8h.html#ab5bb9e746b030d7c4c89cbcf60076c7e">spdk_bdev_get_io_channel</a> (struct spdk_bdev_desc *desc)</td></tr>
 <tr class="memdesc:ab5bb9e746b030d7c4c89cbcf60076c7e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Obtain an I/O channel for the block device opened by the specified descriptor.  <a href="#ab5bb9e746b030d7c4c89cbcf60076c7e">More...</a><br /></td></tr>
 <tr class="separator:ab5bb9e746b030d7c4c89cbcf60076c7e"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -965,6 +971,35 @@ <h2 class="memtitle"><span class="permalink"><a href="#ab1ba28ba382edd1d792d51a0
   </dd>
 </dl>
 
+</div>
+</div>
+<a id="a8a082eb89d57860b2e57ebf7f5b3caa2"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a8a082eb89d57860b2e57ebf7f5b3caa2">&#9670;&nbsp;</a></span>spdk_bdev_get_io_time()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint64_t spdk_bdev_get_io_time </td>
+          <td>(</td>
+          <td class="paramtype">const struct <a class="el" href="structspdk__bdev.html">spdk_bdev</a> *&#160;</td>
+          <td class="paramname"><em>bdev</em></td><td>)</td>
+          <td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Get the time spent processing IO for this device. </p>
+<p>This value is dependent upon the queue depth sampling period and is incremented at sampling time by the sampling period only if the measured queue depth is greater than 0.</p>
+<p>The disk utilization can be calculated by the following formula: disk_util = (io_time_2 - io_time_1) / elapsed_time. The user is responsible for tracking the elapsed time between two measurements.</p>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramname">bdev</td><td>Block device to query.</td></tr>
+  </table>
+  </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>The io time for this device in microseconds. </dd></dl>
+
 </div>
 </div>
 <a id="ad97a853dcb945bf004817424b7aa28af"></a>
@@ -1186,6 +1221,35 @@ <h2 class="memtitle"><span class="permalink"><a href="#add8565cdbf3d57697b67202b
 <dl class="section return"><dt>Returns</dt><dd>Pointer to UUID.</dd></dl>
 <p>Not all bdevs will have a UUID; in this case, the returned UUID will be the nil UUID (all bytes zero). </p>
 
+</div>
+</div>
+<a id="a526ab43ba037b8637a23e9d42289884e"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a526ab43ba037b8637a23e9d42289884e">&#9670;&nbsp;</a></span>spdk_bdev_get_weighted_io_time()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint64_t spdk_bdev_get_weighted_io_time </td>
+          <td>(</td>
+          <td class="paramtype">const struct <a class="el" href="structspdk__bdev.html">spdk_bdev</a> *&#160;</td>
+          <td class="paramname"><em>bdev</em></td><td>)</td>
+          <td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Get the weighted IO processing time for this bdev. </p>
+<p>This value is dependent upon the queue depth sampling period and is equal to the time spent reading from or writing to a device times the measured queue depth during each sampling period.</p>
+<p>The average queue depth can be calculated by the following formula: queue_depth = (weighted_io_time_2 - weighted_io_time_1) / elapsed_time. The user is responsible for tracking the elapsed time between two measurements.</p>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramname">bdev</td><td>Block device to query.</td></tr>
+  </table>
+  </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>The weighted io time for this device in microseconds. </dd></dl>
+
 </div>
 </div>
 <a id="a93f6d6ce09da384501f09a49581caa37"></a>

doc/bdev_8h.js

@@ -46,6 +46,7 @@ var bdev_8h =
     [ "spdk_bdev_get_device_stat", "bdev_8h.html#aa478b43fc9e6e41c34438f5b2ef742d5", null ],
     [ "spdk_bdev_get_io_channel", "bdev_8h.html#ab5bb9e746b030d7c4c89cbcf60076c7e", null ],
     [ "spdk_bdev_get_io_stat", "bdev_8h.html#ab1ba28ba382edd1d792d51a054eb3aa2", null ],
+    [ "spdk_bdev_get_io_time", "bdev_8h.html#a8a082eb89d57860b2e57ebf7f5b3caa2", null ],
     [ "spdk_bdev_get_name", "bdev_8h.html#ad97a853dcb945bf004817424b7aa28af", null ],
     [ "spdk_bdev_get_num_blocks", "bdev_8h.html#a86568eca8f0b4d0dc9bc59c5138fc7a5", null ],
     [ "spdk_bdev_get_optimal_io_boundary", "bdev_8h.html#aa79625889e23318204d235da36a4fa02", null ],
@@ -55,6 +56,7 @@ var bdev_8h =
     [ "spdk_bdev_get_qd_sampling_period", "bdev_8h.html#adab852ac707702316bf869a3d7dfdc85", null ],
     [ "spdk_bdev_get_qos_ios_per_sec", "bdev_8h.html#a95568575f25704de7831adccc0cad94b", null ],
     [ "spdk_bdev_get_uuid", "bdev_8h.html#add8565cdbf3d57697b67202b869a7beb", null ],
+    [ "spdk_bdev_get_weighted_io_time", "bdev_8h.html#a526ab43ba037b8637a23e9d42289884e", null ],
     [ "spdk_bdev_has_write_cache", "bdev_8h.html#a93f6d6ce09da384501f09a49581caa37", null ],
     [ "spdk_bdev_initialize", "bdev_8h.html#a854eb960c06597051071023a3d70e887", null ],
     [ "spdk_bdev_io_get_iovec", "bdev_8h.html#aa05d8c0e82bfbcc209af1eb958230ede", null ],